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

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/hooks/useLocale/index.d.ts

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

package/hooks/useLocale/index.js

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

package/hooks/useLocale/useLocale.d.ts

@@ -0,0 +1 @@
+export declare function useLocale(): string | undefined;

package/hooks/useLocale/useLocale.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useLocale = void 0;
+var useAppBridgeState_1 = require("../useAppBridgeState");
+function useLocale() {
+    return useAppBridgeState_1.useAppBridgeState('staffMember.locale');
+}
+exports.useLocale = useLocale;

package/hooks/useNavigate/index.d.ts

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

package/hooks/useNavigate/index.js

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

package/hooks/useNavigate/useNavigate.d.ts

@@ -0,0 +1,24 @@
+import * as Redirect from '@shopify/app-bridge/actions/Navigation/Redirect';
+export interface Location {
+    pathname: string;
+    search?: string | URLSearchParams;
+    hash?: string;
+}
+export interface AppOptions {
+    replace?: boolean;
+    target?: 'self';
+}
+export interface HostOptions {
+    target: 'host' | 'new';
+}
+export declare type Options = AppOptions | HostOptions;
+export declare type To = Location | URL | string;
+export interface SectionStringName extends Omit<Redirect.Section, 'name'> {
+    name: keyof typeof Redirect.ResourceType;
+}
+export interface Navigate {
+    (to: To, options?: AppOptions): void;
+    (to: To | SectionStringName, options?: HostOptions): void;
+}
+export declare function useNavigate(): Navigate;
+export declare function isAdminSection(to: any): to is SectionStringName;

package/hooks/useNavigate/useNavigate.js

@@ -0,0 +1,109 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isAdminSection = exports.useNavigate = void 0;
+var react_1 = require("react");
+var Redirect = __importStar(require("@shopify/app-bridge/actions/Navigation/Redirect"));
+var useAppBridge_1 = require("../../useAppBridge");
+var useNavigationHistory_1 = require("../useNavigationHistory");
+function useNavigate() {
+    var app = useAppBridge_1.useAppBridge();
+    var history = useNavigationHistory_1.useNavigationHistory();
+    var redirect = react_1.useMemo(function () {
+        return Redirect.create(app);
+    }, [app]);
+    var handleRedirect = react_1.useCallback(function (to, options) {
+        var url = normalizeUrl(to);
+        var isAppUrl = url.startsWith(app.localOrigin);
+        var isHostUrl = url.startsWith(app.hostOrigin);
+        var isRelative = url.startsWith('/');
+        if (isAppUrl || isHostUrl || isRelative) {
+            var path = getRelativePath(url);
+            if (isHostUrl || (options === null || options === void 0 ? void 0 : options.target) === 'new' || (options === null || options === void 0 ? void 0 : options.target) === 'host') {
+                redirect.dispatch(Redirect.Action.ADMIN_PATH, {
+                    path: path.replace(/^\/admin/, ''),
+                    newContext: (options === null || options === void 0 ? void 0 : options.target) === 'new',
+                });
+                return;
+            }
+            if (((options === null || options === void 0 ? void 0 : options.target) === 'self' || !(options === null || options === void 0 ? void 0 : options.target)) && (options === null || options === void 0 ? void 0 : options.replace)) {
+                history.replace({ pathname: path });
+                return;
+            }
+            redirect.dispatch(Redirect.Action.APP, path);
+            return;
+        }
+        redirect.dispatch(Redirect.Action.REMOTE, {
+            url: url,
+            newContext: (options === null || options === void 0 ? void 0 : options.target) === 'new',
+        });
+    }, [redirect, history]);
+    return react_1.useCallback(function (to, options) {
+        if (isAdminSection(to)) {
+            var convertedSection = __assign(__assign({}, to), { name: Redirect.ResourceType[to.name] });
+            redirect.dispatch(Redirect.Action.ADMIN_SECTION, {
+                section: convertedSection,
+                newContext: (options === null || options === void 0 ? void 0 : options.target) === 'new',
+            });
+            return;
+        }
+        handleRedirect(to, options);
+    }, [handleRedirect, redirect]);
+}
+exports.useNavigate = useNavigate;
+function isAdminSection(to) {
+    return typeof to === 'object' && typeof (to === null || to === void 0 ? void 0 : to.name) === 'string';
+}
+exports.isAdminSection = isAdminSection;
+function getPathWithSearchAndHash(_a) {
+    var pathname = _a.pathname, search = _a.search, hash = _a.hash;
+    return "" + pathname + (search || '') + (hash || '');
+}
+function normalizeUrl(to) {
+    if (to instanceof URL) {
+        return to.toString();
+    }
+    if (typeof to === 'string') {
+        return to;
+    }
+    return getRelativePath(to);
+}
+function getRelativePath(to) {
+    if (typeof to === 'string') {
+        if (to.startsWith('/')) {
+            return to;
+        }
+        return getPathWithSearchAndHash(new URL(to));
+    }
+    var search = to.search instanceof URLSearchParams ? to.search.toString() : to.search;
+    return getPathWithSearchAndHash(__assign(__assign({}, to), { search: search }));
+}

package/hooks/useNavigationHistory/index.d.ts

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

package/hooks/useNavigationHistory/index.js

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

package/hooks/useNavigationHistory/useNavigationHistory.d.ts

@@ -0,0 +1,16 @@
+/**
+ * useNavigationHistory hook
+ *
+ * @remarks
+ * React hook which wraps the Shopify App Bridge History action.
+ *
+ * @public
+ */
+export declare function useNavigationHistory(): {
+    push: (location: {
+        pathname: string;
+    }) => void;
+    replace: (location: {
+        pathname: string;
+    }) => void;
+};

package/hooks/useNavigationHistory/useNavigationHistory.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useNavigationHistory = void 0;
+var react_1 = require("react");
+var actions_1 = require("@shopify/app-bridge/actions");
+var useAppBridge_1 = require("../../useAppBridge");
+/**
+ * useNavigationHistory hook
+ *
+ * @remarks
+ * React hook which wraps the Shopify App Bridge History action.
+ *
+ * @public
+ */
+function useNavigationHistory() {
+    var app = useAppBridge_1.useAppBridge();
+    return react_1.useMemo(function () {
+        var history = actions_1.History.create(app);
+        function push(location) {
+            history.dispatch(actions_1.History.Action.PUSH, location.pathname);
+        }
+        function replace(location) {
+            history.dispatch(actions_1.History.Action.REPLACE, location.pathname);
+        }
+        return { push: push, replace: replace };
+    }, []);
+}
+exports.useNavigationHistory = useNavigationHistory;

package/hooks/useToast/index.d.ts

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

package/hooks/useToast/index.js

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

package/hooks/useToast/useToast.d.ts

@@ -0,0 +1,15 @@
+import type { Payload } from '@shopify/app-bridge/actions/Toast';
+export declare const DEFAULT_TOAST_DURATION = 5000;
+/**
+ * useToast hook
+ *
+ * @remarks
+ * React hook which wraps the Shopify App Bridge Toast action.
+ *
+ * @public
+ */
+export declare function useToast(): {
+    show: ({ content: message, duration, isError, onDismiss, }: Omit<Payload, 'message'> & {
+        content: string;
+    }) => void;
+};

package/hooks/useToast/useToast.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useToast = exports.DEFAULT_TOAST_DURATION = void 0;
+var react_1 = require("react");
+var Toast_1 = require("@shopify/app-bridge/actions/Toast");
+var useAppBridge_1 = require("../../useAppBridge");
+exports.DEFAULT_TOAST_DURATION = 5000;
+/**
+ * useToast hook
+ *
+ * @remarks
+ * React hook which wraps the Shopify App Bridge Toast action.
+ *
+ * @public
+ */
+function useToast() {
+    var app = useAppBridge_1.useAppBridge();
+    var toast;
+    var show = react_1.useCallback(function (_a) {
+        var message = _a.content, _b = _a.duration, duration = _b === void 0 ? exports.DEFAULT_TOAST_DURATION : _b, isError = _a.isError, onDismiss = _a.onDismiss;
+        toast = Toast_1.create(app, {
+            message: message,
+            isError: isError,
+            duration: duration,
+        });
+        toast.dispatch(Toast_1.Action.SHOW);
+        if (onDismiss) {
+            toast.subscribe(Toast_1.Action.CLEAR, onDismiss);
+        }
+    }, [app]);
+    react_1.useEffect(function () {
+        return function () {
+            toast.unsubscribe();
+        };
+    }, []);
+    return { show: show };
+}
+exports.useToast = useToast;

package/index.d.ts

@@ -0,0 +1,4 @@
+export * from './components';
+export { AppBridgeContext as Context } from './context';
+export { useAppBridge } from './useAppBridge';
+export * from './hooks';

package/index.js

@@ -0,0 +1,19 @@
+"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 });
+exports.useAppBridge = exports.Context = void 0;
+__exportStar(require("./components"), exports);
+var context_1 = require("./context");
+Object.defineProperty(exports, "Context", { enumerable: true, get: function () { return context_1.AppBridgeContext; } });
+var useAppBridge_1 = require("./useAppBridge");
+Object.defineProperty(exports, "useAppBridge", { enumerable: true, get: function () { return useAppBridge_1.useAppBridge; } });
+__exportStar(require("./hooks"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shopify/app-bridge-react",
-  "version": "2.1.1-alpha.0",
+  "version": "2.1.1-alpha.1",
   "types": "index.d.ts",
   "main": "index.js",
   "unpkg": "umd/index.js",
@@ -45,7 +45,7 @@
     }
   ],
   "dependencies": {
-    "@shopify/app-bridge": "^2.1.1-alpha.0"
+    "@shopify/app-bridge": "^2.1.1-alpha.1"
   },
   "devDependencies": {
     "@types/react": "^17.0.38",
@@ -55,5 +55,5 @@
   "peerDependencies": {
     "react": "^16.0.0 || ^17.0.0 || ^18.0.0"
   },
-  "gitHead": "52a61413c8c25ed7f42bc0651fd08a9e3b9e4072"
+  "gitHead": "6dd83d2fd64ef387e1902a14db27473525182f36"
 }

package/types.d.ts

@@ -0,0 +1,35 @@
+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 */
+    content?: string;
+    /** Should the action be styled as destructive */
+    destructive?: boolean;
+    /** Should the action be disabled */
+    disabled?: boolean;
+    /** Should the action be loading */
+    loading?: boolean;
+    /** Forces url to open in a new tab */
+    external?: boolean;
+    /** Use Polaris plain styling */
+    plain?: boolean;
+    /**
+     * Where to display the target link
+     * @default 'APP'
+     */
+    target?: Target;
+    /** A destination to link to */
+    url?: string;
+    /** Callback when an action takes place */
+    onAction?(): void;
+}
+export interface ActionGroupProps {
+    /** Action group title */
+    title: string;
+    /** Use Polaris plain styling */
+    plain?: boolean;
+    /** List of actions */
+    actions: ActionProps[];
+}
+export { Group };

package/types.js

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