@lupinum/ginko-content 0.1.6 → 0.2.0

package/dist/testing/provider-fixture.js

@@ -1,11 +1,11 @@
-import { contentProviderResultMarker } from "../public/provider";
+import { contentProviderResultMarker, toContentProviderQuery } from "../public/provider";
 import { buildContentGraph } from "../core/content/graph";
 import { executeQueryPlan } from "../core/query/execute";
-import { lowerQueryPlan } from "../core/query/lower";
-import { findUnsupportedQueryOperator, SUPPORTED_QUERY_OPERATORS } from "../core/query/operators";
+import { SUPPORTED_QUERY_OPERATORS } from "../core/query/operators";
 import { mergeContentCacheHints } from "../core/cache-hints";
-import { normalizeRouteMounts, projectContentPathToLocale } from "../features/localization/path";
+import { normalizeContentPath, normalizeRouteMounts, projectContentPathToLocale } from "../features/localization/path";
 import { createRouteMeta, localizePageResult } from "../features/localization/results";
+import { normalizeProviderDocument } from "../runtime/server/provider-document";
 import { createContentProviderError } from "../public/provider-errors";
 const trimSlashes = (value) => value.replace(/^\/+|\/+$/g, "");
 const isObject = (value) => Boolean(value) && typeof value === "object" && !Array.isArray(value);
@@ -42,13 +42,13 @@ const localizePath = (fixture, collection, path, locale) => {
 const navFieldsFromDoc = (doc, fields = []) => Object.fromEntries(fields.filter((field) => field in doc).map((field) => [field, doc[field]]));
 const navIdentityFromDoc = (doc) => ({
   ref: doc.ref,
-  stableId: doc.ref || doc._canonicalKey || doc._id
+  stableId: doc.ref || doc.canonicalKey || doc.id
 });
 const normalizeCachePath = (path) => {
   const normalized = path.startsWith("/") ? path : `/${path}`;
   return normalized.replace(/\/{2,}/g, "/");
 };
-const documentEntryTag = (doc) => `entry:${doc._collection}:${String(doc.ref || doc._canonicalKey || doc._id)}`;
+const documentEntryTag = (doc) => `entry:${doc.collection}:${String(doc.ref || doc.canonicalKey || doc.id)}`;
 const collectionTag = (collection) => `collection:${collection}`;
 const routeTag = (path) => `route:${normalizeCachePath(path)}`;
 const collectStringValues = (value) => {
@@ -85,7 +85,7 @@ export const collectProviderFixtureCacheHint = (event, hint) => {
 };
 export const getProviderFixtureCacheHint = (event) => getProviderFixtureRuntimeContext(event).cacheHint;
 const createCacheHintForDocument = (fixture, doc, path) => {
-  const collection = doc._collection || "content";
+  const collection = doc.collection || "content";
   return {
     tags: Array.from(/* @__PURE__ */ new Set([
       documentEntryTag(doc),
@@ -150,28 +150,31 @@ const invalidateFixtureCache = (cache, input) => {
   }
 };
 export const createProviderFixtureDocument = (input) => {
-  const collection = String(input._collection || "docs");
-  const locale = String(input._locale || "en");
-  const path = String(input._path || "/");
-  const canonicalKey = String(input._canonicalKey || `${collection}:${trimSlashes(path) || "index"}`);
-  const extension = input._extension || (input._type === "yaml" ? "yml" : "md");
-  return {
-    _id: String(input._id || `content:${locale}:${trimSlashes(path).replace(/\//g, ":") || "index"}.${extension}`),
-    _source: String(input._source || "content"),
-    _collection: collection,
-    _locale: locale,
-    _canonicalKey: canonicalKey,
-    _path: path,
-    _file: String(input._file || `/${locale}/${trimSlashes(path) || "index"}.${extension}`),
-    _type: input._type || "markdown",
-    _extension: extension,
+  const collection = String(input.collection || "docs");
+  const locale = String(input.locale || "en");
+  const path = String(input.path || "/");
+  const canonicalKey = String(input.canonicalKey || `${collection}:${trimSlashes(path) || "index"}`);
+  const type = input.type || "markdown";
+  const extension = input.file?.extension || (input.type === "yaml" ? "yml" : "md");
+  return normalizeProviderDocument({
+    ...input,
+    collection,
+    locale,
+    path,
+    canonicalKey,
+    type,
+    id: String(input.id || `content:${locale}:${trimSlashes(path).replace(/\//g, ":") || "index"}.${extension}`),
+    file: {
+      source: String(input.file?.source || "content"),
+      path: String(input.file?.path || `/${locale}/${trimSlashes(path) || "index"}.${extension}`),
+      extension
+    },
     title: String(input.title || canonicalKey),
-    body: {
+    body: input.body ?? {
       type: "root",
       children: []
-    },
-    ...input
-  };
+    }
+  });
 };
 export const createProviderFixture = (input) => {
   const defaultLocale = input.defaultLocale || "en";
@@ -228,26 +231,21 @@ export const createFixtureContentProvider = (fixture, name = fixture.providerNam
       throw createContentProviderError("unknown_collection", `Unknown collection: ${collection}`, { collection });
     }
   };
-  const query = async (event, params) => {
-    assertCollection(params.collection);
-    const unsupported = findUnsupportedQueryOperator(params.where);
-    if (unsupported) {
-      throw createContentProviderError("unsupported_query_operator", `Unsupported query operator: ${unsupported}`, {
-        operator: unsupported
-      });
-    }
+  const query = async (event, providerQuery) => {
+    assertCollection(providerQuery.plan.collection);
     collectProviderFixtureCacheHint(event, {
-      tags: params.collection ? [collectionTag(params.collection)] : []
+      tags: providerQuery.collection ? [collectionTag(providerQuery.collection)] : []
     });
     return executeQueryPlan(
       fixture.graph,
-      lowerQueryPlan(params),
+      providerQuery.plan,
       fixture.runtime
     );
   };
+  const queryWithParams = (event, params) => query(event, toContentProviderQuery(params));
   const docsForNavigation = async (event, params) => {
-    const response = await query(event, params);
-    return normalizeQueryResult(unwrapResponseResult(response)).filter((doc) => !doc._draft && !doc._partial && !doc._navigation && doc.navigation !== false && doc._path);
+    const response = await queryWithParams(event, params);
+    return normalizeQueryResult(unwrapResponseResult(response)).filter((doc) => !doc.draft && !doc.partial && !doc.navigationFile && doc.navigation !== false && doc.path);
   };
   const provider = {
     name,
@@ -268,21 +266,23 @@ export const createFixtureContentProvider = (fixture, name = fixture.providerNam
       }
     },
     query,
-    navigationQuery: async (event, params) => {
-      const docs = await docsForNavigation(event, params);
+    navigationQuery: async (event, providerQuery, navigationOptions = {}) => {
+      const response = await query(event, providerQuery);
+      const docs = normalizeQueryResult(unwrapResponseResult(response)).filter((doc) => !doc.draft && !doc.partial && !doc.navigationFile && doc.navigation !== false && doc.path);
+      const collection = providerQuery.collection ?? void 0;
+      const queryLocale = navigationOptions.resolveLocale?.locale;
       collectProviderFixtureCacheHint(event, {
         tags: [
-          ...params.collection ? [collectionTag(params.collection)] : [],
-          ...params.resolveLocale?.locale ? [`nav:${params.collection || "all"}:${params.resolveLocale.locale}`] : []
+          ...collection ? [collectionTag(collection)] : [],
+          ...queryLocale ? [`nav:${collection || "all"}:${queryLocale}`] : []
         ]
       });
-      const queryLocale = params.resolveLocale?.locale;
       return docs.map((doc) => ({
         title: doc.title,
         ...navIdentityFromDoc(doc),
-        _path: doc._path,
-        path: localizePath(fixture, doc._collection || params.collection || "", doc._path || "/", queryLocale || doc._requestedLocale || doc._locale),
-        _locale: doc._locale
+        unprefixedPath: normalizeContentPath(doc.path || "/"),
+        path: localizePath(fixture, doc.collection || collection || "", doc.path || "/", queryLocale || doc.resolved?.requestedLocale || doc.locale),
+        locale: doc.locale
       }));
     },
     navigation: async (event, collection, options = {}) => {
@@ -298,15 +298,15 @@ export const createFixtureContentProvider = (fixture, name = fixture.providerNam
           locale,
           fallback: fixture.localeFallback[locale] || [fixture.defaultLocale]
         } : void 0,
-        sort: [{ _path: 1 }]
+        sort: [{ path: 1 }]
       });
       return docs.map((doc) => ({
         title: doc.title,
         ...navFieldsFromDoc(doc, fields),
         ...navIdentityFromDoc(doc),
-        _path: doc._path,
-        path: localizePath(fixture, collection, doc._path || "/", locale || doc._locale),
-        _locale: doc._locale
+        unprefixedPath: normalizeContentPath(doc.path || "/"),
+        path: localizePath(fixture, collection, doc.path || "/", locale || doc.locale),
+        locale: doc.locale
       }));
     },
     surroundings: async (event, collection, path, options = {}) => {
@@ -318,14 +318,14 @@ export const createFixtureContentProvider = (fixture, name = fixture.providerNam
           locale,
           fallback: fixture.localeFallback[locale] || [fixture.defaultLocale]
         } : void 0,
-        sort: [{ _path: 1 }]
+        sort: [{ path: 1 }]
       });
-      const index = docs.findIndex((doc) => doc._path === path || localizePath(fixture, collection, doc._path || "/", locale || doc._locale) === path);
+      const index = docs.findIndex((doc) => doc.path === path || localizePath(fixture, collection, doc.path || "/", locale || doc.locale) === path);
       if (index === -1) return [null, null];
       return [docs[index - 1] || null, docs[index + 1] || null].map((doc) => doc ? {
         title: doc.title,
-        _path: doc._path,
-        path: localizePath(fixture, collection, doc._path || "/", locale || doc._locale)
+        unprefixedPath: normalizeContentPath(doc.path || "/"),
+        path: localizePath(fixture, collection, doc.path || "/", locale || doc.locale)
       } : null);
     },
     searchSections: async (event, collection, options = {}) => {
@@ -344,7 +344,7 @@ export const createFixtureContentProvider = (fixture, name = fixture.providerNam
       const extraFields = options.extraFields || [];
       return docs.map((doc) => ({
         ...Object.fromEntries(extraFields.filter((field) => field in doc).map((field) => [field, doc[field]])),
-        id: localizePath(fixture, collection, doc._path || "/", options.locale || doc._locale),
+        id: localizePath(fixture, collection, doc.path || "/", options.locale || doc.locale),
         title: doc.title || "",
         titles: [doc.title || ""],
         content: String(doc.description || doc.title || ""),
@@ -353,13 +353,13 @@ export const createFixtureContentProvider = (fixture, name = fixture.providerNam
     },
     search: async (_event, request) => {
       const term = request.term.toLocaleLowerCase();
-      return fixture.documents.filter((doc) => !request.collections?.length || request.collections.includes(doc._collection || "")).filter((doc) => !request.locale || doc._locale === request.locale).filter((doc) => String(doc.title || "").toLocaleLowerCase().includes(term)).map((doc) => ({
+      return fixture.documents.filter((doc) => !request.collections?.length || request.collections.includes(doc.collection || "")).filter((doc) => !request.locale || doc.locale === request.locale).filter((doc) => String(doc.title || "").toLocaleLowerCase().includes(term)).map((doc) => ({
         score: 1,
-        collection: doc._collection || "",
+        collection: doc.collection || "",
         title: doc.title || "",
         excerpt: String(doc.description || ""),
-        path: localizePath(fixture, doc._collection || "", doc._path || "/", doc._locale),
-        locale: doc._locale
+        path: localizePath(fixture, doc.collection || "", doc.path || "/", doc.locale),
+        locale: doc.locale
       }));
     },
     siteData: async (event, request) => {
@@ -382,7 +382,7 @@ export const createFixtureContentProvider = (fixture, name = fixture.providerNam
       const routeLocale = segments[0] && fixture.locales.includes(segments[0]) ? segments[0] : void 0;
       const providerRoute = routeLocale ? `/${segments.slice(1).join("/")}` : routeOrPath;
       const requestedLocale = options.locale || routeLocale;
-      const response = await query(event, {
+      const response = await queryWithParams(event, {
         collection,
         first: true,
         resolveVariant: {
@@ -396,7 +396,7 @@ export const createFixtureContentProvider = (fixture, name = fixture.providerNam
       if (!doc) return null;
       const page = localizePageResult(
         doc,
-        requestedLocale || doc._resolvedLocale || doc._locale,
+        requestedLocale || doc.resolved?.locale || doc.locale,
         fixture.defaultLocale,
         fixture.locales,
         routeMountsFor(fixture, collection)
@@ -408,7 +408,11 @@ export const createFixtureContentProvider = (fixture, name = fixture.providerNam
     },
     routeMeta: async (event, collection, routeOrPath = "/", options = {}) => {
       const page = await provider.page(event, collection, routeOrPath, options);
-      return page ? createRouteMeta(page, options.locale || page.locale, fixture.defaultLocale, routeMountsFor(fixture, collection)) : null;
+      const routePage = page;
+      return routePage ? createRouteMeta({
+        ...routePage,
+        path: routePage.unprefixedPath || routePage.path
+      }, options.locale || routePage.locale, fixture.defaultLocale, fixture.locales, routeMountsFor(fixture, collection)) : null;
     },
     sitemapEntries: async (event, options = {}) => {
       collectProviderFixtureCacheHint(event, { tags: ["sitemap"] });
@@ -423,9 +427,9 @@ export const createFixtureContentProvider = (fixture, name = fixture.providerNam
           }
           continue;
         }
-        for (const doc of fixture.documents.filter((doc2) => doc2._collection === collection && !doc2._draft && !doc2._partial && !doc2._navigation)) {
+        for (const doc of fixture.documents.filter((doc2) => doc2.collection === collection && !doc2.draft && !doc2.partial && !doc2.navigationFile)) {
           entries.push({
-            loc: localizePath(fixture, collection, doc._path || "/", doc._locale)
+            loc: localizePath(fixture, collection, doc.path || "/", doc.locale)
           });
         }
       }
@@ -437,7 +441,7 @@ export const createFixtureContentProvider = (fixture, name = fixture.providerNam
   };
   return Object.assign(provider, { cache });
 };
-export const createSaasProviderFixture = () => createProviderFixture({
+export const createDefaultProviderFixture = () => createProviderFixture({
   name: "saas-i18n",
   providerName: "fixture",
   defaultLocale: "en",
@@ -467,81 +471,81 @@ export const createSaasProviderFixture = () => createProviderFixture({
   },
   documents: [
     {
-      _collection: "docs",
-      _locale: "en",
-      _canonicalKey: "docs:getting-started",
-      _path: "/docs/getting-started",
+      collection: "docs",
+      locale: "en",
+      canonicalKey: "docs:getting-started",
+      path: "/docs/getting-started",
       ref: "docs.getting-started",
       title: "Getting Started",
       description: "Start here",
       order: 1
     },
     {
-      _collection: "docs",
-      _locale: "de",
-      _canonicalKey: "docs:getting-started",
-      _path: "/dokumentation/einstieg",
+      collection: "docs",
+      locale: "de",
+      canonicalKey: "docs:getting-started",
+      path: "/dokumentation/einstieg",
       ref: "docs.getting-started",
       title: "Einstieg",
       description: "Hier starten",
       order: 1
     },
     {
-      _collection: "docs",
-      _locale: "de",
-      _canonicalKey: "docs:getting-started-installation",
-      _path: "/dokumentation/einstieg/installation",
+      collection: "docs",
+      locale: "de",
+      canonicalKey: "docs:getting-started-installation",
+      path: "/dokumentation/einstieg/installation",
       ref: "docs.getting-started.installation",
       title: "Installation",
       description: "Installieren",
       order: 2
     },
     {
-      _collection: "docs",
-      _locale: "de",
-      _canonicalKey: "docs:getting-started-everyday",
-      _path: "/dokumentation/einstieg/alltag",
+      collection: "docs",
+      locale: "de",
+      canonicalKey: "docs:getting-started-everyday",
+      path: "/dokumentation/einstieg/alltag",
       ref: "docs.getting-started.everyday",
       title: "Alltag",
       description: "Arbeiten",
       order: 3
     },
     {
-      _collection: "docs",
-      _locale: "en",
-      _canonicalKey: "docs:markdown-syntax",
-      _path: "/docs/essentials/markdown-syntax",
+      collection: "docs",
+      locale: "en",
+      canonicalKey: "docs:markdown-syntax",
+      path: "/docs/essentials/markdown-syntax",
       ref: "docs.markdown-syntax",
       title: "Markdown Syntax",
       description: "Writing docs",
       order: 4
     },
     {
-      _collection: "docs",
-      _locale: "en",
-      _canonicalKey: "docs:draft-roadmap",
-      _path: "/docs/draft-roadmap",
+      collection: "docs",
+      locale: "en",
+      canonicalKey: "docs:draft-roadmap",
+      path: "/docs/draft-roadmap",
       ref: "docs.draft-roadmap",
       title: "Draft Roadmap",
       description: "Unpublished draft",
-      _draft: true,
+      draft: true,
       order: 5
     },
     {
-      _collection: "docs",
-      _locale: "de",
-      _canonicalKey: "docs:markdown-syntax",
-      _path: "/dokumentation/grundlagen/markdown-syntax",
+      collection: "docs",
+      locale: "de",
+      canonicalKey: "docs:markdown-syntax",
+      path: "/dokumentation/grundlagen/markdown-syntax",
       ref: "docs.markdown-syntax",
       title: "Markdown Syntax DE",
       description: "Dokumentation schreiben",
       order: 4
     },
     {
-      _collection: "posts",
-      _locale: "en",
-      _canonicalKey: "posts:onboarding",
-      _path: "/blog/multilingual-onboarding",
+      collection: "posts",
+      locale: "en",
+      canonicalKey: "posts:onboarding",
+      path: "/blog/multilingual-onboarding",
       ref: "posts.onboarding",
       title: "Multilingual Onboarding",
       description: "Launch notes",
@@ -549,10 +553,10 @@ export const createSaasProviderFixture = () => createProviderFixture({
       authors: ["authors.emily"]
     },
     {
-      _collection: "posts",
-      _locale: "de",
-      _canonicalKey: "posts:onboarding",
-      _path: "/magazin/mehrsprachiges-onboarding",
+      collection: "posts",
+      locale: "de",
+      canonicalKey: "posts:onboarding",
+      path: "/magazin/mehrsprachiges-onboarding",
       ref: "posts.onboarding",
       title: "Mehrsprachiges Onboarding",
       description: "Startnotizen",
@@ -560,30 +564,30 @@ export const createSaasProviderFixture = () => createProviderFixture({
       authors: ["authors.emily"]
     },
     {
-      _collection: "authors",
-      _locale: "en",
-      _canonicalKey: "authors:emily",
-      _path: "/authors/emily",
+      collection: "authors",
+      locale: "en",
+      canonicalKey: "authors:emily",
+      path: "/authors/emily",
       ref: "authors.emily",
       title: "Emily",
       name: "Emily",
       description: "Author"
     },
     {
-      _collection: "authors",
-      _locale: "de",
-      _canonicalKey: "authors:emily",
-      _path: "/autoren/emily",
+      collection: "authors",
+      locale: "de",
+      canonicalKey: "authors:emily",
+      path: "/autoren/emily",
       ref: "authors.emily",
       title: "Emily DE",
       name: "Emily",
       description: "Autorin"
     },
     {
-      _collection: "versions",
-      _locale: "en",
-      _canonicalKey: "versions:launch-readiness",
-      _path: "/changelog/launch-readiness",
+      collection: "versions",
+      locale: "en",
+      canonicalKey: "versions:launch-readiness",
+      path: "/changelog/launch-readiness",
       ref: "versions.launch-readiness",
       title: "Launch readiness",
       date: "2026-01-01"
@@ -600,18 +604,18 @@ export const createAuthorDependencyProviderFixture = () => createProviderFixture
     authors: { type: "page", route: "/authors" }
   },
   documents: [
-    { _collection: "authors", _path: "/authors/alice", ref: "authors.alice", title: "Alice", name: "Alice" },
-    { _collection: "authors", _path: "/authors/bob", ref: "authors.bob", title: "Bob", name: "Bob" },
+    { collection: "authors", path: "/authors/alice", ref: "authors.alice", title: "Alice", name: "Alice" },
+    { collection: "authors", path: "/authors/bob", ref: "authors.bob", title: "Bob", name: "Bob" },
     ...Array.from({ length: 5 }, (_, index) => ({
-      _collection: "blog",
-      _path: `/blog/post-${index + 1}`,
+      collection: "blog",
+      path: `/blog/post-${index + 1}`,
       ref: `blog.post-${index + 1}`,
       title: `Post ${index + 1}`,
       authors: ["authors.alice"]
     })),
     {
-      _collection: "blog",
-      _path: "/blog/post-6",
+      collection: "blog",
+      path: "/blog/post-6",
       ref: "blog.post-6",
       title: "Post 6",
       authors: ["authors.bob"]

package/dist/types/config.d.ts

@@ -32,14 +32,10 @@ export interface ContentCmsFieldConfig {
     description?: string | null;
     required?: boolean;
     localized?: boolean;
-    hidden?: boolean;
     searchable?: boolean;
     sortable?: boolean;
-    order?: number;
-    width?: 'full' | 'half';
     defaultValue?: unknown;
     validation?: Record<string, unknown> | null;
-    condition?: Record<string, unknown> | null;
     options?: string[] | null;
     relation?: ContentCmsRelationConfig | null;
     fields?: Record<string, ContentCmsFieldConfig> | ContentCmsFieldConfig[] | null;
@@ -48,6 +44,14 @@ export interface ContentCmsFieldConfig {
     step?: number | null;
     slugFrom?: string | null;
     language?: string | null;
+    /**
+     * Opaque editor-layout passthrough. ginko-content does not type or interpret
+     * this bag; it stores and forwards it byte-for-byte through `buildCmsContract`
+     * to the CMS field contract. Pure layout policy (field width, display order,
+     * hidden state, conditional visibility, etc.) belongs here — its schema is
+     * owned entirely by the consuming CMS (e.g. `@lupinum/ginko-cms`).
+     */
+    editor?: Record<string, unknown>;
 }
 export interface ContentCmsCollectionConfig {
     label?: string | Record<string, string>;