@shopify/app-bridge-types 0.1.0 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 0.3.0
+
+### Minor Changes
+
+- [#669](https://github.com/Shopify/extensibility/pull/669) [`ad18a376e0e7a4e3921fa8f394d424644eb1f7bc`](https://github.com/Shopify/extensibility/commit/ad18a376e0e7a4e3921fa8f394d424644eb1f7bc) Thanks [@SammyJoeOsborne](https://github.com/SammyJoeOsborne)! - Updating ReviewRequestDeclinedResponse type with new codes: already-open, open-in-progress, and cancelled
+
+## 0.2.0
+
+### Minor Changes
+
+- [#623](https://github.com/Shopify/extensibility/pull/623) [`6334cc4f89f8c22c871dfb122f8d5aba358b26a3`](https://github.com/Shopify/extensibility/commit/6334cc4f89f8c22c871dfb122f8d5aba358b26a3) Thanks [@SammyJoeOsborne](https://github.com/SammyJoeOsborne)! - Updating ReviewRequestDeclinedResponse type with new recently-installed code
+
 ## 0.1.0
 
 ### Minor Changes

package/dist/shopify.ts

@@ -60,6 +60,21 @@ interface AdminUser {
     accountAccess?: string;
 }
 
+/**
+ * This API interface provides methods to retrieve app and extension status information.
+ */
+interface AppApi {
+    /**
+     * The list of extensions from the current app.
+     * @returns A promise that resolves to the array of ExtensionResponse containing extension status information.
+     *
+     * This array may be empty if the app has no extensions.
+     *
+     * @throws {Error} When the App API is not available or the request fails.
+     */
+    extensions(): Promise<ExtensionInfo[]>;
+}
+
 export interface AppBridgeAttributes {
 }
 
@@ -122,6 +137,7 @@ interface AppBridgeConfig {
 export interface AppBridgeElements {
     'ui-modal': UIModalAttributes;
     'ui-nav-menu': UINavMenuAttributes;
+    's-app-nav': SAppNavAttributes;
     'ui-save-bar': UISaveBarAttributes;
     'ui-title-bar': UITitleBarAttributes;
 }
@@ -337,6 +353,33 @@ interface _EnvironmentApi {
     pos?: boolean;
 }
 
+/**
+ * Represents an activation record for an extension.
+ * Contains information about where an extension is activated.
+ */
+interface ExtensionActivation {
+    /**
+     * The target identifier for the extension activation.
+     */
+    target: string;
+}
+
+/**
+ * Contains the status information for the app's extension.
+ * This includes the extension's handle, and activation targets.
+ */
+interface ExtensionInfo {
+    /**
+     * The unique identifier for the extension.
+     */
+    handle: string;
+    /**
+     * List of activation records for the extension.
+     * Contains information about where the extension is currently activated.
+     */
+    activations: ExtensionActivation[];
+}
+
 interface Filters {
     /**
      * Whether to show hidden resources, referring to products that are not published on any sales channels.
@@ -876,7 +919,7 @@ type ResourceTypes = {
     collection: Collection;
 };
 
-type ReviewRequestDeclinedCode = 'mobile-app' | 'already-reviewed' | 'annual-limit-reached' | 'cooldown-period' | 'merchant-ineligible';
+type ReviewRequestDeclinedCode = 'mobile-app' | 'already-reviewed' | 'annual-limit-reached' | 'cooldown-period' | 'merchant-ineligible' | 'recently-installed' | 'already-open' | 'open-in-progress' | 'cancelled';
 
 interface ReviewRequestDeclinedResponse {
     success: false;
@@ -901,6 +944,13 @@ interface RuleSet {
     rules: CollectionRule[];
 }
 
+export interface SAppNavAttributes {
+    children?: any;
+}
+
+export interface SAppNavElement extends HTMLElement {
+}
+
 interface SaveBarApi extends Required<_SaveBarApi> {
 }
 
@@ -921,9 +971,9 @@ interface _SaveBarApi {
      */
     toggle?(id: string): Promise<void>;
     /**
-     * Show leave confirmation dialog if necessary. This promise is resolved when there is no visible save bar or user confirms to leave.
+     * Checks if saveBar is shown. This promise resolves if the save bar is not shown. Uses this method before navigating away from the page only when you have a custom routing that is not anchor tag.
      */
-    leaveConfirmation(): Promise<void>;
+    leaveConfirmation?(): Promise<void>;
 }
 
 interface ScannerApi {
@@ -1005,6 +1055,7 @@ export interface ShopifyGlobal {
     reviews: ReviewsApi;
     scopes: Scopes;
     picker: PickerApi;
+    app: AppApi;
 }
 
 interface SupportApi {
@@ -1150,33 +1201,14 @@ interface UIModalElement_2 extends Omit<HTMLElement, 'addEventListener' | 'remov
 }
 export type { UIModalElement_2 as UIModalElement }
 
-export interface UINavMenuAttributes extends _UINavMenuAttributes {
+export interface UINavMenuAttributes {
     children?: any;
 }
 
-interface _UINavMenuAttributes {
-    children?: [UINavMenuFirstChild, ...UINavMenuChildren[]];
-}
-
-interface UINavMenuChildren {
-    a?: {
-        href: string;
-        children: string;
-    };
-}
-
 interface UINavMenuElement_2 extends HTMLElement {
 }
 export type { UINavMenuElement_2 as UINavMenuElement }
 
-interface UINavMenuFirstChild {
-    a: {
-        rel: 'home';
-        href: string;
-        children?: string;
-    };
-}
-
 export interface UISaveBarAttributes extends _UISaveBarAttributes {
     children?: any;
 }
@@ -1268,6 +1300,9 @@ interface _UITitleBarAttributes {
 }
 
 interface UITitleBarChildren {
+    /**
+     * Note that anchor tag elements are not supported in Remix. You can use Remix's `<Link>` component instead.
+     */
     a?: BaseElementAttributes & {
         variant?: 'breadcrumb' | 'primary';
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shopify/app-bridge-types",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "Companion types library for the Shopify App Bridge script",
   "private": false,
   "publishConfig": {