@fluidframework/odsp-client 2.0.0-dev-rc.5.0.0.270401

package/.eslintrc.cjs

@@ -0,0 +1,23 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+module.exports = {
+	extends: [require.resolve("@fluidframework/eslint-config-fluid"), "prettier"],
+	parserOptions: {
+		project: ["./tsconfig.json", "./src/test/tsconfig.json"],
+	},
+	rules: {
+		"@typescript-eslint/strict-boolean-expressions": "off",
+	},
+	overrides: [
+		{
+			files: ["src/test/**"],
+			rules: {
+				// It's fine for tests to use Node.js modules
+				"import/no-nodejs-modules": "off",
+			},
+		},
+	],
+};

package/.mocharc.cjs

@@ -0,0 +1,12 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+"use strict";
+
+const getFluidTestMochaConfig = require("@fluid-internal/mocha-test-setup/mocharc-common");
+
+const packageDir = __dirname;
+const config = getFluidTestMochaConfig(packageDir);
+module.exports = config;

package/CHANGELOG.md

@@ -0,0 +1,81 @@
+# @fluid-experimental/odsp-client
+
+## 2.0.0-rc.4.0.0
+
+### Minor Changes
+
+-   Rename `AzureMember.userName` to `AzureMember.name` and `IMember.userId` to `IMember.id` [96872186d0](https://github.com/microsoft/FluidFramework/commit/96872186d0d0f245c1fece7d19b3743e501679b6)
+
+    1. Renamed `AzureMember.userName` to `AzureMember.name` to establish uniform naming across odsp-client and azure-client.
+    2. Renamed `IMember.userId` to `IMember.id` to align with the properties received from AFR.
+
+## 2.0.0-rc.3.0.0
+
+### Major Changes
+
+-   Packages now use package.json "exports" and require modern module resolution [97d68aa06b](https://github.com/microsoft/FluidFramework/commit/97d68aa06bd5c022ecb026655814aea222a062ae)
+
+    Fluid Framework packages have been updated to use the [package.json "exports"
+    field](https://nodejs.org/docs/latest-v18.x/api/packages.html#exports) to define explicit entry points for both
+    TypeScript types and implementation code.
+
+    This means that using Fluid Framework packages require the following TypeScript settings in tsconfig.json:
+
+    -   `"moduleResolution": "Node16"` with `"module": "Node16"`
+    -   `"moduleResolution": "Bundler"` with `"module": "ESNext"`
+
+    We recommend using Node16/Node16 unless absolutely necessary. That will produce transpiled JavaScript that is suitable
+    for use with modern versions of Node.js _and_ Bundlers.
+    [See the TypeScript documentation](https://www.typescriptlang.org/tsconfig#moduleResolution) for more information
+    regarding the module and moduleResolution options.
+
+    **Node10 moduleResolution is not supported; it does not support Fluid Framework's API structuring pattern that is used
+    to distinguish stable APIs from those that are in development.**
+
+## 2.0.0-rc.2.0.0
+
+Dependency updates only.
+
+## 2.0.0-rc.1.0.0
+
+### Minor Changes
+
+-   Updated server dependencies ([#19122](https://github.com/microsoft/FluidFramework/issues/19122)) [25366b4229](https://github.com/microsoft/FluidFramework/commits/25366b422918cb43685c5f328b50450749592902)
+
+    The following Fluid server dependencies have been updated to the latest version, 3.0.0. [See the full changelog.](https://github.com/microsoft/FluidFramework/releases/tag/server_v3.0.0)
+
+    -   @fluidframework/gitresources
+    -   @fluidframework/server-kafka-orderer
+    -   @fluidframework/server-lambdas
+    -   @fluidframework/server-lambdas-driver
+    -   @fluidframework/server-local-server
+    -   @fluidframework/server-memory-orderer
+    -   @fluidframework/protocol-base
+    -   @fluidframework/server-routerlicious
+    -   @fluidframework/server-routerlicious-base
+    -   @fluidframework/server-services
+    -   @fluidframework/server-services-client
+    -   @fluidframework/server-services-core
+    -   @fluidframework/server-services-ordering-kafkanode
+    -   @fluidframework/server-services-ordering-rdkafka
+    -   @fluidframework/server-services-ordering-zookeeper
+    -   @fluidframework/server-services-shared
+    -   @fluidframework/server-services-telemetry
+    -   @fluidframework/server-services-utils
+    -   @fluidframework/server-test-utils
+    -   tinylicious
+
+-   Updated @fluidframework/protocol-definitions ([#19122](https://github.com/microsoft/FluidFramework/issues/19122)) [25366b4229](https://github.com/microsoft/FluidFramework/commits/25366b422918cb43685c5f328b50450749592902)
+
+    The @fluidframework/protocol-definitions dependency has been upgraded to v3.1.0. [See the full
+    changelog.](https://github.com/microsoft/FluidFramework/blob/main/common/lib/protocol-definitions/CHANGELOG.md#310)
+
+## 2.0.0-internal.8.0.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.4.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,109 @@
+# @fluidframework/odsp-client
+
+The odsp-client package provides a simple and powerful way to consume collaborative Fluid data with OneDrive/SharePoint (ODSP) storage. Please note that odsp-client is currently an experimental package. We'd love for you to try it out and provide feedback but it is not yet recommended or supported for production scenarios.
+
+## Using odsp-client
+
+The odsp-client package has an `OdspClient` class that allows you to interact with Fluid.
+
+```typescript
+import { OdspClient } from "@fluidframework/odsp-client";
+```
+
+### Example usage
+
+```typescript
+import { OdspClient, OdspConnectionConfig, OdspClientProps } from "@fluidframework/odsp-client";
+
+const connectionConfig: OdspConnectionConfig = {
+	tokenProvider: "<YOUR_TOKEN_PROVIDER>",
+	siteUrl: "<SITE_URL>",
+	driveId: "<SHAREPOINT_EMBEDDED_CONTAINER_ID>",
+	filePath: "<FLUID_FILE_PATH>",
+};
+
+export const clientProps: OdspClientProps = {
+	connection: connectionConfig,
+};
+
+const client = new OdspClient(clientProps);
+```
+
+### Experimental Features
+
+`OdspClient` provides access to experimental features, as demonstrated below. These features are experimental in nature and should **NOT** be used in production applications. To learn more, see [Experimental Features](https://fluidframework.com/docs/build/experimental-features/).
+
+```typescript
+const configProvider = (settings: Record<string, ConfigTypes>): IConfigProviderBase => ({
+	getRawConfig: (name: string): ConfigTypes => settings[name],
+});
+
+export const clientProps: OdspClientProps = {
+	connection: connectionConfig,
+	configProvider: configProvider({
+		"Fluid.Container.ForceWriteConnection": true,
+	}),
+};
+```
+
+## Fluid Containers
+
+A Container instance is a organizational unit within Fluid. Each Container instance has a connection to the defined Fluid Service and contains a collection of collaborative objects.
+
+Containers are created and identified by unique itemIds. Management and storage of these itemIds are the responsibility of the developer.
+
+## Defining Fluid Containers
+
+Fluid Containers are defined by a schema. The schema includes initial properties of the Container as well as what collaborative objects can be dynamically created.
+
+```typescript
+const containerSchema = {
+	initialObjects: {
+		/* ... */
+	},
+	dynamicObjectTypes: [
+		/*...*/
+	],
+};
+const odspClient = new OdspClient(clientProps);
+const { container, services } = await odspClient.createContainer(containerSchema);
+
+const itemId = await container.attach();
+```
+
+## Using Fluid Containers
+
+Using the `OdspClient` class the developer can create and get Fluid containers. Because Fluid needs to be connected to a server, containers need to be created and retrieved asynchronously.
+
+```typescript
+import { OdspClient } from "@fluidframework/odsp-client";
+
+const odspClient = new OdspClient(props);
+const { container, services } = await odspClient.getContainer("_unique-itemId_", schema);
+```
+
+## Using initial objects
+
+The most common way to use Fluid is through initial collaborative objects that are created when the Container is created. Distributed data structures and DataObjects are both supported types of collaborative objects.
+
+`initialObjects` are loaded into memory when the Container is loaded and the developer can access them via the Container's `initialObjects` property. The `initialObjects` property has the same signature as the Container schema.
+
+```typescript
+// Define the keys and types of the initial list of collaborative objects.
+// Here, we are using a SharedMap DDS on key "map1" and a SharedString on key "text1".
+const schema = {
+	initialObjects: {
+		map1: SharedMap,
+		text1: SharedString,
+	},
+};
+
+// Fetch back the container that had been created earlier with the same itemId and schema
+const { container, services } = await OdspClient.getContainer("_unique-itemId_", schema);
+
+// Get our list of initial objects that we had defined in the schema. initialObjects here will have the same signature
+const initialObjects = container.initialObjects;
+// Use the keys that we had set in the schema to load the individual objects
+const map1 = initialObjects.map1;
+const text1 = initialObjects.text1;
+```

package/api-extractor-lint.json

@@ -0,0 +1,4 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "../../../common/build/build-common/api-extractor-lint.esm.primary.json"
+}

package/api-extractor.json

@@ -0,0 +1,4 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "../../../common/build/build-common/api-extractor-base.esm.primary.json"
+}

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

@@ -0,0 +1,68 @@
+## Alpha API Report File for "@fluidframework/odsp-client"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { ContainerSchema } from '@fluidframework/fluid-static';
+import { IConfigProviderBase } from '@fluidframework/core-interfaces';
+import { IFluidContainer } from '@fluidframework/fluid-static';
+import type { IMember } from '@fluidframework/fluid-static';
+import type { IServiceAudience } from '@fluidframework/fluid-static';
+import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
+import { TokenResponse } from '@fluidframework/odsp-driver-definitions/internal';
+
+// @beta
+export type IOdspAudience = IServiceAudience<OdspMember>;
+
+// @beta
+export interface IOdspTokenProvider {
+    fetchStorageToken(siteUrl: string, refresh: boolean): Promise<TokenResponse>;
+    fetchWebsocketToken(siteUrl: string, refresh: boolean): Promise<TokenResponse>;
+}
+
+// @beta @sealed
+export class OdspClient {
+    constructor(properties: OdspClientProps);
+    // (undocumented)
+    createContainer<T extends ContainerSchema>(containerSchema: T): Promise<{
+        container: IFluidContainer<T>;
+        services: OdspContainerServices;
+    }>;
+    // (undocumented)
+    getContainer<T extends ContainerSchema>(id: string, containerSchema: T): Promise<{
+        container: IFluidContainer<T>;
+        services: OdspContainerServices;
+    }>;
+}
+
+// @beta (undocumented)
+export interface OdspClientProps {
+    readonly configProvider?: IConfigProviderBase;
+    readonly connection: OdspConnectionConfig;
+    readonly logger?: ITelemetryBaseLogger;
+}
+
+// @beta
+export interface OdspConnectionConfig {
+    driveId: string;
+    filePath: string;
+    siteUrl: string;
+    tokenProvider: IOdspTokenProvider;
+}
+
+// @beta
+export interface OdspContainerServices {
+    audience: IOdspAudience;
+}
+
+// @beta
+export interface OdspMember extends IMember {
+    email: string;
+    id: string;
+    name: string;
+}
+
+export { TokenResponse }
+
+```

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

@@ -0,0 +1,68 @@
+## Beta API Report File for "@fluidframework/odsp-client"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { ContainerSchema } from '@fluidframework/fluid-static';
+import { IConfigProviderBase } from '@fluidframework/core-interfaces';
+import { IFluidContainer } from '@fluidframework/fluid-static';
+import type { IMember } from '@fluidframework/fluid-static';
+import type { IServiceAudience } from '@fluidframework/fluid-static';
+import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
+import { TokenResponse } from '@fluidframework/odsp-driver-definitions/internal';
+
+// @beta
+export type IOdspAudience = IServiceAudience<OdspMember>;
+
+// @beta
+export interface IOdspTokenProvider {
+    fetchStorageToken(siteUrl: string, refresh: boolean): Promise<TokenResponse>;
+    fetchWebsocketToken(siteUrl: string, refresh: boolean): Promise<TokenResponse>;
+}
+
+// @beta @sealed
+export class OdspClient {
+    constructor(properties: OdspClientProps);
+    // (undocumented)
+    createContainer<T extends ContainerSchema>(containerSchema: T): Promise<{
+        container: IFluidContainer<T>;
+        services: OdspContainerServices;
+    }>;
+    // (undocumented)
+    getContainer<T extends ContainerSchema>(id: string, containerSchema: T): Promise<{
+        container: IFluidContainer<T>;
+        services: OdspContainerServices;
+    }>;
+}
+
+// @beta (undocumented)
+export interface OdspClientProps {
+    readonly configProvider?: IConfigProviderBase;
+    readonly connection: OdspConnectionConfig;
+    readonly logger?: ITelemetryBaseLogger;
+}
+
+// @beta
+export interface OdspConnectionConfig {
+    driveId: string;
+    filePath: string;
+    siteUrl: string;
+    tokenProvider: IOdspTokenProvider;
+}
+
+// @beta
+export interface OdspContainerServices {
+    audience: IOdspAudience;
+}
+
+// @beta
+export interface OdspMember extends IMember {
+    email: string;
+    id: string;
+    name: string;
+}
+
+export { TokenResponse }
+
+```

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

@@ -0,0 +1,17 @@
+## Public API Report File for "@fluidframework/odsp-client"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { ContainerSchema } from '@fluidframework/fluid-static';
+import { IConfigProviderBase } from '@fluidframework/core-interfaces';
+import { IFluidContainer } from '@fluidframework/fluid-static';
+import type { IMember } from '@fluidframework/fluid-static';
+import type { IServiceAudience } from '@fluidframework/fluid-static';
+import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
+import { TokenResponse } from '@fluidframework/odsp-driver-definitions/internal';
+
+export { TokenResponse }
+
+```

package/beta.d.ts

@@ -0,0 +1,11 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/*
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
+ */
+
+export * from "./lib/beta.js";

package/dist/beta.d.ts

@@ -0,0 +1,21 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/*
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
+ */
+
+export {
+	// @beta APIs
+	IOdspAudience, 
+	IOdspTokenProvider, 
+	OdspClient, 
+	OdspClientProps, 
+	OdspConnectionConfig, 
+	OdspContainerServices, 
+	OdspMember, 
+	TokenResponse
+} from "./index.js";

package/dist/index.d.ts

@@ -0,0 +1,18 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * The odsp-client package provides a simple and powerful way to consume collaborative Fluid data with OneDrive/SharePoint (ODSP) storage.
+ *
+ * @remarks
+ * Please note that odsp-client is currently an experimental package.
+ * We'd love for you to try it out and provide feedback but it is not yet recommended or supported for production scenarios.
+ *
+ * @packageDocumentation
+ */
+export { type TokenResponse } from "@fluidframework/odsp-driver-definitions/internal";
+export type { OdspConnectionConfig, OdspClientProps, OdspContainerServices, IOdspAudience, OdspMember, } 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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;GAQG;AAEH,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,kDAAkD,CAAC;AACtF,YAAY,EACX,oBAAoB,EACpB,eAAe,EACf,qBAAqB,EACrB,aAAa,EACb,UAAU,GACV,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,YAAY,CAAC"}

package/dist/index.js

@@ -0,0 +1,10 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OdspClient = void 0;
+var odspClient_js_1 = require("./odspClient.js");
+Object.defineProperty(exports, "OdspClient", { enumerable: true, get: function () { return odspClient_js_1.OdspClient; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAoBH,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 TokenResponse } from \"@fluidframework/odsp-driver-definitions/internal\";\nexport type {\n\tOdspConnectionConfig,\n\tOdspClientProps,\n\tOdspContainerServices,\n\tIOdspAudience,\n\tOdspMember,\n} from \"./interfaces.js\";\nexport { OdspClient } from \"./odspClient.js\";\nexport { type IOdspTokenProvider } from \"./token.js\";\n"]}

package/dist/interfaces.d.ts

@@ -0,0 +1,102 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { type ITelemetryBaseLogger } from "@fluidframework/core-interfaces";
+import { IConfigProviderBase } from "@fluidframework/core-interfaces";
+import type { IMember, IServiceAudience } from "@fluidframework/fluid-static";
+import { IOdspTokenProvider } from "./token.js";
+/**
+ * Defines the necessary properties that will be applied to all containers
+ * created by an OdspClient instance. This includes callbacks for the authentication tokens
+ * required for ODSP.
+ * @beta
+ */
+export interface OdspConnectionConfig {
+    /**
+     * Instance that provides AAD endpoint tokens for Push and SharePoint
+     */
+    tokenProvider: IOdspTokenProvider;
+    /**
+     * Site url representing ODSP resource location. It points to the specific SharePoint site where you can store and access the containers you create.
+     */
+    siteUrl: string;
+    /**
+     * SharePoint Embedded Container Id of the tenant where Fluid containers are created
+     */
+    driveId: string;
+    /**
+     * Specifies the file path where Fluid files are created. If passed an empty string, the Fluid files will be created at the root level.
+     */
+    filePath: string;
+}
+/**
+ * @beta
+ */
+export interface OdspClientProps {
+    /**
+     * Configuration for establishing a connection with the ODSP Fluid Service (Push).
+     */
+    readonly connection: OdspConnectionConfig;
+    /**
+     * Optional. A logger instance to receive diagnostic messages.
+     */
+    readonly logger?: ITelemetryBaseLogger;
+    /**
+     * Base interface for providing configurations to control experimental features. If unsure, leave this undefined.
+     */
+    readonly configProvider?: IConfigProviderBase;
+}
+/**
+ * @alpha
+ */
+export interface OdspContainerAttachProps {
+    /**
+     * The file path where Fluid containers are created. If undefined, the file is created at the root.
+     */
+    filePath: string | undefined;
+    /**
+     * The file name of the Fluid file. If undefined, the file is named with a GUID.
+     */
+    fileName: string | undefined;
+}
+/**
+ * OdspContainerServices is returned by the OdspClient alongside a FluidContainer. It holds the
+ * functionality specifically tied to the ODSP service, and how the data stored in the
+ * FluidContainer is persisted in the backend and consumed by users. Any functionality regarding
+ * 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
+ */
+export interface OdspContainerServices {
+    /**
+     * 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;
+}
+/**
+ * Since ODSP provides user names and email for all of its members, we extend the
+ * {@link @fluidframework/fluid-static#IMember} interface to include this service-specific value.
+ * It will be returned for all audience members connected.
+ * @beta
+ */
+export interface OdspMember extends IMember {
+    /**
+     * The object ID (oid) for the user, unique among each individual user connecting to the session.
+     */
+    id: string;
+    /**
+     * The user's name
+     */
+    name: string;
+    /**
+     * The user's email
+     */
+    email: string;
+}
+/**
+ * Audience object for ODSP containers
+ * @beta
+ */
+export type IOdspAudience = IServiceAudience<OdspMember>;
+//# sourceMappingURL=interfaces.d.ts.map

package/dist/interfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,KAAK,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAC5E,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,KAAK,EAAE,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAE9E,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAEhD;;;;;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;;;;;;;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"}

package/dist/interfaces.js

@@ -0,0 +1,7 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=interfaces.js.map

package/dist/interfaces.js.map

@@ -0,0 +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 ITelemetryBaseLogger } from \"@fluidframework/core-interfaces\";\nimport { IConfigProviderBase } from \"@fluidframework/core-interfaces\";\nimport type { IMember, IServiceAudience } from \"@fluidframework/fluid-static\";\n\nimport { 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 * @alpha\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 * 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"]}

package/dist/odspAudience.d.ts

@@ -0,0 +1,8 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { type IClient } from "@fluidframework/driver-definitions";
+import { type OdspMember } from "./interfaces.js";
+export declare function createOdspAudienceMember(audienceMember: IClient): OdspMember;
+//# sourceMappingURL=odspAudience.d.ts.map

package/dist/odspAudience.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"odspAudience.d.ts","sourceRoot":"","sources":["../src/odspAudience.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,oCAAoC,CAAC;AAElE,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAsBlD,wBAAgB,wBAAwB,CAAC,cAAc,EAAE,OAAO,GAAG,UAAU,CAa5E"}

package/dist/odspAudience.js

@@ -0,0 +1,20 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createOdspAudienceMember = void 0;
+const internal_1 = require("@fluidframework/core-utils/internal");
+function createOdspAudienceMember(audienceMember) {
+    const user = audienceMember.user;
+    (0, internal_1.assert)(user.name !== undefined || user.email !== undefined || user.oid !== undefined, 0x836 /* Provided user was not an "OdspUser". */);
+    return {
+        id: user.oid,
+        name: user.name,
+        email: user.email,
+        connections: [],
+    };
+}
+exports.createOdspAudienceMember = createOdspAudienceMember;
+//# sourceMappingURL=odspAudience.js.map

package/dist/odspAudience.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"odspAudience.js","sourceRoot":"","sources":["../src/odspAudience.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,kEAA6D;AAyB7D,SAAgB,wBAAwB,CAAC,cAAuB;IAC/D,MAAM,IAAI,GAAG,cAAc,CAAC,IAA2B,CAAC;IACxD,IAAA,iBAAM,EACL,IAAI,CAAC,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,IAAI,IAAI,CAAC,GAAG,KAAK,SAAS,EAC7E,KAAK,CAAC,0CAA0C,CAChD,CAAC;IAEF,OAAO;QACN,EAAE,EAAE,IAAI,CAAC,GAAG;QACZ,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,WAAW,EAAE,EAAE;KACf,CAAC;AACH,CAAC;AAbD,4DAaC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/core-utils/internal\";\nimport { type IClient } from \"@fluidframework/driver-definitions\";\n\nimport { type OdspMember } from \"./interfaces.js\";\n\n/**\n * Since ODSP provides user names, email and oids for all of its members, we extend the\n * {@link @fluidframework/fluid-static#IMember} interface to include this service-specific value.\n * @internal\n */\ninterface OdspUser {\n\t/**\n\t * The user's email address\n\t */\n\temail: string;\n\t/**\n\t * The user's name\n\t */\n\tname: string;\n\t/**\n\t * The object ID (oid). It is a unique identifier assigned to each user, group, or other entity within AAD or another Microsoft 365 service. It is a GUID that uniquely identifies the object. When making Microsoft Graph API calls, you might need to reference or manipulate objects within the directory, and the `oid` is used to identify these objects.\n\t */\n\toid: string;\n}\n\nexport function createOdspAudienceMember(audienceMember: IClient): OdspMember {\n\tconst user = audienceMember.user as unknown as OdspUser;\n\tassert(\n\t\tuser.name !== undefined || user.email !== undefined || user.oid !== undefined,\n\t\t0x836 /* Provided user was not an \"OdspUser\". */,\n\t);\n\n\treturn {\n\t\tid: user.oid,\n\t\tname: user.name,\n\t\temail: user.email,\n\t\tconnections: [],\n\t};\n}\n"]}