@fluidframework/container-definitions 0.42.0-43813 → 0.43.0-45414

package/lib/loader.js.map

@@ -1 +1 @@
-{"version":3,"file":"loader.js","sourceRoot":"","sources":["../src/loader.ts"],"names":[],"mappings":"AAAA;;;GAGG;AA+QH;;GAEG;AACH,MAAM,CAAN,IAAY,YAsBX;AAtBD,WAAY,YAAY;IACpB;;OAEG;IACH,qCAAqB,CAAA;IAErB,sDAAsC,CAAA;IAEtC;;OAEG;IACH,qCAAqB,CAAA;IACrB,6CAA6B,CAAA;IAC7B,wDAAwC,CAAA;IAExC;;;;;OAKG;IACH,mCAAmB,CAAA;AACvB,CAAC,EAtBW,YAAY,KAAZ,YAAY,QAsBvB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n    IRequest,\n    IResponse,\n    IFluidRouter,\n    IFluidCodeDetails,\n    IFluidPackage,\n    IProvideFluidCodeDetailsComparer,\n} from \"@fluidframework/core-interfaces\";\nimport {\n    IClientDetails,\n    IDocumentMessage,\n    IPendingProposal,\n    IQuorum,\n    ISequencedDocumentMessage,\n} from \"@fluidframework/protocol-definitions\";\nimport { IResolvedUrl } from \"@fluidframework/driver-definitions\";\nimport { IEvent, IEventProvider } from \"@fluidframework/common-definitions\";\nimport { IDeltaManager } from \"./deltas\";\nimport { ICriticalContainerError, ContainerWarning } from \"./error\";\nimport { IFluidModule } from \"./fluidModule\";\nimport { AttachState } from \"./runtime\";\n\n/**\n * Code loading interface\n *\n * @deprecated in favor of {@link @fluidframework/container-loader#ICodeDetailsLoader}\n */\nexport interface ICodeLoader extends Partial<IProvideFluidCodeDetailsComparer> {\n    /**\n     * Loads the package specified by code details and returns a promise to its entry point exports.\n     */\n    load(source: IFluidCodeDetails): Promise<IFluidModule>;\n}\n\n/**\n* The interface returned from a IFluidCodeResolver which represents IFluidCodeDetails\n * that have been resolved and are ready to load\n */\nexport interface IResolvedFluidCodeDetails extends IFluidCodeDetails {\n    /**\n     * A resolved version of the Fluid package. All Fluid browser file entries should be absolute urls.\n     */\n    readonly resolvedPackage: Readonly<IFluidPackage>;\n    /**\n     * If not undefined, this id will be used to cache the entry point for the code package\n     */\n    readonly resolvedPackageCacheId: string | undefined;\n}\n\n/**\n * Fluid code resolvers take a Fluid code details, and resolve the\n * full Fluid package including absolute urls for the browser file entries.\n * The Fluid code resolver is coupled to a specific cdn and knows how to resolve\n * the code detail for loading from that cdn. This include resolving to the most recent\n * version of package that supports the provided code details.\n */\nexport interface IFluidCodeResolver {\n    /**\n     * Resolves a Fluid code details into a form that can be loaded\n     * @param details - The Fluid code details to resolve\n     * @returns - A IResolvedFluidCodeDetails where the\n     *            resolvedPackage's Fluid file entries are absolute urls, and\n     *            an optional resolvedPackageCacheId if the loaded package should be\n     *            cached.\n     */\n    resolveCodeDetails(details: IFluidCodeDetails): Promise<IResolvedFluidCodeDetails>;\n}\n\n/**\n * Code AllowListing Interface\n */\nexport interface ICodeAllowList {\n    testSource(source: IResolvedFluidCodeDetails): Promise<boolean>;\n}\n\n/**\n * Events emitted by the Container \"upwards\" to the Loader and Host\n */\nexport interface IContainerEvents extends IEvent {\n    (event: \"readonly\", listener: (readonly: boolean) => void): void;\n    (event: \"connected\", listener: (clientId: string) => void);\n    (event: \"codeDetailsProposed\", listener: (codeDetails: IFluidCodeDetails, proposal: IPendingProposal) => void);\n    (event: \"contextChanged\", listener: (codeDetails: IFluidCodeDetails) => void);\n    (event: \"disconnected\" | \"attached\", listener: () => void);\n    (event: \"closed\", listener: (error?: ICriticalContainerError) => void);\n    (event: \"warning\", listener: (error: ContainerWarning) => void);\n    (event: \"op\", listener: (message: ISequencedDocumentMessage) => void);\n    (event: \"dirty\" | \"saved\", listener: (dirty: boolean) => void);\n}\n\n/**\n * The Host's view of the Container and its connection to storage\n */\nexport interface IContainer extends IEventProvider<IContainerEvents>, IFluidRouter {\n\n    /**\n     * The Delta Manager supporting the op stream for this Container\n     */\n    deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;\n\n    /**\n     * The collection of write clients which were connected as of the current sequence number.\n     * Also contains a map of key-value pairs that must be agreed upon by all clients before being accepted.\n     */\n    getQuorum(): IQuorum;\n\n    /**\n     * Represents the resolved url to the Container\n     */\n    resolvedUrl: IResolvedUrl | undefined;\n\n    /**\n     * Indicates the attachment state of the container to a host service.\n     */\n    readonly attachState: AttachState;\n\n    /**\n     * The current code details for the container's runtime\n     * @deprecated use getSpecifiedCodeDetails for the code details currently specified for this container, or\n     * getLoadedCodeDetails for the code details that the container's context was loaded with.\n     * To be removed after getSpecifiedCodeDetails and getLoadedCodeDetails become ubiquitous.\n     */\n    readonly codeDetails: IFluidCodeDetails | undefined;\n\n    /**\n     * Get the code details that are currently specified for the container.\n     * @returns The current code details if any are specified, undefined if none are specified.\n     */\n    getSpecifiedCodeDetails?(): IFluidCodeDetails | undefined;\n\n    /**\n     * Get the code details that were used to load the container.\n     * @returns The code details that were used to load the container if it is loaded, undefined if it is not yet\n     * loaded.\n     */\n    getLoadedCodeDetails?(): IFluidCodeDetails | undefined;\n\n    /**\n     * Returns true if the container has been closed, otherwise false\n     */\n    readonly closed: boolean;\n\n    /**\n     * Returns true if the container is dirty, i.e. there are user changes that has not been saved\n     * Closing container in this state results in data loss for user.\n     * Container usually gets into this situation due to loss of connectivity.\n     */\n    readonly isDirty: boolean;\n\n    /**\n     * Closes the container\n     */\n    close(error?: ICriticalContainerError): void;\n\n    /**\n     * Closes the container and returns serialized local state intended to be\n     * given to a newly loaded container\n     */\n    closeAndGetPendingLocalState(): string;\n\n    /**\n     * Propose new code details that define the code to be loaded\n     * for this container's runtime. The returned promise will\n     * be true when the proposal is accepted, and false if\n     * the proposal is rejected.\n     */\n    proposeCodeDetails(codeDetails: IFluidCodeDetails): Promise<boolean>\n\n    /**\n     * Attaches the Container to the Container specified by the given Request.\n     *\n     * TODO - in the case of failure options should give a retry policy. Or some continuation function\n     * that allows attachment to a secondary document.\n     */\n    attach(request: IRequest): Promise<void>;\n\n    /**\n     * Extract the snapshot from the detached container.\n     */\n    serialize(): string;\n\n    /**\n     * Get an absolute url for a provided container-relative request url.\n     * If the container is not attached, this will return undefined.\n     *\n     * @param relativeUrl - A container-relative request URL\n     */\n    getAbsoluteUrl(relativeUrl: string): Promise<string | undefined>;\n\n    /**\n     * Issue a request against the container for a resource.\n     * @param request - The request to be issued against the container\n     */\n    request(request: IRequest): Promise<IResponse>;\n}\n\n/**\n * The Runtime's view of the Loader, used for loading Containers\n */\nexport interface ILoader extends IFluidRouter {\n    /**\n     * Resolves the resource specified by the URL + headers contained in the request object\n     * to the underlying container that will resolve the request.\n     *\n     * An analogy for this is resolve is a DNS resolve of a Fluid container. Request then executes\n     * a request against the server found from the resolve step.\n     */\n    resolve(request: IRequest, pendingLocalState?: string): Promise<IContainer>;\n}\n\n/**\n * The Host's view of the Loader, used for loading Containers\n */\nexport interface IHostLoader extends ILoader {\n    /**\n     * Creates a new container using the specified chaincode but in an unattached state. While unattached all\n     * updates will only be local until the user explicitly attaches the container to a service provider.\n     */\n    createDetachedContainer(codeDetails: IFluidCodeDetails): Promise<IContainer>;\n\n    /**\n     * Creates a new container using the specified snapshot but in an unattached state. While unattached all\n     * updates will only be local until the user explicitly attaches the container to a service provider.\n     */\n    rehydrateDetachedContainerFromSnapshot(snapshot: string): Promise<IContainer>;\n}\n\nexport type ILoaderOptions = {\n    [key in string | number]: any;\n} & {\n    /**\n     * Set caching behavior for the loader.  If true, we will load a container from cache if one\n     * with the same id/version exists or create a new container and cache it if it does not. If\n     * false, always load a new container and don't cache it. If the container has already been\n     * closed, it will not be cached.  A cache option in the LoaderHeader for an individual\n     * request will override the Loader's value.\n     * Defaults to true.\n     */\n    cache?: boolean;\n\n    /**\n     * Provide the current Loader through the scope object when creating Containers.  It is added\n     * as the `ILoader` property, and will overwrite an existing property of the same name on the\n     * scope.  Useful for when the host wants to provide the current Loader's functionality to\n     * individual Data Stores, which is typically expected when creating with a Loader.\n     * Defaults to true.\n     */\n    provideScopeLoader?: boolean;\n\n    // Below two are the options based on which we decide how often client needs to send noops in case of active\n    // connection which is not sending any op. The end result is the \"AND\" of these 2 options. So the client\n    // should hit the min time and count to send the noop.\n    /**\n     * Set min time(in ms) frequency with which noops would be sent in case of active connection which is\n     * not sending any op.\n     */\n    noopTimeFrequency?: number;\n\n    /**\n     * Set min op frequency with which noops would be sent in case of active connection which is not sending any op.\n     */\n    noopCountFrequency?: number;\n\n    /**\n     * Max time(in ms) container will wait for a leave message of a disconnected client.\n    */\n    maxClientLeaveWaitTime?: number,\n};\n\n/**\n * Accepted header keys for requests coming to the Loader\n */\nexport enum LoaderHeader {\n    /**\n     * Override the Loader's default caching behavior for this container.\n     */\n    cache = \"fluid-cache\",\n\n    clientDetails = \"fluid-client-details\",\n\n    /**\n     * Start the container in a paused, unconnected state. Defaults to false\n     */\n    loadMode = \"loadMode\",\n    reconnect = \"fluid-reconnect\",\n    sequenceNumber = \"fluid-sequence-number\",\n\n    /**\n     * One of the following:\n     * null or \"null\": use ops, no snapshots\n     * undefined: fetch latest snapshot\n     * otherwise, version sha to load snapshot\n     */\n    version = \"version\",\n}\n\nexport interface IContainerLoadMode {\n    opsBeforeReturn?:\n        /*\n         * No trailing ops are applied before container is returned.\n         * Default value.\n         */\n        | undefined\n        /*\n         * Only cached trailing ops are applied before returning container.\n         * Caching is optional and could be implemented by the driver.\n         * If driver does not implement any kind of local caching strategy, this is same as above.\n         * Driver may cache a lot of ops, so care needs to be exercised (see below).\n         */\n        | \"cached\"\n        /*\n         * All trailing ops in storage are fetched and applied before container is returned\n         * This mode might have significant impact on boot speed (depends on storage perf characteristics)\n         * Also there might be a lot of trailing ops and applying them might take time, so hosts are\n         * recommended to have some progress UX / cancellation built into loading flow when using this option.\n         */\n        | \"all\"\n    deltaConnection?:\n        /*\n         * Connection to delta stream is made only when Container.resume() call is made. Op processing\n         * is paused (when container is returned from Loader.resolve()) until Container.resume() call is made.\n         */\n        | \"none\"\n        /*\n         * Connection to delta stream is made only when Container.resume() call is made.\n         * Op fetching from storage is performed and ops are applied as they come in.\n         * This is useful option if connection to delta stream is expensive and thus it's beneficial to move it\n         * out from critical boot sequence, but it's beneficial to allow catch up to happen as fast as possible.\n         */\n        | \"delayed\"\n        /*\n         * Connection to delta stream is made right away.\n         * Ops processing is enabled and ops are flowing through the system.\n         * Default value.\n         */\n        | undefined\n}\n\n/**\n * Set of Request Headers that the Loader understands and may inspect or modify\n */\nexport interface ILoaderHeader {\n    [LoaderHeader.cache]: boolean;\n    [LoaderHeader.clientDetails]: IClientDetails;\n    [LoaderHeader.loadMode]: IContainerLoadMode;\n    [LoaderHeader.sequenceNumber]: number;\n    [LoaderHeader.reconnect]: boolean;\n    [LoaderHeader.version]: string | undefined;\n}\n\ninterface IProvideLoader {\n    readonly ILoader: ILoader;\n}\n\ndeclare module \"@fluidframework/core-interfaces\" {\n    // eslint-disable-next-line @typescript-eslint/no-empty-interface\n    export interface IRequestHeader extends Partial<ILoaderHeader> { }\n\n    // eslint-disable-next-line @typescript-eslint/no-empty-interface\n    export interface IFluidObject extends Readonly<Partial<IProvideLoader>> { }\n}\n\nexport interface IPendingLocalState {\n    url: string;\n    pendingRuntimeState: unknown;\n}\n"]}
+{"version":3,"file":"loader.js","sourceRoot":"","sources":["../src/loader.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAmWH;;GAEG;AACH,MAAM,CAAN,IAAY,YAsBX;AAtBD,WAAY,YAAY;IACpB;;OAEG;IACH,qCAAqB,CAAA;IAErB,sDAAsC,CAAA;IAEtC;;OAEG;IACH,qCAAqB,CAAA;IACrB,6CAA6B,CAAA;IAC7B,wDAAwC,CAAA;IAExC;;;;;OAKG;IACH,mCAAmB,CAAA;AACvB,CAAC,EAtBW,YAAY,KAAZ,YAAY,QAsBvB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n    IRequest,\n    IResponse,\n    IFluidRouter,\n    IFluidCodeDetails,\n    IFluidPackage,\n    IProvideFluidCodeDetailsComparer,\n} from \"@fluidframework/core-interfaces\";\nimport {\n    IClientDetails,\n    IDocumentMessage,\n    IPendingProposal,\n    IQuorum,\n    ISequencedDocumentMessage,\n} from \"@fluidframework/protocol-definitions\";\nimport { IResolvedUrl } from \"@fluidframework/driver-definitions\";\nimport { IEvent, IEventProvider } from \"@fluidframework/common-definitions\";\nimport { IAudience } from \"./audience\";\nimport { IDeltaManager, ReadOnlyInfo } from \"./deltas\";\nimport { ICriticalContainerError, ContainerWarning } from \"./error\";\nimport { IFluidModule } from \"./fluidModule\";\nimport { AttachState } from \"./runtime\";\n\n/**\n * Code loading interface\n *\n * @deprecated in favor of {@link @fluidframework/container-loader#ICodeDetailsLoader}\n */\nexport interface ICodeLoader extends Partial<IProvideFluidCodeDetailsComparer> {\n    /**\n     * Loads the package specified by code details and returns a promise to its entry point exports.\n     */\n    load(source: IFluidCodeDetails): Promise<IFluidModule>;\n}\n\n/**\n* The interface returned from a IFluidCodeResolver which represents IFluidCodeDetails\n * that have been resolved and are ready to load\n */\nexport interface IResolvedFluidCodeDetails extends IFluidCodeDetails {\n    /**\n     * A resolved version of the Fluid package. All Fluid browser file entries should be absolute urls.\n     */\n    readonly resolvedPackage: Readonly<IFluidPackage>;\n    /**\n     * If not undefined, this id will be used to cache the entry point for the code package\n     */\n    readonly resolvedPackageCacheId: string | undefined;\n}\n\n/**\n * Fluid code resolvers take a Fluid code details, and resolve the\n * full Fluid package including absolute urls for the browser file entries.\n * The Fluid code resolver is coupled to a specific cdn and knows how to resolve\n * the code detail for loading from that cdn. This include resolving to the most recent\n * version of package that supports the provided code details.\n */\nexport interface IFluidCodeResolver {\n    /**\n     * Resolves a Fluid code details into a form that can be loaded\n     * @param details - The Fluid code details to resolve\n     * @returns - A IResolvedFluidCodeDetails where the\n     *            resolvedPackage's Fluid file entries are absolute urls, and\n     *            an optional resolvedPackageCacheId if the loaded package should be\n     *            cached.\n     */\n    resolveCodeDetails(details: IFluidCodeDetails): Promise<IResolvedFluidCodeDetails>;\n}\n\n/**\n * Code AllowListing Interface\n */\nexport interface ICodeAllowList {\n    testSource(source: IResolvedFluidCodeDetails): Promise<boolean>;\n}\n\n/**\n * Events emitted by the Container \"upwards\" to the Loader and Host\n */\nexport interface IContainerEvents extends IEvent {\n    (event: \"readonly\", listener: (readonly: boolean) => void): void;\n    (event: \"connected\", listener: (clientId: string) => void);\n    (event: \"codeDetailsProposed\", listener: (codeDetails: IFluidCodeDetails, proposal: IPendingProposal) => void);\n    (event: \"contextChanged\", listener: (codeDetails: IFluidCodeDetails) => void);\n    (event: \"disconnected\" | \"attached\", listener: () => void);\n    (event: \"closed\", listener: (error?: ICriticalContainerError) => void);\n    (event: \"warning\", listener: (error: ContainerWarning) => void);\n    (event: \"op\", listener: (message: ISequencedDocumentMessage) => void);\n    (event: \"dirty\" | \"saved\", listener: (dirty: boolean) => void);\n}\n\n/**\n * Namespace for the different connection states a container can be in\n */\nexport namespace ConnectionState {\n    /**\n     * The document is no longer connected to the delta server\n     */\n    export type Disconnected = 0;\n\n    /**\n     * The document has an inbound connection but is still pending for outbound deltas\n     */\n    export type Connecting = 1;\n\n    /**\n     * The document is fully connected\n     */\n     export type Connected = 2;\n}\n\n/**\n * Type defining the different states of connectivity a container can be in\n */\nexport type ConnectionState = ConnectionState.Disconnected | ConnectionState.Connecting | ConnectionState.Connected;\n\n/**\n * The Host's view of the Container and its connection to storage\n */\nexport interface IContainer extends IEventProvider<IContainerEvents>, IFluidRouter {\n\n    /**\n     * The Delta Manager supporting the op stream for this Container\n     */\n    deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;\n\n    /**\n     * The collection of write clients which were connected as of the current sequence number.\n     * Also contains a map of key-value pairs that must be agreed upon by all clients before being accepted.\n     */\n    getQuorum(): IQuorum;\n\n    /**\n     * Represents the resolved url to the Container\n     */\n    resolvedUrl: IResolvedUrl | undefined;\n\n    /**\n     * Indicates the attachment state of the container to a host service.\n     */\n    readonly attachState: AttachState;\n\n    /**\n     * The current code details for the container's runtime\n     * @deprecated use getSpecifiedCodeDetails for the code details currently specified for this container, or\n     * getLoadedCodeDetails for the code details that the container's context was loaded with.\n     * To be removed after getSpecifiedCodeDetails and getLoadedCodeDetails become ubiquitous.\n     * This is now marked as optional and due to be removed in next release.\n     */\n    readonly codeDetails?: IFluidCodeDetails | undefined;\n\n    /**\n     * Get the code details that are currently specified for the container.\n     * @returns The current code details if any are specified, undefined if none are specified.\n     */\n    getSpecifiedCodeDetails?(): IFluidCodeDetails | undefined;\n\n    /**\n     * Get the code details that were used to load the container.\n     * @returns The code details that were used to load the container if it is loaded, undefined if it is not yet\n     * loaded.\n     */\n    getLoadedCodeDetails?(): IFluidCodeDetails | undefined;\n\n    /**\n     * Returns true if the container has been closed, otherwise false\n     */\n    readonly closed: boolean;\n\n    /**\n     * Returns true if the container is dirty, i.e. there are user changes that has not been saved\n     * Closing container in this state results in data loss for user.\n     * Container usually gets into this situation due to loss of connectivity.\n     */\n    readonly isDirty: boolean;\n\n    /**\n     * Closes the container\n     */\n    close(error?: ICriticalContainerError): void;\n\n    /**\n     * Closes the container and returns serialized local state intended to be\n     * given to a newly loaded container\n     */\n    closeAndGetPendingLocalState(): string;\n\n    /**\n     * Propose new code details that define the code to be loaded\n     * for this container's runtime. The returned promise will\n     * be true when the proposal is accepted, and false if\n     * the proposal is rejected.\n     */\n    proposeCodeDetails(codeDetails: IFluidCodeDetails): Promise<boolean>\n\n    /**\n     * Attaches the Container to the Container specified by the given Request.\n     *\n     * TODO - in the case of failure options should give a retry policy. Or some continuation function\n     * that allows attachment to a secondary document.\n     */\n    attach(request: IRequest): Promise<void>;\n\n    /**\n     * Extract the snapshot from the detached container.\n     */\n    serialize(): string;\n\n    /**\n     * Get an absolute url for a provided container-relative request url.\n     * If the container is not attached, this will return undefined.\n     *\n     * @param relativeUrl - A container-relative request URL\n     */\n    getAbsoluteUrl(relativeUrl: string): Promise<string | undefined>;\n\n    /**\n     * Issue a request against the container for a resource.\n     * @param request - The request to be issued against the container\n     */\n    request(request: IRequest): Promise<IResponse>;\n\n    /**\n     * Provides the current connected state of the container\n     */\n    readonly connectionState?: ConnectionState;\n\n    /**\n     * Boolean indicating whether the container is currently connected or not\n     */\n    readonly connected?: boolean;\n\n    /**\n     * Dictates whether or not the current container will automatically attempt to reconnect to the delta stream\n     * after receiving a disconnect event\n     * @param reconnect - Boolean indicating if reconnect should automatically occur\n     * @alpha\n     */\n    setAutoReconnect?(reconnect: boolean): void;\n\n    /**\n     * Have the container attempt to resume processing ops\n     * @alpha\n     */\n    resume?(): void;\n\n    /**\n     * The audience information for all clients currently associated with the document in the current session\n     */\n    readonly audience?: IAudience;\n\n    /**\n     * The server provided ID of the client.\n     * Set once this.connected is true, otherwise undefined\n     * @alpha\n     */\n    readonly clientId?: string | undefined;\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     */\n    readonly readOnlyInfo?: ReadOnlyInfo;\n\n    /**\n     * Allows the host to have the container force to be in read-only mode\n     * @param readonly - Boolean that toggles if read-only policies will be enforced\n     * @alpha\n     */\n    forceReadonly?(readonly: boolean);\n}\n\n/**\n * The Runtime's view of the Loader, used for loading Containers\n */\nexport interface ILoader extends IFluidRouter, Partial<IProvideLoader> {\n    /**\n     * Resolves the resource specified by the URL + headers contained in the request object\n     * to the underlying container that will resolve the request.\n     *\n     * An analogy for this is resolve is a DNS resolve of a Fluid container. Request then executes\n     * a request against the server found from the resolve step.\n     */\n    resolve(request: IRequest, pendingLocalState?: string): Promise<IContainer>;\n}\n\n/**\n * The Host's view of the Loader, used for loading Containers\n */\nexport interface IHostLoader extends ILoader {\n    /**\n     * Creates a new container using the specified chaincode but in an unattached state. While unattached all\n     * updates will only be local until the user explicitly attaches the container to a service provider.\n     */\n    createDetachedContainer(codeDetails: IFluidCodeDetails): Promise<IContainer>;\n\n    /**\n     * Creates a new container using the specified snapshot but in an unattached state. While unattached all\n     * updates will only be local until the user explicitly attaches the container to a service provider.\n     */\n    rehydrateDetachedContainerFromSnapshot(snapshot: string): Promise<IContainer>;\n}\n\nexport type ILoaderOptions = {\n    [key in string | number]: any;\n} & {\n    /**\n     * Set caching behavior for the loader.  If true, we will load a container from cache if one\n     * with the same id/version exists or create a new container and cache it if it does not. If\n     * false, always load a new container and don't cache it. If the container has already been\n     * closed, it will not be cached.  A cache option in the LoaderHeader for an individual\n     * request will override the Loader's value.\n     * Defaults to true.\n     */\n    cache?: boolean;\n\n    /**\n     * Provide the current Loader through the scope object when creating Containers.  It is added\n     * as the `ILoader` property, and will overwrite an existing property of the same name on the\n     * scope.  Useful for when the host wants to provide the current Loader's functionality to\n     * individual Data Stores, which is typically expected when creating with a Loader.\n     * Defaults to true.\n     */\n    provideScopeLoader?: boolean;\n\n    // Below two are the options based on which we decide how often client needs to send noops in case of active\n    // connection which is not sending any op. The end result is the \"AND\" of these 2 options. So the client\n    // should hit the min time and count to send the noop.\n    /**\n     * Set min time(in ms) frequency with which noops would be sent in case of active connection which is\n     * not sending any op.\n     */\n    noopTimeFrequency?: number;\n\n    /**\n     * Set min op frequency with which noops would be sent in case of active connection which is not sending any op.\n     */\n    noopCountFrequency?: number;\n\n    /**\n     * Max time(in ms) container will wait for a leave message of a disconnected client.\n    */\n    maxClientLeaveWaitTime?: number,\n};\n\n/**\n * Accepted header keys for requests coming to the Loader\n */\nexport enum LoaderHeader {\n    /**\n     * Override the Loader's default caching behavior for this container.\n     */\n    cache = \"fluid-cache\",\n\n    clientDetails = \"fluid-client-details\",\n\n    /**\n     * Start the container in a paused, unconnected state. Defaults to false\n     */\n    loadMode = \"loadMode\",\n    reconnect = \"fluid-reconnect\",\n    sequenceNumber = \"fluid-sequence-number\",\n\n    /**\n     * One of the following:\n     * null or \"null\": use ops, no snapshots\n     * undefined: fetch latest snapshot\n     * otherwise, version sha to load snapshot\n     */\n    version = \"version\",\n}\n\nexport interface IContainerLoadMode {\n    opsBeforeReturn?:\n        /*\n         * No trailing ops are applied before container is returned.\n         * Default value.\n         */\n        | undefined\n        /*\n         * Only cached trailing ops are applied before returning container.\n         * Caching is optional and could be implemented by the driver.\n         * If driver does not implement any kind of local caching strategy, this is same as above.\n         * Driver may cache a lot of ops, so care needs to be exercised (see below).\n         */\n        | \"cached\"\n        /*\n         * All trailing ops in storage are fetched and applied before container is returned\n         * This mode might have significant impact on boot speed (depends on storage perf characteristics)\n         * Also there might be a lot of trailing ops and applying them might take time, so hosts are\n         * recommended to have some progress UX / cancellation built into loading flow when using this option.\n         */\n        | \"all\"\n    deltaConnection?:\n        /*\n         * Connection to delta stream is made only when Container.resume() call is made. Op processing\n         * is paused (when container is returned from Loader.resolve()) until Container.resume() call is made.\n         */\n        | \"none\"\n        /*\n         * Connection to delta stream is made only when Container.resume() call is made.\n         * Op fetching from storage is performed and ops are applied as they come in.\n         * This is useful option if connection to delta stream is expensive and thus it's beneficial to move it\n         * out from critical boot sequence, but it's beneficial to allow catch up to happen as fast as possible.\n         */\n        | \"delayed\"\n        /*\n         * Connection to delta stream is made right away.\n         * Ops processing is enabled and ops are flowing through the system.\n         * Default value.\n         */\n        | undefined\n}\n\n/**\n * Set of Request Headers that the Loader understands and may inspect or modify\n */\nexport interface ILoaderHeader {\n    [LoaderHeader.cache]: boolean;\n    [LoaderHeader.clientDetails]: IClientDetails;\n    [LoaderHeader.loadMode]: IContainerLoadMode;\n    [LoaderHeader.sequenceNumber]: number;\n    [LoaderHeader.reconnect]: boolean;\n    [LoaderHeader.version]: string | undefined;\n}\n\nexport interface IProvideLoader {\n    readonly ILoader: ILoader;\n}\n\ndeclare module \"@fluidframework/core-interfaces\" {\n    // eslint-disable-next-line @typescript-eslint/no-empty-interface\n    export interface IRequestHeader extends Partial<ILoaderHeader> { }\n\n    export interface IFluidObject  {\n        /**\n         * @deprecated - use `FluidObject<ILoader>` instead\n         */\n        readonly ILoader?: ILoader;\n    }\n}\n\nexport interface IPendingLocalState {\n    url: string;\n    pendingRuntimeState: unknown;\n}\n"]}

package/lib/runtime.d.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 import { ITelemetryBaseLogger, IDisposable } from "@fluidframework/common-definitions";
-import { IFluidObject, IFluidConfiguration, IRequest, IResponse } from "@fluidframework/core-interfaces";
+import { IFluidObject, IFluidConfiguration, IRequest, IResponse, FluidObject } from "@fluidframework/core-interfaces";
 import { IDocumentStorageService } from "@fluidframework/driver-definitions";
 import { IClientConfiguration, IClientDetails, IQuorum, ISequencedDocumentMessage, ISnapshotTree, ITree, MessageType, ISummaryTree, IVersion, IDocumentMessage } from "@fluidframework/protocol-definitions";
 import { IAudience } from "./audience";
@@ -116,7 +116,7 @@ export interface IContainerContext extends IDisposable {
     /**
      * Ambient services provided with the context
      */
-    readonly scope: IFluidObject;
+    readonly scope: IFluidObject & FluidObject;
     raiseContainerWarning(warning: ContainerWarning): void;
     /**
      * Get an absolute url for a provided container-relative request.

package/lib/runtime.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"runtime.d.ts","sourceRoot":"","sources":["../src/runtime.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AACvF,OAAO,EACH,YAAY,EACZ,mBAAmB,EACnB,QAAQ,EACR,SAAS,EACZ,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAC7E,OAAO,EACH,oBAAoB,EACpB,cAAc,EACd,OAAO,EACP,yBAAyB,EACzB,aAAa,EACb,KAAK,EACL,WAAW,EACX,YAAY,EACZ,QAAQ,EACR,gBAAgB,EACnB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AACpE,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAEnD;;;GAGG;AACH,oBAAY,WAAW;IACnB;;;OAGG;IACH,QAAQ,aAAa;IAErB;;OAEG;IACH,SAAS,cAAc;IAEvB;;;OAGG;IACH,QAAQ,aAAa;CACxB;AAGD,oBAAY,SAAS;IACjB,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,KAAK,UAAU;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,QAAS,SAAQ,WAAW;IAEzC;;OAEG;IACH,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAE/C;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;IAExE;;OAEG;IACH,kBAAkB,CAAC,SAAS,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,MAAM,OAAE;IAE1D;;OAEG;IACH,OAAO,CAAC,OAAO,EAAE,yBAAyB,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,OAAE;IAE1E;;OAEG;IACH,aAAa,CAAC,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,OAAE;IAE5C;;;;;;OAMG;IACH,aAAa,CAAC,iBAAiB,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,YAAY,CAAC;IAErE;;;OAGG;IACH,cAAc,CAAC,WAAW,EAAE,WAAW,CAAC,SAAS,GAAG,WAAW,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEhF;;OAEG;IACH,oBAAoB,IAAI,OAAO,CAAC;CACnC;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IAClD,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAC;IACvC,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC;IACjC,QAAQ,CAAC,aAAa,EAAE,mBAAmB,CAAC;IAC5C,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,QAAQ,CAAC,aAAa,EAAE,cAAc,CAAC;IACvC,QAAQ,CAAC,OAAO,EAAE,uBAAuB,CAAC;IAC1C,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,YAAY,EAAE,aAAa,GAAG,SAAS,CAAC;IACjD,QAAQ,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,WAAW,EAAE,QAAQ,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,GAAG,KAAK,MAAM,CAAC;IAC/F,QAAQ,CAAC,cAAc,EAAE,CAAC,QAAQ,EAAE,GAAG,KAAK,IAAI,CAAC;IACjD,QAAQ,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,EAAE,uBAAuB,KAAK,IAAI,CAAC;IAC5D,QAAQ,CAAC,YAAY,EAAE,aAAa,CAAC,yBAAyB,EAAE,gBAAgB,CAAC,CAAC;IAClF,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,QAAQ,CAAC,QAAQ,EAAE,SAAS,GAAG,SAAS,CAAC;IACzC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB;;;;;OAKG;IACH,QAAQ,CAAC,MAAM,EAAE,oBAAoB,CAAC;IAEtC,QAAQ,CAAC,YAAY,CAAC,EAAE,oBAAoB,CAAC;IAC7C,QAAQ,CAAC,oBAAoB,EAAE,oBAAoB,GAAG,SAAS,CAAC;IAChE,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,YAAY,CAAC;IAE7B,qBAAqB,CAAC,OAAO,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAEvD;;;;;OAKG;IACH,cAAc,CAAC,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAElE;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC,oBAAoB,IAAI,QAAQ,GAAG,SAAS,CAAC;IAE7C,yBAAyB,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI,CAAC;CACnD;AAED,eAAO,MAAM,eAAe,EAAE,MAAM,sBAA0C,CAAC;AAE/E,MAAM,WAAW,sBAAsB;IACnC,QAAQ,CAAC,eAAe,EAAE,eAAe,CAAC;CAC7C;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAgB,SAAQ,sBAAsB;IAC3D;;;;;;OAMG;IACH,kBAAkB,CAAC,OAAO,EAAE,iBAAiB,EAAE,QAAQ,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;CACzF"}
+{"version":3,"file":"runtime.d.ts","sourceRoot":"","sources":["../src/runtime.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AACvF,OAAO,EACH,YAAY,EACZ,mBAAmB,EACnB,QAAQ,EACR,SAAS,EACT,WAAW,EACd,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAC7E,OAAO,EACH,oBAAoB,EACpB,cAAc,EACd,OAAO,EACP,yBAAyB,EACzB,aAAa,EACb,KAAK,EACL,WAAW,EACX,YAAY,EACZ,QAAQ,EACR,gBAAgB,EACnB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AACpE,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAEnD;;;GAGG;AACH,oBAAY,WAAW;IACnB;;;OAGG;IACH,QAAQ,aAAa;IAErB;;OAEG;IACH,SAAS,cAAc;IAEvB;;;OAGG;IACH,QAAQ,aAAa;CACxB;AAGD,oBAAY,SAAS;IACjB,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,KAAK,UAAU;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,QAAS,SAAQ,WAAW;IAEzC;;OAEG;IACH,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAE/C;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;IAExE;;OAEG;IACH,kBAAkB,CAAC,SAAS,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,MAAM,OAAE;IAE1D;;OAEG;IACH,OAAO,CAAC,OAAO,EAAE,yBAAyB,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,OAAE;IAE1E;;OAEG;IACH,aAAa,CAAC,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,OAAE;IAE5C;;;;;;OAMG;IACH,aAAa,CAAC,iBAAiB,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,YAAY,CAAC;IAErE;;;OAGG;IACH,cAAc,CAAC,WAAW,EAAE,WAAW,CAAC,SAAS,GAAG,WAAW,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEhF;;OAEG;IACH,oBAAoB,IAAI,OAAO,CAAC;CACnC;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IAClD,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAC;IACvC,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC;IACjC,QAAQ,CAAC,aAAa,EAAE,mBAAmB,CAAC;IAC5C,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,QAAQ,CAAC,aAAa,EAAE,cAAc,CAAC;IACvC,QAAQ,CAAC,OAAO,EAAE,uBAAuB,CAAC;IAC1C,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,YAAY,EAAE,aAAa,GAAG,SAAS,CAAC;IACjD,QAAQ,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,WAAW,EAAE,QAAQ,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,GAAG,KAAK,MAAM,CAAC;IAC/F,QAAQ,CAAC,cAAc,EAAE,CAAC,QAAQ,EAAE,GAAG,KAAK,IAAI,CAAC;IACjD,QAAQ,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,EAAE,uBAAuB,KAAK,IAAI,CAAC;IAC5D,QAAQ,CAAC,YAAY,EAAE,aAAa,CAAC,yBAAyB,EAAE,gBAAgB,CAAC,CAAC;IAClF,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,QAAQ,CAAC,QAAQ,EAAE,SAAS,GAAG,SAAS,CAAC;IACzC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB;;;;;OAKG;IACH,QAAQ,CAAC,MAAM,EAAE,oBAAoB,CAAC;IAEtC,QAAQ,CAAC,YAAY,CAAC,EAAE,oBAAoB,CAAC;IAC7C,QAAQ,CAAC,oBAAoB,EAAE,oBAAoB,GAAG,SAAS,CAAC;IAChE,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,YAAY,GAAG,WAAW,CAAC;IAE3C,qBAAqB,CAAC,OAAO,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAEvD;;;;;OAKG;IACH,cAAc,CAAC,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAElE;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC,oBAAoB,IAAI,QAAQ,GAAG,SAAS,CAAC;IAE7C,yBAAyB,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI,CAAC;CACnD;AAED,eAAO,MAAM,eAAe,EAAE,MAAM,sBAA0C,CAAC;AAE/E,MAAM,WAAW,sBAAsB;IACnC,QAAQ,CAAC,eAAe,EAAE,eAAe,CAAC;CAC7C;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAgB,SAAQ,sBAAsB;IAC3D;;;;;;OAMG;IACH,kBAAkB,CAAC,OAAO,EAAE,iBAAiB,EAAE,QAAQ,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;CACzF"}

package/lib/runtime.js.map

@@ -1 +1 @@
-{"version":3,"file":"runtime.js","sourceRoot":"","sources":["../src/runtime.ts"],"names":[],"mappings":"AAAA;;;GAGG;AA2BH;;;GAGG;AACH,MAAM,CAAN,IAAY,WAiBX;AAjBD,WAAY,WAAW;IACnB;;;OAGG;IACH,oCAAqB,CAAA;IAErB;;OAEG;IACH,sCAAuB,CAAA;IAEvB;;;OAGG;IACH,oCAAqB,CAAA;AACzB,CAAC,EAjBW,WAAW,KAAX,WAAW,QAiBtB;AAED,2CAA2C;AAC3C,MAAM,CAAN,IAAY,SAIX;AAJD,WAAY,SAAS;IACjB,kCAAqB,CAAA;IACrB,gCAAmB,CAAA;IACnB,4BAAe,CAAA;AACnB,CAAC,EAJW,SAAS,KAAT,SAAS,QAIpB;AAoHD,MAAM,CAAC,MAAM,eAAe,GAAiC,iBAAiB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryBaseLogger, IDisposable } from \"@fluidframework/common-definitions\";\nimport {\n    IFluidObject,\n    IFluidConfiguration,\n    IRequest,\n    IResponse,\n} from \"@fluidframework/core-interfaces\";\nimport { IDocumentStorageService } from \"@fluidframework/driver-definitions\";\nimport {\n    IClientConfiguration,\n    IClientDetails,\n    IQuorum,\n    ISequencedDocumentMessage,\n    ISnapshotTree,\n    ITree,\n    MessageType,\n    ISummaryTree,\n    IVersion,\n    IDocumentMessage,\n} from \"@fluidframework/protocol-definitions\";\nimport { IAudience } from \"./audience\";\nimport { IDeltaManager } from \"./deltas\";\nimport { ICriticalContainerError, ContainerWarning } from \"./error\";\nimport { ILoader, ILoaderOptions } from \"./loader\";\n\n/**\n * The attachment state of some Fluid data (e.g. a container or data store), denoting whether it is uploaded to the\n * service.  The transition from detached to attached state is a one-way transition.\n */\nexport enum AttachState {\n    /**\n     * In detached state, the data is only present on the local client's machine.  It has not yet been uploaded\n     * to the service.\n     */\n    Detached = \"Detached\",\n\n    /**\n     * In attaching state, the data has started the upload to the service, but has not yet completed.\n     */\n    Attaching = \"Attaching\",\n\n    /**\n     * In attached state, the data has completed upload to the service.  It can be accessed by other clients after\n     * reaching attached state.\n     */\n    Attached = \"Attached\",\n}\n\n// Represents the bind state of the entity.\nexport enum BindState {\n    NotBound = \"NotBound\",\n    Binding = \"Binding\",\n    Bound = \"Bound\",\n}\n\n/**\n * The IRuntime represents an instantiation of a code package within a Container.\n * Primarily held by the ContainerContext to be able to interact with the running instance of the Container.\n */\nexport interface IRuntime extends IDisposable {\n\n    /**\n     * Executes a request against the runtime\n     */\n    request(request: IRequest): Promise<IResponse>;\n\n    /**\n     * Snapshots the runtime\n     */\n    snapshot(tagMessage: string, fullTree?: boolean): Promise<ITree | null>;\n\n    /**\n     * Notifies the runtime of a change in the connection state\n     */\n    setConnectionState(connected: boolean, clientId?: string);\n\n    /**\n     * Processes the given op (message)\n     */\n    process(message: ISequencedDocumentMessage, local: boolean, context: any);\n\n    /**\n     * Processes the given signal\n     */\n    processSignal(message: any, local: boolean);\n\n    /**\n     * Create a summary. Used when attaching or serializing a detached container.\n     *\n     * @param blobRedirectTable - A table passed during the attach process. While detached, blob upload is supported\n     * using IDs generated locally. After attach, these IDs cannot be used, so this table maps the old local IDs to the\n     * new storage IDs so requests can be redirected.\n     */\n    createSummary(blobRedirectTable?: Map<string, string>): ISummaryTree;\n\n    /**\n     * Propagate the container state when container is attaching or attached.\n     * @param attachState - State of the container.\n     */\n    setAttachState(attachState: AttachState.Attaching | AttachState.Attached): void;\n\n    /**\n     * Get pending local state in a serializable format to be given back to a newly loaded container\n     */\n    getPendingLocalState(): unknown;\n}\n\n/**\n * The ContainerContext is a proxy standing between the Container and the Container's IRuntime.\n * This allows the Container to terminate the connection to the IRuntime.\n *\n * Specifically, there is an event on Container, onContextChanged, which mean a new code proposal has been loaded,\n * so the old IRuntime is no longer valid, as its ContainerContext has been revoked,\n * and the Container has created a new ContainerContext.\n */\nexport interface IContainerContext extends IDisposable {\n    readonly id: string;\n    readonly existing: boolean | undefined;\n    readonly options: ILoaderOptions;\n    readonly configuration: IFluidConfiguration;\n    readonly clientId: string | undefined;\n    readonly clientDetails: IClientDetails;\n    readonly storage: IDocumentStorageService;\n    readonly connected: boolean;\n    readonly baseSnapshot: ISnapshotTree | undefined;\n    readonly submitFn: (type: MessageType, contents: any, batch: boolean, appData?: any) => number;\n    readonly submitSignalFn: (contents: any) => void;\n    readonly closeFn: (error?: ICriticalContainerError) => void;\n    readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;\n    readonly quorum: IQuorum;\n    readonly audience: IAudience | undefined;\n    readonly loader: ILoader;\n    /** @deprecated - Use `taggedLogger` if present. Otherwise, be sure to handle tagged data\n     * before sending events to this logger. In time we will assume the presence of `taggedLogger`,\n     * but in the meantime, current and older loader versions buttress loggers that do not support tags.\n     * IContainerContext will retain both options, but hosts must now support tags as the loader\n     * will soon plumb taggedLogger's events (potentially tagged) to the host's logger.\n     */\n    readonly logger: ITelemetryBaseLogger;\n    // The logger implementation, which would support tagged events, should be provided by the loader.\n    readonly taggedLogger?: ITelemetryBaseLogger;\n    readonly serviceConfiguration: IClientConfiguration | undefined;\n    pendingLocalState?: unknown;\n\n    /**\n     * Ambient services provided with the context\n     */\n    readonly scope: IFluidObject;\n\n    raiseContainerWarning(warning: ContainerWarning): void;\n\n    /**\n     * Get an absolute url for a provided container-relative request.\n     * @param relativeUrl - A relative request within the container\n     *\n     * TODO: Optional for backwards compatibility. Make non-optional in version 0.19\n     */\n    getAbsoluteUrl?(relativeUrl: string): Promise<string | undefined>;\n\n    /**\n     * Indicates the attachment state of the container to a host service.\n     */\n    readonly attachState: AttachState;\n\n    getLoadedFromVersion(): IVersion | undefined;\n\n    updateDirtyContainerState(dirty: boolean): void;\n}\n\nexport const IRuntimeFactory: keyof IProvideRuntimeFactory = \"IRuntimeFactory\";\n\nexport interface IProvideRuntimeFactory {\n    readonly IRuntimeFactory: IRuntimeFactory;\n}\n\n/**\n * Exported module definition\n *\n * Provides the entry point for the ContainerContext to load the proper IRuntime\n * to start up the running instance of the Container.\n */\nexport interface IRuntimeFactory extends IProvideRuntimeFactory {\n    /**\n     * Instantiates a new IRuntime for the given IContainerContext to proxy to\n     * This is the main entry point to the Container's business logic\n     *\n     * @param context - container context to be supplied to the runtime\n     * @param existing - whether to instantiate for the first time or from an existing context\n     */\n    instantiateRuntime(context: IContainerContext, existing?: boolean): Promise<IRuntime>;\n}\n"]}
+{"version":3,"file":"runtime.js","sourceRoot":"","sources":["../src/runtime.ts"],"names":[],"mappings":"AAAA;;;GAGG;AA4BH;;;GAGG;AACH,MAAM,CAAN,IAAY,WAiBX;AAjBD,WAAY,WAAW;IACnB;;;OAGG;IACH,oCAAqB,CAAA;IAErB;;OAEG;IACH,sCAAuB,CAAA;IAEvB;;;OAGG;IACH,oCAAqB,CAAA;AACzB,CAAC,EAjBW,WAAW,KAAX,WAAW,QAiBtB;AAED,2CAA2C;AAC3C,MAAM,CAAN,IAAY,SAIX;AAJD,WAAY,SAAS;IACjB,kCAAqB,CAAA;IACrB,gCAAmB,CAAA;IACnB,4BAAe,CAAA;AACnB,CAAC,EAJW,SAAS,KAAT,SAAS,QAIpB;AAoHD,MAAM,CAAC,MAAM,eAAe,GAAiC,iBAAiB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryBaseLogger, IDisposable } from \"@fluidframework/common-definitions\";\nimport {\n    IFluidObject,\n    IFluidConfiguration,\n    IRequest,\n    IResponse,\n    FluidObject,\n} from \"@fluidframework/core-interfaces\";\nimport { IDocumentStorageService } from \"@fluidframework/driver-definitions\";\nimport {\n    IClientConfiguration,\n    IClientDetails,\n    IQuorum,\n    ISequencedDocumentMessage,\n    ISnapshotTree,\n    ITree,\n    MessageType,\n    ISummaryTree,\n    IVersion,\n    IDocumentMessage,\n} from \"@fluidframework/protocol-definitions\";\nimport { IAudience } from \"./audience\";\nimport { IDeltaManager } from \"./deltas\";\nimport { ICriticalContainerError, ContainerWarning } from \"./error\";\nimport { ILoader, ILoaderOptions } from \"./loader\";\n\n/**\n * The attachment state of some Fluid data (e.g. a container or data store), denoting whether it is uploaded to the\n * service.  The transition from detached to attached state is a one-way transition.\n */\nexport enum AttachState {\n    /**\n     * In detached state, the data is only present on the local client's machine.  It has not yet been uploaded\n     * to the service.\n     */\n    Detached = \"Detached\",\n\n    /**\n     * In attaching state, the data has started the upload to the service, but has not yet completed.\n     */\n    Attaching = \"Attaching\",\n\n    /**\n     * In attached state, the data has completed upload to the service.  It can be accessed by other clients after\n     * reaching attached state.\n     */\n    Attached = \"Attached\",\n}\n\n// Represents the bind state of the entity.\nexport enum BindState {\n    NotBound = \"NotBound\",\n    Binding = \"Binding\",\n    Bound = \"Bound\",\n}\n\n/**\n * The IRuntime represents an instantiation of a code package within a Container.\n * Primarily held by the ContainerContext to be able to interact with the running instance of the Container.\n */\nexport interface IRuntime extends IDisposable {\n\n    /**\n     * Executes a request against the runtime\n     */\n    request(request: IRequest): Promise<IResponse>;\n\n    /**\n     * Snapshots the runtime\n     */\n    snapshot(tagMessage: string, fullTree?: boolean): Promise<ITree | null>;\n\n    /**\n     * Notifies the runtime of a change in the connection state\n     */\n    setConnectionState(connected: boolean, clientId?: string);\n\n    /**\n     * Processes the given op (message)\n     */\n    process(message: ISequencedDocumentMessage, local: boolean, context: any);\n\n    /**\n     * Processes the given signal\n     */\n    processSignal(message: any, local: boolean);\n\n    /**\n     * Create a summary. Used when attaching or serializing a detached container.\n     *\n     * @param blobRedirectTable - A table passed during the attach process. While detached, blob upload is supported\n     * using IDs generated locally. After attach, these IDs cannot be used, so this table maps the old local IDs to the\n     * new storage IDs so requests can be redirected.\n     */\n    createSummary(blobRedirectTable?: Map<string, string>): ISummaryTree;\n\n    /**\n     * Propagate the container state when container is attaching or attached.\n     * @param attachState - State of the container.\n     */\n    setAttachState(attachState: AttachState.Attaching | AttachState.Attached): void;\n\n    /**\n     * Get pending local state in a serializable format to be given back to a newly loaded container\n     */\n    getPendingLocalState(): unknown;\n}\n\n/**\n * The ContainerContext is a proxy standing between the Container and the Container's IRuntime.\n * This allows the Container to terminate the connection to the IRuntime.\n *\n * Specifically, there is an event on Container, onContextChanged, which mean a new code proposal has been loaded,\n * so the old IRuntime is no longer valid, as its ContainerContext has been revoked,\n * and the Container has created a new ContainerContext.\n */\nexport interface IContainerContext extends IDisposable {\n    readonly id: string;\n    readonly existing: boolean | undefined;\n    readonly options: ILoaderOptions;\n    readonly configuration: IFluidConfiguration;\n    readonly clientId: string | undefined;\n    readonly clientDetails: IClientDetails;\n    readonly storage: IDocumentStorageService;\n    readonly connected: boolean;\n    readonly baseSnapshot: ISnapshotTree | undefined;\n    readonly submitFn: (type: MessageType, contents: any, batch: boolean, appData?: any) => number;\n    readonly submitSignalFn: (contents: any) => void;\n    readonly closeFn: (error?: ICriticalContainerError) => void;\n    readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;\n    readonly quorum: IQuorum;\n    readonly audience: IAudience | undefined;\n    readonly loader: ILoader;\n    /** @deprecated - Use `taggedLogger` if present. Otherwise, be sure to handle tagged data\n     * before sending events to this logger. In time we will assume the presence of `taggedLogger`,\n     * but in the meantime, current and older loader versions buttress loggers that do not support tags.\n     * IContainerContext will retain both options, but hosts must now support tags as the loader\n     * will soon plumb taggedLogger's events (potentially tagged) to the host's logger.\n     */\n    readonly logger: ITelemetryBaseLogger;\n    // The logger implementation, which would support tagged events, should be provided by the loader.\n    readonly taggedLogger?: ITelemetryBaseLogger;\n    readonly serviceConfiguration: IClientConfiguration | undefined;\n    pendingLocalState?: unknown;\n\n    /**\n     * Ambient services provided with the context\n     */\n    readonly scope: IFluidObject & FluidObject;\n\n    raiseContainerWarning(warning: ContainerWarning): void;\n\n    /**\n     * Get an absolute url for a provided container-relative request.\n     * @param relativeUrl - A relative request within the container\n     *\n     * TODO: Optional for backwards compatibility. Make non-optional in version 0.19\n     */\n    getAbsoluteUrl?(relativeUrl: string): Promise<string | undefined>;\n\n    /**\n     * Indicates the attachment state of the container to a host service.\n     */\n    readonly attachState: AttachState;\n\n    getLoadedFromVersion(): IVersion | undefined;\n\n    updateDirtyContainerState(dirty: boolean): void;\n}\n\nexport const IRuntimeFactory: keyof IProvideRuntimeFactory = \"IRuntimeFactory\";\n\nexport interface IProvideRuntimeFactory {\n    readonly IRuntimeFactory: IRuntimeFactory;\n}\n\n/**\n * Exported module definition\n *\n * Provides the entry point for the ContainerContext to load the proper IRuntime\n * to start up the running instance of the Container.\n */\nexport interface IRuntimeFactory extends IProvideRuntimeFactory {\n    /**\n     * Instantiates a new IRuntime for the given IContainerContext to proxy to\n     * This is the main entry point to the Container's business logic\n     *\n     * @param context - container context to be supplied to the runtime\n     * @param existing - whether to instantiate for the first time or from an existing context\n     */\n    instantiateRuntime(context: IContainerContext, existing?: boolean): Promise<IRuntime>;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/container-definitions",
-  "version": "0.42.0-43813",
+  "version": "0.43.0-45414",
   "description": "Fluid container definitions",
   "homepage": "https://fluidframework.com",
   "repository": "https://github.com/microsoft/FluidFramework",
@@ -37,16 +37,17 @@
   },
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.0",
-    "@fluidframework/core-interfaces": "^0.40.0",
-    "@fluidframework/driver-definitions": "^0.42.0-0",
-    "@fluidframework/protocol-definitions": "^0.1026.0-0"
+    "@fluidframework/core-interfaces": "^0.41.0",
+    "@fluidframework/driver-definitions": "^0.43.0-0",
+    "@fluidframework/protocol-definitions": "^0.1026.0"
   },
   "devDependencies": {
     "@fluidframework/build-common": "^0.23.0",
-    "@fluidframework/build-tools": "^0.2.43369",
+    "@fluidframework/build-tools": "^0.2.44827",
     "@fluidframework/container-definitions-0.39.8": "npm:@fluidframework/container-definitions@0.39.8",
     "@fluidframework/container-definitions-0.40.0": "npm:@fluidframework/container-definitions@0.40.0",
     "@fluidframework/container-definitions-0.41.0": "npm:@fluidframework/container-definitions@0.41.0",
+    "@fluidframework/container-definitions-0.42.0": "npm:@fluidframework/container-definitions@0.42.0",
     "@fluidframework/eslint-config-fluid": "^0.24.0",
     "@microsoft/api-extractor": "^7.16.1",
     "@types/mocha": "^8.2.2",
@@ -67,7 +68,7 @@
     "typescript-formatter": "7.1.0"
   },
   "typeValidation": {
-    "version": "0.42.0",
+    "version": "0.43.0",
     "broken": {
       "0.39.8": {
         "EnumDeclaration_ContainerErrorType": {
@@ -143,6 +144,61 @@
         "InterfaceDeclaration_IRuntimeFactory": {
           "forwardCompat": false,
           "backCompat": false
+        },
+        "InterfaceDeclaration_ILoader": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IProxyLoaderFactory": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IHostLoader": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IContainer": {
+          "backCompat": false
+        }
+      },
+      "0.41.0": {
+        "InterfaceDeclaration_ILoader": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IProxyLoaderFactory": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IHostLoader": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IFluidModule": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IContainerContext": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IContainer": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_ICodeLoader": {
+          "backCompat": false
+        }
+      },
+      "0.42.0": {
+        "InterfaceDeclaration_ILoader": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IProxyLoaderFactory": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IHostLoader": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IContainerContext": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IContainer": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IProvideLoader": {
+          "backCompat": false
         }
       }
     }

package/src/deltas.ts

@@ -56,13 +56,24 @@ export interface IDeltaHandlerStrategy {
 }
 
 declare module "@fluidframework/core-interfaces" {
-    // eslint-disable-next-line @typescript-eslint/no-empty-interface
-    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 const IDeltaSender: keyof IProvideDeltaSender = "IDeltaSender";
 
+/**
+ * @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/src/error.ts

@@ -3,6 +3,8 @@
  * Licensed under the MIT License.
  */
 
+import { ITelemetryProperties } from "@fluidframework/common-definitions";
+
 /**
  * Different error types the Container may report out to the Host
  */
@@ -36,14 +38,30 @@ export 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;
 }
 
 /**

package/src/fluidModule.ts

@@ -3,8 +3,9 @@
  * 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>;
 }

package/src/index.ts

@@ -2,17 +2,6 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-
-import { IProvideRuntimeFactory } from "./runtime";
-import { IProvideFluidTokenProvider } from "./tokenProvider";
-
-declare module "@fluidframework/core-interfaces" {
-    // eslint-disable-next-line @typescript-eslint/no-empty-interface
-    export interface IFluidObject extends Readonly<Partial<
-        IProvideRuntimeFactory &
-        IProvideFluidTokenProvider>> { }
-}
-
 export * from "./audience";
 export * from "./browserPackage";
 // eslint-disable-next-line import/no-internal-modules

package/src/legacy/chaincode.ts

@@ -3,22 +3,32 @@
  * Licensed under the MIT License.
  */
 
-import { IProvideRuntimeFactory } from "../runtime";
+import { IRuntimeFactory } from "../runtime";
 
+/**
+ * @deprecated - This will be removed in a later release.
+ */
 export const IFluidTokenProvider: keyof IProvideFluidTokenProvider = "IFluidTokenProvider";
 
+/**
+ * @deprecated - This will be removed in a later release.
+ */
 export interface IProvideFluidTokenProvider {
     readonly IFluidTokenProvider: IFluidTokenProvider;
 }
 
+/**
+ * @deprecated - This will be removed in a later release.
+ */
 export interface IFluidTokenProvider extends IProvideFluidTokenProvider {
     intelligence: { [service: string]: any };
 }
 
 declare module "@fluidframework/core-interfaces" {
-    /* eslint-disable @typescript-eslint/no-empty-interface */
-    export interface IFluidObject extends Readonly<Partial<
-        IProvideRuntimeFactory &
-        IProvideFluidTokenProvider>> { }
-    /* eslint-enable @typescript-eslint/no-empty-interface */
+    export interface IFluidObject  {
+        /** @deprecated - use `FluidObject<IRuntimeFactory>` instead */
+        readonly IRuntimeFactory?: IRuntimeFactory;
+        /** @deprecated - use `FluidObject<IFluidTokenProvider>` instead */
+        readonly IFluidTokenProvider?: IFluidTokenProvider;
+    }
 }

package/src/loader.ts

@@ -20,7 +20,8 @@ import {
 } from "@fluidframework/protocol-definitions";
 import { IResolvedUrl } from "@fluidframework/driver-definitions";
 import { IEvent, IEventProvider } from "@fluidframework/common-definitions";
-import { IDeltaManager } from "./deltas";
+import { IAudience } from "./audience";
+import { IDeltaManager, ReadOnlyInfo } from "./deltas";
 import { ICriticalContainerError, ContainerWarning } from "./error";
 import { IFluidModule } from "./fluidModule";
 import { AttachState } from "./runtime";
@@ -93,6 +94,31 @@ export interface IContainerEvents extends IEvent {
     (event: "dirty" | "saved", listener: (dirty: boolean) => void);
 }
 
+/**
+ * Namespace for the different connection states a container can be in
+ */
+export namespace ConnectionState {
+    /**
+     * The document is no longer connected to the delta server
+     */
+    export type Disconnected = 0;
+
+    /**
+     * The document has an inbound connection but is still pending for outbound deltas
+     */
+    export type Connecting = 1;
+
+    /**
+     * The document is fully connected
+     */
+     export type Connected = 2;
+}
+
+/**
+ * Type defining the different states of connectivity a container can be in
+ */
+export type ConnectionState = ConnectionState.Disconnected | ConnectionState.Connecting | ConnectionState.Connected;
+
 /**
  * The Host's view of the Container and its connection to storage
  */
@@ -124,8 +150,9 @@ export interface IContainer extends IEventProvider<IContainerEvents>, IFluidRout
      * @deprecated use getSpecifiedCodeDetails for the code details currently specified for this container, or
      * getLoadedCodeDetails for the code details that the container's context was loaded with.
      * To be removed after getSpecifiedCodeDetails and getLoadedCodeDetails become ubiquitous.
+     * This is now marked as optional and due to be removed in next release.
      */
-    readonly codeDetails: IFluidCodeDetails | undefined;
+    readonly codeDetails?: IFluidCodeDetails | undefined;
 
     /**
      * Get the code details that are currently specified for the container.
@@ -197,12 +224,69 @@ export interface IContainer extends IEventProvider<IContainerEvents>, IFluidRout
      * @param request - The request to be issued against the container
      */
     request(request: IRequest): Promise<IResponse>;
+
+    /**
+     * Provides the current connected state of the container
+     */
+    readonly connectionState?: ConnectionState;
+
+    /**
+     * Boolean indicating whether the container is currently connected or not
+     */
+    readonly connected?: boolean;
+
+    /**
+     * Dictates whether or not the current container will automatically attempt to reconnect to the delta stream
+     * after receiving a disconnect event
+     * @param reconnect - Boolean indicating if reconnect should automatically occur
+     * @alpha
+     */
+    setAutoReconnect?(reconnect: boolean): void;
+
+    /**
+     * Have the container attempt to resume processing ops
+     * @alpha
+     */
+    resume?(): void;
+
+    /**
+     * The audience information for all clients currently associated with the document in the current session
+     */
+    readonly audience?: IAudience;
+
+    /**
+     * The server provided ID of the client.
+     * Set once this.connected is true, otherwise undefined
+     * @alpha
+     */
+    readonly clientId?: string | undefined;
+
+    /**
+     * Tells if container is in read-only mode.
+     * Data stores should listen for "readonly" notifications and disallow user making changes to data stores.
+     * Readonly state can be because of no storage write permission,
+     * or due to host forcing readonly mode for container.
+     *
+     * We do not differentiate here between no write access to storage vs. host disallowing changes to container -
+     * in all cases container runtime and data stores should respect readonly state and not allow local changes.
+     *
+     * It is undefined if we have not yet established websocket connection
+     * and do not know if user has write access to a file.
+     */
+    readonly readOnlyInfo?: ReadOnlyInfo;
+
+    /**
+     * Allows the host to have the container force to be in read-only mode
+     * @param readonly - Boolean that toggles if read-only policies will be enforced
+     * @alpha
+     */
+    forceReadonly?(readonly: boolean);
 }
 
 /**
  * The Runtime's view of the Loader, used for loading Containers
  */
-export interface ILoader extends IFluidRouter {
+export interface ILoader extends IFluidRouter, Partial<IProvideLoader> {
     /**
      * Resolves the resource specified by the URL + headers contained in the request object
      * to the underlying container that will resolve the request.
@@ -353,7 +437,7 @@ export interface ILoaderHeader {
     [LoaderHeader.version]: string | undefined;
 }
 
-interface IProvideLoader {
+export interface IProvideLoader {
     readonly ILoader: ILoader;
 }
 
@@ -361,8 +445,12 @@ declare module "@fluidframework/core-interfaces" {
     // eslint-disable-next-line @typescript-eslint/no-empty-interface
     export interface IRequestHeader extends Partial<ILoaderHeader> { }
 
-    // eslint-disable-next-line @typescript-eslint/no-empty-interface
-    export interface IFluidObject extends Readonly<Partial<IProvideLoader>> { }
+    export interface IFluidObject  {
+        /**
+         * @deprecated - use `FluidObject<ILoader>` instead
+         */
+        readonly ILoader?: ILoader;
+    }
 }
 
 export interface IPendingLocalState {

package/src/runtime.ts

@@ -9,6 +9,7 @@ import {
     IFluidConfiguration,
     IRequest,
     IResponse,
+    FluidObject,
 } from "@fluidframework/core-interfaces";
 import { IDocumentStorageService } from "@fluidframework/driver-definitions";
 import {
@@ -150,7 +151,7 @@ export interface IContainerContext extends IDisposable {
     /**
      * Ambient services provided with the context
      */
-    readonly scope: IFluidObject;
+    readonly scope: IFluidObject & FluidObject;
 
     raiseContainerWarning(warning: ContainerWarning): void;