@payloadcms/figma 0.1.0-alpha.0 → 0.1.0-alpha.2

package/dist/db-content-api/index.d.ts

@@ -2,6 +2,7 @@ import type { BaseDatabaseAdapter, CreateArgs, DatabaseAdapterObj } from 'payloa
 import createClient from 'openapi-fetch';
 import type { paths } from './generated/content-api-types.js';
 import { type AuthMode } from './utilities/auth.js';
+import { type DocumentSchemaWire } from './utilities/schema/buildDocumentSchema.js';
 type ContentAPIOptions = {
     allowIDOnCreate?: boolean;
     auth: AuthMode;
@@ -26,7 +27,9 @@ export type ContentAPIAdapter = {
     auth: AuthMode;
     clearDatabase: () => Promise<void>;
     client: ReturnType<typeof createClient<paths>>;
+    clientVersionHeaders: Record<string, string>;
     contentSystemId: string;
+    documentSchema: DocumentSchemaWire;
     environmentName?: string;
     idType: 'uuid';
     notifyLocalJobQueue: boolean;

package/dist/db-content-api/index.js

@@ -7,12 +7,13 @@ import { getGlobalSlug } from './temp-utilities/slug.js';
 import { addFallbackSort } from './temp-utilities/sorting.js';
 import { unwrapDocument, unwrapFindResponse } from './temp-utilities/unwrapDocument.js';
 import { createAuthMiddleware, createErrorMiddleware } from './utilities/auth.js';
+import { getClientVersionHeaders } from './utilities/clientVersionHeaders.js';
 import { dataToContentAPI, resolveVersionContent } from './utilities/data/index.js';
 import { validateRelationshipIds } from './utilities/data/validateRelationships.js';
 import { convertPayloadJoinsToContentAPI } from './utilities/joins.js';
 import { addFallbackLocale } from './utilities/locale/index.js';
-import { buildMeta } from './utilities/meta/buildMeta.js';
 import { normalizeLocaleInWhere } from './utilities/meta/normalizeLocaleInWhere.js';
+import { buildDocumentSchema } from './utilities/schema/buildDocumentSchema.js';
 import { convertPayloadWhereToContentAPI } from './utilities/where.js';
 /**
  * Heads-up logged locally whenever a job is queued. Queued jobs are executed by Figma's deployed runner, so
@@ -121,21 +122,18 @@ async function createCollection(collectionId) {
 async function findMany({ collection, joins, limit, locale: localeArg, page, pagination: _pagination, sort, where }) {
     const locale = addFallbackLocale(localeArg, this.payload);
     const normalizedWhere = normalizeLocaleInWhere(where, this.payload, collection, locale);
-    const { data: response, error, response: httpResponse } = await this.client.POST('/api/v0/documents:find', {
+    const joinClause = convertPayloadJoinsToContentAPI(this.payload, collection, joins);
+    const { data: response, error, response: httpResponse } = await this.client.POST('/api/v1/documents:find', {
         body: {
             collection,
             contentSystemId: this.contentSystemId,
-            join: convertPayloadJoinsToContentAPI(this.payload, collection, joins, locale),
+            join: joinClause,
             limit,
             locale,
             page: page ?? 1,
+            schema: this.documentSchema,
             sort: addFallbackSort(sort, this.payload, collection),
-            where: convertPayloadWhereToContentAPI(normalizedWhere ?? {}),
-            ...buildMeta(this.payload, {
-                collection,
-                locale,
-                where: normalizedWhere
-            })
+            where: convertPayloadWhereToContentAPI(normalizedWhere ?? {})
         }
     });
     if (error) {
@@ -167,12 +165,9 @@ async function find(args) {
 // TODO: remove Omit when this PR is released: https://github.com/payloadcms/payload/pull/15183
 async function findVersions(args) {
     const sortWithFallback = addFallbackSort(args.sort || '-updatedAt', this.payload, args.collection);
-    const whereClause = convertPayloadWhereToContentAPI(args.where ?? {}, {
-        parentToDocumentId: true,
-        stripVersionPrefix: true
-    });
+    const whereClause = convertPayloadWhereToContentAPI(args.where ?? {});
     const locale = addFallbackLocale(args.locale, this.payload);
-    const { data: response, error, response: httpResponse } = await this.client.POST('/api/v0/document_versions:find', {
+    const { data: response, error, response: httpResponse } = await this.client.POST('/api/v1/document_versions:find', {
         body: {
             collection: args.collection,
             contentSystemId: this.contentSystemId,
@@ -181,13 +176,9 @@ async function findVersions(args) {
             limit: args.limit,
             locale,
             page: args.page ?? 1,
+            schema: this.documentSchema,
             sort: sortWithFallback,
-            where: whereClause,
-            ...buildMeta(this.payload, {
-                collection: args.collection,
-                locale,
-                where: args.where
-            })
+            where: whereClause
         }
     });
     if (error) {
@@ -229,13 +220,17 @@ async function createVersion(args) {
         applyDefaults: true,
         publishedLocale: args.publishedLocale
     });
+    // id/globalType aren't v1 schema fields (id rides as versionDoc.parent)
+    delete versionContent.id;
+    delete versionContent.globalType;
     if (args.autosave) {
         versionContent._payloadAutosave = true;
     }
-    const { data: response, error, response: httpResponse } = await this.client.POST('/api/v0/document_versions:create', {
+    const { data: response, error, response: httpResponse } = await this.client.POST('/api/v1/document_versions:create', {
         body: {
             collection: args.collectionSlug,
             contentSystemId: this.contentSystemId,
+            schema: this.documentSchema,
             versionDoc: {
                 createdAt: args.createdAt,
                 latest: true,
@@ -269,12 +264,15 @@ async function updateVersion(args) {
     const versionContent = dataToContentAPI(this.payload, args.collection, resolvedVersion, {
         publishedLocale
     });
-    const { data: response, error, response: httpResponse } = await this.client.POST('/api/v0/document_versions:update', {
+    delete versionContent.id;
+    delete versionContent.globalType;
+    const { data: response, error, response: httpResponse } = await this.client.POST('/api/v1/document_versions:update', {
         body: {
             collection: args.collection,
             contentSystemId: this.contentSystemId,
             createOnMissing: false,
             locale,
+            schema: this.documentSchema,
             versionDoc: {
                 createdAt: versionMeta.createdAt,
                 latest: versionMeta.latest,
@@ -282,14 +280,7 @@ async function updateVersion(args) {
                 updatedAt: versionMeta.updatedAt,
                 version: versionContent
             },
-            where: convertPayloadWhereToContentAPI(where, {
-                stripVersionPrefix: true
-            }),
-            ...buildMeta(this.payload, {
-                collection: args.collection,
-                locale,
-                where
-            })
+            where: convertPayloadWhereToContentAPI(where)
         }
     });
     if (error) {
@@ -314,19 +305,13 @@ async function deleteVersions(args) {
         throw new Error('deleteVersions requires a collection');
     }
     const locale = addFallbackLocale(args.locale, this.payload);
-    const { error, response: httpResponse } = await this.client.POST('/api/v0/document_versions:delete', {
+    const { error, response: httpResponse } = await this.client.POST('/api/v1/document_versions:delete', {
         body: {
             collection: args.collection,
             contentSystemId: this.contentSystemId,
             locale,
-            where: convertPayloadWhereToContentAPI(args.where, {
-                stripVersionPrefix: true
-            }),
-            ...buildMeta(this.payload, {
-                collection: args.collection,
-                locale,
-                where: args.where
-            })
+            schema: this.documentSchema,
+            where: convertPayloadWhereToContentAPI(args.where)
         }
     });
     if (error) {
@@ -346,7 +331,7 @@ async function findOne(args) {
 }
 async function findDistinct(args) {
     const locale = addFallbackLocale(args.locale, this.payload);
-    const { data: response, error, response: httpResponse } = await this.client.POST('/api/v0/documents:findDistinct', {
+    const { data: response, error, response: httpResponse } = await this.client.POST('/api/v1/documents:findDistinct', {
         body: {
             collection: args.collection,
             contentSystemId: this.contentSystemId,
@@ -354,13 +339,9 @@ async function findDistinct(args) {
             limit: args.limit,
             locale,
             page: args.page ?? 1,
+            schema: this.documentSchema,
             sort: addFallbackSort(args.sort, this.payload, args.collection),
-            where: convertPayloadWhereToContentAPI(args.where ?? {}),
-            ...buildMeta(this.payload, {
-                collection: args.collection,
-                locale,
-                where: args.where
-            })
+            where: convertPayloadWhereToContentAPI(args.where ?? {})
         }
     });
     if (error) {
@@ -382,7 +363,7 @@ async function updateMany(args) {
         data: args.data,
         payload: this.payload
     });
-    const { data: contentAPIResponse, error, response: httpResponse } = await this.client.POST('/api/v0/documents:update', {
+    const { data: contentAPIResponse, error, response: httpResponse } = await this.client.POST('/api/v1/documents:update', {
         body: {
             collection: args.collection,
             contentSystemId: this.contentSystemId,
@@ -391,14 +372,9 @@ async function updateMany(args) {
             environmentName: this.environmentName,
             limit: args.limit,
             locale,
-            returning: {},
+            schema: this.documentSchema,
             sort: addFallbackSort(args.sort || '-updatedAt', this.payload, args.collection),
-            where: convertPayloadWhereToContentAPI(args.where),
-            ...buildMeta(this.payload, {
-                collection: args.collection,
-                locale,
-                where: args.where
-            })
+            where: convertPayloadWhereToContentAPI(args.where)
         }
     });
     if (error) {
@@ -429,7 +405,7 @@ async function updateOne(args) {
         data: args.data,
         payload: this.payload
     });
-    const { data: contentAPIResponse, error, response: httpResponse } = await this.client.POST('/api/v0/documents:update', {
+    const { data: contentAPIResponse, error, response: httpResponse } = await this.client.POST('/api/v1/documents:update', {
         body: {
             collection: args.collection,
             contentSystemId: this.contentSystemId,
@@ -437,13 +413,8 @@ async function updateOne(args) {
             doc: dataToContentAPI(this.payload, args.collection, args.data),
             environmentName: this.environmentName,
             locale,
-            returning: {},
-            where: convertPayloadWhereToContentAPI(where),
-            ...buildMeta(this.payload, {
-                collection: args.collection,
-                locale,
-                where
-            })
+            schema: this.documentSchema,
+            where: convertPayloadWhereToContentAPI(where)
         }
     });
     if (error) {
@@ -468,18 +439,14 @@ async function updateOne(args) {
 }
 async function deleteMany(args) {
     const locale = addFallbackLocale(args.req?.locale, this.payload);
-    const { error, response: httpResponse } = await this.client.POST('/api/v0/documents:delete', {
+    const { error, response: httpResponse } = await this.client.POST('/api/v1/documents:delete', {
         body: {
             collection: args.collection,
             contentSystemId: this.contentSystemId,
             environmentName: this.environmentName,
             locale,
-            where: convertPayloadWhereToContentAPI(args.where),
-            ...buildMeta(this.payload, {
-                collection: args.collection,
-                locale,
-                where: args.where
-            })
+            schema: this.documentSchema,
+            where: convertPayloadWhereToContentAPI(args.where)
         }
     });
     if (error) {
@@ -488,19 +455,14 @@ async function deleteMany(args) {
 }
 async function deleteOne(args) {
     const locale = addFallbackLocale(args.req?.locale, this.payload);
-    const { data: response, error, response: httpResponse } = await this.client.POST('/api/v0/documents:delete', {
+    const { data: response, error, response: httpResponse } = await this.client.POST('/api/v1/documents:delete', {
         body: {
             collection: args.collection,
             contentSystemId: this.contentSystemId,
             environmentName: this.environmentName,
             locale,
-            returning: {},
-            where: convertPayloadWhereToContentAPI(args.where),
-            ...buildMeta(this.payload, {
-                collection: args.collection,
-                locale,
-                where: args.where
-            })
+            schema: this.documentSchema,
+            where: convertPayloadWhereToContentAPI(args.where)
         }
     });
     if (error) {
@@ -541,7 +503,7 @@ async function create(args) {
         data: args.data,
         payload: this.payload
     });
-    const { data: contentAPIResponse, error, response: httpResponse } = await this.client.POST('/api/v0/documents:create', {
+    const { data: contentAPIResponse, error, response: httpResponse } = await this.client.POST('/api/v1/documents:create', {
         body: {
             collection: args.collection,
             contentSystemId: this.contentSystemId,
@@ -554,11 +516,7 @@ async function create(args) {
             },
             environmentName: this.environmentName,
             locale,
-            ...buildMeta(this.payload, {
-                collection: args.collection,
-                data: args.data,
-                locale
-            })
+            schema: this.documentSchema
         }
     });
     if (error) {
@@ -580,7 +538,8 @@ async function clearDatabase() {
     try {
         const response = await fetch(getClearDatabaseUrl(this.url, process.env.FIGMA_CONTENT_API_CUTOVER_STATE), {
             headers: {
-                'Content-Type': 'application/json'
+                'Content-Type': 'application/json',
+                ...this.clientVersionHeaders
             },
             method: 'POST'
         });
@@ -604,17 +563,13 @@ export function getClearDatabaseUrl(url, cutoverState) {
 }
 async function count(args) {
     const locale = addFallbackLocale(args.locale, this.payload);
-    const { data: response, error, response: httpResponse } = await this.client.POST('/api/v0/documents:count', {
+    const { data: response, error, response: httpResponse } = await this.client.POST('/api/v1/documents:count', {
         body: {
             collection: args.collection,
             contentSystemId: this.contentSystemId,
             locale,
-            where: convertPayloadWhereToContentAPI(args.where),
-            ...buildMeta(this.payload, {
-                collection: args.collection,
-                locale,
-                where: args.where
-            })
+            schema: this.documentSchema,
+            where: convertPayloadWhereToContentAPI(args.where)
         }
     });
     if (error) {
@@ -629,20 +584,13 @@ async function count(args) {
 }
 async function countVersions(args) {
     const locale = addFallbackLocale(args.locale, this.payload);
-    const { data: response, error, response: httpResponse } = await this.client.POST('/api/v0/document_versions:count', {
+    const { data: response, error, response: httpResponse } = await this.client.POST('/api/v1/document_versions:count', {
         body: {
             collection: args.collection,
             contentSystemId: this.contentSystemId,
             locale,
-            where: convertPayloadWhereToContentAPI(args.where, {
-                parentToDocumentId: true,
-                stripVersionPrefix: true
-            }),
-            ...buildMeta(this.payload, {
-                collection: args.collection,
-                locale,
-                where: args.where
-            })
+            schema: this.documentSchema,
+            where: convertPayloadWhereToContentAPI(args.where)
         }
     });
     if (error) {
@@ -672,7 +620,7 @@ async function upsert(args) {
         data: args.data,
         payload: this.payload
     });
-    const { data: contentAPIResponse, error, response: httpResponse } = await this.client.POST('/api/v0/documents:update', {
+    const { data: contentAPIResponse, error, response: httpResponse } = await this.client.POST('/api/v1/documents:update', {
         body: {
             collection: args.collection,
             contentSystemId: this.contentSystemId,
@@ -685,13 +633,8 @@ async function upsert(args) {
             }),
             environmentName: this.environmentName,
             locale,
-            where: convertPayloadWhereToContentAPI(args.where),
-            ...buildMeta(this.payload, {
-                collection: args.collection,
-                data: args.data,
-                locale,
-                where: args.where
-            })
+            schema: this.documentSchema,
+            where: convertPayloadWhereToContentAPI(args.where)
         }
     });
     if (error) {
@@ -738,12 +681,7 @@ async function updateJobs(args) {
     const docData = dataToContentAPI(this.payload, 'payload-jobs', data);
     const sortClause = addFallbackSort(sort || '-updatedAt', this.payload, 'payload-jobs');
     const whereQuery = convertPayloadWhereToContentAPI(whereClause);
-    const meta = buildMeta(this.payload, {
-        collection: 'payload-jobs',
-        locale: undefined,
-        where: whereClause
-    });
-    const { data: response, error, response: httpResponse } = await this.client.POST('/api/v0/documents:update', {
+    const { data: response, error, response: httpResponse } = await this.client.POST('/api/v1/documents:update', {
         body: {
             collection: 'payload-jobs',
             contentSystemId: this.contentSystemId,
@@ -753,10 +691,9 @@ async function updateJobs(args) {
             ...limit != null && {
                 limit
             },
-            returning: {},
+            schema: this.documentSchema,
             sort: sortClause,
-            where: whereQuery,
-            ...meta
+            where: whereQuery
         }
     });
     if (error) {
@@ -787,8 +724,7 @@ function createGlobal(args) {
         collection: getGlobalSlug(args.slug),
         data: {
             ...args.data,
-            id: args.slug,
-            globalType: args.slug
+            id: args.slug
         },
         where: {
             id: {
@@ -797,12 +733,17 @@ function createGlobal(args) {
         }
     });
 }
-function findGlobal(args) {
-    return this.findOne({
+async function findGlobal(args) {
+    const doc = await this.findOne({
         collection: getGlobalSlug(args.slug),
         locale: args.locale,
         where: args.where ?? {}
     });
+    if (doc != null) {
+        ;
+        doc.globalType = args.slug;
+    }
+    return doc;
 }
 async function updateGlobal(args) {
     // TODO: upsert's `createOnMissing` path generates a new `createdAt` on every call,
@@ -879,8 +820,10 @@ export const contentAPIAdapter = (opts)=>({
         name: 'content-api',
         defaultIDType: 'text',
         init: ({ payload })=>{
+            const clientVersionHeaders = getClientVersionHeaders();
             const client = createClient({
-                baseUrl: opts.url
+                baseUrl: opts.url,
+                headers: clientVersionHeaders
             });
             const middlewareOpts = {
                 auth: opts.auth,
@@ -897,6 +840,7 @@ export const contentAPIAdapter = (opts)=>({
                 beginTransaction: ()=>Promise.resolve(null),
                 clearDatabase: clearDatabase,
                 client,
+                clientVersionHeaders,
                 commitTransaction: async ()=>{},
                 connect: connect,
                 contentSystemId: opts.contentSystemId,
@@ -911,6 +855,7 @@ export const contentAPIAdapter = (opts)=>({
                 deleteMany: deleteMany,
                 deleteOne: deleteOne,
                 deleteVersions: deleteVersions,
+                documentSchema: buildDocumentSchema(payload.config),
                 environmentName: opts.environmentName,
                 find: find,
                 findDistinct: findDistinct,

package/dist/db-content-api/utilities/clientVersionHeaders.d.ts

@@ -0,0 +1,7 @@
+export declare const FIGMA_PAYLOAD_PLUGIN_VERSION_HEADER = "X-Figma-Payload-Plugin-Version";
+type ClientVersionHeadersArgs = {
+    payloadPluginVersion: string;
+};
+export declare function getClientVersionHeaders(): Record<string, string>;
+export declare function buildClientVersionHeaders({ payloadPluginVersion, }: ClientVersionHeadersArgs): Record<string, string>;
+export {};

package/dist/db-content-api/utilities/clientVersionHeaders.js

@@ -0,0 +1,15 @@
+import packageJson from '../../../package.json' with {
+    type: 'json'
+};
+// KEEP_IN_SYNC(payload/content-api/src/server/clientVersionTelemetry.ts)
+export const FIGMA_PAYLOAD_PLUGIN_VERSION_HEADER = 'X-Figma-Payload-Plugin-Version';
+export function getClientVersionHeaders() {
+    return buildClientVersionHeaders({
+        payloadPluginVersion: packageJson.version
+    });
+}
+export function buildClientVersionHeaders({ payloadPluginVersion }) {
+    return {
+        [FIGMA_PAYLOAD_PLUGIN_VERSION_HEADER]: payloadPluginVersion
+    };
+}

package/dist/db-content-api/utilities/data/atomicOperations.d.ts

@@ -0,0 +1,16 @@
+export type AtomicOperator = '$inc' | '$push' | '$remove';
+export declare const ATOMIC_OPERATORS: readonly AtomicOperator[];
+/** Relationship/upload values are lists, so they only ever carry list operators. */
+export declare const RELATIONSHIP_ATOMIC_OPERATORS: readonly ('$push' | '$remove')[];
+/**
+ * Recognizes an atomic-operation wrapper, returning its operator and the wrapped
+ * value, or `null` when the value is not such a wrapper.
+ */
+export declare function matchAtomicOperation<T extends AtomicOperator>(value: unknown, operators: readonly T[]): {
+    inner: unknown;
+    operator: T;
+} | null;
+/** Whether the value is an atomic-operation wrapper rather than a plain value. */
+export declare function isAtomicOperation(value: unknown, operators: readonly AtomicOperator[]): boolean;
+/** Returns the wrapped value of an atomic operation, or the value itself. */
+export declare function unwrapAtomicOperation(value: unknown, operators: readonly AtomicOperator[]): unknown;

package/dist/db-content-api/utilities/data/atomicOperations.js

@@ -0,0 +1,48 @@
+// Payload expresses an atomic field update as a single-key wrapper around the
+// value — e.g. `{ $push: ['id'] }` on a has-many relationship, `{ $inc: 1 }` on a
+// number field. Which operators are legal depends on the field type, so callers
+// pass the set they accept; the default is every operator the adapter knows about.
+export const ATOMIC_OPERATORS = [
+    '$inc',
+    '$push',
+    '$remove'
+];
+/** Relationship/upload values are lists, so they only ever carry list operators. */ export const RELATIONSHIP_ATOMIC_OPERATORS = [
+    '$push',
+    '$remove'
+];
+/**
+ * Recognizes an atomic-operation wrapper, returning its operator and the wrapped
+ * value, or `null` when the value is not such a wrapper.
+ */ export function matchAtomicOperation(value, operators) {
+    if (!value || typeof value !== 'object' || Array.isArray(value)) {
+        return null;
+    }
+    const keys = Object.keys(value);
+    if (keys.length !== 1) {
+        return null;
+    }
+    const key = keys[0];
+    if (!isOneOf(key, operators)) {
+        return null;
+    }
+    return {
+        inner: value[key],
+        operator: key
+    };
+}
+/** Whether the value is an atomic-operation wrapper rather than a plain value. */ export function isAtomicOperation(value, operators) {
+    return matchAtomicOperation(value, operators) !== null;
+}
+/** Returns the wrapped value of an atomic operation, or the value itself. */ export function unwrapAtomicOperation(value, operators) {
+    const match = matchAtomicOperation(value, operators);
+    return match ? match.inner : value;
+}
+function isOneOf(value, options) {
+    for (const option of options){
+        if (option === value) {
+            return true;
+        }
+    }
+    return false;
+}

package/dist/db-content-api/utilities/data/convertRelationshipIds.d.ts

@@ -0,0 +1,25 @@
+import type { Payload, RelationshipField, UploadField } from 'payload';
+type Direction = 'fromWire' | 'toWire';
+export declare function convertRelationshipFieldIdsFromWire(options: {
+    field: RelationshipField | UploadField;
+    payload: Payload;
+    value: unknown;
+}): unknown;
+export declare function convertRelationshipFieldIdsToWire(options: {
+    field: RelationshipField | UploadField;
+    payload: Payload;
+    value: unknown;
+}): unknown;
+/**
+ * Converts the id(s) inside a relationship/upload field value between Payload's
+ * representation (numeric ids kept as numbers) and the Content API wire form
+ * (all ids as strings). No-op for uuid/text targets. Preserves has-many arrays,
+ * polymorphic shapes, localized locale-maps, and atomic operators.
+ */
+export declare function convertRelationshipFieldIds(options: {
+    direction: Direction;
+    field: RelationshipField | UploadField;
+    payload: Payload;
+    value: unknown;
+}): unknown;
+export {};