@media-quest/engine 0.0.23 → 0.0.25

package/src/utils/DUtil.ts

@@ -1,116 +1,116 @@
-export type RandomObjectId = string & { randomObjectId: true };
-export namespace DUtil {
-  export const randomString = (length: number): string => {
-    const letters = "abcdefghijklmnopqrstuvxyz";
-    const uppercase = letters.toUpperCase();
-    const all = letters + uppercase;
-    const abs = Math.abs(length);
-    let result = "";
-
-    for (let i = 0; i < abs; i++) {
-      const char = all.charAt(Math.floor(Math.random() * all.length));
-      result += char;
-    }
-    return result;
-  };
-
-  export const randomObjectId = () => randomString(32) as RandomObjectId;
-
-  export const deleteProp = <Obj, Key extends keyof Obj>(obj: Obj, key: Key): Omit<Obj, Key> => {
-    delete obj[key];
-    return obj;
-  };
-
-  export const isInRange = (min: number, max: number) => {
-    return (value: number) => value >= min && value <= max;
-  };
-  export const isInfinity = (number: number) => {
-    return (
-      number === Number.POSITIVE_INFINITY ||
-      number === Number.NEGATIVE_INFINITY ||
-      number === Infinity
-    );
-  };
-  export type NonEmptyArray<T> = [T, ...T[]];
-  export const isNonEmptyArray = <T>(array: Array<T>): array is NonEmptyArray<T> => {
-    return array.length > 0;
-  };
-
-  export const neverCheck = (args: never) => {
-    console.log("OOPS: This value slipped through the never-check", args);
-  };
-
-  export const isString = (str: unknown): str is string => typeof str === "string";
-
-  export const hasKey = <T extends string>(
-    obj: unknown,
-    key: T,
-  ): obj is Record<typeof key, unknown> => {
-    if (!isRecord(obj)) {
-      return false;
-    }
-    return Object.prototype.hasOwnProperty.call(obj, key);
-  };
-
-  export const isRecord = (obj: unknown): obj is Record<string, unknown> => {
-    if (!obj) {
-      return false;
-    }
-
-    if (Array.isArray(obj)) {
-      return false;
-    }
-
-    if (typeof obj !== "object") {
-      return false;
-    }
-
-    if (obj === null) {
-      return false;
-    }
-    return true;
-  };
-
-  export const isBool = (obj?: boolean): obj is boolean => typeof obj === "boolean";
-
-  export const isTrue = (bool?: boolean): bool is true => bool === true;
-
-  export const isFalse = (bool?: boolean): bool is false => bool === false;
-
-  export const isDefined = (obj: unknown): boolean => {
-    const notNull = obj !== null;
-    const notUndefined = obj !== undefined;
-    return notNull && notUndefined;
-  };
-
-  export const hasKind = (obj: unknown): obj is { readonly kind: string } => {
-    if (!hasKey(obj, "kind")) {
-      return false;
-    }
-    if (typeof obj.kind !== "string") {
-      return false;
-    }
-    return obj.kind.length > 0;
-  };
-
-  export const hasValue = (obj: unknown): obj is { value: unknown } => {
-    return hasKey(obj, "value");
-  };
-  export const isNumber = (value?: number): value is number => {
-    const isNumber = typeof value === "number";
-    const notNaN = !Number.isNaN(value);
-    return isNumber && notNaN;
-  };
-
-  export const maxFn = (upperLimit: number) => {
-    return (value: number) => {
-      return Math.min(value, upperLimit);
-    };
-  };
-
-  export const minFn = (lowerLimit: number) => {
-    return (value: number) => {
-      return Math.min(value, lowerLimit);
-    };
-  };
-}
+// export type RandomObjectId = string & { randomObjectId: true };
+export namespace DUtil {
+  export const randomString = (length: number): string => {
+    const letters = "abcdefghijklmnopqrstuvxyz";
+    const uppercase = letters.toUpperCase();
+    const all = letters + uppercase;
+    const abs = Math.abs(length);
+    let result = "";
+
+    for (let i = 0; i < abs; i++) {
+      const char = all.charAt(Math.floor(Math.random() * all.length));
+      result += char;
+    }
+    return result;
+  };
+
+  export const randomObjectId = () => randomString(32);
+
+  export const deleteProp = <Obj, Key extends keyof Obj>(obj: Obj, key: Key): Omit<Obj, Key> => {
+    delete obj[key];
+    return obj;
+  };
+
+  export const isInRange = (min: number, max: number) => {
+    return (value: number) => value >= min && value <= max;
+  };
+  export const isInfinity = (number: number) => {
+    return (
+      number === Number.POSITIVE_INFINITY ||
+      number === Number.NEGATIVE_INFINITY ||
+      number === Infinity
+    );
+  };
+  export type NonEmptyArray<T> = [T, ...T[]];
+  export const isNonEmptyArray = <T>(array: Array<T>): array is NonEmptyArray<T> => {
+    return array.length > 0;
+  };
+
+  export const neverCheck = (args: never) => {
+    console.log("OOPS: This value slipped through the never-check", args);
+  };
+
+  export const isString = (str: unknown): str is string => typeof str === "string";
+
+  export const hasKey = <T extends string>(
+    obj: unknown,
+    key: T,
+  ): obj is Record<typeof key, unknown> => {
+    if (!isRecord(obj)) {
+      return false;
+    }
+    return Object.prototype.hasOwnProperty.call(obj, key);
+  };
+
+  export const isRecord = (obj: unknown): obj is Record<string, unknown> => {
+    if (!obj) {
+      return false;
+    }
+
+    if (Array.isArray(obj)) {
+      return false;
+    }
+
+    if (typeof obj !== "object") {
+      return false;
+    }
+
+    if (obj === null) {
+      return false;
+    }
+    return true;
+  };
+
+  export const isBool = (obj?: boolean): obj is boolean => typeof obj === "boolean";
+
+  export const isTrue = (bool?: boolean): bool is true => bool === true;
+
+  export const isFalse = (bool?: boolean): bool is false => bool === false;
+
+  export const isDefined = (obj: unknown): boolean => {
+    const notNull = obj !== null;
+    const notUndefined = obj !== undefined;
+    return notNull && notUndefined;
+  };
+
+  export const hasKind = (obj: unknown): obj is { readonly kind: string } => {
+    if (!hasKey(obj, "kind")) {
+      return false;
+    }
+    if (typeof obj.kind !== "string") {
+      return false;
+    }
+    return obj.kind.length > 0;
+  };
+
+  export const hasValue = (obj: unknown): obj is { value: unknown } => {
+    return hasKey(obj, "value");
+  };
+  export const isNumber = (value?: number): value is number => {
+    const isNumber = typeof value === "number";
+    const notNaN = !Number.isNaN(value);
+    return isNumber && notNaN;
+  };
+
+  export const maxFn = (upperLimit: number) => {
+    return (value: number) => {
+      return Math.min(value, upperLimit);
+    };
+  };
+
+  export const minFn = (lowerLimit: number) => {
+    return (value: number) => {
+      return Math.min(value, lowerLimit);
+    };
+  };
+}

package/src/utils/ID.spec.ts

@@ -1,39 +0,0 @@
-import { PageID, SchemaID } from "./ID";
-
-describe("ID Functions work", () => {
-  //Generate test for schema prefix
-  test("SCHEMA_ID isFunction works", () => {
-    const id = SchemaID.create();
-    expect(SchemaID.is(id)).toBe(true);
-    expect(SchemaID.is("")).toBe(false);
-    expect(SchemaID.is("a")).toBe(false);
-    expect(SchemaID.is("a".repeat(10))).toBe(true);
-    expect(SchemaID.is("a".repeat(9))).toBe(false);
-  });
-  test("SCHEMA_ID ensure works", () => {
-    const id = SchemaID.create();
-    expect(SchemaID.ensure(id)).toBe(id);
-    expect(SchemaID.ensure("")).not.toBe("");
-    expect(SchemaID.ensure("")).not.toBe("a");
-    expect(SchemaID.ensure("a".repeat(10))).toBe("a".repeat(10));
-    expect(SchemaID.ensure("a".repeat(9))).not.toBe("a".repeat(9));
-    expect(SchemaID.ensure("ABcdefghigKLML")).toBe("ABcdefghigKLML");
-  });
-  test("PageID isFunction works", () => {
-    const id = PageID.create();
-    expect(PageID.is(id)).toBe(true);
-    expect(PageID.is("")).toBe(false);
-    expect(PageID.is("a")).toBe(false);
-    expect(PageID.is("a".repeat(10))).toBe(true);
-    expect(PageID.is("a".repeat(9))).toBe(false);
-  });
-  test("PageID ensure works", () => {
-    const id = PageID.create();
-    expect(PageID.ensure(id)).toBe(id);
-    expect(PageID.ensure("")).not.toBe("");
-    expect(PageID.ensure("")).not.toBe("a");
-    expect(PageID.ensure("a".repeat(10))).toBe("a".repeat(10));
-    expect(PageID.ensure("a".repeat(9))).not.toBe("a".repeat(9));
-    expect(PageID.ensure("ABcdefghigKLML")).toBe("ABcdefghigKLML");
-  });
-});

package/src/utils/ID.ts

@@ -1,73 +0,0 @@
-// The default length of an ID
-const ID_LENGTH = 32;
-
-// The minimum length of an ID
-const MIN_LENGTH = 10;
-
-// const SPLITTER = "_";
-
-export type ID<B extends string> = string & { __ID__: B };
-
-const isID = <const B extends string>(idName: B, id?: string): id is ID<B> => {
-  if (typeof id !== "string") return false;
-  return id.length >= MIN_LENGTH;
-};
-
-const createIDByName = <const B extends string>(idName: B): ID<B> => {
-  const letters = "abcdefghijklmnopqrstuvyz";
-  const all = letters + letters.toUpperCase();
-  let result = "";
-  for (let i = 0; i < ID_LENGTH; i++) {
-    const char = all.charAt(Math.floor(Math.random() * all.length));
-    result += char;
-  }
-  return result as ID<B>;
-};
-
-/**
- * Creates a object with helper functions for a specific ID type
- * @param idName
- */
-export const createTypedIdSingleton = <const B extends string>(idName: B) => {
-  /**
-   * Creates a new ID of the correct type
-   */
-  const create = (): ID<B> => createIDByName(idName);
-
-  /**
-   * Checks if the id is of the correct type
-   * @param id
-   */
-  const is = (id: string): id is ID<B> => isID(idName, id);
-
-  /**
-   * Checks if the id is of the correct type, if not it throws an error
-   * @param id
-   */
-  const validateOrThrow = (id: string): ID<B> => {
-    if (!is(id)) {
-      throw new Error(`Invalid id: ${id}`);
-    }
-    return id;
-  };
-
-  /**
-   * The lowercase name of the id (SCHEMA, PAGE, etc)
-   */
-  const name: B = idName;
-
-  /**
-   * Ensures that the id is of the correct type, if not it creates a new one
-   * @param id
-   */
-  const ensure = (id: string): ID<B> => {
-    return is(id) ? id : create();
-  };
-
-  return Object.freeze({ create, is, ensure, validateOrThrow, name });
-};
-
-export type SchemaID = ID<"SCHEMA">;
-export const SchemaID = createTypedIdSingleton("SCHEMA");
-export type PageID = ID<"PAGE">;
-export const PageID = createTypedIdSingleton("PAGE");