@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.
172 lines • 8.81 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 };
}
};
/**
* Allows you to get and set the user ID and PDF metadata of a product at runtime.
* @public
*/
var RuntimeConfiguration = /** @class */ (function () {
/** @internal */
function RuntimeConfiguration(_postMessageClient) {
this._postMessageClient = _postMessageClient;
}
/**
* Reads PDF metadata of the current product.
* @returns The `IPdfMetadata` structure with data to be saved in the hi-res output.
* @example
* ``` js
* const data = await editor.configuration.getPdfMetadata()
* .catch(error => console.error("Retrieving PDF metadata failed with exception: ", error));
*
* console.info("getPdfMetadata returned: " + data.title);
* ```
*/
RuntimeConfiguration.prototype.getPdfMetadata = function () {
return this._postMessageClient.callProcedure("getPdfMetadata");
};
/**
* Sets PDF metadata to the current product.
* @param config - PDF metadata to be saved in the hi-res output.
* @example
* ``` js
* editor.configuration.setPdfMetadata({
* author: "John Wood",
* title: "Postcard template with flowers",
* keywords: "red,flower,postcard"
* })
* .catch(error => console.error("setPdfMetadata failed with exception: ", error));
* ```
*/
RuntimeConfiguration.prototype.setPdfMetadata = function (config) {
return this._postMessageClient.callProcedure("setPdfMetadata", config);
};
/**
* Reads ID of the user working on the product.
* @returns The user identifier.
* @example
* ``` js
* let editor = await CustomersCanvas.IframeApi.loadEditor(iframe, productDefinition, config);
* console.log(await editor.configuration.getUserId());
* ```
*/
RuntimeConfiguration.prototype.getUserId = function () {
return this._postMessageClient.callProcedure("getUserId");
};
/**
* Loads metadata of an image.
* @param url - The link to the image.
* @param fromDesignImages - If `true`, gets metadata from the design gallery.
* @returns Image properties.
* @example
* ``` js
* // Get metadata of an image in the public gallery.
* const metaData = await editor.configuration.getImageMetadata("public:backgrounds/azure.jpg");
* ```
*/
RuntimeConfiguration.prototype.getImageMetadata = function (url, fromDesignImages) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, this._postMessageClient.callProcedure("getImageMetadata", url, fromDesignImages)];
case 1: return [2 /*return*/, _a.sent()];
}
});
});
};
/**
* Sets a new user identifier and moves user files to this user's folders.
* @remarks Before using this method, you must enable the {@link https://customerscanvas.com/dev/editors/design-editor-web-app/it-ops/config-backend/appsettings.html#SecureModeEnabled|secure mode} and {@link https://customerscanvas.com/dev/editors/design-editor-web-app/apis/auth-tokens.html|update an authentication token} by using the `additionalUserId` parameter with the new user identifier.
* @param userId - The new user identifier that needs to be set for the product.
* @example
* ``` html
* <html>
* <head>
* <title>Setting a new user ID</title>
* <!-- The IFrame API script. IMPORTANT! Do not remove or change the ID. -->
* <script id="CcIframeApiScript" type="text/javascript" src="https://example.com/Resources/Generated/IframeApi.js">
* </script>
* </head>
* <body>
* <!-- The iframe to display the editor in. -->
* <iframe id="editorFrame" width="100%" height="800px"></iframe>
* <input type="button" value="Set User ID" onclick="setUserID()" />
*
* <script>
* let editor = null;
*
* document.addEventListener('DOMContentLoaded', async () => {
* // Initialize product with an Invitation template.
* const productDefinition = { surfaces: ["invitation"] };
* // Get the iframe element to display the editor in.
* const iframe = document.getElementById("editorFrame");
* // Load the editor.
* editor = await CustomersCanvas.IframeApi.loadEditor(iframe, productDefinition)
* // If there was an error thrown when loading the editor.
* .catch(e => console.log(e));
* });
*
* // Set JohnWood as a new user ID.
* async function setUserID() {
* let userId = await editor.configuration.getUserId();
* // Get an active token for the current user.
* let token = (await (await fetch("https://example.com/api/Auth/Users/" + userId + "/Tokens",
* {
* method: "GET",
* headers: { "X-CustomersCanvasAPIKey": "UniqueSecurityKey" }
* })).json()).tokens[0].tokenId;
*
* // Update the token for another user.
* await fetch("https://example.com/api/Auth/Tokens/" + token + "?AdditionalUserId=JohnWood", {
* method: "PUT",
* headers: { "X-CustomersCanvasAPIKey": "UniqueSecurityKey" }
* });
*
* // Copy user files.
* editor.configuration.setUserId("JohnWood")
* .catch(e => console.log(e));
* }
* </script>
* </body>
* </html>
* ```
*/
RuntimeConfiguration.prototype.setUserId = function (userId) {
return this._postMessageClient.callProcedure("setUserId", userId);
};
return RuntimeConfiguration;
}());
export { RuntimeConfiguration };
//# sourceMappingURL=RuntimeConfiguration.js.map