canopycms 0.0.0

package/dist/schema/schema-store-types.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Schema Store Types - Client-safe type definitions for schema CRUD operations.
+ *
+ * These types are separated from schema-store.ts to allow client-side code
+ * to import them without pulling in Node.js dependencies (fs, path).
+ */
+import type { ContentFormat } from '../config';
+import type { LogicalPath } from '../paths/types';
+/**
+ * Input for creating a new collection
+ */
+export interface CreateCollectionInput {
+    name: string;
+    label?: string;
+    parentPath?: LogicalPath;
+    entries: CreateEntryTypeInput[];
+}
+/**
+ * Input for creating a new entry type
+ */
+export interface CreateEntryTypeInput {
+    name: string;
+    label?: string;
+    format: ContentFormat;
+    schema: string;
+    default?: boolean;
+    maxItems?: number;
+}
+/**
+ * Input for updating a collection
+ */
+export interface UpdateCollectionInput {
+    name?: string;
+    label?: string;
+    slug?: string;
+    order?: string[];
+}
+/**
+ * Input for updating an entry type
+ */
+export interface UpdateEntryTypeInput {
+    label?: string;
+    format?: ContentFormat;
+    schema?: string;
+    default?: boolean;
+    maxItems?: number;
+}
+//# sourceMappingURL=schema-store-types.d.ts.map

package/dist/schema/schema-store-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema-store-types.d.ts","sourceRoot":"","sources":["../../src/schema/schema-store-types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAA;AAC9C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAMjD;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,UAAU,CAAC,EAAE,WAAW,CAAA;IACxB,OAAO,EAAE,oBAAoB,EAAE,CAAA;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,aAAa,CAAA;IACrB,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,aAAa,CAAA;IACtB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB"}

package/dist/schema/schema-store-types.js

@@ -0,0 +1,8 @@
+/**
+ * Schema Store Types - Client-safe type definitions for schema CRUD operations.
+ *
+ * These types are separated from schema-store.ts to allow client-side code
+ * to import them without pulling in Node.js dependencies (fs, path).
+ */
+export {};
+//# sourceMappingURL=schema-store-types.js.map

package/dist/schema/schema-store-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema-store-types.js","sourceRoot":"","sources":["../../src/schema/schema-store-types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG"}

package/dist/schema/schema-store.d.ts

@@ -0,0 +1,249 @@
+/**
+ * Schema Store - handles reading and writing .collection.json files.
+ *
+ * This module provides CRUD operations for collection schema metadata:
+ * - Create/update/delete collections
+ * - Add/update/remove entry types
+ * - Update ordering of items within collections
+ *
+ * All mutations are branch-specific (like content edits).
+ */
+import { z } from 'zod';
+import type { ContentFormat } from '../config';
+import type { EntrySchemaRegistry } from './types';
+import type { LogicalPath, ContentId } from '../paths/types';
+import type { CanopyServices } from '../services';
+export type { CreateCollectionInput, CreateEntryTypeInput, UpdateCollectionInput, UpdateEntryTypeInput, } from './schema-store-types';
+import type { CreateCollectionInput, CreateEntryTypeInput, UpdateCollectionInput, UpdateEntryTypeInput } from './schema-store-types';
+/**
+ * Raw collection meta as stored in .collection.json
+ */
+interface CollectionMetaFile {
+    name: string;
+    label?: string;
+    entries?: Array<{
+        name: string;
+        label?: string;
+        format: ContentFormat;
+        schema: string;
+        default?: boolean;
+        maxItems?: number;
+    }>;
+    order?: string[];
+}
+/**
+ * Raw root collection meta as stored in content/.collection.json
+ */
+interface RootCollectionMetaFile {
+    label?: string;
+    entries?: Array<{
+        name: string;
+        label?: string;
+        format: ContentFormat;
+        schema: string;
+        default?: boolean;
+        maxItems?: number;
+    }>;
+    order?: string[];
+}
+declare const entryTypeInputSchema: z.ZodObject<{
+    name: z.ZodString;
+    label: z.ZodOptional<z.ZodString>;
+    format: z.ZodEnum<["md", "mdx", "json"]>;
+    schema: z.ZodString;
+    default: z.ZodOptional<z.ZodBoolean>;
+    maxItems: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    format: "mdx" | "md" | "json";
+    schema: string;
+    label?: string | undefined;
+    default?: boolean | undefined;
+    maxItems?: number | undefined;
+}, {
+    name: string;
+    format: "mdx" | "md" | "json";
+    schema: string;
+    label?: string | undefined;
+    default?: boolean | undefined;
+    maxItems?: number | undefined;
+}>;
+declare const createCollectionInputSchema: z.ZodObject<{
+    name: z.ZodString;
+    label: z.ZodOptional<z.ZodString>;
+    parentPath: z.ZodOptional<z.ZodString>;
+    entries: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        label: z.ZodOptional<z.ZodString>;
+        format: z.ZodEnum<["md", "mdx", "json"]>;
+        schema: z.ZodString;
+        default: z.ZodOptional<z.ZodBoolean>;
+        maxItems: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        format: "mdx" | "md" | "json";
+        schema: string;
+        label?: string | undefined;
+        default?: boolean | undefined;
+        maxItems?: number | undefined;
+    }, {
+        name: string;
+        format: "mdx" | "md" | "json";
+        schema: string;
+        label?: string | undefined;
+        default?: boolean | undefined;
+        maxItems?: number | undefined;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    entries: {
+        name: string;
+        format: "mdx" | "md" | "json";
+        schema: string;
+        label?: string | undefined;
+        default?: boolean | undefined;
+        maxItems?: number | undefined;
+    }[];
+    name: string;
+    label?: string | undefined;
+    parentPath?: string | undefined;
+}, {
+    entries: {
+        name: string;
+        format: "mdx" | "md" | "json";
+        schema: string;
+        label?: string | undefined;
+        default?: boolean | undefined;
+        maxItems?: number | undefined;
+    }[];
+    name: string;
+    label?: string | undefined;
+    parentPath?: string | undefined;
+}>;
+declare const updateCollectionInputSchema: z.ZodObject<{
+    name: z.ZodOptional<z.ZodString>;
+    label: z.ZodOptional<z.ZodString>;
+    slug: z.ZodOptional<z.ZodString>;
+    order: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+}, "strip", z.ZodTypeAny, {
+    name?: string | undefined;
+    label?: string | undefined;
+    order?: string[] | undefined;
+    slug?: string | undefined;
+}, {
+    name?: string | undefined;
+    label?: string | undefined;
+    order?: string[] | undefined;
+    slug?: string | undefined;
+}>;
+declare const updateEntryTypeInputSchema: z.ZodObject<{
+    label: z.ZodOptional<z.ZodString>;
+    format: z.ZodOptional<z.ZodEnum<["md", "mdx", "json"]>>;
+    schema: z.ZodOptional<z.ZodString>;
+    default: z.ZodOptional<z.ZodBoolean>;
+    maxItems: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    label?: string | undefined;
+    format?: "mdx" | "md" | "json" | undefined;
+    schema?: string | undefined;
+    default?: boolean | undefined;
+    maxItems?: number | undefined;
+}, {
+    label?: string | undefined;
+    format?: "mdx" | "md" | "json" | undefined;
+    schema?: string | undefined;
+    default?: boolean | undefined;
+    maxItems?: number | undefined;
+}>;
+export declare class SchemaOps {
+    private readonly contentRoot;
+    private readonly entrySchemaRegistry;
+    private readonly services?;
+    constructor(contentRoot: string, entrySchemaRegistry: EntrySchemaRegistry, services?: CanopyServices | undefined);
+    /**
+     * Invalidate schema cache for this branch after mutations.
+     * This marks the cache as stale so the next schema load will regenerate it.
+     */
+    private invalidateSchemaCache;
+    /**
+     * Validate that a schema reference exists in the registry
+     */
+    validateSchemaReference(schemaKey: string): boolean;
+    /**
+     * Validate all schema references in entry types
+     */
+    private validateEntryTypeSchemas;
+    /**
+     * Validate path to prevent traversal attacks
+     */
+    private validatePath;
+    /**
+     * Read a collection's .collection.json file
+     */
+    readCollectionMeta(collectionPath: LogicalPath): Promise<CollectionMetaFile | null>;
+    /**
+     * Read root collection meta (content/.collection.json)
+     */
+    readRootCollectionMeta(): Promise<RootCollectionMetaFile | null>;
+    /**
+     * Check if a collection is empty (has no content files or child collections)
+     */
+    isCollectionEmpty(collectionPath: LogicalPath): Promise<boolean>;
+    /**
+     * Write a collection's .collection.json file
+     */
+    private writeCollectionMeta;
+    /**
+     * Write root collection meta
+     */
+    private writeRootCollectionMeta;
+    /**
+     * Create a new collection
+     */
+    createCollection(input: CreateCollectionInput): Promise<{
+        collectionPath: LogicalPath;
+        contentId: ContentId;
+    }>;
+    /**
+     * Update a collection's metadata
+     */
+    updateCollection(collectionPath: LogicalPath, updates: UpdateCollectionInput): Promise<void>;
+    /**
+     * Delete a collection (must be empty)
+     */
+    deleteCollection(collectionPath: LogicalPath): Promise<void>;
+    /**
+     * Add an entry type to a collection
+     */
+    addEntryType(collectionPath: LogicalPath, entryType: CreateEntryTypeInput): Promise<void>;
+    /**
+     * Update an entry type in a collection
+     */
+    updateEntryType(collectionPath: LogicalPath, entryTypeName: string, updates: UpdateEntryTypeInput): Promise<void>;
+    /**
+     * Remove an entry type from a collection
+     */
+    removeEntryType(collectionPath: LogicalPath, entryTypeName: string): Promise<void>;
+    /**
+     * Count the number of entries using a specific entry type in a collection.
+     * This is used to prevent breaking changes to entry types that have existing content.
+     *
+     * @param collectionPath - Logical path to the collection (e.g., "content/posts")
+     * @param entryTypeName - Name of the entry type to count
+     * @returns Number of entries using this entry type
+     *
+     * @example
+     * ```ts
+     * const count = await store.countEntriesUsingType('content/posts', 'post')
+     * if (count > 0) {
+     *   // Cannot modify schema/format
+     * }
+     * ```
+     */
+    countEntriesUsingType(collectionPath: LogicalPath, entryTypeName: string): Promise<number>;
+    /**
+     * Update the order of items in a collection
+     */
+    updateOrder(collectionPath: LogicalPath, order: string[]): Promise<void>;
+}
+export { createCollectionInputSchema, updateCollectionInputSchema, entryTypeInputSchema, updateEntryTypeInputSchema, };
+//# sourceMappingURL=schema-store.d.ts.map

package/dist/schema/schema-store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema-store.d.ts","sourceRoot":"","sources":["../../src/schema/schema-store.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAIH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAA;AAC9C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAA;AAIlD,OAAO,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC5D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAGjD,YAAY,EACV,qBAAqB,EACrB,oBAAoB,EACpB,qBAAqB,EACrB,oBAAoB,GACrB,MAAM,sBAAsB,CAAA;AAG7B,OAAO,KAAK,EACV,qBAAqB,EACrB,oBAAoB,EACpB,qBAAqB,EACrB,oBAAoB,EACrB,MAAM,sBAAsB,CAAA;AAE7B;;GAEG;AACH,UAAU,kBAAkB;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,KAAK,CAAC;QACd,IAAI,EAAE,MAAM,CAAA;QACZ,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,MAAM,EAAE,aAAa,CAAA;QACrB,MAAM,EAAE,MAAM,CAAA;QACd,OAAO,CAAC,EAAE,OAAO,CAAA;QACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;KAClB,CAAC,CAAA;IACF,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;CACjB;AAED;;GAEG;AACH,UAAU,sBAAsB;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,KAAK,CAAC;QACd,IAAI,EAAE,MAAM,CAAA;QACZ,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,MAAM,EAAE,aAAa,CAAA;QACrB,MAAM,EAAE,MAAM,CAAA;QACd,OAAO,CAAC,EAAE,OAAO,CAAA;QACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;KAClB,CAAC,CAAA;IACF,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;CACjB;AAWD,QAAA,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;EAOxB,CAAA;AAEF,QAAA,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAK/B,CAAA;AAEF,QAAA,MAAM,2BAA2B;;;;;;;;;;;;;;;EAK/B,CAAA;AAEF,QAAA,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;EAM9B,CAAA;AAMF,qBAAa,SAAS;IAElB,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,mBAAmB;IACpC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC;gBAFT,WAAW,EAAE,MAAM,EACnB,mBAAmB,EAAE,mBAAmB,EACxC,QAAQ,CAAC,EAAE,cAAc,YAAA;IAO5C;;;OAGG;YACW,qBAAqB;IAYnC;;OAEG;IACH,uBAAuB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO;IAInD;;OAEG;IACH,OAAO,CAAC,wBAAwB;IAgBhC;;OAEG;IACH,OAAO,CAAC,YAAY;IAgBpB;;OAEG;IACG,kBAAkB,CAAC,cAAc,EAAE,WAAW,GAAG,OAAO,CAAC,kBAAkB,GAAG,IAAI,CAAC;IAmBzF;;OAEG;IACG,sBAAsB,IAAI,OAAO,CAAC,sBAAsB,GAAG,IAAI,CAAC;IAatE;;OAEG;IACG,iBAAiB,CAAC,cAAc,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAqCtE;;OAEG;YACW,mBAAmB;IAMjC;;OAEG;YACW,uBAAuB;IAUrC;;OAEG;IACG,gBAAgB,CACpB,KAAK,EAAE,qBAAqB,GAC3B,OAAO,CAAC;QAAE,cAAc,EAAE,WAAW,CAAC;QAAC,SAAS,EAAE,SAAS,CAAA;KAAE,CAAC;IA2EjE;;OAEG;IACG,gBAAgB,CACpB,cAAc,EAAE,WAAW,EAC3B,OAAO,EAAE,qBAAqB,GAC7B,OAAO,CAAC,IAAI,CAAC;IA4HhB;;OAEG;IACG,gBAAgB,CAAC,cAAc,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAwBlE;;OAEG;IACG,YAAY,CAAC,cAAc,EAAE,WAAW,EAAE,SAAS,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;IAgD/F;;OAEG;IACG,eAAe,CACnB,cAAc,EAAE,WAAW,EAC3B,aAAa,EAAE,MAAM,EACrB,OAAO,EAAE,oBAAoB,GAC5B,OAAO,CAAC,IAAI,CAAC;IAuDhB;;OAEG;IACG,eAAe,CAAC,cAAc,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAiDxF;;;;;;;;;;;;;;;OAeG;IACG,qBAAqB,CAAC,cAAc,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAsDhG;;OAEG;IACG,WAAW,CAAC,cAAc,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;CAoB/E;AAMD,OAAO,EACL,2BAA2B,EAC3B,2BAA2B,EAC3B,oBAAoB,EACpB,0BAA0B,GAC3B,CAAA"}