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

package/lib/services/cron.service.js

@@ -0,0 +1,291 @@
+var __runInitializers = (this && this.__runInitializers) || function (thisArg, initializers, value) {
+    var useValue = arguments.length > 2;
+    for (var i = 0; i < initializers.length; i++) {
+        value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);
+    }
+    return useValue ? value : void 0;
+};
+var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {
+    function accept(f) { if (f !== void 0 && typeof f !== "function") throw new TypeError("Function expected"); return f; }
+    var kind = contextIn.kind, key = kind === "getter" ? "get" : kind === "setter" ? "set" : "value";
+    var target = !descriptorIn && ctor ? contextIn["static"] ? ctor : ctor.prototype : null;
+    var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});
+    var _, done = false;
+    for (var i = decorators.length - 1; i >= 0; i--) {
+        var context = {};
+        for (var p in contextIn) context[p] = p === "access" ? {} : contextIn[p];
+        for (var p in contextIn.access) context.access[p] = contextIn.access[p];
+        context.addInitializer = function (f) { if (done) throw new TypeError("Cannot add initializers after decoration has completed"); extraInitializers.push(accept(f || null)); };
+        var result = (0, decorators[i])(kind === "accessor" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);
+        if (kind === "accessor") {
+            if (result === void 0) continue;
+            if (result === null || typeof result !== "object") throw new TypeError("Object expected");
+            if (_ = accept(result.get)) descriptor.get = _;
+            if (_ = accept(result.set)) descriptor.set = _;
+            if (_ = accept(result.init)) initializers.unshift(_);
+        }
+        else if (_ = accept(result)) {
+            if (kind === "field") initializers.unshift(_);
+            else descriptor[key] = _;
+        }
+    }
+    if (target) Object.defineProperty(target, contextIn.name, descriptor);
+    done = true;
+};
+import { createHash } from "crypto";
+import { schedule } from "node-cron";
+import { Service } from "./service.js";
+import { CancelablePromise } from "@webda/utils";
+import { useCore, useService } from "../core/hooks.js";
+import { Command } from "./command.js";
+export const CronSymbol = Symbol("WebdaCron");
+/**
+ * Cron item
+ */
+export class CronDefinition {
+    /**
+     * Cron definition
+     * * * * 0 3
+     * @pattern ^(\*|([0-5]?\d)) (\*|([01]?\d|2[0-3])) (\*|([01]?\d|2[0-3])) (\*|([0-6])) (\*|([0-6]))$
+     */
+    cron;
+    /**
+     * Description of the task
+     */
+    description;
+    /**
+     * Argument to be passed to the function
+     */
+    args;
+    /**
+     * Method to call
+     */
+    method;
+    /**
+     * Webda service name
+     */
+    serviceName;
+    /**
+     *
+     * @param cron - the cron expression
+     * @param args - additional arguments
+     * @param serviceName - the service name
+     * @param method - the HTTP method
+     * @param description - the description
+     */
+    constructor(cron, args = [], serviceName = "", method = "", description = "") {
+        this.cron = cron;
+        this.serviceName = serviceName;
+        this.method = method;
+        this.description = description;
+        this.args = args;
+    }
+    /**
+     * Format the cron definition as a human-readable string
+     * @returns the result
+     */
+    toString() {
+        return `${this.cron}: ${this.serviceName}.${this.method}(${this.args.map(a => a.toString()).join(",")})${this.description !== "" ? ` # ${this.description}` : ""}`;
+    }
+}
+/**
+ * @WebdaModda
+ */
+let CronService = (() => {
+    let _classSuper = Service;
+    let _instanceExtraInitializers = [];
+    let _runCron_decorators;
+    return class CronService extends _classSuper {
+        static {
+            const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
+            _runCron_decorators = [Command("cron run", { description: "Run once the declared cron matching the id" })];
+            __esDecorate(this, null, _runCron_decorators, { kind: "method", name: "runCron", static: false, private: false, access: { has: obj => "runCron" in obj, get: obj => obj.runCron }, metadata: _metadata }, null, _instanceExtraInitializers);
+            if (_metadata) Object.defineProperty(this, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
+        }
+        enable = __runInitializers(this, _instanceExtraInitializers);
+        crons = [];
+        crontabSchedule = schedule;
+        _scanned = false;
+        /**
+         * Legacy decorator factory for annotating a method with a cron schedule
+         * @param cron - the cron expression
+         * @param description - the description
+         * @param args - additional arguments
+         * @returns the result
+         */
+        static Annotation(cron, description = "", ...args) {
+            return (_target, property, descriptor) => {
+                descriptor.value.cron = descriptor.value.cron || [];
+                descriptor.value.cron.push(new CronDefinition(cron, args, "", property, description));
+            };
+        }
+        /**
+         * Generate a short hash-based identifier for a cron definition
+         * @param cron - the cron expression
+         * @param name - the name to use
+         * @returns the result
+         */
+        static getCronId(cron, name = "") {
+            const hash = createHash("sha256");
+            return hash
+                .update(JSON.stringify(cron) + name)
+                .digest("hex")
+                .substring(0, 8);
+        }
+        /**
+         * Stable identifier of a cron for exported jobs (e.g. Kubernetes CronJob)
+         *
+         * `webda cron run --id <id>` resolves the cron back from this identifier
+         * @param cron - the cron definition
+         * @returns the 8 hex characters identifier
+         */
+        static getExportId(cron) {
+            return CronService.getCronId(cron, "export");
+        }
+        /**
+         * Collect all @Cron-annotated methods from the provided services
+         * @param services - the services
+         * @returns the list of results
+         */
+        static loadAnnotations(services) {
+            const cronsResult = [];
+            for (const i in services) {
+                if (services[i]?.[CronSymbol]) {
+                    services[i]?.[CronSymbol].forEach((cron) => {
+                        cron.serviceName = i;
+                        cronsResult.push(cron);
+                    });
+                }
+            }
+            return cronsResult;
+        }
+        /** Scan all services for cron annotations and add them to the schedule (once) */
+        addAnnotations() {
+            if (this._scanned) {
+                return;
+            }
+            this._scanned = true;
+            this.crons.push(...CronService.loadAnnotations(useCore().getServices()));
+        }
+        /**
+         * Get all registered cron entries including annotations
+         * @returns the result
+         */
+        getCrontab() {
+            // Load all annotations
+            this.addAnnotations();
+            return this.crons;
+        }
+        /**
+         * Start the cron worker, optionally including annotated crons
+         * @param annotations - the annotations
+         * @returns the result
+         */
+        work(annotations = "true") {
+            return this.run(annotations === "true");
+        }
+        /**
+         * Run once the @Cron-annotated method matching an exported cron id
+         *
+         * Only methods declared with `@Cron` can be run, with their declared arguments
+         * @param id - the cron id, as computed by {@link CronService.getExportId}
+         */
+        async runCron(id) {
+            if (!id) {
+                throw new Error("A cron id is required");
+            }
+            const crons = CronService.loadAnnotations(useCore().getServices()).filter(c => CronService.getExportId(c) === id);
+            if (crons.length === 0) {
+                throw new Error(`No cron with id '${id}'`);
+            }
+            for (const cron of crons) {
+                this.log("INFO", `Running cron ${cron.toString()}`);
+                await useService(cron.serviceName)[cron.method](...cron.args);
+            }
+        }
+        /**
+         * Schedule and start all registered cron jobs
+         * @param annotations - the annotations
+         * @returns the result
+         */
+        run(annotations = true) {
+            this.log("INFO", "Running crontab with" + (annotations ? "" : "out"), "annotations");
+            // Load all annotations
+            if (annotations) {
+                this.addAnnotations();
+            }
+            this.enable = true;
+            // Run schedule
+            this.crons.forEach(i => {
+                if (i.cb) {
+                    this.schedule(i.cron, i.cb);
+                }
+                else {
+                    this.schedule(i.cron, () => {
+                        useService(i.serviceName)[i.method](...i.args);
+                    });
+                }
+            });
+            const msgs = [];
+            // Display before
+            this.crons.forEach(c => {
+                if (c.cb) {
+                    msgs.push(`[NativeCode:${c.context || ""}]`);
+                }
+                else {
+                    msgs.push(`${c.serviceName}.${c.method}(${c.args.length ? "..." + c.args : ""})`);
+                }
+            });
+            const cronPad = Math.max(...this.crons.map(c => c.cron.length));
+            const servicePad = Math.max(...msgs.map(c => c.length));
+            this.crons.forEach((c, i) => {
+                this.log("INFO", `${c.cron.padEnd(cronPad)} : ${msgs[i].padEnd(servicePad)}${c.description ? "  # " + c.description : ""}`);
+            });
+            // Remove from memory
+            this.crons = [];
+            return new CancelablePromise();
+        }
+        /**
+         * Register a cron expression to execute a callback, buffering if not yet enabled
+         * @param cron - the cron expression
+         * @param cb - the callback function
+         * @param description - the description
+         */
+        schedule(cron, cb, description = "") {
+            if (this.enable) {
+                this.crontabSchedule(cron, cb);
+            }
+            else {
+                let context;
+                try {
+                    throw new Error();
+                }
+                catch (err) {
+                    // Based on stack trace (not super clean)
+                    const info = err.stack.split("\n")[2].match(/\((.*)\)/);
+                    context = info[1].replace(process.cwd() + "/", "");
+                }
+                this.crons.push({ cron, cb, description, context });
+            }
+        }
+    };
+})();
+/**
+ * Decorator to schedule a service method with a cron expression
+ * @param cron - the cron expression
+ * @param description - the description
+ * @param args - additional arguments
+ * @returns the result
+ */
+export function Cron(cron, description = "", ...args) {
+    return function cronDecorator(value, context) {
+        // Store metadata on each instance when it's constructed
+        context.addInitializer(function cronInitializer() {
+            (this[CronSymbol] ??= []).push(new CronDefinition(cron, args, this.name, context.name, description));
+        });
+        // You can return the same method, or wrap it if you need
+        return value;
+    };
+}
+export { CronService };
+//# sourceMappingURL=cron.service.js.map

package/lib/services/cron.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cron.service.js","sourceRoot":"","sources":["../../src/services/cron.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AACrC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACjD,OAAO,EAAe,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACpE,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAEvC,MAAM,CAAC,MAAM,UAAU,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;AAC9C;;GAEG;AACH,MAAM,OAAO,cAAc;IACzB;;;;OAIG;IACH,IAAI,CAAS;IAEb;;OAEG;IACH,WAAW,CAAS;IACpB;;OAEG;IACH,IAAI,CAAQ;IACZ;;OAEG;IACH,MAAM,CAAS;IACf;;OAEG;IACH,WAAW,CAAS;IAEpB;;;;;;;OAOG;IACH,YAAY,IAAY,EAAE,IAAI,GAAU,EAAE,EAAE,WAAW,GAAW,EAAE,EAAE,MAAM,GAAW,EAAE,EAAE,WAAW,GAAW,EAAE;QACjH,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED;;;OAGG;IACH,QAAQ;QACN,OAAO,GAAG,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IACnG,IAAI,CAAC,WAAW,KAAK,EAAE,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EACvD,EAAE,CAAC;IACL,CAAC;CACF;AAED;;GAEG;IACG,WAAW;sBAAS,OAAO;;;iBAA3B,WAAY,SAAQ,WAAO;;;mCAyG9B,OAAO,CAAC,UAAU,EAAE,EAAE,WAAW,EAAE,4CAA4C,EAAE,CAAC;YACnF,wKAAM,OAAO,6DAYZ;;;QArHD,MAAM,GADF,mDAAW,CACC;QAChB,KAAK,GAQC,EAAE,CAAC;QACT,eAAe,GAAG,QAAQ,CAAC;QACnB,QAAQ,GAAY,KAAK,CAAC;QAElC;;;;;;WAMG;QACH,MAAM,CAAC,UAAU,CAAC,IAAY,EAAE,WAAW,GAAW,EAAE,EAAE,GAAG,IAAI;YAC/D,OAAO,CAAC,OAAY,EAAE,QAAyB,EAAE,UAA8B,EAAE,EAAE;gBACjF,UAAU,CAAC,KAAK,CAAC,IAAI,GAAG,UAAU,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC;gBACpD,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,EAAU,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC;YAChG,CAAC,CAAC;QACJ,CAAC;QAED;;;;;WAKG;QACH,MAAM,CAAC,SAAS,CAAC,IAAoB,EAAE,IAAI,GAAW,EAAE;YACtD,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC;YAClC,OAAO,IAAI;iBACR,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;iBACnC,MAAM,CAAC,KAAK,CAAC;iBACb,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACrB,CAAC;QAED;;;;;;WAMG;QACH,MAAM,CAAC,WAAW,CAAC,IAAoB;YACrC,OAAO,WAAW,CAAC,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAC/C,CAAC;QAED;;;;WAIG;QACH,MAAM,CAAC,eAAe,CAAC,QAAQ;YAC7B,MAAM,WAAW,GAAqB,EAAE,CAAC;YACzC,KAAK,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC;gBACzB,IAAI,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC;oBAC9B,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,CAAC,IAAoB,EAAE,EAAE;wBACzD,IAAI,CAAC,WAAW,GAAG,CAAC,CAAC;wBACrB,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;oBACzB,CAAC,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;YACD,OAAO,WAAW,CAAC;QACrB,CAAC;QAED,iFAAiF;QACjF,cAAc;YACZ,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAClB,OAAO;YACT,CAAC;YACD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;YACrB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,eAAe,CAAC,OAAO,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QAC3E,CAAC;QAED;;;WAGG;QACH,UAAU;YACR,uBAAuB;YACvB,IAAI,CAAC,cAAc,EAAE,CAAC;YACtB,OAAO,IAAI,CAAC,KAAK,CAAC;QACpB,CAAC;QAED;;;;WAIG;QACH,IAAI,CAAC,WAAW,GAAW,MAAM;YAC/B,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,KAAK,MAAM,CAAC,CAAC;QAC1C,CAAC;QAED;;;;;WAKG;QAEH,KAAK,CAAC,OAAO,CAAC,EAAU;YACtB,IAAI,CAAC,EAAE,EAAE,CAAC;gBACR,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;YAC3C,CAAC;YACD,MAAM,KAAK,GAAG,WAAW,CAAC,eAAe,CAAC,OAAO,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;YAClH,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACvB,MAAM,IAAI,KAAK,CAAC,oBAAoB,EAAE,GAAG,CAAC,CAAC;YAC7C,CAAC;YACD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;gBACzB,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,gBAAgB,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;gBACpD,MAAM,UAAU,CAAC,IAAI,CAAC,WAA0B,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;YAC/E,CAAC;QACH,CAAC;QAED;;;;WAIG;QACH,GAAG,CAAC,WAAW,GAAY,IAAI;YAC7B,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,sBAAsB,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,CAAC,CAAC;YACrF,uBAAuB;YACvB,IAAI,WAAW,EAAE,CAAC;gBAChB,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,CAAC;YACD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;YACnB,eAAe;YACf,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;gBACrB,IAAI,CAAC,CAAC,EAAE,EAAE,CAAC;oBACT,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;gBAC9B,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE;wBACzB,UAAU,CAAC,CAAC,CAAC,WAA0B,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;oBAChE,CAAC,CAAC,CAAC;gBACL,CAAC;YACH,CAAC,CAAC,CAAC;YAEH,MAAM,IAAI,GAAG,EAAE,CAAC;YAChB,iBAAiB;YACjB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;gBACrB,IAAI,CAAC,CAAC,EAAE,EAAE,CAAC;oBACT,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,OAAO,IAAI,EAAE,GAAG,CAAC,CAAC;gBAC/C,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,WAAW,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;gBACpF,CAAC;YACH,CAAC,CAAC,CAAC;YACH,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;YAChE,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;YACxD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;gBAC1B,IAAI,CAAC,GAAG,CACN,MAAM,EACN,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,EAAE,CAC1G,CAAC;YACJ,CAAC,CAAC,CAAC;YACH,qBAAqB;YACrB,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;YAChB,OAAO,IAAI,iBAAiB,EAAE,CAAC;QACjC,CAAC;QAED;;;;;WAKG;QACH,QAAQ,CAAC,IAAY,EAAE,EAAa,EAAE,WAAW,GAAW,EAAE;YAC5D,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;gBAChB,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YACjC,CAAC;iBAAM,CAAC;gBACN,IAAI,OAAO,CAAC;gBACZ,IAAI,CAAC;oBACH,MAAM,IAAI,KAAK,EAAE,CAAC;gBACpB,CAAC;gBAAC,OAAO,GAAG,EAAE,CAAC;oBACb,yCAAyC;oBACzC,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;oBACxD,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,GAAG,EAAE,EAAE,CAAC,CAAC;gBACrD,CAAC;gBACD,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;YACtD,CAAC;QACH,CAAC;;;AAGH;;;;;;GAMG;AACH,MAAM,UAAU,IAAI,CAAC,IAAY,EAAE,WAAW,GAAG,EAAE,EAAE,GAAG,IAAW;IACjE,OAAO,SAAS,aAAa,CAC3B,KAAQ,EACR,OAAgD;QAEhD,wDAAwD;QACxD,OAAO,CAAC,cAAc,CAAC,SAAS,eAAe;YAC7C,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,IAAc,EAAE,WAAW,CAAC,CAAC,CAAC;QACjH,CAAC,CAAC,CAAC;QAEH,yDAAyD;QACzD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;AACJ,CAAC;AAED,OAAO,EAAE,WAAW,EAAE,CAAC"}

package/lib/services/{cryptoservice.d.ts → cryptoservice.service.d.ts}

@@ -1,16 +1,43 @@
 import * as util from "util";
-import { OperationContext, RegistryEntry, Store } from "../index.js";
-import { DeepPartial, Service, ServiceParameters } from "./service.js";
+import { CryptoServiceParameters, JWTOptions, KeysDefinition } from "./icryptoservice.js";
+import { Service } from "./service.js";
+import { OperationContext } from "../contexts/operationcontext.js";
+/** Wraps a secret string value, masking it in logs and inspect output */
 export declare class SecretString {
     protected str: string;
     protected encrypter: string;
+    /** Create a new SecretString
+     * @param str - the secret value
+     * @param encrypter - the encrypter service name
+     */
     constructor(str: string, encrypter: string);
+    /**
+     * Extract the plain string value, warning if the string is not encrypted
+     * @param value - the value to set
+     * @param path - the path
+     * @returns the result string
+     */
     static from(value: string | SecretString, path?: string): string;
+    /**
+     * Get the underlying secret value
+     * @returns the result string
+     */
     getValue(): string;
+    /**
+     * Return a masked representation to prevent secret leakage
+     * @returns the result string
+     */
     toString(): string;
+    /**
+     * Custom inspect handler to mask the secret in Node.js util.inspect
+     * @param depth - the depth level
+     * @param options - the options
+     * @param inspect - the inspect function
+     * @returns the result
+     */
     [util.inspect.custom](depth: any, options: any, inspect: any): string;
 }
-export interface KeysRegistry {
+export type KeysRegistry = {
     /**
      * Contains the instanceId of the last
      * service who rotated
@@ -28,7 +55,7 @@ export interface KeysRegistry {
      * Current key
      */
     current: string;
-}
+};
 /**
  * Encrypt/Decrypt string
  */
@@ -46,134 +73,17 @@ export interface StringEncrypter {
      */
     decrypt(data: string, options?: any): Promise<string>;
 }
-/**
- * JWT Options
- */
-export interface JWTOptions {
-    /**
-     * Secret to use with JWT
-     */
-    secretOrPublicKey?: string | Buffer | {
-        key: string;
-        passphrase: string;
-    };
-    /**
-     * Algorithm for JWT token
-     *
-     * @see https://www.npmjs.com/package/jsonwebtoken
-     * @default "HS256"
-     */
-    algorithm?: "HS256" | "HS384" | "HS512" | "RS256" | "RS384" | "RS512" | "PS256" | "PS384" | "PS512" | "ES256" | "ES384" | "ES512";
-    /**
-     * expressed in seconds or a string describing a time span zeit/ms.
-     *
-     * Eg: 60, "2 days", "10h", "7d". A numeric value is interpreted as a seconds count. If you use a string be sure you provide the time units (days, hours, etc), otherwise milliseconds unit is used by default ("120" is equal to "120ms").
-     */
-    expiresIn?: number | string;
-    /**
-     * Audience for the jwt
-     */
-    audience?: string;
-    /**
-     * Issuer of the token
-     */
-    issuer?: string;
-    /**
-     * Subject for JWT
-     */
-    subject?: string;
-    keyid?: any;
-}
-export declare class CryptoServiceParameters extends ServiceParameters {
-    /**
-     * Number of hours a key should be used for encryption
-     *
-     * if auto-rotate is not set this
-     */
-    keyActiveLifespan: number;
-    /**
-     * Number of hours allowed to decrypt data encrypted with this key
-     */
-    keyLifespan: number;
-    /**
-     * Try to rotate keys when they expire in days
-     */
-    autoRotate?: number;
-    /**
-     * Create first set of key if does not exist
-     */
-    autoCreate?: boolean;
-    /**
-     * To expose JWKS
-     *
-     * @see https://datatracker.ietf.org/doc/html/rfc7517
-     */
-    url?: string;
-    /**
-     * Type of asymetric key
-     *
-     * https://nodejs.org/api/crypto.html#cryptogeneratekeypairsynctype-options
-     * https://nodejs.org/docs/latest-v14.x/api/crypto.html#crypto_crypto_generatekeypairsync_type_options
-     */
-    asymetricType: "rsa" | "dsa" | "ec" | "ed25519" | "ed448" | "x25519" | "x448" | "dh";
-    /**
-     * Options for asymetric generation
-     */
-    asymetricOptions?: {
-        /**
-         * @default 2048
-         */
-        modulusLength?: number;
-        /**
-         * Only if asymetricType "ec"
-         */
-        namedCurve?: string;
-        publicKeyEncoding?: {
-            /**
-             * @default spki
-             */
-            type?: "spki" | "pkcs1";
-            format?: "pem";
-        };
-        privateKeyEncoding?: {
-            /**
-             * https://nodejs.org/docs/latest-v14.x/api/crypto.html#crypto_keyobject_export_options
-             * @default pkcs8
-             */
-            type?: "pkcs1" | "pkcs8" | "sec1";
-            format?: "pem";
-            cipher?: string;
-            passphrase?: string;
-        };
-    };
-    /**
-     * @default 256
-     */
-    symetricKeyLength?: number;
-    /**
-     * @default "aes-256-ctr"
-     */
-    symetricCipher?: string;
-    /**
-     * Default JWT options
-     */
-    jwt?: JWTOptions;
-    constructor(params: any);
-}
-interface KeysDefinition {
-    publicKey: string;
-    privateKey: string;
-    symetric: string;
-}
 /**
  * @WebdaModda
  */
-export default class CryptoService<T extends CryptoServiceParameters = CryptoServiceParameters> extends Service<T> implements StringEncrypter {
+export declare class CryptoService<T extends CryptoServiceParameters = CryptoServiceParameters> extends Service<T> implements StringEncrypter {
     private static encrypters;
     /**
      * Register an encrypter for configuration
-     * @param name
-     * @param encrypter
+     * @param name - the name to use
+     * @param encrypter - the encrypter implementation
+     * @param encrypter.encrypt - the encrypter.encrypt
+     * @param encrypter.decrypt - the encrypter.decrypt
      */
     static registerEncrypter(name: string, encrypter: {
         encrypt: (data: string) => Promise<string>;
@@ -198,26 +108,23 @@ export default class CryptoService<T extends CryptoServiceParameters = CryptoSer
             e: string;
         };
     };
-    registry: Store<RegistryEntry>;
-    /**
-     * @override
-     */
-    loadParameters(params: DeepPartial<T>): ServiceParameters;
     /**
      * @override
      */
     init(): Promise<this>;
     /**
      *
+     * @param context - the execution context
      */
     serveJWKS(context: OperationContext): Promise<void>;
     /**
      * Load keys from registry
+     * @returns true if the condition is met
      */
     load(): Promise<boolean>;
     /**
      * Generate asymetric key
-     * @returns
+     * @returns the result
      */
     generateAsymetricKeys(): {
         publicKey: string;
@@ -225,11 +132,12 @@ export default class CryptoService<T extends CryptoServiceParameters = CryptoSer
     };
     /**
      * Generate symetric key
-     * @returns
+     * @returns the result string
      */
     generateSymetricKey(): string;
     /**
      * Return current key set
+     * @returns the result
      */
     getCurrentKeys(): Promise<{
         id: string;
@@ -237,59 +145,77 @@ export default class CryptoService<T extends CryptoServiceParameters = CryptoSer
     }>;
     /**
      * Retrieve a HMAC for a string
-     * @param data
+     * @param data - the data to process
      * @param keyId to use
-     * @returns
+     * @returns the result string
      */
     hmac(data: string | any, keyId?: string): Promise<string>;
     /**
      * Verify a HMAC for a string
-     * @param data
-     * @returns
+     * @param data - the data to process
+     * @param hmac - the HMAC instance
+     * @returns true if the condition is met
      */
     hmacVerify(data: string | any, hmac: string): Promise<boolean>;
     /**
      * JWT token generation
+     * @param data - the data to process
+     * @param options - the options
+     * @returns the result string
      */
     jwtSign(data: any, options?: JWTOptions): Promise<string>;
     /**
      *
-     * @param keyId
-     * @returns
+     * @param keyId - the key identifier
+     * @returns true if the condition is met
      */
     checkKey(keyId: string): Promise<boolean>;
     /**
      * Get JWT key based on kid
+     * @param header - the JWT header
+     * @param callback - the callback function
      */
     getJWTKey(header: any, callback: any): Promise<void>;
     /**
      * JWT token verification
+     * @param token - the token
+     * @param options - the options
+     * @returns the result
      */
     jwtVerify(token: string, options?: JWTOptions): Promise<string | any>;
     /**
      * Encrypt data
+     * @param data - the data to process
+     * @returns the result string
      */
     encrypt(data: any): Promise<string>;
     /**
      * Parse the JWT header section
+     * @param token - the token
+     * @returns the result
      */
     getJWTHeader(token: string): any;
     /**
      * Encrypt configuration
-     * @param data
+     * @param data - the data to process
+     * @returns the result
      */
     static encryptConfiguration(data: any): Promise<any>;
     /**
      *
-     * @param data
+     * @param data - the data to process
+     * @returns the result
      */
     static decryptConfiguration(data: any): Promise<any>;
     /**
      * Decrypt data
+     * @param token - the token
+     * @returns the result
      */
     decrypt(token: string): Promise<any>;
     /**
      * Get next id
+     * @returns the result
      */
     getNextId(): {
         id: string;
@@ -300,4 +226,13 @@ export default class CryptoService<T extends CryptoServiceParameters = CryptoSer
      */
     rotate(): Promise<void>;
 }
-export { CryptoService };
+export default CryptoService;
+/**
+ * Return the CryptoService
+ *
+ * As it is a service, it can be used with the useService hook
+ *
+ * @returns the result
+ */
+export declare function useCrypto(): CryptoService<CryptoServiceParameters>;
+//# sourceMappingURL=cryptoservice.service.d.ts.map

package/lib/services/cryptoservice.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cryptoservice.service.d.ts","sourceRoot":"","sources":["../../src/services/cryptoservice.service.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAG7B,OAAO,EAAE,uBAAuB,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAG1F,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAInE,yEAAyE;AACzE,qBAAa,YAAY;IAMrB,SAAS,CAAC,GAAG,EAAE,MAAM;IACrB,SAAS,CAAC,SAAS,EAAE,MAAM;IAN7B;;;OAGG;IACH,YACY,GAAG,EAAE,MAAM,EACX,SAAS,EAAE,MAAM,EACzB;IAEJ;;;;;OAKG;IACH,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAO/D;IAED;;;OAGG;IACH,QAAQ,IAAI,MAAM,CAEjB;IACD;;;OAGG;IACH,QAAQ,IAAI,MAAM,CAEjB;IACD;;;;;;OAMG;IACH,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,KAAA,EAAE,OAAO,KAAA,EAAE,OAAO,KAAA,UAE5C;CACF;AAED,MAAM,MAAM,YAAY,GAAG;IACzB;;;OAGG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,CAAC,IAAI,EAAE,OAAO,MAAM,EAAE,GAAG;QACvB,SAAS,EAAE,MAAM,CAAC;QAClB,UAAU,EAAE,MAAM,CAAC;QACnB,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IACF;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;OAIG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACtD;;;;OAIG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CACvD;AAED;;GAEG;AACH,qBAAa,aAAa,CAAC,CAAC,SAAS,uBAAuB,GAAG,uBAAuB,CACpF,SAAQ,OAAO,CAAC,CAAC,CACjB,YAAW,eAAe;IAE1B,OAAO,CAAC,MAAM,CAAC,UAAU,CAA0C;IAEnE;;;;;;OAMG;IACH,MAAM,CAAC,iBAAiB,CACtB,IAAI,EAAE,MAAM,EACZ,SAAS,EAAE;QAAE,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;QAAC,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAA;KAAE,QAMtG;IACD,kBAAkB,EAAE,MAAM,CAAC;IAC3B,mBAAmB,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,CAAC;IAC/D,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE;QACJ,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CAAC;KAC/B,CAAC;IACF;;OAEG;IACH,IAAI,EAAE;QACJ,CAAC,GAAG,EAAE,MAAM,GAAG;YACb,CAAC,EAAE,MAAM,CAAC;YACV,CAAC,EAAE,MAAM,CAAC;SACX,CAAC;KACH,CAAM;IAEP;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAQ1B;IAED;;;OAGG;IAOG,SAAS,CAAC,OAAO,EAAE,gBAAgB,iBAmBxC;IAED;;;OAGG;IACG,IAAI,IAAI,OAAO,CAAC,OAAO,CAAC,CAiB7B;IAED;;;OAGG;IACH,qBAAqB,IAAI;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,CAOjE;IAED;;;OAGG;IACH,mBAAmB,IAAI,MAAM,CAE5B;IAED;;;OAGG;IACG,cAAc,IAAI,OAAO,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,cAAc,CAAA;KAAE,CAAC,CAcpE;IAED;;;;;OAKG;IACU,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAMrE;IAED;;;;;OAKG;IACU,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAS1E;IAED;;;;;OAKG;IACU,OAAO,CAAC,IAAI,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,CAiBrE;IAED;;;;OAIG;IACG,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAY9C;IAED;;;;OAIG;IACU,SAAS,CAAC,MAAM,KAAA,EAAE,QAAQ,KAAA,iBAkBtC;IAED;;;;;OAKG;IACU,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,GAAG,GAAG,CAAC,CAkBjF;IAED;;;;OAIG;IACU,OAAO,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,CAe/C;IAED;;;;OAIG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,OAEzB;IAED;;;;OAIG;IACH,OAAoB,oBAAoB,CAAC,IAAI,EAAE,GAAG,gBAqBjD;IAED;;;;OAIG;IACH,OAAoB,oBAAoB,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,CAsBhE;IAED;;;;OAIG;IACU,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAUhD;IAED;;;OAGG;IACH,SAAS,IAAI;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,CAIvC;IAED;;OAEG;IACG,MAAM,kBA2BX;CACF;eAwBc,aAAa;AAE5B;;;;;;GAMG;AACH,wBAAgB,SAAS,2CAExB"}