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

package/lib/odspClient.js

@@ -0,0 +1,161 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { AttachState } from "@fluidframework/container-definitions";
+import { Loader } from "@fluidframework/container-loader/internal";
+import { assert } from "@fluidframework/core-utils/internal";
+import { createDOProviderContainerRuntimeFactory, createFluidContainer, createServiceAudience, } from "@fluidframework/fluid-static/internal";
+import { OdspDocumentServiceFactory, OdspDriverUrlResolver, createOdspCreateContainerRequest, createOdspUrl, isOdspResolvedUrl, } from "@fluidframework/odsp-driver/internal";
+import { wrapConfigProviderWithDefaults } from "@fluidframework/telemetry-utils/internal";
+import { v4 as uuid } from "uuid";
+import { createOdspAudienceMember } from "./odspAudience.js";
+async function getStorageToken(options, tokenProvider) {
+    const tokenResponse = await tokenProvider.fetchStorageToken(options.siteUrl, options.refresh);
+    return tokenResponse;
+}
+async function getWebsocketToken(options, tokenProvider) {
+    const tokenResponse = await tokenProvider.fetchWebsocketToken(options.siteUrl, options.refresh);
+    return tokenResponse;
+}
+/**
+ * Default feature gates.
+ * These values will only be used if the feature gate is not already set by the supplied config provider.
+ */
+const odspClientFeatureGates = {
+// None yet
+};
+/**
+ * Feature gates required to support runtime compatibility when V1 and V2 clients are collaborating
+ */
+const odspClientV1CompatFeatureGates = {
+    // Disable Garbage Collection
+    "Fluid.GarbageCollection.RunSweep": false, // To prevent the GC op
+    "Fluid.GarbageCollection.DisableAutoRecovery": true, // To prevent the GC op
+    "Fluid.GarbageCollection.ThrowOnTombstoneLoadOverride": false, // For a consistent story of "GC is disabled"
+};
+/**
+ * Wrap the config provider to fall back on the appropriate defaults for ODSP Client.
+ * @param baseConfigProvider - The base config provider to wrap
+ * @returns A new config provider with the appropriate defaults applied underneath the given provider
+ */
+function wrapConfigProvider(baseConfigProvider) {
+    const defaults = {
+        ...odspClientFeatureGates,
+        ...odspClientV1CompatFeatureGates,
+    };
+    return wrapConfigProviderWithDefaults(baseConfigProvider, defaults);
+}
+/**
+ * OdspClient provides the ability to have a Fluid object backed by the ODSP service within the context of Microsoft 365 (M365) tenants.
+ * @sealed
+ * @beta
+ */
+export class OdspClient {
+    properties;
+    documentServiceFactory;
+    urlResolver;
+    configProvider;
+    constructor(properties) {
+        this.properties = properties;
+        this.documentServiceFactory = new OdspDocumentServiceFactory(async (options) => getStorageToken(options, this.properties.connection.tokenProvider), async (options) => getWebsocketToken(options, this.properties.connection.tokenProvider));
+        this.urlResolver = new OdspDriverUrlResolver();
+        this.configProvider = wrapConfigProvider(properties.configProvider);
+    }
+    async createContainer(containerSchema) {
+        const loader = this.createLoader(containerSchema);
+        const container = await loader.createDetachedContainer({
+            package: "no-dynamic-package",
+            config: {},
+        });
+        const fluidContainer = await this.createFluidContainer(container, this.properties.connection);
+        const services = await this.getContainerServices(container);
+        return { container: fluidContainer, services };
+    }
+    async getContainer(id, containerSchema) {
+        const loader = this.createLoader(containerSchema);
+        const url = createOdspUrl({
+            siteUrl: this.properties.connection.siteUrl,
+            driveId: this.properties.connection.driveId,
+            itemId: id,
+            dataStorePath: "",
+        });
+        const container = await loader.resolve({ url });
+        const fluidContainer = createFluidContainer({
+            container,
+            rootDataObject: await this.getContainerEntryPoint(container),
+        });
+        const services = await this.getContainerServices(container);
+        return { container: fluidContainer, services };
+    }
+    createLoader(schema) {
+        const runtimeFactory = createDOProviderContainerRuntimeFactory({
+            schema,
+            compatibilityMode: "2",
+        });
+        const load = async () => {
+            return {
+                module: { fluidExport: runtimeFactory },
+                details: { package: "no-dynamic-package", config: {} },
+            };
+        };
+        const codeLoader = { load };
+        const client = {
+            details: {
+                capabilities: { interactive: true },
+            },
+            permission: [],
+            scopes: [],
+            user: { id: "" },
+            mode: "write",
+        };
+        return new Loader({
+            urlResolver: this.urlResolver,
+            documentServiceFactory: this.documentServiceFactory,
+            codeLoader,
+            logger: this.properties.logger,
+            options: { client },
+            configProvider: this.configProvider,
+        });
+    }
+    async createFluidContainer(container, connection) {
+        const rootDataObject = await this.getContainerEntryPoint(container);
+        /**
+         * See {@link FluidContainer.attach}
+         */
+        const attach = async (odspProps) => {
+            const createNewRequest = createOdspCreateContainerRequest(connection.siteUrl, connection.driveId, odspProps?.filePath ?? "", odspProps?.fileName ?? uuid());
+            if (container.attachState !== AttachState.Detached) {
+                throw new Error("Cannot attach container. Container is not in detached state");
+            }
+            await container.attach(createNewRequest);
+            const resolvedUrl = container.resolvedUrl;
+            if (resolvedUrl === undefined || !isOdspResolvedUrl(resolvedUrl)) {
+                throw new Error("Resolved Url not available on attached container");
+            }
+            /**
+             * A unique identifier for the file within the provided SharePoint Embedded container ID. When you attach a container,
+             * a new `itemId` is created in the user's drive, which developers can use for various operations
+             * like updating, renaming, moving the Fluid file, changing permissions, and more. `itemId` is used to load the container.
+             */
+            return resolvedUrl.itemId;
+        };
+        const fluidContainer = createFluidContainer({ container, rootDataObject });
+        fluidContainer.attach = attach;
+        return fluidContainer;
+    }
+    async getContainerServices(container) {
+        return {
+            audience: createServiceAudience({
+                container,
+                createServiceMember: createOdspAudienceMember,
+            }),
+        };
+    }
+    async getContainerEntryPoint(container) {
+        const rootDataObject = await container.getEntryPoint();
+        assert(rootDataObject.IRootDataObject !== undefined, 0x878 /* entryPoint must be of type IRootDataObject */);
+        return rootDataObject.IRootDataObject;
+    }
+}
+//# sourceMappingURL=odspClient.js.map

package/lib/odspClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"odspClient.js","sourceRoot":"","sources":["../src/odspClient.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AAKpE,OAAO,EAAE,MAAM,EAAE,MAAM,2CAA2C,CAAC;AAMnE,OAAO,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAQ7D,OAAO,EAEN,uCAAuC,EACvC,oBAAoB,EACpB,qBAAqB,GACrB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EACN,0BAA0B,EAC1B,qBAAqB,EACrB,gCAAgC,EAChC,aAAa,EACb,iBAAiB,GACjB,MAAM,sCAAsC,CAAC;AAK9C,OAAO,EAAE,8BAA8B,EAAE,MAAM,0CAA0C,CAAC;AAC1F,OAAO,EAAE,EAAE,IAAI,IAAI,EAAE,MAAM,MAAM,CAAC;AAQlC,OAAO,EAAE,wBAAwB,EAAE,MAAM,mBAAmB,CAAC;AAG7D,KAAK,UAAU,eAAe,CAC7B,OAAsC,EACtC,aAAiC;IAEjC,MAAM,aAAa,GAAkB,MAAM,aAAa,CAAC,iBAAiB,CACzE,OAAO,CAAC,OAAO,EACf,OAAO,CAAC,OAAO,CACf,CAAC;IACF,OAAO,aAAa,CAAC;AACtB,CAAC;AAED,KAAK,UAAU,iBAAiB,CAC/B,OAAsC,EACtC,aAAiC;IAEjC,MAAM,aAAa,GAAkB,MAAM,aAAa,CAAC,mBAAmB,CAC3E,OAAO,CAAC,OAAO,EACf,OAAO,CAAC,OAAO,CACf,CAAC;IACF,OAAO,aAAa,CAAC;AACtB,CAAC;AAED;;;GAGG;AACH,MAAM,sBAAsB,GAAG;AAC9B,WAAW;CACX,CAAC;AAEF;;GAEG;AACH,MAAM,8BAA8B,GAAG;IACtC,6BAA6B;IAC7B,kCAAkC,EAAE,KAAK,EAAE,uBAAuB;IAClE,6CAA6C,EAAE,IAAI,EAAE,uBAAuB;IAC5E,sDAAsD,EAAE,KAAK,EAAE,6CAA6C;CAC5G,CAAC;AAEF;;;;GAIG;AACH,SAAS,kBAAkB,CAAC,kBAAwC;IACnE,MAAM,QAAQ,GAAG;QAChB,GAAG,sBAAsB;QACzB,GAAG,8BAA8B;KACjC,CAAC;IACF,OAAO,8BAA8B,CAAC,kBAAkB,EAAE,QAAQ,CAAC,CAAC;AACrE,CAAC;AAED;;;;GAIG;AACH,MAAM,OAAO,UAAU;IAKc;IAJnB,sBAAsB,CAA0B;IAChD,WAAW,CAAwB;IACnC,cAAc,CAAkC;IAEjE,YAAoC,UAA2B;QAA3B,eAAU,GAAV,UAAU,CAAiB;QAC9D,IAAI,CAAC,sBAAsB,GAAG,IAAI,0BAA0B,CAC3D,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,eAAe,CAAC,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,aAAa,CAAC,EACrF,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,iBAAiB,CAAC,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,aAAa,CAAC,CACvF,CAAC;QAEF,IAAI,CAAC,WAAW,GAAG,IAAI,qBAAqB,EAAE,CAAC;QAC/C,IAAI,CAAC,cAAc,GAAG,kBAAkB,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;IACrE,CAAC;IAEM,KAAK,CAAC,eAAe,CAC3B,eAAkB;QAKlB,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;QAElD,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,uBAAuB,CAAC;YACtD,OAAO,EAAE,oBAAoB;YAC7B,MAAM,EAAE,EAAE;SACV,CAAC,CAAC;QAEH,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,oBAAoB,CACrD,SAAS,EACT,IAAI,CAAC,UAAU,CAAC,UAAU,CAC1B,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC;QAE5D,OAAO,EAAE,SAAS,EAAE,cAAoC,EAAE,QAAQ,EAAE,CAAC;IACtE,CAAC;IAEM,KAAK,CAAC,YAAY,CACxB,EAAU,EACV,eAAkB;QAKlB,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;QAClD,MAAM,GAAG,GAAG,aAAa,CAAC;YACzB,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,OAAO;YAC3C,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,OAAO;YAC3C,MAAM,EAAE,EAAE;YACV,aAAa,EAAE,EAAE;SACjB,CAAC,CAAC;QACH,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC;QAEhD,MAAM,cAAc,GAAG,oBAAoB,CAAC;YAC3C,SAAS;YACT,cAAc,EAAE,MAAM,IAAI,CAAC,sBAAsB,CAAC,SAAS,CAAC;SAC5D,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC;QAC5D,OAAO,EAAE,SAAS,EAAE,cAAoC,EAAE,QAAQ,EAAE,CAAC;IACtE,CAAC;IAEO,YAAY,CAAC,MAAuB;QAC3C,MAAM,cAAc,GAAG,uCAAuC,CAAC;YAC9D,MAAM;YACN,iBAAiB,EAAE,GAAG;SACtB,CAAC,CAAC;QACH,MAAM,IAAI,GAAG,KAAK,IAAsC,EAAE;YACzD,OAAO;gBACN,MAAM,EAAE,EAAE,WAAW,EAAE,cAAc,EAAE;gBACvC,OAAO,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE,MAAM,EAAE,EAAE,EAAE;aACtD,CAAC;QACH,CAAC,CAAC;QAEF,MAAM,UAAU,GAAG,EAAE,IAAI,EAAE,CAAC;QAC5B,MAAM,MAAM,GAAY;YACvB,OAAO,EAAE;gBACR,YAAY,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE;aACnC;YACD,UAAU,EAAE,EAAE;YACd,MAAM,EAAE,EAAE;YACV,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE;YAChB,IAAI,EAAE,OAAO;SACb,CAAC;QAEF,OAAO,IAAI,MAAM,CAAC;YACjB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,sBAAsB,EAAE,IAAI,CAAC,sBAAsB;YACnD,UAAU;YACV,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM;YAC9B,OAAO,EAAE,EAAE,MAAM,EAAE;YACnB,cAAc,EAAE,IAAI,CAAC,cAAc;SACnC,CAAC,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,oBAAoB,CACjC,SAAqB,EACrB,UAAgC;QAEhC,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,SAAS,CAAC,CAAC;QAEpE;;WAEG;QACH,MAAM,MAAM,GAAG,KAAK,EACnB,SAA0D,EACxC,EAAE;YACpB,MAAM,gBAAgB,GAAa,gCAAgC,CAClE,UAAU,CAAC,OAAO,EAClB,UAAU,CAAC,OAAO,EAClB,SAAS,EAAE,QAAQ,IAAI,EAAE,EACzB,SAAS,EAAE,QAAQ,IAAI,IAAI,EAAE,CAC7B,CAAC;YACF,IAAI,SAAS,CAAC,WAAW,KAAK,WAAW,CAAC,QAAQ,EAAE,CAAC;gBACpD,MAAM,IAAI,KAAK,CAAC,6DAA6D,CAAC,CAAC;YAChF,CAAC;YACD,MAAM,SAAS,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;YAEzC,MAAM,WAAW,GAAG,SAAS,CAAC,WAAW,CAAC;YAE1C,IAAI,WAAW,KAAK,SAAS,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,EAAE,CAAC;gBAClE,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;YACrE,CAAC;YAED;;;;eAIG;YACH,OAAO,WAAW,CAAC,MAAM,CAAC;QAC3B,CAAC,CAAC;QACF,MAAM,cAAc,GAAG,oBAAoB,CAAC,EAAE,SAAS,EAAE,cAAc,EAAE,CAAC,CAAC;QAC3E,cAAc,CAAC,MAAM,GAAG,MAAM,CAAC;QAC/B,OAAO,cAAc,CAAC;IACvB,CAAC;IAEO,KAAK,CAAC,oBAAoB,CAAC,SAAqB;QACvD,OAAO;YACN,QAAQ,EAAE,qBAAqB,CAAC;gBAC/B,SAAS;gBACT,mBAAmB,EAAE,wBAAwB;aAC7C,CAAC;SACF,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,sBAAsB,CAAC,SAAqB;QACzD,MAAM,cAAc,GAAiC,MAAM,SAAS,CAAC,aAAa,EAAE,CAAC;QACrF,MAAM,CACL,cAAc,CAAC,eAAe,KAAK,SAAS,EAC5C,KAAK,CAAC,gDAAgD,CACtD,CAAC;QACF,OAAO,cAAc,CAAC,eAAe,CAAC;IACvC,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { AttachState } from \"@fluidframework/container-definitions\";\nimport {\n\tIContainer,\n\tIFluidModuleWithDetails,\n} from \"@fluidframework/container-definitions/internal\";\nimport { Loader } from \"@fluidframework/container-loader/internal\";\nimport {\n\ttype FluidObject,\n\ttype IConfigProviderBase,\n\ttype IRequest,\n} from \"@fluidframework/core-interfaces\";\nimport { assert } from \"@fluidframework/core-utils/internal\";\nimport { IClient } from \"@fluidframework/driver-definitions\";\nimport { IDocumentServiceFactory } from \"@fluidframework/driver-definitions/internal\";\nimport {\n\tContainerAttachProps,\n\ttype ContainerSchema,\n\tIFluidContainer,\n} from \"@fluidframework/fluid-static\";\nimport {\n\tIRootDataObject,\n\tcreateDOProviderContainerRuntimeFactory,\n\tcreateFluidContainer,\n\tcreateServiceAudience,\n} from \"@fluidframework/fluid-static/internal\";\nimport {\n\tOdspDocumentServiceFactory,\n\tOdspDriverUrlResolver,\n\tcreateOdspCreateContainerRequest,\n\tcreateOdspUrl,\n\tisOdspResolvedUrl,\n} from \"@fluidframework/odsp-driver/internal\";\nimport type {\n\tOdspResourceTokenFetchOptions,\n\tTokenResponse,\n} from \"@fluidframework/odsp-driver-definitions/internal\";\nimport { wrapConfigProviderWithDefaults } from \"@fluidframework/telemetry-utils/internal\";\nimport { v4 as uuid } from \"uuid\";\n\nimport {\n\tOdspClientProps,\n\tOdspConnectionConfig,\n\tOdspContainerAttachProps,\n\tOdspContainerServices,\n} from \"./interfaces.js\";\nimport { createOdspAudienceMember } from \"./odspAudience.js\";\nimport { type IOdspTokenProvider } from \"./token.js\";\n\nasync function getStorageToken(\n\toptions: OdspResourceTokenFetchOptions,\n\ttokenProvider: IOdspTokenProvider,\n): Promise<TokenResponse> {\n\tconst tokenResponse: TokenResponse = await tokenProvider.fetchStorageToken(\n\t\toptions.siteUrl,\n\t\toptions.refresh,\n\t);\n\treturn tokenResponse;\n}\n\nasync function getWebsocketToken(\n\toptions: OdspResourceTokenFetchOptions,\n\ttokenProvider: IOdspTokenProvider,\n): Promise<TokenResponse> {\n\tconst tokenResponse: TokenResponse = await tokenProvider.fetchWebsocketToken(\n\t\toptions.siteUrl,\n\t\toptions.refresh,\n\t);\n\treturn tokenResponse;\n}\n\n/**\n * Default feature gates.\n * These values will only be used if the feature gate is not already set by the supplied config provider.\n */\nconst odspClientFeatureGates = {\n\t// None yet\n};\n\n/**\n * Feature gates required to support runtime compatibility when V1 and V2 clients are collaborating\n */\nconst odspClientV1CompatFeatureGates = {\n\t// Disable Garbage Collection\n\t\"Fluid.GarbageCollection.RunSweep\": false, // To prevent the GC op\n\t\"Fluid.GarbageCollection.DisableAutoRecovery\": true, // To prevent the GC op\n\t\"Fluid.GarbageCollection.ThrowOnTombstoneLoadOverride\": false, // For a consistent story of \"GC is disabled\"\n};\n\n/**\n * Wrap the config provider to fall back on the appropriate defaults for ODSP Client.\n * @param baseConfigProvider - The base config provider to wrap\n * @returns A new config provider with the appropriate defaults applied underneath the given provider\n */\nfunction wrapConfigProvider(baseConfigProvider?: IConfigProviderBase): IConfigProviderBase {\n\tconst defaults = {\n\t\t...odspClientFeatureGates,\n\t\t...odspClientV1CompatFeatureGates,\n\t};\n\treturn wrapConfigProviderWithDefaults(baseConfigProvider, defaults);\n}\n\n/**\n * OdspClient provides the ability to have a Fluid object backed by the ODSP service within the context of Microsoft 365 (M365) tenants.\n * @sealed\n * @beta\n */\nexport class OdspClient {\n\tprivate readonly documentServiceFactory: IDocumentServiceFactory;\n\tprivate readonly urlResolver: OdspDriverUrlResolver;\n\tprivate readonly configProvider: IConfigProviderBase | undefined;\n\n\tpublic constructor(private readonly properties: OdspClientProps) {\n\t\tthis.documentServiceFactory = new OdspDocumentServiceFactory(\n\t\t\tasync (options) => getStorageToken(options, this.properties.connection.tokenProvider),\n\t\t\tasync (options) => getWebsocketToken(options, this.properties.connection.tokenProvider),\n\t\t);\n\n\t\tthis.urlResolver = new OdspDriverUrlResolver();\n\t\tthis.configProvider = wrapConfigProvider(properties.configProvider);\n\t}\n\n\tpublic async createContainer<T extends ContainerSchema>(\n\t\tcontainerSchema: T,\n\t): Promise<{\n\t\tcontainer: IFluidContainer<T>;\n\t\tservices: OdspContainerServices;\n\t}> {\n\t\tconst loader = this.createLoader(containerSchema);\n\n\t\tconst container = await loader.createDetachedContainer({\n\t\t\tpackage: \"no-dynamic-package\",\n\t\t\tconfig: {},\n\t\t});\n\n\t\tconst fluidContainer = await this.createFluidContainer(\n\t\t\tcontainer,\n\t\t\tthis.properties.connection,\n\t\t);\n\n\t\tconst services = await this.getContainerServices(container);\n\n\t\treturn { container: fluidContainer as IFluidContainer<T>, services };\n\t}\n\n\tpublic async getContainer<T extends ContainerSchema>(\n\t\tid: string,\n\t\tcontainerSchema: T,\n\t): Promise<{\n\t\tcontainer: IFluidContainer<T>;\n\t\tservices: OdspContainerServices;\n\t}> {\n\t\tconst loader = this.createLoader(containerSchema);\n\t\tconst url = createOdspUrl({\n\t\t\tsiteUrl: this.properties.connection.siteUrl,\n\t\t\tdriveId: this.properties.connection.driveId,\n\t\t\titemId: id,\n\t\t\tdataStorePath: \"\",\n\t\t});\n\t\tconst container = await loader.resolve({ url });\n\n\t\tconst fluidContainer = createFluidContainer({\n\t\t\tcontainer,\n\t\t\trootDataObject: await this.getContainerEntryPoint(container),\n\t\t});\n\t\tconst services = await this.getContainerServices(container);\n\t\treturn { container: fluidContainer as IFluidContainer<T>, services };\n\t}\n\n\tprivate createLoader(schema: ContainerSchema): Loader {\n\t\tconst runtimeFactory = createDOProviderContainerRuntimeFactory({\n\t\t\tschema,\n\t\t\tcompatibilityMode: \"2\",\n\t\t});\n\t\tconst load = async (): Promise<IFluidModuleWithDetails> => {\n\t\t\treturn {\n\t\t\t\tmodule: { fluidExport: runtimeFactory },\n\t\t\t\tdetails: { package: \"no-dynamic-package\", config: {} },\n\t\t\t};\n\t\t};\n\n\t\tconst codeLoader = { load };\n\t\tconst client: IClient = {\n\t\t\tdetails: {\n\t\t\t\tcapabilities: { interactive: true },\n\t\t\t},\n\t\t\tpermission: [],\n\t\t\tscopes: [],\n\t\t\tuser: { id: \"\" },\n\t\t\tmode: \"write\",\n\t\t};\n\n\t\treturn new Loader({\n\t\t\turlResolver: this.urlResolver,\n\t\t\tdocumentServiceFactory: this.documentServiceFactory,\n\t\t\tcodeLoader,\n\t\t\tlogger: this.properties.logger,\n\t\t\toptions: { client },\n\t\t\tconfigProvider: this.configProvider,\n\t\t});\n\t}\n\n\tprivate async createFluidContainer(\n\t\tcontainer: IContainer,\n\t\tconnection: OdspConnectionConfig,\n\t): Promise<IFluidContainer> {\n\t\tconst rootDataObject = await this.getContainerEntryPoint(container);\n\n\t\t/**\n\t\t * See {@link FluidContainer.attach}\n\t\t */\n\t\tconst attach = async (\n\t\t\todspProps?: ContainerAttachProps<OdspContainerAttachProps>,\n\t\t): Promise<string> => {\n\t\t\tconst createNewRequest: IRequest = createOdspCreateContainerRequest(\n\t\t\t\tconnection.siteUrl,\n\t\t\t\tconnection.driveId,\n\t\t\t\todspProps?.filePath ?? \"\",\n\t\t\t\todspProps?.fileName ?? uuid(),\n\t\t\t);\n\t\t\tif (container.attachState !== AttachState.Detached) {\n\t\t\t\tthrow new Error(\"Cannot attach container. Container is not in detached state\");\n\t\t\t}\n\t\t\tawait container.attach(createNewRequest);\n\n\t\t\tconst resolvedUrl = container.resolvedUrl;\n\n\t\t\tif (resolvedUrl === undefined || !isOdspResolvedUrl(resolvedUrl)) {\n\t\t\t\tthrow new Error(\"Resolved Url not available on attached container\");\n\t\t\t}\n\n\t\t\t/**\n\t\t\t * A unique identifier for the file within the provided SharePoint Embedded container ID. When you attach a container,\n\t\t\t * a new `itemId` is created in the user's drive, which developers can use for various operations\n\t\t\t * like updating, renaming, moving the Fluid file, changing permissions, and more. `itemId` is used to load the container.\n\t\t\t */\n\t\t\treturn resolvedUrl.itemId;\n\t\t};\n\t\tconst fluidContainer = createFluidContainer({ container, rootDataObject });\n\t\tfluidContainer.attach = attach;\n\t\treturn fluidContainer;\n\t}\n\n\tprivate async getContainerServices(container: IContainer): Promise<OdspContainerServices> {\n\t\treturn {\n\t\t\taudience: createServiceAudience({\n\t\t\t\tcontainer,\n\t\t\t\tcreateServiceMember: createOdspAudienceMember,\n\t\t\t}),\n\t\t};\n\t}\n\n\tprivate async getContainerEntryPoint(container: IContainer): Promise<IRootDataObject> {\n\t\tconst rootDataObject: FluidObject<IRootDataObject> = await container.getEntryPoint();\n\t\tassert(\n\t\t\trootDataObject.IRootDataObject !== undefined,\n\t\t\t0x878 /* entryPoint must be of type IRootDataObject */,\n\t\t);\n\t\treturn rootDataObject.IRootDataObject;\n\t}\n}\n"]}

package/lib/token.d.ts

@@ -0,0 +1,35 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { TokenResponse } from "@fluidframework/odsp-driver-definitions/internal";
+/**
+ * Abstracts the token fetching mechanism for a hosting application.
+ * The hosting application is responsible for providing an implementation.
+ * @beta
+ */
+export interface IOdspTokenProvider {
+    /**
+     * Fetches the orderer token from host.
+     *
+     * @param siteUrl - Site url representing ODSP resource location. It points to the specific SharePoint site where you can store and access the containers you create.
+     * @param refresh - Optional flag indicating whether token fetch must bypass local cache.
+     * This likely indicates that some previous request failed authorization due to an expired token,
+     * and so a fresh token is required.
+     *
+     * Default: `false`.
+     */
+    fetchWebsocketToken(siteUrl: string, refresh: boolean): Promise<TokenResponse>;
+    /**
+     * Fetches the storage token from host.
+     *
+     * @param siteUrl - Site url representing ODSP resource location. It points to the specific SharePoint site where you can store and access the containers you create.
+     * @param refresh - Optional flag indicating whether token fetch must bypass local cache.
+     * This likely indicates that some previous request failed authorization due to an expired token,
+     * and so a fresh token is required.
+     *
+     * Default: `false`.
+     */
+    fetchStorageToken(siteUrl: string, refresh: boolean): Promise<TokenResponse>;
+}
+//# sourceMappingURL=token.d.ts.map

package/lib/token.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"token.d.ts","sourceRoot":"","sources":["../src/token.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,kDAAkD,CAAC;AAEjF;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IAClC;;;;;;;;;OASG;IACH,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAE/E;;;;;;;;;OASG;IACH,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;CAC7E"}

package/lib/token.js

@@ -0,0 +1,6 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export {};
+//# sourceMappingURL=token.js.map

package/lib/token.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"token.js","sourceRoot":"","sources":["../src/token.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 { TokenResponse } from \"@fluidframework/odsp-driver-definitions/internal\";\n\n/**\n * Abstracts the token fetching mechanism for a hosting application.\n * The hosting application is responsible for providing an implementation.\n * @beta\n */\nexport interface IOdspTokenProvider {\n\t/**\n\t * Fetches the orderer token from host.\n\t *\n\t * @param siteUrl - 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 * @param refresh - Optional flag indicating whether token fetch must bypass local cache.\n\t * This likely indicates that some previous request failed authorization due to an expired token,\n\t * and so a fresh token is required.\n\t *\n\t * Default: `false`.\n\t */\n\tfetchWebsocketToken(siteUrl: string, refresh: boolean): Promise<TokenResponse>;\n\n\t/**\n\t * Fetches the storage token from host.\n\t *\n\t * @param siteUrl - 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 * @param refresh - Optional flag indicating whether token fetch must bypass local cache.\n\t * This likely indicates that some previous request failed authorization due to an expired token,\n\t * and so a fresh token is required.\n\t *\n\t * Default: `false`.\n\t */\n\tfetchStorageToken(siteUrl: string, refresh: boolean): Promise<TokenResponse>;\n}\n"]}

package/lib/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.45.1"
+    }
+  ]
+}

package/package.json

@@ -0,0 +1,138 @@
+{
+  "name": "@fluidframework/odsp-client",
+  "version": "2.0.0-dev-rc.5.0.0.270401",
+  "description": "A tool to enable creation and loading of Fluid containers using the ODSP service",
+  "homepage": "https://fluidframework.com",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/microsoft/FluidFramework.git",
+    "directory": "packages/service-clients/odsp-client"
+  },
+  "license": "MIT",
+  "author": "Microsoft and contributors",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./lib/index.d.ts",
+        "default": "./lib/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
+    "./beta": {
+      "import": {
+        "types": "./lib/beta.d.ts",
+        "default": "./lib/index.js"
+      },
+      "require": {
+        "types": "./dist/beta.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
+    "./internal": {
+      "import": {
+        "types": "./lib/index.d.ts",
+        "default": "./lib/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    }
+  },
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "c8": {
+    "all": true,
+    "cache-dir": "nyc/.cache",
+    "exclude": [
+      "src/test/**/*.*ts",
+      "dist/test/**/*.*js"
+    ],
+    "exclude-after-remap": false,
+    "include": [
+      "src/**/*.*ts",
+      "dist/**/*.*js"
+    ],
+    "report-dir": "nyc/report",
+    "reporter": [
+      "cobertura",
+      "html",
+      "text"
+    ],
+    "temp-directory": "nyc/.nyc_output"
+  },
+  "dependencies": {
+    "@fluidframework/container-definitions": "2.0.0-dev-rc.5.0.0.270401",
+    "@fluidframework/container-loader": "2.0.0-dev-rc.5.0.0.270401",
+    "@fluidframework/core-interfaces": "2.0.0-dev-rc.5.0.0.270401",
+    "@fluidframework/core-utils": "2.0.0-dev-rc.5.0.0.270401",
+    "@fluidframework/driver-definitions": "2.0.0-dev-rc.5.0.0.270401",
+    "@fluidframework/fluid-static": "2.0.0-dev-rc.5.0.0.270401",
+    "@fluidframework/map": "2.0.0-dev-rc.5.0.0.270401",
+    "@fluidframework/odsp-doclib-utils": "2.0.0-dev-rc.5.0.0.270401",
+    "@fluidframework/odsp-driver": "2.0.0-dev-rc.5.0.0.270401",
+    "@fluidframework/odsp-driver-definitions": "2.0.0-dev-rc.5.0.0.270401",
+    "@fluidframework/telemetry-utils": "2.0.0-dev-rc.5.0.0.270401",
+    "uuid": "^9.0.0"
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "^0.15.2",
+    "@biomejs/biome": "^1.7.3",
+    "@fluid-internal/mocha-test-setup": "2.0.0-dev-rc.5.0.0.270401",
+    "@fluid-tools/build-cli": "^0.39.0-264124",
+    "@fluidframework/build-common": "^2.0.3",
+    "@fluidframework/build-tools": "^0.39.0-264124",
+    "@fluidframework/eslint-config-fluid": "^5.3.0",
+    "@fluidframework/test-utils": "2.0.0-dev-rc.5.0.0.270401",
+    "@microsoft/api-extractor": "^7.45.1",
+    "@types/mocha": "^9.1.1",
+    "@types/node": "^18.19.0",
+    "@types/uuid": "^9.0.2",
+    "c8": "^8.0.1",
+    "copyfiles": "^2.4.1",
+    "cross-env": "^7.0.3",
+    "eslint": "~8.55.0",
+    "mocha": "^10.2.0",
+    "prettier": "~3.0.3",
+    "rimraf": "^4.4.0",
+    "typescript": "~5.4.5"
+  },
+  "typeValidation": {
+    "disabled": true,
+    "broken": {}
+  },
+  "scripts": {
+    "api": "fluid-build . --task api",
+    "api-extractor:commonjs": "flub generate entrypoints --outFileAlpha legacy --outDir ./dist",
+    "api-extractor:esnext": "flub generate entrypoints --outFileAlpha legacy --outDir ./lib --node10TypeCompat",
+    "build": "fluid-build . --task build",
+    "build:commonjs": "fluid-build . --task commonjs",
+    "build:compile": "fluid-build . --task compile",
+    "build:docs": "api-extractor run --local",
+    "build:esnext": "tsc --project ./tsconfig.json",
+    "build:test": "npm run build:test:esm && npm run build:test:cjs",
+    "build:test:cjs": "fluid-tsc commonjs --project ./src/test/tsconfig.cjs.json",
+    "build:test:esm": "tsc --project ./src/test/tsconfig.json",
+    "check:are-the-types-wrong": "attw --pack .",
+    "check:prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
+    "check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",
+    "ci:build:docs": "api-extractor run",
+    "clean": "rimraf --glob dist lib \"*.d.ts\" \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp nyc",
+    "eslint": "eslint --format stylish src",
+    "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
+    "format": "fluid-build --task format .",
+    "format:prettier": "prettier --write . --cache --ignore-path ../../../.prettierignore",
+    "lint": "fluid-build . --task lint",
+    "lint:fix": "fluid-build . --task eslint:fix --task format",
+    "test": "npm run test:mocha",
+    "test:mocha": "npm run test:mocha:esm && echo skipping cjs to avoid overhead - npm run test:mocha:cjs",
+    "test:mocha:cjs": "mocha --recursive \"dist/test/**/*.spec.*js\" --exit --timeout 10000",
+    "test:mocha:esm": "mocha --recursive \"lib/test/**/*.spec.*js\" --exit --timeout 10000",
+    "tsc": "fluid-tsc commonjs --project ./tsconfig.cjs.json && copyfiles -f ../../../common/build/build-common/src/cjs/package.json ./dist"
+  }
+}

package/prettier.config.cjs

@@ -0,0 +1,8 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+module.exports = {
+	...require("@fluidframework/build-common/prettier.config.cjs"),
+};

package/src/index.ts

@@ -0,0 +1,25 @@
+/*!
+ * 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";

package/src/interfaces.ts

@@ -0,0 +1,114 @@
+/*!
+ * 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>;

package/src/odspAudience.ts

@@ -0,0 +1,44 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { assert } from "@fluidframework/core-utils/internal";
+import { type IClient } from "@fluidframework/driver-definitions";
+
+import { type OdspMember } from "./interfaces.js";
+
+/**
+ * Since ODSP provides user names, email and oids for all of its members, we extend the
+ * {@link @fluidframework/fluid-static#IMember} interface to include this service-specific value.
+ * @internal
+ */
+interface OdspUser {
+	/**
+	 * The user's email address
+	 */
+	email: string;
+	/**
+	 * The user's name
+	 */
+	name: string;
+	/**
+	 * 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.
+	 */
+	oid: string;
+}
+
+export function createOdspAudienceMember(audienceMember: IClient): OdspMember {
+	const user = audienceMember.user as unknown as OdspUser;
+	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: [],
+	};
+}