@payloadcms/figma 0.0.1-alpha.9 → 0.1.0-alpha.1

package/dist/db-content-api/generated/content-api-types.js

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */ /* eslint-disable */ // @ts-nocheck - Recursive types from OpenAPI cause TS2502 errors
+export { };

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

@@ -0,0 +1,40 @@
+import type { BaseDatabaseAdapter, CreateArgs, DatabaseAdapterObj } from 'payload';
+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;
+    contentSystemId: string;
+    environmentName?: string;
+    notifyLocalJobQueue: boolean;
+    url: string;
+};
+/**
+ * Heads-up logged locally whenever a job is queued. Queued jobs are executed by Figma's deployed runner, so
+ * if a deployed environment exists its runner can pick up anything in the queue. The developer
+ * needs to know that a job they just created locally may run on their deployed app instead of their machine.
+ */
+export declare const LOCAL_JOB_QUEUE_NOTICE: string;
+/**
+ * Logs {@link LOCAL_JOB_QUEUE_NOTICE} for every job queued locally: if a deployed
+ * environment exists, its runner can pick up anything in the queue. No-op when
+ * `notifyLocalJobQueue` is false (i.e. not a local runtime).
+ */
+export declare function maybeNotifyLocalJobQueue(adapter: ContentAPIAdapter, args: CreateArgs): void;
+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;
+    url: string;
+} & BaseDatabaseAdapter;
+export declare function getClearDatabaseUrl(url: string, cutoverState?: string): string;
+export declare const contentAPIAdapter: (opts: ContentAPIOptions) => DatabaseAdapterObj;
+export {};