inferred-types 0.22.0 → 0.22.5

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/index.ts

@@ -1,10 +1,11 @@
 // #autoindex
-// #region autoindexed files
-// index last changed at: 7th Jul, 2022, 01:47 PM ( GMT-7 )
-// hash-code: dd2bf50a
+// #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";
@@ -12,30 +13,7 @@ export * from "./strArrayToDict";
 // 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

package/src/utility/dictionary/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: e1ea6f41
+// #region auto-indexed files
+// index last changed at: 8th Aug, 2022, 09:51 AM ( GMT-7 )
+// hash-code: dd4e4592
 
 // file exports
 export * from "./dictToKv";
@@ -9,30 +9,7 @@ export * from "./filterDictArray";
 export * from "./kv";
 export * from "./kvToDict";
 
-// #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/errors/ReadOnlyViolation.ts

@@ -0,0 +1,3 @@
+import { createError } from "brilliant-errors";
+
+export default createError("read-only-violation", "inferred-types")()()()();

package/src/utility/errors/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: 30d9ddb2
+
+// file exports
+export * from "./ReadOnlyViolation";
+
+// #endregion auto-indexed files
+
+// see https://github.com/inocan-group/do-devops/docs/autoindex.md
+// for more info

package/src/utility/index.ts

@@ -1,8 +1,8 @@
 // #autoindex
 
-// #region autoindexed files
-// index last changed at: 1st Jan, 2022, 03:27 PM ( GMT-8 )
-// hash-code: 6886d37a
+// #region auto-indexed files
+// index last changed at: 8th Aug, 2022, 09:51 AM ( GMT-7 )
+// hash-code: 9dd9ac96
 
 // file exports
 export * from "./createFnWithProps";
@@ -11,6 +11,7 @@ export * from "./ruleset";
 // directory exports
 export * from "./api/index";
 export * from "./dictionary/index";
+export * from "./errors/index";
 export * from "./lists/index";
 export * from "./literals/index";
 export * from "./map-reduce/index";
@@ -18,30 +19,7 @@ export * from "./modelling/index";
 export * from "./runtime/index";
 export * from "./state/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/utility/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: 150c313
+// #region auto-indexed files
+// index last changed at: 8th Aug, 2022, 09:51 AM ( GMT-7 )
+// hash-code: bf4a6791
 
 // file exports
 export * from "./groupBy";
 
-// #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/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: b7a5f43
+// #region auto-indexed files
+// index last changed at: 8th Aug, 2022, 09:51 AM ( GMT-7 )
+// hash-code: 7a22bbbc
 
 // file exports
 export * from "./ExplicitFunction";
@@ -10,30 +10,7 @@ export * from "./defineType";
 export * from "./identity";
 export * from "./literal";
 
-// #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/map-reduce/index.ts

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

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

@@ -1,15 +1,14 @@
 // #autoindex
 
-// #region autoindexed files
-// index last changed at: 1st Jan, 2022, 03:27 PM ( GMT-8 )
-// hash-code: a3788912
+// #region auto-indexed files
+// index last changed at: 8th Aug, 2022, 09:51 AM ( GMT-7 )
+// hash-code: 4324574d
 
 // file exports
 export * from "./isArray";
 export * from "./isBoolean";
 export * from "./isFalse";
 export * from "./isFunction";
-export * from "./isLiteral";
 export * from "./isNull";
 export * from "./isNumber";
 export * from "./isObject";
@@ -18,30 +17,7 @@ export * from "./isSymbol";
 export * from "./isTrue";
 export * from "./isUndefined";
 
-// #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/runtime/ifTypeOf.ts

@@ -29,10 +29,11 @@ function runtimeExtendsCheck<TValue extends any, TBase extends any>(
     case "object":
       if (val === null && base === null) {
         return true as TValue extends TBase ? true : false;
+      } else {
+        return keys(base as object).every((i) =>
+          runtimeExtendsCheck((val as TValue)[i], base[i], narrow)
+        ) as TValue extends TBase ? true : false;
       }
-      return keys(base as object).every((i) =>
-        runtimeExtendsCheck(val[i], base[i], narrow)
-      ) as TValue extends TBase ? true : false;
   }
 }
 

package/src/utility/runtime/index.ts

@@ -1,7 +1,7 @@
 // #autoindex
-// #region autoindexed files
-// index last changed at: 1st Jan, 2022, 03:27 PM ( GMT-8 )
-// hash-code: 91796b6
+// #region auto-indexed files
+// index last changed at: 8th Aug, 2022, 09:51 AM ( GMT-7 )
+// hash-code: 687852c8
 
 // file exports
 export * from "./condition";
@@ -11,30 +11,7 @@ export * from "./withValue";
 // directory exports
 export * from "./conditions/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/utility/state/index.ts

@@ -1,36 +1,13 @@
 // #autoindex
-// #region autoindexed files
-// index last changed at: 7th Jul, 2022, 01:15 PM ( GMT-7 )
-// hash-code: 14769606
+// #region auto-indexed files
+// index last changed at: 8th Aug, 2022, 09:51 AM ( GMT-7 )
+// hash-code: 397c607b
 
 // file exports
 export * from "./Configurator";
 export * from "./FluentConfigurator";
 
-// #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/tests/data/index.ts

@@ -1,35 +1,12 @@
 // #autoindex
 
-// #region autoindexed files
-// index last changed at: 1st Jan, 2022, 03:27 PM ( GMT-8 )
-// hash-code: da242834
+// #region auto-indexed files
+// index last changed at: 8th Aug, 2022, 06:09 PM ( GMT-7 )
+// hash-code: 683d9860
 
 
 
-// #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/tests/dictionary/DictChangeValue.test.ts

@@ -0,0 +1,30 @@
+import { describe, it } from "vitest";
+import type { Expect, Equal } from "@type-challenges/utils";
+import { DictChangeValue } from "../../src/types/dictionary/DictChangeValue";
+import { SimplifyObject } from "../../src/types/SimplifyObject";
+
+const test_obj = {
+  foo: "hello world",
+  bar: 42,
+  baz: () => "that's all folks",
+} as const;
+type TestObj = typeof test_obj;
+
+describe("DictChangeValue", () => {
+  it("convert all KVs to a single value type", () => {
+    type T = DictChangeValue<TestObj, number>;
+
+    type cases = [Expect<Equal<T, { foo: number; bar: number; baz: number }>>];
+    const cases: cases = [true];
+  });
+
+  it("convert functions values to boolean", () => {
+    type F = DictChangeValue<TestObj, boolean, Function>;
+    type S = DictChangeValue<TestObj, string, string>;
+    type N = DictChangeValue<TestObj, number, number>;
+    type T = SimplifyObject<F & S & N>;
+
+    type cases = [Expect<Equal<T, { foo: string; bar: number; baz: boolean }>>];
+    const cases: cases = [true];
+  });
+});

package/tests/dictionary/DictReturnValues.test.ts

@@ -25,7 +25,11 @@ describe("DictReturnValues<T, R, O>", () => {
       multiply: (v1: number, v2: number) => null;
     };
 
-    type cases = [Expect<Equal<T1, Expected1>>, Expect<Equal<T2, Expected2>>];
+    type cases = [
+      //
+      Expect<Equal<T1, Expected1>>, 
+      Expect<Equal<T2, Expected2>>
+    ];
 
     const cases: cases = [true, true];
   });