@media-quest/engine 0.0.7 → 0.0.8

package/src/utils/ID.spec.ts

@@ -0,0 +1,39 @@
+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

@@ -0,0 +1,71 @@
+// The default length of an ID
+const ID_LENGTH = 32;
+
+// The minimum length of an ID
+const MIN_LENGTH = 10;
+
+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 createID = <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> => createID(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");