@media-quest/engine 0.0.24 → 0.0.26

package/package.json

@@ -1,12 +1,12 @@
-{
-  "name": "@media-quest/engine",
-  "version": "0.0.24",
-  "description": "Rendering engine for media-quest schemas.",
-  "main": "src/public-api.ts",
-  "license": "MIT",
-  "scripts": {
-    "clean": "rimraf dist",
-    "build": "npm run clean && tsup src/public-api.ts --sourcemap inline --format cjs,esm --dts",
-    "tsc:check:engine": "tsc --watch --noEmit"
-  }
-}
+{
+  "name": "@media-quest/engine",
+  "version": "0.0.26",
+  "description": "Rendering engine for media-quest schemas.",
+  "main": "src/public-api.ts",
+  "license": "MIT",
+  "scripts": {
+    "clean": "rimraf dist",
+    "build": "npm run clean && tsup src/public-api.ts --sourcemap inline --format cjs,esm --dts",
+    "tsc:check:engine": "tsc --watch --noEmit"
+  }
+}

package/src/engine/SchemaDto.ts

@@ -1,7 +1,6 @@
 import { Rule } from "../rules/rule";
 import { Fact } from "../rules/fact";
 import { RuleActionPageQue } from "./page-que-ruleengine-action";
-import { SchemaID } from "../utils/ID";
 import { PageDto } from "../page/Page";
 
 export type PageQueRules = Rule<RuleActionPageQue, never>;
@@ -13,7 +12,7 @@ export interface PageSequenceDto {
 }
 
 export interface SchemaDto {
-  readonly id: SchemaID;
+  readonly id: string;
   readonly baseHeight: number;
   readonly baseWidth: number;
   readonly backgroundColor: string;

package/src/engine/history-que.spec.ts

@@ -1,12 +1,12 @@
 import { HistoryQue } from "./history-que";
 import { DTimestamp } from "../common/DTimestamp";
-import { PageID } from "../utils/ID";
 import { PageDto } from "../page/Page";
 import { PageResult } from "../page/page-result";
+import { DUtil } from "../utils/DUtil";
 
 const p = (id: number): PageDto => {
   return {
-    id: PageID.create(),
+    id: DUtil.randomObjectId(),
     prefix: "prefix" + id,
     components: [],
     initialTasks: [],

package/src/engine/next-que.spec.ts

@@ -1,6 +1,6 @@
 import { NextQue } from "./next-que";
-import { PageID } from "../utils/ID";
 import { PageDto } from "../page/Page";
+import { DUtil } from "../utils/DUtil";
 
 const tag1 = "tag1";
 const tag2 = "tag2";
@@ -9,7 +9,7 @@ const tag3 = "tag3";
 let que = new NextQue();
 const createPage = (tags: string[]): PageDto => {
   const dto: PageDto = {
-    id: PageID.create(),
+    id: DUtil.randomObjectId(),
     prefix: "prefix",
     staticElements: [],
     background: "white",

package/src/engine/page-que-ruleengine-action.ts

@@ -1,6 +1,4 @@
-import { PageID } from "../utils/ID";
-
 export type RuleActionPageQue =
   | { kind: "excludeByTag"; tagIds: string[] }
-  | { kind: "excludeByPageId"; pageIds: Array<PageID> }
-  | { kind: "jumpToPage"; pageId: PageID };
+  | { kind: "excludeByPageId"; pageIds: Array<string> }
+  | { kind: "jumpToPage"; pageId: string };

package/src/public-api.ts

@@ -7,7 +7,7 @@ export * from "./rules/fact";
 export * from "./rules/rule-engine";
 export * from "./rules/condition";
 export * from "./utils/DUtil";
-export * from "./utils/ID";
+// export * from "./utils/ID";
 
 export * from "./events/mq-events";
 

package/src/rules/__test__/rule-engine.spec.ts

@@ -3,9 +3,10 @@ import { Rule } from "../rule";
 import { Fact } from "../fact";
 import { Condition } from "../condition";
 import { RuleActionPageQue } from "../../engine/page-que-ruleengine-action";
-import { PageID } from "../../utils/ID";
+import { DUtil } from "../../utils/DUtil";
+// import { PageID } from "../../utils/ID";
 
-const excludeById = (ids: PageID[]): RuleActionPageQue => {
+const excludeById = (ids: string[]): RuleActionPageQue => {
   return {
     kind: "excludeByPageId",
     pageIds: ids,
@@ -100,7 +101,7 @@ describe("Rule-engine spec", () => {
   });
 
   it("Empty facts => no actions, no errors.", () => {
-    const hideAs1 = excludeById([PageID.create()]);
+    const hideAs1 = excludeById([DUtil.randomObjectId()]);
     const rule: Rule<any, any> = {
       id: "id123",
       description: "",
@@ -126,7 +127,7 @@ describe("Rule-engine spec", () => {
       some: [],
       all: [...trueIf_0_conditions],
       onFailure: [],
-      onSuccess: [excludeById([PageID.create(), PageID.create()])],
+      onSuccess: [excludeById([DUtil.randomObjectId(), DUtil.randomObjectId()])],
     };
     const f1 = xIs(0);
     const rules = [rule];
@@ -146,9 +147,11 @@ describe("Rule-engine spec", () => {
       some: [],
       all: [xCondition("eq", 0)],
       onFailure: [],
-      onSuccess: [excludeById([PageID.create(), PageID.create()])],
+      onSuccess: [excludeById([DUtil.randomObjectId(), DUtil.randomObjectId()])],
     };
+
     expect(engine.solve(rule, facts)).toEqual(false);
+
     const results = engine.solveAll([rule], facts);
     expect(results.matching.length).toBe(0);
     expect(results.errors.length).toBe(0);
@@ -162,7 +165,7 @@ describe("Rule-engine spec", () => {
       some: [xCondition("eq", 6)],
       all: [],
       onFailure: [],
-      onSuccess: [excludeById([PageID.create()])],
+      onSuccess: [excludeById([DUtil.randomObjectId()])],
     };
     expect(engine.solve(rule, facts)).toBe(true);
     const result = engine.solveAll([rule], facts);
@@ -299,7 +302,7 @@ describe("Rule-engine spec", () => {
 
   it("Complex all 6 true conditions -> true", () => {
     const facts = [xIs(0)];
-    const action = excludeById([PageID.create()]);
+    const action = excludeById([DUtil.randomObjectId()]);
     const rule: Rule<any, any> = {
       id: "id123",
 

package/src/utils/DUtil.ts

@@ -1,4 +1,4 @@
-export type RandomObjectId = string & { randomObjectId: true };
+// export type RandomObjectId = string & { randomObjectId: true };
 export namespace DUtil {
   export const randomString = (length: number): string => {
     const letters = "abcdefghijklmnopqrstuvxyz";
@@ -14,7 +14,7 @@ export namespace DUtil {
     return result;
   };
 
-  export const randomObjectId = () => randomString(32) as RandomObjectId;
+  export const randomObjectId = () => randomString(32);
 
   export const deleteProp = <Obj, Key extends keyof Obj>(obj: Obj, key: Key): Omit<Obj, Key> => {
     delete obj[key];

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");