@shopify/app-bridge
Version:
**Shopify is doubling our engineering staff in 2021! [Join our team and work on libraries like this one.](https://smrtr.io/5GGrc)**
55 lines (54 loc) • 1.66 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.LifecycleHook = exports.MessageType = exports.PermissionType = exports.isV1Config = void 0;
/**
* @internal
* @param config
*/
function isV1Config(config) {
return config.shopOrigin !== undefined;
}
exports.isV1Config = isV1Config;
/**
* @internal
*/
var PermissionType;
(function (PermissionType) {
PermissionType["Dispatch"] = "Dispatch";
PermissionType["Subscribe"] = "Subscribe";
})(PermissionType = exports.PermissionType || (exports.PermissionType = {}));
/**
* @internal
*/
var MessageType;
(function (MessageType) {
MessageType["GetState"] = "getState";
MessageType["Dispatch"] = "dispatch";
MessageType["Subscribe"] = "subscribe";
MessageType["Unsubscribe"] = "unsubscribe";
})(MessageType = exports.MessageType || (exports.MessageType = {}));
/**
*
* There are two types of hooks: `LifecycleHook.DispatchAction` and `LifecycleHook.UpdateAction`.
*
* @remarks
* `DispatchAction` hooks are run when an action is dispatched with the `.dispatch()` function:
*
* ```js
* const toastNotice = Toast.create(app, {message: 'Product saved'});
* toastNotice.dispatch(Toast.Action.SHOW);
* ```
*
* `UpdateAction` hooks are run when an action is updated, using the `.set()` function:
*
* ```js
* toastNotice.set({message: 'Product could not be saved', isError: true});
* ```
*
* @public
*/
var LifecycleHook;
(function (LifecycleHook) {
LifecycleHook["UpdateAction"] = "UpdateAction";
LifecycleHook["DispatchAction"] = "DispatchAction";
})(LifecycleHook = exports.LifecycleHook || (exports.LifecycleHook = {}));