@shopify/app-bridge-react 2.1.1-alpha.0 → 2.1.1-alpha.1

package/components/TitleBar/TitleBar.d.ts

@@ -0,0 +1,27 @@
+import { ActionProps, ActionGroupProps, Target } from '../../types';
+export interface Breadcrumb {
+    /** Content the action displays */
+    content?: string;
+    /** A destination to link to */
+    url?: string;
+    /**
+     * Where to display the target link
+     * @default 'APP'
+     */
+    target?: Target;
+    /** Callback when an action takes place */
+    onAction?(): void;
+}
+export interface Props {
+    /** TitleBar title */
+    title: string;
+    /** The current breadcrumb; only displays the last item in array */
+    breadcrumbs?: Breadcrumb | Breadcrumb[];
+    /** Primary TitleBar action */
+    primaryAction?: ActionProps;
+    /** Collection of secondary TitleBar actions */
+    secondaryActions?: ActionProps[];
+    /** Collection of TitleBar groups of secondary actions */
+    actionGroups?: ActionGroupProps[];
+}
+export default function TitleBar(props: Props): null;

package/components/TitleBar/TitleBar.js

@@ -0,0 +1,108 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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 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));
+        }
+        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);
+        }
+        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;
+        }
+        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,
+    };
+}
+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, actionProps.external);
+    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/components/TitleBar/index.d.ts

@@ -0,0 +1,3 @@
+import TitleBar from './TitleBar';
+export { Props } from './TitleBar';
+export default TitleBar;

package/components/TitleBar/index.js

@@ -0,0 +1,7 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var TitleBar_1 = __importDefault(require("./TitleBar"));
+exports.default = TitleBar_1.default;

package/components/Toast/Toast.d.ts

@@ -0,0 +1,31 @@
+import React from 'react';
+export interface Props {
+    /** The content that should appear in the toast message */
+    content: string;
+    /**
+     * The length of time in milliseconds the toast message should persist
+     * @default 5000
+     */
+    duration?: number;
+    /** Display an error toast. */
+    error?: boolean;
+    /** Callback when the dismiss icon is clicked */
+    onDismiss(): void;
+}
+export declare const DEFAULT_TOAST_DURATION = 5000;
+/**
+ * Toast component
+ *
+ * @remarks
+ * React component which wraps the Shopify App Bridge Toast action.
+ *
+ * @public
+ */
+declare class Toast extends React.PureComponent<Props, never> {
+    static contextType: React.Context<import("../../context").IAppBridgeContext>;
+    private toast;
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+    render(): null;
+}
+export default Toast;

package/components/Toast/Toast.js

@@ -0,0 +1,59 @@
+"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 });
+exports.DEFAULT_TOAST_DURATION = void 0;
+var react_1 = __importDefault(require("react"));
+var actions_1 = require("@shopify/app-bridge/actions");
+var context_1 = require("../../context");
+exports.DEFAULT_TOAST_DURATION = 5000;
+/**
+ * Toast component
+ *
+ * @remarks
+ * React component which wraps the Shopify App Bridge Toast action.
+ *
+ * @public
+ */
+var Toast = /** @class */ (function (_super) {
+    __extends(Toast, _super);
+    function Toast() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    Toast.prototype.componentDidMount = function () {
+        var app = this.context;
+        var _a = this.props, error = _a.error, content = _a.content, _b = _a.duration, duration = _b === void 0 ? exports.DEFAULT_TOAST_DURATION : _b, onDismiss = _a.onDismiss;
+        this.toast = actions_1.Toast.create(app, {
+            message: content,
+            duration: duration,
+            isError: error,
+        });
+        this.toast.subscribe(actions_1.Toast.Action.CLEAR, onDismiss);
+        this.toast.dispatch(actions_1.Toast.Action.SHOW);
+    };
+    Toast.prototype.componentWillUnmount = function () {
+        this.toast.unsubscribe();
+    };
+    Toast.prototype.render = function () {
+        return null;
+    };
+    Toast.contextType = context_1.AppBridgeContext;
+    return Toast;
+}(react_1.default.PureComponent));
+exports.default = Toast;

package/components/Toast/index.d.ts

@@ -0,0 +1,3 @@
+import Toast from './Toast';
+export { Props } from './Toast';
+export default Toast;

package/components/Toast/index.js

@@ -0,0 +1,7 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var Toast_1 = __importDefault(require("./Toast"));
+exports.default = Toast_1.default;

package/components/index.d.ts

@@ -0,0 +1,10 @@
+export { default as ContextualSaveBar, Props as ContextualSaveBarProps } from './ContextualSaveBar';
+export { default as Loading } from './Loading';
+export { default as Modal, Props as ModalProps, ModalContent } from './Modal';
+export { default as NavigationMenu, Props as NavigationMenuProps } from './NavigationMenu';
+export { default as Provider, Props as ProviderProps } from './Provider';
+export { default as ResourcePicker, Props as ResourcePickerProps } from './ResourcePicker';
+export { default as TitleBar } from './TitleBar';
+export { default as Toast, Props as ToastProps } from './Toast';
+export * from './RoutePropagator';
+export * from './ClientRouter';

package/components/index.js

@@ -0,0 +1,35 @@
+"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);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Toast = exports.TitleBar = exports.ResourcePicker = exports.Provider = exports.NavigationMenu = exports.ModalContent = exports.Modal = exports.Loading = exports.ContextualSaveBar = void 0;
+var ContextualSaveBar_1 = require("./ContextualSaveBar");
+Object.defineProperty(exports, "ContextualSaveBar", { enumerable: true, get: function () { return __importDefault(ContextualSaveBar_1).default; } });
+var Loading_1 = require("./Loading");
+Object.defineProperty(exports, "Loading", { enumerable: true, get: function () { return __importDefault(Loading_1).default; } });
+var Modal_1 = require("./Modal");
+Object.defineProperty(exports, "Modal", { enumerable: true, get: function () { return __importDefault(Modal_1).default; } });
+Object.defineProperty(exports, "ModalContent", { enumerable: true, get: function () { return Modal_1.ModalContent; } });
+var NavigationMenu_1 = require("./NavigationMenu");
+Object.defineProperty(exports, "NavigationMenu", { enumerable: true, get: function () { return __importDefault(NavigationMenu_1).default; } });
+var Provider_1 = require("./Provider");
+Object.defineProperty(exports, "Provider", { enumerable: true, get: function () { return __importDefault(Provider_1).default; } });
+var ResourcePicker_1 = require("./ResourcePicker");
+Object.defineProperty(exports, "ResourcePicker", { enumerable: true, get: function () { return __importDefault(ResourcePicker_1).default; } });
+var TitleBar_1 = require("./TitleBar");
+Object.defineProperty(exports, "TitleBar", { enumerable: true, get: function () { return __importDefault(TitleBar_1).default; } });
+var Toast_1 = require("./Toast");
+Object.defineProperty(exports, "Toast", { enumerable: true, get: function () { return __importDefault(Toast_1).default; } });
+__exportStar(require("./RoutePropagator"), exports);
+__exportStar(require("./ClientRouter"), exports);

package/context.d.ts

@@ -0,0 +1,13 @@
+import type { ClientApplication } from '@shopify/app-bridge/client';
+/**
+ * App Bridge context consumer type.
+ *
+ * @public
+ */
+export declare type IAppBridgeContext = ClientApplication | null;
+/**
+ * App Bridge context.
+ *
+ * @public
+ */
+export declare const AppBridgeContext: import("react").Context<IAppBridgeContext>;

package/context.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AppBridgeContext = void 0;
+var react_1 = require("react");
+/**
+ * App Bridge context.
+ *
+ * @public
+ */
+exports.AppBridgeContext = react_1.createContext(null);

package/hooks/index.d.ts

@@ -0,0 +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

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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/index.d.ts

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

package/hooks/useAppBridgeState/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("./useAppBridgeState"), exports);

package/hooks/useAppBridgeState/useAppBridgeState.d.ts

@@ -0,0 +1,10 @@
+import type { AppBridgeState, Path, PathValue, StateWithoutFeatures } from '@shopify/app-bridge';
+declare type Query = keyof AppBridgeState | Path<StateWithoutFeatures<AppBridgeState>>;
+declare type State<K extends Query> = K extends keyof AppBridgeState ? AppBridgeState[K] : K extends Path<StateWithoutFeatures<AppBridgeState>> ? PathValue<StateWithoutFeatures<AppBridgeState>, K> : K extends never ? AppBridgeState : never;
+interface UseAppBridgeState {
+    (): AppBridgeState | undefined;
+    <K extends Query>(query: K): State<K> | undefined;
+    <PartialState>(query: keyof AppBridgeState): PartialState | undefined;
+}
+export declare const useAppBridgeState: UseAppBridgeState;
+export {};

package/hooks/useAppBridgeState/useAppBridgeState.js

@@ -0,0 +1,89 @@
+"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.useAppBridgeState = void 0;
+var react_1 = require("react");
+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 newState, _a;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    if (!query) return [3 /*break*/, 2];
+                    return [4 /*yield*/, app.getState(query)];
+                case 1:
+                    _a = _b.sent();
+                    return [3 /*break*/, 4];
+                case 2: return [4 /*yield*/, app.getState()];
+                case 3:
+                    _a = _b.sent();
+                    _b.label = 4;
+                case 4:
+                    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]);
+    react_1.useEffect(function () {
+        refresh();
+        // Automatically check to see if the state has changed every time an action has been dispatched
+        return app.subscribe(function () {
+            refresh();
+        });
+    }, [app, refresh]);
+    react_1.useEffect(function () {
+        return function () {
+            isUnmounted.current = true;
+        };
+    }, [app]);
+    return state;
+};
+exports.useAppBridgeState = useAppBridgeState;

package/hooks/useContextualSaveBar/index.d.ts

@@ -0,0 +1 @@
+export { useContextualSaveBar } from './useContextualSaveBar';

package/hooks/useContextualSaveBar/index.js

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

package/hooks/useContextualSaveBar/useContextualSaveBar.d.ts

@@ -0,0 +1,13 @@
+import type { ContextAction, DiscardAction } from '@shopify/app-bridge/actions/ContextualSaveBar';
+export interface Props {
+    discardAction: DiscardAction & {
+        onAction(): void;
+    };
+    saveAction: ContextAction & {
+        onAction(): void;
+    };
+    fullWidth?: boolean;
+    leaveConfirmationDisable?: boolean;
+    visible?: boolean;
+}
+export declare function useContextualSaveBar({ discardAction, saveAction, fullWidth, leaveConfirmationDisable, visible, }: Props): null;

package/hooks/useContextualSaveBar/useContextualSaveBar.js

@@ -0,0 +1,68 @@
+"use strict";
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useContextualSaveBar = void 0;
+var react_1 = require("react");
+var ContextualSaveBar_1 = require("@shopify/app-bridge/actions/ContextualSaveBar");
+var useAppBridge_1 = require("../../useAppBridge");
+function useContextualSaveBar(_a) {
+    var discardAction = _a.discardAction, saveAction = _a.saveAction, fullWidth = _a.fullWidth, leaveConfirmationDisable = _a.leaveConfirmationDisable, visible = _a.visible;
+    var app = useAppBridge_1.useAppBridge();
+    var onSaveAction = saveAction.onAction, saveActionProps = __rest(saveAction, ["onAction"]);
+    var onDiscardAction = discardAction.onAction, discardActionProps = __rest(discardAction, ["onAction"]);
+    /* We want to reuse the same ContextualSaveBar instance, even when props change
+     * (so we don't include all the props in the dependency array).
+     * Instead of recreating the component on every change, we use the set method,
+     * in the useEffect block below, to dispatch updates when props change.
+     */
+    var contextualSaveBar = react_1.useMemo(function () {
+        return ContextualSaveBar_1.create(app, {
+            saveAction: saveActionProps,
+            discardAction: discardActionProps,
+            fullWidth: fullWidth,
+            leaveConfirmationDisable: leaveConfirmationDisable,
+        });
+    }, [app]);
+    react_1.useEffect(function () {
+        contextualSaveBar.set({
+            saveAction: saveActionProps,
+            discardAction: discardActionProps,
+            fullWidth: fullWidth,
+            leaveConfirmationDisable: leaveConfirmationDisable,
+        }, Boolean(visible));
+    }, [
+        contextualSaveBar,
+        saveActionProps,
+        discardActionProps,
+        fullWidth,
+        leaveConfirmationDisable,
+        visible,
+    ]);
+    react_1.useEffect(function () {
+        contextualSaveBar.subscribe(ContextualSaveBar_1.Action.DISCARD, onDiscardAction);
+        contextualSaveBar.subscribe(ContextualSaveBar_1.Action.SAVE, onSaveAction);
+        return function () {
+            contextualSaveBar.unsubscribe();
+        };
+    }, [contextualSaveBar]);
+    react_1.useEffect(function () {
+        if (visible) {
+            contextualSaveBar.dispatch(ContextualSaveBar_1.Action.SHOW);
+        }
+        else {
+            contextualSaveBar.dispatch(ContextualSaveBar_1.Action.HIDE);
+        }
+    }, [contextualSaveBar, visible]);
+    return null;
+}
+exports.useContextualSaveBar = useContextualSaveBar;

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;