@fluid-experimental/sequence-deprecated 2.0.0-dev.2.2.0.111723

package/src/packageVersion.ts

@@ -0,0 +1,9 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ *
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
+ */
+
+export const pkgName = "@fluid-experimental/sequence-deprecated";
+export const pkgVersion = "2.0.0-dev.2.2.0.111723";

package/src/sequenceFactory.ts

@@ -0,0 +1,181 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import {
+    IChannelAttributes,
+    IFluidDataStoreRuntime,
+    IChannelServices,
+    IChannelFactory,
+} from "@fluidframework/datastore-definitions";
+import {
+    IJSONSegment,
+} from "@fluidframework/merge-tree";
+import { ISharedObject } from "@fluidframework/shared-object-base";
+import { IJSONRunSegment, SubSequence } from "@fluidframework/sequence";
+import { pkgVersion } from "./packageVersion";
+import { SharedNumberSequence } from "./sharedNumberSequence";
+import { SharedObjectSequence } from "./sharedObjectSequence";
+
+/**
+ * @deprecated SharedObjectSequence is not recommended for use and will be removed in an upcoming release.
+ * For more info, please see [Github issue 8526](https://github.com/microsoft/FluidFramework/issues/8526)
+ */
+export class SharedObjectSequenceFactory implements IChannelFactory {
+    /**
+     * @deprecated SharedObjectSequence is not recommended for use and will be removed in an upcoming release.
+     * For more info, please see [Github issue 8526](https://github.com/microsoft/FluidFramework/issues/8526)
+     */
+    public static Type = "https://graph.microsoft.com/types/mergeTree/object-sequence";
+
+    /**
+     * @deprecated SharedObjectSequence is not recommended for use and will be removed in an upcoming release.
+     * For more info, please see [Github issue 8526](https://github.com/microsoft/FluidFramework/issues/8526)
+     */
+    public static readonly Attributes: IChannelAttributes = {
+        type: SharedObjectSequenceFactory.Type,
+        snapshotFormatVersion: "0.1",
+        packageVersion: pkgVersion,
+    };
+
+    /**
+     * @deprecated SharedObjectSequence is not recommended for use and will be removed in an upcoming release.
+     * For more info, please see [Github issue 8526](https://github.com/microsoft/FluidFramework/issues/8526)
+     */
+    public static segmentFromSpec(segSpec: IJSONSegment): SubSequence<object> {
+        const runSegment = segSpec as IJSONRunSegment<object>;
+        if (runSegment.items) {
+            const seg = new SubSequence<object>(runSegment.items);
+            if (runSegment.props) {
+                seg.addProperties(runSegment.props);
+            }
+            return seg;
+        }
+
+        throw new Error(`Unrecognized IJSONObject`);
+    }
+
+    /**
+     * @deprecated SharedObjectSequence is not recommended for use and will be removed in an upcoming release.
+     * For more info, please see [Github issue 8526](https://github.com/microsoft/FluidFramework/issues/8526)
+     */
+    public get type() {
+        return SharedObjectSequenceFactory.Type;
+    }
+
+    /**
+     * @deprecated SharedObjectSequence is not recommended for use and will be removed in an upcoming release.
+     * For more info, please see [Github issue 8526](https://github.com/microsoft/FluidFramework/issues/8526)
+     */
+    public get attributes() {
+        return SharedObjectSequenceFactory.Attributes;
+    }
+
+    /**
+     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}
+     *
+     * @deprecated SharedObjectSequence is not recommended for use and will be removed in an upcoming release.
+     * For more info, please see [Github issue 8526](https://github.com/microsoft/FluidFramework/issues/8526)
+     */
+    public async load(
+        runtime: IFluidDataStoreRuntime,
+        id: string,
+        services: IChannelServices,
+        attributes: IChannelAttributes): Promise<ISharedObject> {
+        const sharedSeq = new SharedObjectSequence<object>(runtime, id, attributes);
+        await sharedSeq.load(services);
+        return sharedSeq;
+    }
+
+    /**
+     * @deprecated SharedObjectSequence is not recommended for use and will be removed in an upcoming release.
+     * For more info, please see [Github issue 8526](https://github.com/microsoft/FluidFramework/issues/8526)
+     */
+    public create(document: IFluidDataStoreRuntime, id: string): ISharedObject {
+        const sharedString = new SharedObjectSequence(document, id, this.attributes);
+        sharedString.initializeLocal();
+        return sharedString;
+    }
+}
+
+/**
+ * @deprecated SharedNumberSequence is not recommended for use and will be removed in an upcoming release.
+ * For more info, please see [Github issue 8526](https://github.com/microsoft/FluidFramework/issues/8526)
+ */
+export class SharedNumberSequenceFactory implements IChannelFactory {
+    /**
+     * @deprecated SharedNumberSequence is not recommended for use and will be removed in an upcoming release.
+     * For more info, please see [Github issue 8526](https://github.com/microsoft/FluidFramework/issues/8526)
+     */
+    public static Type = "https://graph.microsoft.com/types/mergeTree/number-sequence";
+
+    /**
+     * @deprecated SharedNumberSequence is not recommended for use and will be removed in an upcoming release.
+     * For more info, please see [Github issue 8526](https://github.com/microsoft/FluidFramework/issues/8526)
+     */
+    public static readonly Attributes: IChannelAttributes = {
+        type: SharedNumberSequenceFactory.Type,
+        snapshotFormatVersion: "0.1",
+        packageVersion: pkgVersion,
+    };
+
+    /**
+     * @deprecated SharedNumberSequence is not recommended for use and will be removed in an upcoming release.
+     * For more info, please see [Github issue 8526](https://github.com/microsoft/FluidFramework/issues/8526)
+     */
+    public static segmentFromSpec(segSpec: IJSONSegment): SubSequence<number> {
+        const runSegment = segSpec as IJSONRunSegment<number>;
+        if (runSegment.items) {
+            const seg = new SubSequence<number>(runSegment.items);
+            if (runSegment.props) {
+                seg.addProperties(runSegment.props);
+            }
+            return seg;
+        }
+
+        throw new Error(`Unrecognized IJSONObject`);
+    }
+
+    /**
+     * @deprecated SharedNumberSequence is not recommended for use and will be removed in an upcoming release.
+     * For more info, please see [Github issue 8526](https://github.com/microsoft/FluidFramework/issues/8526)
+     */
+    public get type() {
+        return SharedNumberSequenceFactory.Type;
+    }
+
+    /**
+     * @deprecated SharedNumberSequence is not recommended for use and will be removed in an upcoming release.
+     * For more info, please see [Github issue 8526](https://github.com/microsoft/FluidFramework/issues/8526)
+     */
+    public get attributes() {
+        return SharedNumberSequenceFactory.Attributes;
+    }
+
+    /**
+     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}
+     *
+     * @deprecated SharedNumberSequence is not recommended for use and will be removed in an upcoming release.
+     * For more info, please see [Github issue 8526](https://github.com/microsoft/FluidFramework/issues/8526)
+     */
+    public async load(
+        runtime: IFluidDataStoreRuntime,
+        id: string,
+        services: IChannelServices,
+        attributes: IChannelAttributes): Promise<ISharedObject> {
+        const sharedSeq = new SharedNumberSequence(runtime, id, attributes);
+        await sharedSeq.load(services);
+        return sharedSeq;
+    }
+
+    /**
+     * @deprecated SharedNumberSequence is not recommended for use and will be removed in an upcoming release.
+     * For more info, please see [Github issue 8526](https://github.com/microsoft/FluidFramework/issues/8526)
+     */
+    public create(document: IFluidDataStoreRuntime, id: string): ISharedObject {
+        const sharedString = new SharedNumberSequence(document, id, this.attributes);
+        sharedString.initializeLocal();
+        return sharedString;
+    }
+}

package/src/sharedNumberSequence.ts

@@ -0,0 +1,68 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { IFluidDataStoreRuntime, IChannelAttributes } from "@fluidframework/datastore-definitions";
+import { SharedSequence } from "@fluidframework/sequence";
+import { SharedNumberSequenceFactory } from "./sequenceFactory";
+
+/**
+ * The SharedNumberSequence holds a sequence of numbers. Each number will be stored
+ * at a position within the sequence. See the
+ * {@link https://fluidframework.com/docs/data-structures/sequences/ | sequence documentation}
+ * for details on working with sequences.
+ *
+ * @deprecated SharedNumberSequence is not recommended for use and will be removed in an upcoming release.
+ * For more info, please see [Github issue 8526](https://github.com/microsoft/FluidFramework/issues/8526)
+ */
+export class SharedNumberSequence extends SharedSequence<number> {
+    /**
+     * Create a new shared number sequence
+     *
+     * @param runtime - data store runtime the new shared number sequence belongs to
+     * @param id - optional name of the shared number sequence
+     * @returns newly create shared number sequence (but not attached yet)
+     *
+     * @deprecated SharedNumberSequence is not recommended for use and will be removed in an upcoming release.
+     * For more info, please see [Github issue 8526](https://github.com/microsoft/FluidFramework/issues/8526)
+     */
+    public static create(runtime: IFluidDataStoreRuntime, id?: string) {
+        return runtime.createChannel(id,
+            SharedNumberSequenceFactory.Type) as SharedNumberSequence;
+    }
+
+    /**
+     * Get a factory for SharedNumberSequence to register with the data store.
+     *
+     * @returns a factory that creates and load SharedNumberSequence
+     *
+     * @deprecated SharedNumberSequence is not recommended for use and will be removed in an upcoming release.
+     * For more info, please see [Github issue 8526](https://github.com/microsoft/FluidFramework/issues/8526)
+     */
+    public static getFactory() {
+        return new SharedNumberSequenceFactory();
+    }
+
+    /**
+     * @deprecated SharedNumberSequence is not recommended for use and will be removed in an upcoming release.
+     * For more info, please see [Github issue 8526](https://github.com/microsoft/FluidFramework/issues/8526)
+     */
+    constructor(document: IFluidDataStoreRuntime, public id: string, attributes: IChannelAttributes) {
+        super(document, id, attributes, (spec) => {
+            const segment = SharedNumberSequenceFactory.segmentFromSpec(spec);
+            if (!segment) {
+                throw new Error("expected `spec` to be valid `ISegment`");
+            }
+            return segment;
+        });
+    }
+
+    /**
+     * @deprecated SharedNumberSequence is not recommended for use and will be removed in an upcoming release.
+     * For more info, please see [Github issue 8526](https://github.com/microsoft/FluidFramework/issues/8526)
+     */
+    public getRange(start: number, end?: number) {
+        return this.getItems(start, end);
+    }
+}

package/src/sharedObjectSequence.ts

@@ -0,0 +1,62 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { IFluidDataStoreRuntime, IChannelAttributes, Serializable } from "@fluidframework/datastore-definitions";
+import { SharedSequence } from "@fluidframework/sequence";
+import { SharedObjectSequenceFactory } from "./sequenceFactory";
+
+/**
+ * The SharedObjectSequence holds a sequence of serializable objects. Each object will be stored
+ * at a position within the sequence. See the
+ * {@link https://fluidframework.com/docs/data-structures/sequences/ | sequence documentation}
+ * for details on working with sequences.
+ *
+ * @deprecated SharedObjectSequence is not recommended for use and will be removed in an upcoming release.
+ * For more info, please see [Github issue 8526](https://github.com/microsoft/FluidFramework/issues/8526)
+ */
+export class SharedObjectSequence<T> extends SharedSequence<T> {
+    /**
+     * Create a new shared object sequence
+     *
+     * @param runtime - data store runtime the new shared object sequence belongs to
+     * @param id - optional name of the shared object sequence
+     * @returns newly create shared object sequence (but not attached yet)
+     *
+     * @deprecated SharedObjectSequence is not recommended for use and will be removed in an upcoming release.
+     * For more info, please see [Github issue 8526](https://github.com/microsoft/FluidFramework/issues/8526)
+     */
+
+    public static create<T>(runtime: IFluidDataStoreRuntime, id?: string) {
+        return runtime.createChannel(id, SharedObjectSequenceFactory.Type) as SharedObjectSequence<T>;
+    }
+
+    /**
+     * Get a factory for SharedObjectSequence to register with the data store.
+     *
+     * @returns a factory that creates and load SharedObjectSequence
+     *
+     * @deprecated SharedObjectSequence is not recommended for use and will be removed in an upcoming release.
+     * For more info, please see [Github issue 8526](https://github.com/microsoft/FluidFramework/issues/8526)
+     */
+    public static getFactory() {
+        return new SharedObjectSequenceFactory();
+    }
+
+    /**
+     * @deprecated SharedObjectSequence is not recommended for use and will be removed in an upcoming release.
+     * For more info, please see [Github issue 8526](https://github.com/microsoft/FluidFramework/issues/8526)
+     */
+    constructor(document: IFluidDataStoreRuntime, public id: string, attributes: IChannelAttributes) {
+        super(document, id, attributes, SharedObjectSequenceFactory.segmentFromSpec as any);
+    }
+
+    /**
+     * @deprecated SharedObjectSequence is not recommended for use and will be removed in an upcoming release.
+     * For more info, please see [Github issue 8526](https://github.com/microsoft/FluidFramework/issues/8526)
+     */
+    public getRange(start: number, end?: number): Serializable<T>[] {
+        return this.getItems(start, end);
+    }
+}