complete-common 2.28.0 → 2.29.0

package/dist/index.d.cts

@@ -17,8 +17,10 @@ export type * from "./interfaces/SemanticVersion.js";
 export type * from "./types/AddSubtract.js";
 export type * from "./types/CompositionTypeSatisfiesEnum.js";
 export type * from "./types/ERange.js";
+export type * from "./types/Expect.js";
 export type * from "./types/Immutable.js";
 export type * from "./types/IRange.js";
+export type * from "./types/KeysMatch.js";
 export type * from "./types/NaturalNumbersLessThan.js";
 export type * from "./types/NaturalNumbersLessThanOrEqualTo.js";
 export type * from "./types/ObjectValues.js";

package/dist/index.d.mts

@@ -17,8 +17,10 @@ export type * from "./interfaces/SemanticVersion.js";
 export type * from "./types/AddSubtract.js";
 export type * from "./types/CompositionTypeSatisfiesEnum.js";
 export type * from "./types/ERange.js";
+export type * from "./types/Expect.js";
 export type * from "./types/Immutable.js";
 export type * from "./types/IRange.js";
+export type * from "./types/KeysMatch.js";
 export type * from "./types/NaturalNumbersLessThan.js";
 export type * from "./types/NaturalNumbersLessThanOrEqualTo.js";
 export type * from "./types/ObjectValues.js";

package/dist/index.d.ts

@@ -17,8 +17,10 @@ export type * from "./interfaces/SemanticVersion.js";
 export type * from "./types/AddSubtract.js";
 export type * from "./types/CompositionTypeSatisfiesEnum.js";
 export type * from "./types/ERange.js";
+export type * from "./types/Expect.js";
 export type * from "./types/Immutable.js";
 export type * from "./types/IRange.js";
+export type * from "./types/KeysMatch.js";
 export type * from "./types/NaturalNumbersLessThan.js";
 export type * from "./types/NaturalNumbersLessThanOrEqualTo.js";
 export type * from "./types/ObjectValues.js";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,mBAAmB,iCAAiC,CAAC;AACrD,mBAAmB,wBAAwB,CAAC;AAC5C,mBAAmB,yCAAyC,CAAC;AAC7D,mBAAmB,mBAAmB,CAAC;AACvC,mBAAmB,sBAAsB,CAAC;AAC1C,mBAAmB,mBAAmB,CAAC;AACvC,mBAAmB,mCAAmC,CAAC;AACvD,mBAAmB,4CAA4C,CAAC;AAChE,mBAAmB,yBAAyB,CAAC;AAC7C,cAAc,wBAAwB,CAAC;AACvC,mBAAmB,2BAA2B,CAAC;AAC/C,cAAc,wBAAwB,CAAC;AACvC,mBAAmB,2BAA2B,CAAC;AAC/C,mBAAmB,kBAAkB,CAAC;AACtC,mBAAmB,yBAAyB,CAAC;AAC7C,mBAAmB,sBAAsB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,mBAAmB,iCAAiC,CAAC;AACrD,mBAAmB,wBAAwB,CAAC;AAC5C,mBAAmB,yCAAyC,CAAC;AAC7D,mBAAmB,mBAAmB,CAAC;AACvC,mBAAmB,mBAAmB,CAAC;AACvC,mBAAmB,sBAAsB,CAAC;AAC1C,mBAAmB,mBAAmB,CAAC;AACvC,mBAAmB,sBAAsB,CAAC;AAC1C,mBAAmB,mCAAmC,CAAC;AACvD,mBAAmB,4CAA4C,CAAC;AAChE,mBAAmB,yBAAyB,CAAC;AAC7C,cAAc,wBAAwB,CAAC;AACvC,mBAAmB,2BAA2B,CAAC;AAC/C,cAAc,wBAAwB,CAAC;AACvC,mBAAmB,2BAA2B,CAAC;AAC/C,mBAAmB,kBAAkB,CAAC;AACtC,mBAAmB,yBAAyB,CAAC;AAC7C,mBAAmB,sBAAsB,CAAC"}

package/dist/types/Expect.d.cts

@@ -0,0 +1,6 @@
+/**
+ * Helper type used for testing other interfaces/types. Only `true` is assignable, anything else
+ * errors.
+ */
+export type Expect<T extends true> = T;
+//# sourceMappingURL=Expect.d.ts.map

package/dist/types/Expect.d.mts

@@ -0,0 +1,6 @@
+/**
+ * Helper type used for testing other interfaces/types. Only `true` is assignable, anything else
+ * errors.
+ */
+export type Expect<T extends true> = T;
+//# sourceMappingURL=Expect.d.ts.map

package/dist/types/Expect.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Helper type used for testing other interfaces/types. Only `true` is assignable, anything else
+ * errors.
+ */
+export type Expect<T extends true> = T;
+//# sourceMappingURL=Expect.d.ts.map

package/dist/types/Expect.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Expect.d.ts","sourceRoot":"","sources":["../../src/types/Expect.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,SAAS,IAAI,IAAI,CAAC,CAAC"}

package/dist/types/KeysMatch.d.cts

@@ -0,0 +1,25 @@
+/**
+ * Helper type to ensure that an array of keys matches an interface.
+ *
+ * For example:
+ *
+ * ```ts
+ * interface Foo {
+ *   arg1: string;
+ *   arg2: string;
+ * }
+ *
+ * const FOO_KEYS = ["arg1", "arg2"] as const;
+ * type _ = Expect<KeysMatch<Foo, typeof FOO_KEYS>>;
+ * ```
+ */
+export type KeysMatch<T, Keys extends readonly PropertyKey[]> = [
+    keyof T
+] extends [Keys[number]] ? [Keys[number]] extends [keyof T] ? true : {
+    error: "Extra keys not in interface";
+    extra: Exclude<Keys[number], keyof T>;
+} : {
+    error: "Missing keys from interface";
+    missing: Exclude<keyof T, Keys[number]>;
+};
+//# sourceMappingURL=KeysMatch.d.ts.map

package/dist/types/KeysMatch.d.mts

@@ -0,0 +1,25 @@
+/**
+ * Helper type to ensure that an array of keys matches an interface.
+ *
+ * For example:
+ *
+ * ```ts
+ * interface Foo {
+ *   arg1: string;
+ *   arg2: string;
+ * }
+ *
+ * const FOO_KEYS = ["arg1", "arg2"] as const;
+ * type _ = Expect<KeysMatch<Foo, typeof FOO_KEYS>>;
+ * ```
+ */
+export type KeysMatch<T, Keys extends readonly PropertyKey[]> = [
+    keyof T
+] extends [Keys[number]] ? [Keys[number]] extends [keyof T] ? true : {
+    error: "Extra keys not in interface";
+    extra: Exclude<Keys[number], keyof T>;
+} : {
+    error: "Missing keys from interface";
+    missing: Exclude<keyof T, Keys[number]>;
+};
+//# sourceMappingURL=KeysMatch.d.ts.map

package/dist/types/KeysMatch.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Helper type to ensure that an array of keys matches an interface.
+ *
+ * For example:
+ *
+ * ```ts
+ * interface Foo {
+ *   arg1: string;
+ *   arg2: string;
+ * }
+ *
+ * const FOO_KEYS = ["arg1", "arg2"] as const;
+ * type _ = Expect<KeysMatch<Foo, typeof FOO_KEYS>>;
+ * ```
+ */
+export type KeysMatch<T, Keys extends readonly PropertyKey[]> = [
+    keyof T
+] extends [Keys[number]] ? [Keys[number]] extends [keyof T] ? true : {
+    error: "Extra keys not in interface";
+    extra: Exclude<Keys[number], keyof T>;
+} : {
+    error: "Missing keys from interface";
+    missing: Exclude<keyof T, Keys[number]>;
+};
+//# sourceMappingURL=KeysMatch.d.ts.map

package/dist/types/KeysMatch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"KeysMatch.d.ts","sourceRoot":"","sources":["../../src/types/KeysMatch.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,EAAE,IAAI,SAAS,SAAS,WAAW,EAAE,IAAI;IAC9D,MAAM,CAAC;CACR,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GACpB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,GAC9B,IAAI,GACJ;IACE,KAAK,EAAE,6BAA6B,CAAC;IACrC,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;CACvC,GACH;IACE,KAAK,EAAE,6BAA6B,CAAC;IACrC,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;CACzC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "complete-common",
-  "version": "2.28.0",
+  "version": "2.29.0",
   "description": "Helper functions for TypeScript projects.",
   "homepage": "https://complete-ts.github.io/",
   "bugs": {

package/src/index.ts

@@ -17,8 +17,10 @@ export type * from "./interfaces/SemanticVersion.js";
 export type * from "./types/AddSubtract.js";
 export type * from "./types/CompositionTypeSatisfiesEnum.js";
 export type * from "./types/ERange.js";
+export type * from "./types/Expect.js";
 export type * from "./types/Immutable.js";
 export type * from "./types/IRange.js";
+export type * from "./types/KeysMatch.js";
 export type * from "./types/NaturalNumbersLessThan.js";
 export type * from "./types/NaturalNumbersLessThanOrEqualTo.js";
 export type * from "./types/ObjectValues.js";

package/src/types/Expect.ts

@@ -0,0 +1,5 @@
+/**
+ * Helper type used for testing other interfaces/types. Only `true` is assignable, anything else
+ * errors.
+ */
+export type Expect<T extends true> = T;

package/src/types/KeysMatch.ts

@@ -0,0 +1,28 @@
+/**
+ * Helper type to ensure that an array of keys matches an interface.
+ *
+ * For example:
+ *
+ * ```ts
+ * interface Foo {
+ *   arg1: string;
+ *   arg2: string;
+ * }
+ *
+ * const FOO_KEYS = ["arg1", "arg2"] as const;
+ * type _ = Expect<KeysMatch<Foo, typeof FOO_KEYS>>;
+ * ```
+ */
+export type KeysMatch<T, Keys extends readonly PropertyKey[]> = [
+  keyof T,
+] extends [Keys[number]]
+  ? [Keys[number]] extends [keyof T]
+    ? true
+    : {
+        error: "Extra keys not in interface";
+        extra: Exclude<Keys[number], keyof T>;
+      }
+  : {
+      error: "Missing keys from interface";
+      missing: Exclude<keyof T, Keys[number]>;
+    };