@payloadcms/figma 0.0.1-alpha.5 → 0.0.1-alpha.51

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

@@ -0,0 +1,702 @@
+import createClient from 'openapi-fetch';
+import { createDatabaseAdapter } from 'payload';
+import { v4 as uuid } from 'uuid';
+import { FigmaApiError } from '../api/figma-api.js';
+import { CONTENT_SYSTEM_NOT_FOUND_MESSAGE } from '../constants.js';
+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 { dataToContentAPI } from './utilities/data/index.js';
+import { convertPayloadJoinsToContentAPI } from './utilities/joins.js';
+import { addFallbackLocale } from './utilities/locale/index.js';
+import { buildMeta } from './utilities/meta/buildMeta.js';
+import { convertPayloadWhereToContentAPI } from './utilities/where.js';
+async function syncCollections() {
+    let existingIds;
+    try {
+        const { data: response, error, response: httpResponse } = await this.client.GET('/api/v0/content_systems/{contentSystemId}/collections', {
+            params: {
+                path: {
+                    contentSystemId: this.contentSystemId
+                }
+            }
+        });
+        if (httpResponse.status === 404 || httpResponse.status === 410) {
+            throw new Error(CONTENT_SYSTEM_NOT_FOUND_MESSAGE);
+        }
+        if (error) {
+            throw new Error(JSON.stringify(error));
+        }
+        if (!response) {
+            throw new Error('No response from collections endpoint');
+        }
+        existingIds = new Set(response.data.map((c)=>c.id));
+        this.payload.logger.info(`Found ${existingIds.size} existing collections`);
+    } catch (error) {
+        if (error instanceof Error && error.message === CONTENT_SYSTEM_NOT_FOUND_MESSAGE) {
+            throw error;
+        }
+        if (error instanceof FigmaApiError && (error.statusCode === 404 || error.statusCode === 410)) {
+            throw new Error(CONTENT_SYSTEM_NOT_FOUND_MESSAGE);
+        }
+        this.payload.logger.warn(`Failed to fetch collections, will attempt to create all: ${error.message}`);
+        existingIds = new Set();
+    }
+    for (const collection of this.payload.config.collections){
+        if (!existingIds.has(collection.slug)) {
+            await createCollection.call(this, collection.slug);
+        }
+    }
+    for (const global of this.payload.config.globals || []){
+        const globalId = `_global-${global.slug}`;
+        if (!existingIds.has(globalId)) {
+            await createCollection.call(this, globalId);
+        }
+    }
+}
+async function init() {
+    if (this.auth.mode === 'apiKey') {
+        this.payload.logger.info('Using API Key authentication');
+    } else if (this.auth.mode === 'tokenStore') {
+        this.payload.logger.info('Using TokenStore authentication (local dev)');
+    } else {
+        this.payload.logger.info('Using Dev JWT authentication (testing)');
+    }
+    if (process.env.PAYLOAD_DROP_DATABASE === 'true') {
+        await this.clearDatabase();
+    }
+    await syncCollections.call(this);
+}
+async function createCollection(collectionId) {
+    try {
+        const { error } = await this.client.POST('/api/v0/content_systems/{contentSystemId}/collections', {
+            body: {
+                id: collectionId
+            },
+            params: {
+                path: {
+                    contentSystemId: this.contentSystemId
+                }
+            }
+        });
+        if (error) {
+            throw new Error(JSON.stringify(error));
+        }
+        this.payload.logger.info(`Created collection: ${collectionId}`);
+    } catch (error) {
+        const errorMessage = error.message;
+        if (!errorMessage.includes('already exists') && !errorMessage.includes('409')) {
+            this.payload.logger.warn(`Failed to create collection ${collectionId}: ${errorMessage}`);
+        }
+    }
+}
+async function findMany({ collection, joins, limit, locale: localeArg, page, pagination: _pagination, sort, where }) {
+    const locale = addFallbackLocale(localeArg, this.payload);
+    const { data: response, error } = await this.client.POST('/api/v0/documents:find', {
+        body: {
+            collection,
+            contentSystemId: this.contentSystemId,
+            join: convertPayloadJoinsToContentAPI(this.payload, collection, joins),
+            limit,
+            locale,
+            page: page ?? 1,
+            sort: addFallbackSort(sort, this.payload, collection),
+            where: convertPayloadWhereToContentAPI(where ?? {}),
+            ...buildMeta(this.payload, {
+                collection,
+                locale,
+                where
+            })
+        }
+    });
+    if (error) {
+        throw new Error(`Content API findMany error: ${JSON.stringify(error)}`);
+    }
+    if (!response) {
+        throw new Error('No response from findMany');
+    }
+    return unwrapFindResponse(this.payload, response.result, collection);
+}
+async function find(args) {
+    const collectionConfig = this.payload.config.collections.find((c)=>c.slug === args.collection);
+    return findMany.call(this, {
+        collection: args.collection,
+        joins: args.joins,
+        // TODO: FindArgs.limit should be 'number' not 'number | undefined'
+        // is sanitized by Payload Core before calling the adapter (defaults to 10 or 0 based on pagination)
+        limit: args.limit,
+        locale: args.locale,
+        page: args.page ?? 1,
+        pagination: args.pagination,
+        sort: args.sort || collectionConfig?.defaultSort,
+        where: args.where
+    });
+}
+// 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 locale = addFallbackLocale(args.locale, this.payload);
+    const { data: response, error } = await this.client.POST('/api/v0/document_versions:find', {
+        body: {
+            collection: args.collection,
+            contentSystemId: this.contentSystemId,
+            // TODO: FindVersionsArgs.limit should be 'number' not 'number | undefined'
+            // is sanitized by Payload Core before calling the adapter (defaults to 10 or 0 based on pagination)
+            limit: args.limit,
+            locale,
+            page: args.page ?? 1,
+            sort: sortWithFallback,
+            where: whereClause,
+            ...buildMeta(this.payload, {
+                collection: args.collection,
+                locale,
+                where: args.where
+            })
+        }
+    });
+    if (error) {
+        throw new Error(`Content API findVersions error: ${JSON.stringify(error)}`);
+    }
+    if (!response) {
+        throw new Error('No response from findVersions');
+    }
+    return unwrapFindResponse(this.payload, response.result, args.collection);
+}
+async function queryDrafts(args) {
+    const versionsResult = await this.findVersions({
+        collection: args.collection,
+        limit: args.limit,
+        locale: args.locale,
+        page: args.page,
+        pagination: args.pagination,
+        sort: args.sort,
+        where: {
+            ...args.where,
+            latest: {
+                equals: true
+            }
+        }
+    });
+    // queryDrafts returns documents at root level, not nested in 'version'.
+    // Only spread version content; version metadata (latest, parent) must not leak.
+    const docs = versionsResult.docs.map((versionDoc)=>({
+            ...versionDoc.version,
+            id: versionDoc.parent
+        }));
+    return {
+        ...versionsResult,
+        docs
+    };
+}
+async function createVersion(args) {
+    const { data: response, error } = await this.client.POST('/api/v0/document_versions:create', {
+        body: {
+            collection: args.collectionSlug,
+            contentSystemId: this.contentSystemId,
+            versionDoc: {
+                createdAt: args.createdAt,
+                latest: !args.autosave,
+                parent: String(args.parent),
+                updatedAt: args.updatedAt,
+                version: dataToContentAPI(this.payload, args.collectionSlug, args.versionData, {
+                    applyDefaults: true,
+                    publishedLocale: args.publishedLocale
+                })
+            }
+        }
+    });
+    if (error) {
+        throw new Error(`Content API createVersion error: ${JSON.stringify(error)}`);
+    }
+    if (!response) {
+        throw new Error('No response from createVersion');
+    }
+    return unwrapDocument(this.payload, response.result, args.collectionSlug);
+}
+async function updateVersion(args) {
+    const where = args.where ?? {
+        id: {
+            equals: args.id
+        }
+    };
+    const locale = addFallbackLocale(args.locale, this.payload);
+    // versionData contains version metadata plus nested version content
+    const { publishedLocale, version, ...versionMeta } = args.versionData;
+    const { data: response, error } = await this.client.POST('/api/v0/document_versions:update', {
+        body: {
+            collection: args.collection,
+            contentSystemId: this.contentSystemId,
+            createOnMissing: false,
+            locale,
+            versionDoc: {
+                createdAt: versionMeta.createdAt,
+                latest: versionMeta.latest,
+                parent: versionMeta.parent != null ? String(versionMeta.parent) : undefined,
+                updatedAt: versionMeta.updatedAt,
+                version: dataToContentAPI(this.payload, args.collection, version, {
+                    publishedLocale
+                })
+            },
+            where: convertPayloadWhereToContentAPI(where, {
+                stripVersionPrefix: true
+            }),
+            ...buildMeta(this.payload, {
+                collection: args.collection,
+                locale,
+                where
+            })
+        }
+    });
+    if (error) {
+        throw new Error(`Content API updateVersion error: ${JSON.stringify(error)}`);
+    }
+    if (!response?.result || !('data' in response.result)) {
+        throw new Error('No document data in updateVersion response');
+    }
+    const doc = response.result.data[0];
+    if (!doc) {
+        return null;
+    }
+    return unwrapDocument(this.payload, doc, args.collection);
+}
+async function deleteVersions(args) {
+    if (!args.collection) {
+        throw new Error('deleteVersions requires a collection');
+    }
+    const locale = addFallbackLocale(args.locale, this.payload);
+    const { error } = await this.client.POST('/api/v0/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
+            })
+        }
+    });
+    if (error) {
+        throw new Error(`Content API deleteVersions error: ${JSON.stringify(error)}`);
+    }
+}
+async function findOne(args) {
+    const { docs } = await this.find({
+        collection: args.collection,
+        joins: args.joins,
+        limit: 1,
+        locale: args.locale,
+        pagination: false,
+        where: args.where
+    });
+    return docs[0] ?? null;
+}
+async function updateMany(args) {
+    const locale = addFallbackLocale(args.locale, this.payload);
+    const { data: response, error } = await this.client.POST('/api/v0/documents:update', {
+        body: {
+            collection: args.collection,
+            contentSystemId: this.contentSystemId,
+            createOnMissing: false,
+            doc: dataToContentAPI(this.payload, args.collection, args.data),
+            limit: args.limit,
+            locale,
+            returning: {},
+            sort: addFallbackSort(args.sort || '-updatedAt', this.payload, args.collection),
+            where: convertPayloadWhereToContentAPI(args.where),
+            ...buildMeta(this.payload, {
+                collection: args.collection,
+                locale,
+                where: args.where
+            })
+        }
+    });
+    if (error) {
+        throw new Error(`Content API updateMany error: ${JSON.stringify(error)}`);
+    }
+    if (!response) {
+        throw new Error('No response from updateMany');
+    }
+    if (response.result && 'data' in response.result) {
+        return response.result.data.map((doc)=>unwrapDocument(this.payload, doc, args.collection));
+    }
+    return null;
+}
+async function updateOne(args) {
+    const locale = addFallbackLocale(args.locale, this.payload);
+    const where = args.where ?? {
+        id: {
+            equals: args.id
+        }
+    };
+    const { data: response, error } = await this.client.POST('/api/v0/documents:update', {
+        body: {
+            collection: args.collection,
+            contentSystemId: this.contentSystemId,
+            createOnMissing: false,
+            doc: dataToContentAPI(this.payload, args.collection, args.data),
+            locale,
+            returning: {},
+            where: convertPayloadWhereToContentAPI(where),
+            ...buildMeta(this.payload, {
+                collection: args.collection,
+                locale,
+                where
+            })
+        }
+    });
+    if (error) {
+        throw new Error(`Content API updateOne error: ${JSON.stringify(error)}`);
+    }
+    if (!response) {
+        throw new Error('No response from updateOne');
+    }
+    if (!response.result || !('data' in response.result)) {
+        throw new Error('Unexpected response format from updateOne');
+    }
+    const doc = response.result.data[0];
+    if (!doc) {
+        return null;
+    }
+    return unwrapDocument(this.payload, doc, args.collection);
+}
+async function deleteMany(args) {
+    const locale = addFallbackLocale(args.req?.locale, this.payload);
+    const { error } = await this.client.POST('/api/v0/documents:delete', {
+        body: {
+            collection: args.collection,
+            contentSystemId: this.contentSystemId,
+            locale,
+            where: convertPayloadWhereToContentAPI(args.where),
+            ...buildMeta(this.payload, {
+                collection: args.collection,
+                locale,
+                where: args.where
+            })
+        }
+    });
+    if (error) {
+        throw new Error(`Content API deleteMany error: ${JSON.stringify(error)}`);
+    }
+}
+async function deleteOne(args) {
+    const locale = addFallbackLocale(args.req?.locale, this.payload);
+    const { data: response, error } = await this.client.POST('/api/v0/documents:delete', {
+        body: {
+            collection: args.collection,
+            contentSystemId: this.contentSystemId,
+            locale,
+            returning: {},
+            where: convertPayloadWhereToContentAPI(args.where),
+            ...buildMeta(this.payload, {
+                collection: args.collection,
+                locale,
+                where: args.where
+            })
+        }
+    });
+    if (error) {
+        throw new Error(`Content API deleteOne error: ${JSON.stringify(error)}`);
+    }
+    if (!response?.result || !('data' in response.result)) {
+        throw new Error('No document data in deleteOne response');
+    }
+    const doc = response.result.data[0];
+    if (!doc) {
+        return null;
+    }
+    return unwrapDocument(this.payload, doc, args.collection);
+}
+async function create(args) {
+    const isGlobalCollection = args.collection.startsWith('_global-');
+    const customIDType = this.payload.collections[args.collection]?.customIDType;
+    const id = (isGlobalCollection || customIDType || this.allowIDOnCreate) && args.data.id != null && (typeof args.data.id === 'string' || typeof args.data.id === 'number') ? String(args.data.id) : uuid();
+    const locale = addFallbackLocale(args.locale, this.payload);
+    const { data: response, error } = await this.client.POST('/api/v0/documents:create', {
+        body: {
+            collection: args.collection,
+            contentSystemId: this.contentSystemId,
+            doc: {
+                ...dataToContentAPI(this.payload, args.collection, args.data, {
+                    applyDefaults: true,
+                    createdAt: true
+                }),
+                id
+            },
+            locale,
+            ...buildMeta(this.payload, {
+                collection: args.collection,
+                locale
+            })
+        }
+    });
+    if (error) {
+        throw new Error(`Content API create error: ${JSON.stringify(error)}`);
+    }
+    if (!response) {
+        throw new Error('No response from create');
+    }
+    return unwrapDocument(this.payload, response.result, args.collection);
+}
+async function clearDatabase() {
+    this.payload.logger.info(`---- CLEARING CONTENT API DATABASE ----`);
+    try {
+        await fetch(`${this.url}/dev/clear-db`, {
+            headers: {
+                'Content-Type': 'application/json'
+            },
+            method: 'POST'
+        });
+        this.payload.logger.info('---- CONTENT API DATABASE CLEARED ----');
+        // Re-sync collections after clearing
+        await syncCollections.call(this);
+    } catch (error) {
+        this.payload.logger.error(`Failed to clear database: ${error.message}`);
+        throw error;
+    }
+}
+async function count(args) {
+    const locale = addFallbackLocale(args.locale, this.payload);
+    const { data: response, error } = await this.client.POST('/api/v0/documents:count', {
+        body: {
+            collection: args.collection,
+            contentSystemId: this.contentSystemId,
+            locale,
+            where: convertPayloadWhereToContentAPI(args.where),
+            ...buildMeta(this.payload, {
+                collection: args.collection,
+                locale,
+                where: args.where
+            })
+        }
+    });
+    if (error) {
+        throw new Error(`Content API count error: ${JSON.stringify(error)}`);
+    }
+    if (!response) {
+        throw new Error('No response from count');
+    }
+    return {
+        totalDocs: response.result.count
+    };
+}
+async function countVersions(args) {
+    const locale = addFallbackLocale(args.locale, this.payload);
+    const { data: response, error } = await this.client.POST('/api/v0/document_versions:count', {
+        body: {
+            collection: args.collection,
+            contentSystemId: this.contentSystemId,
+            locale,
+            where: convertPayloadWhereToContentAPI(args.where, {
+                stripVersionPrefix: true
+            }),
+            ...buildMeta(this.payload, {
+                collection: args.collection,
+                locale,
+                where: args.where
+            })
+        }
+    });
+    if (error) {
+        throw new Error(`Content API countVersions error: ${JSON.stringify(error)}`);
+    }
+    if (!response) {
+        throw new Error('No response from countVersions');
+    }
+    return {
+        totalDocs: response.result.count
+    };
+}
+async function upsert(args) {
+    let documentId = args.data.id;
+    if (!documentId && args.where && 'id' in args.where) {
+        const idClause = args.where.id;
+        if (idClause && 'equals' in idClause) {
+            documentId = idClause.equals;
+        }
+    }
+    if (!documentId) {
+        documentId = uuid();
+    }
+    const locale = addFallbackLocale(args.locale, this.payload);
+    const { data: response, error } = await this.client.POST('/api/v0/documents:update', {
+        body: {
+            collection: args.collection,
+            contentSystemId: this.contentSystemId,
+            createOnMissing: {
+                id: documentId
+            },
+            doc: dataToContentAPI(this.payload, args.collection, args.data, {
+                applyDefaults: true,
+                createdAt: true
+            }),
+            locale,
+            where: convertPayloadWhereToContentAPI(args.where),
+            ...buildMeta(this.payload, {
+                collection: args.collection,
+                locale,
+                where: args.where
+            })
+        }
+    });
+    if (error) {
+        throw new Error(`Content API upsert error: ${JSON.stringify(error)}`);
+    }
+    if (!response) {
+        throw new Error('No response from upsert');
+    }
+    if (!response.result || !('data' in response.result)) {
+        throw new Error('Unexpected response format from upsert');
+    }
+    const doc = response.result.data[0];
+    if (!doc) {
+        throw new Error('No document data in upsert response');
+    }
+    return unwrapDocument(this.payload, doc, args.collection);
+}
+function createGlobal(args) {
+    return this.create({
+        collection: getGlobalSlug(args.slug),
+        data: {
+            ...args.data,
+            id: args.slug,
+            globalType: args.slug
+        }
+    });
+}
+function findGlobal(args) {
+    return this.findOne({
+        collection: getGlobalSlug(args.slug),
+        locale: args.locale,
+        where: args.where ?? {}
+    });
+}
+async function updateGlobal(args) {
+    // Use upsert to ensure the global exists
+    // Use slug as the consistent document ID for globals
+    return this.upsert({
+        collection: getGlobalSlug(args.slug),
+        data: args.data,
+        where: {
+            id: {
+                equals: args.slug
+            }
+        }
+    });
+}
+// TODO: remove Omit when this PR is released: https://github.com/payloadcms/payload/pull/15183
+function findGlobalVersions(args) {
+    return this.findVersions({
+        collection: getGlobalSlug(args.global),
+        limit: args.limit,
+        locale: args.locale,
+        page: args.page,
+        pagination: args.pagination,
+        sort: args.sort,
+        where: args.where
+    });
+}
+function createGlobalVersion(args) {
+    // For globals, use the globalSlug as the consistent document ID
+    // This matches what we do in updateGlobal
+    return this.createVersion({
+        autosave: args.autosave,
+        collectionSlug: getGlobalSlug(args.globalSlug),
+        createdAt: args.createdAt,
+        parent: args.globalSlug,
+        publishedLocale: args.publishedLocale,
+        updatedAt: args.updatedAt,
+        versionData: args.versionData
+    });
+}
+function updateGlobalVersion(args) {
+    // UpdateVersion requires either id OR where, not both
+    if (args.id !== undefined) {
+        return this.updateVersion({
+            id: args.id,
+            collection: getGlobalSlug(args.global),
+            locale: args.locale,
+            versionData: args.versionData
+        });
+    }
+    // args.where is guaranteed by Payload when args.id is undefined
+    return this.updateVersion({
+        collection: getGlobalSlug(args.global),
+        locale: args.locale,
+        versionData: args.versionData,
+        where: args.where
+    });
+}
+function countGlobalVersions(args) {
+    return this.countVersions({
+        collection: getGlobalSlug(args.global),
+        locale: args.locale,
+        where: args.where
+    });
+}
+export const contentAPIAdapter = (opts)=>({
+        name: 'content-api',
+        defaultIDType: 'text',
+        init: ({ payload })=>{
+            const client = createClient({
+                baseUrl: opts.url
+            });
+            const middlewareOpts = {
+                auth: opts.auth,
+                contentSystemId: opts.contentSystemId,
+                logger: payload.logger,
+                url: opts.url
+            };
+            client.use(createAuthMiddleware(middlewareOpts));
+            client.use(createErrorMiddleware(middlewareOpts));
+            return createDatabaseAdapter({
+                name: 'content-api',
+                allowIDOnCreate: opts.allowIDOnCreate ?? false,
+                auth: opts.auth,
+                beginTransaction: ()=>Promise.resolve(null),
+                clearDatabase: clearDatabase,
+                client,
+                commitTransaction: async ()=>{},
+                contentSystemId: opts.contentSystemId,
+                count: count,
+                countGlobalVersions: countGlobalVersions,
+                countVersions: countVersions,
+                create: create,
+                createGlobal: createGlobal,
+                createGlobalVersion: createGlobalVersion,
+                createVersion: createVersion,
+                defaultIDType: 'text',
+                deleteMany: deleteMany,
+                deleteOne: deleteOne,
+                deleteVersions: deleteVersions,
+                find: find,
+                findDistinct: ()=>Promise.reject(new Error('findDistinct is not yet implemented for Content API adapter')),
+                findGlobal: findGlobal,
+                findGlobalVersions: findGlobalVersions,
+                findOne: findOne,
+                findVersions: findVersions,
+                init,
+                packageName: '@payloadcms/db-content-api',
+                payload,
+                queryDrafts: queryDrafts,
+                rollbackTransaction: async ()=>{},
+                updateGlobal: updateGlobal,
+                updateGlobalVersion: updateGlobalVersion,
+                updateMany: updateMany,
+                updateOne: updateOne,
+                updateVersion: updateVersion,
+                upsert: upsert,
+                url: opts.url
+            });
+        }
+    });
+
+//# sourceMappingURL=index.js.map

package/dist/db-content-api/temp-utilities/slug.d.ts

@@ -0,0 +1,2 @@
+export declare const getGlobalSlug: (slug: string) => string;
+//# sourceMappingURL=slug.d.ts.map

package/dist/db-content-api/temp-utilities/slug.js

@@ -0,0 +1,3 @@
+export const getGlobalSlug = (slug)=>`_global-${slug}`;
+
+//# sourceMappingURL=slug.js.map