inferred-types 0.15.0 → 0.18.0

package/src/errors/InferenceError.ts

@@ -1,3 +1,3 @@
 import { createError } from "brilliant-errors";
 
-export const InferenceError = createError("InferenceError", "inferred-types");
+export const [InferenceError, isInferenceError] = createError("InferenceError", "inferred-types")()()()();

package/src/shared/randomString.ts

@@ -1,5 +1,5 @@
 export function randomString() {
-  return Math.trunc((1 + Math.random()) * 0x10000)
+  return Math.trunc((1 + Math.random()) * 0x1_00_00)
     .toString(16)
     .slice(1);
 }

package/src/types/Constructor.ts

@@ -0,0 +1,5 @@
+/**
+ * Define a class constructor; allowing strong typing for constructor's parameters
+ * and the returned class structure.
+ */
+export type Constructor<Ctor extends any[], Klass extends any> = new (...props: Ctor) => Klass;

package/src/types/Not.ts

@@ -1,5 +1,5 @@
 /**
- * Provides a negation of a type of the type `T` _not_ `U`
+ * Provides a negation of a type of the type `T` _not_ `U`.
  * ```ts
  * const foo = 42;
  * // 33
@@ -7,5 +7,7 @@
  * // never
  * type NotTheMeaningOfLife = Not<42, 42>;
  * ```
+ * 
+ * Note: same as `Exclude`
  */
 export type Not<T, U> = T extends U ? never : T;

package/src/types/Transformer.ts

@@ -1,4 +1,4 @@
-import { SameKeys } from "./SameKeys";
+import { SameKeys } from "./type-conversion/SameKeys";
 
 /**
  * **Transformer**
@@ -13,4 +13,3 @@ export type Transformer<I extends object, O extends SameKeys<I>, K extends keyof
   input: I,
   key: K
 ) => O[K];
-

package/src/types/Where.ts

@@ -0,0 +1,36 @@
+import { Include } from "native-dash";
+
+/**
+ * Allows filtering down `T` to those which extend a given type `U`.
+ * 
+ * - `T` is either a dictionary (where keys will be used to compare) or
+ * a readonly sting array.
+ * ```ts
+ * const arr = ["foo", "bar", "baz"];
+ * // "bar" | "baz"
+ * type BA = Where<typeof arr, `ba${string}`>;
+ * ```
+ */
+ export type Where<T extends Record<string, any> | readonly string[], U> = T extends readonly string[]
+ ? Include<T[number], U>
+ : {
+  [K in keyof T]: K extends U ? K : never;
+}[keyof T];
+
+
+/**
+ * Allows filtering down `T` to those which extend a given type `U`.
+ * 
+ * - `T` is either a dictionary (where keys will be used to compare) or
+ * a readonly sting array.
+ * ```ts
+ * const arr = ["foo", "bar", "baz"];
+ * // "foo"
+ * type F = WhereNot<typeof arr, `ba${string}`>;
+ * ```
+ */
+export type WhereNot<T extends Record<string, any> | readonly string[], U> = T extends readonly string[]
+? Exclude<T[number], U>
+: {
+ [K in keyof T]: K extends U ? never : K;
+}[keyof T];

package/src/types/alphabetic/PascalCase.ts

@@ -1,5 +1,5 @@
 /* eslint @typescript-eslint/no-unused-vars: "off" */
-import type { Capitalize, LowerAllCaps, Trim } from "~/types";
+import type { LowerAllCaps, Trim } from "~/types";
 
 type Delimiter = "_" | "-" | " ";
 
@@ -10,7 +10,7 @@ type DashDelim<T extends string> = T extends `${infer Begin}${" "}${infer Rest}`
   ? DashDelim<`${Begin}-${Rest}`>
   : T;
 
-/** 
+/**
  * Converts a string literal type to a **PascalCase** representation.
  * ```ts
  * // "FooBar"
@@ -20,7 +20,8 @@ type DashDelim<T extends string> = T extends `${infer Begin}${" "}${infer Rest}`
  * type T = PascalCase<"\n foo_bar \t">;
  * ```
  */
-export type PascalCase<S extends string> = string extends S ? string :
-  Trim<DashDelim<LowerAllCaps<S>>> extends `${infer Begin}${Delimiter}${infer Rest}`
+export type PascalCase<S extends string> = string extends S
+  ? string
+  : Trim<DashDelim<LowerAllCaps<S>>> extends `${infer Begin}${Delimiter}${infer Rest}`
   ? PascalCase<`${Capitalize<Begin>}${Capitalize<Rest>}`>
   : Capitalize<Trim<LowerAllCaps<S>>>;

package/src/types/alphabetic/index.ts

@@ -1,9 +1,9 @@
 // #autoindex, exclude: Alpha
 // #region autoindexed files
 
-// index last changed at: 7th Jul, 2021, 01:59 PM ( GMT-7 )
+// index last changed at: 12th Dec, 2021, 12:24 PM ( GMT-8 )
 // export: named; exclusions: Alpha, index, private.
-// files: AllCaps, CamelCase, CapFirstAlpha, CapitalizeWords, DashToSnake, DashUppercase, Dasherize, HasUppercase, Intrinsic, IsCapitalized, KebabCase, LowerAllCaps, PascalCase, Pluralize, SnakeCase, alpha-characters.
+// files: AllCaps, CamelCase, CapFirstAlpha, CapitalizeWords, DashToSnake, DashUppercase, Dasherize, HasUppercase, IsCapitalized, KebabCase, LowerAllCaps, PascalCase, Pluralize, SnakeCase, alpha-characters.
 
 // local file exports
 export * from "./AllCaps";
@@ -14,7 +14,6 @@ export * from "./DashToSnake";
 export * from "./DashUppercase";
 export * from "./Dasherize";
 export * from "./HasUppercase";
-export * from "./Intrinsic";
 export * from "./IsCapitalized";
 export * from "./KebabCase";
 export * from "./LowerAllCaps";
@@ -26,7 +25,7 @@ export * from "./alpha-characters";
 // Note:
 // -----
 // This file was created by running: "dd devops autoindex"; it assumes you have
-// the 'do-devops' pkg installed as a dev dep.
+// the 'do-devops' pkg (that's "dd" on npm) installed as a dev dep.
 //
 // By default it assumes that exports are named exports but this can be changed by
 // adding a modifier to the '// #autoindex' syntax:
@@ -45,7 +44,12 @@ export * from "./alpha-characters";
 //
 //    - autoindex:named, exclude: foo,bar,baz
 //
-// Also be aware that all of your content outside the defined region in this file
+// Inversely, if you state a file to be an "orphan" then autoindex files
+// below this file will not reference this autoindex file:
+//
+//    - autoindex:named, orphan
+// 
+// Also be aware that all of your content outside the "// #region" section in this file
 // will be preserved in situations where you need to do something paricularly awesome.
 // Keep on being awesome.
 

package/src/types/{fluent.ts → fluent/fluent.ts}

@@ -14,8 +14,7 @@ export type ToFluent<
   X extends object = {}
 > = {
   [K in keyof T]: (...args: Parameters<T[K]>) => ToFluent<T, X> & X;
-} &
-  X;
+} & X;
 
 /**
  * A _pure_ Fluent API which promotes an API surface where _every_ API endpoint must be a function
@@ -53,10 +52,10 @@ export type PureFluentApi<
  * pass out the interior state which has been configured by the fluent parts of the API
  * - `TExclude` represents part of the API which -- due to the internal state -- should be hidden
  */
-export type FluentApi<
-  TFluent extends {
-    [K in keyof TFluent]: (...args: Parameters<TFluent[K]>) => FluentApi<TFluent, TEscape>;
-  },
-  TEscape extends object = {},
-  TExclude extends string = ""
-> = Omit<TFluent & TEscape, TExclude>;
+// export type FluentApi<
+//   TFluent extends {
+//     [K in keyof TFluent]: (...args: Parameters<TFluent[K]>) => FluentApi<TFluent, TEscape>;
+//   },
+//   TEscape extends object = {},
+//   TExclude extends string = ""
+// > = Omit<TFluent & TEscape, TExclude>;

package/src/types/fluent/index.ts

@@ -0,0 +1,42 @@
+// #autoindex
+// #region autoindexed files
+
+// index last changed at: 12th Dec, 2021, 12:28 PM ( GMT-8 )
+// export: named; exclusions: index, private.
+// files: fluent.
+
+// local file exports
+export * from "./fluent";
+
+// Note:
+// -----
+// This file was created by running: "dd devops autoindex"; it assumes you have
+// the 'do-devops' pkg (that's "dd" on npm) installed as a dev dep.
+//
+// By default it assumes that exports are named exports but this can be changed by
+// adding a modifier to the '// #autoindex' syntax:
+//
+//    - autoindex:named     same as default, exports "named symbols"
+//    - autoindex:default   assumes each file is exporting a default export
+//                          and converts the default export to the name of the
+//                          file
+//    - autoindex:offset    assumes files export "named symbols" but that each
+//                          file's symbols should be offset by the file's name
+//                          (useful for files which might symbols which collide
+//                          or where the namespacing helps consumers)
+//
+// You may also exclude certain files or directories by adding it to the
+// autoindex command. As an example:
+//
+//    - autoindex:named, exclude: foo,bar,baz
+//
+// Inversely, if you state a file to be an "orphan" then autoindex files
+// below this file will not reference this autoindex file:
+//
+//    - autoindex:named, orphan
+// 
+// Also be aware that all of your content outside the "// #region" section in this file
+// will be preserved in situations where you need to do something paricularly awesome.
+// Keep on being awesome.
+
+// #endregion

package/src/types/index.ts

@@ -1,13 +1,14 @@
 // #autoindex
 // #region autoindexed files
 
-// index last changed at: 8th Aug, 2021, 05:44 PM ( GMT-7 )
+// index last changed at: 10th Oct, 2021, 08:32 PM ( GMT-7 )
 // export: named; exclusions: index, private.
-// files: Api, EnumValues, ExpandRecursively, First, FunctionType, If, Include, Includes, KeyedRecord, Keys, Length, Mutable, Narrowable, Not, Numeric, Opaque, Retain, SameKeys, Transformer, TypeGuard, append-types, fluent, maybe, props, ruleset-types, runtime, type-testing.
-// directories: alphabetic, dictionary, kv, lists, string-literals, tuples, type-conversion.
+// files: Api, Constructor, EnumValues, ExpandRecursively, First, FunctionType, If, Include, Includes, KeyedRecord, Keys, Length, Mutable, Narrowable, Not, Numeric, Opaque, Retain, Transformer, TypeGuard, Where, append-types, maybe, props, ruleset-types, runtime, type-testing.
+// directories: alphabetic, dictionary, fluent, kv, lists, string-literals, tuples, type-conversion.
 
 // local file exports
 export * from "./Api";
+export * from "./Constructor";
 export * from "./EnumValues";
 export * from "./ExpandRecursively";
 export * from "./First";
@@ -24,11 +25,10 @@ export * from "./Not";
 export * from "./Numeric";
 export * from "./Opaque";
 export * from "./Retain";
-export * from "./SameKeys";
 export * from "./Transformer";
 export * from "./TypeGuard";
+export * from "./Where";
 export * from "./append-types";
-export * from "./fluent";
 export * from "./maybe";
 export * from "./props";
 export * from "./ruleset-types";
@@ -38,6 +38,7 @@ export * from "./type-testing";
 // directory exports
 export * from "./alphabetic/index";
 export * from "./dictionary/index";
+export * from "./fluent/index";
 export * from "./kv/index";
 export * from "./lists/index";
 export * from "./string-literals/index";
@@ -47,7 +48,7 @@ export * from "./type-conversion/index";
 // Note:
 // -----
 // This file was created by running: "dd devops autoindex"; it assumes you have
-// the 'do-devops' pkg installed as a dev dep.
+// the 'do-devops' pkg (that's "dd" on npm) installed as a dev dep.
 //
 // By default it assumes that exports are named exports but this can be changed by
 // adding a modifier to the '// #autoindex' syntax:
@@ -66,7 +67,12 @@ export * from "./type-conversion/index";
 //
 //    - autoindex:named, exclude: foo,bar,baz
 //
-// Also be aware that all of your content outside the defined region in this file
+// Inversely, if you state a file to be an "orphan" then autoindex files
+// below this file will not reference this autoindex file:
+//
+//    - autoindex:named, orphan
+// 
+// Also be aware that all of your content outside the "// #region" section in this file
 // will be preserved in situations where you need to do something paricularly awesome.
 // Keep on being awesome.
 

package/src/types/lists/UniqueForProp.ts

@@ -1,8 +1,18 @@
 import { Get } from "../dictionary/Get";
+import { Narrowable } from "../Narrowable";
 
 /**
  * Create a union type based on a given property in an array of objects
+ * ```ts
+ * const data = [
+ *    { id: 123, color: "blue" },
+ *    { id: 456, color: "red" },
+ *  ] as const;
+ * // 123 | 456
+ * type U = UniqueForProp<typeof data, "id">;
+ * ```
  */
-export type UniqueForProp<T extends readonly Record<string, any>[], P extends string> = Readonly<
-  Get<T[number], P>
->;
+export type UniqueForProp<
+  T extends readonly Record<string, Narrowable>[],
+  P extends string
+> = Readonly<Get<T[number], P>>;

package/src/types/ruleset-types.ts

@@ -1,6 +1,6 @@
 import type { TypeCondition } from "~/utility/runtime/ifTypeOf";
 import { OptionalKeys } from "./props";
-import { SameKeys } from "./SameKeys";
+import { SameKeys } from "./type-conversion/SameKeys";
 
 /**
  * **RuleDefinition**

package/src/types/type-conversion/WrapValue.ts

@@ -0,0 +1,15 @@
+type ValueFunction<T extends any> = <R extends any>(v: T) => R;
+
+/**
+ * **SameKeys**
+ *
+ * Given a dictionary `T` and a type-strong wrapper function `F`, returns a dictionary with the
+ * same keys but 
+ * 
+ * Note: meant to be used as part of an _extends_ clause in most cases.
+ */
+export type WrapValue<T extends {}, F extends ValueFunction<T>> = {
+  [P in keyof T]: ReturnType<F>;
+};
+
+

package/src/types/type-conversion/index.ts

@@ -2,19 +2,21 @@
 
 // #region autoindexed files
 
-// index last changed at: 8th Aug, 2021, 04:13 PM ( GMT-7 )
+// index last changed at: 10th Oct, 2021, 08:32 PM ( GMT-7 )
 // export: named; exclusions: index, private.
-// files: TupleToUnion, UnionToIntersection, UnionToTuple.
+// files: SameKeys, TupleToUnion, UnionToIntersection, UnionToTuple, WrapValue.
 
 // local file exports
+export * from "./SameKeys";
 export * from "./TupleToUnion";
 export * from "./UnionToIntersection";
 export * from "./UnionToTuple";
+export * from "./WrapValue";
 
 // Note:
 // -----
 // This file was created by running: "dd devops autoindex"; it assumes you have
-// the 'do-devops' pkg installed as a dev dep.
+// the 'do-devops' pkg (that's "dd" on npm) installed as a dev dep.
 //
 // By default it assumes that exports are named exports but this can be changed by
 // adding a modifier to the '// #autoindex' syntax:
@@ -33,7 +35,12 @@ export * from "./UnionToTuple";
 //
 //    - autoindex:named, exclude: foo,bar,baz
 //
-// Also be aware that all of your content outside the defined region in this file
+// Inversely, if you state a file to be an "orphan" then autoindex files
+// below this file will not reference this autoindex file:
+//
+//    - autoindex:named, orphan
+// 
+// Also be aware that all of your content outside the "// #region" section in this file
 // will be preserved in situations where you need to do something paricularly awesome.
 // Keep on being awesome.
 

package/src/utility/dictionary/arrayToKeyLookup.ts

@@ -1,7 +1,6 @@
 /**
- * Passing in an array of strings, you are passed back a dictionary with all the keys
- * being the strings and values set to `true`.
- * 
+ * Passing in an array of strings, you are passed back a dictionary with
+ * all the keys being the strings and values set to `true`.
  * ```ts
  * // { foo: true, bar: true }
  * const fooBar = arrayToKeyLookup("foo", "bar");
@@ -15,4 +14,4 @@ export function arrayToKeyLookup<T extends readonly string[]>(...keys: T): Recor
   }
 
   return obj;
-}
+}

package/src/utility/dictionary/dictionaryTransform.ts

@@ -1,6 +1,6 @@
 /* eslint-disable no-use-before-define */
+import { keys } from "~/utility/keys";
 import { SameKeys, Transformer } from "~/types";
-import { kv } from "native-dash";
 
 /**
  * Takes a dictionary of type `I` and converts it to a dictionary of type `O` where
@@ -10,13 +10,12 @@ import { kv } from "native-dash";
  * and key, and then return expected value of `O` for the given key.
  */
 export function dictionaryTransform<I extends object, O extends SameKeys<I>>(
-  i: I,
+  input: I,
   transform: Transformer<I, O>
 ) {
-  const result = {} as any;
-  for (const pair of kv(i)) {
-    result[pair.key] = transform(i, pair.key);
-  }
 
-  return result as O;
+  return keys(input).reduce((acc, i) => {
+    const key = i as string & keyof I;
+    return {...acc, [key]: transform(input, key)};
+  }, {} as O);
 }

package/src/utility/index.ts

@@ -2,10 +2,10 @@
 
 // #region autoindexed files
 
-// index last changed at: 8th Aug, 2021, 11:56 AM ( GMT-7 )
+// index last changed at: 8th Aug, 2021, 10:32 AM ( GMT-7 )
 // export: named; exclusions: index, private.
 // files: createFnWithProps, keys, ruleset.
-// directories: api, dictionary, literals, map-reduce, modelling, runtime, state.
+// directories: api, dictionary, lists, literals, map-reduce, modelling, runtime, state.
 
 // local file exports
 export * from "./createFnWithProps";
@@ -15,6 +15,7 @@ export * from "./ruleset";
 // directory exports
 export * from "./api/index";
 export * from "./dictionary/index";
+export * from "./lists/index";
 export * from "./literals/index";
 export * from "./map-reduce/index";
 export * from "./modelling/index";

package/src/utility/lists/groupBy.ts

@@ -0,0 +1,22 @@
+import { Narrowable } from "~/types";
+// import { UniqueForProp } from "~/types/lists/UniqueForProp";
+
+/**
+ * Groups an array of data based on the value of a property
+ * in the objects within the array.
+ * ```ts
+ * const data = [ {}, {}, {} ];
+ *
+ * ```
+ *
+ * @ignore not implemented
+ */
+export function groupBy<T extends Record<string, Narrowable>, K extends keyof T & string>(
+  _data: Readonly<T[]>
+) {
+  throw new Error("not implemented");
+  return (_groupBy: K) => {
+    // type _GroupedBy = UniqueForProp<typeof data, K>;
+    // const _output = {} as Record<GroupedBy, Narrowable>;
+  };
+}

package/src/utility/lists/index.ts

@@ -0,0 +1,38 @@
+// #autoindex
+
+// #region autoindexed files
+
+// index last changed at: 8th Aug, 2021, 10:32 AM ( GMT-7 )
+// export: named; exclusions: index, private.
+// files: groupBy.
+
+// local file exports
+export * from "./groupBy";
+
+// Note:
+// -----
+// This file was created by running: "dd devops autoindex"; it assumes you have
+// the 'do-devops' pkg installed as a dev dep.
+//
+// By default it assumes that exports are named exports but this can be changed by
+// adding a modifier to the '// #autoindex' syntax:
+//
+//    - autoindex:named     same as default, exports "named symbols"
+//    - autoindex:default   assumes each file is exporting a default export
+//                          and converts the default export to the name of the
+//                          file
+//    - autoindex:offset    assumes files export "named symbols" but that each
+//                          file's symbols should be offset by the file's name
+//                          (useful for files which might symbols which collide
+//                          or where the namespacing helps consumers)
+//
+// You may also exclude certain files or directories by adding it to the
+// autoindex command. As an example:
+//
+//    - autoindex:named, exclude: foo,bar,baz
+//
+// Also be aware that all of your content outside the defined region in this file
+// will be preserved in situations where you need to do something paricularly awesome.
+// Keep on being awesome.
+
+// #endregion

package/tests/Where.spec.ts

@@ -0,0 +1,39 @@
+import { Expect, Equal } from "@type-challenges/utils";
+import { Where, WhereNot } from "../src/types/Where";
+
+describe("Where<T,U> and WhereNot<T,U> type utility", () => {
+
+  it("readonly string array works correctly", () => {
+    const arr = ["foo", "bar", "baz"] as const;
+    type A = typeof arr;
+    type B = Where<A, `ba${string}`>;
+    type F = WhereNot<A, `ba${string}`>;
+
+    type cases = [
+      //
+      Expect<Equal<B, "bar"| "baz">>,
+      Expect<Equal<F, "foo">>
+    ];
+    
+    const c: cases = [ true, true ];
+    expect(c).toBe(c);
+  });
+
+  it("object with literal keys works", () => {
+    const arr = {foo: true, bar: true, baz: true} as const;
+    type A = typeof arr;
+    type B = Where<A, `ba${string}`>;
+    type F = WhereNot<A, `ba${string}`>;
+
+    type cases = [
+      //
+      Expect<Equal<B, "bar"| "baz">>,
+      Expect<Equal<F, "foo">>
+    ];
+    
+    const c: cases = [ true, true ];
+    expect(c).toBe(c);
+  });
+
+
+});

package/tests/constructor.spec.ts

@@ -0,0 +1,40 @@
+import { Expect, Equal } from "@type-challenges/utils";
+import { Constructor } from "../src/types/Constructor";
+
+class TestClass {
+  public foo: number;
+  public bar: string;
+
+  constructor(foo: number, bar: string) {
+    this.foo = foo;
+    this.bar = bar;
+  }
+}
+
+describe("Constructor<Ctor, Klass>", () => {
+  it("simple test", () => {
+    type KlassParams = ConstructorParameters<typeof TestClass>;
+    type KlassInstance = InstanceType<typeof TestClass>;
+    type Synthetic = Constructor<[foo: number, bar: string], TestClass>;
+    type SynReturn = InstanceType<Synthetic>;
+    const s: Synthetic = TestClass;
+
+    const myS = new s(1, "bar");
+
+    const inst = new TestClass(1, "bar");
+    type Instance = typeof inst;
+
+    type cases = [
+      // prep
+      Expect<Equal<Instance, { foo: number; bar: string }>>,
+      Expect<Equal<Instance, KlassInstance>>,
+      Expect<Equal<KlassParams, [foo: number, bar: string]>>,
+      //
+      Expect<Equal<SynReturn, TestClass>>
+    ];
+
+    const c: cases = [true, true, true, true];
+    expect(c).toBe(c);
+    expect(myS).toBeInstanceOf(TestClass);
+  });
+});

package/tests/data/index.ts

@@ -2,14 +2,14 @@
 
 // #region autoindexed files
 
-// index last changed at: 8th Aug, 2021, 09:49 AM ( GMT-7 )
+// index last changed at: 12th Dec, 2021, 12:35 PM ( GMT-8 )
 // export: named; exclusions: index, private.
 
 
 // Note:
 // -----
 // This file was created by running: "dd devops autoindex"; it assumes you have
-// the 'do-devops' pkg installed as a dev dep.
+// the 'do-devops' pkg (that's "dd" on npm) installed as a dev dep.
 //
 // By default it assumes that exports are named exports but this can be changed by
 // adding a modifier to the '// #autoindex' syntax:
@@ -28,7 +28,12 @@
 //
 //    - autoindex:named, exclude: foo,bar,baz
 //
-// Also be aware that all of your content outside the defined region in this file
+// Inversely, if you state a file to be an "orphan" then autoindex files
+// below this file will not reference this autoindex file:
+//
+//    - autoindex:named, orphan
+// 
+// Also be aware that all of your content outside the "// #region" section in this file
 // will be preserved in situations where you need to do something paricularly awesome.
 // Keep on being awesome.
 

package/tests/kv/dict-to-kv-and-back.spec.ts

@@ -23,10 +23,7 @@ describe("dictToKv()", () => {
     }
 
     type cases = [
-      Expect<
-        Equal<
-          Val,
-          [
+      Expect<Equal<Val, [
             {
               key: "id";
               value: 123;
@@ -35,8 +32,7 @@ describe("dictToKv()", () => {
               key: "foo";
               value: "bar";
             }
-          ]
-        >
+          ]>
       >
     ];