@fluidframework/sequence 0.53.0 → 0.54.2

package/src/sequenceFactory.ts

@@ -68,15 +68,31 @@ export class SharedStringFactory 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)
+ */
 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) {
         // eslint-disable-next-line @typescript-eslint/ban-types
         const runSegment = segSpec as IJSONRunSegment<object>;
@@ -90,16 +106,27 @@ 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 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,
@@ -112,6 +139,10 @@ export class SharedObjectSequenceFactory implements IChannelFactory {
         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();
@@ -119,15 +150,31 @@ export class SharedObjectSequenceFactory 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)
+ */
 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) {
         const runSegment = segSpec as IJSONRunSegment<number>;
         if (runSegment.items) {
@@ -139,16 +186,27 @@ 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 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,
@@ -160,6 +218,10 @@ export class SharedNumberSequenceFactory implements IChannelFactory {
         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();

package/src/sharedNumberSequence.ts

@@ -12,6 +12,9 @@ import { SharedSequence } from "./sharedSequence";
  * 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> {
     /**
@@ -20,6 +23,9 @@ export class SharedNumberSequence extends SharedSequence<number> {
      * @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,
@@ -30,15 +36,26 @@ export class SharedNumberSequence extends SharedSequence<number> {
      * 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, SharedNumberSequenceFactory.segmentFromSpec);
     }
 
+    /**
+     * @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

@@ -12,6 +12,9 @@ import { SharedSequence } from "./sharedSequence";
  * 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> {
     /**
@@ -20,6 +23,9 @@ export class SharedObjectSequence<T> extends SharedSequence<T> {
      * @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)
      */
     // eslint-disable-next-line @typescript-eslint/no-shadow
     public static create<T>(runtime: IFluidDataStoreRuntime, id?: string) {
@@ -30,15 +36,26 @@ export class SharedObjectSequence<T> extends SharedSequence<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);
     }
 
+    /**
+     * @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);
     }