@fluidframework/legacy-dds 2.50.0-345060

package/lib/signal/sharedSignal.d.ts

@@ -0,0 +1,68 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { IChannelAttributes, IFluidDataStoreRuntime, IChannelStorageService, IChannelFactory } from "@fluidframework/datastore-definitions/internal";
+import type { ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
+import type { ISummaryTreeWithStats } from "@fluidframework/runtime-definitions/internal";
+import type { IFluidSerializer } from "@fluidframework/shared-object-base/internal";
+import { SharedObject } from "@fluidframework/shared-object-base/internal";
+import type { ISharedSignal, ISharedSignalEvents, SerializableTypeForSharedSignal } from "./interfaces.js";
+/**
+ * Represents a shared signal that allows communication between distributed clients.
+ *
+ * @internal
+ */
+export declare class SharedSignalClass<T extends SerializableTypeForSharedSignal = any> extends SharedObject<ISharedSignalEvents<T>> implements ISharedSignal<T> {
+    /**
+     * Create a new shared signal
+     *
+     * @param runtime - data store runtime the new shared signal belongs to
+     * @param id - optional name of the shared signal
+     * @returns newly create shared signal (but not attached yet)
+     */
+    static create(runtime: IFluidDataStoreRuntime, id?: string): SharedSignalClass;
+    /**
+     * Get a factory for SharedSignal to register with the data store.
+     *
+     * @returns a factory that creates and load SharedSignal
+     */
+    static getFactory(): IChannelFactory;
+    /**
+     * Constructs a new shared signal. If the object is non-local an id and service interfaces will
+     * be provided
+     * @param id - optional name of the shared signal
+     * @param runtime - data store runtime the shared signal belongs to
+     * @param attributes - represents the attributes of a channel/DDS.
+     */
+    constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes);
+    /**
+     * Method used for generating a signal.
+     */
+    notify(metadata?: T): void;
+    protected summarizeCore(_serializer: IFluidSerializer): ISummaryTreeWithStats;
+    /**
+     * Load share signal from snapshot
+     *
+     * @param _storage - the storage to get the snapshot from
+     * @returns - promise that resolved when the load is completed
+     */
+    protected loadCore(_storage: IChannelStorageService): Promise<void>;
+    protected initializeLocalCore(): void;
+    /**
+     * Callback on disconnect
+     */
+    protected onDisconnect(): void;
+    /**
+     * Process a shared signal operation
+     *
+     * @param message - the message to prepare
+     * @param local - whether the message was sent by the local client
+     * @param _localOpMetadata - For local client messages, this is the metadata that was submitted with the message.
+     * For messages from a remote client, this will be undefined.
+     */
+    protected processCore(message: ISequencedDocumentMessage, local: boolean, _localOpMetadata: unknown): void;
+    private notifyCore;
+    protected applyStashedOp(_content: unknown): void;
+}
+//# sourceMappingURL=sharedSignal.d.ts.map

package/lib/signal/sharedSignal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sharedSignal.d.ts","sourceRoot":"","sources":["../../src/signal/sharedSignal.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,KAAK,EACX,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACtB,eAAe,EACf,MAAM,gDAAgD,CAAC;AAExD,OAAO,KAAK,EACX,yBAAyB,EAEzB,MAAM,6CAA6C,CAAC;AACrD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,8CAA8C,CAAC;AAE1F,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,6CAA6C,CAAC;AACpF,OAAO,EAAE,YAAY,EAAE,MAAM,6CAA6C,CAAC;AAE3E,OAAO,KAAK,EACX,aAAa,EACb,mBAAmB,EAEnB,+BAA+B,EAC/B,MAAM,iBAAiB,CAAC;AAKzB;;;;GAIG;AACH,qBAAa,iBAAiB,CAAC,CAAC,SAAS,+BAA+B,GAAG,GAAG,CAC7E,SAAQ,YAAY,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAC3C,YAAW,aAAa,CAAC,CAAC,CAAC;IAE3B;;;;;;OAMG;WACW,MAAM,CAAC,OAAO,EAAE,sBAAsB,EAAE,EAAE,CAAC,EAAE,MAAM,GAAG,iBAAiB;IAIrF;;;;OAIG;WACW,UAAU,IAAI,eAAe;IAI3C;;;;;;OAMG;gBAEF,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,sBAAsB,EAC/B,UAAU,EAAE,kBAAkB;IAK/B;;OAEG;IACI,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,IAAI;IAgBjC,SAAS,CAAC,aAAa,CAAC,WAAW,EAAE,gBAAgB,GAAG,qBAAqB;IAqB7E;;;;;OAKG;cACa,QAAQ,CAAC,QAAQ,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;cAEtD,mBAAmB,IAAI,IAAI;IAE9C;;OAEG;IACH,SAAS,CAAC,YAAY,IAAI,IAAI;IAE9B;;;;;;;OAOG;IACH,SAAS,CAAC,WAAW,CACpB,OAAO,EAAE,yBAAyB,EAClC,KAAK,EAAE,OAAO,EACd,gBAAgB,EAAE,OAAO,GACvB,IAAI;IAiBP,OAAO,CAAC,UAAU;IAIlB,SAAS,CAAC,cAAc,CAAC,QAAQ,EAAE,OAAO,GAAG,IAAI;CAGjD"}

package/lib/signal/sharedSignal.js

@@ -0,0 +1,118 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { FileMode, MessageType, TreeEntry } from "@fluidframework/driver-definitions/internal";
+import { convertToSummaryTreeWithStats } from "@fluidframework/runtime-utils/internal";
+import { SharedObject } from "@fluidframework/shared-object-base/internal";
+import { SharedSignalFactory } from "./sharedSignalFactory.js";
+const snapshotFileName = "header";
+/**
+ * Represents a shared signal that allows communication between distributed clients.
+ *
+ * @internal
+ */
+export class SharedSignalClass extends SharedObject {
+    /**
+     * Create a new shared signal
+     *
+     * @param runtime - data store runtime the new shared signal belongs to
+     * @param id - optional name of the shared signal
+     * @returns newly create shared signal (but not attached yet)
+     */
+    static create(runtime, id) {
+        return runtime.createChannel(id, SharedSignalFactory.Type);
+    }
+    /**
+     * Get a factory for SharedSignal to register with the data store.
+     *
+     * @returns a factory that creates and load SharedSignal
+     */
+    static getFactory() {
+        return new SharedSignalFactory();
+    }
+    /**
+     * Constructs a new shared signal. If the object is non-local an id and service interfaces will
+     * be provided
+     * @param id - optional name of the shared signal
+     * @param runtime - data store runtime the shared signal belongs to
+     * @param attributes - represents the attributes of a channel/DDS.
+     */
+    constructor(id, runtime, attributes) {
+        super(id, runtime, attributes, "loop_sharedSignal_" /* telemetryContextPrefix */);
+    }
+    /**
+     * Method used for generating a signal.
+     */
+    notify(metadata) {
+        // If we are not attached, don't submit the op.
+        if (!this.isAttached()) {
+            return;
+        }
+        const op = {
+            type: "signal",
+            metadata,
+        };
+        this.notifyCore(op, true);
+        this.submitLocalMessage(op);
+    }
+    summarizeCore(_serializer) {
+        const tree = {
+            entries: [
+                {
+                    mode: FileMode.File,
+                    path: snapshotFileName,
+                    type: TreeEntry[TreeEntry.Blob],
+                    value: {
+                        contents: JSON.stringify(""),
+                        // eslint-disable-next-line unicorn/text-encoding-identifier-case
+                        encoding: "utf-8",
+                    },
+                },
+            ],
+        };
+        const summaryTreeWithStats = convertToSummaryTreeWithStats(tree);
+        return summaryTreeWithStats;
+    }
+    /**
+     * Load share signal from snapshot
+     *
+     * @param _storage - the storage to get the snapshot from
+     * @returns - promise that resolved when the load is completed
+     */
+    async loadCore(_storage) { }
+    initializeLocalCore() { }
+    /**
+     * Callback on disconnect
+     */
+    onDisconnect() { }
+    /**
+     * Process a shared signal operation
+     *
+     * @param message - the message to prepare
+     * @param local - whether the message was sent by the local client
+     * @param _localOpMetadata - For local client messages, this is the metadata that was submitted with the message.
+     * For messages from a remote client, this will be undefined.
+     */
+    processCore(message, local, _localOpMetadata) {
+        if (message.type === MessageType.Operation && !local) {
+            const op = message.contents;
+            switch (op.type) {
+                case "signal": {
+                    this.notifyCore(op, local);
+                    break;
+                }
+                default: {
+                    throw new Error("Unknown operation");
+                }
+            }
+        }
+    }
+    notifyCore(op, isLocal) {
+        this.emit("notify", op.metadata, isLocal);
+    }
+    applyStashedOp(_content) {
+        throw new Error("Not implemented");
+    }
+}
+//# sourceMappingURL=sharedSignal.js.map

package/lib/signal/sharedSignal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sharedSignal.js","sourceRoot":"","sources":["../../src/signal/sharedSignal.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAUH,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,6CAA6C,CAAC;AAM/F,OAAO,EAAE,6BAA6B,EAAE,MAAM,wCAAwC,CAAC;AAEvF,OAAO,EAAE,YAAY,EAAE,MAAM,6CAA6C,CAAC;AAQ3E,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAE/D,MAAM,gBAAgB,GAAG,QAAQ,CAAC;AAElC;;;;GAIG;AACH,MAAM,OAAO,iBACZ,SAAQ,YAAoC;IAG5C;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,OAA+B,EAAE,EAAW;QAChE,OAAO,OAAO,CAAC,aAAa,CAAC,EAAE,EAAE,mBAAmB,CAAC,IAAI,CAAsB,CAAC;IACjF,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU;QACvB,OAAO,IAAI,mBAAmB,EAAE,CAAC;IAClC,CAAC;IAED;;;;;;OAMG;IACH,YACC,EAAU,EACV,OAA+B,EAC/B,UAA8B;QAE9B,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,oBAAoB,CAAC,4BAA4B,CAAC,CAAC;IACnF,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,QAAY;QACzB,+CAA+C;QAC/C,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC;YACxB,OAAO;QACR,CAAC;QAED,MAAM,EAAE,GAAwB;YAC/B,IAAI,EAAE,QAAQ;YACd,QAAQ;SACR,CAAC;QAEF,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QAE1B,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC;IAC7B,CAAC;IAES,aAAa,CAAC,WAA6B;QACpD,MAAM,IAAI,GAAU;YACnB,OAAO,EAAE;gBACR;oBACC,IAAI,EAAE,QAAQ,CAAC,IAAI;oBACnB,IAAI,EAAE,gBAAgB;oBACtB,IAAI,EAAE,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC;oBAC/B,KAAK,EAAE;wBACN,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;wBAC5B,iEAAiE;wBACjE,QAAQ,EAAE,OAAO;qBACjB;iBACD;aACD;SACD,CAAC;QAEF,MAAM,oBAAoB,GAAG,6BAA6B,CAAC,IAAI,CAAC,CAAC;QAEjE,OAAO,oBAAoB,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACO,KAAK,CAAC,QAAQ,CAAC,QAAgC,IAAkB,CAAC;IAEzD,mBAAmB,KAAU,CAAC;IAEjD;;OAEG;IACO,YAAY,KAAU,CAAC;IAEjC;;;;;;;OAOG;IACO,WAAW,CACpB,OAAkC,EAClC,KAAc,EACd,gBAAyB;QAEzB,IAAK,OAAO,CAAC,IAAoB,KAAK,WAAW,CAAC,SAAS,IAAI,CAAC,KAAK,EAAE,CAAC;YACvE,MAAM,EAAE,GAAG,OAAO,CAAC,QAA+B,CAAC;YAEnD,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC;gBACjB,KAAK,QAAQ,CAAC,CAAC,CAAC;oBACf,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;oBAC3B,MAAM;gBACP,CAAC;gBAED,OAAO,CAAC,CAAC,CAAC;oBACT,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;gBACtC,CAAC;YACF,CAAC;QACF,CAAC;IACF,CAAC;IAEO,UAAU,CAAC,EAAuB,EAAE,OAAgB;QAC3D,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC3C,CAAC;IAES,cAAc,CAAC,QAAiB;QACzC,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACpC,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/* eslint-disable @typescript-eslint/no-explicit-any */\n\nimport type {\n\tIChannelAttributes,\n\tIFluidDataStoreRuntime,\n\tIChannelStorageService,\n\tIChannelFactory,\n} from \"@fluidframework/datastore-definitions/internal\";\nimport { FileMode, MessageType, TreeEntry } from \"@fluidframework/driver-definitions/internal\";\nimport type {\n\tISequencedDocumentMessage,\n\tITree,\n} from \"@fluidframework/driver-definitions/internal\";\nimport type { ISummaryTreeWithStats } from \"@fluidframework/runtime-definitions/internal\";\nimport { convertToSummaryTreeWithStats } from \"@fluidframework/runtime-utils/internal\";\nimport type { IFluidSerializer } from \"@fluidframework/shared-object-base/internal\";\nimport { SharedObject } from \"@fluidframework/shared-object-base/internal\";\n\nimport type {\n\tISharedSignal,\n\tISharedSignalEvents,\n\tISignalOperation,\n\tSerializableTypeForSharedSignal,\n} from \"./interfaces.js\";\nimport { SharedSignalFactory } from \"./sharedSignalFactory.js\";\n\nconst snapshotFileName = \"header\";\n\n/**\n * Represents a shared signal that allows communication between distributed clients.\n *\n * @internal\n */\nexport class SharedSignalClass<T extends SerializableTypeForSharedSignal = any>\n\textends SharedObject<ISharedSignalEvents<T>>\n\timplements ISharedSignal<T>\n{\n\t/**\n\t * Create a new shared signal\n\t *\n\t * @param runtime - data store runtime the new shared signal belongs to\n\t * @param id - optional name of the shared signal\n\t * @returns newly create shared signal (but not attached yet)\n\t */\n\tpublic static create(runtime: IFluidDataStoreRuntime, id?: string): SharedSignalClass {\n\t\treturn runtime.createChannel(id, SharedSignalFactory.Type) as SharedSignalClass;\n\t}\n\n\t/**\n\t * Get a factory for SharedSignal to register with the data store.\n\t *\n\t * @returns a factory that creates and load SharedSignal\n\t */\n\tpublic static getFactory(): IChannelFactory {\n\t\treturn new SharedSignalFactory();\n\t}\n\n\t/**\n\t * Constructs a new shared signal. If the object is non-local an id and service interfaces will\n\t * be provided\n\t * @param id - optional name of the shared signal\n\t * @param runtime - data store runtime the shared signal belongs to\n\t * @param attributes - represents the attributes of a channel/DDS.\n\t */\n\tpublic constructor(\n\t\tid: string,\n\t\truntime: IFluidDataStoreRuntime,\n\t\tattributes: IChannelAttributes,\n\t) {\n\t\tsuper(id, runtime, attributes, \"loop_sharedSignal_\" /* telemetryContextPrefix */);\n\t}\n\n\t/**\n\t * Method used for generating a signal.\n\t */\n\tpublic notify(metadata?: T): void {\n\t\t// If we are not attached, don't submit the op.\n\t\tif (!this.isAttached()) {\n\t\t\treturn;\n\t\t}\n\n\t\tconst op: ISignalOperation<T> = {\n\t\t\ttype: \"signal\",\n\t\t\tmetadata,\n\t\t};\n\n\t\tthis.notifyCore(op, true);\n\n\t\tthis.submitLocalMessage(op);\n\t}\n\n\tprotected summarizeCore(_serializer: IFluidSerializer): ISummaryTreeWithStats {\n\t\tconst tree: ITree = {\n\t\t\tentries: [\n\t\t\t\t{\n\t\t\t\t\tmode: FileMode.File,\n\t\t\t\t\tpath: snapshotFileName,\n\t\t\t\t\ttype: TreeEntry[TreeEntry.Blob],\n\t\t\t\t\tvalue: {\n\t\t\t\t\t\tcontents: JSON.stringify(\"\"),\n\t\t\t\t\t\t// eslint-disable-next-line unicorn/text-encoding-identifier-case\n\t\t\t\t\t\tencoding: \"utf-8\",\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t],\n\t\t};\n\n\t\tconst summaryTreeWithStats = convertToSummaryTreeWithStats(tree);\n\n\t\treturn summaryTreeWithStats;\n\t}\n\n\t/**\n\t * Load share signal from snapshot\n\t *\n\t * @param _storage - the storage to get the snapshot from\n\t * @returns - promise that resolved when the load is completed\n\t */\n\tprotected async loadCore(_storage: IChannelStorageService): Promise<void> {}\n\n\tprotected override initializeLocalCore(): void {}\n\n\t/**\n\t * Callback on disconnect\n\t */\n\tprotected onDisconnect(): void {}\n\n\t/**\n\t * Process a shared signal operation\n\t *\n\t * @param message - the message to prepare\n\t * @param local - whether the message was sent by the local client\n\t * @param _localOpMetadata - For local client messages, this is the metadata that was submitted with the message.\n\t * For messages from a remote client, this will be undefined.\n\t */\n\tprotected processCore(\n\t\tmessage: ISequencedDocumentMessage,\n\t\tlocal: boolean,\n\t\t_localOpMetadata: unknown,\n\t): void {\n\t\tif ((message.type as MessageType) === MessageType.Operation && !local) {\n\t\t\tconst op = message.contents as ISignalOperation<T>;\n\n\t\t\tswitch (op.type) {\n\t\t\t\tcase \"signal\": {\n\t\t\t\t\tthis.notifyCore(op, local);\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\n\t\t\t\tdefault: {\n\t\t\t\t\tthrow new Error(\"Unknown operation\");\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\tprivate notifyCore(op: ISignalOperation<T>, isLocal: boolean): void {\n\t\tthis.emit(\"notify\", op.metadata, isLocal);\n\t}\n\n\tprotected applyStashedOp(_content: unknown): void {\n\t\tthrow new Error(\"Not implemented\");\n\t}\n}\n"]}

package/lib/signal/sharedSignalFactory.d.ts

@@ -0,0 +1,24 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { IChannelAttributes, IFluidDataStoreRuntime, IChannelFactory, IChannelServices } from "@fluidframework/datastore-definitions/internal";
+import type { ISharedSignal } from "./interfaces.js";
+/**
+ * @internal
+ */
+export declare class SharedSignalFactory implements IChannelFactory<ISharedSignal> {
+    static readonly Type: string;
+    static readonly Attributes: IChannelAttributes;
+    get type(): string;
+    get attributes(): IChannelAttributes;
+    load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes): Promise<ISharedSignal>;
+    create(document: IFluidDataStoreRuntime, id: string): ISharedSignal;
+}
+/**
+ * Entrypoint for {@link ISharedSignal} creation.
+ * @legacy
+ * @alpha
+ */
+export declare const SharedSignal: import("@fluidframework/shared-object-base/internal").ISharedObjectKind<ISharedSignal<any>> & import("@fluidframework/shared-object-base/internal").SharedObjectKind<ISharedSignal<any>>;
+//# sourceMappingURL=sharedSignalFactory.d.ts.map

package/lib/signal/sharedSignalFactory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sharedSignalFactory.d.ts","sourceRoot":"","sources":["../../src/signal/sharedSignalFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EACX,kBAAkB,EAClB,sBAAsB,EACtB,eAAe,EACf,gBAAgB,EAChB,MAAM,gDAAgD,CAAC;AAKxD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAGrD;;GAEG;AACH,qBAAa,mBAAoB,YAAW,eAAe,CAAC,aAAa,CAAC;IACzE,gBAAuB,IAAI,EAAE,MAAM,CAA8C;IAEjF,gBAAuB,UAAU,EAAE,kBAAkB,CAInD;IAEF,IAAW,IAAI,IAAI,MAAM,CAExB;IAED,IAAW,UAAU,IAAI,kBAAkB,CAE1C;IAEY,IAAI,CAChB,OAAO,EAAE,sBAAsB,EAC/B,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,gBAAgB,EAC1B,UAAU,EAAE,kBAAkB,GAC5B,OAAO,CAAC,aAAa,CAAC;IAMlB,MAAM,CAAC,QAAQ,EAAE,sBAAsB,EAAE,EAAE,EAAE,MAAM,GAAG,aAAa;CAK1E;AAED;;;;GAIG;AACH,eAAO,MAAM,YAAY,0LAA6D,CAAC"}

package/lib/signal/sharedSignalFactory.js

@@ -0,0 +1,41 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { createSharedObjectKind } from "@fluidframework/shared-object-base/internal";
+import { pkgVersion } from "../packageVersion.js";
+import { SharedSignalClass } from "./sharedSignal.js";
+/**
+ * @internal
+ */
+export class SharedSignalFactory {
+    get type() {
+        return SharedSignalFactory.Type;
+    }
+    get attributes() {
+        return SharedSignalFactory.Attributes;
+    }
+    async load(runtime, id, services, attributes) {
+        const signal = new SharedSignalClass(id, runtime, attributes);
+        await signal.load(services);
+        return signal;
+    }
+    create(document, id) {
+        const signal = new SharedSignalClass(id, document, this.attributes);
+        signal.initializeLocal();
+        return signal;
+    }
+}
+SharedSignalFactory.Type = "https://graph.microsoft.com/types/signal";
+SharedSignalFactory.Attributes = {
+    type: SharedSignalFactory.Type,
+    snapshotFormatVersion: "0.1",
+    packageVersion: pkgVersion,
+};
+/**
+ * Entrypoint for {@link ISharedSignal} creation.
+ * @legacy
+ * @alpha
+ */
+export const SharedSignal = createSharedObjectKind(SharedSignalFactory);
+//# sourceMappingURL=sharedSignalFactory.js.map

package/lib/signal/sharedSignalFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sharedSignalFactory.js","sourceRoot":"","sources":["../../src/signal/sharedSignalFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAQH,OAAO,EAAE,sBAAsB,EAAE,MAAM,6CAA6C,CAAC;AAErF,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAGlD,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAEtD;;GAEG;AACH,MAAM,OAAO,mBAAmB;IAS/B,IAAW,IAAI;QACd,OAAO,mBAAmB,CAAC,IAAI,CAAC;IACjC,CAAC;IAED,IAAW,UAAU;QACpB,OAAO,mBAAmB,CAAC,UAAU,CAAC;IACvC,CAAC;IAEM,KAAK,CAAC,IAAI,CAChB,OAA+B,EAC/B,EAAU,EACV,QAA0B,EAC1B,UAA8B;QAE9B,MAAM,MAAM,GAAG,IAAI,iBAAiB,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAC9D,MAAM,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC5B,OAAO,MAAM,CAAC;IACf,CAAC;IAEM,MAAM,CAAC,QAAgC,EAAE,EAAU;QACzD,MAAM,MAAM,GAAG,IAAI,iBAAiB,CAAC,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QACpE,MAAM,CAAC,eAAe,EAAE,CAAC;QACzB,OAAO,MAAM,CAAC;IACf,CAAC;;AA/BsB,wBAAI,GAAW,0CAA0C,CAAC;AAE1D,8BAAU,GAAuB;IACvD,IAAI,EAAE,mBAAmB,CAAC,IAAI;IAC9B,qBAAqB,EAAE,KAAK;IAC5B,cAAc,EAAE,UAAU;CAC1B,CAAC;AA4BH;;;;GAIG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,sBAAsB,CAAgB,mBAAmB,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type {\n\tIChannelAttributes,\n\tIFluidDataStoreRuntime,\n\tIChannelFactory,\n\tIChannelServices,\n} from \"@fluidframework/datastore-definitions/internal\";\nimport { createSharedObjectKind } from \"@fluidframework/shared-object-base/internal\";\n\nimport { pkgVersion } from \"../packageVersion.js\";\n\nimport type { ISharedSignal } from \"./interfaces.js\";\nimport { SharedSignalClass } from \"./sharedSignal.js\";\n\n/**\n * @internal\n */\nexport class SharedSignalFactory implements IChannelFactory<ISharedSignal> {\n\tpublic static readonly Type: string = \"https://graph.microsoft.com/types/signal\";\n\n\tpublic static readonly Attributes: IChannelAttributes = {\n\t\ttype: SharedSignalFactory.Type,\n\t\tsnapshotFormatVersion: \"0.1\",\n\t\tpackageVersion: pkgVersion,\n\t};\n\n\tpublic get type(): string {\n\t\treturn SharedSignalFactory.Type;\n\t}\n\n\tpublic get attributes(): IChannelAttributes {\n\t\treturn SharedSignalFactory.Attributes;\n\t}\n\n\tpublic async load(\n\t\truntime: IFluidDataStoreRuntime,\n\t\tid: string,\n\t\tservices: IChannelServices,\n\t\tattributes: IChannelAttributes,\n\t): Promise<ISharedSignal> {\n\t\tconst signal = new SharedSignalClass(id, runtime, attributes);\n\t\tawait signal.load(services);\n\t\treturn signal;\n\t}\n\n\tpublic create(document: IFluidDataStoreRuntime, id: string): ISharedSignal {\n\t\tconst signal = new SharedSignalClass(id, document, this.attributes);\n\t\tsignal.initializeLocal();\n\t\treturn signal;\n\t}\n}\n\n/**\n * Entrypoint for {@link ISharedSignal} creation.\n * @legacy\n * @alpha\n */\nexport const SharedSignal = createSharedObjectKind<ISharedSignal>(SharedSignalFactory);\n"]}

package/lib/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.52.8"
+    }
+  ]
+}

package/package.json

@@ -0,0 +1,158 @@
+{
+  "name": "@fluidframework/legacy-dds",
+  "version": "2.50.0-345060",
+  "description": "Legacy DDSs for the Fluid Framework. These are not intended for use in new code.",
+  "homepage": "https://fluidframework.com",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/microsoft/FluidFramework.git",
+    "directory": "packages/dds/legacy-dds"
+  },
+  "license": "MIT",
+  "author": "Microsoft and contributors",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./lib/public.d.ts",
+        "default": "./lib/index.js"
+      },
+      "require": {
+        "types": "./dist/public.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
+    "./legacy": {
+      "import": {
+        "types": "./lib/legacy.d.ts",
+        "default": "./lib/index.js"
+      },
+      "require": {
+        "types": "./dist/legacy.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
+    "./internal": {
+      "import": {
+        "types": "./lib/index.d.ts",
+        "default": "./lib/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    }
+  },
+  "main": "lib/index.js",
+  "types": "lib/public.d.ts",
+  "c8": {
+    "all": true,
+    "cache-dir": "nyc/.cache",
+    "exclude": [
+      "src/test/**/*.*ts",
+      "dist/test/**/*.*js",
+      "lib/test/**/*.*js"
+    ],
+    "exclude-after-remap": false,
+    "include": [
+      "src/**/*.*ts",
+      "dist/**/*.*js",
+      "lib/**/*.*js"
+    ],
+    "report-dir": "nyc/report",
+    "reporter": [
+      "cobertura",
+      "html",
+      "text"
+    ],
+    "temp-directory": "nyc/.nyc_output"
+  },
+  "dependencies": {
+    "@fluidframework/core-interfaces": "2.50.0-345060",
+    "@fluidframework/core-utils": "2.50.0-345060",
+    "@fluidframework/datastore-definitions": "2.50.0-345060",
+    "@fluidframework/driver-definitions": "2.50.0-345060",
+    "@fluidframework/driver-utils": "2.50.0-345060",
+    "@fluidframework/runtime-definitions": "2.50.0-345060",
+    "@fluidframework/runtime-utils": "2.50.0-345060",
+    "@fluidframework/shared-object-base": "2.50.0-345060",
+    "uuid": "^9.0.0"
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "^0.17.1",
+    "@biomejs/biome": "~1.9.3",
+    "@fluid-internal/mocha-test-setup": "2.50.0-345060",
+    "@fluid-tools/build-cli": "^0.56.0",
+    "@fluidframework/build-common": "^2.0.3",
+    "@fluidframework/build-tools": "^0.56.0",
+    "@fluidframework/container-definitions": "2.50.0-345060",
+    "@fluidframework/eslint-config-fluid": "^5.7.4",
+    "@fluidframework/test-runtime-utils": "2.50.0-345060",
+    "@microsoft/api-extractor": "7.52.8",
+    "@types/jest": "29.5.3",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^18.19.0",
+    "@types/uuid": "^9.0.2",
+    "c8": "^8.0.1",
+    "concurrently": "^8.2.1",
+    "copyfiles": "^2.4.1",
+    "cross-env": "^7.0.3",
+    "eslint": "~8.55.0",
+    "mocha": "^10.8.2",
+    "mocha-multi-reporters": "^1.5.1",
+    "rimraf": "^4.4.0",
+    "typescript": "~5.4.5"
+  },
+  "typeValidation": {
+    "disabled": true,
+    "broken": {},
+    "entrypoint": "legacy"
+  },
+  "scripts": {
+    "api": "fluid-build . --task api",
+    "api-extractor:commonjs": "flub generate entrypoints --outDir ./dist",
+    "api-extractor:esnext": "flub generate entrypoints --outDir ./lib --node10TypeCompat",
+    "build": "fluid-build . --task build",
+    "build:api-reports": "concurrently \"npm:build:api-reports:*\"",
+    "build:api-reports:current": "api-extractor run --local --config api-extractor/api-extractor.current.json",
+    "build:api-reports:legacy": "api-extractor run --local --config api-extractor/api-extractor.legacy.json",
+    "build:commonjs": "fluid-build . --task commonjs",
+    "build:compile": "fluid-build . --task compile",
+    "build:docs": "api-extractor run --local",
+    "build:esnext": "tsc --project ./tsconfig.json",
+    "build:genver": "gen-version",
+    "build:test": "npm run build:test:esm && npm run build:test:cjs",
+    "build:test:cjs": "fluid-tsc commonjs --project ./src/test/tsconfig.cjs.json",
+    "build:test:esm": "tsc --project ./src/test/tsconfig.json",
+    "check:are-the-types-wrong": "attw --pack .",
+    "check:biome": "biome check .",
+    "check:exports": "concurrently \"npm:check:exports:*\"",
+    "check:exports:bundle-release-tags": "api-extractor run --config api-extractor/api-extractor-lint-bundle.json",
+    "check:exports:cjs:legacy": "api-extractor run --config api-extractor/api-extractor-lint-legacy.cjs.json",
+    "check:exports:cjs:public": "api-extractor run --config api-extractor/api-extractor-lint-public.cjs.json",
+    "check:exports:esm:legacy": "api-extractor run --config api-extractor/api-extractor-lint-legacy.esm.json",
+    "check:exports:esm:public": "api-extractor run --config api-extractor/api-extractor-lint-public.esm.json",
+    "check:format": "npm run check:biome",
+    "ci:build:api-reports": "concurrently \"npm:ci:build:api-reports:*\"",
+    "ci:build:api-reports:current": "api-extractor run --config api-extractor/api-extractor.current.json",
+    "ci:build:api-reports:legacy": "api-extractor run --config api-extractor/api-extractor.legacy.json",
+    "ci:build:docs": "api-extractor run",
+    "clean": "rimraf --glob dist lib {alpha,beta,internal,legacy}.d.ts \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp nyc",
+    "eslint": "eslint --format stylish src",
+    "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
+    "format": "npm run format:biome",
+    "format:biome": "biome check . --write",
+    "lint": "fluid-build . --task lint",
+    "lint:fix": "fluid-build . --task eslint:fix --task format",
+    "test": "npm run test:mocha",
+    "test:coverage": "c8 npm test",
+    "test:mocha": "npm run test:mocha:esm && echo skipping cjs to avoid overhead - npm run test:mocha:cjs",
+    "test:mocha:cjs": "mocha --recursive \"dist/test/**/*.spec.*js\"",
+    "test:mocha:esm": "mocha --recursive \"lib/test/**/*.spec.*js\"",
+    "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
+    "tsc": "fluid-tsc commonjs --project ./tsconfig.cjs.json && copyfiles -f ../../../common/build/build-common/src/cjs/package.json ./dist",
+    "typetests:gen": "flub generate typetests --dir . -v",
+    "typetests:prepare": "flub typetests --dir . --reset --previous --normalize"
+  }
+}

package/src/array/README.md

@@ -0,0 +1,32 @@
+# @SharedArray
+
+## SharedArray
+
+A DDS created by Loop which we now take ownership. Following README content is provided by them. Last commit in the office bohemia repo before migrating:
+b148d32c796c79a4d934de89436aed0bdbba621f
+
+The SharedArray distributed data structure can be used to store ordered sequence of values. It provides APIs to insert, delete and move a specific entry.
+
+### Creation
+
+To create a `SharedArray`, call the static create method:
+
+```typescript
+const myArray = SharedArray.create(this.runtime, id);
+```
+
+### Usage
+
+Values in `SharedArray` must only be plain JS objects or handles (e.g. to another DDS or component).
+
+In collaborative scenarios, the value is settled with a policy of _last write wins_ except for if a delete preceeds any other operation (in this case the element is considered deleted and hence no other operations for this entry is applied)
+
+The DDS also supports undo/redo of any of the aforesaid operations.
+
+#### `.move(fromIndex, toIndex)`
+
+`SharedArray` has a `move` method in addition to the normal `insert` and `delete`, which moves the value of the curent index to the destination index.
+
+### Eventing
+
+`SharedArray` is an `EventEmitter`, and will emit events when other clients make modifications.  You should register for these events and respond appropriately as the data is modified.  `valueChanged` will be emitted in response to a `insert` or `delete` or `move`.

package/src/array/index.ts

@@ -0,0 +1,28 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+export {
+	SharedArrayFactory,
+	SharedArray,
+	SharedArrayBuilder,
+} from "./sharedArrayFactory.js";
+export { SharedArrayRevertible } from "./sharedArrayRevertible.js";
+export type {
+	SerializableTypeForSharedArray,
+	ISharedArray,
+	ISharedArrayEvents,
+	ISharedArrayRevertible,
+	IRevertible,
+} from "./interfaces.js";
+export type {
+	ISharedArrayOperation,
+	IInsertOperation,
+	IDeleteOperation,
+	IMoveOperation,
+	ISharedArrayRevertibleOperation,
+	IToggleMoveOperation,
+	IToggleOperation,
+} from "./sharedArrayOperations.js";
+export { OperationType } from "./sharedArrayOperations.js";