RudderStack Transformations plugin

• Publishing is not a separate resource. publish is a query flag on transformations.create, transformations.update, libraries.create and libraries.update. Without it the call only writes a revision: the code is not live, and transformations.connect answers 400 "Transformation is not published".
• Use the right region. A token only works on the host its workspace lives in. Pass region: 'eu' when you sign in at app.eu.rudderstack.com; the default is the US host, api.rudderstack.com. region is a plugin option, not part of a tenant’s credentials, so every tenant of one plugin instance uses the same host.

• libraries.publish publishes both kinds of revision. Despite the path, it takes transformations and libraries arrays of version IDs and needs at least one of them. RudderStack runs the code on its servers first, so a failing test rejects the whole call and publishes nothing.
• Every update writes a revision. transformations.update and libraries.update always append one, so the plugin never retries them after a failure: a retry would leave a second revision behind that nobody asked for.
• A destination holds one transformation. transformations.connect replaces whatever was connected to that destination, so read transformations before connecting if the existing one matters.
• The name and language are fixed. A library’s importName comes from its name at creation and neither can be changed; a transformation cannot switch between javascript and pythonfaas. libraries.update still requires language, because RudderStack validates it against the existing value.
• Container keys differ per route. GET /transformations answers transformations, the version routes answer TransformationVersions (capital T) and libraryVersions, and the get-by-ID routes answer the object itself. The response models follow each route.
• Errors carry only a message. There is no error code and no documented error catalogue, so the status is the only structured signal. 401 is Invalid Access Token or Unauthorised; 403 is a token missing a scope.
• Paging: the version routes take count (default 5) and orderBy (asc or desc on createdAt), and nothing else.

• 17 typed API operations

​

Setup

npm install corsair @corsair-dev/rudderstacktransform better-sqlite3
npm install --save-dev @types/better-sqlite3

yarn add corsair @corsair-dev/rudderstacktransform better-sqlite3
yarn add --dev @types/better-sqlite3

pnpm install corsair @corsair-dev/rudderstacktransform better-sqlite3
pnpm install --save-dev @types/better-sqlite3

bun add corsair @corsair-dev/rudderstacktransform better-sqlite3
bun add --dev @types/better-sqlite3

import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { rudderstacktransform } from '@corsair-dev/rudderstacktransform';

export const corsair = createCorsair({
	plugins: [
		rudderstacktransform(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});

rudderstacktransform()

const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'rudderstacktransform',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl

​

Example API calls

const tenant = corsair.withTenant('acme');
await tenant.rudderstacktransform.api.transformations.list({});

const tenant = corsair.withTenant('acme');
await tenant.rudderstacktransform.api.transformations.update({
	id: '2C8Vk2wj8qkofy00YzJbvJOGeqa',
	name: 'Normalise event names',
	publish: true,
	code: 'export function transformEvent(event) { return event; }',
});

​

What’s next