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

package/src/connector/ormConnectionHandler.ts

@@ -1,300 +0,0 @@
-// 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 type { Diff as Patches, Scope } from "../types.ts";
-import { applyPatchesToDeepSignal, Patch } from "./applyPatches.ts";
-
-import { ngSession } from "./initNg.ts";
-
-import {
-    deepSignal,
-    watch as watchDeepSignal,
-    batch,
-} from "@ng-org/alien-deepsignals";
-import type {
-    DeepPatch,
-    DeepSignalPropGenFn,
-    DeepSignalSet,
-    WatchPatchEvent,
-} from "@ng-org/alien-deepsignals";
-import type { ShapeType, BaseType } from "@ng-org/shex-orm";
-
-export class OrmConnection<T extends BaseType> {
-    private static idToEntry = new Map<string, OrmConnection<any>>();
-    /**
-     * Delay in ms to wait before closing connection.\
-     * Useful when a hook unsubscribes and resubscribes in a short time interval
-     * so that no new connections need to be set up.
-     */
-    private WAIT_BEFORE_RELEASE = 500;
-
-    readonly shapeType: ShapeType<T>;
-    readonly scope: Scope;
-    readonly signalObject: DeepSignalSet<T>;
-    private refCount: number;
-    /** Identifier as a combination of shape type and scope. Prevents duplications. */
-    private identifier: string;
-    suspendDeepWatcher: boolean;
-    readyPromise: Promise<void>;
-    cancel: () => void;
-    /** Promise that resolves once initial data has been applied. */
-    resolveReady!: () => void;
-
-    // FinalizationRegistry to clean up connections when signal objects are GC'd.
-    private static cleanupSignalRegistry =
-        typeof FinalizationRegistry === "function"
-            ? new FinalizationRegistry<string>((connectionId) => {
-                  // Best-effort fallback; look up by id and clean
-                  const entry = this.idToEntry.get(connectionId);
-                  //console.log("cleaning up connection",connectionId)
-                  if (!entry) return;
-                  entry.release();
-              })
-            : null;
-
-    private constructor(shapeType: ShapeType<T>, scope: Scope) {
-
-        // @ts-expect-error
-        window.ormSignalConnections = OrmConnection.idToEntry;
-
-        this.shapeType = shapeType;
-        this.scope = scope;
-        this.refCount = 1;
-        this.cancel = () => {};
-        this.suspendDeepWatcher = false;
-        this.identifier = `${shapeType.shape}::${canonicalScope(scope)}`;
-        this.signalObject = deepSignal<Set<T>>(new Set(), {
-            propGenerator: this.signalObjectPropGenerator,
-            // Don't set syntheticIdPropertyName - let propGenerator handle all ID logic
-            readOnlyProps: ["@id", "@graph"],
-        });
-
-        // Schedule cleanup of the connection when the signal object is GC'd.
-        OrmConnection.cleanupSignalRegistry?.register(
-            this.signalObject,
-            this.identifier,
-            this.signalObject
-        );
-
-        // Add listener to deep signal object to report changes back to wasm land.
-        watchDeepSignal(this.signalObject, this.onSignalObjectUpdate);
-
-        // Initialize per-entry readiness promise that resolves in setUpConnection
-        this.readyPromise = new Promise<void>((resolve) => {
-            this.resolveReady = resolve;
-        });
-
-        ngSession.then(async ({ ng, session }) => {
-            //console.log("Creating orm connection. ng and session", ng, session);
-            try {
-                //await new Promise((resolve) => setTimeout(resolve, 4_000));
-                this.cancel = await ng.orm_start(
-                    scope.length == 0 ? "" : scope,
-                    shapeType,
-                    session.session_id,
-                    this.onBackendMessage
-                );
-            } catch (e) {
-                console.error(e);
-            }
-        });
-    }
-
-    /**
-     * Get a connection which contains the ORM and lifecycle methods.
-     * @param shapeType
-     * @param scope
-     * @param ng
-     * @returns
-     */
-    public static getConnection = <T extends BaseType>(
-        shapeType: ShapeType<T>,
-        scope: Scope
-    ): OrmConnection<T> => {
-        const scopeKey = canonicalScope(scope);
-
-        // Unique identifier for a given shape type and scope.
-        const identifier = `${shapeType.shape}::${scopeKey}`;
-
-        // If we already have an object for this shape+scope,
-        // return it and just increase the reference count.
-        // Otherwise, create new one.
-        const existingConnection = OrmConnection.idToEntry.get(identifier);
-        if (existingConnection) {
-            existingConnection.refCount += 1;
-            return existingConnection;
-        } else {
-            const newConnection = new OrmConnection(shapeType, scope);
-            OrmConnection.idToEntry.set(identifier, newConnection);
-            return newConnection;
-        }
-    };
-
-    public release = () => {
-        setTimeout(() => {
-            if (this.refCount > 0) this.refCount--;
-            if (this.refCount === 0) {
-                OrmConnection.idToEntry.delete(this.identifier);
-
-                OrmConnection.cleanupSignalRegistry?.unregister(
-                    this.signalObject
-                );
-                this.cancel();
-            }
-        }, this.WAIT_BEFORE_RELEASE);
-    };
-
-    private onSignalObjectUpdate = async ({ patches }: WatchPatchEvent<T>) => {
-        if (this.suspendDeepWatcher || !patches.length) return;
-
-        const ormPatches = deepPatchesToWasm(patches);
-
-        // Wait for session and subscription to be initialized.
-        const { ng, session } = await ngSession;
-        await this.readyPromise;
-
-        ng.orm_update(
-            this.scope.length == 0 ? "" : this.scope,
-            this.shapeType.shape,
-            ormPatches,
-            session.session_id
-        );
-    };
-
-    private onBackendMessage = (message: any) => {
-        const data = message?.V0;
-        if (data?.OrmInitial) {
-            this.handleInitialResponse(data.OrmInitial);
-        } else if (data?.OrmUpdate) {
-            this.onBackendUpdate(data.OrmUpdate);
-        } else {
-            console.warn("Received unknown ORM message from backend", message);
-        }
-    };
-
-    private handleInitialResponse = (initialData: any) => {
-        // Assign initial data to empty signal object without triggering watcher at first.
-        this.suspendDeepWatcher = true;
-        batch(() => {
-            // Note: Instead, we await for the connection to be initialized and send patches after. So no need to remove.
-            // // Do this in case the there was any (incorrect) data added before initialization.
-            // this.signalObject.clear();
-
-            // Convert arrays to sets and apply to signalObject (we only have sets but can only transport arrays).
-            for (const newItem of parseOrmInitialObject(initialData)) {
-                this.signalObject.add(newItem);
-            }
-        });
-
-        queueMicrotask(() => {
-            this.suspendDeepWatcher = false;
-            // Resolve readiness after initial data is committed and watcher armed.
-            this.resolveReady();
-        });
-    };
-    private onBackendUpdate = (patches: Patch[]) => {
-        this.suspendDeepWatcher = true;
-        applyPatchesToDeepSignal(this.signalObject, patches);
-        // Use queueMicrotask to ensure watcher is re-enabled _after_ batch completes
-        queueMicrotask(() => {
-            this.suspendDeepWatcher = false;
-        });
-    };
-
-    /** Function to create random subject IRIs for newly created nested objects. */
-    private signalObjectPropGenerator: DeepSignalPropGenFn = ({
-        path,
-        object,
-    }) => {
-        let graphIri: string | undefined = undefined;
-        let subjectIri: string | undefined = undefined;
-
-        // If no @graph is set, add the parent's graph IRI. If there is no parent, throw.
-        if (!object["@graph"] || object["@graph"] === "") {
-            if (path.length > 1) {
-                // The first part of the path is the <graphIri>|<subjectIri> composition.
-                graphIri = (path[0] as string).split("|")[0];
-            } else {
-                throw new Error(
-                    "When adding new root orm objects, you must specify the @graph"
-                );
-            }
-        } else {
-            graphIri = object["@graph"];
-        }
-
-        if (object["@id"] && object["@id"] !== "") {
-            subjectIri = object["@id"];
-        } else {
-            // Generate 33 random bytes using Web Crypto API
-            const b = new Uint8Array(33);
-            crypto.getRandomValues(b);
-
-            // Convert to base64url
-            const base64url = (bytes: Uint8Array) =>
-                btoa(String.fromCharCode(...bytes))
-                    .replace(/\+/g, "-")
-                    .replace(/\//g, "_")
-                    .replace(/=+$/, "");
-            const randomString = base64url(b);
-
-            // We use the root subject's graph as the basis.
-            // TODO: We could use the closest parent's graph instead.
-            subjectIri =
-                ((path[0] ?? graphIri) as string).substring(0, 9 + 44) +
-                ":q:" +
-                randomString;
-        }
-
-        return {
-            extraProps: { "@id": subjectIri, "@graph": graphIri },
-            syntheticId: graphIri + "|" + subjectIri,
-        };
-    };
-}
-
-/**
- * Converts DeepSignal patches to ORM Wasm-compatible patches
- * @param patches DeepSignal patches
- * @returns Patches with stringified path
- */
-export function deepPatchesToWasm(patches: DeepPatch[]): Patches {
-    return patches.flatMap((patch) => {
-        if (patch.op === "add" && patch.type === "set" && !patch.value?.length)
-            return [];
-        const path = "/" + patch.path.join("/");
-        return { ...patch, path };
-    }) as Patches;
-}
-
-const parseOrmInitialObject = (obj: any): any => {
-    // Regular arrays become sets.
-    if (Array.isArray(obj)) {
-        return new Set(obj.map(parseOrmInitialObject));
-    } else if (obj && typeof obj === "object") {
-        if ("@id" in obj) {
-            // Regular object.
-            for (const key of Object.keys(obj)) {
-                obj[key] = parseOrmInitialObject(obj[key]);
-            }
-        } else {
-            // Object does not have @id, that means it's a set of objects.
-            return new Set(Object.values(obj).map(parseOrmInitialObject));
-        }
-    }
-    return obj;
-};
-
-function canonicalScope(scope: Scope | Scope[] | undefined): string {
-    if (scope == null) return "";
-    return Array.isArray(scope)
-        ? scope.slice().sort().join(",")
-        : String(scope);
-}

package/src/frontendAdapters/react/index.ts

@@ -1,2 +0,0 @@
-import useShape from "./useShape.ts";
-export { useShape };

package/src/frontendAdapters/react/useShape.ts

@@ -1,36 +0,0 @@
-// 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 type { BaseType } from "@ng-org/shex-orm";
-import { useDeepSignal } from "@ng-org/alien-deepsignals/react";
-import type { ShapeType } from "@ng-org/shex-orm";
-import { useEffect, useRef, useState } from "react";
-import { createSignalObjectForShape } from "../../connector/createSignalObjectForShape.ts";
-import type { Scope } from "../../types.ts";
-
-const useShape = <T extends BaseType>(
-    shape: ShapeType<T>,
-    scope: Scope = ""
-) => {
-    const handleRef = useRef(createSignalObjectForShape(shape, scope));
-
-    const handle = handleRef.current;
-    const state = useDeepSignal(handle.signalObject);
-
-    useEffect(() => {
-        return () => {
-            handleRef.current.stop();
-        };
-    }, [shape, scope]);
-
-    return state;
-};
-
-export default useShape;

package/src/frontendAdapters/svelte/index.ts

@@ -1,2 +0,0 @@
-import useShape from "./useShape.svelte.ts";
-export { useShape };

package/src/frontendAdapters/svelte/useShape.svelte.ts

@@ -1,46 +0,0 @@
-// 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 { createSignalObjectForShape } from "../../connector/createSignalObjectForShape.ts";
-import type { Scope } from "../../types.ts";
-import { onDestroy } from "svelte";
-import type { BaseType, ShapeType } from "@ng-org/shex-orm";
-import {
-    useDeepSignal,
-    type UseDeepSignalResult,
-} from "@ng-org/alien-deepsignals/svelte";
-
-export type { UseDeepSignalResult } from "@ng-org/alien-deepsignals/svelte";
-
-/** Extended result including the originating root signal wrapper from shape logic. */
-export interface UseShapeRuneResult<T extends object>
-    extends UseDeepSignalResult<T> {
-    root: any;
-}
-
-/**
- * Shape-specific rune: constructs the signal object for a shape then delegates to {@link useDeepSignal}.
- */
-export function useShapeRune<T extends BaseType>(
-    shape: ShapeType<T>,
-    scope?: Scope
-): UseShapeRuneResult<Set<T>> {
-    const { signalObject: rootSignal, stop } = createSignalObjectForShape(
-        shape,
-        scope
-    );
-
-    onDestroy(stop);
-
-    const ds = useDeepSignal<Set<T>>(rootSignal as Set<T>);
-    return { root: rootSignal, ...ds } as UseShapeRuneResult<Set<T>>;
-}
-
-export default useShapeRune;

package/src/frontendAdapters/vue/index.ts

@@ -1,2 +0,0 @@
-import useShape from "./useShape.ts";
-export { useShape };

package/src/frontendAdapters/vue/useShape.ts

@@ -1,33 +0,0 @@
-// 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 { createSignalObjectForShape } from "../../connector/createSignalObjectForShape.ts";
-import type { Scope } from "../../types.ts";
-import { useDeepSignal } from "@ng-org/alien-deepsignals/vue";
-import { onBeforeUnmount } from "vue";
-import type { BaseType, ShapeType } from "@ng-org/shex-orm";
-
-export function useShape<T extends BaseType>(
-    shape: ShapeType<T>,
-    scope?: Scope
-) {
-    const handle = createSignalObjectForShape(shape, scope);
-
-    // Cleanup
-    onBeforeUnmount(() => {
-        handle.stop();
-    });
-
-    const ref = useDeepSignal(handle.signalObject);
-
-    return ref;
-}
-
-export default useShape;

package/src/index.ts

@@ -1,14 +0,0 @@
-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";
-export * from "./connector/applyPatches.ts";
-
-export {
-    initNgSignals as initNg,
-    createSignalObjectForShape,
-    svelteUseShape,
-    reactUseShape,
-    vueUseShape,
-};

package/src/types.ts

@@ -1,26 +0,0 @@
-// 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 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;
-};