From b39429a82489260a46b6a10262d066c21389427f Mon Sep 17 00:00:00 2001 From: MarioJGMsoft Date: Tue, 18 Feb 2025 22:57:26 +0000 Subject: [PATCH 1/5] docs: assigned parameter as deprecated --- .../drivers/odsp-driver/src/createOdspCreateContainerRequest.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/drivers/odsp-driver/src/createOdspCreateContainerRequest.ts b/packages/drivers/odsp-driver/src/createOdspCreateContainerRequest.ts index f1bf103e2856..2ff132dc75f0 100644 --- a/packages/drivers/odsp-driver/src/createOdspCreateContainerRequest.ts +++ b/packages/drivers/odsp-driver/src/createOdspCreateContainerRequest.ts @@ -20,7 +20,7 @@ import { buildOdspShareLinkReqParams, getContainerPackageName } from "./odspUtil * @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. + * @param containerPackageInfo - *DEPRECATED* 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 07c1360832914794206822b6655a3b14ff63e6bf Mon Sep 17 00:00:00 2001 From: MarioJGMsoft Date: Wed, 19 Feb 2025 22:44:50 +0000 Subject: [PATCH 2/5] refactor: removed deprecated code --- .changeset/wicked-eagles-search.md | 10 ++++++++++ .../api-report/odsp-driver.legacy.alpha.api.md | 2 +- .../src/createOdspCreateContainerRequest.ts | 7 +------ 3 files changed, 12 insertions(+), 7 deletions(-) create mode 100644 .changeset/wicked-eagles-search.md diff --git a/.changeset/wicked-eagles-search.md b/.changeset/wicked-eagles-search.md new file mode 100644 index 000000000000..e6808ca3ffd8 --- /dev/null +++ b/.changeset/wicked-eagles-search.md @@ -0,0 +1,10 @@ +--- +"@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.0. 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`. 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 272dd95f8649..7ab1d6b9cda2 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,7 +11,7 @@ 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, containerPackageInfo?: IContainerPackageInfo | undefined): IRequest; +export function createOdspCreateContainerRequest(siteUrl: string, driveId: string, filePath: string, fileName: string, createShareLinkType?: ISharingLinkKind): 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 f1e270634345..fba2d6096394 100644 --- a/packages/drivers/odsp-driver/src/createOdspCreateContainerRequest.ts +++ b/packages/drivers/odsp-driver/src/createOdspCreateContainerRequest.ts @@ -4,10 +4,7 @@ */ import { IRequest } from "@fluidframework/core-interfaces"; -import { - DriverHeader, - type IContainerPackageInfo, -} from "@fluidframework/driver-definitions/internal"; +import { DriverHeader } from "@fluidframework/driver-definitions/internal"; import { ISharingLinkKind } from "@fluidframework/odsp-driver-definitions/internal"; import { buildOdspShareLinkReqParams } from "./odspUtils.js"; @@ -20,7 +17,6 @@ import { buildOdspShareLinkReqParams } from "./odspUtils.js"; * @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* 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 @@ -31,7 +27,6 @@ export function createOdspCreateContainerRequest( filePath: string, fileName: string, createShareLinkType?: ISharingLinkKind, - containerPackageInfo?: IContainerPackageInfo | undefined, ): IRequest { const shareLinkRequestParams = buildOdspShareLinkReqParams(createShareLinkType); const createNewRequest: IRequest = { From c54ef04862fc8a2e1e0ea137919d17bca07eaa1b Mon Sep 17 00:00:00 2001 From: MarioJGMsoft Date: Wed, 19 Feb 2025 23:10:37 +0000 Subject: [PATCH 3/5] refactor: fixed build --- .changeset/wicked-eagles-search.md | 2 +- .../odsp-driver/src/createOdspCreateContainerRequest.ts | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.changeset/wicked-eagles-search.md b/.changeset/wicked-eagles-search.md index e6808ca3ffd8..e31df1ff1ef0 100644 --- a/.changeset/wicked-eagles-search.md +++ b/.changeset/wicked-eagles-search.md @@ -7,4 +7,4 @@ createOdspCreateContainerRequest().containerPackageInfo is now deprecated -The parameter `containerPackageInfo` in `createOdspCreateContainerRequest()` is deprecated and will be removed in version 2.40.0. 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 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`. diff --git a/packages/drivers/odsp-driver/src/createOdspCreateContainerRequest.ts b/packages/drivers/odsp-driver/src/createOdspCreateContainerRequest.ts index d363d32149e4..fba2d6096394 100644 --- a/packages/drivers/odsp-driver/src/createOdspCreateContainerRequest.ts +++ b/packages/drivers/odsp-driver/src/createOdspCreateContainerRequest.ts @@ -7,7 +7,7 @@ import { IRequest } from "@fluidframework/core-interfaces"; import { DriverHeader } from "@fluidframework/driver-definitions/internal"; import { ISharingLinkKind } from "@fluidframework/odsp-driver-definitions/internal"; -import { buildOdspShareLinkReqParams, getContainerPackageName } from "./odspUtils.js"; +import { buildOdspShareLinkReqParams } from "./odspUtils.js"; /** * Create the request object with url and headers for creating a new file on OneDrive Sharepoint @@ -32,7 +32,7 @@ export function createOdspCreateContainerRequest( const createNewRequest: IRequest = { url: `${siteUrl}?driveId=${encodeURIComponent(driveId)}&path=${encodeURIComponent( filePath, - )}${containerPackageInfo ? `&containerPackageName=${getContainerPackageName(containerPackageInfo)}` : ""}${shareLinkRequestParams ? `&${shareLinkRequestParams}` : ""}`, + )}${shareLinkRequestParams ? `&${shareLinkRequestParams}` : ""}`, headers: { [DriverHeader.createNew]: { fileName, From 1f06ce9160105219914e181bbf7335abad820e33 Mon Sep 17 00:00:00 2001 From: MarioJGMsoft Date: Wed, 19 Feb 2025 23:11:54 +0000 Subject: [PATCH 4/5] test: updated test --- .../src/test/odspDriverResolverTest.spec.ts | 16 ---------------- 1 file changed, 16 deletions(-) diff --git a/packages/drivers/odsp-driver/src/test/odspDriverResolverTest.spec.ts b/packages/drivers/odsp-driver/src/test/odspDriverResolverTest.spec.ts index 4a8ee49a52d7..79809f4ddd93 100644 --- a/packages/drivers/odsp-driver/src/test/odspDriverResolverTest.spec.ts +++ b/packages/drivers/odsp-driver/src/test/odspDriverResolverTest.spec.ts @@ -457,20 +457,4 @@ describe("Odsp Driver Resolver", () => { `https://placeholder/placeholder/${resolvedUrl.hashedDocumentId}/` + `${testFilePath}`; assert.strictEqual(resolvedUrl.url, expectedResolvedUrl, "resolved url is wrong"); }); - it("Should create request with containerPackageName and resolve it", async () => { - request = createOdspCreateContainerRequest( - siteUrl, - driveId, - filePath, - fileName, - undefined, - { name: "testContainerPackageName" }, // Container package info variable, - ); - const resolvedUrl = await resolver.resolve(request); - assert.strictEqual( - resolvedUrl.codeHint?.containerPackageName, - "testContainerPackageName", - "containerPackageName should match", - ); - }); }); From eae1e2eb0de8eac4051da6582eb95badbcaf87f1 Mon Sep 17 00:00:00 2001 From: MarioJGMsoft Date: Wed, 5 Mar 2025 22:16:08 +0000 Subject: [PATCH 5/5] docs: eliminated changeset --- .changeset/wicked-eagles-search.md | 10 ---------- 1 file changed, 10 deletions(-) delete mode 100644 .changeset/wicked-eagles-search.md diff --git a/.changeset/wicked-eagles-search.md b/.changeset/wicked-eagles-search.md deleted file mode 100644 index e31df1ff1ef0..000000000000 --- a/.changeset/wicked-eagles-search.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -"@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`.