From 83d29c2e79d7944311d758b9fac549ac6353a55c Mon Sep 17 00:00:00 2001
From: Shahed Nasser <shahednasser@gmail.com>
Date: Mon, 7 Apr 2025 18:11:33 +0300
Subject: [PATCH] chore(js-sdk, types): add TSDocs for plugin methods in JS SDK
 (#12106)

* chore(js-sdk, types): add TSDocs for plugin methods in JS SDK

* tsdocs for draft orders
---
 packages/core/js-sdk/src/admin/draft-order.ts  | 10 +++++-----
 packages/core/js-sdk/src/admin/plugin.ts       | 18 ++++++++++++++++++
 .../src/http/draft-order/admin/payloads.ts     |  9 +++++++++
 .../src/http/draft-order/admin/responses.ts    |  9 +++++++++
 .../types/src/http/plugins/admin/responses.ts  |  3 +++
 5 files changed, 44 insertions(+), 5 deletions(-)

diff --git a/packages/core/js-sdk/src/admin/draft-order.ts b/packages/core/js-sdk/src/admin/draft-order.ts
index ccb6de4f17..5fd76a6e4d 100644
--- a/packages/core/js-sdk/src/admin/draft-order.ts
+++ b/packages/core/js-sdk/src/admin/draft-order.ts
@@ -29,7 +29,7 @@ export class DraftOrder {
    * To retrieve a draft order by its ID:
    *
    * ```ts
-   * sdk.admin.draftOrder.retrieve("draft_order_123")
+   * sdk.admin.draftOrder.retrieve("order_123")
    * .then(({ draft_order }) => {
    *   console.log(draft_order)
    * })
@@ -38,7 +38,7 @@ export class DraftOrder {
    * To specify the fields and relations to retrieve:
    *
    * ```ts
-   * sdk.admin.draftOrder.retrieve("draft_order_123", {
+   * sdk.admin.draftOrder.retrieve("order_123", {
    *   fields: "id,*items"
    * })
    * .then(({ draft_order }) => {
@@ -142,7 +142,7 @@ export class DraftOrder {
    *     },
    *   ],
    *   region_id: "region_123",
-   *   sales_channel_id: "sales_channel_123",
+   *   sales_channel_id: "sc_123",
    * })
    * .then(({ draft_order }) => {
    *   console.log(draft_order)
@@ -178,7 +178,7 @@ export class DraftOrder {
    * To update a draft order:
    *
    * ```ts
-   * sdk.admin.draftOrder.update("draft_order_123", {
+   * sdk.admin.draftOrder.update("order_123", {
    *   email: "test@test.com",
    * })
    * .then(({ draft_order }) => {
@@ -215,7 +215,7 @@ export class DraftOrder {
    * To convert a draft order to an order:
    *
    * ```ts
-   * sdk.admin.draftOrder.convertToOrder("draft_order_123")
+   * sdk.admin.draftOrder.convertToOrder("order_123")
    * .then(({ order }) => {
    *   console.log(order)
    * })
diff --git a/packages/core/js-sdk/src/admin/plugin.ts b/packages/core/js-sdk/src/admin/plugin.ts
index c665ebc6f4..63fde55db0 100644
--- a/packages/core/js-sdk/src/admin/plugin.ts
+++ b/packages/core/js-sdk/src/admin/plugin.ts
@@ -3,12 +3,30 @@ import { Client } from "../client"
 import { ClientHeaders } from "../types"
 
 export class Plugin {
+  /**
+   * @ignore
+   */
   private client: Client
 
+  /**
+   * @ignore
+   */
   constructor(client: Client) {
     this.client = client
   }
 
+  /**
+   * This method retrieves the list of plugins installed in a Medusa application.
+   * 
+   * @param headers - Headers to pass in the request.
+   * @returns The list of plugins.
+   * 
+   * @example
+   * sdk.admin.plugin.list()
+   * .then(({ plugins }) => {
+   *   console.log(plugins)
+   * })
+   */
   async list(headers?: ClientHeaders) {
     return await this.client.fetch<HttpTypes.AdminPluginsListResponse>(
       `/admin/plugins`,
diff --git a/packages/core/types/src/http/draft-order/admin/payloads.ts b/packages/core/types/src/http/draft-order/admin/payloads.ts
index f25e598971..a8557f70da 100644
--- a/packages/core/types/src/http/draft-order/admin/payloads.ts
+++ b/packages/core/types/src/http/draft-order/admin/payloads.ts
@@ -181,14 +181,23 @@ export interface AdminAddDraftOrderItem {
 }
 
 export interface AdminAddDraftOrderItems {
+  /**
+   * The items to add to the draft order.
+   */
   items: AdminAddDraftOrderItem[]
 }
 
 export interface AdminAddDraftOrderPromotions {
+  /**
+   * The promotion codes to apply to the draft order.
+   */
   promo_codes: string[]
 }
 
 export interface AdminRemoveDraftOrderPromotions {
+  /**
+   * The promotion codes to remove from the draft order.
+   */
   promo_codes: string[]
 }
 
diff --git a/packages/core/types/src/http/draft-order/admin/responses.ts b/packages/core/types/src/http/draft-order/admin/responses.ts
index 7d97b57080..0f61fa14f4 100644
--- a/packages/core/types/src/http/draft-order/admin/responses.ts
+++ b/packages/core/types/src/http/draft-order/admin/responses.ts
@@ -2,14 +2,23 @@ import { PaginatedResponse } from "../../common"
 import { AdminDraftOrder, AdminDraftOrderPreview } from "./entities"
 
 export interface AdminDraftOrderResponse {
+  /**
+   * The details of the draft order.
+   */
   draft_order: AdminDraftOrder
 }
 
 export interface AdminDraftOrderListResponse
   extends PaginatedResponse<{
+    /**
+     * The list of draft orders.
+     */
     draft_orders: AdminDraftOrder[]
   }> {}
 
 export interface AdminDraftOrderPreviewResponse {
+  /**
+   * The details of the preview on the draft order.
+   */
   draft_order_preview: AdminDraftOrderPreview
 }
diff --git a/packages/core/types/src/http/plugins/admin/responses.ts b/packages/core/types/src/http/plugins/admin/responses.ts
index 854e304f07..c9b77b34e8 100644
--- a/packages/core/types/src/http/plugins/admin/responses.ts
+++ b/packages/core/types/src/http/plugins/admin/responses.ts
@@ -1,4 +1,7 @@
 export interface AdminPlugin {
+  /**
+   * The plugin's name.
+   */
   name: string
 }