@rest-vir/define-service 1.1.0 → 1.2.1

package/dist/index.d.ts

@@ -14,6 +14,7 @@ export * from './service/minimal-service.js';
 export * from './service/service-definition.error.js';
 export * from './service/service-definition.js';
 export * from './util/custom-shapes.js';
+export * from './util/merge-headers.js';
 export * from './util/mock-fetch.js';
 export * from './util/no-param.js';
 export * from './util/origin.js';

package/dist/index.js

@@ -14,6 +14,7 @@ export * from './service/minimal-service.js';
 export * from './service/service-definition.error.js';
 export * from './service/service-definition.js';
 export * from './util/custom-shapes.js';
+export * from './util/merge-headers.js';
 export * from './util/mock-fetch.js';
 export * from './util/no-param.js';
 export * from './util/origin.js';

package/dist/util/merge-headers.d.ts

@@ -0,0 +1,38 @@
+import { type IncomingHttpHeaders, type OutgoingHttpHeaders } from 'node:http';
+/**
+ * Allowed header types for header manipulation utilities:
+ *
+ * - {@link mergeHeaders}
+ * - {@link consolidateHeaders}
+ * - {@link headersToObject}
+ *
+ * @category Internal
+ * @category Package : @rest-vir/define-service
+ * @package [`@rest-vir/define-service`](https://www.npmjs.com/package/@rest-vir/define-service)
+ */
+export type AllowedHeaders = HeadersInit | Record<string, string | string[]> | [string, string | string[]][] | IncomingHttpHeaders | OutgoingHttpHeaders;
+/**
+ * Merges multiple headers containers into a single `Headers` instance.
+ *
+ * @category Internal
+ * @category Package : @rest-vir/define-service
+ * @package [`@rest-vir/define-service`](https://www.npmjs.com/package/@rest-vir/define-service)
+ */
+export declare function mergeHeaders(...headers: AllowedHeaders[]): Headers;
+/**
+ * Consolidate the headers input of whatever valid headers container into a `Headers` instance.
+ *
+ * @category Internal
+ * @category Package : @rest-vir/define-service
+ * @package [`@rest-vir/define-service`](https://www.npmjs.com/package/@rest-vir/define-service)
+ */
+export declare function consolidateHeaders(headers: AllowedHeaders): Headers;
+/**
+ * Consolidate the headers input of whatever valid headers container into an object of header
+ * values.
+ *
+ * @category Internal
+ * @category Package : @rest-vir/define-service
+ * @package [`@rest-vir/define-service`](https://www.npmjs.com/package/@rest-vir/define-service)
+ */
+export declare function headersToObject(headers: AllowedHeaders): Record<string, string | string[]>;

package/dist/util/merge-headers.js

@@ -0,0 +1,73 @@
+import { check } from '@augment-vir/assert';
+/**
+ * Merges multiple headers containers into a single `Headers` instance.
+ *
+ * @category Internal
+ * @category Package : @rest-vir/define-service
+ * @package [`@rest-vir/define-service`](https://www.npmjs.com/package/@rest-vir/define-service)
+ */
+export function mergeHeaders(...headers) {
+    const finalHeaders = new Headers();
+    headers.forEach((headersInit) => {
+        const consolidatedHeadersInit = consolidateHeaders(headersInit);
+        Array.from(consolidatedHeadersInit.entries()).forEach(([key, value,]) => {
+            finalHeaders.append(key, value);
+        });
+    });
+    return finalHeaders;
+}
+/**
+ * Consolidate the headers input of whatever valid headers container into a `Headers` instance.
+ *
+ * @category Internal
+ * @category Package : @rest-vir/define-service
+ * @package [`@rest-vir/define-service`](https://www.npmjs.com/package/@rest-vir/define-service)
+ */
+export function consolidateHeaders(headers) {
+    const newHeaders = new Headers();
+    const headersArray = headers instanceof Headers
+        ? Array.from(headers.entries())
+        : check.isArray(headers)
+            ? headers
+            : Object.entries(headers);
+    headersArray.forEach(([key, value,]) => {
+        if (value == undefined) {
+            return;
+        }
+        if (check.isArray(value)) {
+            value.forEach((innerValue) => newHeaders.append(key, innerValue));
+        }
+        else {
+            newHeaders.append(key, String(value));
+        }
+    });
+    return newHeaders;
+}
+/**
+ * Consolidate the headers input of whatever valid headers container into an object of header
+ * values.
+ *
+ * @category Internal
+ * @category Package : @rest-vir/define-service
+ * @package [`@rest-vir/define-service`](https://www.npmjs.com/package/@rest-vir/define-service)
+ */
+export function headersToObject(headers) {
+    const consolidatedHeaders = consolidateHeaders(headers);
+    const headersObject = {};
+    Array.from(consolidatedHeaders.entries()).forEach(([key, value,]) => {
+        const existingValue = headersObject[key];
+        if (existingValue == undefined) {
+            headersObject[key] = value;
+        }
+        else if (check.isArray(existingValue)) {
+            existingValue.push(value);
+        }
+        else {
+            headersObject[key] = [
+                existingValue,
+                value,
+            ];
+        }
+    });
+    return headersObject;
+}

package/dist/util/origin.d.ts

@@ -60,6 +60,10 @@ export declare const originRequirementShape: import("object-shape-tester").Shape
  * - `boolean`: the origin was explicitly checked and passed (`true`) or failed (`false`)
  * - `undefined`: no origin checking occurred
  * - `AnyOrigin`: requirements explicitly allow any origin.
+ *
+ * @category Internal
+ * @category Package : @rest-vir/define-service
+ * @package [`@rest-vir/define-service`](https://www.npmjs.com/package/@rest-vir/define-service)
  */
 export type OriginRequirementResult = boolean | undefined | AnyOrigin;
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rest-vir/define-service",
-    "version": "1.1.0",
+    "version": "1.2.1",
     "description": "Define an connect to a declarative and type safe REST and WebSocket service.",
     "keywords": [
         "rest",