From 607654c2c4f45cc36b62caa9aaa8c8052207666a Mon Sep 17 00:00:00 2001 From: MarioJGMsoft Date: Tue, 25 Feb 2025 17:46:04 +0000 Subject: [PATCH 01/20] refactor: created overload so that we can properly deprecate the parameter containerPackageInfo --- .../odsp-driver.legacy.alpha.api.md | 3 ++ .../src/createOdspCreateContainerRequest.ts | 30 +++++++++++++++++++ 2 files changed, 33 insertions(+) diff --git a/packages/drivers/odsp-driver/api-report/odsp-driver.legacy.alpha.api.md b/packages/drivers/odsp-driver/api-report/odsp-driver.legacy.alpha.api.md index e1367bf0ac9b..4fc502d2c95d 100644 --- a/packages/drivers/odsp-driver/api-report/odsp-driver.legacy.alpha.api.md +++ b/packages/drivers/odsp-driver/api-report/odsp-driver.legacy.alpha.api.md @@ -11,6 +11,9 @@ export function checkUrl(documentUrl: URL): DriverPreCheckInfo | undefined; export function createLocalOdspDocumentServiceFactory(localSnapshot: Uint8Array | string): IDocumentServiceFactory; // @alpha +export function createOdspCreateContainerRequest(siteUrl: string, driveId: string, filePath: string, fileName: string, createShareLinkType?: ISharingLinkKind): IRequest; + +// @alpha @deprecated export function createOdspCreateContainerRequest(siteUrl: string, driveId: string, filePath: string, fileName: string, createShareLinkType?: ISharingLinkKind, containerPackageInfo?: IContainerPackageInfo | undefined): IRequest; // @alpha diff --git a/packages/drivers/odsp-driver/src/createOdspCreateContainerRequest.ts b/packages/drivers/odsp-driver/src/createOdspCreateContainerRequest.ts index f1bf103e2856..ef27abf2907a 100644 --- a/packages/drivers/odsp-driver/src/createOdspCreateContainerRequest.ts +++ b/packages/drivers/odsp-driver/src/createOdspCreateContainerRequest.ts @@ -12,6 +12,36 @@ import { ISharingLinkKind } from "@fluidframework/odsp-driver-definitions/intern import { buildOdspShareLinkReqParams, getContainerPackageName } from "./odspUtils.js"; +/** + * Original version of createOdspCreateContainerRequest + * @legacy + * @alpha + */ +export function createOdspCreateContainerRequest( + siteUrl: string, + driveId: string, + filePath: string, + fileName: string, + createShareLinkType?: ISharingLinkKind, +): IRequest; + +/** + * Overloaded version of createOdspCreateContainerRequest that takes in containerPackageInfo + * @legacy + * @alpha + * @deprecated - To be removed in 2.40 + * Add containerPackageInfo to the OdspDriverUrlResolverForShareLink constructor instead; see https://github.com/microsoft/FluidFramework/issues/23882 for more details. + * Deprecating overloaded function to remove containerPackageInfo + */ +export function createOdspCreateContainerRequest( + siteUrl: string, + driveId: string, + filePath: string, + fileName: string, + createShareLinkType?: ISharingLinkKind, + containerPackageInfo?: IContainerPackageInfo | undefined, +): IRequest; + /** * Create the request object with url and headers for creating a new file on OneDrive Sharepoint * @param siteUrl - Base url for OneDrive From ef5d85062cb17851695d53a772d1a799b546f6c9 Mon Sep 17 00:00:00 2001 From: MarioJGMsoft Date: Tue, 25 Feb 2025 18:31:00 +0000 Subject: [PATCH 02/20] refactor: had to disable import no deprecated. --- examples/utils/webpack-fluid-loader/src/odspUrlResolver.ts | 2 ++ packages/service-clients/odsp-client/src/odspClient.ts | 2 ++ packages/test/test-drivers/src/odspDriverApi.ts | 2 ++ 3 files changed, 6 insertions(+) diff --git a/examples/utils/webpack-fluid-loader/src/odspUrlResolver.ts b/examples/utils/webpack-fluid-loader/src/odspUrlResolver.ts index c0c11f372d81..79ef929a4959 100644 --- a/examples/utils/webpack-fluid-loader/src/odspUrlResolver.ts +++ b/examples/utils/webpack-fluid-loader/src/odspUrlResolver.ts @@ -11,6 +11,7 @@ import { } from "@fluidframework/odsp-doclib-utils/internal"; import { OdspDriverUrlResolver, + // eslint-disable-next-line import/no-deprecated createOdspCreateContainerRequest, createOdspUrl, } from "@fluidframework/odsp-driver/internal"; @@ -75,6 +76,7 @@ export class OdspUrlResolver implements IUrlResolver { this.authRequestInfo, false, ); + // eslint-disable-next-line import/no-deprecated return createOdspCreateContainerRequest( `https://${this.server}`, driveId, diff --git a/packages/service-clients/odsp-client/src/odspClient.ts b/packages/service-clients/odsp-client/src/odspClient.ts index 7f8435a15109..3b51d4622500 100644 --- a/packages/service-clients/odsp-client/src/odspClient.ts +++ b/packages/service-clients/odsp-client/src/odspClient.ts @@ -36,6 +36,7 @@ import { import { OdspDocumentServiceFactory, OdspDriverUrlResolver, + // eslint-disable-next-line import/no-deprecated createOdspCreateContainerRequest, createOdspUrl, isOdspResolvedUrl, @@ -209,6 +210,7 @@ export class OdspClient { const attach = async ( odspProps?: ContainerAttachProps, ): Promise => { + // eslint-disable-next-line import/no-deprecated const createNewRequest: IRequest = createOdspCreateContainerRequest( connection.siteUrl, connection.driveId, diff --git a/packages/test/test-drivers/src/odspDriverApi.ts b/packages/test/test-drivers/src/odspDriverApi.ts index f92997e5fd67..16219145c66a 100644 --- a/packages/test/test-drivers/src/odspDriverApi.ts +++ b/packages/test/test-drivers/src/odspDriverApi.ts @@ -12,6 +12,7 @@ import { import { OdspDocumentServiceFactory, OdspDriverUrlResolver, + // eslint-disable-next-line import/no-deprecated createOdspCreateContainerRequest, createOdspUrl, } from "@fluidframework/odsp-driver/internal"; @@ -31,6 +32,7 @@ export const OdspDriverApi = { version: pkgVersion, OdspDocumentServiceFactory, OdspDriverUrlResolver, + // eslint-disable-next-line import/no-deprecated createOdspCreateContainerRequest, createOdspUrl, // REVIEW: does this need to be back compat? }; From 7596a0cf304cd68d4330bf2dd75b70a5a5fb8970 Mon Sep 17 00:00:00 2001 From: MarioJGMsoft Date: Wed, 5 Mar 2025 19:17:09 +0000 Subject: [PATCH 03/20] docs: added changelist --- .changeset/weaked-eagles-search.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 .changeset/weaked-eagles-search.md diff --git a/.changeset/weaked-eagles-search.md b/.changeset/weaked-eagles-search.md new file mode 100644 index 000000000000..1a5b392d395b --- /dev/null +++ b/.changeset/weaked-eagles-search.md @@ -0,0 +1,14 @@ +--- +"@fluidframework/odsp-driver": minor +--- +--- +"section": deprecation +--- + +createOdspCreateContainerRequest().containerPackageInfo is now deprecated + +The parameter `containerPackageInfo` in `createOdspCreateContainerRequest()` is deprecated and will be removed in version 2.40. + +This will mean that the name of the containerPackage can no longer be sent through the request. Instead it can be added in the constructor of `OdspDriverUrlResolverForShareLink`. + + See [issue] (https://github.com/microsoft/FluidFramework/issues/23882) for details. From d2a4e9e4dd2ee93a7452c0db10cf7c9c14036c20 Mon Sep 17 00:00:00 2001 From: MarioJGMsoft Date: Wed, 5 Mar 2025 19:17:25 +0000 Subject: [PATCH 04/20] docs: updated text format --- .changeset/weaked-eagles-search.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.changeset/weaked-eagles-search.md b/.changeset/weaked-eagles-search.md index 1a5b392d395b..dfb66d25ab88 100644 --- a/.changeset/weaked-eagles-search.md +++ b/.changeset/weaked-eagles-search.md @@ -11,4 +11,4 @@ The parameter `containerPackageInfo` in `createOdspCreateContainerRequest()` is This will mean that the name of the containerPackage can no longer be sent through the request. Instead it can be added in the constructor of `OdspDriverUrlResolverForShareLink`. - See [issue] (https://github.com/microsoft/FluidFramework/issues/23882) for details. +See [issue] (https://github.com/microsoft/FluidFramework/issues/23882) for details. From f8a5b180dee624bf920b810fce9c540d37f33b71 Mon Sep 17 00:00:00 2001 From: MarioJGMsoft Date: Wed, 5 Mar 2025 22:13:11 +0000 Subject: [PATCH 05/20] docs: updated comments --- .../src/createOdspCreateContainerRequest.ts | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/packages/drivers/odsp-driver/src/createOdspCreateContainerRequest.ts b/packages/drivers/odsp-driver/src/createOdspCreateContainerRequest.ts index ef27abf2907a..7566f1e0702c 100644 --- a/packages/drivers/odsp-driver/src/createOdspCreateContainerRequest.ts +++ b/packages/drivers/odsp-driver/src/createOdspCreateContainerRequest.ts @@ -13,7 +13,13 @@ import { ISharingLinkKind } from "@fluidframework/odsp-driver-definitions/intern import { buildOdspShareLinkReqParams, getContainerPackageName } from "./odspUtils.js"; /** - * Original version of createOdspCreateContainerRequest + * Create the request object with url and headers for creating a new file on OneDrive Sharepoint + * @param siteUrl - Base url for OneDrive + * @param driveId - drive identifier + * @param filePath - path where file needs to be created + * @param fileName - name of the new file to be created + * @param createShareLinkType - type of sharing link you would like to create for this file. ShareLinkTypes + * will be deprecated soon, so for any new implementation please provide createShareLinkType of type ShareLink * @legacy * @alpha */ @@ -27,9 +33,17 @@ export function createOdspCreateContainerRequest( /** * Overloaded version of createOdspCreateContainerRequest that takes in containerPackageInfo + * @param siteUrl - Base url for OneDrive + * @param driveId - drive identifier + * @param filePath - path where file needs to be created + * @param fileName - name of the new file to be created + * @param createShareLinkType - type of sharing link you would like to create for this file. ShareLinkTypes + * will be deprecated soon, so for any new implementation please provide createShareLinkType of type ShareLink + * @param containerPackageInfo - **DEPRECATED PARAMETER** - container package information which will be used to extract the container package name. + * If not given that means that the container package does not have a name. * @legacy * @alpha - * @deprecated - To be removed in 2.40 + * @deprecated To be removed in 2.40 * Add containerPackageInfo to the OdspDriverUrlResolverForShareLink constructor instead; see https://github.com/microsoft/FluidFramework/issues/23882 for more details. * Deprecating overloaded function to remove containerPackageInfo */ From 4c771d18ceed183d7b95878104b705619e71c2d1 Mon Sep 17 00:00:00 2001 From: MarioJGMsoft Date: Wed, 5 Mar 2025 22:16:35 +0000 Subject: [PATCH 06/20] docs: changed changeset doc name --- .changeset/{weaked-eagles-search.md => wicked-eagles-search.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .changeset/{weaked-eagles-search.md => wicked-eagles-search.md} (100%) diff --git a/.changeset/weaked-eagles-search.md b/.changeset/wicked-eagles-search.md similarity index 100% rename from .changeset/weaked-eagles-search.md rename to .changeset/wicked-eagles-search.md From f47b59c9bb6615a3dcd6d16d2d3a1acd6eeeaf57 Mon Sep 17 00:00:00 2001 From: MarioJGMsoft Date: Wed, 5 Mar 2025 22:34:06 +0000 Subject: [PATCH 07/20] docs: updated comment --- .../odsp-driver/src/createOdspCreateContainerRequest.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/drivers/odsp-driver/src/createOdspCreateContainerRequest.ts b/packages/drivers/odsp-driver/src/createOdspCreateContainerRequest.ts index 7566f1e0702c..d6fd22342888 100644 --- a/packages/drivers/odsp-driver/src/createOdspCreateContainerRequest.ts +++ b/packages/drivers/odsp-driver/src/createOdspCreateContainerRequest.ts @@ -39,7 +39,7 @@ export function createOdspCreateContainerRequest( * @param fileName - name of the new file to be created * @param createShareLinkType - type of sharing link you would like to create for this file. ShareLinkTypes * will be deprecated soon, so for any new implementation please provide createShareLinkType of type ShareLink - * @param containerPackageInfo - **DEPRECATED PARAMETER** - container package information which will be used to extract the container package name. + * @param containerPackageInfo - **Deprecated Parameter** - container package information which will be used to extract the container package name. * If not given that means that the container package does not have a name. * @legacy * @alpha @@ -64,7 +64,7 @@ export function createOdspCreateContainerRequest( * @param fileName - name of the new file to be created * @param createShareLinkType - type of sharing link you would like to create for this file. ShareLinkTypes * will be deprecated soon, so for any new implementation please provide createShareLinkType of type ShareLink - * @param containerPackageInfo - container package information which will be used to extract the container package name. + * @deprecated This parameter is deprecated @param containerPackageInfo - **Deprecated Parameter** - container package information which will be used to extract the container package name. * If not given that means that the container package does not have a name. * @legacy * @alpha From 93c452c563b7689bc9a8a5d5df203e9647558f37 Mon Sep 17 00:00:00 2001 From: MarioJGMsoft Date: Wed, 5 Mar 2025 23:00:06 +0000 Subject: [PATCH 08/20] docs: updated changeset --- .changeset/wicked-eagles-search.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.changeset/wicked-eagles-search.md b/.changeset/wicked-eagles-search.md index dfb66d25ab88..1ea62239cf45 100644 --- a/.changeset/wicked-eagles-search.md +++ b/.changeset/wicked-eagles-search.md @@ -5,7 +5,7 @@ "section": deprecation --- -createOdspCreateContainerRequest().containerPackageInfo is now deprecated +The containerPackageInfo parameter of the createOdspCreateContainerRequest() function will be deprecated and removed in 2.40. The parameter `containerPackageInfo` in `createOdspCreateContainerRequest()` is deprecated and will be removed in version 2.40. From a0816bc1568b68acccf286a2a5337dc4350e5614 Mon Sep 17 00:00:00 2001 From: MarioJGMsoft Date: Thu, 6 Mar 2025 17:38:03 +0000 Subject: [PATCH 09/20] docs: updated changeset --- .changeset/wicked-eagles-search.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.changeset/wicked-eagles-search.md b/.changeset/wicked-eagles-search.md index 1ea62239cf45..bc1a11572e31 100644 --- a/.changeset/wicked-eagles-search.md +++ b/.changeset/wicked-eagles-search.md @@ -5,7 +5,7 @@ "section": deprecation --- -The containerPackageInfo parameter of the createOdspCreateContainerRequest() function will be deprecated and removed in 2.40. +The containerPackageInfo parameter of the createOdspCreateContainerRequest() function is deprecated and will be removed in 2.40. The parameter `containerPackageInfo` in `createOdspCreateContainerRequest()` is deprecated and will be removed in version 2.40. From 0016c717b19613699d06121c4af0bec391a470a9 Mon Sep 17 00:00:00 2001 From: MarioJGMsoft Date: Thu, 6 Mar 2025 17:45:14 +0000 Subject: [PATCH 10/20] docs: updated changeset based on comments --- .changeset/wicked-eagles-search.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/.changeset/wicked-eagles-search.md b/.changeset/wicked-eagles-search.md index bc1a11572e31..91456c607232 100644 --- a/.changeset/wicked-eagles-search.md +++ b/.changeset/wicked-eagles-search.md @@ -5,8 +5,6 @@ "section": deprecation --- -The containerPackageInfo parameter of the createOdspCreateContainerRequest() function is deprecated and will be removed in 2.40. - The parameter `containerPackageInfo` in `createOdspCreateContainerRequest()` is deprecated and will be removed in version 2.40. This will mean that the name of the containerPackage can no longer be sent through the request. Instead it can be added in the constructor of `OdspDriverUrlResolverForShareLink`. From 7a3f852b6d9c85eb7d8c98104c2adda00cc4be1c Mon Sep 17 00:00:00 2001 From: MarioJGMsoft Date: Wed, 19 Mar 2025 23:10:17 +0000 Subject: [PATCH 11/20] refactor: added fix for eslint deprecation problems --- .../src/odspUrlResolver.ts | 2 -- .../odsp-driver.legacy.alpha.api.md | 6 +++--- .../src/createOdspCreateContainerRequest.ts | 20 +++++++++---------- .../odsp-client/src/odspClient.ts | 2 -- 4 files changed, 13 insertions(+), 17 deletions(-) diff --git a/examples/utils/webpack-fluid-loader/src/odspUrlResolver.ts b/examples/utils/webpack-fluid-loader/src/odspUrlResolver.ts index 79ef929a4959..c0c11f372d81 100644 --- a/examples/utils/webpack-fluid-loader/src/odspUrlResolver.ts +++ b/examples/utils/webpack-fluid-loader/src/odspUrlResolver.ts @@ -11,7 +11,6 @@ import { } from "@fluidframework/odsp-doclib-utils/internal"; import { OdspDriverUrlResolver, - // eslint-disable-next-line import/no-deprecated createOdspCreateContainerRequest, createOdspUrl, } from "@fluidframework/odsp-driver/internal"; @@ -76,7 +75,6 @@ export class OdspUrlResolver implements IUrlResolver { this.authRequestInfo, false, ); - // eslint-disable-next-line import/no-deprecated return createOdspCreateContainerRequest( `https://${this.server}`, driveId, diff --git a/packages/drivers/odsp-driver/api-report/odsp-driver.legacy.alpha.api.md b/packages/drivers/odsp-driver/api-report/odsp-driver.legacy.alpha.api.md index f5d7410f50af..40b9103b9a0b 100644 --- a/packages/drivers/odsp-driver/api-report/odsp-driver.legacy.alpha.api.md +++ b/packages/drivers/odsp-driver/api-report/odsp-driver.legacy.alpha.api.md @@ -10,12 +10,12 @@ export function checkUrl(documentUrl: URL): DriverPreCheckInfo | undefined; // @alpha export function createLocalOdspDocumentServiceFactory(localSnapshot: Uint8Array | string): IDocumentServiceFactory; +// @alpha @deprecated +export function createOdspCreateContainerRequest(siteUrl: string, driveId: string, filePath: string, fileName: string, createShareLinkType: ISharingLinkKind | undefined, containerPackageInfo?: IContainerPackageInfo | undefined): IRequest; + // @alpha export function createOdspCreateContainerRequest(siteUrl: string, driveId: string, filePath: string, fileName: string, createShareLinkType?: ISharingLinkKind): IRequest; -// @alpha @deprecated -export function createOdspCreateContainerRequest(siteUrl: string, driveId: string, filePath: string, fileName: string, createShareLinkType?: ISharingLinkKind, containerPackageInfo?: IContainerPackageInfo | undefined): IRequest; - // @alpha export function createOdspUrl(l: OdspFluidDataStoreLocator): string; diff --git a/packages/drivers/odsp-driver/src/createOdspCreateContainerRequest.ts b/packages/drivers/odsp-driver/src/createOdspCreateContainerRequest.ts index d6fd22342888..1025ddfd4721 100644 --- a/packages/drivers/odsp-driver/src/createOdspCreateContainerRequest.ts +++ b/packages/drivers/odsp-driver/src/createOdspCreateContainerRequest.ts @@ -13,39 +13,40 @@ import { ISharingLinkKind } from "@fluidframework/odsp-driver-definitions/intern import { buildOdspShareLinkReqParams, getContainerPackageName } from "./odspUtils.js"; /** - * Create the request object with url and headers for creating a new file on OneDrive Sharepoint + * Overloaded version of createOdspCreateContainerRequest that takes in containerPackageInfo * @param siteUrl - Base url for OneDrive * @param driveId - drive identifier * @param filePath - path where file needs to be created * @param fileName - name of the new file to be created * @param createShareLinkType - type of sharing link you would like to create for this file. ShareLinkTypes * will be deprecated soon, so for any new implementation please provide createShareLinkType of type ShareLink + * @param containerPackageInfo - **Deprecated Parameter** - container package information which will be used to extract the container package name. + * If not given that means that the container package does not have a name. * @legacy * @alpha + * @deprecated To be removed in 2.40 + * Add containerPackageInfo to the OdspDriverUrlResolverForShareLink constructor instead; see https://github.com/microsoft/FluidFramework/issues/23882 for more details. + * Deprecating overloaded function to remove containerPackageInfo */ export function createOdspCreateContainerRequest( siteUrl: string, driveId: string, filePath: string, fileName: string, - createShareLinkType?: ISharingLinkKind, + createShareLinkType: ISharingLinkKind | undefined, + containerPackageInfo?: IContainerPackageInfo | undefined, ): IRequest; /** - * Overloaded version of createOdspCreateContainerRequest that takes in containerPackageInfo + * Create the request object with url and headers for creating a new file on OneDrive Sharepoint * @param siteUrl - Base url for OneDrive * @param driveId - drive identifier * @param filePath - path where file needs to be created * @param fileName - name of the new file to be created * @param createShareLinkType - type of sharing link you would like to create for this file. ShareLinkTypes * will be deprecated soon, so for any new implementation please provide createShareLinkType of type ShareLink - * @param containerPackageInfo - **Deprecated Parameter** - container package information which will be used to extract the container package name. - * If not given that means that the container package does not have a name. * @legacy * @alpha - * @deprecated To be removed in 2.40 - * Add containerPackageInfo to the OdspDriverUrlResolverForShareLink constructor instead; see https://github.com/microsoft/FluidFramework/issues/23882 for more details. - * Deprecating overloaded function to remove containerPackageInfo */ export function createOdspCreateContainerRequest( siteUrl: string, @@ -53,7 +54,6 @@ export function createOdspCreateContainerRequest( filePath: string, fileName: string, createShareLinkType?: ISharingLinkKind, - containerPackageInfo?: IContainerPackageInfo | undefined, ): IRequest; /** @@ -64,7 +64,7 @@ export function createOdspCreateContainerRequest( * @param fileName - name of the new file to be created * @param createShareLinkType - type of sharing link you would like to create for this file. ShareLinkTypes * will be deprecated soon, so for any new implementation please provide createShareLinkType of type ShareLink - * @deprecated This parameter is deprecated @param containerPackageInfo - **Deprecated Parameter** - container package information which will be used to extract the container package name. + * @param containerPackageInfo - **Deprecated Parameter** - container package information which will be used to extract the container package name. * If not given that means that the container package does not have a name. * @legacy * @alpha diff --git a/packages/service-clients/odsp-client/src/odspClient.ts b/packages/service-clients/odsp-client/src/odspClient.ts index 3b51d4622500..7f8435a15109 100644 --- a/packages/service-clients/odsp-client/src/odspClient.ts +++ b/packages/service-clients/odsp-client/src/odspClient.ts @@ -36,7 +36,6 @@ import { import { OdspDocumentServiceFactory, OdspDriverUrlResolver, - // eslint-disable-next-line import/no-deprecated createOdspCreateContainerRequest, createOdspUrl, isOdspResolvedUrl, @@ -210,7 +209,6 @@ export class OdspClient { const attach = async ( odspProps?: ContainerAttachProps, ): Promise => { - // eslint-disable-next-line import/no-deprecated const createNewRequest: IRequest = createOdspCreateContainerRequest( connection.siteUrl, connection.driveId, From 66a4be2ea0ba8f80f28b0c5bd19f34a7d69603c3 Mon Sep 17 00:00:00 2001 From: MarioJGMsoft Date: Wed, 19 Mar 2025 23:12:24 +0000 Subject: [PATCH 12/20] docs: removed eslint no deprecated. --- packages/test/test-drivers/src/odspDriverApi.ts | 2 -- 1 file changed, 2 deletions(-) diff --git a/packages/test/test-drivers/src/odspDriverApi.ts b/packages/test/test-drivers/src/odspDriverApi.ts index 16219145c66a..f92997e5fd67 100644 --- a/packages/test/test-drivers/src/odspDriverApi.ts +++ b/packages/test/test-drivers/src/odspDriverApi.ts @@ -12,7 +12,6 @@ import { import { OdspDocumentServiceFactory, OdspDriverUrlResolver, - // eslint-disable-next-line import/no-deprecated createOdspCreateContainerRequest, createOdspUrl, } from "@fluidframework/odsp-driver/internal"; @@ -32,7 +31,6 @@ export const OdspDriverApi = { version: pkgVersion, OdspDocumentServiceFactory, OdspDriverUrlResolver, - // eslint-disable-next-line import/no-deprecated createOdspCreateContainerRequest, createOdspUrl, // REVIEW: does this need to be back compat? }; From 92234d720feddbd746f74eab3a5a5126b832f66e Mon Sep 17 00:00:00 2001 From: MarioJGMsoft Date: Fri, 28 Mar 2025 17:05:14 +0000 Subject: [PATCH 13/20] docs: Disabled eslint deprecation --- .../src/odspUrlResolver.ts | 2 ++ .../odsp-driver.legacy.alpha.api.md | 6 +++--- .../src/createOdspCreateContainerRequest.ts | 20 +++++++++---------- .../odsp-client/src/odspClient.ts | 2 ++ .../test/test-drivers/src/odspDriverApi.ts | 2 ++ .../test/test-drivers/src/odspTestDriver.ts | 3 +++ 6 files changed, 22 insertions(+), 13 deletions(-) diff --git a/examples/utils/webpack-fluid-loader/src/odspUrlResolver.ts b/examples/utils/webpack-fluid-loader/src/odspUrlResolver.ts index c0c11f372d81..79ef929a4959 100644 --- a/examples/utils/webpack-fluid-loader/src/odspUrlResolver.ts +++ b/examples/utils/webpack-fluid-loader/src/odspUrlResolver.ts @@ -11,6 +11,7 @@ import { } from "@fluidframework/odsp-doclib-utils/internal"; import { OdspDriverUrlResolver, + // eslint-disable-next-line import/no-deprecated createOdspCreateContainerRequest, createOdspUrl, } from "@fluidframework/odsp-driver/internal"; @@ -75,6 +76,7 @@ export class OdspUrlResolver implements IUrlResolver { this.authRequestInfo, false, ); + // eslint-disable-next-line import/no-deprecated return createOdspCreateContainerRequest( `https://${this.server}`, driveId, diff --git a/packages/drivers/odsp-driver/api-report/odsp-driver.legacy.alpha.api.md b/packages/drivers/odsp-driver/api-report/odsp-driver.legacy.alpha.api.md index 40b9103b9a0b..ad5ce3ed13a1 100644 --- a/packages/drivers/odsp-driver/api-report/odsp-driver.legacy.alpha.api.md +++ b/packages/drivers/odsp-driver/api-report/odsp-driver.legacy.alpha.api.md @@ -10,12 +10,12 @@ export function checkUrl(documentUrl: URL): DriverPreCheckInfo | undefined; // @alpha export function createLocalOdspDocumentServiceFactory(localSnapshot: Uint8Array | string): IDocumentServiceFactory; -// @alpha @deprecated -export function createOdspCreateContainerRequest(siteUrl: string, driveId: string, filePath: string, fileName: string, createShareLinkType: ISharingLinkKind | undefined, containerPackageInfo?: IContainerPackageInfo | undefined): IRequest; - // @alpha export function createOdspCreateContainerRequest(siteUrl: string, driveId: string, filePath: string, fileName: string, createShareLinkType?: ISharingLinkKind): IRequest; +// @alpha @deprecated +export function createOdspCreateContainerRequest(siteUrl: string, driveId: string, filePath: string, fileName: string, createShareLinkType: ISharingLinkKind | undefined, containerPackageInfo?: IContainerPackageInfo | undefined): IRequest; + // @alpha export function createOdspUrl(l: OdspFluidDataStoreLocator): string; diff --git a/packages/drivers/odsp-driver/src/createOdspCreateContainerRequest.ts b/packages/drivers/odsp-driver/src/createOdspCreateContainerRequest.ts index 1025ddfd4721..b4379a60e24c 100644 --- a/packages/drivers/odsp-driver/src/createOdspCreateContainerRequest.ts +++ b/packages/drivers/odsp-driver/src/createOdspCreateContainerRequest.ts @@ -13,47 +13,47 @@ import { ISharingLinkKind } from "@fluidframework/odsp-driver-definitions/intern import { buildOdspShareLinkReqParams, getContainerPackageName } from "./odspUtils.js"; /** - * Overloaded version of createOdspCreateContainerRequest that takes in containerPackageInfo + * Create the request object with url and headers for creating a new file on OneDrive Sharepoint * @param siteUrl - Base url for OneDrive * @param driveId - drive identifier * @param filePath - path where file needs to be created * @param fileName - name of the new file to be created * @param createShareLinkType - type of sharing link you would like to create for this file. ShareLinkTypes * will be deprecated soon, so for any new implementation please provide createShareLinkType of type ShareLink - * @param containerPackageInfo - **Deprecated Parameter** - container package information which will be used to extract the container package name. - * If not given that means that the container package does not have a name. * @legacy * @alpha - * @deprecated To be removed in 2.40 - * Add containerPackageInfo to the OdspDriverUrlResolverForShareLink constructor instead; see https://github.com/microsoft/FluidFramework/issues/23882 for more details. - * Deprecating overloaded function to remove containerPackageInfo */ export function createOdspCreateContainerRequest( siteUrl: string, driveId: string, filePath: string, fileName: string, - createShareLinkType: ISharingLinkKind | undefined, - containerPackageInfo?: IContainerPackageInfo | undefined, + createShareLinkType?: ISharingLinkKind, ): IRequest; /** - * Create the request object with url and headers for creating a new file on OneDrive Sharepoint + * Overloaded version of createOdspCreateContainerRequest that takes in containerPackageInfo * @param siteUrl - Base url for OneDrive * @param driveId - drive identifier * @param filePath - path where file needs to be created * @param fileName - name of the new file to be created * @param createShareLinkType - type of sharing link you would like to create for this file. ShareLinkTypes * will be deprecated soon, so for any new implementation please provide createShareLinkType of type ShareLink + * @param containerPackageInfo - **Deprecated Parameter** - container package information which will be used to extract the container package name. + * If not given that means that the container package does not have a name. * @legacy * @alpha + * @deprecated To be removed in 2.40 + * Add containerPackageInfo to the OdspDriverUrlResolverForShareLink constructor instead; see https://github.com/microsoft/FluidFramework/issues/23882 for more details. + * Deprecating overloaded function to remove containerPackageInfo */ export function createOdspCreateContainerRequest( siteUrl: string, driveId: string, filePath: string, fileName: string, - createShareLinkType?: ISharingLinkKind, + createShareLinkType: ISharingLinkKind | undefined, + containerPackageInfo?: IContainerPackageInfo | undefined, ): IRequest; /** diff --git a/packages/service-clients/odsp-client/src/odspClient.ts b/packages/service-clients/odsp-client/src/odspClient.ts index 7f8435a15109..3b51d4622500 100644 --- a/packages/service-clients/odsp-client/src/odspClient.ts +++ b/packages/service-clients/odsp-client/src/odspClient.ts @@ -36,6 +36,7 @@ import { import { OdspDocumentServiceFactory, OdspDriverUrlResolver, + // eslint-disable-next-line import/no-deprecated createOdspCreateContainerRequest, createOdspUrl, isOdspResolvedUrl, @@ -209,6 +210,7 @@ export class OdspClient { const attach = async ( odspProps?: ContainerAttachProps, ): Promise => { + // eslint-disable-next-line import/no-deprecated const createNewRequest: IRequest = createOdspCreateContainerRequest( connection.siteUrl, connection.driveId, diff --git a/packages/test/test-drivers/src/odspDriverApi.ts b/packages/test/test-drivers/src/odspDriverApi.ts index f92997e5fd67..16219145c66a 100644 --- a/packages/test/test-drivers/src/odspDriverApi.ts +++ b/packages/test/test-drivers/src/odspDriverApi.ts @@ -12,6 +12,7 @@ import { import { OdspDocumentServiceFactory, OdspDriverUrlResolver, + // eslint-disable-next-line import/no-deprecated createOdspCreateContainerRequest, createOdspUrl, } from "@fluidframework/odsp-driver/internal"; @@ -31,6 +32,7 @@ export const OdspDriverApi = { version: pkgVersion, OdspDocumentServiceFactory, OdspDriverUrlResolver, + // eslint-disable-next-line import/no-deprecated createOdspCreateContainerRequest, createOdspUrl, // REVIEW: does this need to be back compat? }; diff --git a/packages/test/test-drivers/src/odspTestDriver.ts b/packages/test/test-drivers/src/odspTestDriver.ts index 2a63947d8e3c..a42089309719 100644 --- a/packages/test/test-drivers/src/odspTestDriver.ts +++ b/packages/test/test-drivers/src/odspTestDriver.ts @@ -22,6 +22,7 @@ import type { IPersistedCache, OdspResourceTokenFetchOptions, } from "@fluidframework/odsp-driver-definitions/internal"; +import { SharingLinkScope } from "@fluidframework/odsp-driver-definitions/internal"; import { OdspTokenConfig, OdspTokenManager, @@ -397,12 +398,14 @@ export class OdspTestDriver implements ITestDriver { return new this.api.OdspDriverUrlResolver(); } + sharingLinkKind = { scope: SharingLinkScope.organization }; createCreateNewRequest(testId: string): IRequest { return this.api.createOdspCreateContainerRequest( this.config.siteUrl, this.config.driveId, this.config.directory, `${testId}.tstFluid`, + this.sharingLinkKind, ); } From e9c3636646321a91f04b4dd2120853f6adbfef0c Mon Sep 17 00:00:00 2001 From: MarioJGMsoft Date: Fri, 11 Apr 2025 17:12:46 +0000 Subject: [PATCH 14/20] docs: applied changes based on comments --- .changeset/wicked-eagles-search.md | 2 +- examples/utils/webpack-fluid-loader/src/odspUrlResolver.ts | 2 ++ .../odsp-driver/api-report/odsp-driver.legacy.alpha.api.md | 2 +- .../odsp-driver/src/createOdspCreateContainerRequest.ts | 4 ++-- packages/test/test-drivers/src/odspDriverApi.ts | 2 ++ 5 files changed, 8 insertions(+), 4 deletions(-) diff --git a/.changeset/wicked-eagles-search.md b/.changeset/wicked-eagles-search.md index 91456c607232..27c5c2126932 100644 --- a/.changeset/wicked-eagles-search.md +++ b/.changeset/wicked-eagles-search.md @@ -9,4 +9,4 @@ The parameter `containerPackageInfo` in `createOdspCreateContainerRequest()` is This will mean that the name of the containerPackage can no longer be sent through the request. Instead it can be added in the constructor of `OdspDriverUrlResolverForShareLink`. -See [issue] (https://github.com/microsoft/FluidFramework/issues/23882) for details. +See [issue](https://github.com/microsoft/FluidFramework/issues/23882) for details. diff --git a/examples/utils/webpack-fluid-loader/src/odspUrlResolver.ts b/examples/utils/webpack-fluid-loader/src/odspUrlResolver.ts index 79ef929a4959..ba58cbb7120d 100644 --- a/examples/utils/webpack-fluid-loader/src/odspUrlResolver.ts +++ b/examples/utils/webpack-fluid-loader/src/odspUrlResolver.ts @@ -11,6 +11,7 @@ import { } from "@fluidframework/odsp-doclib-utils/internal"; import { OdspDriverUrlResolver, + // The comment will be removed up when the deprecated code is removed in AB#31049 // eslint-disable-next-line import/no-deprecated createOdspCreateContainerRequest, createOdspUrl, @@ -76,6 +77,7 @@ export class OdspUrlResolver implements IUrlResolver { this.authRequestInfo, false, ); + // The comment will be removed up when the deprecated code is removed in AB#31049 // eslint-disable-next-line import/no-deprecated return createOdspCreateContainerRequest( `https://${this.server}`, diff --git a/packages/drivers/odsp-driver/api-report/odsp-driver.legacy.alpha.api.md b/packages/drivers/odsp-driver/api-report/odsp-driver.legacy.alpha.api.md index ad5ce3ed13a1..327047e0953f 100644 --- a/packages/drivers/odsp-driver/api-report/odsp-driver.legacy.alpha.api.md +++ b/packages/drivers/odsp-driver/api-report/odsp-driver.legacy.alpha.api.md @@ -14,7 +14,7 @@ export function createLocalOdspDocumentServiceFactory(localSnapshot: Uint8Array export function createOdspCreateContainerRequest(siteUrl: string, driveId: string, filePath: string, fileName: string, createShareLinkType?: ISharingLinkKind): IRequest; // @alpha @deprecated -export function createOdspCreateContainerRequest(siteUrl: string, driveId: string, filePath: string, fileName: string, createShareLinkType: ISharingLinkKind | undefined, containerPackageInfo?: IContainerPackageInfo | undefined): IRequest; +export function createOdspCreateContainerRequest(siteUrl: string, driveId: string, filePath: string, fileName: string, createShareLinkType: ISharingLinkKind | undefined, containerPackageInfo: IContainerPackageInfo | undefined): IRequest; // @alpha export function createOdspUrl(l: OdspFluidDataStoreLocator): string; diff --git a/packages/drivers/odsp-driver/src/createOdspCreateContainerRequest.ts b/packages/drivers/odsp-driver/src/createOdspCreateContainerRequest.ts index b4379a60e24c..14da3852a215 100644 --- a/packages/drivers/odsp-driver/src/createOdspCreateContainerRequest.ts +++ b/packages/drivers/odsp-driver/src/createOdspCreateContainerRequest.ts @@ -32,7 +32,7 @@ export function createOdspCreateContainerRequest( ): IRequest; /** - * Overloaded version of createOdspCreateContainerRequest that takes in containerPackageInfo + * Create the request object with url and headers for creating a new file on OneDrive Sharepoint * @param siteUrl - Base url for OneDrive * @param driveId - drive identifier * @param filePath - path where file needs to be created @@ -53,7 +53,7 @@ export function createOdspCreateContainerRequest( filePath: string, fileName: string, createShareLinkType: ISharingLinkKind | undefined, - containerPackageInfo?: IContainerPackageInfo | undefined, + containerPackageInfo: IContainerPackageInfo | undefined, ): IRequest; /** diff --git a/packages/test/test-drivers/src/odspDriverApi.ts b/packages/test/test-drivers/src/odspDriverApi.ts index 16219145c66a..b1960b40bb87 100644 --- a/packages/test/test-drivers/src/odspDriverApi.ts +++ b/packages/test/test-drivers/src/odspDriverApi.ts @@ -12,6 +12,7 @@ import { import { OdspDocumentServiceFactory, OdspDriverUrlResolver, + // The comment will be removed up when the deprecated code is removed in AB#31049 // eslint-disable-next-line import/no-deprecated createOdspCreateContainerRequest, createOdspUrl, @@ -32,6 +33,7 @@ export const OdspDriverApi = { version: pkgVersion, OdspDocumentServiceFactory, OdspDriverUrlResolver, + // The comment will be removed up when the deprecated code is removed in AB#31049 // eslint-disable-next-line import/no-deprecated createOdspCreateContainerRequest, createOdspUrl, // REVIEW: does this need to be back compat? From 62c3774db2ff2240fc9993c583f7325d8f3d7712 Mon Sep 17 00:00:00 2001 From: MarioJGMsoft Date: Fri, 11 Apr 2025 17:14:51 +0000 Subject: [PATCH 15/20] docs: applied changes based on comments --- packages/service-clients/odsp-client/src/odspClient.ts | 2 ++ packages/test/test-drivers/src/odspTestDriver.ts | 3 --- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/packages/service-clients/odsp-client/src/odspClient.ts b/packages/service-clients/odsp-client/src/odspClient.ts index 3b51d4622500..8ee74ff4f3fd 100644 --- a/packages/service-clients/odsp-client/src/odspClient.ts +++ b/packages/service-clients/odsp-client/src/odspClient.ts @@ -36,6 +36,7 @@ import { import { OdspDocumentServiceFactory, OdspDriverUrlResolver, + // The comment will be removed up when the deprecated code is removed in AB#31049 // eslint-disable-next-line import/no-deprecated createOdspCreateContainerRequest, createOdspUrl, @@ -210,6 +211,7 @@ export class OdspClient { const attach = async ( odspProps?: ContainerAttachProps, ): Promise => { + // The comment will be removed up when the deprecated code is removed in AB#31049 // eslint-disable-next-line import/no-deprecated const createNewRequest: IRequest = createOdspCreateContainerRequest( connection.siteUrl, diff --git a/packages/test/test-drivers/src/odspTestDriver.ts b/packages/test/test-drivers/src/odspTestDriver.ts index a42089309719..2a63947d8e3c 100644 --- a/packages/test/test-drivers/src/odspTestDriver.ts +++ b/packages/test/test-drivers/src/odspTestDriver.ts @@ -22,7 +22,6 @@ import type { IPersistedCache, OdspResourceTokenFetchOptions, } from "@fluidframework/odsp-driver-definitions/internal"; -import { SharingLinkScope } from "@fluidframework/odsp-driver-definitions/internal"; import { OdspTokenConfig, OdspTokenManager, @@ -398,14 +397,12 @@ export class OdspTestDriver implements ITestDriver { return new this.api.OdspDriverUrlResolver(); } - sharingLinkKind = { scope: SharingLinkScope.organization }; createCreateNewRequest(testId: string): IRequest { return this.api.createOdspCreateContainerRequest( this.config.siteUrl, this.config.driveId, this.config.directory, `${testId}.tstFluid`, - this.sharingLinkKind, ); } From 32f5cae606dbe36a4c6f2128e2a83376f94d0511 Mon Sep 17 00:00:00 2001 From: MarioJGMsoft Date: Fri, 11 Apr 2025 21:25:40 +0000 Subject: [PATCH 16/20] docs: applied changes based on docs review --- .changeset/wicked-eagles-search.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.changeset/wicked-eagles-search.md b/.changeset/wicked-eagles-search.md index 27c5c2126932..aa158e9bd38b 100644 --- a/.changeset/wicked-eagles-search.md +++ b/.changeset/wicked-eagles-search.md @@ -5,8 +5,9 @@ "section": deprecation --- -The parameter `containerPackageInfo` in `createOdspCreateContainerRequest()` is deprecated and will be removed in version 2.40. +Deprecate the `containerPackageInfo` parameter in `createOdspCreateContainerRequest()` is deprecated and will be removed in version 2.40. -This will mean that the name of the containerPackage can no longer be sent through the request. Instead it can be added in the constructor of `OdspDriverUrlResolverForShareLink`. +The name of the containerPackage can no longer be sent through the request. This functionality will be removed in version 2.40. +Instead it can be added in the constructor of `OdspDriverUrlResolverForShareLink`. See [issue](https://github.com/microsoft/FluidFramework/issues/23882) for details. From a0dcc11a8b0039141f88c1786decdc12d1be718e Mon Sep 17 00:00:00 2001 From: MarioJGMsoft Date: Fri, 11 Apr 2025 23:34:02 +0000 Subject: [PATCH 17/20] docs: Applied changes to changeset based on comments --- .changeset/wicked-eagles-search.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/.changeset/wicked-eagles-search.md b/.changeset/wicked-eagles-search.md index aa158e9bd38b..107633149cb1 100644 --- a/.changeset/wicked-eagles-search.md +++ b/.changeset/wicked-eagles-search.md @@ -1,13 +1,12 @@ --- "@fluidframework/odsp-driver": minor +"__section": deprecation --- ---- -"section": deprecation ---- -Deprecate the `containerPackageInfo` parameter in `createOdspCreateContainerRequest()` is deprecated and will be removed in version 2.40. +The `containerPackageInfo` parameter in `createOdspCreateContainerRequest()` is now deprecated. + +The `containerPackageInfo` parameter in `createOdspCreateContainerRequest()` is deprecated will be removed in version 2.40.0. -The name of the containerPackage can no longer be sent through the request. This functionality will be removed in version 2.40. -Instead it can be added in the constructor of `OdspDriverUrlResolverForShareLink`. +The name of the containerPackage can no longer be sent through the request. Instead, it can be added in the constructor of `OdspDriverUrlResolverForShareLink`. -See [issue](https://github.com/microsoft/FluidFramework/issues/23882) for details. +See [issue #23882](https://github.com/microsoft/FluidFramework/issues/23882) for details. From 65124c3b3db2be00468ca83fc1e6b6927e9f1e33 Mon Sep 17 00:00:00 2001 From: MarioJGMsoft Date: Fri, 11 Apr 2025 23:35:12 +0000 Subject: [PATCH 18/20] docs: updated based on comments --- .changeset/wicked-eagles-search.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.changeset/wicked-eagles-search.md b/.changeset/wicked-eagles-search.md index 107633149cb1..c10ba85a9f0a 100644 --- a/.changeset/wicked-eagles-search.md +++ b/.changeset/wicked-eagles-search.md @@ -9,4 +9,4 @@ The `containerPackageInfo` parameter in `createOdspCreateContainerRequest()` is The name of the containerPackage can no longer be sent through the request. Instead, it can be added in the constructor of `OdspDriverUrlResolverForShareLink`. -See [issue #23882](https://github.com/microsoft/FluidFramework/issues/23882) for details. +See [issue #23882](https://github.com/microsoft/FluidFramework/issues/23882) for more details. From 3fd97f039f68987edc8a1b2cdd0af23da9c8c27b Mon Sep 17 00:00:00 2001 From: MarioJGMsoft Date: Mon, 14 Apr 2025 16:24:33 +0000 Subject: [PATCH 19/20] applied changes based on comments. --- .changeset/wicked-eagles-search.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.changeset/wicked-eagles-search.md b/.changeset/wicked-eagles-search.md index c10ba85a9f0a..cc8d2e0c4a37 100644 --- a/.changeset/wicked-eagles-search.md +++ b/.changeset/wicked-eagles-search.md @@ -3,9 +3,9 @@ "__section": deprecation --- -The `containerPackageInfo` parameter in `createOdspCreateContainerRequest()` is now deprecated. +The containerPackageInfo parameter in createOdspCreateContainerRequest() is now deprecated. -The `containerPackageInfo` parameter in `createOdspCreateContainerRequest()` is deprecated will be removed in version 2.40.0. +The `containerPackageInfo` parameter in `createOdspCreateContainerRequest()` is now deprecated and will be removed in version 2.40.0. The name of the containerPackage can no longer be sent through the request. Instead, it can be added in the constructor of `OdspDriverUrlResolverForShareLink`. From d981211a5cc4c24f154c9d5ea2a6f9e1585e0b03 Mon Sep 17 00:00:00 2001 From: MarioJGMsoft Date: Mon, 14 Apr 2025 16:29:17 +0000 Subject: [PATCH 20/20] Applied changes based on comments --- .changeset/wicked-eagles-search.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.changeset/wicked-eagles-search.md b/.changeset/wicked-eagles-search.md index cc8d2e0c4a37..199a7a34ec31 100644 --- a/.changeset/wicked-eagles-search.md +++ b/.changeset/wicked-eagles-search.md @@ -3,7 +3,7 @@ "__section": deprecation --- -The containerPackageInfo parameter in createOdspCreateContainerRequest() is now deprecated. +The containerPackageInfo parameter in createOdspCreateContainerRequest() is now deprecated The `containerPackageInfo` parameter in `createOdspCreateContainerRequest()` is now deprecated and will be removed in version 2.40.0.