inferred-types 0.20.0 → 0.22.5

package/src/types/functions/index.ts

@@ -0,0 +1,12 @@
+// #autoindex
+// #region auto-indexed files
+// index last changed at: 8th Aug, 2022, 09:51 AM ( GMT-7 )
+// hash-code: 57dfa865
+
+// file exports
+export * from "./FinalReturn";
+
+// #endregion auto-indexed files
+
+// see https://github.com/inocan-group/do-devops/docs/autoindex.md
+// for more info

package/src/types/index.ts

@@ -1,7 +1,7 @@
 // #autoindex
-// #region autoindexed files
-// index last changed at: 1st Jan, 2022, 03:27 PM ( GMT-8 )
-// hash-code: 7e6e29a0
+// #region auto-indexed files
+// index last changed at: 8th Aug, 2022, 09:51 AM ( GMT-7 )
+// hash-code: fbd4603a
 
 // file exports
 export * from "./Api";
@@ -22,12 +22,12 @@ export * from "./Not";
 export * from "./Numeric";
 export * from "./Opaque";
 export * from "./Retain";
+export * from "./SimplifyObject";
 export * from "./Transformer";
 export * from "./TypeGuard";
 export * from "./Where";
 export * from "./append-types";
 export * from "./maybe";
-export * from "./props";
 export * from "./ruleset-types";
 export * from "./runtime";
 export * from "./type-testing";
@@ -35,36 +35,14 @@ export * from "./type-testing";
 export * from "./alphabetic/index";
 export * from "./dictionary/index";
 export * from "./fluent/index";
+export * from "./functions/index";
 export * from "./kv/index";
 export * from "./lists/index";
 export * from "./string-literals/index";
 export * from "./tuples/index";
 export * from "./type-conversion/index";
 
-// #endregion
+// #endregion auto-indexed files
 
-// This file was created by running: "dd 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
-//
-// 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
-// 
-// All 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.
+// see https://github.com/inocan-group/do-devops/docs/autoindex.md
+// for more info

package/src/types/kv/index.ts

@@ -1,7 +1,7 @@
 // #autoindex
-// #region autoindexed files
-// index last changed at: 1st Jan, 2022, 03:27 PM ( GMT-8 )
-// hash-code: abd196de
+// #region auto-indexed files
+// index last changed at: 8th Aug, 2022, 09:51 AM ( GMT-7 )
+// hash-code: 744ff3bf
 
 // file exports
 export * from "./DictFromKv";
@@ -9,30 +9,7 @@ export * from "./KeyValue";
 export * from "./KvFrom";
 export * from "./KvTuple";
 
-// #endregion
+// #endregion auto-indexed files
 
-// This file was created by running: "dd 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
-//
-// 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
-// 
-// All 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.
+// see https://github.com/inocan-group/do-devops/docs/autoindex.md
+// for more info

package/src/types/lists/index.ts

@@ -1,36 +1,13 @@
 // #autoindex
 
-// #region autoindexed files
-// index last changed at: 1st Jan, 2022, 03:27 PM ( GMT-8 )
-// hash-code: 61af00e2
+// #region auto-indexed files
+// index last changed at: 8th Aug, 2022, 09:51 AM ( GMT-7 )
+// hash-code: 582c0cf0
 
 // file exports
 export * from "./UniqueForProp";
 
-// #endregion
+// #endregion auto-indexed files
 
-// This file was created by running: "dd 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
-//
-// 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
-// 
-// All 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.
+// see https://github.com/inocan-group/do-devops/docs/autoindex.md
+// for more info

package/src/types/ruleset-types.ts

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

package/src/types/runtime.ts

@@ -1,7 +1,7 @@
-import { TypeGuard } from "~/types";
-
 // runtime types relate to the types coming out of the runtime utilities
 
+import { TypeGuard } from "./TypeGuard";
+
 export type RuntimeType<T> = {
   __kind: "type";
 
@@ -14,21 +14,21 @@ export type RuntimeProp<P extends Readonly<PropertyKey>, T extends RuntimeType<a
   key: Readonly<P>;
   valueType: Readonly<T["type"]>;
   /**
- * Provides the _type_ to the type system when used with `typeof`.
- * 
- * ```ts
- * const t = number();
- * // number
- * type T = typeof t.type;
- * ```
- * 
- * **Note:** _the runtime system will get a string equivalent name:_
- * ```ts
- * const t = number();
- * // "number"
- * console.log(t.type);
- * ```
- */
+   * Provides the _type_ to the type system when used with `typeof`.
+   *
+   * ```ts
+   * const t = number();
+   * // number
+   * type T = typeof t.type;
+   * ```
+   *
+   * **Note:** _the runtime system will get a string equivalent name:_
+   * ```ts
+   * const t = number();
+   * // "number"
+   * console.log(t.type);
+   * ```
+   */
   type: Record<P, T["type"]>;
   is: TypeGuard<Record<P, T["type"]>>;
 };
@@ -36,4 +36,4 @@ export type RuntimeProp<P extends Readonly<PropertyKey>, T extends RuntimeType<a
 export type TypeOptions<T extends Partial<object> = {}> = {
   /** each type has a default type guard but you can override if you need to be more specific */
   typeGuard?: TypeGuard<T>;
-} & T;
+} & T;

package/src/types/string-literals/LeftWhitespace.ts

@@ -1,4 +1,5 @@
-import type { Replace, TrimLeft } from "~/types";
+import { Replace } from "./Replace";
+import { TrimLeft } from "./TrimLeft";
 
 /**
  * Provides the _left_ whitespace of a string
@@ -7,4 +8,6 @@ import type { Replace, TrimLeft } from "~/types";
  * type T = LeftWhitespace<"\n\t foobar">;
  * ```
  */
-export type LeftWhitespace<S extends string> = string extends S ? string : Replace<S, TrimLeft<S>, "">;
+export type LeftWhitespace<S extends string> = string extends S
+  ? string
+  : Replace<S, TrimLeft<S>, "">;

package/src/types/string-literals/RightWhitespace.ts

@@ -1,4 +1,5 @@
-import type { Replace, TrimRight } from "~/types";
+import { Replace } from "./Replace";
+import { TrimRight } from "./TrimRight";
 
 /**
  * Provides the _left_ whitespace of a string
@@ -7,4 +8,6 @@ import type { Replace, TrimRight } from "~/types";
  * type T = LeftWhitespace<"\n\t foobar">;
  * ```
  */
-export type RightWhitespace<S extends string> = string extends S ? string : Replace<S, TrimRight<S>, "">;
+export type RightWhitespace<S extends string> = string extends S
+  ? string
+  : Replace<S, TrimRight<S>, "">;

package/src/types/string-literals/index.ts

@@ -1,7 +1,7 @@
 // #autoindex
-// #region autoindexed files
-// index last changed at: 1st Jan, 2022, 03:27 PM ( GMT-8 )
-// hash-code: a80cfdd7
+// #region auto-indexed files
+// index last changed at: 8th Aug, 2022, 09:51 AM ( GMT-7 )
+// hash-code: d0cf1562
 
 // file exports
 export * from "./Break";
@@ -15,30 +15,7 @@ export * from "./TrimLeft";
 export * from "./TrimRight";
 export * from "./form-fields";
 
-// #endregion
+// #endregion auto-indexed files
 
-// This file was created by running: "dd 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
-//
-// 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
-// 
-// All 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.
+// see https://github.com/inocan-group/do-devops/docs/autoindex.md
+// for more info

package/src/types/tuples/FirstKey.ts

@@ -1,10 +1,10 @@
-import type { Keys, UnionToTuple } from "~/types";
+import { Keys } from "../Keys";
+import { UnionToTuple } from "../type-conversion/UnionToTuple";
 
 /**
  * Returns the _first_ key in an object.
- * 
+ *
  * **Note:** key order is not guarenteed so typically this is used
  * for a key/value pair where only one key is expected
  */
 export type FirstKey<T extends object> = UnionToTuple<Keys<T>>[0];
-

package/src/types/tuples/FromDictArray.ts

@@ -1,5 +1,5 @@
-import { ExpandRecursively, UnionToIntersection } from "~/types";
-
+import { ExpandRecursively } from "../ExpandRecursively";
+import { UnionToIntersection } from "../type-conversion";
 
 /**
  * Typescript utility which receives `T` as shape which resembles `DictArray<D>`
@@ -9,5 +9,6 @@ import { ExpandRecursively, UnionToIntersection } from "~/types";
  * type Dict = FromDictArray<[["foo", { foo: 1 }], ["bar", { bar: "hi" }]]>;
  * ```
  */
-export type FromDictArray<T extends [string, Record<string, unknown>][]> =
-  ExpandRecursively<UnionToIntersection<T[number][1]>>;
+export type FromDictArray<T extends [string, Record<string, unknown>][]> = ExpandRecursively<
+  UnionToIntersection<T[number][1]>
+>;

package/src/types/tuples/index.ts

@@ -1,7 +1,7 @@
 // #autoindex
-// #region autoindexed files
-// index last changed at: 1st Jan, 2022, 03:27 PM ( GMT-8 )
-// hash-code: 37b8bb67
+// #region auto-indexed files
+// index last changed at: 8th Aug, 2022, 09:51 AM ( GMT-7 )
+// hash-code: 582cd3f6
 
 // file exports
 export * from "./DictArray";
@@ -11,30 +11,7 @@ export * from "./FirstOfEach";
 export * from "./FromDictArray";
 export * from "./SecondOfEach";
 
-// #endregion
+// #endregion auto-indexed files
 
-// This file was created by running: "dd 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
-//
-// 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
-// 
-// All 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.
+// see https://github.com/inocan-group/do-devops/docs/autoindex.md
+// for more info

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

@@ -1,41 +1,15 @@
 // #autoindex
 
-// #region autoindexed files
-// index last changed at: 6th Jun, 2022, 03:36 AM ( GMT-7 )
-// hash-code: ac142b94
+// #region auto-indexed files
+// index last changed at: 8th Aug, 2022, 09:51 AM ( GMT-7 )
+// hash-code: 200001fa
 
 // file exports
-export * from "./SameKeys";
 export * from "./TupleToUnion";
 export * from "./UnionToIntersection";
 export * from "./UnionToTuple";
-export * from "./UnwrapValue";
-export * from "./WrapValue";
 
-// #endregion
+// #endregion auto-indexed files
 
-// This file was created by running: "dd 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
-//
-// 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
-// 
-// All 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.
+// see https://github.com/inocan-group/do-devops/docs/autoindex.md
+// for more info

package/src/utility/api/api.ts

@@ -1,9 +1,10 @@
-import { Narrowable } from "~/types";
+import { Narrowable } from "src/types/Narrowable";
 
-export const api = <N extends Narrowable, TPrivate extends Readonly<Record<any, N>>>(priv: TPrivate) => <TPublic extends object>(pub: TPublic) => {
-  const surface = () => pub as TPublic;
-  surface.prototype.priv = () => priv as TPrivate;
-
-  return surface;
-};
+export const api =
+  <N extends Narrowable, TPrivate extends Readonly<Record<any, N>>>(priv: TPrivate) =>
+  <TPublic extends object>(pub: TPublic) => {
+    const surface = () => pub as TPublic;
+    surface.prototype.priv = () => priv as TPrivate;
 
+    return surface;
+  };

package/src/utility/api/index.ts

@@ -1,35 +1,12 @@
 // #autoindex
-// #region autoindexed files
-// index last changed at: 1st Jan, 2022, 03:27 PM ( GMT-8 )
-// hash-code: d2d3ad38
+// #region auto-indexed files
+// index last changed at: 8th Aug, 2022, 09:51 AM ( GMT-7 )
+// hash-code: 57c2f8db
 
 // file exports
 export * from "./api";
 
-// #endregion
+// #endregion auto-indexed files
 
-// This file was created by running: "dd 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
-//
-// 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
-// 
-// All 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.
+// see https://github.com/inocan-group/do-devops/docs/autoindex.md
+// for more info

package/src/utility/dictionary/defineProperties.ts

@@ -0,0 +1,35 @@
+export interface DefinePropertiesApi<T extends {}> {
+  /**
+   * Makes a property on the object **readonly** on the Javascript runtime
+   */
+  ro<K extends keyof T>(
+    prop: K,
+    errorMsg?: (p: K, v: any) => string
+  ): Omit<T, K> & Record<K, Readonly<T[K]>>;
+  /**
+   * Makes a property on the object **read/writeable** on the Javascript runtime;
+   * this is the default so only use this where it is needed.
+   */
+  rw<K extends keyof T>(prop: K): Omit<T, K> & Record<K, Readonly<T[K]>>;
+}
+
+export function defineProperties<T extends {}>(obj: T) {
+  return {
+    ro(prop, errorMsg) {
+      Object.defineProperty(obj, prop, {
+        writable: false,
+        set(v: any) {
+          const message = errorMsg
+            ? errorMsg(prop, v)
+            : `The ${String(
+                prop
+              )} is readonly but an attempt was made to change it's value to "${JSON.stringify(
+                v
+              )}"!`;
+          throw new Error(message);
+        },
+      });
+      return obj;
+    },
+  } as DefinePropertiesApi<T>;
+}

package/src/utility/dictionary/dictionaryTransform.ts

@@ -1,6 +1,8 @@
 /* eslint-disable no-use-before-define */
-import { keys } from "~/utility/keys";
-import { SameKeys, Transformer } from "~/types";
+
+import { SameKeys } from "src/types/dictionary";
+import { Transformer } from "src/types/Transformer";
+import { keys } from "../keys";
 
 /**
  * Takes a dictionary of type `I` and converts it to a dictionary of type `O` where
@@ -13,9 +15,8 @@ export function dictionaryTransform<I extends object, O extends SameKeys<I>>(
   input: I,
   transform: Transformer<I, O>
 ) {
-
   return keys(input).reduce((acc, i) => {
     const key = i as string & keyof I;
-    return {...acc, [key]: transform(input, key)};
+    return { ...acc, [key]: transform(input, key) };
   }, {} as O);
 }

package/src/utility/dictionary/entries.ts

@@ -1,10 +1,11 @@
-import { KeyValue, Narrowable } from "~/types";
+import { KeyValue } from "src/types/kv";
+import { Narrowable } from "src/types/Narrowable";
 import { keys } from "../keys";
 
 /**
  * **entries**
  *
- * Provides an _interable_ over the passed in dictionary object where each iteration 
+ * Provides an _iterable_ over the passed in dictionary object where each iteration
  * provides a tuple of `[ key, value ]` which preserve type literals.
  *
  * For example:
@@ -14,8 +15,11 @@ import { keys } from "../keys";
  * for (const [k, v] of entries(obj)) { ... }
  * ```
  */
-export function entries<N extends Narrowable, T extends Record<string, N>, I extends KeyValue<T, keyof T>>(obj: T) {
-
+export function entries<
+  N extends Narrowable,
+  T extends Record<string, N>,
+  I extends KeyValue<T, keyof T>
+>(obj: T) {
   const iterable = {
     *[Symbol.iterator]() {
       for (const k of keys(obj)) {
@@ -26,4 +30,4 @@ export function entries<N extends Narrowable, T extends Record<string, N>, I ext
   };
 
   return iterable;
-}
+}

package/src/utility/dictionary/index.ts

@@ -1,42 +1,19 @@
 // #autoindex
-// #region autoindexed files
-// index last changed at: 1st Jan, 2022, 03:27 PM ( GMT-8 )
-// hash-code: c3587066
+// #region auto-indexed files
+// index last changed at: 8th Aug, 2022, 09:51 AM ( GMT-7 )
+// hash-code: b0051c37
 
 // file exports
 export * from "./arrayToKeyLookup";
+export * from "./defineProperties";
 export * from "./dictionaryTransform";
 export * from "./entries";
 export * from "./mapValues";
 export * from "./strArrayToDict";
-export * from "./valuesOfProp";
 // directory exports
 export * from "./kv/index";
 
-// #endregion
+// #endregion auto-indexed files
 
-// This file was created by running: "dd 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
-//
-// 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
-// 
-// All 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.
+// see https://github.com/inocan-group/do-devops/docs/autoindex.md
+// for more info