Renderform plugin

• A render costs a credit unless it is cached. An identical request for the same version returns the file from the render cache, costs nothing and reports cached: true. cache: false forces a fresh render and the cost. Reuse version deliberately, or leave it off and accept the spend.
• A video render is asynchronous. An image render is synchronous and href is ready. A video format needs a template made in the Advanced Editor and answers 202 with status: "pending", so href is not usable yet: poll results.get with the requestId until the status is done or failed. A video costs 5 credits per started second.
• data is keyed by merge fields, not field names. A field looks like my-text.text: the component name, a dot, then the property. templates.content returns the sampleData a template was previewed with, which is the fastest way to learn the exact keys.
• fps is a string. The spec types it as "24", "25" or "30" rather than a number, and it is sent that way. duration and recordDuration are numbers in milliseconds, between 1000 and 30000.
• Two API versions are in use. Templates, renders and results are on /api/v2; usage and fonts are on /api/v1. Both are kept as they are.
• templates.list answers a bare array, not a page, while results.list answers a Spring-style page whose rows are in content. The two models differ accordingly.
• templates.update replaces the tag set. Sending tags swaps the whole list rather than merging into it, and updating metadata is a separate route from updating content: templates.updateContent is the one that changes HTML and CSS, and only an html-editor template has any.
• A 402 is an exhausted credit balance, not a bad request; read usage before a bulk render loop.

• 15 typed API operations

​

Setup

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

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

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

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

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

export const corsair = createCorsair({
	plugins: [
		renderform(),
	],
	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!,
	},
});

renderform()

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

​

Example API calls

const tenant = corsair.withTenant('acme');
await tenant.renderform.api.usage({});

const tenant = corsair.withTenant('acme');
await tenant.renderform.api.render({
	template: 'template_1234',
	data: { 'my-text.text': 'John' },
	fileName: 'welcome-card',
});

​

What’s next