@fluidframework/odsp-client 2.73.0 → 2.74.0-368706

package/api-report/odsp-client.alpha.api.md

@@ -7,6 +7,12 @@
 // @beta
 export type IOdspAudience = IServiceAudience<OdspMember>;
 
+// @beta @sealed
+export interface IOdspContainerServicesEvents {
+    readOnlyStateChanged: () => void;
+    sensitivityLabelsInfoChanged: () => void;
+}
+
 // @beta
 export interface IOdspFluidContainer<TContainerSchema extends ContainerSchema = ContainerSchema> extends IFluidContainer<TContainerSchema> {
     attach(props?: ContainerAttachProps<OdspContainerAttachProps>): Promise<string>;
@@ -54,9 +60,13 @@ export interface OdspContainerAttachProps {
     filePath: string | undefined;
 }
 
-// @beta
-export interface OdspContainerServices {
+// @beta @sealed
+export interface OdspContainerServices extends IDisposable {
     audience: IOdspAudience;
+    // (undocumented)
+    events: Listenable<IOdspContainerServicesEvents>;
+    getReadOnlyState(): boolean | undefined;
+    getSensitivityLabelsInfo(): string | undefined;
 }
 
 // @beta

package/api-report/odsp-client.beta.api.md

@@ -7,6 +7,12 @@
 // @beta
 export type IOdspAudience = IServiceAudience<OdspMember>;
 
+// @beta @sealed
+export interface IOdspContainerServicesEvents {
+    readOnlyStateChanged: () => void;
+    sensitivityLabelsInfoChanged: () => void;
+}
+
 // @beta
 export interface IOdspFluidContainer<TContainerSchema extends ContainerSchema = ContainerSchema> extends IFluidContainer<TContainerSchema> {
     attach(props?: ContainerAttachProps<OdspContainerAttachProps>): Promise<string>;
@@ -54,9 +60,13 @@ export interface OdspContainerAttachProps {
     filePath: string | undefined;
 }
 
-// @beta
-export interface OdspContainerServices {
+// @beta @sealed
+export interface OdspContainerServices extends IDisposable {
     audience: IOdspAudience;
+    // (undocumented)
+    events: Listenable<IOdspContainerServicesEvents>;
+    getReadOnlyState(): boolean | undefined;
+    getSensitivityLabelsInfo(): string | undefined;
 }
 
 // @beta

package/dist/beta.d.ts

@@ -21,6 +21,7 @@
 export {
 	// #region @beta APIs
 	IOdspAudience, 
+	IOdspContainerServicesEvents, 
 	IOdspFluidContainer, 
 	IOdspTokenProvider, 
 	OdspClient, 

package/dist/index.d.ts

@@ -11,7 +11,7 @@
  *
  * @packageDocumentation
  */
-export type { IOdspAudience, IOdspFluidContainer, OdspClientProps, OdspConnectionConfig, OdspContainerAttachProps, OdspContainerServices, OdspMember, TokenResponse, } from "./interfaces.js";
+export type { IOdspAudience, IOdspContainerServicesEvents, IOdspFluidContainer, OdspClientProps, OdspConnectionConfig, OdspContainerAttachProps, OdspContainerServices, OdspMember, TokenResponse, } from "./interfaces.js";
 export { OdspClient } from "./odspClient.js";
 export { type IOdspTokenProvider } from "./token.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;GAQG;AAEH,YAAY,EACX,aAAa,EACb,mBAAmB,EACnB,eAAe,EACf,oBAAoB,EACpB,wBAAwB,EACxB,qBAAqB,EACrB,UAAU,EACV,aAAa,GACb,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;GAQG;AAEH,YAAY,EACX,aAAa,EACb,4BAA4B,EAC5B,mBAAmB,EACnB,eAAe,EACf,oBAAoB,EACpB,wBAAwB,EACxB,qBAAqB,EACrB,UAAU,EACV,aAAa,GACb,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,YAAY,CAAC"}

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAsBH,iDAA6C;AAApC,2GAAA,UAAU,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * The odsp-client package provides a simple and powerful way to consume collaborative Fluid data with OneDrive/SharePoint (ODSP) storage.\n *\n * @remarks\n * Please note that odsp-client is currently an experimental package.\n * We'd love for you to try it out and provide feedback but it is not yet recommended or supported for production scenarios.\n *\n * @packageDocumentation\n */\n\nexport type {\n\tIOdspAudience,\n\tIOdspFluidContainer,\n\tOdspClientProps,\n\tOdspConnectionConfig,\n\tOdspContainerAttachProps,\n\tOdspContainerServices,\n\tOdspMember,\n\tTokenResponse,\n} from \"./interfaces.js\";\nexport { OdspClient } from \"./odspClient.js\";\nexport { type IOdspTokenProvider } from \"./token.js\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAuBH,iDAA6C;AAApC,2GAAA,UAAU,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * The odsp-client package provides a simple and powerful way to consume collaborative Fluid data with OneDrive/SharePoint (ODSP) storage.\n *\n * @remarks\n * Please note that odsp-client is currently an experimental package.\n * We'd love for you to try it out and provide feedback but it is not yet recommended or supported for production scenarios.\n *\n * @packageDocumentation\n */\n\nexport type {\n\tIOdspAudience,\n\tIOdspContainerServicesEvents,\n\tIOdspFluidContainer,\n\tOdspClientProps,\n\tOdspConnectionConfig,\n\tOdspContainerAttachProps,\n\tOdspContainerServices,\n\tOdspMember,\n\tTokenResponse,\n} from \"./interfaces.js\";\nexport { OdspClient } from \"./odspClient.js\";\nexport { type IOdspTokenProvider } from \"./token.js\";\n"]}

package/dist/interfaces.d.ts

@@ -2,7 +2,7 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import type { IConfigProviderBase, ITelemetryBaseLogger } from "@fluidframework/core-interfaces";
+import type { IConfigProviderBase, IDisposable, ITelemetryBaseLogger, Listenable } from "@fluidframework/core-interfaces";
 import type { ContainerAttachProps, ContainerSchema, IFluidContainer, IMember, IServiceAudience } from "@fluidframework/fluid-static";
 import type { IOdspTokenProvider } from "./token.js";
 /**
@@ -59,6 +59,24 @@ export interface OdspContainerAttachProps {
      */
     fileName: string | undefined;
 }
+/**
+ * Events emitted by the ODSP container service to notify consumers of select
+ * container changes.
+ * @beta
+ * @sealed
+ */
+export interface IOdspContainerServicesEvents {
+    /**
+     * Emitted when the read-only state of the container changes.
+     * Consumers can call `OdspContainerServices.getReadOnlyState()` to get the updated value.
+     */
+    readOnlyStateChanged: () => void;
+    /**
+     * Emitted when the sensitivity label of the container changes.
+     * Consumers can call `OdspContainerServices.getSensitivityLabelsInfo()` to get the updated value.
+     */
+    sensitivityLabelsInfoChanged: () => void;
+}
 /**
  * ODSP version of the IFluidContainer interface.
  * @beta
@@ -83,12 +101,31 @@ export interface IOdspFluidContainer<TContainerSchema extends ContainerSchema =
  * how the data is handled within the FluidContainer itself, i.e. which data objects or DDSes to
  * use, will not be included here but rather on the FluidContainer class itself.
  * @beta
+ * @sealed
  */
-export interface OdspContainerServices {
+export interface OdspContainerServices extends IDisposable {
+    events: Listenable<IOdspContainerServicesEvents>;
     /**
      * Provides an object that facilitates obtaining information about users present in the Fluid session, as well as listeners for roster changes triggered by users joining or leaving the session.
      */
     audience: IOdspAudience;
+    /**
+     * Gets the read-only state of the container, if available.
+     * This is not available until the container is in the "Connected" state.
+     * @remarks
+     * In the case that the read-only state cannot be determined, wait for the "readOnlyStateChanged" event to be emitted.
+     * @returns The read-only state (true when readonly, false when editable), or undefined if not available.
+     */
+    getReadOnlyState(): boolean | undefined;
+    /**
+     * Gets the sensitivity labels info of the container, if available.
+     * This is not available until the container is in the "Connected" state, and will only be available
+     * if sensitivity labels have been applied to the container.
+     * @remarks
+     * In the case that the sensitivity labels info are expected but cannot be determined, wait for the "sensitivityLabelChanged" event to be emitted.
+     * @returns The sensitivity labels info string, or undefined if not available.
+     */
+    getSensitivityLabelsInfo(): string | undefined;
 }
 /**
  * Since ODSP provides user names and email for all of its members, we extend the

package/dist/interfaces.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EACX,mBAAmB,EACnB,oBAAoB,EACpB,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EACX,oBAAoB,EACpB,eAAe,EACf,eAAe,EACf,OAAO,EACP,gBAAgB,EAChB,MAAM,8BAA8B,CAAC;AAEtC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAErD;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB;IACpC;;OAEG;IACH,aAAa,EAAE,kBAAkB,CAAC;IAElC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CACjB;AACD;;GAEG;AACH,MAAM,WAAW,eAAe;IAC/B;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,oBAAoB,CAAC;IAE1C;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAEvC;;OAEG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,mBAAmB,CAAC;CAC9C;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACxC;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAE7B;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB,CACnC,gBAAgB,SAAS,eAAe,GAAG,eAAe,CACzD,SAAQ,eAAe,CAAC,gBAAgB,CAAC;IAC1C;;;;;;;;;OASG;IACH,MAAM,CAAC,KAAK,CAAC,EAAE,oBAAoB,CAAC,wBAAwB,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CAChF;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,qBAAqB;IACrC;;OAEG;IACH,QAAQ,EAAE,aAAa,CAAC;CACxB;AAED;;;;;GAKG;AACH,MAAM,WAAW,UAAW,SAAQ,OAAO;IAC1C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;AAEzD;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC7B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACpB"}
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EACX,mBAAmB,EACnB,WAAW,EACX,oBAAoB,EACpB,UAAU,EACV,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EACX,oBAAoB,EACpB,eAAe,EACf,eAAe,EACf,OAAO,EACP,gBAAgB,EAChB,MAAM,8BAA8B,CAAC;AAEtC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAErD;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB;IACpC;;OAEG;IACH,aAAa,EAAE,kBAAkB,CAAC;IAElC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CACjB;AACD;;GAEG;AACH,MAAM,WAAW,eAAe;IAC/B;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,oBAAoB,CAAC;IAE1C;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAEvC;;OAEG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,mBAAmB,CAAC;CAC9C;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACxC;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAE7B;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B;AAED;;;;;GAKG;AACH,MAAM,WAAW,4BAA4B;IAC5C;;;OAGG;IACH,oBAAoB,EAAE,MAAM,IAAI,CAAC;IACjC;;;OAGG;IACH,4BAA4B,EAAE,MAAM,IAAI,CAAC;CACzC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB,CACnC,gBAAgB,SAAS,eAAe,GAAG,eAAe,CACzD,SAAQ,eAAe,CAAC,gBAAgB,CAAC;IAC1C;;;;;;;;;OASG;IACH,MAAM,CAAC,KAAK,CAAC,EAAE,oBAAoB,CAAC,wBAAwB,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CAChF;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,qBAAsB,SAAQ,WAAW;IACzD,MAAM,EAAE,UAAU,CAAC,4BAA4B,CAAC,CAAC;IACjD;;OAEG;IACH,QAAQ,EAAE,aAAa,CAAC;IAExB;;;;;;OAMG;IACH,gBAAgB,IAAI,OAAO,GAAG,SAAS,CAAC;IACxC;;;;;;;OAOG;IACH,wBAAwB,IAAI,MAAM,GAAG,SAAS,CAAC;CAC/C;AAED;;;;;GAKG;AACH,MAAM,WAAW,UAAW,SAAQ,OAAO;IAC1C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;AAEzD;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC7B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACpB"}

package/dist/interfaces.js.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../src/interfaces.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 type {\n\tIConfigProviderBase,\n\tITelemetryBaseLogger,\n} from \"@fluidframework/core-interfaces\";\nimport type {\n\tContainerAttachProps,\n\tContainerSchema,\n\tIFluidContainer,\n\tIMember,\n\tIServiceAudience,\n} from \"@fluidframework/fluid-static\";\n\nimport type { IOdspTokenProvider } from \"./token.js\";\n\n/**\n * Defines the necessary properties that will be applied to all containers\n * created by an OdspClient instance. This includes callbacks for the authentication tokens\n * required for ODSP.\n * @beta\n */\nexport interface OdspConnectionConfig {\n\t/**\n\t * Instance that provides AAD endpoint tokens for Push and SharePoint\n\t */\n\ttokenProvider: IOdspTokenProvider;\n\n\t/**\n\t * Site url representing ODSP resource location. It points to the specific SharePoint site where you can store and access the containers you create.\n\t */\n\tsiteUrl: string;\n\n\t/**\n\t * SharePoint Embedded Container Id of the tenant where Fluid containers are created\n\t */\n\tdriveId: string;\n\n\t/**\n\t * Specifies the file path where Fluid files are created. If passed an empty string, the Fluid files will be created at the root level.\n\t */\n\tfilePath: string;\n}\n/**\n * @beta\n */\nexport interface OdspClientProps {\n\t/**\n\t * Configuration for establishing a connection with the ODSP Fluid Service (Push).\n\t */\n\treadonly connection: OdspConnectionConfig;\n\n\t/**\n\t * Optional. A logger instance to receive diagnostic messages.\n\t */\n\treadonly logger?: ITelemetryBaseLogger;\n\n\t/**\n\t * Base interface for providing configurations to control experimental features. If unsure, leave this undefined.\n\t */\n\treadonly configProvider?: IConfigProviderBase;\n}\n\n/**\n * @beta\n */\nexport interface OdspContainerAttachProps {\n\t/**\n\t * The file path where Fluid containers are created. If undefined, the file is created at the root.\n\t */\n\tfilePath: string | undefined;\n\n\t/**\n\t * The file name of the Fluid file. If undefined, the file is named with a GUID.\n\t */\n\tfileName: string | undefined;\n}\n\n/**\n * ODSP version of the IFluidContainer interface.\n * @beta\n */\nexport interface IOdspFluidContainer<\n\tTContainerSchema extends ContainerSchema = ContainerSchema,\n> extends IFluidContainer<TContainerSchema> {\n\t/**\n\t * A newly created container starts detached from the collaborative service.\n\t * Calling `attach()` uploads the new container to the service and connects to the collaborative service.\n\t *\n\t * This function is the same as the IFluidContainer.attach function, but has ODSP specific function signatures.\n\t *\n\t * @param props - Optional properties to pass to the attach function.\n\t *\n\t * @returns A promise which resolves when the attach is complete, with the string identifier of the container.\n\t */\n\tattach(props?: ContainerAttachProps<OdspContainerAttachProps>): Promise<string>;\n}\n\n/**\n * OdspContainerServices is returned by the OdspClient alongside a FluidContainer. It holds the\n * functionality specifically tied to the ODSP service, and how the data stored in the\n * FluidContainer is persisted in the backend and consumed by users. Any functionality regarding\n * how the data is handled within the FluidContainer itself, i.e. which data objects or DDSes to\n * use, will not be included here but rather on the FluidContainer class itself.\n * @beta\n */\nexport interface OdspContainerServices {\n\t/**\n\t * Provides an object that facilitates obtaining information about users present in the Fluid session, as well as listeners for roster changes triggered by users joining or leaving the session.\n\t */\n\taudience: IOdspAudience;\n}\n\n/**\n * Since ODSP provides user names and email for all of its members, we extend the\n * {@link @fluidframework/fluid-static#IMember} interface to include this service-specific value.\n * It will be returned for all audience members connected.\n * @beta\n */\nexport interface OdspMember extends IMember {\n\t/**\n\t * The object ID (oid) for the user, unique among each individual user connecting to the session.\n\t */\n\tid: string;\n\t/**\n\t * The user's name\n\t */\n\tname: string;\n\t/**\n\t * The user's email\n\t */\n\temail: string;\n}\n\n/**\n * Audience object for ODSP containers\n * @beta\n */\nexport type IOdspAudience = IServiceAudience<OdspMember>;\n\n/**\n * Represents token response\n * @beta\n */\nexport interface TokenResponse {\n\t/**\n\t * Token value\n\t */\n\ttoken: string;\n\n\t/**\n\t * Whether or not the token was obtained from local cache.\n\t * @remarks `undefined` indicates that it could not be determined whether or not the token was obtained this way.\n\t */\n\tfromCache?: boolean;\n}\n"]}
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../src/interfaces.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 type {\n\tIConfigProviderBase,\n\tIDisposable,\n\tITelemetryBaseLogger,\n\tListenable,\n} from \"@fluidframework/core-interfaces\";\nimport type {\n\tContainerAttachProps,\n\tContainerSchema,\n\tIFluidContainer,\n\tIMember,\n\tIServiceAudience,\n} from \"@fluidframework/fluid-static\";\n\nimport type { IOdspTokenProvider } from \"./token.js\";\n\n/**\n * Defines the necessary properties that will be applied to all containers\n * created by an OdspClient instance. This includes callbacks for the authentication tokens\n * required for ODSP.\n * @beta\n */\nexport interface OdspConnectionConfig {\n\t/**\n\t * Instance that provides AAD endpoint tokens for Push and SharePoint\n\t */\n\ttokenProvider: IOdspTokenProvider;\n\n\t/**\n\t * Site url representing ODSP resource location. It points to the specific SharePoint site where you can store and access the containers you create.\n\t */\n\tsiteUrl: string;\n\n\t/**\n\t * SharePoint Embedded Container Id of the tenant where Fluid containers are created\n\t */\n\tdriveId: string;\n\n\t/**\n\t * Specifies the file path where Fluid files are created. If passed an empty string, the Fluid files will be created at the root level.\n\t */\n\tfilePath: string;\n}\n/**\n * @beta\n */\nexport interface OdspClientProps {\n\t/**\n\t * Configuration for establishing a connection with the ODSP Fluid Service (Push).\n\t */\n\treadonly connection: OdspConnectionConfig;\n\n\t/**\n\t * Optional. A logger instance to receive diagnostic messages.\n\t */\n\treadonly logger?: ITelemetryBaseLogger;\n\n\t/**\n\t * Base interface for providing configurations to control experimental features. If unsure, leave this undefined.\n\t */\n\treadonly configProvider?: IConfigProviderBase;\n}\n\n/**\n * @beta\n */\nexport interface OdspContainerAttachProps {\n\t/**\n\t * The file path where Fluid containers are created. If undefined, the file is created at the root.\n\t */\n\tfilePath: string | undefined;\n\n\t/**\n\t * The file name of the Fluid file. If undefined, the file is named with a GUID.\n\t */\n\tfileName: string | undefined;\n}\n\n/**\n * Events emitted by the ODSP container service to notify consumers of select\n * container changes.\n * @beta\n * @sealed\n */\nexport interface IOdspContainerServicesEvents {\n\t/**\n\t * Emitted when the read-only state of the container changes.\n\t * Consumers can call `OdspContainerServices.getReadOnlyState()` to get the updated value.\n\t */\n\treadOnlyStateChanged: () => void;\n\t/**\n\t * Emitted when the sensitivity label of the container changes.\n\t * Consumers can call `OdspContainerServices.getSensitivityLabelsInfo()` to get the updated value.\n\t */\n\tsensitivityLabelsInfoChanged: () => void;\n}\n\n/**\n * ODSP version of the IFluidContainer interface.\n * @beta\n */\nexport interface IOdspFluidContainer<\n\tTContainerSchema extends ContainerSchema = ContainerSchema,\n> extends IFluidContainer<TContainerSchema> {\n\t/**\n\t * A newly created container starts detached from the collaborative service.\n\t * Calling `attach()` uploads the new container to the service and connects to the collaborative service.\n\t *\n\t * This function is the same as the IFluidContainer.attach function, but has ODSP specific function signatures.\n\t *\n\t * @param props - Optional properties to pass to the attach function.\n\t *\n\t * @returns A promise which resolves when the attach is complete, with the string identifier of the container.\n\t */\n\tattach(props?: ContainerAttachProps<OdspContainerAttachProps>): Promise<string>;\n}\n\n/**\n * OdspContainerServices is returned by the OdspClient alongside a FluidContainer. It holds the\n * functionality specifically tied to the ODSP service, and how the data stored in the\n * FluidContainer is persisted in the backend and consumed by users. Any functionality regarding\n * how the data is handled within the FluidContainer itself, i.e. which data objects or DDSes to\n * use, will not be included here but rather on the FluidContainer class itself.\n * @beta\n * @sealed\n */\nexport interface OdspContainerServices extends IDisposable {\n\tevents: Listenable<IOdspContainerServicesEvents>;\n\t/**\n\t * Provides an object that facilitates obtaining information about users present in the Fluid session, as well as listeners for roster changes triggered by users joining or leaving the session.\n\t */\n\taudience: IOdspAudience;\n\n\t/**\n\t * Gets the read-only state of the container, if available.\n\t * This is not available until the container is in the \"Connected\" state.\n\t * @remarks\n\t * In the case that the read-only state cannot be determined, wait for the \"readOnlyStateChanged\" event to be emitted.\n\t * @returns The read-only state (true when readonly, false when editable), or undefined if not available.\n\t */\n\tgetReadOnlyState(): boolean | undefined;\n\t/**\n\t * Gets the sensitivity labels info of the container, if available.\n\t * This is not available until the container is in the \"Connected\" state, and will only be available\n\t * if sensitivity labels have been applied to the container.\n\t * @remarks\n\t * In the case that the sensitivity labels info are expected but cannot be determined, wait for the \"sensitivityLabelChanged\" event to be emitted.\n\t * @returns The sensitivity labels info string, or undefined if not available.\n\t */\n\tgetSensitivityLabelsInfo(): string | undefined;\n}\n\n/**\n * Since ODSP provides user names and email for all of its members, we extend the\n * {@link @fluidframework/fluid-static#IMember} interface to include this service-specific value.\n * It will be returned for all audience members connected.\n * @beta\n */\nexport interface OdspMember extends IMember {\n\t/**\n\t * The object ID (oid) for the user, unique among each individual user connecting to the session.\n\t */\n\tid: string;\n\t/**\n\t * The user's name\n\t */\n\tname: string;\n\t/**\n\t * The user's email\n\t */\n\temail: string;\n}\n\n/**\n * Audience object for ODSP containers\n * @beta\n */\nexport type IOdspAudience = IServiceAudience<OdspMember>;\n\n/**\n * Represents token response\n * @beta\n */\nexport interface TokenResponse {\n\t/**\n\t * Token value\n\t */\n\ttoken: string;\n\n\t/**\n\t * Whether or not the token was obtained from local cache.\n\t * @remarks `undefined` indicates that it could not be determined whether or not the token was obtained this way.\n\t */\n\tfromCache?: boolean;\n}\n"]}

package/dist/odspContainerServices.d.ts

@@ -3,12 +3,19 @@
  * Licensed under the MIT License.
  */
 import type { IContainer } from "@fluidframework/container-definitions/internal";
-import type { IOdspAudience, OdspContainerServices as IOdspContainerServices } from "./interfaces.js";
+import type { IDisposable, Listenable } from "@fluidframework/core-interfaces";
+import type { IOdspAudience, OdspContainerServices as IOdspContainerServices, IOdspContainerServicesEvents } from "./interfaces.js";
 /**
  * @internal
  */
-export declare class OdspContainerServices implements IOdspContainerServices {
+export declare class OdspContainerServices implements IOdspContainerServices, IDisposable {
+    #private;
     readonly audience: IOdspAudience;
+    get events(): Listenable<IOdspContainerServicesEvents>;
     constructor(container: IContainer);
+    get disposed(): boolean;
+    dispose(): void;
+    getReadOnlyState(): boolean | undefined;
+    getSensitivityLabelsInfo(): string | undefined;
 }
 //# sourceMappingURL=odspContainerServices.d.ts.map

package/dist/odspContainerServices.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"odspContainerServices.d.ts","sourceRoot":"","sources":["../src/odspContainerServices.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gDAAgD,CAAC;AAGjF,OAAO,KAAK,EACX,aAAa,EACb,qBAAqB,IAAI,sBAAsB,EAC/C,MAAM,iBAAiB,CAAC;AAGzB;;GAEG;AACH,qBAAa,qBAAsB,YAAW,sBAAsB;IACnE,SAAgB,QAAQ,EAAE,aAAa,CAAC;gBAErB,SAAS,EAAE,UAAU;CAMxC"}
+{"version":3,"file":"odspContainerServices.d.ts","sourceRoot":"","sources":["../src/odspContainerServices.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gDAAgD,CAAC;AACjF,OAAO,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAG/E,OAAO,KAAK,EACX,aAAa,EACb,qBAAqB,IAAI,sBAAsB,EAC/C,4BAA4B,EAC5B,MAAM,iBAAiB,CAAC;AAGzB;;GAEG;AACH,qBAAa,qBAAsB,YAAW,sBAAsB,EAAE,WAAW;;IAIhF,SAAgB,QAAQ,EAAE,aAAa,CAAC;IAGxC,IAAW,MAAM,IAAI,UAAU,CAAC,4BAA4B,CAAC,CAE5D;gBAEkB,SAAS,EAAE,UAAU;IAoBxC,IAAW,QAAQ,IAAI,OAAO,CAE7B;IAEM,OAAO,IAAI,IAAI;IAUf,gBAAgB,IAAI,OAAO,GAAG,SAAS;IAIvC,wBAAwB,IAAI,MAAM,GAAG,SAAS;CAGrD"}

package/dist/odspContainerServices.js

@@ -3,20 +3,68 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var _OdspContainerServices_disposed, _OdspContainerServices_container, _OdspContainerServices_events, _OdspContainerServices_readonlyEventHandler, _OdspContainerServices_metadataUpdateEventHandler;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OdspContainerServices = void 0;
+const client_utils_1 = require("@fluid-internal/client-utils");
 const internal_1 = require("@fluidframework/fluid-static/internal");
 const odspAudience_js_1 = require("./odspAudience.js");
 /**
  * @internal
  */
 class OdspContainerServices {
+    get events() {
+        return __classPrivateFieldGet(this, _OdspContainerServices_events, "f");
+    }
     constructor(container) {
+        _OdspContainerServices_disposed.set(this, false);
+        _OdspContainerServices_container.set(this, void 0);
+        _OdspContainerServices_events.set(this, (0, client_utils_1.createEmitter)());
+        _OdspContainerServices_readonlyEventHandler.set(this, () => {
+            __classPrivateFieldGet(this, _OdspContainerServices_events, "f").emit("readOnlyStateChanged");
+        });
+        _OdspContainerServices_metadataUpdateEventHandler.set(this, (metadata) => {
+            if (metadata.sensitivityLabelsInfo !== undefined) {
+                __classPrivateFieldGet(this, _OdspContainerServices_events, "f").emit("sensitivityLabelsInfoChanged");
+            }
+        });
+        __classPrivateFieldSet(this, _OdspContainerServices_container, container, "f");
+        __classPrivateFieldGet(this, _OdspContainerServices_container, "f").on("readonly", __classPrivateFieldGet(this, _OdspContainerServices_readonlyEventHandler, "f"));
+        __classPrivateFieldGet(this, _OdspContainerServices_container, "f").on("metadataUpdate", __classPrivateFieldGet(this, _OdspContainerServices_metadataUpdateEventHandler, "f"));
         this.audience = (0, internal_1.createServiceAudience)({
             container,
             createServiceMember: odspAudience_js_1.createOdspAudienceMember,
         });
     }
+    get disposed() {
+        return __classPrivateFieldGet(this, _OdspContainerServices_disposed, "f");
+    }
+    dispose() {
+        if (__classPrivateFieldGet(this, _OdspContainerServices_disposed, "f")) {
+            return;
+        }
+        __classPrivateFieldSet(this, _OdspContainerServices_disposed, true, "f");
+        __classPrivateFieldGet(this, _OdspContainerServices_container, "f").off("readonly", __classPrivateFieldGet(this, _OdspContainerServices_readonlyEventHandler, "f"));
+        __classPrivateFieldGet(this, _OdspContainerServices_container, "f").off("metadataUpdate", __classPrivateFieldGet(this, _OdspContainerServices_metadataUpdateEventHandler, "f"));
+    }
+    getReadOnlyState() {
+        return __classPrivateFieldGet(this, _OdspContainerServices_container, "f").readOnlyInfo.readonly;
+    }
+    getSensitivityLabelsInfo() {
+        return __classPrivateFieldGet(this, _OdspContainerServices_container, "f").containerMetadata.sensitivityLabelsInfo;
+    }
 }
 exports.OdspContainerServices = OdspContainerServices;
+_OdspContainerServices_disposed = new WeakMap(), _OdspContainerServices_container = new WeakMap(), _OdspContainerServices_events = new WeakMap(), _OdspContainerServices_readonlyEventHandler = new WeakMap(), _OdspContainerServices_metadataUpdateEventHandler = new WeakMap();
 //# sourceMappingURL=odspContainerServices.js.map

package/dist/odspContainerServices.js.map

@@ -1 +1 @@
-{"version":3,"file":"odspContainerServices.js","sourceRoot":"","sources":["../src/odspContainerServices.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,oEAA8E;AAM9E,uDAA6D;AAE7D;;GAEG;AACH,MAAa,qBAAqB;IAGjC,YAAmB,SAAqB;QACvC,IAAI,CAAC,QAAQ,GAAG,IAAA,gCAAqB,EAAC;YACrC,SAAS;YACT,mBAAmB,EAAE,0CAAwB;SAC7C,CAAC,CAAC;IACJ,CAAC;CACD;AATD,sDASC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IContainer } from \"@fluidframework/container-definitions/internal\";\nimport { createServiceAudience } from \"@fluidframework/fluid-static/internal\";\n\nimport type {\n\tIOdspAudience,\n\tOdspContainerServices as IOdspContainerServices,\n} from \"./interfaces.js\";\nimport { createOdspAudienceMember } from \"./odspAudience.js\";\n\n/**\n * @internal\n */\nexport class OdspContainerServices implements IOdspContainerServices {\n\tpublic readonly audience: IOdspAudience;\n\n\tpublic constructor(container: IContainer) {\n\t\tthis.audience = createServiceAudience({\n\t\t\tcontainer,\n\t\t\tcreateServiceMember: createOdspAudienceMember,\n\t\t});\n\t}\n}\n"]}
+{"version":3,"file":"odspContainerServices.js","sourceRoot":"","sources":["../src/odspContainerServices.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;AAEH,+DAA6D;AAG7D,oEAA8E;AAO9E,uDAA6D;AAE7D;;GAEG;AACH,MAAa,qBAAqB;IAOjC,IAAW,MAAM;QAChB,OAAO,uBAAA,IAAI,qCAAQ,CAAC;IACrB,CAAC;IAED,YAAmB,SAAqB;QAVxC,0CAAY,KAAK,EAAC;QACT,mDAAuB;QAIvB,wCAAU,IAAA,4BAAa,GAAgC,EAAC;QAexD,sDAAwB,GAAS,EAAE;YAC3C,uBAAA,IAAI,qCAAQ,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;QAC3C,CAAC,EAAC;QAEO,4DAA8B,CAAC,QAAgC,EAAQ,EAAE;YACjF,IAAI,QAAQ,CAAC,qBAAqB,KAAK,SAAS,EAAE,CAAC;gBAClD,uBAAA,IAAI,qCAAQ,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;YACnD,CAAC;QACF,CAAC,EAAC;QAjBD,uBAAA,IAAI,oCAAc,SAAS,MAAA,CAAC;QAC5B,uBAAA,IAAI,wCAAW,CAAC,EAAE,CAAC,UAAU,EAAE,uBAAA,IAAI,mDAAsB,CAAC,CAAC;QAC3D,uBAAA,IAAI,wCAAW,CAAC,EAAE,CAAC,gBAAgB,EAAE,uBAAA,IAAI,yDAA4B,CAAC,CAAC;QACvE,IAAI,CAAC,QAAQ,GAAG,IAAA,gCAAqB,EAAC;YACrC,SAAS;YACT,mBAAmB,EAAE,0CAAwB;SAC7C,CAAC,CAAC;IACJ,CAAC;IAYD,IAAW,QAAQ;QAClB,OAAO,uBAAA,IAAI,uCAAU,CAAC;IACvB,CAAC;IAEM,OAAO;QACb,IAAI,uBAAA,IAAI,uCAAU,EAAE,CAAC;YACpB,OAAO;QACR,CAAC;QAED,uBAAA,IAAI,mCAAa,IAAI,MAAA,CAAC;QACtB,uBAAA,IAAI,wCAAW,CAAC,GAAG,CAAC,UAAU,EAAE,uBAAA,IAAI,mDAAsB,CAAC,CAAC;QAC5D,uBAAA,IAAI,wCAAW,CAAC,GAAG,CAAC,gBAAgB,EAAE,uBAAA,IAAI,yDAA4B,CAAC,CAAC;IACzE,CAAC;IAEM,gBAAgB;QACtB,OAAO,uBAAA,IAAI,wCAAW,CAAC,YAAY,CAAC,QAAQ,CAAC;IAC9C,CAAC;IAEM,wBAAwB;QAC9B,OAAO,uBAAA,IAAI,wCAAW,CAAC,iBAAiB,CAAC,qBAAqB,CAAC;IAChE,CAAC;CACD;AApDD,sDAoDC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { createEmitter } from \"@fluid-internal/client-utils\";\nimport type { IContainer } from \"@fluidframework/container-definitions/internal\";\nimport type { IDisposable, Listenable } from \"@fluidframework/core-interfaces\";\nimport { createServiceAudience } from \"@fluidframework/fluid-static/internal\";\n\nimport type {\n\tIOdspAudience,\n\tOdspContainerServices as IOdspContainerServices,\n\tIOdspContainerServicesEvents,\n} from \"./interfaces.js\";\nimport { createOdspAudienceMember } from \"./odspAudience.js\";\n\n/**\n * @internal\n */\nexport class OdspContainerServices implements IOdspContainerServices, IDisposable {\n\t#disposed = false;\n\treadonly #container: IContainer;\n\n\tpublic readonly audience: IOdspAudience;\n\n\treadonly #events = createEmitter<IOdspContainerServicesEvents>();\n\tpublic get events(): Listenable<IOdspContainerServicesEvents> {\n\t\treturn this.#events;\n\t}\n\n\tpublic constructor(container: IContainer) {\n\t\tthis.#container = container;\n\t\tthis.#container.on(\"readonly\", this.#readonlyEventHandler);\n\t\tthis.#container.on(\"metadataUpdate\", this.#metadataUpdateEventHandler);\n\t\tthis.audience = createServiceAudience({\n\t\t\tcontainer,\n\t\t\tcreateServiceMember: createOdspAudienceMember,\n\t\t});\n\t}\n\n\treadonly #readonlyEventHandler = (): void => {\n\t\tthis.#events.emit(\"readOnlyStateChanged\");\n\t};\n\n\treadonly #metadataUpdateEventHandler = (metadata: Record<string, string>): void => {\n\t\tif (metadata.sensitivityLabelsInfo !== undefined) {\n\t\t\tthis.#events.emit(\"sensitivityLabelsInfoChanged\");\n\t\t}\n\t};\n\n\tpublic get disposed(): boolean {\n\t\treturn this.#disposed;\n\t}\n\n\tpublic dispose(): void {\n\t\tif (this.#disposed) {\n\t\t\treturn;\n\t\t}\n\n\t\tthis.#disposed = true;\n\t\tthis.#container.off(\"readonly\", this.#readonlyEventHandler);\n\t\tthis.#container.off(\"metadataUpdate\", this.#metadataUpdateEventHandler);\n\t}\n\n\tpublic getReadOnlyState(): boolean | undefined {\n\t\treturn this.#container.readOnlyInfo.readonly;\n\t}\n\n\tpublic getSensitivityLabelsInfo(): string | undefined {\n\t\treturn this.#container.containerMetadata.sensitivityLabelsInfo;\n\t}\n}\n"]}

package/lib/beta.d.ts

@@ -21,6 +21,7 @@
 export {
 	// #region @beta APIs
 	IOdspAudience, 
+	IOdspContainerServicesEvents, 
 	IOdspFluidContainer, 
 	IOdspTokenProvider, 
 	OdspClient, 

package/lib/index.d.ts

@@ -11,7 +11,7 @@
  *
  * @packageDocumentation
  */
-export type { IOdspAudience, IOdspFluidContainer, OdspClientProps, OdspConnectionConfig, OdspContainerAttachProps, OdspContainerServices, OdspMember, TokenResponse, } from "./interfaces.js";
+export type { IOdspAudience, IOdspContainerServicesEvents, IOdspFluidContainer, OdspClientProps, OdspConnectionConfig, OdspContainerAttachProps, OdspContainerServices, OdspMember, TokenResponse, } from "./interfaces.js";
 export { OdspClient } from "./odspClient.js";
 export { type IOdspTokenProvider } from "./token.js";
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;GAQG;AAEH,YAAY,EACX,aAAa,EACb,mBAAmB,EACnB,eAAe,EACf,oBAAoB,EACpB,wBAAwB,EACxB,qBAAqB,EACrB,UAAU,EACV,aAAa,GACb,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;GAQG;AAEH,YAAY,EACX,aAAa,EACb,4BAA4B,EAC5B,mBAAmB,EACnB,eAAe,EACf,oBAAoB,EACpB,wBAAwB,EACxB,qBAAqB,EACrB,UAAU,EACV,aAAa,GACb,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,YAAY,CAAC"}

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAsBH,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * The odsp-client package provides a simple and powerful way to consume collaborative Fluid data with OneDrive/SharePoint (ODSP) storage.\n *\n * @remarks\n * Please note that odsp-client is currently an experimental package.\n * We'd love for you to try it out and provide feedback but it is not yet recommended or supported for production scenarios.\n *\n * @packageDocumentation\n */\n\nexport type {\n\tIOdspAudience,\n\tIOdspFluidContainer,\n\tOdspClientProps,\n\tOdspConnectionConfig,\n\tOdspContainerAttachProps,\n\tOdspContainerServices,\n\tOdspMember,\n\tTokenResponse,\n} from \"./interfaces.js\";\nexport { OdspClient } from \"./odspClient.js\";\nexport { type IOdspTokenProvider } from \"./token.js\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAuBH,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * The odsp-client package provides a simple and powerful way to consume collaborative Fluid data with OneDrive/SharePoint (ODSP) storage.\n *\n * @remarks\n * Please note that odsp-client is currently an experimental package.\n * We'd love for you to try it out and provide feedback but it is not yet recommended or supported for production scenarios.\n *\n * @packageDocumentation\n */\n\nexport type {\n\tIOdspAudience,\n\tIOdspContainerServicesEvents,\n\tIOdspFluidContainer,\n\tOdspClientProps,\n\tOdspConnectionConfig,\n\tOdspContainerAttachProps,\n\tOdspContainerServices,\n\tOdspMember,\n\tTokenResponse,\n} from \"./interfaces.js\";\nexport { OdspClient } from \"./odspClient.js\";\nexport { type IOdspTokenProvider } from \"./token.js\";\n"]}

package/lib/interfaces.d.ts

@@ -2,7 +2,7 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import type { IConfigProviderBase, ITelemetryBaseLogger } from "@fluidframework/core-interfaces";
+import type { IConfigProviderBase, IDisposable, ITelemetryBaseLogger, Listenable } from "@fluidframework/core-interfaces";
 import type { ContainerAttachProps, ContainerSchema, IFluidContainer, IMember, IServiceAudience } from "@fluidframework/fluid-static";
 import type { IOdspTokenProvider } from "./token.js";
 /**
@@ -59,6 +59,24 @@ export interface OdspContainerAttachProps {
      */
     fileName: string | undefined;
 }
+/**
+ * Events emitted by the ODSP container service to notify consumers of select
+ * container changes.
+ * @beta
+ * @sealed
+ */
+export interface IOdspContainerServicesEvents {
+    /**
+     * Emitted when the read-only state of the container changes.
+     * Consumers can call `OdspContainerServices.getReadOnlyState()` to get the updated value.
+     */
+    readOnlyStateChanged: () => void;
+    /**
+     * Emitted when the sensitivity label of the container changes.
+     * Consumers can call `OdspContainerServices.getSensitivityLabelsInfo()` to get the updated value.
+     */
+    sensitivityLabelsInfoChanged: () => void;
+}
 /**
  * ODSP version of the IFluidContainer interface.
  * @beta
@@ -83,12 +101,31 @@ export interface IOdspFluidContainer<TContainerSchema extends ContainerSchema =
  * how the data is handled within the FluidContainer itself, i.e. which data objects or DDSes to
  * use, will not be included here but rather on the FluidContainer class itself.
  * @beta
+ * @sealed
  */
-export interface OdspContainerServices {
+export interface OdspContainerServices extends IDisposable {
+    events: Listenable<IOdspContainerServicesEvents>;
     /**
      * Provides an object that facilitates obtaining information about users present in the Fluid session, as well as listeners for roster changes triggered by users joining or leaving the session.
      */
     audience: IOdspAudience;
+    /**
+     * Gets the read-only state of the container, if available.
+     * This is not available until the container is in the "Connected" state.
+     * @remarks
+     * In the case that the read-only state cannot be determined, wait for the "readOnlyStateChanged" event to be emitted.
+     * @returns The read-only state (true when readonly, false when editable), or undefined if not available.
+     */
+    getReadOnlyState(): boolean | undefined;
+    /**
+     * Gets the sensitivity labels info of the container, if available.
+     * This is not available until the container is in the "Connected" state, and will only be available
+     * if sensitivity labels have been applied to the container.
+     * @remarks
+     * In the case that the sensitivity labels info are expected but cannot be determined, wait for the "sensitivityLabelChanged" event to be emitted.
+     * @returns The sensitivity labels info string, or undefined if not available.
+     */
+    getSensitivityLabelsInfo(): string | undefined;
 }
 /**
  * Since ODSP provides user names and email for all of its members, we extend the

package/lib/interfaces.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EACX,mBAAmB,EACnB,oBAAoB,EACpB,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EACX,oBAAoB,EACpB,eAAe,EACf,eAAe,EACf,OAAO,EACP,gBAAgB,EAChB,MAAM,8BAA8B,CAAC;AAEtC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAErD;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB;IACpC;;OAEG;IACH,aAAa,EAAE,kBAAkB,CAAC;IAElC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CACjB;AACD;;GAEG;AACH,MAAM,WAAW,eAAe;IAC/B;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,oBAAoB,CAAC;IAE1C;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAEvC;;OAEG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,mBAAmB,CAAC;CAC9C;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACxC;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAE7B;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB,CACnC,gBAAgB,SAAS,eAAe,GAAG,eAAe,CACzD,SAAQ,eAAe,CAAC,gBAAgB,CAAC;IAC1C;;;;;;;;;OASG;IACH,MAAM,CAAC,KAAK,CAAC,EAAE,oBAAoB,CAAC,wBAAwB,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CAChF;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,qBAAqB;IACrC;;OAEG;IACH,QAAQ,EAAE,aAAa,CAAC;CACxB;AAED;;;;;GAKG;AACH,MAAM,WAAW,UAAW,SAAQ,OAAO;IAC1C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;AAEzD;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC7B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACpB"}
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EACX,mBAAmB,EACnB,WAAW,EACX,oBAAoB,EACpB,UAAU,EACV,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EACX,oBAAoB,EACpB,eAAe,EACf,eAAe,EACf,OAAO,EACP,gBAAgB,EAChB,MAAM,8BAA8B,CAAC;AAEtC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAErD;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB;IACpC;;OAEG;IACH,aAAa,EAAE,kBAAkB,CAAC;IAElC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CACjB;AACD;;GAEG;AACH,MAAM,WAAW,eAAe;IAC/B;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,oBAAoB,CAAC;IAE1C;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAEvC;;OAEG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,mBAAmB,CAAC;CAC9C;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACxC;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAE7B;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B;AAED;;;;;GAKG;AACH,MAAM,WAAW,4BAA4B;IAC5C;;;OAGG;IACH,oBAAoB,EAAE,MAAM,IAAI,CAAC;IACjC;;;OAGG;IACH,4BAA4B,EAAE,MAAM,IAAI,CAAC;CACzC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB,CACnC,gBAAgB,SAAS,eAAe,GAAG,eAAe,CACzD,SAAQ,eAAe,CAAC,gBAAgB,CAAC;IAC1C;;;;;;;;;OASG;IACH,MAAM,CAAC,KAAK,CAAC,EAAE,oBAAoB,CAAC,wBAAwB,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CAChF;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,qBAAsB,SAAQ,WAAW;IACzD,MAAM,EAAE,UAAU,CAAC,4BAA4B,CAAC,CAAC;IACjD;;OAEG;IACH,QAAQ,EAAE,aAAa,CAAC;IAExB;;;;;;OAMG;IACH,gBAAgB,IAAI,OAAO,GAAG,SAAS,CAAC;IACxC;;;;;;;OAOG;IACH,wBAAwB,IAAI,MAAM,GAAG,SAAS,CAAC;CAC/C;AAED;;;;;GAKG;AACH,MAAM,WAAW,UAAW,SAAQ,OAAO;IAC1C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;AAEzD;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC7B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACpB"}

package/lib/interfaces.js.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../src/interfaces.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 type {\n\tIConfigProviderBase,\n\tITelemetryBaseLogger,\n} from \"@fluidframework/core-interfaces\";\nimport type {\n\tContainerAttachProps,\n\tContainerSchema,\n\tIFluidContainer,\n\tIMember,\n\tIServiceAudience,\n} from \"@fluidframework/fluid-static\";\n\nimport type { IOdspTokenProvider } from \"./token.js\";\n\n/**\n * Defines the necessary properties that will be applied to all containers\n * created by an OdspClient instance. This includes callbacks for the authentication tokens\n * required for ODSP.\n * @beta\n */\nexport interface OdspConnectionConfig {\n\t/**\n\t * Instance that provides AAD endpoint tokens for Push and SharePoint\n\t */\n\ttokenProvider: IOdspTokenProvider;\n\n\t/**\n\t * Site url representing ODSP resource location. It points to the specific SharePoint site where you can store and access the containers you create.\n\t */\n\tsiteUrl: string;\n\n\t/**\n\t * SharePoint Embedded Container Id of the tenant where Fluid containers are created\n\t */\n\tdriveId: string;\n\n\t/**\n\t * Specifies the file path where Fluid files are created. If passed an empty string, the Fluid files will be created at the root level.\n\t */\n\tfilePath: string;\n}\n/**\n * @beta\n */\nexport interface OdspClientProps {\n\t/**\n\t * Configuration for establishing a connection with the ODSP Fluid Service (Push).\n\t */\n\treadonly connection: OdspConnectionConfig;\n\n\t/**\n\t * Optional. A logger instance to receive diagnostic messages.\n\t */\n\treadonly logger?: ITelemetryBaseLogger;\n\n\t/**\n\t * Base interface for providing configurations to control experimental features. If unsure, leave this undefined.\n\t */\n\treadonly configProvider?: IConfigProviderBase;\n}\n\n/**\n * @beta\n */\nexport interface OdspContainerAttachProps {\n\t/**\n\t * The file path where Fluid containers are created. If undefined, the file is created at the root.\n\t */\n\tfilePath: string | undefined;\n\n\t/**\n\t * The file name of the Fluid file. If undefined, the file is named with a GUID.\n\t */\n\tfileName: string | undefined;\n}\n\n/**\n * ODSP version of the IFluidContainer interface.\n * @beta\n */\nexport interface IOdspFluidContainer<\n\tTContainerSchema extends ContainerSchema = ContainerSchema,\n> extends IFluidContainer<TContainerSchema> {\n\t/**\n\t * A newly created container starts detached from the collaborative service.\n\t * Calling `attach()` uploads the new container to the service and connects to the collaborative service.\n\t *\n\t * This function is the same as the IFluidContainer.attach function, but has ODSP specific function signatures.\n\t *\n\t * @param props - Optional properties to pass to the attach function.\n\t *\n\t * @returns A promise which resolves when the attach is complete, with the string identifier of the container.\n\t */\n\tattach(props?: ContainerAttachProps<OdspContainerAttachProps>): Promise<string>;\n}\n\n/**\n * OdspContainerServices is returned by the OdspClient alongside a FluidContainer. It holds the\n * functionality specifically tied to the ODSP service, and how the data stored in the\n * FluidContainer is persisted in the backend and consumed by users. Any functionality regarding\n * how the data is handled within the FluidContainer itself, i.e. which data objects or DDSes to\n * use, will not be included here but rather on the FluidContainer class itself.\n * @beta\n */\nexport interface OdspContainerServices {\n\t/**\n\t * Provides an object that facilitates obtaining information about users present in the Fluid session, as well as listeners for roster changes triggered by users joining or leaving the session.\n\t */\n\taudience: IOdspAudience;\n}\n\n/**\n * Since ODSP provides user names and email for all of its members, we extend the\n * {@link @fluidframework/fluid-static#IMember} interface to include this service-specific value.\n * It will be returned for all audience members connected.\n * @beta\n */\nexport interface OdspMember extends IMember {\n\t/**\n\t * The object ID (oid) for the user, unique among each individual user connecting to the session.\n\t */\n\tid: string;\n\t/**\n\t * The user's name\n\t */\n\tname: string;\n\t/**\n\t * The user's email\n\t */\n\temail: string;\n}\n\n/**\n * Audience object for ODSP containers\n * @beta\n */\nexport type IOdspAudience = IServiceAudience<OdspMember>;\n\n/**\n * Represents token response\n * @beta\n */\nexport interface TokenResponse {\n\t/**\n\t * Token value\n\t */\n\ttoken: string;\n\n\t/**\n\t * Whether or not the token was obtained from local cache.\n\t * @remarks `undefined` indicates that it could not be determined whether or not the token was obtained this way.\n\t */\n\tfromCache?: boolean;\n}\n"]}
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../src/interfaces.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 type {\n\tIConfigProviderBase,\n\tIDisposable,\n\tITelemetryBaseLogger,\n\tListenable,\n} from \"@fluidframework/core-interfaces\";\nimport type {\n\tContainerAttachProps,\n\tContainerSchema,\n\tIFluidContainer,\n\tIMember,\n\tIServiceAudience,\n} from \"@fluidframework/fluid-static\";\n\nimport type { IOdspTokenProvider } from \"./token.js\";\n\n/**\n * Defines the necessary properties that will be applied to all containers\n * created by an OdspClient instance. This includes callbacks for the authentication tokens\n * required for ODSP.\n * @beta\n */\nexport interface OdspConnectionConfig {\n\t/**\n\t * Instance that provides AAD endpoint tokens for Push and SharePoint\n\t */\n\ttokenProvider: IOdspTokenProvider;\n\n\t/**\n\t * Site url representing ODSP resource location. It points to the specific SharePoint site where you can store and access the containers you create.\n\t */\n\tsiteUrl: string;\n\n\t/**\n\t * SharePoint Embedded Container Id of the tenant where Fluid containers are created\n\t */\n\tdriveId: string;\n\n\t/**\n\t * Specifies the file path where Fluid files are created. If passed an empty string, the Fluid files will be created at the root level.\n\t */\n\tfilePath: string;\n}\n/**\n * @beta\n */\nexport interface OdspClientProps {\n\t/**\n\t * Configuration for establishing a connection with the ODSP Fluid Service (Push).\n\t */\n\treadonly connection: OdspConnectionConfig;\n\n\t/**\n\t * Optional. A logger instance to receive diagnostic messages.\n\t */\n\treadonly logger?: ITelemetryBaseLogger;\n\n\t/**\n\t * Base interface for providing configurations to control experimental features. If unsure, leave this undefined.\n\t */\n\treadonly configProvider?: IConfigProviderBase;\n}\n\n/**\n * @beta\n */\nexport interface OdspContainerAttachProps {\n\t/**\n\t * The file path where Fluid containers are created. If undefined, the file is created at the root.\n\t */\n\tfilePath: string | undefined;\n\n\t/**\n\t * The file name of the Fluid file. If undefined, the file is named with a GUID.\n\t */\n\tfileName: string | undefined;\n}\n\n/**\n * Events emitted by the ODSP container service to notify consumers of select\n * container changes.\n * @beta\n * @sealed\n */\nexport interface IOdspContainerServicesEvents {\n\t/**\n\t * Emitted when the read-only state of the container changes.\n\t * Consumers can call `OdspContainerServices.getReadOnlyState()` to get the updated value.\n\t */\n\treadOnlyStateChanged: () => void;\n\t/**\n\t * Emitted when the sensitivity label of the container changes.\n\t * Consumers can call `OdspContainerServices.getSensitivityLabelsInfo()` to get the updated value.\n\t */\n\tsensitivityLabelsInfoChanged: () => void;\n}\n\n/**\n * ODSP version of the IFluidContainer interface.\n * @beta\n */\nexport interface IOdspFluidContainer<\n\tTContainerSchema extends ContainerSchema = ContainerSchema,\n> extends IFluidContainer<TContainerSchema> {\n\t/**\n\t * A newly created container starts detached from the collaborative service.\n\t * Calling `attach()` uploads the new container to the service and connects to the collaborative service.\n\t *\n\t * This function is the same as the IFluidContainer.attach function, but has ODSP specific function signatures.\n\t *\n\t * @param props - Optional properties to pass to the attach function.\n\t *\n\t * @returns A promise which resolves when the attach is complete, with the string identifier of the container.\n\t */\n\tattach(props?: ContainerAttachProps<OdspContainerAttachProps>): Promise<string>;\n}\n\n/**\n * OdspContainerServices is returned by the OdspClient alongside a FluidContainer. It holds the\n * functionality specifically tied to the ODSP service, and how the data stored in the\n * FluidContainer is persisted in the backend and consumed by users. Any functionality regarding\n * how the data is handled within the FluidContainer itself, i.e. which data objects or DDSes to\n * use, will not be included here but rather on the FluidContainer class itself.\n * @beta\n * @sealed\n */\nexport interface OdspContainerServices extends IDisposable {\n\tevents: Listenable<IOdspContainerServicesEvents>;\n\t/**\n\t * Provides an object that facilitates obtaining information about users present in the Fluid session, as well as listeners for roster changes triggered by users joining or leaving the session.\n\t */\n\taudience: IOdspAudience;\n\n\t/**\n\t * Gets the read-only state of the container, if available.\n\t * This is not available until the container is in the \"Connected\" state.\n\t * @remarks\n\t * In the case that the read-only state cannot be determined, wait for the \"readOnlyStateChanged\" event to be emitted.\n\t * @returns The read-only state (true when readonly, false when editable), or undefined if not available.\n\t */\n\tgetReadOnlyState(): boolean | undefined;\n\t/**\n\t * Gets the sensitivity labels info of the container, if available.\n\t * This is not available until the container is in the \"Connected\" state, and will only be available\n\t * if sensitivity labels have been applied to the container.\n\t * @remarks\n\t * In the case that the sensitivity labels info are expected but cannot be determined, wait for the \"sensitivityLabelChanged\" event to be emitted.\n\t * @returns The sensitivity labels info string, or undefined if not available.\n\t */\n\tgetSensitivityLabelsInfo(): string | undefined;\n}\n\n/**\n * Since ODSP provides user names and email for all of its members, we extend the\n * {@link @fluidframework/fluid-static#IMember} interface to include this service-specific value.\n * It will be returned for all audience members connected.\n * @beta\n */\nexport interface OdspMember extends IMember {\n\t/**\n\t * The object ID (oid) for the user, unique among each individual user connecting to the session.\n\t */\n\tid: string;\n\t/**\n\t * The user's name\n\t */\n\tname: string;\n\t/**\n\t * The user's email\n\t */\n\temail: string;\n}\n\n/**\n * Audience object for ODSP containers\n * @beta\n */\nexport type IOdspAudience = IServiceAudience<OdspMember>;\n\n/**\n * Represents token response\n * @beta\n */\nexport interface TokenResponse {\n\t/**\n\t * Token value\n\t */\n\ttoken: string;\n\n\t/**\n\t * Whether or not the token was obtained from local cache.\n\t * @remarks `undefined` indicates that it could not be determined whether or not the token was obtained this way.\n\t */\n\tfromCache?: boolean;\n}\n"]}

package/lib/odspContainerServices.d.ts

@@ -3,12 +3,19 @@
  * Licensed under the MIT License.
  */
 import type { IContainer } from "@fluidframework/container-definitions/internal";
-import type { IOdspAudience, OdspContainerServices as IOdspContainerServices } from "./interfaces.js";
+import type { IDisposable, Listenable } from "@fluidframework/core-interfaces";
+import type { IOdspAudience, OdspContainerServices as IOdspContainerServices, IOdspContainerServicesEvents } from "./interfaces.js";
 /**
  * @internal
  */
-export declare class OdspContainerServices implements IOdspContainerServices {
+export declare class OdspContainerServices implements IOdspContainerServices, IDisposable {
+    #private;
     readonly audience: IOdspAudience;
+    get events(): Listenable<IOdspContainerServicesEvents>;
     constructor(container: IContainer);
+    get disposed(): boolean;
+    dispose(): void;
+    getReadOnlyState(): boolean | undefined;
+    getSensitivityLabelsInfo(): string | undefined;
 }
 //# sourceMappingURL=odspContainerServices.d.ts.map

package/lib/odspContainerServices.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"odspContainerServices.d.ts","sourceRoot":"","sources":["../src/odspContainerServices.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gDAAgD,CAAC;AAGjF,OAAO,KAAK,EACX,aAAa,EACb,qBAAqB,IAAI,sBAAsB,EAC/C,MAAM,iBAAiB,CAAC;AAGzB;;GAEG;AACH,qBAAa,qBAAsB,YAAW,sBAAsB;IACnE,SAAgB,QAAQ,EAAE,aAAa,CAAC;gBAErB,SAAS,EAAE,UAAU;CAMxC"}
+{"version":3,"file":"odspContainerServices.d.ts","sourceRoot":"","sources":["../src/odspContainerServices.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gDAAgD,CAAC;AACjF,OAAO,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAG/E,OAAO,KAAK,EACX,aAAa,EACb,qBAAqB,IAAI,sBAAsB,EAC/C,4BAA4B,EAC5B,MAAM,iBAAiB,CAAC;AAGzB;;GAEG;AACH,qBAAa,qBAAsB,YAAW,sBAAsB,EAAE,WAAW;;IAIhF,SAAgB,QAAQ,EAAE,aAAa,CAAC;IAGxC,IAAW,MAAM,IAAI,UAAU,CAAC,4BAA4B,CAAC,CAE5D;gBAEkB,SAAS,EAAE,UAAU;IAoBxC,IAAW,QAAQ,IAAI,OAAO,CAE7B;IAEM,OAAO,IAAI,IAAI;IAUf,gBAAgB,IAAI,OAAO,GAAG,SAAS;IAIvC,wBAAwB,IAAI,MAAM,GAAG,SAAS;CAGrD"}

package/lib/odspContainerServices.js

@@ -2,17 +2,65 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var _OdspContainerServices_disposed, _OdspContainerServices_container, _OdspContainerServices_events, _OdspContainerServices_readonlyEventHandler, _OdspContainerServices_metadataUpdateEventHandler;
+import { createEmitter } from "@fluid-internal/client-utils";
 import { createServiceAudience } from "@fluidframework/fluid-static/internal";
 import { createOdspAudienceMember } from "./odspAudience.js";
 /**
  * @internal
  */
 export class OdspContainerServices {
+    get events() {
+        return __classPrivateFieldGet(this, _OdspContainerServices_events, "f");
+    }
     constructor(container) {
+        _OdspContainerServices_disposed.set(this, false);
+        _OdspContainerServices_container.set(this, void 0);
+        _OdspContainerServices_events.set(this, createEmitter());
+        _OdspContainerServices_readonlyEventHandler.set(this, () => {
+            __classPrivateFieldGet(this, _OdspContainerServices_events, "f").emit("readOnlyStateChanged");
+        });
+        _OdspContainerServices_metadataUpdateEventHandler.set(this, (metadata) => {
+            if (metadata.sensitivityLabelsInfo !== undefined) {
+                __classPrivateFieldGet(this, _OdspContainerServices_events, "f").emit("sensitivityLabelsInfoChanged");
+            }
+        });
+        __classPrivateFieldSet(this, _OdspContainerServices_container, container, "f");
+        __classPrivateFieldGet(this, _OdspContainerServices_container, "f").on("readonly", __classPrivateFieldGet(this, _OdspContainerServices_readonlyEventHandler, "f"));
+        __classPrivateFieldGet(this, _OdspContainerServices_container, "f").on("metadataUpdate", __classPrivateFieldGet(this, _OdspContainerServices_metadataUpdateEventHandler, "f"));
         this.audience = createServiceAudience({
             container,
             createServiceMember: createOdspAudienceMember,
         });
     }
+    get disposed() {
+        return __classPrivateFieldGet(this, _OdspContainerServices_disposed, "f");
+    }
+    dispose() {
+        if (__classPrivateFieldGet(this, _OdspContainerServices_disposed, "f")) {
+            return;
+        }
+        __classPrivateFieldSet(this, _OdspContainerServices_disposed, true, "f");
+        __classPrivateFieldGet(this, _OdspContainerServices_container, "f").off("readonly", __classPrivateFieldGet(this, _OdspContainerServices_readonlyEventHandler, "f"));
+        __classPrivateFieldGet(this, _OdspContainerServices_container, "f").off("metadataUpdate", __classPrivateFieldGet(this, _OdspContainerServices_metadataUpdateEventHandler, "f"));
+    }
+    getReadOnlyState() {
+        return __classPrivateFieldGet(this, _OdspContainerServices_container, "f").readOnlyInfo.readonly;
+    }
+    getSensitivityLabelsInfo() {
+        return __classPrivateFieldGet(this, _OdspContainerServices_container, "f").containerMetadata.sensitivityLabelsInfo;
+    }
 }
+_OdspContainerServices_disposed = new WeakMap(), _OdspContainerServices_container = new WeakMap(), _OdspContainerServices_events = new WeakMap(), _OdspContainerServices_readonlyEventHandler = new WeakMap(), _OdspContainerServices_metadataUpdateEventHandler = new WeakMap();
 //# sourceMappingURL=odspContainerServices.js.map

package/lib/odspContainerServices.js.map

@@ -1 +1 @@
-{"version":3,"file":"odspContainerServices.js","sourceRoot":"","sources":["../src/odspContainerServices.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,qBAAqB,EAAE,MAAM,uCAAuC,CAAC;AAM9E,OAAO,EAAE,wBAAwB,EAAE,MAAM,mBAAmB,CAAC;AAE7D;;GAEG;AACH,MAAM,OAAO,qBAAqB;IAGjC,YAAmB,SAAqB;QACvC,IAAI,CAAC,QAAQ,GAAG,qBAAqB,CAAC;YACrC,SAAS;YACT,mBAAmB,EAAE,wBAAwB;SAC7C,CAAC,CAAC;IACJ,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IContainer } from \"@fluidframework/container-definitions/internal\";\nimport { createServiceAudience } from \"@fluidframework/fluid-static/internal\";\n\nimport type {\n\tIOdspAudience,\n\tOdspContainerServices as IOdspContainerServices,\n} from \"./interfaces.js\";\nimport { createOdspAudienceMember } from \"./odspAudience.js\";\n\n/**\n * @internal\n */\nexport class OdspContainerServices implements IOdspContainerServices {\n\tpublic readonly audience: IOdspAudience;\n\n\tpublic constructor(container: IContainer) {\n\t\tthis.audience = createServiceAudience({\n\t\t\tcontainer,\n\t\t\tcreateServiceMember: createOdspAudienceMember,\n\t\t});\n\t}\n}\n"]}
+{"version":3,"file":"odspContainerServices.js","sourceRoot":"","sources":["../src/odspContainerServices.ts"],"names":[],"mappings":"AAAA;;;GAGG;;;;;;;;;;;;;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAG7D,OAAO,EAAE,qBAAqB,EAAE,MAAM,uCAAuC,CAAC;AAO9E,OAAO,EAAE,wBAAwB,EAAE,MAAM,mBAAmB,CAAC;AAE7D;;GAEG;AACH,MAAM,OAAO,qBAAqB;IAOjC,IAAW,MAAM;QAChB,OAAO,uBAAA,IAAI,qCAAQ,CAAC;IACrB,CAAC;IAED,YAAmB,SAAqB;QAVxC,0CAAY,KAAK,EAAC;QACT,mDAAuB;QAIvB,wCAAU,aAAa,EAAgC,EAAC;QAexD,sDAAwB,GAAS,EAAE;YAC3C,uBAAA,IAAI,qCAAQ,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;QAC3C,CAAC,EAAC;QAEO,4DAA8B,CAAC,QAAgC,EAAQ,EAAE;YACjF,IAAI,QAAQ,CAAC,qBAAqB,KAAK,SAAS,EAAE,CAAC;gBAClD,uBAAA,IAAI,qCAAQ,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;YACnD,CAAC;QACF,CAAC,EAAC;QAjBD,uBAAA,IAAI,oCAAc,SAAS,MAAA,CAAC;QAC5B,uBAAA,IAAI,wCAAW,CAAC,EAAE,CAAC,UAAU,EAAE,uBAAA,IAAI,mDAAsB,CAAC,CAAC;QAC3D,uBAAA,IAAI,wCAAW,CAAC,EAAE,CAAC,gBAAgB,EAAE,uBAAA,IAAI,yDAA4B,CAAC,CAAC;QACvE,IAAI,CAAC,QAAQ,GAAG,qBAAqB,CAAC;YACrC,SAAS;YACT,mBAAmB,EAAE,wBAAwB;SAC7C,CAAC,CAAC;IACJ,CAAC;IAYD,IAAW,QAAQ;QAClB,OAAO,uBAAA,IAAI,uCAAU,CAAC;IACvB,CAAC;IAEM,OAAO;QACb,IAAI,uBAAA,IAAI,uCAAU,EAAE,CAAC;YACpB,OAAO;QACR,CAAC;QAED,uBAAA,IAAI,mCAAa,IAAI,MAAA,CAAC;QACtB,uBAAA,IAAI,wCAAW,CAAC,GAAG,CAAC,UAAU,EAAE,uBAAA,IAAI,mDAAsB,CAAC,CAAC;QAC5D,uBAAA,IAAI,wCAAW,CAAC,GAAG,CAAC,gBAAgB,EAAE,uBAAA,IAAI,yDAA4B,CAAC,CAAC;IACzE,CAAC;IAEM,gBAAgB;QACtB,OAAO,uBAAA,IAAI,wCAAW,CAAC,YAAY,CAAC,QAAQ,CAAC;IAC9C,CAAC;IAEM,wBAAwB;QAC9B,OAAO,uBAAA,IAAI,wCAAW,CAAC,iBAAiB,CAAC,qBAAqB,CAAC;IAChE,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { createEmitter } from \"@fluid-internal/client-utils\";\nimport type { IContainer } from \"@fluidframework/container-definitions/internal\";\nimport type { IDisposable, Listenable } from \"@fluidframework/core-interfaces\";\nimport { createServiceAudience } from \"@fluidframework/fluid-static/internal\";\n\nimport type {\n\tIOdspAudience,\n\tOdspContainerServices as IOdspContainerServices,\n\tIOdspContainerServicesEvents,\n} from \"./interfaces.js\";\nimport { createOdspAudienceMember } from \"./odspAudience.js\";\n\n/**\n * @internal\n */\nexport class OdspContainerServices implements IOdspContainerServices, IDisposable {\n\t#disposed = false;\n\treadonly #container: IContainer;\n\n\tpublic readonly audience: IOdspAudience;\n\n\treadonly #events = createEmitter<IOdspContainerServicesEvents>();\n\tpublic get events(): Listenable<IOdspContainerServicesEvents> {\n\t\treturn this.#events;\n\t}\n\n\tpublic constructor(container: IContainer) {\n\t\tthis.#container = container;\n\t\tthis.#container.on(\"readonly\", this.#readonlyEventHandler);\n\t\tthis.#container.on(\"metadataUpdate\", this.#metadataUpdateEventHandler);\n\t\tthis.audience = createServiceAudience({\n\t\t\tcontainer,\n\t\t\tcreateServiceMember: createOdspAudienceMember,\n\t\t});\n\t}\n\n\treadonly #readonlyEventHandler = (): void => {\n\t\tthis.#events.emit(\"readOnlyStateChanged\");\n\t};\n\n\treadonly #metadataUpdateEventHandler = (metadata: Record<string, string>): void => {\n\t\tif (metadata.sensitivityLabelsInfo !== undefined) {\n\t\t\tthis.#events.emit(\"sensitivityLabelsInfoChanged\");\n\t\t}\n\t};\n\n\tpublic get disposed(): boolean {\n\t\treturn this.#disposed;\n\t}\n\n\tpublic dispose(): void {\n\t\tif (this.#disposed) {\n\t\t\treturn;\n\t\t}\n\n\t\tthis.#disposed = true;\n\t\tthis.#container.off(\"readonly\", this.#readonlyEventHandler);\n\t\tthis.#container.off(\"metadataUpdate\", this.#metadataUpdateEventHandler);\n\t}\n\n\tpublic getReadOnlyState(): boolean | undefined {\n\t\treturn this.#container.readOnlyInfo.readonly;\n\t}\n\n\tpublic getSensitivityLabelsInfo(): string | undefined {\n\t\treturn this.#container.containerMetadata.sensitivityLabelsInfo;\n\t}\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/odsp-client",
-  "version": "2.73.0",
+  "version": "2.74.0-368706",
   "description": "A tool to enable creation and loading of Fluid containers using the ODSP service",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -69,28 +69,29 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluidframework/container-definitions": "~2.73.0",
-    "@fluidframework/container-loader": "~2.73.0",
-    "@fluidframework/core-interfaces": "~2.73.0",
-    "@fluidframework/core-utils": "~2.73.0",
-    "@fluidframework/driver-definitions": "~2.73.0",
-    "@fluidframework/fluid-static": "~2.73.0",
-    "@fluidframework/map": "~2.73.0",
-    "@fluidframework/odsp-doclib-utils": "~2.73.0",
-    "@fluidframework/odsp-driver": "~2.73.0",
-    "@fluidframework/odsp-driver-definitions": "~2.73.0",
-    "@fluidframework/telemetry-utils": "~2.73.0",
+    "@fluid-internal/client-utils": "2.74.0-368706",
+    "@fluidframework/container-definitions": "2.74.0-368706",
+    "@fluidframework/container-loader": "2.74.0-368706",
+    "@fluidframework/core-interfaces": "2.74.0-368706",
+    "@fluidframework/core-utils": "2.74.0-368706",
+    "@fluidframework/driver-definitions": "2.74.0-368706",
+    "@fluidframework/fluid-static": "2.74.0-368706",
+    "@fluidframework/map": "2.74.0-368706",
+    "@fluidframework/odsp-doclib-utils": "2.74.0-368706",
+    "@fluidframework/odsp-driver": "2.74.0-368706",
+    "@fluidframework/odsp-driver-definitions": "2.74.0-368706",
+    "@fluidframework/telemetry-utils": "2.74.0-368706",
     "uuid": "^11.1.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.17.1",
     "@biomejs/biome": "~1.9.3",
-    "@fluid-internal/mocha-test-setup": "~2.73.0",
+    "@fluid-internal/mocha-test-setup": "2.74.0-368706",
     "@fluid-tools/build-cli": "^0.60.0",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.60.0",
-    "@fluidframework/eslint-config-fluid": "~2.73.0",
-    "@fluidframework/test-utils": "~2.73.0",
+    "@fluidframework/eslint-config-fluid": "2.74.0-368706",
+    "@fluidframework/test-utils": "2.74.0-368706",
     "@microsoft/api-extractor": "7.52.11",
     "@types/mocha": "^10.0.10",
     "@types/node": "^18.19.0",

package/src/index.ts

@@ -15,6 +15,7 @@
 
 export type {
 	IOdspAudience,
+	IOdspContainerServicesEvents,
 	IOdspFluidContainer,
 	OdspClientProps,
 	OdspConnectionConfig,

package/src/interfaces.ts

@@ -5,7 +5,9 @@
 
 import type {
 	IConfigProviderBase,
+	IDisposable,
 	ITelemetryBaseLogger,
+	Listenable,
 } from "@fluidframework/core-interfaces";
 import type {
 	ContainerAttachProps,
@@ -79,6 +81,25 @@ export interface OdspContainerAttachProps {
 	fileName: string | undefined;
 }
 
+/**
+ * Events emitted by the ODSP container service to notify consumers of select
+ * container changes.
+ * @beta
+ * @sealed
+ */
+export interface IOdspContainerServicesEvents {
+	/**
+	 * Emitted when the read-only state of the container changes.
+	 * Consumers can call `OdspContainerServices.getReadOnlyState()` to get the updated value.
+	 */
+	readOnlyStateChanged: () => void;
+	/**
+	 * Emitted when the sensitivity label of the container changes.
+	 * Consumers can call `OdspContainerServices.getSensitivityLabelsInfo()` to get the updated value.
+	 */
+	sensitivityLabelsInfoChanged: () => void;
+}
+
 /**
  * ODSP version of the IFluidContainer interface.
  * @beta
@@ -106,12 +127,32 @@ export interface IOdspFluidContainer<
  * how the data is handled within the FluidContainer itself, i.e. which data objects or DDSes to
  * use, will not be included here but rather on the FluidContainer class itself.
  * @beta
+ * @sealed
  */
-export interface OdspContainerServices {
+export interface OdspContainerServices extends IDisposable {
+	events: Listenable<IOdspContainerServicesEvents>;
 	/**
 	 * Provides an object that facilitates obtaining information about users present in the Fluid session, as well as listeners for roster changes triggered by users joining or leaving the session.
 	 */
 	audience: IOdspAudience;
+
+	/**
+	 * Gets the read-only state of the container, if available.
+	 * This is not available until the container is in the "Connected" state.
+	 * @remarks
+	 * In the case that the read-only state cannot be determined, wait for the "readOnlyStateChanged" event to be emitted.
+	 * @returns The read-only state (true when readonly, false when editable), or undefined if not available.
+	 */
+	getReadOnlyState(): boolean | undefined;
+	/**
+	 * Gets the sensitivity labels info of the container, if available.
+	 * This is not available until the container is in the "Connected" state, and will only be available
+	 * if sensitivity labels have been applied to the container.
+	 * @remarks
+	 * In the case that the sensitivity labels info are expected but cannot be determined, wait for the "sensitivityLabelChanged" event to be emitted.
+	 * @returns The sensitivity labels info string, or undefined if not available.
+	 */
+	getSensitivityLabelsInfo(): string | undefined;
 }
 
 /**

package/src/odspContainerServices.ts

@@ -3,25 +3,71 @@
  * Licensed under the MIT License.
  */
 
+import { createEmitter } from "@fluid-internal/client-utils";
 import type { IContainer } from "@fluidframework/container-definitions/internal";
+import type { IDisposable, Listenable } from "@fluidframework/core-interfaces";
 import { createServiceAudience } from "@fluidframework/fluid-static/internal";
 
 import type {
 	IOdspAudience,
 	OdspContainerServices as IOdspContainerServices,
+	IOdspContainerServicesEvents,
 } from "./interfaces.js";
 import { createOdspAudienceMember } from "./odspAudience.js";
 
 /**
  * @internal
  */
-export class OdspContainerServices implements IOdspContainerServices {
+export class OdspContainerServices implements IOdspContainerServices, IDisposable {
+	#disposed = false;
+	readonly #container: IContainer;
+
 	public readonly audience: IOdspAudience;
 
+	readonly #events = createEmitter<IOdspContainerServicesEvents>();
+	public get events(): Listenable<IOdspContainerServicesEvents> {
+		return this.#events;
+	}
+
 	public constructor(container: IContainer) {
+		this.#container = container;
+		this.#container.on("readonly", this.#readonlyEventHandler);
+		this.#container.on("metadataUpdate", this.#metadataUpdateEventHandler);
 		this.audience = createServiceAudience({
 			container,
 			createServiceMember: createOdspAudienceMember,
 		});
 	}
+
+	readonly #readonlyEventHandler = (): void => {
+		this.#events.emit("readOnlyStateChanged");
+	};
+
+	readonly #metadataUpdateEventHandler = (metadata: Record<string, string>): void => {
+		if (metadata.sensitivityLabelsInfo !== undefined) {
+			this.#events.emit("sensitivityLabelsInfoChanged");
+		}
+	};
+
+	public get disposed(): boolean {
+		return this.#disposed;
+	}
+
+	public dispose(): void {
+		if (this.#disposed) {
+			return;
+		}
+
+		this.#disposed = true;
+		this.#container.off("readonly", this.#readonlyEventHandler);
+		this.#container.off("metadataUpdate", this.#metadataUpdateEventHandler);
+	}
+
+	public getReadOnlyState(): boolean | undefined {
+		return this.#container.readOnlyInfo.readonly;
+	}
+
+	public getSensitivityLabelsInfo(): string | undefined {
+		return this.#container.containerMetadata.sensitivityLabelsInfo;
+	}
 }