@fulmenhq/tsfulmen 0.1.6

package/dist/crucible/index.d.ts

@@ -0,0 +1,78 @@
+type AssetCategory = 'docs' | 'schemas' | 'config' | 'templates';
+interface CrucibleVersion {
+    readonly version: string;
+    readonly commit: string;
+    readonly syncedAt: string | null;
+    readonly dirty: boolean;
+    readonly syncMethod: 'local-path' | 'git-ref' | 'git-tag' | string;
+}
+interface AssetSummary {
+    readonly id: string;
+    readonly category: AssetCategory;
+    readonly path: string;
+    readonly size: number;
+    readonly modified: Date;
+    readonly checksum?: string;
+}
+interface AssetListOptions {
+    readonly prefix?: string;
+    readonly limit?: number;
+}
+interface DocumentationMetadata {
+    readonly title?: string;
+    readonly status?: string;
+    readonly tags?: readonly string[];
+    readonly author?: string;
+    readonly date?: string;
+    readonly lastUpdated?: string;
+    readonly description?: string;
+}
+interface DocumentationFilter extends AssetListOptions {
+    readonly status?: string;
+    readonly tags?: readonly string[];
+}
+interface DocumentationSummary extends AssetSummary {
+    readonly metadata?: DocumentationMetadata;
+}
+type SchemaKind = 'observability' | 'library' | 'terminal' | 'config' | 'meta' | 'api' | 'ascii' | 'assessment' | 'content' | 'error-handling' | 'pathfinder' | 'schema-validation' | 'taxonomy' | 'tooling' | string;
+interface SchemaSummary extends AssetSummary {
+    readonly kind: SchemaKind;
+    readonly version: string;
+}
+interface ConfigSummary extends AssetSummary {
+    readonly configCategory: string;
+    readonly version: string;
+}
+
+declare function listConfigDefaults(category?: string): Promise<readonly ConfigSummary[]>;
+declare function getConfigDefaults(category: string, version: string): Promise<unknown>;
+
+declare function listCategories(): readonly AssetCategory[];
+declare function listAssets(category: AssetCategory, options?: AssetListOptions): Promise<readonly AssetSummary[]>;
+
+declare function listDocumentation(filters?: DocumentationFilter): Promise<readonly DocumentationSummary[]>;
+declare function getDocumentation(id: string): Promise<string>;
+declare function getDocumentationWithMetadata(id: string): Promise<{
+    content: string;
+    metadata: DocumentationMetadata | null;
+}>;
+declare function getDocumentationMetadata(id: string): Promise<DocumentationMetadata | null>;
+
+declare class AssetNotFoundError extends Error {
+    readonly assetId: string;
+    readonly category: AssetCategory;
+    readonly suggestions: readonly string[];
+    constructor(id: string, category: AssetCategory, availableIds: string[]);
+}
+declare class InvalidAssetIdError extends Error {
+    readonly assetId: string;
+    readonly category: AssetCategory;
+    constructor(id: string, category: AssetCategory, reason: string);
+}
+
+declare function listSchemas(kind?: SchemaKind): Promise<readonly SchemaSummary[]>;
+declare function loadSchemaById(id: string): Promise<unknown>;
+
+declare function getCrucibleVersion(): CrucibleVersion;
+
+export { type AssetCategory, type AssetListOptions, AssetNotFoundError, type AssetSummary, type ConfigSummary, type CrucibleVersion, type DocumentationFilter, type DocumentationMetadata, type DocumentationSummary, InvalidAssetIdError, type SchemaKind, type SchemaSummary, getConfigDefaults, getCrucibleVersion, getDocumentation, getDocumentationMetadata, getDocumentationWithMetadata, listAssets, listCategories, listConfigDefaults, listDocumentation, listSchemas, loadSchemaById };