inferred-types 0.16.1 → 0.18.2

package/src/Mutation/index.ts

@@ -1,39 +1,37 @@
 // #autoindex
 
 // #region autoindexed files
+// index last changed at: 12th Dec, 2021, 09:28 AM ( GMT-8 )
+// hash-code: 4139440866
 
-// index last changed at: 5th May, 2021, 05:45 PM ( GMT-7 )
-// export: named; exclusions: index, private.
-// files: MutationFunction, MutationIdentity.
-
-// local file exports
+// file exports
 export * from "./MutationFunction";
 export * from "./MutationIdentity";
 
-// Note:
-// -----
-// This file was created by running: "dd devops autoindex"; it assumes you have
-// the 'do-devops' pkg installed as a dev dep.
+// #endregion
+
+// 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: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.
+// 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.
-
-// #endregion

package/src/index.ts

@@ -1,43 +1,39 @@
 // #autoindex
 
 // #region autoindexed files
-
-// index last changed at: 6th Jun, 2021, 01:46 PM ( GMT-7 )
-// export: named; exclusions: index, private.
-// directories: Mutation, errors, types, utility.
+// index last changed at: 12th Dec, 2021, 09:30 AM ( GMT-8 )
+// hash-code: 1064662042
 
 // directory exports
 export * from "./Mutation/index";
-export * from "./errors/index";
+export * from "./shared/index";
 export * from "./types/index";
 export * from "./utility/index";
 
-// there were directories orphaned: shared
+// #endregion
 
-// Note:
-// -----
-// This file was created by running: "dd devops autoindex"; it assumes you have
-// the 'do-devops' pkg installed as a dev dep.
+// 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: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.
+// 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.
-
-// #endregion

package/src/shared/index.ts

@@ -1,40 +1,38 @@
 // #autoindex: orphan
 
 // #region autoindexed files
+// index last changed at: 12th Dec, 2021, 09:28 AM ( GMT-8 )
+// hash-code: 1491784011
 
-// index last changed at: 6th Jun, 2021, 06:35 PM ( GMT-7 )
-// export: named; exclusions: index, private.
-// files: randomString, uuid, valueTypes.
-
-// local file exports
+// file exports
 export * from "./randomString";
 export * from "./uuid";
 export * from "./valueTypes";
 
-// Note:
-// -----
-// This file was created by running: "dd devops autoindex"; it assumes you have
-// the 'do-devops' pkg installed as a dev dep.
+// #endregion
+
+// 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: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.
+// 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.
-
-// #endregion

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,20 +1,16 @@
 // #autoindex, exclude: Alpha
 // #region autoindexed files
+// index last changed at: 12th Dec, 2021, 09:28 AM ( GMT-8 )
+// hash-code: 265264203
 
-// index last changed at: 7th Jul, 2021, 01:59 PM ( GMT-7 )
-// export: named; exclusions: Alpha, index, private.
-// files: AllCaps, CamelCase, CapFirstAlpha, CapitalizeWords, DashToSnake, DashUppercase, Dasherize, HasUppercase, Intrinsic, IsCapitalized, KebabCase, LowerAllCaps, PascalCase, Pluralize, SnakeCase, alpha-characters.
-
-// local file exports
+// file exports
 export * from "./AllCaps";
 export * from "./CamelCase";
-export * from "./CapFirstAlpha";
 export * from "./CapitalizeWords";
 export * from "./DashToSnake";
 export * from "./DashUppercase";
 export * from "./Dasherize";
 export * from "./HasUppercase";
-export * from "./Intrinsic";
 export * from "./IsCapitalized";
 export * from "./KebabCase";
 export * from "./LowerAllCaps";
@@ -23,30 +19,30 @@ export * from "./Pluralize";
 export * from "./SnakeCase";
 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.
+// #endregion
+
+// 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: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.
+// 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.
-
-// #endregion

package/src/types/dictionary/index.ts

@@ -1,37 +1,35 @@
 // #autoindex
 // #region autoindexed files
+// index last changed at: 12th Dec, 2021, 09:28 AM ( GMT-8 )
+// hash-code: 1199590002
 
-// index last changed at: 7th Jul, 2021, 10:23 PM ( GMT-7 )
-// export: named; exclusions: index, private.
-// files: Get.
-
-// local file exports
+// file exports
 export * from "./Get";
 
-// Note:
-// -----
-// This file was created by running: "dd devops autoindex"; it assumes you have
-// the 'do-devops' pkg installed as a dev dep.
+// #endregion
+
+// 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: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.
+// 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.
-
-// #endregion

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,35 @@
+// #autoindex
+// #region autoindexed files
+// index last changed at: 12th Dec, 2021, 09:28 AM ( GMT-8 )
+// hash-code: 3321613880
+
+// file exports
+export * from "./fluent";
+
+// #endregion
+
+// 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.

package/src/types/index.ts

@@ -1,12 +1,9 @@
 // #autoindex
 // #region autoindexed files
+// index last changed at: 12th Dec, 2021, 09:28 AM ( GMT-8 )
+// hash-code: 2121148832
 
-// index last changed at: 10th Oct, 2021, 01:52 PM ( GMT-7 )
-// export: named; exclusions: index, private.
-// files: Api, Constructor, 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.
-
-// local file exports
+// file exports
 export * from "./Api";
 export * from "./Constructor";
 export * from "./EnumValues";
@@ -25,50 +22,49 @@ 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";
 export * from "./runtime";
 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";
 export * from "./tuples/index";
 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.
+// #endregion
+
+// 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: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.
+// 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.
-
-// #endregion

package/src/types/kv/index.ts

@@ -1,40 +1,38 @@
 // #autoindex
 // #region autoindexed files
+// index last changed at: 12th Dec, 2021, 09:28 AM ( GMT-8 )
+// hash-code: 2882639582
 
-// index last changed at: 7th Jul, 2021, 01:41 PM ( GMT-7 )
-// export: named; exclusions: index, private.
-// files: DictFromKv, KeyValue, KvFrom, KvTuple.
-
-// local file exports
+// file exports
 export * from "./DictFromKv";
 export * from "./KeyValue";
 export * from "./KvFrom";
 export * from "./KvTuple";
 
-// Note:
-// -----
-// This file was created by running: "dd devops autoindex"; it assumes you have
-// the 'do-devops' pkg installed as a dev dep.
+// #endregion
+
+// 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: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.
+// 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.
-
-// #endregion