@ng-org/orm 0.1.2-alpha.13 → 0.1.2-alpha.15

package/README.md

@@ -22,19 +22,17 @@ Note that we support discrete (**JSON**) CRDT and graph (**RDF**) CRDT ORMs.
 
 ## Table of Contents
 
-- [Reference documentation](#reference-documentation)
-- [Why?](#why)
 - [Installation](#installation)
 - [Start](#start)
 - [RDF (graph) ORM: Defining Schemas](#rdf-graph-orm-defining-schemas)
 - [Frontend Framework Usage](#frontend-framework-usage)
 - [Working with Data](#working-with-data)
-  - [Creating a Document](#creating-a-document)
-  - [Using and Modifying ORM Objects](#using-and-modifying-orm-objects)
-  - [The (Discrete)OrmSubscription Class](#the-discreteormsubscription-class)
-  - [Transactions](#transactions)
-    - [The DeepSignal\<\> type](#the-deepsignal-type)
-    - [Graph ORM: Relationships](#graph-orm-relationships)
+    - [Creating a Document](#creating-a-document)
+    - [Using and Modifying ORM Objects](#using-and-modifying-orm-objects)
+    - [The (Discrete)OrmSubscription Class](#the-discreteormsubscription-class)
+    - [Transactions](#transactions)
+        - [The DeepSignal\<\> type](#the-deepsignal-type)
+        - [Graph ORM: Relationships](#graph-orm-relationships)
 
 ---
 
@@ -56,12 +54,14 @@ pnpm add -D @ng-org/shex-orm
 
 Before writing your own app, you are strongly advised to look at the example apps below, where you can find framework and crdt-specific walkthroughs.
 
-- Discrete CRDTs [all frameworks running in the same window with Astro](https://git.nextgraph.org/NextGraph/expense-tracker-discrete)
+- Discrete CRDTs
+    - [all frameworks running in the same window with Astro](https://git.nextgraph.org/NextGraph/expense-tracker-discrete)
     - [Svelte 5](https://git.nextgraph.org/NextGraph/expense-tracker-discrete-svelte)
     - [Svelte 4](https://git.nextgraph.org/NextGraph/expense-tracker-discrete-svelte4) (no support for Svelte 3)
     - [Vue](https://git.nextgraph.org/NextGraph/expense-tracker-discrete-vue)
     - [React](https://git.nextgraph.org/NextGraph/expense-tracker-discrete-react)
-- RDF CRDTs for [all frameworks running in the same window with Astro](https://git.nextgraph.org/NextGraph/expense-tracker-graph)
+- RDF CRDT
+    - [all frameworks running in the same window with Astro](https://git.nextgraph.org/NextGraph/expense-tracker-graph)
     - [Svelte 5](https://git.nextgraph.org/NextGraph/expense-tracker-graph-svelte)
     - [Svelte 4](https://git.nextgraph.org/NextGraph/expense-tracker-graph-svelte4) (no support for Svelte 3)
     - [Vue](https://git.nextgraph.org/NextGraph/expense-tracker-graph-vue)
@@ -129,7 +129,7 @@ The SDK offers hooks for discrete and graph-based CRDTs for Svelte, Vue and Reac
     - Svelte 4: [useDiscrete](#svelte4usediscrete)
     - Vue: [useDiscrete](#vueusediscrete)
     - React: [useDiscrete](#reactusediscrete)
-- graph CRDTs for:
+- graph CRDT for:
     - Svelte 5: [useShape](#svelteuseshape)
     - Svelte 4: [useShape](#svelte4useshape)
     - Vue: [useShape](#vueuseshape)
@@ -216,7 +216,7 @@ There are multiple ways to get and modify data:
 You can establish subscriptions outside of frontend components using the (Discrete)OrmSubscription class. DiscreteOrmSubscriptions are scoped to one document, (RDF-based) OrmSubscriptions can have a `Scope` of more than one document and require a shape type. Once a subscription is established, its `.readyPromise` resolves and the `.signalObject` contains the 2-way bound data.
 
 You can create a new subscription using `(Discrete)OrmSubscription.getOrCreate()`. If a subscription with the same document or scope exists already, a reference to that object is returned. Otherwise, a new one is created.
-The pooling is especially useful when more than one frontend component subscribes to the same data and scope by calling `useShape()` or `useDiscrete()`. This reduces load and the data is available instantly.
+This pooling is especially useful when more than one frontend component subscribes to the same data and scope by calling `useShape()` or `useDiscrete()`. This reduces load and the data is available instantly.
 
 Subscriptions are open until `.close()` is called on all references of this object. The `useShape` and `useDiscrete` hooks call `.close()` on their reference when their component unmounts.
 
@@ -242,7 +242,7 @@ const dogSet: DeepSignal<Set<Dog>> = dogSubscription.signalObject;
 dogs.add({
     // Required: The document NURI. May be set to `""` for nested objects (will be inherited from parent object then).
     "@graph": docNuri,
-    "@type": "did:ng:x:Dog", // Required: RDF type
+    "@type": "did:ng:z:Dog", // Required: RDF type
     "@id": "", // Empty string = auto-generate subject IRI
     name: "Mr Puppy",
     age: 2,

package/dist/frontendAdapters/react/useShape.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useShape.d.ts","sourceRoot":"","sources":["../../../src/frontendAdapters/react/useShape.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAEjD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAElD,OAAO,EAAkB,KAAK,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAE5D,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAG1D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiEG;AACH,QAAA,MAAM,QAAQ,GAAI,CAAC,SAAS,QAAQ,EAChC,OAAO,SAAS,CAAC,CAAC,CAAC,EACnB,OAAO,KAAK,GAAG,MAAM,GAAG,SAAS,KAgCjB,aAAa,CAAC,CAAC,CAClC,CAAC;AAEF,eAAe,QAAQ,CAAC"}
+{"version":3,"file":"useShape.d.ts","sourceRoot":"","sources":["../../../src/frontendAdapters/react/useShape.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAEjD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAElD,OAAO,EAAkB,KAAK,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAE5D,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAG1D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiEG;AACH,QAAA,MAAM,QAAQ,GAAI,CAAC,SAAS,QAAQ,EAChC,OAAO,SAAS,CAAC,CAAC,CAAC,EACnB,OAAO,KAAK,GAAG,MAAM,GAAG,SAAS,KAmCjB,aAAa,CAAC,CAAC,CAClC,CAAC;AAEF,eAAe,QAAQ,CAAC"}

package/dist/frontendAdapters/react/useShape.js

@@ -79,7 +79,7 @@ import { readOnlySet } from "../utils.js";
  * ```
  */
 const useShape = (shape, scope) => {
-    const parsedScope = !scope ? undefined : normalizeScope(scope);
+    const parsedScope = useMemo(() => (!scope ? undefined : normalizeScope(scope)), [scope, scope?.graphs, scope?.subjects]);
     const prevOrmSubscription = useRef(undefined);
     const ormSubscription = useMemo(() => {
         if (parsedScope === undefined)
@@ -89,7 +89,7 @@ const useShape = (shape, scope) => {
         const newOrmSubscription = OrmSubscription.getOrCreate(shape, parsedScope);
         prevOrmSubscription.current = newOrmSubscription;
         return newOrmSubscription;
-    }, [shape, scope, parsedScope?.graphs, parsedScope?.subjects]);
+    }, [shape, parsedScope, parsedScope?.graphs, parsedScope?.subjects]);
     useEffect(() => {
         if (!ormSubscription)
             return;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ng-org/orm",
-  "version": "0.1.2-alpha.13",
+  "version": "0.1.2-alpha.15",
   "private": false,
   "type": "module",
   "authors": [
@@ -54,7 +54,7 @@
     }
   },
   "dependencies": {
-    "@ng-org/alien-deepsignals": "0.1.2-alpha.10"
+    "@ng-org/alien-deepsignals": "0.1.2-alpha.11"
   },
   "devDependencies": {
     "@types/react": "^19.1.10",
@@ -67,7 +67,7 @@
     "svelte": "^5.39.12",
     "vue": "^3.5.19",
     "@ng-org/shex-orm": "0.1.2-alpha.7",
-    "@ng-org/web": "0.1.2-alpha.10"
+    "@ng-org/web": "0.1.2-alpha.11"
   },
   "files": [
     "dist"