Arbor OST

.eslintrc.json

@@ -4,6 +4,14 @@
   "plugins": ["@typescript-eslint"],
   "ignorePatterns": ["dist"],
   "extends": ["prettier", "plugin:@typescript-eslint/recommended"],
+  "parserOptions": {
+    "ecmaVersion": 2023,
+    "sourceType": "module"
+  },
+  "env": {
+    "es2022": true,
+    "node": true
+  },
   "rules": {
     "@typescript-eslint/ban-types": "off",
     "@typescript-eslint/no-unsafe-member-access": "off",

.tool-versions

@@ -0,0 +1,2 @@
+nodejs 23.11.0
+yarn 1.22.22

.zed/debug.json

@@ -0,0 +1,5 @@
+// Project-local debug tasks
+//
+// For more documentation on how to configure debug tasks,
+// see: https://zed.dev/docs/debugger
+[]

package.json

@@ -23,6 +23,6 @@
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-jsx-a11y": "^6.7.1",
     "turbo": "^1.9.4",
-    "typescript": "^5.0.4"
+    "typescript": "^5.5.0"
   }
 }

packages/arbor-ost/.eslintrc.json

@@ -0,0 +1,7 @@
+{
+  "extends": ["../../.eslintrc.json"],
+  "ignorePatterns": ["perf"],
+  "parserOptions": {
+    "project": ["./tsconfig.eslint.json"]
+  }
+}

packages/arbor-ost/.prettierignore

@@ -0,0 +1,2 @@
+dist/
+**/dist/

packages/arbor-ost/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@arborjs/ost",
+  "sideEffects": false,
+  "version": "0.0.1-alpha.1",
+  "description": "An observable state tree data structure used to power @arborjs/store.",
+  "keywords": [
+    "arbor",
+    "react",
+    "state",
+    "store",
+    "typescript",
+    "tree"
+  ],
+  "repository": {
+    "url": "https://github.com/drborges/arbor",
+    "type": "git"
+  },
+  "bugs": {
+    "url": "https://github.com/drborges/arbor/issues",
+    "email": "drborges.cic@gmail.com"
+  },
+  "author": {
+    "email": "drborges.cic@gmail.com",
+    "name": "Diego Borges",
+    "url": "https://github.com/drborges"
+  },
+  "main": "./dist/index.cjs.js",
+  "module": "./dist/index.esm.js",
+  "types": "./dist/index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs.js",
+      "import": "./dist/index.esm.js",
+      "default": "./dist/index.esm.js"
+    }
+  },
+  "license": "MIT",
+  "prettier": "@arborjs/config-prettier",
+  "files": [
+    "./dist",
+    "./README",
+    "../../LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "esbuild": "^0.17.19",
+    "eslint": "^8.40.0",
+    "prettier": "^2.8.8",
+    "typescript": "^5.0.4",
+    "vitest": "^1.6.0"
+  },
+  "scripts": {
+    "prettier": "prettier -w . ",
+    "clean": "rm -rf dist",
+    "lint": "yarn eslint . --ext .js,.jsx,.ts,.tsx",
+    "test": "vitest run",
+    "dev": "vitest -w",
+    "build": "yarn clean && NODE_ENV=production node ../../tools/build.js && yarn tsc",
+    "build:dev": "yarn clean && NODE_ENV=development node ../../tools/build.js && yarn tsc"
+  }
+}

packages/arbor-ost/src/decorators/detached.ts

@@ -0,0 +1,7 @@
+export const ArborDetached = Symbol.for("ArborDetached")
+
+export function detached(target: unknown, prop: unknown) {
+  target[ArborDetached] = target[ArborDetached] || {}
+  const detachedProps = target[ArborDetached]
+  detachedProps[prop] = true
+}

packages/arbor-ost/src/decorators/node.ts

@@ -0,0 +1,17 @@
+export const ArborProxiable = Symbol.for("ArborProxiable")
+
+/**
+ * Make application classes eligible for being used as nodes in the Arbor state tree.
+ *
+ * @example
+ *
+ * ```ts
+ * @node
+ * class Todo {
+ *   text: string
+ * }
+ * ```
+ */
+export function node<T extends Function>(target: T, _context: unknown = null) {
+  target.prototype[ArborProxiable] = true
+}

packages/arbor-ost/src/errors.ts

@@ -0,0 +1,9 @@
+export class ArborError extends Error {}
+
+export class DetachedPathError extends ArborError {
+  constructor(humanizedPath: string) {
+    super(
+      `Path ${humanizedPath} is detached from the tree. Cannot perform mutation.`
+    )
+  }
+}

packages/arbor-ost/src/handlers/$array/index.ts

@@ -0,0 +1,32 @@
+import { OST } from "../../ost"
+import { $object } from "./../$object"
+import { PopVisitor } from "./visitors/pop"
+import { PushVisitor } from "./visitors/push"
+import { ShiftVisitor } from "./visitors/shift"
+import { SpliceVisitor } from "./visitors/splice"
+import { UnshiftVisitor } from "./visitors/unshift"
+import { ReverseVisitor } from "./visitors/reverse"
+import { CopyWithinVisitor } from "./visitors/copyWithin"
+import { FillVisitor } from "./visitors/fill"
+import { Visitors } from "../visitors"
+
+const visitors = new Visitors(
+  new PushVisitor(),
+  new PopVisitor(),
+  new ShiftVisitor(),
+  new UnshiftVisitor(),
+  new ReverseVisitor(),
+  new SpliceVisitor(),
+  new CopyWithinVisitor(),
+  new FillVisitor()
+)
+
+export class $array extends $object {
+  constructor(ost: OST) {
+    super(ost, visitors)
+  }
+
+  static accepts(value: unknown): boolean {
+    return Array.isArray(value)
+  }
+}

packages/arbor-ost/src/handlers/$array/visitors/copyWithin.ts

@@ -0,0 +1,18 @@
+import { Visitor } from "../../visitor"
+
+export class CopyWithinVisitor extends Visitor {
+  prop = "copyWithin"
+
+  visit({ ost, target, $node }) {
+    return (...args: unknown[]) => {
+      return ost.mutate($node, () => {
+        target.copyWithin(...args)
+
+        return {
+          args: args,
+          operation: "copyWithin",
+        }
+      })
+    }
+  }
+}

packages/arbor-ost/src/handlers/$array/visitors/fill.ts

@@ -0,0 +1,18 @@
+import { Visitor } from "../../visitor"
+
+export class FillVisitor extends Visitor {
+  prop = "fill"
+
+  visit({ ost, target, $node }) {
+    return (...args: unknown[]) => {
+      return ost.mutate($node, () => {
+        target.fill(...args)
+
+        return {
+          args: args,
+          operation: "fill",
+        }
+      })
+    }
+  }
+}

packages/arbor-ost/src/handlers/$array/visitors/pop.ts

@@ -0,0 +1,22 @@
+import { Visitor } from "../../visitor"
+
+export class PopVisitor extends Visitor {
+  prop = "pop"
+
+  visit({ ost, target, $node }) {
+    return () => {
+      let popped: unknown
+
+      ost.mutate($node, () => {
+        popped = target.pop()
+
+        return {
+          args: [],
+          operation: "pop",
+        }
+      })
+
+      return popped
+    }
+  }
+}

packages/arbor-ost/src/handlers/$array/visitors/push.ts

@@ -0,0 +1,23 @@
+import { Visitor } from "../../visitor"
+import { Value } from "../../../types"
+
+export class PushVisitor extends Visitor {
+  prop = "push"
+
+  visit({ ost, target, $node }) {
+    return (...items: Value[]) => {
+      let length: number
+
+      ost.mutate($node, () => {
+        length = target.push(...items)
+
+        return {
+          args: [items],
+          operation: "push",
+        }
+      })
+
+      return length
+    }
+  }
+}

packages/arbor-ost/src/handlers/$array/visitors/reverse.ts

@@ -0,0 +1,18 @@
+import { Visitor } from "../../visitor"
+
+export class ReverseVisitor extends Visitor {
+  prop = "reverse"
+
+  visit({ ost, target, $node }) {
+    return () => {
+      return ost.mutate($node, () => {
+        target.reverse()
+
+        return {
+          args: [],
+          operation: "reverse",
+        }
+      })
+    }
+  }
+}

packages/arbor-ost/src/handlers/$array/visitors/shift.ts

@@ -0,0 +1,22 @@
+import { Visitor } from "../../visitor"
+
+export class ShiftVisitor extends Visitor {
+  prop = "shift"
+
+  visit({ ost, target, $node }) {
+    return () => {
+      let removed: unknown
+
+      ost.mutate($node, () => {
+        removed = target.shift()
+
+        return {
+          args: [],
+          operation: "shift",
+        }
+      })
+
+      return removed
+    }
+  }
+}

packages/arbor-ost/src/handlers/$array/visitors/splice.ts

@@ -0,0 +1,26 @@
+import { Visitor } from "../../visitor"
+
+export class SpliceVisitor extends Visitor {
+  prop = "splice"
+
+  visit({ ost, target, $node }) {
+    return (
+      start: number,
+      deleteCount: number,
+      ...items: unknown[]
+    ): unknown[] => {
+      let deleted: unknown[]
+
+      ost.mutate($node, () => {
+        deleted = target.splice(start, deleteCount, ...items)
+
+        return {
+          args: [start, deleteCount, items],
+          operation: "splice",
+        }
+      })
+
+      return deleted
+    }
+  }
+}

packages/arbor-ost/src/handlers/$array/visitors/unshift.ts

@@ -0,0 +1,22 @@
+import { Visitor } from "../../visitor"
+
+export class UnshiftVisitor extends Visitor {
+  prop = "unshift"
+
+  visit({ ost, target, $node }) {
+    return (...args: unknown[]) => {
+      let unshifted: unknown[]
+
+      ost.mutate($node, () => {
+        unshifted = target.unshift(...args)
+
+        return {
+          args: [args],
+          operation: "unshift",
+        }
+      })
+
+      return unshifted
+    }
+  }
+}

packages/arbor-ost/src/handlers/$map/index.ts

@@ -0,0 +1,40 @@
+import { OST } from "../../ost"
+import { $object } from "./../$object"
+import { Visitors } from "../visitors"
+import { GetVisitor } from "./visitors/get"
+import { SetVisitor } from "./visitors/set"
+import { SizeVisitor } from "./visitors/size"
+import { DeleteVisitor } from "./visitors/delete"
+import { ClearVisitor } from "./visitors/clear"
+import { EntriesVisitor } from "./visitors/entries"
+import { ForEachVisitor } from "./visitors/forEach"
+import { HasVisitor } from "./visitors/has"
+import { KeysVisitor } from "./visitors/keys"
+import { ValuesVisitor } from "./visitors/values"
+import { IteratorVisitor } from "./visitors/iterator"
+import { ChildrenVisitor } from "./visitors/$children"
+
+const visitors = new Visitors(
+  new ChildrenVisitor(),
+  new GetVisitor(),
+  new SetVisitor(),
+  new SizeVisitor(),
+  new DeleteVisitor(),
+  new ClearVisitor(),
+  new EntriesVisitor(),
+  new ForEachVisitor(),
+  new HasVisitor(),
+  new KeysVisitor(),
+  new ValuesVisitor(),
+  new IteratorVisitor()
+)
+
+export class $map extends $object {
+  constructor(ost: OST) {
+    super(ost, visitors)
+  }
+
+  static accepts(value: unknown): boolean {
+    return value instanceof Map
+  }
+}