@libar-dev/architect 1.0.0-pre.3 → 1.0.0-pre.5

package/dist/renderable/generate.d.ts

@@ -1,338 +0,0 @@
-/**
- * @architect
- * @architect-core
- * @architect-pattern DocumentGenerator
- * @architect-status completed
- * @architect-arch-role service
- * @architect-arch-context renderer
- * @architect-arch-layer application
- *
- * ## Document Generation
- *
- * Simplified document generation using codecs.
- * Replaces the complex BuiltInGenerator + SectionRegistry pattern.
- *
- * ### When to Use
- *
- * - When generating specific document types from MasterDataset
- * - When needing high-level generation API without direct codec usage
- * - When building custom documentation workflows
- *
- * Flow: MasterDataset → Codec → RenderableDocument → Renderer → Markdown
- */
-import type { MasterDataset } from '../validation-schemas/master-dataset.js';
-import { type OutputFile } from './render.js';
-import { Result } from '../types/result.js';
-import type { PatternsCodecOptions, RoadmapCodecOptions, CompletedMilestonesCodecOptions, CurrentWorkCodecOptions, RequirementsCodecOptions, SessionCodecOptions, RemainingWorkCodecOptions, PrChangesCodecOptions, AdrCodecOptions, PlanningChecklistCodecOptions, SessionPlanCodecOptions, SessionFindingsCodecOptions, ChangelogCodecOptions, TraceabilityCodecOptions, OverviewCodecOptions, BusinessRulesCodecOptions, ArchitectureCodecOptions, TaxonomyCodecOptions, ValidationRulesCodecOptions, ClaudeModuleCodecOptions, IndexCodecOptions } from './codecs/index.js';
-import type { DocumentCodec, BaseCodecOptions } from './codecs/types/base.js';
-/**
- * Available document types and their output paths
- */
-export declare const DOCUMENT_TYPES: {
-    readonly patterns: {
-        readonly outputPath: "PATTERNS.md";
-        readonly description: "Pattern registry with category details";
-    };
-    readonly roadmap: {
-        readonly outputPath: "ROADMAP.md";
-        readonly description: "Development roadmap by phase";
-    };
-    readonly milestones: {
-        readonly outputPath: "COMPLETED-MILESTONES.md";
-        readonly description: "Historical completed milestones";
-    };
-    readonly current: {
-        readonly outputPath: "CURRENT-WORK.md";
-        readonly description: "Active development work in progress";
-    };
-    readonly requirements: {
-        readonly outputPath: "PRODUCT-REQUIREMENTS.md";
-        readonly description: "Product requirements by area/role";
-    };
-    readonly session: {
-        readonly outputPath: "SESSION-CONTEXT.md";
-        readonly description: "Current session context and focus";
-    };
-    readonly remaining: {
-        readonly outputPath: "REMAINING-WORK.md";
-        readonly description: "Aggregate view of incomplete work";
-    };
-    readonly 'pr-changes': {
-        readonly outputPath: "working/PR-CHANGES.md";
-        readonly description: "PR-scoped changes for review";
-    };
-    readonly adrs: {
-        readonly outputPath: "DECISIONS.md";
-        readonly description: "Architecture Decision Records";
-    };
-    readonly 'planning-checklist': {
-        readonly outputPath: "PLANNING-CHECKLIST.md";
-        readonly description: "Pre-planning questions and Definition of Done";
-    };
-    readonly 'session-plan': {
-        readonly outputPath: "SESSION-PLAN.md";
-        readonly description: "Implementation plans for phases";
-    };
-    readonly 'session-findings': {
-        readonly outputPath: "SESSION-FINDINGS.md";
-        readonly description: "Retrospective discoveries for roadmap refinement";
-    };
-    readonly changelog: {
-        readonly outputPath: "CHANGELOG-GENERATED.md";
-        readonly description: "Keep a Changelog format changelog";
-    };
-    readonly traceability: {
-        readonly outputPath: "TRACEABILITY.md";
-        readonly description: "Timeline to behavior file coverage";
-    };
-    readonly overview: {
-        readonly outputPath: "OVERVIEW.md";
-        readonly description: "Project architecture overview";
-    };
-    readonly 'business-rules': {
-        readonly outputPath: "BUSINESS-RULES.md";
-        readonly description: "Business rules and invariants by domain";
-    };
-    readonly architecture: {
-        readonly outputPath: "ARCHITECTURE.md";
-        readonly description: "Architecture diagrams (component and layered views)";
-    };
-    readonly taxonomy: {
-        readonly outputPath: "TAXONOMY.md";
-        readonly description: "Tag taxonomy configuration reference";
-    };
-    readonly 'validation-rules': {
-        readonly outputPath: "VALIDATION-RULES.md";
-        readonly description: "Process Guard validation rules reference";
-    };
-    readonly 'claude-modules': {
-        readonly outputPath: "CLAUDE-MODULES.md";
-        readonly description: "CLAUDE.md modules generated from annotated behavior specs";
-    };
-    readonly index: {
-        readonly outputPath: "INDEX.md";
-        readonly description: "Navigation hub with editorial preamble and MasterDataset statistics";
-    };
-};
-export type DocumentType = keyof typeof DOCUMENT_TYPES;
-/**
- * Union type for all codec-specific options.
- * Used to pass runtime options (e.g., changedFiles for PR changes) through
- * the CLI → Orchestrator → Generator → Codec pipeline.
- *
- * Each document type can optionally have its own options.
- * If options are provided for a document type, the factory function is used
- * instead of the default codec instance.
- *
- * @example
- * ```typescript
- * const options: CodecOptions = {
- *   "pr-changes": { changedFiles: ["src/foo.ts"], releaseFilter: "v0.2.0" }
- * };
- * generateDocument("pr-changes", dataset, options);
- * ```
- */
-export interface CodecOptions {
-    patterns?: PatternsCodecOptions;
-    roadmap?: RoadmapCodecOptions;
-    milestones?: CompletedMilestonesCodecOptions;
-    current?: CurrentWorkCodecOptions;
-    requirements?: RequirementsCodecOptions;
-    session?: SessionCodecOptions;
-    remaining?: RemainingWorkCodecOptions;
-    'pr-changes'?: PrChangesCodecOptions;
-    adrs?: AdrCodecOptions;
-    'planning-checklist'?: PlanningChecklistCodecOptions;
-    'session-plan'?: SessionPlanCodecOptions;
-    'session-findings'?: SessionFindingsCodecOptions;
-    changelog?: ChangelogCodecOptions;
-    traceability?: TraceabilityCodecOptions;
-    overview?: OverviewCodecOptions;
-    'business-rules'?: BusinessRulesCodecOptions;
-    architecture?: ArchitectureCodecOptions;
-    taxonomy?: TaxonomyCodecOptions;
-    'validation-rules'?: ValidationRulesCodecOptions;
-    'claude-modules'?: ClaudeModuleCodecOptions;
-    index?: IndexCodecOptions;
-}
-/**
- * Factory function type for creating codecs with options.
- */
-type CodecFactory = (opts?: BaseCodecOptions) => DocumentCodec;
-/**
- * Registry for document codecs providing a single source of truth.
- *
- * The CodecRegistry centralizes codec and factory registration, eliminating
- * the need to manually synchronize CODEC_MAP and CODEC_FACTORY_MAP.
- *
- * @example
- * ```typescript
- * // Register a codec and its factory
- * CodecRegistry.register('patterns', PatternsDocumentCodec);
- * CodecRegistry.registerFactory('patterns', createPatternsCodec);
- *
- * // Retrieve codec or factory
- * const codec = CodecRegistry.get('patterns');
- * const factory = CodecRegistry.getFactory('patterns');
- * ```
- */
-export declare const CodecRegistry: {
-    /**
-     * Register a default codec for a document type.
-     *
-     * @param type - The document type to register
-     * @param codec - The codec instance to use
-     */
-    readonly register: (type: DocumentType, codec: DocumentCodec) => void;
-    /**
-     * Register a factory function for a document type.
-     *
-     * Factory functions are used when codec options are provided,
-     * allowing customization of codec behavior at runtime.
-     *
-     * @param type - The document type to register
-     * @param factory - The factory function to create codecs with options
-     */
-    readonly registerFactory: (type: DocumentType, factory: CodecFactory) => void;
-    /**
-     * Get the default codec for a document type.
-     *
-     * @param type - The document type to retrieve
-     * @returns The codec instance, or undefined if not registered
-     */
-    readonly get: (type: DocumentType) => DocumentCodec | undefined;
-    /**
-     * Get the factory function for a document type.
-     *
-     * @param type - The document type to retrieve
-     * @returns The factory function, or undefined if not registered
-     */
-    readonly getFactory: (type: DocumentType) => CodecFactory | undefined;
-    /**
-     * Check if a codec is registered for a document type.
-     *
-     * @param type - The document type to check
-     * @returns True if a codec is registered
-     */
-    readonly has: (type: DocumentType) => boolean;
-    /**
-     * Check if a factory is registered for a document type.
-     *
-     * @param type - The document type to check
-     * @returns True if a factory is registered
-     */
-    readonly hasFactory: (type: DocumentType) => boolean;
-    /**
-     * Get all registered document types.
-     *
-     * @returns Array of registered document types
-     */
-    readonly getRegisteredTypes: () => DocumentType[];
-    /**
-     * Clear all registrations (useful for testing).
-     */
-    readonly clear: () => void;
-};
-/**
- * Error that occurred during document generation.
- *
- * Provides structured information about what went wrong during the
- * codec decode or render phase.
- */
-export interface GenerationError {
-    /** The document type that failed to generate */
-    documentType: DocumentType;
-    /** Error message describing what went wrong */
-    message: string;
-    /** The original error (if available) */
-    cause?: Error | undefined;
-    /** Phase where the error occurred */
-    phase: 'decode' | 'render';
-}
-/**
- * Generate a single document type with Result-based error handling.
- *
- * This function wraps codec.decode() and renderDocumentWithFiles() in try/catch,
- * returning a Result type instead of throwing exceptions. Use this when you need
- * explicit error handling without try/catch at the call site.
- *
- * @param type - Document type to generate
- * @param dataset - MasterDataset with pattern data
- * @param options - Optional codec-specific options
- * @returns Result containing OutputFile[] on success, or GenerationError on failure
- *
- * @example
- * ```typescript
- * const result = generateDocumentSafe("patterns", masterDataset);
- * if (Result.isOk(result)) {
- *   for (const file of result.value) {
- *     fs.writeFileSync(file.path, file.content);
- *   }
- * } else {
- *   console.error(`Failed to generate ${result.error.documentType}: ${result.error.message}`);
- * }
- * ```
- */
-export declare function generateDocumentSafe(type: DocumentType, dataset: MasterDataset, options?: CodecOptions): Result<OutputFile[], GenerationError>;
-/**
- * Generate a single document type
- *
- * @param type - Document type to generate
- * @param dataset - MasterDataset with pattern data
- * @param options - Optional codec-specific options (e.g., changedFiles for PR changes)
- * @returns Array of output files (main + additional for progressive disclosure)
- *
- * When options are provided for the requested document type, the factory function
- * is used to create a codec with custom configuration. Otherwise, the default
- * codec instance is used.
- *
- * **Error Handling:** This function may throw if codec.decode() or rendering fails.
- * For explicit error handling without exceptions, use `generateDocumentSafe()` which
- * returns a Result type instead.
- *
- * @example
- * ```typescript
- * // Without options (uses default codec)
- * const files = generateDocument("patterns", masterDataset);
- *
- * // With options (uses factory function)
- * const files = generateDocument("pr-changes", masterDataset, {
- *   "pr-changes": { changedFiles: ["src/foo.ts"], releaseFilter: "v0.2.0" }
- * });
- * ```
- */
-export declare function generateDocument(type: DocumentType, dataset: MasterDataset, options?: CodecOptions): OutputFile[];
-/**
- * Generate multiple document types
- *
- * @param types - Document types to generate
- * @param dataset - MasterDataset with pattern data
- * @param options - Optional codec-specific options
- * @returns Array of all output files
- */
-export declare function generateDocuments(types: DocumentType[], dataset: MasterDataset, options?: CodecOptions): OutputFile[];
-/**
- * Generate all document types
- *
- * @param dataset - MasterDataset with pattern data
- * @param options - Optional codec-specific options
- * @returns Array of all output files
- */
-export declare function generateAllDocuments(dataset: MasterDataset, options?: CodecOptions): OutputFile[];
-/**
- * Get available document types
- */
-export declare function getAvailableDocumentTypes(): DocumentType[];
-/**
- * Check if a string is a valid document type
- */
-export declare function isValidDocumentType(type: string): type is DocumentType;
-/**
- * Get document type info
- */
-export declare function getDocumentTypeInfo(type: DocumentType): {
-    outputPath: string;
-    description: string;
-};
-export {};
-//# sourceMappingURL=generate.d.ts.map

package/dist/renderable/generate.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"generate.d.ts","sourceRoot":"","sources":["../../src/renderable/generate.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,yCAAyC,CAAC;AAE7E,OAAO,EAAmD,KAAK,UAAU,EAAE,MAAM,aAAa,CAAC;AAC/F,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAqD5C,OAAO,KAAK,EACV,oBAAoB,EACpB,mBAAmB,EACnB,+BAA+B,EAC/B,uBAAuB,EACvB,wBAAwB,EACxB,mBAAmB,EACnB,yBAAyB,EACzB,qBAAqB,EACrB,eAAe,EACf,6BAA6B,EAC7B,uBAAuB,EACvB,2BAA2B,EAC3B,qBAAqB,EACrB,wBAAwB,EACxB,oBAAoB,EACpB,yBAAyB,EACzB,wBAAwB,EACxB,oBAAoB,EACpB,2BAA2B,EAC3B,wBAAwB,EACxB,iBAAiB,EAClB,MAAM,mBAAmB,CAAC;AAG3B,OAAO,KAAK,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAM9E;;GAEG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqFjB,CAAC;AAEX,MAAM,MAAM,YAAY,GAAG,MAAM,OAAO,cAAc,CAAC;AAevD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,EAAE,oBAAoB,CAAC;IAChC,OAAO,CAAC,EAAE,mBAAmB,CAAC;IAC9B,UAAU,CAAC,EAAE,+BAA+B,CAAC;IAC7C,OAAO,CAAC,EAAE,uBAAuB,CAAC;IAClC,YAAY,CAAC,EAAE,wBAAwB,CAAC;IACxC,OAAO,CAAC,EAAE,mBAAmB,CAAC;IAC9B,SAAS,CAAC,EAAE,yBAAyB,CAAC;IACtC,YAAY,CAAC,EAAE,qBAAqB,CAAC;IACrC,IAAI,CAAC,EAAE,eAAe,CAAC;IACvB,oBAAoB,CAAC,EAAE,6BAA6B,CAAC;IACrD,cAAc,CAAC,EAAE,uBAAuB,CAAC;IACzC,kBAAkB,CAAC,EAAE,2BAA2B,CAAC;IACjD,SAAS,CAAC,EAAE,qBAAqB,CAAC;IAClC,YAAY,CAAC,EAAE,wBAAwB,CAAC;IACxC,QAAQ,CAAC,EAAE,oBAAoB,CAAC;IAChC,gBAAgB,CAAC,EAAE,yBAAyB,CAAC;IAC7C,YAAY,CAAC,EAAE,wBAAwB,CAAC;IACxC,QAAQ,CAAC,EAAE,oBAAoB,CAAC;IAChC,kBAAkB,CAAC,EAAE,2BAA2B,CAAC;IACjD,gBAAgB,CAAC,EAAE,wBAAwB,CAAC;IAC5C,KAAK,CAAC,EAAE,iBAAiB,CAAC;CAC3B;AAMD;;GAEG;AACH,KAAK,YAAY,GAAG,CAAC,IAAI,CAAC,EAAE,gBAAgB,KAAK,aAAa,CAAC;AAM/D;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa;IACxB;;;;;OAKG;8BACY,YAAY,SAAS,aAAa,KAAG,IAAI;IAIxD;;;;;;;;OAQG;qCACmB,YAAY,WAAW,YAAY,KAAG,IAAI;IAIhE;;;;;OAKG;yBACO,YAAY,KAAG,aAAa,GAAG,SAAS;IAIlD;;;;;OAKG;gCACc,YAAY,KAAG,YAAY,GAAG,SAAS;IAIxD;;;;;OAKG;yBACO,YAAY,KAAG,OAAO;IAIhC;;;;;OAKG;gCACc,YAAY,KAAG,OAAO;IAIvC;;;;OAIG;uCACmB,YAAY,EAAE;IAIpC;;OAEG;0BACM,IAAI;CAIL,CAAC;AAwDX;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B,gDAAgD;IAChD,YAAY,EAAE,YAAY,CAAC;IAC3B,+CAA+C;IAC/C,OAAO,EAAE,MAAM,CAAC;IAChB,wCAAwC;IACxC,KAAK,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC;IAC1B,qCAAqC;IACrC,KAAK,EAAE,QAAQ,GAAG,QAAQ,CAAC;CAC5B;AAwBD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,oBAAoB,CAClC,IAAI,EAAE,YAAY,EAClB,OAAO,EAAE,aAAa,EACtB,OAAO,CAAC,EAAE,YAAY,GACrB,MAAM,CAAC,UAAU,EAAE,EAAE,eAAe,CAAC,CAsCvC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,YAAY,EAClB,OAAO,EAAE,aAAa,EACtB,OAAO,CAAC,EAAE,YAAY,GACrB,UAAU,EAAE,CAcd;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,YAAY,EAAE,EACrB,OAAO,EAAE,aAAa,EACtB,OAAO,CAAC,EAAE,YAAY,GACrB,UAAU,EAAE,CASd;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,UAAU,EAAE,CAGjG;AAMD;;GAEG;AACH,wBAAgB,yBAAyB,IAAI,YAAY,EAAE,CAE1D;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,IAAI,YAAY,CAEtE;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,YAAY,GAAG;IACvD,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;CACrB,CAEA"}