canopycms 0.0.40 → 0.0.42

package/dist/server.d.ts

@@ -8,17 +8,67 @@ export * from './branch-workspace';
 export * from './content-store';
 export { loadCollectionMetaFiles, resolveCollectionReferences, watchCollectionMetaFiles, resolveSchema, } from './schema';
 export type { CollectionMeta, RootCollectionMeta } from './schema';
-export { createEntrySchemaRegistry, validateEntrySchemaRegistry } from './entry-schema-registry';
-export { generateId, isValidId } from './id';
+/**
+ * Create a type-safe entry schema registry with runtime validation.
+ *
+ * Maps each entry-type's name to its `EntrySchema`. Keys are referenced by
+ * `.collection.json` files via the `entry.schema` property. Recommended
+ * convention is to key by entry-type name (filename token, also the value of
+ * `meta.entryType` in tree-builder callbacks) — that way
+ * `EntryTypesFromRegistry<typeof yourRegistry>` derives the
+ * discriminated-union map for `buildContentTree`'s `TEntryTypes` parameter
+ * automatically. See `createEntrySchemaRegistry`'s source-file JSDoc for the
+ * full example.
+ */
+export { createEntrySchemaRegistry } from './entry-schema-registry';
+/**
+ * Validate that entry-schema references in `.collection.json` files exist in
+ * the registry. Useful at build time to fail fast on stale references rather
+ * than at request time.
+ */
+export { validateEntrySchemaRegistry } from './entry-schema-registry';
+/**
+ * Derive a discriminated-union entry-type map from a registry value. Pass
+ * `typeof entrySchemaRegistry` as the type argument. The registry must be
+ * keyed by entry-type name for the result to plug straight into
+ * `buildContentTree`'s `TEntryTypes` generic.
+ */
+export type { EntryTypesFromRegistry } from './entry-schema';
+/** Generate a Canopy-format 12-character Base58 content ID. */
+export { generateId } from './id';
+/** Returns true if a string is a valid 12-character Base58 Canopy ID. */
+export { isValidId } from './id';
+/**
+ * Build a hierarchical tree of content nodes from the schema and filesystem.
+ *
+ * Pass `TEntryTypes` (typically `EntryTypesFromRegistry<typeof entrySchemaRegistry>`)
+ * to get narrowed access to `meta.indexEntry.data` after switching on
+ * `meta.entryType` in your `extract` callback.
+ *
+ * Adopters using `canopycms-next` typically call `canopy.buildContentTree(...)`
+ * via `getCanopyForBuild()` rather than the bare function.
+ */
 export { buildContentTree } from './content-tree';
-export type { ContentTreeNode, BuildContentTreeOptions, ContentTreeExtractMeta, } from './content-tree';
+export type { ContentTreeNode, BuildContentTreeOptions, ContentTreeExtractMeta, EntryTypeMap, DefaultEntryTypes, } from './content-tree';
+/** List all content entries as a flat array. */
 export { listEntries } from './content-listing';
 export type { ListEntriesItem, ListEntriesOptions } from './content-listing';
+/**
+ * Resolve a canopy entry-link to its URL. Pair with the field-walker variants
+ * (`resolveEntryLinksInText`, `resolveEntryLinksInData`) when rendering MDX
+ * bodies or arbitrary frontmatter that may contain link tokens.
+ */
 export { resolveEntryUrl, resolveEntryLinksInText, resolveEntryLinksInData, extractEntryLinkIds, } from './entry-link-resolver';
 export type { EntryLinkUrlResolver } from './entry-link-resolver';
+/** Compute the canonical URL for an entry given its logical path + slug. */
 export { computeEntryUrl } from './utils/entry-url';
+/** Collect static paths for `generateStaticParams` / sitemap emission. */
 export { collectStaticPaths } from './static';
 export type { StaticPathEntry, CollectStaticPathsOptions } from './static';
+/**
+ * Start a chokidar-backed watcher that detects divergence between the dev
+ * working tree and the resolved branch clone. Dev mode only.
+ */
 export { startDevContentWatcher } from './dev-content-watcher';
 export type { StartDevContentWatcherOptions } from './dev-content-watcher';
 //# sourceMappingURL=server.d.ts.map

package/dist/server.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAA;AAChC,cAAc,YAAY,CAAA;AAC1B,cAAc,cAAc,CAAA;AAC5B,cAAc,WAAW,CAAA;AACzB,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAA;AACpD,cAAc,wBAAwB,CAAA;AACtC,cAAc,oBAAoB,CAAA;AAClC,cAAc,iBAAiB,CAAA;AAC/B,OAAO,EACL,uBAAuB,EACvB,2BAA2B,EAC3B,wBAAwB,EACxB,aAAa,GACd,MAAM,UAAU,CAAA;AACjB,YAAY,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAA;AAClE,OAAO,EAAE,yBAAyB,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAA;AAChG,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,MAAM,CAAA;AAC5C,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AACjD,YAAY,EACV,eAAe,EACf,uBAAuB,EACvB,sBAAsB,GACvB,MAAM,gBAAgB,CAAA;AACvB,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAC/C,YAAY,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAC5E,OAAO,EACL,eAAe,EACf,uBAAuB,EACvB,uBAAuB,EACvB,mBAAmB,GACpB,MAAM,uBAAuB,CAAA;AAC9B,YAAY,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAA;AACjE,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAA;AAC7C,YAAY,EAAE,eAAe,EAAE,yBAAyB,EAAE,MAAM,UAAU,CAAA;AAC1E,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAA;AAC9D,YAAY,EAAE,6BAA6B,EAAE,MAAM,uBAAuB,CAAA"}
+{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AAMA,cAAc,kBAAkB,CAAA;AAChC,cAAc,YAAY,CAAA;AAC1B,cAAc,cAAc,CAAA;AAC5B,cAAc,WAAW,CAAA;AACzB,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAA;AACpD,cAAc,wBAAwB,CAAA;AACtC,cAAc,oBAAoB,CAAA;AAClC,cAAc,iBAAiB,CAAA;AAC/B,OAAO,EACL,uBAAuB,EACvB,2BAA2B,EAC3B,wBAAwB,EACxB,aAAa,GACd,MAAM,UAAU,CAAA;AACjB,YAAY,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAA;AAElE;;;;;;;;;;;GAWG;AACH,OAAO,EAAE,yBAAyB,EAAE,MAAM,yBAAyB,CAAA;AAEnE;;;;GAIG;AACH,OAAO,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAA;AAErE;;;;;GAKG;AACH,YAAY,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAA;AAE5D,+DAA+D;AAC/D,OAAO,EAAE,UAAU,EAAE,MAAM,MAAM,CAAA;AAEjC,yEAAyE;AACzE,OAAO,EAAE,SAAS,EAAE,MAAM,MAAM,CAAA;AAEhC;;;;;;;;;GASG;AACH,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AAEjD,YAAY,EACV,eAAe,EACf,uBAAuB,EACvB,sBAAsB,EACtB,YAAY,EACZ,iBAAiB,GAClB,MAAM,gBAAgB,CAAA;AAEvB,gDAAgD;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAE/C,YAAY,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAE5E;;;;GAIG;AACH,OAAO,EACL,eAAe,EACf,uBAAuB,EACvB,uBAAuB,EACvB,mBAAmB,GACpB,MAAM,uBAAuB,CAAA;AAE9B,YAAY,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAA;AAEjE,4EAA4E;AAC5E,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAEnD,0EAA0E;AAC1E,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAA;AAE7C,YAAY,EAAE,eAAe,EAAE,yBAAyB,EAAE,MAAM,UAAU,CAAA;AAE1E;;;GAGG;AACH,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAA;AAE9D,YAAY,EAAE,6BAA6B,EAAE,MAAM,uBAAuB,CAAA"}

package/dist/server.js

@@ -1,3 +1,8 @@
+// Public server-side API for adopters. JSDoc is duplicated at each named
+// re-export so it shows on hover in adopter editors — TypeScript propagation
+// through `export { X } from './module.js'` is inconsistent across LSP versions
+// and module-resolution modes. New top-level public re-exports should follow
+// the same pattern (see DEVELOPING.md).
 export * from './content-reader.js';
 export * from './services.js';
 export * from './build-mode.js';
@@ -7,12 +12,55 @@ export * from './authorization/groups/index.js';
 export * from './branch-workspace.js';
 export * from './content-store.js';
 export { loadCollectionMetaFiles, resolveCollectionReferences, watchCollectionMetaFiles, resolveSchema, } from './schema/index.js';
-export { createEntrySchemaRegistry, validateEntrySchemaRegistry } from './entry-schema-registry.js';
-export { generateId, isValidId } from './id.js';
+/**
+ * Create a type-safe entry schema registry with runtime validation.
+ *
+ * Maps each entry-type's name to its `EntrySchema`. Keys are referenced by
+ * `.collection.json` files via the `entry.schema` property. Recommended
+ * convention is to key by entry-type name (filename token, also the value of
+ * `meta.entryType` in tree-builder callbacks) — that way
+ * `EntryTypesFromRegistry<typeof yourRegistry>` derives the
+ * discriminated-union map for `buildContentTree`'s `TEntryTypes` parameter
+ * automatically. See `createEntrySchemaRegistry`'s source-file JSDoc for the
+ * full example.
+ */
+export { createEntrySchemaRegistry } from './entry-schema-registry.js';
+/**
+ * Validate that entry-schema references in `.collection.json` files exist in
+ * the registry. Useful at build time to fail fast on stale references rather
+ * than at request time.
+ */
+export { validateEntrySchemaRegistry } from './entry-schema-registry.js';
+/** Generate a Canopy-format 12-character Base58 content ID. */
+export { generateId } from './id.js';
+/** Returns true if a string is a valid 12-character Base58 Canopy ID. */
+export { isValidId } from './id.js';
+/**
+ * Build a hierarchical tree of content nodes from the schema and filesystem.
+ *
+ * Pass `TEntryTypes` (typically `EntryTypesFromRegistry<typeof entrySchemaRegistry>`)
+ * to get narrowed access to `meta.indexEntry.data` after switching on
+ * `meta.entryType` in your `extract` callback.
+ *
+ * Adopters using `canopycms-next` typically call `canopy.buildContentTree(...)`
+ * via `getCanopyForBuild()` rather than the bare function.
+ */
 export { buildContentTree } from './content-tree.js';
+/** List all content entries as a flat array. */
 export { listEntries } from './content-listing.js';
+/**
+ * Resolve a canopy entry-link to its URL. Pair with the field-walker variants
+ * (`resolveEntryLinksInText`, `resolveEntryLinksInData`) when rendering MDX
+ * bodies or arbitrary frontmatter that may contain link tokens.
+ */
 export { resolveEntryUrl, resolveEntryLinksInText, resolveEntryLinksInData, extractEntryLinkIds, } from './entry-link-resolver.js';
+/** Compute the canonical URL for an entry given its logical path + slug. */
 export { computeEntryUrl } from './utils/entry-url.js';
+/** Collect static paths for `generateStaticParams` / sitemap emission. */
 export { collectStaticPaths } from './static/index.js';
+/**
+ * Start a chokidar-backed watcher that detects divergence between the dev
+ * working tree and the resolved branch clone. Dev mode only.
+ */
 export { startDevContentWatcher } from './dev-content-watcher.js';
 //# sourceMappingURL=server.js.map

package/dist/server.js.map

@@ -1 +1 @@
-{"version":3,"file":"server.js","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAA;AAChC,cAAc,YAAY,CAAA;AAC1B,cAAc,cAAc,CAAA;AAC5B,cAAc,WAAW,CAAA;AACzB,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAA;AACpD,cAAc,wBAAwB,CAAA;AACtC,cAAc,oBAAoB,CAAA;AAClC,cAAc,iBAAiB,CAAA;AAC/B,OAAO,EACL,uBAAuB,EACvB,2BAA2B,EAC3B,wBAAwB,EACxB,aAAa,GACd,MAAM,UAAU,CAAA;AAEjB,OAAO,EAAE,yBAAyB,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAA;AAChG,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,MAAM,CAAA;AAC5C,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AAMjD,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAE/C,OAAO,EACL,eAAe,EACf,uBAAuB,EACvB,uBAAuB,EACvB,mBAAmB,GACpB,MAAM,uBAAuB,CAAA;AAE9B,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAA;AAE7C,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAA"}
+{"version":3,"file":"server.js","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AAAA,yEAAyE;AACzE,6EAA6E;AAC7E,6EAA6E;AAC7E,6EAA6E;AAC7E,wCAAwC;AAExC,cAAc,kBAAkB,CAAA;AAChC,cAAc,YAAY,CAAA;AAC1B,cAAc,cAAc,CAAA;AAC5B,cAAc,WAAW,CAAA;AACzB,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAA;AACpD,cAAc,wBAAwB,CAAA;AACtC,cAAc,oBAAoB,CAAA;AAClC,cAAc,iBAAiB,CAAA;AAC/B,OAAO,EACL,uBAAuB,EACvB,2BAA2B,EAC3B,wBAAwB,EACxB,aAAa,GACd,MAAM,UAAU,CAAA;AAGjB;;;;;;;;;;;GAWG;AACH,OAAO,EAAE,yBAAyB,EAAE,MAAM,yBAAyB,CAAA;AAEnE;;;;GAIG;AACH,OAAO,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAA;AAUrE,+DAA+D;AAC/D,OAAO,EAAE,UAAU,EAAE,MAAM,MAAM,CAAA;AAEjC,yEAAyE;AACzE,OAAO,EAAE,SAAS,EAAE,MAAM,MAAM,CAAA;AAEhC;;;;;;;;;GASG;AACH,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AAUjD,gDAAgD;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAI/C;;;;GAIG;AACH,OAAO,EACL,eAAe,EACf,uBAAuB,EACvB,uBAAuB,EACvB,mBAAmB,GACpB,MAAM,uBAAuB,CAAA;AAI9B,4EAA4E;AAC5E,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAEnD,0EAA0E;AAC1E,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAA;AAI7C;;;GAGG;AACH,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAA"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "//": "@codemirror/language, @lezer/highlight: workaround — @mdxeditor/editor uses cm6-theme-basic-light which peer-requires these but mdxeditor doesn't declare them as dependencies",
   "name": "canopycms",
-  "version": "0.0.40",
+  "version": "0.0.42",
   "description": "CanopyCMS core package: schema-driven content, branch-aware editing, and editor UI for Next.js.",
   "license": "MIT",
   "repository": {