@vandenberghinc/volt 1.1.2

package/backend/dist/esm/database.d.ts

@@ -0,0 +1,364 @@
+import { ChildProcess } from "child_process";
+import { MongoClient, Collection as MongoCollection } from 'mongodb';
+declare class Collection {
+    static chunk_size: number;
+    static constructor_scheme: {
+        name: string;
+        uid_based: string;
+        ttl: {
+            type: string;
+            default: null;
+        };
+        indexes: {
+            type: string;
+            default: never[];
+            value_scheme: {
+                type: string[];
+                scheme: {
+                    key: {
+                        type: string;
+                        required: (data: any) => boolean;
+                    };
+                    keys: {
+                        type: string[];
+                        required: (data: any) => boolean;
+                        value_scheme: string;
+                        postprocess: (keys: any) => any;
+                    };
+                    options: {
+                        type: string;
+                        required: boolean;
+                    };
+                    commit_quorom: {
+                        type: string;
+                        required: boolean;
+                    };
+                    forced: {
+                        type: string;
+                        default: boolean;
+                    };
+                };
+                postprocess: (info: any) => any;
+            };
+        };
+    };
+    col: MongoCollection;
+    name: string;
+    uid_based: boolean;
+    ttl: number | null;
+    ttl_enabled: boolean;
+    constructor(name: string, collection: MongoCollection, ttl?: number | null, indexes?: Array<{
+        keys: string[] | string | Record<string, any>;
+        options?: Record<string, any>;
+        commit_quorum?: any;
+        forced?: boolean;
+    }>, uid_based?: boolean);
+    private _process_doc;
+    private _load_chunked;
+    private _save_chunked;
+    create_index({ keys, options, commit_quorum, forced }: {
+        keys: string[] | string | Record<string, any>;
+        options?: Record<string, any> | null;
+        commit_quorum?: any;
+        forced?: boolean;
+    }): Promise<string>;
+    find(query: Record<string, any>): Promise<any>;
+    exists(path: string | Record<string, any>): Promise<boolean>;
+    load(path: string | Record<string, any>, opts?: {
+        default?: any;
+        chunked?: boolean;
+        attributes?: string[];
+        projection?: Record<string, any>;
+    } | null): Promise<any>;
+    save(path: string | Record<string, any>, content: any, opts?: {
+        chunked?: boolean;
+        bulk?: boolean;
+        set?: boolean;
+    } | null): Promise<any>;
+    list(path: string | Record<string, any>, options?: {
+        process?: boolean;
+        projection?: Record<string, any>;
+    }): Promise<any[]>;
+    list_query(query?: Record<string, any>, options?: {
+        process?: boolean;
+        projection?: Record<string, any>;
+    }): Promise<any[]>;
+    list_all(query?: Record<string, any>, options?: {
+        process?: boolean;
+        projection?: Record<string, any>;
+    }): Promise<any[]>;
+    delete(path: string | Record<string, any>, opts?: {
+        chunked?: boolean;
+        bulk?: boolean;
+    } | null): Promise<any>;
+    delete_query(query?: Record<string, any>): Promise<any>;
+    delete_all(path: string | Record<string, any>): Promise<void>;
+    delete_collection(): Promise<void>;
+    clean<T>(doc: T): T | null;
+    /** Write bulk operations. */
+    bulk_operations(operations?: any[]): Promise<any>;
+}
+declare class UIDCollection {
+    private _col;
+    col: MongoCollection;
+    constructor(name: string, collection: MongoCollection, indexes?: Array<{
+        keys: string[] | string | Record<string, any>;
+        options?: Record<string, any>;
+        commit_quorum?: any;
+    }>, ttl?: number | null);
+    create_index({ keys, options, commit_quorum }: {
+        keys: string[] | string | Record<string, any>;
+        options?: Record<string, any> | null;
+        commit_quorum?: any;
+    }): Promise<string>;
+    find(uid?: string | null, query?: Record<string, any>): Promise<any>;
+    exists(uid: string, path: string | Record<string, any>): Promise<boolean>;
+    load(uid: string, path: string | Record<string, any>, opts?: {
+        default?: any;
+        chunked?: boolean;
+        attributes?: string[];
+        projection?: Record<string, any>;
+    } | null): Promise<any>;
+    save(uid: string, path: string | Record<string, any>, content: any, opts?: {
+        chunked?: boolean;
+        bulk?: boolean;
+        set?: boolean;
+    } | null): Promise<any>;
+    list(uid: string, path: string | Record<string, any>, options?: {
+        process?: boolean;
+        projection?: Record<string, any>;
+    }): Promise<any[]>;
+    list_query(query?: Record<string, any>, options?: {
+        process?: boolean;
+        projection?: Record<string, any>;
+    }): Promise<any[]>;
+    list_all(uid?: string | null, options?: {
+        process?: boolean;
+        projection?: Record<string, any>;
+    }): Promise<any[]>;
+    delete(uid: string, path: string | Record<string, any>, opts?: {
+        chunked?: boolean;
+        bulk?: boolean;
+    } | null): Promise<any>;
+    delete_query(query: Record<string, any>): Promise<any>;
+    delete_all(uid: string, path?: string | Record<string, any> | null): Promise<void>;
+    delete_collection(): Promise<void>;
+    clean<T>(doc: T): T | null;
+    /** Write bulk operations. */
+    bulk_operations(operations?: any[]): Promise<any>;
+}
+declare class Database {
+    static constructor_scheme: {
+        uri: {
+            type: string;
+            default: null;
+        };
+        source: {
+            type: string;
+            default: null;
+        };
+        config: {
+            type: string;
+            default: {};
+        };
+        start_args: {
+            type: string;
+            default: never[];
+        };
+        client: {
+            type: string;
+            default: {};
+        };
+        collections: {
+            type: string;
+            default: never[];
+            value_scheme: {
+                type: string[];
+                preprocess: (info: string | Record<string, any>) => Record<string, any>;
+                scheme: {
+                    name: string;
+                    ttl: {
+                        type: string;
+                        default: null;
+                    };
+                    indexes: {
+                        type: string;
+                        default: never[];
+                        value_scheme: {
+                            type: string[];
+                            scheme: {
+                                key: {
+                                    type: string;
+                                    required: (data: any) => boolean;
+                                };
+                                keys: {
+                                    type: string[];
+                                    required: (data: any) => boolean;
+                                    value_scheme: string;
+                                    postprocess: (keys: any) => any;
+                                };
+                                options: {
+                                    type: string;
+                                    required: boolean;
+                                };
+                                commit_quorom: {
+                                    type: string;
+                                    required: boolean;
+                                };
+                                forced: {
+                                    type: string;
+                                    default: boolean;
+                                };
+                            };
+                            postprocess: (info: any) => any;
+                        };
+                    };
+                };
+            };
+        };
+        uid_collections: {
+            type: string;
+            default: never[];
+            value_scheme: {
+                type: string[];
+                preprocess: (info: string | Record<string, any>) => Record<string, any>;
+                scheme: {
+                    name: string;
+                    ttl: {
+                        type: string;
+                        default: null;
+                    };
+                    indexes: {
+                        type: string;
+                        default: never[];
+                        value_scheme: {
+                            type: string[];
+                            scheme: {
+                                key: {
+                                    type: string;
+                                    required: (data: any) => boolean;
+                                };
+                                keys: {
+                                    type: string[];
+                                    required: (data: any) => boolean;
+                                    value_scheme: string;
+                                    postprocess: (keys: any) => any;
+                                };
+                                options: {
+                                    type: string;
+                                    required: boolean;
+                                };
+                                commit_quorom: {
+                                    type: string;
+                                    required: boolean;
+                                };
+                                forced: {
+                                    type: string;
+                                    default: boolean;
+                                };
+                            };
+                            postprocess: (info: any) => any;
+                        };
+                    };
+                };
+            };
+        };
+        preview: {
+            type: string;
+            default: boolean;
+        };
+        preview_ip_whitelist: {
+            type: string;
+            default: never[];
+        };
+        daemon: {
+            type: string[];
+            default: {};
+        };
+        _server: string;
+    };
+    uri: string | null;
+    preview: boolean;
+    preview_ip_whitelist: string[];
+    client_opts: Record<string, any> | null;
+    config: Record<string, any>;
+    source: any;
+    start_args: string[];
+    _collections: Array<{
+        name: string;
+        ttl?: number | null;
+        indexes?: Array<{
+            keys: string[] | string | Record<string, any>;
+            options?: Record<string, any>;
+            commit_quorum?: any;
+        }>;
+    }>;
+    _uid_collections: Array<{
+        name: string;
+        ttl?: number | null;
+        indexes?: Array<{
+            keys: string[] | string | Record<string, any>;
+            options?: Record<string, any>;
+            commit_quorum?: any;
+        }>;
+    }>;
+    server: any;
+    client: MongoClient | null;
+    collections: Record<string, Collection | UIDCollection>;
+    proc?: ChildProcess;
+    daemon?: any;
+    db?: any;
+    constructor({ uri, source, config, start_args, client, collections, uid_collections, preview, preview_ip_whitelist, daemon, _server, }: {
+        uri?: string | null;
+        source?: string | null;
+        config?: Record<string, any> | null;
+        start_args?: string[];
+        client?: Record<string, any> | null;
+        collections?: Array<{
+            name: string;
+            ttl?: number | null;
+            indexes?: Array<{
+                keys: string[] | string | Record<string, any>;
+                options?: Record<string, any>;
+                commit_quorum?: any;
+            }>;
+        }>;
+        uid_collections?: Array<{
+            name: string;
+            ttl?: number | null;
+            indexes?: Array<{
+                keys: string[] | string | Record<string, any>;
+                options?: Record<string, any>;
+                commit_quorum?: any;
+            }>;
+        }>;
+        preview?: boolean;
+        preview_ip_whitelist?: string[];
+        daemon?: Record<string, any> | boolean;
+        _server: any;
+    });
+    _initialize_db_preview(): void;
+    connect(): Promise<void>;
+    initialize(): Promise<void>;
+    close(): Promise<void>;
+    create_collection(info: {
+        name: string;
+        indexes?: Array<{
+            keys: string[] | string | Record<string, any>;
+            options?: Record<string, any>;
+            commit_quorum?: any;
+        }>;
+        ttl?: number | null;
+    } | string): Collection;
+    create_uid_collection(info: {
+        name: string;
+        indexes?: Array<{
+            keys: string[] | string | Record<string, any>;
+            options?: Record<string, any>;
+            commit_quorum?: any;
+        }>;
+        ttl?: number | null;
+    } | string): UIDCollection;
+    get_collections(): Promise<string[]>;
+}
+export { Collection, UIDCollection, Database };