@fluidframework/odsp-client 2.1.0-276326 → 2.1.0-276985

package/README.md

@@ -2,6 +2,41 @@
 
 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.
 
+<!-- AUTO-GENERATED-CONTENT:START (README_DEPENDENCY_GUIDELINES_SECTION:includeHeading=TRUE) -->
+
+<!-- prettier-ignore-start -->
+<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
+
+## Using Fluid Framework libraries
+
+When taking a dependency on a Fluid Framework library's public APIs, we recommend using a `^` (caret) version range, such as `^1.3.4`.
+While Fluid Framework libraries may use different ranges with interdependencies between other Fluid Framework libraries,
+library consumers should always prefer `^`.
+
+If using any of Fluid Framework's unstable APIs (for example, its `beta` APIs), we recommend using a more constrained version range, such as `~`.
+
+<!-- prettier-ignore-end -->
+
+<!-- AUTO-GENERATED-CONTENT:END -->
+
+<!-- AUTO-GENERATED-CONTENT:START (README_IMPORT_INSTRUCTIONS:includeHeading=TRUE) -->
+
+<!-- prettier-ignore-start -->
+<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
+
+## Importing from this package
+
+This package leverages [package.json exports](https://nodejs.org/api/packages.html#exports) to separate its APIs by support level.
+For more information on the related support guarantees, see [API Support Levels](https://fluidframework.com/docs/build/releases-and-apitags/#api-support-levels).
+
+To access the `public` ([SemVer](https://semver.org/)) APIs, import via `@fluidframework/odsp-client` like normal.
+
+To access the `beta` APIs, import via `@fluidframework/odsp-client/beta`.
+
+<!-- prettier-ignore-end -->
+
+<!-- AUTO-GENERATED-CONTENT:END -->
+
 ## Using odsp-client
 
 The odsp-client package has an `OdspClient` class that allows you to interact with Fluid.
@@ -107,3 +142,50 @@ const initialObjects = container.initialObjects;
 const map1 = initialObjects.map1;
 const text1 = initialObjects.text1;
 ```
+
+<!-- AUTO-GENERATED-CONTENT:START (LIBRARY_PACKAGE_README:scripts=FALSE&installation=FALSE&importInstructions=FALSE) -->
+
+<!-- prettier-ignore-start -->
+<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
+
+## API Documentation
+
+API documentation for **@fluidframework/odsp-client** is available at <https://fluidframework.com/docs/apis/odsp-client>.
+
+## Contribution Guidelines
+
+There are many ways to [contribute](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md) to Fluid.
+
+-   Participate in Q&A in our [GitHub Discussions](https://github.com/microsoft/FluidFramework/discussions).
+-   [Submit bugs](https://github.com/microsoft/FluidFramework/issues) and help us verify fixes as they are checked in.
+-   Review the [source code changes](https://github.com/microsoft/FluidFramework/pulls).
+-   [Contribute bug fixes](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md).
+
+Detailed instructions for working in the repo can be found in the [Wiki](https://github.com/microsoft/FluidFramework/wiki).
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
+
+This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
+Use of these trademarks or logos must follow Microsoft’s [Trademark & Brand Guidelines](https://www.microsoft.com/trademarks).
+Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
+
+## Help
+
+Not finding what you're looking for in this README? Check out [fluidframework.com](https://fluidframework.com/docs/).
+
+Still not finding what you're looking for? Please [file an issue](https://github.com/microsoft/FluidFramework/wiki/Submitting-Bugs-and-Feature-Requests).
+
+Thank you!
+
+## Trademark
+
+This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
+
+Use of these trademarks or logos must follow Microsoft's [Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
+
+Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
+
+<!-- prettier-ignore-end -->
+
+<!-- AUTO-GENERATED-CONTENT:END -->

package/api-extractor/{api-extractor-lint-index.esm.json → api-extractor-lint-public.cjs.json}

@@ -1,5 +1,5 @@
 {
 	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
 	"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-lint.entrypoint.json",
-	"mainEntryPointFilePath": "<projectFolder>/lib/index.d.ts"
+	"mainEntryPointFilePath": "<projectFolder>/dist/public.d.ts"
 }

package/api-extractor/{api-extractor-lint-index.cjs.json → api-extractor-lint-public.esm.json}

@@ -1,5 +1,5 @@
 {
 	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
 	"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-lint.entrypoint.json",
-	"mainEntryPointFilePath": "<projectFolder>/dist/index.d.ts"
+	"mainEntryPointFilePath": "<projectFolder>/lib/public.d.ts"
 }

package/dist/public.d.ts

@@ -0,0 +1,12 @@
+/*!
+ * 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 {}
+

package/lib/public.d.ts

@@ -0,0 +1,12 @@
+/*!
+ * 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 {}
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/odsp-client",
-  "version": "2.1.0-276326",
+  "version": "2.1.0-276985",
   "description": "A tool to enable creation and loading of Fluid containers using the ODSP service",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -15,11 +15,11 @@
   "exports": {
     ".": {
       "import": {
-        "types": "./lib/index.d.ts",
+        "types": "./lib/public.d.ts",
         "default": "./lib/index.js"
       },
       "require": {
-        "types": "./dist/index.d.ts",
+        "types": "./dist/public.d.ts",
         "default": "./dist/index.js"
       }
     },
@@ -45,7 +45,7 @@
     }
   },
   "main": "lib/index.js",
-  "types": "lib/index.d.ts",
+  "types": "lib/public.d.ts",
   "c8": {
     "all": true,
     "cache-dir": "nyc/.cache",
@@ -67,28 +67,28 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluidframework/container-definitions": "2.1.0-276326",
-    "@fluidframework/container-loader": "2.1.0-276326",
-    "@fluidframework/core-interfaces": "2.1.0-276326",
-    "@fluidframework/core-utils": "2.1.0-276326",
-    "@fluidframework/driver-definitions": "2.1.0-276326",
-    "@fluidframework/fluid-static": "2.1.0-276326",
-    "@fluidframework/map": "2.1.0-276326",
-    "@fluidframework/odsp-doclib-utils": "2.1.0-276326",
-    "@fluidframework/odsp-driver": "2.1.0-276326",
-    "@fluidframework/odsp-driver-definitions": "2.1.0-276326",
-    "@fluidframework/telemetry-utils": "2.1.0-276326",
+    "@fluidframework/container-definitions": "2.1.0-276985",
+    "@fluidframework/container-loader": "2.1.0-276985",
+    "@fluidframework/core-interfaces": "2.1.0-276985",
+    "@fluidframework/core-utils": "2.1.0-276985",
+    "@fluidframework/driver-definitions": "2.1.0-276985",
+    "@fluidframework/fluid-static": "2.1.0-276985",
+    "@fluidframework/map": "2.1.0-276985",
+    "@fluidframework/odsp-doclib-utils": "2.1.0-276985",
+    "@fluidframework/odsp-driver": "2.1.0-276985",
+    "@fluidframework/odsp-driver-definitions": "2.1.0-276985",
+    "@fluidframework/telemetry-utils": "2.1.0-276985",
     "uuid": "^9.0.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.15.2",
     "@biomejs/biome": "^1.7.3",
-    "@fluid-internal/mocha-test-setup": "2.1.0-276326",
+    "@fluid-internal/mocha-test-setup": "2.1.0-276985",
     "@fluid-tools/build-cli": "^0.39.0",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.39.0",
     "@fluidframework/eslint-config-fluid": "^5.3.0",
-    "@fluidframework/test-utils": "2.1.0-276326",
+    "@fluidframework/test-utils": "2.1.0-276985",
     "@microsoft/api-extractor": "^7.45.1",
     "@types/mocha": "^9.1.1",
     "@types/node": "^18.19.0",
@@ -124,9 +124,9 @@
     "check:exports": "concurrently \"npm:check:exports:*\"",
     "check:exports:bundle-release-tags": "api-extractor run --config api-extractor/api-extractor-lint-bundle.json",
     "check:exports:cjs:beta": "api-extractor run --config api-extractor/api-extractor-lint-beta.cjs.json",
-    "check:exports:cjs:index": "api-extractor run --config api-extractor/api-extractor-lint-index.cjs.json",
+    "check:exports:cjs:public": "api-extractor run --config api-extractor/api-extractor-lint-public.cjs.json",
     "check:exports:esm:beta": "api-extractor run --config api-extractor/api-extractor-lint-beta.esm.json",
-    "check:exports:esm:index": "api-extractor run --config api-extractor/api-extractor-lint-index.esm.json",
+    "check:exports:esm:public": "api-extractor run --config api-extractor/api-extractor-lint-public.esm.json",
     "check:format": "npm run check:biome",
     "check:prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
     "ci:build:docs": "api-extractor run",