@pascal-app/core 1.0.5 → 1.0.7

package/dist/runtime/patch.js

@@ -0,0 +1,165 @@
+import { nextSceneOperationState, } from '../store/use-scene.js';
+/** Structural equality of document values; a key holding `undefined` counts as absent. */
+export function sameValue(left, right) {
+    if (Object.is(left, right))
+        return true;
+    if (typeof left !== typeof right || left === null || right === null)
+        return false;
+    if (Array.isArray(left) || Array.isArray(right)) {
+        return (Array.isArray(left) &&
+            Array.isArray(right) &&
+            left.length === right.length &&
+            left.every((value, index) => sameValue(value, right[index])));
+    }
+    if (typeof left !== 'object')
+        return false;
+    const a = left;
+    const b = right;
+    const keys = new Set([...Object.keys(a), ...Object.keys(b)]);
+    for (const key of keys)
+        if (!sameValue(a[key], b[key]))
+            return false;
+    return true;
+}
+export function childIdsOf(node) {
+    return node && 'children' in node && Array.isArray(node.children)
+        ? node.children
+        : [];
+}
+/** Where `node` sits among its siblings in `doc`: its parent's children, or the roots. */
+function siblingPosition(doc, node) {
+    const parentId = node.parentId;
+    const siblings = parentId ? childIdsOf(doc.nodes[parentId]) : doc.rootNodeIds;
+    return siblings.indexOf(node.id);
+}
+export class UnexpressiblePatchError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'UnexpressiblePatchError';
+    }
+}
+/** The fields of `next` that differ from `base`, and those `next` no longer has. */
+export function fieldChanges(base, next, ignore = []) {
+    const data = {};
+    const removeFields = [];
+    for (const field of new Set([...Object.keys(base), ...Object.keys(next)])) {
+        if (ignore.includes(field) || sameValue(base[field], next[field]))
+            continue;
+        if (next[field] === undefined)
+            removeFields.push(field);
+        else
+            data[field] = next[field];
+    }
+    return { data, removeFields };
+}
+const documentParts = (doc) => ({
+    nodes: doc.nodes,
+    rootNodeIds: doc.rootNodeIds,
+    collections: doc.collections,
+    materials: doc.materials,
+    installedPlugins: doc.installedPlugins,
+});
+/**
+ * The patch that turns `base` into `next`, field by field: created nodes with the position they
+ * take among their siblings, deleted nodes as they were and where, each changed node field (and
+ * the fields removed), changed materials, collections and plugin state. A parent's `children` is
+ * written only where creates and deletes do not already account for it (a reorder). The patch is
+ * checked by applying it to `base`; one that does not land exactly on `next` (a reordering of the
+ * roots, which a patch cannot express) throws `UnexpressiblePatchError`.
+ */
+export function diffSceneDocuments(base, next) {
+    const created = new Set();
+    const nodeCreates = [];
+    const nodeDeletes = [];
+    const nodeUpdates = [];
+    for (const node of Object.values(next.nodes)) {
+        if (base.nodes[node.id])
+            continue;
+        created.add(node.id);
+        nodeCreates.push({ node, position: siblingPosition(next, node) });
+    }
+    for (const node of Object.values(base.nodes)) {
+        if (!next.nodes[node.id])
+            nodeDeletes.push({ node, position: siblingPosition(base, node) });
+    }
+    const reordered = [];
+    for (const node of Object.values(next.nodes)) {
+        const before = base.nodes[node.id];
+        if (!before || before === node)
+            continue;
+        const { data, removeFields } = fieldChanges(before, node, ['children']);
+        if (Object.keys(data).length || removeFields.length)
+            nodeUpdates.push({ id: node.id, data: data, removeFields });
+        if (!sameValue(childIdsOf(before), childIdsOf(node)))
+            reordered.push(node.id);
+    }
+    const materialChanges = [];
+    for (const id of new Set([...Object.keys(base.materials), ...Object.keys(next.materials)])) {
+        const material = next.materials[id];
+        if (!sameValue(base.materials[id], material))
+            materialChanges.push({ id: id, material: material ?? null });
+    }
+    const collectionChanges = [];
+    for (const id of new Set([...Object.keys(base.collections), ...Object.keys(next.collections)])) {
+        const collection = next.collections[id];
+        if (!sameValue(base.collections[id], collection))
+            collectionChanges.push({ id: id, collection: collection ?? null });
+    }
+    const pluginsChanged = !sameValue(base.installedPlugins, next.installedPlugins) ||
+        (base.hasExplicitPluginInstallState ?? false) !== (next.hasExplicitPluginInstallState ?? false);
+    const patch = {
+        nodeCreates,
+        nodeDeletes,
+        nodeUpdates,
+        materialChanges,
+        ...(collectionChanges.length ? { collectionChanges } : {}),
+        ...(pluginsChanged
+            ? {
+                pluginInstallState: {
+                    installedPlugins: [...next.installedPlugins],
+                    explicit: next.hasExplicitPluginInstallState ?? false,
+                },
+            }
+            : {}),
+    };
+    // A parent's children follow from the creates and deletes, unless the order itself changed.
+    if (reordered.length) {
+        const landed = nextSceneOperationState(documentParts(base), patch);
+        for (const id of reordered) {
+            const children = childIdsOf(next.nodes[id]);
+            if (landed && sameValue(childIdsOf(landed.nodes[id]), children))
+                continue;
+            const kept = children.filter((child) => !created.has(child));
+            const update = nodeUpdates.find((entry) => entry.id === id);
+            if (update)
+                update.data.children = kept;
+            else
+                nodeUpdates.push({
+                    id,
+                    data: { children: kept },
+                    removeFields: [],
+                });
+        }
+    }
+    const landed = nextSceneOperationState(documentParts(base), patch);
+    if (!landed)
+        throw new UnexpressiblePatchError('The scene change does not apply to its base.');
+    if (!sameValue(landed.rootNodeIds, next.rootNodeIds))
+        throw new UnexpressiblePatchError('A scene patch cannot reorder the scene roots.');
+    for (const id of new Set([...Object.keys(landed.nodes), ...Object.keys(next.nodes)])) {
+        const key = id;
+        if (!sameValue(landed.nodes[key], next.nodes[key]))
+            throw new UnexpressiblePatchError(`The scene patch does not reproduce node ${id}.`);
+    }
+    return patch;
+}
+/** Whether a patch changes nothing. */
+export function isEmptyScenePatch(patch) {
+    return (patch.nodeCreates.length === 0 &&
+        patch.nodeDeletes.length === 0 &&
+        patch.nodeUpdates.length === 0 &&
+        patch.materialChanges.length === 0 &&
+        !patch.collectionChanges?.length &&
+        !patch.pluginChanges?.length &&
+        !patch.pluginInstallState);
+}

package/dist/runtime/reader.d.ts

@@ -0,0 +1,104 @@
+import type { SceneNodes } from '../agent-operations/types.js';
+import type { AnyNode, Collection } from '../schema/index.js';
+import type { SceneMaterial } from '../schema/scene-material.js';
+import { type CollectionPredicate, type Dependency, type NodePredicate, type QueryDependency } from './dependencies.js';
+/** Where a reader reads: a scene store's current document. */
+export type DocumentSource = {
+    nodes(): Readonly<Record<string, AnyNode>>;
+    collections(): Readonly<Record<string, Collection>>;
+    materials(): Readonly<Record<string, SceneMaterial>>;
+    rootNodeIds(): readonly string[];
+    installedPlugins(): readonly string[];
+    /** Throws once the scene is disposed. */
+    assertActive(): void;
+};
+/**
+ * Reads a scene's document. A tracked reader records each read as a `Dependency`; values it
+ * returns (nodes, collections, the `nodes` and `collections` records) are read-only views whose
+ * field reads are recorded too. Code that only copies an entity through to a write wraps it in
+ * `untracked` first: copying is not a read.
+ */
+export interface DocumentReader {
+    /** The node, or undefined: either way its presence is recorded. */
+    get(id: string): AnyNode | undefined;
+    /** Entities matching a query; the matching ids are recorded, absent matches included. */
+    query(query: {
+        entity: 'node';
+        where?: NodePredicate;
+    }): AnyNode[];
+    query(query: {
+        entity: 'collection';
+        where?: CollectionPredicate;
+    }): Collection[];
+    query(query: {
+        entity: 'material';
+    }): SceneMaterial[];
+    query(query: {
+        entity: 'root';
+    }): AnyNode[];
+    /** A parent's children in order, recording the order: for reads whose result depends on it. */
+    orderedChildren(id: string): string[];
+    collection(id: string): Collection | undefined;
+    material(id: string): SceneMaterial | undefined;
+    installedPlugins(): readonly string[];
+    /**
+     * The nodes as a record, for operations written against `SceneNodes`. A node read through it is
+     * recorded like `get`; enumerating it records a query over every node (conservative: any
+     * created or deleted node then conflicts). Prefer `query`.
+     */
+    readonly nodes: SceneNodes;
+    /** The collections as a record, recorded like `nodes`. */
+    readonly collections: Readonly<Record<string, Collection>>;
+    /**
+     * The view of another version of the nodes record (one this scene held earlier), recorded like
+     * `nodes`; comparing two versions node by node by identity holds across views.
+     */
+    track(nodes: SceneNodes): SceneNodes;
+}
+/** Accumulates a computation's reads. */
+export declare class DependencyRecorder {
+    private readonly nodes;
+    private readonly collections;
+    private readonly materials;
+    private readonly queries;
+    private readonly orders;
+    private readonly declared;
+    private plugins;
+    node(id: string, field?: string): void;
+    collection(id: string, field?: string): void;
+    material(id: string): void;
+    installedPlugins(): void;
+    query(dependency: QueryDependency): void;
+    order(parentId: string, childIds: readonly string[]): void;
+    /** A dependency the host declares: a file or artifact it read, or a conservative scope. */
+    declare(dependency: Dependency): void;
+    dependencies(): Dependency[];
+}
+/** Selections over one version of a record, recorded by the reader that viewed it. */
+export type VersionQueries = Pick<DocumentReader, 'query' | 'orderedChildren'>;
+/**
+ * The tracked selections behind a record view, when it is one (a detached scene's): helpers that
+ * receive `SceneNodes` query through them, so they record what they select rather than everything.
+ * They read the version the view is of, not the scene's current one.
+ */
+export declare function readerOf(record: object): VersionQueries | undefined;
+/**
+ * A record to write a draft into, over `record`: a plain record is copied; a tracked view's (or a
+ * draft's) draft reads through to it entry by entry, so a draft that is only written and read by id
+ * records those ids, not a read of every entry (enumerating the draft still reads the whole view).
+ */
+export declare function draftOf<T>(record: Readonly<Record<string, T>>): Record<string, T>;
+/** The plain value behind a tracked view (copying it records nothing); other values as they are. */
+export declare function untracked<T>(value: T): T;
+/**
+ * `value` with every tracked view inside it replaced by a plain copy, recursively: what a
+ * computation hands out of its scene (a tool's result) so it outlives the scene. Copying a view
+ * reads all of it, and is recorded so.
+ */
+export declare function materialize<T>(value: T): T;
+/**
+ * A reader over `source`. With a recorder, every read is recorded; without one (the editor's own
+ * runtime) it reads the raw document.
+ */
+export declare function createDocumentReader(source: DocumentSource, recorder: DependencyRecorder | null): DocumentReader;
+//# sourceMappingURL=reader.d.ts.map

package/dist/runtime/reader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reader.d.ts","sourceRoot":"","sources":["../../src/runtime/reader.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAA;AAC3D,OAAO,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AACpD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAA;AAC7D,OAAO,EACL,KAAK,mBAAmB,EACxB,KAAK,UAAU,EAGf,KAAK,aAAa,EAClB,KAAK,eAAe,EAErB,MAAM,gBAAgB,CAAA;AAEvB,8DAA8D;AAC9D,MAAM,MAAM,cAAc,GAAG;IAC3B,KAAK,IAAI,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;IAC1C,WAAW,IAAI,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAA;IACnD,SAAS,IAAI,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,CAAA;IACpD,WAAW,IAAI,SAAS,MAAM,EAAE,CAAA;IAChC,gBAAgB,IAAI,SAAS,MAAM,EAAE,CAAA;IACrC,yCAAyC;IACzC,YAAY,IAAI,IAAI,CAAA;CACrB,CAAA;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,mEAAmE;IACnE,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAA;IACpC,yFAAyF;IACzF,KAAK,CAAC,KAAK,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,aAAa,CAAA;KAAE,GAAG,OAAO,EAAE,CAAA;IAClE,KAAK,CAAC,KAAK,EAAE;QAAE,MAAM,EAAE,YAAY,CAAC;QAAC,KAAK,CAAC,EAAE,mBAAmB,CAAA;KAAE,GAAG,UAAU,EAAE,CAAA;IACjF,KAAK,CAAC,KAAK,EAAE;QAAE,MAAM,EAAE,UAAU,CAAA;KAAE,GAAG,aAAa,EAAE,CAAA;IACrD,KAAK,CAAC,KAAK,EAAE;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,EAAE,CAAA;IAC3C,+FAA+F;IAC/F,eAAe,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACrC,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CAAA;IAC9C,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS,CAAA;IAC/C,gBAAgB,IAAI,SAAS,MAAM,EAAE,CAAA;IACrC;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAA;IAC1B,0DAA0D;IAC1D,QAAQ,CAAC,WAAW,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAA;IAC1D;;;OAGG;IACH,KAAK,CAAC,KAAK,EAAE,UAAU,GAAG,UAAU,CAAA;CACrC;AAED,yCAAyC;AACzC,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAiC;IACvD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAiC;IAC7D,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAoB;IAC9C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAqC;IAC7D,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAuC;IAC9D,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAgC;IACzD,OAAO,CAAC,OAAO,CAAQ;IAEvB,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAIrC;IAED,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAI3C;IAED,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAEzB;IAED,gBAAgB,IAAI,IAAI,CAEvB;IAED,KAAK,CAAC,UAAU,EAAE,eAAe,GAAG,IAAI,CAEvC;IAED,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,MAAM,EAAE,GAAG,IAAI,CAEzD;IAED,2FAA2F;IAC3F,OAAO,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI,CAEpC;IAED,YAAY,IAAI,UAAU,EAAE,CAsB3B;CACF;AAID,sFAAsF;AACtF,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,EAAE,OAAO,GAAG,iBAAiB,CAAC,CAAA;AAG9E;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS,CAEnE;AAKD;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAkEjF;AAED,oGAAoG;AACpG,wBAAgB,SAAS,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAExC;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAkB1C;AAyGD;;;GAGG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,cAAc,EACtB,QAAQ,EAAE,kBAAkB,GAAG,IAAI,GAClC,cAAc,CAGhB"}