v0.0.1

Author: c-py

.gitignore

@@ -0,0 +1,3 @@
+node_modules
+
+yarn-error.log

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 c-py
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,93 @@
+# One Way Data Binding Library .MJS
+
+## 😎 Description 🙏
+
+Maps a javascript objects to arbitrary create, update and delete functions.
+
+Can be used to sync stateful or stateless components to some other provider of data.
+
+## 🚀 Installation 😱
+
+```bash
+yarn add one-way-data-binding-library.mjs
+```
+
+## 💯 Basic Usage 👆
+
+```js
+import oneWayDataBindingLibraryJs from "one-way-data-binding-library.mjs";
+
+const bar = () => ({
+  create: (relative, absolute) => console.log("Create", relative, absolute),
+  update: (relative, absolute) => console.log("Update", relative, absolute),
+  delete: (absolute) => console.log("Delete", absolute),
+});
+
+const run = oneWayDataBindingLibraryJs({ "foo.bar": bar });
+
+// Create
+run(() => ({ foo: { bar: { hello: "world" } } }));
+
+// Update
+run((state) => {
+  state.foo.bar.hello = "moon";
+});
+
+// Delete
+run((state) => ({}));
+```
+
+## 💪 Additional Usage 😂
+
+### Multiple Paths
+
+```js
+const example = () => ({
+  create: (relative, absolute) => console.log("Create", relative, absolute),
+  update: (relative, absolute) => console.log("Update", relative, absolute),
+  delete: (absolute) => console.log("Delete", absolute),
+});
+
+const run = oneWayDataBindingLibraryJs({
+  "foo.bar": example,
+  "foo.baz": example,
+});
+
+run(() => ({
+  foo: {
+    bar: {},
+    baz: {},
+  },
+}));
+```
+
+### Wildcards
+
+```js
+const example = () => ({
+  create: (relative, absolute) => console.log("Create", relative, absolute),
+  update: (relative, absolute) => console.log("Update", relative, absolute),
+  delete: (absolute) => console.log("Delete", absolute),
+});
+
+const run = oneWayDataBindingLibraryJs({
+  "foo.*": example,
+});
+
+run(() => ({
+  foo: {
+    bar: {},
+    baz: {},
+  },
+}));
+```
+
+## 👀 Help & Documentation 🎉
+
+### Path Matching
+
+JSON Path matching utilises Object Scan: https://github.com/blackflux/object-scan
+
+### State Updates
+
+State updates are Immer patch expressions: https://github.com/immerjs/immer

one-way-data-binding-library.mjs

@@ -0,0 +1,45 @@
+import scan from "object-scan";
+import { produce } from "immer";
+
+export default (bindings) => {
+  let state = {};
+  let bound = {};
+
+  const processor = (update) => {
+    state = produce(state, update);
+
+    const nextBound = {};
+
+    scan(Object.keys(bindings), {
+      joined: true,
+      rtn: ["key", "value", "matchedBy"],
+    })(state).forEach(([key, data, matchedBy]) => {
+      matchedBy.forEach((match) => {
+        // No binding exists for this key; bind and call create method
+        if (!(key in bound)) {
+          nextBound[key] = { methods: bindings[match](), data };
+          if (nextBound[key].methods.create) {
+            nextBound[key].methods.create(data, state);
+          }
+        }
+        // Binding exists and data reference has changed; call update method
+        else if (bound[key].methods.update && data !== bound[key].data) {
+          nextBound[key] = { methods: bound[key].methods, data };
+          nextBound[key].methods.update(data, state);
+        }
+      });
+    });
+
+    Object.keys(bound).forEach((key) => {
+      if (!(key in nextBound) || nextBound[key] === undefined) {
+        bound[key].methods.delete?.();
+      }
+    });
+
+    bound = nextBound;
+
+    return processor;
+  };
+
+  return processor;
+};