@mml-io/networked-dom-document 0.0.0-experimental-d240bbd-20230807

package/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2023 Improbable MV Limited
+
+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.

package/build/EditableNetworkedDOM.d.ts

@@ -0,0 +1,18 @@
+import { LogMessage } from "@mml-io/observable-dom-common";
+import { ObservableDOMFactory } from "./NetworkedDOM";
+export declare class EditableNetworkedDOM {
+    private htmlPath;
+    private params;
+    private websockets;
+    private loadedState;
+    private observableDOMFactory;
+    private ignoreTextNodes;
+    private logCallback?;
+    constructor(htmlPath: string, observableDOMFactory: ObservableDOMFactory, ignoreTextNodes?: boolean, logCallback?: (message: LogMessage) => void);
+    isLoaded(): boolean;
+    load(htmlContents: string, params?: object): void;
+    reload(): void;
+    dispose(): void;
+    addWebSocket(webSocket: WebSocket): void;
+    removeWebSocket(webSocket: WebSocket): void;
+}

package/build/NetworkedDOM.d.ts

@@ -0,0 +1,51 @@
+import { ClientMessage, PongMessage } from "@mml-io/networked-dom-protocol";
+import { LogMessage, ObservableDOMInterface, ObservableDOMMessage, ObservableDOMParameters, StaticVirtualDOMElement } from "@mml-io/observable-dom-common";
+import { VirtualDOMDiffStruct } from "./common";
+export declare const networkedDOMProtocolSubProtocol_v0_1 = "networked-dom-v0.1";
+export declare const defaultWebsocketSubProtocol = "networked-dom-v0.1";
+export type ObservableDOMFactory = (observableDOMParameters: ObservableDOMParameters, callback: (message: ObservableDOMMessage, observableDOM: ObservableDOMInterface) => void) => ObservableDOMInterface;
+export declare class NetworkedDOM {
+    static SupportedWebsocketSubProtocolsPreferenceOrder: string[];
+    private internalNodeIdToClientNodeId;
+    private clientNodeIdToInternalNodeId;
+    private currentConnectionId;
+    private connectionIdToWebSocketContext;
+    private webSocketToConnectionId;
+    private visibleNodeIdsByConnectionId;
+    private initialLoad;
+    private readonly htmlPath;
+    private disposed;
+    private ignoreTextNodes;
+    private documentRoot;
+    private nodeIdToNode;
+    private nodeIdToParentNodeId;
+    private observableDOM;
+    private documentEffectiveStartTime;
+    private latestDocumentTime;
+    private pingCounter;
+    private maximumNodeId;
+    private logCallback?;
+    constructor(observableDOMFactory: ObservableDOMFactory, htmlPath: string, htmlContents: string, oldInstanceDocumentRoot: StaticVirtualDOMElement | null, onLoad: (domDiff: VirtualDOMDiffStruct | null, networkedDOM: NetworkedDOM) => void, params?: {}, ignoreTextNodes?: boolean, logCallback?: (message: LogMessage) => void);
+    private defaultLogCallback;
+    private addRemappedNodeId;
+    private sendPings;
+    private getInitialSnapshot;
+    getDocumentTime(): number;
+    addExistingWebsockets(websockets: Array<WebSocket>, existingWebsocketMap: Map<WebSocket, number> | null, domDiff: VirtualDOMDiffStruct | null): void;
+    private findParentNodeOfNodeId;
+    private registerWebsocket;
+    static handleWebsocketSubprotocol(protocols: Set<string> | Array<string>): string | false;
+    addWebSocket(webSocket: WebSocket): void;
+    removeWebSocket(webSocket: WebSocket): void;
+    dispose(): void;
+    private processModification;
+    private removeKnownNodesInMutation;
+    private removeVirtualDOMElement;
+    static IsPongMessage(message: ClientMessage): message is PongMessage;
+    private dispatchRemoteEvent;
+    private getStaticVirtualDOMElementByInternalNodeIdOrThrow;
+    private addKnownNodesInMutation;
+    getSnapshot(): StaticVirtualDOMElement;
+    private addAndRemapNodeFromInstance;
+    getWebsocketConnectionIdMap(): Map<WebSocket, number>;
+}

package/build/common.d.ts

@@ -0,0 +1,19 @@
+import { StaticVirtualDOMElement } from "@mml-io/observable-dom-common";
+import * as rfc6902 from "rfc6902";
+export type NodeMapping = {
+    clientFacingNodeId: number;
+    internalNodeId: number;
+};
+export type VirtualDOMDiffStruct = {
+    originalState: StaticVirtualDOMElement;
+    nodeIdRemappings: Array<NodeMapping>;
+    virtualDOMDiffs: Array<rfc6902.Operation>;
+};
+export type StaticVirtualDOMMutationRecord = {
+    type: "attributes" | "characterData" | "childList" | "snapshot";
+    target: StaticVirtualDOMElement;
+    addedNodes: Array<StaticVirtualDOMElement>;
+    removedNodes: Array<StaticVirtualDOMElement>;
+    previousSibling: StaticVirtualDOMElement | null;
+    attributeName: string | null;
+};

package/build/diffing.d.ts

@@ -0,0 +1,11 @@
+import { Diff, NodeDescription } from "@mml-io/networked-dom-protocol";
+import { StaticVirtualDOMElement } from "@mml-io/observable-dom-common";
+import * as rfc6902 from "rfc6902";
+import { StaticVirtualDOMMutationRecord, VirtualDOMDiffStruct } from "./common";
+export declare const visibleToAttrName = "visible-to";
+export declare const hiddenFromAttrName = "hidden-from";
+export declare function diffFromApplicationOfStaticVirtualDOMMutationRecordToConnection(mutation: StaticVirtualDOMMutationRecord, parentNode: StaticVirtualDOMElement | null, connectionId: number, visibleNodesForConnection: Set<number>): Diff | null;
+export declare function describeNodeWithChildrenForConnectionId(virtualDOMElement: StaticVirtualDOMElement, connectionId: number, visibleNodesForConnection: Set<number>): NodeDescription | null;
+export declare function findParentNodeOfNodeId(virtualDOMElement: StaticVirtualDOMElement, targetNodeId: number): StaticVirtualDOMElement | null;
+export declare function virtualDOMDiffToVirtualDOMMutationRecord(virtualStructure: StaticVirtualDOMElement, domDiff: rfc6902.Operation): Array<StaticVirtualDOMMutationRecord>;
+export declare function calculateStaticVirtualDOMDiff(originalState: StaticVirtualDOMElement, latestState: StaticVirtualDOMElement): VirtualDOMDiffStruct;

package/build/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./NetworkedDOM";
+export * from "./EditableNetworkedDOM";