@3sixty/api-models 0.0.0-stage → 0.20.0-next.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 IOTA Stiftung.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,25 @@
-# Temporary Holding Version
+# 3Sixty API Models
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+This package provides shared API contracts, route types, and response models used across services and clients.
+
+## Installation
+
+```shell
+npm install @3sixty/api-models
+```
+
+## Examples
+
+Usage of the APIs is shown in the examples [docs/examples.md](docs/examples.md)
+
+## Reference
+
+Detailed reference documentation for the API can be found in [docs/reference/index.md](docs/reference/index.md)
+
+## Changelog
+
+The changes between each version can be found in [docs/changelog.md](docs/changelog.md)
+
+## Origin
+
+This package is derived from the original [iotaledger/twin-api](https://github.com/iotaledger/twin-api/tree/next/packages/api-models) repository.

package/dist/es/errors/forbiddenError.js

@@ -0,0 +1,23 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { BaseError } from "@3sixty/core";
+/**
+ * Class to handle errors which are triggered by forbidden actions.
+ */
+export class ForbiddenError extends BaseError {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "ForbiddenError";
+    /**
+     * Create a new instance of ForbiddenError.
+     * @param source The source of the error.
+     * @param message The message as a code.
+     * @param properties Any additional information for the error.
+     * @param cause The cause of the error if we have wrapped another error.
+     */
+    constructor(source, message, properties, cause) {
+        super(ForbiddenError.CLASS_NAME, source, message, properties, cause);
+    }
+}
+//# sourceMappingURL=forbiddenError.js.map

package/dist/es/errors/forbiddenError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"forbiddenError.js","sources":["../../../src/errors/forbiddenError.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAGzC;;GAEG;AACH,MAAM,OAAO,cAAe,SAAQ,SAAS;IAC5C;;OAEG;IACI,MAAM,CAAU,UAAU,GAAW,gBAAgB,CAAC;IAE7D;;;;;;OAMG;IACH,YACC,MAAc,EACd,OAAe,EACf,UAAsC,EACtC,KAAe;QAEf,KAAK,CAAC,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;IACtE,CAAC;CACD","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { BaseError } from \"@3sixty/core\";\n\n\n/**\n * Class to handle errors which are triggered by forbidden actions.\n */\nexport class ForbiddenError extends BaseError {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = \"ForbiddenError\";\n\n\t/**\n\t * Create a new instance of ForbiddenError.\n\t * @param source The source of the error.\n\t * @param message The message as a code.\n\t * @param properties Any additional information for the error.\n\t * @param cause The cause of the error if we have wrapped another error.\n\t */\n\tconstructor(\n\t\tsource: string,\n\t\tmessage: string,\n\t\tproperties?: { [id: string]: unknown },\n\t\tcause?: unknown\n\t) {\n\t\tsuper(ForbiddenError.CLASS_NAME, source, message, properties, cause);\n\t}\n}\n"]}

package/dist/es/errors/tooManyRequestsError.js

@@ -0,0 +1,25 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { BaseError } from "@3sixty/core";
+/**
+ * Class to handle errors which are triggered by too many requests.
+ */
+export class TooManyRequestsError extends BaseError {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "TooManyRequestsError";
+    /**
+     * Create a new instance of TooManyRequestsError.
+     * @param source The source of the error.
+     * @param message The message as a code.
+     * @param requestCount The current request count.
+     * @param nextRequestTime The time when the next request can be made, as date ISO string.
+     * @param properties Any additional information for the error.
+     * @param cause The cause of the error if we have wrapped another error.
+     */
+    constructor(source, message, requestCount, nextRequestTime, properties, cause) {
+        super(TooManyRequestsError.CLASS_NAME, source, message, { requestCount, nextRequestTime, ...properties }, cause);
+    }
+}
+//# sourceMappingURL=tooManyRequestsError.js.map

package/dist/es/errors/tooManyRequestsError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tooManyRequestsError.js","sources":["../../../src/errors/tooManyRequestsError.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAGzC;;GAEG;AACH,MAAM,OAAO,oBAAqB,SAAQ,SAAS;IAClD;;OAEG;IACI,MAAM,CAAU,UAAU,GAAW,sBAAsB,CAAC;IAEnE;;;;;;;;OAQG;IACH,YACC,MAAc,EACd,OAAe,EACf,YAAoB,EACpB,eAAuB,EACvB,UAAsC,EACtC,KAAe;QAEf,KAAK,CACJ,oBAAoB,CAAC,UAAU,EAC/B,MAAM,EACN,OAAO,EACP,EAAE,YAAY,EAAE,eAAe,EAAE,GAAG,UAAU,EAAE,EAChD,KAAK,CACL,CAAC;IACH,CAAC;CACD","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { BaseError } from \"@3sixty/core\";\n\n\n/**\n * Class to handle errors which are triggered by too many requests.\n */\nexport class TooManyRequestsError extends BaseError {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = \"TooManyRequestsError\";\n\n\t/**\n\t * Create a new instance of TooManyRequestsError.\n\t * @param source The source of the error.\n\t * @param message The message as a code.\n\t * @param requestCount The current request count.\n\t * @param nextRequestTime The time when the next request can be made, as date ISO string.\n\t * @param properties Any additional information for the error.\n\t * @param cause The cause of the error if we have wrapped another error.\n\t */\n\tconstructor(\n\t\tsource: string,\n\t\tmessage: string,\n\t\trequestCount: number,\n\t\tnextRequestTime: string,\n\t\tproperties?: { [id: string]: unknown },\n\t\tcause?: unknown\n\t) {\n\t\tsuper(\n\t\t\tTooManyRequestsError.CLASS_NAME,\n\t\t\tsource,\n\t\t\tmessage,\n\t\t\t{ requestCount, nextRequestTime, ...properties },\n\t\t\tcause\n\t\t);\n\t}\n}\n"]}

package/dist/es/factories/mimeTypeProcessorFactory.js

@@ -0,0 +1,9 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Factory } from "@3sixty/core";
+/**
+ * Factory for creating implementation of mime type processor types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const MimeTypeProcessorFactory = Factory.createFactory("mime-type-processor");
+//# sourceMappingURL=mimeTypeProcessorFactory.js.map

package/dist/es/factories/mimeTypeProcessorFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mimeTypeProcessorFactory.js","sources":["../../../src/factories/mimeTypeProcessorFactory.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAGvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,wBAAwB,GACpC,OAAO,CAAC,aAAa,CAAqB,qBAAqB,CAAC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Factory } from \"@3sixty/core\";\nimport type { IMimeTypeProcessor } from \"../models/server/IMimeTypeProcessor.js\";\n\n/**\n * Factory for creating implementation of mime type processor types.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const MimeTypeProcessorFactory =\n\tFactory.createFactory<IMimeTypeProcessor>(\"mime-type-processor\");\n"]}

package/dist/es/factories/restClientProcessorFactory.js

@@ -0,0 +1,9 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Factory } from "@3sixty/core";
+/**
+ * Factory for creating implementation of REST client processor types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const RestClientProcessorFactory = Factory.createFactory("rest-client-processor");
+//# sourceMappingURL=restClientProcessorFactory.js.map

package/dist/es/factories/restClientProcessorFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"restClientProcessorFactory.js","sources":["../../../src/factories/restClientProcessorFactory.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAGvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,0BAA0B,GACtC,OAAO,CAAC,aAAa,CAAuB,uBAAuB,CAAC,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Factory } from \"@3sixty/core\";\nimport type { IRestClientProcessor } from \"../models/client/IRestClientProcessor.js\";\n\n/**\n * Factory for creating implementation of REST client processor types.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const RestClientProcessorFactory =\n\tFactory.createFactory<IRestClientProcessor>(\"rest-client-processor\");\n"]}

package/dist/es/factories/restRouteProcessorFactory.js

@@ -0,0 +1,9 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Factory } from "@3sixty/core";
+/**
+ * Factory for creating implementation of REST route processor types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const RestRouteProcessorFactory = Factory.createFactory("rest-route-processor");
+//# sourceMappingURL=restRouteProcessorFactory.js.map

package/dist/es/factories/restRouteProcessorFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"restRouteProcessorFactory.js","sources":["../../../src/factories/restRouteProcessorFactory.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAGvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,yBAAyB,GACrC,OAAO,CAAC,aAAa,CAAsB,sBAAsB,CAAC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Factory } from \"@3sixty/core\";\nimport type { IRestRouteProcessor } from \"../models/server/IRestRouteProcessor.js\";\n\n/**\n * Factory for creating implementation of REST route processor types.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const RestRouteProcessorFactory =\n\tFactory.createFactory<IRestRouteProcessor>(\"rest-route-processor\");\n"]}

package/dist/es/factories/socketRouteProcessorFactory.js

@@ -0,0 +1,9 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Factory } from "@3sixty/core";
+/**
+ * Factory for creating implementation of socket route processor types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const SocketRouteProcessorFactory = Factory.createFactory("socket-route-processor");
+//# sourceMappingURL=socketRouteProcessorFactory.js.map

package/dist/es/factories/socketRouteProcessorFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"socketRouteProcessorFactory.js","sources":["../../../src/factories/socketRouteProcessorFactory.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAGvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,2BAA2B,GACvC,OAAO,CAAC,aAAa,CAAwB,wBAAwB,CAAC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Factory } from \"@3sixty/core\";\nimport type { ISocketRouteProcessor } from \"../models/server/ISocketRouteProcessor.js\";\n\n/**\n * Factory for creating implementation of socket route processor types.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const SocketRouteProcessorFactory =\n\tFactory.createFactory<ISocketRouteProcessor>(\"socket-route-processor\");\n"]}

package/dist/es/helpers/httpErrorHelper.js

@@ -0,0 +1,75 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { AlreadyExistsError, BaseError, ConflictError, GuardError, NotFoundError, NotImplementedError, UnauthorizedError, UnprocessableError, ValidationError } from "@3sixty/core";
+import { HeaderTypes, HttpStatusCode, MimeTypes } from "@3sixty/web";
+import { ForbiddenError } from "../errors/forbiddenError.js";
+import { TooManyRequestsError } from "../errors/tooManyRequestsError.js";
+/**
+ * Class to help with processing http errors.
+ */
+export class HttpErrorHelper {
+    /**
+     * Mapping of error types to status codes.
+     */
+    static ERROR_TYPE_MAP = {
+        [GuardError.CLASS_NAME]: HttpStatusCode.badRequest,
+        [ValidationError.CLASS_NAME]: HttpStatusCode.badRequest,
+        [ConflictError.CLASS_NAME]: HttpStatusCode.conflict,
+        [AlreadyExistsError.CLASS_NAME]: HttpStatusCode.conflict,
+        [NotFoundError.CLASS_NAME]: HttpStatusCode.notFound,
+        [UnauthorizedError.CLASS_NAME]: HttpStatusCode.unauthorized,
+        [NotImplementedError.CLASS_NAME]: HttpStatusCode.notImplemented,
+        [UnprocessableError.CLASS_NAME]: HttpStatusCode.unprocessableEntity,
+        [TooManyRequestsError.CLASS_NAME]: HttpStatusCode.tooManyRequests,
+        [ForbiddenError.CLASS_NAME]: HttpStatusCode.forbidden
+    };
+    /**
+     * Process the errors from the routes.
+     * @param err The error to process.
+     * @param includeStack Should the stack be included in the error.
+     * @returns The status code and additional error data.
+     */
+    static processError(err, includeStack) {
+        const error = BaseError.fromError(err);
+        // If the error or any of its sub errors are of the specific
+        // types then set the http response code accordingly
+        const flattened = BaseError.flatten(error);
+        let httpStatusCode = HttpStatusCode.internalServerError;
+        // First check the primary error, as we don't want to override that with a sub error
+        if (flattened.length > 0) {
+            const primaryError = flattened[0];
+            if (HttpErrorHelper.ERROR_TYPE_MAP[primaryError.name]) {
+                httpStatusCode = HttpErrorHelper.ERROR_TYPE_MAP[primaryError.name];
+            }
+            // The primary error is still internal server error, check the sub errors
+            if (httpStatusCode === HttpStatusCode.internalServerError) {
+                for (const className in HttpErrorHelper.ERROR_TYPE_MAP) {
+                    if (flattened.some(e => BaseError.isErrorName(e, className))) {
+                        httpStatusCode = HttpErrorHelper.ERROR_TYPE_MAP[className];
+                        break;
+                    }
+                }
+            }
+        }
+        const returnError = error.toJsonObject(includeStack);
+        return {
+            error: returnError,
+            httpStatusCode
+        };
+    }
+    /**
+     * Build an error response.
+     * @param response The response to build the error into.
+     * @param error The error to build the response for.
+     * @param statusCode The status code to use for the error.
+     * @param includeStack Should the stack be included in the error.
+     */
+    static buildResponse(response, error, statusCode, includeStack) {
+        response.headers ??= {};
+        response.headers[HeaderTypes.ContentType] = `${MimeTypes.Json}; charset=utf-8`;
+        // Fastify treats an Error-typed body as a framework error and overrides the status with 500.
+        response.body = BaseError.fromError(error).toJsonObject(includeStack);
+        response.statusCode = statusCode;
+    }
+}
+//# sourceMappingURL=httpErrorHelper.js.map

package/dist/es/helpers/httpErrorHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"httpErrorHelper.js","sources":["../../../src/helpers/httpErrorHelper.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EACN,kBAAkB,EAClB,SAAS,EACT,aAAa,EACb,UAAU,EAEV,aAAa,EACb,mBAAmB,EACnB,iBAAiB,EACjB,kBAAkB,EAClB,eAAe,EACf,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACrE,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAGzE;;GAEG;AACH,MAAM,OAAO,eAAe;IAC3B;;OAEG;IACI,MAAM,CAAU,cAAc,GAAqC;QACzE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,cAAc,CAAC,UAAU;QAClD,CAAC,eAAe,CAAC,UAAU,CAAC,EAAE,cAAc,CAAC,UAAU;QACvD,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,cAAc,CAAC,QAAQ;QACnD,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE,cAAc,CAAC,QAAQ;QACxD,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,cAAc,CAAC,QAAQ;QACnD,CAAC,iBAAiB,CAAC,UAAU,CAAC,EAAE,cAAc,CAAC,YAAY;QAC3D,CAAC,mBAAmB,CAAC,UAAU,CAAC,EAAE,cAAc,CAAC,cAAc;QAC/D,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE,cAAc,CAAC,mBAAmB;QACnE,CAAC,oBAAoB,CAAC,UAAU,CAAC,EAAE,cAAc,CAAC,eAAe;QACjE,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,cAAc,CAAC,SAAS;KACrD,CAAC;IAEF;;;;;OAKG;IACI,MAAM,CAAC,YAAY,CACzB,GAAY,EACZ,YAAsB;QAKtB,MAAM,KAAK,GAAc,SAAS,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAElD,4DAA4D;QAC5D,oDAAoD;QACpD,MAAM,SAAS,GAAG,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAE3C,IAAI,cAAc,GAAmB,cAAc,CAAC,mBAAmB,CAAC;QAExE,oFAAoF;QACpF,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1B,MAAM,YAAY,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;YAClC,IAAI,eAAe,CAAC,cAAc,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC;gBACvD,cAAc,GAAG,eAAe,CAAC,cAAc,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;YACpE,CAAC;YAED,yEAAyE;YACzE,IAAI,cAAc,KAAK,cAAc,CAAC,mBAAmB,EAAE,CAAC;gBAC3D,KAAK,MAAM,SAAS,IAAI,eAAe,CAAC,cAAc,EAAE,CAAC;oBACxD,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC;wBAC9D,cAAc,GAAG,eAAe,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;wBAC3D,MAAM;oBACP,CAAC;gBACF,CAAC;YACF,CAAC;QACF,CAAC;QAED,MAAM,WAAW,GAAG,KAAK,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;QAErD,OAAO;YACN,KAAK,EAAE,WAAW;YAClB,cAAc;SACd,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,aAAa,CAC1B,QAAuB,EACvB,KAAa,EACb,UAA0B,EAC1B,YAAqB;QAErB,QAAQ,CAAC,OAAO,KAAK,EAAE,CAAC;QACxB,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,WAAW,CAAC,GAAG,GAAG,SAAS,CAAC,IAAI,iBAAiB,CAAC;QAC/E,6FAA6F;QAC7F,QAAQ,CAAC,IAAI,GAAG,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;QACtE,QAAQ,CAAC,UAAU,GAAG,UAAU,CAAC;IAClC,CAAC;CACD","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport {\n\tAlreadyExistsError,\n\tBaseError,\n\tConflictError,\n\tGuardError,\n\ttype IError,\n\tNotFoundError,\n\tNotImplementedError,\n\tUnauthorizedError,\n\tUnprocessableError,\n\tValidationError\n} from \"@3sixty/core\";\nimport { HeaderTypes, HttpStatusCode, MimeTypes } from \"@3sixty/web\";\nimport { ForbiddenError } from \"../errors/forbiddenError.js\";\nimport { TooManyRequestsError } from \"../errors/tooManyRequestsError.js\";\nimport type { IHttpResponse } from \"../models/protocol/IHttpResponse.js\";\n\n/**\n * Class to help with processing http errors.\n */\nexport class HttpErrorHelper {\n\t/**\n\t * Mapping of error types to status codes.\n\t */\n\tpublic static readonly ERROR_TYPE_MAP: { [id: string]: HttpStatusCode } = {\n\t\t[GuardError.CLASS_NAME]: HttpStatusCode.badRequest,\n\t\t[ValidationError.CLASS_NAME]: HttpStatusCode.badRequest,\n\t\t[ConflictError.CLASS_NAME]: HttpStatusCode.conflict,\n\t\t[AlreadyExistsError.CLASS_NAME]: HttpStatusCode.conflict,\n\t\t[NotFoundError.CLASS_NAME]: HttpStatusCode.notFound,\n\t\t[UnauthorizedError.CLASS_NAME]: HttpStatusCode.unauthorized,\n\t\t[NotImplementedError.CLASS_NAME]: HttpStatusCode.notImplemented,\n\t\t[UnprocessableError.CLASS_NAME]: HttpStatusCode.unprocessableEntity,\n\t\t[TooManyRequestsError.CLASS_NAME]: HttpStatusCode.tooManyRequests,\n\t\t[ForbiddenError.CLASS_NAME]: HttpStatusCode.forbidden\n\t};\n\n\t/**\n\t * Process the errors from the routes.\n\t * @param err The error to process.\n\t * @param includeStack Should the stack be included in the error.\n\t * @returns The status code and additional error data.\n\t */\n\tpublic static processError(\n\t\terr: unknown,\n\t\tincludeStack?: boolean\n\t): {\n\t\terror: IError;\n\t\thttpStatusCode: HttpStatusCode;\n\t} {\n\t\tconst error: BaseError = BaseError.fromError(err);\n\n\t\t// If the error or any of its sub errors are of the specific\n\t\t// types then set the http response code accordingly\n\t\tconst flattened = BaseError.flatten(error);\n\n\t\tlet httpStatusCode: HttpStatusCode = HttpStatusCode.internalServerError;\n\n\t\t// First check the primary error, as we don't want to override that with a sub error\n\t\tif (flattened.length > 0) {\n\t\t\tconst primaryError = flattened[0];\n\t\t\tif (HttpErrorHelper.ERROR_TYPE_MAP[primaryError.name]) {\n\t\t\t\thttpStatusCode = HttpErrorHelper.ERROR_TYPE_MAP[primaryError.name];\n\t\t\t}\n\n\t\t\t// The primary error is still internal server error, check the sub errors\n\t\t\tif (httpStatusCode === HttpStatusCode.internalServerError) {\n\t\t\t\tfor (const className in HttpErrorHelper.ERROR_TYPE_MAP) {\n\t\t\t\t\tif (flattened.some(e => BaseError.isErrorName(e, className))) {\n\t\t\t\t\t\thttpStatusCode = HttpErrorHelper.ERROR_TYPE_MAP[className];\n\t\t\t\t\t\tbreak;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\tconst returnError = error.toJsonObject(includeStack);\n\n\t\treturn {\n\t\t\terror: returnError,\n\t\t\thttpStatusCode\n\t\t};\n\t}\n\n\t/**\n\t * Build an error response.\n\t * @param response The response to build the error into.\n\t * @param error The error to build the response for.\n\t * @param statusCode The status code to use for the error.\n\t * @param includeStack Should the stack be included in the error.\n\t */\n\tpublic static buildResponse(\n\t\tresponse: IHttpResponse,\n\t\terror: IError,\n\t\tstatusCode: HttpStatusCode,\n\t\tincludeStack: boolean\n\t): void {\n\t\tresponse.headers ??= {};\n\t\tresponse.headers[HeaderTypes.ContentType] = `${MimeTypes.Json}; charset=utf-8`;\n\t\t// Fastify treats an Error-typed body as a framework error and overrides the status with 500.\n\t\tresponse.body = BaseError.fromError(error).toJsonObject(includeStack);\n\t\tresponse.statusCode = statusCode;\n\t}\n}\n"]}

package/dist/es/helpers/httpHeaderHelper.js

@@ -0,0 +1,120 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { GeneralError, Guards, Is, StringHelper } from "@3sixty/core";
+import { HeaderHelper, HeaderTypes, MimeTypes } from "@3sixty/web";
+import { HttpUrlHelper } from "./httpUrlHelper.js";
+/**
+ * Class to help with handling http headers.
+ */
+export class HttpHeaderHelper {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "HttpHeaderHelper";
+    /**
+     * Set the Link header with a next cursor relation when a cursor is present.
+     * @param headers The response headers to mutate.
+     * @param url The request URL used as the base for the link.
+     * @param publicOrigin The public origin to substitute into the URL, if any.
+     * @param cursor The cursor value; when undefined or empty the header is not set.
+     */
+    static buildCursor(headers, url, publicOrigin, cursor) {
+        if (Is.stringValue(cursor)) {
+            const baseUrl = HttpUrlHelper.replaceOrigin(url, publicOrigin);
+            const cursorUrl = HttpUrlHelper.addQueryStringParam(baseUrl, "cursor", cursor);
+            headers[HeaderTypes.Link] = HeaderHelper.createLinkHeader(cursorUrl, undefined, "next");
+        }
+    }
+    /**
+     * Set the Location header to the encoded ID, optionally placed within a URL template.
+     * When the template contains `:id` (e.g. "/path1/:id/path2" or "/path?p=:id") the
+     * encoded ID is substituted at that position; otherwise it is appended.
+     * When no template is provided the bare encoded ID is used.
+     * Callers that need to combine a public origin with a path should use
+     * HttpUrlHelper.combineOriginPath to build the template before calling this method.
+     * @param headers The response headers to mutate.
+     * @param id The resource ID to encode and place.
+     * @param urlTemplate The optional URL template (absolute or relative).
+     */
+    static buildId(headers, id, urlTemplate) {
+        Guards.stringValue(HttpHeaderHelper.CLASS_NAME, "id", id);
+        const encodedId = encodeURIComponent(id);
+        if (Is.stringValue(urlTemplate)) {
+            if (/:id(?![a-zA-Z0-9])/.test(urlTemplate)) {
+                headers[HeaderTypes.Location] = urlTemplate.replace(/:id(?![a-zA-Z0-9])/, encodedId);
+            }
+            else {
+                headers[HeaderTypes.Location] =
+                    `${StringHelper.trimTrailingSlashes(urlTemplate)}/${encodedId}`;
+            }
+        }
+        else {
+            headers[HeaderTypes.Location] = encodedId;
+        }
+    }
+    /**
+     * Set the Content-Type header to JSON-LD or JSON depending on the request Accept header.
+     * Uses HeaderHelper.extractAccept which parses the Accept header per RFC 7231 and returns
+     * entries ordered by quality descending, preserving original order for equal q-values.
+     * @param headers The response headers to mutate.
+     * @param requestHeaders The request headers to inspect for the Accept value.
+     */
+    static buildJsonContentType(headers, requestHeaders) {
+        const accepted = HeaderHelper.extractAccept(requestHeaders);
+        let contentType = MimeTypes.Json;
+        if (Is.arrayValue(accepted)) {
+            for (const { mimeType } of accepted) {
+                if (mimeType === MimeTypes.JsonLd) {
+                    contentType = MimeTypes.JsonLd;
+                    break;
+                }
+                if (mimeType === MimeTypes.Json || mimeType === "application/*" || mimeType === "*/*") {
+                    break;
+                }
+            }
+        }
+        headers[HeaderTypes.ContentType] = contentType;
+    }
+    /**
+     * Extract the cursor from the Link header's next relation.
+     * @param headers The response headers to extract the cursor from.
+     * @returns The cursor value or undefined if not present.
+     */
+    static extractCursor(headers) {
+        return HeaderHelper.extractLinkHeaderRelation(headers?.[HeaderTypes.Link], "next")
+            ?.urlQueryParams?.cursor;
+    }
+    /**
+     * Extract the resource ID from the Location response header.
+     * Handles absolute URLs, relative paths, and bare ID values.
+     * When a templateUrl containing ':id' is supplied (e.g. "/path1/:id/path2" or
+     * "https://host/path/:id") the ID is extracted via pattern matching at the ':id'
+     * position. Without a matching template the last path segment is returned.
+     * @param headers The response headers containing the Location header.
+     * @param templateUrl Optional URL template containing the ':id' placeholder, e.g. "/path1/:id/path2".
+     * @returns The extracted ID string.
+     * @throws GeneralError If the Location header is missing or the ID cannot be extracted.
+     */
+    static extractId(headers, templateUrl) {
+        const location = headers?.[HeaderTypes.Location];
+        if (!Is.stringValue(location)) {
+            throw new GeneralError(HttpHeaderHelper.CLASS_NAME, "locationMissing");
+        }
+        const withoutQuery = location.split("?")[0];
+        if (Is.stringValue(templateUrl) && templateUrl.includes(":id")) {
+            const escaped = templateUrl.replace(/[.+^${}()|[\]\\?]/g, "\\$&");
+            const pattern = new RegExp(escaped.replace(/:[a-zA-Z][a-zA-Z0-9]*/g, m => (m === ":id" ? "([^/?#]+)" : "[^/?#]+")));
+            const match = pattern.exec(location);
+            if (!Is.stringValue(match?.[1])) {
+                throw new GeneralError(HttpHeaderHelper.CLASS_NAME, "idNotFound");
+            }
+            return decodeURIComponent(match[1]);
+        }
+        const id = withoutQuery.includes("/") ? withoutQuery.split("/").pop() : withoutQuery;
+        if (!Is.stringValue(id)) {
+            throw new GeneralError(HttpHeaderHelper.CLASS_NAME, "idNotFound");
+        }
+        return decodeURIComponent(id);
+    }
+}
+//# sourceMappingURL=httpHeaderHelper.js.map

package/dist/es/helpers/httpHeaderHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"httpHeaderHelper.js","sources":["../../../src/helpers/httpHeaderHelper.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAEtE,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,SAAS,EAAqB,MAAM,aAAa,CAAC;AACtF,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD;;GAEG;AACH,MAAM,OAAO,gBAAgB;IAC5B;;OAEG;IACI,MAAM,CAAU,UAAU,GAAW,kBAAkB,CAAC;IAE/D;;;;;;OAMG;IACI,MAAM,CAAC,WAAW,CACxB,OAAqB,EACrB,GAAW,EACX,YAAgC,EAChC,MAA0B;QAE1B,IAAI,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC;YAC5B,MAAM,OAAO,GAAG,aAAa,CAAC,aAAa,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;YAC/D,MAAM,SAAS,GAAG,aAAa,CAAC,mBAAmB,CAAC,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;YAC/E,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,gBAAgB,CAAC,SAAS,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;QACzF,CAAC;IACF,CAAC;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAC,OAAO,CACpB,OAAqB,EACrB,EAAU,EACV,WAAoB;QAEpB,MAAM,CAAC,WAAW,CAAC,gBAAgB,CAAC,UAAU,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;QAC1D,MAAM,SAAS,GAAG,kBAAkB,CAAC,EAAE,CAAC,CAAC;QAEzC,IAAI,EAAE,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE,CAAC;YACjC,IAAI,oBAAoB,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;gBAC5C,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,GAAG,WAAW,CAAC,OAAO,CAAC,oBAAoB,EAAE,SAAS,CAAC,CAAC;YACtF,CAAC;iBAAM,CAAC;gBACP,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC;oBAC5B,GAAG,YAAY,CAAC,mBAAmB,CAAC,WAAW,CAAC,IAAI,SAAS,EAAE,CAAC;YAClE,CAAC;QACF,CAAC;aAAM,CAAC;YACP,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC;QAC3C,CAAC;IACF,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,oBAAoB,CACjC,OAAqB,EACrB,cAA6B;QAI7B,MAAM,QAAQ,GAAG,YAAY,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;QAC5D,IAAI,WAAW,GAAW,SAAS,CAAC,IAAI,CAAC;QACzC,IAAI,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC7B,KAAK,MAAM,EAAE,QAAQ,EAAE,IAAI,QAAQ,EAAE,CAAC;gBACrC,IAAI,QAAQ,KAAK,SAAS,CAAC,MAAM,EAAE,CAAC;oBACnC,WAAW,GAAG,SAAS,CAAC,MAAM,CAAC;oBAC/B,MAAM;gBACP,CAAC;gBACD,IAAI,QAAQ,KAAK,SAAS,CAAC,IAAI,IAAI,QAAQ,KAAK,eAAe,IAAI,QAAQ,KAAK,KAAK,EAAE,CAAC;oBACvF,MAAM;gBACP,CAAC;YACF,CAAC;QACF,CAAC;QACD,OAAO,CAAC,WAAW,CAAC,WAAW,CAAC,GAAG,WAAW,CAAC;IAChD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,aAAa,CAAC,OAAsB;QACjD,OAAO,YAAY,CAAC,yBAAyB,CAAC,OAAO,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;YACjF,EAAE,cAAc,EAAE,MAAM,CAAC;IAC3B,CAAC;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAC,SAAS,CAAC,OAAsB,EAAE,WAAoB;QACnE,MAAM,QAAQ,GAAG,OAAO,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QACjD,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC/B,MAAM,IAAI,YAAY,CAAC,gBAAgB,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;QACxE,CAAC;QAED,MAAM,YAAY,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAE5C,IAAI,EAAE,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YAChE,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;YAClE,MAAM,OAAO,GAAG,IAAI,MAAM,CACzB,OAAO,CAAC,OAAO,CAAC,wBAAwB,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CACvF,CAAC;YACF,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACrC,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBACjC,MAAM,IAAI,YAAY,CAAC,gBAAgB,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;YACnE,CAAC;YACD,OAAO,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QACrC,CAAC;QAED,MAAM,EAAE,GAAG,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC;QAErF,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,EAAE,CAAC,EAAE,CAAC;YACzB,MAAM,IAAI,YAAY,CAAC,gBAAgB,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;QACnE,CAAC;QACD,OAAO,kBAAkB,CAAC,EAAE,CAAC,CAAC;IAC/B,CAAC;CACD","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { GeneralError, Guards, Is, StringHelper } from \"@3sixty/core\";\n\nimport { HeaderHelper, HeaderTypes, MimeTypes, type IHttpHeaders } from \"@3sixty/web\";\nimport { HttpUrlHelper } from \"./httpUrlHelper.js\";\n\n/**\n * Class to help with handling http headers.\n */\nexport class HttpHeaderHelper {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = \"HttpHeaderHelper\";\n\n\t/**\n\t * Set the Link header with a next cursor relation when a cursor is present.\n\t * @param headers The response headers to mutate.\n\t * @param url The request URL used as the base for the link.\n\t * @param publicOrigin The public origin to substitute into the URL, if any.\n\t * @param cursor The cursor value; when undefined or empty the header is not set.\n\t */\n\tpublic static buildCursor(\n\t\theaders: IHttpHeaders,\n\t\turl: string,\n\t\tpublicOrigin: string | undefined,\n\t\tcursor: string | undefined\n\t): asserts headers is IHttpHeaders & { [HeaderTypes.Link]: string | undefined } {\n\t\tif (Is.stringValue(cursor)) {\n\t\t\tconst baseUrl = HttpUrlHelper.replaceOrigin(url, publicOrigin);\n\t\t\tconst cursorUrl = HttpUrlHelper.addQueryStringParam(baseUrl, \"cursor\", cursor);\n\t\t\theaders[HeaderTypes.Link] = HeaderHelper.createLinkHeader(cursorUrl, undefined, \"next\");\n\t\t}\n\t}\n\n\t/**\n\t * Set the Location header to the encoded ID, optionally placed within a URL template.\n\t * When the template contains `:id` (e.g. \"/path1/:id/path2\" or \"/path?p=:id\") the\n\t * encoded ID is substituted at that position; otherwise it is appended.\n\t * When no template is provided the bare encoded ID is used.\n\t * Callers that need to combine a public origin with a path should use\n\t * HttpUrlHelper.combineOriginPath to build the template before calling this method.\n\t * @param headers The response headers to mutate.\n\t * @param id The resource ID to encode and place.\n\t * @param urlTemplate The optional URL template (absolute or relative).\n\t */\n\tpublic static buildId(\n\t\theaders: IHttpHeaders,\n\t\tid: string,\n\t\turlTemplate?: string\n\t): asserts headers is IHttpHeaders & { [HeaderTypes.Location]: string } {\n\t\tGuards.stringValue(HttpHeaderHelper.CLASS_NAME, \"id\", id);\n\t\tconst encodedId = encodeURIComponent(id);\n\n\t\tif (Is.stringValue(urlTemplate)) {\n\t\t\tif (/:id(?![a-zA-Z0-9])/.test(urlTemplate)) {\n\t\t\t\theaders[HeaderTypes.Location] = urlTemplate.replace(/:id(?![a-zA-Z0-9])/, encodedId);\n\t\t\t} else {\n\t\t\t\theaders[HeaderTypes.Location] =\n\t\t\t\t\t`${StringHelper.trimTrailingSlashes(urlTemplate)}/${encodedId}`;\n\t\t\t}\n\t\t} else {\n\t\t\theaders[HeaderTypes.Location] = encodedId;\n\t\t}\n\t}\n\n\t/**\n\t * Set the Content-Type header to JSON-LD or JSON depending on the request Accept header.\n\t * Uses HeaderHelper.extractAccept which parses the Accept header per RFC 7231 and returns\n\t * entries ordered by quality descending, preserving original order for equal q-values.\n\t * @param headers The response headers to mutate.\n\t * @param requestHeaders The request headers to inspect for the Accept value.\n\t */\n\tpublic static buildJsonContentType(\n\t\theaders: IHttpHeaders,\n\t\trequestHeaders?: IHttpHeaders\n\t): asserts headers is IHttpHeaders & {\n\t\t[HeaderTypes.ContentType]: typeof MimeTypes.JsonLd | typeof MimeTypes.Json;\n\t} {\n\t\tconst accepted = HeaderHelper.extractAccept(requestHeaders);\n\t\tlet contentType: string = MimeTypes.Json;\n\t\tif (Is.arrayValue(accepted)) {\n\t\t\tfor (const { mimeType } of accepted) {\n\t\t\t\tif (mimeType === MimeTypes.JsonLd) {\n\t\t\t\t\tcontentType = MimeTypes.JsonLd;\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\t\tif (mimeType === MimeTypes.Json || mimeType === \"application/*\" || mimeType === \"*/*\") {\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\theaders[HeaderTypes.ContentType] = contentType;\n\t}\n\n\t/**\n\t * Extract the cursor from the Link header's next relation.\n\t * @param headers The response headers to extract the cursor from.\n\t * @returns The cursor value or undefined if not present.\n\t */\n\tpublic static extractCursor(headers?: IHttpHeaders): string | undefined {\n\t\treturn HeaderHelper.extractLinkHeaderRelation(headers?.[HeaderTypes.Link], \"next\")\n\t\t\t?.urlQueryParams?.cursor;\n\t}\n\n\t/**\n\t * Extract the resource ID from the Location response header.\n\t * Handles absolute URLs, relative paths, and bare ID values.\n\t * When a templateUrl containing ':id' is supplied (e.g. \"/path1/:id/path2\" or\n\t * \"https://host/path/:id\") the ID is extracted via pattern matching at the ':id'\n\t * position. Without a matching template the last path segment is returned.\n\t * @param headers The response headers containing the Location header.\n\t * @param templateUrl Optional URL template containing the ':id' placeholder, e.g. \"/path1/:id/path2\".\n\t * @returns The extracted ID string.\n\t * @throws GeneralError If the Location header is missing or the ID cannot be extracted.\n\t */\n\tpublic static extractId(headers?: IHttpHeaders, templateUrl?: string): string {\n\t\tconst location = headers?.[HeaderTypes.Location];\n\t\tif (!Is.stringValue(location)) {\n\t\t\tthrow new GeneralError(HttpHeaderHelper.CLASS_NAME, \"locationMissing\");\n\t\t}\n\n\t\tconst withoutQuery = location.split(\"?\")[0];\n\n\t\tif (Is.stringValue(templateUrl) && templateUrl.includes(\":id\")) {\n\t\t\tconst escaped = templateUrl.replace(/[.+^${}()|[\\]\\\\?]/g, \"\\\\$&\");\n\t\t\tconst pattern = new RegExp(\n\t\t\t\tescaped.replace(/:[a-zA-Z][a-zA-Z0-9]*/g, m => (m === \":id\" ? \"([^/?#]+)\" : \"[^/?#]+\"))\n\t\t\t);\n\t\t\tconst match = pattern.exec(location);\n\t\t\tif (!Is.stringValue(match?.[1])) {\n\t\t\t\tthrow new GeneralError(HttpHeaderHelper.CLASS_NAME, \"idNotFound\");\n\t\t\t}\n\t\t\treturn decodeURIComponent(match[1]);\n\t\t}\n\n\t\tconst id = withoutQuery.includes(\"/\") ? withoutQuery.split(\"/\").pop() : withoutQuery;\n\n\t\tif (!Is.stringValue(id)) {\n\t\t\tthrow new GeneralError(HttpHeaderHelper.CLASS_NAME, \"idNotFound\");\n\t\t}\n\t\treturn decodeURIComponent(id);\n\t}\n}\n"]}

package/dist/es/helpers/httpParameterHelper.js

@@ -0,0 +1,41 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Is } from "@3sixty/core";
+/**
+ * Class to help with handling http parameters.
+ */
+export class HttpParameterHelper {
+    /**
+     * Convert list query to array.
+     * @param values The values query string.
+     * @returns The array of values.
+     */
+    static arrayFromString(values) {
+        return values?.split(",");
+    }
+    /**
+     * Convert array of values to query string.
+     * @param values The values to combine string.
+     * @returns The combined.
+     */
+    static arrayToString(values) {
+        return Is.arrayValue(values) ? values.join(",") : undefined;
+    }
+    /**
+     * Convert object string to object.
+     * @param value The value query string.
+     * @returns The object.
+     */
+    static objectFromString(value) {
+        return Is.json(value) ? JSON.parse(value) : undefined;
+    }
+    /**
+     * Convert object to query string.
+     * @param value The value to convert to a string.
+     * @returns The converted object.
+     */
+    static objectToString(value) {
+        return Is.empty(value) ? undefined : JSON.stringify(value);
+    }
+}
+//# sourceMappingURL=httpParameterHelper.js.map

package/dist/es/helpers/httpParameterHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"httpParameterHelper.js","sources":["../../../src/helpers/httpParameterHelper.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,EAAE,EAAE,MAAM,cAAc,CAAC;AAElC;;GAEG;AACH,MAAM,OAAO,mBAAmB;IAC/B;;;;OAIG;IACI,MAAM,CAAC,eAAe,CAAa,MAAe;QACxD,OAAO,MAAM,EAAE,KAAK,CAAC,GAAG,CAAQ,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,aAAa,CAAa,MAAY;QACnD,OAAO,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC7D,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,gBAAgB,CAAc,KAAc;QACzD,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAE,IAAI,CAAC,KAAK,CAAC,KAAK,CAAO,CAAC,CAAC,CAAC,SAAS,CAAC;IAC9D,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,cAAc,CAAc,KAAS;QAClD,OAAO,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAC5D,CAAC;CACD","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Is } from \"@3sixty/core\";\n\n/**\n * Class to help with handling http parameters.\n */\nexport class HttpParameterHelper {\n\t/**\n\t * Convert list query to array.\n\t * @param values The values query string.\n\t * @returns The array of values.\n\t */\n\tpublic static arrayFromString<T = string>(values?: string): T[] | undefined {\n\t\treturn values?.split(\",\") as T[];\n\t}\n\n\t/**\n\t * Convert array of values to query string.\n\t * @param values The values to combine string.\n\t * @returns The combined.\n\t */\n\tpublic static arrayToString<T = string>(values?: T[]): string | undefined {\n\t\treturn Is.arrayValue(values) ? values.join(\",\") : undefined;\n\t}\n\n\t/**\n\t * Convert object string to object.\n\t * @param value The value query string.\n\t * @returns The object.\n\t */\n\tpublic static objectFromString<T = unknown>(value?: string): T | undefined {\n\t\treturn Is.json(value) ? (JSON.parse(value) as T) : undefined;\n\t}\n\n\t/**\n\t * Convert object to query string.\n\t * @param value The value to convert to a string.\n\t * @returns The converted object.\n\t */\n\tpublic static objectToString<T = unknown>(value?: T): string | undefined {\n\t\treturn Is.empty(value) ? undefined : JSON.stringify(value);\n\t}\n}\n"]}