@ng-org/orm 0.1.2-alpha.1 → 0.1.2-alpha.10

package/dist/frontendAdapters/vue/index.js

@@ -1,2 +1,3 @@
 import useShape from "./useShape.js";
-export { useShape };
+import { useDiscrete } from "./useDiscrete.js";
+export { useShape, useDiscrete };

package/dist/frontendAdapters/vue/useDiscrete.d.ts

@@ -0,0 +1,99 @@
+import { MaybeRefOrGetter, ToRefs } from "vue";
+import { DiscreteRoot } from "../../types.ts";
+/**
+ * Hook to subscribe to an existing discrete (JSON) CRDT document.
+ * You can modify the returned object like any other JSON object. Changes are immediately
+ * reflected in the CRDT document.
+ *
+ * Establishes a 2-way binding: Modifications to the object are immediately committed,
+ * changes coming from the engine (or other components) cause an immediate rerender.
+ *
+ * In comparison to `useShape`, discrete CRDTs are untyped.
+ * You can put any JSON data inside and need to validate the schema yourself.
+ *
+ * @param documentId The NURI of the CRDT document or `undefined` as MaybeRefOrGetter.
+ * @returns An object that contains as `data` the reactive DeepSignal object or undefined if not loaded yet or `documentId` is undefined.
+ *
+ *@example
+ * ```html
+ * <script lang="ts">
+ * // We assume you have created a CRDT document already, as below.
+ * // const documentId = await ng.doc_create(
+ * //     session_id,
+ * //     crdt, // "Automerge" | "YMap" | "YArray"
+ * //     crdt === "Automerge" ? "data:json" : crdt === "YMap ? "data:map" : "data:array",
+ * //     "store",
+ * //     undefined
+ * // );
+ * const { doc } = useDiscrete(documentId);
+ *
+ * // If document is new, we need to set up the basic structure.
+ * effect(() => {
+ *     if (doc.value && !doc.value.expenses) {
+ *         doc.value.expenses = [];
+ *     }
+ * })
+ *
+ * const createExpense = () => {
+ *     // Note that we use *expense["@id"]* as a key in the expense list.
+ *     // Every object added to a CRDT array gets a stable `@id` property assigned
+ *     // which you can use for referencing objects in arrays even as
+ *     // objects are removed or added from the array.
+ *     // The `@id` is an NURI with the schema `<documentId>:d:<object-specific id>`.
+ *     // Since the `@id` is generated in the engine, the object is
+ *     // *preliminarily given a mock id* which will be replaced immediately.
+ *     doc.value.expenses.push({
+ *         title: "New expense",
+ *         date: new Date().toISOString(),
+ *     });
+ * };
+ * </script>
+ *
+ * <template>
+ *     <div v-if="!doc">
+ *         Loading...
+ *     </div>
+ *     <div v-else>
+ *         <p v-if="expenses.length === 0">
+ *             No expenses yet.
+ *         </p>
+ *         <template v-else>
+ *             <button
+ *                 @click={() => createExpense()}
+ *             >
+ *                 + Add expense
+ *             </button>
+ *             <ExpenseCard
+ *                 v-for="expense in expenses"
+ *                 :key="expense['@id']"
+ *                 :expense="expense"
+ *             />
+ *         </template>
+ *     </div>
+ * </template>
+ * ```
+ *
+ * In the `ExpenseCard` component:
+ * ```html
+ * <script lang="ts">
+ * const { expense } = defineProps<{
+ *     expense: DeepSignal<Expense>;
+ * }>();
+ *
+ * // If you modify expense in the component,
+ * // the changes are immediately propagated to other consuming components
+ * // And persisted in the database.
+ * </script>
+ *
+ * <template>
+ *     <input
+ *         v-model="expense.title"
+ *         placeholder="Expense title"
+ *     />
+ * </template>
+ * ```
+ */
+export declare function useDiscrete<T extends DiscreteRoot = DiscreteRoot>(documentId: MaybeRefOrGetter<string | undefined>): ToRefs<{
+    doc: T;
+}>;
+//# sourceMappingURL=useDiscrete.d.ts.map

package/dist/frontendAdapters/vue/useDiscrete.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useDiscrete.d.ts","sourceRoot":"","sources":["../../../src/frontendAdapters/vue/useDiscrete.ts"],"names":[],"mappings":"AAUA,OAAO,EAEH,gBAAgB,EAGhB,MAAM,EAIT,MAAM,KAAK,CAAC;AAGb,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4FG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,YAAY,GAAG,YAAY,EAC7D,UAAU,EAAE,gBAAgB,CAAC,MAAM,GAAG,SAAS,CAAC,GAoB1B,MAAM,CAAC;IAAE,GAAG,EAAE,CAAC,CAAA;CAAE,CAAC,CAC3C"}

package/dist/frontendAdapters/vue/useDiscrete.js

@@ -0,0 +1,123 @@
+// Copyright (c) 2026 Laurin Weger, Par le Peuple, NextGraph.org developers
+// All rights reserved.
+// Licensed under the Apache License, Version 2.0
+// <LICENSE-APACHE2 or http://www.apache.org/licenses/LICENSE-2.0>
+// or the MIT license <LICENSE-MIT or http://opensource.org/licenses/MIT>,
+// at your option. All files in the project carrying such
+// notice may not be copied, modified, or distributed except
+// according to those terms.
+// SPDX-License-Identifier: Apache-2.0 OR MIT
+import { computed, onBeforeUnmount, shallowReactive, toRefs, toValue, watchEffect, } from "vue";
+import { useDeepSignal } from "@ng-org/alien-deepsignals/vue";
+import { DiscreteOrmSubscription } from "../../connector/discrete/discreteOrmSubscriptionHandler.js";
+/**
+ * Hook to subscribe to an existing discrete (JSON) CRDT document.
+ * You can modify the returned object like any other JSON object. Changes are immediately
+ * reflected in the CRDT document.
+ *
+ * Establishes a 2-way binding: Modifications to the object are immediately committed,
+ * changes coming from the engine (or other components) cause an immediate rerender.
+ *
+ * In comparison to `useShape`, discrete CRDTs are untyped.
+ * You can put any JSON data inside and need to validate the schema yourself.
+ *
+ * @param documentId The NURI of the CRDT document or `undefined` as MaybeRefOrGetter.
+ * @returns An object that contains as `data` the reactive DeepSignal object or undefined if not loaded yet or `documentId` is undefined.
+ *
+ *@example
+ * ```html
+ * <script lang="ts">
+ * // We assume you have created a CRDT document already, as below.
+ * // const documentId = await ng.doc_create(
+ * //     session_id,
+ * //     crdt, // "Automerge" | "YMap" | "YArray"
+ * //     crdt === "Automerge" ? "data:json" : crdt === "YMap ? "data:map" : "data:array",
+ * //     "store",
+ * //     undefined
+ * // );
+ * const { doc } = useDiscrete(documentId);
+ *
+ * // If document is new, we need to set up the basic structure.
+ * effect(() => {
+ *     if (doc.value && !doc.value.expenses) {
+ *         doc.value.expenses = [];
+ *     }
+ * })
+ *
+ * const createExpense = () => {
+ *     // Note that we use *expense["@id"]* as a key in the expense list.
+ *     // Every object added to a CRDT array gets a stable `@id` property assigned
+ *     // which you can use for referencing objects in arrays even as
+ *     // objects are removed or added from the array.
+ *     // The `@id` is an NURI with the schema `<documentId>:d:<object-specific id>`.
+ *     // Since the `@id` is generated in the engine, the object is
+ *     // *preliminarily given a mock id* which will be replaced immediately.
+ *     doc.value.expenses.push({
+ *         title: "New expense",
+ *         date: new Date().toISOString(),
+ *     });
+ * };
+ * </script>
+ *
+ * <template>
+ *     <div v-if="!doc">
+ *         Loading...
+ *     </div>
+ *     <div v-else>
+ *         <p v-if="expenses.length === 0">
+ *             No expenses yet.
+ *         </p>
+ *         <template v-else>
+ *             <button
+ *                 @click={() => createExpense()}
+ *             >
+ *                 + Add expense
+ *             </button>
+ *             <ExpenseCard
+ *                 v-for="expense in expenses"
+ *                 :key="expense['@id']"
+ *                 :expense="expense"
+ *             />
+ *         </template>
+ *     </div>
+ * </template>
+ * ```
+ *
+ * In the `ExpenseCard` component:
+ * ```html
+ * <script lang="ts">
+ * const { expense } = defineProps<{
+ *     expense: DeepSignal<Expense>;
+ * }>();
+ *
+ * // If you modify expense in the component,
+ * // the changes are immediately propagated to other consuming components
+ * // And persisted in the database.
+ * </script>
+ *
+ * <template>
+ *     <input
+ *         v-model="expense.title"
+ *         placeholder="Expense title"
+ *     />
+ * </template>
+ * ```
+ */
+export function useDiscrete(documentId) {
+    const ormSubscription = computed(() => {
+        const id = toValue(documentId);
+        return id ? DiscreteOrmSubscription.getOrCreate(id) : undefined;
+    });
+    const ret = shallowReactive({
+        doc: undefined,
+    });
+    watchEffect(() => {
+        ormSubscription.value?.readyPromise.then(() => {
+            ret.doc = useDeepSignal(ormSubscription.value.signalObject);
+        });
+    });
+    onBeforeUnmount(() => {
+        ormSubscription.value?.close();
+    });
+    return toRefs(ret);
+}

package/dist/frontendAdapters/vue/useShape.d.ts

@@ -1,5 +1,76 @@
-import type { Scope } from "../../types.ts";
+import { type Scope } from "../../types.ts";
 import type { BaseType, ShapeType } from "@ng-org/shex-orm";
-export declare function useShape<T extends BaseType>(shape: ShapeType<T>, scope?: Scope): import("@ng-org/alien-deepsignals").DeepSignalSet<T>;
+import { DeepSignalSet } from "@ng-org/alien-deepsignals";
+/**
+ * Hook to subscribe to RDF data in the graph database using a shape, see {@link ShapeType}.
+ * The returned objects are as easy to use as other TypeScript objects.
+ *
+ * Returns a {@link DeepSignalSet} of objects matching the shape and that are within the scope.
+ * Establishes a 2-way binding: Modifications to the object are immediately committed,
+ * changes coming from the backend (or other components) cause an immediate rerender.
+ *
+ * @param shape The {@link ShapeType} the objects should have (generated by the shex-orm tool).
+ * @param scope The {@link Scope} as graph string or scope object with graphs and subjects.
+ * @returns A {@link DeepSignalSet} with the orm objects or an empty set, if still loading.\
+ *          If the scope is explicitly set to `undefined`, an empty set is returned which errors
+ *          if you try to make modifications on it.
+ *
+ * @example
+ * ```html
+ * <script lang="ts">
+ * // Contains all expense objects with `@id` <s1 IRI> or <s2 IRI> and `@graph` <g1 NURI> or <g2 NURI>
+ * const expenses: DeepSignal<Set<Expense>> = useShape(ExpenseShapeType,
+ *      {graphs: ["<g1 NURI>", "<g2 NURI>"],
+ *       subjects: ["<s1 IRI>", "<s2 IRI>"]});
+ *
+ *
+ * const expensesSorted = computed(() => [...expenses].sort((a, b) =>
+ *     a.dateOfPurchase.localeCompare(b.dateOfPurchase)
+ * ));
+ *
+ * // Simply call expenses.add({"@graph": "<g1 or g2 NURI>", "@id": "", title: "Example title"}), to add new elements.
+ * // Leave `@id` an empty string to auto-generate a subject NURI (adjust your scope accordingly).
+ *
+ * // Note that if you use `@id` (the subject IRI) as key, you need to ensure that it is unique within your scope.
+ * // If it is not (i.e. there are two graphs with the same subject), use the combination of `@graph` and `@id`.
+ * </script>
+ *
+ * <template>
+ *     <div>
+ *         <p v-if="expensesSorted.length === 0">
+ *             No expenses yet.
+ *         </p>
+ *         <template v-else>
+ *             <ExpenseCard
+ *                 v-for="expense in expensesSorted"
+ *                 :key="expense['@id'])"
+ *                 :expense="expense"
+ *             />
+ *         </template>
+ *     </div>
+ * </template>
+ * ```
+ *
+ * In the `ExpenseCard` component:
+ * ```html
+ * <script lang="ts">
+ * const { expense } = defineProps<{
+ *     expense: DeepSignal<Expense>;
+ * }>();
+ *
+ * // If you modify expense in the component,
+ * // the changes are immediately propagated to other consuming components.
+ * // And persisted in the database.
+ * </script>
+ *
+ * <template>
+ *     <input
+ *         v-model="expense.title"
+ *         placeholder="Expense title"
+ *     />
+ * </template>
+ * ```
+ */
+export declare function useShape<T extends BaseType>(shape: ShapeType<T>, scope: Scope | string | undefined): DeepSignalSet<T>;
 export default useShape;
 //# sourceMappingURL=useShape.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"useShape.d.ts","sourceRoot":"","sources":["../../../src/frontendAdapters/vue/useShape.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAG5C,OAAO,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAE5D,wBAAgB,QAAQ,CAAC,CAAC,SAAS,QAAQ,EACvC,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,EACnB,KAAK,CAAC,EAAE,KAAK,wDAYhB;AAED,eAAe,QAAQ,CAAC"}
+{"version":3,"file":"useShape.d.ts","sourceRoot":"","sources":["../../../src/frontendAdapters/vue/useShape.ts"],"names":[],"mappings":"AAUA,OAAO,EAAkB,KAAK,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAG5D,OAAO,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAE5D,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAG1D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqEG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,QAAQ,EACvC,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,EACnB,KAAK,EAAE,KAAK,GAAG,MAAM,GAAG,SAAS,oBAmBpC;AAED,eAAe,QAAQ,CAAC"}

package/dist/frontendAdapters/vue/useShape.js

@@ -7,16 +7,91 @@
 // notice may not be copied, modified, or distributed except
 // according to those terms.
 // SPDX-License-Identifier: Apache-2.0 OR MIT
-import { createSignalObjectForShape } from "../../connector/createSignalObjectForShape.js";
+import { normalizeScope } from "../../types.js";
 import { useDeepSignal } from "@ng-org/alien-deepsignals/vue";
 import { onBeforeUnmount } from "vue";
+import { OrmSubscription } from "../../connector/ormSubscriptionHandler.js";
+import { readOnlySet } from "../utils.js";
+/**
+ * Hook to subscribe to RDF data in the graph database using a shape, see {@link ShapeType}.
+ * The returned objects are as easy to use as other TypeScript objects.
+ *
+ * Returns a {@link DeepSignalSet} of objects matching the shape and that are within the scope.
+ * Establishes a 2-way binding: Modifications to the object are immediately committed,
+ * changes coming from the backend (or other components) cause an immediate rerender.
+ *
+ * @param shape The {@link ShapeType} the objects should have (generated by the shex-orm tool).
+ * @param scope The {@link Scope} as graph string or scope object with graphs and subjects.
+ * @returns A {@link DeepSignalSet} with the orm objects or an empty set, if still loading.\
+ *          If the scope is explicitly set to `undefined`, an empty set is returned which errors
+ *          if you try to make modifications on it.
+ *
+ * @example
+ * ```html
+ * <script lang="ts">
+ * // Contains all expense objects with `@id` <s1 IRI> or <s2 IRI> and `@graph` <g1 NURI> or <g2 NURI>
+ * const expenses: DeepSignal<Set<Expense>> = useShape(ExpenseShapeType,
+ *      {graphs: ["<g1 NURI>", "<g2 NURI>"],
+ *       subjects: ["<s1 IRI>", "<s2 IRI>"]});
+ *
+ *
+ * const expensesSorted = computed(() => [...expenses].sort((a, b) =>
+ *     a.dateOfPurchase.localeCompare(b.dateOfPurchase)
+ * ));
+ *
+ * // Simply call expenses.add({"@graph": "<g1 or g2 NURI>", "@id": "", title: "Example title"}), to add new elements.
+ * // Leave `@id` an empty string to auto-generate a subject NURI (adjust your scope accordingly).
+ *
+ * // Note that if you use `@id` (the subject IRI) as key, you need to ensure that it is unique within your scope.
+ * // If it is not (i.e. there are two graphs with the same subject), use the combination of `@graph` and `@id`.
+ * </script>
+ *
+ * <template>
+ *     <div>
+ *         <p v-if="expensesSorted.length === 0">
+ *             No expenses yet.
+ *         </p>
+ *         <template v-else>
+ *             <ExpenseCard
+ *                 v-for="expense in expensesSorted"
+ *                 :key="expense['@id'])"
+ *                 :expense="expense"
+ *             />
+ *         </template>
+ *     </div>
+ * </template>
+ * ```
+ *
+ * In the `ExpenseCard` component:
+ * ```html
+ * <script lang="ts">
+ * const { expense } = defineProps<{
+ *     expense: DeepSignal<Expense>;
+ * }>();
+ *
+ * // If you modify expense in the component,
+ * // the changes are immediately propagated to other consuming components.
+ * // And persisted in the database.
+ * </script>
+ *
+ * <template>
+ *     <input
+ *         v-model="expense.title"
+ *         placeholder="Expense title"
+ *     />
+ * </template>
+ * ```
+ */
 export function useShape(shape, scope) {
-    const handle = createSignalObjectForShape(shape, scope);
+    if (scope === undefined) {
+        return useDeepSignal(readOnlySet);
+    }
+    const connection = OrmSubscription.getOrCreate(shape, normalizeScope(scope));
     // Cleanup
     onBeforeUnmount(() => {
-        handle.stop();
+        connection.close();
     });
-    const ref = useDeepSignal(handle.signalObject);
+    const ref = useDeepSignal(connection.signalObject);
     return ref;
 }
 export default useShape;

package/dist/index.d.ts

@@ -1,8 +1,15 @@
-import { createSignalObjectForShape } from "./connector/createSignalObjectForShape.ts";
-import { useShape as svelteUseShape } from "./frontendAdapters/svelte/index.ts";
-import { useShape as reactUseShape } from "./frontendAdapters/react/index.ts";
-import { useShape as vueUseShape } from "./frontendAdapters/vue/useShape.ts";
-import { initNgSignals } from "./connector/initNg.ts";
+import { OrmSubscription } from "./connector/ormSubscriptionHandler.ts";
+import { DiscreteOrmSubscription } from "./connector/discrete/discreteOrmSubscriptionHandler.ts";
+import { useShape as svelteUseShape, useDiscrete as svelteUseDiscrete } from "./frontendAdapters/svelte/index.ts";
+import { useShape as svelte4UseShape, useDiscrete as svelte4UseDiscrete } from "./frontendAdapters/svelte4/index.ts";
+import { useShape as reactUseShape, useDiscrete as reactUseDiscrete } from "./frontendAdapters/react/index.ts";
+import { useShape as vueUseShape, useDiscrete as vueUseDiscrete } from "./frontendAdapters/vue/index.ts";
+import { initNgSignals, ngSession } from "./connector/initNg.ts";
+import { insertObject } from "./connector/insertObject.ts";
+import { getObjects } from "./connector/getObjects.ts";
 export * from "./connector/applyPatches.ts";
-export { initNgSignals as initNg, createSignalObjectForShape, svelteUseShape, reactUseShape, vueUseShape, };
+export * from "./types.ts";
+export type { DeepSignal, DeepSignalObject, DeepSignalSet, } from "@ng-org/alien-deepsignals";
+export { getRaw, watch, effect } from "@ng-org/alien-deepsignals";
+export { initNgSignals as initNg, ngSession, OrmSubscription as OrmSubscription, DiscreteOrmSubscription, svelteUseShape, svelteUseDiscrete, svelte4UseShape, svelte4UseDiscrete, reactUseShape, reactUseDiscrete, vueUseShape, vueUseDiscrete, insertObject, getObjects, };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,2CAA2C,CAAC;AACvF,OAAO,EAAE,QAAQ,IAAI,cAAc,EAAE,MAAM,oCAAoC,CAAC;AAChF,OAAO,EAAE,QAAQ,IAAI,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAC9E,OAAO,EAAE,QAAQ,IAAI,WAAW,EAAE,MAAM,oCAAoC,CAAC;AAC7E,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,cAAc,6BAA6B,CAAC;AAE5C,OAAO,EACH,aAAa,IAAI,MAAM,EACvB,0BAA0B,EAC1B,cAAc,EACd,aAAa,EACb,WAAW,GACd,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AACxE,OAAO,EAAE,uBAAuB,EAAE,MAAM,wDAAwD,CAAC;AACjG,OAAO,EACH,QAAQ,IAAI,cAAc,EAC1B,WAAW,IAAI,iBAAiB,EACnC,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EACH,QAAQ,IAAI,eAAe,EAC3B,WAAW,IAAI,kBAAkB,EACpC,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EACH,QAAQ,IAAI,aAAa,EACzB,WAAW,IAAI,gBAAgB,EAClC,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EACH,QAAQ,IAAI,WAAW,EACvB,WAAW,IAAI,cAAc,EAChC,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACvD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,YAAY,CAAC;AAE3B,YAAY,EACR,UAAU,EACV,gBAAgB,EAChB,aAAa,GAChB,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAC;AAElE,OAAO,EACH,aAAa,IAAI,MAAM,EACvB,SAAS,EACT,eAAe,IAAI,eAAe,EAClC,uBAAuB,EACvB,cAAc,EACd,iBAAiB,EACjB,eAAe,EACf,kBAAkB,EAClB,aAAa,EACb,gBAAgB,EAChB,WAAW,EACX,cAAc,EACd,YAAY,EACZ,UAAU,GACb,CAAC"}

package/dist/index.js

@@ -1,7 +1,22 @@
-import { createSignalObjectForShape } from "./connector/createSignalObjectForShape.js";
-import { useShape as svelteUseShape } from "./frontendAdapters/svelte/index.js";
-import { useShape as reactUseShape } from "./frontendAdapters/react/index.js";
-import { useShape as vueUseShape } from "./frontendAdapters/vue/useShape.js";
-import { initNgSignals } from "./connector/initNg.js";
+// Copyright (c) 2025 Laurin Weger, Par le Peuple, NextGraph.org developers
+// All rights reserved.
+// Licensed under the Apache License, Version 2.0
+// <LICENSE-APACHE2 or http://www.apache.org/licenses/LICENSE-2.0>
+// or the MIT license <LICENSE-MIT or http://opensource.org/licenses/MIT>,
+// at your option. All files in the project carrying such
+// notice may not be copied, modified, or distributed except
+// according to those terms.
+// SPDX-License-Identifier: Apache-2.0 OR MIT
+import { OrmSubscription } from "./connector/ormSubscriptionHandler.js";
+import { DiscreteOrmSubscription } from "./connector/discrete/discreteOrmSubscriptionHandler.js";
+import { useShape as svelteUseShape, useDiscrete as svelteUseDiscrete, } from "./frontendAdapters/svelte/index.js";
+import { useShape as svelte4UseShape, useDiscrete as svelte4UseDiscrete, } from "./frontendAdapters/svelte4/index.js";
+import { useShape as reactUseShape, useDiscrete as reactUseDiscrete, } from "./frontendAdapters/react/index.js";
+import { useShape as vueUseShape, useDiscrete as vueUseDiscrete, } from "./frontendAdapters/vue/index.js";
+import { initNgSignals, ngSession } from "./connector/initNg.js";
+import { insertObject } from "./connector/insertObject.js";
+import { getObjects } from "./connector/getObjects.js";
 export * from "./connector/applyPatches.js";
-export { initNgSignals as initNg, createSignalObjectForShape, svelteUseShape, reactUseShape, vueUseShape, };
+export * from "./types.js";
+export { getRaw, watch, effect } from "@ng-org/alien-deepsignals";
+export { initNgSignals as initNg, ngSession, OrmSubscription as OrmSubscription, DiscreteOrmSubscription, svelteUseShape, svelteUseDiscrete, svelte4UseShape, svelte4UseDiscrete, reactUseShape, reactUseDiscrete, vueUseShape, vueUseDiscrete, insertObject, getObjects, };

package/dist/types.d.ts

@@ -1,13 +1,65 @@
-import type { Patch } from "./connector/applyPatches.ts";
-/** The shape of an object requested. */
-export type Shape = "Shape1" | "Shape2" | "TestShape";
-/** The Scope of a shape request */
-export type Scope = string;
-/** The diff format used to communicate updates between wasm-land and js-land. */
-export type Diff = Patch[];
-/** A connection established between wasm-land and js-land for subscription of a shape. */
-export type Connection = {
-    id: string;
-    onUpdateFromWasm: (diff: Diff) => void;
+/**
+ * When dealing with shapes (RDF-based graph database ORMs):
+ * The scope of a shape request.
+ * In most cases, it is recommended to use a narrow scope for performance.
+ * You can filter results by `subjects` and `graphs`. Only objects in that scope will be returned.
+ *
+ * @example
+ * ```typescript
+ * // Contains all expense objects with `@id` <s1 IRI> or <s2 IRI> and `@graph` <g1 NURI> or <g2 NURI>
+ * const expenses: DeepSignal<Set<Expense>> = useShape(ExpenseShape,
+ *      {graphs: ["<graph1 NURI>", "<graph2 NURI>"],
+ *       subjects: ["<subject1 IRI>", "<subject2 IRI>"]});
+ * ```
+ */
+export type Scope = {
+    /**
+     * The graphs to filter for. If more than one NURI is provided, the union of all graphs is considered.
+     *
+     * - Set value to `["did:ng:i"]` or `[""]` for whole dataset.
+     * - Setting value to `[]` or leaving it `undefined`, no objects are returned.
+     */
+    graphs?: string[];
+    /**
+     * Subjects to filter for. Set to `[]` or leave it `undefined` for no filtering.
+     */
+    subjects?: string[];
 };
+/**
+ * Converts undefined to [] and for graphs "" to "did:ng:i". If scope is string, it means {graphs: [\<scope string>], subjects: []}.
+ * @ignore
+ */
+export declare const normalizeScope: (scope?: Scope | string | undefined) => {
+    graphs: string[];
+    subjects: string[];
+};
+/** An allowed array in the CRDT. */
+export interface DiscreteArray extends Array<DiscreteType> {
+}
+/** An allowed object in the CRDT. */
+export interface DiscreteObject {
+    [key: string]: DiscreteType;
+}
+/** An allowed type in the CRDT. */
+export type DiscreteType = DiscreteArray | DiscreteObject | string | number | boolean;
+/**
+ * The root array for reading and modifying the CRDT as a plain object.
+ */
+export type DiscreteRootArray = (DiscreteArray | string | number | boolean | (DiscreteObject & {
+    readonly "@id": string;
+}))[];
+/**
+ * The root object for reading and modifying the CRDT as a plain object.
+ */
+export interface DiscreteRootObject {
+    [key: string]: DiscreteObject | string | number | boolean | DiscreteRootArray;
+}
+/** A discrete document's root object, either an array or an object. */
+export type DiscreteRoot = DiscreteRootArray | DiscreteRootObject;
+/**
+ * The supported discrete (JSON) CRDTs.
+ * Automerge and YMap require objects as roots.
+ * YArray requires an array as root.
+ */
+export type DiscreteCrdt = "YMap" | "YArray" | "Automerge";
 //# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AAEzD,wCAAwC;AACxC,MAAM,MAAM,KAAK,GAAG,QAAQ,GAAG,QAAQ,GAAG,WAAW,CAAC;AAEtD,mCAAmC;AACnC,MAAM,MAAM,KAAK,GAAG,MAAM,CAAC;AAE3B,iFAAiF;AACjF,MAAM,MAAM,IAAI,GAAG,KAAK,EAAE,CAAC;AAE3B,0FAA0F;AAC1F,MAAM,MAAM,UAAU,GAAG;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,gBAAgB,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,IAAI,CAAC;CAC1C,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAUA;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,KAAK,GAAG;IAChB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACvB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,cAAc,GAAI,QAAO,KAAK,GAAG,MAAM,GAAG,SAAc;;;CASpE,CAAC;AAEF,oCAAoC;AACpC,MAAM,WAAW,aAAc,SAAQ,KAAK,CAAC,YAAY,CAAC;CAAG;AAE7D,qCAAqC;AACrC,MAAM,WAAW,cAAc;IAC3B,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,CAAC;CAC/B;AACD,mCAAmC;AACnC,MAAM,MAAM,YAAY,GAClB,aAAa,GACb,cAAc,GACd,MAAM,GACN,MAAM,GACN,OAAO,CAAC;AAEd;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAC1B,aAAa,GACb,MAAM,GACN,MAAM,GACN,OAAO,GACP,CAAC,cAAc,GAAG;IAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC,CAClD,EAAE,CAAC;AAEJ;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAC/B,CAAC,GAAG,EAAE,MAAM,GACN,cAAc,GACd,MAAM,GACN,MAAM,GACN,OAAO,GACP,iBAAiB,CAAC;CAC3B;AAED,uEAAuE;AACvE,MAAM,MAAM,YAAY,GAAG,iBAAiB,GAAG,kBAAkB,CAAC;AAElE;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,QAAQ,GAAG,WAAW,CAAC"}

package/dist/types.js

@@ -7,4 +7,16 @@
 // notice may not be copied, modified, or distributed except
 // according to those terms.
 // SPDX-License-Identifier: Apache-2.0 OR MIT
-export {};
+/**
+ * Converts undefined to [] and for graphs "" to "did:ng:i". If scope is string, it means {graphs: [\<scope string>], subjects: []}.
+ * @ignore
+ */
+export const normalizeScope = (scope = {}) => {
+    if (typeof scope === "string") {
+        return { graphs: [scope], subjects: [] };
+    }
+    // Convert "" to did:ng:i
+    const graphs = (scope.graphs ?? []).map((g) => (g === "" ? "did:ng:i" : g));
+    const subjects = scope.subjects ?? [];
+    return { graphs, subjects };
+};