inferred-types 0.22.0 → 0.22.6

package/src/types/Keys.ts

@@ -1,10 +1,10 @@
-/** 
+/**
  * A Utility class that provides the same functionality as the built-in
  * `keyof` TS operator but can also:
- * 
+ *
  * - receive an array of strings and convert that into a union type.
  * - you can exclude literal string from the returned result
- * 
+ *
  * ```ts
  * const t1 = { foo: 1, bar: 2 };
  * // "foo" | "bar"
@@ -17,6 +17,10 @@
 export type Keys<
   T extends Record<string, any> | readonly string[],
   W extends string | undefined = undefined
-  > = T extends readonly string[]
-  ? W extends string ? Exclude<T[number], W> : T[number]
-  : W extends string ? Exclude<keyof T & string, W> : keyof T & string;
+> = T extends readonly string[]
+  ? W extends string
+    ? Exclude<T[number], W>
+    : T[number]
+  : W extends string
+  ? Exclude<keyof T & string, W>
+  : keyof T & string;

package/src/types/alphabetic/CamelCase.ts

@@ -1,3 +1,3 @@
 import { PascalCase } from "./PascalCase";
 
-export type CamelCase<S extends string> = Uncapitalize<PascalCase<S>>;
+export type CamelCase<S extends string> = string extends S ? string : Uncapitalize<PascalCase<S>>;

package/src/types/alphabetic/alpha-characters.ts

@@ -1,4 +1,30 @@
-export type LowerAlpha = "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z";
+export type LowerAlpha =
+  | "a"
+  | "b"
+  | "c"
+  | "d"
+  | "e"
+  | "f"
+  | "g"
+  | "h"
+  | "i"
+  | "j"
+  | "k"
+  | "l"
+  | "m"
+  | "n"
+  | "o"
+  | "p"
+  | "q"
+  | "r"
+  | "s"
+  | "t"
+  | "u"
+  | "v"
+  | "w"
+  | "x"
+  | "y"
+  | "z";
 
 /** Uppercase alphabetic character */
 export type UpperAlpha = Uppercase<LowerAlpha>;
@@ -8,7 +34,6 @@ export type UpperAlpha = Uppercase<LowerAlpha>;
  */
 export type Alpha = UpperAlpha | LowerAlpha;
 
-
 export type Whitespace = " " | "\n" | "\t";
 
 export type Punctuation = "." | "," | ";" | "!" | "?";
@@ -17,18 +42,18 @@ export type Punctuation = "." | "," | ";" | "!" | "?";
  */
 export type StringDelimiter = "_" | "-" | "/" | "\\";
 
-export type OpenningBracket = "(" | "[" | "{";
+export type OpeningBracket = "(" | "[" | "{";
 export type ClosingBracket = ")" | "]" | "}";
 
 /**
- * Openning and closing parenthesis
+ * Opening and closing parenthesis
  */
 export type Parenthesis = "(" | ")";
 
 /**
- * Openning and closing brackets
+ * Opening and closing brackets
  */
-export type Bracket = OpenningBracket | ClosingBracket;
+export type Bracket = OpeningBracket | ClosingBracket;
 
 /**
  * Numeric string characters
@@ -40,10 +65,9 @@ export type NumericString = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8"
  */
 export type AlphaNumeric = Alpha | NumericString;
 
-
 export type SpecialCharacters = "@" | "~" | "^" | "#" | "&" | "*";
 
 /**
- * Non-alphabetic characters including whitespace, string numerals, and 
+ * Non-alphabetic characters including whitespace, string numerals, and
  */
-export type NonAlpha = Whitespace | Punctuation | NumericString | Bracket | SpecialCharacters;
+export type NonAlpha = Whitespace | Punctuation | NumericString | Bracket | SpecialCharacters;

package/src/types/alphabetic/index.ts

@@ -1,7 +1,7 @@
 // #autoindex, exclude: Alpha
-// #region autoindexed files
-// index last changed at: 1st Jan, 2022, 03:27 PM ( GMT-8 )
-// hash-code: fcf9c4b
+// #region auto-indexed files
+// index last changed at: 8th Aug, 2022, 09:51 AM ( GMT-7 )
+// hash-code: b32382ed
 
 // file exports
 export * from "./AllCaps";
@@ -19,30 +19,7 @@ export * from "./Pluralize";
 export * from "./SnakeCase";
 export * from "./alpha-characters";
 
-// #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/dictionary/DictChangeValue.ts

@@ -0,0 +1,26 @@
+import { SimplifyObject } from "../SimplifyObject";
+
+/**
+ * Allow a dictionary have it's value's type changed to `T` while maintaining the keys in
+ * the original object `I` so long as the original value for the KV pair extends `V`.
+ *
+ * If `V` is not specified then it defaults to _any_ and therefore all KVs are preserved.
+ */
+export type DictChangeValue<
+  /** the object who's value-type we're changing */
+  I extends Record<string, any>,
+  /** the return type that functions should be modified to have */
+  T extends any,
+  /**
+   *The type we expect in the value; if the value extends type `V` then the value will
+   * be converted to type `O`; if not then the KV pair will be discarded
+   */
+  V extends any = any
+> = SimplifyObject<
+  {
+    [K in keyof I]: I[K] extends V
+      ? // it's a function (or at least the scoped down type of function we're looking for)
+        Record<K, T>
+      : never;
+  }[keyof I]
+>;

package/src/types/dictionary/MutableProps.ts

@@ -0,0 +1,19 @@
+import { ExpandRecursively } from "../ExpandRecursively";
+import { Keys } from "../Keys";
+import { Mutable } from "../Mutable";
+
+/**
+ * Given a dictionary of type `<T>`, this utility function will
+ * make the `<M>` generic property _mutable_ and all other _read-only_.
+ *
+ * ```ts
+ * // { foo: string, bar?: Readonly<number> }
+ * type Example = MutableProps<{
+ *    foo: Readonly<string>,
+ *    bar?: number
+ * }, "foo">;
+ * ```
+ */
+export type MutableProps<T extends {}, M extends keyof T & string> = ExpandRecursively<
+  Mutable<Pick<T, M>> & Readonly<Pick<T, Keys<T, M>>>
+>;

package/src/types/dictionary/index.ts

@@ -1,41 +1,20 @@
 // #autoindex
-// #region autoindexed files
-// index last changed at: 7th Jul, 2022, 02:28 PM ( GMT-7 )
-// hash-code: 6e90bc78
+// #region auto-indexed files
+// index last changed at: 8th Aug, 2022, 09:51 AM ( GMT-7 )
+// hash-code: 55881f7d
 
 // file exports
 export * from "./DictPartialApplication";
+export * from "./DictChangeValue";
 export * from "./DictPrependWithFn";
 export * from "./DictReturnValues";
 export * from "./Get";
+export * from "./MutableProps";
 export * from "./RequireProps";
 export * from "./SameKeys";
 export * from "./props";
 
-// #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/dictionary/props.ts

@@ -1,4 +1,4 @@
-import { Alpha } from "common-types";
+import { Alpha } from "../alphabetic/alpha-characters";
 
 /**
  * Extracts the _required_ keys in the object's type

package/src/types/fluent/index.ts

@@ -1,35 +1,12 @@
 // #autoindex
-// #region autoindexed files
-// index last changed at: 1st Jan, 2022, 03:27 PM ( GMT-8 )
-// hash-code: c5fbce38
+// #region auto-indexed files
+// index last changed at: 8th Aug, 2022, 09:51 AM ( GMT-7 )
+// hash-code: 9dbff34
 
 // file exports
 export * from "./fluent";
 
-// #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/functions/index.ts

@@ -1,35 +1,12 @@
 // #autoindex
-// #region autoindexed files
-// index last changed at: 6th Jun, 2022, 10:19 AM ( GMT-7 )
-// hash-code: 7fa9afdf
+// #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
+// #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/index.ts

@@ -1,7 +1,7 @@
 // #autoindex
-// #region autoindexed files
-// index last changed at: 7th Jul, 2022, 01:15 PM ( GMT-7 )
-// hash-code: f976e182
+// #region auto-indexed files
+// index last changed at: 8th Aug, 2022, 09:51 AM ( GMT-7 )
+// hash-code: fbd4603a
 
 // file exports
 export * from "./Api";
@@ -42,30 +42,7 @@ 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/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/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,38 +1,15 @@
 // #autoindex
 
-// #region autoindexed files
-// index last changed at: 6th Jun, 2022, 10:18 AM ( GMT-7 )
-// hash-code: b346a5f3
+// #region auto-indexed files
+// index last changed at: 8th Aug, 2022, 09:51 AM ( GMT-7 )
+// hash-code: 200001fa
 
 // file exports
 export * from "./TupleToUnion";
 export * from "./UnionToIntersection";
 export * from "./UnionToTuple";
 
-// #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