@platecms/delta-castscript 1.0.0 → 1.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platecms/delta-castscript",
-  "version": "1.0.0",
+  "version": "1.3.0",
   "description": "Helper function for quickly creating CAST based trees.",
   "license": "UNLICENSED",
   "publishConfig": {
@@ -17,12 +17,10 @@
     "src/**/*"
   ],
   "dependencies": {
-    "@platecms/delta-cast": "1.0.0",
-    "@platecms/delta-plate-resource-notation": "1.0.0",
+    "@platecms/delta-cast": "1.3.0",
+    "@platecms/delta-plate-resource-notation": "1.3.0",
     "class-transformer": "0.5.1",
-    "lodash": "4.17.21",
     "reflect-metadata": "0.2.2",
     "tslib": "2.8.1"
-  },
-  "type": "commonjs"
+  }
 }

package/src/index.ts

@@ -0,0 +1,6 @@
+import { createC } from "./lib";
+
+/*
+ eslint-disable-next-line id-length, @typescript-eslint/naming-convention -- we use c as a variable name to create as compact functions as possible
+*/
+export const c = createC();

package/src/lib/index.spec.ts

@@ -0,0 +1,52 @@
+import { c } from "../index";
+
+describe("create c", () => {
+  it("should create a content node", () => {
+    const result = c("paragraph", "hello");
+
+    expect(result).toEqual({
+      type: "paragraph",
+      children: [
+        {
+          type: "text",
+          value: "hello",
+        },
+      ],
+    });
+  });
+
+  it("should create a content node with children", () => {
+    const result = c("heading", { level: 1 }, [c("text", "hello")]);
+
+    expect(result).toEqual({
+      type: "heading",
+      level: 1,
+      children: [
+        {
+          type: "text",
+          value: "hello",
+        },
+      ],
+    });
+  });
+
+  it("should create a content node with root and children", () => {
+    const result = c("root", [c("heading", "welcome", { level: 1 })]);
+
+    expect(result).toEqual({
+      type: "root",
+      children: [
+        {
+          type: "heading",
+          level: 1,
+          children: [
+            {
+              type: "text",
+              value: "welcome",
+            },
+          ],
+        },
+      ],
+    });
+  });
+});

package/src/lib/index.ts

@@ -0,0 +1,75 @@
+import { Content, Root } from "@platecms/delta-cast";
+import { isObject, isUndefined } from "../schema/lib/utils";
+
+type Children = Content[];
+type Properties = Record<string, unknown>;
+type Text = string;
+
+type Args = Children | Properties | Text;
+
+type NodeType = Content["type"] | "root";
+interface Node {
+  [key: string]: unknown;
+  type: NodeType;
+  value?: string;
+  children?: Children;
+}
+
+function isTextArgument(arg: Args): arg is string {
+  return typeof arg === "string";
+}
+
+function isObjectArgument(arg: Args): arg is Record<string, unknown> {
+  return isObject(arg);
+}
+
+function isChildrenArgument(arg: Args): arg is Content[] {
+  return Array.isArray(arg);
+}
+
+function addChild(node: Node, child: Content): void {
+  node.children ??= [];
+
+  node.children.push(child);
+}
+
+export function createC(): <T extends NodeType>(
+  type: T,
+  ...args: [Children | Properties | Text, (Children | Properties)?, Children?]
+) => T extends "root" ? Root : Content {
+  function create<T extends NodeType>(
+    type: T,
+    ...args: [Children | Properties | Text, (Children | Properties)?, Children?]
+  ): T extends "root" ? Root : Content {
+    const node: Node = {
+      type,
+    };
+
+    args.forEach((arg) => {
+      if (isUndefined(arg)) {
+        return;
+      }
+
+      if (isTextArgument(arg)) {
+        if (type === "text") {
+          node.value = arg;
+        } else {
+          addChild(node, {
+            type: "text",
+            value: arg,
+          });
+        }
+      } else if (isChildrenArgument(arg)) {
+        for (const child of arg) {
+          addChild(node, child);
+        }
+      } else if (isObjectArgument(arg)) {
+        Object.assign(node, arg);
+      }
+    });
+
+    return node as unknown as T extends "root" ? Root : Content;
+  }
+
+  return create;
+}

package/src/schema/lib/utils/index.spec.ts

@@ -0,0 +1,261 @@
+import { compact, first, isArray, isObject, isUndefined } from "./index";
+
+describe("first", () => {
+  it("should return the first element of an array with numbers", () => {
+    const array = [1, 2, 3, 4, 5];
+    const result = first(array);
+    expect(result).toBe(1);
+  });
+
+  it("should return the first element of an array with strings", () => {
+    const array = ["apple", "banana", "cherry"];
+    const result = first(array);
+    expect(result).toBe("apple");
+  });
+
+  it("should return the first element of an array with objects", () => {
+    const obj1 = { id: 1, name: "first" };
+    const obj2 = { id: 2, name: "second" };
+    const array = [obj1, obj2];
+    const result = first(array);
+    expect(result).toBe(obj1);
+  });
+
+  it("should return undefined for an empty array", () => {
+    const array: number[] = [];
+    const result = first(array);
+    expect(result).toBeUndefined();
+  });
+
+  it("should return the first element even if it's falsy", () => {
+    const array = [0, 1, 2];
+    const result = first(array);
+    expect(result).toBe(0);
+  });
+
+  it("should work with arrays containing undefined", () => {
+    const array = [undefined, "second", "third"];
+    const result = first(array);
+    expect(result).toBeUndefined();
+  });
+});
+
+describe("compact", () => {
+  it("should remove null values from array", () => {
+    const array = [1, null, 2, null, 3];
+    const result = compact(array);
+    expect(result).toEqual([1, 2, 3]);
+  });
+
+  it("should remove undefined values from array", () => {
+    const array = [1, undefined, 2, undefined, 3];
+    const result = compact(array);
+    expect(result).toEqual([1, 2, 3]);
+  });
+
+  it("should remove false values from array", () => {
+    const array = [true, false, true, false];
+    const result = compact(array);
+    expect(result).toEqual([true, true]);
+  });
+
+  it("should remove empty strings from array", () => {
+    const array = ["hello", "", "world", ""];
+    const result = compact(array);
+    expect(result).toEqual(["hello", "world"]);
+  });
+
+  it("should remove zero values from array", () => {
+    const array = [1, 0, 2, 0, 3];
+    const result = compact(array);
+    expect(result).toEqual([1, 2, 3]);
+  });
+
+  it("should remove all falsy values in mixed array", () => {
+    const array = [1, null, "hello", undefined, false, "", 0, 2, "world"];
+    const result = compact(array);
+    expect(result).toEqual([1, "hello", 2, "world"]);
+  });
+
+  it("should return empty array when all values are falsy", () => {
+    const array = [null, undefined, false, "", 0];
+    const result = compact(array);
+    expect(result).toEqual([]);
+  });
+
+  it("should return same array when no falsy values", () => {
+    const array = [1, 2, "hello", true, { id: 1 }];
+    const result = compact(array);
+    expect(result).toEqual([1, 2, "hello", true, { id: 1 }]);
+  });
+
+  it("should work with empty array", () => {
+    const array: (string | null)[] = [];
+    const result = compact(array);
+    expect(result).toEqual([]);
+  });
+});
+
+describe("isArray", () => {
+  it("should return true for empty array", () => {
+    const value: unknown[] = [];
+    expect(isArray(value)).toBe(true);
+  });
+
+  it("should return true for array of numbers", () => {
+    const value: number[] = [1, 2, 3];
+    expect(isArray(value)).toBe(true);
+  });
+
+  it("should return true for array of strings", () => {
+    const value: string[] = ["a", "b", "c"];
+    expect(isArray(value)).toBe(true);
+  });
+
+  it("should return true for array of objects", () => {
+    const value: { id: number }[] = [{ id: 1 }, { id: 2 }];
+    expect(isArray(value)).toBe(true);
+  });
+
+  it("should return false for null", () => {
+    const value: unknown = null;
+    expect(isArray(value)).toBe(false);
+  });
+
+  it("should return false for undefined", () => {
+    const value: unknown = undefined;
+    expect(isArray(value)).toBe(false);
+  });
+
+  it("should return false for plain object", () => {
+    const value: { key: string } = { key: "value" };
+    expect(isArray(value)).toBe(false);
+  });
+
+  it("should return false for string", () => {
+    const value = "hello";
+    expect(isArray(value)).toBe(false);
+  });
+
+  it("should return false for number", () => {
+    const value = 42;
+    expect(isArray(value)).toBe(false);
+  });
+
+  it("should return false for boolean", () => {
+    const value = true;
+    expect(isArray(value)).toBe(false);
+  });
+
+  it("should return false for function", () => {
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    function value(): void {}
+    expect(isArray(value)).toBe(false);
+  });
+
+  it("should return false for Date object", () => {
+    const value = new Date();
+    expect(isArray(value)).toBe(false);
+  });
+});
+
+describe("isObject", () => {
+  it("should return true for empty object", () => {
+    const value = {};
+    expect(isObject(value)).toBe(true);
+  });
+
+  it("should return true for object with properties", () => {
+    const value = { key: "value" };
+    expect(isObject(value)).toBe(true);
+  });
+
+  it("should return false for null", () => {
+    const value = null;
+    expect(isObject(value)).toBe(false);
+  });
+
+  it("should return false for undefined", () => {
+    const value = undefined;
+    expect(isObject(value)).toBe(false);
+  });
+
+  it("should return true for array", () => {
+    const value = [1, 2, 3];
+    expect(isObject(value)).toBe(true);
+  });
+
+  it("should return true for function", () => {
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    function value(): void {}
+    expect(isObject(value)).toBe(true);
+  });
+
+  it("should return true for Date object", () => {
+    const value = new Date();
+    expect(isObject(value)).toBe(true);
+  });
+
+  it("should return false for number", () => {
+    const value = 42;
+    expect(isObject(value)).toBe(false);
+  });
+
+  it("should return false for boolean", () => {
+    const value = true;
+    expect(isObject(value)).toBe(false);
+  });
+
+  it("should return false for string", () => {
+    const value = "hello";
+    expect(isObject(value)).toBe(false);
+  });
+});
+
+describe("isUndefined", () => {
+  it("should return true for undefined", () => {
+    const value = undefined;
+    expect(isUndefined(value)).toBe(true);
+  });
+
+  it("should return false for null", () => {
+    const value = null;
+    expect(isUndefined(value)).toBe(false);
+  });
+
+  it("should return false for string", () => {
+    const value = "hello";
+    expect(isUndefined(value)).toBe(false);
+  });
+
+  it("should return false for number", () => {
+    const value = 42;
+    expect(isUndefined(value)).toBe(false);
+  });
+
+  it("should return false for boolean", () => {
+    const value = true;
+    expect(isUndefined(value)).toBe(false);
+  });
+
+  it("should return false for function", () => {
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    function value(): void {}
+    expect(isUndefined(value)).toBe(false);
+  });
+
+  it("should return false for Date object", () => {
+    const value = new Date();
+    expect(isUndefined(value)).toBe(false);
+  });
+
+  it("should return false for null", () => {
+    const value = null;
+    expect(isUndefined(value)).toBe(false);
+  });
+
+  it("should return false for undefined", () => {
+    const value = undefined;
+    expect(isUndefined(value)).toBe(true);
+  });
+});

package/src/schema/lib/utils/index.ts

@@ -0,0 +1,19 @@
+export function first<T>(array: T[]): T | undefined {
+  return array[0];
+}
+
+export function compact<T>(array: (T | "" | 0 | false | null | undefined)[]): T[] {
+  return array.filter((value) => Boolean(value)) as T[];
+}
+
+export function isArray<T>(value: unknown): value is T[] {
+  return Array.isArray(value);
+}
+
+export function isObject(value: unknown): value is object {
+  return value != null && (typeof value === "object" || typeof value === "function");
+}
+
+export function isUndefined(value: unknown): value is undefined {
+  return value === undefined;
+}

package/src/index.d.ts

@@ -1,5 +0,0 @@
-export declare const c: <T extends "paragraph" | "heading" | "list" | "listItem" | "blockquote" | "code" | "text" | "bold" | "italic" | "underline" | "strikethrough" | "inlineCode" | "highlight" | "contentValue" | "externalLink" | "internalLink" | "root">(type: T, args_0: string | {
-    [x: string]: unknown;
-} | import("generated/dist/packages/cast/src").Content[], args_1?: {
-    [x: string]: unknown;
-} | import("generated/dist/packages/cast/src").Content[] | undefined, args_2?: import("generated/dist/packages/cast/src").Content[] | undefined) => T extends "root" ? import("generated/dist/packages/cast/src").Root : import("generated/dist/packages/cast/src").Content;

package/src/index.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.c = void 0;
-const lib_1 = require("./lib");
-exports.c = (0, lib_1.createC)();
-//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/castscript/src/index.ts"],"names":[],"mappings":";;;AAAA,+BAAgC;AAKnB,QAAA,CAAC,GAAG,IAAA,aAAO,GAAE,CAAC"}

package/src/lib/index.d.ts

@@ -1,7 +0,0 @@
-import { Content, Root } from "@platecms/delta-cast";
-type Children = Content[];
-type Properties = Record<string, unknown>;
-type Text = string;
-type NodeType = Content["type"] | "root";
-export declare function createC(): <T extends NodeType>(type: T, ...args: [Children | Properties | Text, (Children | Properties)?, Children?]) => T extends "root" ? Root : Content;
-export {};

package/src/lib/index.js

@@ -1,51 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createC = createC;
-const lodash_1 = require("lodash");
-function isTextArgument(arg) {
-    return typeof arg === "string";
-}
-function isObjectArgument(arg) {
-    return (0, lodash_1.isObject)(arg);
-}
-function isChildrenArgument(arg) {
-    return Array.isArray(arg);
-}
-function addChild(node, child) {
-    node.children ??= [];
-    node.children.push(child);
-}
-function createC() {
-    function create(type, ...args) {
-        const node = {
-            type,
-        };
-        args.forEach((arg) => {
-            if ((0, lodash_1.isUndefined)(arg)) {
-                return;
-            }
-            if (isTextArgument(arg)) {
-                if (type === "text") {
-                    node.value = arg;
-                }
-                else {
-                    addChild(node, {
-                        type: "text",
-                        value: arg,
-                    });
-                }
-            }
-            else if (isChildrenArgument(arg)) {
-                for (const child of arg) {
-                    addChild(node, child);
-                }
-            }
-            else if (isObjectArgument(arg)) {
-                Object.assign(node, arg);
-            }
-        });
-        return node;
-    }
-    return create;
-}
-//# sourceMappingURL=index.js.map

package/src/lib/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/castscript/src/lib/index.ts"],"names":[],"mappings":";;AAmCA,0BAuCC;AAzED,mCAA+C;AAgB/C,SAAS,cAAc,CAAC,GAAS;IAC/B,OAAO,OAAO,GAAG,KAAK,QAAQ,CAAC;AACjC,CAAC;AAED,SAAS,gBAAgB,CAAC,GAAS;IACjC,OAAO,IAAA,iBAAQ,EAAC,GAAG,CAAC,CAAC;AACvB,CAAC;AAED,SAAS,kBAAkB,CAAC,GAAS;IACnC,OAAO,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;AAC5B,CAAC;AAED,SAAS,QAAQ,CAAC,IAAU,EAAE,KAAc;IAC1C,IAAI,CAAC,QAAQ,KAAK,EAAE,CAAC;IAErB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAC5B,CAAC;AAED,SAAgB,OAAO;IAIrB,SAAS,MAAM,CACb,IAAO,EACP,GAAG,IAAyE;QAE5E,MAAM,IAAI,GAAS;YACjB,IAAI;SACL,CAAC;QAEF,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACnB,IAAI,IAAA,oBAAW,EAAC,GAAG,CAAC,EAAE,CAAC;gBACrB,OAAO;YACT,CAAC;YAED,IAAI,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC;gBACxB,IAAI,IAAI,KAAK,MAAM,EAAE,CAAC;oBACpB,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC;gBACnB,CAAC;qBAAM,CAAC;oBACN,QAAQ,CAAC,IAAI,EAAE;wBACb,IAAI,EAAE,MAAM;wBACZ,KAAK,EAAE,GAAG;qBACX,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;iBAAM,IAAI,kBAAkB,CAAC,GAAG,CAAC,EAAE,CAAC;gBACnC,KAAK,MAAM,KAAK,IAAI,GAAG,EAAE,CAAC;oBACxB,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;gBACxB,CAAC;YACH,CAAC;iBAAM,IAAI,gBAAgB,CAAC,GAAG,CAAC,EAAE,CAAC;gBACjC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;YAC3B,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,IAAoD,CAAC;IAC9D,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}