@fluidframework/datastore-definitions 2.0.0-dev.2.3.0.115467 → 2.0.0-dev.4.1.0.148229

package/src/dataStoreRuntime.ts

@@ -3,128 +3,138 @@
  * Licensed under the MIT License.
  */
 
-import { IDisposable, IEvent, IEventProvider, ITelemetryLogger } from "@fluidframework/common-definitions";
 import {
-    IFluidHandleContext,
-    IFluidRouter,
-    IFluidHandle,
-    FluidObject,
+	IDisposable,
+	IEvent,
+	IEventProvider,
+	ITelemetryLogger,
+} from "@fluidframework/common-definitions";
+import {
+	IFluidHandleContext,
+	IFluidRouter,
+	IFluidHandle,
+	FluidObject,
 } from "@fluidframework/core-interfaces";
 import {
-    IAudience,
-    IDeltaManager,
-    AttachState,
-    ILoaderOptions,
+	IAudience,
+	IDeltaManager,
+	AttachState,
+	ILoaderOptions,
 } from "@fluidframework/container-definitions";
 import {
-    IDocumentMessage,
-    IQuorumClients,
-    ISequencedDocumentMessage,
+	IDocumentMessage,
+	IQuorumClients,
+	ISequencedDocumentMessage,
 } from "@fluidframework/protocol-definitions";
 import {
-    IInboundSignalMessage,
-    IProvideFluidDataStoreRegistry,
+	IInboundSignalMessage,
+	IProvideFluidDataStoreRegistry,
 } from "@fluidframework/runtime-definitions";
 import { IChannel } from ".";
 
 export interface IFluidDataStoreRuntimeEvents extends IEvent {
-    (
-        // eslint-disable-next-line @typescript-eslint/unified-signatures
-        event: "disconnected" | "dispose" | "attaching" | "attached",
-        listener: () => void,
-    );
-    (event: "op", listener: (message: ISequencedDocumentMessage) => void);
-    (event: "signal", listener: (message: IInboundSignalMessage, local: boolean) => void);
-    (event: "connected", listener: (clientId: string) => void);
+	(event: "disconnected" | "dispose" | "attaching" | "attached", listener: () => void);
+	(event: "op", listener: (message: ISequencedDocumentMessage) => void);
+	(event: "signal", listener: (message: IInboundSignalMessage, local: boolean) => void);
+	(event: "connected", listener: (clientId: string) => void);
 }
 
 /**
  * Represents the runtime for the data store. Contains helper functions/state of the data store.
  */
-export interface IFluidDataStoreRuntime extends
-    IFluidRouter,
-    IEventProvider<IFluidDataStoreRuntimeEvents>,
-    IDisposable,
-    Partial<IProvideFluidDataStoreRegistry> {
-
-    readonly id: string;
-
-    readonly IFluidHandleContext: IFluidHandleContext;
-
-    readonly rootRoutingContext: IFluidHandleContext;
-    readonly channelsRoutingContext: IFluidHandleContext;
-    readonly objectsRoutingContext: IFluidHandleContext;
-
-    readonly options: ILoaderOptions;
-
-    readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;
-
-    readonly clientId: string | undefined;
-
-    readonly connected: boolean;
-
-    readonly logger: ITelemetryLogger;
-
-    /**
-     * Indicates the attachment state of the data store to a host service.
-     */
-    readonly attachState: AttachState;
-
-    /**
-     * Returns the channel with the given id
-     */
-    getChannel(id: string): Promise<IChannel>;
-
-    /**
-     * Creates a new channel of the given type.
-     * @param id - ID of the channel to be created.  A unique ID will be generated if left undefined.
-     * @param type - Type of the channel.
-     */
-    createChannel(id: string | undefined, type: string): IChannel;
-
-    /**
-     * Bind the channel with the data store runtime. If the runtime
-     * is attached then we attach the channel to make it live.
-     */
-    bindChannel(channel: IChannel): void;
-
-    // Blob related calls
-    /**
-     * Api to upload a blob of data.
-     * @param blob - blob to be uploaded.
-     */
-    uploadBlob(blob: ArrayBufferLike): Promise<IFluidHandle<ArrayBufferLike>>;
-
-    /**
-     * Submits the signal to be sent to other clients.
-     * @param type - Type of the signal.
-     * @param content - Content of the signal.
-     */
-    submitSignal(type: string, content: any): void;
-
-    /**
-     * Returns the current quorum.
-     */
-    getQuorum(): IQuorumClients;
-
-    /**
-     * Returns the current audience.
-     */
-    getAudience(): IAudience;
-
-    /**
-     * Resolves when a local data store is attached.
-     */
-    waitAttached(): Promise<void>;
-
-    /**
-     * Exposes a handle to the root object / entryPoint of the data store. Use this as the primary way of interacting
-     * with it. If this property is undefined (meaning that exposing the entryPoint hasn't been implemented in a
-     * particular scenario) fall back to the current approach of requesting the root object through the request pattern.
-     *
-     * @remarks The plan is that eventually the data store will stop providing IFluidRouter functionality, this property
-     * will become non-optional and return an IFluidHandle (no undefined) and will become the only way to access
-     * the data store's entryPoint.
-     */
-    readonly entryPoint?: IFluidHandle<FluidObject>;
+export interface IFluidDataStoreRuntime
+	extends IFluidRouter,
+		IEventProvider<IFluidDataStoreRuntimeEvents>,
+		IDisposable,
+		Partial<IProvideFluidDataStoreRegistry> {
+	readonly id: string;
+
+	readonly IFluidHandleContext: IFluidHandleContext;
+
+	readonly rootRoutingContext: IFluidHandleContext;
+	readonly channelsRoutingContext: IFluidHandleContext;
+	readonly objectsRoutingContext: IFluidHandleContext;
+
+	readonly options: ILoaderOptions;
+
+	readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;
+
+	readonly clientId: string | undefined;
+
+	readonly connected: boolean;
+
+	readonly logger: ITelemetryLogger;
+
+	/**
+	 * Indicates the attachment state of the data store to a host service.
+	 */
+	readonly attachState: AttachState;
+
+	/**
+	 * Returns the channel with the given id
+	 */
+	getChannel(id: string): Promise<IChannel>;
+
+	/**
+	 * Invokes the given callback and expects that no ops are submitted
+	 * until execution finishes. If an op is submitted, an error will be raised.
+	 *
+	 * Can be disabled by feature gate `Fluid.ContainerRuntime.DisableOpReentryCheck`
+	 *
+	 * @param callback - the callback to be invoked
+	 */
+	ensureNoDataModelChanges<T>(callback: () => T): T;
+
+	/**
+	 * Creates a new channel of the given type.
+	 * @param id - ID of the channel to be created.  A unique ID will be generated if left undefined.
+	 * @param type - Type of the channel.
+	 */
+	createChannel(id: string | undefined, type: string): IChannel;
+
+	/**
+	 * Bind the channel with the data store runtime. If the runtime
+	 * is attached then we attach the channel to make it live.
+	 */
+	bindChannel(channel: IChannel): void;
+
+	// Blob related calls
+	/**
+	 * Api to upload a blob of data.
+	 * @param blob - blob to be uploaded.
+	 */
+	uploadBlob(blob: ArrayBufferLike): Promise<IFluidHandle<ArrayBufferLike>>;
+
+	/**
+	 * Submits the signal to be sent to other clients.
+	 * @param type - Type of the signal.
+	 * @param content - Content of the signal.
+	 */
+	submitSignal(type: string, content: any): void;
+
+	/**
+	 * Returns the current quorum.
+	 */
+	getQuorum(): IQuorumClients;
+
+	/**
+	 * Returns the current audience.
+	 */
+	getAudience(): IAudience;
+
+	/**
+	 * Resolves when a local data store is attached.
+	 */
+	waitAttached(): Promise<void>;
+
+	/**
+	 * Exposes a handle to the root object / entryPoint of the data store. Use this as the primary way of interacting
+	 * with it. If this property is undefined (meaning that exposing the entryPoint hasn't been implemented in a
+	 * particular scenario) fall back to the current approach of requesting the root object through the request pattern.
+	 *
+	 * @remarks The plan is that eventually the data store will stop providing IFluidRouter functionality, this property
+	 * will become non-optional and return an IFluidHandle (no undefined) and will become the only way to access
+	 * the data store's entryPoint.
+	 */
+	readonly entryPoint?: IFluidHandle<FluidObject>;
 }

package/src/index.ts

@@ -4,11 +4,11 @@
  */
 
 /**
-* This library defines the interfaces required to implement and/or communicate
-* with a data store.
-*
-* @packageDocumentation
-*/
+ * This library defines the interfaces required to implement and/or communicate
+ * with a data store.
+ *
+ * @packageDocumentation
+ */
 
 export {
 	IChannel,

package/src/jsonable.ts

@@ -41,14 +41,17 @@
  *      function foo<T>(value: Jsonable<T>) { ... }
  * ```
  */
-export type Jsonable<T = any, TReplaced = void> =
-    T extends undefined | null | boolean | number | string | TReplaced
-        ? T
-        // eslint-disable-next-line @typescript-eslint/ban-types
-        : Extract<T, Function> extends never
-            ? {
-                [K in keyof T]: Extract<K, symbol> extends never
-                    ? Jsonable<T[K], TReplaced>
-                    : never
-            }
-            : never;
+export type Jsonable<T = any, TReplaced = void> = T extends
+	| undefined
+	| null
+	| boolean
+	| number
+	| string
+	| TReplaced
+	? T
+	: // eslint-disable-next-line @typescript-eslint/ban-types
+	Extract<T, Function> extends never
+	? {
+			[K in keyof T]: Extract<K, symbol> extends never ? Jsonable<T[K], TReplaced> : never;
+	  }
+	: never;

package/src/storage.ts

@@ -7,19 +7,19 @@
  * Represents the attributes of a channel/DDS.
  */
 export interface IChannelAttributes {
-    /**
-     * Type name of the DDS for factory look up with ISharedObjectRegistry
-     */
-    readonly type: string;
+	/**
+	 * Type name of the DDS for factory look up with ISharedObjectRegistry
+	 */
+	readonly type: string;
 
-    /**
-     * Format version of the snapshot
-     * Currently, only use to display a debug message if the version is incompatible
-     */
-    readonly snapshotFormatVersion: string;
+	/**
+	 * Format version of the snapshot
+	 * Currently, only use to display a debug message if the version is incompatible
+	 */
+	readonly snapshotFormatVersion: string;
 
-    /**
-     * The package version of the code of the DDS, for debug only
-     */
-    readonly packageVersion?: string;
+	/**
+	 * The package version of the code of the DDS, for debug only
+	 */
+	readonly packageVersion?: string;
 }

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/**/*"],
 }