@lupinum/ginko-content 0.1.0 → 0.1.2

package/dist/module.d.mts

@@ -4,8 +4,8 @@ import { ContentCollectionConfig as ContentCollectionConfig$1, ContentCollection
 export { defineCollection, defineContentConfig, reference } from '../dist/types/config';
 import { StorageValue } from 'unstorage';
 import { ModuleOptions as ModuleOptions$1, ContentContext as ContentContext$1, ContentRevalidateOptions as ContentRevalidateOptions$1 } from '../dist/types/module';
-import { ContentSearchPublicRuntimeConfig as ContentSearchPublicRuntimeConfig$1 } from '../dist/types/search';
 import { ZodType, z } from 'zod';
+import { ContentSearchPublicRuntimeConfig as ContentSearchPublicRuntimeConfig$1 } from '../dist/types/search';
 import { ListenOptions } from 'listhen';
 
 /**
@@ -29,6 +29,7 @@ type ContentCollectionSource = string | string[];
  * express roots such as `{ en: '/docs', de: '/dokumentation' }`.
  */
 type ContentCollectionRouteConfig = string | Record<string, string>;
+type ContentCollectionKind = 'page' | 'data';
 type ContentCmsFieldType = 'text' | 'textarea' | 'richtext' | 'slug' | 'email' | 'url' | 'number' | 'range' | 'select' | 'multiselect' | 'radio' | 'checkbox' | 'toggle' | 'date' | 'datetime' | 'time' | 'json' | 'object' | 'array' | 'blocks' | 'relation' | 'relations' | 'image' | 'images' | 'file' | 'icon' | 'code' | 'color' | 'divider' | 'section';
 interface ContentCmsRelationConfig {
     collectionId: string;
@@ -88,6 +89,11 @@ interface ContentCollectionSourceObject {
  * Declarative collection definition used by `content.config.ts`.
  */
 interface ContentCollectionConfig<TSchema extends ZodType | undefined = ZodType | undefined> {
+    /**
+     * Collection kind declared in `defineCollection`. Page collections are public
+     * content routes by default; data collections are app-owned records.
+     */
+    type?: ContentCollectionKind;
     /**
      * Source glob or source descriptor understood by the filesystem ingestion
      * layer. CMS-backed projects do not need a runtime source; filesystem
@@ -140,14 +146,13 @@ interface ContentCollectionConfig<TSchema extends ZodType | undefined = ZodType
      */
     cms?: ContentCmsCollectionConfig;
 }
-type ContentCollectionKind = 'page' | 'data';
-type BuiltinContentProviderName = 'filesystem' | 'cms' | 'ginko-cms' | 'ginko';
-type ContentProviderName = BuiltinContentProviderName | (string & {});
+type ContentProviderName = 'filesystem' | (string & {});
 type DefineCollectionOptions<TSchema extends ZodType | undefined = ZodType | undefined> = Omit<ContentCollectionConfig<TSchema>, 'source' | 'exclude'>;
 interface DefineCollectionObject<TSchema extends ZodType | undefined = ZodType | undefined> extends DefineCollectionOptions<TSchema> {
     /**
      * Nuxt Content v3-compatible collection kind. Ginko does not keep separate
-     * page/data collection runtimes; `data` collections default to `sitemap: false`.
+     * page/data query builders, but the kind remains canonical metadata at runtime.
+     * `data` collections default to `sitemap: false`.
      */
     type: ContentCollectionKind;
     /**
@@ -162,14 +167,13 @@ interface DefineCollectionObject<TSchema extends ZodType | undefined = ZodType |
  */
 interface ContentConfig<TCollections extends Record<string, ContentCollectionConfig> = Record<string, ContentCollectionConfig>> {
     /**
-     * Content backing implementation. `filesystem` is the default. `cms`,
-     * `ginko-cms`, and `ginko` resolve to the official Ginko CMS provider when
-     * `@lupinum/ginko-cms` is installed.
+     * Content backing implementation. `filesystem` is the default. Provider
+     * modules can register named implementations, for example `cms`.
      */
     provider?: ContentProviderName;
     /**
-     * External provider modules keyed by provider name. Built-in providers do not
-     * need to be registered here.
+     * External provider modules keyed by provider name. First-party provider
+     * modules register themselves, so app configs usually do not need this.
      */
     providers?: Record<string, string>;
     /**
@@ -221,6 +225,17 @@ interface ContentCollectionHandle<Name extends string = string, TSchema extends
      */
     readonly __schema: TSchema;
 }
+type IsI18nConfig<TConfig> = TConfig extends {
+    i18n: true | ContentCollectionI18nConfig;
+} ? TConfig['i18n'] extends false ? false : true : false;
+type CollectionNameFromConfigKey<Key extends string, TCollection> = TCollection extends ContentCollectionHandle<infer Name, ZodType | undefined, boolean> ? [Name] extends [never] ? Key : Name : Key;
+type NamedContentCollection<Key extends string, TCollection> = TCollection extends ContentCollectionHandle<infer Name, infer TSchema, infer TI18n> ? Omit<TCollection, 'name' | '__schema' | '__i18n'> & ContentCollectionHandle<[
+    Name
+] extends [never] ? Key : Name, TSchema, TI18n> : TCollection extends ContentCollectionConfig<infer TSchema> ? Omit<TCollection, 'name' | '__schema' | '__i18n'> & ContentCollectionHandle<CollectionNameFromConfigKey<Key, TCollection>, TSchema, IsI18nConfig<TCollection>> : TCollection;
+type NamedContentCollections<TCollections extends Record<string, ContentCollectionConfig>> = {
+    [Key in keyof TCollections]: Key extends string ? NamedContentCollection<Key, TCollections[Key]> : TCollections[Key];
+};
+declare function normalizeContentConfigCollectionNames<TCollections extends Record<string, ContentCollectionConfig>>(collections: TCollections): NamedContentCollections<TCollections>;
 
 type LayoutKey = string;
 interface ContentSeoImage {
@@ -1012,6 +1027,7 @@ interface ContentSitemapImage {
 interface ContentSitemapEntry {
     loc: string;
     _sitemap?: string;
+    lastmod?: string;
     alternatives?: ContentSitemapAlternative[];
     images?: ContentSitemapImage[];
 }
@@ -1108,12 +1124,20 @@ interface ContentQueryRequest {
  */
 type ContentQueryFetcher<T> = (query: ContentQueryRequest) => Promise<ContentQueryResponse<T>>;
 type QueryMatchOperator = (item: unknown, condition: unknown) => boolean;
-interface ContentCollectionMap {
+declare global {
+    interface GinkoContentCollectionMap {
+    }
+    interface GinkoContentCollectionI18nMap {
+    }
+}
+interface ContentCollectionMap extends GinkoContentCollectionMap {
 }
-interface ContentCollectionI18nMap {
+interface ContentCollectionI18nMap extends GinkoContentCollectionI18nMap {
 }
-type ContentCollectionName = keyof ContentCollectionMap & string;
+type ContentCollectionName = keyof GinkoContentCollectionMap & string;
 type ContentCollectionItem<K extends ContentCollectionName> = ContentCollectionMap[K];
+type ContentCollectionStringName = [ContentCollectionName] extends [never] ? string : ContentCollectionName;
+type ContentCollectionTarget = ContentCollectionHandle | ContentCollectionStringName;
 /**
  * ============================================================================
  *  Unified Query API — public surface (ADR-0016)
@@ -1204,8 +1228,8 @@ type HandleSchema<H> = H extends {
     __schema: infer S;
 } ? S extends {
     _output: infer O;
-} ? O & StrictParsedContentMeta : StrictParsedContentMeta : StrictParsedContentMeta;
-type SelectFields<H> = H extends string ? ReadonlyArray<string> : ReadonlyArray<Extract<keyof HandleSchema<H>, string>>;
+} ? O & StrictParsedContentMeta : StrictParsedContentMeta : H extends ContentCollectionName ? ContentCollectionMap[H] & StrictParsedContentMeta : StrictParsedContentMeta;
+type SelectFields<H> = string extends H ? ReadonlyArray<string> : ReadonlyArray<Extract<keyof HandleSchema<H>, string>>;
 /**
  * Runtime document shape inferred from a collection handle.
  */
@@ -1213,12 +1237,12 @@ type DocumentFromHandle<H> = H extends {
     __schema: {
         _output: infer O;
     };
-} ? O & ParsedContent : ParsedContent;
+} ? O & StrictParsedContent : H extends ContentCollectionName ? ContentCollectionMap[H] : ParsedContent;
 /**
  * Explicit reference population map. Keys are fields on the source document;
  * values are target collection handles.
  */
-type PopulateSpec = Record<string, ContentCollectionHandle | string>;
+type PopulateSpec = Record<string, ContentCollectionTarget>;
 type PopulatedDocument<T, P> = P extends undefined ? T : P extends PopulateSpec ? string extends keyof P ? T : Omit<T, keyof P> & {
     [K in keyof P & keyof T]: T[K] extends ReadonlyArray<unknown> ? Array<LocalizedDoc<DocumentFromHandle<P[K]>>> : LocalizedDoc<DocumentFromHandle<P[K]>> | null;
 } : T;
@@ -1233,7 +1257,7 @@ type PopulateOption<P extends PopulateSpec | undefined = undefined> = {
  */
 type HandleIsI18n<H> = H extends {
     __i18n: infer I;
-} ? I extends true ? true : false : false;
+} ? I extends true ? true : false : H extends keyof GinkoContentCollectionI18nMap ? true : false;
 /**
  * Locale option made required when the handle is i18n.
  */
@@ -1350,7 +1374,7 @@ interface PaginationResult<T = ParsedContentMeta> {
     nextPage: number | null;
     prevPage: number | null;
 }
-type BacklinkSource = ContentCollectionHandle | string;
+type BacklinkSource = ContentCollectionTarget;
 type SourceName<S> = S extends string ? S : S extends {
     name: infer N;
 } ? Extract<N, string> : string;
@@ -1377,7 +1401,7 @@ type BacklinksOptions<Target = unknown, Source extends BacklinkSource | Readonly
     limit?: number;
     skip?: number;
     fallback?: LocaleFallback;
-    select?: Source extends string ? ReadonlyArray<string> : ReadonlyArray<Extract<keyof DocumentFromSource<Source>, string>>;
+    select?: string extends Source ? ReadonlyArray<string> : ReadonlyArray<Extract<keyof DocumentFromSource<Source>, string>>;
 } & BacklinksLocaleOption<Target, Source> & PopulateOption<P>;
 type BacklinksResult<Source extends BacklinkSource | ReadonlyArray<BacklinkSource> = BacklinkSource | ReadonlyArray<BacklinkSource>, P extends PopulateSpec | undefined = undefined> = Array<LocalizedDoc<PopulatedDocument<DocumentFromSource<Source>, P>>>;
 /**
@@ -1449,7 +1473,7 @@ interface ContentMiniSearchOptions {
     /**
      * Fields copied into search result payloads.
      *
-     * @default ['path', 'title', 'excerpt', 'anchor', 'locale']
+     * @default ['path', 'title', 'excerpt', 'anchor', 'locale', 'collection']
      */
     storeFields: string[];
     /**
@@ -1479,6 +1503,7 @@ interface ContentSearchPublicRuntimeConfig {
 }
 interface ContentSearchIndexRecord {
     id: string;
+    collection: string;
     path: string;
     title: string;
     excerpt: string;
@@ -1489,6 +1514,7 @@ interface ContentSearchIndexRecord {
     [field: string]: unknown;
 }
 interface ContentSearchResult {
+    collection: string;
     path: string;
     title: string;
     excerpt: string;
@@ -1660,6 +1686,36 @@ interface ContentSitemapAssertOptions {
      * @default []
      */
     requiredCollections?: string[];
+    /**
+     * Public URL paths that must appear in generated sitemap loc values.
+     *
+     * Values are compared by URL pathname, so absolute sitemap URLs are
+     * normalized before assertion. Use this for release QA of important route
+     * identities; keep `requiredCollections` for the broader content invariant.
+     *
+     * @default []
+     */
+    requiredPaths?: string[];
+    /**
+     * Public URL path prefixes that must not appear in generated sitemap loc
+     * values.
+     *
+     * Use this to guard against internal/generated routes such as `/_payload`,
+     * `/_nuxt`, API routes, or auth-only sections.
+     *
+     * @default []
+     */
+    forbiddenPathPrefixes?: string[];
+    /**
+     * Fail when generated sitemap URLs use placeholder or local hosts such as
+     * `example.com`, `localhost`, `127.0.0.1`, or `.localhost`.
+     *
+     * Enable this for production-like release checks. It is disabled by default
+     * so local examples and template builds can still generate static output.
+     *
+     * @default false
+     */
+    requireProductionSiteUrl?: boolean;
     /**
      * Optional per-sitemap overrides keyed by sitemap name, for example `en-US`.
      *
@@ -1695,7 +1751,8 @@ interface ContentSearchOptions {
     /**
      * Collections included in the built-in index.
      *
-     * When omitted, all configured collections are indexed.
+     * When omitted, Ginko indexes route-backed public collections only. Data-only
+     * collections are excluded unless listed explicitly.
      */
     collections?: string[];
     /**
@@ -1758,8 +1815,9 @@ interface ModuleOptions {
      * Built-in full-text search configuration.
      *
      * When enabled, Ginko exposes JSON/Pagefind search endpoints under
-     * the content api base route. Import `useContentSearchResults()` from
-     * `@lupinum/ginko-content/client` to consume them from app components.
+     * the content api base route. `useContentSearchData()` and
+     * `useContentSearchResults()` are auto-imported; import the headless
+     * `useContentSearch()` helper from `@lupinum/ginko-content/client`.
      */
     search: false | ContentSearchOptions;
     /**
@@ -1886,12 +1944,13 @@ interface ModuleOptions {
     /**
      * Backing implementation for public content reads.
      *
-     * `filesystem` is the default. `cms`, `ginko-cms`, and `ginko` resolve to the
-     * official Ginko CMS provider when `@lupinum/ginko-cms` is installed.
+     * `filesystem` is the default. Provider modules can register named
+     * implementations, for example `cms`.
      */
     provider?: ContentProviderName;
     /**
-     * External provider modules keyed by provider name.
+     * External provider modules keyed by provider name. First-party provider
+     * modules register themselves, so app configs usually do not need this.
      */
     providers?: Record<string, string>;
     /**
@@ -1973,7 +2032,8 @@ declare function createSearchRuntimeConfig(search: Exclude<ModuleOptions$1['sear
 declare const _default: _nuxt_schema.NuxtModule<ModuleOptions$1, ModuleOptions$1, false>;
 
 interface ModuleHooks {
-    'content:context'(ctx: ContentContext$1): void;
+    'content:providers'(providers: Record<string, string>): void | Promise<void>;
+    'content:context'(ctx: ContentContext$1): void | Promise<void>;
 }
 interface ModulePublicRuntimeConfig {
     experimental: {
@@ -2040,5 +2100,5 @@ declare module 'nitropack' {
     }
 }
 
-export { _default as default };
-export type { BacklinkFields, BacklinkSource, BacklinksOptions, BacklinksResult, BuiltinContentProviderName, CollectionQueryBuilder, CollectionQueryOperator, CollectionQueryValue, CollectionSchema, ContentCacheArtifact, ContentCmsCollectionConfig, ContentCmsFieldConfig, ContentCmsFieldType, ContentCmsRelationConfig, ContentCollectionConfig, ContentCollectionHandle, ContentCollectionI18nConfig, ContentCollectionI18nMap, ContentCollectionItem, ContentCollectionItemSurroundingsOptions, ContentCollectionKind, ContentCollectionMap, ContentCollectionName, ContentCollectionNavigationOptions, ContentCollectionPageOptions, ContentCollectionRouteConfig, ContentCollectionRouteMetaOptions, ContentCollectionSearchSectionsOptions, ContentCollectionSource, ContentCollectionSourceObject, ContentConfig, ContentContext, ContentI18nOptions, ContentLocaleEntry, ContentLocaleRoute, ContentManifest, ContentMiniSearchOptions, ContentNavigationItem, ContentPageResult, ContentPreviewOptions, ContentProviderName, ContentProviderSearchRequest, ContentQueryBuilder, ContentQueryBuilderParams, ContentQueryBuilderWhere, ContentQueryFetcher, ContentQueryRequest, ContentQuerySortFields, ContentQuerySortOptions, ContentQuerySortParams, ContentReferenceSchema, ContentResolvedMeta, ContentRevalidateOptions, ContentRouteMeta, ContentSearchEngine, ContentSearchIndexRecord, ContentSearchOptions, ContentSearchPublicRuntimeConfig, ContentSearchResult, ContentSearchSection, ContentSelector, ContentSeoImage, ContentSeoMeta, ContentSitemapAlternative, ContentSitemapAssertOptions, ContentSitemapAssertSitemapOptions, ContentSitemapEntry, ContentSitemapImage, ContentSitemapOptions, ContentTransformer, ContentTreeItem, ContentVariant, DefineCollectionObject, DefineCollectionOptions, DocumentFromHandle, LocaleFallback, LocalePathEntry, LocalizedDoc, ManifestVariant, ManyOptions, MarkdownNode, MarkdownOptions, MarkdownParsedContent, MarkdownPluginDescriptor, MarkdownPluginOptions, MarkdownRoot, ModuleHooks, ModuleOptions, MountOptions, NavItem, NeighborsOptions, NeighborsResult, OneOptions, PaginationOptions, PaginationResult, ParseContentOptions, ParsedContent, ParsedContentInternalMeta, ParsedContentMeta, PopulateFromOptions, PopulateSpec, PopulatedDocument, QueryGroupBuilder, QueryGroupFunction, QueryMatchOperator, QueryOperators, QueryOrderDirection, QueryOrderOptions, QueryWhere, ResolutionEnvelope, ResolveContentReferenceOptions, ResolveOneOptions, ResolveOneResult, ResolvedContentI18nOptions, ResolvedMarkdownPlugin, ResolvedVariant, SortDirection, SortSpec, StrictParsedContent, StrictParsedContentMeta, Toc, TocLink, TransformContentOptions, TransformContentSource, TreeOptions, VariantsOptions };
+export { _default as default, normalizeContentConfigCollectionNames };
+export type { BacklinkFields, BacklinkSource, BacklinksOptions, BacklinksResult, CollectionQueryBuilder, CollectionQueryOperator, CollectionQueryValue, CollectionSchema, ContentCacheArtifact, ContentCmsCollectionConfig, ContentCmsFieldConfig, ContentCmsFieldType, ContentCmsRelationConfig, ContentCollectionConfig, ContentCollectionHandle, ContentCollectionI18nConfig, ContentCollectionI18nMap, ContentCollectionItem, ContentCollectionItemSurroundingsOptions, ContentCollectionKind, ContentCollectionMap, ContentCollectionName, ContentCollectionNavigationOptions, ContentCollectionPageOptions, ContentCollectionRouteConfig, ContentCollectionRouteMetaOptions, ContentCollectionSearchSectionsOptions, ContentCollectionSource, ContentCollectionSourceObject, ContentCollectionStringName, ContentCollectionTarget, ContentConfig, ContentContext, ContentI18nOptions, ContentLocaleEntry, ContentLocaleRoute, ContentManifest, ContentMiniSearchOptions, ContentNavigationItem, ContentPageResult, ContentPreviewOptions, ContentProviderName, ContentProviderSearchRequest, ContentQueryBuilder, ContentQueryBuilderParams, ContentQueryBuilderWhere, ContentQueryFetcher, ContentQueryRequest, ContentQuerySortFields, ContentQuerySortOptions, ContentQuerySortParams, ContentReferenceSchema, ContentResolvedMeta, ContentRevalidateOptions, ContentRouteMeta, ContentSearchEngine, ContentSearchIndexRecord, ContentSearchOptions, ContentSearchPublicRuntimeConfig, ContentSearchResult, ContentSearchSection, ContentSelector, ContentSeoImage, ContentSeoMeta, ContentSitemapAlternative, ContentSitemapAssertOptions, ContentSitemapAssertSitemapOptions, ContentSitemapEntry, ContentSitemapImage, ContentSitemapOptions, ContentTransformer, ContentTreeItem, ContentVariant, DefineCollectionObject, DefineCollectionOptions, DocumentFromHandle, LocaleFallback, LocalePathEntry, LocalizedDoc, ManifestVariant, ManyOptions, MarkdownNode, MarkdownOptions, MarkdownParsedContent, MarkdownPluginDescriptor, MarkdownPluginOptions, MarkdownRoot, ModuleHooks, ModuleOptions, MountOptions, NavItem, NeighborsOptions, NeighborsResult, OneOptions, PaginationOptions, PaginationResult, ParseContentOptions, ParsedContent, ParsedContentInternalMeta, ParsedContentMeta, PopulateFromOptions, PopulateSpec, PopulatedDocument, QueryGroupBuilder, QueryGroupFunction, QueryMatchOperator, QueryOperators, QueryOrderDirection, QueryOrderOptions, QueryWhere, ResolutionEnvelope, ResolveContentReferenceOptions, ResolveOneOptions, ResolveOneResult, ResolvedContentI18nOptions, ResolvedMarkdownPlugin, ResolvedVariant, SortDirection, SortSpec, StrictParsedContent, StrictParsedContentMeta, Toc, TocLink, TransformContentOptions, TransformContentSource, TreeOptions, VariantsOptions };

package/dist/module.json

@@ -1,6 +1,6 @@
 {
   "name": "@lupinum/ginko-content",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "configKey": "content",
   "compatibility": {
     "nuxt": ">=4.0.0"