inferred-types 0.22.0 → 0.22.5

package/dist/index.d.ts

@@ -1,5 +1,3 @@
-import { Alpha as Alpha$1 } from 'common-types';
-
 /**
  * **MutationIdentity**
  *
@@ -433,9 +431,6 @@ declare type IsFunction<T> = T extends FunctionType ? true : false;
  */
 declare function isFunction<T extends unknown>(input: T): IsFunction<T>;
 
-declare type IsLiteral<L extends string | number, T extends any> = T extends L ? true : false;
-declare function isLiteral<L extends Readonly<string>>(...allowed: L[]): <T extends unknown>(i: T) => IsLiteral<L, T>;
-
 declare function isNull<T>(i: T): T extends null ? true : false;
 
 declare function isNumber<T>(i: T): T extends number ? true : false;
@@ -562,6 +557,20 @@ O extends (...args: any[]) => any = (...args: any[]) => any> = SimplifyObject<{
  */
 declare type Get<T, K> = K extends `${infer FK}.${infer L}` ? FK extends keyof T ? Get<T[FK], L> : never : K extends keyof T ? T[K] : never;
 
+/**
+ * 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">;
+ * ```
+ */
+declare type MutableProps<T extends {}, M extends keyof T & string> = ExpandRecursively<Mutable<Pick<T, M>> & Readonly<Pick<T, Keys<T, M>>>>;
+
 /**
  * Given a dictionary of type `<T>`, this utility function will
  * make the `<R>` generic property _required_ (use a union to make
@@ -574,6 +583,43 @@ declare type Get<T, K> = K extends `${infer FK}.${infer L}` ? FK extends keyof T
  */
 declare type RequireProps<T extends {}, R extends keyof T> = ExpandRecursively<Required<Pick<T, R>> & T>;
 
+declare 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 */
+declare type UpperAlpha = Uppercase<LowerAlpha>;
+/**
+ * Alphabetical characters (upper and lower)
+ */
+declare type Alpha = UpperAlpha | LowerAlpha;
+declare type Whitespace = " " | "\n" | "\t";
+declare type Punctuation = "." | "," | ";" | "!" | "?";
+/**
+ * Characters which typically are used to separate words (but not including a space)
+ */
+declare type StringDelimiter = "_" | "-" | "/" | "\\";
+declare type OpeningBracket = "(" | "[" | "{";
+declare type ClosingBracket = ")" | "]" | "}";
+/**
+ * Opening and closing parenthesis
+ */
+declare type Parenthesis = "(" | ")";
+/**
+ * Opening and closing brackets
+ */
+declare type Bracket = OpeningBracket | ClosingBracket;
+/**
+ * Numeric string characters
+ */
+declare type NumericString = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9";
+/**
+ * Any alphabetic or numeric string character
+ */
+declare type AlphaNumeric = Alpha | NumericString;
+declare type SpecialCharacters = "@" | "~" | "^" | "#" | "&" | "*";
+/**
+ * Non-alphabetic characters including whitespace, string numerals, and
+ */
+declare type NonAlpha = Whitespace | Punctuation | NumericString | Bracket | SpecialCharacters;
+
 /**
  * Extracts the _required_ keys in the object's type
  */
@@ -607,7 +653,7 @@ declare type KeysWithValue<W extends any, T extends object> = {
  * A `PrivateKey` must start with a `_` character and then follow with
  * an alphabetic character
  */
-declare type PrivateKey = `_${Alpha$1}${string}`;
+declare type PrivateKey = `_${Alpha}${string}`;
 /**
  * Keys on an object which have a `_` character as first part of the
  * name are considered private and this utility will create a union
@@ -905,43 +951,6 @@ declare type StringLength<S extends string, R extends number[] = []> = S extends
  */
 declare type Trim<S extends string> = string extends S ? string : S extends `${Whitespace}${infer Right}` ? Trim<Right> : S extends `${infer Left}${Whitespace}` ? Trim<Left> : S;
 
-declare 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 */
-declare type UpperAlpha = Uppercase<LowerAlpha>;
-/**
- * Alphabetical characters (upper and lower)
- */
-declare type Alpha = UpperAlpha | LowerAlpha;
-declare type Whitespace = " " | "\n" | "\t";
-declare type Punctuation = "." | "," | ";" | "!" | "?";
-/**
- * Characters which typically are used to separate words (but not including a space)
- */
-declare type StringDelimiter = "_" | "-" | "/" | "\\";
-declare type OpenningBracket = "(" | "[" | "{";
-declare type ClosingBracket = ")" | "]" | "}";
-/**
- * Openning and closing parenthesis
- */
-declare type Parenthesis = "(" | ")";
-/**
- * Openning and closing brackets
- */
-declare type Bracket = OpenningBracket | ClosingBracket;
-/**
- * Numeric string characters
- */
-declare type NumericString = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9";
-/**
- * Any alphabetic or numeric string character
- */
-declare type AlphaNumeric = Alpha | NumericString;
-declare type SpecialCharacters = "@" | "~" | "^" | "#" | "&" | "*";
-/**
- * Non-alphabetic characters including whitespace, string numerals, and
- */
-declare type NonAlpha = Whitespace | Punctuation | NumericString | Bracket | SpecialCharacters;
-
 /**
  * An email address
  */
@@ -972,7 +981,7 @@ declare type DashDelim<T extends string> = T extends `${infer Begin}${" "}${infe
  */
 declare 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>>>;
 
-declare type CamelCase<S extends string> = Uncapitalize<PascalCase<S>>;
+declare type CamelCase<S extends string> = string extends S ? string : Uncapitalize<PascalCase<S>>;
 
 /**
  * Capitalize all words in a string
@@ -1331,6 +1340,19 @@ declare const api: <N extends Narrowable, TPrivate extends Readonly<Record<any,
  */
 declare function arrayToKeyLookup<T extends readonly string[]>(...keys: T): Record<T[number], true>;
 
+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]>>;
+}
+declare function defineProperties<T extends {}>(obj: T): DefinePropertiesApi<T>;
+
 /**
  * Takes a dictionary of type `I` and converts it to a dictionary of type `O` where
  * they _keys_ used in both dictionaries are the same.
@@ -1383,10 +1405,10 @@ declare function strArrayToDict<T extends readonly string[]>(...strings: T): Exp
  * const arr = dictToKv({ id: 123, foo: "bar" });
  * ```
  */
-declare function dictToKv<N extends Narrowable, T extends Record<string, N>, U extends boolean>(obj: T, _makeTuple?: U): U extends true ? UnionToTuple<(Mutable<T> extends infer T_1 ? { [K in keyof T_1]: {
+declare function dictToKv<N extends Narrowable, T extends Record<string, N>, U extends boolean>(obj: T, _makeTuple?: U): U extends true ? UnionToTuple<(Mutable<T> extends infer T_1 extends object ? { [K in keyof T_1]: {
     key: K;
     value: Mutable<T>[K];
-}; } : never)[keyof T], LastInUnion<(Mutable<T> extends infer T_1 ? { [K in keyof T_1]: {
+}; } : never)[keyof T], LastInUnion<(Mutable<T> extends infer T_1 extends object ? { [K in keyof T_1]: {
     key: K;
     value: Mutable<T>[K];
 }; } : never)[keyof T]>> : KvFrom<Mutable<T>>;
@@ -1653,4 +1675,4 @@ interface IFluentConfigurator<C> {
  */
 declare function FluentConfigurator<I>(initial?: I): IFluentConfigurator<{}>;
 
-export { AllCaps, Alpha, AlphaNumeric, Api, ApiFunction, ApiValue, AppendToDictionary, AppendToObject, ArrConcat, Array$1 as Array, ArrayConverter, AssertExtends, Bracket, Break, CamelCase, CapitalizeWords, ClosingBracket, Condition, Configurator, Constructor, DashToSnake, DashUppercase, Dasherize, DictArray, DictArrayFilterCallback, DictArrayKv, DictFromKv, DictKvTuple, DictPartialApplication, DictPrependWithFn, DictReturnValues, DynamicRule, DynamicRuleSet, Email, EnumValues, ExpandRecursively, ExpectExtends, ExplicitFunction, ExtendsClause, ExtendsNarrowlyClause, Filter, FinalReturn, First, FirstKey, FirstKeyValue, FirstOfEach, FluentConfigurator, FluentFunction, FromDictArray, FunctionType, GeneralDictionary, Get, HasUppercase, IConfigurator, IFluentConfigurator, If, IfExtends, IfExtendsThen, Include, Includes, IsArray, IsBoolean, IsCapitalized, IsFalse, IsFunction, IsLiteral, IsObject, IsString, IsTrue, KebabCase, KeyValue, KeyedRecord, Keys, KeysWithValue, KvFrom, KvTuple, LastInUnion, LeftWhitespace, Length, LowerAllCaps, LowerAlpha, MaybeFalse, MaybeTrue, Model, Mutable, MutationFunction, MutationIdentity, Narrowable, NonAlpha, NonNumericKeys, NonStringKeys, Not, Numeric, NumericKeys, NumericString, ObjectType, Opaque, OpenningBracket, OptionalKeys, OptionalProps, Parenthesis, PascalCase, Pluralize, PrivateKey, PrivateKeys, PublicKeys, Punctuation, PureFluentApi, Replace, RequireProps, RequiredKeys, RequiredProps, Retain, RightWhitespace, RuleDefinition, RuntimeProp, RuntimeType, SameKeys, SecondOfEach, SimplifyObject, SnakeCase, SpecialCharacters, StringDelimiter, StringKeys, StringLength, ToFluent, Transformer, Trim, TrimLeft, TrimRight, TupleToUnion, Type, TypeApi, TypeCondition, TypeDefinition, TypeGuard, TypeOptions, UnionToIntersection, UnionToTuple, UniqueDictionary, UniqueForProp, UpperAlpha, ValueTuple, ValueTypeFunc, ValueTypes, Where, WhereNot, Whitespace, WithNumericKeys, WithStringKeys, WithValue, ZipCode, and, api, arrayToKeyLookup, arrayToObject, condition, createFnWithProps, createMutationFunction, defineType, dictToKv, dictionaryTransform, entries, equals, filterDictArray, fnWithProps, greater, groupBy, idLiteral, idTypeGuard, identity, ifTypeOf, isArray, isBoolean, isFalse, isFunction, isLiteral, isNull, isNumber, isObject, isString, isSymbol, isTrue, isType, isUndefined, keys, kindLiteral, kv, kvToDict, less, literal, mapValues, nameLiteral, or, randomString, readonlyFnWithProps, ruleSet, strArrayToDict, type, typeApi, uuid, valueTypes, withValue };
+export { AllCaps, Alpha, AlphaNumeric, Api, ApiFunction, ApiValue, AppendToDictionary, AppendToObject, ArrConcat, Array$1 as Array, ArrayConverter, AssertExtends, Bracket, Break, CamelCase, CapitalizeWords, ClosingBracket, Condition, Configurator, Constructor, DashToSnake, DashUppercase, Dasherize, DefinePropertiesApi, DictArray, DictArrayFilterCallback, DictArrayKv, DictFromKv, DictKvTuple, DictPartialApplication, DictPrependWithFn, DictReturnValues, DynamicRule, DynamicRuleSet, Email, EnumValues, ExpandRecursively, ExpectExtends, ExplicitFunction, ExtendsClause, ExtendsNarrowlyClause, Filter, FinalReturn, First, FirstKey, FirstKeyValue, FirstOfEach, FluentConfigurator, FluentFunction, FromDictArray, FunctionType, GeneralDictionary, Get, HasUppercase, IConfigurator, IFluentConfigurator, If, IfExtends, IfExtendsThen, Include, Includes, IsArray, IsBoolean, IsCapitalized, IsFalse, IsFunction, IsObject, IsString, IsTrue, KebabCase, KeyValue, KeyedRecord, Keys, KeysWithValue, KvFrom, KvTuple, LastInUnion, LeftWhitespace, Length, LowerAllCaps, LowerAlpha, MaybeFalse, MaybeTrue, Model, Mutable, MutableProps, MutationFunction, MutationIdentity, Narrowable, NonAlpha, NonNumericKeys, NonStringKeys, Not, Numeric, NumericKeys, NumericString, ObjectType, Opaque, OpeningBracket, OptionalKeys, OptionalProps, Parenthesis, PascalCase, Pluralize, PrivateKey, PrivateKeys, PublicKeys, Punctuation, PureFluentApi, Replace, RequireProps, RequiredKeys, RequiredProps, Retain, RightWhitespace, RuleDefinition, RuntimeProp, RuntimeType, SameKeys, SecondOfEach, SimplifyObject, SnakeCase, SpecialCharacters, StringDelimiter, StringKeys, StringLength, ToFluent, Transformer, Trim, TrimLeft, TrimRight, TupleToUnion, Type, TypeApi, TypeCondition, TypeDefinition, TypeGuard, TypeOptions, UnionToIntersection, UnionToTuple, UniqueDictionary, UniqueForProp, UpperAlpha, ValueTuple, ValueTypeFunc, ValueTypes, Where, WhereNot, Whitespace, WithNumericKeys, WithStringKeys, WithValue, ZipCode, and, api, arrayToKeyLookup, arrayToObject, condition, createFnWithProps, createMutationFunction, defineProperties, defineType, dictToKv, dictionaryTransform, entries, equals, filterDictArray, fnWithProps, greater, groupBy, idLiteral, idTypeGuard, identity, ifTypeOf, isArray, isBoolean, isFalse, isFunction, isNull, isNumber, isObject, isString, isSymbol, isTrue, isType, isUndefined, keys, kindLiteral, kv, kvToDict, less, literal, mapValues, nameLiteral, or, randomString, readonlyFnWithProps, ruleSet, strArrayToDict, type, typeApi, uuid, valueTypes, withValue };

package/dist/index.js

@@ -32,6 +32,7 @@ __export(src_exports, {
   condition: () => condition,
   createFnWithProps: () => createFnWithProps,
   createMutationFunction: () => createMutationFunction,
+  defineProperties: () => defineProperties,
   defineType: () => defineType,
   dictToKv: () => dictToKv,
   dictionaryTransform: () => dictionaryTransform,
@@ -49,7 +50,6 @@ __export(src_exports, {
   isBoolean: () => isBoolean,
   isFalse: () => isFalse,
   isFunction: () => isFunction,
-  isLiteral: () => isLiteral,
   isNull: () => isNull,
   isNumber: () => isNumber,
   isObject: () => isObject,
@@ -174,6 +174,26 @@ function arrayToKeyLookup(...keys2) {
   return obj;
 }
 
+// src/utility/dictionary/defineProperties.ts
+function defineProperties(obj) {
+  return {
+    ro(prop, errorMsg) {
+      Object.defineProperty(obj, prop, {
+        writable: false,
+        set(v) {
+          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;
+    }
+  };
+}
+
 // src/utility/dictionary/dictionaryTransform.ts
 function dictionaryTransform(input, transform) {
   return keys(input).reduce((acc, i) => {
@@ -196,7 +216,9 @@ function entries(obj) {
 
 // src/utility/dictionary/mapValues.ts
 function mapValues(obj, valueMapper) {
-  return Object.fromEntries([...entries(obj)].map(([k, v]) => [k, valueMapper(v)]));
+  return Object.fromEntries(
+    [...entries(obj)].map(([k, v]) => [k, valueMapper(v)])
+  );
 }
 
 // src/utility/dictionary/strArrayToDict.ts
@@ -259,7 +281,9 @@ function FluentConfigurator(initial = {}) {
     };
   };
   if (initial && typeof initial !== "object") {
-    throw new Error("The FluentConfigurator was passed a non-object based value as the initial value. This is not allowed.");
+    throw new Error(
+      "The FluentConfigurator was passed a non-object based value as the initial value. This is not allowed."
+    );
   }
   return initial ? api2(initial) : api2({});
 }
@@ -413,8 +437,11 @@ function runtimeExtendsCheck(val, base, narrow = false) {
     case "object":
       if (val === null && base === null) {
         return true;
+      } else {
+        return keys(base).every(
+          (i) => runtimeExtendsCheck(val[i], base[i], narrow)
+        );
       }
-      return keys(base).every((i) => runtimeExtendsCheck(val[i], base[i], narrow));
   }
 }
 var ifTypeOf = (val) => ({
@@ -464,13 +491,6 @@ function isFunction(input) {
   return typeof input === "function";
 }
 
-// src/utility/runtime/conditions/isLiteral.ts
-function isLiteral(...allowed) {
-  return (i) => {
-    return !allowed.every((v) => i !== v);
-  };
-}
-
 // src/utility/runtime/conditions/isNull.ts
 function isNull(i) {
   return i === null;
@@ -581,7 +601,9 @@ function isType(t) {
 function type(fn) {
   const result = fn(typeApi());
   if (!isType(result)) {
-    throw new Error(`When using type(), the callback passed in returned an invalid type! Value returned was: ${result}`);
+    throw new Error(
+      `When using type(), the callback passed in returned an invalid type! Value returned was: ${result}`
+    );
   }
   return result;
 }
@@ -590,9 +612,11 @@ function type(fn) {
 function withValue(td) {
   return (obj) => {
     const t = type(td);
-    return Object.fromEntries([...entries(obj)].filter(([_key, value]) => {
-      return t.typeGuard(value);
-    }));
+    return Object.fromEntries(
+      [...entries(obj)].filter(([_key, value]) => {
+        return t.typeGuard(value);
+      })
+    );
   };
 }
 // Annotate the CommonJS export names for ESM import in node:
@@ -609,6 +633,7 @@ function withValue(td) {
   condition,
   createFnWithProps,
   createMutationFunction,
+  defineProperties,
   defineType,
   dictToKv,
   dictionaryTransform,
@@ -626,7 +651,6 @@ function withValue(td) {
   isBoolean,
   isFalse,
   isFunction,
-  isLiteral,
   isNull,
   isNumber,
   isObject,

package/dist/index.mjs

@@ -93,6 +93,26 @@ function arrayToKeyLookup(...keys2) {
   return obj;
 }
 
+// src/utility/dictionary/defineProperties.ts
+function defineProperties(obj) {
+  return {
+    ro(prop, errorMsg) {
+      Object.defineProperty(obj, prop, {
+        writable: false,
+        set(v) {
+          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;
+    }
+  };
+}
+
 // src/utility/dictionary/dictionaryTransform.ts
 function dictionaryTransform(input, transform) {
   return keys(input).reduce((acc, i) => {
@@ -115,7 +135,9 @@ function entries(obj) {
 
 // src/utility/dictionary/mapValues.ts
 function mapValues(obj, valueMapper) {
-  return Object.fromEntries([...entries(obj)].map(([k, v]) => [k, valueMapper(v)]));
+  return Object.fromEntries(
+    [...entries(obj)].map(([k, v]) => [k, valueMapper(v)])
+  );
 }
 
 // src/utility/dictionary/strArrayToDict.ts
@@ -178,7 +200,9 @@ function FluentConfigurator(initial = {}) {
     };
   };
   if (initial && typeof initial !== "object") {
-    throw new Error("The FluentConfigurator was passed a non-object based value as the initial value. This is not allowed.");
+    throw new Error(
+      "The FluentConfigurator was passed a non-object based value as the initial value. This is not allowed."
+    );
   }
   return initial ? api2(initial) : api2({});
 }
@@ -332,8 +356,11 @@ function runtimeExtendsCheck(val, base, narrow = false) {
     case "object":
       if (val === null && base === null) {
         return true;
+      } else {
+        return keys(base).every(
+          (i) => runtimeExtendsCheck(val[i], base[i], narrow)
+        );
       }
-      return keys(base).every((i) => runtimeExtendsCheck(val[i], base[i], narrow));
   }
 }
 var ifTypeOf = (val) => ({
@@ -383,13 +410,6 @@ function isFunction(input) {
   return typeof input === "function";
 }
 
-// src/utility/runtime/conditions/isLiteral.ts
-function isLiteral(...allowed) {
-  return (i) => {
-    return !allowed.every((v) => i !== v);
-  };
-}
-
 // src/utility/runtime/conditions/isNull.ts
 function isNull(i) {
   return i === null;
@@ -500,7 +520,9 @@ function isType(t) {
 function type(fn) {
   const result = fn(typeApi());
   if (!isType(result)) {
-    throw new Error(`When using type(), the callback passed in returned an invalid type! Value returned was: ${result}`);
+    throw new Error(
+      `When using type(), the callback passed in returned an invalid type! Value returned was: ${result}`
+    );
   }
   return result;
 }
@@ -509,9 +531,11 @@ function type(fn) {
 function withValue(td) {
   return (obj) => {
     const t = type(td);
-    return Object.fromEntries([...entries(obj)].filter(([_key, value]) => {
-      return t.typeGuard(value);
-    }));
+    return Object.fromEntries(
+      [...entries(obj)].filter(([_key, value]) => {
+        return t.typeGuard(value);
+      })
+    );
   };
 }
 export {
@@ -527,6 +551,7 @@ export {
   condition,
   createFnWithProps,
   createMutationFunction,
+  defineProperties,
   defineType,
   dictToKv,
   dictionaryTransform,
@@ -544,7 +569,6 @@ export {
   isBoolean,
   isFalse,
   isFunction,
-  isLiteral,
   isNull,
   isNumber,
   isObject,

package/package.json

@@ -1,12 +1,15 @@
 {
   "name": "inferred-types",
-  "version": "0.22.0",
+  "version": "0.22.5",
   "description": "Functions which provide useful type inference on TS projects",
   "license": "MIT",
   "author": "Ken Snyder<ken@ken.net>",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
   "typings": "dist/index.d.ts",
+  "repository": {
+    "url": "https://github.com/inocan-group/inferred-types"
+  },
   "sideEffects": false,
   "scripts": {
     "about": "tokei src",
@@ -29,29 +32,30 @@
   },
   "devDependencies": {
     "@type-challenges/utils": "~0.1.1",
-    "@types/node": "^16.11.45",
-    "@typescript-eslint/eslint-plugin": "^5.30.7",
-    "@typescript-eslint/parser": "^5.30.7",
+    "@types/node": "16",
+    "@typescript-eslint/eslint-plugin": "^5.40.1",
+    "@typescript-eslint/parser": "^5.40.1",
     "bumpp": "^8.2.1",
-    "common-types": "^1.30.0",
+    "common-types": "^1.31.1",
     "cross-env": "^7.0.3",
-    "dd": "^0.21.0",
-    "dotenv": "^16.0.1",
-    "eslint": "^8.20.0",
+    "dd": "^0.24.0",
+    "dotenv": "^16.0.3",
+    "eslint": "^8.25.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-prettier": "^4.2.1",
-    "eslint-plugin-promise": "^6.0.0",
+    "eslint-plugin-promise": "^6.1.0",
     "npm-run-all": "~4.1.5",
     "prettier": "~2.7.1",
     "rimraf": "^3.0.2",
-    "tsup": "^6.1.3",
-    "typescript": "^4.7.4",
-    "vite": "^3.0.2",
-    "vitest": "^0.19.0"
+    "sharp": "^0.31.1",
+    "tsup": "^6.3.0",
+    "typescript": "^4.8.4",
+    "vite": "^3.1.8",
+    "vitest": "^0.24.3"
   },
   "dependencies": {
-    "common-types": "^1.31.1"
+    "brilliant-errors": "^0.6.0"
   },
   "pnpm": {
     "overrides": {

package/src/Mutation/index.ts

@@ -1,37 +1,14 @@
 // #autoindex
 
-// #region autoindexed files
-// index last changed at: 1st Jan, 2022, 03:27 PM ( GMT-8 )
-// hash-code: f6badae2
+// #region auto-indexed files
+// index last changed at: 8th Aug, 2022, 09:51 AM ( GMT-7 )
+// hash-code: bd3a442e
 
 // file exports
 export * from "./MutationFunction";
 export * from "./MutationIdentity";
 
-// #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/index.ts

@@ -1,8 +1,8 @@
 // #autoindex
 
-// #region autoindexed files
-// index last changed at: 1st Jan, 2022, 03:27 PM ( GMT-8 )
-// hash-code: 3f75741a
+// #region auto-indexed files
+// index last changed at: 8th Aug, 2022, 09:51 AM ( GMT-7 )
+// hash-code: 5ddbbf55
 
 // directory exports
 export * from "./Mutation/index";
@@ -10,30 +10,7 @@ export * from "./shared/index";
 export * from "./types/index";
 export * from "./utility/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/shared/index.ts

@@ -1,38 +1,15 @@
 // #autoindex: orphan
 
-// #region autoindexed files
-// index last changed at: 1st Jan, 2022, 03:27 PM ( GMT-8 )
-// hash-code: 58ead14b
+// #region auto-indexed files
+// index last changed at: 8th Aug, 2022, 09:51 AM ( GMT-7 )
+// hash-code: 3305143b
 
 // file exports
 export * from "./randomString";
 export * from "./uuid";
 export * from "./valueTypes";
 
-// #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/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>>;