Add "options" for NEW_TAB

.changeset/blue-pears-grab.md

@@ -0,0 +1,5 @@
+---
+"@saleor/app-sdk": minor
+---
+
+Added "options" field to AppExtension types within manifest

.changeset/eight-eagles-fry.md

@@ -0,0 +1,7 @@
+---
+"@saleor/app-sdk": minor
+---
+
+Added NEW_TAB target and WIDGET target for AppExtension.
+
+[todo see docs](todo)

.changeset/some-snakes-begin.md

@@ -30,4 +30,11 @@ Add additional `AppExtensionMount` available in Saleor 3.22:
 - "PAGE_TYPE_DETAILS_MORE_ACTIONS"
 - "MENU_OVERVIEW_CREATE"
 - "MENU_OVERVIEW_MORE_ACTIONS"
-- "MENU_DETAILS_MORE_ACTIONS";
+- "MENU_DETAILS_MORE_ACTIONS"
+- "ORDER_DETAILS_WIDGETS"
+- "DRAFT_ORDER_DETAILS_WIDGETS"
+- "VOUCHER_DETAILS_WIDGETS"
+- "PRODUCT_DETAILS_WIDGETS"
+- "CUSTOMER_DETAILS_WIDGETS"
+- "GIFT_CARD_DETAILS_WIDGETS"
+- "COLLECTION_DETAILS_WIDGETS"

src/types.ts

@@ -1,4 +1,4 @@
-export type AppExtensionTarget = "POPUP" | "APP_PAGE";
+export type AppExtensionTarget = "POPUP" | "APP_PAGE" | "NEW_TAB" | "WIDGET";
 
 // Available mounts in Saleor 3.22 and newer
 type AppExtensionMount3_22 =
@@ -28,7 +28,14 @@ type AppExtensionMount3_22 =
   | "PAGE_TYPE_DETAILS_MORE_ACTIONS"
   | "MENU_OVERVIEW_CREATE"
   | "MENU_OVERVIEW_MORE_ACTIONS"
-  | "MENU_DETAILS_MORE_ACTIONS";
+  | "MENU_DETAILS_MORE_ACTIONS"
+  | "COLLECTION_DETAILS_WIDGETS"
+  | "CUSTOMER_DETAILS_WIDGETS"
+  | "PRODUCT_DETAILS_WIDGETS"
+  | "ORDER_DETAILS_WIDGETS"
+  | "DRAFT_ORDER_DETAILS_WIDGETS"
+  | "VOUCHER_DETAILS_WIDGETS"
+  | "GIFT_CARD_DETAILS_WIDGETS";
 
 export type AppExtensionMount =
   | AppExtensionMount3_22
@@ -229,26 +236,82 @@ export type SyncWebhookEventType =
   | "PAYMENT_METHOD_INITIALIZE_TOKENIZATION_SESSION"
   | "PAYMENT_METHOD_PROCESS_TOKENIZATION_SESSION";
 
-export interface AppExtension {
+interface BaseAppExtension {
   /** Name which will be displayed in the dashboard */
   label: string;
   /** the place where the extension will be mounted */
   mount: AppExtensionMount;
   /** Method of presenting the interface
-    `POPUP` will present the interface in a modal overlay
-    `APP_PAGE` will navigate to the application page
-    @default `POPUP`
-  */
-  target: AppExtensionTarget;
+   `POPUP` will present the interface in a modal overlay
+   `APP_PAGE` will navigate to the application page
+   @default `POPUP`
+   */
   permissions: AppPermission[];
   /** URL of the view to display;
-    you can skip the domain and protocol when target is set to `APP_PAGE`, or when your manifest defines an `appUrl`.
+   you can skip the domain and protocol when target is set to `APP_PAGE`, or when your manifest defines an `appUrl`.
 
-    When target is set to `POPUP`, the url will be used to render an `<iframe>`.
+   When target is set to `POPUP`, the url will be used to render an `<iframe>`.
    */
   url: string;
 }
 
+type PopupExtensionWidget = BaseAppExtension & {
+  target: "POPUP";
+};
+
+type AppPageExtensionWidget = BaseAppExtension & {
+  target: "APP_PAGE";
+};
+
+/**
+ * Added in 3.22
+ */
+type AppExtensionWidget = BaseAppExtension & {
+  target: "WIDGET";
+  /**
+   * Added in 3.22
+   */
+  options?: {
+    widgetTarget?: {
+      /**
+       * Controls how dashboard will open the new tab
+       * - GET -> open URL in the new window
+       * - POST -> submit internal <form> using POST method. Passes token and additional parameters into body*
+       */
+      method?: "GET" | "POST";
+    };
+  };
+};
+
+/**
+ * Added in 3.22
+ */
+type AppExtensionNewTab = BaseAppExtension & {
+  target: "NEW_TAB";
+  /**
+   * Added in 3.22
+   */
+  options?: {
+    /**
+     * Only when target is NEW_TAB.
+     */
+    newTabTarget?: {
+      /**
+       * Controls how dashboard will open the new tab
+       * - GET -> open URL in the new window
+       * - POST -> submit internal <form> using POST method. Passes token and additional parameters into body*
+       */
+      method?: "GET" | "POST";
+    };
+  };
+};
+
+export type AppExtension =
+  | AppPageExtensionWidget
+  | AppExtensionNewTab
+  | AppExtensionWidget
+  | PopupExtensionWidget;
+
 export interface WebhookManifest {
   name: string;
   asyncEvents?: AsyncWebhookEventType[];
@@ -282,18 +345,18 @@ export interface AppManifest {
   /** App website rendered in the dashboard */
   appUrl: string;
   /** Address to the app configuration page, which is rendered in the dashboard
-    @deprecated in Saleor 3.5, use appUrl instead
-  */
+   @deprecated in Saleor 3.5, use appUrl instead
+   */
   configurationUrl?: string;
   /** Endpoint used during process of app installation
 
-    @see [Installing an app](https://docs.saleor.io/docs/3.x/developer/extending/apps/installing-apps#installing-an-app) 
-  */
+   @see [Installing an app](https://docs.saleor.io/docs/3.x/developer/extending/apps/installing-apps#installing-an-app)
+   */
   tokenTargetUrl: string;
   /** Short description of privacy policy displayed in the dashboard
 
-    @deprecated in Saleor 3.5, use dataPrivacyUrl instead
-  */
+   @deprecated in Saleor 3.5, use dataPrivacyUrl instead
+   */
   dataPrivacy?: string;
   /** URL to the full privacy policy */
   dataPrivacyUrl?: string;
@@ -303,17 +366,17 @@ export interface AppManifest {
   supportUrl?: string;
   /** List of extensions that will be mounted in Saleor's dashboard
 
-  @see For details, please see the [extension section](https://docs.saleor.io/docs/3.x/developer/extending/apps/extending-dashboard-with-apps#key-concepts)
-  */
+   @see For details, please see the [extension section](https://docs.saleor.io/docs/3.x/developer/extending/apps/extending-dashboard-with-apps#key-concepts)
+   */
   extensions?: AppExtension[];
   /** List of webhooks that will be set.
-
-  @see For details, please look at [asynchronous webhooks](https://docs.saleor.io/docs/3.x/developer/extending/apps/asynchronous-webhooks),
-  [synchronous-webhooks](https://docs.saleor.io/docs/3.x/developer/extending/apps/synchronous-webhooks/key-concepts)
-  and [webhooks' subscription](https://docs.saleor.io/docs/3.x/developer/extending/apps/subscription-webhook-payloads)
 
-  Be aware that subscription queries are required in manifest sections
-  */
+   @see For details, please look at [asynchronous webhooks](https://docs.saleor.io/docs/3.x/developer/extending/apps/asynchronous-webhooks),
+    [synchronous-webhooks](https://docs.saleor.io/docs/3.x/developer/extending/apps/synchronous-webhooks/key-concepts)
+    and [webhooks' subscription](https://docs.saleor.io/docs/3.x/developer/extending/apps/subscription-webhook-payloads)
+
+    Be aware that subscription queries are required in manifest sections
+   */
   webhooks?: WebhookManifest[];
   /**
    * Allows app installation for specific Saleor versions, using semver.