@fluidframework/legacy-dds 2.50.0-345060

package/.eslintrc.cjs

@@ -0,0 +1,11 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+module.exports = {
+	extends: [require.resolve("@fluidframework/eslint-config-fluid/strict"), "prettier"],
+	parserOptions: {
+		project: ["./tsconfig.json", "./src/test/tsconfig.json"],
+	},
+};

package/.mocharc.cjs

@@ -0,0 +1,12 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+"use strict";
+
+const getFluidTestMochaConfig = require("@fluid-internal/mocha-test-setup/mocharc-common");
+
+const packageDir = __dirname;
+const config = getFluidTestMochaConfig(packageDir);
+module.exports = config;

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# @fluid-private/legacy-dds
+
+## 2.43.0
+
+Dependency updates only.
+
+## 2.42.0
+
+Dependency updates only.
+
+## 2.41.0
+
+New package.

package/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+
+MIT License
+
+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/api-extractor/api-extractor-lint-bundle.json

@@ -0,0 +1,5 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-lint.json",
+	"mainEntryPointFilePath": "<projectFolder>/lib/index.d.ts"
+}

package/api-extractor/api-extractor-lint-legacy.cjs.json

@@ -0,0 +1,5 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-lint.entrypoint.json",
+	"mainEntryPointFilePath": "<projectFolder>/dist/legacy.d.ts"
+}

package/api-extractor/api-extractor-lint-legacy.esm.json

@@ -0,0 +1,5 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-lint.entrypoint.json",
+	"mainEntryPointFilePath": "<projectFolder>/lib/legacy.d.ts"
+}

package/api-extractor/api-extractor-lint-public.cjs.json

@@ -0,0 +1,5 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-lint.entrypoint.json",
+	"mainEntryPointFilePath": "<projectFolder>/dist/public.d.ts"
+}

package/api-extractor/api-extractor-lint-public.esm.json

@@ -0,0 +1,5 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-lint.entrypoint.json",
+	"mainEntryPointFilePath": "<projectFolder>/lib/public.d.ts"
+}

package/api-extractor/api-extractor.current.json

@@ -0,0 +1,5 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-report.esm.current.json",
+	"mainEntryPointFilePath": "<projectFolder>/lib/public.d.ts"
+}

package/api-extractor/api-extractor.legacy.json

@@ -0,0 +1,4 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-report.esm.legacy.json"
+}

package/api-extractor-lint.json

@@ -0,0 +1,4 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "../../../common/build/build-common/api-extractor-lint.esm.primary.json"
+}

package/api-extractor.json

@@ -0,0 +1,4 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "../../../common/build/build-common/api-extractor-model.esm.json"
+}

package/api-report/legacy-dds.beta.api.md

@@ -0,0 +1,9 @@
+## Beta API Report File for "@fluidframework/legacy-dds"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+// (No @packageDocumentation comment for this package)
+
+```

package/api-report/legacy-dds.legacy.alpha.api.md

@@ -0,0 +1,140 @@
+## Alpha API Report File for "@fluidframework/legacy-dds"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+// @alpha @legacy (undocumented)
+export interface IDeleteOperation {
+    // (undocumented)
+    entryId: string;
+    // (undocumented)
+    type: typeof OperationType.deleteEntry;
+}
+
+// @alpha @legacy (undocumented)
+export interface IInsertOperation<T = unknown> {
+    // (undocumented)
+    entryId: string;
+    // (undocumented)
+    insertAfterEntryId?: string;
+    // (undocumented)
+    type: typeof OperationType.insertEntry;
+    // (undocumented)
+    value: T;
+}
+
+// @alpha @legacy (undocumented)
+export interface IMoveOperation {
+    // (undocumented)
+    changedToEntryId: string;
+    // (undocumented)
+    entryId: string;
+    // (undocumented)
+    insertAfterEntryId?: string;
+    // (undocumented)
+    type: typeof OperationType.moveEntry;
+}
+
+// @alpha @legacy (undocumented)
+export interface IRevertible {
+    // (undocumented)
+    dispose(): void;
+    // (undocumented)
+    revert(): void;
+}
+
+// @alpha @legacy
+export interface ISharedArray<T extends SerializableTypeForSharedArray> extends ISharedObject<ISharedArrayEvents> {
+    // (undocumented)
+    delete(index: number): void;
+    // (undocumented)
+    get(): readonly T[];
+    // (undocumented)
+    insert<TWrite>(index: number, value: Serializable<TWrite> & T): void;
+    // (undocumented)
+    insertBulkAfter<TWrite>(ref: T | undefined, values: (Serializable<TWrite> & T)[]): void;
+    // (undocumented)
+    move(oldIndex: number, newIndex: number): void;
+    // (undocumented)
+    toggle(entryId: string): void;
+    // (undocumented)
+    toggleMove(oldEntryId: string, newEntryId: string): void;
+}
+
+// @alpha @legacy
+export interface ISharedArrayEvents extends ISharedObjectEvents {
+    // @eventProperty (undocumented)
+    (event: "valueChanged", listener: (op: ISharedArrayOperation, isLocal: boolean, target: IEventThisPlaceHolder) => void): void;
+    // @eventProperty (undocumented)
+    (event: "revertible", listener: (revertible: IRevertible) => void): void;
+}
+
+// @alpha @legacy (undocumented)
+export type ISharedArrayOperation<T = unknown> = IInsertOperation<T> | IDeleteOperation | IMoveOperation | ISharedArrayRevertibleOperation;
+
+// @alpha @legacy (undocumented)
+export type ISharedArrayRevertibleOperation = IToggleOperation | IToggleMoveOperation;
+
+// @alpha @legacy (undocumented)
+export interface ISharedSignal<T extends SerializableTypeForSharedSignal = any> extends ISharedObject<ISharedSignalEvents<T>> {
+    // (undocumented)
+    notify(metadata?: T): void;
+}
+
+// @alpha @legacy (undocumented)
+export interface ISharedSignalEvents<T extends SerializableTypeForSharedSignal> extends ISharedObjectEvents {
+    // (undocumented)
+    (event: "notify", listener: (value: T, isLocal: boolean) => void): any;
+}
+
+// @alpha @legacy (undocumented)
+export interface IToggleMoveOperation {
+    // (undocumented)
+    changedToEntryId: string;
+    // (undocumented)
+    entryId: string;
+    // (undocumented)
+    type: typeof OperationType.toggleMove;
+}
+
+// @alpha @legacy (undocumented)
+export interface IToggleOperation {
+    // (undocumented)
+    entryId: string;
+    // (undocumented)
+    isDeleted: boolean;
+    // (undocumented)
+    type: typeof OperationType.toggle;
+}
+
+// @alpha @legacy (undocumented)
+export const OperationType: {
+    readonly insertEntry: 0;
+    readonly deleteEntry: 1;
+    readonly moveEntry: 2;
+    readonly toggle: 3;
+    readonly toggleMove: 4;
+};
+
+// @alpha @legacy (undocumented)
+export type OperationType = (typeof OperationType)[keyof typeof OperationType];
+
+// @alpha @legacy
+export type SerializableTypeForSharedArray = boolean | number | string | object | IFluidHandle;
+
+// @alpha @legacy
+export type SerializableTypeForSharedSignal = boolean | number | string | IFluidHandle | object;
+
+// @alpha @legacy
+export const SharedArray: ISharedObjectKind<ISharedArray<SerializableTypeForSharedArray>> & SharedObjectKind<ISharedArray<SerializableTypeForSharedArray>>;
+
+// @alpha @legacy
+export const SharedArrayBuilder: <T extends SerializableTypeForSharedArray>() => ISharedObjectKind<ISharedArray<T>> & SharedObjectKind<ISharedArray<T>>;
+
+// @alpha @legacy
+export const SharedSignal: ISharedObjectKind<ISharedSignal<any>> & SharedObjectKind<ISharedSignal<any>>;
+
+// (No @packageDocumentation comment for this package)
+
+```

package/api-report/legacy-dds.legacy.public.api.md

@@ -0,0 +1,9 @@
+## Public API Report File for "@fluidframework/legacy-dds"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+// (No @packageDocumentation comment for this package)
+
+```

package/api-report/legacy-dds.public.api.md

@@ -0,0 +1,9 @@
+## Public API Report File for "@fluidframework/legacy-dds"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+// (No @packageDocumentation comment for this package)
+
+```

package/biome.jsonc

@@ -0,0 +1,4 @@
+{
+	"$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
+	"extends": ["../../../biome.jsonc"]
+}

package/dist/array/index.d.ts

@@ -0,0 +1,10 @@
+/*!
+ * 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";
+//# sourceMappingURL=index.d.ts.map

package/dist/array/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/array/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,kBAAkB,EAClB,WAAW,EACX,kBAAkB,GAClB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,YAAY,EACX,8BAA8B,EAC9B,YAAY,EACZ,kBAAkB,EAClB,sBAAsB,EACtB,WAAW,GACX,MAAM,iBAAiB,CAAC;AACzB,YAAY,EACX,qBAAqB,EACrB,gBAAgB,EAChB,gBAAgB,EAChB,cAAc,EACd,+BAA+B,EAC/B,oBAAoB,EACpB,gBAAgB,GAChB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC"}

package/dist/array/index.js

@@ -0,0 +1,16 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OperationType = exports.SharedArrayRevertible = exports.SharedArrayBuilder = exports.SharedArray = exports.SharedArrayFactory = void 0;
+var sharedArrayFactory_js_1 = require("./sharedArrayFactory.js");
+Object.defineProperty(exports, "SharedArrayFactory", { enumerable: true, get: function () { return sharedArrayFactory_js_1.SharedArrayFactory; } });
+Object.defineProperty(exports, "SharedArray", { enumerable: true, get: function () { return sharedArrayFactory_js_1.SharedArray; } });
+Object.defineProperty(exports, "SharedArrayBuilder", { enumerable: true, get: function () { return sharedArrayFactory_js_1.SharedArrayBuilder; } });
+var sharedArrayRevertible_js_1 = require("./sharedArrayRevertible.js");
+Object.defineProperty(exports, "SharedArrayRevertible", { enumerable: true, get: function () { return sharedArrayRevertible_js_1.SharedArrayRevertible; } });
+var sharedArrayOperations_js_1 = require("./sharedArrayOperations.js");
+Object.defineProperty(exports, "OperationType", { enumerable: true, get: function () { return sharedArrayOperations_js_1.OperationType; } });
+//# sourceMappingURL=index.js.map

package/dist/array/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/array/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,iEAIiC;AAHhC,2HAAA,kBAAkB,OAAA;AAClB,oHAAA,WAAW,OAAA;AACX,2HAAA,kBAAkB,OAAA;AAEnB,uEAAmE;AAA1D,iIAAA,qBAAqB,OAAA;AAiB9B,uEAA2D;AAAlD,yHAAA,aAAa,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport {\n\tSharedArrayFactory,\n\tSharedArray,\n\tSharedArrayBuilder,\n} from \"./sharedArrayFactory.js\";\nexport { SharedArrayRevertible } from \"./sharedArrayRevertible.js\";\nexport type {\n\tSerializableTypeForSharedArray,\n\tISharedArray,\n\tISharedArrayEvents,\n\tISharedArrayRevertible,\n\tIRevertible,\n} from \"./interfaces.js\";\nexport type {\n\tISharedArrayOperation,\n\tIInsertOperation,\n\tIDeleteOperation,\n\tIMoveOperation,\n\tISharedArrayRevertibleOperation,\n\tIToggleMoveOperation,\n\tIToggleOperation,\n} from \"./sharedArrayOperations.js\";\nexport { OperationType } from \"./sharedArrayOperations.js\";\n"]}

package/dist/array/interfaces.d.ts

@@ -0,0 +1,142 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { IEventThisPlaceHolder, IFluidHandle } from "@fluidframework/core-interfaces";
+import type { Serializable } from "@fluidframework/datastore-definitions/internal";
+import type { ISharedObjectEvents, ISharedObject } from "@fluidframework/shared-object-base/internal";
+import type { ISharedArrayOperation } from "./sharedArrayOperations.js";
+/**
+ * Basic types for the SharedArray DDS
+ * It can be used as a generic constraint (`extends SerializableTypeForSharedArray`) but is
+ * *never* meant to be a concrete/real type on its own.
+ *
+ * @legacy
+ * @alpha
+ */
+export type SerializableTypeForSharedArray = boolean | number | string | object | IFluidHandle;
+/**
+ * Interface defining the events that can be emitted by the SharedArray DDS
+ * and the events that can be listened to by the SharedArray DDS
+ *
+ * @legacy
+ * @alpha
+ */
+export interface ISharedArrayEvents extends ISharedObjectEvents {
+    /**
+     *
+     * @param event - The event name.
+     * @param listener - An event listener.
+     *
+     * @eventProperty
+     */
+    (event: "valueChanged", listener: (op: ISharedArrayOperation, isLocal: boolean, target: IEventThisPlaceHolder) => void): void;
+    /**
+     *
+     * @param event - The event name.
+     * @param listener - An event listener.
+     *
+     * @eventProperty
+     */
+    (event: "revertible", listener: (revertible: IRevertible) => void): void;
+}
+/**
+ * Interface defining the SharedArray DDS
+ * It is a generic interface that can be used to create a SharedArray of any type
+ * The type of the SharedArray is defined by the type parameter T
+ *
+ * @typeParam T - The type of the SharedArray
+ *
+ * @legacy
+ * @alpha
+ */
+export interface ISharedArray<T extends SerializableTypeForSharedArray> extends ISharedObject<ISharedArrayEvents> {
+    get(): readonly T[];
+    insert<TWrite>(index: number, value: Serializable<TWrite> & T): void;
+    delete(index: number): void;
+    move(oldIndex: number, newIndex: number): void;
+    toggle(entryId: string): void;
+    toggleMove(oldEntryId: string, newEntryId: string): void;
+    insertBulkAfter<TWrite>(ref: T | undefined, values: (Serializable<TWrite> & T)[]): void;
+}
+/**
+ *
+ * @internal
+ */
+export interface ISharedArrayRevertible extends ISharedObject<ISharedArrayEvents> {
+    toggle(entryId: string): void;
+    toggleMove(oldEntryId: string, newEntryId: string): void;
+}
+/**
+ * Interface defining the in memory shared array entry of the DDS
+ *
+ * @internal
+ */
+export interface SharedArrayEntry<T extends SerializableTypeForSharedArray> extends SharedArrayEntryCore<T> {
+    /**
+     * Flag that tracks whether an ack from the server has been received for a local insert.
+     * True for local changes.
+     */
+    isAckPending: boolean;
+    /**
+     * Counter is shared by delete and undo/redo (of delete and insert) as undo/redo simply
+     * operates on the isDeleted flag of the DDS. This flag will help us skip local op acks as
+     * they have already inflicted state change. The flag helps us ignore remote ops if there is a
+     * local pending delete as we would be getting the pending op after server stamping
+     */
+    isLocalPendingDelete: number;
+    /**
+     * Counter is for move and its undo/redo. This flag will be used to skip local op acks as
+     * they have already inflicted state change. The flag helps us ignore remote ops if there is a
+     * local pending delete as we would be getting the pending op after server stamping. Only exception
+     * being if there is a remote delete, we will have to respect that
+     */
+    isLocalPendingMove: number;
+}
+/**
+ * Interface defining the core entry attributes
+ *
+ * @internal
+ */
+export interface SharedArrayEntryCore<T extends SerializableTypeForSharedArray> {
+    /**
+     * a unique ID for this particular entry
+     */
+    entryId: string;
+    /**
+     * the value stored in this entry, may not be unique
+     */
+    value: T;
+    /**
+     * Flag to track whether this entry is deleted or not.
+     */
+    isDeleted: boolean;
+    /**
+     * Primarily used for move op and tracks the old entry id from which this entry was changed from.
+     */
+    prevEntryId?: string;
+    /**
+     * Primarily used for move op and tracks the new entry id to which this entry was changed to.
+     */
+    nextEntryId?: string;
+}
+/**
+ * Format of the snapshot for the DDS
+ *
+ * @internal
+ */
+export interface SnapshotFormat<T> {
+    /**
+     * Array of the data entries that represent the DDS in-memory representation
+     */
+    dataArray: T[];
+}
+/**
+ * @legacy
+ * @alpha
+ */
+export interface IRevertible {
+    revert(): void;
+    dispose(): void;
+}
+//# sourceMappingURL=interfaces.d.ts.map

package/dist/array/interfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../../src/array/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,qBAAqB,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAC3F,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gDAAgD,CAAC;AACnF,OAAO,KAAK,EACX,mBAAmB,EACnB,aAAa,EACb,MAAM,6CAA6C,CAAC;AAErD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACxE;;;;;;;GAOG;AACH,MAAM,MAAM,8BAA8B,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,YAAY,CAAC;AAE/F;;;;;;GAMG;AACH,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;IAC9D;;;;;;OAMG;IACH,CACC,KAAK,EAAE,cAAc,EACrB,QAAQ,EAAE,CACT,EAAE,EAAE,qBAAqB,EACzB,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE,qBAAqB,KACzB,IAAI,GACP,IAAI,CAAC;IAER;;;;;;OAMG;IACH,CAAC,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC,UAAU,EAAE,WAAW,KAAK,IAAI,GAAG,IAAI,CAAC;CACzE;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,8BAA8B,CACrE,SAAQ,aAAa,CAAC,kBAAkB,CAAC;IACzC,GAAG,IAAI,SAAS,CAAC,EAAE,CAAC;IACpB,MAAM,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;IACrE,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/C,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IACzD,eAAe,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,SAAS,EAAE,MAAM,EAAE,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC;CACxF;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAuB,SAAQ,aAAa,CAAC,kBAAkB,CAAC;IAChF,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CACzD;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB,CAAC,CAAC,SAAS,8BAA8B,CACzE,SAAQ,oBAAoB,CAAC,CAAC,CAAC;IAC/B;;;OAGG;IACH,YAAY,EAAE,OAAO,CAAC;IAEtB;;;;;OAKG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;;;;OAKG;IACH,kBAAkB,EAAE,MAAM,CAAC;CAC3B;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB,CAAC,CAAC,SAAS,8BAA8B;IAC7E;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,EAAE,CAAC,CAAC;IAET;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc,CAAC,CAAC;IAChC;;OAEG;IACH,SAAS,EAAE,CAAC,EAAE,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC3B,MAAM,IAAI,IAAI,CAAC;IACf,OAAO,IAAI,IAAI,CAAC;CAChB"}

package/dist/array/interfaces.js

@@ -0,0 +1,7 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=interfaces.js.map

package/dist/array/interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../../src/array/interfaces.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IEventThisPlaceHolder, IFluidHandle } from \"@fluidframework/core-interfaces\";\nimport type { Serializable } from \"@fluidframework/datastore-definitions/internal\";\nimport type {\n\tISharedObjectEvents,\n\tISharedObject,\n} from \"@fluidframework/shared-object-base/internal\";\n\nimport type { ISharedArrayOperation } from \"./sharedArrayOperations.js\";\n/**\n * Basic types for the SharedArray DDS\n * It can be used as a generic constraint (`extends SerializableTypeForSharedArray`) but is\n * *never* meant to be a concrete/real type on its own.\n *\n * @legacy\n * @alpha\n */\nexport type SerializableTypeForSharedArray = boolean | number | string | object | IFluidHandle;\n\n/**\n * Interface defining the events that can be emitted by the SharedArray DDS\n * and the events that can be listened to by the SharedArray DDS\n *\n * @legacy\n * @alpha\n */\nexport interface ISharedArrayEvents extends ISharedObjectEvents {\n\t/**\n\t *\n\t * @param event - The event name.\n\t * @param listener - An event listener.\n\t *\n\t * @eventProperty\n\t */\n\t(\n\t\tevent: \"valueChanged\",\n\t\tlistener: (\n\t\t\top: ISharedArrayOperation,\n\t\t\tisLocal: boolean,\n\t\t\ttarget: IEventThisPlaceHolder,\n\t\t) => void,\n\t): void;\n\n\t/**\n\t *\n\t * @param event - The event name.\n\t * @param listener - An event listener.\n\t *\n\t * @eventProperty\n\t */\n\t(event: \"revertible\", listener: (revertible: IRevertible) => void): void;\n}\n\n/**\n * Interface defining the SharedArray DDS\n * It is a generic interface that can be used to create a SharedArray of any type\n * The type of the SharedArray is defined by the type parameter T\n *\n * @typeParam T - The type of the SharedArray\n *\n * @legacy\n * @alpha\n */\nexport interface ISharedArray<T extends SerializableTypeForSharedArray>\n\textends ISharedObject<ISharedArrayEvents> {\n\tget(): readonly T[];\n\tinsert<TWrite>(index: number, value: Serializable<TWrite> & T): void;\n\tdelete(index: number): void;\n\tmove(oldIndex: number, newIndex: number): void;\n\ttoggle(entryId: string): void;\n\ttoggleMove(oldEntryId: string, newEntryId: string): void;\n\tinsertBulkAfter<TWrite>(ref: T | undefined, values: (Serializable<TWrite> & T)[]): void;\n}\n\n/**\n *\n * @internal\n */\nexport interface ISharedArrayRevertible extends ISharedObject<ISharedArrayEvents> {\n\ttoggle(entryId: string): void;\n\ttoggleMove(oldEntryId: string, newEntryId: string): void;\n}\n\n/**\n * Interface defining the in memory shared array entry of the DDS\n *\n * @internal\n */\nexport interface SharedArrayEntry<T extends SerializableTypeForSharedArray>\n\textends SharedArrayEntryCore<T> {\n\t/**\n\t * Flag that tracks whether an ack from the server has been received for a local insert.\n\t * True for local changes.\n\t */\n\tisAckPending: boolean;\n\n\t/**\n\t * Counter is shared by delete and undo/redo (of delete and insert) as undo/redo simply\n\t * operates on the isDeleted flag of the DDS. This flag will help us skip local op acks as\n\t * they have already inflicted state change. The flag helps us ignore remote ops if there is a\n\t * local pending delete as we would be getting the pending op after server stamping\n\t */\n\tisLocalPendingDelete: number;\n\n\t/**\n\t * Counter is for move and its undo/redo. This flag will be used to skip local op acks as\n\t * they have already inflicted state change. The flag helps us ignore remote ops if there is a\n\t * local pending delete as we would be getting the pending op after server stamping. Only exception\n\t * being if there is a remote delete, we will have to respect that\n\t */\n\tisLocalPendingMove: number;\n}\n\n/**\n * Interface defining the core entry attributes\n *\n * @internal\n */\nexport interface SharedArrayEntryCore<T extends SerializableTypeForSharedArray> {\n\t/**\n\t * a unique ID for this particular entry\n\t */\n\tentryId: string;\n\n\t/**\n\t * the value stored in this entry, may not be unique\n\t */\n\tvalue: T;\n\n\t/**\n\t * Flag to track whether this entry is deleted or not.\n\t */\n\tisDeleted: boolean;\n\n\t/**\n\t * Primarily used for move op and tracks the old entry id from which this entry was changed from.\n\t */\n\tprevEntryId?: string;\n\n\t/**\n\t * Primarily used for move op and tracks the new entry id to which this entry was changed to.\n\t */\n\tnextEntryId?: string;\n}\n\n/**\n * Format of the snapshot for the DDS\n *\n * @internal\n */\nexport interface SnapshotFormat<T> {\n\t/**\n\t * Array of the data entries that represent the DDS in-memory representation\n\t */\n\tdataArray: T[];\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface IRevertible {\n\trevert(): void;\n\tdispose(): void;\n}\n"]}