@shopify/app-bridge-react 2.0.23 → 2.0.26

package/components/ResourcePicker/ResourcePicker.js

@@ -1,19 +1,4 @@
 "use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
 var __assign = (this && this.__assign) || function () {
     __assign = Object.assign || function(t) {
         for (var s, i = 1, n = arguments.length; i < n; i++) {
@@ -25,13 +10,13 @@ var __assign = (this && this.__assign) || function () {
     };
     return __assign.apply(this, arguments);
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-var react_1 = __importDefault(require("react"));
-var actions_1 = require("@shopify/app-bridge/actions");
-var context_1 = require("../../context");
+exports.ResourceType = exports.ActionVerb = void 0;
+var react_1 = require("react");
+var ResourcePicker_1 = require("@shopify/app-bridge/actions/ResourcePicker");
+Object.defineProperty(exports, "ActionVerb", { enumerable: true, get: function () { return ResourcePicker_1.ActionVerb; } });
+Object.defineProperty(exports, "ResourceType", { enumerable: true, get: function () { return ResourcePicker_1.ResourceType; } });
+var useAppBridge_1 = require("../../useAppBridge");
 /**
  * ResourcePicker component
  *
@@ -40,92 +25,90 @@ var context_1 = require("../../context");
  *
  * @public
  */
-var ResourcePicker = /** @class */ (function (_super) {
-    __extends(ResourcePicker, _super);
-    function ResourcePicker() {
-        var _this = _super !== null && _super.apply(this, arguments) || this;
-        _this.focusReturnPoint = null;
-        return _this;
-    }
-    ResourcePicker.prototype.componentDidMount = function () {
-        var _a = this.props, open = _a.open, resourceType = _a.resourceType, onSelection = _a.onSelection, onCancel = _a.onCancel;
-        var app = this.context;
-        this.picker = actions_1.ResourcePicker.create(app, {
-            resourceType: actions_1.ResourcePicker.ResourceType[resourceType],
-            options: this.getActionOptions(),
+function ResourcePicker(props) {
+    var app = useAppBridge_1.useAppBridge();
+    var focusReturnPoint = react_1.useRef(null);
+    var resourceType = props.resourceType, onSelection = props.onSelection, onCancel = props.onCancel, open = props.open;
+    // Initialize with open: false so the open action will dispatch on initial load
+    var prevProps = react_1.useRef({ open: false });
+    var picker = react_1.useMemo(function () {
+        return ResourcePicker_1.create(app, {
+            resourceType: ResourcePicker_1.ResourceType[resourceType],
+            options: getActionOptions(props),
         });
-        if (onSelection != null) {
-            this.picker.subscribe(actions_1.ResourcePicker.Action.SELECT, onSelection);
-        }
-        if (onCancel != null) {
-            this.picker.subscribe(actions_1.ResourcePicker.Action.CANCEL, onCancel);
-        }
-        if (open) {
-            this.focusReturnPoint = document.activeElement;
-            this.picker.dispatch(actions_1.ResourcePicker.Action.OPEN);
-        }
-    };
-    ResourcePicker.prototype.componentDidUpdate = function (prevProps) {
-        var wasOpen = prevProps.open;
-        var _a = this.props, open = _a.open, onCancel = _a.onCancel, onSelection = _a.onSelection;
-        this.picker.unsubscribe();
-        this.picker.set(this.getActionOptions());
-        if (onSelection != null) {
-            this.picker.subscribe(actions_1.ResourcePicker.Action.SELECT, onSelection);
-        }
-        if (onCancel != null) {
-            this.picker.subscribe(actions_1.ResourcePicker.Action.CANCEL, onCancel);
-        }
+        // We purposely want to reuse the same picker instance
+        // and use a useEffect to call `picker.set` when needed
+    }, [app]);
+    react_1.useEffect(function () {
+        var _a;
+        var wasOpen = (_a = prevProps.current) === null || _a === void 0 ? void 0 : _a.open;
         if (wasOpen !== open) {
             if (open) {
-                this.picker.dispatch(actions_1.ResourcePicker.Action.OPEN);
+                picker.dispatch(ResourcePicker_1.Action.OPEN);
             }
             else {
-                this.picker.dispatch(actions_1.ResourcePicker.Action.CLOSE);
+                picker.dispatch(ResourcePicker_1.Action.CLOSE);
             }
         }
         if (!wasOpen && open) {
-            this.focusReturnPoint = document.activeElement;
+            focusReturnPoint.current = document.activeElement;
         }
         else if (wasOpen &&
             !open &&
-            this.focusReturnPoint != null &&
-            document.contains(this.focusReturnPoint)) {
-            this.focusReturnPoint.focus();
-            this.focusReturnPoint = null;
+            focusReturnPoint.current != null &&
+            document.contains(focusReturnPoint.current)) {
+            focusReturnPoint.current.focus();
+            focusReturnPoint.current = null;
         }
-    };
-    ResourcePicker.prototype.componentWillUnmount = function () {
-        this.picker.unsubscribe();
-    };
-    ResourcePicker.prototype.render = function () {
-        return null;
-    };
-    ResourcePicker.prototype.getActionOptions = function () {
-        var _a = this.props, initialQuery = _a.initialQuery, initialSelectionIds = _a.initialSelectionIds, showHidden = _a.showHidden, allowMultiple = _a.allowMultiple, selectMultiple = _a.selectMultiple, actionVerb = _a.actionVerb;
-        var sharedOptions = {
-            initialQuery: initialQuery,
-            initialSelectionIds: initialSelectionIds,
-            showHidden: showHidden,
-            selectMultiple: selectMultiple !== null && selectMultiple !== void 0 ? selectMultiple : allowMultiple,
-            actionVerb: actionVerb,
+    }, [open]);
+    react_1.useEffect(function () {
+        var unsubscribeList = [];
+        if (onSelection != null) {
+            unsubscribeList.push(picker.subscribe(ResourcePicker_1.Action.SELECT, onSelection));
+        }
+        if (onCancel != null) {
+            unsubscribeList.push(picker.subscribe(ResourcePicker_1.Action.CANCEL, onCancel));
+        }
+        return function () {
+            var unsubscribe = unsubscribeList.pop();
+            while (unsubscribe) {
+                unsubscribe();
+                unsubscribe = unsubscribeList.pop();
+            }
         };
-        var result = sharedOptions;
-        if (this.props.resourceType === 'Product') {
-            var _b = this.props, showVariants = _b.showVariants, showDraft = _b.showDraft, showArchived = _b.showArchived, showDraftBadge = _b.showDraftBadge, showArchivedBadge = _b.showArchivedBadge;
-            var productSpecificOptions = {
-                showVariants: showVariants,
-                showDraft: showDraft,
-                showArchived: showArchived,
-                showDraftBadge: showDraftBadge,
-                showArchivedBadge: showArchivedBadge,
-            };
-            result = __assign(__assign({}, sharedOptions), productSpecificOptions);
+    }, [onSelection, onCancel]);
+    react_1.useEffect(function () {
+        var shouldUpdate = JSON.stringify(__assign(__assign({}, prevProps.current), { open: undefined })) !==
+            JSON.stringify(__assign(__assign({}, props), { open: undefined }));
+        if (!shouldUpdate) {
+            return;
         }
-        return result;
+        picker.set(getActionOptions(props));
+        prevProps.current = props;
+    }, [props]);
+    return null;
+}
+function getActionOptions(props) {
+    var initialQuery = props.initialQuery, initialSelectionIds = props.initialSelectionIds, showHidden = props.showHidden, allowMultiple = props.allowMultiple, selectMultiple = props.selectMultiple, actionVerb = props.actionVerb;
+    var sharedOptions = {
+        initialQuery: initialQuery,
+        initialSelectionIds: initialSelectionIds,
+        showHidden: showHidden,
+        selectMultiple: selectMultiple !== null && selectMultiple !== void 0 ? selectMultiple : allowMultiple,
+        actionVerb: actionVerb,
     };
-    ResourcePicker.contextType = context_1.AppBridgeContext;
-    ResourcePicker.ActionVerb = actions_1.ResourcePicker.ActionVerb;
-    return ResourcePicker;
-}(react_1.default.PureComponent));
+    var result = sharedOptions;
+    if (props.resourceType === 'Product') {
+        var showVariants = props.showVariants, showDraft = props.showDraft, showArchived = props.showArchived, showDraftBadge = props.showDraftBadge, showArchivedBadge = props.showArchivedBadge;
+        var productSpecificOptions = {
+            showVariants: showVariants,
+            showDraft: showDraft,
+            showArchived: showArchived,
+            showDraftBadge: showDraftBadge,
+            showArchivedBadge: showArchivedBadge,
+        };
+        result = __assign(__assign({}, sharedOptions), productSpecificOptions);
+    }
+    return result;
+}
 exports.default = ResourcePicker;

package/components/TitleBar/TitleBar.d.ts

@@ -1,4 +1,3 @@
-import React from 'react';
 import { ActionProps, ActionGroupProps, Target } from '../../types';
 export interface Breadcrumb {
     /** Content the action displays */
@@ -16,8 +15,8 @@ export interface Breadcrumb {
 export interface Props {
     /** TitleBar title */
     title: string;
-    /** Collection of breadcrumbs */
-    breadcrumbs?: Breadcrumb[];
+    /** The current breadcrumb; only displays the last item in array */
+    breadcrumbs?: Breadcrumb | Breadcrumb[];
     /** Primary TitleBar action */
     primaryAction?: ActionProps;
     /** Collection of secondary TitleBar actions */
@@ -25,14 +24,4 @@ export interface Props {
     /** Collection of TitleBar groups of secondary actions */
     actionGroups?: ActionGroupProps[];
 }
-declare class TitleBar extends React.PureComponent<Props, never> {
-    static contextType: React.Context<import("../../context").IAppBridgeContext>;
-    private titleBar;
-    componentDidMount(): void;
-    componentDidUpdate(): void;
-    componentWillUnmount(): void;
-    render(): null;
-    private transformProps;
-    private transformBreadcrumbs;
-}
-export default TitleBar;
+export default function TitleBar(props: Props): null;

package/components/TitleBar/TitleBar.js

@@ -1,80 +1,108 @@
 "use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-var react_1 = __importDefault(require("react"));
-var actions_1 = require("@shopify/app-bridge/actions");
+var react_1 = require("react");
+var Button_1 = require("@shopify/app-bridge/actions/Button");
+var TitleBar_1 = require("@shopify/app-bridge/actions/TitleBar");
+var ButtonGroup_1 = require("@shopify/app-bridge/actions/ButtonGroup");
 var transformers_1 = require("../../utilities/transformers");
-var context_1 = require("../../context");
-var TitleBar = /** @class */ (function (_super) {
-    __extends(TitleBar, _super);
-    function TitleBar() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    TitleBar.prototype.componentDidMount = function () {
-        var app = this.context;
-        this.titleBar = actions_1.TitleBar.create(app, this.transformProps());
-    };
-    TitleBar.prototype.componentDidUpdate = function () {
-        this.titleBar.unsubscribe();
-        this.titleBar.set(this.transformProps());
-    };
-    TitleBar.prototype.componentWillUnmount = function () {
-        this.titleBar.unsubscribe();
-    };
-    TitleBar.prototype.render = function () {
-        return null;
-    };
-    TitleBar.prototype.transformProps = function () {
-        var app = this.context;
-        var _a = this.props, title = _a.title, primaryAction = _a.primaryAction, secondaryActions = _a.secondaryActions, actionGroups = _a.actionGroups;
-        return {
-            title: title,
-            buttons: transformers_1.transformActions(app, {
-                primaryAction: primaryAction,
-                secondaryActions: secondaryActions,
-                actionGroups: actionGroups,
-            }),
-            breadcrumbs: this.transformBreadcrumbs(),
-        };
-    };
-    TitleBar.prototype.transformBreadcrumbs = function () {
-        var app = this.context;
-        var breadcrumbs = this.props.breadcrumbs;
-        if (breadcrumbs == null || breadcrumbs.length === 0) {
-            return undefined;
+var useAppBridge_1 = require("../../useAppBridge");
+function TitleBar(props) {
+    var title = props.title;
+    var app = useAppBridge_1.useAppBridge();
+    var currentProps = react_1.useRef({ title: title });
+    var titleBar = react_1.useMemo(function () {
+        /**
+         * We purposely don't pass buttons here as they will be replaced
+         * by the subsequent useEffect to call `set` to update the options.
+         * If we pass them in here button subscriptions will be created without
+         * being cleaned up.
+         */
+        return TitleBar_1.create(app, {});
+    }, [app]);
+    /**
+     * All option updates are handled in this useEffect so they can be cleaned up.
+     */
+    react_1.useEffect(function () {
+        var _a;
+        var propsChanged = JSON.stringify(currentProps.current) !== JSON.stringify(props);
+        currentProps.current = props;
+        if (propsChanged) {
+            titleBar.set(transformProps(app, props));
         }
-        var breadcrumb = breadcrumbs[breadcrumbs.length - 1];
-        var url = breadcrumb.url, onAction = breadcrumb.onAction, target = breadcrumb.target, content = breadcrumb.content;
-        var button = actions_1.Button.create(app, {
-            label: content || '',
-        });
-        var redirect = transformers_1.generateRedirect(app, url, target);
-        if (redirect != null) {
-            button.subscribe(actions_1.Button.Action.CLICK, redirect);
+        else {
+            /**
+             * We manually update the button callbacks when no props have changed aside from the
+             * callbacks to avoid sending an unnecessary UPDATE action to the host
+             */
+            var primaryAction = props.primaryAction, secondaryActions = props.secondaryActions, actionGroups = props.actionGroups, breadcrumbs = props.breadcrumbs;
+            var breadcrumb = Array.isArray(breadcrumbs)
+                ? breadcrumbs[breadcrumbs.length - 1]
+                : breadcrumbs;
+            updateButton(breadcrumb, titleBar.options.breadcrumbs);
+            updateButton(primaryAction, (_a = titleBar.options.buttons) === null || _a === void 0 ? void 0 : _a.primary);
+            updateSecondaryActions(titleBar, secondaryActions);
+            updateActionGroups(titleBar, actionGroups);
         }
-        if (onAction != null) {
-            button.subscribe(actions_1.Button.Action.CLICK, onAction);
+        return function () {
+            titleBar.unsubscribe();
+        };
+    }, [titleBar, props]);
+    return null;
+}
+exports.default = TitleBar;
+function updateSecondaryActions(titleBar, secondaryActions) {
+    var _a, _b;
+    var secondaryButtons = ((_b = (_a = titleBar.options.buttons) === null || _a === void 0 ? void 0 : _a.secondary) === null || _b === void 0 ? void 0 : _b.filter(function (button) { return !ButtonGroup_1.isGroupedButton(button); })) || [];
+    secondaryButtons === null || secondaryButtons === void 0 ? void 0 : secondaryButtons.forEach(function (secondaryButton, index) {
+        return updateButton(secondaryActions === null || secondaryActions === void 0 ? void 0 : secondaryActions[index], 
+        // This needs to be casted as the React TitleBar component doesn't accept button groups for secondary actions
+        secondaryButton);
+    });
+}
+function updateActionGroups(titleBar, actionGroups) {
+    var _a, _b;
+    var actionGroupButtons = ((_b = (_a = titleBar.options.buttons) === null || _a === void 0 ? void 0 : _a.secondary) === null || _b === void 0 ? void 0 : _b.filter(ButtonGroup_1.isGroupedButton)) ||
+        [];
+    actionGroupButtons === null || actionGroupButtons === void 0 ? void 0 : actionGroupButtons.forEach(function (actionBroupButton, index) {
+        var actionGroup = actionGroups === null || actionGroups === void 0 ? void 0 : actionGroups[index];
+        if (!actionGroup) {
+            return;
         }
-        return button;
+        actionBroupButton.options.buttons.forEach(function (nestedButton, nestedIndex) {
+            return updateButton(actionGroup.actions[nestedIndex], nestedButton);
+        });
+    });
+}
+function transformProps(app, _a) {
+    var actionGroups = _a.actionGroups, breadcrumbs = _a.breadcrumbs, primaryAction = _a.primaryAction, secondaryActions = _a.secondaryActions, title = _a.title;
+    var breadcrumb = Array.isArray(breadcrumbs) ? breadcrumbs[breadcrumbs.length - 1] : breadcrumbs;
+    return {
+        title: title,
+        buttons: transformers_1.transformActions(app, {
+            primaryAction: primaryAction,
+            secondaryActions: secondaryActions,
+            actionGroups: actionGroups,
+        }),
+        breadcrumbs: breadcrumb ? transformBreadcrumb(app, breadcrumb) : undefined,
     };
-    TitleBar.contextType = context_1.AppBridgeContext;
-    return TitleBar;
-}(react_1.default.PureComponent));
-exports.default = TitleBar;
+}
+function transformBreadcrumb(app, breadcrumb, updateBreadcrumb) {
+    var button = updateBreadcrumb ||
+        Button_1.create(app, {
+            label: breadcrumb.content || '',
+        });
+    updateButton(breadcrumb, button);
+    return button;
+}
+function updateButton(actionProps, button) {
+    if (!actionProps || !button) {
+        return;
+    }
+    var redirect = transformers_1.generateRedirect(button.app, actionProps.url, actionProps.target);
+    if (redirect) {
+        button.subscribe(Button_1.Action.CLICK, redirect, button);
+    }
+    if (actionProps === null || actionProps === void 0 ? void 0 : actionProps.onAction) {
+        button.subscribe(Button_1.Action.CLICK, actionProps.onAction, button);
+    }
+}

package/hooks/index.d.ts

@@ -1,4 +1,8 @@
 export { useContextualSaveBar } from './useContextualSaveBar';
+export { useFeaturesAvailable } from './useFeaturesAvailable';
+export { useFeatureRequest } from './useFeatureRequest';
+export type { FeaturesAvailable } from './useFeaturesAvailable';
 export { useNavigationHistory } from './useNavigationHistory';
 export { useToast } from './useToast';
 export { useAppBridgeState } from './useAppBridgeState';
+export { useNavigate } from './useNavigate';

package/hooks/index.js

@@ -1,11 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.useAppBridgeState = exports.useToast = exports.useNavigationHistory = exports.useContextualSaveBar = void 0;
+exports.useNavigate = exports.useAppBridgeState = exports.useToast = exports.useNavigationHistory = exports.useFeatureRequest = exports.useFeaturesAvailable = exports.useContextualSaveBar = void 0;
 var useContextualSaveBar_1 = require("./useContextualSaveBar");
 Object.defineProperty(exports, "useContextualSaveBar", { enumerable: true, get: function () { return useContextualSaveBar_1.useContextualSaveBar; } });
+var useFeaturesAvailable_1 = require("./useFeaturesAvailable");
+Object.defineProperty(exports, "useFeaturesAvailable", { enumerable: true, get: function () { return useFeaturesAvailable_1.useFeaturesAvailable; } });
+var useFeatureRequest_1 = require("./useFeatureRequest");
+Object.defineProperty(exports, "useFeatureRequest", { enumerable: true, get: function () { return useFeatureRequest_1.useFeatureRequest; } });
 var useNavigationHistory_1 = require("./useNavigationHistory");
 Object.defineProperty(exports, "useNavigationHistory", { enumerable: true, get: function () { return useNavigationHistory_1.useNavigationHistory; } });
 var useToast_1 = require("./useToast");
 Object.defineProperty(exports, "useToast", { enumerable: true, get: function () { return useToast_1.useToast; } });
 var useAppBridgeState_1 = require("./useAppBridgeState");
 Object.defineProperty(exports, "useAppBridgeState", { enumerable: true, get: function () { return useAppBridgeState_1.useAppBridgeState; } });
+var useNavigate_1 = require("./useNavigate");
+Object.defineProperty(exports, "useNavigate", { enumerable: true, get: function () { return useNavigate_1.useNavigate; } });

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;