@crvouga/mockingbird-service-payload-cms 1.8.0 → 2.1.0

package/dist/cli.js

@@ -3,8 +3,8 @@ import {
   runCli,
   serveCommand,
   serveTarget
-} from "./chunk-FBRZZAKE.js";
-import "./chunk-COTVMNU6.js";
+} from "./chunk-2JAJSWIZ.js";
+import "./chunk-TR5SV7HY.js";
 
 // src/cli.ts
 var code = await runCli(

package/dist/index.d.ts

@@ -893,6 +893,7 @@ type PayloadCmsRuntimeOptions = {
     sqlite?: SqliteClient;
     clock?: Clock;
     seed?: number | string;
+    adminPrefix?: string;
     adminKey?: string;
     onLog?: (entry: RequestLog) => void;
     /** Collections every namespace starts with. Default: the marketing collection seed. */
@@ -900,8 +901,8 @@ type PayloadCmsRuntimeOptions = {
 };
 type PayloadCmsRuntime = ServiceRuntime<PayloadCmsAPI>;
 /**
- * The Payload CMS mock with Mockingbird's full service contract: `/health`, `/__admin/*`,
- * namespaces by header, by `/ns/<name>` path prefix (on `PAYLOAD_CMS_API_URL`), or by API key
+ * The Payload CMS mock with Mockingbird's full service contract: `/__admin/health`, `/__admin/*`,
+ * namespaces by header, by `/__admin/ns/<name>` path prefix (on `PAYLOAD_CMS_API_URL`), or by API key
  * / bearer token, clock control, fault presets and a request journal.
  */
 declare const createRuntime: (options?: PayloadCmsRuntimeOptions) => PayloadCmsRuntime;
@@ -916,7 +917,7 @@ declare const payloadError: (status: number, message: string) => Response;
 /**
  * The credential a request carries: an API key (`Authorization: <collection> API-Key <key>`)
  * or a bearer JWT. Our backend sends none (the marketing collection is public), so namespaces
- * usually come from the header or the `/ns/<name>` prefix on `PAYLOAD_CMS_API_URL`.
+ * usually come from the header or the `/__admin/ns/<name>` prefix on `PAYLOAD_CMS_API_URL`.
  */
 declare const payloadCredential: (request: Request) => string | undefined;
 /** A compiled `where`: a predicate, or the path Payload refuses to query. */

package/dist/index.js

@@ -11,7 +11,7 @@ import {
   payloadCredential,
   payloadError,
   supportedOperationIds
-} from "./chunk-COTVMNU6.js";
+} from "./chunk-TR5SV7HY.js";
 export {
   DEFAULT_MARKETING_DOCS,
   MARKETING_FIELDS,

package/dist/server.d.ts

@@ -593,6 +593,7 @@ type CliOption = {
 };
 type CliValues = Record<string, string | boolean | undefined>;
 type CommonServeOptions = {
+    adminPrefix?: string;
     adminKey: string | undefined;
     seed: string | undefined;
     onLog: ((entry: RequestLog$1) => void) | undefined;
@@ -1339,6 +1340,7 @@ type PayloadCmsRuntimeOptions = {
     sqlite?: SqliteClient;
     clock?: Clock;
     seed?: number | string;
+    adminPrefix?: string;
     adminKey?: string;
     onLog?: (entry: RequestLog) => void;
     /** Collections every namespace starts with. Default: the marketing collection seed. */

package/dist/server.js

@@ -2,8 +2,8 @@ import {
   DEFAULT_PORT,
   createServer,
   serveTarget
-} from "./chunk-FBRZZAKE.js";
-import "./chunk-COTVMNU6.js";
+} from "./chunk-2JAJSWIZ.js";
+import "./chunk-TR5SV7HY.js";
 export {
   DEFAULT_PORT,
   createServer,

package/openapi.yaml

@@ -0,0 +1,206 @@
+openapi: 3.1.0
+info:
+  title: Payload CMS REST API (Mockingbird subset)
+  description: |
+    Stateful mock subset of Payload CMS's auto-generated collection REST API: find documents
+    (with a `where` query subset, `limit`, `page`, `sort`) and find one by id. Hand-authored
+    from Payload's REST API docs and the consumer's response type (payload-cms-response.type.ts).
+  version: "2"
+  x-mockingbird-upstream:
+    note: >-
+      Shapes from https://payloadcms.com/docs/rest-api/overview and
+      https://payloadcms.com/docs/queries/overview; the consumer is
+      apps/backend/src/modules/cms/payload-cms/payload-cms.service.ts.
+servers:
+  - url: https://payload.acme.example
+paths:
+  /api/{collection}:
+    parameters:
+      - name: collection
+        in: path
+        required: true
+        schema:
+          type: string
+          enum: [marketing]
+    get:
+      operationId: FindDocuments
+      description: >-
+        Paginated find. `where[<field>][<operator>]=<value>` supports equals, not_equals, in,
+        not_in, exists, greater_than(_equal), less_than(_equal), like, contains, and nested
+        `where[and|or][<i>]…`. Only the consumer's filters are declared here for parity walks.
+      x-mockingbird:
+        supported: true
+        parity:
+          enabled: true
+          safe: true
+      parameters:
+        - name: where[type][equals]
+          in: query
+          required: false
+          schema:
+            type: string
+            enum: [referral, banner, email]
+        - name: where[isActive][equals]
+          in: query
+          required: false
+          schema:
+            type: string
+            enum: ["true", "false"]
+        - name: limit
+          in: query
+          required: false
+          schema:
+            type: integer
+            minimum: 0
+            maximum: 100
+        - name: page
+          in: query
+          required: false
+          schema:
+            type: integer
+            minimum: 1
+            maximum: 20
+        - name: sort
+          in: query
+          required: false
+          schema:
+            type: string
+            enum: [createdAt, -createdAt, name, -name, id, -id]
+      responses:
+        "200":
+          description: A page of documents
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/PaginatedDocs"
+        "400":
+          description: Invalid query
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Errors"
+        "404":
+          description: Unknown collection
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Errors"
+  /api/{collection}/{id}:
+    parameters:
+      - name: collection
+        in: path
+        required: true
+        schema:
+          type: string
+          enum: [marketing]
+      - name: id
+        in: path
+        required: true
+        schema:
+          type: string
+          description: The seeded documents are 1-3; anything else is a 404.
+          pattern: "^[1-5]$"
+    get:
+      operationId: FindDocumentById
+      x-mockingbird:
+        supported: true
+        parity:
+          enabled: true
+          safe: true
+      responses:
+        "200":
+          description: The document
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/MarketingDoc"
+        "404":
+          description: Unknown document or collection
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Errors"
+components:
+  schemas:
+    MarketingDoc:
+      type: object
+      required: [id, name, type, createdAt, updatedAt]
+      properties:
+        id:
+          type: integer
+          description: Integer ids, as Payload's Postgres adapter issues them (the consumer types `id` as a number).
+        name:
+          type: string
+        type:
+          type: string
+          enum: [referral, banner, email]
+        isActive:
+          type: boolean
+        cardTitle:
+          type: ["string", "null"]
+        cardSubtitle:
+          type: ["string", "null"]
+        cardDescription:
+          type: ["string", "null"]
+        ctaTitle:
+          type: ["string", "null"]
+        ctaActionText:
+          type: ["string", "null"]
+        shareMessage:
+          type: ["string", "null"]
+        createdAt:
+          type: string
+          x-mockingbird-volatile:
+            kind: timestamp
+        updatedAt:
+          type: string
+          x-mockingbird-volatile:
+            kind: timestamp
+    PaginatedDocs:
+      type: object
+      required:
+        - docs
+        - totalDocs
+        - limit
+        - totalPages
+        - page
+        - pagingCounter
+        - hasPrevPage
+        - hasNextPage
+        - prevPage
+        - nextPage
+      properties:
+        docs:
+          type: array
+          items:
+            $ref: "#/components/schemas/MarketingDoc"
+        totalDocs:
+          type: integer
+        limit:
+          type: integer
+        totalPages:
+          type: integer
+        page:
+          type: integer
+        pagingCounter:
+          type: integer
+        hasPrevPage:
+          type: boolean
+        hasNextPage:
+          type: boolean
+        prevPage:
+          type: ["integer", "null"]
+        nextPage:
+          type: ["integer", "null"]
+    Errors:
+      type: object
+      required: [errors]
+      properties:
+        errors:
+          type: array
+          items:
+            type: object
+            required: [message]
+            properties:
+              message:
+                type: string

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crvouga/mockingbird-service-payload-cms",
-  "version": "1.8.0",
+  "version": "2.1.0",
   "description": "Stateful mock of the Payload CMS collection REST API: paginated finds with a where-query subset, find by id, a seeded marketing collection and admin-editable documents.",
   "license": "MIT",
   "type": "module",
@@ -8,7 +8,10 @@
   "files": [
     "dist",
     "README.md",
-    "CHANGELOG.md"
+    "CHANGELOG.md",
+    "DISCOVERY.md",
+    "SUPPORT.md",
+    "openapi.yaml"
   ],
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -56,7 +59,29 @@
       "docs": "https://payloadcms.com/docs/rest-api/overview"
     },
     "parity": "Collection REST",
-    "parityTier": "cold"
+    "parityTier": "cold",
+    "discovery": {
+      "guide": "DISCOVERY.md",
+      "behavior": "README.md",
+      "capabilities": "SUPPORT.md",
+      "contract": "openapi.yaml",
+      "types": "dist/index.d.ts",
+      "oracle": {
+        "kind": "Live vendor API or sandbox",
+        "command": "bun run parity:service -- payload-cms",
+        "note": "Run from a Mockingbird checkout; credentials come only from .env.local or GitHub Actions secrets. Missing credentials exit 2."
+      },
+      "introspection": [
+        "GET /__admin/health",
+        "GET /__admin",
+        "GET /__admin/state",
+        "GET /__admin/requests",
+        "GET /__admin/metrics",
+        "GET /__admin/faults/presets",
+        "GET /__admin/ui"
+      ],
+      "reporting": "https://github.com/crvouga/mockingbird/blob/main/docs/REPORTING_ISSUES.md"
+    }
   },
   "scripts": {
     "generate": "bun ../../openapi/codegen/dist/cli.js",
@@ -71,7 +96,7 @@
     "pack:check": "bun ../../../scripts/pack-check.ts"
   },
   "dependencies": {
-    "@crvouga/mockingbird-service-sqlite": "1.3.0",
+    "@crvouga/mockingbird-service-sqlite": "2.1.0",
     "hono": "4.11.9"
   },
   "devDependencies": {