From c440068d49163d549b80e35ae15d541dbccdbd5c Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Mon, 6 Jan 2025 14:01:46 +0200 Subject: [PATCH] chore: small tsdoc changes for remoteLink and remoteQueryConfig (#10837) --- packages/core/framework/src/http/types.ts | 4 +++- packages/core/framework/src/types/container.ts | 5 ++++- packages/core/utils/src/common/container.ts | 5 ++++- 3 files changed, 11 insertions(+), 3 deletions(-) diff --git a/packages/core/framework/src/http/types.ts b/packages/core/framework/src/http/types.ts index 987f610080..c5d6b4f0d9 100644 --- a/packages/core/framework/src/http/types.ts +++ b/packages/core/framework/src/http/types.ts @@ -111,6 +111,8 @@ export interface MedusaRequest< /** * An object containing fields and variables to be used with the remoteQuery + * + * @version 2.1.4 */ queryConfig: { fields: string[] @@ -118,7 +120,7 @@ export interface MedusaRequest< } /** - * @deprecated. Instead use "req.queryConfig" + * @deprecated Use {@link queryConfig} instead. */ remoteQueryConfig: MedusaRequest["queryConfig"] diff --git a/packages/core/framework/src/types/container.ts b/packages/core/framework/src/types/container.ts index 65a121a445..62f29ecc58 100644 --- a/packages/core/framework/src/types/container.ts +++ b/packages/core/framework/src/types/container.ts @@ -36,9 +36,12 @@ import { AwilixContainer, ResolveOptions } from "awilix" declare module "@medusajs/types" { export interface ModuleImplementations { /** - * @deprecated. Instead use "link" + * @deprecated use {@link ContainerRegistrationKeys.LINK} instead. */ [ContainerRegistrationKeys.REMOTE_LINK]: Link + /** + * @version 2.1.4 + */ [ContainerRegistrationKeys.LINK]: Link [ContainerRegistrationKeys.CONFIG_MODULE]: ConfigModule [ContainerRegistrationKeys.PG_CONNECTION]: Knex diff --git a/packages/core/utils/src/common/container.ts b/packages/core/utils/src/common/container.ts index 1b20944413..c6af4b9c18 100644 --- a/packages/core/utils/src/common/container.ts +++ b/packages/core/utils/src/common/container.ts @@ -6,9 +6,12 @@ export const ContainerRegistrationKeys = { REMOTE_QUERY: "remoteQuery", QUERY: "query", /** - * @deprecated. Instead use "ContainerRegistrationKeys.LINK" + * @deprecated use {@link ContainerRegistrationKeys.LINK} instead. */ REMOTE_LINK: "remoteLink", + /** + * @version 2.1.4 + */ LINK: "link", FEATURE_FLAG_ROUTER: "featureFlagRouter", } as const