@fluidframework/container-definitions 0.42.0-43895 → 0.43.0

package/api-report/container-definitions.api.md

@@ -6,6 +6,7 @@
 
 import { ConnectionMode } from '@fluidframework/protocol-definitions';
 import { EventEmitter } from 'events';
+import { FluidObject } from '@fluidframework/core-interfaces';
 import { IClient } from '@fluidframework/protocol-definitions';
 import { IClientConfiguration } from '@fluidframework/protocol-definitions';
 import { IClientDetails } from '@fluidframework/protocol-definitions';
@@ -15,15 +16,15 @@ import { IDocumentStorageService } from '@fluidframework/driver-definitions';
 import { IErrorEvent } from '@fluidframework/common-definitions';
 import { IEvent } from '@fluidframework/common-definitions';
 import { IEventProvider } from '@fluidframework/common-definitions';
-import { IFluidCodeDetails } from '@fluidframework/core-interfaces';
+import { IFluidCodeDetails as IFluidCodeDetails_2 } from '@fluidframework/core-interfaces';
 import { IFluidConfiguration } from '@fluidframework/core-interfaces';
 import { IFluidObject } from '@fluidframework/core-interfaces';
-import { IFluidPackage } from '@fluidframework/core-interfaces';
-import { IFluidPackageEnvironment } from '@fluidframework/core-interfaces';
+import { IFluidPackage as IFluidPackage_2 } from '@fluidframework/core-interfaces';
+import { IFluidPackageEnvironment as IFluidPackageEnvironment_2 } from '@fluidframework/core-interfaces';
 import { IFluidResolvedUrl } from '@fluidframework/driver-definitions';
 import { IFluidRouter } from '@fluidframework/core-interfaces';
 import { IPendingProposal } from '@fluidframework/protocol-definitions';
-import { IProvideFluidCodeDetailsComparer } from '@fluidframework/core-interfaces';
+import { IProvideFluidCodeDetailsComparer as IProvideFluidCodeDetailsComparer_2 } from '@fluidframework/core-interfaces';
 import { IQuorum } from '@fluidframework/protocol-definitions';
 import { IRequest } from '@fluidframework/core-interfaces';
 import { IResolvedUrl } from '@fluidframework/driver-definitions';
@@ -34,6 +35,7 @@ import { ISignalMessage } from '@fluidframework/protocol-definitions';
 import { ISnapshotTree } from '@fluidframework/protocol-definitions';
 import { ISummaryTree } from '@fluidframework/protocol-definitions';
 import { ITelemetryBaseLogger } from '@fluidframework/common-definitions';
+import { ITelemetryProperties } from '@fluidframework/common-definitions';
 import { ITokenClaims } from '@fluidframework/protocol-definitions';
 import { ITree } from '@fluidframework/protocol-definitions';
 import { IVersion } from '@fluidframework/protocol-definitions';
@@ -56,6 +58,16 @@ export enum BindState {
     NotBound = "NotBound"
 }
 
+// @public
+export namespace ConnectionState {
+    export type Connected = 2;
+    export type Connecting = 1;
+    export type Disconnected = 0;
+}
+
+// @public
+export type ConnectionState = ConnectionState.Disconnected | ConnectionState.Connecting | ConnectionState.Connected;
+
 // @public
 export enum ContainerErrorType {
     dataCorruptionError = "dataCorruptionError",
@@ -84,9 +96,14 @@ export interface ICodeAllowList {
     testSource(source: IResolvedFluidCodeDetails): Promise<boolean>;
 }
 
+// @public
+export interface ICodeDetailsLoader extends Partial<IProvideFluidCodeDetailsComparer_2> {
+    load(source: IFluidCodeDetails_2): Promise<IFluidModuleWithDetails>;
+}
+
 // @public @deprecated
-export interface ICodeLoader extends Partial<IProvideFluidCodeDetailsComparer> {
-    load(source: IFluidCodeDetails): Promise<IFluidModule>;
+export interface ICodeLoader extends Partial<IProvideFluidCodeDetailsComparer_2> {
+    load(source: IFluidCodeDetails_2): Promise<IFluidModule>;
 }
 
 // @public
@@ -100,8 +117,6 @@ export interface IConnectionDetails {
     existing: boolean;
     // (undocumented)
     initialClients: ISignalClient[];
-    // @deprecated (undocumented)
-    maxMessageSize: number;
     // (undocumented)
     mode: ConnectionMode;
     // (undocumented)
@@ -114,21 +129,33 @@ export interface IConnectionDetails {
 export interface IContainer extends IEventProvider<IContainerEvents>, IFluidRouter {
     attach(request: IRequest): Promise<void>;
     readonly attachState: AttachState;
+    readonly audience?: IAudience;
+    // @alpha
+    readonly clientId?: string | undefined;
     close(error?: ICriticalContainerError): void;
     closeAndGetPendingLocalState(): string;
     readonly closed: boolean;
     // @deprecated
-    readonly codeDetails: IFluidCodeDetails | undefined;
+    readonly codeDetails?: IFluidCodeDetails_2 | undefined;
+    readonly connected?: boolean;
+    readonly connectionState?: ConnectionState;
     deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;
+    // @alpha
+    forceReadonly?(readonly: boolean): any;
     getAbsoluteUrl(relativeUrl: string): Promise<string | undefined>;
-    getLoadedCodeDetails?(): IFluidCodeDetails | undefined;
+    getLoadedCodeDetails?(): IFluidCodeDetails_2 | undefined;
     getQuorum(): IQuorum;
-    getSpecifiedCodeDetails?(): IFluidCodeDetails | undefined;
+    getSpecifiedCodeDetails?(): IFluidCodeDetails_2 | undefined;
     readonly isDirty: boolean;
-    proposeCodeDetails(codeDetails: IFluidCodeDetails): Promise<boolean>;
+    proposeCodeDetails(codeDetails: IFluidCodeDetails_2): Promise<boolean>;
+    readonly readOnlyInfo?: ReadOnlyInfo;
     request(request: IRequest): Promise<IResponse>;
     resolvedUrl: IResolvedUrl | undefined;
+    // @alpha
+    resume?(): void;
     serialize(): string;
+    // @alpha
+    setAutoReconnect?(reconnect: boolean): void;
 }
 
 // @public
@@ -155,6 +182,8 @@ export interface IContainerContext extends IDisposable {
     getAbsoluteUrl?(relativeUrl: string): Promise<string | undefined>;
     // (undocumented)
     getLoadedFromVersion(): IVersion | undefined;
+    // @deprecated (undocumented)
+    getSpecifiedCodeDetails?(): IFluidCodeDetails_2 | undefined;
     // (undocumented)
     readonly id: string;
     // (undocumented)
@@ -169,7 +198,7 @@ export interface IContainerContext extends IDisposable {
     readonly quorum: IQuorum;
     // (undocumented)
     raiseContainerWarning(warning: ContainerWarning): void;
-    readonly scope: IFluidObject;
+    readonly scope: IFluidObject & FluidObject;
     // (undocumented)
     readonly serviceConfiguration: IClientConfiguration | undefined;
     // (undocumented)
@@ -191,9 +220,9 @@ export interface IContainerEvents extends IEvent {
     // (undocumented)
     (event: "connected", listener: (clientId: string) => void): any;
     // (undocumented)
-    (event: "codeDetailsProposed", listener: (codeDetails: IFluidCodeDetails, proposal: IPendingProposal) => void): any;
+    (event: "codeDetailsProposed", listener: (codeDetails: IFluidCodeDetails_2, proposal: IPendingProposal) => void): any;
     // (undocumented)
-    (event: "contextChanged", listener: (codeDetails: IFluidCodeDetails) => void): any;
+    (event: "contextChanged", listener: (codeDetails: IFluidCodeDetails_2) => void): any;
     // (undocumented)
     (event: "disconnected" | "attached", listener: () => void): any;
     // (undocumented)
@@ -287,7 +316,7 @@ export interface IDeltaQueueEvents<T> extends IErrorEvent {
     (event: "idle", listener: (count: number, duration: number) => void): any;
 }
 
-// @public (undocumented)
+// @public @deprecated (undocumented)
 export const IDeltaSender: keyof IProvideDeltaSender;
 
 // @public
@@ -296,44 +325,90 @@ export interface IDeltaSender extends IProvideDeltaSender {
 }
 
 // @public
-export interface IErrorBase {
+export interface IErrorBase extends Partial<Error> {
     readonly errorType: string;
-    // (undocumented)
+    getTelemetryProperties?(): ITelemetryProperties;
     readonly message: string;
+    readonly name?: string;
+    readonly stack?: string;
 }
 
 // @public
-export interface IFluidBrowserPackage extends IFluidPackage {
+export interface IFluidBrowserPackage extends IFluidPackage_2 {
     // (undocumented)
     fluid: {
         browser: IFluidBrowserPackageEnvironment;
-        [environment: string]: IFluidPackageEnvironment;
+        [environment: string]: IFluidPackageEnvironment_2;
     };
 }
 
 // @public
-export interface IFluidBrowserPackageEnvironment extends IFluidPackageEnvironment {
+export interface IFluidBrowserPackageEnvironment extends IFluidPackageEnvironment_2 {
     umd: {
         files: string[];
         library: string;
     };
 }
 
+// @public
+export interface IFluidCodeDetails {
+    readonly config?: IFluidCodeDetailsConfig;
+    readonly package: string | Readonly<IFluidPackage>;
+}
+
+// @public (undocumented)
+export const IFluidCodeDetailsComparer: keyof IProvideFluidCodeDetailsComparer;
+
+// @public
+export interface IFluidCodeDetailsComparer extends IProvideFluidCodeDetailsComparer {
+    compare(a: IFluidCodeDetails, b: IFluidCodeDetails): Promise<number | undefined>;
+    satisfies(candidate: IFluidCodeDetails, constraint: IFluidCodeDetails): Promise<boolean>;
+}
+
+// @public
+export interface IFluidCodeDetailsConfig {
+    // (undocumented)
+    readonly [key: string]: string;
+}
+
 // @public
 export interface IFluidCodeResolver {
-    resolveCodeDetails(details: IFluidCodeDetails): Promise<IResolvedFluidCodeDetails>;
+    resolveCodeDetails(details: IFluidCodeDetails_2): Promise<IResolvedFluidCodeDetails>;
 }
 
 // @public (undocumented)
 export interface IFluidModule {
     // (undocumented)
-    fluidExport: IFluidObject & Partial<Readonly<IProvideFluidCodeDetailsComparer>>;
+    fluidExport: IFluidObject & FluidObject<IRuntimeFactory & IProvideFluidCodeDetailsComparer_2>;
 }
 
-// @public (undocumented)
+// @public
+export interface IFluidModuleWithDetails {
+    details: IFluidCodeDetails_2;
+    module: IFluidModule;
+}
+
+// @public
+export interface IFluidPackage {
+    [key: string]: unknown;
+    fluid: {
+        [environment: string]: undefined | IFluidPackageEnvironment;
+    };
+    name: string;
+}
+
+// @public
+export interface IFluidPackageEnvironment {
+    [target: string]: undefined | {
+        files: string[];
+        [key: string]: unknown;
+    };
+}
+
+// @public @deprecated (undocumented)
 export const IFluidTokenProvider: keyof IProvideFluidTokenProvider;
 
-// @public (undocumented)
+// @public @deprecated (undocumented)
 export interface IFluidTokenProvider extends IProvideFluidTokenProvider {
     // (undocumented)
     intelligence: {
@@ -351,12 +426,12 @@ export interface IGenericError extends IErrorBase {
 
 // @public
 export interface IHostLoader extends ILoader {
-    createDetachedContainer(codeDetails: IFluidCodeDetails): Promise<IContainer>;
+    createDetachedContainer(codeDetails: IFluidCodeDetails_2): Promise<IContainer>;
     rehydrateDetachedContainerFromSnapshot(snapshot: string): Promise<IContainer>;
 }
 
 // @public
-export interface ILoader extends IFluidRouter {
+export interface ILoader extends IFluidRouter, Partial<IProvideLoader> {
     resolve(request: IRequest, pendingLocalState?: string): Promise<IContainer>;
 }
 
@@ -395,18 +470,30 @@ export interface IPendingLocalState {
     url: string;
 }
 
-// @public (undocumented)
+// @public @deprecated (undocumented)
 export interface IProvideDeltaSender {
-    // (undocumented)
+    // @deprecated (undocumented)
     readonly IDeltaSender: IDeltaSender;
 }
 
 // @public (undocumented)
+export interface IProvideFluidCodeDetailsComparer {
+    // (undocumented)
+    readonly IFluidCodeDetailsComparer: IFluidCodeDetailsComparer;
+}
+
+// @public @deprecated (undocumented)
 export interface IProvideFluidTokenProvider {
     // (undocumented)
     readonly IFluidTokenProvider: IFluidTokenProvider;
 }
 
+// @public (undocumented)
+export interface IProvideLoader {
+    // (undocumented)
+    readonly ILoader: ILoader;
+}
+
 // @public (undocumented)
 export interface IProvideRuntimeFactory {
     // (undocumented)
@@ -420,8 +507,8 @@ export interface IProxyLoaderFactory {
 }
 
 // @public
-export interface IResolvedFluidCodeDetails extends IFluidCodeDetails {
-    readonly resolvedPackage: Readonly<IFluidPackage>;
+export interface IResolvedFluidCodeDetails extends IFluidCodeDetails_2 {
+    readonly resolvedPackage: Readonly<IFluidPackage_2>;
     readonly resolvedPackageCacheId: string | undefined;
 }
 
@@ -448,6 +535,12 @@ export interface IRuntimeFactory extends IProvideRuntimeFactory {
 // @public
 export const isFluidBrowserPackage: (maybePkg: any) => maybePkg is Readonly<IFluidBrowserPackage>;
 
+// @public (undocumented)
+export const isFluidCodeDetails: (details: unknown) => details is Readonly<IFluidCodeDetails>;
+
+// @public
+export const isFluidPackage: (pkg: any) => pkg is Readonly<IFluidPackage>;
+
 // @public
 export interface IThrottlingWarning extends IErrorBase {
     // (undocumented)

package/dist/deltas.d.ts

@@ -14,10 +14,6 @@ export interface IConnectionDetails {
     mode: ConnectionMode;
     version: string;
     initialClients: ISignalClient[];
-    /**
-     * @deprecated - please use `serviceConfiguration.maxMessageSize`
-     */
-    maxMessageSize: number;
     serviceConfiguration: IClientConfiguration;
     /**
      * Last known sequence number to ordering service at the time of connection
@@ -42,11 +38,22 @@ export interface IDeltaHandlerStrategy {
     processSignal: (message: ISignalMessage) => void;
 }
 declare module "@fluidframework/core-interfaces" {
-    interface IFluidObject extends Readonly<Partial<IProvideDeltaSender>> {
+    interface IFluidObject {
+        /** @deprecated - use `FluidObject<IDeltaSender>` instead */
+        readonly IDeltaSender?: IDeltaSender;
     }
 }
+/**
+ * @deprecated - This will be removed in a later release.
+ */
 export declare const IDeltaSender: keyof IProvideDeltaSender;
+/**
+ * @deprecated - This will be removed in a later release.
+ */
 export interface IProvideDeltaSender {
+    /**
+     * @deprecated - This will be removed in a later release.
+     */
     readonly IDeltaSender: IDeltaSender;
 }
 /**

package/dist/deltas.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"deltas.d.ts","sourceRoot":"","sources":["../src/deltas.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AACtG,OAAO,EACH,cAAc,EACd,oBAAoB,EACpB,cAAc,EACd,gBAAgB,EAChB,yBAAyB,EACzB,aAAa,EACb,cAAc,EACd,YAAY,EACf,MAAM,sCAAsC,CAAC;AAE9C;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,YAAY,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;IAClB,IAAI,EAAE,cAAc,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,aAAa,EAAE,CAAC;IAChC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB,oBAAoB,EAAE,oBAAoB,CAAC;IAC3C;;;;;;OAMG;IACH,wBAAwB,EAAE,MAAM,GAAG,SAAS,CAAC;CAChD;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC;;OAEG;IACH,OAAO,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,IAAI,CAAC;IAEtD;;OAEG;IACH,aAAa,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,IAAI,CAAC;CACpD;AAED,OAAO,QAAQ,iCAAiC,CAAC;IAE7C,UAAU,YAAa,SAAQ,QAAQ,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;KAAI;CAC5E;AAED,eAAO,MAAM,YAAY,EAAE,MAAM,mBAAoC,CAAC;AAEtE,MAAM,WAAW,mBAAmB;IAChC,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,mBAAmB;IACrD;;OAEG;IACH,KAAK,IAAI,IAAI,CAAC;CACjB;AAED,0CAA0C;AAC1C,MAAM,WAAW,mBAAoB,SAAQ,MAAM;IAC/C,CAAC,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,aAAa,EAAE,GAAG,EAAE,KAAK,IAAI,OAAE;IACjE,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,gBAAgB,KAAK,IAAI,OAAE;IACnE,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,yBAAyB,EAAE,cAAc,EAAE,MAAM,KAAK,IAAI,OAAE;IAC9F,CAAC,KAAK,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAChD,CAAC,KAAK,EAAE,MAAM,GAAG,aAAa,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,OAAE;IACrE;;;OAGG;IACH,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,kBAAkB,EAAE,SAAS,CAAC,EAAE,MAAM,KAAK,IAAI,OAAE;IACxF,CAAC,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,OAAE;IAC1D,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,IAAI,OAAE;CAC9D;AAED;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,EAAE,CAAC,CAAE,SAAQ,cAAc,CAAC,mBAAmB,CAAC,EAAE,YAAY,EAAE,WAAW;IACvG,0CAA0C;IAC1C,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IAEjC,2CAA2C;IAC3C,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC;IAEpC,yCAAyC;IACzC,QAAQ,CAAC,aAAa,EAAE,WAAW,CAAC,cAAc,CAAC,CAAC;IAEpD,0CAA0C;IAC1C,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC;IAEvC,8DAA8D;IAC9D,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAC;IAEpC,sDAAsD;IACtD,QAAQ,CAAC,WAAW,EAAE,yBAAyB,GAAG,SAAS,CAAC;IAE5D,+DAA+D;IAC/D,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAC;IAEpC,oEAAoE;IACpE,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC;IAEvC;;;OAGG;IACH,QAAQ,CAAC,2BAA2B,EAAE,OAAO,CAAC;IAE9C,wBAAwB;IACxB,QAAQ,CAAC,aAAa,EAAE,cAAc,CAAC;IAEvC,kEAAkE;IAClE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB,oDAAoD;IACpD,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAEhC,qDAAqD;IACrD,QAAQ,CAAC,oBAAoB,EAAE,oBAAoB,GAAG,SAAS,CAAC;IAEhE,4DAA4D;IAC5D,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IAEzB;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAE5B,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IAEpC,0CAA0C;IAC1C,KAAK,IAAI,IAAI,CAAC;IAEd,mGAAmG;IACnG,YAAY,CAAC,OAAO,EAAE,GAAG,GAAG,IAAI,CAAC;CACpC;AAED,sCAAsC;AACtC,MAAM,WAAW,iBAAiB,CAAC,CAAC,CAAE,SAAQ,WAAW;IACrD,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,OAAE;IACpD;;;OAGG;IACH,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,IAAI,OAAE;CACxE;AAED;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC,CAAE,SAAQ,cAAc,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,EAAE,WAAW;IACrF;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;OAGG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvB;;OAEG;IACH,MAAM,IAAI,IAAI,CAAC;IAEf;;OAEG;IACH,IAAI,IAAI,CAAC,GAAG,SAAS,CAAC;IAEtB;;OAEG;IACH,OAAO,IAAI,CAAC,EAAE,CAAC;IAEf,sBAAsB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC3C;AAED,oBAAY,YAAY,GAAG;IACvB,QAAQ,CAAC,QAAQ,EAAE,KAAK,GAAG,SAAS,CAAC;CACxC,GAAG;IACA,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC;IACxB,mDAAmD;IACnD,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,4EAA4E;IAC5E,QAAQ,CAAC,WAAW,EAAE,OAAO,GAAG,SAAS,CAAC;IAC1C,gDAAgD;IAChD,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;CACjC,CAAC"}
+{"version":3,"file":"deltas.d.ts","sourceRoot":"","sources":["../src/deltas.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AACtG,OAAO,EACH,cAAc,EACd,oBAAoB,EACpB,cAAc,EACd,gBAAgB,EAChB,yBAAyB,EACzB,aAAa,EACb,cAAc,EACd,YAAY,EACf,MAAM,sCAAsC,CAAC;AAE9C;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,YAAY,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;IAClB,IAAI,EAAE,cAAc,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,aAAa,EAAE,CAAC;IAChC,oBAAoB,EAAE,oBAAoB,CAAC;IAC3C;;;;;;OAMG;IACH,wBAAwB,EAAE,MAAM,GAAG,SAAS,CAAC;CAChD;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC;;OAEG;IACH,OAAO,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,IAAI,CAAC;IAEtD;;OAEG;IACH,aAAa,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,IAAI,CAAC;CACpD;AAED,OAAO,QAAQ,iCAAiC,CAAC;IAC7C,UAAU,YAAY;QAClB,4DAA4D;QAC5D,QAAQ,CAAC,YAAY,CAAC,EAAE,YAAY,CAAA;KACtC;CACL;AAED;;GAEG;AACH,eAAO,MAAM,YAAY,EAAE,MAAM,mBAAoC,CAAC;AAEtE;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,mBAAmB;IACrD;;OAEG;IACH,KAAK,IAAI,IAAI,CAAC;CACjB;AAED,0CAA0C;AAC1C,MAAM,WAAW,mBAAoB,SAAQ,MAAM;IAC/C,CAAC,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,aAAa,EAAE,GAAG,EAAE,KAAK,IAAI,OAAE;IACjE,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,gBAAgB,KAAK,IAAI,OAAE;IACnE,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,yBAAyB,EAAE,cAAc,EAAE,MAAM,KAAK,IAAI,OAAE;IAC9F,CAAC,KAAK,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAChD,CAAC,KAAK,EAAE,MAAM,GAAG,aAAa,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,OAAE;IACrE;;;OAGG;IACH,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,kBAAkB,EAAE,SAAS,CAAC,EAAE,MAAM,KAAK,IAAI,OAAE;IACxF,CAAC,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,OAAE;IAC1D,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,IAAI,OAAE;CAC9D;AAED;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,EAAE,CAAC,CAAE,SAAQ,cAAc,CAAC,mBAAmB,CAAC,EAAE,YAAY,EAAE,WAAW;IACvG,0CAA0C;IAC1C,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IAEjC,2CAA2C;IAC3C,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC;IAEpC,yCAAyC;IACzC,QAAQ,CAAC,aAAa,EAAE,WAAW,CAAC,cAAc,CAAC,CAAC;IAEpD,0CAA0C;IAC1C,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC;IAEvC,8DAA8D;IAC9D,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAC;IAEpC,sDAAsD;IACtD,QAAQ,CAAC,WAAW,EAAE,yBAAyB,GAAG,SAAS,CAAC;IAE5D,+DAA+D;IAC/D,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAC;IAEpC,oEAAoE;IACpE,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC;IAEvC;;;OAGG;IACH,QAAQ,CAAC,2BAA2B,EAAE,OAAO,CAAC;IAE9C,wBAAwB;IACxB,QAAQ,CAAC,aAAa,EAAE,cAAc,CAAC;IAEvC,kEAAkE;IAClE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB,oDAAoD;IACpD,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAEhC,qDAAqD;IACrD,QAAQ,CAAC,oBAAoB,EAAE,oBAAoB,GAAG,SAAS,CAAC;IAEhE,4DAA4D;IAC5D,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IAEzB;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAE5B,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IAEpC,0CAA0C;IAC1C,KAAK,IAAI,IAAI,CAAC;IAEd,mGAAmG;IACnG,YAAY,CAAC,OAAO,EAAE,GAAG,GAAG,IAAI,CAAC;CACpC;AAED,sCAAsC;AACtC,MAAM,WAAW,iBAAiB,CAAC,CAAC,CAAE,SAAQ,WAAW;IACrD,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,OAAE;IACpD;;;OAGG;IACH,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,IAAI,OAAE;CACxE;AAED;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC,CAAE,SAAQ,cAAc,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,EAAE,WAAW;IACrF;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;OAGG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvB;;OAEG;IACH,MAAM,IAAI,IAAI,CAAC;IAEf;;OAEG;IACH,IAAI,IAAI,CAAC,GAAG,SAAS,CAAC;IAEtB;;OAEG;IACH,OAAO,IAAI,CAAC,EAAE,CAAC;IAEf,sBAAsB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC3C;AAED,oBAAY,YAAY,GAAG;IACvB,QAAQ,CAAC,QAAQ,EAAE,KAAK,GAAG,SAAS,CAAC;CACxC,GAAG;IACA,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC;IACxB,mDAAmD;IACnD,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,4EAA4E;IAC5E,QAAQ,CAAC,WAAW,EAAE,OAAO,GAAG,SAAS,CAAC;IAC1C,gDAAgD;IAChD,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;CACjC,CAAC"}

package/dist/deltas.js

@@ -5,5 +5,8 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IDeltaSender = void 0;
+/**
+ * @deprecated - This will be removed in a later release.
+ */
 exports.IDeltaSender = "IDeltaSender";
 //# sourceMappingURL=deltas.js.map

package/dist/deltas.js.map

@@ -1 +1 @@
-{"version":3,"file":"deltas.js","sourceRoot":"","sources":["../src/deltas.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AA2DU,QAAA,YAAY,GAA8B,cAAc,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IDisposable, IEventProvider, IEvent, IErrorEvent } from \"@fluidframework/common-definitions\";\nimport {\n    ConnectionMode,\n    IClientConfiguration,\n    IClientDetails,\n    IDocumentMessage,\n    ISequencedDocumentMessage,\n    ISignalClient,\n    ISignalMessage,\n    ITokenClaims,\n} from \"@fluidframework/protocol-definitions\";\n\n/**\n * Contract representing the result of a newly established connection to the server for syncing deltas\n */\nexport interface IConnectionDetails {\n    clientId: string;\n    claims: ITokenClaims;\n    existing: boolean;\n    mode: ConnectionMode;\n    version: string;\n    initialClients: ISignalClient[];\n    /**\n     * @deprecated - please use `serviceConfiguration.maxMessageSize`\n     */\n    maxMessageSize: number;\n    serviceConfiguration: IClientConfiguration;\n    /**\n     * Last known sequence number to ordering service at the time of connection\n     * It may lap actual last sequence number (quite a bit, if container  is very active).\n     * But it's best information for client to figure out how far it is behind, at least\n     * for \"read\" connections. \"write\" connections may use own \"join\" op to similar information,\n     * that is likely to be more up-to-date.\n     */\n    checkpointSequenceNumber: number | undefined;\n}\n\n/**\n * Interface used to define a strategy for handling incoming delta messages\n */\nexport interface IDeltaHandlerStrategy {\n    /**\n     * Processes the message.\n     */\n    process: (message: ISequencedDocumentMessage) => void;\n\n    /**\n     * Processes the signal.\n     */\n    processSignal: (message: ISignalMessage) => void;\n}\n\ndeclare module \"@fluidframework/core-interfaces\" {\n    // eslint-disable-next-line @typescript-eslint/no-empty-interface\n    interface IFluidObject extends Readonly<Partial<IProvideDeltaSender>> { }\n}\n\nexport const IDeltaSender: keyof IProvideDeltaSender = \"IDeltaSender\";\n\nexport interface IProvideDeltaSender {\n    readonly IDeltaSender: IDeltaSender;\n}\n\n/**\n * Contract supporting delivery of outbound messages to the server\n */\nexport interface IDeltaSender extends IProvideDeltaSender {\n    /**\n     * Flush all pending messages through the outbound queue\n     */\n    flush(): void;\n}\n\n/** Events emitted by the Delta Manager */\nexport interface IDeltaManagerEvents extends IEvent {\n    (event: \"prepareSend\", listener: (messageBuffer: any[]) => void);\n    (event: \"submitOp\", listener: (message: IDocumentMessage) => void);\n    (event: \"op\", listener: (message: ISequencedDocumentMessage, processingTime: number) => void);\n    (event: \"allSentOpsAckd\", listener: () => void);\n    (event: \"pong\" | \"processTime\", listener: (latency: number) => void);\n    /**\n     * The connect event fires once we've received the connect_document_success message from the\n     * server.  This happens prior to the client's join message (if there is a join message).\n     */\n    (event: \"connect\", listener: (details: IConnectionDetails, opsBehind?: number) => void);\n    (event: \"disconnect\", listener: (reason: string) => void);\n    (event: \"readonly\", listener: (readonly: boolean) => void);\n}\n\n/**\n * Manages the transmission of ops between the runtime and storage.\n */\nexport interface IDeltaManager<T, U> extends IEventProvider<IDeltaManagerEvents>, IDeltaSender, IDisposable {\n    /** The queue of inbound delta messages */\n    readonly inbound: IDeltaQueue<T>;\n\n    /** The queue of outbound delta messages */\n    readonly outbound: IDeltaQueue<U[]>;\n\n    /** The queue of inbound delta signals */\n    readonly inboundSignal: IDeltaQueue<ISignalMessage>;\n\n    /** The current minimum sequence number */\n    readonly minimumSequenceNumber: number;\n\n    /** The last sequence number processed by the delta manager */\n    readonly lastSequenceNumber: number;\n\n    /** The last message processed by the delta manager */\n    readonly lastMessage: ISequencedDocumentMessage | undefined;\n\n    /** The latest sequence number the delta manager is aware of */\n    readonly lastKnownSeqNumber: number;\n\n    /** The initial sequence number set when attaching the op handler */\n    readonly initialSequenceNumber: number;\n\n    /**\n     * Tells if  current connection has checkpoint information.\n     * I.e. we know how far behind the client was at the time of establishing connection\n     */\n    readonly hasCheckpointSequenceNumber: boolean;\n\n    /** Details of client */\n    readonly clientDetails: IClientDetails;\n\n    /** Protocol version being used to communicate with the service */\n    readonly version: string;\n\n    /** Max message size allowed to the delta manager */\n    readonly maxMessageSize: number;\n\n    /** Service configuration provided by the service. */\n    readonly serviceConfiguration: IClientConfiguration | undefined;\n\n    /** Flag to indicate whether the client can write or not. */\n    readonly active: boolean;\n\n    /**\n     * Tells if container is in read-only mode.\n     * Data stores should listen for \"readonly\" notifications and disallow user making changes to data stores.\n     * Readonly state can be because of no storage write permission,\n     * or due to host forcing readonly mode for container.\n     *\n     * We do not differentiate here between no write access to storage vs. host disallowing changes to container -\n     * in all cases container runtime and data stores should respect readonly state and not allow local changes.\n     *\n     * It is undefined if we have not yet established websocket connection\n     * and do not know if user has write access to a file.\n     * @deprecated - use readOnlyInfo\n     */\n    readonly readonly?: boolean;\n\n    readonly readOnlyInfo: ReadOnlyInfo;\n\n    /** Terminate the connection to storage */\n    close(): void;\n\n    /** Submit a signal to the service to be broadcast to other connected clients, but not persisted */\n    submitSignal(content: any): void;\n}\n\n/** Events emitted by a Delta Queue */\nexport interface IDeltaQueueEvents<T> extends IErrorEvent {\n    (event: \"push\" | \"op\", listener: (task: T) => void);\n    /**\n     * @param count - number of events (T) processed before becoming idle\n     * @param duration - amount of time it took to process elements (milliseconds).\n     */\n    (event: \"idle\", listener: (count: number, duration: number) => void);\n}\n\n/**\n * Queue of ops to be sent to or processed from storage\n */\nexport interface IDeltaQueue<T> extends IEventProvider<IDeltaQueueEvents<T>>, IDisposable {\n    /**\n     * Flag indicating whether or not the queue was paused\n     */\n    paused: boolean;\n\n    /**\n     * The number of messages remaining in the queue\n     */\n    length: number;\n\n    /**\n     * Flag indicating whether or not the queue is idle\n     */\n    idle: boolean;\n\n    /**\n     * Pauses processing on the queue\n     * @returns A promise which resolves when processing has been paused.\n     */\n    pause(): Promise<void>;\n\n    /**\n     * Resumes processing on the queue\n     */\n    resume(): void;\n\n    /**\n     * Peeks at the next message in the queue\n     */\n    peek(): T | undefined;\n\n    /**\n     * Returns all the items in the queue as an array. Does not remove them from the queue.\n     */\n    toArray(): T[];\n\n    waitTillProcessingDone(): Promise<void>;\n}\n\nexport type ReadOnlyInfo = {\n    readonly readonly: false | undefined;\n} | {\n    readonly readonly: true;\n    /** read-only because forceReadOnly() was called */\n    readonly forced: boolean;\n    /** read-only because client does not have write permissions for document */\n    readonly permissions: boolean | undefined;\n    /** read-only with no delta stream connection */\n    readonly storageOnly: boolean;\n};\n"]}
+{"version":3,"file":"deltas.js","sourceRoot":"","sources":["../src/deltas.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAyDH;;GAEG;AACU,QAAA,YAAY,GAA8B,cAAc,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IDisposable, IEventProvider, IEvent, IErrorEvent } from \"@fluidframework/common-definitions\";\nimport {\n    ConnectionMode,\n    IClientConfiguration,\n    IClientDetails,\n    IDocumentMessage,\n    ISequencedDocumentMessage,\n    ISignalClient,\n    ISignalMessage,\n    ITokenClaims,\n} from \"@fluidframework/protocol-definitions\";\n\n/**\n * Contract representing the result of a newly established connection to the server for syncing deltas\n */\nexport interface IConnectionDetails {\n    clientId: string;\n    claims: ITokenClaims;\n    existing: boolean;\n    mode: ConnectionMode;\n    version: string;\n    initialClients: ISignalClient[];\n    serviceConfiguration: IClientConfiguration;\n    /**\n     * Last known sequence number to ordering service at the time of connection\n     * It may lap actual last sequence number (quite a bit, if container  is very active).\n     * But it's best information for client to figure out how far it is behind, at least\n     * for \"read\" connections. \"write\" connections may use own \"join\" op to similar information,\n     * that is likely to be more up-to-date.\n     */\n    checkpointSequenceNumber: number | undefined;\n}\n\n/**\n * Interface used to define a strategy for handling incoming delta messages\n */\nexport interface IDeltaHandlerStrategy {\n    /**\n     * Processes the message.\n     */\n    process: (message: ISequencedDocumentMessage) => void;\n\n    /**\n     * Processes the signal.\n     */\n    processSignal: (message: ISignalMessage) => void;\n}\n\ndeclare module \"@fluidframework/core-interfaces\" {\n    interface IFluidObject  {\n        /** @deprecated - use `FluidObject<IDeltaSender>` instead */\n        readonly IDeltaSender?: IDeltaSender\n     }\n}\n\n/**\n * @deprecated - This will be removed in a later release.\n */\nexport const IDeltaSender: keyof IProvideDeltaSender = \"IDeltaSender\";\n\n/**\n * @deprecated - This will be removed in a later release.\n */\nexport interface IProvideDeltaSender {\n    /**\n     * @deprecated - This will be removed in a later release.\n     */\n    readonly IDeltaSender: IDeltaSender;\n}\n\n/**\n * Contract supporting delivery of outbound messages to the server\n */\nexport interface IDeltaSender extends IProvideDeltaSender {\n    /**\n     * Flush all pending messages through the outbound queue\n     */\n    flush(): void;\n}\n\n/** Events emitted by the Delta Manager */\nexport interface IDeltaManagerEvents extends IEvent {\n    (event: \"prepareSend\", listener: (messageBuffer: any[]) => void);\n    (event: \"submitOp\", listener: (message: IDocumentMessage) => void);\n    (event: \"op\", listener: (message: ISequencedDocumentMessage, processingTime: number) => void);\n    (event: \"allSentOpsAckd\", listener: () => void);\n    (event: \"pong\" | \"processTime\", listener: (latency: number) => void);\n    /**\n     * The connect event fires once we've received the connect_document_success message from the\n     * server.  This happens prior to the client's join message (if there is a join message).\n     */\n    (event: \"connect\", listener: (details: IConnectionDetails, opsBehind?: number) => void);\n    (event: \"disconnect\", listener: (reason: string) => void);\n    (event: \"readonly\", listener: (readonly: boolean) => void);\n}\n\n/**\n * Manages the transmission of ops between the runtime and storage.\n */\nexport interface IDeltaManager<T, U> extends IEventProvider<IDeltaManagerEvents>, IDeltaSender, IDisposable {\n    /** The queue of inbound delta messages */\n    readonly inbound: IDeltaQueue<T>;\n\n    /** The queue of outbound delta messages */\n    readonly outbound: IDeltaQueue<U[]>;\n\n    /** The queue of inbound delta signals */\n    readonly inboundSignal: IDeltaQueue<ISignalMessage>;\n\n    /** The current minimum sequence number */\n    readonly minimumSequenceNumber: number;\n\n    /** The last sequence number processed by the delta manager */\n    readonly lastSequenceNumber: number;\n\n    /** The last message processed by the delta manager */\n    readonly lastMessage: ISequencedDocumentMessage | undefined;\n\n    /** The latest sequence number the delta manager is aware of */\n    readonly lastKnownSeqNumber: number;\n\n    /** The initial sequence number set when attaching the op handler */\n    readonly initialSequenceNumber: number;\n\n    /**\n     * Tells if  current connection has checkpoint information.\n     * I.e. we know how far behind the client was at the time of establishing connection\n     */\n    readonly hasCheckpointSequenceNumber: boolean;\n\n    /** Details of client */\n    readonly clientDetails: IClientDetails;\n\n    /** Protocol version being used to communicate with the service */\n    readonly version: string;\n\n    /** Max message size allowed to the delta manager */\n    readonly maxMessageSize: number;\n\n    /** Service configuration provided by the service. */\n    readonly serviceConfiguration: IClientConfiguration | undefined;\n\n    /** Flag to indicate whether the client can write or not. */\n    readonly active: boolean;\n\n    /**\n     * Tells if container is in read-only mode.\n     * Data stores should listen for \"readonly\" notifications and disallow user making changes to data stores.\n     * Readonly state can be because of no storage write permission,\n     * or due to host forcing readonly mode for container.\n     *\n     * We do not differentiate here between no write access to storage vs. host disallowing changes to container -\n     * in all cases container runtime and data stores should respect readonly state and not allow local changes.\n     *\n     * It is undefined if we have not yet established websocket connection\n     * and do not know if user has write access to a file.\n     * @deprecated - use readOnlyInfo\n     */\n    readonly readonly?: boolean;\n\n    readonly readOnlyInfo: ReadOnlyInfo;\n\n    /** Terminate the connection to storage */\n    close(): void;\n\n    /** Submit a signal to the service to be broadcast to other connected clients, but not persisted */\n    submitSignal(content: any): void;\n}\n\n/** Events emitted by a Delta Queue */\nexport interface IDeltaQueueEvents<T> extends IErrorEvent {\n    (event: \"push\" | \"op\", listener: (task: T) => void);\n    /**\n     * @param count - number of events (T) processed before becoming idle\n     * @param duration - amount of time it took to process elements (milliseconds).\n     */\n    (event: \"idle\", listener: (count: number, duration: number) => void);\n}\n\n/**\n * Queue of ops to be sent to or processed from storage\n */\nexport interface IDeltaQueue<T> extends IEventProvider<IDeltaQueueEvents<T>>, IDisposable {\n    /**\n     * Flag indicating whether or not the queue was paused\n     */\n    paused: boolean;\n\n    /**\n     * The number of messages remaining in the queue\n     */\n    length: number;\n\n    /**\n     * Flag indicating whether or not the queue is idle\n     */\n    idle: boolean;\n\n    /**\n     * Pauses processing on the queue\n     * @returns A promise which resolves when processing has been paused.\n     */\n    pause(): Promise<void>;\n\n    /**\n     * Resumes processing on the queue\n     */\n    resume(): void;\n\n    /**\n     * Peeks at the next message in the queue\n     */\n    peek(): T | undefined;\n\n    /**\n     * Returns all the items in the queue as an array. Does not remove them from the queue.\n     */\n    toArray(): T[];\n\n    waitTillProcessingDone(): Promise<void>;\n}\n\nexport type ReadOnlyInfo = {\n    readonly readonly: false | undefined;\n} | {\n    readonly readonly: true;\n    /** read-only because forceReadOnly() was called */\n    readonly forced: boolean;\n    /** read-only because client does not have write permissions for document */\n    readonly permissions: boolean | undefined;\n    /** read-only with no delta stream connection */\n    readonly storageOnly: boolean;\n};\n"]}

package/dist/error.d.ts

@@ -2,6 +2,7 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
+import { ITelemetryProperties } from "@fluidframework/common-definitions";
 /**
  * Different error types the Container may report out to the Host
  */
@@ -30,14 +31,29 @@ export declare enum ContainerErrorType {
 /**
  * Base interface for all errors and warnings at container level
  */
-export interface IErrorBase {
+export interface IErrorBase extends Partial<Error> {
     /** errorType is a union of error types from
      * - container
      * - runtime
      * - drivers
      */
     readonly errorType: string;
+    /**
+     * See Error.message
+     * Privacy Note - This is a freeform string that we may not control in all cases (e.g. a dependency throws an error)
+     * If there are known cases where this contains privacy-sensitive data it will be tagged and included in the result
+     * of getTelemetryProperties. When logging, consider fetching it that way rather than straight from this field.
+     */
     readonly message: string;
+    /** See Error.name */
+    readonly name?: string;
+    /** See Error.stack */
+    readonly stack?: string;
+    /**
+     * Returns all properties of this error object that are either safe to log
+     * or explicitly tagged as containing privacy-sensitive data.
+     */
+    getTelemetryProperties?(): ITelemetryProperties;
 }
 /**
  * Represents warnings raised on container.

package/dist/error.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AACH,oBAAY,kBAAkB;IAC1B;;OAEG;IACH,YAAY,iBAAiB;IAE7B;;OAEG;IACH,eAAe,oBAAoB;IAEnC;;OAEG;IACH,mBAAmB,wBAAwB;IAE3C;;OAEG;IACH,mBAAmB,wBAAwB;IAE3C;;OAEG;IACF,UAAU,eAAe;CACzB;AAEL;;GAEG;AACH,MAAM,WAAW,UAAU;IACvB;;;;OAIG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAChD;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;GAEG;AACH,oBAAY,uBAAuB,GAAG,UAAU,CAAC;AAEjD;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,UAAU;IAC7C,QAAQ,CAAC,SAAS,EAAE,kBAAkB,CAAC,YAAY,CAAC;IACpD,KAAK,CAAC,EAAE,GAAG,CAAC;CACf;AAED;;GAEG;AACF,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC5C,QAAQ,CAAC,SAAS,EAAE,kBAAkB,CAAC,UAAU,CAAC;CACrD;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IAClD,QAAQ,CAAC,SAAS,EAAE,kBAAkB,CAAC,eAAe,CAAC;IACvD,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;CACtC"}
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAE1E;;GAEG;AACH,oBAAY,kBAAkB;IAC1B;;OAEG;IACH,YAAY,iBAAiB;IAE7B;;OAEG;IACH,eAAe,oBAAoB;IAEnC;;OAEG;IACH,mBAAmB,wBAAwB;IAE3C;;OAEG;IACH,mBAAmB,wBAAwB;IAE3C;;OAEG;IACF,UAAU,eAAe;CACzB;AAEL;;GAEG;AACH,MAAM,WAAW,UAAW,SAAQ,OAAO,CAAC,KAAK,CAAC;IAC9C;;;;OAIG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,qBAAqB;IACrB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,sBAAsB;IACtB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,sBAAsB,CAAC,IAAI,oBAAoB,CAAC;CACnD;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAChD;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;GAEG;AACH,oBAAY,uBAAuB,GAAG,UAAU,CAAC;AAEjD;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,UAAU;IAC7C,QAAQ,CAAC,SAAS,EAAE,kBAAkB,CAAC,YAAY,CAAC;IACpD,KAAK,CAAC,EAAE,GAAG,CAAC;CACf;AAED;;GAEG;AACF,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC5C,QAAQ,CAAC,SAAS,EAAE,kBAAkB,CAAC,UAAU,CAAC;CACrD;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IAClD,QAAQ,CAAC,SAAS,EAAE,kBAAkB,CAAC,eAAe,CAAC;IACvD,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;CACtC"}

package/dist/error.js.map

@@ -1 +1 @@
-{"version":3,"file":"error.js","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH;;GAEG;AACH,IAAY,kBAyBP;AAzBL,WAAY,kBAAkB;IAC1B;;OAEG;IACH,mDAA6B,CAAA;IAE7B;;OAEG;IACH,yDAAmC,CAAA;IAEnC;;OAEG;IACH,iEAA2C,CAAA;IAE3C;;OAEG;IACH,iEAA2C,CAAA;IAE3C;;OAEG;IACF,+CAAyB,CAAA;AAC1B,CAAC,EAzBO,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAyBzB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Different error types the Container may report out to the Host\n */\nexport enum ContainerErrorType {\n    /**\n     * Some error, most likely an exception caught by runtime and propagated to container as critical error\n     */\n    genericError = \"genericError\",\n\n    /**\n     * Throttling error from server. Server is busy and is asking not to reconnect for some time\n     */\n    throttlingError = \"throttlingError\",\n\n    /**\n     * Data loss error detected by Container / DeltaManager. Likely points to storage issue.\n     */\n    dataCorruptionError = \"dataCorruptionError\",\n\n    /**\n     * Error encountered when processing an operation. May correlate with data corruption.\n     */\n    dataProcessingError = \"dataProcessingError\",\n\n    /**\n     * Error indicating an API is being used improperly resulting in an invalid operation.\n     */\n     usageError = \"usageError\",\n    }\n\n/**\n * Base interface for all errors and warnings at container level\n */\nexport interface IErrorBase {\n    /** errorType is a union of error types from\n     * - container\n     * - runtime\n     * - drivers\n     */\n    readonly errorType: string;\n    readonly message: string;\n}\n\n/**\n * Represents warnings raised on container.\n */\nexport interface ContainerWarning extends IErrorBase {\n    /**\n     * Whether this error has already been logged. Used to avoid logging errors twice.\n     * Default is false.\n     */\n    logged?: boolean;\n}\n\n/**\n * Represents errors raised on container.\n */\nexport type ICriticalContainerError = IErrorBase;\n\n/**\n * Generic wrapper for an unrecognized/uncategorized error object\n */\nexport interface IGenericError extends IErrorBase {\n    readonly errorType: ContainerErrorType.genericError;\n    error?: any;\n}\n\n/**\n * Error indicating an API is being used improperly resulting in an invalid operation.\n */\n export interface IUsageError extends IErrorBase {\n    readonly errorType: ContainerErrorType.usageError;\n}\n\n/**\n * Warning emitted when requests to storage are being throttled\n */\nexport interface IThrottlingWarning extends IErrorBase {\n    readonly errorType: ContainerErrorType.throttlingError;\n    readonly retryAfterSeconds: number;\n}\n"]}
+{"version":3,"file":"error.js","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH;;GAEG;AACH,IAAY,kBAyBP;AAzBL,WAAY,kBAAkB;IAC1B;;OAEG;IACH,mDAA6B,CAAA;IAE7B;;OAEG;IACH,yDAAmC,CAAA;IAEnC;;OAEG;IACH,iEAA2C,CAAA;IAE3C;;OAEG;IACH,iEAA2C,CAAA;IAE3C;;OAEG;IACF,+CAAyB,CAAA;AAC1B,CAAC,EAzBO,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAyBzB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryProperties } from \"@fluidframework/common-definitions\";\n\n/**\n * Different error types the Container may report out to the Host\n */\nexport enum ContainerErrorType {\n    /**\n     * Some error, most likely an exception caught by runtime and propagated to container as critical error\n     */\n    genericError = \"genericError\",\n\n    /**\n     * Throttling error from server. Server is busy and is asking not to reconnect for some time\n     */\n    throttlingError = \"throttlingError\",\n\n    /**\n     * Data loss error detected by Container / DeltaManager. Likely points to storage issue.\n     */\n    dataCorruptionError = \"dataCorruptionError\",\n\n    /**\n     * Error encountered when processing an operation. May correlate with data corruption.\n     */\n    dataProcessingError = \"dataProcessingError\",\n\n    /**\n     * Error indicating an API is being used improperly resulting in an invalid operation.\n     */\n     usageError = \"usageError\",\n    }\n\n/**\n * Base interface for all errors and warnings at container level\n */\nexport interface IErrorBase extends Partial<Error> {\n    /** errorType is a union of error types from\n     * - container\n     * - runtime\n     * - drivers\n     */\n    readonly errorType: string;\n\n    /**\n     * See Error.message\n     * Privacy Note - This is a freeform string that we may not control in all cases (e.g. a dependency throws an error)\n     * If there are known cases where this contains privacy-sensitive data it will be tagged and included in the result\n     * of getTelemetryProperties. When logging, consider fetching it that way rather than straight from this field.\n     */\n    readonly message: string;\n    /** See Error.name */\n    readonly name?: string;\n    /** See Error.stack */\n    readonly stack?: string;\n    /**\n     * Returns all properties of this error object that are either safe to log\n     * or explicitly tagged as containing privacy-sensitive data.\n     */\n    getTelemetryProperties?(): ITelemetryProperties;\n}\n\n/**\n * Represents warnings raised on container.\n */\nexport interface ContainerWarning extends IErrorBase {\n    /**\n     * Whether this error has already been logged. Used to avoid logging errors twice.\n     * Default is false.\n     */\n    logged?: boolean;\n}\n\n/**\n * Represents errors raised on container.\n */\nexport type ICriticalContainerError = IErrorBase;\n\n/**\n * Generic wrapper for an unrecognized/uncategorized error object\n */\nexport interface IGenericError extends IErrorBase {\n    readonly errorType: ContainerErrorType.genericError;\n    error?: any;\n}\n\n/**\n * Error indicating an API is being used improperly resulting in an invalid operation.\n */\n export interface IUsageError extends IErrorBase {\n    readonly errorType: ContainerErrorType.usageError;\n}\n\n/**\n * Warning emitted when requests to storage are being throttled\n */\nexport interface IThrottlingWarning extends IErrorBase {\n    readonly errorType: ContainerErrorType.throttlingError;\n    readonly retryAfterSeconds: number;\n}\n"]}

package/dist/fluidModule.d.ts

@@ -2,8 +2,9 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { IFluidObject, IProvideFluidCodeDetailsComparer } from "@fluidframework/core-interfaces";
+import { FluidObject, IFluidObject, IProvideFluidCodeDetailsComparer } from "@fluidframework/core-interfaces";
+import { IRuntimeFactory } from "./runtime";
 export interface IFluidModule {
-    fluidExport: IFluidObject & Partial<Readonly<IProvideFluidCodeDetailsComparer>>;
+    fluidExport: IFluidObject & FluidObject<IRuntimeFactory & IProvideFluidCodeDetailsComparer>;
 }
 //# sourceMappingURL=fluidModule.d.ts.map

package/dist/fluidModule.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fluidModule.d.ts","sourceRoot":"","sources":["../src/fluidModule.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,gCAAgC,EAAE,MAAM,iCAAiC,CAAC;AAEjG,MAAM,WAAW,YAAY;IACzB,WAAW,EAAE,YAAY,GAAG,OAAO,CAAC,QAAQ,CAAC,gCAAgC,CAAC,CAAC,CAAC;CACnF"}
+{"version":3,"file":"fluidModule.d.ts","sourceRoot":"","sources":["../src/fluidModule.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,gCAAgC,EAAE,MAAM,iCAAiC,CAAC;AAC9G,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAE5C,MAAM,WAAW,YAAY;IACzB,WAAW,EAAE,YAAY,GAAG,WAAW,CAAC,eAAe,GAAG,gCAAgC,CAAC,CAAC;CAC/F"}

package/dist/fluidModule.js.map

@@ -1 +1 @@
-{"version":3,"file":"fluidModule.js","sourceRoot":"","sources":["../src/fluidModule.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IFluidObject, IProvideFluidCodeDetailsComparer } from \"@fluidframework/core-interfaces\";\n\nexport interface IFluidModule {\n    fluidExport: IFluidObject & Partial<Readonly<IProvideFluidCodeDetailsComparer>>;\n}\n"]}
+{"version":3,"file":"fluidModule.js","sourceRoot":"","sources":["../src/fluidModule.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { FluidObject, IFluidObject, IProvideFluidCodeDetailsComparer } from \"@fluidframework/core-interfaces\";\nimport { IRuntimeFactory } from \"./runtime\";\n\nexport interface IFluidModule {\n    fluidExport: IFluidObject & FluidObject<IRuntimeFactory & IProvideFluidCodeDetailsComparer>;\n}\n"]}

package/dist/fluidPackage.d.ts

@@ -0,0 +1,109 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * Specifies an environment on Fluid property of a IFluidPackage
+ */
+export interface IFluidPackageEnvironment {
+    /**
+     * The name of the target. For a browser environment, this could be umd for scripts
+     * or css for styles.
+     */
+    [target: string]: undefined | {
+        /**
+         * List of files for the target. These can be relative or absolute.
+         * The code loader should resolve relative paths, and validate all
+         * full urls.
+         */
+        files: string[];
+        /**
+         * General access for extended fields as specific usages will
+         * likely have additional infornamation like a definition
+         * of Library, the entrypoint for umd packages
+         */
+        [key: string]: unknown;
+    };
+}
+/**
+ * Fluid-specific properties expected on a package to be loaded by the code loader.
+ * While compatible with the npm package format it is not necessary that that package is an
+ * npm package:
+ * {@link https://stackoverflow.com/questions/10065564/add-custom-metadata-or-config-to-package-json-is-it-valid}
+ */
+export interface IFluidPackage {
+    /**
+     * The name of the package that this code represnets
+     */
+    name: string;
+    /**
+     * This object represents the Fluid specific properties of the package
+     */
+    fluid: {
+        /**
+         * The name of the of the environment. This should be something like browser, or node
+         * and contain the necessary targets for loading this code in that environment.
+         */
+        [environment: string]: undefined | IFluidPackageEnvironment;
+    };
+    /**
+     * General access for extended fields as specific usages will
+     * likely have additional infornamation like a definition of
+     * compatible versions, or deployment information like rings or rollouts.
+     */
+    [key: string]: unknown;
+}
+/**
+ * Check if the package.json defines a Fluid package
+ * @param pkg - the package json data to check if it is a Fluid package.
+ */
+export declare const isFluidPackage: (pkg: any) => pkg is Readonly<IFluidPackage>;
+/**
+ * Package manager configuration. Provides a key value mapping of config values
+ */
+export interface IFluidCodeDetailsConfig {
+    readonly [key: string]: string;
+}
+/**
+ * Data structure used to describe the code to load on the Fluid document
+ */
+export interface IFluidCodeDetails {
+    /**
+     * The code package to be used on the Fluid document. This is either the package name which will be loaded
+     * from a package manager. Or the expanded Fluid package.
+     */
+    readonly package: string | Readonly<IFluidPackage>;
+    /**
+     * Configuration details. This includes links to the package manager and base CDNs.
+     */
+    readonly config?: IFluidCodeDetailsConfig;
+}
+export declare const isFluidCodeDetails: (details: unknown) => details is Readonly<IFluidCodeDetails>;
+export declare const IFluidCodeDetailsComparer: keyof IProvideFluidCodeDetailsComparer;
+export interface IProvideFluidCodeDetailsComparer {
+    readonly IFluidCodeDetailsComparer: IFluidCodeDetailsComparer;
+}
+/**
+ * Provides capability to compare Fluid code details.
+ */
+export interface IFluidCodeDetailsComparer extends IProvideFluidCodeDetailsComparer {
+    /**
+     * Determines if the `candidate` code details satisfy the constraints specified in `constraint` code details.
+     *
+     * Similar semantics to:
+     * {@link https://github.com/npm/node-semver#usage}
+     */
+    satisfies(candidate: IFluidCodeDetails, constraint: IFluidCodeDetails): Promise<boolean>;
+    /**
+     * Return a number representing the ascending sort order of the `a` and `b` code details;
+     *      `< 0` if `a < b`.
+     *      `= 0` if `a === b`.
+     *      `> 0` if `a > b`.
+     *      `undefined` if `a` is not comparable to `b`.
+     *
+     * Similar semantics to:
+     * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#Description | Array.sort}
+     */
+    compare(a: IFluidCodeDetails, b: IFluidCodeDetails): Promise<number | undefined>;
+}
+//# sourceMappingURL=fluidPackage.d.ts.map

package/dist/fluidPackage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fluidPackage.d.ts","sourceRoot":"","sources":["../src/fluidPackage.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEF;;GAEG;AACJ,MAAM,WAAW,wBAAwB;IAErC;;;OAGG;IACH,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG;QAC1B;;;;WAIG;QACH,KAAK,EAAE,MAAM,EAAE,CAAC;QAEhB;;;;WAIG;QACH,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KAC1B,CAAA;CACJ;AAED;;;;;GAKG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,KAAK,EAAE;QACH;;;WAGG;QACH,CAAC,WAAW,EAAE,MAAM,GAAI,SAAS,GAAG,wBAAwB,CAAC;KAChE,CAAC;IACF;;;;OAIG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CAC1B;AAED;;;GAGG;AACH,eAAO,MAAM,cAAc,QAAS,GAAG,mCAGF,CAAC;AAEtC;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACpC,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAC9B;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,CAAC;IAEnD;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,uBAAuB,CAAC;CAC7C;AAED,eAAO,MAAM,kBAAkB,YAAa,OAAO,2CAKlD,CAAC;AAEF,eAAO,MAAM,yBAAyB,EAAE,MAAM,gCAA8D,CAAC;AAE7G,MAAM,WAAW,gCAAgC;IAC7C,QAAQ,CAAC,yBAAyB,EAAE,yBAAyB,CAAE;CAClE;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,gCAAgC;IAE/E;;;;;OAKG;IACH,SAAS,CAAC,SAAS,EAAE,iBAAiB,EAAE,UAAU,EAAE,iBAAiB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAGzF;;;;;;;;;OASG;IACH,OAAO,CAAC,CAAC,EAAE,iBAAiB,EAAE,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;CAEpF"}