@rest-vir/define-service 0.15.1 → 0.16.0

package/dist/util/origin.d.ts

@@ -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/package.json

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