@shopify/app-bridge-host
Version:
App Bridge Host contains middleware and components that are meant to be consumed by the app's host. The middleware and `Frame` component are responsible for facilitating messages posted between the client and host, and used to act on actions sent from the
87 lines (86 loc) • 4.04 kB
JavaScript
;
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 __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)
t[p[i]] = s[p[i]];
return t;
};
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
result["default"] = mod;
return result;
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
var react_1 = __importStar(require("react"));
var react_redux_1 = require("react-redux");
var Error_1 = require("@shopify/app-bridge/actions/Error");
var Middleware_1 = require("./Middleware");
var async_1 = require("./store/async");
var Host_1 = __importDefault(require("./Host"));
/**
* The context provider for the app, config and addReducer method
* @public
* */
exports.HostContext = react_1.createContext(null);
/**
* The context provider for the router.
* Keeps track of the current location and
* handles history push/replace
* @public
* */
exports.RouterContext = react_1.createContext(null);
/**
* A component that creates a dynamic Redux store
* and renders the Host
* @public
* */
function HostProvider(props) {
var config = props.config, dispatchClientEventHandler = props.dispatchClientEventHandler, initialState = props.initialState, router = props.router, hostProps = __rest(props, ["config", "dispatchClientEventHandler", "initialState", "router"]);
var appBridgeMiddleware = react_1.useMemo(function () { return Middleware_1.buildMiddleware(async_1.APP_BRIDGE_KEY, dispatchClientEventHandler); }, [dispatchClientEventHandler]);
if (!config) {
Error_1.throwError(Error_1.AppActionType.MISSING_CONFIG, 'Missing required prop `config`');
}
if (!appBridgeMiddleware || typeof appBridgeMiddleware.load !== 'function') {
Error_1.throwError(Error_1.AppActionType.MISSING_APP_BRIDGE_MIDDLEWARE, 'Missing required context `appBridgeMiddleware`. Maybe you forgot the App Bridge `<Provider>` component?');
}
var store = react_1.useMemo(function () {
// Only take the features state as features is the only default reducer
var defaultState = initialState.features && { features: initialState.features };
return async_1.createStore([appBridgeMiddleware], defaultState);
}, [appBridgeMiddleware]);
var hostContext = react_1.useMemo(function () {
var addReducer = async_1.createAddReducer(store, initialState);
var app = appBridgeMiddleware.load({
config: config,
type: 'application',
});
return { app: app, addReducer: addReducer, config: config };
}, [config]);
var content = (react_1.default.createElement(react_redux_1.Provider, { store: store },
react_1.default.createElement(Host_1.default, __assign({}, hostProps))));
if (!router) {
return react_1.default.createElement(exports.HostContext.Provider, { value: hostContext }, content);
}
return (react_1.default.createElement(exports.HostContext.Provider, { value: hostContext },
react_1.default.createElement(exports.RouterContext.Provider, { value: router }, content)));
}
exports.default = HostProvider;