@valkyrianlabs/payload-markdown-docs 0.3.1 → 0.4.0

package/dist/types.d.ts

@@ -4,7 +4,6 @@ export type PayloadMarkdownDocsConfig = {
     enabled?: boolean;
     endpoint?: PayloadMarkdownDocsEndpointConfig;
     routing?: PayloadMarkdownDocsRoutingConfig;
-    sources?: PayloadMarkdownDocsSourceConfig[];
     sync?: PayloadMarkdownDocsSyncConfig;
     target?: PayloadMarkdownDocsTargetConfig;
 };
@@ -13,47 +12,13 @@ export type PayloadMarkdownDocsEndpointConfig = {
     path?: string;
 };
 export type PayloadMarkdownDocsAuthConfig = {
+    ed25519?: boolean | PayloadMarkdownDocsAuthToggle;
+    githubOidc?: boolean | PayloadMarkdownDocsAuthToggle;
+} | {
     mode: 'disabled';
-} | PayloadMarkdownDocsCombinedAuthConfig | PayloadMarkdownDocsEd25519AuthConfig | PayloadMarkdownDocsGitHubOidcAuthConfig;
-export type PayloadMarkdownDocsCombinedAuthConfig = {
-    ed25519?: PayloadMarkdownDocsEd25519AuthOptions;
-    githubOidc?: PayloadMarkdownDocsGitHubOidcAuthOptions;
-    mode?: 'multi';
-};
-export type PayloadMarkdownDocsDocsSetAuthConfig = {
-    ed25519?: PayloadMarkdownDocsEd25519AuthOptions;
-    githubOidc?: PayloadMarkdownDocsDocsSetGitHubOidcAuthOptions;
 };
-export type PayloadMarkdownDocsDocsSetGitHubOidcAuthOptions = {
+export type PayloadMarkdownDocsAuthToggle = {
     enabled?: boolean;
-} & Partial<PayloadMarkdownDocsGitHubOidcAuthOptions>;
-export type PayloadMarkdownDocsEd25519AuthConfig = {
-    mode: 'ed25519';
-} & PayloadMarkdownDocsEd25519AuthOptions;
-export type PayloadMarkdownDocsEd25519AuthOptions = {
-    keys: PayloadMarkdownDocsEd25519Key[];
-    maxSkewSeconds?: number;
-    nonceTtlSeconds?: number;
-};
-export type PayloadMarkdownDocsEd25519Key = {
-    id: string;
-    publicKey: string;
-};
-export type PayloadMarkdownDocsGitHubOidcAuthConfig = {
-    mode: 'github-oidc';
-} & PayloadMarkdownDocsGitHubOidcAuthOptions;
-export type PayloadMarkdownDocsGitHubOidcAuthOptions = {
-    allowedEnvironments?: string[];
-    allowedRefs?: string[];
-    allowedRepositories?: string[];
-    allowedRepositoryOwners?: string[];
-    allowedWorkflowRefs?: string[];
-    allowedWorkflows?: string[];
-    allowPullRequests?: boolean;
-    audience: string;
-    issuer?: string;
-    jwksUrl?: string;
-    maxSkewSeconds?: number;
 };
 export type PayloadMarkdownDocsCollectionConfig = {
     enabled?: boolean;
@@ -62,7 +27,9 @@ export type PayloadMarkdownDocsCollectionConfig = {
 export type PayloadMarkdownDocsCollectionsConfig = {
     docs?: PayloadMarkdownDocsCollectionConfig;
     docsGroups?: PayloadMarkdownDocsCollectionConfig;
+    docsKeys?: PayloadMarkdownDocsCollectionConfig;
     docsSets?: PayloadMarkdownDocsCollectionConfig;
+    docsTrusted?: PayloadMarkdownDocsCollectionConfig;
     nonces?: PayloadMarkdownDocsCollectionConfig;
     syncRuns?: PayloadMarkdownDocsCollectionConfig;
 };
@@ -76,21 +43,11 @@ export type PayloadMarkdownDocsPagesRoutingConfig = {
 export type PayloadMarkdownDocsRoutingConfig = {
     pages?: PayloadMarkdownDocsPagesRoutingConfig;
 };
-export type PayloadMarkdownDocsSourceConfig = {
-    id: string;
-    root?: string;
-    routeBase: string;
-};
 export type PayloadMarkdownDocsTargetConfig = {
-    collection: string;
-    markdownField: string;
-    routeField?: string;
-    type: 'existingCollection';
-} | {
     enableDrafts?: boolean;
     markdownField?: string;
     slug?: string;
-    type: 'docsCollection';
+    type?: 'docsCollection';
 };
 export type PayloadMarkdownDocsSyncConfig = {
     allowHardDelete?: boolean;

package/dist/types.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/types.ts"],"sourcesContent":["export type PayloadMarkdownDocsConfig = {\n  auth?: PayloadMarkdownDocsAuthConfig\n  collections?: PayloadMarkdownDocsCollectionsConfig\n  enabled?: boolean\n  endpoint?: PayloadMarkdownDocsEndpointConfig\n  routing?: PayloadMarkdownDocsRoutingConfig\n  sources?: PayloadMarkdownDocsSourceConfig[]\n  sync?: PayloadMarkdownDocsSyncConfig\n  target?: PayloadMarkdownDocsTargetConfig\n}\n\nexport type PayloadMarkdownDocsEndpointConfig = {\n  maxBodyBytes?: number\n  path?: string\n}\n\nexport type PayloadMarkdownDocsAuthConfig =\n  | {\n      mode: 'disabled'\n    }\n  | PayloadMarkdownDocsCombinedAuthConfig\n  | PayloadMarkdownDocsEd25519AuthConfig\n  | PayloadMarkdownDocsGitHubOidcAuthConfig\n\nexport type PayloadMarkdownDocsCombinedAuthConfig = {\n  ed25519?: PayloadMarkdownDocsEd25519AuthOptions\n  githubOidc?: PayloadMarkdownDocsGitHubOidcAuthOptions\n  mode?: 'multi'\n}\n\nexport type PayloadMarkdownDocsDocsSetAuthConfig = {\n  ed25519?: PayloadMarkdownDocsEd25519AuthOptions\n  githubOidc?: PayloadMarkdownDocsDocsSetGitHubOidcAuthOptions\n}\n\nexport type PayloadMarkdownDocsDocsSetGitHubOidcAuthOptions =\n  {\n    enabled?: boolean\n  } & Partial<PayloadMarkdownDocsGitHubOidcAuthOptions>\n\nexport type PayloadMarkdownDocsEd25519AuthConfig =\n  {\n    mode: 'ed25519'\n  } & PayloadMarkdownDocsEd25519AuthOptions\n\nexport type PayloadMarkdownDocsEd25519AuthOptions = {\n  keys: PayloadMarkdownDocsEd25519Key[]\n  maxSkewSeconds?: number\n  nonceTtlSeconds?: number\n}\n\nexport type PayloadMarkdownDocsEd25519Key = {\n  id: string\n  publicKey: string\n}\n\nexport type PayloadMarkdownDocsGitHubOidcAuthConfig =\n  {\n    mode: 'github-oidc'\n  } & PayloadMarkdownDocsGitHubOidcAuthOptions\n\nexport type PayloadMarkdownDocsGitHubOidcAuthOptions = {\n  allowedEnvironments?: string[]\n  allowedRefs?: string[]\n  allowedRepositories?: string[]\n  allowedRepositoryOwners?: string[]\n  allowedWorkflowRefs?: string[]\n  allowedWorkflows?: string[]\n  allowPullRequests?: boolean\n  audience: string\n  issuer?: string\n  jwksUrl?: string\n  maxSkewSeconds?: number\n}\n\nexport type PayloadMarkdownDocsCollectionConfig = {\n  enabled?: boolean\n  slug?: string\n}\n\nexport type PayloadMarkdownDocsCollectionsConfig = {\n  docs?: PayloadMarkdownDocsCollectionConfig\n  docsGroups?: PayloadMarkdownDocsCollectionConfig\n  docsSets?: PayloadMarkdownDocsCollectionConfig\n  nonces?: PayloadMarkdownDocsCollectionConfig\n  syncRuns?: PayloadMarkdownDocsCollectionConfig\n}\n\nexport type PayloadMarkdownDocsPagesRoutingConfig = {\n  allowBridgePages?: boolean\n  bridgeField?: string\n  collection?: string\n  enabled?: boolean\n  routeField?: string\n}\n\nexport type PayloadMarkdownDocsRoutingConfig = {\n  pages?: PayloadMarkdownDocsPagesRoutingConfig\n}\n\nexport type PayloadMarkdownDocsSourceConfig = {\n  id: string\n  root?: string\n  routeBase: string\n}\n\nexport type PayloadMarkdownDocsTargetConfig =\n  | {\n      collection: string\n      markdownField: string\n      routeField?: string\n      type: 'existingCollection'\n    }\n  | {\n      enableDrafts?: boolean\n      markdownField?: string\n      slug?: string\n      type: 'docsCollection'\n    }\n\nexport type PayloadMarkdownDocsSyncConfig = {\n  allowHardDelete?: boolean\n  allowPublish?: boolean\n  allowWrites?: boolean\n  defaultPublishMode?: 'draft' | 'preserve' | 'published'\n  deleteBehavior?: 'archive' | 'delete' | 'draft' | 'ignore'\n  requireDryRunBeforeApply?: boolean\n}\n"],"names":[],"mappings":"AAwHA,WAOC"}
+{"version":3,"sources":["../src/types.ts"],"sourcesContent":["export type PayloadMarkdownDocsConfig = {\n  auth?: PayloadMarkdownDocsAuthConfig\n  collections?: PayloadMarkdownDocsCollectionsConfig\n  enabled?: boolean\n  endpoint?: PayloadMarkdownDocsEndpointConfig\n  routing?: PayloadMarkdownDocsRoutingConfig\n  sync?: PayloadMarkdownDocsSyncConfig\n  target?: PayloadMarkdownDocsTargetConfig\n}\n\nexport type PayloadMarkdownDocsEndpointConfig = {\n  maxBodyBytes?: number\n  path?: string\n}\n\nexport type PayloadMarkdownDocsAuthConfig =\n  | {\n      ed25519?: boolean | PayloadMarkdownDocsAuthToggle\n      githubOidc?: boolean | PayloadMarkdownDocsAuthToggle\n    }\n  | {\n      mode: 'disabled'\n    }\n\nexport type PayloadMarkdownDocsAuthToggle = {\n  enabled?: boolean\n}\n\nexport type PayloadMarkdownDocsCollectionConfig = {\n  enabled?: boolean\n  slug?: string\n}\n\nexport type PayloadMarkdownDocsCollectionsConfig = {\n  docs?: PayloadMarkdownDocsCollectionConfig\n  docsGroups?: PayloadMarkdownDocsCollectionConfig\n  docsKeys?: PayloadMarkdownDocsCollectionConfig\n  docsSets?: PayloadMarkdownDocsCollectionConfig\n  docsTrusted?: PayloadMarkdownDocsCollectionConfig\n  nonces?: PayloadMarkdownDocsCollectionConfig\n  syncRuns?: PayloadMarkdownDocsCollectionConfig\n}\n\nexport type PayloadMarkdownDocsPagesRoutingConfig = {\n  allowBridgePages?: boolean\n  bridgeField?: string\n  collection?: string\n  enabled?: boolean\n  routeField?: string\n}\n\nexport type PayloadMarkdownDocsRoutingConfig = {\n  pages?: PayloadMarkdownDocsPagesRoutingConfig\n}\n\nexport type PayloadMarkdownDocsTargetConfig =\n  {\n    enableDrafts?: boolean\n    markdownField?: string\n    slug?: string\n    type?: 'docsCollection'\n  }\n\nexport type PayloadMarkdownDocsSyncConfig = {\n  allowHardDelete?: boolean\n  allowPublish?: boolean\n  allowWrites?: boolean\n  defaultPublishMode?: 'draft' | 'preserve' | 'published'\n  deleteBehavior?: 'archive' | 'delete' | 'draft' | 'ignore'\n  requireDryRunBeforeApply?: boolean\n}\n"],"names":[],"mappings":"AA+DA,WAOC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@valkyrianlabs/payload-markdown-docs",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "description": "Git-backed Markdown documentation sync for Payload CMS, powered by payload-markdown.",
   "bin": {
     "payload-markdown-docs": "./dist/cli/index.js"
@@ -48,11 +48,11 @@
     "copyfiles": "copyfiles -u 1 \"src/**/*.{html,css,scss,ttf,woff,woff2,eot,svg,jpg,png,json,md}\" dist/",
     "dev": "next dev dev --turbo",
     "dev:docs:keygen": "pnpm dev:payload run ./dev/scripts/create-docs-keypair.ts",
-    "dev:docs:manifest": "node --import @swc-node/register/esm-register ./src/cli/index.ts manifest ./dev/docs-fixtures/basic --source payload-markdown-docs --root docs --route-base /plugins/payload-markdown-docs --pretty",
-    "dev:docs:plan": "node --import @swc-node/register/esm-register ./src/cli/index.ts plan ./dev/docs-fixtures/basic --source payload-markdown-docs --root docs --route-base /plugins/payload-markdown-docs",
+    "dev:docs:manifest": "node --import @swc-node/register/esm-register ./src/cli/index.ts manifest ./dev/docs-fixtures/basic --source payload-markdown-docs --pretty",
+    "dev:docs:plan": "node --import @swc-node/register/esm-register ./src/cli/index.ts plan ./dev/docs-fixtures/basic --source payload-markdown-docs",
     "dev:docs:reset": "pnpm dev:payload run ./dev/scripts/reset-docs.ts",
     "dev:docs:seed": "pnpm dev:payload run ./dev/scripts/seed-docs.ts",
-    "dev:docs:validate": "node --import @swc-node/register/esm-register ./src/cli/index.ts validate ./dev/docs-fixtures/basic --source payload-markdown-docs --root docs --route-base /plugins/payload-markdown-docs",
+    "dev:docs:validate": "node --import @swc-node/register/esm-register ./src/cli/index.ts validate ./dev/docs-fixtures/basic --source payload-markdown-docs",
     "dev:generate-importmap": "pnpm dev:payload generate:importmap",
     "dev:generate-types": "pnpm dev:payload generate:types",
     "dev:payload": "cross-env PAYLOAD_CONFIG_PATH=./dev/payload.config.ts payload",