zone4code-sdk 1.0.0

package/dist/index.d.cts

@@ -0,0 +1,248 @@
+interface StorageAdapter {
+    getItem(key: string): string | null | Promise<string | null>;
+    setItem(key: string, value: string): void | Promise<void>;
+    removeItem(key: string): void | Promise<void>;
+}
+interface Zone4CodeConfig {
+    /**
+     * The base URL of the API Gateway (e.g., 'http://localhost:8080' or 'https://api.yourdomain.com')
+     */
+    gatewayUrl: string;
+    /**
+     * Default tenant identifier (workspace ID)
+     */
+    tenantId: string;
+    /**
+     * Optional initial JWT authorization token
+     */
+    token?: string;
+    /**
+     * Optional custom storage adapter for token persistence (defaults to localStorage in browser or MemoryStorage in Node)
+     */
+    storage?: StorageAdapter;
+    /**
+     * Optional custom fetch implementation (useful for tests or custom proxies)
+     */
+    fetch?: typeof fetch;
+}
+interface AuthUser {
+    id: string;
+    email?: string;
+    username?: string;
+    name?: string;
+    firstName?: string;
+    lastName?: string;
+    roles?: string[];
+    attributes?: Record<string, any>;
+}
+interface AuthResponse {
+    token: string;
+    refreshToken?: string;
+    user?: AuthUser;
+}
+interface EntityRecord<T = Record<string, any>> {
+    id: string;
+    entity_type_id?: string;
+    created_at: string;
+    updated_at?: string;
+    deleted_at?: string | null;
+    data: T;
+}
+interface EntityListResponse<T = Record<string, any>> {
+    data: Array<EntityRecord<T> | (T & {
+        id: string;
+    })>;
+    total: number;
+    page?: number;
+    limit?: number;
+    cursor?: string;
+}
+interface SchemaProperty {
+    type: 'string' | 'number' | 'integer' | 'boolean' | 'object' | 'array';
+    description?: string;
+    format?: string;
+    enum?: any[];
+    items?: SchemaProperty;
+    properties?: Record<string, SchemaProperty>;
+    required?: string[];
+}
+interface EntitySchemaDefinition {
+    typeName: string;
+    schema: {
+        type: 'object';
+        required?: string[];
+        properties: Record<string, SchemaProperty>;
+        additionalProperties?: boolean;
+    };
+}
+type FilterOperator = 'eq' | 'ne' | 'gt' | 'gte' | 'lt' | 'lte' | 'like' | 'in' | 'null';
+
+declare class MemoryStorage implements StorageAdapter {
+    private store;
+    getItem(key: string): string | null;
+    setItem(key: string, value: string): void;
+    removeItem(key: string): void;
+}
+declare function getDefaultStorage(): StorageAdapter;
+
+declare class AuthClient {
+    private gatewayUrl;
+    private tenantId;
+    private storage;
+    private token;
+    private fetchFn;
+    private static TOKEN_KEY_PREFIX;
+    constructor(options: {
+        gatewayUrl: string;
+        tenantId: string;
+        storage: StorageAdapter;
+        initialToken?: string;
+        fetchFn?: typeof fetch;
+    });
+    getToken(): string | null;
+    setToken(token: string | null): void;
+    isAuthenticated(): boolean;
+    /**
+     * Register a new user in the tenant realm
+     */
+    register(data: {
+        email: string;
+        password: string;
+        name?: string;
+        username?: string;
+        attributes?: Record<string, any>;
+    }): Promise<AuthResponse>;
+    /**
+     * Log in an existing user and store their JWT token
+     */
+    login(credentials: {
+        email?: string;
+        username?: string;
+        password: string;
+    }): Promise<AuthResponse>;
+    /**
+     * Fetch current authenticated user profile
+     */
+    getProfile(): Promise<AuthUser>;
+    /**
+     * Log out and clear saved token
+     */
+    logout(): void;
+}
+
+declare class SchemaClient {
+    private gatewayUrl;
+    private tenantId;
+    private getToken;
+    private fetchFn;
+    constructor(options: {
+        gatewayUrl: string;
+        tenantId: string;
+        getToken: () => string | null;
+        fetchFn?: typeof fetch;
+    });
+    private getHeaders;
+    /**
+     * Define a new JSON Schema or alter an existing schema for an entity type in real-time
+     */
+    define(definition: EntitySchemaDefinition): Promise<{
+        success: boolean;
+        version?: number;
+    }>;
+}
+
+declare class EntityQueryBuilder<T = Record<string, any>> {
+    private gatewayUrl;
+    private tenantId;
+    private typeName;
+    private getToken;
+    private fetchFn;
+    private queryParams;
+    constructor(options: {
+        gatewayUrl: string;
+        tenantId: string;
+        typeName: string;
+        getToken: () => string | null;
+        fetchFn?: typeof fetch;
+    });
+    private getHeaders;
+    eq(field: string, value: string | number | boolean): this;
+    ne(field: string, value: string | number | boolean): this;
+    gt(field: string, value: number): this;
+    gte(field: string, value: number): this;
+    lt(field: string, value: number): this;
+    lte(field: string, value: number): this;
+    /**
+     * Case-insensitive substring search (ILIKE %substring%)
+     */
+    like(field: string, substring: string): this;
+    /**
+     * Set membership: matches if field value is in the array
+     */
+    in(field: string, values: Array<string | number>): this;
+    isNull(field: string): this;
+    isNotNull(field: string): this;
+    /**
+     * Filter entities connected by graph relationship
+     */
+    related(relationName: string, entityIds: string | string[]): this;
+    orderBy(field: string, direction?: 'asc' | 'desc'): this;
+    limit(limit: number): this;
+    page(page: number, limit?: number): this;
+    offset(offset: number): this;
+    cursor(token: string): this;
+    flat(enabled?: boolean): this;
+    /**
+     * Execute query and list matching records with pagination metadata
+     */
+    list(): Promise<EntityListResponse<T>>;
+    /**
+     * Fetch a single entity by ID
+     */
+    get(id: string): Promise<EntityRecord<T>>;
+    /**
+     * Create a new entity record matching schema
+     */
+    create(data: T): Promise<EntityRecord<T>>;
+    /**
+     * Update an existing entity record
+     */
+    update(id: string, partialData: Partial<T>): Promise<EntityRecord<T>>;
+    /**
+     * Soft-delete an entity record
+     */
+    delete(id: string): Promise<{
+        success: boolean;
+    }>;
+}
+
+declare class Zone4CodeClient {
+    readonly gatewayUrl: string;
+    readonly tenantId: string;
+    readonly auth: AuthClient;
+    readonly schema: SchemaClient;
+    private storage;
+    private fetchFn;
+    constructor(config: Zone4CodeConfig);
+    /**
+     * Access an entity collection with chainable query builder (like Supabase .from('orders'))
+     */
+    from<T = Record<string, any>>(typeName: string): EntityQueryBuilder<T>;
+    /**
+     * Alias for .from(typeName)
+     */
+    entities<T = Record<string, any>>(typeName: string): EntityQueryBuilder<T>;
+    /**
+     * Check gateway connectivity & health
+     */
+    health(): Promise<{
+        status: string;
+        licenseTier?: string;
+    }>;
+}
+/**
+ * Factory function to instantiate a new Zone4Code client
+ */
+declare function createClient(config: Zone4CodeConfig): Zone4CodeClient;
+
+export { AuthClient, type AuthResponse, type AuthUser, type EntityListResponse, EntityQueryBuilder, type EntityRecord, type EntitySchemaDefinition, type FilterOperator, MemoryStorage, SchemaClient, type SchemaProperty, type StorageAdapter, Zone4CodeClient, type Zone4CodeConfig, createClient, createClient as default, getDefaultStorage };

package/dist/index.d.ts

@@ -0,0 +1,248 @@
+interface StorageAdapter {
+    getItem(key: string): string | null | Promise<string | null>;
+    setItem(key: string, value: string): void | Promise<void>;
+    removeItem(key: string): void | Promise<void>;
+}
+interface Zone4CodeConfig {
+    /**
+     * The base URL of the API Gateway (e.g., 'http://localhost:8080' or 'https://api.yourdomain.com')
+     */
+    gatewayUrl: string;
+    /**
+     * Default tenant identifier (workspace ID)
+     */
+    tenantId: string;
+    /**
+     * Optional initial JWT authorization token
+     */
+    token?: string;
+    /**
+     * Optional custom storage adapter for token persistence (defaults to localStorage in browser or MemoryStorage in Node)
+     */
+    storage?: StorageAdapter;
+    /**
+     * Optional custom fetch implementation (useful for tests or custom proxies)
+     */
+    fetch?: typeof fetch;
+}
+interface AuthUser {
+    id: string;
+    email?: string;
+    username?: string;
+    name?: string;
+    firstName?: string;
+    lastName?: string;
+    roles?: string[];
+    attributes?: Record<string, any>;
+}
+interface AuthResponse {
+    token: string;
+    refreshToken?: string;
+    user?: AuthUser;
+}
+interface EntityRecord<T = Record<string, any>> {
+    id: string;
+    entity_type_id?: string;
+    created_at: string;
+    updated_at?: string;
+    deleted_at?: string | null;
+    data: T;
+}
+interface EntityListResponse<T = Record<string, any>> {
+    data: Array<EntityRecord<T> | (T & {
+        id: string;
+    })>;
+    total: number;
+    page?: number;
+    limit?: number;
+    cursor?: string;
+}
+interface SchemaProperty {
+    type: 'string' | 'number' | 'integer' | 'boolean' | 'object' | 'array';
+    description?: string;
+    format?: string;
+    enum?: any[];
+    items?: SchemaProperty;
+    properties?: Record<string, SchemaProperty>;
+    required?: string[];
+}
+interface EntitySchemaDefinition {
+    typeName: string;
+    schema: {
+        type: 'object';
+        required?: string[];
+        properties: Record<string, SchemaProperty>;
+        additionalProperties?: boolean;
+    };
+}
+type FilterOperator = 'eq' | 'ne' | 'gt' | 'gte' | 'lt' | 'lte' | 'like' | 'in' | 'null';
+
+declare class MemoryStorage implements StorageAdapter {
+    private store;
+    getItem(key: string): string | null;
+    setItem(key: string, value: string): void;
+    removeItem(key: string): void;
+}
+declare function getDefaultStorage(): StorageAdapter;
+
+declare class AuthClient {
+    private gatewayUrl;
+    private tenantId;
+    private storage;
+    private token;
+    private fetchFn;
+    private static TOKEN_KEY_PREFIX;
+    constructor(options: {
+        gatewayUrl: string;
+        tenantId: string;
+        storage: StorageAdapter;
+        initialToken?: string;
+        fetchFn?: typeof fetch;
+    });
+    getToken(): string | null;
+    setToken(token: string | null): void;
+    isAuthenticated(): boolean;
+    /**
+     * Register a new user in the tenant realm
+     */
+    register(data: {
+        email: string;
+        password: string;
+        name?: string;
+        username?: string;
+        attributes?: Record<string, any>;
+    }): Promise<AuthResponse>;
+    /**
+     * Log in an existing user and store their JWT token
+     */
+    login(credentials: {
+        email?: string;
+        username?: string;
+        password: string;
+    }): Promise<AuthResponse>;
+    /**
+     * Fetch current authenticated user profile
+     */
+    getProfile(): Promise<AuthUser>;
+    /**
+     * Log out and clear saved token
+     */
+    logout(): void;
+}
+
+declare class SchemaClient {
+    private gatewayUrl;
+    private tenantId;
+    private getToken;
+    private fetchFn;
+    constructor(options: {
+        gatewayUrl: string;
+        tenantId: string;
+        getToken: () => string | null;
+        fetchFn?: typeof fetch;
+    });
+    private getHeaders;
+    /**
+     * Define a new JSON Schema or alter an existing schema for an entity type in real-time
+     */
+    define(definition: EntitySchemaDefinition): Promise<{
+        success: boolean;
+        version?: number;
+    }>;
+}
+
+declare class EntityQueryBuilder<T = Record<string, any>> {
+    private gatewayUrl;
+    private tenantId;
+    private typeName;
+    private getToken;
+    private fetchFn;
+    private queryParams;
+    constructor(options: {
+        gatewayUrl: string;
+        tenantId: string;
+        typeName: string;
+        getToken: () => string | null;
+        fetchFn?: typeof fetch;
+    });
+    private getHeaders;
+    eq(field: string, value: string | number | boolean): this;
+    ne(field: string, value: string | number | boolean): this;
+    gt(field: string, value: number): this;
+    gte(field: string, value: number): this;
+    lt(field: string, value: number): this;
+    lte(field: string, value: number): this;
+    /**
+     * Case-insensitive substring search (ILIKE %substring%)
+     */
+    like(field: string, substring: string): this;
+    /**
+     * Set membership: matches if field value is in the array
+     */
+    in(field: string, values: Array<string | number>): this;
+    isNull(field: string): this;
+    isNotNull(field: string): this;
+    /**
+     * Filter entities connected by graph relationship
+     */
+    related(relationName: string, entityIds: string | string[]): this;
+    orderBy(field: string, direction?: 'asc' | 'desc'): this;
+    limit(limit: number): this;
+    page(page: number, limit?: number): this;
+    offset(offset: number): this;
+    cursor(token: string): this;
+    flat(enabled?: boolean): this;
+    /**
+     * Execute query and list matching records with pagination metadata
+     */
+    list(): Promise<EntityListResponse<T>>;
+    /**
+     * Fetch a single entity by ID
+     */
+    get(id: string): Promise<EntityRecord<T>>;
+    /**
+     * Create a new entity record matching schema
+     */
+    create(data: T): Promise<EntityRecord<T>>;
+    /**
+     * Update an existing entity record
+     */
+    update(id: string, partialData: Partial<T>): Promise<EntityRecord<T>>;
+    /**
+     * Soft-delete an entity record
+     */
+    delete(id: string): Promise<{
+        success: boolean;
+    }>;
+}
+
+declare class Zone4CodeClient {
+    readonly gatewayUrl: string;
+    readonly tenantId: string;
+    readonly auth: AuthClient;
+    readonly schema: SchemaClient;
+    private storage;
+    private fetchFn;
+    constructor(config: Zone4CodeConfig);
+    /**
+     * Access an entity collection with chainable query builder (like Supabase .from('orders'))
+     */
+    from<T = Record<string, any>>(typeName: string): EntityQueryBuilder<T>;
+    /**
+     * Alias for .from(typeName)
+     */
+    entities<T = Record<string, any>>(typeName: string): EntityQueryBuilder<T>;
+    /**
+     * Check gateway connectivity & health
+     */
+    health(): Promise<{
+        status: string;
+        licenseTier?: string;
+    }>;
+}
+/**
+ * Factory function to instantiate a new Zone4Code client
+ */
+declare function createClient(config: Zone4CodeConfig): Zone4CodeClient;
+
+export { AuthClient, type AuthResponse, type AuthUser, type EntityListResponse, EntityQueryBuilder, type EntityRecord, type EntitySchemaDefinition, type FilterOperator, MemoryStorage, SchemaClient, type SchemaProperty, type StorageAdapter, Zone4CodeClient, type Zone4CodeConfig, createClient, createClient as default, getDefaultStorage };