@forumone/throughline-publishing 0.2.0 → 0.2.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @forumone/throughline-publishing
 
+## 0.2.1
+
+### Patch Changes
+
+- 3ef6f6a: The pipeline's `approvalStep` now falls back to looking up an approval resolver on the Payload instance under `Symbol.for('@forumone/throughline/approvals-resolver')` when no resolver is supplied via `publishingPlugin`'s `options.approvalResolver`. The `@forumone/throughline-approvals` plugin attaches its resolver under that symbol automatically, so adding approvals to a config no longer requires re-wiring the publishing plugin's options. An explicit `options.approvalResolver` still takes precedence when you need to override.
+
 ## 0.2.0
 
 ### Minor Changes

package/dist/pipeline/steps/approval.d.ts

@@ -1,11 +1,21 @@
 import type { PipelineStep } from '../types.js';
+/**
+ * Symbol the approvals plugin attaches its resolver under. Publishing's
+ * approval step looks here when no resolver is supplied via options, which
+ * lets clients add the approvals plugin without re-wiring publishing's
+ * config. Keep in sync with the matching constant in the approvals package.
+ */
+export declare const APPROVALS_RESOLVER_SYMBOL: unique symbol;
 /**
  * Gates publish on a granted approval when the document's policy demands
- * one. Fails closed: if `policy.requiresApproval` is true but no
- * `approvalResolver` is configured, the step fails rather than silently
- * letting the publish proceed without approval. The Approvals Server
- * (C7) provides the resolver implementation; until it ships, clients
- * who want approvals must wire their own.
+ * one. Fails closed: if `policy.requiresApproval` is true but no resolver
+ * is available (neither in options nor attached via the approvals plugin),
+ * the step blocks the publish.
+ *
+ * Resolution order:
+ *   1. `options.approvalResolver` (explicit wiring)
+ *   2. The resolver attached on the Payload instance via
+ *      `APPROVALS_RESOLVER_SYMBOL` by the approvals plugin
  */
 export declare const approvalStep: PipelineStep;
 //# sourceMappingURL=approval.d.ts.map

package/dist/pipeline/steps/approval.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"approval.d.ts","sourceRoot":"","sources":["../../../src/pipeline/steps/approval.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAE/C;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,EAAE,YAmC1B,CAAA"}
+{"version":3,"file":"approval.d.ts","sourceRoot":"","sources":["../../../src/pipeline/steps/approval.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAE/C;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB,eAErC,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,YAAY,EAAE,YAoC1B,CAAA"}

package/dist/pipeline/steps/approval.js

@@ -1,25 +1,36 @@
+/**
+ * Symbol the approvals plugin attaches its resolver under. Publishing's
+ * approval step looks here when no resolver is supplied via options, which
+ * lets clients add the approvals plugin without re-wiring publishing's
+ * config. Keep in sync with the matching constant in the approvals package.
+ */
+export const APPROVALS_RESOLVER_SYMBOL = Symbol.for('@forumone/throughline/approvals-resolver');
 /**
  * Gates publish on a granted approval when the document's policy demands
- * one. Fails closed: if `policy.requiresApproval` is true but no
- * `approvalResolver` is configured, the step fails rather than silently
- * letting the publish proceed without approval. The Approvals Server
- * (C7) provides the resolver implementation; until it ships, clients
- * who want approvals must wire their own.
+ * one. Fails closed: if `policy.requiresApproval` is true but no resolver
+ * is available (neither in options nor attached via the approvals plugin),
+ * the step blocks the publish.
+ *
+ * Resolution order:
+ *   1. `options.approvalResolver` (explicit wiring)
+ *   2. The resolver attached on the Payload instance via
+ *      `APPROVALS_RESOLVER_SYMBOL` by the approvals plugin
  */
 export const approvalStep = async (ctx) => {
     const policy = ctx.document[ctx.collection.policyField];
     if (!policy?.['requiresApproval'])
         return { pass: true };
-    if (!ctx.options.approvalResolver) {
+    const resolver = ctx.options.approvalResolver ?? lookupResolverOnPayload(ctx.payload);
+    if (!resolver) {
         return {
             pass: false,
             code: 'approval-resolver-missing',
             reason: 'Document requires approval but no approval resolver is configured',
-            suggestion: 'Add the approvalsPlugin to your Payload config and pass its resolver to publishingPlugin.approvalResolver.',
+            suggestion: 'Register approvalsPlugin in your Payload config (it attaches the resolver automatically) or pass an explicit `approvalResolver` to publishingPlugin.',
         };
     }
     const versionId = String(ctx.document['updatedAt'] ?? ctx.documentId);
-    const approval = await ctx.options.approvalResolver.getActiveApproval(ctx.collection.slug, ctx.documentId, versionId);
+    const approval = await resolver.getActiveApproval(ctx.collection.slug, ctx.documentId, versionId);
     if (!approval) {
         return {
             pass: false,
@@ -30,4 +41,8 @@ export const approvalStep = async (ctx) => {
     }
     return { pass: true };
 };
+function lookupResolverOnPayload(payload) {
+    const value = payload[APPROVALS_RESOLVER_SYMBOL];
+    return typeof value === 'object' && value !== null ? value : undefined;
+}
 //# sourceMappingURL=approval.js.map

package/dist/pipeline/steps/approval.js.map

@@ -1 +1 @@
-{"version":3,"file":"approval.js","sourceRoot":"","sources":["../../../src/pipeline/steps/approval.ts"],"names":[],"mappings":"AAEA;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,YAAY,GAAiB,KAAK,EAAE,GAAG,EAAE,EAAE;IACtD,MAAM,MAAM,GAAG,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,WAAW,CAEzC,CAAA;IACb,IAAI,CAAC,MAAM,EAAE,CAAC,kBAAkB,CAAC;QAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,CAAA;IAExD,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC;QAClC,OAAO;YACL,IAAI,EAAE,KAAK;YACX,IAAI,EAAE,2BAA2B;YACjC,MAAM,EAAE,mEAAmE;YAC3E,UAAU,EACR,4GAA4G;SAC/G,CAAA;IACH,CAAC;IAED,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,CAAA;IACrE,MAAM,QAAQ,GAAG,MAAM,GAAG,CAAC,OAAO,CAAC,gBAAgB,CAAC,iBAAiB,CACnE,GAAG,CAAC,UAAU,CAAC,IAAI,EACnB,GAAG,CAAC,UAAU,EACd,SAAS,CACV,CAAA;IAED,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO;YACL,IAAI,EAAE,KAAK;YACX,IAAI,EAAE,mBAAmB;YACzB,MAAM,EACJ,wFAAwF;YAC1F,UAAU,EACR,mFAAmF;SACtF,CAAA;IACH,CAAC;IAED,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,CAAA;AACvB,CAAC,CAAA"}
+{"version":3,"file":"approval.js","sourceRoot":"","sources":["../../../src/pipeline/steps/approval.ts"],"names":[],"mappings":"AAGA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,MAAM,CAAC,GAAG,CACjD,0CAA0C,CAC3C,CAAA;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,YAAY,GAAiB,KAAK,EAAE,GAAG,EAAE,EAAE;IACtD,MAAM,MAAM,GAAG,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,WAAW,CAEzC,CAAA;IACb,IAAI,CAAC,MAAM,EAAE,CAAC,kBAAkB,CAAC;QAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,CAAA;IAExD,MAAM,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC,gBAAgB,IAAI,uBAAuB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;IACrF,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO;YACL,IAAI,EAAE,KAAK;YACX,IAAI,EAAE,2BAA2B;YACjC,MAAM,EAAE,mEAAmE;YAC3E,UAAU,EACR,sJAAsJ;SACzJ,CAAA;IACH,CAAC;IAED,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,CAAA;IACrE,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,iBAAiB,CAC/C,GAAG,CAAC,UAAU,CAAC,IAAI,EACnB,GAAG,CAAC,UAAU,EACd,SAAS,CACV,CAAA;IAED,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO;YACL,IAAI,EAAE,KAAK;YACX,IAAI,EAAE,mBAAmB;YACzB,MAAM,EACJ,wFAAwF;YAC1F,UAAU,EACR,mFAAmF;SACtF,CAAA;IACH,CAAC;IAED,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,CAAA;AACvB,CAAC,CAAA;AAED,SAAS,uBAAuB,CAAC,OAAe;IAC9C,MAAM,KAAK,GAAI,OAAmC,CAAC,yBAAyB,CAAC,CAAA;IAC7E,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,CAAC,CAAC,CAAE,KAA0B,CAAC,CAAC,CAAC,SAAS,CAAA;AAC9F,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forumone/throughline-publishing",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Policy-gated publishing server for Throughline. Wraps Payload's update operation with composition, accessibility, required-field, embargo, and approval gating.",
   "type": "module",
   "main": "./dist/index.js",