Package exports
Supported package import paths, execution environments, and focused guides.
This page is generated by pnpm api-docs:generate; do not edit it directly.
packages/content/package.json is the source of truth for import paths and
declaration targets. The generator requires a purpose, execution environment,
and focused guide for every manifest export, so an unclassified new subpath
fails pnpm api-docs:check.
Public TypeScript declarations at each subpath define its complete symbol-level
API. For example, the data-source declaration exposes
createContentDataSourceError and ContentDataSourceErrorCode as well as
the adapter interfaces and limits. See the
data-source adapter guide for their use.
Package subpaths
| Import | Environment | Purpose | Types | Guide |
|---|---|---|---|---|
@lupinum/ginko-content | Nuxt module setup | Module registration and content configuration helpers | ./dist/module.d.mts | Quickstart |
@lupinum/ginko-content/config | Build time | Collection, schema, and source configuration | ./dist/config.d.mts | Content config |
@lupinum/ginko-content/server | Nitro / H3 | Server queries, sitemap reads, and cache helpers | ./dist/public/server.d.ts | Server API |
@lupinum/ginko-content/provider | Nitro / H3 | Runtime content-provider contract and binder | ./dist/public/provider.d.ts | Providers |
@lupinum/ginko-content/data-source | Framework-free | Bounded backend adapter contract and stable errors | ./dist/public/data-source.d.ts | Data-source adapters |
@lupinum/ginko-content/client | Vue SSR / browser | Client query functions, page/search composables, and derivations | ./dist/public/client.d.ts | Query API |
@lupinum/ginko-content/navigation | Framework-free | Navigation-tree traversal and path helpers | ./dist/public/navigation.d.ts | Navigation |
@lupinum/ginko-content/agent | Framework-free | Agent-readable Markdown serialization and index rendering | ./dist/public/agent.d.ts | Agent-readable output |
@lupinum/ginko-content/agent-registry | Build time | Agent component-serializer registry definitions | ./dist/public/agent-registry.d.ts | Agent-readable output |
@lupinum/ginko-content/agent-paths | Framework-free | Canonical agent and raw-content route paths | ./dist/public/agent-paths.d.ts | Agent-readable output |
@lupinum/ginko-content/cms-contract | Framework-free | Resolved CMS contract, schema inspection, MDC, hashing, and safety | ./dist/cms-contract/index.d.ts | Data-source adapters |
@lupinum/ginko-content/portability | Framework-free | Portable document, manifest, asset, and validation codecs | ./dist/portability/index.d.ts | Portable reads and writes |
@lupinum/ginko-content/portability/node | Node | Bounded portable-directory filesystem I/O | ./dist/portability-node/index.d.ts | Portable reads and writes |
@lupinum/ginko-content/testing/provider-fixture | Vitest / Node | Reusable provider-contract fixture data | ./dist/testing/provider-fixture.d.ts | Provider contract |
@lupinum/ginko-content/testing/provider-contract | Vitest / Node | Executable provider conformance suite | ./dist/testing/provider-contract.d.ts | Provider contract |
@lupinum/ginko-content/testing/data-source-contract | Vitest / Node | Executable data-source and binder conformance suite | ./dist/testing/data-source-contract.d.ts | Adapter evidence |
@lupinum/ginko-content/testing/portability-contract | Vitest / Node | Executable portable-directory conformance suite | ./dist/testing/portability-contract.d.ts | Portable reads and writes |
@lupinum/ginko-content/transformers | Build time | Custom content-transformer definition helper | ./dist/runtime/transformers/define.d.ts | Module options |