@valkyrianlabs/payload-markdown-docs 0.2.1 → 0.3.1

package/README.md

@@ -1,41 +1,44 @@
 # @valkyrianlabs/payload-markdown-docs
 
-Git-backed Markdown documentation sync for Payload CMS, powered by `@valkyrianlabs/payload-markdown`.
+Git-backed Markdown documentation sync for Payload CMS, powered by
+`@valkyrianlabs/payload-markdown`.
 
-`payload-markdown-docs` lets developers and agents maintain Markdown in a repo-local `docs/` folder, validate it in CI, sign a manifest, and publish it into server-owned Payload docs sets.
+This package has two sides:
 
-The client sends docs content. The Payload plugin decides where it may go.
+- The docs repo keeps Markdown files in source control and uses the CLI to
+  validate, plan, and push them.
+- The Payload server installs the plugin, verifies signed or GitHub OIDC
+  requests, and writes generated docs records into Payload-owned collections.
 
-## Current Status
+The sync endpoint is not the human docs route. If your Payload site is deployed
+at `https://docs.valkyrianlabs.com`, the default sync endpoint is:
 
-Implemented:
-
-- docs groups and docs sets as the user-facing model
-- generated/internal docs records linked to docs sets
-- route reservations and optional docs-side Pages collision checks
-- signed sync endpoint with nonce replay protection
-- CLI commands for `validate`, `manifest`, `plan`, `keygen`, and signed `push`
-- dedicated docs create/update/archive/draft/delete lifecycle behind server gates
-- publishing controls for draft-enabled dedicated docs collections
-- read-only `/next` route adapter, sidebar helper, metadata helper, and page component
-- read-only Docs Set Admin Manager
-- local agent skill installer
-- GitHub Actions OIDC auth mode
-- real `/docs` dogfood documentation set
+```text
+https://docs.valkyrianlabs.com/api/payload-markdown-docs/sync
+```
 
-Not implemented yet:
+The human docs route is whatever docs set route base you configure, for example:
 
-- existing collection targets
-- block targets
-- inline override editing from the docs set manager
+```text
+https://docs.valkyrianlabs.com/plugins/payload-markdown-docs
+```
 
 ## Install
 
+Install this package in the Payload app that will receive and render docs:
+
 ```bash
 pnpm add @valkyrianlabs/payload-markdown-docs @valkyrianlabs/payload-markdown
 ```
 
-## Minimal Config
+Install the same package in any repo whose CI will run the
+`payload-markdown-docs` CLI.
+
+## 1. Configure The Payload Server
+
+Add the plugin to `payload.config.ts`. Keep source authorization in Payload
+Admin docs sets; the plugin config should define the endpoint, collections, and
+sync lifecycle behavior.
 
 ```ts
 import { payloadMarkdownDocs } from '@valkyrianlabs/payload-markdown-docs'
@@ -45,151 +48,235 @@ export default buildConfig({
   plugins: [
     payloadMarkdownDocs({
       enabled: true,
+
+      // Optional default OIDC audience. Repository/workflow/environment
+      // allowlists belong on the docs set in Payload Admin.
+      auth: {
+        githubOidc: {
+          audience: 'payload-markdown-docs',
+        },
+      },
+
+      target: {
+        type: 'docsCollection',
+        enableDrafts: true,
+      },
+
+      sync: {
+        allowWrites: true,
+        allowPublish: true,
+        allowHardDelete: false,
+        defaultPublishMode: 'draft',
+        deleteBehavior: 'archive',
+      },
     }),
   ],
 })
 ```
 
-## Dedicated Docs Config
+What this does:
+
+- Adds docs groups, docs sets, generated docs, sync run, and nonce collections.
+- Registers the default Payload custom endpoint at
+  `/api/payload-markdown-docs/sync`.
+- Accepts Ed25519 signed requests or GitHub OIDC bearer requests on the same
+  endpoint when the matched docs set has those auth policies.
+- Uses docs sets in Payload Admin as the source allow-list. `sources` still
+  exists as a legacy fallback, but it is not the recommended path.
+- Allows sync writes and publish requests, while archiving removed docs instead
+  of hard-deleting them.
+
+If you configure `allowedRefs` on a docs set, remember release workflows run on
+tag refs like `refs/tags/v0.1.0-canary.1`. The first pass uses exact string
+matches, not glob patterns. For release publishing, constrain by repository and
+workflow unless you want to list exact tag refs.
+
+## 2. Create The Docs Set
+
+In Payload Admin, create a docs set with values that match the CLI and server
+config:
+
+- `sourceId`: `payload-markdown-docs`
+- `sourceRoot`: `docs`
+- `routeBase`: `/plugins/payload-markdown-docs`
+- `title`: Payload Markdown Docs
+- `auth.githubOidc.enabled`: checked
+- `auth.githubOidc.allowedRepositories`: `valkyrianlabs/payload-markdown-docs`
+- optionally restrict `auth.githubOidc.allowedWorkflows`,
+  `auth.githubOidc.allowedEnvironments`, or exact `auth.githubOidc.allowedRefs`
+- optionally add `auth.ed25519.keys` with `keyId` and `publicKey` for local
+  machines or non-GitHub CI
+
+The CLI sends `source.id`. The server uses that id to find the docs set and
+decide where generated routes live and which credentials may update it. You can
+add a new docs source by creating a new docs set in Payload Admin; you should
+not need to redeploy the Payload app just to add another docs package.
+
+## 3. Render Docs In Next
+
+The plugin writes docs records. Your Next route renders them.
+
+```tsx
+import config from '@payload-config'
+import {
+  PayloadMarkdownDocsPage,
+  resolvePayloadMarkdownDocsRoute,
+} from '@valkyrianlabs/payload-markdown-docs/next'
+import { notFound } from 'next/navigation'
+import { getPayload } from 'payload'
+
+export default async function Page({
+  params,
+}: {
+  params: Promise<{ slug?: string[] }>
+}) {
+  const { slug } = await params
+  const payload = await getPayload({ config })
+  const resolved = await resolvePayloadMarkdownDocsRoute({ payload, slug })
+
+  if (resolved) {
+    return <PayloadMarkdownDocsPage resolved={resolved} />
+  }
+
+  notFound()
+}
+```
 
-```ts
-payloadMarkdownDocs({
-  enabled: true,
-
-  auth: {
-    mode: 'ed25519',
-    keys: [
-      {
-        id: 'github-actions-main',
-        publicKey: process.env.DOCS_SYNC_PUBLIC_KEY!,
-      },
-    ],
-  },
-
-  target: {
-    type: 'docsCollection',
-    enableDrafts: true,
-  },
-
-  sources: [
-    {
-      id: 'main-docs',
-      root: 'docs',
-      routeBase: '/docs',
-    },
-  ],
+In a real app, fall back to your normal Pages lookup instead of calling
+`notFound()` immediately.
 
-  sync: {
-    allowWrites: true,
-    allowPublish: true,
-    allowHardDelete: false,
-    defaultPublishMode: 'draft',
-    deleteBehavior: 'archive',
-  },
-})
+## 4. Add Docs Source Files
+
+Keep docs in `docs/` and commit the AI Markdown Export manifest next to them.
+The manifest controls the generated raw Markdown export; it is not a human docs
+page and should not appear in human navigation.
+
+```text
+docs/
+  index.md
+  install.md
+  usage.md
+  index.ai.yml
 ```
 
-GitHub Actions can use OIDC instead of a long-lived private key:
+Example `docs/index.ai.yml`:
 
-```ts
-payloadMarkdownDocs({
-  enabled: true,
-
-  auth: {
-    mode: 'github-oidc',
-    audience: 'payload-markdown-docs',
-    allowedRepositories: ['valkyrianlabs/payload-markdown-docs'],
-    allowedRefs: ['refs/heads/main'],
-  },
-
-  target: {
-    type: 'docsCollection',
-    enableDrafts: true,
-  },
-
-  sync: {
-    allowWrites: true,
-    allowPublish: true,
-  },
-})
+```yaml
+version: 1
+
+title: Payload Markdown Docs
+canonical: /plugins/payload-markdown-docs
+output: /plugins/payload-markdown-docs.md
+
+description: >
+  Consolidated AI-facing documentation export for Payload Markdown Docs.
+
+preamble: |
+  This file is intended for AI agents, editor tooling, Codex, ChatGPT,
+  and offline reference.
+
+order:
+  - ./index.md
+  - ./install.md
+  - ./usage.md
+
+exclude:
+  - ./drafts/**
+
+orphans: append
+headingMode: normalize
 ```
 
-## Quick Commands
+## 5. Validate Locally
+
+Validation does not contact the server:
 
 ```bash
-pnpm exec payload-markdown-docs keygen --out .docs-sync
-pnpm exec payload-markdown-docs validate ./docs --source main-docs
-pnpm exec payload-markdown-docs manifest ./docs --source main-docs --pretty
-pnpm exec payload-markdown-docs plan ./docs --source main-docs
-pnpm exec payload-markdown-docs install skill --codex
+pnpm exec payload-markdown-docs validate ./docs \
+  --source payload-markdown-docs \
+  --route-base /plugins/payload-markdown-docs
 ```
 
-Signed dry-run:
+Preview the manifest or plan:
 
 ```bash
-pnpm exec payload-markdown-docs push ./docs \
-  --endpoint "$DOCS_SYNC_ENDPOINT" \
-  --source main-docs \
-  --key-id github-actions-main \
-  --private-key-file .docs-sync/docs-sync-private.pem \
-  --dry-run
+pnpm exec payload-markdown-docs manifest ./docs \
+  --source payload-markdown-docs \
+  --route-base /plugins/payload-markdown-docs \
+  --pretty
+```
+
+```bash
+pnpm exec payload-markdown-docs plan ./docs \
+  --source payload-markdown-docs \
+  --route-base /plugins/payload-markdown-docs
+```
+
+## 6. Publish From GitHub Actions
+
+GitHub OIDC only works inside GitHub Actions. The workflow needs:
+
+```yaml
+permissions:
+  contents: read
+  id-token: write
 ```
 
-Signed sync and publish:
+Then push docs to the Payload sync endpoint:
 
 ```bash
 pnpm exec payload-markdown-docs push ./docs \
-  --endpoint "$DOCS_SYNC_ENDPOINT" \
-  --source main-docs \
-  --key-id github-actions-main \
-  --private-key-env DOCS_SYNC_PRIVATE_KEY \
+  --endpoint "https://docs.valkyrianlabs.com/api/payload-markdown-docs/sync" \
+  --source payload-markdown-docs \
+  --route-base /plugins/payload-markdown-docs \
+  --repository "$GITHUB_REPOSITORY" \
+  --branch "$GITHUB_REF_NAME" \
+  --commit "$GITHUB_SHA" \
+  --github-oidc \
+  --oidc-audience payload-markdown-docs \
   --sync \
   --publish
 ```
 
-GitHub OIDC sync from Actions:
+`--sync` only works when the server has `sync.allowWrites: true`.
+`--publish` also requires `sync.allowPublish: true` and
+`target.enableDrafts: true`.
+
+For non-GitHub CI, use Ed25519 keys instead of OIDC:
 
 ```bash
+pnpm exec payload-markdown-docs keygen --out .docs-sync
 pnpm exec payload-markdown-docs push ./docs \
   --endpoint "$DOCS_SYNC_ENDPOINT" \
-  --source main-docs \
-  --github-oidc \
-  --oidc-audience payload-markdown-docs \
+  --source payload-markdown-docs \
+  --key-id github-actions-main \
+  --private-key-env DOCS_SYNC_PRIVATE_KEY \
   --sync \
   --publish
 ```
 
-`--sync` requires `sync.allowWrites: true`. `--publish` requires `sync.allowPublish: true` and `target.enableDrafts: true`. Hard delete requires `sync.allowHardDelete: true`.
+## This Repo
+
+This repo's release workflow publishes the npm package first, then pushes
+`./docs` to:
+
+```text
+https://docs.valkyrianlabs.com/api/payload-markdown-docs/sync
+```
+
+using:
 
-## Documentation
+- source id: `payload-markdown-docs`
+- route base: `/plugins/payload-markdown-docs`
+- auth: GitHub OIDC configured on the matching docs set
+- mode: sync and publish
 
-The real plugin docs now live in [`docs/`](docs/index.md). Start with:
+## More Docs
 
-- [Overview](docs/index.md)
 - [Installation](docs/getting-started/installation.md)
 - [Quick Start](docs/getting-started/quick-start.md)
-- [Architecture](docs/concepts/architecture.md)
+- [Plugin Config](docs/configuration/plugin-config.md)
 - [GitHub OIDC](docs/configuration/github-oidc.md)
 - [GitHub Actions](docs/workflow/ci-github-actions.md)
-- [Agent Skill Installer](docs/workflow/agent-skill-installer.md)
 - [Route Adapter](docs/frontend/route-adapter.md)
-- [Docs Set Admin Manager](docs/admin/docs-set-manager.md)
 - [Troubleshooting](docs/reference/troubleshooting.md)
-
-The `/docs` tree is also dogfood material for the plugin: it uses supported frontmatter, root-relative internal links, and `payload-markdown` directives.
-
-## Examples
-
-- `examples/docs/` is a small fixture docs tree.
-- `examples/github-actions/publish-docs.yml` shows PR dry-run and main-branch sync/publish.
-- `examples/next/app-docs-route.md` shows the native route adapter pattern.
-- `dev/README.md` documents the local end-to-end dev harness for fixtures, seed scripts, signed push, and route adapter checks.
-
-## Roadmap
-
-Next major work:
-
-- existing collection or block bridges only if still needed
-- skill update/verify and drift-check workflow polish
-
-See [`.codex/scratch/roadmap.md`](.codex/scratch/roadmap.md) for the working implementation roadmap.

package/dist/collections/docsSets.js

@@ -60,6 +60,155 @@ export const createDocsSetsCollection = ({ slug, docsCollectionSlug, docsGroupsC
                 type: 'number',
                 defaultValue: 0
             },
+            {
+                name: 'auth',
+                type: 'group',
+                admin: {
+                    description: 'Source-specific sync authentication policy. Use this instead of hardcoding docs sources in payload.config.ts.'
+                },
+                fields: [
+                    {
+                        name: 'ed25519',
+                        type: 'group',
+                        fields: [
+                            {
+                                name: 'keys',
+                                type: 'array',
+                                admin: {
+                                    description: 'Public keys allowed to sync this docs set from local machines or non-GitHub CI.'
+                                },
+                                fields: [
+                                    {
+                                        name: 'keyId',
+                                        type: 'text',
+                                        required: true
+                                    },
+                                    {
+                                        name: 'publicKey',
+                                        type: 'textarea',
+                                        required: true
+                                    }
+                                ]
+                            },
+                            {
+                                name: 'maxSkewSeconds',
+                                type: 'number'
+                            },
+                            {
+                                name: 'nonceTtlSeconds',
+                                type: 'number'
+                            }
+                        ]
+                    },
+                    {
+                        name: 'githubOidc',
+                        type: 'group',
+                        fields: [
+                            {
+                                name: 'enabled',
+                                type: 'checkbox',
+                                defaultValue: false
+                            },
+                            {
+                                name: 'audience',
+                                type: 'text',
+                                admin: {
+                                    description: 'Optional override. Defaults to the plugin-level GitHub OIDC audience.'
+                                }
+                            },
+                            {
+                                name: 'allowedRepositories',
+                                type: 'array',
+                                admin: {
+                                    description: 'GitHub repositories allowed to sync this docs set, for example valkyrianlabs/payload-markdown-docs.'
+                                },
+                                fields: [
+                                    {
+                                        name: 'value',
+                                        type: 'text',
+                                        required: true
+                                    }
+                                ]
+                            },
+                            {
+                                name: 'allowedRepositoryOwners',
+                                type: 'array',
+                                fields: [
+                                    {
+                                        name: 'value',
+                                        type: 'text',
+                                        required: true
+                                    }
+                                ]
+                            },
+                            {
+                                name: 'allowedRefs',
+                                type: 'array',
+                                admin: {
+                                    description: 'Exact Git refs such as refs/heads/main or refs/tags/v0.2.1.'
+                                },
+                                fields: [
+                                    {
+                                        name: 'value',
+                                        type: 'text',
+                                        required: true
+                                    }
+                                ]
+                            },
+                            {
+                                name: 'allowedWorkflows',
+                                type: 'array',
+                                fields: [
+                                    {
+                                        name: 'value',
+                                        type: 'text',
+                                        required: true
+                                    }
+                                ]
+                            },
+                            {
+                                name: 'allowedWorkflowRefs',
+                                type: 'array',
+                                fields: [
+                                    {
+                                        name: 'value',
+                                        type: 'text',
+                                        required: true
+                                    }
+                                ]
+                            },
+                            {
+                                name: 'allowedEnvironments',
+                                type: 'array',
+                                fields: [
+                                    {
+                                        name: 'value',
+                                        type: 'text',
+                                        required: true
+                                    }
+                                ]
+                            },
+                            {
+                                name: 'allowPullRequests',
+                                type: 'checkbox',
+                                defaultValue: false
+                            },
+                            {
+                                name: 'issuer',
+                                type: 'text'
+                            },
+                            {
+                                name: 'jwksUrl',
+                                type: 'text'
+                            },
+                            {
+                                name: 'maxSkewSeconds',
+                                type: 'number'
+                            }
+                        ]
+                    }
+                ]
+            },
             {
                 name: 'defaults',
                 type: 'group',

package/dist/collections/docsSets.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/collections/docsSets.ts"],"sourcesContent":["import type { CollectionConfig } from 'payload'\n\nimport { DOCS_SET_MANAGER_COMPONENT } from '../constants.js'\n\nexport type CreateDocsSetsCollectionOptions = {\n  docsCollectionSlug?: string\n  docsGroupsCollectionSlug: string\n  slug: string\n  syncRunsCollectionSlug?: string\n}\n\nexport const createDocsSetsCollection = ({\n  slug,\n  docsCollectionSlug,\n  docsGroupsCollectionSlug,\n  syncRunsCollectionSlug,\n}: CreateDocsSetsCollectionOptions): CollectionConfig => ({\n  slug,\n  admin: {\n    defaultColumns: ['title', 'sourceId', 'routeBase', 'updatedAt'],\n    group: 'Docs',\n    useAsTitle: 'title',\n  },\n  fields: [\n    {\n      name: 'title',\n      type: 'text',\n      required: true,\n    },\n    {\n      name: 'slug',\n      type: 'text',\n      index: true,\n      required: true,\n    },\n    {\n      name: 'sourceId',\n      type: 'text',\n      index: true,\n      required: true,\n      unique: true,\n    },\n    {\n      name: 'sourceRoot',\n      type: 'text',\n      defaultValue: 'docs',\n    },\n    {\n      name: 'group',\n      type: 'relationship',\n      relationTo: docsGroupsCollectionSlug,\n    },\n    {\n      name: 'routeBase',\n      type: 'text',\n      index: true,\n      required: true,\n      unique: true,\n    },\n    {\n      name: 'description',\n      type: 'textarea',\n    },\n    {\n      name: 'navTitle',\n      type: 'text',\n    },\n    {\n      name: 'order',\n      type: 'number',\n      defaultValue: 0,\n    },\n    {\n      name: 'defaults',\n      type: 'group',\n      fields: [\n        {\n          name: 'theme',\n          type: 'text',\n        },\n        {\n          name: 'heroEyebrow',\n          type: 'text',\n        },\n        {\n          name: 'heroTitle',\n          type: 'text',\n        },\n        {\n          name: 'heroDescription',\n          type: 'textarea',\n        },\n        {\n          name: 'seoTitle',\n          type: 'text',\n        },\n        {\n          name: 'seoDescription',\n          type: 'textarea',\n        },\n        {\n          name: 'sidebarMode',\n          type: 'select',\n          options: ['auto', 'manual', 'hidden'],\n        },\n      ],\n    },\n    {\n      name: 'aiExport',\n      type: 'json',\n      admin: {\n        description:\n          'Parsed index.ai.yml control data for the raw Markdown AI export route.',\n      },\n    },\n    {\n      name: 'sync',\n      type: 'group',\n      fields: [\n        {\n          name: 'lastSyncedAt',\n          type: 'date',\n        },\n        ...(syncRunsCollectionSlug\n          ? [\n              {\n                name: 'lastSyncRunId',\n                type: 'relationship' as const,\n                relationTo: syncRunsCollectionSlug,\n              },\n            ]\n          : []),\n        {\n          name: 'lastStatus',\n          type: 'select',\n          options: ['failed', 'pending', 'success'],\n        },\n        {\n          name: 'docsCount',\n          type: 'number',\n          defaultValue: 0,\n        },\n      ],\n    },\n    ...(docsCollectionSlug\n      ? [\n          {\n            name: 'docsSetManager',\n            type: 'ui' as const,\n            admin: {\n              components: {\n                Field: DOCS_SET_MANAGER_COMPONENT,\n              },\n              custom: {\n                docsCollectionSlug,\n                docsSetsCollectionSlug: slug,\n              },\n            },\n          },\n        ]\n      : []),\n  ],\n})\n"],"names":["DOCS_SET_MANAGER_COMPONENT","createDocsSetsCollection","slug","docsCollectionSlug","docsGroupsCollectionSlug","syncRunsCollectionSlug","admin","defaultColumns","group","useAsTitle","fields","name","type","required","index","unique","defaultValue","relationTo","options","description","components","Field","custom","docsSetsCollectionSlug"],"mappings":"AAEA,SAASA,0BAA0B,QAAQ,kBAAiB;AAS5D,OAAO,MAAMC,2BAA2B,CAAC,EACvCC,IAAI,EACJC,kBAAkB,EAClBC,wBAAwB,EACxBC,sBAAsB,EACU,GAAwB,CAAA;QACxDH;QACAI,OAAO;YACLC,gBAAgB;gBAAC;gBAAS;gBAAY;gBAAa;aAAY;YAC/DC,OAAO;YACPC,YAAY;QACd;QACAC,QAAQ;YACN;gBACEC,MAAM;gBACNC,MAAM;gBACNC,UAAU;YACZ;YACA;gBACEF,MAAM;gBACNC,MAAM;gBACNE,OAAO;gBACPD,UAAU;YACZ;YACA;gBACEF,MAAM;gBACNC,MAAM;gBACNE,OAAO;gBACPD,UAAU;gBACVE,QAAQ;YACV;YACA;gBACEJ,MAAM;gBACNC,MAAM;gBACNI,cAAc;YAChB;YACA;gBACEL,MAAM;gBACNC,MAAM;gBACNK,YAAYb;YACd;YACA;gBACEO,MAAM;gBACNC,MAAM;gBACNE,OAAO;gBACPD,UAAU;gBACVE,QAAQ;YACV;YACA;gBACEJ,MAAM;gBACNC,MAAM;YACR;YACA;gBACED,MAAM;gBACNC,MAAM;YACR;YACA;gBACED,MAAM;gBACNC,MAAM;gBACNI,cAAc;YAChB;YACA;gBACEL,MAAM;gBACNC,MAAM;gBACNF,QAAQ;oBACN;wBACEC,MAAM;wBACNC,MAAM;oBACR;oBACA;wBACED,MAAM;wBACNC,MAAM;oBACR;oBACA;wBACED,MAAM;wBACNC,MAAM;oBACR;oBACA;wBACED,MAAM;wBACNC,MAAM;oBACR;oBACA;wBACED,MAAM;wBACNC,MAAM;oBACR;oBACA;wBACED,MAAM;wBACNC,MAAM;oBACR;oBACA;wBACED,MAAM;wBACNC,MAAM;wBACNM,SAAS;4BAAC;4BAAQ;4BAAU;yBAAS;oBACvC;iBACD;YACH;YACA;gBACEP,MAAM;gBACNC,MAAM;gBACNN,OAAO;oBACLa,aACE;gBACJ;YACF;YACA;gBACER,MAAM;gBACNC,MAAM;gBACNF,QAAQ;oBACN;wBACEC,MAAM;wBACNC,MAAM;oBACR;uBACIP,yBACA;wBACE;4BACEM,MAAM;4BACNC,MAAM;4BACNK,YAAYZ;wBACd;qBACD,GACD,EAAE;oBACN;wBACEM,MAAM;wBACNC,MAAM;wBACNM,SAAS;4BAAC;4BAAU;4BAAW;yBAAU;oBAC3C;oBACA;wBACEP,MAAM;wBACNC,MAAM;wBACNI,cAAc;oBAChB;iBACD;YACH;eACIb,qBACA;gBACE;oBACEQ,MAAM;oBACNC,MAAM;oBACNN,OAAO;wBACLc,YAAY;4BACVC,OAAOrB;wBACT;wBACAsB,QAAQ;4BACNnB;4BACAoB,wBAAwBrB;wBAC1B;oBACF;gBACF;aACD,GACD,EAAE;SACP;IACH,CAAA,EAAE"}
+{"version":3,"sources":["../../src/collections/docsSets.ts"],"sourcesContent":["import type { CollectionConfig } from 'payload'\n\nimport { DOCS_SET_MANAGER_COMPONENT } from '../constants.js'\n\nexport type CreateDocsSetsCollectionOptions = {\n  docsCollectionSlug?: string\n  docsGroupsCollectionSlug: string\n  slug: string\n  syncRunsCollectionSlug?: string\n}\n\nexport const createDocsSetsCollection = ({\n  slug,\n  docsCollectionSlug,\n  docsGroupsCollectionSlug,\n  syncRunsCollectionSlug,\n}: CreateDocsSetsCollectionOptions): CollectionConfig => ({\n  slug,\n  admin: {\n    defaultColumns: ['title', 'sourceId', 'routeBase', 'updatedAt'],\n    group: 'Docs',\n    useAsTitle: 'title',\n  },\n  fields: [\n    {\n      name: 'title',\n      type: 'text',\n      required: true,\n    },\n    {\n      name: 'slug',\n      type: 'text',\n      index: true,\n      required: true,\n    },\n    {\n      name: 'sourceId',\n      type: 'text',\n      index: true,\n      required: true,\n      unique: true,\n    },\n    {\n      name: 'sourceRoot',\n      type: 'text',\n      defaultValue: 'docs',\n    },\n    {\n      name: 'group',\n      type: 'relationship',\n      relationTo: docsGroupsCollectionSlug,\n    },\n    {\n      name: 'routeBase',\n      type: 'text',\n      index: true,\n      required: true,\n      unique: true,\n    },\n    {\n      name: 'description',\n      type: 'textarea',\n    },\n    {\n      name: 'navTitle',\n      type: 'text',\n    },\n    {\n      name: 'order',\n      type: 'number',\n      defaultValue: 0,\n    },\n    {\n      name: 'auth',\n      type: 'group',\n      admin: {\n        description:\n          'Source-specific sync authentication policy. Use this instead of hardcoding docs sources in payload.config.ts.',\n      },\n      fields: [\n        {\n          name: 'ed25519',\n          type: 'group',\n          fields: [\n            {\n              name: 'keys',\n              type: 'array',\n              admin: {\n                description:\n                  'Public keys allowed to sync this docs set from local machines or non-GitHub CI.',\n              },\n              fields: [\n                {\n                  name: 'keyId',\n                  type: 'text',\n                  required: true,\n                },\n                {\n                  name: 'publicKey',\n                  type: 'textarea',\n                  required: true,\n                },\n              ],\n            },\n            {\n              name: 'maxSkewSeconds',\n              type: 'number',\n            },\n            {\n              name: 'nonceTtlSeconds',\n              type: 'number',\n            },\n          ],\n        },\n        {\n          name: 'githubOidc',\n          type: 'group',\n          fields: [\n            {\n              name: 'enabled',\n              type: 'checkbox',\n              defaultValue: false,\n            },\n            {\n              name: 'audience',\n              type: 'text',\n              admin: {\n                description:\n                  'Optional override. Defaults to the plugin-level GitHub OIDC audience.',\n              },\n            },\n            {\n              name: 'allowedRepositories',\n              type: 'array',\n              admin: {\n                description:\n                  'GitHub repositories allowed to sync this docs set, for example valkyrianlabs/payload-markdown-docs.',\n              },\n              fields: [\n                {\n                  name: 'value',\n                  type: 'text',\n                  required: true,\n                },\n              ],\n            },\n            {\n              name: 'allowedRepositoryOwners',\n              type: 'array',\n              fields: [\n                {\n                  name: 'value',\n                  type: 'text',\n                  required: true,\n                },\n              ],\n            },\n            {\n              name: 'allowedRefs',\n              type: 'array',\n              admin: {\n                description:\n                  'Exact Git refs such as refs/heads/main or refs/tags/v0.2.1.',\n              },\n              fields: [\n                {\n                  name: 'value',\n                  type: 'text',\n                  required: true,\n                },\n              ],\n            },\n            {\n              name: 'allowedWorkflows',\n              type: 'array',\n              fields: [\n                {\n                  name: 'value',\n                  type: 'text',\n                  required: true,\n                },\n              ],\n            },\n            {\n              name: 'allowedWorkflowRefs',\n              type: 'array',\n              fields: [\n                {\n                  name: 'value',\n                  type: 'text',\n                  required: true,\n                },\n              ],\n            },\n            {\n              name: 'allowedEnvironments',\n              type: 'array',\n              fields: [\n                {\n                  name: 'value',\n                  type: 'text',\n                  required: true,\n                },\n              ],\n            },\n            {\n              name: 'allowPullRequests',\n              type: 'checkbox',\n              defaultValue: false,\n            },\n            {\n              name: 'issuer',\n              type: 'text',\n            },\n            {\n              name: 'jwksUrl',\n              type: 'text',\n            },\n            {\n              name: 'maxSkewSeconds',\n              type: 'number',\n            },\n          ],\n        },\n      ],\n    },\n    {\n      name: 'defaults',\n      type: 'group',\n      fields: [\n        {\n          name: 'theme',\n          type: 'text',\n        },\n        {\n          name: 'heroEyebrow',\n          type: 'text',\n        },\n        {\n          name: 'heroTitle',\n          type: 'text',\n        },\n        {\n          name: 'heroDescription',\n          type: 'textarea',\n        },\n        {\n          name: 'seoTitle',\n          type: 'text',\n        },\n        {\n          name: 'seoDescription',\n          type: 'textarea',\n        },\n        {\n          name: 'sidebarMode',\n          type: 'select',\n          options: ['auto', 'manual', 'hidden'],\n        },\n      ],\n    },\n    {\n      name: 'aiExport',\n      type: 'json',\n      admin: {\n        description:\n          'Parsed index.ai.yml control data for the raw Markdown AI export route.',\n      },\n    },\n    {\n      name: 'sync',\n      type: 'group',\n      fields: [\n        {\n          name: 'lastSyncedAt',\n          type: 'date',\n        },\n        ...(syncRunsCollectionSlug\n          ? [\n              {\n                name: 'lastSyncRunId',\n                type: 'relationship' as const,\n                relationTo: syncRunsCollectionSlug,\n              },\n            ]\n          : []),\n        {\n          name: 'lastStatus',\n          type: 'select',\n          options: ['failed', 'pending', 'success'],\n        },\n        {\n          name: 'docsCount',\n          type: 'number',\n          defaultValue: 0,\n        },\n      ],\n    },\n    ...(docsCollectionSlug\n      ? [\n          {\n            name: 'docsSetManager',\n            type: 'ui' as const,\n            admin: {\n              components: {\n                Field: DOCS_SET_MANAGER_COMPONENT,\n              },\n              custom: {\n                docsCollectionSlug,\n                docsSetsCollectionSlug: slug,\n              },\n            },\n          },\n        ]\n      : []),\n  ],\n})\n"],"names":["DOCS_SET_MANAGER_COMPONENT","createDocsSetsCollection","slug","docsCollectionSlug","docsGroupsCollectionSlug","syncRunsCollectionSlug","admin","defaultColumns","group","useAsTitle","fields","name","type","required","index","unique","defaultValue","relationTo","description","options","components","Field","custom","docsSetsCollectionSlug"],"mappings":"AAEA,SAASA,0BAA0B,QAAQ,kBAAiB;AAS5D,OAAO,MAAMC,2BAA2B,CAAC,EACvCC,IAAI,EACJC,kBAAkB,EAClBC,wBAAwB,EACxBC,sBAAsB,EACU,GAAwB,CAAA;QACxDH;QACAI,OAAO;YACLC,gBAAgB;gBAAC;gBAAS;gBAAY;gBAAa;aAAY;YAC/DC,OAAO;YACPC,YAAY;QACd;QACAC,QAAQ;YACN;gBACEC,MAAM;gBACNC,MAAM;gBACNC,UAAU;YACZ;YACA;gBACEF,MAAM;gBACNC,MAAM;gBACNE,OAAO;gBACPD,UAAU;YACZ;YACA;gBACEF,MAAM;gBACNC,MAAM;gBACNE,OAAO;gBACPD,UAAU;gBACVE,QAAQ;YACV;YACA;gBACEJ,MAAM;gBACNC,MAAM;gBACNI,cAAc;YAChB;YACA;gBACEL,MAAM;gBACNC,MAAM;gBACNK,YAAYb;YACd;YACA;gBACEO,MAAM;gBACNC,MAAM;gBACNE,OAAO;gBACPD,UAAU;gBACVE,QAAQ;YACV;YACA;gBACEJ,MAAM;gBACNC,MAAM;YACR;YACA;gBACED,MAAM;gBACNC,MAAM;YACR;YACA;gBACED,MAAM;gBACNC,MAAM;gBACNI,cAAc;YAChB;YACA;gBACEL,MAAM;gBACNC,MAAM;gBACNN,OAAO;oBACLY,aACE;gBACJ;gBACAR,QAAQ;oBACN;wBACEC,MAAM;wBACNC,MAAM;wBACNF,QAAQ;4BACN;gCACEC,MAAM;gCACNC,MAAM;gCACNN,OAAO;oCACLY,aACE;gCACJ;gCACAR,QAAQ;oCACN;wCACEC,MAAM;wCACNC,MAAM;wCACNC,UAAU;oCACZ;oCACA;wCACEF,MAAM;wCACNC,MAAM;wCACNC,UAAU;oCACZ;iCACD;4BACH;4BACA;gCACEF,MAAM;gCACNC,MAAM;4BACR;4BACA;gCACED,MAAM;gCACNC,MAAM;4BACR;yBACD;oBACH;oBACA;wBACED,MAAM;wBACNC,MAAM;wBACNF,QAAQ;4BACN;gCACEC,MAAM;gCACNC,MAAM;gCACNI,cAAc;4BAChB;4BACA;gCACEL,MAAM;gCACNC,MAAM;gCACNN,OAAO;oCACLY,aACE;gCACJ;4BACF;4BACA;gCACEP,MAAM;gCACNC,MAAM;gCACNN,OAAO;oCACLY,aACE;gCACJ;gCACAR,QAAQ;oCACN;wCACEC,MAAM;wCACNC,MAAM;wCACNC,UAAU;oCACZ;iCACD;4BACH;4BACA;gCACEF,MAAM;gCACNC,MAAM;gCACNF,QAAQ;oCACN;wCACEC,MAAM;wCACNC,MAAM;wCACNC,UAAU;oCACZ;iCACD;4BACH;4BACA;gCACEF,MAAM;gCACNC,MAAM;gCACNN,OAAO;oCACLY,aACE;gCACJ;gCACAR,QAAQ;oCACN;wCACEC,MAAM;wCACNC,MAAM;wCACNC,UAAU;oCACZ;iCACD;4BACH;4BACA;gCACEF,MAAM;gCACNC,MAAM;gCACNF,QAAQ;oCACN;wCACEC,MAAM;wCACNC,MAAM;wCACNC,UAAU;oCACZ;iCACD;4BACH;4BACA;gCACEF,MAAM;gCACNC,MAAM;gCACNF,QAAQ;oCACN;wCACEC,MAAM;wCACNC,MAAM;wCACNC,UAAU;oCACZ;iCACD;4BACH;4BACA;gCACEF,MAAM;gCACNC,MAAM;gCACNF,QAAQ;oCACN;wCACEC,MAAM;wCACNC,MAAM;wCACNC,UAAU;oCACZ;iCACD;4BACH;4BACA;gCACEF,MAAM;gCACNC,MAAM;gCACNI,cAAc;4BAChB;4BACA;gCACEL,MAAM;gCACNC,MAAM;4BACR;4BACA;gCACED,MAAM;gCACNC,MAAM;4BACR;4BACA;gCACED,MAAM;gCACNC,MAAM;4BACR;yBACD;oBACH;iBACD;YACH;YACA;gBACED,MAAM;gBACNC,MAAM;gBACNF,QAAQ;oBACN;wBACEC,MAAM;wBACNC,MAAM;oBACR;oBACA;wBACED,MAAM;wBACNC,MAAM;oBACR;oBACA;wBACED,MAAM;wBACNC,MAAM;oBACR;oBACA;wBACED,MAAM;wBACNC,MAAM;oBACR;oBACA;wBACED,MAAM;wBACNC,MAAM;oBACR;oBACA;wBACED,MAAM;wBACNC,MAAM;oBACR;oBACA;wBACED,MAAM;wBACNC,MAAM;wBACNO,SAAS;4BAAC;4BAAQ;4BAAU;yBAAS;oBACvC;iBACD;YACH;YACA;gBACER,MAAM;gBACNC,MAAM;gBACNN,OAAO;oBACLY,aACE;gBACJ;YACF;YACA;gBACEP,MAAM;gBACNC,MAAM;gBACNF,QAAQ;oBACN;wBACEC,MAAM;wBACNC,MAAM;oBACR;uBACIP,yBACA;wBACE;4BACEM,MAAM;4BACNC,MAAM;4BACNK,YAAYZ;wBACd;qBACD,GACD,EAAE;oBACN;wBACEM,MAAM;wBACNC,MAAM;wBACNO,SAAS;4BAAC;4BAAU;4BAAW;yBAAU;oBAC3C;oBACA;wBACER,MAAM;wBACNC,MAAM;wBACNI,cAAc;oBAChB;iBACD;YACH;eACIb,qBACA;gBACE;oBACEQ,MAAM;oBACNC,MAAM;oBACNN,OAAO;wBACLc,YAAY;4BACVC,OAAOrB;wBACT;wBACAsB,QAAQ;4BACNnB;4BACAoB,wBAAwBrB;wBAC1B;oBACF;gBACF;aACD,GACD,EAAE;SACP;IACH,CAAA,EAAE"}