zone4code-sdk 1.0.2 → 1.0.4

package/dist/index.d.ts

@@ -51,6 +51,8 @@ interface EntityRecord<T = Record<string, any>> {
     updated_at?: string;
     deleted_at?: string | null;
     data: T;
+    relations?: Record<string, any[]>;
+    [key: string]: any;
 }
 interface EntityListResponse<T = Record<string, any>> {
     data: Array<EntityRecord<T> | (T & {
@@ -80,21 +82,52 @@ interface EntitySchemaDefinition {
     };
 }
 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;
+interface UserProfileWithWallet {
+    id: string;
+    name: string;
+    email?: string;
+    profile?: Record<string, any>;
+    wallet?: {
+        total_points: number;
+        points_used: number;
+        available_points: number;
+    };
+}
+interface EntityRevision<T = Record<string, any>> {
+    id: string;
+    entity_id: string;
+    entity_definition_id?: string;
+    data: T;
+    actor_id?: string;
+    created_at: string;
+}
+interface EntityRelationPayload {
+    targetTypeName: string;
+    targetId: string;
+    relationName: string;
+}
+interface EntityReplaceRelationsPayload {
+    targetTypeName: string;
+    targetIds: string[];
+    relationName: string;
+}
+interface EntityRelationRecord {
+    id?: string;
+    source_id: string;
+    target_id: string;
+    relation_name: string;
+    target_type_name?: string;
+    target?: EntityRecord<any>;
 }
-declare function getDefaultStorage(): StorageAdapter;
 
 declare class AuthClient {
     private gatewayUrl;
     private tenantId;
     private storage;
     private storageKey;
+    private refreshStorageKey;
     private token;
+    private refreshTokenValue;
     private fetchFn;
     private static TOKEN_KEY_PREFIX;
     constructor(options: {
@@ -106,7 +139,9 @@ declare class AuthClient {
         fetchFn?: typeof fetch;
     });
     getToken(): string | null;
+    getRefreshToken(): string | null;
     setToken(token: string | null): void;
+    setRefreshToken(token: string | null): void;
     isAuthenticated(): boolean;
     /**
      * Synchronously parse and return current authenticated user from JWT token
@@ -136,34 +171,55 @@ declare class AuthClient {
         password: string;
     }): Promise<AuthResponse>;
     /**
-     * Fetch current authenticated user profile
+     * Authenticate via Google OAuth ID token
      */
-    getProfile(): Promise<AuthUser>;
+    loginWithGoogle(token: string): Promise<AuthResponse>;
     /**
-     * Log out and clear saved token
+     * Renew expired access token using stored or provided refresh 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;
+    refreshToken(refreshToken?: string): Promise<AuthResponse>;
     /**
-     * Define a new JSON Schema or alter an existing schema for an entity type in real-time
+     * Request password reset email
      */
-    define(definition: EntitySchemaDefinition): Promise<{
+    forgotPassword(data: {
+        email: string;
+        frontendUrl?: string;
+    } | string): Promise<{
         success: boolean;
-        version?: number;
+        message: string;
+    }>;
+    /**
+     * Complete password reset using action token
+     */
+    resetPassword(data: {
+        token: string;
+        newPassword: string;
+    }): Promise<{
+        success: boolean;
+        message: string;
     }>;
+    /**
+     * Change password for current or specified user
+     */
+    changePassword(data: {
+        oldPassword: string;
+        newPassword: string;
+    }, userId?: string): Promise<{
+        success: boolean;
+        message?: string;
+    }>;
+    /**
+     * Update profile attributes for current or specified user
+     */
+    updateProfile(data: Partial<AuthUser> & Record<string, any>, userId?: string): Promise<AuthUser>;
+    /**
+     * Fetch current authenticated user profile
+     */
+    getProfile(): Promise<AuthUser>;
+    /**
+     * Log out and clear saved tokens
+     */
+    logout(): void;
 }
 
 declare class EntityQueryBuilder<T = Record<string, any>> {
@@ -201,6 +257,11 @@ declare class EntityQueryBuilder<T = Record<string, any>> {
      * Filter entities connected by graph relationship
      */
     related(relationName: string, entityIds: string | string[]): this;
+    /**
+     * Declaratively expand graph relations (Supabase-style join expansion)
+     * Example: .include('placed_by', 'payment', 'items')
+     */
+    include(...relations: string[]): this;
     orderBy(field: string, direction?: 'asc' | 'desc'): this;
     limit(limit: number): this;
     page(page: number, limit?: number): this;
@@ -212,9 +273,12 @@ declare class EntityQueryBuilder<T = Record<string, any>> {
      */
     list(): Promise<EntityListResponse<T>>;
     /**
-     * Fetch a single entity by ID
+     * Fetch a single entity by ID with optional expansion and flattening
      */
-    get(id: string): Promise<EntityRecord<T>>;
+    get(id: string, options?: {
+        flat?: boolean;
+        include?: string[];
+    }): Promise<EntityRecord<T>>;
     /**
      * Create a new entity record matching schema
      */
@@ -229,6 +293,65 @@ declare class EntityQueryBuilder<T = Record<string, any>> {
     delete(id: string): Promise<{
         success: boolean;
     }>;
+    /**
+     * Fetch revision history for an entity record
+     */
+    revisions(id: string): Promise<EntityRevision<T>[]>;
+    /**
+     * Fetch all graph relations for this entity record
+     */
+    getRelations(id: string, lang?: string): Promise<EntityRelationRecord[]>;
+    /**
+     * Link this record to another entity record
+     */
+    link(id: string, payload: EntityRelationPayload): Promise<{
+        success: boolean;
+    }>;
+    /**
+     * Replace the full set of relations of one relation name
+     */
+    setLinks(id: string, payload: EntityReplaceRelationsPayload): Promise<{
+        success: boolean;
+    }>;
+    /**
+     * Remove one graph link between two records
+     */
+    unlink(id: string, relationName: string, targetId: string, targetTypeName: string): Promise<{
+        success: boolean;
+    }>;
+    /**
+     * Execute a type-level workflow plugin action (e.g. checkout, batch-process)
+     */
+    action<R = any>(actionName: string, payload?: object): Promise<R>;
+    /**
+     * Execute an instance-level workflow plugin action (e.g. cancel order, approve)
+     */
+    instanceAction<R = any>(id: string, actionName: string, payload?: object): Promise<R>;
+    /**
+     * Export matching entity records to CSV format with active filters
+     */
+    exportCsv(): Promise<string>;
+}
+
+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 Zone4CodeClient {
@@ -247,6 +370,10 @@ declare class Zone4CodeClient {
      * Alias for .from(typeName)
      */
     entities<T = Record<string, any>>(typeName: string): EntityQueryBuilder<T>;
+    /**
+     * Get current authenticated user profile and platform wallet
+     */
+    getMe(): Promise<UserProfileWithWallet>;
     /**
      * Check gateway connectivity & health
      */
@@ -260,4 +387,12 @@ declare class Zone4CodeClient {
  */
 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 };
+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;
+
+export { AuthClient, type AuthResponse, type AuthUser, type EntityListResponse, EntityQueryBuilder, type EntityRecord, type EntityRelationPayload, type EntityRelationRecord, type EntityReplaceRelationsPayload, type EntityRevision, type EntitySchemaDefinition, type FilterOperator, MemoryStorage, SchemaClient, type SchemaProperty, type StorageAdapter, type UserProfileWithWallet, Zone4CodeClient, type Zone4CodeConfig, createClient, createClient as default, getDefaultStorage };