@canva/design 0.0.1-rc.1

package/lib/cjs/sdk/design/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (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("./public"), exports);

package/lib/cjs/sdk/design/public.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initAppElement = exports.getCurrentPageContext = exports.addAudioTrack = exports.addNativeElement = exports.ui = exports.requestExport = exports.getDefaultPageDimensions = exports.addPage = void 0;
+const { canva } = window;
+/**
+ * @public
+ * Adds a new page immediately after the currently selected page.
+ * @param opts - Configuration for the new page to be added.
+ */
+function addPage(opts) {
+    return canva.designInteraction.addPage(opts);
+}
+exports.addPage = addPage;
+/**
+ * @public
+ * Gets the default dimensions that a new page will have when it is added to a design.
+ * It is possible for a user to resize a page without resizing the entire design, e.g. by clicking
+ * "Expand to Whiteboard". However, there will always be a single set of default dimensions for a
+ * design that is applied whenever a new page is created.
+ *
+ * Returns `undefined` if the design is unbounded (e.g. Whiteboard or Doc).
+ */
+function getDefaultPageDimensions() {
+    return canva.designInteraction.getDefaultPageDimensions();
+}
+exports.getDefaultPageDimensions = getDefaultPageDimensions;
+/**
+ * @public
+ * Exports the user's design as one or more static files.
+ * @param request - The request object containing configurations of the design export.
+ */
+function requestExport(request) {
+    return canva.export.requestExport(request);
+}
+exports.requestExport = requestExport;
+/**
+ * An alias for the UI interface, providing access to ui related functionality
+ * @public
+ */
+exports.ui = canva.dragAndDrop;
+/**
+ * @public
+ * Adds a native element to the user's design.
+ * @param element - The element to add to the user's design.
+ */
+function addNativeElement(element) {
+    return canva.designInteraction.addNativeElement(element);
+}
+exports.addNativeElement = addNativeElement;
+/**
+ * Adds an audio track to the user's design.
+ * @public
+ * @param audioTrack - The audio track to add to the user's design.
+ */
+function addAudioTrack(audioTrack) {
+    return canva.designInteraction.addAudioTrack(audioTrack);
+}
+exports.addAudioTrack = addAudioTrack;
+/**
+ * Allows to get the context of currently selected page.
+ * @public
+ * @returns Page context of currently selected page
+ */
+function getCurrentPageContext() {
+    return canva.designInteraction.getCurrentPageContext();
+}
+exports.getCurrentPageContext = getCurrentPageContext;
+/**
+ * @public
+ * @param appElementConfig - Configuration for an AppElementClient
+ */
+function initAppElement(appElementConfig) {
+    return canva.designInteraction.initAppElement(appElementConfig);
+}
+exports.initAppElement = initAppElement;

package/lib/esm/sdk/design/index.js

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

package/lib/esm/sdk/design/public.js

@@ -0,0 +1,65 @@
+const { canva } = window;
+/**
+ * @public
+ * Adds a new page immediately after the currently selected page.
+ * @param opts - Configuration for the new page to be added.
+ */
+export function addPage(opts) {
+    return canva.designInteraction.addPage(opts);
+}
+/**
+ * @public
+ * Gets the default dimensions that a new page will have when it is added to a design.
+ * It is possible for a user to resize a page without resizing the entire design, e.g. by clicking
+ * "Expand to Whiteboard". However, there will always be a single set of default dimensions for a
+ * design that is applied whenever a new page is created.
+ *
+ * Returns `undefined` if the design is unbounded (e.g. Whiteboard or Doc).
+ */
+export function getDefaultPageDimensions() {
+    return canva.designInteraction.getDefaultPageDimensions();
+}
+/**
+ * @public
+ * Exports the user's design as one or more static files.
+ * @param request - The request object containing configurations of the design export.
+ */
+export function requestExport(request) {
+    return canva.export.requestExport(request);
+}
+/**
+ * An alias for the UI interface, providing access to ui related functionality
+ * @public
+ */
+export const ui = canva.dragAndDrop;
+/**
+ * @public
+ * Adds a native element to the user's design.
+ * @param element - The element to add to the user's design.
+ */
+export function addNativeElement(element) {
+    return canva.designInteraction.addNativeElement(element);
+}
+/**
+ * Adds an audio track to the user's design.
+ * @public
+ * @param audioTrack - The audio track to add to the user's design.
+ */
+export function addAudioTrack(audioTrack) {
+    return canva.designInteraction.addAudioTrack(audioTrack);
+}
+/**
+ * Allows to get the context of currently selected page.
+ * @public
+ * @returns Page context of currently selected page
+ */
+export function getCurrentPageContext() {
+    return canva.designInteraction.getCurrentPageContext();
+}
+/**
+ * @public
+ * @param appElementConfig - Configuration for an AppElementClient
+ */
+export function initAppElement(appElementConfig) {
+    return canva.designInteraction.initAppElement(appElementConfig);
+}

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@canva/design",
+  "version": "0.0.1-rc.1",
+  "description": "The Canva Apps SDK design library",
+  "author": "Canva Pty Ltd.",
+  "license": "SEE LICENSE IN LICENSE.md FILE",
+  "peerDependencies": {
+    "@canva/error": "^0.0.1-rc.1"
+  },
+  "main": "lib/cjs/sdk/design/index.js",
+  "module": "lib/esm/sdk/design/index.js",
+  "exports": {
+    ".": {
+      "require": "./lib/cjs/sdk/design/index.js",
+      "import": "./lib/esm/sdk/design/index.js"
+    }
+  },
+  "typings": "./index.d.ts"
+}