Prismic plugin

• What an account stores. Every call needs the repository id (repository, such as my-repo from my-repo.prismic.io), stored on the account or passed as prismic({ repository }). The account’s key is a write token (Settings, API & Security, Write APIs), which only the migration.* operations need. A private repository also needs its Content API access token (access_token, or prismic({ accessToken })); a public one needs nothing for reads.
• A query is pinned to a ref. Prismic refuses a document query without one. When ref is omitted, the plugin reads the repository’s master ref first, which is the published content. Pass a release’s ref from repository.info to read that release instead.
• Paging. A search returns next_page while another page exists. It already carries the ref and every filter, so pass it as nextPage and the other fields are ignored. For a changing dataset the after cursor is steadier than page.
• Predicates. q takes a Prismic predicate expression such as [[at(document.type, "page")]], and orderings takes a sort such as [my.page.date desc]. The plugin passes both through rather than parsing them.
• Document bodies are yours. Which fields a document has depends on the repository’s custom types, so data is read and written as it is sent and Prismic validates it.
• Migration writes are drafts. migration.create and migration.update save into a migration release, which you publish from the Prismic UI or the client library afterwards. Prismic accepts one page per request at one request per second per repository.
• An update replaces the content. migration.update needs the full data, which replaces what is stored, and omitting tags deletes every tag. type, lang and the translation link cannot be changed.
• Webhooks. Prismic can call a URL when content changes, but this plugin does not handle inbound deliveries.

• 5 typed API operations

Setup

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

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

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

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

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

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

prismic()

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

Example API calls

const tenant = corsair.withTenant('acme');
await tenant.prismic.api.documents.search({ pageSize: 20 });

const tenant = corsair.withTenant('acme');
await tenant.prismic.api.migration.create({
	title: 'Example page',
	type: 'page',
	lang: 'en-us',
	data: { title: 'Hello' },
});

What’s next