From 9d00a01682a09e2b9b867a683613422b9b786dd2 Mon Sep 17 00:00:00 2001 From: MarioJGMsoft Date: Thu, 24 Apr 2025 22:45:39 +0000 Subject: [PATCH] refactor: removed deprecated version of createOdspCreateContainerRequest --- .../dds/tree/api-report/tree.alpha.api.md | 6 +- .../odsp-driver.legacy.alpha.api.md | 3 - .../src/createOdspCreateContainerRequest.ts | 56 +------------------ .../src/test/odspDriverResolverTest.spec.ts | 16 ------ .../api-report/fluid-framework.alpha.api.md | 6 +- .../odsp-client/src/odspClient.ts | 2 - .../test/test-drivers/src/odspDriverApi.ts | 4 -- 7 files changed, 9 insertions(+), 84 deletions(-) diff --git a/packages/dds/tree/api-report/tree.alpha.api.md b/packages/dds/tree/api-report/tree.alpha.api.md index 663597c93699..daab9ebe64f2 100644 --- a/packages/dds/tree/api-report/tree.alpha.api.md +++ b/packages/dds/tree/api-report/tree.alpha.api.md @@ -450,9 +450,9 @@ export namespace JsonAsTree { } const // @system _APIExtractorWorkaroundObjectBase: TreeNodeSchemaClass<"com.fluidframework.json.object", NodeKind.Map, TreeMapNodeUnsafe, LeafSchema<"number", number>, LeafSchema<"string", string>, LeafSchema<"boolean", boolean>, () => typeof JsonObject, () => typeof Array]> & WithType<"com.fluidframework.json.object", NodeKind.Map, unknown>, { - [Symbol.iterator](): Iterator<[string, string | number | JsonObject | Array | InsertableTypedNodeUnsafe, LeafSchema<"boolean", boolean>> | null], any, undefined>; + [Symbol.iterator](): Iterator<[string, string | number | InsertableTypedNodeUnsafe, LeafSchema<"boolean", boolean>> | JsonObject | Array | null], any, undefined>; } | { - readonly [x: string]: string | number | JsonObject | Array | InsertableTypedNodeUnsafe, LeafSchema<"boolean", boolean>> | null; + readonly [x: string]: string | number | InsertableTypedNodeUnsafe, LeafSchema<"boolean", boolean>> | JsonObject | Array | null; }, false, readonly [LeafSchema<"null", null>, LeafSchema<"number", number>, LeafSchema<"string", string>, LeafSchema<"boolean", boolean>, () => typeof JsonObject, () => typeof Array], undefined>; // (undocumented) export type Primitive = TreeNodeFromImplicitAllowedTypes; @@ -460,7 +460,7 @@ export namespace JsonAsTree { export type _RecursiveArrayWorkaroundJsonArray = FixRecursiveArraySchema; const // @system _APIExtractorWorkaroundArrayBase: TreeNodeSchemaClass<"com.fluidframework.json.array", NodeKind.Array, TreeArrayNodeUnsafe, LeafSchema<"number", number>, LeafSchema<"string", string>, LeafSchema<"boolean", boolean>, () => typeof JsonObject, () => typeof Array]> & WithType<"com.fluidframework.json.array", NodeKind.Array, unknown>, { - [Symbol.iterator](): Iterator, LeafSchema<"boolean", boolean>> | null, any, undefined>; + [Symbol.iterator](): Iterator, LeafSchema<"boolean", boolean>> | JsonObject | Array | null, any, undefined>; }, false, readonly [LeafSchema<"null", null>, LeafSchema<"number", number>, LeafSchema<"string", string>, LeafSchema<"boolean", boolean>, () => typeof JsonObject, () => typeof Array], undefined>; // (undocumented) export type Tree = TreeNodeFromImplicitAllowedTypes; 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 bd057277507f..000b8fb5cb2f 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 @@ -13,9 +13,6 @@ export function createLocalOdspDocumentServiceFactory(localSnapshot: Uint8Array // @alpha @legacy export function createOdspCreateContainerRequest(siteUrl: string, driveId: string, filePath: string, fileName: string, createShareLinkType?: ISharingLinkKind): IRequest; -// @alpha @deprecated @legacy -export function createOdspCreateContainerRequest(siteUrl: string, driveId: string, filePath: string, fileName: string, createShareLinkType: ISharingLinkKind | undefined, containerPackageInfo: IContainerPackageInfo | undefined): IRequest; - // @alpha @legacy 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 14da3852a215..6359294a56c5 100644 --- a/packages/drivers/odsp-driver/src/createOdspCreateContainerRequest.ts +++ b/packages/drivers/odsp-driver/src/createOdspCreateContainerRequest.ts @@ -4,13 +4,10 @@ */ 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, 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 @@ -29,59 +26,12 @@ export function createOdspCreateContainerRequest( filePath: string, fileName: string, createShareLinkType?: ISharingLinkKind, -): IRequest; - -/** - * 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, -): IRequest; - -/** - * 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 - */ -export function createOdspCreateContainerRequest( - siteUrl: string, - driveId: string, - filePath: string, - fileName: string, - createShareLinkType?: ISharingLinkKind, - containerPackageInfo?: IContainerPackageInfo | undefined, ): IRequest { const shareLinkRequestParams = buildOdspShareLinkReqParams(createShareLinkType); const createNewRequest: IRequest = { url: `${siteUrl}?driveId=${encodeURIComponent(driveId)}&path=${encodeURIComponent( filePath, - )}${containerPackageInfo ? `&containerPackageName=${getContainerPackageName(containerPackageInfo)}` : ""}${shareLinkRequestParams ? `&${shareLinkRequestParams}` : ""}`, + )}${shareLinkRequestParams ? `&${shareLinkRequestParams}` : ""}`, headers: { [DriverHeader.createNew]: { fileName, 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", - ); - }); }); diff --git a/packages/framework/fluid-framework/api-report/fluid-framework.alpha.api.md b/packages/framework/fluid-framework/api-report/fluid-framework.alpha.api.md index 42714cca75a5..14d1332469f0 100644 --- a/packages/framework/fluid-framework/api-report/fluid-framework.alpha.api.md +++ b/packages/framework/fluid-framework/api-report/fluid-framework.alpha.api.md @@ -790,9 +790,9 @@ export namespace JsonAsTree { } const // @system _APIExtractorWorkaroundObjectBase: TreeNodeSchemaClass<"com.fluidframework.json.object", NodeKind.Map, TreeMapNodeUnsafe, LeafSchema<"number", number>, LeafSchema<"string", string>, LeafSchema<"boolean", boolean>, () => typeof JsonObject, () => typeof Array]> & WithType<"com.fluidframework.json.object", NodeKind.Map, unknown>, { - [Symbol.iterator](): Iterator<[string, string | number | JsonObject | Array | InsertableTypedNodeUnsafe, LeafSchema<"boolean", boolean>> | null], any, undefined>; + [Symbol.iterator](): Iterator<[string, string | number | InsertableTypedNodeUnsafe, LeafSchema<"boolean", boolean>> | JsonObject | Array | null], any, undefined>; } | { - readonly [x: string]: string | number | JsonObject | Array | InsertableTypedNodeUnsafe, LeafSchema<"boolean", boolean>> | null; + readonly [x: string]: string | number | InsertableTypedNodeUnsafe, LeafSchema<"boolean", boolean>> | JsonObject | Array | null; }, false, readonly [LeafSchema<"null", null>, LeafSchema<"number", number>, LeafSchema<"string", string>, LeafSchema<"boolean", boolean>, () => typeof JsonObject, () => typeof Array], undefined>; // (undocumented) export type Primitive = TreeNodeFromImplicitAllowedTypes; @@ -800,7 +800,7 @@ export namespace JsonAsTree { export type _RecursiveArrayWorkaroundJsonArray = FixRecursiveArraySchema; const // @system _APIExtractorWorkaroundArrayBase: TreeNodeSchemaClass<"com.fluidframework.json.array", NodeKind.Array, TreeArrayNodeUnsafe, LeafSchema<"number", number>, LeafSchema<"string", string>, LeafSchema<"boolean", boolean>, () => typeof JsonObject, () => typeof Array]> & WithType<"com.fluidframework.json.array", NodeKind.Array, unknown>, { - [Symbol.iterator](): Iterator, LeafSchema<"boolean", boolean>> | null, any, undefined>; + [Symbol.iterator](): Iterator, LeafSchema<"boolean", boolean>> | JsonObject | Array | null, any, undefined>; }, false, readonly [LeafSchema<"null", null>, LeafSchema<"number", number>, LeafSchema<"string", string>, LeafSchema<"boolean", boolean>, () => typeof JsonObject, () => typeof Array], undefined>; // (undocumented) export type Tree = TreeNodeFromImplicitAllowedTypes; diff --git a/packages/service-clients/odsp-client/src/odspClient.ts b/packages/service-clients/odsp-client/src/odspClient.ts index 8ee74ff4f3fd..3b07beeb4ec1 100644 --- a/packages/service-clients/odsp-client/src/odspClient.ts +++ b/packages/service-clients/odsp-client/src/odspClient.ts @@ -211,8 +211,6 @@ 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, connection.driveId, diff --git a/packages/test/test-drivers/src/odspDriverApi.ts b/packages/test/test-drivers/src/odspDriverApi.ts index b1960b40bb87..f92997e5fd67 100644 --- a/packages/test/test-drivers/src/odspDriverApi.ts +++ b/packages/test/test-drivers/src/odspDriverApi.ts @@ -12,8 +12,6 @@ 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, } from "@fluidframework/odsp-driver/internal"; @@ -33,8 +31,6 @@ 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? };