@shopify/app-bridge-react 2.0.24 → 2.0.25

package/hooks/useAppBridgeState/useAppBridgeState.js

@@ -42,8 +42,9 @@ var useAppBridge_1 = require("../../useAppBridge");
 var useAppBridgeState = function (query) {
     var app = useAppBridge_1.useAppBridge();
     var _a = react_1.useState(), state = _a[0], setState = _a[1];
+    var isUnmounted = react_1.useRef(false);
     var refresh = react_1.useCallback(function () { return __awaiter(void 0, void 0, void 0, function () {
-        var state, _a;
+        var newState, _a;
         return __generator(this, function (_b) {
             switch (_b.label) {
                 case 0:
@@ -57,9 +58,17 @@ var useAppBridgeState = function (query) {
                     _a = _b.sent();
                     _b.label = 4;
                 case 4:
-                    state = _a;
-                    setState(state);
-                    return [2 /*return*/, state];
+                    newState = _a;
+                    if (isUnmounted.current) {
+                        return [2 /*return*/];
+                    }
+                    setState(function (currentState) {
+                        if (JSON.stringify(newState) === JSON.stringify(currentState)) {
+                            return currentState;
+                        }
+                        return newState;
+                    });
+                    return [2 /*return*/];
             }
         });
     }); }, [app, query]);
@@ -70,6 +79,11 @@ var useAppBridgeState = function (query) {
             refresh();
         });
     }, [app, refresh]);
+    react_1.useEffect(function () {
+        return function () {
+            isUnmounted.current = true;
+        };
+    }, [app]);
     return state;
 };
 exports.useAppBridgeState = useAppBridgeState;

package/hooks/useFeatureRequest/index.d.ts

@@ -0,0 +1 @@
+export * from './useFeatureRequest';

package/hooks/useFeatureRequest/index.js

@@ -0,0 +1,13 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./useFeatureRequest"), exports);

package/hooks/useFeatureRequest/useFeatureRequest.d.ts

@@ -0,0 +1,13 @@
+import type { FeaturePermission, FeaturesAction } from '@shopify/app-bridge';
+import { Group } from '@shopify/app-bridge/actions';
+/**
+ * useFeatureRequest hook
+ *
+ * @public
+ * @remarks
+ * React hook performs a feature request and then returns
+ * the requested feature when permissions has been updated
+ * @param {Group} group - The requested group enum
+ * @param {string} action - The requested action. This param is optional
+ */
+export declare function useFeatureRequest(group: Group, action?: string): FeaturesAction | FeaturePermission | undefined;

package/hooks/useFeatureRequest/useFeatureRequest.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useFeatureRequest = void 0;
+var react_1 = require("react");
+var Features_1 = require("@shopify/app-bridge/actions/Features");
+var useAppBridge_1 = require("../../useAppBridge");
+var useFeaturesAvailable_1 = require("../useFeaturesAvailable");
+/**
+ * useFeatureRequest hook
+ *
+ * @public
+ * @remarks
+ * React hook performs a feature request and then returns
+ * the requested feature when permissions has been updated
+ * @param {Group} group - The requested group enum
+ * @param {string} action - The requested action. This param is optional
+ */
+function useFeatureRequest(group, action) {
+    var app = useAppBridge_1.useAppBridge();
+    var featuresAvailable = useFeaturesAvailable_1.useFeaturesAvailable();
+    var _a = react_1.useState(), feature = _a[0], setFeature = _a[1];
+    var handleFeatureUpdate = react_1.useCallback(function (featuresAvailable) {
+        var updatedFeatures = featuresAvailable === null || featuresAvailable === void 0 ? void 0 : featuresAvailable[group];
+        if (action && (updatedFeatures === null || updatedFeatures === void 0 ? void 0 : updatedFeatures[action])) {
+            var actionPermission_1 = updatedFeatures === null || updatedFeatures === void 0 ? void 0 : updatedFeatures[action];
+            setFeature(function (currentState) {
+                if (JSON.stringify(actionPermission_1) !== JSON.stringify(currentState)) {
+                    return actionPermission_1;
+                }
+                return currentState;
+            });
+            return;
+        }
+        setFeature(function (currentState) {
+            if (JSON.stringify(updatedFeatures) !== JSON.stringify(currentState)) {
+                return updatedFeatures;
+            }
+            return currentState;
+        });
+    }, [group, action]);
+    react_1.useEffect(function () {
+        Features_1.create(app).dispatch(Features_1.Action.REQUEST, { feature: group, action: action });
+    }, [app, group, action]);
+    react_1.useEffect(function () {
+        handleFeatureUpdate(featuresAvailable);
+    }, [featuresAvailable, handleFeatureUpdate]);
+    return feature;
+}
+exports.useFeatureRequest = useFeatureRequest;

package/hooks/useFeaturesAvailable/index.d.ts

@@ -0,0 +1,2 @@
+export type { FeaturesAvailable } from './useFeaturesAvailable';
+export { useFeaturesAvailable } from './useFeaturesAvailable';

package/hooks/useFeaturesAvailable/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useFeaturesAvailable = void 0;
+var useFeaturesAvailable_1 = require("./useFeaturesAvailable");
+Object.defineProperty(exports, "useFeaturesAvailable", { enumerable: true, get: function () { return useFeaturesAvailable_1.useFeaturesAvailable; } });

package/hooks/useFeaturesAvailable/useFeaturesAvailable.d.ts

@@ -0,0 +1,12 @@
+import { Group } from '@shopify/app-bridge/actions/types';
+import { AppBridgeState } from '@shopify/app-bridge/client';
+export declare type FeaturesAvailable = AppBridgeState['features'];
+/**
+ * useFeaturesAvailable hook
+ *
+ * @remarks
+ * React hook that wraps the Shopify App Bridge getFeaturesAvailable method.
+ *
+ * @public
+ */
+export declare function useFeaturesAvailable(...query: Group[]): import("@shopify/app-bridge/client").FeaturesAvailable<Group> | undefined;

package/hooks/useFeaturesAvailable/useFeaturesAvailable.js

@@ -0,0 +1,101 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useFeaturesAvailable = void 0;
+var react_1 = require("react");
+var types_1 = require("@shopify/app-bridge/actions/Features/types");
+var useAppBridge_1 = require("../../useAppBridge");
+/**
+ * useFeaturesAvailable hook
+ *
+ * @remarks
+ * React hook that wraps the Shopify App Bridge getFeaturesAvailable method.
+ *
+ * @public
+ */
+function useFeaturesAvailable() {
+    var _this = this;
+    var query = [];
+    for (var _i = 0; _i < arguments.length; _i++) {
+        query[_i] = arguments[_i];
+    }
+    var app = useAppBridge_1.useAppBridge();
+    var _a = react_1.useState(), state = _a[0], setState = _a[1];
+    var queryRef = react_1.useRef([]);
+    var refresh = react_1.useCallback(function () {
+        var isUnmounted = false;
+        (function () { return __awaiter(_this, void 0, void 0, function () {
+            var features;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, app.featuresAvailable.apply(app, queryRef.current)];
+                    case 1:
+                        features = _a.sent();
+                        if (!isUnmounted) {
+                            setState(function (currentFeatures) {
+                                if (JSON.stringify(currentFeatures) === JSON.stringify(features)) {
+                                    return currentFeatures;
+                                }
+                                return features;
+                            });
+                        }
+                        return [2 /*return*/];
+                }
+            });
+        }); })();
+        return function () {
+            isUnmounted = true;
+        };
+    }, [app]);
+    react_1.useEffect(function () {
+        queryRef.current = query;
+        return refresh();
+    }, [JSON.stringify(query)]);
+    react_1.useEffect(function () {
+        var onRefreshCleanup;
+        var unsubscribe = app.subscribe(types_1.Action.UPDATE, function () {
+            onRefreshCleanup = refresh();
+        });
+        return function () {
+            unsubscribe();
+            onRefreshCleanup === null || onRefreshCleanup === void 0 ? void 0 : onRefreshCleanup();
+        };
+    }, [app, refresh]);
+    return state;
+}
+exports.useFeaturesAvailable = useFeaturesAvailable;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shopify/app-bridge-react",
-  "version": "2.0.24",
+  "version": "2.0.25",
   "types": "index.d.ts",
   "main": "index.js",
   "unpkg": "umd/index.js",
@@ -45,7 +45,7 @@
     }
   ],
   "dependencies": {
-    "@shopify/app-bridge": "^2.0.24"
+    "@shopify/app-bridge": "^2.0.25"
   },
   "devDependencies": {
     "@types/react": "^17.0.38",
@@ -55,5 +55,5 @@
   "peerDependencies": {
     "react": "^16.0.0 || ^17.0.0"
   },
-  "gitHead": "0c3aa24d39c86120c8823bd43f439cda0ab7df5e"
+  "gitHead": "60fa946eeb60316459d58b45aba7cfc85dc0f7f7"
 }

package/types.d.ts

@@ -1,4 +1,5 @@
 import { Redirect } from '@shopify/app-bridge/actions';
+import { Group } from '@shopify/app-bridge/actions/types';
 export declare type Target = Exclude<keyof typeof Redirect.Action, 'ADMIN_SECTION'>;
 export interface ActionProps {
     /** Content the action displays */
@@ -31,3 +32,4 @@ export interface ActionGroupProps {
     /** List of actions */
     actions: ActionProps[];
 }
+export { Group };

package/types.js

@@ -1,2 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.Group = void 0;
+var types_1 = require("@shopify/app-bridge/actions/types");
+Object.defineProperty(exports, "Group", { enumerable: true, get: function () { return types_1.Group; } });