@shopify/app-bridge-types 0.0.18 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 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
+
+- [#518](https://github.com/Shopify/extensibility/pull/518) [`bc1af9034c8cca66ebd7a44474aa7a11de7013e9`](https://github.com/Shopify/extensibility/commit/bc1af9034c8cca66ebd7a44474aa7a11de7013e9) Thanks [@SammyJoeOsborne](https://github.com/SammyJoeOsborne)! - Adding types for reviews plugin api.
+
 ## 0.0.18
 
 ### Patch 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 {
 }
 
@@ -337,6 +352,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,6 +918,26 @@ type ResourceTypes = {
     collection: Collection;
 };
 
+type ReviewRequestDeclinedCode = 'mobile-app' | 'already-reviewed' | 'annual-limit-reached' | 'cooldown-period' | 'merchant-ineligible' | 'recently-installed';
+
+interface ReviewRequestDeclinedResponse {
+    success: false;
+    code: ReviewRequestDeclinedCode;
+    message: string;
+}
+
+type ReviewRequestResponse = ReviewRequestSuccessResponse | ReviewRequestDeclinedResponse;
+
+interface ReviewRequestSuccessResponse {
+    success: true;
+    code: 'success';
+    message: 'Review modal shown successfully';
+}
+
+interface ReviewsApi {
+    request(): Promise<ReviewRequestResponse>;
+}
+
 interface RuleSet {
     appliedDisjunctively: boolean;
     rules: CollectionRule[];
@@ -982,8 +1044,10 @@ export interface ShopifyGlobal {
     intents: IntentsApi;
     webVitals: WebVitalsApi;
     support: SupportApi;
+    reviews: ReviewsApi;
     scopes: Scopes;
     picker: PickerApi;
+    app: AppApi;
 }
 
 interface SupportApi {

package/package.json

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