@valkyrianlabs/payload-markdown-docs 0.1.0-canary.0

package/dist/collections/syncRuns.js

@@ -0,0 +1,139 @@
+export const createSyncRunsCollection = ({ slug })=>({
+        slug,
+        admin: {
+            defaultColumns: [
+                'sourceId',
+                'mode',
+                'status',
+                'startedAt',
+                'completedAt'
+            ],
+            hidden: true,
+            useAsTitle: 'sourceId'
+        },
+        fields: [
+            {
+                name: 'sourceId',
+                type: 'text',
+                index: true,
+                required: true
+            },
+            {
+                name: 'repository',
+                type: 'text'
+            },
+            {
+                name: 'branch',
+                type: 'text'
+            },
+            {
+                name: 'commit',
+                type: 'text',
+                index: true
+            },
+            {
+                name: 'actor',
+                type: 'text'
+            },
+            {
+                name: 'keyId',
+                type: 'text',
+                index: true
+            },
+            {
+                name: 'mode',
+                type: 'select',
+                options: [
+                    'dry-run',
+                    'sync'
+                ],
+                required: true
+            },
+            {
+                name: 'status',
+                type: 'select',
+                defaultValue: 'pending',
+                options: [
+                    'pending',
+                    'success',
+                    'failed'
+                ],
+                required: true
+            },
+            {
+                name: 'publishRequested',
+                type: 'checkbox',
+                defaultValue: false
+            },
+            {
+                name: 'effectivePublishMode',
+                type: 'select',
+                options: [
+                    'draft',
+                    'preserve',
+                    'published'
+                ]
+            },
+            {
+                name: 'deleteBehavior',
+                type: 'select',
+                options: [
+                    'archive',
+                    'delete',
+                    'draft',
+                    'ignore'
+                ]
+            },
+            {
+                name: 'bodyHash',
+                type: 'text',
+                index: true
+            },
+            {
+                name: 'fileCount',
+                type: 'number',
+                defaultValue: 0
+            },
+            {
+                name: 'totalBytes',
+                type: 'number',
+                defaultValue: 0
+            },
+            {
+                name: 'summary',
+                type: 'json'
+            },
+            {
+                name: 'warnings',
+                type: 'array',
+                fields: [
+                    {
+                        name: 'message',
+                        type: 'textarea'
+                    }
+                ]
+            },
+            {
+                name: 'errors',
+                type: 'array',
+                fields: [
+                    {
+                        name: 'message',
+                        type: 'textarea'
+                    }
+                ]
+            },
+            {
+                name: 'startedAt',
+                type: 'date',
+                index: true,
+                required: true
+            },
+            {
+                name: 'completedAt',
+                type: 'date'
+            }
+        ]
+    });
+
+//# sourceMappingURL=syncRuns.js.map

package/dist/collections/syncRuns.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/collections/syncRuns.ts"],"sourcesContent":["import type { CollectionConfig } from 'payload'\n\nexport type CreateSyncRunsCollectionOptions = {\n  slug: string\n}\n\nexport const createSyncRunsCollection = ({\n  slug,\n}: CreateSyncRunsCollectionOptions): CollectionConfig => ({\n  slug,\n  admin: {\n    defaultColumns: ['sourceId', 'mode', 'status', 'startedAt', 'completedAt'],\n    hidden: true,\n    useAsTitle: 'sourceId',\n  },\n  fields: [\n    {\n      name: 'sourceId',\n      type: 'text',\n      index: true,\n      required: true,\n    },\n    {\n      name: 'repository',\n      type: 'text',\n    },\n    {\n      name: 'branch',\n      type: 'text',\n    },\n    {\n      name: 'commit',\n      type: 'text',\n      index: true,\n    },\n    {\n      name: 'actor',\n      type: 'text',\n    },\n    {\n      name: 'keyId',\n      type: 'text',\n      index: true,\n    },\n    {\n      name: 'mode',\n      type: 'select',\n      options: ['dry-run', 'sync'],\n      required: true,\n    },\n    {\n      name: 'status',\n      type: 'select',\n      defaultValue: 'pending',\n      options: ['pending', 'success', 'failed'],\n      required: true,\n    },\n    {\n      name: 'publishRequested',\n      type: 'checkbox',\n      defaultValue: false,\n    },\n    {\n      name: 'effectivePublishMode',\n      type: 'select',\n      options: ['draft', 'preserve', 'published'],\n    },\n    {\n      name: 'deleteBehavior',\n      type: 'select',\n      options: ['archive', 'delete', 'draft', 'ignore'],\n    },\n    {\n      name: 'bodyHash',\n      type: 'text',\n      index: true,\n    },\n    {\n      name: 'fileCount',\n      type: 'number',\n      defaultValue: 0,\n    },\n    {\n      name: 'totalBytes',\n      type: 'number',\n      defaultValue: 0,\n    },\n    {\n      name: 'summary',\n      type: 'json',\n    },\n    {\n      name: 'warnings',\n      type: 'array',\n      fields: [\n        {\n          name: 'message',\n          type: 'textarea',\n        },\n      ],\n    },\n    {\n      name: 'errors',\n      type: 'array',\n      fields: [\n        {\n          name: 'message',\n          type: 'textarea',\n        },\n      ],\n    },\n    {\n      name: 'startedAt',\n      type: 'date',\n      index: true,\n      required: true,\n    },\n    {\n      name: 'completedAt',\n      type: 'date',\n    },\n  ],\n})\n"],"names":["createSyncRunsCollection","slug","admin","defaultColumns","hidden","useAsTitle","fields","name","type","index","required","options","defaultValue"],"mappings":"AAMA,OAAO,MAAMA,2BAA2B,CAAC,EACvCC,IAAI,EAC4B,GAAwB,CAAA;QACxDA;QACAC,OAAO;YACLC,gBAAgB;gBAAC;gBAAY;gBAAQ;gBAAU;gBAAa;aAAc;YAC1EC,QAAQ;YACRC,YAAY;QACd;QACAC,QAAQ;YACN;gBACEC,MAAM;gBACNC,MAAM;gBACNC,OAAO;gBACPC,UAAU;YACZ;YACA;gBACEH,MAAM;gBACNC,MAAM;YACR;YACA;gBACED,MAAM;gBACNC,MAAM;YACR;YACA;gBACED,MAAM;gBACNC,MAAM;gBACNC,OAAO;YACT;YACA;gBACEF,MAAM;gBACNC,MAAM;YACR;YACA;gBACED,MAAM;gBACNC,MAAM;gBACNC,OAAO;YACT;YACA;gBACEF,MAAM;gBACNC,MAAM;gBACNG,SAAS;oBAAC;oBAAW;iBAAO;gBAC5BD,UAAU;YACZ;YACA;gBACEH,MAAM;gBACNC,MAAM;gBACNI,cAAc;gBACdD,SAAS;oBAAC;oBAAW;oBAAW;iBAAS;gBACzCD,UAAU;YACZ;YACA;gBACEH,MAAM;gBACNC,MAAM;gBACNI,cAAc;YAChB;YACA;gBACEL,MAAM;gBACNC,MAAM;gBACNG,SAAS;oBAAC;oBAAS;oBAAY;iBAAY;YAC7C;YACA;gBACEJ,MAAM;gBACNC,MAAM;gBACNG,SAAS;oBAAC;oBAAW;oBAAU;oBAAS;iBAAS;YACnD;YACA;gBACEJ,MAAM;gBACNC,MAAM;gBACNC,OAAO;YACT;YACA;gBACEF,MAAM;gBACNC,MAAM;gBACNI,cAAc;YAChB;YACA;gBACEL,MAAM;gBACNC,MAAM;gBACNI,cAAc;YAChB;YACA;gBACEL,MAAM;gBACNC,MAAM;YACR;YACA;gBACED,MAAM;gBACNC,MAAM;gBACNF,QAAQ;oBACN;wBACEC,MAAM;wBACNC,MAAM;oBACR;iBACD;YACH;YACA;gBACED,MAAM;gBACNC,MAAM;gBACNF,QAAQ;oBACN;wBACEC,MAAM;wBACNC,MAAM;oBACR;iBACD;YACH;YACA;gBACED,MAAM;gBACNC,MAAM;gBACNC,OAAO;gBACPC,UAAU;YACZ;YACA;gBACEH,MAAM;gBACNC,MAAM;YACR;SACD;IACH,CAAA,EAAE"}

package/dist/constants.d.ts

@@ -0,0 +1,21 @@
+export declare const DEFAULT_DOCS_COLLECTION_SLUG = "docs";
+export declare const DEFAULT_DOCS_GROUPS_COLLECTION_SLUG = "docs-groups";
+export declare const DEFAULT_DOCS_ROUTE_BASE = "/docs";
+export declare const DEFAULT_DOCS_SETS_COLLECTION_SLUG = "docs-sets";
+export declare const DEFAULT_DOCS_SYNC_NONCES_COLLECTION_SLUG = "docs-sync-nonces";
+export declare const DEFAULT_DOCS_SYNC_RUNS_COLLECTION_SLUG = "docs-sync-runs";
+export declare const DEFAULT_DOCS_SYNC_ENDPOINT_PATH = "/payload-markdown-docs/sync";
+export declare const DEFAULT_MARKDOWN_FIELD_NAME = "content";
+export declare const DOCS_SET_MANAGER_COMPONENT = "@valkyrianlabs/payload-markdown-docs/admin#DocsSetManager";
+export declare const DEFAULT_PAGES_BRIDGE_FIELD = "docsBridge";
+export declare const DEFAULT_PAGES_COLLECTION_SLUG = "pages";
+export declare const DEFAULT_PAGES_ROUTE_FIELD = "slug";
+export declare const DEFAULT_MAX_DOCS_FILE_BYTES = 500000;
+export declare const DEFAULT_MAX_DOCS_FILES = 500;
+export declare const DEFAULT_MAX_DOCS_TOTAL_BYTES = 5000000;
+export declare const DEFAULT_MAX_BODY_BYTES = 5000000;
+export declare const DEFAULT_MAX_SKEW_SECONDS = 300;
+export declare const DEFAULT_NONCE_TTL_SECONDS = 600;
+export declare const DEFAULT_GITHUB_OIDC_AUDIENCE = "payload-markdown-docs";
+export declare const DEFAULT_GITHUB_OIDC_ISSUER = "https://token.actions.githubusercontent.com";
+export declare const MANAGED_BY = "payload-markdown-docs";

package/dist/constants.js

@@ -0,0 +1,23 @@
+export const DEFAULT_DOCS_COLLECTION_SLUG = 'docs';
+export const DEFAULT_DOCS_GROUPS_COLLECTION_SLUG = 'docs-groups';
+export const DEFAULT_DOCS_ROUTE_BASE = '/docs';
+export const DEFAULT_DOCS_SETS_COLLECTION_SLUG = 'docs-sets';
+export const DEFAULT_DOCS_SYNC_NONCES_COLLECTION_SLUG = 'docs-sync-nonces';
+export const DEFAULT_DOCS_SYNC_RUNS_COLLECTION_SLUG = 'docs-sync-runs';
+export const DEFAULT_DOCS_SYNC_ENDPOINT_PATH = '/payload-markdown-docs/sync';
+export const DEFAULT_MARKDOWN_FIELD_NAME = 'content';
+export const DOCS_SET_MANAGER_COMPONENT = '@valkyrianlabs/payload-markdown-docs/admin#DocsSetManager';
+export const DEFAULT_PAGES_BRIDGE_FIELD = 'docsBridge';
+export const DEFAULT_PAGES_COLLECTION_SLUG = 'pages';
+export const DEFAULT_PAGES_ROUTE_FIELD = 'slug';
+export const DEFAULT_MAX_DOCS_FILE_BYTES = 500_000;
+export const DEFAULT_MAX_DOCS_FILES = 500;
+export const DEFAULT_MAX_DOCS_TOTAL_BYTES = 5_000_000;
+export const DEFAULT_MAX_BODY_BYTES = 5_000_000;
+export const DEFAULT_MAX_SKEW_SECONDS = 300;
+export const DEFAULT_NONCE_TTL_SECONDS = 600;
+export const DEFAULT_GITHUB_OIDC_AUDIENCE = 'payload-markdown-docs';
+export const DEFAULT_GITHUB_OIDC_ISSUER = 'https://token.actions.githubusercontent.com';
+export const MANAGED_BY = 'payload-markdown-docs';
+
+//# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/constants.ts"],"sourcesContent":["export const DEFAULT_DOCS_COLLECTION_SLUG = 'docs'\nexport const DEFAULT_DOCS_GROUPS_COLLECTION_SLUG = 'docs-groups'\nexport const DEFAULT_DOCS_ROUTE_BASE = '/docs'\nexport const DEFAULT_DOCS_SETS_COLLECTION_SLUG = 'docs-sets'\nexport const DEFAULT_DOCS_SYNC_NONCES_COLLECTION_SLUG = 'docs-sync-nonces'\nexport const DEFAULT_DOCS_SYNC_RUNS_COLLECTION_SLUG = 'docs-sync-runs'\nexport const DEFAULT_DOCS_SYNC_ENDPOINT_PATH = '/payload-markdown-docs/sync'\nexport const DEFAULT_MARKDOWN_FIELD_NAME = 'content'\nexport const DOCS_SET_MANAGER_COMPONENT =\n  '@valkyrianlabs/payload-markdown-docs/admin#DocsSetManager'\nexport const DEFAULT_PAGES_BRIDGE_FIELD = 'docsBridge'\nexport const DEFAULT_PAGES_COLLECTION_SLUG = 'pages'\nexport const DEFAULT_PAGES_ROUTE_FIELD = 'slug'\nexport const DEFAULT_MAX_DOCS_FILE_BYTES = 500_000\nexport const DEFAULT_MAX_DOCS_FILES = 500\nexport const DEFAULT_MAX_DOCS_TOTAL_BYTES = 5_000_000\nexport const DEFAULT_MAX_BODY_BYTES = 5_000_000\nexport const DEFAULT_MAX_SKEW_SECONDS = 300\nexport const DEFAULT_NONCE_TTL_SECONDS = 600\nexport const DEFAULT_GITHUB_OIDC_AUDIENCE = 'payload-markdown-docs'\nexport const DEFAULT_GITHUB_OIDC_ISSUER =\n  'https://token.actions.githubusercontent.com'\nexport const MANAGED_BY = 'payload-markdown-docs'\n"],"names":["DEFAULT_DOCS_COLLECTION_SLUG","DEFAULT_DOCS_GROUPS_COLLECTION_SLUG","DEFAULT_DOCS_ROUTE_BASE","DEFAULT_DOCS_SETS_COLLECTION_SLUG","DEFAULT_DOCS_SYNC_NONCES_COLLECTION_SLUG","DEFAULT_DOCS_SYNC_RUNS_COLLECTION_SLUG","DEFAULT_DOCS_SYNC_ENDPOINT_PATH","DEFAULT_MARKDOWN_FIELD_NAME","DOCS_SET_MANAGER_COMPONENT","DEFAULT_PAGES_BRIDGE_FIELD","DEFAULT_PAGES_COLLECTION_SLUG","DEFAULT_PAGES_ROUTE_FIELD","DEFAULT_MAX_DOCS_FILE_BYTES","DEFAULT_MAX_DOCS_FILES","DEFAULT_MAX_DOCS_TOTAL_BYTES","DEFAULT_MAX_BODY_BYTES","DEFAULT_MAX_SKEW_SECONDS","DEFAULT_NONCE_TTL_SECONDS","DEFAULT_GITHUB_OIDC_AUDIENCE","DEFAULT_GITHUB_OIDC_ISSUER","MANAGED_BY"],"mappings":"AAAA,OAAO,MAAMA,+BAA+B,OAAM;AAClD,OAAO,MAAMC,sCAAsC,cAAa;AAChE,OAAO,MAAMC,0BAA0B,QAAO;AAC9C,OAAO,MAAMC,oCAAoC,YAAW;AAC5D,OAAO,MAAMC,2CAA2C,mBAAkB;AAC1E,OAAO,MAAMC,yCAAyC,iBAAgB;AACtE,OAAO,MAAMC,kCAAkC,8BAA6B;AAC5E,OAAO,MAAMC,8BAA8B,UAAS;AACpD,OAAO,MAAMC,6BACX,4DAA2D;AAC7D,OAAO,MAAMC,6BAA6B,aAAY;AACtD,OAAO,MAAMC,gCAAgC,QAAO;AACpD,OAAO,MAAMC,4BAA4B,OAAM;AAC/C,OAAO,MAAMC,8BAA8B,QAAO;AAClD,OAAO,MAAMC,yBAAyB,IAAG;AACzC,OAAO,MAAMC,+BAA+B,UAAS;AACrD,OAAO,MAAMC,yBAAyB,UAAS;AAC/C,OAAO,MAAMC,2BAA2B,IAAG;AAC3C,OAAO,MAAMC,4BAA4B,IAAG;AAC5C,OAAO,MAAMC,+BAA+B,wBAAuB;AACnE,OAAO,MAAMC,6BACX,8CAA6C;AAC/C,OAAO,MAAMC,aAAa,wBAAuB"}

package/dist/endpoints/index.d.ts

@@ -0,0 +1,2 @@
+export { createSyncEndpoint } from './sync.js';
+export type { CreateSyncEndpointOptions, DocsSyncEndpointErrorCode, } from './sync.js';

package/dist/endpoints/index.js

@@ -0,0 +1,3 @@
+export { createSyncEndpoint } from './sync.js';
+
+//# sourceMappingURL=index.js.map

package/dist/endpoints/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/endpoints/index.ts"],"sourcesContent":["export { createSyncEndpoint } from './sync.js'\nexport type {\n  CreateSyncEndpointOptions,\n  DocsSyncEndpointErrorCode,\n} from './sync.js'\n"],"names":["createSyncEndpoint"],"mappings":"AAAA,SAASA,kBAAkB,QAAQ,YAAW"}

package/dist/endpoints/sync.d.ts

@@ -0,0 +1,47 @@
+import type { Endpoint } from 'payload';
+import type { DocsPublishMode } from '../payload/index.js';
+import type { FetchJson } from '../security/index.js';
+import type { DocsDeleteBehavior } from '../sync/index.js';
+import type { PayloadMarkdownDocsAuthConfig } from '../types.js';
+export type DocsSyncEndpointErrorCode = 'audit_unavailable' | 'auth_disabled' | 'body_hash_mismatch' | 'delete_behavior_not_implemented' | 'draft_behavior_not_available' | 'dry_run_required_not_implemented' | 'hard_delete_disabled' | 'invalid_body' | 'invalid_manifest' | 'invalid_method' | 'invalid_signature' | 'invalid_timestamp' | 'manual_edit_conflict' | 'missing_header' | 'nonce_replay' | 'oidc_environment_not_allowed' | 'oidc_expired' | 'oidc_invalid_audience' | 'oidc_invalid_issuer' | 'oidc_invalid_token' | 'oidc_jwks_unavailable' | 'oidc_missing_claim' | 'oidc_missing_jti' | 'oidc_not_yet_valid' | 'oidc_owner_not_allowed' | 'oidc_pull_request_not_allowed' | 'oidc_ref_not_allowed' | 'oidc_replay' | 'oidc_repository_not_allowed' | 'oidc_workflow_not_allowed' | 'publish_disabled' | 'publish_not_available' | 'replay_protection_unavailable' | 'route_collision' | 'source_not_allowed' | 'sync_apply_failed' | 'sync_mode_not_implemented' | 'sync_writes_disabled' | 'unknown_key';
+export type CreateSyncEndpointOptions = {
+    allowHardDelete?: boolean;
+    allowPublish?: boolean;
+    allowWrites?: boolean;
+    auth?: PayloadMarkdownDocsAuthConfig;
+    defaultPublishMode?: DocsPublishMode;
+    deleteBehavior?: DocsDeleteBehavior;
+    docsCollectionSlug: string;
+    docsEnabled: boolean;
+    docsEnableDrafts: boolean;
+    docsSetsCollectionSlug: string;
+    docsSetsEnabled: boolean;
+    endpointPath: string;
+    getNow?: () => Date;
+    markdownFieldName: string;
+    maxBodyBytes?: number;
+    maxSkewSeconds?: number;
+    noncesCollectionSlug: string;
+    noncesEnabled: boolean;
+    nonceTtlSeconds?: number;
+    oidcFetchJson?: FetchJson;
+    requireDryRunBeforeApply?: boolean;
+    routeBase?: string;
+    routing?: {
+        pages?: {
+            allowBridgePages: boolean;
+            bridgeField: string;
+            collection: string;
+            enabled: boolean;
+            routeField: string;
+        };
+    };
+    sources?: {
+        id: string;
+        root?: string;
+        routeBase: string;
+    }[];
+    syncRunsCollectionSlug: string;
+    syncRunsEnabled: boolean;
+};
+export declare const createSyncEndpoint: (options: CreateSyncEndpointOptions) => Endpoint;