@forumone/throughline 0.0.0 → 1.0.0-next.1

package/dist/publishing/plugin.js

@@ -0,0 +1,196 @@
+import { getPluginRegistry } from '../plugin-contract/registry.js';
+import { createNamedLogger, defaultLogger } from '../logger/index.js';
+import { getAuditWriter } from '../audit/plugin.js';
+import { resolveCollection, validateOptions } from './options.js';
+import { createBlockStatusWritesHook } from './hooks/block-status-writes.js';
+import { createRecordDraftWritesHook } from './hooks/draft-writes.js';
+import { createSendScheduledEventHook } from './hooks/schedule-events.js';
+import { createAdminEndpoints } from './endpoints/admin.js';
+import { attachPublishingService, createPublishingService } from './service.js';
+import { PUBLISHING_TOOL_DESCRIPTORS, createGetPublishStatusTool, createPublishTool, createRollbackTool, createSchedulePublishTool, createUnpublishTool, } from './tools/index.js';
+const PLUGIN_ID = '@forumone/throughline/publishing';
+const PLUGIN_VERSION = '0.1.0';
+const CLIENT_ENTRY = '@forumone/throughline/client';
+export const publishingPlugin = (rawOptions) => (incomingConfig) => {
+    if (rawOptions.enabled === false)
+        return incomingConfig;
+    const options = validateOptions(rawOptions);
+    // Payload prepends `config.routes.api` (default `/api`); paths here must
+    // not start with /api or they'll be doubled.
+    const routePrefix = options.routePrefix ?? '/publishing';
+    const logger = createNamedLogger('publishing', options.logger ?? defaultLogger);
+    const publishableSlugs = new Set(options.collections.map((c) => c.slug));
+    const adminComponents = options.adminComponents !== false;
+    const modifiedCollections = (incomingConfig.collections ?? []).map((collection) => {
+        if (!publishableSlugs.has(collection.slug))
+            return collection;
+        return {
+            ...collection,
+            // The trust boundary: nothing may change the live document's
+            // `_status` outside the pipeline. `beforeOperation` records whether
+            // the update is a draft write, which is the only place Payload
+            // exposes that; `beforeChange` enforces. They must ship together.
+            hooks: {
+                ...(collection.hooks ?? {}),
+                beforeOperation: [
+                    ...(collection.hooks?.beforeOperation ?? []),
+                    createRecordDraftWritesHook(),
+                ],
+                beforeChange: [
+                    ...(collection.hooks?.beforeChange ?? []),
+                    createBlockStatusWritesHook(),
+                ],
+                // A new scheduled time wakes the run that publishes at it.
+                afterChange: [
+                    ...(collection.hooks?.afterChange ?? []),
+                    createSendScheduledEventHook({
+                        inngest: options.inngest,
+                        scheduledPublishField: resolveCollection(options, collection.slug)
+                            .scheduledPublishField,
+                    }),
+                ],
+            },
+            ...(adminComponents
+                ? {
+                    admin: withAdminControls(collection, routePrefix),
+                    fields: withScheduleControl(collection.fields, resolveCollection(options, collection.slug).scheduledPublishField, routePrefix),
+                }
+                : {}),
+        };
+    });
+    /*
+    Declared here, bound at `onInit`.
+
+    `mcpPlugin` generates one per-key checkbox per tool while the config is being
+    built, from the names and descriptions in this array, and denies any tool it
+    has no checkbox for. The handlers cannot exist yet — they close over
+    `payload`, the service and the audit writer — but the names never needed to
+    wait for them.
+
+    This runs when Payload applies the plugin, so **this plugin must come before
+    `mcpPlugin` in the host's array** or the declarations land after the fields
+    are generated.
+    */
+    options.mcpTools?.declare(PUBLISHING_TOOL_DESCRIPTORS, { serverName: 'publishing' });
+    return {
+        ...incomingConfig,
+        collections: modifiedCollections,
+        endpoints: [
+            ...(incomingConfig.endpoints ?? []),
+            ...createAdminEndpoints({ routePrefix, publishableSlugs }),
+        ],
+        onInit: async (payload) => {
+            if (incomingConfig.onInit) {
+                await incomingConfig.onInit(payload);
+            }
+            const registry = getPluginRegistry(payload);
+            registry.requireCapability('audit-log', PLUGIN_ID);
+            const auditWriter = getAuditWriter(payload);
+            // One service instance behind every channel — MCP tools, the admin
+            // endpoints, and host code reaching in through `publishDocument`.
+            const service = createPublishingService({ payload, options, auditWriter, logger });
+            attachPublishingService(payload, service);
+            const tools = [
+                createPublishTool({ payload, options, auditWriter, service }),
+                createUnpublishTool({ payload, options, auditWriter, service }),
+                createSchedulePublishTool({ options, service }),
+                createGetPublishStatusTool({ payload, options, service }),
+                createRollbackTool({ payload, options, auditWriter }),
+            ];
+            /*
+            Payload's own MCP plugin, and the only transport these tools have.
+    
+            `onInit` is the first moment they can exist — they close over the
+            service, the audit writer and `payload` — and it runs before any request,
+            which is when `mcpPlugin` reads the array. That ordering is the whole
+            reason a config-time option can be filled at init.
+    
+            A host that registers this plugin without `mcpTools` gets the publish
+            pipeline, the admin controls and `publishDocument`, and no MCP surface
+            at all. This plugin used to serve its own `/mcp` endpoint as a fallback;
+            it no longer does.
+            */
+            options.mcpTools?.add(tools, { serverName: 'publishing', logger, audit: auditWriter });
+            registry.register({
+                id: PLUGIN_ID,
+                version: PLUGIN_VERSION,
+                capabilities: ['publishing', 'publish-pipeline'],
+            });
+            logger.info('Publishing server ready', {
+                collections: options.collections.map((c) => c.slug),
+                adminComponents,
+            });
+        },
+    };
+};
+/**
+ * Points the collection's Publish / Unpublish slots at the plugin's own
+ * controls, so a stock admin can publish without any host-side code.
+ *
+ * A slot the host already set is left alone — an explicit override in the
+ * host config wins over the plugin's default.
+ *
+ * Hosts must run `payload generate:importmap` after adding the plugin (the
+ * dev server does it automatically) so Payload can resolve these paths.
+ */
+function withAdminControls(collection, routePrefix) {
+    const edit = collection.admin?.components?.edit ?? {};
+    return {
+        ...(collection.admin ?? {}),
+        components: {
+            ...(collection.admin?.components ?? {}),
+            edit: {
+                ...edit,
+                ...(edit.PublishButton === undefined
+                    ? {
+                        PublishButton: {
+                            path: CLIENT_ENTRY,
+                            exportName: 'PublishButton',
+                            clientProps: { routePrefix },
+                        },
+                    }
+                    : {}),
+                ...(edit.UnpublishButton === undefined
+                    ? {
+                        UnpublishButton: {
+                            path: CLIENT_ENTRY,
+                            exportName: 'UnpublishButton',
+                            clientProps: { routePrefix },
+                        },
+                    }
+                    : {}),
+            },
+        },
+    };
+}
+/**
+ * Renders the collection's scheduled-publish field as the plugin's Schedule
+ * control, so scheduling runs the pipeline's checks when the time is picked.
+ *
+ * Only a top-level `date` field with that name, and only when the host has not
+ * set a component of its own. A collection with no such field is left alone —
+ * declaring the field is the host's way of opting a collection in.
+ */
+function withScheduleControl(fields, fieldName, routePrefix) {
+    return fields.map((field) => {
+        if (!('name' in field) || field.name !== fieldName || field.type !== 'date')
+            return field;
+        if (field.admin?.components?.Field !== undefined)
+            return field;
+        return {
+            ...field,
+            admin: {
+                ...(field.admin ?? {}),
+                components: {
+                    ...(field.admin?.components ?? {}),
+                    Field: {
+                        path: CLIENT_ENTRY,
+                        exportName: 'SchedulePublishField',
+                        clientProps: { routePrefix },
+                    },
+                },
+            },
+        };
+    });
+}
+//# sourceMappingURL=plugin.js.map

package/dist/publishing/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../src/publishing/plugin.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAA;AAClE,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AACrE,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AACnD,OAAO,EAAgC,iBAAiB,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AAC/F,OAAO,EAAE,2BAA2B,EAAE,MAAM,gCAAgC,CAAA;AAC5E,OAAO,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAA;AACrE,OAAO,EAAE,4BAA4B,EAAE,MAAM,4BAA4B,CAAA;AACzE,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AAC3D,OAAO,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAA;AAC/E,OAAO,EACL,2BAA2B,EAC3B,0BAA0B,EAC1B,iBAAiB,EACjB,kBAAkB,EAClB,yBAAyB,EACzB,mBAAmB,GACpB,MAAM,kBAAkB,CAAA;AAEzB,MAAM,SAAS,GAAG,kCAAkC,CAAA;AACpD,MAAM,cAAc,GAAG,OAAO,CAAA;AAC9B,MAAM,YAAY,GAAG,8BAA8B,CAAA;AAEnD,MAAM,CAAC,MAAM,gBAAgB,GAC3B,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,cAAc,EAAE,EAAE;IACjC,IAAI,UAAU,CAAC,OAAO,KAAK,KAAK;QAAE,OAAO,cAAc,CAAA;IAEvD,MAAM,OAAO,GAAG,eAAe,CAAC,UAAU,CAAC,CAAA;IAC3C,yEAAyE;IACzE,6CAA6C;IAC7C,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,aAAa,CAAA;IACxD,MAAM,MAAM,GAAG,iBAAiB,CAAC,YAAY,EAAE,OAAO,CAAC,MAAM,IAAI,aAAa,CAAC,CAAA;IAC/E,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAA;IACxE,MAAM,eAAe,GAAG,OAAO,CAAC,eAAe,KAAK,KAAK,CAAA;IAEzD,MAAM,mBAAmB,GAAG,CAAC,cAAc,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE;QAChF,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC;YAAE,OAAO,UAAU,CAAA;QAE7D,OAAO;YACL,GAAG,UAAU;YACb,6DAA6D;YAC7D,oEAAoE;YACpE,+DAA+D;YAC/D,kEAAkE;YAClE,KAAK,EAAE;gBACL,GAAG,CAAC,UAAU,CAAC,KAAK,IAAI,EAAE,CAAC;gBAC3B,eAAe,EAAE;oBACf,GAAG,CAAC,UAAU,CAAC,KAAK,EAAE,eAAe,IAAI,EAAE,CAAC;oBAC5C,2BAA2B,EAAE;iBAC9B;gBACD,YAAY,EAAE;oBACZ,GAAG,CAAC,UAAU,CAAC,KAAK,EAAE,YAAY,IAAI,EAAE,CAAC;oBACzC,2BAA2B,EAAE;iBAC9B;gBACD,2DAA2D;gBAC3D,WAAW,EAAE;oBACX,GAAG,CAAC,UAAU,CAAC,KAAK,EAAE,WAAW,IAAI,EAAE,CAAC;oBACxC,4BAA4B,CAAC;wBAC3B,OAAO,EAAE,OAAO,CAAC,OAAO;wBACxB,qBAAqB,EAAE,iBAAiB,CAAC,OAAO,EAAE,UAAU,CAAC,IAAI,CAAC;6BAC/D,qBAAqB;qBACzB,CAAC;iBACH;aACF;YACD,GAAG,CAAC,eAAe;gBACjB,CAAC,CAAC;oBACE,KAAK,EAAE,iBAAiB,CAAC,UAAU,EAAE,WAAW,CAAC;oBACjD,MAAM,EAAE,mBAAmB,CACzB,UAAU,CAAC,MAAM,EACjB,iBAAiB,CAAC,OAAO,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,qBAAqB,EACjE,WAAW,CACZ;iBACF;gBACH,CAAC,CAAC,EAAE,CAAC;SACmB,CAAA;IAC9B,CAAC,CAAC,CAAA;IAEF;;;;;;;;;;;;MAYE;IACF,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,2BAA2B,EAAE,EAAE,UAAU,EAAE,YAAY,EAAE,CAAC,CAAA;IAEpF,OAAO;QACL,GAAG,cAAc;QACjB,WAAW,EAAE,mBAAmB;QAChC,SAAS,EAAE;YACT,GAAG,CAAC,cAAc,CAAC,SAAS,IAAI,EAAE,CAAC;YACnC,GAAG,oBAAoB,CAAC,EAAE,WAAW,EAAE,gBAAgB,EAAE,CAAC;SAC3D;QACD,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;YACxB,IAAI,cAAc,CAAC,MAAM,EAAE,CAAC;gBAC1B,MAAM,cAAc,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;YACtC,CAAC;YAED,MAAM,QAAQ,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAA;YAC3C,QAAQ,CAAC,iBAAiB,CAAC,WAAW,EAAE,SAAS,CAAC,CAAA;YAElD,MAAM,WAAW,GAAG,cAAc,CAAC,OAAO,CAAC,CAAA;YAE3C,mEAAmE;YACnE,kEAAkE;YAClE,MAAM,OAAO,GAAG,uBAAuB,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC,CAAA;YAClF,uBAAuB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;YAEzC,MAAM,KAAK,GAAG;gBACZ,iBAAiB,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC;gBAC7D,mBAAmB,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC;gBAC/D,yBAAyB,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;gBAC/C,0BAA0B,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;gBACzD,kBAAkB,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,CAAC;aACtD,CAAA;YAED;;;;;;;;;;;;cAYE;YACF,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC,KAAK,EAAE,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,CAAA;YAEtF,QAAQ,CAAC,QAAQ,CAAC;gBAChB,EAAE,EAAE,SAAS;gBACb,OAAO,EAAE,cAAc;gBACvB,YAAY,EAAE,CAAC,YAAY,EAAE,kBAAkB,CAAC;aACjD,CAAC,CAAA;YAEF,MAAM,CAAC,IAAI,CAAC,yBAAyB,EAAE;gBACrC,WAAW,EAAE,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;gBACnD,eAAe;aAChB,CAAC,CAAA;QACJ,CAAC;KACF,CAAA;AACH,CAAC,CAAA;AAEH;;;;;;;;;GASG;AACH,SAAS,iBAAiB,CACxB,UAA4B,EAC5B,WAAmB;IAEnB,MAAM,IAAI,GAAG,UAAU,CAAC,KAAK,EAAE,UAAU,EAAE,IAAI,IAAI,EAAE,CAAA;IAErD,OAAO;QACL,GAAG,CAAC,UAAU,CAAC,KAAK,IAAI,EAAE,CAAC;QAC3B,UAAU,EAAE;YACV,GAAG,CAAC,UAAU,CAAC,KAAK,EAAE,UAAU,IAAI,EAAE,CAAC;YACvC,IAAI,EAAE;gBACJ,GAAG,IAAI;gBACP,GAAG,CAAC,IAAI,CAAC,aAAa,KAAK,SAAS;oBAClC,CAAC,CAAC;wBACE,aAAa,EAAE;4BACb,IAAI,EAAE,YAAY;4BAClB,UAAU,EAAE,eAAe;4BAC3B,WAAW,EAAE,EAAE,WAAW,EAAE;yBAC7B;qBACF;oBACH,CAAC,CAAC,EAAE,CAAC;gBACP,GAAG,CAAC,IAAI,CAAC,eAAe,KAAK,SAAS;oBACpC,CAAC,CAAC;wBACE,eAAe,EAAE;4BACf,IAAI,EAAE,YAAY;4BAClB,UAAU,EAAE,iBAAiB;4BAC7B,WAAW,EAAE,EAAE,WAAW,EAAE;yBAC7B;qBACF;oBACH,CAAC,CAAC,EAAE,CAAC;aACR;SACF;KACF,CAAA;AACH,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,mBAAmB,CAC1B,MAAkC,EAClC,SAAiB,EACjB,WAAmB;IAEnB,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QAC1B,IAAI,CAAC,CAAC,MAAM,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM;YAAE,OAAO,KAAK,CAAA;QACzF,IAAI,KAAK,CAAC,KAAK,EAAE,UAAU,EAAE,KAAK,KAAK,SAAS;YAAE,OAAO,KAAK,CAAA;QAC9D,OAAO;YACL,GAAG,KAAK;YACR,KAAK,EAAE;gBACL,GAAG,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC;gBACtB,UAAU,EAAE;oBACV,GAAG,CAAC,KAAK,CAAC,KAAK,EAAE,UAAU,IAAI,EAAE,CAAC;oBAClC,KAAK,EAAE;wBACL,IAAI,EAAE,YAAY;wBAClB,UAAU,EAAE,sBAAsB;wBAClC,WAAW,EAAE,EAAE,WAAW,EAAE;qBAC7B;iBACF;aACF;SACF,CAAA;IACH,CAAC,CAAC,CAAA;AACJ,CAAC"}

package/dist/publishing/service.d.ts

@@ -0,0 +1,149 @@
+import type { Payload, TypedUser } from 'payload';
+import type { AuditWriter } from '../audit/writer.js';
+import type { AuthenticatedUser } from '../plugin-contract/mcp.js';
+import type { Logger } from '../plugin-contract/index.js';
+import { type PublishingPluginOptions } from './options.js';
+import type { PipelineIssue, PipelineMeta } from './pipeline/types.js';
+/**
+ * Who an action is attributed to, and whose permissions it runs under.
+ *
+ * `user` is what lands in the audit log. `enforceAccessAs` is separate
+ * because the MCP path authenticates an API key linked to a user (the key's
+ * own permissions govern) while the admin path runs as a real session (the
+ * editor's permissions govern).
+ */
+export interface PublishingActor {
+    /** The principal recorded as the audit actor. */
+    user?: AuthenticatedUser | null | undefined;
+    /** Name of the API key, when the call arrived over MCP. */
+    apiKeyName?: string | undefined;
+    /**
+     * When set, Payload reads and writes run as this user with
+     * `overrideAccess: false` so collection access control applies.
+     */
+    enforceAccessAs?: TypedUser | undefined;
+    /** Recorded on the audit event's `mcpTool` so channels are distinguishable. */
+    channel?: 'mcp' | 'admin' | undefined;
+}
+export interface PublishRequest {
+    collection: string;
+    id: string;
+    actor: PublishingActor;
+    meta?: PipelineMeta | undefined;
+}
+export interface PublishOutcome {
+    published: boolean;
+    publishedAt?: string;
+    failedAt?: string;
+    reason?: string;
+    code?: string;
+    issues?: PipelineIssue[];
+    suggestion?: string;
+    /**
+     * Non-fatal problems. The publish happened; something downstream of it
+     * did not. Present on a successful result.
+     */
+    warnings?: string[];
+}
+export interface UnpublishOutcome {
+    unpublished: boolean;
+    reason?: string;
+    warnings?: string[];
+}
+export interface ScheduleRequest extends PublishRequest {
+    /** ISO 8601. Must be in the future. */
+    publishAt: string;
+}
+export interface ScheduleOutcome {
+    scheduled: boolean;
+    /** The stored time, normalised to UTC ISO 8601. */
+    scheduledFor?: string;
+    failedAt?: string;
+    reason?: string;
+    code?: string;
+    issues?: PipelineIssue[];
+    suggestion?: string;
+    /**
+     * A check that could not pass *yet* but may by the scheduled time — an
+     * approval not granted, an embargo that ends first. The schedule stands; the
+     * check runs again when it fires.
+     */
+    warnings?: string[];
+}
+export interface UnscheduleOutcome {
+    unscheduled: boolean;
+    reason?: string;
+}
+export interface PublishStatusOutcome {
+    /** The document's current `_status`. */
+    status: string;
+    /** Whether every preflight check passes right now. */
+    publishable: boolean;
+    failedAt?: string;
+    reason?: string;
+    code?: string;
+    issues?: PipelineIssue[];
+    suggestion?: string;
+    /** Last successful publish, or `null` if never published. */
+    publishedAt: string | null;
+    hasUnpublishedChanges: boolean;
+}
+export interface PublishingService {
+    publish: (request: PublishRequest) => Promise<PublishOutcome>;
+    unpublish: (request: PublishRequest) => Promise<UnpublishOutcome>;
+    schedule: (request: ScheduleRequest) => Promise<ScheduleOutcome>;
+    unschedule: (request: PublishRequest) => Promise<UnscheduleOutcome>;
+    getStatus: (request: PublishRequest) => Promise<PublishStatusOutcome>;
+}
+export interface CreatePublishingServiceDeps {
+    payload: Payload;
+    options: PublishingPluginOptions;
+    auditWriter: AuditWriter;
+    logger?: Logger | undefined;
+}
+/**
+ * The single implementation of publish / unpublish / status. Both the MCP
+ * tools and the admin endpoints call through here, so the two channels
+ * cannot drift: same pipeline, same audit shape, same trust boundary.
+ */
+export declare function createPublishingService(deps: CreatePublishingServiceDeps): PublishingService;
+/** Attaches the service to the Payload instance so host code can find it. */
+export declare function attachPublishingService(payload: object, service: PublishingService): void;
+/**
+ * Returns the publishing service attached to this Payload instance.
+ *
+ * Use this (or the `publishDocument` / `unpublishDocument` /
+ * `getPublishStatus` helpers below) from host code — a custom endpoint, a
+ * job, a Server Action — to publish through the full policy pipeline as a
+ * given user. No API key, and the audit event records that user.
+ */
+export declare function getPublishingService(payload: object): PublishingService;
+export interface DocumentActionArgs {
+    payload: Payload;
+    collection: string;
+    id: string;
+    /** The person the action is attributed to and whose permissions apply. */
+    user: TypedUser;
+    meta?: PipelineMeta | undefined;
+}
+/**
+ * Publishes a document through the full pipeline as `user`. Rejects if that
+ * user lacks update access on the collection.
+ */
+export declare function publishDocument(args: DocumentActionArgs): Promise<PublishOutcome>;
+/** Reverts a published document to draft as `user`. */
+export declare function unpublishDocument(args: DocumentActionArgs): Promise<UnpublishOutcome>;
+/** Schedules a document to publish at `publishAt`, as `user`. */
+export declare function scheduleDocument(args: DocumentActionArgs & {
+    publishAt: string;
+}): Promise<ScheduleOutcome>;
+/** Cancels a document's scheduled publish, as `user`. */
+export declare function unscheduleDocument(args: DocumentActionArgs): Promise<UnscheduleOutcome>;
+/**
+ * Runs every check except the write and reports whether the document would
+ * publish. Mutates nothing.
+ */
+export declare function getPublishStatus(args: DocumentActionArgs): Promise<PublishStatusOutcome>;
+/** Narrows a Payload user document to the audit-log actor shape. */
+export declare function toAuthenticatedUser(user: TypedUser | null): AuthenticatedUser | null;
+//# sourceMappingURL=service.d.ts.map

package/dist/publishing/service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../src/publishing/service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA;AACjD,OAAO,KAAK,EAAc,WAAW,EAAE,MAAM,oBAAoB,CAAA;AACjE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAA;AAClE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,6BAA6B,CAAA;AAEzD,OAAO,EAAE,KAAK,uBAAuB,EAAqB,MAAM,cAAc,CAAA;AAE9E,OAAO,KAAK,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAA;AAItE;;;;;;;GAOG;AACH,MAAM,WAAW,eAAe;IAC9B,iDAAiD;IACjD,IAAI,CAAC,EAAE,iBAAiB,GAAG,IAAI,GAAG,SAAS,CAAA;IAC3C,2DAA2D;IAC3D,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B;;;OAGG;IACH,eAAe,CAAC,EAAE,SAAS,GAAG,SAAS,CAAA;IACvC,+EAA+E;IAC/E,OAAO,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,SAAS,CAAA;CACtC;AAED,MAAM,WAAW,cAAc;IAC7B,UAAU,EAAE,MAAM,CAAA;IAClB,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,eAAe,CAAA;IACtB,IAAI,CAAC,EAAE,YAAY,GAAG,SAAS,CAAA;CAChC;AAED,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,OAAO,CAAA;IAClB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,aAAa,EAAE,CAAA;IACxB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;CACpB;AAED,MAAM,WAAW,gBAAgB;IAC/B,WAAW,EAAE,OAAO,CAAA;IACpB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;CACpB;AAED,MAAM,WAAW,eAAgB,SAAQ,cAAc;IACrD,uCAAuC;IACvC,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,eAAe;IAC9B,SAAS,EAAE,OAAO,CAAA;IAClB,mDAAmD;IACnD,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,aAAa,EAAE,CAAA;IACxB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;CACpB;AAED,MAAM,WAAW,iBAAiB;IAChC,WAAW,EAAE,OAAO,CAAA;IACpB,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,oBAAoB;IACnC,wCAAwC;IACxC,MAAM,EAAE,MAAM,CAAA;IACd,sDAAsD;IACtD,WAAW,EAAE,OAAO,CAAA;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,aAAa,EAAE,CAAA;IACxB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,6DAA6D;IAC7D,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,qBAAqB,EAAE,OAAO,CAAA;CAC/B;AAED,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,OAAO,CAAC,cAAc,CAAC,CAAA;IAC7D,SAAS,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,OAAO,CAAC,gBAAgB,CAAC,CAAA;IACjE,QAAQ,EAAE,CAAC,OAAO,EAAE,eAAe,KAAK,OAAO,CAAC,eAAe,CAAC,CAAA;IAChE,UAAU,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,OAAO,CAAC,iBAAiB,CAAC,CAAA;IACnE,SAAS,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,OAAO,CAAC,oBAAoB,CAAC,CAAA;CACtE;AAED,MAAM,WAAW,2BAA2B;IAC1C,OAAO,EAAE,OAAO,CAAA;IAChB,OAAO,EAAE,uBAAuB,CAAA;IAChC,WAAW,EAAE,WAAW,CAAA;IACxB,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAC5B;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CACrC,IAAI,EAAE,2BAA2B,GAChC,iBAAiB,CAmXnB;AA4FD,6EAA6E;AAC7E,wBAAgB,uBAAuB,CACrC,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,iBAAiB,GACzB,IAAI,CAON;AAED;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,iBAAiB,CAQvE;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,OAAO,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;IAClB,EAAE,EAAE,MAAM,CAAA;IACV,0EAA0E;IAC1E,IAAI,EAAE,SAAS,CAAA;IACf,IAAI,CAAC,EAAE,YAAY,GAAG,SAAS,CAAA;CAChC;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,cAAc,CAAC,CAEjF;AAED,uDAAuD;AACvD,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAErF;AAED,iEAAiE;AACjE,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,kBAAkB,GAAG;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE,GAC/C,OAAO,CAAC,eAAe,CAAC,CAE1B;AAED,yDAAyD;AACzD,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAEvF;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,kBAAkB,GACvB,OAAO,CAAC,oBAAoB,CAAC,CAE/B;AAeD,oEAAoE;AACpE,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,SAAS,GAAG,IAAI,GAAG,iBAAiB,GAAG,IAAI,CAUpF"}