@dyrected/sdk 0.0.1 → 1.0.0

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 import { PaginatedResult, FileData } from '@dyrected/core';
-export { FileData as Media } from '@dyrected/core';
+export { Block, CollectionConfig, Field, FieldType, GlobalConfig, FileData as Media, PaginatedResult } from '@dyrected/core';
 
 interface QueryArgs {
     limit?: number;
@@ -7,6 +7,7 @@ interface QueryArgs {
     depth?: number;
     where?: any;
     sort?: string;
+    initialData?: any[];
 }
 declare class QueryBuilder<T = any> {
     private collection;
@@ -18,43 +19,138 @@ declare class QueryBuilder<T = any> {
     limit(limit: number): this;
     page(page: number): this;
     depth(depth: number): this;
+    seed(data: T[]): this;
     exec(): Promise<PaginatedResult<T>>;
     then<TResult1 = PaginatedResult<T>, TResult2 = never>(onfulfilled?: ((value: PaginatedResult<T>) => TResult1 | PromiseLike<TResult1>) | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2>;
 }
 
+/**
+ * Structured error thrown by the SDK when the server returns a non-2xx response.
+ */
+declare class DyrectedError extends Error {
+    readonly statusCode: number;
+    readonly errors: {
+        field?: string;
+        message: string;
+    }[];
+    constructor(message: string, statusCode: number, errors?: {
+        field?: string;
+        message: string;
+    }[]);
+}
 interface DyrectedClientConfig {
     baseUrl: string;
     apiKey?: string;
+    siteId?: string;
     headers?: Record<string, string>;
     fetch?: typeof fetch;
+    /** Default depth for relationship population. Applied to every request unless overridden per-call. */
+    defaultDepth?: number;
 }
-declare class DyrectedClient {
+interface BaseSchema {
+    collections: Record<string, any>;
+    globals: Record<string, any>;
+}
+declare class DyrectedClient<TSchema extends BaseSchema = any> {
     private baseUrl;
     private headers;
     private fetch;
+    private defaultDepth;
     constructor(config: DyrectedClientConfig);
+    /**
+     * Update the Authorization header with a Bearer token.
+     * Call this after a successful login.
+     */
+    setToken(token: string): void;
+    /**
+     * Remove the Authorization header.
+     * Call this after logout.
+     */
+    clearToken(): void;
     getBaseUrl(): string;
     getSchemas(): Promise<{
         collections: any[];
         globals: any[];
     }>;
-    find<T = any>(collection: string, args?: QueryArgs): Promise<PaginatedResult<T>>;
+    /**
+     * Fetch draft data for a specific preview token.
+     * Used in "token" preview mode.
+     */
+    getPreviewData(token: string): Promise<any>;
+    find<K extends keyof TSchema['collections']>(collection: K & string, args?: QueryArgs): Promise<PaginatedResult<TSchema['collections'][K]>>;
     /**
      * Returns a fluent query builder for a collection.
      */
-    collection<T = any>(slug: string): {
-        find: (args?: QueryArgs) => QueryBuilder<T>;
+    collection<K extends keyof TSchema['collections']>(slug: K & string): {
+        find: (args?: QueryArgs) => QueryBuilder<TSchema["collections"][K]>;
         findOne: (id: string, args?: {
             depth?: number;
-        }) => Promise<T>;
-        create: (data: any) => Promise<T>;
-        update: (id: string, data: any) => Promise<T>;
+            initialData?: TSchema["collections"][K];
+        }) => Promise<TSchema["collections"][K]>;
+        create: (data: any) => Promise<TSchema["collections"][K]>;
+        update: (id: string, data: any) => Promise<TSchema["collections"][K]>;
         delete: (id: string) => Promise<{
             message: string;
         }>;
+        /**
+         * Upload a file to this collection. Sends as multipart/form-data.
+         * @param file - A File or Blob (browser) or Buffer with filename/mimeType (Node.js)
+         * @param data - Additional metadata fields to save alongside the file (e.g. alt, caption)
+         */
+        upload: (file: File | Blob, data?: Record<string, string>) => Promise<any>;
+        /**
+         * Log in with email + password. Returns a JWT token and the user document.
+         * Call `client.setToken(token)` afterwards to authenticate subsequent requests.
+         */
+        login: (email: string, password: string) => Promise<{
+            token: string;
+            user: TSchema["collections"][K];
+        }>;
+        /** Log out. Stateless — token must be discarded client-side; call client.clearToken() too. */
+        logout: () => Promise<{
+            success: boolean;
+        }>;
+        /** Return the currently authenticated user (requires a token via setToken). */
+        me: () => Promise<TSchema["collections"][K]>;
+        /** Issue a fresh token for the currently authenticated user. */
+        refreshToken: () => Promise<{
+            token: string;
+        }>;
+        /** Check if this auth collection has any users (initialized). */
+        isInitialized: () => Promise<{
+            initialized: boolean;
+        }>;
+        /** Register the very first user in an empty auth collection. */
+        registerFirstUser: (data: any) => Promise<{
+            token: string;
+            user: TSchema["collections"][K];
+        }>;
+        /** Send an invitation email to a new user. Requires authentication. */
+        invite: (email: string) => Promise<{
+            success: boolean;
+            message: string;
+        }>;
+        /** Accept an invitation and create an account. Returns token + user. */
+        acceptInvite: (token: string, password: string, extraFields?: Record<string, any>) => Promise<{
+            token: string;
+            user: TSchema["collections"][K];
+        }>;
+    };
+    /**
+     * Access a global by its slug with a fluent builder.
+     * @example client.global('site-settings').get()
+     * @example client.global('site-settings').update({ siteName: 'My Site' })
+     */
+    global<K extends keyof TSchema['globals']>(slug: K & string): {
+        get: (args?: {
+            depth?: number;
+            initialData?: TSchema["globals"][K];
+        }) => Promise<TSchema["globals"][K]>;
+        update: (data: any) => Promise<TSchema["globals"][K]>;
     };
     findOne<T = any>(collection: string, id: string, args?: {
         depth?: number;
+        initialData?: T;
     }): Promise<T>;
     create<T = any>(collection: string, data: any): Promise<T>;
     update<T = any>(collection: string, id: string, data: any): Promise<T>;
@@ -63,15 +159,24 @@ declare class DyrectedClient {
     }>;
     getGlobal<T = any>(slug: string, args?: {
         depth?: number;
+        initialData?: T;
     }): Promise<T>;
     updateGlobal<T = any>(slug: string, data: any): Promise<T>;
-    listMedia(args?: QueryArgs): Promise<PaginatedResult<FileData>>;
-    uploadMedia(file: File): Promise<FileData>;
-    deleteMedia(id: string): Promise<{
+    listMedia(args?: QueryArgs, collection?: string): Promise<PaginatedResult<FileData>>;
+    /** @deprecated Use client.collection('media').upload(file, data) instead */
+    uploadMedia(file: File, collection?: string): Promise<FileData>;
+    /**
+     * Internal upload implementation shared by collection().upload() and uploadMedia().
+     */
+    private _upload;
+    deleteMedia(id: string, collection?: string): Promise<{
         message: string;
     }>;
     private request;
 }
-declare function createClient(config: DyrectedClientConfig): DyrectedClient;
+declare function createClient<TSchema extends {
+    collections: any;
+    globals: any;
+} = any>(config: DyrectedClientConfig): DyrectedClient<TSchema>;
 
-export { DyrectedClient, type DyrectedClientConfig, createClient };
+export { type BaseSchema, DyrectedClient, type DyrectedClientConfig, DyrectedError, createClient };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { PaginatedResult, FileData } from '@dyrected/core';
-export { FileData as Media } from '@dyrected/core';
+export { Block, CollectionConfig, Field, FieldType, GlobalConfig, FileData as Media, PaginatedResult } from '@dyrected/core';
 
 interface QueryArgs {
     limit?: number;
@@ -7,6 +7,7 @@ interface QueryArgs {
     depth?: number;
     where?: any;
     sort?: string;
+    initialData?: any[];
 }
 declare class QueryBuilder<T = any> {
     private collection;
@@ -18,43 +19,138 @@ declare class QueryBuilder<T = any> {
     limit(limit: number): this;
     page(page: number): this;
     depth(depth: number): this;
+    seed(data: T[]): this;
     exec(): Promise<PaginatedResult<T>>;
     then<TResult1 = PaginatedResult<T>, TResult2 = never>(onfulfilled?: ((value: PaginatedResult<T>) => TResult1 | PromiseLike<TResult1>) | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2>;
 }
 
+/**
+ * Structured error thrown by the SDK when the server returns a non-2xx response.
+ */
+declare class DyrectedError extends Error {
+    readonly statusCode: number;
+    readonly errors: {
+        field?: string;
+        message: string;
+    }[];
+    constructor(message: string, statusCode: number, errors?: {
+        field?: string;
+        message: string;
+    }[]);
+}
 interface DyrectedClientConfig {
     baseUrl: string;
     apiKey?: string;
+    siteId?: string;
     headers?: Record<string, string>;
     fetch?: typeof fetch;
+    /** Default depth for relationship population. Applied to every request unless overridden per-call. */
+    defaultDepth?: number;
 }
-declare class DyrectedClient {
+interface BaseSchema {
+    collections: Record<string, any>;
+    globals: Record<string, any>;
+}
+declare class DyrectedClient<TSchema extends BaseSchema = any> {
     private baseUrl;
     private headers;
     private fetch;
+    private defaultDepth;
     constructor(config: DyrectedClientConfig);
+    /**
+     * Update the Authorization header with a Bearer token.
+     * Call this after a successful login.
+     */
+    setToken(token: string): void;
+    /**
+     * Remove the Authorization header.
+     * Call this after logout.
+     */
+    clearToken(): void;
     getBaseUrl(): string;
     getSchemas(): Promise<{
         collections: any[];
         globals: any[];
     }>;
-    find<T = any>(collection: string, args?: QueryArgs): Promise<PaginatedResult<T>>;
+    /**
+     * Fetch draft data for a specific preview token.
+     * Used in "token" preview mode.
+     */
+    getPreviewData(token: string): Promise<any>;
+    find<K extends keyof TSchema['collections']>(collection: K & string, args?: QueryArgs): Promise<PaginatedResult<TSchema['collections'][K]>>;
     /**
      * Returns a fluent query builder for a collection.
      */
-    collection<T = any>(slug: string): {
-        find: (args?: QueryArgs) => QueryBuilder<T>;
+    collection<K extends keyof TSchema['collections']>(slug: K & string): {
+        find: (args?: QueryArgs) => QueryBuilder<TSchema["collections"][K]>;
         findOne: (id: string, args?: {
             depth?: number;
-        }) => Promise<T>;
-        create: (data: any) => Promise<T>;
-        update: (id: string, data: any) => Promise<T>;
+            initialData?: TSchema["collections"][K];
+        }) => Promise<TSchema["collections"][K]>;
+        create: (data: any) => Promise<TSchema["collections"][K]>;
+        update: (id: string, data: any) => Promise<TSchema["collections"][K]>;
         delete: (id: string) => Promise<{
             message: string;
         }>;
+        /**
+         * Upload a file to this collection. Sends as multipart/form-data.
+         * @param file - A File or Blob (browser) or Buffer with filename/mimeType (Node.js)
+         * @param data - Additional metadata fields to save alongside the file (e.g. alt, caption)
+         */
+        upload: (file: File | Blob, data?: Record<string, string>) => Promise<any>;
+        /**
+         * Log in with email + password. Returns a JWT token and the user document.
+         * Call `client.setToken(token)` afterwards to authenticate subsequent requests.
+         */
+        login: (email: string, password: string) => Promise<{
+            token: string;
+            user: TSchema["collections"][K];
+        }>;
+        /** Log out. Stateless — token must be discarded client-side; call client.clearToken() too. */
+        logout: () => Promise<{
+            success: boolean;
+        }>;
+        /** Return the currently authenticated user (requires a token via setToken). */
+        me: () => Promise<TSchema["collections"][K]>;
+        /** Issue a fresh token for the currently authenticated user. */
+        refreshToken: () => Promise<{
+            token: string;
+        }>;
+        /** Check if this auth collection has any users (initialized). */
+        isInitialized: () => Promise<{
+            initialized: boolean;
+        }>;
+        /** Register the very first user in an empty auth collection. */
+        registerFirstUser: (data: any) => Promise<{
+            token: string;
+            user: TSchema["collections"][K];
+        }>;
+        /** Send an invitation email to a new user. Requires authentication. */
+        invite: (email: string) => Promise<{
+            success: boolean;
+            message: string;
+        }>;
+        /** Accept an invitation and create an account. Returns token + user. */
+        acceptInvite: (token: string, password: string, extraFields?: Record<string, any>) => Promise<{
+            token: string;
+            user: TSchema["collections"][K];
+        }>;
+    };
+    /**
+     * Access a global by its slug with a fluent builder.
+     * @example client.global('site-settings').get()
+     * @example client.global('site-settings').update({ siteName: 'My Site' })
+     */
+    global<K extends keyof TSchema['globals']>(slug: K & string): {
+        get: (args?: {
+            depth?: number;
+            initialData?: TSchema["globals"][K];
+        }) => Promise<TSchema["globals"][K]>;
+        update: (data: any) => Promise<TSchema["globals"][K]>;
     };
     findOne<T = any>(collection: string, id: string, args?: {
         depth?: number;
+        initialData?: T;
     }): Promise<T>;
     create<T = any>(collection: string, data: any): Promise<T>;
     update<T = any>(collection: string, id: string, data: any): Promise<T>;
@@ -63,15 +159,24 @@ declare class DyrectedClient {
     }>;
     getGlobal<T = any>(slug: string, args?: {
         depth?: number;
+        initialData?: T;
     }): Promise<T>;
     updateGlobal<T = any>(slug: string, data: any): Promise<T>;
-    listMedia(args?: QueryArgs): Promise<PaginatedResult<FileData>>;
-    uploadMedia(file: File): Promise<FileData>;
-    deleteMedia(id: string): Promise<{
+    listMedia(args?: QueryArgs, collection?: string): Promise<PaginatedResult<FileData>>;
+    /** @deprecated Use client.collection('media').upload(file, data) instead */
+    uploadMedia(file: File, collection?: string): Promise<FileData>;
+    /**
+     * Internal upload implementation shared by collection().upload() and uploadMedia().
+     */
+    private _upload;
+    deleteMedia(id: string, collection?: string): Promise<{
         message: string;
     }>;
     private request;
 }
-declare function createClient(config: DyrectedClientConfig): DyrectedClient;
+declare function createClient<TSchema extends {
+    collections: any;
+    globals: any;
+} = any>(config: DyrectedClientConfig): DyrectedClient<TSchema>;
 
-export { DyrectedClient, type DyrectedClientConfig, createClient };
+export { type BaseSchema, DyrectedClient, type DyrectedClientConfig, DyrectedError, createClient };