nextjs-studio 1.0.5 → 1.0.6

package/dist/core/index.d.ts

@@ -0,0 +1,117 @@
+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-BOu-D7a1.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-BOu-D7a1.js';
+
+/**
+ * @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 isDraft(entry: ContentEntry): boolean;
+declare function filterDrafts(entries: ContentEntry[]): ContentEntry[];
+
+/**
+ * @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
+ */
+/**
+ * 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 bindFrontmatter(body: string, data: Record<string, unknown>): string;
+/**
+ * Extracts all frontmatter token paths from the body.
+ */
+declare function extractFrontmatterTokens(body: string): string[];
+
+/**
+ * @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
+ */
+/**
+ * Parses locale from a filename.
+ * Supports `post.pt.mdx`, `post.en-US.mdx` patterns.
+ * Returns undefined for files without a locale suffix.
+ */
+declare function parseLocaleFromFilename(filename: string): string | undefined;
+/**
+ * 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 stripLocaleFromSlug(slug: string, locale?: string): string;
+
+/**
+ * @context  Shared layer — schema inference types at src/shared/schema-types.ts
+ * @does     Provides TypeScript utility types to infer typed data shapes from CollectionSchema
+ * @depends  src/shared/fields.ts
+ * @do       Add new schema-level inference utilities here
+ * @dont     Import from CLI or UI; contain runtime logic or field definitions
+ */
+
+/** Infer the TypeScript value type for a single field definition. */
+type InferFieldValue<F extends FieldDefinition> = F extends TextField ? string : F extends LongTextField ? string : F extends NumberField ? number : F extends BooleanField ? boolean : F extends DateField ? F["includeTime"] extends true ? Date : ISODate : F extends SelectField ? F["options"][number]["value"] : F extends MultiSelectField ? Array<F["options"][number]["value"]> : F extends UrlField ? HttpUrl : F extends EmailField ? Email : F extends MediaField ? MediaPath : F extends ObjectField ? InferObjectFields<F["fields"]> : F extends ArrayField ? Array<InferObjectFields<F["itemFields"]>> : F extends IdField ? ID : F extends SlugField ? Slug : F extends RelationField ? F["multiple"] extends true ? ID[] : ID : F extends FormulaField ? F["resultType"] extends "number" ? number : F["resultType"] extends "boolean" ? boolean : string : F extends StatusField ? F["options"][number]["value"] : F extends CreatedTimeField ? Date : F extends UpdatedTimeField ? Date : never;
+/**
+ * Infer a record type from an array of field definitions.
+ * Fields marked `required: false` become optional (`T | undefined`).
+ */
+type InferObjectFields<Fields extends FieldDefinition[]> = {
+    [F in Fields[number] as F["name"]]: F extends {
+        required: false;
+    } ? InferFieldValue<F> | undefined : InferFieldValue<F>;
+};
+/**
+ * Infer the full data shape of a collection from its schema.
+ *
+ * @example
+ * ```ts
+ * const blogSchema = {
+ *   collection: "blog",
+ *   fields: [
+ *     { name: "title", type: "text", required: true },
+ *     { name: "published", type: "boolean" },
+ *   ],
+ * } satisfies CollectionSchema;
+ *
+ * type BlogData = InferSchemaData<typeof blogSchema>;
+ * // => { title: string; published: boolean }
+ * ```
+ */
+type InferSchemaData<S extends CollectionSchema> = InferObjectFields<S["fields"]>;
+
+/**
+ * @context  Shared layer — field label utilities at src/shared/field-utils.ts
+ * @does     Resolves human-readable labels for field definitions and raw key strings
+ * @depends  src/shared/fields.ts
+ * @do       Add field-related utility functions here
+ * @dont     Import from CLI or UI; contain field type definitions or schema logic
+ */
+
+/**
+ * Resolve the human-readable label for a field.
+ *
+ * When the field definition has an explicit `label`, that is returned as-is.
+ * Otherwise the `name` (camelCase / kebab-case / snake_case) is converted to Title Case:
+ *
+ * @example
+ * fieldLabel({ name: "siteName", type: "text" }) // "Site Name"
+ * fieldLabel({ name: "created_at", type: "date" }) // "Created At"
+ * fieldLabel({ name: "bio", type: "long-text", label: "About" }) // "About"
+ */
+declare function fieldLabel(field: Pick<BaseField, "name" | "label">): string;
+/**
+ * Resolve the label for a raw key string (no field definition available).
+ * Useful for dynamic keys that have no schema entry.
+ */
+declare function keyLabel(name: string): string;
+
+export { CollectionSchema, ContentEntry, FieldDefinition, type InferFieldValue, type InferSchemaData, bindFrontmatter, extractFrontmatterTokens, fieldLabel, filterDrafts, isDraft, keyLabel, parseLocaleFromFilename, stripLocaleFromSlug };

package/dist/core/server.d.ts

@@ -0,0 +1,136 @@
+import { v as FileInfo, w as DirectoryFileEntry, t as StudioConfig, C as ContentEntry, n as Collection } from '../query-builder-BOu-D7a1.js';
+export { o as CollectionConfig, p as CollectionTypeMap, Q as QueryOptions, s as QueryResult, u as queryCollection } from '../query-builder-BOu-D7a1.js';
+
+/**
+ * @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
+ */
+
+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;
+    readFileSync(filePath: string): string;
+    existsSync(filePath: string): boolean;
+    listFilesSync(dirPath: string, extensions?: readonly string[]): string[];
+    listDirectoriesSync(dirPath: string): string[];
+}
+
+/**
+ * @context  Core layer — filesystem adapter at src/core/fs-adapter.ts
+ * @does     Implements IFsAdapter; abstracts all file read/write/list operations behind a single interface
+ * @depends  src/shared/types.ts, src/shared/constants.ts, src/shared/fs-adapter.interface.ts
+ * @do       Add new I/O operations here; all file access must go through this adapter
+ * @dont     Import UI components, run HTTP requests, or contain business logic
+ */
+
+declare class FsAdapter implements IFsAdapter {
+    private readonly basePath;
+    constructor(basePath: string);
+    private resolve;
+    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;
+    readFileSync(filePath: string): string;
+    existsSync(filePath: string): boolean;
+    listFilesSync(dirPath: string, extensions?: readonly string[]): string[];
+    listDirectoriesSync(dirPath: 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
+ */
+
+declare class ContentIndex {
+    private readonly entries;
+    private readonly collections;
+    private readonly fs;
+    constructor(fsAdapter: IFsAdapter);
+    build(config?: StudioConfig): Promise<void>;
+    buildSync(config?: StudioConfig): void;
+    getCollection(name: string): ContentEntry[];
+    getCollections(): Collection[];
+    clear(): void;
+    updateEntry(collectionName: string, entry: ContentEntry): void;
+    removeEntry(collectionName: string, slug: string): void;
+    private updateCollectionMeta;
+    private indexCollection;
+    private indexCollectionSync;
+    private scanDir;
+    private scanDirSync;
+    private buildMdxEntry;
+    private buildJsonEntries;
+    private readOrdering;
+    private readOrderingSync;
+    private applyOrdering;
+    private detectCollectionType;
+}
+
+/**
+ * @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/types.ts
+ * @do       Use this as the single access point for in-memory indexed content
+ * @dont     Import from CLI or UI; contain parsing or I/O logic; import fs-adapter at top level
+ */
+
+declare function loadContent(fsAdapter: IFsAdapter, config?: StudioConfig): Promise<ContentIndex>;
+declare function loadContentSync(fsAdapter: IFsAdapter, config?: StudioConfig): ContentIndex;
+
+/**
+ * @context  Core layer — config loader at src/core/config-loader.ts
+ * @does     Resolves and loads studio.config.ts/.js from the project root using dynamic import
+ * @depends  src/shared/constants.ts, src/shared/types.ts
+ * @do       Add new config resolution strategies or validation here
+ * @dont     Import from CLI or UI; access content files
+ */
+
+/**
+ * Resolves the config file path from the project root.
+ * Returns undefined if no config file is found.
+ */
+declare function resolveConfigPath(projectRoot: string): string | undefined;
+/**
+ * Loads the studio config from the project root.
+ * Tries CONFIG_FILENAMES in order, uses dynamic import().
+ * Returns empty config if no file found or loading fails.
+ */
+declare function loadStudioConfig(projectRoot: string): Promise<StudioConfig>;
+/**
+ * Loads config from a specific file path.
+ * Uses tsx's tsImport for .ts files so TypeScript configs work at runtime.
+ */
+declare function loadConfigFromPath(configPath: string): Promise<StudioConfig>;
+
+export { Collection, ContentEntry, ContentIndex, FsAdapter, StudioConfig, loadConfigFromPath, loadContent, loadContentSync, loadStudioConfig, resolveConfigPath };