@webda/core 4.0.0-beta.1 → 4.0.0-beta.3

package/lib/configurations/fileconfiguration.service.d.ts

@@ -0,0 +1,30 @@
+import { ConfigurationService, ConfigurationServiceParameters } from "./configuration.service.js";
+/**
+ * Allow for dynamic configuration from a file
+ * @WebdaModda Webda/FileConfiguration
+ */
+export declare class FileConfigurationService<T extends ConfigurationServiceParameters = ConfigurationServiceParameters> extends ConfigurationService<T> {
+    sourcePaths: Record<string, string>;
+    /**
+     * Resolve the file path for a given configuration source id, creating from defaults if missing
+     * @param id - the identifier
+     * @returns the result string
+     */
+    getFilePath(id: string): string;
+    /**
+     * Watch the configuration file for changes and trigger the callback when modified
+     * @param id - the identifier
+     * @param callback - the callback function
+     * @param defaultValue - the default value
+     * @returns the result
+     */
+    canTriggerConfiguration(id: string, callback: () => void, defaultValue?: any): boolean;
+    /**
+     * Load the JSON from source defined file
+     * @override
+     */
+    getConfiguration(id: string): Promise<{
+        [key: string]: any;
+    }>;
+}
+//# sourceMappingURL=fileconfiguration.service.d.ts.map

package/lib/configurations/fileconfiguration.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fileconfiguration.service.d.ts","sourceRoot":"","sources":["../../src/configurations/fileconfiguration.service.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,oBAAoB,EAAE,8BAA8B,EAAE,MAAM,4BAA4B,CAAC;AAGlG;;;GAGG;AACH,qBAAa,wBAAwB,CACnC,CAAC,SAAS,8BAA8B,GAAG,8BAA8B,CACzE,SAAQ,oBAAoB,CAAC,CAAC,CAAC;IAC/B,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAM;IAEzC;;;;OAIG;IACH,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CA0B9B;IAED;;;;;;OAMG;IACH,uBAAuB,CAAC,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,IAAI,EAAE,YAAY,CAAC,EAAE,GAAG,GAAG,OAAO,CAIrF;IAED;;;OAGG;IACH,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC,CAG5D;CACF"}

package/lib/configurations/fileconfiguration.service.js

@@ -0,0 +1,65 @@
+import { existsSync, watchFile } from "fs";
+import * as WebdaError from "../errors/errors.js";
+import { FileUtils } from "@webda/utils";
+import { ConfigurationService } from "./configuration.service.js";
+import { useApplication } from "../application/hooks.js";
+/**
+ * Allow for dynamic configuration from a file
+ * @WebdaModda Webda/FileConfiguration
+ */
+export class FileConfigurationService extends ConfigurationService {
+    sourcePaths = {};
+    /**
+     * Resolve the file path for a given configuration source id, creating from defaults if missing
+     * @param id - the identifier
+     * @returns the result string
+     */
+    getFilePath(id) {
+        // Allow .jsonc, .yaml, .yml, .json
+        if (/\.(jsonc?|ya?ml)$/.test(id)) {
+            this.sourcePaths[id] = useApplication().getPath(id);
+        }
+        else {
+            try {
+                this.sourcePaths[id] = FileUtils.getConfigurationFile(useApplication().getPath(id));
+                this.log("DEBUG", `Using configuration file ${this.sourcePaths[id]}`);
+            }
+            catch (error) {
+                // Default to yaml in case we create based on default value
+                this.sourcePaths[id] = useApplication().getPath(id + ".yaml");
+                this.log("DEBUG", `Using configuration file ${this.sourcePaths[id]} (defaulted to .yaml extension)`);
+            }
+        }
+        if (!existsSync(this.sourcePaths[id])) {
+            if (!this.parameters.default) {
+                throw new WebdaError.CodeError("FILE_CONFIGURATION_SOURCE_MISSING", "Configuration file not found: " + this.sourcePaths[id]);
+            }
+            else {
+                this.log("DEBUG", `Setting default value for file ${this.sourcePaths[id]}`);
+                FileUtils.save(this.parameters.default, this.sourcePaths[id]);
+            }
+        }
+        return this.sourcePaths[id];
+    }
+    /**
+     * Watch the configuration file for changes and trigger the callback when modified
+     * @param id - the identifier
+     * @param callback - the callback function
+     * @param defaultValue - the default value
+     * @returns the result
+     */
+    canTriggerConfiguration(id, callback, defaultValue) {
+        this.sourcePaths[id] ??= this.getFilePath(id);
+        watchFile(this.sourcePaths[id], callback);
+        return true;
+    }
+    /**
+     * Load the JSON from source defined file
+     * @override
+     */
+    getConfiguration(id) {
+        this.sourcePaths[id] ??= this.getFilePath(id);
+        return FileUtils.load(this.sourcePaths[id]);
+    }
+}
+//# sourceMappingURL=fileconfiguration.service.js.map

package/lib/configurations/fileconfiguration.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fileconfiguration.service.js","sourceRoot":"","sources":["../../src/configurations/fileconfiguration.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,IAAI,CAAC;AAC3C,OAAO,KAAK,UAAU,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,oBAAoB,EAAkC,MAAM,4BAA4B,CAAC;AAClG,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAEzD;;;GAGG;AACH,MAAM,OAAO,wBAEX,SAAQ,oBAAuB;IAC/B,WAAW,GAA2B,EAAE,CAAC;IAEzC;;;;OAIG;IACH,WAAW,CAAC,EAAU;QACpB,mCAAmC;QACnC,IAAI,mBAAmB,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;YACjC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,GAAG,cAAc,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACtD,CAAC;aAAM,CAAC;YACN,IAAI,CAAC;gBACH,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,oBAAoB,CAAC,cAAc,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;gBACpF,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,4BAA4B,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;YACxE,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,2DAA2D;gBAC3D,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,GAAG,cAAc,EAAE,CAAC,OAAO,CAAC,EAAE,GAAG,OAAO,CAAC,CAAC;gBAC9D,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,4BAA4B,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,iCAAiC,CAAC,CAAC;YACvG,CAAC;QACH,CAAC;QACD,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;YACtC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;gBAC7B,MAAM,IAAI,UAAU,CAAC,SAAS,CAC5B,mCAAmC,EACnC,gCAAgC,GAAG,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CACxD,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,kCAAkC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;gBAC5E,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC;YAChE,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;;OAMG;IACH,uBAAuB,CAAC,EAAU,EAAE,QAAoB,EAAE,YAAkB;QAC1E,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,KAAK,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QAC9C,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;QAC1C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,gBAAgB,CAAC,EAAU;QACzB,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,KAAK,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QAC9C,OAAO,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC;IAC9C,CAAC;CACF"}

package/lib/configurations/kubernetesconfiguration.service.d.ts

@@ -0,0 +1,43 @@
+import { ConfigurationService, ConfigurationServiceParameters } from "./configuration.service.js";
+/**
+ * Parameters for KubernetesConfigurationService
+ * Throw error if default is set
+ */
+export declare class KubernetesConfigurationParameters extends ConfigurationServiceParameters {
+    /**
+     * Load parameters, rejecting any default configuration since Kubernetes sources are required
+     * @param params - the service parameters
+     * @returns the result
+     */
+    load(params: any): this;
+}
+/**
+ * Allow for dynamic configuration from ConfigMap or Secrets
+ *
+ * Read a ConfigMap from Kubernetes and auto-update
+ * @WebdaModda
+ */
+export declare class KubernetesConfigurationService<T extends KubernetesConfigurationParameters = KubernetesConfigurationParameters> extends ConfigurationService<T> {
+    sourcePaths: Record<string, string>;
+    /**
+     * Resolve the Kubernetes-mounted file path for a configuration source
+     * @param id - the identifier
+     * @returns the result string
+     */
+    getFilePath(id: string): string;
+    /**
+     * Check if the configuration can be triggered
+     * @param id - the identifier
+     * @param callback - the callback function
+     * @returns true if the condition is met
+     */
+    canTriggerConfiguration(id: string, callback: () => void): boolean;
+    /**
+     * Load configuration from a ConfigMap or a Secret
+     * @override
+     */
+    getConfiguration(id: string): Promise<{
+        [key: string]: any;
+    }>;
+}
+//# sourceMappingURL=kubernetesconfiguration.service.d.ts.map

package/lib/configurations/kubernetesconfiguration.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"kubernetesconfiguration.service.d.ts","sourceRoot":"","sources":["../../src/configurations/kubernetesconfiguration.service.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,oBAAoB,EAAE,8BAA8B,EAAE,MAAM,4BAA4B,CAAC;AAGlG;;;GAGG;AACH,qBAAa,iCAAkC,SAAQ,8BAA8B;IACnF;;;;OAIG;IACH,IAAI,CAAC,MAAM,EAAE,GAAG,QAcf;CACF;AACD;;;;;GAKG;AACH,qBAAa,8BAA8B,CAEzC,CAAC,SAAS,iCAAiC,GAAG,iCAAiC,CAC/E,SAAQ,oBAAoB,CAAC,CAAC,CAAC;IAC/B,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAM;IAEzC;;;;OAIG;IACH,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAS9B;IAED;;;;;OAKG;IACH,uBAAuB,CAAC,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,OAAO,CAejE;IAED;;;OAGG;IACG,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC,CAalE;CACF"}

package/lib/configurations/kubernetesconfiguration.service.js

@@ -0,0 +1,83 @@
+import * as fs from "fs";
+import * as path from "path";
+import * as WebdaError from "../errors/errors.js";
+import { FileUtils } from "@webda/utils";
+import { ConfigurationService, ConfigurationServiceParameters } from "./configuration.service.js";
+import { useApplication } from "../application/hooks.js";
+/**
+ * Parameters for KubernetesConfigurationService
+ * Throw error if default is set
+ */
+export class KubernetesConfigurationParameters extends ConfigurationServiceParameters {
+    /**
+     * Load parameters, rejecting any default configuration since Kubernetes sources are required
+     * @param params - the service parameters
+     * @returns the result
+     */
+    load(params) {
+        super.load(params);
+        if (Object.keys(params.default?.services || {}).length ||
+            Object.keys(params.default?.application || {}).length ||
+            Object.keys(params.default?.parameters || {}).length) {
+            throw new WebdaError.CodeError("KUBE_CONFIGURATION_NO_DEFAULT", `KubernetesConfigurationService does not support default configuration ${params.default}`);
+        }
+        console.log(this.source, this.sources);
+        return this;
+    }
+}
+/**
+ * Allow for dynamic configuration from ConfigMap or Secrets
+ *
+ * Read a ConfigMap from Kubernetes and auto-update
+ * @WebdaModda
+ */
+export class KubernetesConfigurationService extends ConfigurationService {
+    sourcePaths = {};
+    /**
+     * Resolve the Kubernetes-mounted file path for a configuration source
+     * @param id - the identifier
+     * @returns the result string
+     */
+    getFilePath(id) {
+        this.sourcePaths[id] ??= useApplication().getPath(id);
+        if (!fs.existsSync(this.sourcePaths[id])) {
+            throw new WebdaError.CodeError("KUBE_CONFIGURATION_SOURCE_MISSING", `Kubernetes configuration source not found: ${this.sourcePaths[id]}`);
+        }
+        return this.sourcePaths[id];
+    }
+    /**
+     * Check if the configuration can be triggered
+     * @param id - the identifier
+     * @param callback - the callback function
+     * @returns true if the condition is met
+     */
+    canTriggerConfiguration(id, callback) {
+        this.sourcePaths[id] ??= this.getFilePath(id);
+        console.log("canTriggerConfiguration", this.sourcePaths[id]);
+        if (!fs.existsSync(this.sourcePaths[id])) {
+            throw new WebdaError.CodeError("KUBE_CONFIGURATION_SOURCE_MISSING", `Kubernetes configuration source not found: ${this.sourcePaths[id]}`);
+        }
+        console.log("Watch", path.join(this.sourcePaths[id], "..data"));
+        fs.watchFile(path.join(this.sourcePaths[id], "..data"), { interval: 500 }, () => {
+            console.log("Configuration source changed", id, this.sourcePaths[id], Date.now());
+            callback();
+        });
+        return true;
+    }
+    /**
+     * Load configuration from a ConfigMap or a Secret
+     * @override
+     */
+    async getConfiguration(id) {
+        this.sourcePaths[id] ??= this.getFilePath(id);
+        const found = fs
+            .readdirSync(this.sourcePaths[id])
+            .filter(f => !f.startsWith(".") && f.match(/webda\.(jsonc?|ya?ml)$/i))
+            .pop();
+        if (!found) {
+            throw new WebdaError.CodeError("KUBE_CONFIGURATION_SOURCE_INVALID", `Kubernetes configuration source not valid: ${this.sourcePaths[id]}`);
+        }
+        return FileUtils.load(path.join(this.sourcePaths[id], found));
+    }
+}
+//# sourceMappingURL=kubernetesconfiguration.service.js.map

package/lib/configurations/kubernetesconfiguration.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"kubernetesconfiguration.service.js","sourceRoot":"","sources":["../../src/configurations/kubernetesconfiguration.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,KAAK,UAAU,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,oBAAoB,EAAE,8BAA8B,EAAE,MAAM,4BAA4B,CAAC;AAClG,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAEzD;;;GAGG;AACH,MAAM,OAAO,iCAAkC,SAAQ,8BAA8B;IACnF;;;;OAIG;IACH,IAAI,CAAC,MAAW;QACd,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACnB,IACE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,QAAQ,IAAI,EAAE,CAAC,CAAC,MAAM;YAClD,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,WAAW,IAAI,EAAE,CAAC,CAAC,MAAM;YACrD,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,UAAU,IAAI,EAAE,CAAC,CAAC,MAAM,EACpD,CAAC;YACD,MAAM,IAAI,UAAU,CAAC,SAAS,CAC5B,+BAA+B,EAC/B,yEAAyE,MAAM,CAAC,OAAO,EAAE,CAC1F,CAAC;QACJ,CAAC;QACD,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AACD;;;;;GAKG;AACH,MAAM,OAAO,8BAGX,SAAQ,oBAAuB;IAC/B,WAAW,GAA2B,EAAE,CAAC;IAEzC;;;;OAIG;IACH,WAAW,CAAC,EAAU;QACpB,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,KAAK,cAAc,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACtD,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;YACzC,MAAM,IAAI,UAAU,CAAC,SAAS,CAC5B,mCAAmC,EACnC,8CAA8C,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,EAAE,CACrE,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;OAKG;IACH,uBAAuB,CAAC,EAAU,EAAE,QAAoB;QACtD,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,KAAK,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QAC9C,OAAO,CAAC,GAAG,CAAC,yBAAyB,EAAE,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC;QAC7D,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;YACzC,MAAM,IAAI,UAAU,CAAC,SAAS,CAC5B,mCAAmC,EACnC,8CAA8C,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,EAAE,CACrE,CAAC;QACJ,CAAC;QACD,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC;QAChE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,EAAE,GAAG,EAAE;YAC9E,OAAO,CAAC,GAAG,CAAC,8BAA8B,EAAE,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;YAClF,QAAQ,EAAE,CAAC;QACb,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,gBAAgB,CAAC,EAAU;QAC/B,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,KAAK,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QAC9C,MAAM,KAAK,GAAG,EAAE;aACb,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;aACjC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC;aACrE,GAAG,EAAE,CAAC;QACT,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,UAAU,CAAC,SAAS,CAC5B,mCAAmC,EACnC,8CAA8C,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,EAAE,CACrE,CAAC;QACJ,CAAC;QACD,OAAO,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;IAChE,CAAC;CACF"}

package/lib/contexts/execution.d.ts

@@ -0,0 +1,33 @@
+import { Context, IContextAware } from "./icontext.js";
+/**
+ * Get current execution context
+ * @returns the result
+ */
+export declare function useContext<T extends Context>(): T;
+/**
+ * Shortcut to get the current user
+ * @returns the result
+ */
+export declare function useCurrentUser(): Promise<any>;
+/**
+ * Shortcut to get the current user id
+ * @returns the result
+ */
+export declare function useCurrentUserId(): string;
+/**
+ * Run this function as system
+ *
+ * @param run - the function to run
+ * @param attach - whether to attach to current context
+ * @returns the list of results
+ */
+export declare function runAsSystem<T>(run: () => T, attach?: IContextAware[]): T;
+/**
+ * Run this function as user
+ * @param context - the execution context
+ * @param run - the function to run
+ * @param attach - whether to attach to current context
+ * @returns the list of results
+ */
+export declare function runWithContext<T>(context: Context, run: () => T, attach?: IContextAware[]): T;
+//# sourceMappingURL=execution.d.ts.map

package/lib/contexts/execution.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"execution.d.ts","sourceRoot":"","sources":["../../src/contexts/execution.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,aAAa,EAAoB,MAAM,eAAe,CAAC;AAMzE;;;GAGG;AACH,wBAAgB,UAAU,CAAC,CAAC,SAAS,OAAO,KAAK,CAAC,CAEjD;AAED;;;GAGG;AACH,wBAAgB,cAAc,iBAE7B;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,WAE/B;AAcD;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,EAAE,MAAM,GAAE,aAAa,EAAO,GAAG,CAAC,CAE5E;AACD;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,CAAC,EAAE,MAAM,GAAE,aAAa,EAAO,GAAG,CAAC,CAcjG"}

package/lib/contexts/execution.js

@@ -0,0 +1,73 @@
+import { AsyncLocalStorage } from "node:async_hooks";
+import { GlobalContext } from "./globalcontext.js";
+import { setContextUpdate } from "./icontext.js";
+const globalContext = new GlobalContext();
+// Test are transpiling and creating several instances of 'instancestorage.ts'
+process["webdaContexts"] ??= new AsyncLocalStorage();
+const storage = process["webdaContexts"];
+/**
+ * Get current execution context
+ * @returns the result
+ */
+export function useContext() {
+    return (storage.getStore()?.context || globalContext);
+}
+/**
+ * Shortcut to get the current user
+ * @returns the result
+ */
+export function useCurrentUser() {
+    return useContext().getCurrentUser();
+}
+/**
+ * Shortcut to get the current user id
+ * @returns the result
+ */
+export function useCurrentUserId() {
+    return useContext().getCurrentUserId();
+}
+/**
+ * Used to update model context
+ *
+ * @param models - the models
+ * @param context - the execution context
+ */
+function attachModels(models, context) {
+    setContextUpdate(true);
+    models.forEach(m => (m.context = context));
+    setContextUpdate(false);
+}
+/**
+ * Run this function as system
+ *
+ * @param run - the function to run
+ * @param attach - whether to attach to current context
+ * @returns the list of results
+ */
+export function runAsSystem(run, attach = []) {
+    return this.runWithContext(globalContext, run, attach);
+}
+/**
+ * Run this function as user
+ * @param context - the execution context
+ * @param run - the function to run
+ * @param attach - whether to attach to current context
+ * @returns the list of results
+ */
+export function runWithContext(context, run, attach = []) {
+    const previousContext = storage.getStore()?.context;
+    attachModels(attach, context);
+    const res = storage.run({ context, previousContext }, run);
+    // Manage both promise and normal
+    if (res instanceof Promise) {
+        // Return the .finally() promise so the rejection is not left dangling.
+        // Without this, .finally() creates a derived promise that rejects
+        // (when `run` rejects) with no handler, causing unhandled rejections.
+        return res.finally(() => attachModels(attach, undefined));
+    }
+    else {
+        attachModels(attach, undefined);
+    }
+    return res;
+}
+//# sourceMappingURL=execution.js.map

package/lib/contexts/execution.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"execution.js","sourceRoot":"","sources":["../../src/contexts/execution.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAA0B,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAEzE,MAAM,aAAa,GAAG,IAAI,aAAa,EAAE,CAAC;AAC1C,8EAA8E;AAC9E,OAAO,CAAC,eAAe,CAAC,KAAK,IAAI,iBAAiB,EAAkD,CAAC;AACrG,MAAM,OAAO,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;AACzC;;;GAGG;AACH,MAAM,UAAU,UAAU;IACxB,OAAU,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,OAAO,IAAI,aAAa,CAAC,CAAC;AAC3D,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,cAAc;IAC5B,OAAO,UAAU,EAAE,CAAC,cAAc,EAAE,CAAC;AACvC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,gBAAgB;IAC9B,OAAO,UAAU,EAAE,CAAC,gBAAgB,EAAE,CAAC;AACzC,CAAC;AAED;;;;;GAKG;AACH,SAAS,YAAY,CAAC,MAAa,EAAE,OAAgB;IACnD,gBAAgB,CAAC,IAAI,CAAC,CAAC;IACvB,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC;IAC3C,gBAAgB,CAAC,KAAK,CAAC,CAAC;AAC1B,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CAAI,GAAY,EAAE,MAAM,GAAoB,EAAE;IACvE,OAAO,IAAI,CAAC,cAAc,CAAC,aAAa,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;AACzD,CAAC;AACD;;;;;;GAMG;AACH,MAAM,UAAU,cAAc,CAAI,OAAgB,EAAE,GAAY,EAAE,MAAM,GAAoB,EAAE;IAC5F,MAAM,eAAe,GAAG,OAAO,CAAC,QAAQ,EAAE,EAAE,OAAO,CAAC;IACpD,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9B,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,eAAe,EAAE,EAAE,GAAG,CAAC,CAAC;IAC3D,iCAAiC;IACjC,IAAI,GAAG,YAAY,OAAO,EAAE,CAAC;QAC3B,uEAAuE;QACvE,kEAAkE;QAClE,sEAAsE;QACtE,OAAO,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC,MAAM,EAAE,SAAS,CAAC,CAAM,CAAC;IACjE,CAAC;SAAM,CAAC;QACN,YAAY,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAClC,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC"}

package/lib/contexts/globalcontext.d.ts

@@ -0,0 +1,29 @@
+import { Writable } from "stream";
+import { Context } from "./icontext.js";
+/**
+ * Global Context is used as system context
+ */
+export declare class GlobalContext extends Context {
+    /**
+     * @override
+     */
+    getOutputStream(): Promise<Writable>;
+    /**
+     * @override
+     */
+    getCurrentUserId(): string;
+    /**
+     * @override
+     */
+    isGlobalContext(): boolean;
+    /**
+     * @override
+     */
+    getCurrentUser(): Promise<undefined>;
+    /**
+     * Provide an empty session object
+     * @returns the result
+     */
+    getSession(): {};
+}
+//# sourceMappingURL=globalcontext.d.ts.map

package/lib/contexts/globalcontext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"globalcontext.d.ts","sourceRoot":"","sources":["../../src/contexts/globalcontext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAClC,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAExC;;GAEG;AACH,qBAAa,aAAc,SAAQ,OAAO;IACxC;;OAEG;IACH,eAAe,IAAI,OAAO,CAAC,QAAQ,CAAC,CAEnC;IAED;;OAEG;IACH,gBAAgB,IAAI,MAAM,CAEzB;IAED;;OAEG;IACH,eAAe,IAAI,OAAO,CAEzB;IAED;;OAEG;IACH,cAAc,IAAI,OAAO,CAAC,SAAS,CAAC,CAEnC;IAED;;;OAGG;IACH,UAAU,OAET;CACF"}

package/lib/contexts/globalcontext.js

@@ -0,0 +1,38 @@
+import { Context } from "./icontext.js";
+/**
+ * Global Context is used as system context
+ */
+export class GlobalContext extends Context {
+    /**
+     * @override
+     */
+    getOutputStream() {
+        throw new Error("You cannot write to a global context.");
+    }
+    /**
+     * @override
+     */
+    getCurrentUserId() {
+        return "system";
+    }
+    /**
+     * @override
+     */
+    isGlobalContext() {
+        return true;
+    }
+    /**
+     * @override
+     */
+    getCurrentUser() {
+        return undefined;
+    }
+    /**
+     * Provide an empty session object
+     * @returns the result
+     */
+    getSession() {
+        return {};
+    }
+}
+//# sourceMappingURL=globalcontext.js.map

package/lib/contexts/globalcontext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"globalcontext.js","sourceRoot":"","sources":["../../src/contexts/globalcontext.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAExC;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,OAAO;IACxC;;OAEG;IACH,eAAe;QACb,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;IAC3D,CAAC;IAED;;OAEG;IACH,gBAAgB;QACd,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;OAEG;IACH,eAAe;QACb,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,cAAc;QACZ,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;OAGG;IACH,UAAU;QACR,OAAO,EAAE,CAAC;IACZ,CAAC;CACF"}

package/lib/{utils → contexts}/httpcontext.d.ts

@@ -1,4 +1,4 @@
-import { IncomingHttpHeaders } from "http";
+import { type IncomingHttpHeaders } from "http";
 import { Readable } from "stream";
 export type HttpMethodType = "GET" | "OPTIONS" | "POST" | "PUT" | "PATCH" | "DELETE";
 /**
@@ -49,21 +49,32 @@ export declare class HttpContext {
      * URI prefix in case it is exposed through something that prefix the uri
      */
     prefix: string;
+    /** Create a new HttpContext
+     * @param hostname - the request hostname
+     * @param method - the HTTP method
+     * @param uri - the request URI
+     * @param protocol - the protocol
+     * @param port - the port number
+     * @param headers - the request headers
+     */
     constructor(hostname: string, method: HttpMethodType, uri: string, protocol?: "http" | "https", port?: number | string, headers?: {
         [key: string]: string | string[];
     });
     /**
      * Set the client ip
+     * @param ip - the IP address
+     * @returns this for chaining
      */
     setClientIp(ip: string): this;
     /**
      * Get the client ip
+     * @returns the result string
      */
     getClientIp(): string;
     /**
      *
      * @see https://developer.mozilla.org/en-US/docs/Web/API/URL/href
-     * @returns
+     * @returns the result string
      */
     getHref(): string;
     /**
@@ -73,51 +84,56 @@ export declare class HttpContext {
     setPrefix(prefix: string): void;
     /**
      * Return Uri without prefix
+     *
+     * The prefix is only removed on a path boundary, so prefix `/prod` does not strip `/production`
+     * @returns the result string
      */
     getRelativeUri(): string;
     /**
      * Get full URI
-     * @returns
+     * @returns the result string
      */
     getUrl(): string;
     /**
      * Get cookies
-     * @returns
+     * @returns the result
      */
     getCookies(): any;
     /**
      * Get port number as string
      *
      * If http on port 80, or https on port 443 will return ""
+     * @returns the result string
      */
     getPort(): string;
     /**
      * Get the port number
+     * @returns the result number
      */
     getPortNumber(): number;
     /**
      * Return hostname and port
-     * @returns
+     * @returns the result string
      */
     getHost(): string;
     /**
      * Return protocol, hostname and port
-     * @returns
+     * @returns the result string
      */
     getOrigin(): string;
     /**
      * Get the hostname
-     * @returns
+     * @returns the result string
      */
     getHostName(): string;
     /**
      * Get HTTP Method used
-     * @returns
+     * @returns the result
      */
     getMethod(): HttpMethodType;
     /**
      * Get protocol used
-     * @returns
+     * @returns the result
      */
     getProtocol(): "http:" | "https:";
     /**
@@ -126,7 +142,7 @@ export declare class HttpContext {
      * @param limit the size of readable request
      * @param timeout the time to read the request
      * @param encoding to analyze
-     * @returns
+     * @returns the result
      */
     getRawBodyAsString(limit?: number, timeout?: number, encoding?: string): Promise<string>;
     /**
@@ -134,52 +150,62 @@ export declare class HttpContext {
      *
      * @param limit the size of readable request
      * @param timeout the time to read the request
-     * @returns
+     * @returns the result
      */
     getRawBody(limit?: number, timeout?: number): Promise<Buffer | undefined>;
     /**
      * Get the body as stream
+     * @returns the result
      */
     getRawStream(): Readable;
     /**
      * Get HTTP Headers
-     * @returns
+     * @returns the result
      */
     getHeaders(): Readonly<IncomingHttpHeaders>;
     /**
      * Get header value
-     * @param name
-     * @param def
-     * @returns
+     * @param name - the name to use
+     * @param def - the default value
+     * @returns the list of results
      */
     getHeader(name: string, def?: string): string | string[];
     /**
      * Return the last header found with that name
+     * @param name - the name to use
+     * @param def - the default value
+     * @returns the result string
      */
     getUniqueHeader(name: string, def?: string): string;
     /**
      * Used for test
-     * @param body
+     * @param body - the request body
+     * @returns this for chaining
      */
     setBody(body: Buffer | string | Readable | any): this;
     /**
      * Get request path name
      *
      * @see https://developer.mozilla.org/en-US/docs/Web/API/URL/pathname
-     * @returns
+     * @returns the result
      */
     getPathName(): string;
     /**
      * Get search section
      *
      * @see https://developer.mozilla.org/en-US/docs/Web/API/URL/search
-     * @returns
+     * @returns the result
      */
     getSearch(): string;
     /**
+     * Return the absolute url of the request, or of an application uri
+     *
+     * An application uri is relative to the prefix, so the prefix is added to it
      *
-     * @param uri to return absolute url from
+     * @param uri to return absolute url from, the request uri by default
+     * @returns the result string
      */
     getAbsoluteUrl(uri?: string): string;
 }
 export {};
+//# sourceMappingURL=httpcontext.d.ts.map

package/lib/contexts/httpcontext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"httpcontext.d.ts","sourceRoot":"","sources":["../../src/contexts/httpcontext.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,mBAAmB,EAAE,MAAM,MAAM,CAAC;AAChD,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAElC,MAAM,MAAM,cAAc,GAAG,KAAK,GAAG,SAAS,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;AACrF;;GAEG;AACH,eAAO,MAAM,iBAAiB,EAAE,cAAc,EAAyD,CAAC;AAExG,KAAK,cAAc,GAAG,mBAAmB,GAAG;IAE1C,CAAC,UAAU,EAAE,KAAK,MAAM,EAAE,GAAG,MAAM,CAAC;CACrC,CAAC;AAEF;;;;;;;;GAQG;AACH,qBAAa,WAAW;IACtB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,MAAM,EAAE,cAAc,CAAC;IACvB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,OAAO,GAAG,QAAQ,CAAC;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,cAAc,CAAC;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAC;IACpC,OAAO,EAAE,GAAG,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAM;IAEpB;;;;;;;OAOG;IACH,YACE,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,cAAc,EACtB,GAAG,EAAE,MAAM,EACX,QAAQ,GAAE,MAAM,GAAG,OAAgB,EACnC,IAAI,GAAE,MAAM,GAAG,MAAa,EAC5B,OAAO,GAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAA;KAAO,EAkCnD;IAED;;;;OAIG;IACH,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAG5B;IAED;;;OAGG;IACH,WAAW,IAAI,MAAM,CAEpB;IAED;;;;OAIG;IACH,OAAO,IAAI,MAAM,CAEhB;IAED;;;OAGG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAK9B;IAED;;;;;OAKG;IACH,cAAc,IAAI,MAAM,CAYvB;IAED;;;OAGG;IACH,MAAM,IAAI,MAAM,CAEf;IAED;;;OAGG;IACH,UAAU,QAET;IAED;;;;;OAKG;IACH,OAAO,IAAI,MAAM,CAEhB;IAED;;;OAGG;IACH,aAAa,IAAI,MAAM,CAStB;IAED;;;OAGG;IACH,OAAO,IAAI,MAAM,CAEhB;IAED;;;OAGG;IACH,SAAS,IAAI,MAAM,CAElB;IAED;;;OAGG;IACH,WAAW,IAAI,MAAM,CAEpB;IAED;;;OAGG;IACH,SAAS,IAAI,cAAc,CAE1B;IAED;;;OAGG;IACH,WAAW,IAAI,OAAO,GAAG,QAAQ,CAEhC;IAED;;;;;;;OAOG;IACG,kBAAkB,CAAC,KAAK,GAAE,MAAyB,EAAE,OAAO,GAAE,MAAc,EAAE,QAAQ,CAAC,EAAE,MAAM,mBAcpG;IAED;;;;;;OAMG;IACG,UAAU,CAAC,KAAK,GAAE,MAAyB,EAAE,OAAO,GAAE,MAAc,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CA4BvG;IAED;;;OAGG;IACH,YAAY,IAAI,QAAQ,CAKvB;IAED;;;OAGG;IACH,UAAU,IAAI,QAAQ,CAAC,mBAAmB,CAAC,CAE1C;IAED;;;;;OAKG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAEvD;IAED;;;;;OAKG;IACH,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,CAMlD;IAED;;;;OAIG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,GAAG,GAAG,IAAI,CAWpD;IACD;;;;;OAKG;IACH,WAAW,WAEV;IAED;;;;;OAKG;IACH,SAAS,WAER;IAED;;;;;;;OAOG;IACH,cAAc,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,CAenC;CACF"}