@oa-sdk/spec-bundler 0.1.0

package/dist/schema.d.ts

@@ -0,0 +1,563 @@
+export declare const BUNDLE_MANIFEST_SCHEMA: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $id: "https://spec-platform.org/schemas/bundle-manifest.v1.json";
+    readonly title: "BundleManifest";
+    readonly description: "Declarative configuration schema for @spec-platform/meta-bundler";
+    readonly type: "object";
+    readonly required: readonly ["name", "version", "output", "targets"];
+    readonly properties: {
+        readonly $schema: {
+            readonly type: "string";
+        };
+        readonly name: {
+            readonly type: "string";
+            readonly description: "Identifier name for the bundle";
+        };
+        readonly version: {
+            readonly type: "string";
+            readonly description: "Semantic version of the bundle";
+        };
+        readonly description: {
+            readonly type: "string";
+            readonly description: "Human-readable description";
+        };
+        readonly output: {
+            readonly type: "string";
+            readonly description: "Output zip archive or directory path relative to manifest";
+        };
+        readonly format: {
+            readonly type: "string";
+            readonly enum: readonly ["zip", "directory"];
+            readonly default: "zip";
+            readonly description: "Output bundle format";
+        };
+        readonly targets: {
+            readonly type: "array";
+            readonly description: "List of target file mappings";
+            readonly items: {
+                readonly type: "object";
+                readonly required: readonly ["source", "dest"];
+                readonly properties: {
+                    readonly source: {
+                        readonly type: "string";
+                        readonly description: "Source file path or glob pattern relative to manifest directory";
+                    };
+                    readonly dest: {
+                        readonly type: "string";
+                        readonly description: "Destination directory or file path inside bundle";
+                    };
+                    readonly exclude: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "string";
+                        };
+                        readonly description: "Target-specific exclusion glob patterns";
+                    };
+                };
+                readonly additionalProperties: false;
+            };
+        };
+        readonly exclude: {
+            readonly type: "array";
+            readonly items: {
+                readonly type: "string";
+            };
+            readonly description: "Global exclusion glob patterns";
+        };
+        readonly deduplicate: {
+            readonly type: "object";
+            readonly description: "Deduplication and collision resolution rules";
+            readonly properties: {
+                readonly byPath: {
+                    readonly type: "string";
+                    readonly enum: readonly ["warn-overwrite", "overwrite", "error"];
+                    readonly default: "warn-overwrite";
+                    readonly description: "Collision handling strategy when two sources map to same destination";
+                };
+                readonly byContentHash: {
+                    readonly type: "boolean";
+                    readonly default: true;
+                    readonly description: "Whether to report content hash duplicates";
+                };
+            };
+            readonly additionalProperties: false;
+        };
+        readonly linkResolution: {
+            readonly type: "object";
+            readonly description: "Markdown link rewriting and resolution configuration";
+            readonly properties: {
+                readonly enabled: {
+                    readonly type: "boolean";
+                    readonly default: true;
+                    readonly description: "Whether automatic link resolution is enabled";
+                };
+                readonly rewriteRelativeLinks: {
+                    readonly type: "boolean";
+                    readonly default: true;
+                    readonly description: "Whether to rewrite relative links to bundle coordinates";
+                };
+                readonly normalizeFileSchemes: {
+                    readonly type: "boolean";
+                    readonly default: true;
+                    readonly description: "Whether to normalize file:/// URIs";
+                };
+                readonly unbundledPolicy: {
+                    readonly type: "string";
+                    readonly enum: readonly ["warn", "error", "preserve", "github-fallback"];
+                    readonly default: "warn";
+                    readonly description: "Handling strategy for links pointing to unbundled files";
+                };
+                readonly gitRepositoryUrl: {
+                    readonly type: "string";
+                    readonly description: "Base remote GitHub repository URL for github-fallback policy";
+                };
+            };
+            readonly additionalProperties: false;
+        };
+        readonly treeShake: {
+            readonly type: "object";
+            readonly description: "Declarative tree-shaking reachability configuration";
+            readonly required: readonly ["entrypoints"];
+            readonly properties: {
+                readonly enabled: {
+                    readonly type: "boolean";
+                    readonly default: false;
+                    readonly description: "Whether tree-shaking reachability pruning is enabled";
+                };
+                readonly entrypoints: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                    readonly description: "Entrypoint files from which reachability traversal begins";
+                };
+                readonly scope: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                    readonly description: "Boundary scope patterns allowed to be pulled into the bundle";
+                };
+                readonly stopAt: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                    readonly description: "Terminal boundary patterns where traversal immediately halts";
+                };
+                readonly maxDepth: {
+                    readonly type: "integer";
+                    readonly minimum: 1;
+                    readonly description: "Maximum traversal hop depth from entrypoints";
+                };
+                readonly preserve: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                    readonly description: "Unconditionally preserved file patterns exempt from tree-shaking pruning";
+                };
+                readonly reportEliminated: {
+                    readonly type: "boolean";
+                    readonly default: true;
+                    readonly description: "Whether to list eliminated files in output report";
+                };
+                readonly traversalMode: {
+                    readonly type: "string";
+                    readonly enum: readonly ["hybrid", "reachability", "explicit"];
+                    readonly default: "hybrid";
+                    readonly description: "Reachability traversal mode: hybrid (preserve targets), reachability, or explicit";
+                };
+                readonly preserveTargets: {
+                    readonly type: "boolean";
+                    readonly default: true;
+                    readonly description: "Whether to unconditionally preserve all declared targets";
+                };
+            };
+            readonly additionalProperties: false;
+        };
+        readonly topics: {
+            readonly type: "object";
+            readonly description: "Declarative named topic profiles for repeatable modular documentation bundling";
+            readonly additionalProperties: {
+                readonly type: "object";
+                readonly required: readonly ["targets"];
+                readonly properties: {
+                    readonly phase: {
+                        readonly type: "string";
+                        readonly enum: readonly ["develop", "fix", "test", "review"];
+                        readonly description: "Work activity lifecycle phase designated for this topic";
+                    };
+                    readonly author: {
+                        readonly type: "string";
+                        readonly description: "Initial worker or author who established this topic definition";
+                    };
+                    readonly description: {
+                        readonly type: "string";
+                        readonly description: "Human-readable description of the topic";
+                    };
+                    readonly output: {
+                        readonly type: "string";
+                        readonly description: "Output zip archive or directory path relative to manifest";
+                    };
+                    readonly format: {
+                        readonly type: "string";
+                        readonly enum: readonly ["zip", "directory"];
+                        readonly description: "Output bundle format";
+                    };
+                    readonly targets: {
+                        readonly type: "array";
+                        readonly description: "List of target file mappings designated for this topic";
+                        readonly items: {
+                            readonly type: "object";
+                            readonly required: readonly ["source", "dest"];
+                            readonly properties: {
+                                readonly source: {
+                                    readonly type: "string";
+                                    readonly description: "Source file path or glob pattern relative to manifest directory";
+                                };
+                                readonly dest: {
+                                    readonly type: "string";
+                                    readonly description: "Destination directory or file path inside bundle";
+                                };
+                                readonly exclude: {
+                                    readonly type: "array";
+                                    readonly items: {
+                                        readonly type: "string";
+                                    };
+                                    readonly description: "Target-specific exclusion glob patterns";
+                                };
+                            };
+                            readonly additionalProperties: false;
+                        };
+                    };
+                    readonly exclude: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "string";
+                        };
+                        readonly description: "Topic-specific exclusion glob patterns";
+                    };
+                    readonly deduplicate: {
+                        readonly type: "object";
+                        readonly description: "Deduplication and collision resolution rules";
+                        readonly properties: {
+                            readonly byPath: {
+                                readonly type: "string";
+                                readonly enum: readonly ["warn-overwrite", "overwrite", "error"];
+                                readonly default: "warn-overwrite";
+                            };
+                            readonly byContentHash: {
+                                readonly type: "boolean";
+                                readonly default: true;
+                            };
+                        };
+                        readonly additionalProperties: false;
+                    };
+                    readonly linkResolution: {
+                        readonly type: "object";
+                        readonly description: "Markdown link rewriting and resolution configuration";
+                        readonly properties: {
+                            readonly enabled: {
+                                readonly type: "boolean";
+                                readonly default: true;
+                            };
+                            readonly rewriteRelativeLinks: {
+                                readonly type: "boolean";
+                                readonly default: true;
+                            };
+                            readonly normalizeFileSchemes: {
+                                readonly type: "boolean";
+                                readonly default: true;
+                            };
+                            readonly unbundledPolicy: {
+                                readonly type: "string";
+                                readonly enum: readonly ["warn", "error", "preserve", "github-fallback"];
+                                readonly default: "warn";
+                            };
+                            readonly gitRepositoryUrl: {
+                                readonly type: "string";
+                            };
+                        };
+                        readonly additionalProperties: false;
+                    };
+                    readonly treeShake: {
+                        readonly type: "object";
+                        readonly description: "Topic-specific tree-shaking and boundary-scoped reachability configuration";
+                        readonly required: readonly ["entrypoints"];
+                        readonly properties: {
+                            readonly enabled: {
+                                readonly type: "boolean";
+                                readonly default: true;
+                            };
+                            readonly entrypoints: {
+                                readonly type: "array";
+                                readonly items: {
+                                    readonly type: "string";
+                                };
+                                readonly description: "Entrypoint files from which reachability traversal begins";
+                            };
+                            readonly scope: {
+                                readonly type: "array";
+                                readonly items: {
+                                    readonly type: "string";
+                                };
+                                readonly description: "Boundary scope patterns allowed to be pulled into this topic";
+                            };
+                            readonly stopAt: {
+                                readonly type: "array";
+                                readonly items: {
+                                    readonly type: "string";
+                                };
+                                readonly description: "Terminal boundary patterns where traversal immediately halts";
+                            };
+                            readonly maxDepth: {
+                                readonly type: "integer";
+                                readonly minimum: 1;
+                                readonly description: "Maximum traversal hop depth from entrypoints";
+                            };
+                            readonly preserve: {
+                                readonly type: "array";
+                                readonly items: {
+                                    readonly type: "string";
+                                };
+                                readonly description: "Unconditionally preserved file patterns exempt from tree-shaking pruning";
+                            };
+                            readonly reportEliminated: {
+                                readonly type: "boolean";
+                                readonly default: true;
+                                readonly description: "Whether to list eliminated files in output report";
+                            };
+                            readonly traversalMode: {
+                                readonly type: "string";
+                                readonly enum: readonly ["hybrid", "reachability", "explicit"];
+                                readonly default: "hybrid";
+                            };
+                            readonly preserveTargets: {
+                                readonly type: "boolean";
+                                readonly default: true;
+                            };
+                        };
+                        readonly additionalProperties: false;
+                    };
+                    readonly scope: {
+                        readonly type: "object";
+                        readonly description: "Declarative extraction scope and domain boundary configuration";
+                        readonly properties: {
+                            readonly entrypoints: {
+                                readonly type: "array";
+                                readonly items: {
+                                    readonly type: "string";
+                                };
+                                readonly description: "Entrypoint files from which extraction traversal begins";
+                            };
+                            readonly include: {
+                                readonly type: "array";
+                                readonly items: {
+                                    readonly type: "string";
+                                };
+                                readonly description: "Allowed boundary patterns for documents pulled into this topic";
+                            };
+                            readonly exclude: {
+                                readonly type: "array";
+                                readonly items: {
+                                    readonly type: "string";
+                                };
+                                readonly description: "Patterns strictly excluded from this topic";
+                            };
+                            readonly stopAt: {
+                                readonly type: "array";
+                                readonly items: {
+                                    readonly type: "string";
+                                };
+                                readonly description: "Terminal boundary patterns where traversal immediately halts";
+                            };
+                            readonly maxDepth: {
+                                readonly type: "integer";
+                                readonly minimum: 1;
+                                readonly description: "Maximum traversal hop depth from entrypoints";
+                            };
+                            readonly sections: {
+                                readonly type: "array";
+                                readonly items: {
+                                    readonly type: "string";
+                                };
+                                readonly description: "Section/heading patterns to slice from multi-topic documents";
+                            };
+                            readonly direction: {
+                                readonly type: "string";
+                                readonly enum: readonly ["downstream", "upstream", "bidirectional"];
+                                readonly default: "downstream";
+                                readonly description: "Graph reachability traversal direction";
+                            };
+                            readonly upstreamDepth: {
+                                readonly type: "integer";
+                                readonly minimum: 1;
+                                readonly default: 1;
+                                readonly description: "Maximum traversal depth when traversing upstream";
+                            };
+                            readonly includeCategories: {
+                                readonly type: "array";
+                                readonly items: {
+                                    readonly type: "string";
+                                    readonly enum: readonly ["feature", "mechanism", "error", "issue", "convention"];
+                                };
+                                readonly description: "Document categories permitted in topic bundle";
+                            };
+                            readonly excludeCategories: {
+                                readonly type: "array";
+                                readonly items: {
+                                    readonly type: "string";
+                                    readonly enum: readonly ["feature", "mechanism", "error", "issue", "convention"];
+                                };
+                                readonly description: "Document categories strictly pruned from topic bundle";
+                            };
+                            readonly categoryFidelity: {
+                                readonly type: "object";
+                                readonly description: "Level of detail/fidelity per category or upstream contracts";
+                                readonly properties: {
+                                    readonly feature: {
+                                        readonly type: "string";
+                                        readonly enum: readonly ["full", "contract-only", "summary"];
+                                    };
+                                    readonly mechanism: {
+                                        readonly type: "string";
+                                        readonly enum: readonly ["full", "contract-only", "summary"];
+                                    };
+                                    readonly error: {
+                                        readonly type: "string";
+                                        readonly enum: readonly ["full", "contract-only", "summary"];
+                                    };
+                                    readonly issue: {
+                                        readonly type: "string";
+                                        readonly enum: readonly ["full", "contract-only", "summary"];
+                                    };
+                                    readonly convention: {
+                                        readonly type: "string";
+                                        readonly enum: readonly ["full", "contract-only", "summary"];
+                                    };
+                                    readonly upstream: {
+                                        readonly type: "string";
+                                        readonly enum: readonly ["full", "contract-only", "summary"];
+                                    };
+                                    readonly default: {
+                                        readonly type: "string";
+                                        readonly enum: readonly ["full", "contract-only", "summary"];
+                                    };
+                                };
+                                readonly additionalProperties: false;
+                            };
+                            readonly traversalMode: {
+                                readonly type: "string";
+                                readonly enum: readonly ["hybrid", "reachability", "explicit"];
+                                readonly default: "hybrid";
+                            };
+                            readonly preserveTargets: {
+                                readonly type: "boolean";
+                                readonly default: true;
+                            };
+                        };
+                        readonly additionalProperties: false;
+                    };
+                    readonly context: {
+                        readonly type: "object";
+                        readonly description: "Ambient background context, metadata, prompt, and documentation";
+                        readonly properties: {
+                            readonly description: {
+                                readonly type: "string";
+                                readonly description: "Context description";
+                            };
+                            readonly template: {
+                                readonly type: "string";
+                                readonly description: "Custom CONTEXT.md template file path relative to manifest, or raw template string";
+                            };
+                            readonly domain: {
+                                readonly type: "string";
+                                readonly description: "Target domain identifier";
+                            };
+                            readonly issue: {
+                                readonly type: "string";
+                                readonly description: "Associated issue/ticket ID";
+                            };
+                            readonly tags: {
+                                readonly type: "array";
+                                readonly items: {
+                                    readonly type: "string";
+                                };
+                                readonly description: "Category tags";
+                            };
+                            readonly prompt: {
+                                readonly type: "string";
+                                readonly description: "Agent system prompt or developer instructions";
+                            };
+                            readonly persona: {
+                                readonly type: "string";
+                                readonly description: "Target persona or role";
+                            };
+                            readonly prerequisites: {
+                                readonly type: "array";
+                                readonly items: {
+                                    readonly type: "string";
+                                };
+                                readonly description: "Dependent topic names or prerequisites";
+                            };
+                            readonly generateContextDoc: {
+                                readonly type: "boolean";
+                                readonly default: true;
+                                readonly description: "Whether to synthesize CONTEXT.md at bundle root";
+                            };
+                            readonly metadata: {
+                                readonly type: "object";
+                                readonly description: "Arbitrary structured metadata";
+                            };
+                            readonly docs: {
+                                readonly type: "array";
+                                readonly description: "Ambient background context documents";
+                                readonly items: {
+                                    readonly type: "object";
+                                    readonly required: readonly ["source"];
+                                    readonly properties: {
+                                        readonly source: {
+                                            readonly type: "string";
+                                            readonly description: "Source path or glob pattern";
+                                        };
+                                        readonly dest: {
+                                            readonly type: "string";
+                                            readonly description: "Destination inside bundle (defaults to 'context/')";
+                                        };
+                                        readonly exclude: {
+                                            readonly type: "array";
+                                            readonly items: {
+                                                readonly type: "string";
+                                            };
+                                            readonly description: "Exclusion patterns";
+                                        };
+                                    };
+                                    readonly additionalProperties: false;
+                                };
+                            };
+                        };
+                        readonly additionalProperties: false;
+                    };
+                };
+                readonly additionalProperties: false;
+            };
+        };
+        readonly lockfileMode: {
+            readonly type: "string";
+            readonly enum: readonly ["consolidated", "split"];
+            readonly default: "consolidated";
+            readonly description: "Lockfile storage mode (consolidated into bundle.manifest.lock.json or split per topic)";
+        };
+    };
+    readonly additionalProperties: false;
+};
+/**
+ * Emits the JSON Schema 2020-12 as formatted JSON string.
+ */
+export declare function emitJsonSchema(): string;
+/**
+ * Validates a manifest object against schema invariants and returns a list of human-readable errors.
+ */
+export declare function validateManifestSchema(raw: any): string[];
+//# sourceMappingURL=schema.d.ts.map