@baasix/sdk 0.1.6 → 0.1.8

package/dist/index.d.cts

@@ -365,6 +365,43 @@ declare class PermissionsModule {
      * ```
      */
     reloadCache(): Promise<void>;
+    /**
+     * Export all permissions (admin only)
+     *
+     * @example
+     * ```typescript
+     * const exported = await baasix.permissions.export();
+     * // Save to file or transfer
+     * ```
+     */
+    export(): Promise<{
+        permissions: Permission[];
+        exportedAt: string;
+        version: string;
+    }>;
+    /**
+     * Import permissions from exported data (admin only)
+     *
+     * @example
+     * ```typescript
+     * const result = await baasix.permissions.import(exportedData, {
+     *   overwrite: true
+     * });
+     * console.log('Imported:', result.imported, 'permissions');
+     * ```
+     */
+    import(data: {
+        permissions: Array<Partial<Permission>>;
+    }, options?: {
+        overwrite?: boolean;
+    }): Promise<{
+        imported: number;
+        skipped: number;
+        errors: Array<{
+            permission: Partial<Permission>;
+            error: string;
+        }>;
+    }>;
 }
 
 interface SettingsModuleConfig {
@@ -432,6 +469,55 @@ declare class SettingsModule {
      * ```
      */
     set<T>(key: string, value: T): Promise<Settings>;
+    /**
+     * Get settings by application URL (useful for multi-tenant apps)
+     *
+     * @example
+     * ```typescript
+     * const settings = await baasix.settings.getByAppUrl('https://myapp.example.com');
+     * ```
+     */
+    getByAppUrl(appUrl: string): Promise<Settings>;
+    /**
+     * Get email branding settings for the current tenant
+     *
+     * @example
+     * ```typescript
+     * const branding = await baasix.settings.getBranding();
+     * console.log(branding.logo, branding.primaryColor);
+     * ```
+     */
+    getBranding(): Promise<Record<string, unknown>>;
+    /**
+     * Test email configuration by sending a test email
+     *
+     * @example
+     * ```typescript
+     * await baasix.settings.testEmail('admin@example.com');
+     * ```
+     */
+    testEmail(to: string): Promise<{
+        success: boolean;
+        message?: string;
+    }>;
+    /**
+     * Reload settings cache (admin only)
+     *
+     * @example
+     * ```typescript
+     * await baasix.settings.reload();
+     * ```
+     */
+    reload(): Promise<void>;
+    /**
+     * Delete tenant settings (admin only, multi-tenant)
+     *
+     * @example
+     * ```typescript
+     * await baasix.settings.deleteTenant();
+     * ```
+     */
+    deleteTenant(): Promise<void>;
 }
 
 interface ReportsModuleConfig {
@@ -771,6 +857,163 @@ declare class WorkflowsModule {
      * ```
      */
     duplicate(id: string, overrides?: Partial<Omit<Workflow, "id" | "createdAt" | "updatedAt">>): Promise<Workflow>;
+    /**
+     * Execute a specific node in a workflow
+     *
+     * @example
+     * ```typescript
+     * const result = await baasix.workflows.executeNode(
+     *   'workflow-uuid',
+     *   'node-id',
+     *   { inputData: 'value' }
+     * );
+     * ```
+     */
+    executeNode(workflowId: string, nodeId: string, triggerData?: Record<string, unknown>): Promise<WorkflowExecution>;
+    /**
+     * Get execution logs for a specific execution
+     *
+     * @example
+     * ```typescript
+     * const logs = await baasix.workflows.getExecutionLogs(
+     *   'workflow-uuid',
+     *   'execution-uuid'
+     * );
+     * ```
+     */
+    getExecutionLogs(workflowId: string, executionId: string): Promise<Array<{
+        timestamp: string;
+        level: string;
+        message: string;
+        nodeId?: string;
+    }>>;
+    /**
+     * Get workflow statistics
+     *
+     * @example
+     * ```typescript
+     * const stats = await baasix.workflows.getStats('workflow-uuid');
+     * console.log(stats.totalExecutions, stats.successRate);
+     * ```
+     */
+    getStats(id: string): Promise<{
+        totalExecutions: number;
+        successCount: number;
+        failedCount: number;
+        successRate: number;
+        avgExecutionTime: number;
+    }>;
+    /**
+     * Validate a workflow definition
+     *
+     * @example
+     * ```typescript
+     * const result = await baasix.workflows.validate({
+     *   name: 'My Workflow',
+     *   nodes: [...],
+     *   edges: [...]
+     * });
+     * if (result.valid) {
+     *   console.log('Workflow is valid');
+     * } else {
+     *   console.log('Errors:', result.errors);
+     * }
+     * ```
+     */
+    validate(workflow: Partial<Workflow>): Promise<{
+        valid: boolean;
+        errors?: Array<{
+            path: string;
+            message: string;
+        }>;
+    }>;
+    /**
+     * Export a single workflow
+     *
+     * @example
+     * ```typescript
+     * const exported = await baasix.workflows.export('workflow-uuid');
+     * // Save to file or transfer
+     * ```
+     */
+    export(id: string): Promise<Workflow & {
+        exportedAt: string;
+        version: string;
+    }>;
+    /**
+     * Export multiple workflows
+     *
+     * @example
+     * ```typescript
+     * // Export all workflows
+     * const exported = await baasix.workflows.exportAll();
+     *
+     * // Export specific workflows
+     * const exported = await baasix.workflows.exportAll({
+     *   ids: ['workflow-1', 'workflow-2']
+     * });
+     * ```
+     */
+    exportAll(options?: {
+        ids?: string[];
+        includeInactive?: boolean;
+    }): Promise<{
+        workflows: Array<Workflow & {
+            exportedAt: string;
+        }>;
+        exportedAt: string;
+        version: string;
+    }>;
+    /**
+     * Preview workflow import without applying changes
+     *
+     * @example
+     * ```typescript
+     * const preview = await baasix.workflows.importPreview(file);
+     * console.log('Will import:', preview.workflows.length, 'workflows');
+     * console.log('Conflicts:', preview.conflicts);
+     * ```
+     */
+    importPreview(file: File | {
+        uri: string;
+        name: string;
+        type: string;
+    }): Promise<{
+        workflows: Array<{
+            name: string;
+            id?: string;
+            isNew: boolean;
+        }>;
+        conflicts: Array<{
+            name: string;
+            existingId: string;
+        }>;
+    }>;
+    /**
+     * Import workflows from a file
+     *
+     * @example
+     * ```typescript
+     * const result = await baasix.workflows.import(file, {
+     *   overwrite: true
+     * });
+     * console.log('Imported:', result.imported, 'workflows');
+     * ```
+     */
+    import(file: File | {
+        uri: string;
+        name: string;
+        type: string;
+    }, options?: {
+        overwrite?: boolean;
+    }): Promise<{
+        imported: number;
+        skipped: number;
+        errors: Array<{
+            name: string;
+            error: string;
+        }>;
+    }>;
 }
 
 interface SocketOptions {
@@ -835,6 +1078,22 @@ interface RoomUserEvent {
     socketId: string;
     timestamp: string;
 }
+interface RoomKickEvent {
+    room: string;
+    kickedBy: string | number;
+    timestamp: string;
+}
+interface RoomCreatorChangedEvent {
+    room: string;
+    newCreatorSocketId: string;
+    newCreatorUserId: string | number;
+    timestamp: string;
+}
+interface RoomMember {
+    socketId: string;
+    userId: string | number;
+    isCreator: boolean;
+}
 interface SubscriptionCallback<T = any> {
     (payload: SubscriptionPayload<T>): void;
 }
@@ -876,6 +1135,8 @@ declare class RealtimeModule {
     private workflowCallbacks;
     private roomCallbacks;
     private roomUserCallbacks;
+    private kickCallbacks;
+    private creatorChangedCallbacks;
     private connectionCallbacks;
     private reconnecting;
     private connectionPromise;
@@ -1029,6 +1290,52 @@ declare class RealtimeModule {
      * ```
      */
     leaveRoom(roomName: string): Promise<void>;
+    /**
+     * Get the list of users currently in a room.
+     * You must already be a member of the room to call this.
+     *
+     * @example
+     * ```typescript
+     * const members = await baasix.realtime.getRoomMembers('game:lobby');
+     * members.forEach(m => {
+     *   console.log(m.userId, m.isCreator ? '(owner)' : '');
+     * });
+     * ```
+     */
+    getRoomMembers(roomName: string): Promise<RoomMember[]>;
+    /**
+     * Kick a user from a custom room. Only the room creator may call this.
+     *
+     * @example
+     * ```typescript
+     * await baasix.realtime.kickFromRoom('game:lobby', 'user-id-123');
+     * ```
+     */
+    kickFromRoom(roomName: string, targetUserId: string | number): Promise<void>;
+    /**
+     * Listen for being kicked from a room.
+     * The callback fires when the current user is removed by the room creator.
+     * Room listeners are automatically cleaned up after the kick.
+     *
+     * @example
+     * ```typescript
+     * baasix.realtime.onKicked('game:lobby', ({ kickedBy }) => {
+     *   console.log(`You were kicked by user ${kickedBy}`);
+     * });
+     * ```
+     */
+    onKicked(roomName: string, callback: (data: RoomKickEvent) => void): () => void;
+    /**
+     * Listen for room ownership changes (e.g. when the creator leaves).
+     *
+     * @example
+     * ```typescript
+     * baasix.realtime.onRoomCreatorChanged('game:lobby', ({ newCreatorUserId }) => {
+     *   console.log(`New room owner: ${newCreatorUserId}`);
+     * });
+     * ```
+     */
+    onRoomCreatorChanged(roomName: string, callback: (data: RoomCreatorChangedEvent) => void): () => void;
     /**
      * Send a message to a room
      *

package/dist/index.d.ts

@@ -365,6 +365,43 @@ declare class PermissionsModule {
      * ```
      */
     reloadCache(): Promise<void>;
+    /**
+     * Export all permissions (admin only)
+     *
+     * @example
+     * ```typescript
+     * const exported = await baasix.permissions.export();
+     * // Save to file or transfer
+     * ```
+     */
+    export(): Promise<{
+        permissions: Permission[];
+        exportedAt: string;
+        version: string;
+    }>;
+    /**
+     * Import permissions from exported data (admin only)
+     *
+     * @example
+     * ```typescript
+     * const result = await baasix.permissions.import(exportedData, {
+     *   overwrite: true
+     * });
+     * console.log('Imported:', result.imported, 'permissions');
+     * ```
+     */
+    import(data: {
+        permissions: Array<Partial<Permission>>;
+    }, options?: {
+        overwrite?: boolean;
+    }): Promise<{
+        imported: number;
+        skipped: number;
+        errors: Array<{
+            permission: Partial<Permission>;
+            error: string;
+        }>;
+    }>;
 }
 
 interface SettingsModuleConfig {
@@ -432,6 +469,55 @@ declare class SettingsModule {
      * ```
      */
     set<T>(key: string, value: T): Promise<Settings>;
+    /**
+     * Get settings by application URL (useful for multi-tenant apps)
+     *
+     * @example
+     * ```typescript
+     * const settings = await baasix.settings.getByAppUrl('https://myapp.example.com');
+     * ```
+     */
+    getByAppUrl(appUrl: string): Promise<Settings>;
+    /**
+     * Get email branding settings for the current tenant
+     *
+     * @example
+     * ```typescript
+     * const branding = await baasix.settings.getBranding();
+     * console.log(branding.logo, branding.primaryColor);
+     * ```
+     */
+    getBranding(): Promise<Record<string, unknown>>;
+    /**
+     * Test email configuration by sending a test email
+     *
+     * @example
+     * ```typescript
+     * await baasix.settings.testEmail('admin@example.com');
+     * ```
+     */
+    testEmail(to: string): Promise<{
+        success: boolean;
+        message?: string;
+    }>;
+    /**
+     * Reload settings cache (admin only)
+     *
+     * @example
+     * ```typescript
+     * await baasix.settings.reload();
+     * ```
+     */
+    reload(): Promise<void>;
+    /**
+     * Delete tenant settings (admin only, multi-tenant)
+     *
+     * @example
+     * ```typescript
+     * await baasix.settings.deleteTenant();
+     * ```
+     */
+    deleteTenant(): Promise<void>;
 }
 
 interface ReportsModuleConfig {
@@ -771,6 +857,163 @@ declare class WorkflowsModule {
      * ```
      */
     duplicate(id: string, overrides?: Partial<Omit<Workflow, "id" | "createdAt" | "updatedAt">>): Promise<Workflow>;
+    /**
+     * Execute a specific node in a workflow
+     *
+     * @example
+     * ```typescript
+     * const result = await baasix.workflows.executeNode(
+     *   'workflow-uuid',
+     *   'node-id',
+     *   { inputData: 'value' }
+     * );
+     * ```
+     */
+    executeNode(workflowId: string, nodeId: string, triggerData?: Record<string, unknown>): Promise<WorkflowExecution>;
+    /**
+     * Get execution logs for a specific execution
+     *
+     * @example
+     * ```typescript
+     * const logs = await baasix.workflows.getExecutionLogs(
+     *   'workflow-uuid',
+     *   'execution-uuid'
+     * );
+     * ```
+     */
+    getExecutionLogs(workflowId: string, executionId: string): Promise<Array<{
+        timestamp: string;
+        level: string;
+        message: string;
+        nodeId?: string;
+    }>>;
+    /**
+     * Get workflow statistics
+     *
+     * @example
+     * ```typescript
+     * const stats = await baasix.workflows.getStats('workflow-uuid');
+     * console.log(stats.totalExecutions, stats.successRate);
+     * ```
+     */
+    getStats(id: string): Promise<{
+        totalExecutions: number;
+        successCount: number;
+        failedCount: number;
+        successRate: number;
+        avgExecutionTime: number;
+    }>;
+    /**
+     * Validate a workflow definition
+     *
+     * @example
+     * ```typescript
+     * const result = await baasix.workflows.validate({
+     *   name: 'My Workflow',
+     *   nodes: [...],
+     *   edges: [...]
+     * });
+     * if (result.valid) {
+     *   console.log('Workflow is valid');
+     * } else {
+     *   console.log('Errors:', result.errors);
+     * }
+     * ```
+     */
+    validate(workflow: Partial<Workflow>): Promise<{
+        valid: boolean;
+        errors?: Array<{
+            path: string;
+            message: string;
+        }>;
+    }>;
+    /**
+     * Export a single workflow
+     *
+     * @example
+     * ```typescript
+     * const exported = await baasix.workflows.export('workflow-uuid');
+     * // Save to file or transfer
+     * ```
+     */
+    export(id: string): Promise<Workflow & {
+        exportedAt: string;
+        version: string;
+    }>;
+    /**
+     * Export multiple workflows
+     *
+     * @example
+     * ```typescript
+     * // Export all workflows
+     * const exported = await baasix.workflows.exportAll();
+     *
+     * // Export specific workflows
+     * const exported = await baasix.workflows.exportAll({
+     *   ids: ['workflow-1', 'workflow-2']
+     * });
+     * ```
+     */
+    exportAll(options?: {
+        ids?: string[];
+        includeInactive?: boolean;
+    }): Promise<{
+        workflows: Array<Workflow & {
+            exportedAt: string;
+        }>;
+        exportedAt: string;
+        version: string;
+    }>;
+    /**
+     * Preview workflow import without applying changes
+     *
+     * @example
+     * ```typescript
+     * const preview = await baasix.workflows.importPreview(file);
+     * console.log('Will import:', preview.workflows.length, 'workflows');
+     * console.log('Conflicts:', preview.conflicts);
+     * ```
+     */
+    importPreview(file: File | {
+        uri: string;
+        name: string;
+        type: string;
+    }): Promise<{
+        workflows: Array<{
+            name: string;
+            id?: string;
+            isNew: boolean;
+        }>;
+        conflicts: Array<{
+            name: string;
+            existingId: string;
+        }>;
+    }>;
+    /**
+     * Import workflows from a file
+     *
+     * @example
+     * ```typescript
+     * const result = await baasix.workflows.import(file, {
+     *   overwrite: true
+     * });
+     * console.log('Imported:', result.imported, 'workflows');
+     * ```
+     */
+    import(file: File | {
+        uri: string;
+        name: string;
+        type: string;
+    }, options?: {
+        overwrite?: boolean;
+    }): Promise<{
+        imported: number;
+        skipped: number;
+        errors: Array<{
+            name: string;
+            error: string;
+        }>;
+    }>;
 }
 
 interface SocketOptions {
@@ -835,6 +1078,22 @@ interface RoomUserEvent {
     socketId: string;
     timestamp: string;
 }
+interface RoomKickEvent {
+    room: string;
+    kickedBy: string | number;
+    timestamp: string;
+}
+interface RoomCreatorChangedEvent {
+    room: string;
+    newCreatorSocketId: string;
+    newCreatorUserId: string | number;
+    timestamp: string;
+}
+interface RoomMember {
+    socketId: string;
+    userId: string | number;
+    isCreator: boolean;
+}
 interface SubscriptionCallback<T = any> {
     (payload: SubscriptionPayload<T>): void;
 }
@@ -876,6 +1135,8 @@ declare class RealtimeModule {
     private workflowCallbacks;
     private roomCallbacks;
     private roomUserCallbacks;
+    private kickCallbacks;
+    private creatorChangedCallbacks;
     private connectionCallbacks;
     private reconnecting;
     private connectionPromise;
@@ -1029,6 +1290,52 @@ declare class RealtimeModule {
      * ```
      */
     leaveRoom(roomName: string): Promise<void>;
+    /**
+     * Get the list of users currently in a room.
+     * You must already be a member of the room to call this.
+     *
+     * @example
+     * ```typescript
+     * const members = await baasix.realtime.getRoomMembers('game:lobby');
+     * members.forEach(m => {
+     *   console.log(m.userId, m.isCreator ? '(owner)' : '');
+     * });
+     * ```
+     */
+    getRoomMembers(roomName: string): Promise<RoomMember[]>;
+    /**
+     * Kick a user from a custom room. Only the room creator may call this.
+     *
+     * @example
+     * ```typescript
+     * await baasix.realtime.kickFromRoom('game:lobby', 'user-id-123');
+     * ```
+     */
+    kickFromRoom(roomName: string, targetUserId: string | number): Promise<void>;
+    /**
+     * Listen for being kicked from a room.
+     * The callback fires when the current user is removed by the room creator.
+     * Room listeners are automatically cleaned up after the kick.
+     *
+     * @example
+     * ```typescript
+     * baasix.realtime.onKicked('game:lobby', ({ kickedBy }) => {
+     *   console.log(`You were kicked by user ${kickedBy}`);
+     * });
+     * ```
+     */
+    onKicked(roomName: string, callback: (data: RoomKickEvent) => void): () => void;
+    /**
+     * Listen for room ownership changes (e.g. when the creator leaves).
+     *
+     * @example
+     * ```typescript
+     * baasix.realtime.onRoomCreatorChanged('game:lobby', ({ newCreatorUserId }) => {
+     *   console.log(`New room owner: ${newCreatorUserId}`);
+     * });
+     * ```
+     */
+    onRoomCreatorChanged(roomName: string, callback: (data: RoomCreatorChangedEvent) => void): () => void;
     /**
      * Send a message to a room
      *