@rest-vir/define-service 1.0.0 → 1.2.0

package/dist/frontend-connect/generate-api.d.ts

@@ -5,7 +5,7 @@ import { type CommonWebSocket } from '../web-socket/common-web-socket.js';
 import { type ClientWebSocket, type GenericConnectWebSocketParams } from '../web-socket/overwrite-web-socket-methods.js';
 import { type GenericWebSocketDefinition } from '../web-socket/web-socket-definition.js';
 import { type CollapsedConnectWebSocketParams } from './connect-web-socket.js';
-import { type CollapsedFetchEndpointParams, type FetchEndpointOutput, type GenericFetchEndpointParams } from './fetch-endpoint.js';
+import { buildEndpointUrl, type CollapsedFetchEndpointParams, type FetchEndpointOutput, type GenericFetchEndpointParams } from './fetch-endpoint.js';
 /**
  * An API generated by {@link generateApi}. This can be easily mocked by wrapping this API in
  * {@link makeMockApi}.
@@ -23,6 +23,7 @@ export declare class RestVirApi<SpecificService extends ServiceDefinition> {
         [EndpointPath in keyof SpecificService['endpoints']]: SpecificService['endpoints'][EndpointPath] extends GenericEndpointDefinition ? SpecificService['endpoints'][EndpointPath] & {
             /** Send a fetch request to this endpoint. */
             fetch(...params: CollapsedFetchEndpointParams<SpecificService['endpoints'][EndpointPath]>): Promise<FetchEndpointOutput<SpecificService['endpoints'][EndpointPath]>>;
+            buildUrl(params: Parameters<typeof buildEndpointUrl<SpecificService['endpoints'][EndpointPath]>>[1]): string;
         } : never;
     };
     /**

package/dist/frontend-connect/generate-api.js

@@ -1,6 +1,6 @@
 import { mapObjectValues, } from '@augment-vir/common';
 import { connectWebSocket } from './connect-web-socket.js';
-import { fetchEndpoint, } from './fetch-endpoint.js';
+import { buildEndpointUrl, fetchEndpoint, } from './fetch-endpoint.js';
 /**
  * An API generated by {@link generateApi}. This can be easily mocked by wrapping this API in
  * {@link makeMockApi}.
@@ -46,6 +46,9 @@ export class RestVirApi {
                         ...params[0],
                     });
                 },
+                buildUrl(params) {
+                    return buildEndpointUrl(endpointDefinition, params);
+                },
             };
         });
         this.webSockets = mapObjectValues(service.webSockets, (webSocketPath, webSocketDefinition) => {

package/dist/service/match-url.js

@@ -25,7 +25,7 @@ url) {
     else {
         return {
             ...(endpointPath ? { endpointPath } : {}),
-            ...(webSocketPath ? { webSocketPath: webSocketPath } : {}),
+            ...(webSocketPath ? { webSocketPath } : {}),
         };
     }
 }

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/mock-fetch.d.ts

@@ -43,7 +43,7 @@ export type MockResponseParams = Overwrite<Partial<Pick<Response, 'redirected' |
  * @category Package : @rest-vir/define-service
  * @package [`@rest-vir/define-service`](https://www.npmjs.com/package/@rest-vir/define-service)
  */
-export declare class MockResponseBodyStream extends ReadableStream<Uint8Array> {
+export declare class MockResponseBodyStream extends ReadableStream<Uint8Array<ArrayBuffer>> {
     private getReaderCalled;
     constructor(body: unknown, getReaderCalled: () => void);
     getReader(...args: any): any;

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/dist/web-socket/overwrite-web-socket-methods.js

@@ -133,6 +133,7 @@ export function overwriteWebSocketMethods(webSocketDefinition, rawWebSocket, web
         send(message) {
             originalSend.call(webSocket, 
             /** The extra `String()` wrapper is to convert `undefined` into `'undefined'`. */
+            // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-conversion
             String(JSON.stringify(verifyWebSocketMessage(webSocketDefinition, message, webSocketLocation))));
         },
     });

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rest-vir/define-service",
-    "version": "1.0.0",
+    "version": "1.2.0",
     "description": "Define an connect to a declarative and type safe REST and WebSocket service.",
     "keywords": [
         "rest",
@@ -40,14 +40,14 @@
         "test:update": "npm test update"
     },
     "dependencies": {
-        "@augment-vir/assert": "^31.28.0",
-        "@augment-vir/common": "^31.28.0",
+        "@augment-vir/assert": "^31.32.2",
+        "@augment-vir/common": "^31.32.2",
         "date-vir": "^7.4.0",
         "type-fest": "^4.41.0",
         "url-vir": "^2.1.3"
     },
     "devDependencies": {
-        "@augment-vir/test": "^31.28.0",
+        "@augment-vir/test": "^31.32.2",
         "@web/dev-server-esbuild": "^1.0.4",
         "@web/test-runner": "^0.20.2",
         "@web/test-runner-commands": "^0.9.0",
@@ -56,7 +56,7 @@
         "istanbul-smart-text-reporter": "^1.1.5",
         "markdown-code-example-inserter": "^3.0.3",
         "object-shape-tester": "^5.3.0",
-        "typedoc": "^0.28.8",
+        "typedoc": "^0.28.10",
         "ws": "^8.18.3"
     },
     "peerDependencies": {