@shopify/app-bridge-types 0.0.13 → 0.0.14-snapshot-20240910215355

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.0.14-snapshot-20240910215355
+
+### Patch Changes
+
+- [#12](https://github.com/Shopify/extensibility/pull/12) [`a79a42172c1af3412ed40213f89e694ac8ada6dd`](https://github.com/Shopify/extensibility/commit/a79a42172c1af3412ed40213f89e694ac8ada6dd) Thanks [@charlesdobson](https://github.com/charlesdobson)! - structure output in dist dir
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),

package/{shopify.ts → dist/shopify.ts}

@@ -63,11 +63,7 @@ interface AdminUser {
 export interface AppBridgeAttributes {
 }
 
-interface AppBridgeConfig extends Required<Omit<_AppBridgeConfig, 'disabledFeatures' | 'appOrigins'>>, Pick<_AppBridgeConfig, 'disabledFeatures' | 'appOrigins'> {
-    experimentalFeatures?: string[];
-}
-
-interface _AppBridgeConfig {
+interface AppBridgeConfig {
     /**
      * The client ID provided for your application in the Partner Dashboard.
      *
@@ -80,12 +76,28 @@ interface _AppBridgeConfig {
      * This is useful if your app needs to make authenticated requests to a different domain that you control.
      */
     appOrigins?: string[];
+    /**
+     * Configuration options for enabling debug features within the app.
+     * Includes options for monitoring performance metrics, such as web vitals.
+     *
+     * Recommended for use during development and debugging to aid in identifying and resolving performance issues.
+     *
+     * Generally not recommended for long-term use in production environments.
+     *
+     */
+    debug?: DebugOptions;
     /**
      * The features to disable in your app.
      *
      * This allows app developers to opt-out of features such as <code>fetch</code>.
      */
     disabledFeatures?: string[];
+    /**
+     * The experimental features to enable in your app.
+     *
+     * This allows app developers to opt-in to experiement features.
+     */
+    experimentalFeatures?: string[];
     /**
      * The base64-encoded host of the shop that's embedding your app.
      *
@@ -140,7 +152,7 @@ interface Cart {
     /**
      * 	The total cost of the current cart including discounts, but before taxes and shipping. Value is based on the shop's existing currency settings.
      */
-    subtotal: string;
+    subTotal: string;
     /**
      * The sum of taxes for the current cart. Value is based on the shop's existing currency settings.
      */
@@ -259,6 +271,18 @@ interface CustomSale {
     taxable: boolean;
 }
 
+interface DebugOptions {
+    /**
+     * Enables or disables the logging of web performance metrics (Web Vitals) in the browser's console.
+     *
+     * When set to `true`, the app will log Core Web Vitals (such as LCP, INP, and CLS) and other relevant performance metrics to help developers understand the real-world performance of their app. This can be useful for debugging performance issues during development or in a staging environment.
+     *
+     * This field is optional and defaults to `false`, meaning that web vitals logging is disabled by default to avoid performance overhead and unnecessary console output in production environments.
+     * @defaultValue false
+     */
+    webVitals?: boolean;
+}
+
 interface Device {
     /**
      * The name of the device.
@@ -800,7 +824,7 @@ interface _SaveBarApi {
     /**
      * Show leave confirmation dialog if necessary. This promise is resolved when there is no visible save bar or user confirms to leave.
      */
-    leaveConfirmation?(): Promise<void>;
+    leaveConfirmation(): Promise<void>;
 }
 
 interface ScannerApi {

package/package.json

@@ -1,28 +1,32 @@
 {
   "name": "@shopify/app-bridge-types",
-  "version": "0.0.13",
+  "version": "0.0.14-snapshot-20240910215355",
   "description": "Companion types library for the Shopify App Bridge script",
+  "private": false,
+  "publishConfig": {
+    "access": "public",
+    "@shopify:registry": "https://registry.npmjs.org"
+  },
   "license": "ISC",
-  "main": "./index.js",
-  "module": "./index.mjs",
-  "types": "./index.d.ts",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
   "exports": {
-    "types": "./index.d.ts",
-    "module": "./index.mjs",
-    "import": "./index.mjs",
-    "default": "./index.js"
-  },
-  "scripts": {
-    "build": "cjyes && node ./scripts/build.mjs"
+    "types": "./dist/index.d.ts",
+    "module": "./dist/index.mjs",
+    "import": "./dist/index.mjs",
+    "default": "./dist/index.js"
   },
   "devDependencies": {
-    "cjyes": "^0.3.1"
+    "cjyes": "^0.3.1",
+    "app-bridge-next": "0.0.1"
   },
   "files": [
-    "index.d.ts",
-    "shopify.ts",
-    "index.mjs",
-    "index.js",
+    "dist",
     "CHANGELOG.md"
-  ]
-}
+  ],
+  "scripts": {
+    "prebuild": "mkdir -p ./dist && touch ./dist/index.mjs",
+    "build": "npm run prebuild && cjyes && node ./scripts/build.mjs"
+  }
+}