@nmshd/connector-types 6.17.0 → 6.17.2

package/README.md

@@ -6,7 +6,7 @@
 >
 > This package is still in development and should not be used yet.
 
-This package provides TypeScript types for writing connector modules.
+This package provides TypeScript types for writing Connector modules.
 
 ## Documentation
 
@@ -18,11 +18,11 @@ To get started developing in this repository, see the [developer's guide](README
 
 Please file any bugs or feature requests by creating an [issue](https://github.com/nmshd/feedback/issues).
 
-Share your feedback with the Enmeshed team by contributing to the [discussions](https://github.com/nmshd/feedback/discussions).
+Share your feedback with the enmeshed team by contributing to the [discussions](https://github.com/nmshd/feedback/discussions).
 
 ## Contribute
 
-Contribution to this project is highly apprecicated. Head over to our [contribution guide](https://github.com/nmshd/.github/blob/main/CONTRIBUTING.md) to learn more.
+Contribution to this project is highly appreciated. Head over to our [contribution guide](https://github.com/nmshd/.github/blob/main/CONTRIBUTING.md) to learn more.
 
 ## License
 

package/dist/infrastructure/httpServer/BaseController.d.ts

@@ -0,0 +1,14 @@
+import { Result } from "@js-soft/ts-utils";
+import { Return } from "@nmshd/typescript-rest";
+import express from "express";
+import { Envelope } from "./common/Envelope";
+import { Mimetype } from "./common/Mimetype";
+export declare abstract class BaseController {
+    protected created<T>(result: Result<T>): Return.NewResource<Envelope>;
+    protected ok<T>(result: Result<T>): Envelope;
+    protected noContent<T>(result: Result<T>): void;
+    private json;
+    private guard;
+    protected file<T extends Result<any>>(result: T, contentPredicate: (result: T) => Buffer | string | Uint8Array | undefined, filenamePredicate: (result: T) => string, mimetypePredicate: (result: T) => Mimetype, response: express.Response, status: number): void;
+}
+//# sourceMappingURL=BaseController.d.ts.map

package/dist/infrastructure/httpServer/BaseController.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseController.d.ts","sourceRoot":"","sources":["../../../src/infrastructure/httpServer/BaseController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAChD,OAAO,OAAO,MAAM,SAAS,CAAC;AAC9B,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE7C,8BAAsB,cAAc;IAChC,SAAS,CAAC,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC;IAIrE,SAAS,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,QAAQ;IAI5C,SAAS,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI;IAK/C,OAAO,CAAC,IAAI;IAKZ,OAAO,CAAC,KAAK;IAMb,SAAS,CAAC,IAAI,CAAC,CAAC,SAAS,MAAM,CAAC,GAAG,CAAC,EAChC,MAAM,EAAE,CAAC,EACT,gBAAgB,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,MAAM,GAAG,MAAM,GAAG,UAAU,GAAG,SAAS,EACzE,iBAAiB,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,MAAM,EACxC,iBAAiB,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,QAAQ,EAC1C,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAC1B,MAAM,EAAE,MAAM,GACf,IAAI;CAwBV"}

package/dist/infrastructure/httpServer/BaseController.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseController = void 0;
+const typescript_rest_1 = require("@nmshd/typescript-rest");
+const Envelope_1 = require("./common/Envelope");
+class BaseController {
+    created(result) {
+        return new typescript_rest_1.Return.NewResource("_", this.json(result));
+    }
+    ok(result) {
+        return this.json(result);
+    }
+    noContent(result) {
+        this.guard(result);
+        return;
+    }
+    json(result) {
+        this.guard(result);
+        return Envelope_1.Envelope.ok(result.value);
+    }
+    guard(result) {
+        if (result.isError) {
+            throw result.error;
+        }
+    }
+    file(result, contentPredicate, filenamePredicate, mimetypePredicate, response, status) {
+        this.guard(result);
+        const content = contentPredicate(result);
+        const filename = filenamePredicate(result);
+        const mimetype = mimetypePredicate(result);
+        if (!content)
+            throw new Error("'content' cannot be undefined");
+        let buffer;
+        if (content instanceof Buffer) {
+            buffer = content;
+        }
+        else if (content instanceof Uint8Array) {
+            buffer = Buffer.from(content);
+        }
+        else {
+            buffer = Buffer.from(content, "base64");
+        }
+        response
+            .status(status)
+            .setHeader("content-type", mimetype.value)
+            .setHeader("content-disposition", `attachment;filename=${encodeURIComponent(filename)}`)
+            .send(buffer);
+    }
+}
+exports.BaseController = BaseController;
+//# sourceMappingURL=BaseController.js.map

package/dist/infrastructure/httpServer/BaseController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseController.js","sourceRoot":"","sources":["../../../src/infrastructure/httpServer/BaseController.ts"],"names":[],"mappings":";;;AACA,4DAAgD;AAEhD,gDAA6C;AAG7C,MAAsB,cAAc;IACtB,OAAO,CAAI,MAAiB;QAClC,OAAO,IAAI,wBAAM,CAAC,WAAW,CAAW,GAAG,EAAE,IAAI,CAAC,IAAI,CAAI,MAAM,CAAC,CAAC,CAAC;IACvE,CAAC;IAES,EAAE,CAAI,MAAiB;QAC7B,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC7B,CAAC;IAES,SAAS,CAAI,MAAiB;QACpC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACnB,OAAO;IACX,CAAC;IAEO,IAAI,CAAI,MAAiB;QAC7B,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACnB,OAAO,mBAAQ,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC;IAEO,KAAK,CAAI,MAAiB;QAC9B,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACjB,MAAM,MAAM,CAAC,KAAK,CAAC;QACvB,CAAC;IACL,CAAC;IAES,IAAI,CACV,MAAS,EACT,gBAAyE,EACzE,iBAAwC,EACxC,iBAA0C,EAC1C,QAA0B,EAC1B,MAAc;QAEd,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAEnB,MAAM,OAAO,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;QACzC,MAAM,QAAQ,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC;QAC3C,MAAM,QAAQ,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC;QAE3C,IAAI,CAAC,OAAO;YAAE,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;QAE/D,IAAI,MAAc,CAAC;QACnB,IAAI,OAAO,YAAY,MAAM,EAAE,CAAC;YAC5B,MAAM,GAAG,OAAO,CAAC;QACrB,CAAC;aAAM,IAAI,OAAO,YAAY,UAAU,EAAE,CAAC;YACvC,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAClC,CAAC;aAAM,CAAC;YACJ,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QAC5C,CAAC;QAED,QAAQ;aACH,MAAM,CAAC,MAAM,CAAC;aACd,SAAS,CAAC,cAAc,EAAE,QAAQ,CAAC,KAAK,CAAC;aACzC,SAAS,CAAC,qBAAqB,EAAE,uBAAuB,kBAAkB,CAAC,QAAQ,CAAC,EAAE,CAAC;aACvF,IAAI,CAAC,MAAM,CAAC,CAAC;IACtB,CAAC;CACJ;AAxDD,wCAwDC"}

package/dist/infrastructure/httpServer/common/Mimetype.d.ts

@@ -0,0 +1,9 @@
+export declare class Mimetype {
+    value: string;
+    constructor(value: string);
+    static png(): Mimetype;
+    static jpeg(): Mimetype;
+    static json(): Mimetype;
+    static pdf(): Mimetype;
+}
+//# sourceMappingURL=Mimetype.d.ts.map

package/dist/infrastructure/httpServer/common/Mimetype.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Mimetype.d.ts","sourceRoot":"","sources":["../../../../src/infrastructure/httpServer/common/Mimetype.ts"],"names":[],"mappings":"AAAA,qBAAa,QAAQ;IACS,KAAK,EAAE,MAAM;gBAAb,KAAK,EAAE,MAAM;WAEzB,GAAG,IAAI,QAAQ;WAIf,IAAI,IAAI,QAAQ;WAIhB,IAAI,IAAI,QAAQ;WAIhB,GAAG,IAAI,QAAQ;CAGhC"}

package/dist/infrastructure/httpServer/common/Mimetype.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Mimetype = void 0;
+class Mimetype {
+    constructor(value) {
+        this.value = value;
+    }
+    static png() {
+        return new Mimetype("image/png");
+    }
+    static jpeg() {
+        return new Mimetype("image/png");
+    }
+    static json() {
+        return new Mimetype("application/json");
+    }
+    static pdf() {
+        return new Mimetype("application/pdf");
+    }
+}
+exports.Mimetype = Mimetype;
+//# sourceMappingURL=Mimetype.js.map

package/dist/infrastructure/httpServer/common/Mimetype.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Mimetype.js","sourceRoot":"","sources":["../../../../src/infrastructure/httpServer/common/Mimetype.ts"],"names":[],"mappings":";;;AAAA,MAAa,QAAQ;IACjB,YAA0B,KAAa;QAAb,UAAK,GAAL,KAAK,CAAQ;IAAG,CAAC;IAEpC,MAAM,CAAC,GAAG;QACb,OAAO,IAAI,QAAQ,CAAC,WAAW,CAAC,CAAC;IACrC,CAAC;IAEM,MAAM,CAAC,IAAI;QACd,OAAO,IAAI,QAAQ,CAAC,WAAW,CAAC,CAAC;IACrC,CAAC;IAEM,MAAM,CAAC,IAAI;QACd,OAAO,IAAI,QAAQ,CAAC,kBAAkB,CAAC,CAAC;IAC5C,CAAC;IAEM,MAAM,CAAC,GAAG;QACb,OAAO,IAAI,QAAQ,CAAC,iBAAiB,CAAC,CAAC;IAC3C,CAAC;CACJ;AAlBD,4BAkBC"}

package/dist/infrastructure/httpServer/common/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./Envelope";
 export * from "./HttpError";
 export * from "./HttpErrors";
+export * from "./Mimetype";
 //# sourceMappingURL=index.d.ts.map

package/dist/infrastructure/httpServer/common/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/infrastructure/httpServer/common/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/infrastructure/httpServer/common/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC"}

package/dist/infrastructure/httpServer/common/index.js

@@ -17,4 +17,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./Envelope"), exports);
 __exportStar(require("./HttpError"), exports);
 __exportStar(require("./HttpErrors"), exports);
+__exportStar(require("./Mimetype"), exports);
 //# sourceMappingURL=index.js.map

package/dist/infrastructure/httpServer/common/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/infrastructure/httpServer/common/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,8CAA4B;AAC5B,+CAA6B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/infrastructure/httpServer/common/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,8CAA4B;AAC5B,+CAA6B;AAC7B,6CAA2B"}

package/dist/infrastructure/httpServer/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./BaseController";
 export * from "./common";
 export * from "./HttpMethod";
 export * from "./IHttpServer";

package/dist/infrastructure/httpServer/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/infrastructure/httpServer/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/infrastructure/httpServer/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC"}

package/dist/infrastructure/httpServer/index.js

@@ -14,6 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./BaseController"), exports);
 __exportStar(require("./common"), exports);
 __exportStar(require("./HttpMethod"), exports);
 __exportStar(require("./IHttpServer"), exports);

package/dist/infrastructure/httpServer/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/infrastructure/httpServer/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,+CAA6B;AAC7B,gDAA8B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/infrastructure/httpServer/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAiC;AACjC,2CAAyB;AACzB,+CAA6B;AAC7B,gDAA8B"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@nmshd/connector-types",
-    "description": "the enmeshed connector types",
+    "description": "the enmeshed Connector types",
     "keywords": [
         "enmeshed",
         "connector"
@@ -24,19 +24,22 @@
         "build:ci": "tsc",
         "build:watch": "tsc --watch"
     },
-    "peerDependencies": {
-        "@nmshd/runtime": "^6.32.0"
-    },
     "devDependencies": {
         "@js-soft/logging-abstractions": "^1.0.1",
         "@types/express": "^5.0.1",
         "@types/luxon": "^3.4.2",
-        "@types/node": "^22.13.10",
+        "@types/node": "^22.13.13",
         "typescript": "^5.8.2"
     },
+    "peerDependencies": {
+        "@js-soft/ts-utils": "^2.3.3",
+        "@nmshd/runtime": "^6.33.0",
+        "@nmshd/typescript-rest": "^3.1.1",
+        "express": "^4.21.2"
+    },
     "publishConfig": {
         "access": "public",
         "provenance": true
     },
-    "version": "6.17.0"
+    "version": "6.17.2"
 }