@shopify/app-bridge-react 3.7.11-snapshot-20240220213625 → 4.0.0

package/hooks/useLocale/useLocale.js

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

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

package/hooks/useNavigate/index.js

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

@@ -1,3 +0,0 @@
-import type { To, Navigate } from '@shopify/app-bridge/actions/Navigation/Redirect';
-export declare function useNavigate(): Navigate<To>;
-export type { Location, AppOptions, HostOptions, Options, To, SectionStringName, Navigate, } from '@shopify/app-bridge/actions/Navigation/Redirect';

package/hooks/useNavigate/useNavigate.js

@@ -1,63 +0,0 @@
-"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);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useNavigate = void 0;
-var react_1 = require("react");
-var Redirect_1 = 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_1.create(app);
-    }, [app]);
-    var handleRedirect = react_1.useCallback(function (to, options) {
-        var url = Redirect_1.normalizeUrl(to);
-        var isAppUrl = url.startsWith(app.localOrigin);
-        var isHostUrl = url.startsWith(app.hostOrigin);
-        var isRelative = url.startsWith('/');
-        if (isAppUrl || isHostUrl || isRelative) {
-            var path = Redirect_1.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_1.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_1.Action.APP, path);
-            return;
-        }
-        redirect.dispatch(Redirect_1.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 (Redirect_1.isAdminSection(to)) {
-            var convertedSection = __assign(__assign({}, to), { name: Redirect_1.ResourceType[to.name] });
-            redirect.dispatch(Redirect_1.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;

package/hooks/useNavigationHistory/index.d.ts

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

package/hooks/useNavigationHistory/index.js

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

@@ -1,16 +0,0 @@
-/**
- * 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

@@ -1,28 +0,0 @@
-"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/useOnceEffect/index.d.ts

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

package/hooks/useOnceEffect/index.js

@@ -1,13 +0,0 @@
-"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("./useOnceEffect"), exports);

package/hooks/useOnceEffect/useOnceEffect.d.ts

@@ -1,5 +0,0 @@
-import React from 'react';
-/**
- * `useLayoutEffect`, but never runs twice, even in React 18 StrictMode.
- */
-export declare const useOnceEffect: typeof React.useInsertionEffect;

package/hooks/useOnceEffect/useOnceEffect.js

@@ -1,11 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useOnceEffect = void 0;
-var react_1 = __importDefault(require("react"));
-/**
- * `useLayoutEffect`, but never runs twice, even in React 18 StrictMode.
- */
-exports.useOnceEffect = react_1.default.useInsertionEffect || react_1.default.useLayoutEffect;

package/hooks/useToast/index.d.ts

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

package/hooks/useToast/index.js

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

@@ -1,20 +0,0 @@
-import type { Payload } from '@shopify/app-bridge/actions/Toast';
-export declare const DEFAULT_TOAST_DURATION = 5000;
-interface ShowOptionsPayload extends Payload {
-    action?: {
-        content: string;
-        onAction?: () => void;
-    };
-}
-/**
- * useToast hook
- *
- * @remarks
- * React hook which wraps the Shopify App Bridge Toast action.
- *
- * @public
- */
-export declare function useToast(): {
-    show: (content: string, options?: Partial<Omit<ShowOptionsPayload, "message">> | undefined) => void;
-};
-export {};

package/hooks/useToast/useToast.js

@@ -1,46 +0,0 @@
-"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 toastList = react_1.useRef([]);
-    var show = react_1.useCallback(function (content, options) {
-        var toast = Toast_1.create(app, {
-            message: content,
-            isError: options === null || options === void 0 ? void 0 : options.isError,
-            duration: (options === null || options === void 0 ? void 0 : options.duration) || exports.DEFAULT_TOAST_DURATION,
-            action: options === null || options === void 0 ? void 0 : options.action,
-        });
-        toast.dispatch(Toast_1.Action.SHOW);
-        toastList.current.push(toast);
-        toast.subscribe(Toast_1.Action.CLEAR, function () {
-            var _a;
-            (_a = options === null || options === void 0 ? void 0 : options.onDismiss) === null || _a === void 0 ? void 0 : _a.call(options);
-            toastList.current.splice(toastList.current.indexOf(toast), 1);
-            toast.unsubscribe();
-        });
-        toast.subscribe(Toast_1.Action.ACTION, function () {
-            var _a, _b;
-            (_b = (_a = options === null || options === void 0 ? void 0 : options.action) === null || _a === void 0 ? void 0 : _a.onAction) === null || _b === void 0 ? void 0 : _b.call(_a);
-        });
-    }, [app]);
-    react_1.useEffect(function () {
-        return function () {
-            toastList.current.forEach(function (toast) { return toast === null || toast === void 0 ? void 0 : toast.unsubscribe(); });
-        };
-    }, []);
-    return { show: show };
-}
-exports.useToast = useToast;

package/index.d.ts

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

package/index.js

@@ -1,19 +0,0 @@
-"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;
-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("./components"), exports);
-__exportStar(require("./hooks"), exports);

package/types.d.ts

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

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