@rapidrest/service-core 1.0.0-beta.1

package/dist/lib/security/AccessControlListMongo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AccessControlListMongo.js","sourceRoot":"","sources":["../../../src/security/AccessControlListMongo.ts"],"names":[],"mappings":";;;;;;;;;AAAA,+EAA+E;AAC/E,wEAAwE;AACxE,+EAA+E;AAC/E,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACxE,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAErD,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,wCAAwC,CAAC;AAC/E,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,GAAG,aAAa,CAAC;AAChD,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,eAAe,CAAC;AAE7C;;GAEG;AAYI,IAAM,cAAc,GAApB,MAAM,cAAc;IAsCvB,YAAY,KAAW;QACnB,IAAI,KAAK,EAAE,CAAC;YACR,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC;YACvC,IAAI,CAAC,MAAM,GAAG,QAAQ,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;YACtD,IAAI,CAAC,IAAI,GAAG,MAAM,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;YAChD,IAAI,CAAC,MAAM,GAAG,QAAQ,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;YACtD,IAAI,CAAC,MAAM,GAAG,QAAQ,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;YACtD,IAAI,CAAC,OAAO,GAAG,SAAS,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;YACzD,IAAI,CAAC,IAAI,GAAG,MAAM,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;QACpD,CAAC;aAAM,CAAC;YACJ,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;QACtD,CAAC;IACL,CAAC;CACJ,CAAA;AA7CU;IALN,WAAW,CACR,kJAAkJ,CACrJ;IACA,MAAM,EAAE;IACR,KAAK,CAAC,cAAc,CAAC;;oDACM;AAKrB;IAHN,WAAW,CAAC,qDAAqD,CAAC;IAClE,MAAM,EAAE;IACR,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC;;8CACU;AAKvB;IAHN,WAAW,CAAC,iDAAiD,CAAC;IAC9D,MAAM,EAAE;IACR,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC;;4CACQ;AAKrB;IAHN,WAAW,CAAC,0DAA0D,CAAC;IACvE,MAAM,EAAE;IACR,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC;;8CACU;AAKvB;IAHN,WAAW,CAAC,0DAA0D,CAAC;IACvE,MAAM,EAAE;IACR,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC;;8CACU;AAKvB;IAHN,WAAW,CAAC,qEAAqE,CAAC;IAClF,MAAM,EAAE;IACR,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC;;+CACW;AAKxB;IAHN,WAAW,CAAC,+FAA+F,CAAC;IAC5G,MAAM,EAAE;IACR,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC;;4CACQ;AApCnB,cAAc;IAX1B,MAAM,EAAE;IACR,WAAW,CAAC;;;;;;;;;4GAS+F,CAAC;;GAChG,cAAc,CAmD1B;;AAED;;GAEG;AAyBI,IAAM,sBAAsB,GAA5B,MAAM,sBAAuB,SAAQ,eAAe;IAgBvD,YAAY,KAAW;QACnB,KAAK,CAAC,KAAK,CAAC,CAAC;QAHV,YAAO,GAAqB,EAAE,CAAC;QAKlC,IAAI,KAAK,EAAE,CAAC;YACR,IAAI,CAAC,MAAM,GAAG,QAAQ,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;YAC7D,IAAI,CAAC,SAAS,GAAG,WAAW,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC;YAEzE,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;gBAChB,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;gBAClB,KAAK,MAAM,MAAM,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;oBACjC,MAAM,SAAS,GAAmB,IAAI,cAAc,CAAC,MAAM,CAAC,CAAC;oBAC7D,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBACjC,CAAC;YACL,CAAC;QACL,CAAC;IACL,CAAC;CACJ,CAAA;AAvBU;IANN,WAAW,CACR,qHAAqH,CACxH;IACA,MAAM,EAAE;IACR,KAAK,CAAC,WAAW,CAAC;IAClB,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC;;yDACmB;AAK/B;IAHN,WAAW,CAAC,8EAA8E,CAAC;IAC3F,MAAM,EAAE;IACR,QAAQ,CAAC,CAAC,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC,CAAC;;uDACE;AAd7B,sBAAsB;IAxBlC,SAAS,CAAC,KAAK,CAAC;IAChB,MAAM,EAAE;IACR,KAAK,CAAC,IAAI,CAAC;IACX,WAAW,CAAC;;;;;;;;;;;;;;;;;;;;SAoBJ,CAAC;;GACG,sBAAsB,CAgClC"}

package/dist/lib/security/AccessControlListSQL.js

@@ -0,0 +1,149 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2020-2026 Jean-Philippe Steinmetz. All rights reserved.
+///////////////////////////////////////////////////////////////////////////////
+import { DocDecorators, ModelDecorators } from "../decorators/index.js";
+import { BaseEntity } from "../models/BaseEntity.js";
+import { Column, Entity, Index } from "../decorators/PersistenceDecorators.js";
+const { Description, TypeInfo } = DocDecorators;
+const { Cache, DataStore } = ModelDecorators;
+/**
+ * Implementation of the `ACLRecord` interface for use with SQL databases.
+ */
+let ACLRecordSQL = class ACLRecordSQL {
+    constructor(other) {
+        if (other) {
+            this.userOrRoleId = other.userOrRoleId;
+            this.create = "create" in other ? other.create : null;
+            this.read = "read" in other ? other.read : null;
+            this.update = "update" in other ? other.update : null;
+            this.delete = "delete" in other ? other.delete : null;
+            this.special = "special" in other ? other.special : null;
+            this.full = "full" in other ? other.full : null;
+        }
+        else {
+            throw new Error("Argument other cannot be null.");
+        }
+    }
+};
+__decorate([
+    Description("The unique identiifer of the user or role that the record will apply to. This can also be a regular expression to match multiple users or roles."),
+    Column(),
+    Index("userOrRoleId"),
+    __metadata("design:type", String)
+], ACLRecordSQL.prototype, "userOrRoleId", void 0);
+__decorate([
+    Description("The user or role can create a new record or object."),
+    Column(),
+    TypeInfo([Boolean]),
+    __metadata("design:type", Object)
+], ACLRecordSQL.prototype, "create", void 0);
+__decorate([
+    Description("The user or role can read the record or object."),
+    Column(),
+    TypeInfo([Boolean]),
+    __metadata("design:type", Object)
+], ACLRecordSQL.prototype, "read", void 0);
+__decorate([
+    Description("The user or role can modify existing records or objects."),
+    Column(),
+    TypeInfo([Boolean]),
+    __metadata("design:type", Object)
+], ACLRecordSQL.prototype, "update", void 0);
+__decorate([
+    Description("The user or role can delete existing records or objects."),
+    Column(),
+    TypeInfo([Boolean]),
+    __metadata("design:type", Object)
+], ACLRecordSQL.prototype, "delete", void 0);
+__decorate([
+    Description("The user or role has special prilieges to edit the ACL permissions."),
+    Column(),
+    TypeInfo([Boolean]),
+    __metadata("design:type", Object)
+], ACLRecordSQL.prototype, "special", void 0);
+__decorate([
+    Description("The user or role has total control over the record or object and supersedes any of the above."),
+    Column(),
+    TypeInfo([Boolean]),
+    __metadata("design:type", Object)
+], ACLRecordSQL.prototype, "full", void 0);
+ACLRecordSQL = __decorate([
+    Entity(),
+    Description(`
+The \`ACLRecord\` interface describes a single permissions entry in an \`AccessControlList\` that grants or denies a set of permissions to a single user or role.
+
+Each permission can be one of the following actions:
+ - \`Create\` - The user or role can create a new record or object.
+ - \`Read\` - The user or role can read the record or object.
+ - \`Update\` - The user or role can modify existing records or objects.
+ - \`Delete\` - The user or role can delete existing records or objects.
+ - \`Special\` - The user or role has special prilieges to edit the ACL permissions.
+ - \`Full\` - The user or role has total control over the record or object and supersedes any of the above.`),
+    __metadata("design:paramtypes", [Object])
+], ACLRecordSQL);
+export { ACLRecordSQL };
+/**
+ * Implementation of the `AccessControlList` interface for use with SQL databases.
+ */
+let AccessControlListSQL = class AccessControlListSQL extends BaseEntity {
+    constructor(other) {
+        super(other);
+        this.records = [];
+        if (other) {
+            this.parent = "parent" in other ? other.parent : this.parent;
+            this.parentUid = "parentUid" in other ? other.parentUid : this.parentUid;
+            this.records = "records" in other ? other.records : this.records;
+        }
+    }
+};
+__decorate([
+    Description("The universally unique identifier of the parent `AccessControlList` that this object will inherit permissions from."),
+    Column(),
+    Index("parentUid"),
+    TypeInfo([String]),
+    __metadata("design:type", Object)
+], AccessControlListSQL.prototype, "parentUid", void 0);
+__decorate([
+    Description("The list of all permission records associated with this access control list."),
+    Column(),
+    TypeInfo([[Array, ACLRecordSQL]]),
+    __metadata("design:type", Array)
+], AccessControlListSQL.prototype, "records", void 0);
+AccessControlListSQL = __decorate([
+    DataStore("acl"),
+    Entity(),
+    Cache(),
+    Description(`The access control list provides a generic interface for the storage of user and roles permissions. Each ACL object
+ represents the permission set for a single entity within the system. The entity is identified generically by its
+ universally unique identifier (\`uuid\`). Each entry in the ACL records the permissions available to a particular user
+ or role.
+
+ Each permission can be one of the following actions:
+ - \`Create\` - The user or role can create a new record or object.
+ - \`Read\` - The user or role can read the record or object.
+ - \`Update\` - The user or role can modify existing records or objects.
+ - \`Delete\` - The user or role can delete existing records or objects.
+ - \`Special\` - The user or role has special prilieges to edit the ACL permissions.
+ - \`Full\` - The user or role has total control over the record or object and supersedes any of the above.
+
+ For each of the above actions the user or role will be granted either an \`allow\` permission or a \`deny\` permission.
+ If an \`allow\` is granted, the user or role has permission to perform that action. If a \`deny\` is set, then the user
+ or role is denied that action. If no explicit \`allow\` or \`deny\` is set then the user or role will inherit the
+ permission from a parent role or ACL.
+
+ ACLs can be chained via single inheritance through the specification of the \`parentUid\`. This allows the ability to
+ create complex trees of permissions that can easily inherit control schemes to make the definition of permissions
+ easier.`),
+    __metadata("design:paramtypes", [Object])
+], AccessControlListSQL);
+export { AccessControlListSQL };
+//# sourceMappingURL=AccessControlListSQL.js.map

package/dist/lib/security/AccessControlListSQL.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AccessControlListSQL.js","sourceRoot":"","sources":["../../../src/security/AccessControlListSQL.ts"],"names":[],"mappings":";;;;;;;;;AAAA,+EAA+E;AAC/E,wEAAwE;AACxE,+EAA+E;AAC/E,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACxE,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAErD,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,wCAAwC,CAAC;AAC/E,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,GAAG,aAAa,CAAC;AAChD,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,eAAe,CAAC;AAE7C;;GAEG;AAYI,IAAM,YAAY,GAAlB,MAAM,YAAY;IAsCrB,YAAY,KAAW;QACnB,IAAI,KAAK,EAAE,CAAC;YACR,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC;YACvC,IAAI,CAAC,MAAM,GAAG,QAAQ,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;YACtD,IAAI,CAAC,IAAI,GAAG,MAAM,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;YAChD,IAAI,CAAC,MAAM,GAAG,QAAQ,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;YACtD,IAAI,CAAC,MAAM,GAAG,QAAQ,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;YACtD,IAAI,CAAC,OAAO,GAAG,SAAS,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;YACzD,IAAI,CAAC,IAAI,GAAG,MAAM,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;QACpD,CAAC;aAAM,CAAC;YACJ,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;QACtD,CAAC;IACL,CAAC;CACJ,CAAA;AA7CU;IALN,WAAW,CACR,kJAAkJ,CACrJ;IACA,MAAM,EAAE;IACR,KAAK,CAAC,cAAc,CAAC;;kDACM;AAKrB;IAHN,WAAW,CAAC,qDAAqD,CAAC;IAClE,MAAM,EAAE;IACR,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC;;4CACU;AAKvB;IAHN,WAAW,CAAC,iDAAiD,CAAC;IAC9D,MAAM,EAAE;IACR,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC;;0CACQ;AAKrB;IAHN,WAAW,CAAC,0DAA0D,CAAC;IACvE,MAAM,EAAE;IACR,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC;;4CACU;AAKvB;IAHN,WAAW,CAAC,0DAA0D,CAAC;IACvE,MAAM,EAAE;IACR,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC;;4CACU;AAKvB;IAHN,WAAW,CAAC,qEAAqE,CAAC;IAClF,MAAM,EAAE;IACR,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC;;6CACW;AAKxB;IAHN,WAAW,CAAC,+FAA+F,CAAC;IAC5G,MAAM,EAAE;IACR,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC;;0CACQ;AApCnB,YAAY;IAXxB,MAAM,EAAE;IACR,WAAW,CAAC;;;;;;;;;4GAS+F,CAAC;;GAChG,YAAY,CAmDxB;;AAED;;GAEG;AAyBI,IAAM,oBAAoB,GAA1B,MAAM,oBAAqB,SAAQ,UAAU;IAgBhD,YAAY,KAAW;QACnB,KAAK,CAAC,KAAK,CAAC,CAAC;QAHV,YAAO,GAAmB,EAAE,CAAC;QAKhC,IAAI,KAAK,EAAE,CAAC;YACR,IAAI,CAAC,MAAM,GAAG,QAAQ,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;YAC7D,IAAI,CAAC,SAAS,GAAG,WAAW,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC;YACzE,IAAI,CAAC,OAAO,GAAG,SAAS,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;QACrE,CAAC;IACL,CAAC;CACJ,CAAA;AAhBU;IANN,WAAW,CACR,qHAAqH,CACxH;IACA,MAAM,EAAE;IACR,KAAK,CAAC,WAAW,CAAC;IAClB,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC;;uDACmB;AAK/B;IAHN,WAAW,CAAC,8EAA8E,CAAC;IAC3F,MAAM,EAAE;IACR,QAAQ,CAAC,CAAC,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC;;qDACE;AAd3B,oBAAoB;IAxBhC,SAAS,CAAC,KAAK,CAAC;IAChB,MAAM,EAAE;IACR,KAAK,EAAE;IACP,WAAW,CAAC;;;;;;;;;;;;;;;;;;;;SAoBJ,CAAC;;GACG,oBAAoB,CAyBhC"}

package/dist/lib/security/index.js

@@ -0,0 +1,3 @@
+export * from "./AccessControlList.js";
+export * from "./ACLUtils.js";
+//# sourceMappingURL=index.js.map

package/dist/lib/security/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/security/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAC;AACvC,cAAc,eAAe,CAAC"}

package/dist/lib/test/index.js

@@ -0,0 +1,3 @@
+export * from "./request.js";
+export * from "./requestws.js";
+//# sourceMappingURL=index.js.map

package/dist/lib/test/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/test/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC"}

package/dist/lib/test/request.js

@@ -0,0 +1,99 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2020-2026 Jean-Philippe Steinmetz. All rights reserved.
+///////////////////////////////////////////////////////////////////////////////
+/**
+ * Supertest-compatible HTTP test helper built on axios.
+ * Accepts either a Server instance (extracts port from server.port) or a port number.
+ */
+import axios from "axios";
+function extractPort(app) {
+    if (typeof app === "number")
+        return app;
+    // Server instance
+    if (app && typeof app.port === "number")
+        return app.port;
+    // HttpRouter instance
+    if (app && typeof app.listenPort === "number")
+        return app.listenPort;
+    throw new Error("request(): cannot determine port from argument");
+}
+function extractMimeType(contentType) {
+    if (!contentType)
+        return "";
+    return contentType.split(";")[0].trim();
+}
+/**
+ * Creates a supertest-style request builder that sends requests via axios to
+ * `http://localhost:<port>`.
+ */
+export function request(app) {
+    const port = extractPort(app);
+    const baseUrl = `http://localhost:${port}`;
+    function makeChain(method, url) {
+        const hdrs = {};
+        let body = undefined;
+        const chain = {
+            set(key, value) {
+                hdrs[key] = value;
+                return chain;
+            },
+            send(data) {
+                body = data;
+                return chain;
+            },
+            then(onFulfilled, onRejected) {
+                // Auto-set Content-Type for JSON object bodies
+                if (body !== undefined && typeof body === "object" && !Buffer.isBuffer(body)) {
+                    hdrs["content-type"] = hdrs["content-type"] || "application/json";
+                }
+                return axios
+                    .request({
+                    method,
+                    url: baseUrl + url,
+                    data: body,
+                    headers: hdrs,
+                    validateStatus: () => true,
+                    responseType: "text",
+                    transformResponse: (data) => data,
+                })
+                    .then((res) => {
+                    const raw = res.data;
+                    const ct = res.headers["content-type"];
+                    const mime = extractMimeType(ct);
+                    let parsed;
+                    try {
+                        parsed = JSON.parse(raw);
+                    }
+                    catch {
+                        parsed = raw;
+                    }
+                    const result = {
+                        status: res.status,
+                        statusCode: res.status,
+                        body: parsed,
+                        text: raw,
+                        type: mime,
+                        headers: res.headers,
+                        ok: res.status >= 200 && res.status < 300,
+                    };
+                    return onFulfilled ? onFulfilled(result) : result;
+                })
+                    .catch(onRejected);
+            },
+            catch(onRejected) {
+                return chain.then(undefined, onRejected);
+            },
+        };
+        return chain;
+    }
+    return {
+        get: (url) => makeChain("GET", url),
+        post: (url) => makeChain("POST", url),
+        put: (url) => makeChain("PUT", url),
+        delete: (url) => makeChain("DELETE", url),
+        patch: (url) => makeChain("PATCH", url),
+        head: (url) => makeChain("HEAD", url),
+        options: (url) => makeChain("OPTIONS", url),
+    };
+}
+//# sourceMappingURL=request.js.map

package/dist/lib/test/request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request.js","sourceRoot":"","sources":["../../../src/test/request.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,wEAAwE;AACxE,+EAA+E;AAC/E;;;GAGG;AACH,OAAO,KAAK,MAAM,OAAO,CAAC;AAc1B,SAAS,WAAW,CAAC,GAAQ;IACzB,IAAI,OAAO,GAAG,KAAK,QAAQ;QAAE,OAAO,GAAG,CAAC;IACxC,kBAAkB;IAClB,IAAI,GAAG,IAAI,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ;QAAE,OAAO,GAAG,CAAC,IAAI,CAAC;IACzD,sBAAsB;IACtB,IAAI,GAAG,IAAI,OAAO,GAAG,CAAC,UAAU,KAAK,QAAQ;QAAE,OAAO,GAAG,CAAC,UAAU,CAAC;IACrE,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;AACtE,CAAC;AAED,SAAS,eAAe,CAAC,WAAoB;IACzC,IAAI,CAAC,WAAW;QAAE,OAAO,EAAE,CAAC;IAC5B,OAAO,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;AAC5C,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,OAAO,CAAC,GAAQ;IAC5B,MAAM,IAAI,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;IAC9B,MAAM,OAAO,GAAG,oBAAoB,IAAI,EAAE,CAAC;IAE3C,SAAS,SAAS,CAAC,MAAc,EAAE,GAAW;QAC1C,MAAM,IAAI,GAA2B,EAAE,CAAC;QACxC,IAAI,IAAI,GAAQ,SAAS,CAAC;QAE1B,MAAM,KAAK,GAAQ;YACf,GAAG,CAAC,GAAW,EAAE,KAAa;gBAC1B,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;gBAClB,OAAO,KAAK,CAAC;YACjB,CAAC;YACD,IAAI,CAAC,IAAS;gBACV,IAAI,GAAG,IAAI,CAAC;gBACZ,OAAO,KAAK,CAAC;YACjB,CAAC;YACD,IAAI,CAAC,WAAgB,EAAE,UAAgB;gBACnC,+CAA+C;gBAC/C,IAAI,IAAI,KAAK,SAAS,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC3E,IAAI,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,kBAAkB,CAAC;gBACtE,CAAC;gBACD,OAAO,KAAK;qBACP,OAAO,CAAC;oBACL,MAAM;oBACN,GAAG,EAAE,OAAO,GAAG,GAAG;oBAClB,IAAI,EAAE,IAAI;oBACV,OAAO,EAAE,IAAI;oBACb,cAAc,EAAE,GAAG,EAAE,CAAC,IAAI;oBAC1B,YAAY,EAAE,MAAM;oBACpB,iBAAiB,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI;iBACpC,CAAC;qBACD,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE;oBACV,MAAM,GAAG,GAAG,GAAG,CAAC,IAAc,CAAC;oBAC/B,MAAM,EAAE,GAAG,GAAG,CAAC,OAAO,CAAC,cAAc,CAAuB,CAAC;oBAC7D,MAAM,IAAI,GAAG,eAAe,CAAC,EAAE,CAAC,CAAC;oBACjC,IAAI,MAAW,CAAC;oBAChB,IAAI,CAAC;wBACD,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;oBAC7B,CAAC;oBAAC,MAAM,CAAC;wBACL,MAAM,GAAG,GAAG,CAAC;oBACjB,CAAC;oBACD,MAAM,MAAM,GAAiB;wBACzB,MAAM,EAAE,GAAG,CAAC,MAAM;wBAClB,UAAU,EAAE,GAAG,CAAC,MAAM;wBACtB,IAAI,EAAE,MAAM;wBACZ,IAAI,EAAE,GAAG;wBACT,IAAI,EAAE,IAAI;wBACV,OAAO,EAAE,GAAG,CAAC,OAAiC;wBAC9C,EAAE,EAAE,GAAG,CAAC,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,MAAM,GAAG,GAAG;qBAC5C,CAAC;oBACF,OAAO,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;gBACtD,CAAC,CAAC;qBACD,KAAK,CAAC,UAAU,CAAC,CAAC;YAC3B,CAAC;YACD,KAAK,CAAC,UAAe;gBACjB,OAAO,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;YAC7C,CAAC;SACJ,CAAC;QAEF,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO;QACH,GAAG,EAAE,CAAC,GAAW,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC;QAC3C,IAAI,EAAE,CAAC,GAAW,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,GAAG,CAAC;QAC7C,GAAG,EAAE,CAAC,GAAW,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC;QAC3C,MAAM,EAAE,CAAC,GAAW,EAAE,EAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,GAAG,CAAC;QACjD,KAAK,EAAE,CAAC,GAAW,EAAE,EAAE,CAAC,SAAS,CAAC,OAAO,EAAE,GAAG,CAAC;QAC/C,IAAI,EAAE,CAAC,GAAW,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,GAAG,CAAC;QAC7C,OAAO,EAAE,CAAC,GAAW,EAAE,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,GAAG,CAAC;KACtD,CAAC;AACN,CAAC"}

package/dist/lib/test/requestws.js

@@ -0,0 +1,173 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2020-2026 Jean-Philippe Steinmetz. All rights reserved.
+///////////////////////////////////////////////////////////////////////////////
+/**
+ * Superwstest-compatible WebSocket test helper built on the `ws` package.
+ * Accepts a port number (or a Server instance with a `port` property).
+ */
+import { WebSocket } from "ws";
+/** Fluent WebSocket test chain, mirrors the superwstest API. */
+export class WsChain {
+    constructor(url, wsOptions) {
+        this.actions = [];
+        this.url = url;
+        this.wsOptions = wsOptions;
+    }
+    expectText(value) {
+        this.actions.push({ kind: "expectText", value });
+        return this;
+    }
+    expectJson(value) {
+        this.actions.push({ kind: "expectJson", value });
+        return this;
+    }
+    expectClosed(code, reason) {
+        this.actions.push({ kind: "expectClosed", code, reason });
+        return this;
+    }
+    sendText(value) {
+        this.actions.push({ kind: "sendText", value });
+        return this;
+    }
+    sendJson(value) {
+        this.actions.push({ kind: "sendJson", value });
+        return this;
+    }
+    close() {
+        this.actions.push({ kind: "close" });
+        return this;
+    }
+    /** Execute the queued actions and resolve when all pass. */
+    then(onFulfilled, onRejected) {
+        return this._run().then(onFulfilled, onRejected);
+    }
+    catch(onRejected) {
+        return this._run().catch(onRejected);
+    }
+    _run() {
+        return new Promise((resolve, reject) => {
+            const actions = [...this.actions];
+            let actionIndex = 0;
+            let closed = false;
+            const ws = new WebSocket(this.url, this.wsOptions);
+            const timeout = setTimeout(() => {
+                ws.terminate();
+                reject(new Error(`WebSocket test timed out at action ${actionIndex}: ${JSON.stringify(actions[actionIndex])}`));
+            }, 10000);
+            const fail = (err) => {
+                clearTimeout(timeout);
+                ws.terminate();
+                reject(err instanceof Error ? err : new Error(String(err)));
+            };
+            const done = () => {
+                clearTimeout(timeout);
+                ws.terminate();
+                resolve();
+            };
+            /** Execute the next action, or resolve if all done. */
+            const next = () => {
+                if (actionIndex >= actions.length) {
+                    done();
+                    return;
+                }
+                const action = actions[actionIndex++];
+                if (action.kind === "sendText") {
+                    ws.send(action.value, (err) => {
+                        if (err) {
+                            fail(err);
+                            return;
+                        }
+                        next();
+                    });
+                }
+                else if (action.kind === "sendJson") {
+                    ws.send(JSON.stringify(action.value), (err) => {
+                        if (err) {
+                            fail(err);
+                            return;
+                        }
+                        next();
+                    });
+                }
+                else if (action.kind === "close") {
+                    ws.close();
+                    next();
+                }
+                else if (action.kind === "expectClosed") {
+                    const checkClose = (code, _reason) => {
+                        if (action.code !== undefined && code !== action.code) {
+                            fail(new Error(`Expected close code ${action.code} but got ${code}`));
+                            return;
+                        }
+                        if (action.reason !== undefined) {
+                            const reasonStr = _reason.toString();
+                            if (reasonStr !== action.reason) {
+                                fail(new Error(`Expected close reason "${action.reason}" but got "${reasonStr}"`));
+                                return;
+                            }
+                        }
+                        closed = true;
+                        next();
+                    };
+                    if (closed) {
+                        next();
+                    }
+                    else {
+                        ws.once("close", checkClose);
+                    }
+                }
+                else {
+                    // expectText / expectJson — wait for next message
+                    ws.once("message", (raw) => {
+                        try {
+                            const text = raw.toString();
+                            if (action.kind === "expectText") {
+                                if (text !== action.value) {
+                                    fail(new Error(`Expected text "${action.value}" but got "${text}"`));
+                                    return;
+                                }
+                            }
+                            else if (action.kind === "expectJson") {
+                                const parsed = JSON.parse(text);
+                                // Deep equal check
+                                const exp = JSON.stringify(action.value);
+                                const got = JSON.stringify(parsed);
+                                if (exp !== got) {
+                                    fail(new Error(`Expected JSON ${exp} but got ${got}`));
+                                    return;
+                                }
+                            }
+                            next();
+                        }
+                        catch (err) {
+                            fail(err);
+                        }
+                    });
+                }
+            };
+            ws.on("error", fail);
+            ws.on("close", () => { closed = true; });
+            ws.on("open", () => {
+                next();
+            });
+        });
+    }
+}
+/** Creates a superwstest-style chain connected to `ws://localhost:<port>`. */
+export function requestws(appOrPort) {
+    const port = typeof appOrPort === "number"
+        ? appOrPort
+        : appOrPort?.port ?? appOrPort?.listenPort;
+    if (!port) {
+        throw new Error("requestws(): cannot determine port from argument");
+    }
+    return {
+        ws(path, options) {
+            const wsOptions = options
+                ? { headers: options.headers }
+                : undefined;
+            return new WsChain(`ws://localhost:${port}${path}`, wsOptions);
+        },
+    };
+}
+//# sourceMappingURL=requestws.js.map

package/dist/lib/test/requestws.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"requestws.js","sourceRoot":"","sources":["../../../src/test/requestws.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,wEAAwE;AACxE,+EAA+E;AAC/E;;;GAGG;AACH,OAAO,EAAE,SAAS,EAAE,MAAM,IAAI,CAAC;AAU/B,gEAAgE;AAChE,MAAM,OAAO,OAAO;IAKhB,YAAY,GAAW,EAAE,SAAe;QAFvB,YAAO,GAAe,EAAE,CAAC;QAGtC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC/B,CAAC;IAED,UAAU,CAAC,KAAa;QACpB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC,CAAC;QACjD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,UAAU,CAAC,KAAU;QACjB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC,CAAC;QACjD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,YAAY,CAAC,IAAa,EAAE,MAAe;QACvC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,QAAQ,CAAC,KAAa;QAClB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAC;QAC/C,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,QAAQ,CAAC,KAAU;QACf,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAC;QAC/C,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,KAAK;QACD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;QACrC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,4DAA4D;IAC5D,IAAI,CACA,WAAwE,EACxE,UAAuE;QAEvE,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;IACrD,CAAC;IAED,KAAK,CACD,UAAqE;QAErE,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACzC,CAAC;IAEO,IAAI;QACR,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACzC,MAAM,OAAO,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;YAClC,IAAI,WAAW,GAAG,CAAC,CAAC;YACpB,IAAI,MAAM,GAAG,KAAK,CAAC;YAEnB,MAAM,EAAE,GAAG,IAAI,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;YACnD,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE;gBAC5B,EAAE,CAAC,SAAS,EAAE,CAAC;gBACf,MAAM,CAAC,IAAI,KAAK,CAAC,sCAAsC,WAAW,KAAK,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;YACpH,CAAC,EAAE,KAAK,CAAC,CAAC;YAEV,MAAM,IAAI,GAAG,CAAC,GAAQ,EAAE,EAAE;gBACtB,YAAY,CAAC,OAAO,CAAC,CAAC;gBACtB,EAAE,CAAC,SAAS,EAAE,CAAC;gBACf,MAAM,CAAC,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YAChE,CAAC,CAAC;YAEF,MAAM,IAAI,GAAG,GAAG,EAAE;gBACd,YAAY,CAAC,OAAO,CAAC,CAAC;gBACtB,EAAE,CAAC,SAAS,EAAE,CAAC;gBACf,OAAO,EAAE,CAAC;YACd,CAAC,CAAC;YAEF,uDAAuD;YACvD,MAAM,IAAI,GAAG,GAAG,EAAE;gBACd,IAAI,WAAW,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;oBAChC,IAAI,EAAE,CAAC;oBACP,OAAO;gBACX,CAAC;gBAED,MAAM,MAAM,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;gBAEtC,IAAI,MAAM,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;oBAC7B,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,GAAG,EAAE,EAAE;wBAC1B,IAAI,GAAG,EAAE,CAAC;4BAAC,IAAI,CAAC,GAAG,CAAC,CAAC;4BAAC,OAAO;wBAAC,CAAC;wBAC/B,IAAI,EAAE,CAAC;oBACX,CAAC,CAAC,CAAC;gBACP,CAAC;qBAAM,IAAI,MAAM,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;oBACpC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE;wBAC1C,IAAI,GAAG,EAAE,CAAC;4BAAC,IAAI,CAAC,GAAG,CAAC,CAAC;4BAAC,OAAO;wBAAC,CAAC;wBAC/B,IAAI,EAAE,CAAC;oBACX,CAAC,CAAC,CAAC;gBACP,CAAC;qBAAM,IAAI,MAAM,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;oBACjC,EAAE,CAAC,KAAK,EAAE,CAAC;oBACX,IAAI,EAAE,CAAC;gBACX,CAAC;qBAAM,IAAI,MAAM,CAAC,IAAI,KAAK,cAAc,EAAE,CAAC;oBACxC,MAAM,UAAU,GAAG,CAAC,IAAY,EAAE,OAAe,EAAE,EAAE;wBACjD,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC;4BACpD,IAAI,CAAC,IAAI,KAAK,CAAC,uBAAuB,MAAM,CAAC,IAAI,YAAY,IAAI,EAAE,CAAC,CAAC,CAAC;4BACtE,OAAO;wBACX,CAAC;wBACD,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;4BAC9B,MAAM,SAAS,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;4BACrC,IAAI,SAAS,KAAK,MAAM,CAAC,MAAM,EAAE,CAAC;gCAC9B,IAAI,CAAC,IAAI,KAAK,CAAC,0BAA0B,MAAM,CAAC,MAAM,cAAc,SAAS,GAAG,CAAC,CAAC,CAAC;gCACnF,OAAO;4BACX,CAAC;wBACL,CAAC;wBACD,MAAM,GAAG,IAAI,CAAC;wBACd,IAAI,EAAE,CAAC;oBACX,CAAC,CAAC;oBACF,IAAI,MAAM,EAAE,CAAC;wBACT,IAAI,EAAE,CAAC;oBACX,CAAC;yBAAM,CAAC;wBACJ,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;oBACjC,CAAC;gBACL,CAAC;qBAAM,CAAC;oBACJ,kDAAkD;oBAClD,EAAE,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,GAAQ,EAAE,EAAE;wBAC5B,IAAI,CAAC;4BACD,MAAM,IAAI,GAAG,GAAG,CAAC,QAAQ,EAAE,CAAC;4BAC5B,IAAI,MAAM,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;gCAC/B,IAAI,IAAI,KAAK,MAAM,CAAC,KAAK,EAAE,CAAC;oCACxB,IAAI,CAAC,IAAI,KAAK,CAAC,kBAAkB,MAAM,CAAC,KAAK,cAAc,IAAI,GAAG,CAAC,CAAC,CAAC;oCACrE,OAAO;gCACX,CAAC;4BACL,CAAC;iCAAM,IAAI,MAAM,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;gCACtC,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gCAChC,mBAAmB;gCACnB,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;gCACzC,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;gCACnC,IAAI,GAAG,KAAK,GAAG,EAAE,CAAC;oCACd,IAAI,CAAC,IAAI,KAAK,CAAC,iBAAiB,GAAG,YAAY,GAAG,EAAE,CAAC,CAAC,CAAC;oCACvD,OAAO;gCACX,CAAC;4BACL,CAAC;4BACD,IAAI,EAAE,CAAC;wBACX,CAAC;wBAAC,OAAO,GAAG,EAAE,CAAC;4BACX,IAAI,CAAC,GAAG,CAAC,CAAC;wBACd,CAAC;oBACL,CAAC,CAAC,CAAC;gBACP,CAAC;YACL,CAAC,CAAC;YAEF,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;YACrB,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,GAAG,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAEzC,EAAE,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE;gBACf,IAAI,EAAE,CAAC;YACX,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC;CACJ;AAED,8EAA8E;AAC9E,MAAM,UAAU,SAAS,CAAC,SAAc;IACpC,MAAM,IAAI,GAAG,OAAO,SAAS,KAAK,QAAQ;QACtC,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,SAAS,EAAE,IAAI,IAAI,SAAS,EAAE,UAAU,CAAC;IAE/C,IAAI,CAAC,IAAI,EAAE,CAAC;QACR,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;IACxE,CAAC;IAED,OAAO;QACH,EAAE,CAAC,IAAY,EAAE,OAAa;YAC1B,MAAM,SAAS,GAAG,OAAO;gBACrB,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE;gBAC9B,CAAC,CAAC,SAAS,CAAC;YAChB,OAAO,IAAI,OAAO,CAAC,kBAAkB,IAAI,GAAG,IAAI,EAAE,EAAE,SAAS,CAAC,CAAC;QACnE,CAAC;KACJ,CAAC;AACN,CAAC"}

package/dist/types/ApiErrors.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Defines the unique codes for all common API errors.
+ */
+export declare enum ApiErrors {
+    UNKNOWN = "api-001",
+    INTERNAL_ERROR = "api-002",
+    INVALID_REQUEST = "api-003",
+    NOT_FOUND = "api-010",
+    IDENTIFIER_EXISTS = "api-011",
+    INVALID_OBJECT_VERSION = "api-012",
+    OBJECT_ID_MISMATCH = "api-013",
+    SEARCH_INVALID_RANGE = "api-014",
+    SEARCH_INVALID_ME_REFERENCE = "api-015",
+    BULK_CREATE_FAILURE = "api-021",
+    BULK_UPDATE_FAILURE = "api-022",
+    AUTH_REQUIRED = "api-100",
+    AUTH_FAILED = "api-101",
+    AUTH_PERMISSION_FAILURE = "api-102"
+}
+/**
+ * Defines the default message of all common API errors.
+ */
+export declare enum ApiErrorMessages {
+    UNKNOWN = "An unknown error has occurred. Please try again.",
+    INTERNAL_ERROR = "An internal error has occurred. Please contact the adminstrator.",
+    INVALID_REQUEST = "Invalid message or request.",
+    NOT_FOUND = "No resource could be found with the specified identifier.",
+    IDENTIFIER_EXISTS = "A resource with that identifier already exists.",
+    INVALID_OBJECT_VERSION = "Invalid object version. Do you have the latest version?",
+    OBJECT_ID_MISMATCH = "The object provided does not match the identifier given.",
+    SEARCH_INVALID_RANGE = "Invalid range value: '{{value}}'. Expected 2 arguments, got {{length}}",
+    SEARCH_INVALID_ME_REFERENCE = "Use of the `me` reference requires authentication.",
+    BULK_CREATE_FAILURE = "Failed to create one or more objects.",
+    BULK_UPDATE_FAILURE = "Failed to update one or more objects.",
+    AUTH_REQUIRED = "Authorization is required to access this resource.",
+    AUTH_FAILED = "Invalid or missing authentication token.",
+    AUTH_PERMISSION_FAILURE = "User does not have permission to perform this action."
+}

package/dist/types/BackgroundService.d.ts

@@ -0,0 +1,30 @@
+/**
+ * The `BackgroundService` is an abstract base class for defining scheduled background services. A background service
+ * executes in the background once on startup or on a set schedule (like a cron job) and performs additional processing.
+ *
+ * @author Jean-Philippe Steinmetz <rapidrests@gmail.com>
+ */
+export declare abstract class BackgroundService {
+    /** The global application configuration that the service can reference. */
+    protected config: any;
+    /** The logging utility to use. */
+    protected logger: any;
+    constructor(config: any, logger: any);
+    /**
+     * Returns the desired execution interval that this service should be scheduled with. If `undefined` is returned
+     * the service is executed only once.
+     */
+    abstract get schedule(): string | undefined;
+    /**
+     * The processing function to execute at each scheduled interval.
+     */
+    abstract run(): Promise<void> | void;
+    /**
+     * Initializes the background service with any defaults.
+     */
+    abstract start(): Promise<void> | void;
+    /**
+     * Shuts down the background allowing the service to complete any outstanding tasks.
+     */
+    abstract stop(): Promise<void> | void;
+}

package/dist/types/BackgroundServiceManager.d.ts

@@ -0,0 +1,66 @@
+import { BackgroundService } from "./BackgroundService.js";
+import { ObjectFactory } from "./ObjectFactory.js";
+/**
+ * The `BackgroundServiceManager` manages all configured background services in the application. It is responsible for
+ * initializing the jobs, scheduling them and performing any related shutdown tasks. See the `BackgroundService`
+ * class for details on how to create a background service class to be used by this manager.
+ *
+ * ## Usage
+ * To use the manager instantiate a new object and provide the required constructor arguments. Then simply call the
+ * `startAll` function. When shutting your application down you should call the `stopAll` function.
+ *
+ * ```
+ * import { BackgroundServiceManager } from "@rapidrest/service-core";
+ *
+ * const manager: BackgroundServiceManager = new BackgroundServiceManager(objectFactory, serviceClasses, config, logger);
+ * await manager.startAll();
+ * ...
+ * await manager.stopAll();
+ * ```
+ *
+ * You may optionally start and stop individual services using the `start` and `stop` functions respectively.
+ *
+ * ```
+ * await manager.start("MyService");
+ * ...
+ * await manger.stop("MyService");
+ * ```
+ * @author Jean-Philippe Steinmetz <rapidrests@gmail.com>
+ */
+export declare class BackgroundServiceManager {
+    private readonly config;
+    private classes;
+    private jobs;
+    private readonly logger;
+    private objectFactory;
+    private services;
+    constructor(objectFactory: ObjectFactory, classes: {}, config: any, logger: any);
+    /**
+     * Returns the service instance with the given name.
+     *
+     * @param name The name of the background service to retrieve.
+     */
+    getService(name: string): BackgroundService | undefined;
+    /**
+     * Starts all configured background services.
+     */
+    startAll(): Promise<void>;
+    /**
+     * Starts the background service with the given name.
+     *
+     * @param serviceName The name of the background service to start.
+     * @param clazz The class type of the service to start. If not specified the name is used to lookup the class type.
+     * @param args The list of arguments to pass into the service constructor
+     */
+    start(serviceName: string, clazz?: any, ...args: any): Promise<void>;
+    /**
+     * Stops all currently active background services that are owned by the manager.
+     */
+    stopAll(): Promise<void>;
+    /**
+     * Stops the background service with the given name.
+     *
+     * @param serviceName The name of the background service to stop.
+     */
+    stop(serviceName: string): Promise<void>;
+}

package/dist/types/BulkError.d.ts

@@ -0,0 +1,11 @@
+import { ApiError } from "@rapidrest/core";
+/**
+ * An error take that takes an array of other errors.
+ */
+export declare class BulkError extends ApiError {
+    /**
+     * The list of errors that have been thrown.
+     */
+    readonly errors: (Error | null)[];
+    constructor(errs: (Error | null)[], code: string, defaultStatus: number, message?: string);
+}