@vandenberghinc/volt 1.1.5 → 1.1.7

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

@@ -1,5 +1,18 @@
 import { ChildProcess } from "child_process";
 import { MongoClient, Collection as MongoCollection } from 'mongodb';
+import { vlib } from "./vinc.js";
+interface BaseOptions {
+    options?: Record<string, any>;
+    commit_quorum?: any;
+    forced?: boolean;
+}
+type IndexOptions = (BaseOptions & {
+    key: string;
+    keys?: never;
+}) | (BaseOptions & {
+    key?: never;
+    keys: string[];
+});
 declare class Collection {
     static chunk_size: number;
     static constructor_scheme: {
@@ -47,21 +60,13 @@ declare class Collection {
     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);
+    constructor(name: string, collection: MongoCollection, ttl?: number | null, // ttl in msec
+    indexes?: IndexOptions[], 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>;
+    create_index({ key, keys, // following the IndexOptions "key" or "keys" must be defined in typescript but not in raw js.
+    options, commit_quorum, forced }: IndexOptions): Promise<string>;
     find(query: Record<string, any>): Promise<any>;
     exists(path: string | Record<string, any>): Promise<boolean>;
     load(path: string | Record<string, any>, opts?: {
@@ -101,16 +106,8 @@ declare class Collection {
 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>;
+    constructor(name: string, collection: MongoCollection, indexes?: IndexOptions[], ttl?: number | null);
+    create_index(args: IndexOptions): 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?: {
@@ -275,90 +272,66 @@ declare class Database {
             type: string[];
             default: {};
         };
-        _server: string;
+        _server: {
+            type: string[];
+        };
     };
     uri: string | null;
-    preview: boolean;
-    preview_ip_whitelist: string[];
     client_opts: Record<string, any> | null;
     config: Record<string, any>;
-    source: any;
+    source: vlib.Path | undefined;
     start_args: string[];
-    _collections: Array<{
+    _collections: {
         name: string;
         ttl?: number | null;
-        indexes?: Array<{
-            keys: string[] | string | Record<string, any>;
-            options?: Record<string, any>;
-            commit_quorum?: any;
-        }>;
-    }>;
-    _uid_collections: Array<{
+        indexes?: string[] | IndexOptions[];
+    }[];
+    _uid_collections: {
         name: string;
         ttl?: number | null;
-        indexes?: Array<{
-            keys: string[] | string | Record<string, any>;
-            options?: Record<string, any>;
-            commit_quorum?: any;
-        }>;
-    }>;
+        indexes?: string[] | IndexOptions[];
+    }[];
     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, }: {
+    _listed_cols: any;
+    constructor({ uri, source, config, start_args, client, collections, uid_collections, daemon, _server, }: {
         uri?: string | null;
         source?: string | null;
         config?: Record<string, any> | null;
         start_args?: string[];
         client?: Record<string, any> | null;
-        collections?: Array<{
+        collections?: {
             name: string;
             ttl?: number | null;
-            indexes?: Array<{
-                keys: string[] | string | Record<string, any>;
-                options?: Record<string, any>;
-                commit_quorum?: any;
-            }>;
-        }>;
-        uid_collections?: Array<{
+            indexes?: string[] | IndexOptions[];
+        }[];
+        uid_collections?: {
             name: string;
             ttl?: number | null;
-            indexes?: Array<{
-                keys: string[] | string | Record<string, any>;
-                options?: Record<string, any>;
-                commit_quorum?: any;
-            }>;
-        }>;
+            indexes?: string[] | IndexOptions[];
+        }[];
         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;
-        }>;
+        indexes?: IndexOptions[];
         ttl?: number | null;
-    } | string): Collection;
+    } | string): Promise<Collection>;
     create_uid_collection(info: {
         name: string;
-        indexes?: Array<{
-            keys: string[] | string | Record<string, any>;
-            options?: Record<string, any>;
-            commit_quorum?: any;
-        }>;
+        indexes?: IndexOptions[];
         ttl?: number | null;
-    } | string): UIDCollection;
+    } | string): Promise<UIDCollection>;
     get_collections(): Promise<string[]>;
 }
 export { Collection, UIDCollection, Database };

package/backend/dist/cjs/database.js

@@ -34,7 +34,7 @@ class Collection {
     static constructor_scheme = {
         name: "string",
         uid_based: "boolean",
-        ttl: { type: "number", default: null },
+        ttl: { type: "number", default: null }, // ttl in msec
         indexes: {
             type: "array",
             default: [],
@@ -43,7 +43,7 @@ class Collection {
                 scheme: {
                     key: { type: "string", required: (data) => data.key == null && data.keys == null },
                     keys: {
-                        type: ["string", "array"],
+                        type: ["array"],
                         required: (data) => data.key == null && data.keys == null, value_scheme: "string",
                         postprocess: (keys) => typeof keys === "string" ? [keys] : keys,
                     },
@@ -54,11 +54,6 @@ class Collection {
                 postprocess: (info) => {
                     if (typeof info === "string")
                         return { keys: [info] };
-                    if (typeof info === "object" && info.key) {
-                        info.keys = info.key;
-                        delete info.key;
-                        return info;
-                    }
                     return info;
                 },
             },
@@ -68,9 +63,10 @@ class Collection {
     col;
     name;
     uid_based;
-    ttl;
+    ttl; // ttl in msec
     ttl_enabled;
-    constructor(name, collection, ttl = null, indexes = [], uid_based = false) {
+    constructor(name, collection, ttl = null, // ttl in msec
+    indexes = [], uid_based = false) {
         // Verify scheme.
         ({ indexes, ttl } = _vinc_1.vlib.Scheme.verify({
             object: {
@@ -110,13 +106,8 @@ class Collection {
         }
         // Create indexes.
         if (Array.isArray(indexes) && indexes.length > 0) {
-            for (const index of indexes) {
-                this.create_index({
-                    keys: index.keys,
-                    options: index.options,
-                    commit_quorum: index.commit_quorum,
-                    forced: index.forced,
-                });
+            for (let item of indexes) {
+                this.create_index(item);
             }
         }
     }
@@ -231,23 +222,22 @@ class Collection {
             @name: commitQuorum
             @desc: The `commitQuorum` argument for the orignal mongodb `createIndex()` function.
      */
-    async create_index({ keys, options = null, commit_quorum = null, forced = false }) {
+    async create_index({ key = undefined, keys = undefined, // following the IndexOptions "key" or "keys" must be defined in typescript but not in raw js.
+    options = undefined, commit_quorum = undefined, forced = false }) {
+        // Create keys objs per input type.
         let keys_obj = {};
-        if (typeof keys === "string") {
+        if (key) {
             keys_obj = {};
-            keys_obj[keys] = 1;
+            keys_obj[key] = 1;
         }
-        else if (Array.isArray(keys)) {
+        else if (Array.isArray(keys) && keys.length > 0) {
             keys_obj = {};
             for (const key of keys) {
                 keys_obj[key] = 1;
             }
         }
-        else if (keys == null || typeof keys !== "object") {
-            _vinc_1.vlib.Scheme.throw_invalid_type("keys", keys, ["string", "string[]", "object"], true);
-        }
         else {
-            keys_obj = keys;
+            throw new Error("Define one of the following parameters: [key, keys].");
         }
         // Drop index.
         if (forced) {
@@ -780,8 +770,8 @@ class UIDCollection {
             @name: commitQuorum
             @desc: The `commitQuorum` argument for the orignal mongodb `createIndex()` function.
      */
-    async create_index({ keys, options = null, commit_quorum = null }) {
-        return this._col.create_index({ keys, options, commit_quorum });
+    async create_index(args) {
+        return this._col.create_index(args);
     }
     /*  @docs:
      *  @title: Find
@@ -1170,11 +1160,11 @@ class Database {
         preview: { type: "boolean", default: true },
         preview_ip_whitelist: { type: "array", default: [] },
         daemon: { type: ["object", "boolean"], default: {} },
-        _server: "object",
+        _server: { type: ["object", "undefined"] },
     };
     uri;
-    preview;
-    preview_ip_whitelist;
+    // preview: boolean;
+    // preview_ip_whitelist: string[];
     client_opts;
     config;
     source; // Using vlib.Path type
@@ -1187,9 +1177,14 @@ class Database {
     proc;
     daemon;
     db;
-    constructor({ uri = null, source = null, config = null, start_args = [], client = null, collections = [], uid_collections = [], preview = true, preview_ip_whitelist = [], daemon = {}, _server, }) {
+    // System.
+    _listed_cols;
+    constructor({ uri = null, source = null, config = null, start_args = [], client = null, collections = [], uid_collections = [], 
+    // preview = true,
+    // preview_ip_whitelist = [],
+    daemon = {}, _server = undefined, }) {
         // Checks.
-        if (_server.is_primary && uri == null) {
+        if (!_server || (_server.is_primary && uri == null)) {
             ({ uri, config, start_args, config, client } = _vinc_1.vlib.Scheme.verify({
                 object: arguments[0],
                 check_unknown: true,
@@ -1198,24 +1193,27 @@ class Database {
         }
         // Arguments.
         this.uri = uri;
-        this.preview = preview;
-        this.preview_ip_whitelist = preview_ip_whitelist;
+        // this.preview = preview;
+        // this.preview_ip_whitelist = preview_ip_whitelist;
         this.client_opts = client;
         this.config = config || {};
-        this.source = source != null ? new _vinc_1.vlib.Path(source) : _server.source.join(".db");
+        this.source = source != null ? new _vinc_1.vlib.Path(source) : _server?.source.join(".db");
         this.start_args = start_args;
-        this._collections = collections;
-        this._uid_collections = uid_collections;
+        this._collections = collections ?? [];
+        this._uid_collections = uid_collections ?? [];
         this.server = _server;
         // Attributes.
         this.client = null;
         this.collections = {};
         // Initialize the service daemon.
-        if (this.server.daemon && daemon !== false) {
+        if (this.server?.daemon && daemon !== false) {
             const log_source = this.server.source.join(".logs");
             if (!log_source.exists()) {
                 log_source.mkdir_sync();
             }
+            if (!this.server) {
+                throw new Error("Parameter 'Database._server' must be defined for this behaviour.");
+            }
             this.daemon = new _vinc_1.vlib.Daemon({
                 name: this.server.daemon.name + ".mongodb",
                 user: daemon.user || this.server.daemon.user,
@@ -1231,9 +1229,9 @@ class Database {
             });
         }
     }
-    // Database preview.
-    _initialize_db_preview() {
-        /*
+    /* Database preview.
+    _initialize_db_preview(): void {
+        
         if (this.preview && this.server.production === false) {
             this.server.endpoint(
 
@@ -1758,8 +1756,7 @@ class Database {
                 },
             )
         }
-        */
-    }
+    }*/
     // Connect.
     async connect() {
         try {
@@ -1779,7 +1776,7 @@ class Database {
         if (this.config.systemLog === undefined) {
             this.config.systemLog = {};
         }
-        this.config.systemLog.path = this.source.join("mongod.log").str();
+        this.config.systemLog.path = this.source?.join("mongod.log").str();
         if (this.config.systemLog.destination === undefined) {
             this.config.systemLog.destination = "file";
         }
@@ -1789,21 +1786,23 @@ class Database {
         if (this.config.systemLog.logRotate === undefined) {
             this.config.systemLog.logRotate = "reopen";
         }
-        if (this.config.systemLog.verbosity === undefined) {
+        if (this.config.systemLog.verbosity === undefined && this.server) {
             this.config.systemLog.verbosity = this.server.production ? 0 : 1;
         }
         if (this.config.storage === undefined) {
             this.config.storage = {};
         }
-        const db_path = this.source.join("db");
-        this.config.storage.dbPath = db_path.str();
-        if (!db_path.exists()) {
-            db_path.mkdir_sync();
-        }
-        if (this.config.processManagement === undefined) {
-            this.config.processManagement = {};
+        if (this.source) {
+            const db_path = this.source.join("db");
+            this.config.storage.dbPath = db_path.str();
+            if (!db_path.exists()) {
+                db_path.mkdir_sync();
+            }
+            if (this.config.processManagement === undefined) {
+                this.config.processManagement = {};
+            }
+            this.config.processManagement.pidFilePath = this.source.join("mongod.pid").str();
         }
-        this.config.processManagement.pidFilePath = this.source.join("mongod.pid").str();
         if (this.config.net === undefined) {
             this.config.net = {};
         }
@@ -1814,7 +1813,7 @@ class Database {
             this.config.net.bindIp = "127.0.0.1";
         }
         // Mode 2: Start database.
-        if (this.server.is_primary && this.uri == null) {
+        if (this.server?.is_primary && this.uri == null) {
             // Create the database.
             if (!this.source.exists()) {
                 this.source.mkdir_sync();
@@ -1844,7 +1843,7 @@ class Database {
             });
         }
         // Assign URI.
-        else if (!this.server.is_primary && this.uri == null) {
+        else if (this.server && !this.server.is_primary && this.uri == null) {
             this.uri = `mongodb://${this.config.net.bindIp}:${this.config.net.port}/main`;
         }
         // Initialize client.
@@ -1859,33 +1858,65 @@ class Database {
         }
         // Connect.
         await this.connect();
+        // Batch.
+        const multiprocessing = true;
+        const promises = [];
         // Create collections.
-        this._collections.forEach((info) => {
-            if (this[info.name] !== undefined) {
-                throw Error(`Unable to initialize database collection "${info.name}", this attribute name is already used.`);
-            }
-            if (Array.isArray(info.indexes)) {
-                for (const index of info.indexes) {
-                    if (index != null && typeof index === "object") {
-                        index.forced = true;
+        for (const info of this._collections) {
+            const promise = new Promise(resolve => {
+                if (this[info.name] !== undefined) {
+                    throw Error(`Unable to initialize database collection "${info.name}", this attribute name is reserved for a system value.`);
+                }
+                if (Array.isArray(info.indexes)) {
+                    for (let index = 0; index < info.indexes.length; index++) {
+                        let item = info.indexes[index];
+                        if (typeof item === "string") {
+                            info.indexes[index] = item = { keys: [item] };
+                        }
                     }
                 }
+                this.create_collection(info).then(data => {
+                    this[info.name] = data;
+                    resolve();
+                });
+            });
+            if (multiprocessing) {
+                promises.push(promise);
             }
-            this[info.name] = this.create_collection(info);
-        });
-        this._uid_collections.forEach((info) => {
-            if (this[info.name] !== undefined) {
-                throw Error(`Unable to initialize database collection "${info.name}", this attribute name is already used.`);
+            else {
+                await promise;
             }
-            if (Array.isArray(info.indexes)) {
-                for (const index of info.indexes) {
-                    if (index != null && typeof index === "object") {
-                        index.forced = true;
+        }
+        for (const info of this._uid_collections) {
+            const promise = new Promise(resolve => {
+                if (this[info.name] !== undefined) {
+                    throw Error(`Unable to initialize database collection "${info.name}", this attribute name is reserved for a system value.`);
+                }
+                if (Array.isArray(info.indexes)) {
+                    for (let index = 0; index < info.indexes.length; index++) {
+                        let item = info.indexes[index];
+                        if (typeof item === "string") {
+                            info.indexes[index] = item = {
+                                key: item,
+                            };
+                        }
                     }
                 }
+                this.create_uid_collection(info).then(data => {
+                    this[info.name] = data;
+                    resolve();
+                });
+            });
+            if (multiprocessing) {
+                promises.push(promise);
             }
-            this[info.name] = this.create_uid_collection(info);
-        });
+            else {
+                await promise;
+            }
+        }
+        if (multiprocessing) {
+            await Promise.all(promises);
+        }
     }
     // Close.
     async close() {
@@ -1896,7 +1927,7 @@ class Database {
      *  @title: Create Collection
      *  @description: Create a database collection.
      */
-    create_collection(info) {
+    async create_collection(info) {
         // Set name by single string argument.
         let name;
         let indexes = [];
@@ -1913,6 +1944,17 @@ class Database {
         if (name in this.collections) {
             throw Error(`Collection "${name}" is already initialized.`);
         }
+        // Logs.
+        logger_js_1.logger.log(1, log_source, `Initializing collection "${name}".`);
+        // Check if the collection exists
+        if (this._listed_cols == null) {
+            this._listed_cols = await this.db.listCollections().toArray();
+        }
+        if (!this._listed_cols.find(x => x.name === name)) {
+            logger_js_1.logger.log(0, log_source, `Creating collection "${name}".`);
+            await this.db.createCollection(name);
+        }
+        // Create collection.
         const col = new Collection(name, this.db.collection(name), ttl, indexes);
         this.collections[name] = col;
         return col;
@@ -1921,7 +1963,7 @@ class Database {
      *  @title: Create UID Based Collection
      *  @description: Create a UID based database collection.
      */
-    create_uid_collection(info) {
+    async create_uid_collection(info) {
         // Set name by single string argument.
         let name;
         let indexes = [];
@@ -1934,10 +1976,19 @@ class Database {
             indexes = info.indexes || [];
             ttl = info.ttl || null;
         }
-        // Check collection.
+        // Check duplicate collection.
         if (name in this.collections) {
             throw Error(`Collection "${name}" is already initialized.`);
         }
+        // Logs.
+        logger_js_1.logger.log(1, log_source, `Initializing uid collection "${name}".`);
+        // Check if the collection exists
+        const collections = await this.db.listCollections({ name: name }).toArray();
+        if (collections.length === 0) {
+            logger_js_1.logger.log(0, log_source, `Creating uid collection "${name}".`);
+            await this.db.createCollection(name);
+        }
+        // Collection.
         const col = new UIDCollection(name, this.db.collection(name), indexes, ttl);
         this.collections[name] = col;
         return col;

package/backend/dist/cjs/endpoint.d.ts

@@ -1,18 +1,17 @@
 import { View } from './view.js';
 import { RateLimitGroup } from "./rate_limit.js";
 import { Stream, AuthStream, Params } from "./stream.js";
+import type { Server } from "./server.js";
 type EndpointCallback = ((stream: Stream, params: Params) => any) | ((stream: AuthStream, params: Params) => any);
-export interface EndpointOptions {
+interface BaseEndpointOptions {
     method?: string;
     endpoint: string | RegExp;
     authenticated?: boolean;
     rate_limit?: string | RateLimitGroup | RateLimitGroup[] | null;
     params?: Record<string, any> | null;
     callback?: EndpointCallback;
-    view?: View | Record<string, any> | null;
     data?: any;
-    content_type?: string;
-    compress?: boolean;
+    compress?: "auto" | boolean;
     cache?: boolean | number;
     ip_whitelist?: string[] | null;
     sitemap?: boolean | null;
@@ -21,15 +20,25 @@ export interface EndpointOptions {
     _path?: string | null;
     _is_static?: boolean;
 }
+interface EndpointOptionsWithView extends Omit<BaseEndpointOptions, "content_type" | "view"> {
+    view: View | Record<string, any>;
+    content_type?: string;
+}
+interface EndpointOptionsWithoutView extends BaseEndpointOptions {
+    view?: null | undefined;
+    content_type: string;
+}
+export type EndpointOptions = EndpointOptionsWithView | EndpointOptionsWithoutView;
 declare class Endpoint {
     static rate_limits: Map<string, any>;
+    static compressed_content_types: string[];
     method: string;
     endpoint: string | RegExp;
     authenticated: boolean;
     params: Record<string, any> | null;
     callback?: EndpointCallback;
     data: any;
-    content_type: string;
+    content_type?: string;
     compress: boolean;
     cache: boolean | number;
     sitemap: boolean | null;
@@ -46,12 +55,17 @@ declare class Endpoint {
     raw_data?: any;
     content_length?: number;
     is_image_endpoint?: boolean;
-    constructor({ method, endpoint, authenticated, rate_limit, params, callback, view, data, content_type, compress, cache, ip_whitelist, sitemap, robots, _templates, // only used in loading static files.
-    _path, _is_static, }: EndpointOptions);
+    _initialized: boolean;
+    _server: any;
+    constructor({ method, endpoint, authenticated, rate_limit, params, callback, view, data, content_type, // = "text/plain",
+    compress, cache, ip_whitelist, sitemap, robots, _templates, // only used in loading static files.
+    _path, _is_static, _server, }: EndpointOptions & {
+        _server: Server;
+    });
     _load_data_by_path(server: any): this;
     _set_headers(stream: any): void;
     _refresh(server: any): Promise<void>;
-    _initialize(server: any): Promise<void>;
-    _serve(stream: any, status_code?: number): Promise<void>;
+    _dynamic_initialize(): Promise<void>;
+    _serve(stream: Stream, status_code?: number): Promise<void>;
 }
 export { Endpoint };