@fluidframework/datastore 2.0.0-dev.7.4.0.215930 → 2.0.0-dev.7.4.0.216897

package/lib/datastore-public.d.ts

@@ -1,342 +1,64 @@
-import { AttachState } from '@fluidframework/container-definitions';
-import { FluidObject } from '@fluidframework/core-interfaces';
-import { IAudience } from '@fluidframework/container-definitions';
-import { IChannel } from '@fluidframework/datastore-definitions';
-import { IChannelFactory } from '@fluidframework/datastore-definitions';
 import { IClientDetails } from '@fluidframework/protocol-definitions';
-import { IDeltaManager } from '@fluidframework/container-definitions';
 import { IDocumentMessage } from '@fluidframework/protocol-definitions';
-import { IFluidDataStoreChannel } from '@fluidframework/runtime-definitions';
-import { IFluidDataStoreContext } from '@fluidframework/runtime-definitions';
-import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
-import { IFluidDataStoreRuntimeEvents } from '@fluidframework/datastore-definitions';
-import { IFluidHandle } from '@fluidframework/core-interfaces';
-import { IFluidHandleContext } from '@fluidframework/core-interfaces';
-import { IGarbageCollectionData } from '@fluidframework/runtime-definitions';
-import { IIdCompressor } from '@fluidframework/runtime-definitions';
-import { IInboundSignalMessage } from '@fluidframework/runtime-definitions';
-import { ILoaderOptions } from '@fluidframework/container-definitions';
 import { IQuorumClients } from '@fluidframework/protocol-definitions';
-import { IRequest } from '@fluidframework/core-interfaces';
-import { IResponse } from '@fluidframework/core-interfaces';
 import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
-import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
-import { ITelemetryContext } from '@fluidframework/runtime-definitions';
-import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
-import { VisibilityState } from '@fluidframework/runtime-definitions';
 
-/**
- * @public
- */
-export declare enum DataStoreMessageType {
-    Attach = "attach",
-    ChannelOp = "op"
-}
+/* Excluded from this release type: AttachState */
 
-/**
- * Base data store class
- *
- * @public
- */
-export declare class FluidDataStoreRuntime extends TypedEventEmitter<IFluidDataStoreRuntimeEvents> implements IFluidDataStoreChannel, IFluidDataStoreRuntime, IFluidHandleContext {
-    private readonly dataStoreContext;
-    private readonly sharedObjectRegistry;
-    /**
-     * @deprecated Instantiate the class using its constructor instead.
-     *
-     * Loads the data store runtime
-     * @param context - The data store context
-     * @param sharedObjectRegistry - The registry of shared objects used by this data store
-     * @param existing - If loading from an existing file.
-     */
-    static load(context: IFluidDataStoreContext, sharedObjectRegistry: ISharedObjectRegistry, existing: boolean): FluidDataStoreRuntime;
-    /**
-     * {@inheritDoc @fluidframework/datastore-definitions#IFluidDataStoreRuntime.entryPoint}
-     */
-    readonly entryPoint: IFluidHandle<FluidObject>;
-    /**
-     * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
-     */
-    get IFluidRouter(): this;
-    get connected(): boolean;
-    get clientId(): string | undefined;
-    get clientDetails(): IClientDetails;
-    get isAttached(): boolean;
-    get attachState(): AttachState;
-    get absolutePath(): string;
-    get routeContext(): IFluidHandleContext;
-    get idCompressor(): IIdCompressor | undefined;
-    get IFluidHandleContext(): this;
-    get rootRoutingContext(): this;
-    get channelsRoutingContext(): this;
-    get objectsRoutingContext(): this;
-    private _disposed;
-    get disposed(): boolean;
-    private readonly contexts;
-    private readonly pendingAttach;
-    private readonly deferredAttached;
-    private readonly localChannelContextQueue;
-    private readonly notBoundedChannelContextSet;
-    private _attachState;
-    visibilityState: VisibilityState;
-    private readonly pendingHandlesToMakeVisible;
-    readonly id: string;
-    readonly options: ILoaderOptions;
-    readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;
-    private readonly quorum;
-    private readonly audience;
-    private readonly mc;
-    get logger(): ITelemetryLoggerExt;
-    /**
-     * If the summarizer makes local changes, a telemetry event is logged. This has the potential to be very noisy.
-     * So, adding a count of how many telemetry events are logged per data store context. This can be
-     * controlled via feature flags.
-     */
-    private localChangesTelemetryCount;
-    /**
-     * 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;
-    /**
-     * Create an instance of a DataStore runtime.
-     *
-     * @param dataStoreContext - Context object for the runtime.
-     * @param sharedObjectRegistry - The registry of shared objects that this data store will be able to instantiate.
-     * @param existing - Pass 'true' if loading this datastore from an existing file; pass 'false' otherwise.
-     * @param provideEntryPoint - Function to initialize the entryPoint object for the data store runtime. The
-     * handle to this data store runtime will point to the object returned by this function. If this function is not
-     * provided, the handle will be left undefined. This is here so we can start making handles a first-class citizen
-     * and the primary way of interacting with some Fluid objects, and should be used if possible.
-     */
-    constructor(dataStoreContext: IFluidDataStoreContext, sharedObjectRegistry: ISharedObjectRegistry, existing: boolean, provideEntryPoint: (runtime: IFluidDataStoreRuntime) => Promise<FluidObject>);
-    dispose(): void;
-    resolveHandle(request: IRequest): Promise<IResponse>;
-    request(request: IRequest): Promise<IResponse>;
-    getChannel(id: string): Promise<IChannel>;
-    /**
-     * Api which allows caller to create the channel first and then add it to the runtime.
-     * The channel type should be present in the registry, otherwise the runtime would reject
-     * the channel. Also the runtime used to create the channel object should be same to which
-     * it is added.
-     * @param channel - channel which needs to be added to the runtime.
-     */
-    addChannel(channel: IChannel): void;
-    createChannel(id: string | undefined, type: string): IChannel;
-    private createChannelContext;
-    /**
-     * Binds a channel with the runtime. If the runtime is attached we will attach the channel right away.
-     * If the runtime is not attached we will defer the attach until the runtime attaches.
-     * @param channel - channel to be registered.
-     */
-    bindChannel(channel: IChannel): void;
-    /**
-     * This function is called when a data store becomes root. It does the following:
-     *
-     * 1. Marks the data store locally visible in the container.
-     *
-     * 2. Attaches the graph of all the handles bound to it.
-     *
-     * 3. Calls into the data store context to mark it visible in the container too. If the container is globally
-     * visible, it will mark us globally visible. Otherwise, it will mark us globally visible when it becomes
-     * globally visible.
-     */
-    makeVisibleAndAttachGraph(): void;
-    /**
-     * This function is called when a handle to this data store is added to a visible DDS.
-     */
-    attachGraph(): void;
-    bind(handle: IFluidHandle): void;
-    setConnectionState(connected: boolean, clientId?: string): void;
-    getQuorum(): IQuorumClients;
-    getAudience(): IAudience;
-    uploadBlob(blob: ArrayBufferLike, signal?: AbortSignal): Promise<IFluidHandle<ArrayBufferLike>>;
-    private createRemoteChannelContext;
-    process(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
-    processSignal(message: IInboundSignalMessage, local: boolean): void;
-    private isChannelAttached;
-    /**
-     * Returns the outbound routes of this channel. Currently, all contexts in this channel are considered
-     * referenced and are hence outbound. This will change when we have root and non-root channel contexts.
-     * The only root contexts will be considered as referenced.
-     */
-    private getOutboundRoutes;
-    /**
-     * Updates the GC nodes of this channel. It does the following:
-     * - Adds a back route to self to all its child GC nodes.
-     * - Adds a node for this channel.
-     * @param builder - The builder that contains the GC nodes for this channel's children.
-     */
-    private updateGCNodes;
-    /**
-     * Generates data used for garbage collection. This includes a list of GC nodes that represent this channel
-     * including any of its child channel contexts. Each node has a set of outbound routes to other GC nodes in the
-     * document. It does the following:
-     *
-     * 1. Calls into each child context to get its GC data.
-     *
-     * 2. Prefixes the child context's id to the GC nodes in the child's GC data. This makes sure that the node can be
-     * identified as belonging to the child.
-     *
-     * 3. Adds a GC node for this channel to the nodes received from the children. All these nodes together represent
-     * the GC data of this channel.
-     *
-     * @param fullGC - true to bypass optimizations and force full generation of GC data.
-     */
-    getGCData(fullGC?: boolean): Promise<IGarbageCollectionData>;
-    /**
-     * After GC has run, called to notify this channel of routes that are used in it. It calls the child contexts to
-     * update their used routes.
-     * @param usedRoutes - The routes that are used in all contexts in this channel.
-     */
-    updateUsedRoutes(usedRoutes: string[]): void;
-    /**
-     * Called when a new outbound reference is added to another node. This is used by garbage collection to identify
-     * all references added in the system.
-     * @param srcHandle - The handle of the node that added the reference.
-     * @param outboundHandle - The handle of the outbound node that is referenced.
-     */
-    private addedGCOutboundReference;
-    /**
-     * Returns a summary at the current sequence number.
-     * @param fullTree - true to bypass optimizations and force a full summary tree
-     * @param trackState - This tells whether we should track state from this summary.
-     * @param telemetryContext - summary data passed through the layers for telemetry purposes
-     */
-    summarize(fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext): Promise<ISummaryTreeWithStats>;
-    getAttachSummary(telemetryContext?: ITelemetryContext): ISummaryTreeWithStats;
-    submitMessage(type: DataStoreMessageType, content: any, localOpMetadata: unknown): void;
-    /**
-     * Submits the signal to be sent to other clients.
-     * @param type - Type of the signal.
-     * @param content - Content of the signal.
-     * @param targetClientId - When specified, the signal is only sent to the provided client id.
-     */
-    submitSignal(type: string, content: any, targetClientId?: string): void;
-    /**
-     * Will return when the data store is attached.
-     */
-    waitAttached(): Promise<void>;
-    /**
-     * Attach channel should only be called after the data store has been attached
-     */
-    private attachChannel;
-    private submitChannelOp;
-    private submit;
-    /**
-     * For messages of type MessageType.Operation, finds the right channel and asks it to resubmit the message.
-     * For all other messages, just submit it again.
-     * This typically happens when we reconnect and there are unacked messages.
-     * @param content - The content of the original message.
-     * @param localOpMetadata - The local metadata associated with the original message.
-     */
-    reSubmit(type: DataStoreMessageType, content: any, localOpMetadata: unknown): void;
-    /**
-     * Revert a local op.
-     * @param content - The content of the original message.
-     * @param localOpMetadata - The local metadata associated with the original message.
-     */
-    rollback?(type: DataStoreMessageType, content: any, localOpMetadata: unknown): void;
-    applyStashedOp(content: any): Promise<unknown>;
-    private setChannelDirty;
-    private processChannelOp;
-    private attachListener;
-    private verifyNotClosed;
-    /**
-     * Summarizer client should not have local changes. These changes can become part of the summary and can break
-     * eventual consistency. For example, the next summary (say at ref seq# 100) may contain these changes whereas
-     * other clients that are up-to-date till seq# 100 may not have them yet.
-     */
-    private identifyLocalChangeInSummarizer;
-}
+/* Excluded from this release type: DataStoreMessageType */
 
-/**
- * Handle for a shared {@link @fluidframework/core-interfaces#FluidObject}.
- *
- * @public
- */
-export declare class FluidObjectHandle<T extends FluidObject = FluidObject> implements IFluidHandle {
-    protected readonly value: T | Promise<T>;
-    readonly path: string;
-    readonly routeContext: IFluidHandleContext;
-    private readonly pendingHandlesToMakeVisible;
-    /**
-     * {@inheritDoc @fluidframework/core-interfaces#IFluidHandle.absolutePath}
-     */
-    readonly absolutePath: string;
-    /**
-     * {@inheritDoc @fluidframework/core-interfaces#IProvideFluidHandle.IFluidHandle}
-     */
-    get IFluidHandle(): IFluidHandle;
-    /**
-     * {@inheritDoc @fluidframework/core-interfaces#IFluidHandle.isAttached}
-     */
-    get isAttached(): boolean;
-    /**
-     * Tells whether the object of this handle is visible in the container locally or globally.
-     */
-    private get visible();
-    /**
-     * Tracks whether this handle is locally visible in the container.
-     */
-    private locallyVisible;
-    /**
-     * Creates a new `FluidObjectHandle`.
-     *
-     * @param value - The {@link @fluidframework/core-interfaces#FluidObject} object this handle is for.
-     * @param path - The path to this handle relative to the `routeContext`.
-     * @param routeContext - The parent {@link @fluidframework/core-interfaces#IFluidHandleContext} that has a route
-     * to this handle.
-     */
-    constructor(value: T | Promise<T>, path: string, routeContext: IFluidHandleContext);
-    /**
-     * {@inheritDoc @fluidframework/core-interfaces#IFluidHandle.get}
-     */
-    get(): Promise<any>;
-    /**
-     * {@inheritDoc @fluidframework/core-interfaces#IFluidHandle.attachGraph }
-     */
-    attachGraph(): void;
-    /**
-     * {@inheritDoc @fluidframework/core-interfaces#IFluidHandle.bind}
-     */
-    bind(handle: IFluidHandle): void;
-}
+/* Excluded from this release type: FluidDataStoreRuntime */
 
-/**
- * @public
- */
-export declare interface ISharedObjectRegistry {
-    get(name: string): IChannelFactory | undefined;
-}
+/* Excluded from this release type: FluidObject */
 
-/**
- * Mixin class that adds request handler to FluidDataStoreRuntime
- * Request handler is only called when data store can't resolve request, i.e. for custom requests.
- * @param Base - base class, inherits from FluidDataStoreRuntime
- * @param requestHandler - request handler to mix in
- *
- * @public
- */
-export declare const mixinRequestHandler: (requestHandler: (request: IRequest, runtime: FluidDataStoreRuntime) => Promise<IResponse>, Base?: typeof FluidDataStoreRuntime) => typeof FluidDataStoreRuntime;
+/* Excluded from this release type: FluidObjectHandle */
 
-/**
- * Mixin class that adds await for DataObject to finish initialization before we proceed to summary.
- * @param handler - handler that returns info about blob to be added to summary.
- * Or undefined not to add anything to summary.
- * @param Base - base class, inherits from FluidDataStoreRuntime
- *
- * @public
- */
-export declare const mixinSummaryHandler: (handler: (runtime: FluidDataStoreRuntime) => Promise<{
-    path: string[];
-    content: string;
-} | undefined>, Base?: typeof FluidDataStoreRuntime) => typeof FluidDataStoreRuntime;
+/* Excluded from this release type: IAudience */
+
+/* Excluded from this release type: IChannel */
+
+/* Excluded from this release type: IChannelFactory */
+
+/* Excluded from this release type: IDeltaManager */
+
+/* Excluded from this release type: IFluidDataStoreChannel */
+
+/* Excluded from this release type: IFluidDataStoreContext */
+
+/* Excluded from this release type: IFluidDataStoreRuntime */
+
+/* Excluded from this release type: IFluidDataStoreRuntimeEvents */
+
+/* Excluded from this release type: IFluidHandle */
+
+/* Excluded from this release type: IFluidHandleContext */
+
+/* Excluded from this release type: IGarbageCollectionData */
+
+/* Excluded from this release type: IIdCompressor */
+
+/* Excluded from this release type: IInboundSignalMessage */
+
+/* Excluded from this release type: ILoaderOptions */
+
+/* Excluded from this release type: IRequest */
+
+/* Excluded from this release type: IResponse */
+
+/* Excluded from this release type: ISharedObjectRegistry */
+
+/* Excluded from this release type: ISummaryTreeWithStats */
+
+/* Excluded from this release type: ITelemetryContext */
+
+/* Excluded from this release type: ITelemetryLoggerExt */
+
+/* Excluded from this release type: mixinRequestHandler */
+
+/* Excluded from this release type: mixinSummaryHandler */
 
 /* Excluded from this release type: TypedEventEmitter */
 
+/* Excluded from this release type: VisibilityState */
+
 export { }

package/lib/datastore-untrimmed.d.ts

@@ -27,7 +27,7 @@ import { TypedEventEmitter } from '@fluid-internal/client-utils';
 import { VisibilityState } from '@fluidframework/runtime-definitions';
 
 /**
- * @public
+ * @internal
  */
 export declare enum DataStoreMessageType {
     Attach = "attach",
@@ -36,8 +36,7 @@ export declare enum DataStoreMessageType {
 
 /**
  * Base data store class
- *
- * @public
+ * @internal
  */
 export declare class FluidDataStoreRuntime extends TypedEventEmitter<IFluidDataStoreRuntimeEvents> implements IFluidDataStoreChannel, IFluidDataStoreRuntime, IFluidHandleContext {
     private readonly dataStoreContext;
@@ -257,8 +256,7 @@ export declare class FluidDataStoreRuntime extends TypedEventEmitter<IFluidDataS
 
 /**
  * Handle for a shared {@link @fluidframework/core-interfaces#FluidObject}.
- *
- * @public
+ * @internal
  */
 export declare class FluidObjectHandle<T extends FluidObject = FluidObject> implements IFluidHandle {
     protected readonly value: T | Promise<T>;
@@ -309,7 +307,7 @@ export declare class FluidObjectHandle<T extends FluidObject = FluidObject> impl
 }
 
 /**
- * @public
+ * @internal
  */
 export declare interface ISharedObjectRegistry {
     get(name: string): IChannelFactory | undefined;
@@ -320,8 +318,7 @@ export declare interface ISharedObjectRegistry {
  * Request handler is only called when data store can't resolve request, i.e. for custom requests.
  * @param Base - base class, inherits from FluidDataStoreRuntime
  * @param requestHandler - request handler to mix in
- *
- * @public
+ * @internal
  */
 export declare const mixinRequestHandler: (requestHandler: (request: IRequest, runtime: FluidDataStoreRuntime) => Promise<IResponse>, Base?: typeof FluidDataStoreRuntime) => typeof FluidDataStoreRuntime;
 
@@ -330,8 +327,7 @@ export declare const mixinRequestHandler: (requestHandler: (request: IRequest, r
  * @param handler - handler that returns info about blob to be added to summary.
  * Or undefined not to add anything to summary.
  * @param Base - base class, inherits from FluidDataStoreRuntime
- *
- * @public
+ * @internal
  */
 export declare const mixinSummaryHandler: (handler: (runtime: FluidDataStoreRuntime) => Promise<{
     path: string[];

package/lib/fluidHandle.d.ts

@@ -5,8 +5,7 @@
 import { IFluidHandle, IFluidHandleContext, FluidObject } from "@fluidframework/core-interfaces";
 /**
  * Handle for a shared {@link @fluidframework/core-interfaces#FluidObject}.
- *
- * @public
+ * @internal
  */
 export declare class FluidObjectHandle<T extends FluidObject = FluidObject> implements IFluidHandle {
     protected readonly value: T | Promise<T>;

package/lib/fluidHandle.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fluidHandle.d.ts","sourceRoot":"","sources":["../src/fluidHandle.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAGjG;;;;GAIG;AACH,qBAAa,iBAAiB,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,CAAE,YAAW,YAAY;IAuDzF,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;aACxB,IAAI,EAAE,MAAM;aACZ,YAAY,EAAE,mBAAmB;IAxDlD,OAAO,CAAC,QAAQ,CAAC,2BAA2B,CAAgC;IAE5E;;OAEG;IACH,SAAgB,YAAY,EAAE,MAAM,CAAC;IAErC;;OAEG;IACH,IAAW,YAAY,IAAI,YAAY,CAEtC;IAED;;OAEG;IACH,IAAW,UAAU,IAAI,OAAO,CAE/B;IAED;;OAEG;IACH,OAAO,KAAK,OAAO,GAclB;IAED;;OAEG;IACH,OAAO,CAAC,cAAc,CAAkB;IAExC;;;;;;;OAOG;gBAEiB,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,EACxB,IAAI,EAAE,MAAM,EACZ,YAAY,EAAE,mBAAmB;IAKlD;;OAEG;IACU,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC;IAKhC;;OAEG;IACI,WAAW,IAAI,IAAI;IAa1B;;OAEG;IACI,IAAI,CAAC,MAAM,EAAE,YAAY;CAQhC"}
+{"version":3,"file":"fluidHandle.d.ts","sourceRoot":"","sources":["../src/fluidHandle.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAGjG;;;GAGG;AACH,qBAAa,iBAAiB,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,CAAE,YAAW,YAAY;IAuDzF,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;aACxB,IAAI,EAAE,MAAM;aACZ,YAAY,EAAE,mBAAmB;IAxDlD,OAAO,CAAC,QAAQ,CAAC,2BAA2B,CAAgC;IAE5E;;OAEG;IACH,SAAgB,YAAY,EAAE,MAAM,CAAC;IAErC;;OAEG;IACH,IAAW,YAAY,IAAI,YAAY,CAEtC;IAED;;OAEG;IACH,IAAW,UAAU,IAAI,OAAO,CAE/B;IAED;;OAEG;IACH,OAAO,KAAK,OAAO,GAclB;IAED;;OAEG;IACH,OAAO,CAAC,cAAc,CAAkB;IAExC;;;;;;;OAOG;gBAEiB,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,EACxB,IAAI,EAAE,MAAM,EACZ,YAAY,EAAE,mBAAmB;IAKlD;;OAEG;IACU,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC;IAKhC;;OAEG;IACI,WAAW,IAAI,IAAI;IAa1B;;OAEG;IACI,IAAI,CAAC,MAAM,EAAE,YAAY;CAQhC"}

package/lib/fluidHandle.js

@@ -5,8 +5,7 @@
 import { generateHandleContextPath } from "@fluidframework/runtime-utils";
 /**
  * Handle for a shared {@link @fluidframework/core-interfaces#FluidObject}.
- *
- * @public
+ * @internal
  */
 export class FluidObjectHandle {
     /**

package/lib/fluidHandle.js.map

@@ -1 +1 @@
-{"version":3,"file":"fluidHandle.js","sourceRoot":"","sources":["../src/fluidHandle.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAE1E;;;;GAIG;AACH,MAAM,OAAO,iBAAiB;IAQ7B;;OAEG;IACH,IAAW,YAAY;QACtB,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;OAEG;IACH,IAAW,UAAU;QACpB,OAAO,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC;IACrC,CAAC;IAED;;OAEG;IACH,IAAY,OAAO;QAClB;;;;;;;;;;;WAWG;QACH,OAAO,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,cAAc,CAAC;IAC/C,CAAC;IAOD;;;;;;;OAOG;IACH,YACoB,KAAqB,EACxB,IAAY,EACZ,YAAiC;QAF9B,UAAK,GAAL,KAAK,CAAgB;QACxB,SAAI,GAAJ,IAAI,CAAQ;QACZ,iBAAY,GAAZ,YAAY,CAAqB;QAxDjC,gCAA2B,GAAsB,IAAI,GAAG,EAAE,CAAC;QAwC5E;;WAEG;QACK,mBAAc,GAAY,KAAK,CAAC;QAevC,IAAI,CAAC,YAAY,GAAG,yBAAyB,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IACxE,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,GAAG;QACf,yGAAyG;QACzG,OAAO,IAAI,CAAC,KAAK,CAAC;IACnB,CAAC;IAED;;OAEG;IACI,WAAW;QACjB,IAAI,IAAI,CAAC,OAAO,EAAE;YACjB,OAAO;SACP;QAED,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;QAC3B,IAAI,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YACnD,MAAM,CAAC,WAAW,EAAE,CAAC;QACtB,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,2BAA2B,CAAC,KAAK,EAAE,CAAC;QACzC,IAAI,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC;IACjC,CAAC;IAED;;OAEG;IACI,IAAI,CAAC,MAAoB;QAC/B,8EAA8E;QAC9E,IAAI,IAAI,CAAC,OAAO,EAAE;YACjB,MAAM,CAAC,WAAW,EAAE,CAAC;YACrB,OAAO;SACP;QACD,IAAI,CAAC,2BAA2B,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC9C,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IFluidHandle, IFluidHandleContext, FluidObject } from \"@fluidframework/core-interfaces\";\nimport { generateHandleContextPath } from \"@fluidframework/runtime-utils\";\n\n/**\n * Handle for a shared {@link @fluidframework/core-interfaces#FluidObject}.\n *\n * @public\n */\nexport class FluidObjectHandle<T extends FluidObject = FluidObject> implements IFluidHandle {\n\tprivate readonly pendingHandlesToMakeVisible: Set<IFluidHandle> = new Set();\n\n\t/**\n\t * {@inheritDoc @fluidframework/core-interfaces#IFluidHandle.absolutePath}\n\t */\n\tpublic readonly absolutePath: string;\n\n\t/**\n\t * {@inheritDoc @fluidframework/core-interfaces#IProvideFluidHandle.IFluidHandle}\n\t */\n\tpublic get IFluidHandle(): IFluidHandle {\n\t\treturn this;\n\t}\n\n\t/**\n\t * {@inheritDoc @fluidframework/core-interfaces#IFluidHandle.isAttached}\n\t */\n\tpublic get isAttached(): boolean {\n\t\treturn this.routeContext.isAttached;\n\t}\n\n\t/**\n\t * Tells whether the object of this handle is visible in the container locally or globally.\n\t */\n\tprivate get visible(): boolean {\n\t\t/**\n\t\t * If the object of this handle is attached, it is visible in the container. Ideally, checking local visibility\n\t\t * should be enough for a handle. However, there are scenarios where the object becomes locally visible but the\n\t\t * handle does not know this - This will happen is attachGraph is never called on the handle. Couple of examples\n\t\t * where this can happen:\n\t\t *\n\t\t * 1. Handles to DDS other than the default handle won't know if the DDS becomes visible after the handle was\n\t\t * created.\n\t\t *\n\t\t * 2. Handles to root data stores will never know that it was visible because the handle will not be stores in\n\t\t * another DDS and so, attachGraph will never be called on it.\n\t\t */\n\t\treturn this.isAttached || this.locallyVisible;\n\t}\n\n\t/**\n\t * Tracks whether this handle is locally visible in the container.\n\t */\n\tprivate locallyVisible: boolean = false;\n\n\t/**\n\t * Creates a new `FluidObjectHandle`.\n\t *\n\t * @param value - The {@link @fluidframework/core-interfaces#FluidObject} object this handle is for.\n\t * @param path - The path to this handle relative to the `routeContext`.\n\t * @param routeContext - The parent {@link @fluidframework/core-interfaces#IFluidHandleContext} that has a route\n\t * to this handle.\n\t */\n\tconstructor(\n\t\tprotected readonly value: T | Promise<T>,\n\t\tpublic readonly path: string,\n\t\tpublic readonly routeContext: IFluidHandleContext,\n\t) {\n\t\tthis.absolutePath = generateHandleContextPath(path, this.routeContext);\n\t}\n\n\t/**\n\t * {@inheritDoc @fluidframework/core-interfaces#IFluidHandle.get}\n\t */\n\tpublic async get(): Promise<any> {\n\t\t// Note that this return works whether we received a T or a Promise<T> for this.value in the constructor.\n\t\treturn this.value;\n\t}\n\n\t/**\n\t * {@inheritDoc @fluidframework/core-interfaces#IFluidHandle.attachGraph }\n\t */\n\tpublic attachGraph(): void {\n\t\tif (this.visible) {\n\t\t\treturn;\n\t\t}\n\n\t\tthis.locallyVisible = true;\n\t\tthis.pendingHandlesToMakeVisible.forEach((handle) => {\n\t\t\thandle.attachGraph();\n\t\t});\n\t\tthis.pendingHandlesToMakeVisible.clear();\n\t\tthis.routeContext.attachGraph();\n\t}\n\n\t/**\n\t * {@inheritDoc @fluidframework/core-interfaces#IFluidHandle.bind}\n\t */\n\tpublic bind(handle: IFluidHandle) {\n\t\t// If this handle is visible, attach the graph of the incoming handle as well.\n\t\tif (this.visible) {\n\t\t\thandle.attachGraph();\n\t\t\treturn;\n\t\t}\n\t\tthis.pendingHandlesToMakeVisible.add(handle);\n\t}\n}\n"]}
+{"version":3,"file":"fluidHandle.js","sourceRoot":"","sources":["../src/fluidHandle.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAE1E;;;GAGG;AACH,MAAM,OAAO,iBAAiB;IAQ7B;;OAEG;IACH,IAAW,YAAY;QACtB,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;OAEG;IACH,IAAW,UAAU;QACpB,OAAO,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC;IACrC,CAAC;IAED;;OAEG;IACH,IAAY,OAAO;QAClB;;;;;;;;;;;WAWG;QACH,OAAO,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,cAAc,CAAC;IAC/C,CAAC;IAOD;;;;;;;OAOG;IACH,YACoB,KAAqB,EACxB,IAAY,EACZ,YAAiC;QAF9B,UAAK,GAAL,KAAK,CAAgB;QACxB,SAAI,GAAJ,IAAI,CAAQ;QACZ,iBAAY,GAAZ,YAAY,CAAqB;QAxDjC,gCAA2B,GAAsB,IAAI,GAAG,EAAE,CAAC;QAwC5E;;WAEG;QACK,mBAAc,GAAY,KAAK,CAAC;QAevC,IAAI,CAAC,YAAY,GAAG,yBAAyB,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IACxE,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,GAAG;QACf,yGAAyG;QACzG,OAAO,IAAI,CAAC,KAAK,CAAC;IACnB,CAAC;IAED;;OAEG;IACI,WAAW;QACjB,IAAI,IAAI,CAAC,OAAO,EAAE;YACjB,OAAO;SACP;QAED,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;QAC3B,IAAI,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YACnD,MAAM,CAAC,WAAW,EAAE,CAAC;QACtB,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,2BAA2B,CAAC,KAAK,EAAE,CAAC;QACzC,IAAI,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC;IACjC,CAAC;IAED;;OAEG;IACI,IAAI,CAAC,MAAoB;QAC/B,8EAA8E;QAC9E,IAAI,IAAI,CAAC,OAAO,EAAE;YACjB,MAAM,CAAC,WAAW,EAAE,CAAC;YACrB,OAAO;SACP;QACD,IAAI,CAAC,2BAA2B,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC9C,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IFluidHandle, IFluidHandleContext, FluidObject } from \"@fluidframework/core-interfaces\";\nimport { generateHandleContextPath } from \"@fluidframework/runtime-utils\";\n\n/**\n * Handle for a shared {@link @fluidframework/core-interfaces#FluidObject}.\n * @internal\n */\nexport class FluidObjectHandle<T extends FluidObject = FluidObject> implements IFluidHandle {\n\tprivate readonly pendingHandlesToMakeVisible: Set<IFluidHandle> = new Set();\n\n\t/**\n\t * {@inheritDoc @fluidframework/core-interfaces#IFluidHandle.absolutePath}\n\t */\n\tpublic readonly absolutePath: string;\n\n\t/**\n\t * {@inheritDoc @fluidframework/core-interfaces#IProvideFluidHandle.IFluidHandle}\n\t */\n\tpublic get IFluidHandle(): IFluidHandle {\n\t\treturn this;\n\t}\n\n\t/**\n\t * {@inheritDoc @fluidframework/core-interfaces#IFluidHandle.isAttached}\n\t */\n\tpublic get isAttached(): boolean {\n\t\treturn this.routeContext.isAttached;\n\t}\n\n\t/**\n\t * Tells whether the object of this handle is visible in the container locally or globally.\n\t */\n\tprivate get visible(): boolean {\n\t\t/**\n\t\t * If the object of this handle is attached, it is visible in the container. Ideally, checking local visibility\n\t\t * should be enough for a handle. However, there are scenarios where the object becomes locally visible but the\n\t\t * handle does not know this - This will happen is attachGraph is never called on the handle. Couple of examples\n\t\t * where this can happen:\n\t\t *\n\t\t * 1. Handles to DDS other than the default handle won't know if the DDS becomes visible after the handle was\n\t\t * created.\n\t\t *\n\t\t * 2. Handles to root data stores will never know that it was visible because the handle will not be stores in\n\t\t * another DDS and so, attachGraph will never be called on it.\n\t\t */\n\t\treturn this.isAttached || this.locallyVisible;\n\t}\n\n\t/**\n\t * Tracks whether this handle is locally visible in the container.\n\t */\n\tprivate locallyVisible: boolean = false;\n\n\t/**\n\t * Creates a new `FluidObjectHandle`.\n\t *\n\t * @param value - The {@link @fluidframework/core-interfaces#FluidObject} object this handle is for.\n\t * @param path - The path to this handle relative to the `routeContext`.\n\t * @param routeContext - The parent {@link @fluidframework/core-interfaces#IFluidHandleContext} that has a route\n\t * to this handle.\n\t */\n\tconstructor(\n\t\tprotected readonly value: T | Promise<T>,\n\t\tpublic readonly path: string,\n\t\tpublic readonly routeContext: IFluidHandleContext,\n\t) {\n\t\tthis.absolutePath = generateHandleContextPath(path, this.routeContext);\n\t}\n\n\t/**\n\t * {@inheritDoc @fluidframework/core-interfaces#IFluidHandle.get}\n\t */\n\tpublic async get(): Promise<any> {\n\t\t// Note that this return works whether we received a T or a Promise<T> for this.value in the constructor.\n\t\treturn this.value;\n\t}\n\n\t/**\n\t * {@inheritDoc @fluidframework/core-interfaces#IFluidHandle.attachGraph }\n\t */\n\tpublic attachGraph(): void {\n\t\tif (this.visible) {\n\t\t\treturn;\n\t\t}\n\n\t\tthis.locallyVisible = true;\n\t\tthis.pendingHandlesToMakeVisible.forEach((handle) => {\n\t\t\thandle.attachGraph();\n\t\t});\n\t\tthis.pendingHandlesToMakeVisible.clear();\n\t\tthis.routeContext.attachGraph();\n\t}\n\n\t/**\n\t * {@inheritDoc @fluidframework/core-interfaces#IFluidHandle.bind}\n\t */\n\tpublic bind(handle: IFluidHandle) {\n\t\t// If this handle is visible, attach the graph of the incoming handle as well.\n\t\tif (this.visible) {\n\t\t\thandle.attachGraph();\n\t\t\treturn;\n\t\t}\n\t\tthis.pendingHandlesToMakeVisible.add(handle);\n\t}\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/datastore",
-  "version": "2.0.0-dev.7.4.0.215930",
+  "version": "2.0.0-dev.7.4.0.216897",
   "description": "Fluid data store implementation",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -35,17 +35,17 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/container-definitions": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/core-interfaces": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/core-utils": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/datastore-definitions": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/driver-definitions": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/driver-utils": "2.0.0-dev.7.4.0.215930",
+    "@fluid-internal/client-utils": "2.0.0-dev.7.4.0.216897",
+    "@fluidframework/container-definitions": "2.0.0-dev.7.4.0.216897",
+    "@fluidframework/core-interfaces": "2.0.0-dev.7.4.0.216897",
+    "@fluidframework/core-utils": "2.0.0-dev.7.4.0.216897",
+    "@fluidframework/datastore-definitions": "2.0.0-dev.7.4.0.216897",
+    "@fluidframework/driver-definitions": "2.0.0-dev.7.4.0.216897",
+    "@fluidframework/driver-utils": "2.0.0-dev.7.4.0.216897",
     "@fluidframework/protocol-definitions": "^3.0.0",
-    "@fluidframework/runtime-definitions": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/runtime-utils": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/telemetry-utils": "2.0.0-dev.7.4.0.215930",
+    "@fluidframework/runtime-definitions": "2.0.0-dev.7.4.0.216897",
+    "@fluidframework/runtime-utils": "2.0.0-dev.7.4.0.216897",
+    "@fluidframework/telemetry-utils": "2.0.0-dev.7.4.0.216897",
     "lodash": "^4.17.21",
     "uuid": "^9.0.0"
   },
@@ -55,8 +55,8 @@
     "@fluidframework/build-tools": "^0.28.0",
     "@fluidframework/datastore-previous": "npm:@fluidframework/datastore@2.0.0-internal.7.2.0",
     "@fluidframework/eslint-config-fluid": "^3.1.0",
-    "@fluidframework/mocha-test-setup": "2.0.0-dev.7.4.0.215930",
-    "@fluidframework/test-runtime-utils": "2.0.0-dev.7.4.0.215930",
+    "@fluidframework/mocha-test-setup": "2.0.0-dev.7.4.0.216897",
+    "@fluidframework/test-runtime-utils": "2.0.0-dev.7.4.0.216897",
     "@microsoft/api-extractor": "^7.38.3",
     "@types/mocha": "^9.1.1",
     "@types/node": "^16.18.38",
@@ -102,12 +102,13 @@
     "build:docs": "fluid-build . --task api",
     "build:esnext": "tsc --project ./tsconfig.esnext.json",
     "build:test": "tsc --project ./src/test/tsconfig.json",
+    "check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",
     "ci:build:docs": "api-extractor run",
     "clean": "rimraf --glob dist lib \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp nyc",
     "eslint": "eslint --format stylish src",
     "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
     "format": "npm run prettier:fix",
-    "lint": "npm run prettier && npm run eslint",
+    "lint": "npm run prettier && npm run check:release-tags && npm run eslint",
     "lint:fix": "npm run prettier:fix && npm run eslint:fix",
     "prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
     "prettier:fix": "prettier --write . --cache --ignore-path ../../../.prettierignore",

package/src/dataStoreRuntime.ts

@@ -82,7 +82,7 @@ import { RemoteChannelContext } from "./remoteChannelContext";
 import { FluidObjectHandle } from "./fluidHandle";
 
 /**
- * @public
+ * @internal
  */
 export enum DataStoreMessageType {
 	// Creates a new channel
@@ -91,7 +91,7 @@ export enum DataStoreMessageType {
 }
 
 /**
- * @public
+ * @internal
  */
 export interface ISharedObjectRegistry {
 	// TODO consider making this async. A consequence is that either the creation of a distributed data type
@@ -101,8 +101,7 @@ export interface ISharedObjectRegistry {
 
 /**
  * Base data store class
- *
- * @public
+ * @internal
  */
 export class FluidDataStoreRuntime
 	extends TypedEventEmitter<IFluidDataStoreRuntimeEvents>
@@ -1164,8 +1163,7 @@ export class FluidDataStoreRuntime
  * Request handler is only called when data store can't resolve request, i.e. for custom requests.
  * @param Base - base class, inherits from FluidDataStoreRuntime
  * @param requestHandler - request handler to mix in
- *
- * @public
+ * @internal
  */
 export const mixinRequestHandler = (
 	requestHandler: (request: IRequest, runtime: FluidDataStoreRuntime) => Promise<IResponse>,
@@ -1186,8 +1184,7 @@ export const mixinRequestHandler = (
  * @param handler - handler that returns info about blob to be added to summary.
  * Or undefined not to add anything to summary.
  * @param Base - base class, inherits from FluidDataStoreRuntime
- *
- * @public
+ * @internal
  */
 export const mixinSummaryHandler = (
 	handler: (

package/src/fluidHandle.ts

@@ -8,8 +8,7 @@ import { generateHandleContextPath } from "@fluidframework/runtime-utils";
 
 /**
  * Handle for a shared {@link @fluidframework/core-interfaces#FluidObject}.
- *
- * @public
+ * @internal
  */
 export class FluidObjectHandle<T extends FluidObject = FluidObject> implements IFluidHandle {
 	private readonly pendingHandlesToMakeVisible: Set<IFluidHandle> = new Set();