@contentrain/query 3.2.0 → 5.0.0

package/dist/index.d.mts

@@ -1,291 +1,108 @@
-interface ContentrainConfig {
-    contentDir: string;
-    defaultLocale?: string;
-    models: {
-        [modelId: string]: {
-            localized: boolean;
-            defaultLocale?: string;
-            locales?: string[];
-        };
-    };
-}
-
-interface BaseContentrainType {
-    ID: string;
-    createdAt: string;
-    updatedAt: string;
-    status: 'draft' | 'changed' | 'publish';
-    scheduled: boolean;
-    _relations?: {
-        [key: string]: BaseContentrainType | BaseContentrainType[];
-    };
-}
-type ContentrainStatus = 'draft' | 'changed' | 'publish';
-interface ModelMetadata {
-    name: string;
-    modelId: string;
-    localization: boolean;
-    type: 'JSON';
-    createdBy: string;
-    isServerless: boolean;
-}
-interface FieldMetadata {
-    name: string;
-    fieldId: string;
-    modelId: string;
-    componentId: ContentrainComponentId;
-    fieldType: ContentrainFieldType;
-    options: FieldOptions;
-    validations: FieldValidations;
-    system?: boolean;
-    defaultField?: boolean;
-}
-type ContentrainFieldType = 'string' | 'number' | 'boolean' | 'array' | 'date' | 'media' | 'relation';
-type ContentrainComponentId = 'single-line-text' | 'multi-line-text' | 'email' | 'url' | 'slug' | 'color' | 'json' | 'md-editor' | 'rich-text-editor' | 'integer' | 'decimal' | 'rating' | 'percent' | 'phone-number' | 'checkbox' | 'switch' | 'date' | 'date-time' | 'media' | 'one-to-one' | 'one-to-many';
-interface FieldOptions {
-    'title-field'?: {
-        value: boolean;
-    };
-    'default-value'?: {
-        value: boolean;
-        form: {
-            [key: string]: {
-                value: any;
-            };
-        };
-    };
-    'reference'?: {
-        value: boolean;
-        form: {
-            reference: {
-                value: string;
-            };
-        };
-    };
-}
-interface FieldValidations {
-    'required-field'?: {
-        value: boolean;
-    };
-    'unique-field'?: {
-        value: boolean;
-    };
-    'input-range-field'?: {
-        value: {
-            min: number;
-            max: number;
-        };
-    };
-}
-type ContentrainLocales = string;
-
-interface ContentLoaderOptions {
-    contentDir: string;
-    defaultLocale?: string;
-    cache?: boolean;
-    ttl?: number;
-    maxCacheSize?: number;
-    modelTTL?: {
-        [model: string]: number;
-    };
-}
-interface ModelConfig {
-    metadata: ModelMetadata;
-    fields: FieldMetadata[];
-}
-interface ContentFile<T extends BaseContentrainType = BaseContentrainType> {
-    model: string;
-    locale?: string;
-    data: T[];
-}
-interface AssetMetadata {
-    path: string;
-    mimetype: string;
-    size: number;
-    alt: string;
-    meta: {
-        user: {
-            name: string;
-            email: string;
-            avatar: string;
-        };
-        createdAt: string;
-    };
-}
-interface LoaderResult<T extends BaseContentrainType = BaseContentrainType> {
-    model: ModelConfig;
-    content: {
-        [locale: string]: T[];
-    };
-    assets?: AssetMetadata[];
-}
-interface RelationConfig {
-    model: string;
-    type: 'one-to-one' | 'one-to-many';
-    foreignKey: string;
-}
-interface CacheStats {
-    hits: number;
-    misses: number;
-    size: number;
-    lastCleanup: number;
-}
-interface CacheEntry<T> {
-    data: T;
-    expireAt: number;
-    size: number;
-    createdAt: number;
-}
-interface MemoryCacheOptions {
-    maxSize?: number;
-    defaultTTL?: number;
-}
-
-type StringOperator = 'eq' | 'ne' | 'contains' | 'startsWith' | 'endsWith';
-type NumericOperator = 'eq' | 'ne' | 'gt' | 'gte' | 'lt' | 'lte';
-type ArrayOperator = 'in' | 'nin';
-type Operator = StringOperator | NumericOperator | ArrayOperator;
-interface Filter<T = any> {
-    field: string;
-    operator: Operator;
-    value: T extends Array<infer U> ? (ArrayOperator extends 'in' | 'nin' ? U[] : U) : T;
-}
-interface Sort {
-    field: string;
-    direction: 'asc' | 'desc';
-}
-interface Pagination {
-    limit?: number;
-    offset?: number;
-}
-interface Include {
-    [relation: string]: {
-        fields?: string[];
-        include?: Include;
-    };
-}
-interface QueryOptions {
-    locale?: string;
-    cache?: boolean;
-    ttl?: number;
-}
-interface QueryResult<T> {
-    data: T[];
-    total: number;
-    pagination?: {
-        limit: number;
-        offset: number;
-        hasMore: boolean;
-    };
-}
-interface QueryConfig<TFields extends BaseContentrainType, TLocales extends ContentrainLocales = 'en' | 'tr', TRelations extends Record<string, BaseContentrainType> = Record<string, never>> {
-    fields: TFields;
-    locales: TLocales;
-    relations: TRelations;
-}
-
-declare class ContentLoader {
-    private options;
-    private modelConfigs;
-    private relations;
-    private cache;
-    constructor(options: ContentLoaderOptions);
-    private getCacheKey;
-    private getModelTTL;
-    clearCache(): Promise<void>;
-    refreshCache(model: string): Promise<void>;
-    getCacheStats(): CacheStats;
-    private loadModelConfig;
-    private loadContentFile;
-    private loadRelations;
-    private getModelLocales;
-    load<T extends BaseContentrainType>(model: string): Promise<LoaderResult<T>>;
-    resolveRelation<T extends BaseContentrainType, R extends BaseContentrainType>(model: string, relationField: keyof T, data: T[], locale?: string): Promise<R[]>;
-}
-
-declare class QueryExecutor {
-    private loader;
-    constructor(loader: ContentLoader);
-    private applyFilters;
-    private applySorting;
-    private applyPagination;
-    private resolveIncludes;
-    private applyStringOperation;
-    execute<T extends BaseContentrainType>({ model, data, filters, includes, sorting, pagination, options, }: {
-        model: string;
-        data: T[];
-        filters?: Filter[];
-        includes?: Include;
-        sorting?: Sort[];
-        pagination?: {
-            limit?: number;
-            offset?: number;
-        };
-        options?: QueryOptions;
-    }): Promise<QueryResult<T>>;
-}
-
-declare class ContentrainQueryBuilder<TFields extends BaseContentrainType, TLocales extends ContentrainLocales = 'en' | 'tr', TRelations extends Record<string, BaseContentrainType> = Record<string, never>> {
-    private model;
-    private filters;
-    private includes;
-    private sorting;
-    private pagination;
-    private options;
-    private executor;
-    private loader;
-    constructor(model: string, executor: QueryExecutor, loader: ContentLoader);
-    where<K extends keyof TFields, O extends Operator>(field: K, operator: O, value: O extends 'in' ? TFields[K][] : TFields[K]): this;
-    include<K extends keyof TRelations>(relation: K | K[]): this;
-    orderBy<K extends keyof TFields>(field: K, direction?: 'asc' | 'desc'): this;
-    limit(count: number): this;
-    offset(count: number): this;
-    locale(code: TLocales): this;
-    cache(ttl?: number): this;
-    noCache(): this;
-    bypassCache(): this;
-    toJSON(): {
-        model: string;
-        filters: Filter<any>[];
-        includes: Include;
-        sorting: Sort[];
-        pagination: Pagination;
-        options: QueryOptions;
-    };
-    get(): Promise<QueryResult<TFields>>;
-    first(): Promise<TFields | null>;
-    count(): Promise<number>;
-}
-
-declare class MemoryCache {
-    private cache;
-    private options;
-    private stats;
-    constructor(options?: MemoryCacheOptions);
-    private calculateSize;
-    set<T>(key: string, data: T, ttl?: number): Promise<void>;
-    private findOldestKey;
-    get<T>(key: string): Promise<T | null>;
-    delete(key: string): Promise<void>;
-    clear(): Promise<void>;
-    private cleanupCache;
-    getStats(): CacheStats;
-}
-
-declare const logger: {
-    debug: (...args: unknown[]) => void;
-    error: (...args: unknown[]) => void;
-};
-
-declare class ContentrainSDK {
-    private loader;
-    private executor;
-    constructor(options: ContentLoaderOptions);
-    query<T extends QueryConfig<BaseContentrainType, string, Record<string, BaseContentrainType>>>(model: string): ContentrainQueryBuilder<T['fields'], T['locales'], T['relations']>;
-    load<T extends BaseContentrainType>(model: string): Promise<LoaderResult<T>>;
-    clearCache(): Promise<void>;
-    refreshCache(model: string): Promise<void>;
-    getCacheStats(): CacheStats;
-}
+import { ContentStatus, ContentrainConfig, FieldDef, FieldType, ModelDefinition, ModelKind } from "@contentrain/types";
 
-export { type ArrayOperator, type AssetMetadata, type BaseContentrainType, type CacheEntry, type CacheStats, type ContentFile, ContentLoader, type ContentLoaderOptions, type ContentrainComponentId, type ContentrainConfig, type ContentrainFieldType, type ContentrainLocales, ContentrainQueryBuilder, ContentrainSDK, type ContentrainStatus, type FieldMetadata, type FieldOptions, type FieldValidations, type Filter, type Include, type LoaderResult, MemoryCache, type MemoryCacheOptions, type ModelConfig, type ModelMetadata, type NumericOperator, type Operator, type Pagination, type QueryConfig, QueryExecutor, type QueryOptions, type QueryResult, type RelationConfig, type Sort, type StringOperator, logger };
+//#region src/runtime/query.d.ts
+interface RelationMeta {
+  target: string | string[];
+  multi: boolean;
+}
+type RelationResolver = (model: string, id: string, locale: string | null) => Record<string, unknown> | undefined;
+declare class QueryBuilder<T extends object> {
+  private _data;
+  private _locale;
+  private _filters;
+  private _sortField;
+  private _sortOrder;
+  private _limit;
+  private _offset;
+  private _includes;
+  private _relationMeta;
+  private _resolver;
+  private _defaultLocale;
+  constructor(data: Map<string, T[]>, relationMeta?: Record<string, RelationMeta>, resolver?: RelationResolver, defaultLocale?: string);
+  locale(lang: string): this;
+  where<K extends string & keyof T>(field: K, value: T[K]): this;
+  sort<K extends string & keyof T>(field: K, order?: 'asc' | 'desc'): this;
+  limit(n: number): this;
+  offset(n: number): this;
+  include(...fields: string[]): this;
+  all(): T[];
+  first(): T | undefined;
+  private _resolveData;
+  private _resolveIncludes;
+  private _resolveId;
+}
+//#endregion
+//#region src/runtime/singleton.d.ts
+declare class SingletonAccessor<T extends Record<string, unknown>> {
+  private _data;
+  private _locale;
+  private _defaultLocale;
+  private _includes;
+  private _relationMeta;
+  private _resolveEntry?;
+  constructor(data: Map<string, T>, defaultLocale?: string, relationMeta?: Record<string, {
+    target: string | string[];
+    multi: boolean;
+  }>, resolveEntry?: (model: string, id: string, locale: string) => unknown);
+  locale(lang: string): this;
+  include(...fields: string[]): this;
+  get(): T;
+  private _resolveIncludes;
+  private _resolveId;
+}
+//#endregion
+//#region src/runtime/dictionary.d.ts
+declare class DictionaryAccessor {
+  private _data;
+  private _locale;
+  private _defaultLocale;
+  constructor(data: Map<string, Record<string, string>>, defaultLocale?: string);
+  locale(lang: string): this;
+  get(): Record<string, string>;
+  get(key: string): string | undefined;
+  get(key: string, params: Record<string, string | number>): string;
+  private _resolveData;
+}
+//#endregion
+//#region src/runtime/document.d.ts
+declare class DocumentQuery<T extends object> {
+  private _data;
+  private _locale;
+  private _filters;
+  private _includes;
+  private _relationMeta;
+  private _resolver;
+  private _defaultLocale;
+  constructor(data: Map<string, T[]>, relationMeta?: Record<string, RelationMeta>, resolver?: RelationResolver, defaultLocale?: string);
+  locale(lang: string): this;
+  where<K extends string & keyof T>(field: K, value: T[K]): this;
+  include(...fields: string[]): this;
+  bySlug(slug: string): T | undefined;
+  all(): T[];
+  first(): T | undefined;
+  private _resolveData;
+  private _resolveIncludes;
+  private _resolveId;
+}
+//#endregion
+//#region src/index.d.ts
+/**
+ * Factory for framework SDK authors.
+ * Returns the generated client module loaded from .contentrain/client/.
+ *
+ * Usage (Nuxt composable):
+ * ```ts
+ * import { createContentrainClient } from '@contentrain/query'
+ * const client = createContentrainClient()
+ * const posts = client.query('blog-post').locale('en').all()
+ * ```
+ */
+declare function createContentrainClient(projectRoot?: string): Promise<{
+  query: (model: string) => QueryBuilder<Record<string, unknown>>;
+  singleton: (model: string) => SingletonAccessor<Record<string, unknown>>;
+  dictionary: (model: string) => DictionaryAccessor;
+  document: (model: string) => DocumentQuery<Record<string, unknown>>;
+}>;
+//#endregion
+export { type ContentStatus, type ContentrainConfig, DictionaryAccessor, DocumentQuery, type FieldDef, type FieldType, type ModelDefinition, type ModelKind, QueryBuilder, type RelationMeta, type RelationResolver, SingletonAccessor, createContentrainClient, createContentrainClient as default };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/runtime/query.ts","../src/runtime/singleton.ts","../src/runtime/dictionary.ts","../src/runtime/document.ts","../src/index.ts"],"mappings":";;;UAAiB,YAAA;EACf,MAAA;EACA,KAAA;AAAA;AAAA,KAGU,gBAAA,IAAoB,KAAA,UAAe,EAAA,UAAY,MAAA,oBAA0B,MAAA;AAAA,cAExE,YAAA;EAAA,QACH,KAAA;EAAA,QACA,OAAA;EAAA,QACA,QAAA;EAAA,QACA,UAAA;EAAA,QACA,UAAA;EAAA,QACA,MAAA;EAAA,QACA,OAAA;EAAA,QACA,SAAA;EAAA,QACA,aAAA;EAAA,QACA,SAAA;EAAA,QACA,cAAA;cAGN,IAAA,EAAM,GAAA,SAAY,CAAA,KAClB,YAAA,GAAe,MAAA,SAAe,YAAA,GAC9B,QAAA,GAAW,gBAAA,EACX,aAAA;EAQF,MAAA,CAAO,IAAA;EAKP,KAAA,0BAA+B,CAAA,CAAA,CAAG,KAAA,EAAO,CAAA,EAAG,KAAA,EAAO,CAAA,CAAE,CAAA;EASrD,IAAA,0BAA8B,CAAA,CAAA,CAAG,KAAA,EAAO,CAAA,EAAG,KAAA;EAM3C,KAAA,CAAM,CAAA;EAKN,MAAA,CAAO,CAAA;EAKP,OAAA,CAAA,GAAW,MAAA;EAKX,GAAA,CAAA,GAAO,CAAA;EAsCP,KAAA,CAAA,GAAS,CAAA;EAAA,QAID,YAAA;EAAA,QAeA,gBAAA;EAAA,QAoCA,UAAA;AAAA;;;cChKG,iBAAA,WAA4B,MAAA;EAAA,QAC/B,KAAA;EAAA,QACA,OAAA;EAAA,QACA,cAAA;EAAA,QACA,SAAA;EAAA,QACA,aAAA;EAAA,QACA,aAAA;cAGN,IAAA,EAAM,GAAA,SAAY,CAAA,GAClB,aAAA,WACA,YAAA,GAAe,MAAA;IAAiB,MAAA;IAA2B,KAAA;EAAA,IAC3D,YAAA,IAAgB,KAAA,UAAe,EAAA,UAAY,MAAA;EAQ7C,MAAA,CAAO,IAAA;EAKP,OAAA,CAAA,GAAW,MAAA;EAKX,GAAA,CAAA,GAAO,CAAA;EAAA,QA4BC,gBAAA;EAAA,QAuCA,UAAA;AAAA;;;cCjGG,kBAAA;EAAA,QACH,KAAA;EAAA,QACA,OAAA;EAAA,QACA,cAAA;cAEI,IAAA,EAAM,GAAA,SAAY,MAAA,mBAAyB,aAAA;EAKvD,MAAA,CAAO,IAAA;EAKP,GAAA,CAAA,GAAO,MAAA;EACP,GAAA,CAAI,GAAA;EACJ,GAAA,CAAI,GAAA,UAAa,MAAA,EAAQ,MAAA;EAAA,QAUjB,YAAA;AAAA;;;cCzBG,aAAA;EAAA,QACH,KAAA;EAAA,QACA,OAAA;EAAA,QACA,QAAA;EAAA,QACA,SAAA;EAAA,QACA,aAAA;EAAA,QACA,SAAA;EAAA,QACA,cAAA;cAGN,IAAA,EAAM,GAAA,SAAY,CAAA,KAClB,YAAA,GAAe,MAAA,SAAe,YAAA,GAC9B,QAAA,GAAW,gBAAA,EACX,aAAA;EAQF,MAAA,CAAO,IAAA;EAKP,KAAA,0BAA+B,CAAA,CAAA,CAAG,KAAA,EAAO,CAAA,EAAG,KAAA,EAAO,CAAA,CAAE,CAAA;EAKrD,OAAA,CAAA,GAAW,MAAA;EAKX,MAAA,CAAO,IAAA,WAAe,CAAA;EAStB,GAAA,CAAA,GAAO,CAAA;EAWP,KAAA,CAAA,GAAS,CAAA;EAAA,QAID,YAAA;EAAA,QAeA,gBAAA;EAAA,QAoCA,UAAA;AAAA;;;;;AH5GV;;;;;;;;;iBIuBsB,uBAAA,CACpB,WAAA,YACC,OAAA;EACD,KAAA,GAAQ,KAAA,aAAkE,YAAA,CAAN,MAAA;EACpE,SAAA,GAAY,KAAA,aAA2E,iBAAA,CAAN,MAAA;EACjF,UAAA,GAAa,KAAA,aADmE,kBAAA;EAEhF,QAAA,GAAW,KAAA,aAAsE,aAAA,CAAN,MAAA;AAAA"}