@rest-vir/define-service 0.15.0 → 0.16.0

package/dist/dev-port/find-dev-port.d.ts

@@ -1,8 +1,8 @@
 import { type MaybePromise, type PartialWithUndefined, type SelectFrom } from '@augment-vir/common';
 import { type AnyDuration } from 'date-vir';
-import type { EndpointPathBase } from '../endpoint/endpoint-path.js';
-import { GenericFetchEndpointParams } from '../frontend-connect/fetch-endpoint.js';
-import type { ServiceDefinition } from '../service/service-definition.js';
+import { type EndpointPathBase } from '../endpoint/endpoint-path.js';
+import { type GenericFetchEndpointParams } from '../frontend-connect/fetch-endpoint.js';
+import { type ServiceDefinition } from '../service/service-definition.js';
 /**
  * This header is set on all responses handled by rest-vir so we know what service a response came
  * from.

package/dist/endpoint/endpoint.d.ts

@@ -1,10 +1,10 @@
-import { AnyObject, HttpMethod, Overwrite, type SelectFrom } from '@augment-vir/common';
+import { HttpMethod, type AnyObject, type Overwrite, type SelectFrom } from '@augment-vir/common';
 import { type ShapeDefinition, type ShapeToRuntimeType } from 'object-shape-tester';
 import { type RequireAtLeastOne } from 'type-fest';
 import { type MinimalService } from '../service/minimal-service.js';
 import { type NoParam } from '../util/no-param.js';
 import { type OriginRequirement } from '../util/origin.js';
-import { BaseSearchParams } from '../util/search-params.js';
+import { type BaseSearchParams } from '../util/search-params.js';
 import { type EndpointPathBase } from './endpoint-path.js';
 /**
  * The type for setting up an individual endpoint, used in `defineService`.

package/dist/frontend-connect/connect-web-socket.d.ts

@@ -1,8 +1,8 @@
-import { RequiredKeysOf, SelectFrom } from '@augment-vir/common';
-import { IsNever } from 'type-fest';
-import { PathParams } from '../endpoint/endpoint-path.js';
+import { type RequiredKeysOf, type SelectFrom } from '@augment-vir/common';
+import { type IsNever } from 'type-fest';
+import { type PathParams } from '../endpoint/endpoint-path.js';
 import { type NoParam } from '../util/no-param.js';
-import type { CommonWebSocket } from '../web-socket/common-web-socket.js';
+import { type CommonWebSocket } from '../web-socket/common-web-socket.js';
 import { type ClientWebSocket, type ConnectWebSocketListeners, type GenericConnectWebSocketParams } from '../web-socket/overwrite-web-socket-methods.js';
 import { type WebSocketDefinition } from '../web-socket/web-socket-definition.js';
 /**

package/dist/frontend-connect/fetch-endpoint.d.ts

@@ -1,7 +1,7 @@
-import { HttpMethod, KeyCount, type ExtractKeysWithMatchingValues, type MaybePromise, type RequiredKeysOf, type SelectFrom } from '@augment-vir/common';
+import { HttpMethod, type ExtractKeysWithMatchingValues, type KeyCount, type MaybePromise, type RequiredKeysOf, type SelectFrom } from '@augment-vir/common';
 import { type IsEqual, type IsNever } from 'type-fest';
 import { type PathParams } from '../endpoint/endpoint-path.js';
-import { EndpointExecutorData, type EndpointDefinition, type GenericEndpointDefinition } from '../endpoint/endpoint.js';
+import { type EndpointDefinition, type EndpointExecutorData, type GenericEndpointDefinition } from '../endpoint/endpoint.js';
 import { type NoParam } from '../util/no-param.js';
 /**
  * A general version of {@link FetchEndpointParams} to be used when accepting _any_ endpoint (like in

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

@@ -1,11 +1,11 @@
-import { MaybePromise, Overwrite, PartialWithUndefined, type Values } from '@augment-vir/common';
-import type { GenericEndpointDefinition } from '../endpoint/endpoint.js';
-import type { ServiceDefinition } from '../service/service-definition.js';
-import type { CommonWebSocket } from '../web-socket/common-web-socket.js';
-import { ClientWebSocket, GenericConnectWebSocketParams } from '../web-socket/overwrite-web-socket-methods.js';
-import type { WebSocketDefinition } from '../web-socket/web-socket-definition.js';
-import { CollapsedConnectWebSocketParams } from './connect-web-socket.js';
-import { CollapsedFetchEndpointParams, FetchEndpointOutput, GenericFetchEndpointParams } from './fetch-endpoint.js';
+import { type MaybePromise, type Overwrite, type PartialWithUndefined, type Values } from '@augment-vir/common';
+import { type GenericEndpointDefinition } from '../endpoint/endpoint.js';
+import { type ServiceDefinition } from '../service/service-definition.js';
+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 WebSocketDefinition } 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';
 /**
  * An API generated by {@link generateApi}. This can be easily mocked by wrapping this API in
  * {@link makeMockApi}.

package/dist/frontend-connect/mock-client-web-socket.d.ts

@@ -1,7 +1,7 @@
 import { type MaybePromise, type PartialWithUndefined } from '@augment-vir/common';
-import { CommonWebSocket, CommonWebSocketEventMap, CommonWebSocketState } from '../web-socket/common-web-socket.js';
-import { GenericConnectWebSocketParams, WebSocketLocation, type ClientWebSocket } from '../web-socket/overwrite-web-socket-methods.js';
-import { WebSocketDefinition } from '../web-socket/web-socket-definition.js';
+import { CommonWebSocketState, type CommonWebSocket, type CommonWebSocketEventMap } from '../web-socket/common-web-socket.js';
+import { WebSocketLocation, type ClientWebSocket, type GenericConnectWebSocketParams } from '../web-socket/overwrite-web-socket-methods.js';
+import { type WebSocketDefinition } from '../web-socket/web-socket-definition.js';
 /**
  * Parameters for {@link MockClientWebSocketClientSendCallback}.
  *

package/dist/frontend-connect/web-socket-protocol-parse.js

@@ -1,4 +1,3 @@
-/* eslint-disable unicorn/number-literal-case */
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
 // cspell:ignore Einar Stangvik Arnout Kazemier Pinca
 /**

package/dist/service/define-service.d.ts

@@ -1,4 +1,4 @@
-import type { BaseServiceEndpointsInit, BaseServiceWebSocketsInit, ServiceDefinition, ServiceInit } from './service-definition.js';
+import { type BaseServiceEndpointsInit, type BaseServiceWebSocketsInit, type ServiceDefinition, type ServiceInit } from './service-definition.js';
 /**
  * The main entry point to the whole `@rest-vir/define-service` package. This function accepts a
  * {@link ServiceInit} object and returns a fully defined {@link ServiceDefinition}.

package/dist/service/define-service.js

@@ -1,5 +1,5 @@
 import { assert, check } from '@augment-vir/assert';
-import { getObjectTypedEntries, mapObjectValues, stringify } from '@augment-vir/common';
+import { getObjectTypedEntries, mapObjectValues, stringify, } from '@augment-vir/common';
 import { assertValidShape, defineShape } from 'object-shape-tester';
 import { assertValidEndpoint, attachEndpointShapeTypeGetters, endpointInitShape, } from '../endpoint/endpoint.js';
 import { assertValidWebSocketDefinition, attachWebSocketShapeTypeGetters, webSocketInitShape, } from '../web-socket/web-socket-definition.js';

package/dist/service/match-url.d.ts

@@ -1,5 +1,5 @@
 import { type RequireAtLeastOne } from 'type-fest';
-import { EndpointPathBase } from '../endpoint/endpoint-path.js';
+import { type EndpointPathBase } from '../endpoint/endpoint-path.js';
 /**
  * Given a raw path or URL, finds an endpoint or WebSocket path that will match in the given
  * service. If no match is found, this returns `undefined`.

package/dist/service/service-definition.d.ts

@@ -1,11 +1,11 @@
-import type { Overwrite } from '@augment-vir/common';
-import { IsEqual, SetRequired } from 'type-fest';
-import { EndpointPathBase } from '../endpoint/endpoint-path.js';
-import { EndpointDefinition, EndpointInit, WithFinalEndpointProps } from '../endpoint/endpoint.js';
-import { NoParam } from '../util/no-param.js';
-import { OriginRequirement } from '../util/origin.js';
-import { WebSocketDefinition, WebSocketInit, WithFinalWebSocketProps } from '../web-socket/web-socket-definition.js';
-import { MinimalService } from './minimal-service.js';
+import { type Overwrite } from '@augment-vir/common';
+import { type IsEqual, type SetRequired } from 'type-fest';
+import { type EndpointPathBase } from '../endpoint/endpoint-path.js';
+import { type EndpointDefinition, type EndpointInit, type WithFinalEndpointProps } from '../endpoint/endpoint.js';
+import { type NoParam } from '../util/no-param.js';
+import { type OriginRequirement } from '../util/origin.js';
+import { type WebSocketDefinition, type WebSocketInit, type WithFinalWebSocketProps } from '../web-socket/web-socket-definition.js';
+import { type MinimalService } from './minimal-service.js';
 /**
  * A string used for type errors triggered when an endpoint path is defined without a leading slash.
  *

package/dist/util/origin.d.ts

@@ -1,4 +1,4 @@
-import { MaybePromise } from '@augment-vir/common';
+import { type MaybePromise } from '@augment-vir/common';
 /**
  * Explicity denotes that any origin is allowed. Use {@link isAnyOrigin} to check if something is
  * equal to this.
@@ -56,3 +56,27 @@ export declare const originRequirementShape: import("object-shape-tester").Shape
 }]>, import("object-shape-tester").ShapeClass<[RegExpConstructor]>, () => void, import("object-shape-tester").ShapeOr<[string, import("object-shape-tester").ShapeExact<readonly [{
     anyOrigin: boolean;
 }]>, import("object-shape-tester").ShapeClass<[RegExpConstructor]>, () => void]>[]]>, false>;
+/**
+ * - `boolean`: the origin was explicitly checked and passed (`true`) or failed (`false`)
+ * - `undefined`: no origin checking occurred
+ * - `AnyOrigin`: requirements explicitly allow any origin.
+ */
+export type OriginRequirementResult = boolean | undefined | AnyOrigin;
+/**
+ * Checks the given origin against the given origin requirement and determine if the origin matches.
+ * See {@link OriginRequirementResult} for details on what each possible return value means.
+ *
+ * @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 checkOriginRequirement(origin: string | undefined, originRequirement: OriginRequirement): Promise<OriginRequirementResult>;
+/**
+ * Narrower version of {@link checkOriginRequirement} that simply returns `true` if the origin
+ * matched or `false` otherwise.
+ *
+ * @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 matchesOriginRequirement(origin: string | undefined, originRequirement: NonNullable<OriginRequirement>): Promise<boolean>;

package/dist/util/origin.js

@@ -31,3 +31,53 @@ export function isAnyOrigin(input) {
 export const originRequirementShape = defineShape(or(undefined, '', exact(AnyOrigin), classShape(RegExp), () => { }, [
     or('', exact(AnyOrigin), classShape(RegExp), () => { }),
 ]));
+/**
+ * Checks the given origin against the given origin requirement and determine if the origin matches.
+ * See {@link OriginRequirementResult} for details on what each possible return value means.
+ *
+ * @category Internal
+ * @category Package : @rest-vir/define-service
+ * @package [`@rest-vir/define-service`](https://www.npmjs.com/package/@rest-vir/define-service)
+ */
+export async function checkOriginRequirement(origin, originRequirement) {
+    if (isAnyOrigin(originRequirement)) {
+        /** Any origin has been explicitly allowed. */
+        return AnyOrigin;
+    }
+    else if (originRequirement === undefined) {
+        /** No checking occurred. */
+        return undefined;
+    }
+    else if (!origin) {
+        /** If there is an origin requirement but no origin then the origin automatically fails. */
+        return false;
+    }
+    else if (check.isString(originRequirement)) {
+        return origin === originRequirement;
+    }
+    else if (check.instanceOf(originRequirement, RegExp)) {
+        return !!originRequirement.exec(origin);
+    }
+    else if (check.isArray(originRequirement)) {
+        for (const requirement of originRequirement) {
+            if (await checkOriginRequirement(origin, requirement)) {
+                return true;
+            }
+        }
+        return false;
+    }
+    else {
+        return await originRequirement(origin);
+    }
+}
+/**
+ * Narrower version of {@link checkOriginRequirement} that simply returns `true` if the origin
+ * matched or `false` otherwise.
+ *
+ * @category Internal
+ * @category Package : @rest-vir/define-service
+ * @package [`@rest-vir/define-service`](https://www.npmjs.com/package/@rest-vir/define-service)
+ */
+export async function matchesOriginRequirement(origin, originRequirement) {
+    return !!(await checkOriginRequirement(origin, originRequirement));
+}

package/dist/util/path-to-regexp.js

@@ -5,7 +5,8 @@
  * This file was copied from
  * https://github.com/pillarjs/path-to-regexp/blob/39e861d02d959ba99d0632af994ab48d4a8eeb14/src/index.ts
  * because its published package on Npm is not browser friendly. It has been modified here to remove
- * all code not used in rest-vir and to meet rest-vir's coding standards.
+ * all code not used in rest-vir and to meet rest-vir's coding standards. It has also been modified
+ * to not require wildcard names.
  *
  * The original package and file source have the following license:
  *
@@ -99,8 +100,7 @@ function* lexer(str) {
             yield { type: 'PARAM', index: i, value };
         }
         else if (value === '*') {
-            const value = name();
-            yield { type: 'WILDCARD', index: i, value };
+            yield { type: 'WILDCARD', index: i++, value: '*' };
         }
         else {
             yield { type: 'CHAR', index: i, value: chars[i++] };

package/dist/web-socket/common-web-socket.d.ts

@@ -1,4 +1,4 @@
-import type { AnyFunction } from '@augment-vir/common';
+import { type AnyFunction } from '@augment-vir/common';
 /**
  * A WebSocket interface that matches both [client-side
  * WebSockets](https://developer.mozilla.org/docs/Web/API/WebSocket) and [host-side

package/dist/web-socket/overwrite-web-socket-methods.d.ts

@@ -1,8 +1,8 @@
-import { MaybePromise, Overwrite, SelectFrom } from '@augment-vir/common';
+import { type MaybePromise, type Overwrite, type SelectFrom } from '@augment-vir/common';
 import { type AnyDuration } from 'date-vir';
-import type { HasRequiredKeys } from 'type-fest';
-import { NoParam } from '../util/no-param.js';
-import { CommonWebSocket, CommonWebSocketEventMap } from './common-web-socket.js';
+import { type HasRequiredKeys } from 'type-fest';
+import { type NoParam } from '../util/no-param.js';
+import { type CommonWebSocket, type CommonWebSocketEventMap } from './common-web-socket.js';
 import { type WebSocketDefinition } from './web-socket-definition.js';
 /**
  * Location of the WebSocket in question: on a client connecting to a WebSocket host or on the host

package/dist/web-socket/web-socket-definition.d.ts

@@ -1,11 +1,11 @@
-import { AnyObject, Overwrite, type SelectFrom } from '@augment-vir/common';
-import { ShapeDefinition, ShapeToRuntimeType } from 'object-shape-tester';
-import type { IsEqual } from 'type-fest';
-import { EndpointPathBase } from '../endpoint/endpoint-path.js';
-import { MinimalService } from '../service/minimal-service.js';
-import { NoParam } from '../util/no-param.js';
-import { OriginRequirement } from '../util/origin.js';
-import type { BaseSearchParams } from '../util/search-params.js';
+import { type AnyObject, type Overwrite, type SelectFrom } from '@augment-vir/common';
+import { type ShapeDefinition, type ShapeToRuntimeType } from 'object-shape-tester';
+import { type IsEqual } from 'type-fest';
+import { type EndpointPathBase } from '../endpoint/endpoint-path.js';
+import { type MinimalService } from '../service/minimal-service.js';
+import { type NoParam } from '../util/no-param.js';
+import { type OriginRequirement } from '../util/origin.js';
+import { type BaseSearchParams } from '../util/search-params.js';
 /**
  * Initialization for a WebSocket within a service definition..
  *

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rest-vir/define-service",
-    "version": "0.15.0",
+    "version": "0.16.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.14.1",
-        "@augment-vir/common": "^31.14.1",
+        "@augment-vir/assert": "^31.16.0",
+        "@augment-vir/common": "^31.16.0",
         "date-vir": "^7.3.1",
-        "type-fest": "^4.40.0",
+        "type-fest": "^4.40.1",
         "url-vir": "^2.1.3"
     },
     "devDependencies": {
-        "@augment-vir/test": "^31.14.1",
+        "@augment-vir/test": "^31.16.0",
         "@web/dev-server-esbuild": "^1.0.4",
         "@web/test-runner": "^0.20.1",
         "@web/test-runner-commands": "^0.9.0",
@@ -57,7 +57,7 @@
         "markdown-code-example-inserter": "^3.0.3",
         "object-shape-tester": "^5.1.5",
         "typedoc": "^0.28.3",
-        "ws": "^8.18.1"
+        "ws": "^8.18.2"
     },
     "peerDependencies": {
         "object-shape-tester": ">=5"