@aurigma/design-editor-iframe
Version:
Using this module you can embed Design Editor (a part of Customer's Canvas) to your page through the IFrame API.
110 lines • 6.73 kB
JavaScript
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 };
}
};
import { EditorLoader } from "./EditorLoader";
import { loadEditor, setEditorUrl } from "./IframeApi";
/**
* Using this class you can load {@link (Editor:class)} instances to a specified iframe element and initialize them with a specified product and configuration.
* @public
*/
var EditorBuilder = /** @class */ (function () {
/**
* Creates a new instance of the builder. Note, you may prefer to use a static method {@link EditorBuilder.for} instead.
*
* @param backendUrl - a URL to your Design Editor instance (can be installed either on your server or hosted on Aurigma's servers). If you don't have it, contact Aurigma team at <a href="mailto:info@aurigma.com">info\@aurigma.com</a>.
*/
function EditorBuilder(backendUrl) {
this.backendUrl = backendUrl;
setEditorUrl(backendUrl);
}
/**
* The same as a constructor, but implemented as a static method.
*
* @param backendUrl - a URL to your Design Editor instance (can be installed either on your server or hosted on Aurigma's servers). If you don't have it, contact Aurigma team at <a href="mailto:info@aurigma.com">info\@aurigma.com</a>.
*
* @example You may think of this methods as a "syntax sugar" to make it possible creating the editor with a single line, like this:
* ``` ts
* const editor = EditorLoader.for('<your-URL>').build(...);
* ```
*/
EditorBuilder.for = function (backendUrl) {
return new EditorBuilder(backendUrl);
};
/**
* Creates an invisible iframe and preloads all Design Editor scripts inside it to cache them in a browser.
*
* @remarks Use this method in scenarios when instead of calling the {@link EditorBuilder.build} method in the beginning of a page lifecycle,
* you do it later (e.g. when the user clicks a sort of a "Personalize" button). In this case, you should call the {@link EditorBuilder.preload}
* as early as possible. By the moment when you call {@link EditorBuilder.build}, all Design Editor scripts will be loaded to the browser cache and
* the editor will be opened very quickly.
*
* If you call the {@link EditorBuilder.build} during the page initialization, there is no need to preload scripts.
*
* Hint: Although this method is async, most likely you don't want to call it with `await`. You should just call it and let it work in
* the background.
*/
EditorBuilder.prototype.preload = function () {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, EditorLoader.preload(this.backendUrl)];
case 1: return [2 /*return*/, _a.sent()];
}
});
});
};
/**
* Builds an instance of {@link (Editor:class)} and loads it in a specified iframe element.
*
* @param target - the IFrame element where you want to load the editor. If another instance of an editor is already loaded, it will be automatically disposed.
* @param productDefinition - it can be either a {@link IProductDefinition} structure describing the template you want to load or a string (array of strings) containing the ID of state files. When multiple state files specified, they are merged to a single product.
* @param config - the editor configuration described with the {@link IConfiguration} structure.
* @returns The {@link (Editor:class)} class instance which allows manipulating the editor and its content.
*/
EditorBuilder.prototype.build = function (target, productDefinition, config) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, loadEditor(target, productDefinition, config)];
case 1: return [2 /*return*/, _a.sent()];
}
});
});
};
return EditorBuilder;
}());
export { EditorBuilder };
//# sourceMappingURL=EditorBuilder.js.map