@rest-vir/define-service 1.2.5 → 1.3.0

package/dist/endpoint/endpoint-path.d.ts

@@ -1,11 +1,56 @@
+import { type IsEqual, type IsNever } from 'type-fest';
+import { type NoParam } from '../util/no-param.js';
 /**
- * Extracts all path parameters from an endpoint path.
+ * Extracts all named path parameters from an endpoint path.
  *
  * @category Internal
  * @category Package : @rest-vir/define-service
  * @package [`@rest-vir/define-service`](https://www.npmjs.com/package/@rest-vir/define-service)
  */
-export type PathParams<EndpointPath extends string> = string extends EndpointPath ? Record<string, string> : EndpointPath extends `${string}:${infer Param}/${infer Rest}` ? Param | PathParams<`/${Rest}`> : EndpointPath extends `${string}:${infer Param}` ? Param : never;
+export type NamedPathParams<EndpointPath extends string> = string extends EndpointPath ? string : EndpointPath extends `${string}:${infer Param}/${infer Rest}` ? Param | NamedPathParams<`/${Rest}`> : EndpointPath extends `${string}:${infer Param}` ? Param : IsEqual<`/${string}`, EndpointPath> extends true ? string : never;
+/**
+ * Determines if the given endpoint path has a trailing wildcard.
+ *
+ * @category Internal
+ * @category Package : @rest-vir/define-service
+ * @package [`@rest-vir/define-service`](https://www.npmjs.com/package/@rest-vir/define-service)
+ */
+export type HasWildcardParam<EndpointPath extends string> = string extends EndpointPath ? boolean : EndpointPath extends `${string}/*` ? true : IsEqual<`/${string}`, EndpointPath> extends true ? boolean : false;
+/**
+ * Extracts named and wildcard path params.
+ *
+ * @category Internal
+ * @category Package : @rest-vir/define-service
+ * @package [`@rest-vir/define-service`](https://www.npmjs.com/package/@rest-vir/define-service)
+ */
+export type PathParams<EndpointPath extends string> = {
+    namedParams: NamedPathParams<EndpointPath>;
+    hasWildcard: HasWildcardParam<EndpointPath>;
+};
+export type GenericPathParams = {
+    pathParams: Readonly<Record<string, string>>;
+    wildcard: string | undefined;
+};
+/**
+ * Converts an endpoint path into the fetch params needed for its to operate.
+ *
+ * @category Internal
+ * @category Package : @rest-vir/define-service
+ * @package [`@rest-vir/define-service`](https://www.npmjs.com/package/@rest-vir/define-service)
+ */
+export type ConstructPathParams<EndpointPath extends string | NoParam> = EndpointPath extends NoParam ? GenericPathParams : (IsEqual<PathParams<Exclude<EndpointPath, NoParam>>['hasWildcard'], true> extends true ? Readonly<{
+    wildcard: string;
+}> : IsEqual<PathParams<Exclude<EndpointPath, NoParam>>['hasWildcard'], false> extends true ? Readonly<{
+    wildcard?: undefined;
+}> : Readonly<{
+    wildcard?: string | undefined;
+}>) & (IsNever<PathParams<Exclude<EndpointPath, NoParam>>['namedParams']> extends true ? Readonly<{
+    pathParams?: undefined;
+}> : PathParams<Exclude<EndpointPath, NoParam>>['namedParams'] extends string ? Readonly<{
+    pathParams: Readonly<Record<PathParams<Exclude<EndpointPath, NoParam>>['namedParams'], string>>;
+}> : Readonly<{
+    pathParams?: undefined;
+}>);
 /**
  * Base requirement for endpoint paths.
  *

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

@@ -1,6 +1,5 @@
 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 ConstructPathParams } 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 ClientWebSocket, type ConnectWebSocketListeners, type GenericConnectWebSocketParams } from '../web-socket/overwrite-web-socket-methods.js';
@@ -51,16 +50,7 @@ export type ConnectWebSocketParams<WebSocketToConnect extends Readonly<SelectFro
      * requiring externally adding them.
      */
     listeners?: ConnectWebSocketListeners<WebSocketToConnect, WebSocketClass>;
-} & (IsNever<PathParams<WebSocketToConnect['path']>> extends true ? {
-    /** This WebSocket has no path parameters to configure. */
-    pathParams?: undefined;
-} : PathParams<WebSocketToConnect['path']> extends string ? {
-    /** Required path params for this WebSocket's path. */
-    pathParams: Readonly<Record<PathParams<WebSocketToConnect['path']>, string>>;
-} : {
-    /** This WebSocket has no path parameters to configure. */
-    pathParams?: undefined;
-}) & (AllowWebSocketMock extends true ? Pick<GenericConnectWebSocketParams<WebSocketClass>, 'webSocketConstructor'> : unknown) & (WebSocketToConnect['protocolsShape'] extends undefined ? {
+} & ConstructPathParams<WebSocketToConnect['path']> & (AllowWebSocketMock extends true ? Pick<GenericConnectWebSocketParams<WebSocketClass>, 'webSocketConstructor'> : unknown) & (WebSocketToConnect['protocolsShape'] extends undefined ? {
     protocols?: string[];
 } : {
     protocols: WebSocketToConnect['ProtocolsType'];

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

@@ -1,6 +1,6 @@
-import { HttpMethod, type ExtractKeysWithMatchingValues, type KeyCount, type MaybePromise, type RequiredKeysOf, type SelectFrom } from '@augment-vir/common';
+import { HttpMethod, type ExtractKeysWithMatchingValues, type KeyCount, type MaybePromise, type PartialWithUndefined, 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 { type ConstructPathParams, type GenericPathParams } from '../endpoint/endpoint-path.js';
 import { type EndpointDefinition, type EndpointExecutorData, type GenericEndpointDefinition } from '../endpoint/endpoint.js';
 import { type NoParam } from '../util/no-param.js';
 import { type BaseSearchParams } from '../util/search-params.js';
@@ -12,8 +12,7 @@ import { type BaseSearchParams } from '../util/search-params.js';
  * @category Package : @rest-vir/define-service
  * @package [`@rest-vir/define-service`](https://www.npmjs.com/package/@rest-vir/define-service)
  */
-export type GenericFetchEndpointParams = {
-    pathParams?: Record<string, string> | undefined;
+export type GenericFetchEndpointParams = PartialWithUndefined<GenericPathParams> & {
     requestData?: any;
     searchParams?: BaseSearchParams | undefined;
     bypassResponseValidation?: undefined | boolean;
@@ -45,15 +44,7 @@ export type FetchEndpointParams<EndpointToFetch extends SelectFrom<EndpointDefin
     requestDataShape: true;
     responseDataShape: true;
     methods: true;
-}>, AllowFetchMock extends boolean = true> = EndpointToFetch extends EndpointDefinition ? Readonly<(IsNever<PathParams<EndpointToFetch['path']>> extends true ? {
-    /** This endpoint has no path parameters to configure. */
-    pathParams?: undefined;
-} : PathParams<EndpointToFetch['path']> extends string ? {
-    pathParams: Readonly<Record<PathParams<EndpointToFetch['path']>, string>>;
-} : {
-    /** This endpoint has no path parameters to configure. */
-    pathParams?: undefined;
-}) & (EndpointToFetch['SearchParamsType'] extends undefined ? {
+}>, AllowFetchMock extends boolean = true> = EndpointToFetch extends EndpointDefinition ? Readonly<ConstructPathParams<EndpointToFetch['path']> & (EndpointToFetch['SearchParamsType'] extends undefined ? {
     searchParams?: never;
 } : {
     searchParams: EndpointToFetch['SearchParamsType'];
@@ -181,7 +172,7 @@ export declare function buildEndpointRequestInit<const EndpointToFetch extends R
         serviceOrigin: true;
         serviceName: true;
     };
-}>, ...[{ method, options, pathParams, requestData, searchParams },]: CollapsedFetchEndpointParams<EndpointToFetch, false>): {
+}>, ...[{ method, options, pathParams, requestData, searchParams, wildcard },]: CollapsedFetchEndpointParams<EndpointToFetch, false>): {
     url: string;
     requestInit: RequestInit;
 };
@@ -212,4 +203,4 @@ export declare function buildEndpointUrl<const EndpointToFetch extends Readonly<
     searchParamsShape: true;
     responseDataShape: true;
     methods: true;
-}>, { pathParams, searchParams, }: Pick<EndpointToFetch extends NoParam ? Readonly<GenericFetchEndpointParams> : Readonly<FetchEndpointParams<Exclude<EndpointToFetch, NoParam>>>, 'pathParams' | 'searchParams'>): string;
+}>, { pathParams, searchParams, wildcard, }: Pick<EndpointToFetch extends NoParam ? Readonly<GenericFetchEndpointParams> : Readonly<FetchEndpointParams<Exclude<EndpointToFetch, NoParam>>>, 'pathParams' | 'searchParams' | 'wildcard'>): string;

package/dist/frontend-connect/fetch-endpoint.js

@@ -93,7 +93,7 @@ export async function fetchEndpoint(endpoint, ...params) {
  * @category Package : @rest-vir/define-service
  * @package [`@rest-vir/define-service`](https://www.npmjs.com/package/@rest-vir/define-service)
  */
-export function buildEndpointRequestInit(endpoint, ...[{ method, options = {}, pathParams, requestData, searchParams } = {},]) {
+export function buildEndpointRequestInit(endpoint, ...[{ method, options = {}, pathParams, requestData, searchParams, wildcard } = {},]) {
     const headers = options.headers instanceof Headers
         ? Object.fromEntries(options.headers.entries())
         : check.isArray(options.headers)
@@ -115,6 +115,7 @@ export function buildEndpointRequestInit(endpoint, ...[{ method, options = {}, p
     const url = buildEndpointUrl(endpoint, {
         pathParams,
         searchParams,
+        wildcard,
     });
     const requestInit = {
         ...options,
@@ -142,7 +143,7 @@ export function buildEndpointRequestInit(endpoint, ...[{ method, options = {}, p
  * @category Package : @rest-vir/define-service
  * @package [`@rest-vir/define-service`](https://www.npmjs.com/package/@rest-vir/define-service)
  */
-export function buildEndpointUrl(endpoint, { pathParams, searchParams, }) {
+export function buildEndpointUrl(endpoint, { pathParams, searchParams, wildcard, }) {
     let pathParamsCount = 0;
     if (endpoint.searchParamsShape) {
         assertValidShape(searchParams, endpoint.searchParamsShape, {
@@ -150,20 +151,26 @@ export function buildEndpointUrl(endpoint, { pathParams, searchParams, }) {
             allowExtraKeys: true,
         }, `Invalid search params given to '${endpoint.path}' in service '${endpoint.service.serviceName}'`);
     }
+    if (endpoint.path.endsWith('/*') && wildcard == undefined) {
+        throw new Error('Missing value for wildcard param.');
+    }
+    const pathname = endpoint.path
+        .replaceAll(/\/:([^/]+)/g, (wholeMatch, paramName) => {
+        pathParamsCount++;
+        if (pathParams && check.hasKey(pathParams, paramName) && pathParams[paramName]) {
+            return addPrefix({
+                value: pathParams[paramName],
+                prefix: '/',
+            });
+        }
+        else {
+            throw new Error(`Missing value for path param '${paramName}'.`);
+        }
+    })
+        .replace(/\/\*$/, addPrefix({ value: wildcard || '', prefix: '/' }));
     const builtUrl = buildUrl(endpoint.service.serviceOrigin, {
         search: searchParams,
-        pathname: endpoint.path.replaceAll(/\/:([^/]+)/g, (wholeMatch, paramName) => {
-            pathParamsCount++;
-            if (pathParams && check.hasKey(pathParams, paramName) && pathParams[paramName]) {
-                return addPrefix({
-                    value: pathParams[paramName],
-                    prefix: '/',
-                });
-            }
-            else {
-                throw new Error(`Missing value for path param '${paramName}'.`);
-            }
-        }),
+        pathname,
     }).href;
     if (!pathParamsCount && pathParams) {
         throw new Error(`'${endpoint.path}' in service '${endpoint.service.serviceName}' does not allow any path params but some where set.`);

package/dist/util/origin.d.ts

@@ -1,7 +1,7 @@
 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.
+ * Explicity denotes that any origin (`*`) is allowed. Use {@link isAnyOrigin} to check if something
+ * is equal to this.
  *
  * @category Internal
  * @category Package : @rest-vir/define-service
@@ -26,6 +26,34 @@ export declare function isAnyOrigin(input: unknown): input is AnyOrigin;
  * @package [`@rest-vir/define-service`](https://www.npmjs.com/package/@rest-vir/define-service)
  */
 export type AnyOrigin = typeof AnyOrigin;
+/**
+ * Different from {@link AnyOrigin} in that it accepts _all origins_ as the accepted origin. In
+ * practice this is similar to {@link AnyOrigin} but allows credentials to be included in requests
+ * when the browser normally blocks them for {@link AnyOrigin} (`*`).
+ *
+ * @category Internal
+ * @category Package : @rest-vir/define-service
+ * @package [`@rest-vir/define-service`](https://www.npmjs.com/package/@rest-vir/define-service)
+ */
+export declare const AllOrigins: {
+    allOrigins: boolean;
+};
+/**
+ * Checks if the input is equal to {@link AllOrigins}.
+ *
+ * @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 isAllOrigins(input: unknown): input is AllOrigins;
+/**
+ * Type for {@link AllOrigins}.
+ *
+ * @category Internal
+ * @category Package : @rest-vir/define-service
+ * @package [`@rest-vir/define-service`](https://www.npmjs.com/package/@rest-vir/define-service)
+ */
+export type AllOrigins = typeof AllOrigins;
 /**
  * Options explained:
  *
@@ -33,7 +61,9 @@ export type AnyOrigin = typeof AnyOrigin;
  *   parent service's origin requirement. When on the service, `undefined` is not allowed.
  * - `string`: require all request origins to exactly match the given string.
  * - `RegExp`: all request origins must match the RegExp.
- * - {@link AnyOrigin}: allow any origin.
+ * - {@link AnyOrigin}: allow any origin with a `*`.
+ * - {@link AllOrigins}: accept whatever origin is received as the required origin (See
+ *   {@link AllOrigins} for details on how this is different from {@link AnyOrigin}).
  * - A function: allow custom checking. If this function returns something truthy, the origin is
  *   allowed.
  * - An array: a combination of `string` values, `RegExp` values, or functions to compare against. If
@@ -43,7 +73,7 @@ export type AnyOrigin = typeof AnyOrigin;
  * @category Package : @rest-vir/define-service
  * @package [`@rest-vir/define-service`](https://www.npmjs.com/package/@rest-vir/define-service)
  */
-export type OriginRequirement = undefined | string | RegExp | AnyOrigin | (((origin: string | undefined) => MaybePromise<boolean>) | string | RegExp)[] | ((origin: string | undefined) => MaybePromise<boolean>);
+export type OriginRequirement = undefined | string | RegExp | AnyOrigin | AllOrigins | (((origin: string | undefined) => MaybePromise<boolean>) | string | RegExp)[] | ((origin: string | undefined) => MaybePromise<boolean>);
 /**
  * Shape definition for {@link OriginRequirement}.
  *

package/dist/util/origin.js

@@ -1,8 +1,8 @@
 import { check } from '@augment-vir/assert';
 import { classShape, defineShape, exactShape, unionShape } from 'object-shape-tester';
 /**
- * Explicity denotes that any origin is allowed. Use {@link isAnyOrigin} to check if something is
- * equal to this.
+ * Explicity denotes that any origin (`*`) is allowed. Use {@link isAnyOrigin} to check if something
+ * is equal to this.
  *
  * @category Internal
  * @category Package : @rest-vir/define-service
@@ -21,6 +21,28 @@ export const AnyOrigin = {
 export function isAnyOrigin(input) {
     return check.jsonEquals(input, AnyOrigin);
 }
+/**
+ * Different from {@link AnyOrigin} in that it accepts _all origins_ as the accepted origin. In
+ * practice this is similar to {@link AnyOrigin} but allows credentials to be included in requests
+ * when the browser normally blocks them for {@link AnyOrigin} (`*`).
+ *
+ * @category Internal
+ * @category Package : @rest-vir/define-service
+ * @package [`@rest-vir/define-service`](https://www.npmjs.com/package/@rest-vir/define-service)
+ */
+export const AllOrigins = {
+    allOrigins: true,
+};
+/**
+ * Checks if the input is equal to {@link AllOrigins}.
+ *
+ * @category Internal
+ * @category Package : @rest-vir/define-service
+ * @package [`@rest-vir/define-service`](https://www.npmjs.com/package/@rest-vir/define-service)
+ */
+export function isAllOrigins(input) {
+    return check.jsonEquals(input, AllOrigins);
+}
 /**
  * Shape definition for {@link OriginRequirement}.
  *
@@ -44,6 +66,9 @@ export async function checkOriginRequirement(origin, originRequirement) {
         /** Any origin has been explicitly allowed. */
         return AnyOrigin;
     }
+    else if (isAllOrigins(originRequirement)) {
+        return true;
+    }
     else if (originRequirement == undefined) {
         /** No checking occurred. */
         return undefined;

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

@@ -283,7 +283,7 @@ function toRegExp(tokens, keys) {
                 result += `(${negate(DEFAULT_DELIMITER, isSafeSegmentParam ? '' : backtrack)}+)`;
             }
             else {
-                result += `([\\s\\S]+)`;
+                result += String.raw `([\s\S]+)`;
             }
             keys.push(token);
             backtrack = '';
@@ -303,5 +303,5 @@ function negate(delimiter, backtrack) {
     if (delimiter.length < 2) {
         return `(?:(?!${escape(backtrack)})[^${escape(delimiter)}])`;
     }
-    return `(?:(?!${escape(backtrack)}|${escape(delimiter)})[\\s\\S])`;
+    return String.raw `(?:(?!${escape(backtrack)}|${escape(delimiter)})[\s\S])`;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rest-vir/define-service",
-    "version": "1.2.5",
+    "version": "1.3.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.40.0",
-        "@augment-vir/common": "^31.40.0",
+        "@augment-vir/assert": "^31.48.0",
+        "@augment-vir/common": "^31.48.0",
         "date-vir": "^8.0.0",
-        "type-fest": "^5.1.0",
+        "type-fest": "^5.2.0",
         "url-vir": "^2.1.6"
     },
     "devDependencies": {
-        "@augment-vir/test": "^31.40.0",
+        "@augment-vir/test": "^31.48.0",
         "@web/dev-server-esbuild": "^1.0.4",
         "@web/test-runner": "^0.20.2",
         "@web/test-runner-commands": "^0.9.0",
@@ -55,7 +55,7 @@
         "@web/test-runner-visual-regression": "^0.10.0",
         "istanbul-smart-text-reporter": "^1.1.5",
         "markdown-code-example-inserter": "^3.0.3",
-        "object-shape-tester": "^6.9.2",
+        "object-shape-tester": "^6.9.3",
         "typedoc": "^0.28.14",
         "ws": "^8.18.3"
     },