deep-guards 1.0.1 → 1.0.3

package/README.md

@@ -52,15 +52,19 @@ if (vehicleGuard(value)) {
    4. [isNot](#isnot)
    5. [isOneOf](#isoneof)
    6. [isUnionOf](#isunionof)
-   7. [isExact](#isexact)
+   7. [isIntersectionOf](#isintersectionof)
+   8. [isExact](#isexact)
 3. [Structures](#structures)
    1. [isAnyArray](#isanyarray)
    2. [isAnyRecord](#isanyrecord)
    3. [isArrayOf](#isarrayof)
-   4. [isRecordOf](#isrecordof)
-   5. [isObjectOf](#isobjectof)
-4. [guardOrThrow](#guardorthrow)
-5. [TypeFromGuard](#typefromguard)
+   4. [isTupleOf](#istupleof)
+   5. [isRecordOf](#isrecordof)
+   6. [isObjectOf](#isobjectof)
+4. [Macros](#macros)
+   1. [isDiscriminatedObjectOf](#isdiscriminatedobjectof)
+5. [guardOrThrow](#guardorthrow)
+6. [TypeFromGuard](#typefromguard)
 
 ## Terminology
 
@@ -123,7 +127,11 @@ It's very useful for enumerations, where you only have a few specific values, e.
 
 ### isUnionOf
 
-Higher order guard. This takes in any amount of guards as arguments, and then produces a guard which does a union over all the incoming guards.
+Higher order guard. This takes in any amount of guards as arguments, and then produces a guard which does a union over all the incoming guards. This means that if _any_ one of the guards passes for the incoming value, then this will pass.
+
+### isIntersectionOf
+
+Higher order guard. This takes in any amount of guards as arguments, and then produces a guard which does an intersection over all the incoming guards. This means that if _every_ one of the guards passes for the incoming value, then this will pass.
 
 ### isExact
 
@@ -153,6 +161,21 @@ Higher order guard. This will pass if the incoming value is an array which conta
 
 NOTE: This passes for empty arrays
 
+### isTupleOf
+
+Higher order guard. This takes in any number of guards, and then checks that the incoming value is an array of the same size, with the guards guarding the items in the same order as they appear.
+
+For example:
+
+```ts
+const myTupleGuard = isTupleOf(isNumber, isString, isBoolean);
+const value: unknown = [1, "foo", true];
+
+if (myTupleGuard(value)) {
+  // value passes
+}
+```
+
 ### isRecordOf
 
 Higher order guard. It has two guard parameters, where the first is the key guard, and then the second is a value guard which is optional. If you don't pass in a value guard, the returned guard function has `unknown`s as the value type.
@@ -168,6 +191,56 @@ As seen in the example at the start of this readme, you can do all sorts of comp
 NOTE: This throws an error if you give it an empty object.\
 It will also accept an object which contains keys which are not specified.
 
+## Macros
+
+These are common use cases for guarding setups, where they are made entirely out of the above guard suite.
+
+### isDiscriminatedObjectOf
+
+This takes in a string literal `type`, and an `isObjectOf` guard. This then combines the two, where the returned guard has the signature: `Guard<{ type: T } & O>`.
+This is good for use cases where you don't have a discriminator on an individual type, but then do have it on the union type. For example:
+
+```ts
+interface Car {
+  wheels: 4;
+  owner: string;
+  passengers: {
+    name: string;
+  }[];
+}
+
+interface Bike {
+  wheels: 2;
+  owner: string;
+  storage?: string[];
+}
+
+type Vehicle = ({ type: "car" } & Car) | ({ type: "bike" } & Bike);
+
+// Can then be represented like so in guards:
+
+const carGuard = isObjectOf({
+  wheels: isExact(4),
+  owner: isString,
+  passengers: isArrayOf(
+    isObjectOf({
+      name: isString,
+    })
+  ),
+});
+
+const bikeGuard = isObjectOf({
+  wheels: isExact(2),
+  owner: isString,
+  storage: isOptional(isArrayOf(isString)),
+});
+
+const vehicleGuard = isUnionOf(
+  isDiscriminatedObjectOf("car", carGuard),
+  isDiscriminatedObjectOf("bike", bikeGuard)
+);
+```
+
 ## guardOrThrow
 
 This package also includes a `guardOrThrow` method which when given an incoming value, a guard, and an optional hint message, will return a narrowed version of the value, or throw a `GuardError` containing that hint message.

package/dist/compound.d.ts

@@ -1,8 +1,14 @@
-import { Guard, GuardSchemaOf } from "./types.js";
+import { Guard, GuardSchemaOf } from "./types";
 export declare function isOptional<T>(guard: Guard<T>): Guard<T | undefined>;
 export declare function isNullable<T>(guard: Guard<T>): Guard<T | null | undefined>;
 export declare function isNonNullable<T>(value: T | null | undefined): value is T;
 export declare function isNot<const N>(guard: Guard<N>): <const T>(value: T | N) => value is T;
 export declare function isOneOf<const T extends (string | number | boolean | symbol | null | undefined)[]>(...values: T): Guard<(typeof values)[number]>;
 export declare function isUnionOf<T extends readonly unknown[]>(...guards: GuardSchemaOf<T>): Guard<T[number]>;
+type ArrayToIntersection<A extends readonly unknown[]> = A extends [
+    infer T,
+    ...infer R
+] ? T & ArrayToIntersection<R> : unknown;
+export declare function isIntersectionOf<T extends readonly unknown[]>(...guards: GuardSchemaOf<T>): Guard<ArrayToIntersection<T>>;
 export declare function isExact<const T>(expected: T, deep?: boolean): Guard<T>;
+export {};

package/dist/compound.js

@@ -2,7 +2,7 @@ export function isOptional(guard) {
     if (typeof guard !== "function") {
         throw new TypeError(`isOptional expects a guard parameter. Got instead: ${guard}`);
     }
-    return ((value) => value === undefined || guard(value));
+    return (value) => value === undefined || guard(value);
 }
 export function isNullable(guard) {
     if (typeof guard !== "function") {
@@ -29,6 +29,12 @@ export function isUnionOf(...guards) {
     }
     return (value) => guards.some((guard) => guard(value));
 }
+export function isIntersectionOf(...guards) {
+    if (guards.every((guard) => typeof guard !== "function")) {
+        throw new TypeError(`isIntersectionOf expects N guard parameters. Got instead: ${guards}`);
+    }
+    return (value) => guards.every((guard) => guard(value));
+}
 function isEqual(a, b) {
     return (a === b ||
         (a != null &&

package/dist/compound.js.map

@@ -1 +1 @@
-{"version":3,"file":"compound.js","sourceRoot":"src/","sources":["compound.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,UAAU,CAAI,KAAe;IAC3C,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;QAChC,MAAM,IAAI,SAAS,CACjB,sDAAsD,KAAK,EAAE,CAC9D,CAAC;IACJ,CAAC;IAED,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,KAAK,CAAC,CAErD,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,UAAU,CAAI,KAAe;IAC3C,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;QAChC,MAAM,IAAI,SAAS,CACjB,sDAAsD,KAAK,EAAE,CAC9D,CAAC;IACJ,CAAC;IAED,OAAO,CAAC,KAAc,EAAiC,EAAE,CACvD,KAAK,IAAI,IAAI,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC;AAClC,CAAC;AAED,MAAM,UAAU,aAAa,CAAI,KAA2B;IAC1D,OAAO,KAAK,IAAI,IAAI,CAAC;AACvB,CAAC;AAED,MAAM,UAAU,KAAK,CAAU,KAAe;IAC5C,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;QAChC,MAAM,IAAI,SAAS,CACjB,iDAAiD,KAAK,EAAE,CACzD,CAAC;IACJ,CAAC;IAED,OAAO,CAAU,KAAY,EAAc,EAAE,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AAC9D,CAAC;AAED,MAAM,UAAU,OAAO,CAErB,GAAG,MAAS;IACZ,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC;IACjC,OAAO,CAAC,KAAc,EAAsB,EAAE,CAC5C,QAAQ,CAAC,GAAG,CAAC,KAAkB,CAAC,CAAC;AACrC,CAAC;AAED,MAAM,UAAU,SAAS,CACvB,GAAG,MAAwB;IAE3B,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,KAAK,KAAK,UAAU,CAAC,EAAE,CAAC;QACzD,MAAM,IAAI,SAAS,CACjB,sDAAsD,MAAM,EAAE,CAC/D,CAAC;IACJ,CAAC;IAED,OAAO,CAAC,KAAK,EAAc,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;AACrE,CAAC;AAED,SAAS,OAAO,CAAI,CAAI,EAAE,CAAU;IAClC,OAAO,CACL,CAAC,KAAK,CAAC;QACP,CAAC,CAAC,IAAI,IAAI;YACR,CAAC,IAAI,IAAI;YACT,OAAO,CAAC,KAAK,QAAQ;YACrB,OAAO,CAAC,KAAK,QAAQ;YACrB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;gBACf,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;oBAChB,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM;oBACrB,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBACrC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM;oBAC/C,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CACrB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,CAAC,EAAG,CAA6B,CAAC,CAAC,CAAC,CAAC,CACpE,CAAC,CAAC,CACV,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,OAAO,CAAU,QAAW,EAAE,OAAgB,IAAI;IAChE,OAAO,CAAC,KAAK,EAAc,EAAE,CAC3B,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,KAAK,KAAK,CAAC;AACzD,CAAC"}
+{"version":3,"file":"compound.js","sourceRoot":"src/","sources":["compound.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,UAAU,CAAI,KAAe;IAC3C,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;QAChC,MAAM,IAAI,SAAS,CACjB,sDAAsD,KAAK,EAAE,CAC9D,CAAC;IACJ,CAAC;IAED,OAAO,CAAC,KAAK,EAA0B,EAAE,CAAC,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC;AAChF,CAAC;AAED,MAAM,UAAU,UAAU,CAAI,KAAe;IAC3C,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;QAChC,MAAM,IAAI,SAAS,CACjB,sDAAsD,KAAK,EAAE,CAC9D,CAAC;IACJ,CAAC;IAED,OAAO,CAAC,KAAc,EAAiC,EAAE,CACvD,KAAK,IAAI,IAAI,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC;AAClC,CAAC;AAED,MAAM,UAAU,aAAa,CAAI,KAA2B;IAC1D,OAAO,KAAK,IAAI,IAAI,CAAC;AACvB,CAAC;AAED,MAAM,UAAU,KAAK,CAAU,KAAe;IAC5C,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;QAChC,MAAM,IAAI,SAAS,CACjB,iDAAiD,KAAK,EAAE,CACzD,CAAC;IACJ,CAAC;IAED,OAAO,CAAU,KAAY,EAAc,EAAE,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AAC9D,CAAC;AAED,MAAM,UAAU,OAAO,CAErB,GAAG,MAAS;IACZ,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC;IACjC,OAAO,CAAC,KAAc,EAAsB,EAAE,CAC5C,QAAQ,CAAC,GAAG,CAAC,KAAkB,CAAC,CAAC;AACrC,CAAC;AAED,MAAM,UAAU,SAAS,CACvB,GAAG,MAAwB;IAE3B,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,KAAK,KAAK,UAAU,CAAC,EAAE,CAAC;QACzD,MAAM,IAAI,SAAS,CACjB,sDAAsD,MAAM,EAAE,CAC/D,CAAC;IACJ,CAAC;IAED,OAAO,CAAC,KAAK,EAAc,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;AACrE,CAAC;AASD,MAAM,UAAU,gBAAgB,CAC9B,GAAG,MAAwB;IAE3B,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,KAAK,KAAK,UAAU,CAAC,EAAE,CAAC;QACzD,MAAM,IAAI,SAAS,CACjB,6DAA6D,MAAM,EAAE,CACtE,CAAC;IACJ,CAAC;IAED,OAAO,CAAC,KAAK,EAAmC,EAAE,CAChD,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;AAC1C,CAAC;AAED,SAAS,OAAO,CAAI,CAAI,EAAE,CAAU;IAClC,OAAO,CACL,CAAC,KAAK,CAAC;QACP,CAAC,CAAC,IAAI,IAAI;YACR,CAAC,IAAI,IAAI;YACT,OAAO,CAAC,KAAK,QAAQ;YACrB,OAAO,CAAC,KAAK,QAAQ;YACrB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;gBACf,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;oBAChB,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM;oBACrB,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBACrC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM;oBAC/C,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CACrB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,CAAC,EAAG,CAA6B,CAAC,CAAC,CAAC,CAAC,CACpE,CAAC,CAAC,CACV,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,OAAO,CAAU,QAAW,EAAE,OAAgB,IAAI;IAChE,OAAO,CAAC,KAAK,EAAc,EAAE,CAC3B,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,KAAK,KAAK,CAAC;AACzD,CAAC"}

package/dist/errors.d.ts

@@ -1,4 +1,4 @@
-import { Guard } from "./types.js";
+import { Guard } from "./types";
 export declare class GuardError extends Error {
     name: string;
 }

package/dist/index.d.ts

@@ -1,5 +1,6 @@
-export * from "./compound.js";
-export * from "./errors.js";
-export * from "./primitives.js";
-export * from "./structures.js";
-export * from "./types.js";
+export * from "./compound";
+export * from "./errors";
+export * from "./macros";
+export * from "./primitives";
+export * from "./structures";
+export * from "./types";

package/dist/index.js

@@ -1,6 +1,7 @@
-export * from "./compound.js";
-export * from "./errors.js";
-export * from "./primitives.js";
-export * from "./structures.js";
-export * from "./types.js";
+export * from "./compound";
+export * from "./errors";
+export * from "./macros";
+export * from "./primitives";
+export * from "./structures";
+export * from "./types";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"src/","sources":["index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,YAAY,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"src/","sources":["index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC"}

package/dist/macros.d.ts

@@ -0,0 +1,4 @@
+import { Guard } from "./types";
+export declare const isDiscriminatedObjectOf: <T extends string, O extends object>(type: T, guard: Guard<O>) => Guard<{
+    type: T;
+} & O>;

package/dist/macros.js

@@ -0,0 +1,4 @@
+import { isExact, isIntersectionOf } from "./compound";
+import { isObjectOf } from "./structures";
+export const isDiscriminatedObjectOf = (type, guard) => isIntersectionOf(isObjectOf({ type: isExact(type) }), guard);
+//# sourceMappingURL=macros.js.map

package/dist/macros.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"macros.js","sourceRoot":"src/","sources":["macros.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAG1C,MAAM,CAAC,MAAM,uBAAuB,GAAG,CACrC,IAAO,EACP,KAAe,EACS,EAAE,CAC1B,gBAAgB,CAAC,UAAU,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,KAAK,CAE1D,CAAC"}

package/dist/primitives.d.ts

@@ -1,4 +1,4 @@
-import { Guard } from "./types.js";
+import { Guard } from "./types";
 export declare const isUnknown: Guard<unknown>;
 export declare const isNull: Guard<null>;
 export declare const isUndefined: Guard<undefined>;

package/dist/structures.d.ts

@@ -1,9 +1,10 @@
-import { Guard, GuardSchemaOf } from "./types.js";
+import { Guard, GuardSchemaOf } from "./types";
 type ObjectKey = string | number | symbol;
 export declare const isAnyArray: Guard<unknown[]>;
 export declare const isAnyRecord: Guard<Record<ObjectKey, unknown>>;
 export declare function isArrayOf<T>(guard: Guard<T>): Guard<T[]>;
+export declare function isTupleOf<T extends readonly unknown[]>(...tupleGuards: GuardSchemaOf<T>): Guard<T>;
 export declare function isRecordOf<K extends ObjectKey>(keyGuard: Guard<K>): Guard<Record<K, unknown>>;
 export declare function isRecordOf<K extends ObjectKey, V>(keyGuard: Guard<K>, valueGuard: Guard<V>): Guard<Record<K, V>>;
-export declare function isObjectOf<O extends object>(schema: GuardSchemaOf<O>): O extends unknown[] ? never : Guard<O>;
+export declare function isObjectOf<O extends object>(schema: GuardSchemaOf<O>): O extends unknown[] ? never : {} extends O ? never : Guard<O>;
 export {};

package/dist/structures.js

@@ -9,6 +9,14 @@ export function isArrayOf(guard) {
     }
     return (value) => Array.isArray(value) && value.every(guard);
 }
+export function isTupleOf(...tupleGuards) {
+    if (tupleGuards.some((guard) => typeof guard !== "function")) {
+        throw new TypeError(`isTupleOf expects guard parameters. Got instead: ${JSON.stringify(tupleGuards)}`);
+    }
+    return (value) => Array.isArray(value) &&
+        value.length === tupleGuards.length &&
+        tupleGuards.every((guard, i) => guard(value[i]));
+}
 export function isRecordOf(keyGuard, valueGuard) {
     if (typeof keyGuard !== "function") {
         throw new TypeError(`isRecordOf keyGuard expects a guard parameter. Got instead: ${keyGuard}`);
@@ -22,16 +30,16 @@ export function isRecordOf(keyGuard, valueGuard) {
         objectKeys(value).every((key) => keyGuard(key) && (valueGuard?.(value[key]) ?? true));
 }
 export function isObjectOf(schema) {
+    if (schema == null || typeof schema !== "object") {
+        throw new TypeError(`isObjectOf expects a guard schema object. Got instead: ${schema}`);
+    }
     const schemaKeys = objectKeys(schema);
-    const schemaUnknown = schema;
-    if (schemaKeys.length === 0) {
-        throw new Error("isObjectOf received an empty schema");
+    if (Array.isArray(schema) ||
+        schemaKeys.some((key) => typeof schema[key] !== "function")) {
+        throw new TypeError(`isObjectOf expects a guard schema object. Got instead ${JSON.stringify(schema)}`);
     }
-    else if (schemaUnknown == null ||
-        typeof schemaUnknown !== "object" ||
-        Array.isArray(schemaUnknown) ||
-        schemaKeys.some((key) => typeof schemaUnknown[key] !== "function")) {
-        throw new TypeError(`isObjectOf expects a guard schema. Got instead: ${schemaUnknown}`);
+    else if (schemaKeys.length === 0) {
+        throw new Error("isObjectOf received an empty schema");
     }
     return ((value) => value != null &&
         typeof value === "object" &&

package/dist/structures.js.map

@@ -1 +1 @@
-{"version":3,"file":"structures.js","sourceRoot":"src/","sources":["structures.ts"],"names":[],"mappings":"AAIA,SAAS,UAAU,CAAsB,GAAuB;IAC9D,OAAQ,MAAM,CAAC,mBAAmB,CAAC,GAAG,CAAS,CAAC,MAAM,CACpD,MAAM,CAAC,qBAAqB,CAAC,GAAG,CAAQ,CACzC,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,MAAM,UAAU,GAAqB,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAE5E,MAAM,CAAC,MAAM,WAAW,GAAsC,CAC5D,KAAK,EACgC,EAAE,CACvC,KAAK,IAAI,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAEtE,MAAM,UAAU,SAAS,CAAI,KAAe;IAC1C,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;QAChC,MAAM,IAAI,SAAS,CACjB,qDAAqD,KAAK,EAAE,CAC7D,CAAC;IACJ,CAAC;IAED,OAAO,CAAC,KAAK,EAAgB,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AAC7E,CAAC;AASD,MAAM,UAAU,UAAU,CACxB,QAAkB,EAClB,UAAqB;IAErB,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE,CAAC;QACnC,MAAM,IAAI,SAAS,CACjB,+DAA+D,QAAQ,EAAE,CAC1E,CAAC;IACJ,CAAC;SAAM,IAAI,UAAU,IAAI,IAAI,IAAI,OAAO,UAAU,KAAK,UAAU,EAAE,CAAC;QAClE,MAAM,IAAI,SAAS,CACjB,2EAA2E,UAAU,EAAE,CACxF,CAAC;IACJ,CAAC;IAED,OAAO,CAAC,KAAK,EAAyB,EAAE,CACtC,KAAK,IAAI,IAAI;QACb,OAAO,KAAK,KAAK,QAAQ;QACzB,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QACrB,UAAU,CAAC,KAAK,CAAC,CAAC,KAAK,CACrB,CAAC,GAAG,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC,CAC7D,CAAC;AACN,CAAC;AAED,MAAM,UAAU,UAAU,CACxB,MAAwB;IAExB,MAAM,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;IACtC,MAAM,aAAa,GAAG,MAAiB,CAAC;IACxC,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;IACzD,CAAC;SAAM,IACL,aAAa,IAAI,IAAI;QACrB,OAAO,aAAa,KAAK,QAAQ;QACjC,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC;QAC5B,UAAU,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAQ,aAAmB,CAAC,GAAG,CAAC,KAAK,UAAU,CAAC,EACzE,CAAC;QACD,MAAM,IAAI,SAAS,CACjB,mDAAmD,aAAa,EAAE,CACnE,CAAC;IACJ,CAAC;IAED,OAAO,CAAC,CAAC,KAAK,EAAc,EAAE,CAC5B,KAAK,IAAI,IAAI;QACb,OAAO,KAAK,KAAK,QAAQ;QACzB,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QACrB,UAAU,CAAC,KAAK,CACd,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,IAAI,KAAK,IAAI,MAAM,CAAC,GAAG,CAAC,CAAE,KAAW,CAAC,GAAG,CAAC,CAAC,CACxD,CAA2C,CAAC;AACjD,CAAC"}
+{"version":3,"file":"structures.js","sourceRoot":"src/","sources":["structures.ts"],"names":[],"mappings":"AAIA,SAAS,UAAU,CAAsB,GAAuB;IAC9D,OAAQ,MAAM,CAAC,mBAAmB,CAAC,GAAG,CAAS,CAAC,MAAM,CACpD,MAAM,CAAC,qBAAqB,CAAC,GAAG,CAAQ,CACzC,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,MAAM,UAAU,GAAqB,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAE5E,MAAM,CAAC,MAAM,WAAW,GAAsC,CAC5D,KAAK,EACgC,EAAE,CACvC,KAAK,IAAI,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAEtE,MAAM,UAAU,SAAS,CAAI,KAAe;IAC1C,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;QAChC,MAAM,IAAI,SAAS,CACjB,qDAAqD,KAAK,EAAE,CAC7D,CAAC;IACJ,CAAC;IAED,OAAO,CAAC,KAAK,EAAgB,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AAC7E,CAAC;AAED,MAAM,UAAU,SAAS,CACvB,GAAG,WAA6B;IAEhC,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,KAAK,KAAK,UAAU,CAAC,EAAE,CAAC;QAC7D,MAAM,IAAI,SAAS,CACjB,oDAAoD,IAAI,CAAC,SAAS,CAChE,WAAW,CACZ,EAAE,CACJ,CAAC;IACJ,CAAC;IAED,OAAO,CAAC,KAAK,EAAc,EAAE,CAC3B,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QACpB,KAAK,CAAC,MAAM,KAAK,WAAW,CAAC,MAAM;QACnC,WAAW,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACrD,CAAC;AASD,MAAM,UAAU,UAAU,CACxB,QAAkB,EAClB,UAAqB;IAErB,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE,CAAC;QACnC,MAAM,IAAI,SAAS,CACjB,+DAA+D,QAAQ,EAAE,CAC1E,CAAC;IACJ,CAAC;SAAM,IAAI,UAAU,IAAI,IAAI,IAAI,OAAO,UAAU,KAAK,UAAU,EAAE,CAAC;QAClE,MAAM,IAAI,SAAS,CACjB,2EAA2E,UAAU,EAAE,CACxF,CAAC;IACJ,CAAC;IAED,OAAO,CAAC,KAAK,EAAyB,EAAE,CACtC,KAAK,IAAI,IAAI;QACb,OAAO,KAAK,KAAK,QAAQ;QACzB,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QACrB,UAAU,CAAC,KAAK,CAAC,CAAC,KAAK,CACrB,CAAC,GAAG,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC,CAC7D,CAAC;AACN,CAAC;AAED,MAAM,UAAU,UAAU,CACxB,MAAwB;IAExB,IAAI,MAAM,IAAI,IAAI,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QACjD,MAAM,IAAI,SAAS,CACjB,0DAA0D,MAAM,EAAE,CACnE,CAAC;IACJ,CAAC;IAED,MAAM,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;IACtC,IACE,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;QACrB,UAAU,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK,UAAU,CAAC,EAC3D,CAAC;QACD,MAAM,IAAI,SAAS,CACjB,yDAAyD,IAAI,CAAC,SAAS,CACrE,MAAM,CACP,EAAE,CACJ,CAAC;IACJ,CAAC;SAAM,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;IACzD,CAAC;IAED,OAAO,CAAC,CAAC,KAAK,EAAc,EAAE,CAC5B,KAAK,IAAI,IAAI;QACb,OAAO,KAAK,KAAK,QAAQ;QACzB,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QACrB,UAAU,CAAC,KAAK,CACd,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,IAAI,KAAK,IAAI,MAAM,CAAC,GAAG,CAAC,CAAE,KAAW,CAAC,GAAG,CAAC,CAAC,CACxD,CAAkE,CAAC;AACxE,CAAC"}

package/package.json

@@ -8,7 +8,7 @@
   "type": "module",
   "types": "dist/index.d.ts",
   "homepage": "https://github.com/eniallator/Deep-Guards",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "scripts": {
     "test": "jest",
     "build": "tsc",
@@ -28,15 +28,15 @@
     "@types/eslint": "^9.6.1",
     "@types/eslint__js": "^8.42.3",
     "@types/jest": "^29.5.14",
-    "@typescript-eslint/eslint-plugin": "^8.15.0",
-    "@typescript-eslint/parser": "^8.15.0",
+    "@typescript-eslint/eslint-plugin": "^8.16.0",
+    "@typescript-eslint/parser": "^8.16.0",
     "babel-jest": "^29.7.0",
     "eslint": "^9.15.0",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-import": "^2.31.0",
     "eslint-plugin-jest": "^28.9.0",
     "jest": "^29.7.0",
-    "typescript": "^5.6.3",
-    "typescript-eslint": "^8.15.0"
+    "typescript": "^5.7.2",
+    "typescript-eslint": "^8.16.0"
   }
 }

package/src/compound.ts

@@ -1,81 +1,99 @@
-import { Guard, GuardSchemaOf } from "./types.js";
-
-export function isOptional<T>(guard: Guard<T>): Guard<T | undefined> {
-  if (typeof guard !== "function") {
-    throw new TypeError(
-      `isOptional expects a guard parameter. Got instead: ${guard}`
-    );
-  }
-
-  return ((value) => value === undefined || guard(value)) as Guard<
-    T | undefined
-  >;
-}
-
-export function isNullable<T>(guard: Guard<T>): Guard<T | null | undefined> {
-  if (typeof guard !== "function") {
-    throw new TypeError(
-      `isNullable expects a guard parameter. Got instead: ${guard}`
-    );
-  }
-
-  return (value: unknown): value is T | null | undefined =>
-    value == null || guard(value);
-}
-
-export function isNonNullable<T>(value: T | null | undefined): value is T {
-  return value != null;
-}
-
-export function isNot<const N>(guard: Guard<N>) {
-  if (typeof guard !== "function") {
-    throw new TypeError(
-      `isNot expects a guard parameter. Got instead: ${guard}`
-    );
-  }
-
-  return <const T>(value: T | N): value is T => !guard(value);
-}
-
-export function isOneOf<
-  const T extends (string | number | boolean | symbol | null | undefined)[]
->(...values: T): Guard<(typeof values)[number]> {
-  const valueSet = new Set(values);
-  return (value: unknown): value is T[number] =>
-    valueSet.has(value as T[number]);
-}
-
-export function isUnionOf<T extends readonly unknown[]>(
-  ...guards: GuardSchemaOf<T>
-): Guard<T[number]> {
-  if (guards.every((guard) => typeof guard !== "function")) {
-    throw new TypeError(
-      `isUnionOf expects N guard parameters. Got instead: ${guards}`
-    );
-  }
-
-  return (value): value is T => guards.some((guard) => guard(value));
-}
-
-function isEqual<T>(a: T, b: unknown): b is T {
-  return (
-    a === b ||
-    (a != null &&
-      b != null &&
-      typeof a === "object" &&
-      typeof b === "object" &&
-      (Array.isArray(a)
-        ? Array.isArray(b) &&
-          a.length === b.length &&
-          a.every((v, i) => isEqual(v, b[i]))
-        : Object.keys(a).length === Object.keys(b).length &&
-          Object.entries(a).every(
-            ([k, v]) => k in b && isEqual(v, (b as Record<string, unknown>)[k])
-          )))
-  );
-}
-
-export function isExact<const T>(expected: T, deep: boolean = true): Guard<T> {
-  return (value): value is T =>
-    deep ? isEqual(expected, value) : expected === value;
-}
+import { Guard, GuardSchemaOf } from "./types";
+
+export function isOptional<T>(guard: Guard<T>): Guard<T | undefined> {
+  if (typeof guard !== "function") {
+    throw new TypeError(
+      `isOptional expects a guard parameter. Got instead: ${guard}`
+    );
+  }
+
+  return (value): value is T | undefined => value === undefined || guard(value);
+}
+
+export function isNullable<T>(guard: Guard<T>): Guard<T | null | undefined> {
+  if (typeof guard !== "function") {
+    throw new TypeError(
+      `isNullable expects a guard parameter. Got instead: ${guard}`
+    );
+  }
+
+  return (value: unknown): value is T | null | undefined =>
+    value == null || guard(value);
+}
+
+export function isNonNullable<T>(value: T | null | undefined): value is T {
+  return value != null;
+}
+
+export function isNot<const N>(guard: Guard<N>) {
+  if (typeof guard !== "function") {
+    throw new TypeError(
+      `isNot expects a guard parameter. Got instead: ${guard}`
+    );
+  }
+
+  return <const T>(value: T | N): value is T => !guard(value);
+}
+
+export function isOneOf<
+  const T extends (string | number | boolean | symbol | null | undefined)[]
+>(...values: T): Guard<(typeof values)[number]> {
+  const valueSet = new Set(values);
+  return (value: unknown): value is T[number] =>
+    valueSet.has(value as T[number]);
+}
+
+export function isUnionOf<T extends readonly unknown[]>(
+  ...guards: GuardSchemaOf<T>
+): Guard<T[number]> {
+  if (guards.every((guard) => typeof guard !== "function")) {
+    throw new TypeError(
+      `isUnionOf expects N guard parameters. Got instead: ${guards}`
+    );
+  }
+
+  return (value): value is T => guards.some((guard) => guard(value));
+}
+
+type ArrayToIntersection<A extends readonly unknown[]> = A extends [
+  infer T,
+  ...infer R
+]
+  ? T & ArrayToIntersection<R>
+  : unknown;
+
+export function isIntersectionOf<T extends readonly unknown[]>(
+  ...guards: GuardSchemaOf<T>
+): Guard<ArrayToIntersection<T>> {
+  if (guards.every((guard) => typeof guard !== "function")) {
+    throw new TypeError(
+      `isIntersectionOf expects N guard parameters. Got instead: ${guards}`
+    );
+  }
+
+  return (value): value is ArrayToIntersection<T> =>
+    guards.every((guard) => guard(value));
+}
+
+function isEqual<T>(a: T, b: unknown): b is T {
+  return (
+    a === b ||
+    (a != null &&
+      b != null &&
+      typeof a === "object" &&
+      typeof b === "object" &&
+      (Array.isArray(a)
+        ? Array.isArray(b) &&
+          a.length === b.length &&
+          a.every((v, i) => isEqual(v, b[i]))
+        : Object.keys(a).length === Object.keys(b).length &&
+          Object.entries(a).every(
+            ([k, v]) => k in b && isEqual(v, (b as Record<string, unknown>)[k])
+          )))
+  );
+}
+
+export function isExact<const T>(expected: T, deep: boolean = true): Guard<T> {
+  return (value): value is T =>
+    deep ? isEqual(expected, value) : expected === value;
+}

package/src/errors.ts

@@ -1,17 +1,17 @@
-import { Guard } from "./types.js";
-
-export class GuardError extends Error {
-  name = "GuardError";
-}
-
-export function guardOrThrow<T>(
-  value: unknown,
-  guard: Guard<T>,
-  hint?: string
-): T {
-  if (guard(value)) {
-    return value;
-  } else {
-    throw new GuardError(hint ?? "Guard error");
-  }
-}
+import { Guard } from "./types";
+
+export class GuardError extends Error {
+  name = "GuardError";
+}
+
+export function guardOrThrow<T>(
+  value: unknown,
+  guard: Guard<T>,
+  hint?: string
+): T {
+  if (guard(value)) {
+    return value;
+  } else {
+    throw new GuardError(hint ?? "Guard error");
+  }
+}

package/src/index.ts

@@ -1,5 +1,6 @@
-export * from "./compound.js";
-export * from "./errors.js";
-export * from "./primitives.js";
-export * from "./structures.js";
-export * from "./types.js";
+export * from "./compound";
+export * from "./errors";
+export * from "./macros";
+export * from "./primitives";
+export * from "./structures";
+export * from "./types";

package/src/macros.ts

@@ -0,0 +1,11 @@
+import { isExact, isIntersectionOf } from "./compound";
+import { isObjectOf } from "./structures";
+import { Guard } from "./types";
+
+export const isDiscriminatedObjectOf = <T extends string, O extends object>(
+  type: T,
+  guard: Guard<O>
+): Guard<{ type: T } & O> =>
+  isIntersectionOf(isObjectOf({ type: isExact(type) }), guard) satisfies Guard<
+    { type: T } & O
+  >;

package/src/primitives.ts

@@ -1,23 +1,23 @@
-import { Guard } from "./types.js";
-
-export const isUnknown: Guard<unknown> = (_value): _value is unknown => true;
-
-export const isNull: Guard<null> = (value) => value === null;
-
-export const isUndefined: Guard<undefined> = (value) => value === undefined;
-
-export const isNumber: Guard<number> = (value) => typeof value === "number";
-
-export const isInteger: Guard<number> = (value): value is number =>
-  Number.isInteger(value);
-
-export const isString: Guard<string> = (value) => typeof value === "string";
-
-export const isSymbol: Guard<symbol> = (value) => typeof value === "symbol";
-
-export const isBoolean: Guard<boolean> = (value) =>
-  value === true || value === false;
-
-export const isFunction: Guard<(...args: unknown[]) => unknown> = (
-  value
-): value is (...args: unknown[]) => unknown => typeof value === "function";
+import { Guard } from "./types";
+
+export const isUnknown: Guard<unknown> = (_value): _value is unknown => true;
+
+export const isNull: Guard<null> = (value) => value === null;
+
+export const isUndefined: Guard<undefined> = (value) => value === undefined;
+
+export const isNumber: Guard<number> = (value) => typeof value === "number";
+
+export const isInteger: Guard<number> = (value): value is number =>
+  Number.isInteger(value);
+
+export const isString: Guard<string> = (value) => typeof value === "string";
+
+export const isSymbol: Guard<symbol> = (value) => typeof value === "symbol";
+
+export const isBoolean: Guard<boolean> = (value) =>
+  value === true || value === false;
+
+export const isFunction: Guard<(...args: unknown[]) => unknown> = (
+  value
+): value is (...args: unknown[]) => unknown => typeof value === "function";