@fluidframework/shared-object-base 2.0.0-dev.2.3.0.115467 → 2.0.0-dev.4.1.0.148229

package/src/summarySerializer.ts

@@ -10,13 +10,13 @@ import { FluidSerializer } from "./serializer";
  * Serializer implementation for serializing handles during summary.
  */
 export class SummarySerializer extends FluidSerializer {
-    private readonly serializedRoutes: Set<string> = new Set();
-    public getSerializedRoutes(): string[] {
-        return Array.from(this.serializedRoutes);
-    }
+	private readonly serializedRoutes: Set<string> = new Set();
+	public getSerializedRoutes(): string[] {
+		return Array.from(this.serializedRoutes);
+	}
 
-    protected serializeHandle(handle: IFluidHandle, bind: IFluidHandle) {
-        this.serializedRoutes.add(handle.absolutePath);
-        return super.serializeHandle(handle, bind);
-    }
+	protected serializeHandle(handle: IFluidHandle, bind: IFluidHandle) {
+		this.serializedRoutes.add(handle.absolutePath);
+		return super.serializeHandle(handle, bind);
+	}
 }

package/src/types.ts

@@ -3,7 +3,11 @@
  * Licensed under the MIT License.
  */
 
-import { IErrorEvent, IEventProvider, IEventThisPlaceHolder } from "@fluidframework/common-definitions";
+import {
+	IErrorEvent,
+	IEventProvider,
+	IEventThisPlaceHolder,
+} from "@fluidframework/common-definitions";
 import { IChannel } from "@fluidframework/datastore-definitions";
 import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
 import { IGarbageCollectionData } from "@fluidframework/runtime-definitions";
@@ -12,43 +16,57 @@ import { IGarbageCollectionData } from "@fluidframework/runtime-definitions";
  * Events emitted by {@link ISharedObject}.
  */
 export interface ISharedObjectEvents extends IErrorEvent {
-    /**
-     * Fires before an incoming operation (op) is applied to the shared object.
-     *
-     * @remarks Note: this should be considered an internal implementation detail. It is not recommended for external
-     * use.
-     *
-     * @eventProperty
-     */
-    (event: "pre-op", listener: (op: ISequencedDocumentMessage, local: boolean, target: IEventThisPlaceHolder) => void);
+	/**
+	 * Fires before an incoming operation (op) is applied to the shared object.
+	 *
+	 * @remarks Note: this should be considered an internal implementation detail. It is not recommended for external
+	 * use.
+	 *
+	 * @eventProperty
+	 */
+	(
+		event: "pre-op",
+		listener: (
+			op: ISequencedDocumentMessage,
+			local: boolean,
+			target: IEventThisPlaceHolder,
+		) => void,
+	);
 
-    /**
-     * Fires after an incoming op is applied to the shared object.
-     *
-     * @remarks Note: this should be considered an internal implementation detail. It is not recommended for external
-     * use.
-     *
-     * @eventProperty
-     */
-    // eslint-disable-next-line @typescript-eslint/unified-signatures
-    (event: "op", listener: (op: ISequencedDocumentMessage, local: boolean, target: IEventThisPlaceHolder) => void);
+	/**
+	 * Fires after an incoming op is applied to the shared object.
+	 *
+	 * @remarks Note: this should be considered an internal implementation detail. It is not recommended for external
+	 * use.
+	 *
+	 * @eventProperty
+	 */
+	(
+		event: "op",
+		listener: (
+			op: ISequencedDocumentMessage,
+			local: boolean,
+			target: IEventThisPlaceHolder,
+		) => void,
+	);
 }
 
 /**
  * Base interface for shared objects from which other interfaces derive. Implemented by SharedObject
  */
 export interface ISharedObject<TEvent extends ISharedObjectEvents = ISharedObjectEvents>
-    extends IChannel, IEventProvider<TEvent> {
-    /**
-     * Binds the given shared object to its containing data store runtime, causing it to attach once
-     * the runtime attaches.
-     */
-    bindToContext(): void;
+	extends IChannel,
+		IEventProvider<TEvent> {
+	/**
+	 * Binds the given shared object to its containing data store runtime, causing it to attach once
+	 * the runtime attaches.
+	 */
+	bindToContext(): void;
 
-    /**
-     * Returns the GC data for this shared object. It contains a list of GC nodes that contains references to
-     * other GC nodes.
-     * @param fullGC - true to bypass optimizations and force full generation of GC data.
-     */
-    getGCData(fullGC?: boolean): IGarbageCollectionData;
+	/**
+	 * Returns the GC data for this shared object. It contains a list of GC nodes that contains references to
+	 * other GC nodes.
+	 * @param fullGC - true to bypass optimizations and force full generation of GC data.
+	 */
+	getGCData(fullGC?: boolean): IGarbageCollectionData;
 }

package/src/utils.ts

@@ -18,16 +18,12 @@ import { IFluidSerializer } from "./serializer";
  * @returns Result of strigifying an object
  */
 export function serializeHandles(
-    value: any,
-    serializer: IFluidSerializer,
-    bind: IFluidHandle,
+	value: any,
+	serializer: IFluidSerializer,
+	bind: IFluidHandle,
 ): string | undefined {
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-return
-    return value !== undefined
-        ? serializer.stringify(
-            value,
-            bind)
-        : value;
+	// eslint-disable-next-line @typescript-eslint/no-unsafe-return
+	return value !== undefined ? serializer.stringify(value, bind) : value;
 }
 
 /**
@@ -43,14 +39,12 @@ export function serializeHandles(
  * @returns The fully-plain object
  */
 export function makeHandlesSerializable(
-    value: any,
-    serializer: IFluidSerializer,
-    bind: IFluidHandle,
+	value: any,
+	serializer: IFluidSerializer,
+	bind: IFluidHandle,
 ) {
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-return
-    return serializer.encode(
-        value,
-        bind);
+	// eslint-disable-next-line @typescript-eslint/no-unsafe-return
+	return serializer.encode(value, bind);
 }
 
 /**
@@ -61,12 +55,9 @@ export function makeHandlesSerializable(
  * @param context - The handle context for the container
  * @returns The mostly-plain object with handle objects within
  */
-export function parseHandles(
-    value: any,
-    serializer: IFluidSerializer,
-) {
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-return
-    return value !== undefined ? serializer.parse(JSON.stringify(value)) : value;
+export function parseHandles(value: any, serializer: IFluidSerializer) {
+	// eslint-disable-next-line @typescript-eslint/no-unsafe-return
+	return value !== undefined ? serializer.parse(JSON.stringify(value)) : value;
 }
 
 /**
@@ -75,8 +66,11 @@ export function parseHandles(
  * @param content - blob content
  * @returns The summary containing the blob
  */
-export function createSingleBlobSummary(key: string, content: string | Uint8Array): ISummaryTreeWithStats {
-    const builder = new SummaryTreeBuilder();
-    builder.addBlob(key, content);
-    return builder.getSummaryTree();
+export function createSingleBlobSummary(
+	key: string,
+	content: string | Uint8Array,
+): ISummaryTreeWithStats {
+	const builder = new SummaryTreeBuilder();
+	builder.addBlob(key, content);
+	return builder.getSummaryTree();
 }

package/src/valueType.ts

@@ -7,14 +7,14 @@
  * enum representing the possible types of a shared object
  */
 export enum ValueType {
-    /**
-     * The value is a shared object
-     * @deprecated Instead store the handle of the shared object, rather than the shared object itself.
-     */
-    Shared,
+	/**
+	 * The value is a shared object
+	 * @deprecated Instead store the handle of the shared object, rather than the shared object itself.
+	 */
+	Shared,
 
-    /**
-     * The value is a plain JavaScript object or handle.  If a plain object, it may contain handles deeper within.
-     */
-    Plain,
+	/**
+	 * The value is a plain JavaScript object or handle.  If a plain object, it may contain handles deeper within.
+	 */
+	Plain,
 }

package/tsconfig.esnext.json

@@ -1,7 +1,7 @@
 {
-    "extends": "./tsconfig.json",
-    "compilerOptions": {
-        "outDir": "./lib",
-        "module": "esnext"
-    },
-}
+	"extends": "./tsconfig.json",
+	"compilerOptions": {
+		"outDir": "./lib",
+		"module": "esnext",
+	},
+}

package/tsconfig.json

@@ -1,14 +1,10 @@
 {
-    "extends": "@fluidframework/build-common/ts-common-config.json",
-    "exclude": [
-        "src/test/**/*"
-    ],
-    "compilerOptions": {
-        "rootDir": "./src",
-        "outDir": "./dist",
-        "composite": true
-    },
-    "include": [
-        "src/**/*"
-    ]
+	"extends": "@fluidframework/build-common/ts-common-config.json",
+	"exclude": ["src/test/**/*"],
+	"compilerOptions": {
+		"rootDir": "./src",
+		"outDir": "./dist",
+		"composite": true,
+	},
+	"include": ["src/**/*"],
 }