nextjs-studio 0.4.0 → 1.0.0

package/dist/core/index.d.ts

@@ -1,411 +1,54 @@
-/**
- * @context  Shared layer — field type system at src/shared/fields.ts
- * @does     Defines every field interface, the FieldDefinition union, and CollectionSchema
- * @depends  none
- * @do       Add new field types here; the UI and type-generator derive behavior from this shape
- * @dont     Import from CLI or UI; contain runtime logic beyond fieldLabel utilities
- */
-declare const __brand: unique symbol;
-type Brand<T, B extends string> = T & {
-    readonly [__brand]: B;
-};
-type Email = Brand<string, "Email">;
-type HttpUrl = Brand<string, "HttpUrl">;
-type ISODate = Brand<string, "ISODate">;
-type MediaPath = Brand<string, "MediaPath">;
-type ID = Brand<string, "ID">;
-type Slug = Brand<string, "Slug">;
-interface SelectOption {
-    label: string;
-    value: string;
-    color?: string;
-}
-interface StatusOption {
-    label: string;
-    value: string;
-    /** Semantic color bucket — maps to a badge color in the editor. */
-    color?: "gray" | "red" | "yellow" | "green" | "blue" | "purple";
-}
-interface BaseField {
-    /** Machine-readable key used in the data object / JSON key. */
-    name: string;
-    /** Human-readable label shown in the editor. Defaults to `name`. */
-    label?: string;
-    /** Whether the field must have a non-empty value. */
-    required?: boolean;
-    /** Helper text shown below the input in the editor. */
-    description?: string;
-    /** Default value used when creating a new entry. */
-    defaultValue?: unknown;
-}
-interface TextField extends BaseField {
-    type: "text";
-    placeholder?: string;
-    maxLength?: number;
-}
-interface LongTextField extends BaseField {
-    type: "long-text";
-    placeholder?: string;
-    /** Minimum visible rows in the textarea. */
-    rows?: number;
-}
-interface NumberField extends BaseField {
-    type: "number";
-    format?: "integer" | "decimal";
-    min?: number;
-    max?: number;
-    step?: number;
-}
-interface BooleanField extends BaseField {
-    type: "boolean";
-    defaultValue?: boolean;
-}
-interface DateField extends BaseField {
-    type: "date";
-    /**
-     * When `true` the editor renders a datetime-picker (date + time).
-     * When `false` or omitted it renders a date-only picker.
-     */
-    includeTime?: boolean;
-}
-interface SelectField extends BaseField {
-    type: "select";
-    options: SelectOption[];
-    defaultValue?: string;
-}
-interface MultiSelectField extends BaseField {
-    type: "multi-select";
-    options: SelectOption[];
-    defaultValue?: string[];
-}
-interface UrlField extends BaseField {
-    type: "url";
-    placeholder?: string;
-}
-interface EmailField extends BaseField {
-    type: "email";
-    placeholder?: string;
-}
-interface MediaField extends BaseField {
-    type: "media";
-    /** Accepted MIME types or extensions, e.g. `["image/*"]`. */
-    accept?: string[];
-}
-interface ObjectField extends BaseField {
-    type: "object";
-    /** Nested field definitions rendered as a form. */
-    fields: FieldDefinition[];
-}
-interface ArrayField extends BaseField {
-    type: "array";
-    /** Shape of each item in the array — rendered as a sheet (table). */
-    itemFields: FieldDefinition[];
-}
-interface IdField extends BaseField {
-    type: "id";
-    /** Strategy for auto-generating IDs. Defaults to `"nanoid"`. */
-    generate?: "uuid" | "nanoid" | "cuid";
-}
-interface SlugField extends BaseField {
-    type: "slug";
-    /** Name of the field whose value is used as the slug source. */
-    from: string;
-}
-interface RelationField extends BaseField {
-    type: "relation";
-    /** Target collection name. */
-    collection: string;
-    /** Allow selecting multiple entries. */
-    multiple?: boolean;
-}
-interface FormulaField extends BaseField {
-    type: "formula";
-    /**
-     * Expression string evaluated at read time.
-     * Syntax TBD — placeholder for v2.
-     */
-    expression: string;
-    /** TypeScript type that the expression produces. Used by the type generator. */
-    resultType?: "string" | "number" | "boolean";
-}
-interface StatusField extends BaseField {
-    type: "status";
-    options: StatusOption[];
-    defaultValue?: string;
-}
-interface CreatedTimeField extends BaseField {
-    type: "created-time";
-}
-interface UpdatedTimeField extends BaseField {
-    type: "updated-time";
-}
-type FieldDefinition = TextField | LongTextField | NumberField | BooleanField | DateField | SelectField | MultiSelectField | UrlField | EmailField | MediaField | ObjectField | ArrayField | IdField | SlugField | RelationField | FormulaField | StatusField | CreatedTimeField | UpdatedTimeField;
-type FieldType = FieldDefinition["type"];
-interface CollectionSchema {
-    /** Collection name — must match the folder name under /contents. */
-    collection: string;
-    /**
-     * Human-readable label for the collection.
-     * Defaults to the collection name with title case.
-     */
-    label?: string;
-    /** Field definitions that describe the shape of each entry. */
-    fields: FieldDefinition[];
-}
-
-/**
- * @context  Shared layer — domain types at src/shared/types.ts
- * @does     Defines core domain interfaces shared across core, CLI, and UI layers
- * @depends  src/shared/fields.ts
- * @do       Add new shared domain types here
- * @dont     Import from CLI or UI; contain runtime logic; import framework-specific code
- */
+import { C as ContentEntry, F as FieldDefinition, T as TextField, L as LongTextField, N as NumberField, B as BooleanField, D as DateField, I as ISODate, S as SelectField, M as MultiSelectField, U as UrlField, H as HttpUrl, E as EmailField, a as Email, b as MediaField, c as MediaPath, O as ObjectField, A as ArrayField, d as IdField, e as ID, f as SlugField, g as Slug, R as RelationField, h as FormulaField, i as StatusField, j as CreatedTimeField, k as UpdatedTimeField, l as CollectionSchema, m as BaseField } from '../query-builder-KXz9cPzF.js';
+export { n as Collection, o as CollectionConfig, p as CollectionTypeMap, q as EntryResult, r as FieldType, Q as QueryOptions, s as QueryResult, t as StudioConfig, u as queryCollection } from '../query-builder-KXz9cPzF.js';
 
 /**
- * Core content entry representing a single piece of content.
- */
-interface ContentEntry {
-    /** Collection name derived from the parent folder */
-    collection: string;
-    /** URL-friendly identifier derived from the filename */
-    slug: string;
-    /** Full path relative to the contents directory */
-    path: string;
-    /** Raw body content (MDX string or undefined for JSON) */
-    body?: string;
-    /** Parsed frontmatter or JSON data */
-    data: Record<string, unknown>;
-}
-/**
- * Collection metadata describing a content collection.
- */
-interface Collection {
-    /** Collection name (folder name) */
-    name: string;
-    /** Type of content in the collection */
-    type: "mdx" | "json-array" | "json-object";
-    /** Number of entries in the collection */
-    count: number;
-    /** Filesystem path to the collection folder */
-    basePath: string;
-    /** Optional schema that describes the fields in this collection. */
-    schema?: CollectionSchema;
-}
-/**
- * Studio configuration from studio.config.ts
- */
-interface StudioConfig {
-    /** Per-collection configuration */
-    collections?: Record<string, CollectionConfig>;
-}
-/**
- * Per-collection configuration options.
- */
-interface CollectionConfig {
-    /** Field schema that describes the shape of each entry. */
-    schema?: CollectionSchema;
-    /** Import/sync scripts for the collection */
-    scripts?: {
-        import?: string;
-        sync?: string;
-    };
-}
-/**
- * Augmentable map of collection names to their typed entry shapes.
- * Extend this via generated types or manual declaration:
- *
- * @example
- * // .studio/studio.d.ts (auto-generated)
- * declare module 'nextjs-studio' {
- *   interface CollectionTypeMap {
- *     posts: { title: string; date: string; slug: string };
- *   }
- * }
- */
-interface CollectionTypeMap {
-}
-/**
- * Query options for the content query builder.
- */
-interface QueryOptions {
-    where?: Record<string, unknown>;
-    sort?: {
-        field: string;
-        order: "asc" | "desc";
-    };
-    limit?: number;
-    offset?: number;
-}
-/**
- * File metadata returned by the FS adapter.
- */
-interface FileInfo {
-    path: string;
-    size: number;
-    modifiedAt: Date;
-}
-/**
- * A file entry returned by a flat directory listing (non-recursive).
- */
-interface DirectoryFileEntry {
-    name: string;
-    relativePath: string;
-    size: number;
-    modifiedAt: Date;
-}
-
-/**
- * @context  Core layer — query builder at src/core/query-builder.ts
- * @does     Provides a fluent API to filter, sort, and paginate content entries from a collection
- * @depends  src/shared/types.ts, src/core/content-store.ts
- * @do       Add new query capabilities here (e.g. search, groupBy)
- * @dont     Import from CLI or UI; access the filesystem; perform I/O
- */
-
-/**
- * Fluent query builder for content collections.
- *
- * ```ts
- * const posts = queryCollection("blog")
- *   .where({ published: true })
- *   .sort("date", "desc")
- *   .limit(10)
- *   .all();
- * ```
- *
- * Supports dot notation for nested properties:
- * ```ts
- * queryCollection("pages").where({ "hero.title": "Welcome" }).all();
- * ```
- */
-declare class QueryBuilder<T = Record<string, unknown>> {
-    private readonly collectionName;
-    private options;
-    constructor(collection: string);
-    where(conditions: Record<string, unknown>): this;
-    sort(field: string, order?: "asc" | "desc"): this;
-    limit(count: number): this;
-    offset(count: number): this;
-    all(): T[];
-    first(): T | undefined;
-    count(): number;
-}
-/**
- * Entry point for querying a content collection.
+ * @context  Core layer — draft filter at src/core/draft-filter.ts
+ * @does     Provides utilities to detect and filter draft content entries
+ * @depends  src/shared/types.ts
+ * @do       Add new draft detection heuristics here
+ * @dont     Import from CLI or UI; access filesystem
  */
-declare function queryCollection<K extends keyof CollectionTypeMap>(name: K): QueryBuilder<CollectionTypeMap[K]>;
-declare function queryCollection(name: string): QueryBuilder<Record<string, unknown>>;
 
-/**
- * @context  Core layer — studio initializer at src/core/init.ts
- * @does     Convenience function to initialize the content store for Node.js environments
- * @depends  src/core/content-store.ts, src/cli/adapters/fs-adapter.ts
- * @do       Use this as the entry point for Next.js and other Node.js consumers
- * @dont     Import from UI; use in browser environments
- */
+declare function isDraft(entry: ContentEntry): boolean;
+declare function filterDrafts(entries: ContentEntry[]): ContentEntry[];
 
 /**
- * Initialize the content store from the filesystem.
- * Call this once before using `queryCollection()`.
- *
- * @param contentsDir - Path to the contents directory. Defaults to `./contents` relative to cwd.
- * @param config - Optional studio config for schemas and scripts.
- *
- * @example
- * ```ts
- * import { initStudio, queryCollection } from "nextjs-studio";
- *
- * await initStudio();
- * const posts = queryCollection("posts").all();
- * ```
+ * @context  Core layer — frontmatter binder at src/core/frontmatter-binder.ts
+ * @does     Replaces {frontmatter.X} tokens in MDX body with actual frontmatter values
+ * @depends  none
+ * @do       Add new token patterns or transformation rules here
+ * @dont     Import from CLI or UI; access filesystem
  */
-declare function initStudio(contentsDir?: string, config?: StudioConfig): Promise<void>;
 /**
- * Returns true if the content store has been initialized.
+ * Replaces `{frontmatter.X}` tokens in the body with values from the data object.
+ * Supports dot-notation for nested values (e.g. `{frontmatter.author.name}`).
  */
-declare function isStudioInitialized(): boolean;
+declare function bindFrontmatter(body: string, data: Record<string, unknown>): string;
 /**
- * Ensures the content store is initialized. Safe to call multiple times — only
- * initializes once. Ideal for use at the top of Next.js server components and
- * `generateStaticParams` / `generateMetadata` functions.
- *
- * @param contentsDir - Path to the contents directory. Defaults to `./contents` relative to cwd.
- * @param config - Optional studio config for schemas and scripts.
- *
- * @example
- * ```ts
- * import { ensureContentLoaded, queryCollection } from "nextjs-studio";
- *
- * export default async function Page() {
- *   await ensureContentLoaded();
- *   const posts = queryCollection("posts");
- *   // ...
- * }
- * ```
+ * Extracts all frontmatter token paths from the body.
  */
-declare function ensureContentLoaded(contentsDir?: string, config?: StudioConfig): Promise<void>;
+declare function extractFrontmatterTokens(body: string): string[];
 
 /**
- * @context  Shared layer — FS adapter interface at src/shared/fs-adapter.interface.ts
- * @does     Defines the IFsAdapter contract so Core can perform I/O without depending on CLI
- * @depends  src/shared/types.ts
- * @do       Add new I/O methods here when Core needs them; keep the interface minimal
- * @dont     Import from CLI or UI; contain implementation logic
+ * @context  Core layer — locale parser at src/core/locale-parser.ts
+ * @does     Extracts locale codes from filenames using the convention `slug.locale.mdx`
+ * @depends  none
+ * @do       Add new locale detection strategies here
+ * @dont     Import from CLI or UI; access filesystem
  */
-
-interface IFsAdapter {
-    readFile(filePath: string): Promise<string>;
-    writeFile(filePath: string, content: string): Promise<void>;
-    deleteFile(filePath: string): Promise<void>;
-    exists(filePath: string): Promise<boolean>;
-    getStats(filePath: string): Promise<FileInfo>;
-    listFiles(dirPath: string, extensions?: readonly string[]): Promise<string[]>;
-    listDirectories(dirPath: string): Promise<string[]>;
-    readBuffer(filePath: string): Promise<Buffer>;
-    writeBuffer(filePath: string, data: Buffer): Promise<void>;
-    listAllFiles(dirPath: string): Promise<DirectoryFileEntry[]>;
-    join(...segments: string[]): string;
-    basename(filePath: string): string;
-    extname(filePath: string): string;
-    relative(from: string, to: string): string;
-    normalizeSlug(relativePath: string, ext: string): string;
-}
-
 /**
- * @context  Core layer — content indexer at src/core/indexer.ts
- * @does     Scans the contents directory, parses MDX/JSON files, and builds an in-memory index
- * @depends  src/shared/types.ts, src/shared/constants.ts, src/shared/fs-adapter.interface.ts, src/core/parsers/, src/core/schema-inferrer.ts
- * @do       Add new file type handling here; extend indexCollection for new collection behaviors
- * @dont     Import from CLI or UI; instantiate FsAdapter; access the filesystem directly
+ * Parses locale from a filename.
+ * Supports `post.pt.mdx`, `post.en-US.mdx` patterns.
+ * Returns undefined for files without a locale suffix.
  */
-
-declare class ContentIndex {
-    private readonly entries;
-    private readonly collections;
-    private readonly fs;
-    constructor(fsAdapter: IFsAdapter);
-    build(config?: StudioConfig): Promise<void>;
-    getCollection(name: string): ContentEntry[];
-    getCollections(): Collection[];
-    clear(): void;
-    private indexCollection;
-    private scanDir;
-    private buildMdxEntry;
-    private buildJsonEntries;
-    private readOrdering;
-    private applyOrdering;
-    private detectCollectionType;
-}
-
+declare function parseLocaleFromFilename(filename: string): string | undefined;
 /**
- * @context  Core layer — content store at src/core/content-store.ts
- * @does     Manages a singleton ContentIndex; exposes loadContent() and getStore() for consumers
- * @depends  src/core/indexer.ts, src/shared/fs-adapter.interface.ts, src/shared/types.ts
- * @do       Use this as the single access point for in-memory indexed content
- * @dont     Import from CLI or UI; instantiate FsAdapter here; contain parsing or I/O logic
+ * Removes the locale suffix from a slug.
+ * Handles both pre-slugify (`.pt`) and post-slugify (`-pt`) formats,
+ * since `@sindresorhus/slugify` converts dots to dashes.
+ * `post.pt` → `post`, `post-pt` → `post`, `post` → `post`
  */
-
-declare function loadContent(fsAdapter: IFsAdapter, config?: StudioConfig): Promise<ContentIndex>;
+declare function stripLocaleFromSlug(slug: string, locale?: string): string;
 
 /**
  * @context  Shared layer — schema inference types at src/shared/schema-types.ts
@@ -471,4 +114,4 @@ declare function fieldLabel(field: Pick<BaseField, "name" | "label">): string;
  */
 declare function keyLabel(name: string): string;
 
-export { type Collection, type CollectionConfig, type CollectionSchema, type ContentEntry, ContentIndex, type FieldDefinition, type FieldType, type InferFieldValue, type InferSchemaData, type QueryOptions, type StudioConfig, ensureContentLoaded, fieldLabel, initStudio, isStudioInitialized, keyLabel, loadContent, queryCollection };
+export { CollectionSchema, ContentEntry, FieldDefinition, type InferFieldValue, type InferSchemaData, bindFrontmatter, extractFrontmatterTokens, fieldLabel, filterDrafts, isDraft, keyLabel, parseLocaleFromFilename, stripLocaleFromSlug };