@platecms/delta-castscript 0.1.0

package/README.md

@@ -0,0 +1,120 @@
+# castscript
+
+This library is part of the [CAST]() abstract syntax tree utilities.
+It provides a scriptable interface to help with creating cast trees.
+
+## Usage
+
+Castscript provides an easy way to create cast trees using a scriptable interface.
+Using the utility `script` to `cast` looks as follows:
+```ts
+import {c} from '@platecms/delta-castscript'
+
+const tree = c('root', [
+    // only using the type argument
+    c('paragraph', [
+        // using the type and text arguments
+        c('text', 'Hello, world!')
+    ]),
+    // using the type, properties and children arguments
+    c('heading', { level: 1 }, [
+        c('bold', [
+            c('text', 'Hello, world!')
+        ])
+    ]),
+    //using the type, text, properties and children arguments
+    c('paragraph', 'Hello,', { class: 'text' }, [
+        c('text', 'world!')
+    ])
+])
+```
+
+yields:
+```json
+{
+  "type": "root",
+  "children": [
+    {
+      "type": "paragraph",
+      "children": [
+        { "type": "text", "value": "Hello, world!" }
+      ]
+    },
+    {
+      "type": "heading",
+      "level": 1,
+      "children": [
+        {
+          "type": "bold",
+          "children": [
+            { "type": "text", "value": "Hello, world!" }
+          ]
+        }
+      ]
+    },
+    {
+      "type": "paragraph",
+      "properties": { "class": "text" },
+      "children": [
+        { "type": "text", "value": "Hello," },
+        { "type": "text", "value": "world!" }
+      ]
+    }
+  ]
+}
+```
+
+You can use the following arguments to create complex cast trees:
+
+Required arguments
+- `type`: The type of the node
+
+Optional arguments, these can be used in different combinations
+- `text`: The text value of the node.
+- `properties`: The properties of the node.
+- `children`: The children of the node.
+
+Signature and overloads:
+```ts
+import {Root, Content} from 'cast'
+
+function c(type: string): Root | Content {
+    // function body
+}
+
+function c(type: string, text: string): Root | Content {
+    // function body
+}
+
+function c(type: string, properties: Record<string, any>): Root | Content {
+    // function body
+}
+
+function c(type: string, children: Node[]): Root | Content {
+    // function body
+}
+
+function c(type: string, text: string, properties: Record<string, any>): Root | Content {
+    // function body
+}
+
+function c(type: string, text: string, children: Node[]): Root | Content {
+    // function body
+}
+
+function c(type: string, properties: Record<string, any>, children: Node[]): Root | Content {
+    // function body
+}
+
+function c(type: string, text: string, properties: Record<string, any>, children: Node[]): Root | Content {
+    // function body
+}
+```
+
+## Building
+
+Run `nx build castscript` to build the library.
+
+## Running unit tests
+
+Run `nx test castscript` to execute the unit tests via [Vitest](https://vitest.dev/).

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@platecms/delta-castscript",
+  "version": "0.1.0",
+  "description": "Helper function for quickly creating CAST based trees.",
+  "license": "UNLICENSED",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://bitbucket.org/startmetplate/delta.git"
+  },
+  "homepage": "https://bitbucket.org/startmetplate/delta/src/dev/packages/castscript",
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts",
+  "files": [
+    "src/**/*"
+  ],
+  "dependencies": {
+    "@platecms/delta-cast": "0.4.8",
+    "@platecms/delta-plate-resource-notation": "1.4.1",
+    "class-transformer": "0.5.1",
+    "lodash": "4.17.21",
+    "reflect-metadata": "0.2.2",
+    "tslib": "2.8.1"
+  },
+  "type": "commonjs"
+}

package/src/index.d.ts

@@ -0,0 +1,5 @@
+export declare const c: <T extends "paragraph" | "heading" | "list" | "listItem" | "blockquote" | "code" | "text" | "bold" | "italic" | "underline" | "strikethrough" | "inlineCode" | "highlight" | "contentValue" | "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

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

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

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

@@ -0,0 +1,51 @@
+"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) {
+    if (!node.children)
+        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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/castscript/src/lib/index.ts"],"names":[],"mappings":";;AAmCA,0BAqCC;AAvED,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,IAAI,CAAC,QAAQ;QAAE,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;IAEvC,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;gBAAE,OAAO;YAE7B,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"}