@lupinum/ginko-content 0.1.0 → 0.1.2

package/dist/types/module.d.ts

@@ -160,6 +160,36 @@ export 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`.
      *
@@ -195,7 +225,8 @@ export 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[];
     /**
@@ -258,8 +289,9 @@ export 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;
     /**
@@ -386,12 +418,13 @@ export 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>;
     /**

package/dist/types/query.d.ts

@@ -1,6 +1,6 @@
 import type { ContentQueryResponse } from './api';
 import type { ContentCollectionHandle } from './config';
-import type { ContentNavigationItem, ParsedContent, ParsedContentInternalMeta, ParsedContentMeta, StrictParsedContentMeta } from './content';
+import type { ContentNavigationItem, ParsedContent, ParsedContentInternalMeta, ParsedContentMeta, StrictParsedContent, StrictParsedContentMeta } from './content';
 /**
  * Query
  */
@@ -434,6 +434,7 @@ export interface ContentSitemapImage {
 export interface ContentSitemapEntry {
     loc: string;
     _sitemap?: string;
+    lastmod?: string;
     alternatives?: ContentSitemapAlternative[];
     images?: ContentSitemapImage[];
 }
@@ -530,12 +531,20 @@ export interface ContentQueryRequest {
  */
 export type ContentQueryFetcher<T> = (query: ContentQueryRequest) => Promise<ContentQueryResponse<T>>;
 export type QueryMatchOperator = (item: unknown, condition: unknown) => boolean;
-export interface ContentCollectionMap {
+declare global {
+    interface GinkoContentCollectionMap {
+    }
+    interface GinkoContentCollectionI18nMap {
+    }
 }
-export interface ContentCollectionI18nMap {
+export interface ContentCollectionMap extends GinkoContentCollectionMap {
 }
-export type ContentCollectionName = keyof ContentCollectionMap & string;
+export interface ContentCollectionI18nMap extends GinkoContentCollectionI18nMap {
+}
+export type ContentCollectionName = keyof GinkoContentCollectionMap & string;
 export type ContentCollectionItem<K extends ContentCollectionName> = ContentCollectionMap[K];
+export type ContentCollectionStringName = [ContentCollectionName] extends [never] ? string : ContentCollectionName;
+export type ContentCollectionTarget = ContentCollectionHandle | ContentCollectionStringName;
 /**
  * ============================================================================
  *  Unified Query API — public surface (ADR-0016)
@@ -626,8 +635,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.
  */
@@ -635,12 +644,12 @@ export 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.
  */
-export type PopulateSpec = Record<string, ContentCollectionHandle | string>;
+export type PopulateSpec = Record<string, ContentCollectionTarget>;
 export 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;
@@ -655,7 +664,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.
  */
@@ -772,7 +781,7 @@ export interface PaginationResult<T = ParsedContentMeta> {
     nextPage: number | null;
     prevPage: number | null;
 }
-export type BacklinkSource = ContentCollectionHandle | string;
+export type BacklinkSource = ContentCollectionTarget;
 type SourceName<S> = S extends string ? S : S extends {
     name: infer N;
 } ? Extract<N, string> : string;
@@ -799,7 +808,7 @@ export type BacklinksOptions<Target = unknown, Source extends BacklinkSource | R
     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>;
 export type BacklinksResult<Source extends BacklinkSource | ReadonlyArray<BacklinkSource> = BacklinkSource | ReadonlyArray<BacklinkSource>, P extends PopulateSpec | undefined = undefined> = Array<LocalizedDoc<PopulatedDocument<DocumentFromSource<Source>, P>>>;
 /**

package/dist/types/search.d.ts

@@ -9,7 +9,7 @@ export interface ContentMiniSearchOptions {
     /**
      * Fields copied into search result payloads.
      *
-     * @default ['path', 'title', 'excerpt', 'anchor', 'locale']
+     * @default ['path', 'title', 'excerpt', 'anchor', 'locale', 'collection']
      */
     storeFields: string[];
     /**
@@ -39,6 +39,7 @@ export interface ContentSearchPublicRuntimeConfig {
 }
 export interface ContentSearchIndexRecord {
     id: string;
+    collection: string;
     path: string;
     title: string;
     excerpt: string;
@@ -49,6 +50,7 @@ export interface ContentSearchIndexRecord {
     [field: string]: unknown;
 }
 export interface ContentSearchResult {
+    collection: string;
     path: string;
     title: string;
     excerpt: string;

package/dist/types.d.mts

@@ -6,6 +6,6 @@ declare module '@nuxt/schema' {
 
 export { type defineCollection, type defineContentConfig, type reference } from '../dist/types/config'
 
-export { default } from './module.mjs'
+export { default, type normalizeContentConfigCollectionNames } from './module.mjs'
 
-export { type BacklinkFields, type BacklinkSource, type BacklinksOptions, type BacklinksResult, type BuiltinContentProviderName, type CollectionQueryBuilder, type CollectionQueryOperator, type CollectionQueryValue, type CollectionSchema, type ContentCacheArtifact, type ContentCmsCollectionConfig, type ContentCmsFieldConfig, type ContentCmsFieldType, type ContentCmsRelationConfig, type ContentCollectionConfig, type ContentCollectionHandle, type ContentCollectionI18nConfig, type ContentCollectionI18nMap, type ContentCollectionItem, type ContentCollectionItemSurroundingsOptions, type ContentCollectionKind, type ContentCollectionMap, type ContentCollectionName, type ContentCollectionNavigationOptions, type ContentCollectionPageOptions, type ContentCollectionRouteConfig, type ContentCollectionRouteMetaOptions, type ContentCollectionSearchSectionsOptions, type ContentCollectionSource, type ContentCollectionSourceObject, type ContentConfig, type ContentContext, type ContentI18nOptions, type ContentLocaleEntry, type ContentLocaleRoute, type ContentManifest, type ContentMiniSearchOptions, type ContentNavigationItem, type ContentPageResult, type ContentPreviewOptions, type ContentProviderName, type ContentProviderSearchRequest, type ContentQueryBuilder, type ContentQueryBuilderParams, type ContentQueryBuilderWhere, type ContentQueryFetcher, type ContentQueryRequest, type ContentQuerySortFields, type ContentQuerySortOptions, type ContentQuerySortParams, type ContentReferenceSchema, type ContentResolvedMeta, type ContentRevalidateOptions, type ContentRouteMeta, type ContentSearchEngine, type ContentSearchIndexRecord, type ContentSearchOptions, type ContentSearchPublicRuntimeConfig, type ContentSearchResult, type ContentSearchSection, type ContentSelector, type ContentSeoImage, type ContentSeoMeta, type ContentSitemapAlternative, type ContentSitemapAssertOptions, type ContentSitemapAssertSitemapOptions, type ContentSitemapEntry, type ContentSitemapImage, type ContentSitemapOptions, type ContentTransformer, type ContentTreeItem, type ContentVariant, type DefineCollectionObject, type DefineCollectionOptions, type DocumentFromHandle, type LocaleFallback, type LocalePathEntry, type LocalizedDoc, type ManifestVariant, type ManyOptions, type MarkdownNode, type MarkdownOptions, type MarkdownParsedContent, type MarkdownPluginDescriptor, type MarkdownPluginOptions, type MarkdownRoot, type ModuleHooks, type ModuleOptions, type MountOptions, type NavItem, type NeighborsOptions, type NeighborsResult, type OneOptions, type PaginationOptions, type PaginationResult, type ParseContentOptions, type ParsedContent, type ParsedContentInternalMeta, type ParsedContentMeta, type PopulateFromOptions, type PopulateSpec, type PopulatedDocument, type QueryGroupBuilder, type QueryGroupFunction, type QueryMatchOperator, type QueryOperators, type QueryOrderDirection, type QueryOrderOptions, type QueryWhere, type ResolutionEnvelope, type ResolveContentReferenceOptions, type ResolveOneOptions, type ResolveOneResult, type ResolvedContentI18nOptions, type ResolvedMarkdownPlugin, type ResolvedVariant, type SortDirection, type SortSpec, type StrictParsedContent, type StrictParsedContentMeta, type Toc, type TocLink, type TransformContentOptions, type TransformContentSource, type TreeOptions, type VariantsOptions } from './module.mjs'
+export { type BacklinkFields, type BacklinkSource, type BacklinksOptions, type BacklinksResult, type CollectionQueryBuilder, type CollectionQueryOperator, type CollectionQueryValue, type CollectionSchema, type ContentCacheArtifact, type ContentCmsCollectionConfig, type ContentCmsFieldConfig, type ContentCmsFieldType, type ContentCmsRelationConfig, type ContentCollectionConfig, type ContentCollectionHandle, type ContentCollectionI18nConfig, type ContentCollectionI18nMap, type ContentCollectionItem, type ContentCollectionItemSurroundingsOptions, type ContentCollectionKind, type ContentCollectionMap, type ContentCollectionName, type ContentCollectionNavigationOptions, type ContentCollectionPageOptions, type ContentCollectionRouteConfig, type ContentCollectionRouteMetaOptions, type ContentCollectionSearchSectionsOptions, type ContentCollectionSource, type ContentCollectionSourceObject, type ContentCollectionStringName, type ContentCollectionTarget, type ContentConfig, type ContentContext, type ContentI18nOptions, type ContentLocaleEntry, type ContentLocaleRoute, type ContentManifest, type ContentMiniSearchOptions, type ContentNavigationItem, type ContentPageResult, type ContentPreviewOptions, type ContentProviderName, type ContentProviderSearchRequest, type ContentQueryBuilder, type ContentQueryBuilderParams, type ContentQueryBuilderWhere, type ContentQueryFetcher, type ContentQueryRequest, type ContentQuerySortFields, type ContentQuerySortOptions, type ContentQuerySortParams, type ContentReferenceSchema, type ContentResolvedMeta, type ContentRevalidateOptions, type ContentRouteMeta, type ContentSearchEngine, type ContentSearchIndexRecord, type ContentSearchOptions, type ContentSearchPublicRuntimeConfig, type ContentSearchResult, type ContentSearchSection, type ContentSelector, type ContentSeoImage, type ContentSeoMeta, type ContentSitemapAlternative, type ContentSitemapAssertOptions, type ContentSitemapAssertSitemapOptions, type ContentSitemapEntry, type ContentSitemapImage, type ContentSitemapOptions, type ContentTransformer, type ContentTreeItem, type ContentVariant, type DefineCollectionObject, type DefineCollectionOptions, type DocumentFromHandle, type LocaleFallback, type LocalePathEntry, type LocalizedDoc, type ManifestVariant, type ManyOptions, type MarkdownNode, type MarkdownOptions, type MarkdownParsedContent, type MarkdownPluginDescriptor, type MarkdownPluginOptions, type MarkdownRoot, type ModuleHooks, type ModuleOptions, type MountOptions, type NavItem, type NeighborsOptions, type NeighborsResult, type OneOptions, type PaginationOptions, type PaginationResult, type ParseContentOptions, type ParsedContent, type ParsedContentInternalMeta, type ParsedContentMeta, type PopulateFromOptions, type PopulateSpec, type PopulatedDocument, type QueryGroupBuilder, type QueryGroupFunction, type QueryMatchOperator, type QueryOperators, type QueryOrderDirection, type QueryOrderOptions, type QueryWhere, type ResolutionEnvelope, type ResolveContentReferenceOptions, type ResolveOneOptions, type ResolveOneResult, type ResolvedContentI18nOptions, type ResolvedMarkdownPlugin, type ResolvedVariant, type SortDirection, type SortSpec, type StrictParsedContent, type StrictParsedContentMeta, type Toc, type TocLink, type TransformContentOptions, type TransformContentSource, type TreeOptions, type VariantsOptions } from './module.mjs'

package/dist/web-types.json

@@ -1,7 +1,7 @@
 {
   "framework": "vue",
   "name": "@lupinum/ginko-content",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "contributions": {
     "html": {
       "description-markup": "markdown",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lupinum/ginko-content",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Collection-first content engine for Nuxt",
   "homepage": "https://ginko-content.nuxt.dev",
   "bugs": {
@@ -86,7 +86,7 @@
   ],
   "dependencies": {
     "@comark/vue": "^0.3.1",
-    "@nuxt/kit": "^4.4.6",
+    "@nuxt/kit": "^4.4.7",
     "comark": "^0.3.2",
     "consola": "^3.4.2",
     "defu": "^6.1.7",
@@ -114,12 +114,12 @@
   },
   "devDependencies": {
     "@nuxt/module-builder": "1.0.2",
-    "nuxt": "4.4.6",
+    "nuxt": "4.4.7",
     "unbuild": "^3.6.1",
     "vue-docgen-web-types": "^0.1.8"
   },
   "peerDependencies": {
-    "nuxt": ">=4.0.0",
+    "nuxt": ">=4.4.7",
     "vitest": ">=4.1.6",
     "vue": "^3.5.0"
   },