@dyrected/core 0.0.1 → 1.0.1

package/dist/index.d.mts

@@ -1,7 +1,7 @@
 import * as hono_types from 'hono/types';
 import { Hono } from 'hono';
 
-type FieldType = 'text' | 'textarea' | 'richText' | 'number' | 'boolean' | 'date' | 'select' | 'multiSelect' | 'email' | 'url' | 'relationship' | 'array' | 'object' | 'json' | 'blocks';
+type FieldType = "text" | "textarea" | "richText" | "number" | "boolean" | "date" | "select" | "multiSelect" | "relationship" | "array" | "object" | "json" | "blocks" | "image" | "email" | "url";
 interface Block {
     slug: string;
     labels?: {
@@ -21,7 +21,8 @@ interface Field {
         label: string;
         value: string;
     }[];
-    collection?: string;
+    relationTo?: string;
+    hasMany?: boolean;
     fields?: Field[];
     blocks?: Block[];
     access?: {
@@ -37,7 +38,9 @@ interface Field {
         description?: string;
         hidden?: boolean;
         readOnly?: boolean;
-        condition?: (data: any) => boolean;
+        condition?: ((data: any, siblingData: any) => boolean) | string;
+        layout?: "radio" | "select" | string;
+        direction?: "horizontal" | "vertical";
     };
 }
 type AccessFunction = (args: {
@@ -51,6 +54,8 @@ type HookFunction = (args: {
     doc?: any;
     user?: any;
     req?: any;
+    /** The operation that triggered this hook. */
+    operation?: 'create' | 'update' | 'delete';
 }) => any | Promise<any>;
 type FieldHook = (args: {
     value: any;
@@ -60,6 +65,8 @@ type FieldHook = (args: {
 }) => any | Promise<any>;
 interface CollectionConfig {
     slug: string;
+    siteId?: string;
+    shared?: boolean;
     labels?: {
         singular: string;
         plural: string;
@@ -67,6 +74,7 @@ interface CollectionConfig {
     auth?: boolean;
     upload?: boolean | UploadConfig;
     fields: Field[];
+    timestamps?: boolean;
     access?: {
         read?: AccessFunction;
         create?: AccessFunction;
@@ -86,20 +94,43 @@ interface CollectionConfig {
         defaultColumns?: string[];
         group?: string;
         hidden?: boolean;
+        /**
+         * URL to open in the Live Preview pane.
+         * Accepts a static string or a function that receives the document and returns a URL.
+         */
+        previewUrl?: string | ((doc: any, opts: {
+            locale?: string;
+        }) => string | null);
+        /** Which mode to use for live preview. Defaults to 'postMessage'. */
+        previewMode?: 'postMessage' | 'token';
     };
 }
 interface UploadConfig {
     allowedMimeTypes?: string[];
     maxFileSize?: number;
+    /** Local disk path where files are stored. Only used by LocalStorage adapter. */
+    staticDir?: string;
+    /** Public URL prefix for locally stored files. Only used by LocalStorage adapter. */
+    staticURL?: string;
+    /** Which imageSizes entry to use as the thumbnail in the Admin media grid. */
+    adminThumbnail?: string;
     imageSizes?: {
         name: string;
-        width: number;
-        height: number;
+        width?: number;
+        height?: number;
         crop?: string;
+        /** sharp fit strategy: 'cover' | 'contain' | 'fill' | 'inside' | 'outside' */
+        fit?: string;
+        /** Never upscale images smaller than the target size. Default: true. */
+        withoutEnlargement?: boolean;
+        /** Additional sharp format options. */
+        formatOptions?: Record<string, any>;
     }[];
 }
 interface GlobalConfig {
     slug: string;
+    siteId?: string;
+    shared?: boolean;
     label?: string;
     fields: Field[];
     access?: {
@@ -122,6 +153,10 @@ interface PaginatedResult<T = any> {
     total: number;
     limit: number;
     page: number;
+    /** Total number of pages given the current limit. */
+    totalPages: number;
+    hasNextPage: boolean;
+    hasPrevPage: boolean;
 }
 interface DatabaseAdapter {
     find(args: {
@@ -155,6 +190,16 @@ interface DatabaseAdapter {
         slug: string;
         data: any;
     }): Promise<any>;
+    /**
+     * Sync the database schema with the provided collections and globals.
+     * Useful for creating tables on startup.
+     */
+    sync?(collections: CollectionConfig[], globals: GlobalConfig[]): Promise<void>;
+    /**
+     * Low-level raw query execution.
+     * Optional as not all adapters may support raw SQL/commands.
+     */
+    execute?(query: string, params?: any[]): Promise<any>;
 }
 interface FileData {
     filename: string;
@@ -163,7 +208,12 @@ interface FileData {
     url: string;
     width?: number;
     height?: number;
-    type?: 'upload' | 'external';
+    focalPoint?: {
+        x: number;
+        y: number;
+    };
+    blurhash?: string;
+    type?: "upload" | "external";
     provider?: string;
     provider_metadata?: any;
     [key: string]: any;
@@ -173,6 +223,7 @@ interface StorageAdapter {
         filename: string;
         buffer: Buffer;
         mimeType: string;
+        prefix?: string;
     }): Promise<FileData>;
     delete(args: {
         filename: string;
@@ -180,16 +231,96 @@ interface StorageAdapter {
     getURL(args: {
         filename: string;
     }): string;
+    /** Retrieve file content for serving via API */
+    resolve?(args: {
+        filename: string;
+    }): Promise<{
+        buffer: Buffer;
+        mimeType: string;
+    } | null>;
+}
+/** Branding and metadata configuration for the Admin UI. */
+interface AdminConfig {
+    branding?: {
+        /** URL or imported image for the full logo shown in the sidebar. */
+        logo?: string;
+        /** URL or imported image for the compact logo mark used in collapsed sidebar. */
+        logoMark?: string;
+        /** Primary accent colour as a CSS value (e.g. '#6366f1' or 'hsl(240 50% 60%)') */
+        primaryColor?: string;
+        /** URL for the browser tab favicon. */
+        favicon?: string;
+    };
+    meta?: {
+        /** Appended to every Admin page title. Default: '- Dyrected' */
+        titleSuffix?: string;
+    };
+}
+interface ImageService {
+    process(args: {
+        buffer: Buffer;
+        mimeType: string;
+        config?: CollectionConfig['upload'];
+        focalPoint?: {
+            x: number;
+            y: number;
+        };
+    }): Promise<{
+        metadata: {
+            width?: number;
+            height?: number;
+            blurhash?: string;
+        };
+        sizes?: Record<string, {
+            buffer: Buffer;
+            width: number;
+            height: number;
+            filename: string;
+        }>;
+    }>;
 }
 interface DyrectedConfig {
     collections: CollectionConfig[];
     globals: GlobalConfig[];
-    db: DatabaseAdapter;
+    db?: DatabaseAdapter;
     storage?: StorageAdapter;
+    image?: ImageService;
+    /** Admin UI branding and meta configuration. */
+    admin?: AdminConfig;
     email?: {
-        provider: string;
-        apiKey?: string;
         from: string;
+        send: (args: {
+            to: string;
+            subject: string;
+            html: string;
+        }) => Promise<void>;
+        templates?: {
+            welcome?: (args: {
+                email: string;
+            }) => {
+                subject?: string;
+                html: string;
+            };
+            invite?: (args: {
+                token: string;
+                invitedByEmail?: string;
+            }) => {
+                subject?: string;
+                html: string;
+            };
+            resetPassword?: (args: {
+                token: string;
+            }) => {
+                subject?: string;
+                html: string;
+            };
+            passwordChanged?: (args: {
+                email: string;
+            }) => {
+                subject?: string;
+                html: string;
+            };
+        };
     };
     redis?: {
         url: string;
@@ -197,18 +328,30 @@ interface DyrectedConfig {
     cors?: {
         origins: string[];
     };
+    onSchemaFetch?: (siteId: string) => Promise<{
+        collections?: CollectionConfig[];
+        globals?: GlobalConfig[];
+    }>;
 }
 
 interface DyrectedContext {
     Variables: {
         config: DyrectedConfig;
         siteId?: string;
+        workspaceId?: string;
+        /** Decoded JWT payload set by requireAuth() or optionalAuth() middleware. */
+        user?: {
+            sub: string;
+            email: string;
+            collection: string;
+            [key: string]: any;
+        };
     };
 }
 /**
  * Create the main Dyrected Hono application.
  */
-declare function createDyrectedApp(config: DyrectedConfig): Hono<DyrectedContext, hono_types.BlankSchema, "/">;
+declare function createDyrectedApp(rawConfig: DyrectedConfig): Promise<Hono<DyrectedContext, hono_types.BlankSchema, "/">>;
 
 declare class PopulationService {
     private db;
@@ -249,6 +392,15 @@ declare class MediaService {
     private static extractVimeoId;
 }
 
+interface SetupPromptConfig {
+    siteName?: string;
+    siteId?: string;
+    apiKey?: string;
+    baseUrl?: string;
+    isSelfHosted?: boolean;
+}
+declare function generateAIPrompt(activeTab: "next" | "nuxt" | "react" | "vue", config: SetupPromptConfig): string;
+
 /**
  * Define a collection configuration with full type safety.
  */
@@ -262,4 +414,4 @@ declare function defineGlobal(config: GlobalConfig): GlobalConfig;
  */
 declare function defineConfig(config: DyrectedConfig): DyrectedConfig;
 
-export { type AccessFunction, type Block, type CollectionConfig, type DatabaseAdapter, type DyrectedConfig, type DyrectedContext, type Field, type FieldHook, type FieldType, type FileData, type GlobalConfig, type HookFunction, MediaService, type PaginatedResult, PopulationService, type StorageAdapter, type UploadConfig, createDyrectedApp, defineCollection, defineConfig, defineGlobal };
+export { type AccessFunction, type AdminConfig, type Block, type CollectionConfig, type DatabaseAdapter, type DyrectedConfig, type DyrectedContext, type Field, type FieldHook, type FieldType, type FileData, type GlobalConfig, type HookFunction, type ImageService, MediaService, type PaginatedResult, PopulationService, type SetupPromptConfig, type StorageAdapter, type UploadConfig, createDyrectedApp, defineCollection, defineConfig, defineGlobal, generateAIPrompt };

package/dist/index.d.ts

@@ -1,253 +1,21 @@
-import * as hono_types from 'hono/types';
-import { Hono } from 'hono';
+import { D as DyrectedConfig, C as CollectionConfig, G as GlobalConfig } from './index-RylhgOwj.js';
+export { A as AccessFunction, a as AdminConfig, B as Block, b as DatabaseAdapter, F as Field, c as FieldHook, d as FieldType, e as FileData, H as HookFunction, I as ImageService, P as PaginatedResult, S as StorageAdapter, U as UploadConfig } from './index-RylhgOwj.js';
 
-type FieldType = 'text' | 'textarea' | 'richText' | 'number' | 'boolean' | 'date' | 'select' | 'multiSelect' | 'email' | 'url' | 'relationship' | 'array' | 'object' | 'json' | 'blocks';
-interface Block {
-    slug: string;
-    labels?: {
-        singular: string;
-        plural: string;
-    };
-    fields: Field[];
-}
-interface Field {
-    name: string;
-    type: FieldType;
-    label?: string;
-    required?: boolean;
-    unique?: boolean;
-    defaultValue?: any;
-    options?: string[] | {
-        label: string;
-        value: string;
-    }[];
-    collection?: string;
-    fields?: Field[];
-    blocks?: Block[];
-    access?: {
-        read?: AccessFunction;
-        update?: AccessFunction;
-    };
-    hooks?: {
-        beforeChange?: FieldHook[];
-        afterRead?: FieldHook[];
-    };
-    admin?: {
-        placeholder?: string;
-        description?: string;
-        hidden?: boolean;
-        readOnly?: boolean;
-        condition?: (data: any) => boolean;
-    };
-}
-type AccessFunction = (args: {
-    user: any;
-    doc?: any;
-    data?: any;
-    req: any;
-}) => boolean | object | Promise<boolean | object>;
-type HookFunction = (args: {
-    data?: any;
-    doc?: any;
-    user?: any;
-    req?: any;
-}) => any | Promise<any>;
-type FieldHook = (args: {
-    value: any;
-    originalDoc?: any;
-    data?: any;
-    user?: any;
-}) => any | Promise<any>;
-interface CollectionConfig {
-    slug: string;
-    labels?: {
-        singular: string;
-        plural: string;
-    };
-    auth?: boolean;
-    upload?: boolean | UploadConfig;
-    fields: Field[];
-    access?: {
-        read?: AccessFunction;
-        create?: AccessFunction;
-        update?: AccessFunction;
-        delete?: AccessFunction;
-    };
-    hooks?: {
-        beforeRead?: HookFunction[];
-        afterRead?: HookFunction[];
-        beforeChange?: HookFunction[];
-        afterChange?: HookFunction[];
-        beforeDelete?: HookFunction[];
-        afterDelete?: HookFunction[];
-    };
-    admin?: {
-        useAsTitle?: string;
-        defaultColumns?: string[];
-        group?: string;
-        hidden?: boolean;
-    };
-}
-interface UploadConfig {
-    allowedMimeTypes?: string[];
-    maxFileSize?: number;
-    imageSizes?: {
-        name: string;
-        width: number;
-        height: number;
-        crop?: string;
-    }[];
-}
-interface GlobalConfig {
-    slug: string;
-    label?: string;
-    fields: Field[];
-    access?: {
-        read?: AccessFunction;
-        update?: AccessFunction;
-    };
-    hooks?: {
-        beforeRead?: HookFunction[];
-        afterRead?: HookFunction[];
-        beforeChange?: HookFunction[];
-        afterChange?: HookFunction[];
-    };
-    admin?: {
-        group?: string;
-        hidden?: boolean;
-    };
-}
-interface PaginatedResult<T = any> {
-    docs: T[];
-    total: number;
-    limit: number;
-    page: number;
-}
-interface DatabaseAdapter {
-    find(args: {
-        collection: string;
-        where?: any;
-        limit?: number;
-        page?: number;
-        sort?: string;
-    }): Promise<PaginatedResult>;
-    findOne(args: {
-        collection: string;
-        id: string;
-    }): Promise<any>;
-    create(args: {
-        collection: string;
-        data: any;
-    }): Promise<any>;
-    update(args: {
-        collection: string;
-        id: string;
-        data: any;
-    }): Promise<any>;
-    delete(args: {
-        collection: string;
-        id: string;
-    }): Promise<any>;
-    getGlobal(args: {
-        slug: string;
-    }): Promise<any>;
-    updateGlobal(args: {
-        slug: string;
-        data: any;
-    }): Promise<any>;
-}
-interface FileData {
-    filename: string;
-    filesize?: number;
-    mimeType: string;
-    url: string;
-    width?: number;
-    height?: number;
-    type?: 'upload' | 'external';
-    provider?: string;
-    provider_metadata?: any;
-    [key: string]: any;
-}
-interface StorageAdapter {
-    upload(args: {
-        filename: string;
-        buffer: Buffer;
-        mimeType: string;
-    }): Promise<FileData>;
-    delete(args: {
-        filename: string;
-    }): Promise<void>;
-    getURL(args: {
-        filename: string;
-    }): string;
-}
-interface DyrectedConfig {
-    collections: CollectionConfig[];
-    globals: GlobalConfig[];
-    db: DatabaseAdapter;
-    storage?: StorageAdapter;
-    email?: {
-        provider: string;
-        apiKey?: string;
-        from: string;
-    };
-    redis?: {
-        url: string;
-    };
-    cors?: {
-        origins: string[];
-    };
-}
-
-interface DyrectedContext {
-    Variables: {
-        config: DyrectedConfig;
-        siteId?: string;
-    };
-}
-/**
- * Create the main Dyrected Hono application.
- */
-declare function createDyrectedApp(config: DyrectedConfig): Hono<DyrectedContext, hono_types.BlankSchema, "/">;
-
-declare class PopulationService {
-    private db;
-    private collections;
-    constructor(db: DatabaseAdapter, collections: CollectionConfig[]);
-    /**
-     * Recursively populate relationship fields in a document or array of documents.
-     */
-    populate(args: {
-        data: any;
-        fields: Field[];
-        currentDepth: number;
-        maxDepth: number;
-    }): Promise<any>;
-    /**
-     * Helper to populate a PaginatedResult
-     */
-    populateResult(result: PaginatedResult, fields: Field[], maxDepth: number): Promise<PaginatedResult>;
-}
+interface SetupPromptConfig {
+    siteName?: string;
+    siteId?: string;
+    apiKey?: string;
+    baseUrl?: string;
+    isSelfHosted?: boolean;
+}
+declare function generateAIPrompt(activeTab: "next" | "nuxt" | "react" | "vue", config: SetupPromptConfig): string;
 
 /**
- * MediaService handles background tasks for media assets,
- * such as extracting metadata from external URLs (YouTube/Vimeo).
+ * Normalizes the Dyrected configuration by injecting system fields
+ * (createdAt, updatedAt, createdBy, updatedBy) into every collection and
+ * registering the __audit collection if any collection has audit: true.
  */
-declare class MediaService {
-    /**
-     * Fetches metadata for a given URL.
-     * Supports YouTube and Vimeo.
-     */
-    static fetchMetadata(url: string): Promise<{
-        provider: string;
-        provider_id: string;
-        thumbnail: string;
-        embedUrl: string;
-        type: "video";
-    } | null>;
-    private static extractYoutubeId;
-    private static extractVimeoId;
-}
+declare function normalizeConfig(config: DyrectedConfig): DyrectedConfig;
 
 /**
  * Define a collection configuration with full type safety.
@@ -262,4 +30,4 @@ declare function defineGlobal(config: GlobalConfig): GlobalConfig;
  */
 declare function defineConfig(config: DyrectedConfig): DyrectedConfig;
 
-export { type AccessFunction, type Block, type CollectionConfig, type DatabaseAdapter, type DyrectedConfig, type DyrectedContext, type Field, type FieldHook, type FieldType, type FileData, type GlobalConfig, type HookFunction, MediaService, type PaginatedResult, PopulationService, type StorageAdapter, type UploadConfig, createDyrectedApp, defineCollection, defineConfig, defineGlobal };
+export { CollectionConfig, DyrectedConfig, GlobalConfig, type SetupPromptConfig, defineCollection, defineConfig, defineGlobal, generateAIPrompt, normalizeConfig };