@njdamstra/appwrite-utils-cli 1.8.9

package/dist/adapters/DatabaseAdapter.d.ts

@@ -0,0 +1,233 @@
+/**
+ * DatabaseAdapter Interface - Unified API for Appwrite Database Operations
+ *
+ * This interface provides a unified way to interact with both legacy Appwrite
+ * (collections/documents) and new TablesDB (tables/rows) APIs. All internal
+ * code uses TablesDB-style method signatures for consistency.
+ */
+import type { Client } from "node-appwrite";
+import type { ApiMode } from "../utils/versionDetection.js";
+export interface CreateRowParams {
+    databaseId: string;
+    tableId: string;
+    id: string;
+    data: any;
+    permissions?: string[];
+}
+export interface UpdateRowParams {
+    databaseId: string;
+    tableId: string;
+    id: string;
+    data?: any;
+    permissions?: string[];
+}
+export interface ListRowsParams {
+    databaseId: string;
+    tableId: string;
+    queries?: any[];
+}
+export interface DeleteRowParams {
+    databaseId: string;
+    tableId: string;
+    id: string;
+}
+export interface CreateTableParams {
+    databaseId: string;
+    id: string;
+    name: string;
+    permissions?: string[];
+    documentSecurity?: boolean;
+    rowSecurity?: boolean;
+    enabled?: boolean;
+}
+export interface UpdateTableParams {
+    databaseId: string;
+    id: string;
+    name: string;
+    permissions?: string[];
+    documentSecurity?: boolean;
+    rowSecurity?: boolean;
+    enabled?: boolean;
+}
+export interface ListTablesParams {
+    databaseId: string;
+    queries?: any[];
+}
+export interface DeleteTableParams {
+    databaseId: string;
+    tableId: string;
+}
+export interface GetTableParams {
+    databaseId: string;
+    tableId: string;
+}
+export interface BulkCreateRowsParams {
+    databaseId: string;
+    tableId: string;
+    rows: any[];
+}
+export interface BulkUpsertRowsParams {
+    databaseId: string;
+    tableId: string;
+    rows: any[];
+}
+export interface BulkDeleteRowsParams {
+    databaseId: string;
+    tableId: string;
+    rowIds: string[];
+    batchSize?: number;
+}
+export interface CreateIndexParams {
+    databaseId: string;
+    tableId: string;
+    key: string;
+    type: string;
+    attributes: string[];
+    orders?: string[];
+}
+export interface ListIndexesParams {
+    databaseId: string;
+    tableId: string;
+    queries?: any[];
+}
+export interface DeleteIndexParams {
+    databaseId: string;
+    tableId: string;
+    key: string;
+}
+export interface CreateAttributeParams {
+    databaseId: string;
+    tableId: string;
+    key: string;
+    type: string;
+    size?: number;
+    required?: boolean;
+    default?: any;
+    array?: boolean;
+    encrypt?: boolean;
+    [key: string]: any;
+}
+export interface UpdateAttributeParams {
+    databaseId: string;
+    tableId: string;
+    key: string;
+    type?: string;
+    required?: boolean;
+    default?: any;
+    size?: number;
+    min?: number;
+    max?: number;
+    array?: boolean;
+    encrypt?: boolean;
+    elements?: string[];
+    relatedCollection?: string;
+    relationType?: string;
+    twoWay?: boolean;
+    twoWayKey?: string;
+    onDelete?: string;
+}
+export interface DeleteAttributeParams {
+    databaseId: string;
+    tableId: string;
+    key: string;
+}
+export interface ApiResponse<T = any> {
+    data?: T;
+    total?: number;
+    documents?: T[];
+    rows?: T[];
+    collections?: T[];
+    tables?: T[];
+    errors?: any[];
+}
+export interface AdapterMetadata {
+    apiMode: ApiMode;
+    terminology: {
+        container: 'collection' | 'table';
+        item: 'document' | 'row';
+        service: 'Databases' | 'TablesDB';
+    };
+    capabilities: {
+        bulkOperations: boolean;
+        advancedQueries: boolean;
+        realtime: boolean;
+        transactions?: boolean;
+    };
+}
+/**
+ * Main DatabaseAdapter interface - all implementations must support these methods
+ */
+export interface DatabaseAdapter {
+    listRows(params: ListRowsParams): Promise<ApiResponse>;
+    createRow(params: CreateRowParams): Promise<ApiResponse>;
+    updateRow(params: UpdateRowParams): Promise<ApiResponse>;
+    deleteRow(params: DeleteRowParams): Promise<ApiResponse>;
+    getRow(params: {
+        databaseId: string;
+        tableId: string;
+        id: string;
+    }): Promise<ApiResponse>;
+    listTables(params: ListTablesParams): Promise<ApiResponse>;
+    createTable(params: CreateTableParams): Promise<ApiResponse>;
+    updateTable(params: UpdateTableParams): Promise<ApiResponse>;
+    deleteTable(params: DeleteTableParams): Promise<ApiResponse>;
+    getTable(params: GetTableParams): Promise<ApiResponse>;
+    listIndexes(params: ListIndexesParams): Promise<ApiResponse>;
+    createIndex(params: CreateIndexParams): Promise<ApiResponse>;
+    deleteIndex(params: DeleteIndexParams): Promise<ApiResponse>;
+    createAttribute(params: CreateAttributeParams): Promise<ApiResponse>;
+    updateAttribute(params: UpdateAttributeParams): Promise<ApiResponse>;
+    deleteAttribute(params: DeleteAttributeParams): Promise<ApiResponse>;
+    bulkCreateRows?(params: BulkCreateRowsParams): Promise<ApiResponse>;
+    bulkUpsertRows?(params: BulkUpsertRowsParams): Promise<ApiResponse>;
+    bulkDeleteRows?(params: BulkDeleteRowsParams): Promise<ApiResponse>;
+    getMetadata(): AdapterMetadata;
+    supportsBulkOperations(): boolean;
+    getApiMode(): ApiMode;
+    getTerminology(): AdapterMetadata['terminology'];
+    getRawClient(): any;
+}
+/**
+ * Base adapter class with common functionality
+ */
+export declare abstract class BaseAdapter implements DatabaseAdapter {
+    protected client: Client;
+    protected apiMode: ApiMode;
+    constructor(client: Client, apiMode: ApiMode);
+    abstract listRows(params: ListRowsParams): Promise<ApiResponse>;
+    abstract createRow(params: CreateRowParams): Promise<ApiResponse>;
+    abstract updateRow(params: UpdateRowParams): Promise<ApiResponse>;
+    abstract deleteRow(params: DeleteRowParams): Promise<ApiResponse>;
+    abstract getRow(params: {
+        databaseId: string;
+        tableId: string;
+        id: string;
+    }): Promise<ApiResponse>;
+    abstract listTables(params: ListTablesParams): Promise<ApiResponse>;
+    abstract createTable(params: CreateTableParams): Promise<ApiResponse>;
+    abstract updateTable(params: UpdateTableParams): Promise<ApiResponse>;
+    abstract deleteTable(params: DeleteTableParams): Promise<ApiResponse>;
+    abstract getTable(params: GetTableParams): Promise<ApiResponse>;
+    abstract listIndexes(params: ListIndexesParams): Promise<ApiResponse>;
+    abstract createIndex(params: CreateIndexParams): Promise<ApiResponse>;
+    abstract deleteIndex(params: DeleteIndexParams): Promise<ApiResponse>;
+    abstract createAttribute(params: CreateAttributeParams): Promise<ApiResponse>;
+    abstract updateAttribute(params: UpdateAttributeParams): Promise<ApiResponse>;
+    abstract deleteAttribute(params: DeleteAttributeParams): Promise<ApiResponse>;
+    abstract getMetadata(): AdapterMetadata;
+    getApiMode(): ApiMode;
+    getRawClient(): any;
+    supportsBulkOperations(): boolean;
+    getTerminology(): AdapterMetadata['terminology'];
+}
+/**
+ * Error types for adapter operations
+ */
+export declare class AdapterError extends Error {
+    readonly code: string;
+    readonly originalError?: Error | undefined;
+    constructor(message: string, code: string, originalError?: Error | undefined);
+}
+export declare class UnsupportedOperationError extends AdapterError {
+    constructor(operation: string, apiMode: ApiMode);
+}

package/dist/adapters/DatabaseAdapter.js

@@ -0,0 +1,50 @@
+/**
+ * DatabaseAdapter Interface - Unified API for Appwrite Database Operations
+ *
+ * This interface provides a unified way to interact with both legacy Appwrite
+ * (collections/documents) and new TablesDB (tables/rows) APIs. All internal
+ * code uses TablesDB-style method signatures for consistency.
+ */
+/**
+ * Base adapter class with common functionality
+ */
+export class BaseAdapter {
+    client;
+    apiMode;
+    constructor(client, apiMode) {
+        this.client = client;
+        this.apiMode = apiMode;
+    }
+    // Common implementations
+    getApiMode() {
+        return this.apiMode;
+    }
+    getRawClient() {
+        return this.client;
+    }
+    supportsBulkOperations() {
+        return this.getMetadata().capabilities.bulkOperations;
+    }
+    getTerminology() {
+        return this.getMetadata().terminology;
+    }
+}
+/**
+ * Error types for adapter operations
+ */
+export class AdapterError extends Error {
+    code;
+    originalError;
+    constructor(message, code, originalError) {
+        super(message);
+        this.code = code;
+        this.originalError = originalError;
+        this.name = 'AdapterError';
+    }
+}
+export class UnsupportedOperationError extends AdapterError {
+    constructor(operation, apiMode) {
+        super(`Operation '${operation}' is not supported in ${apiMode} mode`, 'UNSUPPORTED_OPERATION');
+        this.name = 'UnsupportedOperationError';
+    }
+}

package/dist/adapters/LegacyAdapter.d.ts

@@ -0,0 +1,50 @@
+/**
+ * LegacyAdapter - Translation Layer for Legacy Appwrite API
+ *
+ * This adapter translates TablesDB-style calls (object notation) to legacy
+ * Appwrite Databases API calls (positional parameters). It ensures all internal
+ * code can use modern TablesDB patterns while maintaining compatibility with
+ * older Appwrite instances.
+ */
+import { Client } from "node-appwrite";
+import { BaseAdapter, type CreateRowParams, type UpdateRowParams, type ListRowsParams, type DeleteRowParams, type CreateTableParams, type UpdateTableParams, type ListTablesParams, type DeleteTableParams, type GetTableParams, type BulkCreateRowsParams, type BulkUpsertRowsParams, type BulkDeleteRowsParams, type CreateIndexParams, type ListIndexesParams, type DeleteIndexParams, type CreateAttributeParams, type UpdateAttributeParams, type DeleteAttributeParams, type ApiResponse, type AdapterMetadata } from './DatabaseAdapter.js';
+/**
+ * LegacyAdapter - Translates TablesDB calls to legacy Databases API
+ */
+export declare class LegacyAdapter extends BaseAdapter {
+    private databases;
+    constructor(client: Client);
+    listRows(params: ListRowsParams): Promise<ApiResponse>;
+    createRow(params: CreateRowParams): Promise<ApiResponse>;
+    updateRow(params: UpdateRowParams): Promise<ApiResponse>;
+    deleteRow(params: DeleteRowParams): Promise<ApiResponse>;
+    getRow(params: {
+        databaseId: string;
+        tableId: string;
+        id: string;
+    }): Promise<ApiResponse>;
+    listTables(params: ListTablesParams): Promise<ApiResponse>;
+    createTable(params: CreateTableParams): Promise<ApiResponse>;
+    updateTable(params: UpdateTableParams): Promise<ApiResponse>;
+    deleteTable(params: DeleteTableParams): Promise<ApiResponse>;
+    getTable(params: GetTableParams): Promise<ApiResponse>;
+    listIndexes(params: ListIndexesParams): Promise<ApiResponse>;
+    createIndex(params: CreateIndexParams): Promise<ApiResponse>;
+    deleteIndex(params: DeleteIndexParams): Promise<ApiResponse>;
+    createAttribute(params: CreateAttributeParams): Promise<ApiResponse>;
+    updateAttribute(params: UpdateAttributeParams): Promise<ApiResponse>;
+    deleteAttribute(params: DeleteAttributeParams): Promise<ApiResponse>;
+    bulkCreateRows(params: BulkCreateRowsParams): Promise<ApiResponse>;
+    bulkUpsertRows(params: BulkUpsertRowsParams): Promise<ApiResponse>;
+    bulkDeleteRows(params: BulkDeleteRowsParams): Promise<ApiResponse>;
+    getMetadata(): AdapterMetadata;
+    supportsBulkOperations(): boolean;
+    /**
+     * Check if endpoint supports bulk operations via HTTP (for cloud instances)
+     */
+    private supportsHttpBulkOperations;
+    /**
+     * Normalize response format to be consistent with TablesDB
+     */
+    private normalizeResponse;
+}