@rest-vir/define-service 1.2.6 → 1.3.1

package/dist/endpoint/endpoint.d.ts

@@ -98,6 +98,8 @@ export declare const endpointInitShape: Shape<{
      * - Any other set value overrides the service's origin requirement (if it has any).
      */
     requiredClientOrigin: Shape<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TUnsafe<{
+        allOrigins: boolean;
+    }> | import("@sinclair/typebox").TUnsafe<{
         anyOrigin: boolean;
     }> | import("@sinclair/typebox").TUnsafe<RegExp> | import("@sinclair/typebox").TString | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TUnsafe<() => void> | import("@sinclair/typebox").TArray<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TUnsafe<{
         anyOrigin: boolean;

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}.
  *
@@ -52,6 +82,8 @@ export type OriginRequirement = undefined | string | RegExp | AnyOrigin | (((ori
  * @package [`@rest-vir/define-service`](https://www.npmjs.com/package/@rest-vir/define-service)
  */
 export declare const originRequirementShape: import("object-shape-tester").Shape<import("object-shape-tester").Shape<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TUnsafe<{
+    allOrigins: boolean;
+}> | import("@sinclair/typebox").TUnsafe<{
     anyOrigin: boolean;
 }> | import("@sinclair/typebox").TUnsafe<RegExp> | import("@sinclair/typebox").TString | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TUnsafe<() => void> | import("@sinclair/typebox").TArray<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TUnsafe<{
     anyOrigin: boolean;

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}.
  *
@@ -28,7 +50,7 @@ export function isAnyOrigin(input) {
  * @category Package : @rest-vir/define-service
  * @package [`@rest-vir/define-service`](https://www.npmjs.com/package/@rest-vir/define-service)
  */
-export const originRequirementShape = defineShape(unionShape(undefined, '', exactShape(AnyOrigin), classShape(RegExp), () => { }, [
+export const originRequirementShape = defineShape(unionShape(undefined, '', exactShape(AllOrigins), exactShape(AnyOrigin), classShape(RegExp), () => { }, [
     unionShape('', exactShape(AnyOrigin), classShape(RegExp), () => { }),
 ]));
 /**
@@ -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/dist/web-socket/web-socket-definition.d.ts

@@ -137,6 +137,8 @@ export declare const webSocketInitShape: Shape<{
      * - Any other set value overrides the service's origin requirement (if it has any).
      */
     requiredClientOrigin: Shape<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TUnsafe<{
+        allOrigins: boolean;
+    }> | import("@sinclair/typebox").TUnsafe<{
         anyOrigin: boolean;
     }> | import("@sinclair/typebox").TUnsafe<RegExp> | import("@sinclair/typebox").TString | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TUnsafe<() => void> | import("@sinclair/typebox").TArray<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TUnsafe<{
         anyOrigin: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rest-vir/define-service",
-    "version": "1.2.6",
+    "version": "1.3.1",
     "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.46.1",
-        "@augment-vir/common": "^31.46.1",
+        "@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.46.1",
+        "@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",