contentbase 0.2.0 → 0.4.1

package/dist/cli/registry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../../src/cli/registry.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAE5B,MAAM,WAAW,iBAAiB;IAChC,WAAW,EAAE,MAAM,CAAA;IACnB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,UAAU,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;IAC3B,OAAO,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE;QAAE,SAAS,EAAE,GAAG,CAAA;KAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;CACtE;AAID,eAAO,MAAM,QAAQ;mBACJ,MAAM,cAAc,iBAAiB;cAI1C,MAAM,GAAG,OAAO;cAIhB,MAAM,GAAG,iBAAiB,GAAG,SAAS;wBAI/B,MAAM,EAAE;CAG1B,CAAA"}

package/dist/cli/registry.js

@@ -0,0 +1,16 @@
+const registry = new Map();
+export const commands = {
+    register(name, definition) {
+        registry.set(name, definition);
+    },
+    has(name) {
+        return registry.has(name);
+    },
+    get(name) {
+        return registry.get(name);
+    },
+    get available() {
+        return Array.from(registry.keys());
+    },
+};
+//# sourceMappingURL=registry.js.map

package/dist/cli/registry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"registry.js","sourceRoot":"","sources":["../../src/cli/registry.ts"],"names":[],"mappings":"AAUA,MAAM,QAAQ,GAAG,IAAI,GAAG,EAA6B,CAAA;AAErD,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,QAAQ,CAAC,IAAY,EAAE,UAA6B;QAClD,QAAQ,CAAC,GAAG,CAAC,IAAI,EAAE,UAAU,CAAC,CAAA;IAChC,CAAC;IAED,GAAG,CAAC,IAAY;QACd,OAAO,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IAC3B,CAAC;IAED,GAAG,CAAC,IAAY;QACd,OAAO,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IAC3B,CAAC;IAED,IAAI,SAAS;QACX,OAAO,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAA;IACpC,CAAC;CACF,CAAA"}

package/dist/collection.d.ts

@@ -0,0 +1,145 @@
+import { Document } from "./document";
+import { CollectionQuery } from "./query/collection-query";
+import type { ModelDefinition, CollectionItem, CollectionOptions, InferModelInstance } from "./types";
+export interface FieldInfo {
+    name: string;
+    type: string;
+    required: boolean;
+    defaultValue?: unknown;
+    description?: string;
+}
+export declare function introspectMetaSchema(schema: any): FieldInfo[];
+export declare class Collection {
+    #private;
+    readonly rootPath: string;
+    readonly name: string;
+    readonly extensions: string[];
+    constructor(options: CollectionOptions);
+    /**
+     * Register a model definition with this collection.
+     * Accepts the output of defineModel().
+     */
+    register<TDef extends ModelDefinition<any, any, any, any, any>>(definition: TDef): this;
+    /** Get a model definition by name */
+    getModelDefinition(name: string): ModelDefinition<any, any, any, any, any> | undefined;
+    get modelDefinitions(): ModelDefinition<any, any, any, any, any>[];
+    get loaded(): boolean;
+    get items(): Map<string, CollectionItem>;
+    get documents(): Map<string, Document>;
+    get available(): string[];
+    /**
+     * Match available pathIds against one or more glob patterns.
+     */
+    matchPaths(patterns: string | string[]): string[];
+    /**
+     * Recursively load all markdown files from rootPath.
+     * Parses frontmatter with gray-matter, stores content and metadata.
+     */
+    load(options?: {
+        refresh?: boolean;
+    }): Promise<this>;
+    /**
+     * Get or create a Document for the given pathId.
+     * Documents are cached: calling document("foo") twice returns the same instance.
+     */
+    document(pathId: string): Document;
+    /**
+     * Creates a new Document tied to this collection without it
+     * existing in the items map. Used for in-memory documents
+     * (e.g., extracted from hasMany relationships).
+     */
+    createDocument(attrs: {
+        id: string;
+        content?: string;
+        meta?: Record<string, unknown>;
+        ast?: import("mdast").Root;
+    }): Document;
+    /**
+     * Get a typed model instance for a document.
+     * The definition parameter carries the type information.
+     */
+    getModel<TDef extends ModelDefinition<any, any, any, any, any>>(pathId: string, definition: TDef): InferModelInstance<TDef>;
+    /**
+     * Determine which model definition matches a document,
+     * using match functions or prefix matching.
+     */
+    findModelDefinition(pathId: string): ModelDefinition<any, any, any, any, any> | undefined;
+    /**
+     * Create a typed query for model instances.
+     */
+    query<TDef extends ModelDefinition<any, any, any, any, any>>(definition: TDef): CollectionQuery<TDef>;
+    saveItem(pathId: string, options: {
+        content: string;
+        extension?: string;
+    }): Promise<CollectionItem>;
+    deleteItem(pathId: string): Promise<this>;
+    readItem(pathId: string, extension?: string): Promise<CollectionItem>;
+    action(name: string, fn: (collection: Collection, ...args: any[]) => any): this;
+    get actions(): Map<string, Function>;
+    get availableActions(): string[];
+    runAction(name: string, ...args: any[]): Promise<any>;
+    use(plugin: (collection: Collection, options?: any) => void, options?: any): this;
+    resolve(...args: string[]): string;
+    getPathId(key: string): string;
+    /**
+     * Generate a markdown table of contents with links to each document.
+     * Links use relative paths that work for GitHub navigation.
+     *
+     * If models are registered, items are grouped under model name headings.
+     * Items that don't match any model appear under an "Other" group.
+     *
+     * @example
+     * ```ts
+     * const toc = collection.tableOfContents({ title: "Project Docs" });
+     * // # Project Docs
+     * //
+     * // ## Epics
+     * //
+     * // - [Authentication](./epics/authentication.mdx)
+     * // - [Searching And Browsing](./epics/searching-and-browsing.mdx)
+     * //
+     * // ## Stories
+     * //
+     * // - [A User should be able to register.](./stories/authentication/a-user-should-be-able-to-register.mdx)
+     * ```
+     */
+    tableOfContents(options?: {
+        title?: string;
+        basePath?: string;
+    }): string;
+    /**
+     * Renders an ASCII file tree of all documents in the collection.
+     *
+     * @example
+     * ```
+     * const tree = collection.renderFileTree();
+     * // epics/
+     * //   authentication.mdx
+     * //   searching-and-browsing.mdx
+     * // stories/
+     * //   authentication/
+     * //     a-user-should-be-able-to-register.mdx
+     * ```
+     */
+    renderFileTree(): string;
+    /**
+     * Generate a plain-text summary of the collection and its models.
+     * Returns the same output as `cnotes inspect`.
+     */
+    generateModelSummary(options?: {
+        includeIds?: boolean;
+    }): string;
+    /**
+     * Write README.md to the collection root.
+     * Preserves the `## Overview` section if it already exists.
+     * The generated summary is placed in the `## Summary` section.
+     */
+    saveModelSummary(options?: {
+        includeIds?: boolean;
+    }): Promise<string>;
+    toJSON(options?: {
+        content?: boolean;
+    }): Record<string, unknown>;
+    export(options?: Record<string, unknown>): Promise<Record<string, unknown>>;
+}
+//# sourceMappingURL=collection.d.ts.map

package/dist/collection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"collection.d.ts","sourceRoot":"","sources":["../src/collection.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAK3D,OAAO,KAAK,EACV,eAAe,EACf,cAAc,EACd,iBAAiB,EACjB,kBAAkB,EAInB,MAAM,SAAS,CAAC;AAIjB,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,OAAO,CAAC;IAClB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAsDD,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,GAAG,GAAG,SAAS,EAAE,CAc7D;AAYD,qBAAa,UAAU;;IACrB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;gBAYlB,OAAO,EAAE,iBAAiB;IAgBtC;;;OAGG;IACH,QAAQ,CAAC,IAAI,SAAS,eAAe,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAC5D,UAAU,EAAE,IAAI,GACf,IAAI;IAKP,qCAAqC;IACrC,kBAAkB,CAChB,IAAI,EAAE,MAAM,GACX,eAAe,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,SAAS;IAIvD,IAAI,gBAAgB,IAAI,eAAe,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,CAEjE;IA6BD,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED,IAAI,KAAK,IAAI,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,CAEvC;IAED,IAAI,SAAS,IAAI,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,CAErC;IAED,IAAI,SAAS,IAAI,MAAM,EAAE,CAIxB;IAED;;OAEG;IACH,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE;IAwBjD;;;OAGG;IACG,IAAI,CAAC,OAAO,GAAE;QAAE,OAAO,CAAC,EAAE,OAAO,CAAA;KAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAqE9D;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,QAAQ;IAiClC;;;;OAIG;IACH,cAAc,CAAC,KAAK,EAAE;QACpB,EAAE,EAAE,MAAM,CAAC;QACX,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAC/B,GAAG,CAAC,EAAE,OAAO,OAAO,EAAE,IAAI,CAAC;KAC5B,GAAG,QAAQ;IAYZ;;;OAGG;IACH,QAAQ,CAAC,IAAI,SAAS,eAAe,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAC5D,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,IAAI,GACf,kBAAkB,CAAC,IAAI,CAAC;IAK3B;;;OAGG;IACH,mBAAmB,CACjB,MAAM,EAAE,MAAM,GACb,eAAe,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,SAAS;IAkCvD;;OAEG;IACH,KAAK,CAAC,IAAI,SAAS,eAAe,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EACzD,UAAU,EAAE,IAAI,GACf,eAAe,CAAC,IAAI,CAAC;IAMlB,QAAQ,CACZ,MAAM,EAAE,MAAM,EACd,OAAO,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,GAC/C,OAAO,CAAC,cAAc,CAAC;IAyCpB,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAUzC,QAAQ,CACZ,MAAM,EAAE,MAAM,EACd,SAAS,GAAE,MAAa,GACvB,OAAO,CAAC,cAAc,CAAC;IA6B1B,MAAM,CACJ,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,CAAC,UAAU,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,GAClD,IAAI;IAQP,IAAI,OAAO,IAAI,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,CAEnC;IAED,IAAI,gBAAgB,IAAI,MAAM,EAAE,CAE/B;IAEK,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAU3D,GAAG,CACD,MAAM,EAAE,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,GAAG,KAAK,IAAI,EACvD,OAAO,CAAC,EAAE,GAAG,GACZ,IAAI;IAOP,OAAO,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM;IAIlC,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAO9B;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,eAAe,CACb,OAAO,GAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAO,GAClD,MAAM;IA8DT;;;;;;;;;;;;;OAaG;IACH,cAAc,IAAI,MAAM;IA2DxB;;;OAGG;IACH,oBAAoB,CAAC,OAAO,GAAE;QAAE,UAAU,CAAC,EAAE,OAAO,CAAA;KAAO,GAAG,MAAM;IAoDpE;;;;OAIG;IACG,gBAAgB,CAAC,OAAO,GAAE;QAAE,UAAU,CAAC,EAAE,OAAO,CAAA;KAAO,GAAG,OAAO,CAAC,MAAM,CAAC;IAyC/E,MAAM,CAAC,OAAO,GAAE;QAAE,OAAO,CAAC,EAAE,OAAO,CAAA;KAAO,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAyB9D,MAAM,CACV,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,GACpC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAmBpC"}