nesoi 3.2.8 → 3.3.0

package/lib/engine/builder.js

@@ -0,0 +1,99 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Builder = void 0;
+const log_1 = require("./util/log");
+const message_builder_1 = require("../elements/entities/message/message.builder");
+const bucket_builder_1 = require("../elements/entities/bucket/bucket.builder");
+const resource_builder_1 = require("../elements/blocks/resource/resource.builder");
+const machine_builder_1 = require("../elements/blocks/machine/machine.builder");
+const job_builder_1 = require("../elements/blocks/job/job.builder");
+const constants_builder_1 = require("../elements/entities/constants/constants.builder");
+const controller_builder_1 = require("../elements/edge/controller/controller.builder");
+const externals_builder_1 = require("../elements/edge/externals/externals.builder");
+const error_1 = require("./data/error");
+const queue_builder_1 = require("../elements/blocks/queue/queue.builder");
+const topic_builder_1 = require("../elements/blocks/topic/topic.builder");
+class Builder {
+    // Build Nodes
+    /**
+     * Build a resolved builder node, then merge the
+     * resulting schema(s) to the module.
+     * This also merges the resulting inline nodes of building a node.
+     *
+     * @param node A resolved builder node
+     * @param tree A module tree
+     */
+    static buildNode(module, node, tree) {
+        log_1.Log.trace('builder', 'module', `Building ${module.name}::${(0, log_1.scopeTag)(node.builder.$b, node.builder.name)}`);
+        if (node.builder.$b === 'constants') {
+            module.schema.constants = constants_builder_1.ConstantsBuilder.build(node);
+        }
+        else if (node.builder.$b === 'externals') {
+            module.schema.externals = externals_builder_1.ExternalsBuilder.build(node, tree);
+        }
+        else if (node.builder.$b === 'bucket') {
+            module.schema.buckets[node.tag.name] = bucket_builder_1.BucketBuilder.build(node, tree);
+        }
+        else if (node.builder.$b === 'message') {
+            module.schema.messages[node.tag.name] = message_builder_1.MessageBuilder.build(node, tree, module.schema);
+        }
+        else if (node.builder.$b === 'job') {
+            const { schema, inlineMessages } = job_builder_1.JobBuilder.build(node, tree, module.schema);
+            module.schema.jobs[node.tag.name] = schema;
+            this.mergeInlineMessages(module, inlineMessages);
+        }
+        else if (node.builder.$b === 'resource') {
+            const { schema, inlineMessages, inlineJobs } = resource_builder_1.ResourceBuilder.build(node, tree, module.schema);
+            module.schema.resources[schema.name] = schema;
+            this.mergeInlineMessages(module, inlineMessages);
+            this.mergeInlineJobs(module, inlineJobs);
+        }
+        else if (node.builder.$b === 'machine') {
+            const { schema, inlineMessages, inlineJobs } = machine_builder_1.MachineBuilder.build(node, tree, module.schema);
+            module.schema.machines[schema.name] = schema;
+            this.mergeInlineMessages(module, inlineMessages);
+            this.mergeInlineJobs(module, inlineJobs);
+        }
+        else if (node.builder.$b === 'controller') {
+            module.schema.controllers[node.tag.name] = controller_builder_1.ControllerBuilder.build(node);
+        }
+        else if (node.builder.$b === 'queue') {
+            const { schema, inlineMessages } = queue_builder_1.QueueBuilder.build(node, tree, module.schema);
+            module.schema.queues[node.tag.name] = schema;
+            this.mergeInlineMessages(module, inlineMessages);
+        }
+        else if (node.builder.$b === 'topic') {
+            const { schema, inlineMessages } = topic_builder_1.TopicBuilder.build(node, tree, module.schema);
+            module.schema.topics[node.tag.name] = schema;
+            this.mergeInlineMessages(module, inlineMessages);
+        }
+        else {
+            throw error_1.NesoiError.Module.UnknownBuilderType(module, node.filepath.toString(), node.tag.name, node.builder.$b);
+        }
+    }
+    /**
+     * Merge inline message schemas into the module.
+     *
+     * @param node A resolved builder node
+     * @param schemas A dictionary of Message schemas by name
+     */
+    static mergeInlineMessages(module, schemas) {
+        for (const name in schemas) {
+            const $msg = schemas[name];
+            module.schema.messages[name] = $msg;
+        }
+    }
+    /**
+     * Merge inline job schemas into the module.
+     *
+     * @param node A resolved builder node
+     * @param schemas A dictionary of job schemas by name
+     */
+    static mergeInlineJobs(module, schemas) {
+        for (const name in schemas) {
+            const $job = schemas[name];
+            module.schema.jobs[name] = $job;
+        }
+    }
+}
+exports.Builder = Builder;

package/lib/engine/cli/cli.js

@@ -1,4 +1,5 @@
 "use strict";
+/* @nesoi:browser ignore-file */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -46,7 +47,7 @@ const daemon_1 = require("../daemon");
 const log_1 = require("../util/log");
 const cli_input_1 = require("./cli_input");
 const shell_1 = __importDefault(require("../util/shell"));
-const crypto_1 = require("crypto");
+const random_1 = require("../util/random");
 /**
  * @category Engine
  * @subcategory CLI
@@ -146,7 +147,7 @@ class CLI {
             ui_1.default.error(`Invalid job '${job}'. Expected "module::name"`);
             return;
         }
-        const tmpFile = 'job_input__' + (0, crypto_1.randomBytes)(8).toString('hex') + '.js';
+        const tmpFile = 'job_input__' + random_1.Random.bytes(8).toString('hex') + '.js';
         const tmpPath = path.join(process.cwd(), tmpFile);
         fs.writeFileSync(tmpPath, 'export const input = {\n  \n}');
         await this.daemon.trx(module).run(async (trx) => {

package/lib/engine/cli/ui.js

@@ -1,4 +1,5 @@
 "use strict";
+/* @nesoi:browser ignore-file */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);

package/lib/engine/daemon.d.ts

@@ -1,12 +1,13 @@
 import { $Module, $Space } from "../elements";
 import { ModuleName } from "../schema";
-import { AnyTrxEngine } from './transaction/trx_engine';
-import { AnyAppConfig } from './apps/app.config';
-import { AnyUsers, AuthnRequest } from './auth/authn';
+import { AnyTrxEngine, HeldTrxNode } from './transaction/trx_engine';
+import { AnyAppConfig } from './app/app.config';
+import { AnyUsers, AuthRequest } from './auth/authn';
 import { TrxNode } from './transaction/trx_node';
 import { TrxStatus } from './transaction/trx';
-import { AnyElementSchema, AnyModule } from './module';
-import { IService } from './apps/service';
+import { AnyModule } from './module';
+import { IService } from './app/service';
+import { Tag } from './dependency';
 /**
  * A background process running one or more modules,
  * which runs _Transactions_ for the available elements.
@@ -59,16 +60,6 @@ export declare abstract class Daemon<S extends $Space, Modules extends ModuleNam
      * @param services A dictionary of Service by name
      */
     reload(trxEngines: Record<Modules, AnyTrxEngine>, services: Record<string, any>): void;
-    /**
-     * Bind the controller of each module to this Daemon.
-     * This allows the registered `Controller Adapters` to run
-     * transactions on the daemon.
-     */
-    protected abstract getSchema(tag: {
-        module: keyof S['modules'];
-        type: string;
-        name: string;
-    }): Promise<AnyElementSchema>;
     /**
      * Return a `Daemon` property.
      * This is used to read private properties.
@@ -91,17 +82,21 @@ export declare abstract class Daemon<S extends $Space, Modules extends ModuleNam
      */
     static getModule<Module extends ModuleName<any>, D extends Daemon<any, Module>>(daemon: D, module: Module): import("./module").Module<any, any>;
     /**
-     * Return one module of the `Daemon` by name.
+     * Return the metadata of a bucket
      *
      * @param daemon A `Daemon` instance
      * @param module A module name
      * @returns The `Module` instance
      */
-    static getSchema<Module extends ModuleName<any>, D extends Daemon<any, Module>>(daemon: D, tag: {
-        module: Module;
-        type: string;
-        name: string;
-    }): Promise<AnyElementSchema>;
+    static getBucketMetadata<Module extends ModuleName<any>, D extends Daemon<any, Module>>(daemon: D, tag: Tag): import("./transaction/trx_engine").BucketMetadata;
+    /**
+     * Return the metadata of a bucket
+     *
+     * @param daemon A `Daemon` instance
+     * @param module A module name
+     * @returns The `Module` instance
+     */
+    static getBucketDrive<Module extends ModuleName<any>, D extends Daemon<any, Module>>(daemon: D, tag: Tag): import("../elements/entities/drive/drive_adapter").DriveAdapter | undefined;
     /**
      * Return all modules of the `Daemon`.
      *
@@ -117,7 +112,7 @@ export declare abstract class Daemon<S extends $Space, Modules extends ModuleNam
  *
  * @category Engine
  */
-export declare class DaemonTrx<S extends $Space, M extends $Module, Authn extends AnyUsers = {}> {
+export declare class DaemonTrx<S extends $Space, M extends $Module, AuthUsers extends AnyUsers = {}> {
     private trxEngine;
     /**
      * The authentication request which will be used to
@@ -129,17 +124,25 @@ export declare class DaemonTrx<S extends $Space, M extends $Module, Authn extend
      */
     constructor(trxEngine: AnyTrxEngine);
     /**
-     * Authenticate the transaction with the given credentials.
+     * Authenticate/authorize the transaction with the given credentials.
      * You can specify one or more credentials, so the transaction
      * is able to access elements with different authn providers.
      */
-    authn<Authn extends AuthnRequest<keyof S['authnUsers']>>(authn?: Authn): DaemonTrx<S, M, { [K in keyof Authn]: S["authnUsers"][K & keyof S["authnUsers"]]; }>;
+    auth<Auth extends AuthRequest<keyof S['authnUsers']>>(auth?: Auth): DaemonTrx<S, M, { [K in keyof Auth]: S["authnUsers"][K & keyof S["authnUsers"]]; }>;
     /**
      * Run a method inside the transaction.
      *
      * @param fn A function to execute inside the transaction
      * @returns A `TrxStatus` containing metadata about the transaction and the function response
      */
-    run<Output>(fn: (trx: TrxNode<S, M, Authn>) => Promise<Output>): Promise<TrxStatus<Output>>;
+    run<Output>(fn: (trx: TrxNode<S, M, AuthUsers>) => Promise<Output>, id?: string): Promise<TrxStatus<Output>>;
+    /**
+     * Run a method inside the transaction, and hold it until
+     * the external caller decides to commit.
+     *
+     * @param fn A function to execute inside the transaction
+     * @returns A `TrxStatus` containing metadata about the transaction and the function response
+     */
+    run_and_hold<Output>(fn: (trx: TrxNode<S, M, AuthUsers>) => Promise<Output>, id?: string): Promise<HeldTrxNode<Output>>;
 }
 export type AnyDaemon = Daemon<any, any>;

package/lib/engine/daemon.js

@@ -3,7 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DaemonTrx = exports.Daemon = void 0;
 const log_1 = require("./util/log");
 const error_1 = require("./data/error");
+/* @nesoi:browser ignore-start */
 const cli_1 = require("./cli/cli");
+/* @nesoi:browser ignore-end */
 /**
  * A background process running one or more modules,
  * which runs _Transactions_ for the available elements.
@@ -44,8 +46,13 @@ class Daemon {
      * Run the Nesoi CLI for this Daemon.
      */
     async cli(cmd) {
+        /* @nesoi:browser ignore-start */
         const cli = new cli_1.CLI(this, this.config?.cli);
         await cli.run(cmd);
+        /* @nesoi:browser ignore-end */
+        /* @nesoi:browser add
+            throw new Exception('CLI not supported on Browser');
+        */
     }
     /**
      * Bind the controller of each module to this Daemon.
@@ -114,14 +121,26 @@ class Daemon {
         return daemon.trxEngines[module].getModule();
     }
     /**
-     * Return one module of the `Daemon` by name.
+     * Return the metadata of a bucket
+     *
+     * @param daemon A `Daemon` instance
+     * @param module A module name
+     * @returns The `Module` instance
+     */
+    static getBucketMetadata(daemon, tag) {
+        const trxEngine = daemon.trxEngines[tag.module];
+        return trxEngine.getBucketMetadata(tag);
+    }
+    /**
+     * Return the metadata of a bucket
      *
      * @param daemon A `Daemon` instance
      * @param module A module name
      * @returns The `Module` instance
      */
-    static getSchema(daemon, tag) {
-        return daemon.getSchema(tag);
+    static getBucketDrive(daemon, tag) {
+        const trxEngine = daemon.trxEngines[tag.module];
+        return trxEngine.getBucketDrive(tag);
     }
     /**
      * Return all modules of the `Daemon`.
@@ -150,12 +169,12 @@ class DaemonTrx {
         this.trxEngine = trxEngine;
     }
     /**
-     * Authenticate the transaction with the given credentials.
+     * Authenticate/authorize the transaction with the given credentials.
      * You can specify one or more credentials, so the transaction
      * is able to access elements with different authn providers.
      */
-    authn(authn) {
-        this.authnRequest = authn;
+    auth(auth) {
+        this.authnRequest = auth;
         return this;
     }
     /**
@@ -164,8 +183,18 @@ class DaemonTrx {
      * @param fn A function to execute inside the transaction
      * @returns A `TrxStatus` containing metadata about the transaction and the function response
      */
-    run(fn) {
-        return this.trxEngine.trx(fn, this.authnRequest);
+    run(fn, id) {
+        return this.trxEngine.trx(fn, id, this.authnRequest);
+    }
+    /**
+     * Run a method inside the transaction, and hold it until
+     * the external caller decides to commit.
+     *
+     * @param fn A function to execute inside the transaction
+     * @returns A `TrxStatus` containing metadata about the transaction and the function response
+     */
+    run_and_hold(fn, id) {
+        return this.trxEngine.trx_hold(fn, id, this.authnRequest);
     }
 }
 exports.DaemonTrx = DaemonTrx;

package/lib/engine/data/error.d.ts

@@ -11,6 +11,27 @@ export declare namespace NesoiError {
         toString(): string;
     }
     namespace Builder {
+        function UnmetModuleDependency($: {
+            from: string;
+            dep: string;
+        }): BaseError;
+        function UnmetDependency($: {
+            from: string;
+            dep: string;
+        }): BaseError;
+        function UnmetDependencyEnum($: {
+            from: string;
+            dep: string;
+        }): BaseError;
+        function UnmetDependencyValue($: {
+            from: string;
+            dep: string;
+        }): BaseError;
+        function NotImportedDependency($: {
+            from: string;
+            dep: string;
+        }): BaseError;
+        function CircularDependency($: {}): BaseError;
         namespace Job {
             function NoMethod($: {
                 job: string;
@@ -35,6 +56,10 @@ export declare namespace NesoiError {
             function CustomInputRequiresPrepare(resource: string): BaseError;
         }
     }
+    namespace Space {
+        function DirectoryDoesntExists(dir: string): BaseError;
+        function NoModulesFolder(): BaseError;
+    }
     namespace App {
         function ModuleNotFound(module: string): BaseError;
     }
@@ -50,15 +75,17 @@ export declare namespace NesoiError {
         function InlineMessageNotFoundOnMerge(msg: string): BaseError;
         function InlineJobNotFoundOnMerge(job: string): BaseError;
     }
-    namespace Authn {
+    namespace Auth {
         function NoProvidersRegisteredForModule(module: string): BaseError;
         function NoProviderRegisteredForModule(module: string, provider: string): BaseError;
-        function NoUsersAuthenticatedForTrxNode(globalId: string): BaseError;
     }
     namespace Trx {
+        function DaemonNotFound(module: string): BaseError;
         function ModuleNotFound(module: string): BaseError;
         function NodeNotFound(node: string, trx: string): BaseError;
-        function NotAuthenticated($: {}): BaseError;
+        function Unauthorized($: {
+            providers: string[];
+        }): BaseError;
     }
     namespace Bucket {
         function InvalidId($: {
@@ -124,6 +151,13 @@ export declare namespace NesoiError {
                 index: (string | number)[];
             }): BaseError;
         }
+        namespace Model {
+            function InvalidEnum($: {
+                bucket: string;
+                value: string;
+                options: string[];
+            }): BaseError;
+        }
         namespace Drive {
             function NoAdapter($: {
                 bucket: string;

package/lib/engine/data/error.js

@@ -25,6 +25,30 @@ var NesoiError;
     })(Status || (Status = {}));
     let Builder;
     (function (Builder) {
+        function UnmetModuleDependency($) {
+            return new BaseError('Builder.UnmetModuleDependency', `Unment module dependency '${$.dep}' while building '${$.from}'.`, Status.INTERNAL_ERROR, $);
+        }
+        Builder.UnmetModuleDependency = UnmetModuleDependency;
+        function UnmetDependency($) {
+            return new BaseError('Builder.UnmetDependency', `Unment dependency '${$.dep}' while building '${$.from}'.`, Status.INTERNAL_ERROR, $);
+        }
+        Builder.UnmetDependency = UnmetDependency;
+        function UnmetDependencyEnum($) {
+            return new BaseError('Builder.UnmetDependencyEnum', `Unment dependency enum '${$.dep}' while building '${$.from}'.`, Status.INTERNAL_ERROR, $);
+        }
+        Builder.UnmetDependencyEnum = UnmetDependencyEnum;
+        function UnmetDependencyValue($) {
+            return new BaseError('Builder.UnmetDependencyValue', `Unment dependency value '${$.dep}' while building '${$.from}'.`, Status.INTERNAL_ERROR, $);
+        }
+        Builder.UnmetDependencyValue = UnmetDependencyValue;
+        function NotImportedDependency($) {
+            return new BaseError('Builder.NotImportedDependency', `Dependency '${$.dep}' must be included on '${$.from}' externals.`, Status.INTERNAL_ERROR, $);
+        }
+        Builder.NotImportedDependency = NotImportedDependency;
+        function CircularDependency($) {
+            return new BaseError('Builder.CircularDependency', 'Circular dependency found while building.', Status.INTERNAL_ERROR, $);
+        }
+        Builder.CircularDependency = CircularDependency;
         let Job;
         (function (Job) {
             function NoMethod($) {
@@ -78,6 +102,17 @@ var NesoiError;
             Resource.CustomInputRequiresPrepare = CustomInputRequiresPrepare;
         })(Resource = Builder.Resource || (Builder.Resource = {}));
     })(Builder = NesoiError.Builder || (NesoiError.Builder = {}));
+    let Space;
+    (function (Space) {
+        function DirectoryDoesntExists(dir) {
+            return new BaseError('Space.DirectoryDoesntExists', `Directory '${module}' not found on space`, Status.INTERNAL_ERROR);
+        }
+        Space.DirectoryDoesntExists = DirectoryDoesntExists;
+        function NoModulesFolder() {
+            return new BaseError('Space.NoModulesFolder', 'No modules folder found on space root', Status.INTERNAL_ERROR);
+        }
+        Space.NoModulesFolder = NoModulesFolder;
+    })(Space = NesoiError.Space || (NesoiError.Space = {}));
     let App;
     (function (App) {
         function ModuleNotFound(module) {
@@ -128,35 +163,35 @@ var NesoiError;
         }
         Module.InlineJobNotFoundOnMerge = InlineJobNotFoundOnMerge;
     })(Module = NesoiError.Module || (NesoiError.Module = {}));
-    let Authn;
-    (function (Authn) {
+    let Auth;
+    (function (Auth) {
         function NoProvidersRegisteredForModule(module) {
-            return new BaseError('Authn.NoProvidersRegisteredForModule', `No authentication providers registered for module ${module}`, Status.NOT_FOUND);
+            return new BaseError('Auth.NoProvidersRegisteredForModule', `No authentication providers registered for module ${module}`, Status.NOT_FOUND);
         }
-        Authn.NoProvidersRegisteredForModule = NoProvidersRegisteredForModule;
+        Auth.NoProvidersRegisteredForModule = NoProvidersRegisteredForModule;
         function NoProviderRegisteredForModule(module, provider) {
-            return new BaseError('Authn.NoProviderRegisteredForModule', `No authentication provider named ${provider} registered for module ${module}`, Status.NOT_FOUND);
-        }
-        Authn.NoProviderRegisteredForModule = NoProviderRegisteredForModule;
-        function NoUsersAuthenticatedForTrxNode(globalId) {
-            return new BaseError('Authn.NoUsersAuthenticatedForTrxNode', `No users authenticated for trx node ${globalId}`, Status.NOT_FOUND);
+            return new BaseError('Auth.NoProviderRegisteredForModule', `No authentication provider named ${provider} registered for module ${module}`, Status.NOT_FOUND);
         }
-        Authn.NoUsersAuthenticatedForTrxNode = NoUsersAuthenticatedForTrxNode;
-    })(Authn = NesoiError.Authn || (NesoiError.Authn = {}));
+        Auth.NoProviderRegisteredForModule = NoProviderRegisteredForModule;
+    })(Auth = NesoiError.Auth || (NesoiError.Auth = {}));
     let Trx;
     (function (Trx) {
+        function DaemonNotFound(module) {
+            return new BaseError('Trx.DaemonNotFound', `Daemon not found for module ${module}`, Status.INTERNAL_ERROR);
+        }
+        Trx.DaemonNotFound = DaemonNotFound;
         function ModuleNotFound(module) {
-            return new BaseError('Trx.ModuleNotFound', `Module ${module} not found on app`, Status.NOT_FOUND);
+            return new BaseError('Trx.ModuleNotFound', `Module ${module} not found on app`, Status.INTERNAL_ERROR);
         }
         Trx.ModuleNotFound = ModuleNotFound;
         function NodeNotFound(node, trx) {
-            return new BaseError('Trx.NodeNotFoundOnTrx', `Node ${node} not found on transaction ${trx}`, Status.NOT_FOUND);
+            return new BaseError('Trx.NodeNotFoundOnTrx', `Node ${node} not found on transaction ${trx}`, Status.INTERNAL_ERROR);
         }
         Trx.NodeNotFound = NodeNotFound;
-        function NotAuthenticated($) {
-            return new BaseError('Trx.NotAuthenticated', 'Unauthorized', Status.UNAUTHORIZED, $);
+        function Unauthorized($) {
+            return new BaseError('Trx.Unauthorized', `Transaction not authenticated/authorized. Providers: ${$.providers}`, Status.UNAUTHORIZED, $);
         }
-        Trx.NotAuthenticated = NotAuthenticated;
+        Trx.Unauthorized = Unauthorized;
     })(Trx = NesoiError.Trx || (NesoiError.Trx = {}));
     /*
         Elements / Entities
@@ -252,6 +287,13 @@ var NesoiError;
             }
             Fieldpath.InvalidIndexLength = InvalidIndexLength;
         })(Fieldpath = Bucket.Fieldpath || (Bucket.Fieldpath = {}));
+        let Model;
+        (function (Model) {
+            function InvalidEnum($) {
+                return new BaseError('Bucket.Model.InvalidEnum', `Value '${$.value}' for bucket '${$.bucket}' doesn't match the options: ${$.options}.`, Status.BAD_REQUEST, $);
+            }
+            Model.InvalidEnum = InvalidEnum;
+        })(Model = Bucket.Model || (Bucket.Model = {}));
         let Drive;
         (function (Drive) {
             function NoAdapter($) {

package/lib/engine/data/file.d.ts

@@ -12,6 +12,7 @@ export declare class LocalNesoiFile {
     static delete(file: NesoiFile): void;
     static move(file: NesoiFile, to: string): void;
     static read(file: NesoiFile): string;
+    static new(filepath: string, content: string, overrides?: Partial<NesoiFile>): NesoiFile;
 }
 /**
  * @category Engine

package/lib/engine/data/file.js

@@ -50,6 +50,10 @@ class LocalNesoiFile {
     static read(file) {
         return fs_1.default.readFileSync(file.filepath).toString();
     }
+    static new(filepath, content, overrides) {
+        fs_1.default.writeFileSync(filepath, content);
+        return this.from(filepath, overrides);
+    }
 }
 exports.LocalNesoiFile = LocalNesoiFile;
 /**