@voyantjs/plugin-sanity-cms 0.24.0 → 0.24.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@voyantjs/plugin-sanity-cms",
-  "version": "0.24.0",
+  "version": "0.24.1",
   "license": "Apache-2.0",
   "type": "module",
   "exports": {
@@ -27,7 +27,7 @@
   },
   "dependencies": {
     "zod": "^4.3.6",
-    "@voyantjs/core": "0.24.0"
+    "@voyantjs/core": "0.24.1"
   },
   "devDependencies": {
     "typescript": "^6.0.2",

package/dist/client.d.ts

@@ -1,54 +0,0 @@
-import type { SanityDocBody, SanityFetch } from "./types.js";
-/**
- * Options for {@link createSanityClient}.
- */
-export interface SanityClientOptions {
-    /** Sanity project ID (the short slug from sanity.io/manage). */
-    projectId: string;
-    /** Sanity dataset (e.g. `"production"`). */
-    dataset: string;
-    /**
-     * Sanity API token with write access. Sent as
-     * `Authorization: Bearer ${token}`.
-     */
-    token: string;
-    /**
-     * Sanity API version (date-based, e.g. `"2024-01-01"`). Defaults to
-     * `"2024-01-01"`.
-     */
-    apiVersion?: string;
-    /**
-     * Field on the Sanity document that stores the Voyant record's ID.
-     * Defaults to `"voyantId"`. A matching field (+unique index) must be
-     * declared in the Sanity schema.
-     */
-    voyantIdField?: string;
-    /**
-     * Sanity API host. Defaults to `"api.sanity.io"`. Override for regional
-     * hosts, proxies, or self-hosted deployments.
-     */
-    apiHost?: string;
-    /** Override `fetch` (e.g. in tests). Defaults to global `fetch`. */
-    fetch?: SanityFetch;
-}
-export interface SanityClient {
-    /**
-     * Create or replace a document whose {@link SanityClientOptions.voyantIdField}
-     * equals `voyantId`.
-     */
-    upsertByVoyantId(documentType: string, voyantId: string, body: SanityDocBody): Promise<{
-        _id: string;
-        created: boolean;
-    }>;
-    /**
-     * Delete a document whose `voyantId` field equals the given value.
-     * Returns `false` if no matching document was found.
-     */
-    deleteByVoyantId(documentType: string, voyantId: string): Promise<boolean>;
-    /** Find at most one document whose `voyantId` field equals the given value. */
-    findByVoyantId(documentType: string, voyantId: string): Promise<{
-        _id: string;
-    } | null>;
-}
-export declare function createSanityClient(options: SanityClientOptions): SanityClient;
-//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AAE5D;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,gEAAgE;IAChE,SAAS,EAAE,MAAM,CAAA;IACjB,4CAA4C;IAC5C,OAAO,EAAE,MAAM,CAAA;IACf;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,oEAAoE;IACpE,KAAK,CAAC,EAAE,WAAW,CAAA;CACpB;AAWD,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,gBAAgB,CACd,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,aAAa,GAClB,OAAO,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC,CAAA;IAC7C;;;OAGG;IACH,gBAAgB,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAC1E,+EAA+E;IAC/E,cAAc,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC,CAAA;CACxF;AAED,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,mBAAmB,GAAG,YAAY,CAiH7E"}

package/dist/client.js

@@ -1,91 +0,0 @@
-export function createSanityClient(options) {
-    const apiVersion = options.apiVersion ?? "2024-01-01";
-    const voyantIdField = options.voyantIdField ?? "voyantId";
-    const apiHost = options.apiHost ?? "api.sanity.io";
-    const baseUrl = `https://${options.projectId}.${apiHost}/v${apiVersion}/data`;
-    const fetchImpl = options.fetch ?? globalThis.fetch;
-    function headers() {
-        return {
-            Authorization: `Bearer ${options.token}`,
-            "Content-Type": "application/json",
-        };
-    }
-    async function request(method, path, body) {
-        if (!fetchImpl) {
-            throw new Error("Sanity client requires a fetch implementation");
-        }
-        const init = {
-            method,
-            headers: headers(),
-        };
-        if (body !== undefined)
-            init.body = JSON.stringify(body);
-        const response = await fetchImpl(`${baseUrl}${path}`, init);
-        let text = "";
-        let json = null;
-        try {
-            text = await response.text();
-            json = text ? JSON.parse(text) : null;
-        }
-        catch {
-            // leave json as null, surface text
-        }
-        return { ok: response.ok, status: response.status, json, text };
-    }
-    async function findByVoyantId(documentType, voyantId) {
-        // GROQ parameters are JSON-encoded values attached as $-prefixed query params.
-        const groq = `*[_type == $type && ${voyantIdField} == $vid][0]{_id}`;
-        const query = [
-            `query=${encodeURIComponent(groq)}`,
-            `$type=${encodeURIComponent(JSON.stringify(documentType))}`,
-            `$vid=${encodeURIComponent(JSON.stringify(voyantId))}`,
-        ].join("&");
-        const res = await request("GET", `/query/${options.dataset}?${query}`);
-        if (!res.ok) {
-            throw new Error(`Sanity findByVoyantId(${documentType}) failed (${res.status}): ${res.text}`);
-        }
-        const body = (res.json ?? {});
-        const first = body.result;
-        if (!first)
-            return null;
-        return { _id: first._id };
-    }
-    async function mutate(mutations) {
-        return request("POST", `/mutate/${options.dataset}?returnIds=true&visibility=sync`, {
-            mutations,
-        });
-    }
-    async function upsertByVoyantId(documentType, voyantId, body) {
-        const existing = await findByVoyantId(documentType, voyantId);
-        const docFields = { ...body, [voyantIdField]: voyantId };
-        if (existing) {
-            const res = await mutate([{ patch: { id: existing._id, set: docFields } }]);
-            if (!res.ok) {
-                throw new Error(`Sanity update(${documentType}/${existing._id}) failed (${res.status}): ${res.text}`);
-            }
-            return { _id: existing._id, created: false };
-        }
-        const createDoc = { _type: documentType, ...docFields };
-        const res = await mutate([{ create: createDoc }]);
-        if (!res.ok) {
-            throw new Error(`Sanity create(${documentType}) failed (${res.status}): ${res.text}`);
-        }
-        const json = (res.json ?? {});
-        const id = json.results?.[0]?.id;
-        if (!id) {
-            throw new Error(`Sanity create(${documentType}) response missing id`);
-        }
-        return { _id: id, created: true };
-    }
-    async function deleteByVoyantId(documentType, voyantId) {
-        const existing = await findByVoyantId(documentType, voyantId);
-        if (!existing)
-            return false;
-        const res = await mutate([{ delete: { id: existing._id } }]);
-        if (!res.ok) {
-            throw new Error(`Sanity delete(${documentType}/${existing._id}) failed (${res.status}): ${res.text}`);
-        }
-        return true;
-    }
-    return { upsertByVoyantId, deleteByVoyantId, findByVoyantId };
-}

package/dist/index.d.ts

@@ -1,8 +0,0 @@
-export type { SanityClient, SanityClientOptions } from "./client.js";
-export { createSanityClient } from "./client.js";
-export type { SanityCmsPluginOptions, SanityLogger, SanityMapFn, SanitySyncEventNames, } from "./plugin.js";
-export { sanityCmsPlugin } from "./plugin.js";
-export type { ResolvedSanitySyncEventNames, SanitySyncRuntime } from "./runtime.js";
-export { createSanitySyncRuntime } from "./runtime.js";
-export type { SanityDocBody, SanityFetch, VoyantEntityEvent } from "./types.js";
-//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAA;AACpE,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AAChD,YAAY,EACV,sBAAsB,EACtB,YAAY,EACZ,WAAW,EACX,oBAAoB,GACrB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7C,YAAY,EAAE,4BAA4B,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AACnF,OAAO,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAA;AACtD,YAAY,EAAE,aAAa,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA"}

package/dist/index.js

@@ -1,3 +0,0 @@
-export { createSanityClient } from "./client.js";
-export { sanityCmsPlugin } from "./plugin.js";
-export { createSanitySyncRuntime } from "./runtime.js";

package/dist/plugin.d.ts

@@ -1,21 +0,0 @@
-import type { Plugin } from "@voyantjs/core";
-import type { SanityClientOptions } from "./client.js";
-import type { SanityDocBody, VoyantEntityEvent } from "./types.js";
-export interface SanitySyncEventNames {
-    created?: string;
-    updated?: string;
-    deleted?: string;
-}
-export type SanityMapFn = (event: VoyantEntityEvent) => SanityDocBody;
-export interface SanityLogger {
-    error: (message: string, meta?: unknown) => void;
-    info?: (message: string, meta?: unknown) => void;
-}
-export interface SanityCmsPluginOptions extends SanityClientOptions {
-    documentType: string;
-    events?: SanitySyncEventNames;
-    mapEvent?: SanityMapFn;
-    logger?: SanityLogger;
-}
-export declare function sanityCmsPlugin(options: SanityCmsPluginOptions): Plugin;
-//# sourceMappingURL=plugin.d.ts.map

package/dist/plugin.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAc,MAAM,gBAAgB,CAAA;AAGxD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAA;AAEtD,OAAO,KAAK,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAGlE,MAAM,WAAW,oBAAoB;IACnC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,MAAM,WAAW,GAAG,CAAC,KAAK,EAAE,iBAAiB,KAAK,aAAa,CAAA;AAErE,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,KAAK,IAAI,CAAA;IAChD,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,KAAK,IAAI,CAAA;CACjD;AAED,MAAM,WAAW,sBAAuB,SAAQ,mBAAmB;IACjE,YAAY,EAAE,MAAM,CAAA;IACpB,MAAM,CAAC,EAAE,oBAAoB,CAAA;IAC7B,QAAQ,CAAC,EAAE,WAAW,CAAA;IACtB,MAAM,CAAC,EAAE,YAAY,CAAA;CACtB;AASD,wBAAgB,eAAe,CAAC,OAAO,EAAE,sBAAsB,GAAG,MAAM,CAgDvE"}

package/dist/plugin.js

@@ -1,81 +0,0 @@
-import { ZodError } from "zod";
-import { createSanitySyncRuntime } from "./runtime.js";
-import { sanityCmsPluginOptionsSchema } from "./validation.js";
-function coerceEvent(data) {
-    if (data == null || typeof data !== "object")
-        return null;
-    const maybe = data;
-    if (typeof maybe.id !== "string")
-        return null;
-    return maybe;
-}
-export function sanityCmsPlugin(options) {
-    const validatedOptions = parseSanityCmsPluginOptions(options);
-    const { client, mapEvent, logger, eventNames } = createSanitySyncRuntime(validatedOptions);
-    const subscribers = [
-        {
-            event: eventNames.created,
-            handler: async (envelope) => {
-                const event = coerceEvent(envelope.data);
-                if (!event)
-                    return;
-                try {
-                    await client.upsertByVoyantId(validatedOptions.documentType, event.id, mapEvent(event));
-                }
-                catch (err) {
-                    logger.error(`[sanity-cms] upsert on "${eventNames.created}" failed for ${event.id}`, err);
-                }
-            },
-        },
-        {
-            event: eventNames.updated,
-            handler: async (envelope) => {
-                const event = coerceEvent(envelope.data);
-                if (!event)
-                    return;
-                try {
-                    await client.upsertByVoyantId(validatedOptions.documentType, event.id, mapEvent(event));
-                }
-                catch (err) {
-                    logger.error(`[sanity-cms] upsert on "${eventNames.updated}" failed for ${event.id}`, err);
-                }
-            },
-        },
-        {
-            event: eventNames.deleted,
-            handler: async (envelope) => {
-                const event = coerceEvent(envelope.data);
-                if (!event)
-                    return;
-                try {
-                    await client.deleteByVoyantId(validatedOptions.documentType, event.id);
-                }
-                catch (err) {
-                    logger.error(`[sanity-cms] delete on "${eventNames.deleted}" failed for ${event.id}`, err);
-                }
-            },
-        },
-    ];
-    return {
-        name: "sanity-cms",
-        version: "0.1.0",
-        subscribers,
-    };
-}
-function parseSanityCmsPluginOptions(options) {
-    try {
-        return sanityCmsPluginOptionsSchema.parse(options);
-    }
-    catch (error) {
-        if (error instanceof ZodError) {
-            const detail = error.issues
-                .map((issue) => {
-                const path = issue.path.join(".") || "options";
-                return `${path}: ${issue.message}`;
-            })
-                .join("; ");
-            throw new Error(`Invalid Sanity CMS plugin options: ${detail}`);
-        }
-        throw error;
-    }
-}

package/dist/runtime.d.ts

@@ -1,15 +0,0 @@
-import { createSanityClient } from "./client.js";
-import type { SanityCmsPluginOptions, SanityLogger, SanityMapFn } from "./plugin.js";
-export interface ResolvedSanitySyncEventNames {
-    created: string;
-    updated: string;
-    deleted: string;
-}
-export interface SanitySyncRuntime {
-    client: ReturnType<typeof createSanityClient>;
-    logger: SanityLogger;
-    mapEvent: SanityMapFn;
-    eventNames: ResolvedSanitySyncEventNames;
-}
-export declare function createSanitySyncRuntime(options: SanityCmsPluginOptions): SanitySyncRuntime;
-//# sourceMappingURL=runtime.d.ts.map

package/dist/runtime.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"runtime.d.ts","sourceRoot":"","sources":["../src/runtime.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AAChD,OAAO,KAAK,EAAE,sBAAsB,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAGpF,MAAM,WAAW,4BAA4B;IAC3C,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAA;IAC7C,MAAM,EAAE,YAAY,CAAA;IACpB,QAAQ,EAAE,WAAW,CAAA;IACrB,UAAU,EAAE,4BAA4B,CAAA;CACzC;AAOD,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,sBAAsB,GAAG,iBAAiB,CAW1F"}

package/dist/runtime.js

@@ -1,17 +0,0 @@
-import { createSanityClient } from "./client.js";
-function defaultMapEvent(event) {
-    const { id: _id, ...rest } = event;
-    return rest;
-}
-export function createSanitySyncRuntime(options) {
-    return {
-        client: createSanityClient(options),
-        logger: options.logger ?? console,
-        mapEvent: options.mapEvent ?? defaultMapEvent,
-        eventNames: {
-            created: options.events?.created ?? "product.created",
-            updated: options.events?.updated ?? "product.updated",
-            deleted: options.events?.deleted ?? "product.deleted",
-        },
-    };
-}

package/dist/types.d.ts

@@ -1,31 +0,0 @@
-/**
- * Minimal shape Voyant events expose when carrying a record identifier.
- * The plugin accepts anything with `id: string`; everything else is passed
- * through to `mapEvent` untouched.
- */
-export interface VoyantEntityEvent {
-    id: string;
-    [key: string]: unknown;
-}
-/**
- * A Sanity document body, as a bag of properties. Sanity assigns `_id` +
- * `_type` on creation; the plugin sets a `voyantId` field (configurable)
- * for idempotent lookups.
- */
-export type SanityDocBody = Record<string, unknown>;
-/**
- * Minimal `fetch` shape the Sanity client depends on. Works with the global
- * `fetch` in Node 18+ / Cloudflare Workers / browsers, and is trivially
- * stubbable in tests.
- */
-export type SanityFetch = (input: string, init: {
-    method: string;
-    headers: Record<string, string>;
-    body?: string;
-}) => Promise<{
-    ok: boolean;
-    status: number;
-    json: () => Promise<unknown>;
-    text: () => Promise<string>;
-}>;
-//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAA;IACV,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACvB;AAED;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAEnD;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,CACxB,KAAK,EAAE,MAAM,EACb,IAAI,EAAE;IACJ,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,KACE,OAAO,CAAC;IACX,EAAE,EAAE,OAAO,CAAA;IACX,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAA;IAC5B,IAAI,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAA;CAC5B,CAAC,CAAA"}

package/dist/types.js

@@ -1 +0,0 @@
-export {};

package/dist/validation.d.ts

@@ -1,17 +0,0 @@
-import { z } from "zod";
-import type { SanityLogger, SanityMapFn, SanitySyncEventNames } from "./plugin.js";
-import type { SanityFetch } from "./types.js";
-export declare const sanityCmsPluginOptionsSchema: z.ZodObject<{
-    projectId: z.ZodString;
-    dataset: z.ZodString;
-    token: z.ZodString;
-    documentType: z.ZodString;
-    apiVersion: z.ZodOptional<z.ZodString>;
-    voyantIdField: z.ZodOptional<z.ZodString>;
-    apiHost: z.ZodOptional<z.ZodString>;
-    fetch: z.ZodOptional<z.ZodCustom<SanityFetch | undefined, SanityFetch | undefined>>;
-    events: z.ZodOptional<z.ZodCustom<SanitySyncEventNames | undefined, SanitySyncEventNames | undefined>>;
-    mapEvent: z.ZodOptional<z.ZodCustom<SanityMapFn | undefined, SanityMapFn | undefined>>;
-    logger: z.ZodOptional<z.ZodCustom<SanityLogger | undefined, SanityLogger | undefined>>;
-}, z.core.$strip>;
-//# sourceMappingURL=validation.d.ts.map

package/dist/validation.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../src/validation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AACvB,OAAO,KAAK,EAEV,YAAY,EACZ,WAAW,EACX,oBAAoB,EACrB,MAAM,aAAa,CAAA;AACpB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AAkC7C,eAAO,MAAM,4BAA4B;;;;;;;;;;;;iBAYK,CAAA"}

package/dist/validation.js

@@ -1,31 +0,0 @@
-import { z } from "zod";
-const optionalString = z.string().trim().min(1).optional();
-const optionalFetch = z.custom((value) => value === undefined || typeof value === "function", "Expected a fetch implementation function");
-const optionalLogger = z.custom((value) => value === undefined ||
-    (typeof value === "object" &&
-        value !== null &&
-        typeof value.error === "function" &&
-        ((value.info ?? undefined) === undefined ||
-            typeof value.info === "function")), "Expected a logger with an error function");
-const optionalMapEvent = z.custom((value) => value === undefined || typeof value === "function", "Expected a mapEvent function");
-const optionalEvents = z.custom((value) => {
-    if (value === undefined)
-        return true;
-    if (typeof value !== "object" || value === null)
-        return false;
-    const events = value;
-    return [events.created, events.updated, events.deleted].every((entry) => entry === undefined || (typeof entry === "string" && entry.trim().length > 0));
-}, "Expected event names to be non-empty strings");
-export const sanityCmsPluginOptionsSchema = z.object({
-    projectId: z.string().trim().min(1),
-    dataset: z.string().trim().min(1),
-    token: z.string().trim().min(1),
-    documentType: z.string().trim().min(1),
-    apiVersion: optionalString,
-    voyantIdField: optionalString,
-    apiHost: optionalString,
-    fetch: optionalFetch.optional(),
-    events: optionalEvents.optional(),
-    mapEvent: optionalMapEvent.optional(),
-    logger: optionalLogger.optional(),
-});