@baasix/sdk 0.1.0

package/dist/client-DeXa-R9w.d.ts

@@ -0,0 +1,680 @@
+import { S as StorageAdapter } from './types-BdjsGANq.js';
+
+/**
+ * Authentication mode for the SDK
+ * - 'jwt': Use JWT tokens stored in the configured storage adapter (default)
+ * - 'cookie': Use HTTP-only cookies (server handles token storage)
+ */
+type AuthMode = "jwt" | "cookie";
+/**
+ * SDK Configuration options
+ */
+interface BaasixConfig {
+    /**
+     * The base URL of your Baasix instance
+     * @example 'https://api.example.com' or 'http://localhost:8056'
+     */
+    url: string;
+    /**
+     * Authentication mode
+     * @default 'jwt'
+     */
+    authMode?: AuthMode;
+    /**
+     * Storage adapter for persisting tokens and user data
+     * @default LocalStorageAdapter (web) or MemoryStorageAdapter (SSR)
+     */
+    storage?: StorageAdapter;
+    /**
+     * Static access token (useful for server-side or service accounts)
+     * When provided, this token is used instead of stored tokens
+     */
+    token?: string;
+    /**
+     * Custom headers to include in all requests
+     */
+    headers?: Record<string, string>;
+    /**
+     * Request timeout in milliseconds
+     * @default 30000 (30 seconds)
+     */
+    timeout?: number;
+    /**
+     * Whether to automatically refresh tokens before expiry
+     * @default true
+     */
+    autoRefresh?: boolean;
+    /**
+     * Credentials mode for fetch requests (important for cookies)
+     * @default 'include' for cookie mode, 'same-origin' for jwt mode
+     */
+    credentials?: RequestCredentials;
+    /**
+     * Tenant ID for multi-tenant mode
+     */
+    tenantId?: string;
+    /**
+     * Global error handler
+     */
+    onError?: (error: BaasixError) => void;
+    /**
+     * Called when authentication state changes
+     */
+    onAuthStateChange?: (event: AuthStateEvent, user: User | null) => void;
+    /**
+     * WebSocket server URL for realtime features
+     * @default Same as url
+     */
+    socketUrl?: string;
+    /**
+     * WebSocket path
+     * @default '/socket'
+     */
+    socketPath?: string;
+}
+interface User {
+    id: string;
+    email: string;
+    firstName?: string;
+    lastName?: string;
+    avatar?: string;
+    role?: Role;
+    role_Id?: string;
+    tenant_Id?: string;
+    status?: string;
+    createdAt?: string;
+    updatedAt?: string;
+    [key: string]: unknown;
+}
+interface Role {
+    id: string;
+    name: string;
+    description?: string;
+    [key: string]: unknown;
+}
+interface Tenant {
+    id: string;
+    name: string;
+    [key: string]: unknown;
+}
+interface AuthTokens {
+    accessToken: string;
+    refreshToken?: string;
+    expiresAt?: number;
+    expiresIn?: number;
+}
+interface LoginCredentials {
+    email: string;
+    password: string;
+    tenantId?: string;
+}
+interface RegisterData {
+    email: string;
+    password: string;
+    firstName?: string;
+    lastName?: string;
+    [key: string]: unknown;
+}
+interface AuthResponse {
+    token: string;
+    refreshToken?: string;
+    user: User;
+    expiresIn?: number;
+}
+type AuthStateEvent = "SIGNED_IN" | "SIGNED_OUT" | "TOKEN_REFRESHED" | "USER_UPDATED" | "TENANT_SWITCHED";
+interface AuthState {
+    user: User | null;
+    isAuthenticated: boolean;
+    isLoading: boolean;
+    error: BaasixError | null;
+}
+interface MagicLinkOptions {
+    email: string;
+    redirectUrl?: string;
+    mode?: "link" | "code";
+}
+interface PasswordResetOptions {
+    email: string;
+    redirectUrl?: string;
+}
+/**
+ * Filter operators supported by Baasix
+ */
+type FilterOperator = "eq" | "ne" | "neq" | "gt" | "gte" | "lt" | "lte" | "is" | "not" | "in" | "notIn" | "nin" | "like" | "notLike" | "iLike" | "notILike" | "ilike" | "contains" | "icontains" | "ncontains" | "startsWith" | "startsWiths" | "endsWith" | "endsWiths" | "nstartsWith" | "nstartsWiths" | "nendsWith" | "nendsWiths" | "between" | "notBetween" | "nbetween" | "isNull" | "isNotNull" | "arraycontains" | "arraycontained" | "arrayoverlap" | "arraylength" | "jsonbContains" | "jsonbContainedBy" | "jsonbNotContains" | "jsonbHasKey" | "jsonbHasAnyKeys" | "jsonbHasAllKeys" | "jsonbKeyEquals" | "jsonbKeyNotEquals" | "jsonbKeyGt" | "jsonbKeyGte" | "jsonbKeyLt" | "jsonbKeyLte" | "jsonbKeyIn" | "jsonbKeyNotIn" | "jsonbKeyLike" | "jsonbKeyIsNull" | "jsonbKeyIsNotNull" | "jsonbPathExists" | "jsonbPathMatch" | "jsonbDeepValue" | "jsonbArrayLength" | "jsonbTypeOf" | "within" | "containsGEO" | "intersects" | "nIntersects" | "dwithin";
+/**
+ * Filter value with operator
+ */
+type FilterValue<T = unknown> = T | {
+    [K in FilterOperator]?: T | T[];
+} | {
+    cast?: string;
+};
+/**
+ * Filter condition for a field
+ */
+type FilterCondition = {
+    [field: string]: FilterValue | FilterCondition;
+};
+/**
+ * Logical filter operators
+ */
+interface LogicalFilter {
+    AND?: (FilterCondition | LogicalFilter)[];
+    OR?: (FilterCondition | LogicalFilter)[];
+    NOT?: FilterCondition | LogicalFilter;
+}
+/**
+ * Complete filter type
+ */
+type Filter = FilterCondition | LogicalFilter;
+/**
+ * Sort direction
+ */
+type SortDirection = "asc" | "desc" | "ASC" | "DESC";
+/**
+ * Sort configuration
+ */
+type Sort = string | string[] | Record<string, SortDirection> | {
+    column: string;
+    order: SortDirection;
+}[];
+/**
+ * Aggregation function
+ */
+type AggregateFunction = "count" | "sum" | "avg" | "min" | "max";
+/**
+ * Aggregation configuration
+ */
+interface AggregateConfig {
+    function: AggregateFunction;
+    field: string;
+}
+type Aggregate = Record<string, AggregateConfig>;
+/**
+ * Query parameters for listing items
+ */
+interface QueryParams<T = unknown> {
+    /**
+     * Fields to return
+     * @example ['*'], ['id', 'name'], ['*', 'author.*']
+     */
+    fields?: string[];
+    /**
+     * Filter conditions
+     */
+    filter?: Filter;
+    /**
+     * Sorting configuration
+     * @example { createdAt: 'desc' } or ['-createdAt', 'name']
+     */
+    sort?: Sort;
+    /**
+     * Number of items per page (-1 for all)
+     * @default 10
+     */
+    limit?: number;
+    /**
+     * Page number (1-indexed)
+     * @default 1
+     */
+    page?: number;
+    /**
+     * Number of items to skip
+     */
+    offset?: number;
+    /**
+     * Full-text search query
+     */
+    search?: string;
+    /**
+     * Fields to search in
+     */
+    searchFields?: string[];
+    /**
+     * Aggregation configuration
+     */
+    aggregate?: Aggregate;
+    /**
+     * Fields to group by (used with aggregate)
+     */
+    groupBy?: string[];
+    /**
+     * Include soft-deleted items
+     * @default false
+     */
+    paranoid?: boolean;
+    /**
+     * Filter conditions for related items (O2M/M2M)
+     */
+    relConditions?: Record<string, Filter>;
+    /**
+     * Additional metadata
+     */
+    meta?: T;
+}
+/**
+ * Paginated response
+ */
+interface PaginatedResponse<T> {
+    data: T[];
+    totalCount?: number;
+    page?: number;
+    limit?: number;
+    totalPages?: number;
+}
+/**
+ * Single item response
+ */
+interface SingleResponse<T> {
+    data: T;
+}
+/**
+ * Create/Update response
+ */
+interface MutationResponse<T = string> {
+    data: T;
+    message?: string;
+}
+/**
+ * Delete response
+ */
+interface DeleteResponse {
+    data: {
+        deleted: boolean;
+        count?: number;
+    };
+    message?: string;
+}
+/**
+ * Bulk operation response
+ */
+interface BulkResponse<T = string[]> {
+    data: T;
+    message?: string;
+    errors?: Array<{
+        index: number;
+        error: string;
+    }>;
+}
+type FieldType = "String" | "Text" | "HTML" | "Integer" | "BigInt" | "Float" | "Real" | "Double" | "Decimal" | "Boolean" | "Date" | "DateTime" | "Time" | "UUID" | "SUID" | "JSON" | "JSONB" | "Array" | "Geometry" | "Point" | "LineString" | "Polygon" | "Enum";
+/**
+ * Default value types supported by Baasix
+ */
+type DefaultValueType = {
+    type: "UUIDV4";
+} | {
+    type: "SUID";
+} | {
+    type: "NOW";
+} | {
+    type: "AUTOINCREMENT";
+} | {
+    type: "SQL";
+    value: string;
+} | {
+    type: "CURRENT_USER";
+} | {
+    type: "CURRENT_TENANT";
+};
+interface FieldDefinition {
+    type: FieldType;
+    primaryKey?: boolean;
+    allowNull?: boolean;
+    unique?: boolean;
+    /**
+     * Default value for the field
+     * Can be a static value or a dynamic type
+     * @example
+     * // Static values
+     * defaultValue: "active"
+     * defaultValue: 0
+     * defaultValue: false
+     * defaultValue: []
+     *
+     * // Dynamic types
+     * defaultValue: { type: "UUIDV4" }
+     * defaultValue: { type: "SUID" }
+     * defaultValue: { type: "NOW" }
+     * defaultValue: { type: "AUTOINCREMENT" }
+     * defaultValue: { type: "SQL", value: "CURRENT_DATE" }
+     */
+    defaultValue?: DefaultValueType | string | number | boolean | null | unknown[] | Record<string, unknown>;
+    values?: {
+        length?: number;
+        precision?: number;
+        scale?: number;
+        type?: string;
+        values?: string[];
+    };
+    validate?: {
+        /** Minimum value for numeric fields */
+        min?: number;
+        /** Maximum value for numeric fields */
+        max?: number;
+        /** Validate as integer */
+        isInt?: boolean;
+        /** String must not be empty */
+        notEmpty?: boolean;
+        /** Validate email format */
+        isEmail?: boolean;
+        /** Validate URL format */
+        isUrl?: boolean;
+        /** String length range [min, max] */
+        len?: [number, number];
+        /** Pattern matching with regex (alias: matches) */
+        is?: string;
+        /** Pattern matching with regex (alias: is) */
+        matches?: string;
+        /** @deprecated Use 'is' or 'matches' instead */
+        regex?: string;
+    };
+    comment?: string;
+}
+interface SchemaDefinition {
+    name: string;
+    timestamps?: boolean;
+    paranoid?: boolean;
+    /**
+     * True for M2M/M2A junction tables (system-generated)
+     * Junction tables are auto-created when defining M2M or M2A relationships
+     */
+    isJunction?: boolean;
+    fields: Record<string, FieldDefinition>;
+    indexes?: IndexDefinition[];
+}
+interface IndexDefinition {
+    name: string;
+    fields: string[];
+    unique?: boolean;
+    /** When true, NULL values are considered equal for unique indexes (PostgreSQL 15+) */
+    nullsNotDistinct?: boolean;
+}
+type RelationshipType = "M2O" | "O2M" | "M2M" | "M2A" | "O2O";
+interface RelationshipDefinition {
+    type: RelationshipType;
+    target: string;
+    name: string;
+    alias?: string;
+    /**
+     * Custom junction table name for M2M/M2A relationships (max 63 chars for PostgreSQL)
+     * If not provided, auto-generated as: {source}_{target}_{name}_junction
+     * @example "product_tags" or "comment_refs"
+     */
+    through?: string;
+    onDelete?: "CASCADE" | "RESTRICT" | "SET NULL";
+    onUpdate?: "CASCADE" | "RESTRICT" | "SET NULL";
+    /** Target tables for M2A (polymorphic) relationships */
+    tables?: string[];
+}
+interface SchemaInfo {
+    collectionName: string;
+    schema: SchemaDefinition;
+    relationships?: RelationshipDefinition[];
+}
+interface FileMetadata {
+    id: string;
+    title?: string;
+    description?: string;
+    filename: string;
+    mimeType: string;
+    size: number;
+    width?: number;
+    height?: number;
+    duration?: number;
+    storage: string;
+    path: string;
+    isPublic?: boolean;
+    uploadedBy?: string;
+    createdAt: string;
+    updatedAt?: string;
+    [key: string]: unknown;
+}
+interface UploadOptions {
+    title?: string;
+    description?: string;
+    folder?: string;
+    storage?: "local" | "s3";
+    isPublic?: boolean;
+    metadata?: Record<string, unknown>;
+    onProgress?: (progress: number) => void;
+    /** Request timeout in milliseconds (default: 30000). Set to 0 for no timeout. */
+    timeout?: number;
+}
+interface AssetTransformOptions {
+    width?: number;
+    height?: number;
+    fit?: "cover" | "contain" | "fill" | "inside" | "outside";
+    quality?: number;
+    format?: "jpeg" | "png" | "webp" | "avif";
+}
+type PermissionAction = "create" | "read" | "update" | "delete";
+interface Permission {
+    id: string;
+    role_Id: string;
+    collection: string;
+    action: PermissionAction;
+    fields?: string[];
+    conditions?: Filter;
+    defaultValues?: Record<string, unknown>;
+    relConditions?: Record<string, Filter>;
+}
+interface CreatePermissionData {
+    role_Id: string;
+    collection: string;
+    action: PermissionAction;
+    fields?: string[];
+    conditions?: Filter;
+    defaultValues?: Record<string, unknown>;
+    relConditions?: Record<string, Filter>;
+}
+interface Notification {
+    id: string;
+    type: string;
+    title: string;
+    message: string;
+    data?: Record<string, unknown>;
+    seen: boolean;
+    user_Id: string;
+    createdAt: string;
+}
+interface SendNotificationData {
+    type?: string;
+    title: string;
+    message: string;
+    data?: Record<string, unknown>;
+    userIds: string[];
+}
+interface Workflow {
+    id: string;
+    name: string;
+    description?: string;
+    trigger: WorkflowTrigger;
+    nodes: WorkflowNode[];
+    edges: WorkflowEdge[];
+    isActive: boolean;
+    createdAt: string;
+    updatedAt?: string;
+}
+interface WorkflowTrigger {
+    type: "manual" | "webhook" | "schedule" | "hook";
+    config?: Record<string, unknown>;
+}
+interface WorkflowNode {
+    id: string;
+    type: string;
+    config: Record<string, unknown>;
+    position?: {
+        x: number;
+        y: number;
+    };
+}
+interface WorkflowEdge {
+    id: string;
+    source: string;
+    target: string;
+    condition?: string;
+}
+interface WorkflowExecution {
+    id: string;
+    workflow_Id: string;
+    status: "pending" | "running" | "completed" | "failed";
+    triggerData?: Record<string, unknown>;
+    result?: Record<string, unknown>;
+    error?: string;
+    startedAt: string;
+    completedAt?: string;
+}
+interface ReportConfig {
+    collection: string;
+    filter?: Filter;
+    groupBy?: string;
+    aggregate?: Aggregate;
+    dateRange?: {
+        start: string;
+        end: string;
+        field?: string;
+    };
+}
+interface ReportResult {
+    data: Record<string, unknown>[];
+    summary?: Record<string, unknown>;
+}
+interface BaasixErrorDetails {
+    code?: string;
+    field?: string;
+    message?: string;
+    [key: string]: unknown;
+}
+declare class BaasixError extends Error {
+    readonly status: number;
+    readonly code?: string;
+    readonly details?: BaasixErrorDetails[];
+    readonly isRetryable: boolean;
+    constructor(message: string, status?: number, code?: string, details?: BaasixErrorDetails[]);
+    toJSON(): {
+        name: string;
+        message: string;
+        status: number;
+        code: string | undefined;
+        details: BaasixErrorDetails[] | undefined;
+    };
+}
+/**
+ * Make all properties of T optional recursively
+ */
+type DeepPartial<T> = {
+    [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
+};
+/**
+ * Extract the item type from a collection
+ */
+type CollectionItem<T> = T extends Array<infer U> ? U : T;
+/**
+ * Generic record type with ID
+ */
+interface BaseItem {
+    id: string;
+    createdAt?: string;
+    updatedAt?: string;
+    deletedAt?: string;
+    [key: string]: unknown;
+}
+/**
+ * Settings configuration
+ */
+interface Settings {
+    [key: string]: unknown;
+}
+
+interface RequestOptions extends RequestInit {
+    params?: Record<string, unknown>;
+    timeout?: number;
+    skipAuth?: boolean;
+    rawResponse?: boolean;
+}
+interface HttpClientConfig {
+    baseUrl: string;
+    authMode: AuthMode;
+    storage: StorageAdapter;
+    timeout: number;
+    autoRefresh: boolean;
+    credentials: RequestCredentials;
+    headers: Record<string, string>;
+    token?: string;
+    tenantId?: string;
+    onAuthError?: () => void;
+    onTokenRefresh?: (tokens: AuthTokens) => void;
+}
+/**
+ * Core HTTP client for making API requests.
+ * Handles authentication, token refresh, and error handling.
+ */
+declare class HttpClient {
+    private config;
+    private refreshPromise;
+    constructor(config: HttpClientConfig);
+    /**
+     * Update client configuration
+     */
+    updateConfig(config: Partial<HttpClientConfig>): void;
+    /**
+     * Get the current base URL
+     */
+    getBaseUrl(): string;
+    /**
+     * Build the full URL with query parameters
+     */
+    private buildUrl;
+    /**
+     * Get the current access token
+     */
+    private getAccessToken;
+    /**
+     * Check if token is expired or about to expire (within 60 seconds)
+     */
+    private isTokenExpired;
+    /**
+     * Refresh the access token
+     */
+    private refreshToken;
+    /**
+     * Build request headers
+     */
+    private buildHeaders;
+    /**
+     * Parse error response
+     */
+    private parseError;
+    /**
+     * Make an HTTP request
+     */
+    request<T>(method: string, path: string, options?: RequestOptions): Promise<T>;
+    /**
+     * GET request
+     */
+    get<T>(path: string, options?: RequestOptions): Promise<T>;
+    /**
+     * POST request
+     */
+    post<T>(path: string, data?: unknown, options?: RequestOptions): Promise<T>;
+    /**
+     * PATCH request
+     */
+    patch<T>(path: string, data?: unknown, options?: RequestOptions): Promise<T>;
+    /**
+     * PUT request
+     */
+    put<T>(path: string, data?: unknown, options?: RequestOptions): Promise<T>;
+    /**
+     * DELETE request
+     */
+    delete<T>(path: string, options?: RequestOptions): Promise<T>;
+    /**
+     * Upload file with multipart/form-data
+     */
+    upload<T>(path: string, formData: FormData, options?: Omit<RequestOptions, "body"> & {
+        onProgress?: (progress: number) => void;
+    }): Promise<T>;
+}
+
+export { type PermissionAction as $, type AuthMode as A, type BaseItem as B, type CreatePermissionData as C, type DeleteResponse as D, type FilterValue as E, type Filter as F, type FilterCondition as G, HttpClient as H, type IndexDefinition as I, type LogicalFilter as J, type SortDirection as K, type LoginCredentials as L, type MagicLinkOptions as M, type Notification as N, type AggregateFunction as O, type PasswordResetOptions as P, type QueryParams as Q, type RegisterData as R, type Sort as S, type Tenant as T, type User as U, type AggregateConfig as V, type Workflow as W, type FieldType as X, type DefaultValueType as Y, type FieldDefinition as Z, type RelationshipType as _, type AuthStateEvent as a, type WorkflowTrigger as a0, type WorkflowNode as a1, type WorkflowEdge as a2, type BaasixErrorDetails as a3, BaasixError as a4, type DeepPartial as a5, type CollectionItem as a6, type AuthResponse as b, type AuthTokens as c, type AuthState as d, type PaginatedResponse as e, type BulkResponse as f, type MutationResponse as g, type SingleResponse as h, type UploadOptions as i, type FileMetadata as j, type AssetTransformOptions as k, type SchemaInfo as l, type SchemaDefinition as m, type RelationshipDefinition as n, type SendNotificationData as o, type Permission as p, type Role as q, type Settings as r, type ReportConfig as s, type ReportResult as t, type Aggregate as u, type WorkflowExecution as v, type BaasixConfig as w, type RequestOptions as x, type HttpClientConfig as y, type FilterOperator as z };