@canva/design 2.8.0 → 2.8.1-alpha.1

package/lib/cjs/api/design/types/design_interaction/document/alpha.js

@@ -0,0 +1,11 @@
+"use strict"
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "ResetToDefault", {
+    enumerable: true,
+    get: function() {
+        return ResetToDefault;
+    }
+});
+const ResetToDefault = Symbol.for('$$canva_reset_to_default');

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

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: Object.getOwnPropertyDescriptor(all, name).get
+    });
+}
+_export(exports, {
+    get ResetToDefault () {
+        return _alpha.ResetToDefault;
+    },
+    get applyTemplate () {
+        return applyTemplate;
+    },
+    get getBrandTemplateMetadata () {
+        return getBrandTemplateMetadata;
+    },
+    get initAppElement () {
+        return initAppElement;
+    },
+    get openDesign () {
+        return openDesign;
+    },
+    get requestAutofillDesign () {
+        return requestAutofillDesign;
+    },
+    get requestBrandTemplates () {
+        return requestBrandTemplates;
+    }
+});
+const _version = require("./version");
+const _alpha = require('../../api/design/types/design_interaction/document/alpha');
+_export_star(require("./public"), exports);
+function _export_star(from, to) {
+    Object.keys(from).forEach(function(k) {
+        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {
+            Object.defineProperty(to, k, {
+                enumerable: true,
+                get: function() {
+                    return from[k];
+                }
+            });
+        }
+    });
+    return from;
+}
+const initAppElement = canva_sdk.design.v2.designInteraction.initAppElement;
+const requestAutofillDesign = canva_sdk.design.v2.autofill.requestAutofillDesign;
+const requestBrandTemplates = canva_sdk.design.v2.designInteraction.requestBrandTemplates;
+const getBrandTemplateMetadata = canva_sdk.design.v2.designInteraction.getBrandTemplateMetadata;
+const openDesign = canva_sdk.design.v2.designInteraction.openDesign;
+const applyTemplate = canva_sdk.design.v2.designInteraction.applyTemplate;
+window.__canva__?.sdkRegistration?.registerPackageVersion('design', _version.LATEST_VERSION_ALPHA, 'alpha');

package/lib/cjs/sdk/design/fake/create_beta.js

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "createBetaFakeDesignClients", {
+    enumerable: true,
+    get: function() {
+        return createBetaFakeDesignClients;
+    }
+});
+const _synthetic_delay = require('../../utils/synthetic_delay');
+const _fake_autofill_client = require("./fake_autofill_client");
+const _fake_design_interaction_client = require("./fake_design_interaction_client");
+const _fake_drag_and_drop_client = require("./fake_drag_and_drop_client");
+const _fake_export_client = require("./fake_export_client");
+function createBetaFakeDesignClients() {
+    const syntheticDelay = (0, _synthetic_delay.createSyntheticDelay)(10);
+    const v2 = {
+        designInteraction: new FakeBetaDesignInteractionClient(syntheticDelay),
+        dragAndDrop: new _fake_drag_and_drop_client.FakeDragAndDropClient(syntheticDelay),
+        export: new _fake_export_client.FakeExportClient(syntheticDelay),
+        autofill: new _fake_autofill_client.FakeAutofillClient(syntheticDelay)
+    };
+    return {
+        design: {
+            v2
+        }
+    };
+}
+class FakeBetaDesignInteractionClient extends _fake_design_interaction_client.FakeDesignInteractionClient {
+    async editContent(options, callback) {
+        await this.delay();
+        await callback({
+            contents: [],
+            sync: async ()=>{
+                await this.delay();
+            }
+        });
+    }
+    async openDesign(options, callback) {
+        await this.delay();
+        await callback({
+            page: _fake_design_interaction_client.fakePage,
+            pageRefs: fakePageRefList,
+            sync: async ()=>{
+                await this.delay();
+            },
+            helpers: {
+                ..._fake_design_interaction_client.fakeOpenDesignHelpers,
+                openPage: async (_, callback)=>{
+                    await callback({
+                        page: _fake_design_interaction_client.fakePage,
+                        helpers: _fake_design_interaction_client.fakeOpenDesignHelpers
+                    });
+                    return {
+                        status: 'executed'
+                    };
+                }
+            }
+        });
+    }
+    getDesignMetadata() {
+        return Promise.resolve({
+            title: 'title',
+            defaultPageDimensions: {
+                width: 800,
+                height: 600
+            },
+            pageMetadata: [
+                {
+                    title: 'title',
+                    type: 'absolute',
+                    pageDimensions: {
+                        width: 800,
+                        height: 600
+                    }
+                }
+            ],
+            durationInSeconds: 30
+        });
+    }
+}
+const fakePageRef = {
+    type: 'absolute',
+    locked: false
+};
+const fakePageRefList = {
+    forEach (callback) {},
+    toArray () {
+        return [
+            fakePageRef
+        ];
+    },
+    count () {
+        return 0;
+    },
+    filter (filter) {}
+};

package/lib/cjs/sdk/design/fake/fake_autofill_client.js

@@ -0,0 +1,21 @@
+"use strict"
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "FakeAutofillClient", {
+    enumerable: true,
+    get: function() {
+        return FakeAutofillClient;
+    }
+});
+class FakeAutofillClient {
+    async requestAutofillDesign(opts) {
+        await this.delay();
+        return {
+            status: 'success'
+        };
+    }
+    constructor(delay){
+        this.delay = delay;
+    }
+}

package/lib/cjs/sdk/design/fake/fake_design_interaction_client.js

@@ -26,6 +26,34 @@ class FakeDesignInteractionClient {
             token: 'token'
         };
     }
+    async requestBrandTemplates() {
+        await this.delay();
+        return {
+            status: 'completed',
+            brandTemplates: [
+                {
+                    token: 'token'
+                }
+            ]
+        };
+    }
+    async applyTemplate(options) {
+        await this.delay();
+        return {
+            status: 'completed'
+        };
+    }
+    async getBrandTemplateMetadata(id) {
+        await this.delay();
+        return {
+            domain: 'brand',
+            keywords: [
+                'word1',
+                'word2'
+            ],
+            dataset: undefined
+        };
+    }
     async getDesignMetadata() {
         await this.delay();
         return {
@@ -388,10 +416,18 @@ const fakeAsyncOperations = {
         ];
     }
 };
+const fakeTimingAccessor = {
+    get: ()=>({
+            delayInSeconds: 0,
+            durationInSeconds: 'until_end_of_page'
+        }),
+    set: async ()=>{}
+};
 const fakeOpenDesignHelpers = {
     elementStateBuilder: fakeElementStateBuilder,
     group: fakeAsyncOperations.group,
     ungroup: fakeAsyncOperations.ungroup,
+    timingFor: (_elementRef)=>fakeTimingAccessor,
     snapshot: ()=>{
         return {};
     }

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

@@ -1,9 +1,8 @@
-"use strict"
+"use strict";
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
-const _version = require("./version");
-_export_star(require("./public"), exports);
+_export_star(require("./alpha"), exports);
 function _export_star(from, to) {
     Object.keys(from).forEach(function(k) {
         if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {
@@ -17,4 +16,3 @@ function _export_star(from, to) {
     });
     return from;
 }
-window.__canva__?.sdkRegistration?.registerPackageVersion('design', _version.LATEST_VERSION, 'ga');

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

@@ -70,7 +70,6 @@ _export(exports, {
         return ui;
     }
 });
-const { canva_sdk } = window;
 const selection = canva_sdk.design.v2.designInteraction.selection;
 const overlay = canva_sdk.design.v2.designInteraction.overlay;
 const addPage = canva_sdk.design.v2.designInteraction.addPage;

package/lib/cjs/sdk/design/test/alpha.js

@@ -0,0 +1,18 @@
+"use strict"
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+_export_star(require("./beta"), exports);
+function _export_star(from, to) {
+    Object.keys(from).forEach(function(k) {
+        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {
+            Object.defineProperty(to, k, {
+                enumerable: true,
+                get: function() {
+                    return from[k];
+                }
+            });
+        }
+    });
+    return from;
+}

package/lib/cjs/sdk/design/test/beta.js

@@ -0,0 +1,16 @@
+"use strict"
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "initTestEnvironment", {
+    enumerable: true,
+    get: function() {
+        return initTestEnvironment;
+    }
+});
+const _create_beta = require('../fake/create_beta');
+const _canva_sdk = require('../../utils/canva_sdk');
+function initTestEnvironment() {
+    (0, _canva_sdk.assertIsTestCanvaSdk)();
+    (0, _canva_sdk.injectFakeAPIClients)((0, _create_beta.createBetaFakeDesignClients)());
+}

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

@@ -1,16 +1,18 @@
-"use strict"
+"use strict";
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
-Object.defineProperty(exports, "initTestEnvironment", {
-    enumerable: true,
-    get: function() {
-        return initTestEnvironment;
-    }
-});
-const _create = require('../fake/create');
-const _canva_sdk = require('../../utils/canva_sdk');
-function initTestEnvironment() {
-    (0, _canva_sdk.assertIsTestCanvaSdk)();
-    (0, _canva_sdk.injectFakeAPIClients)((0, _create.createFakeDesignClients)());
+_export_star(require("./alpha"), exports);
+function _export_star(from, to) {
+    Object.keys(from).forEach(function(k) {
+        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {
+            Object.defineProperty(to, k, {
+                enumerable: true,
+                get: function() {
+                    return from[k];
+                }
+            });
+        }
+    });
+    return from;
 }

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

@@ -20,5 +20,5 @@ _export(exports, {
     }
 });
 const LATEST_VERSION = '2.8.0';
-const LATEST_VERSION_BETA = '2.7.6-beta.1';
-const LATEST_VERSION_ALPHA = 'NONE';
+const LATEST_VERSION_BETA = '2.7.6-beta.2';
+const LATEST_VERSION_ALPHA = '2.8.1-alpha.1';

package/lib/esm/api/design/types/design_interaction/document/alpha.js

@@ -0,0 +1 @@
+export const ResetToDefault = Symbol.for('$$canva_reset_to_default');

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

@@ -0,0 +1,10 @@
+import { LATEST_VERSION_ALPHA } from './version';
+export const initAppElement = canva_sdk.design.v2.designInteraction.initAppElement;
+export const requestAutofillDesign = canva_sdk.design.v2.autofill.requestAutofillDesign;
+export const requestBrandTemplates = canva_sdk.design.v2.designInteraction.requestBrandTemplates;
+export const getBrandTemplateMetadata = canva_sdk.design.v2.designInteraction.getBrandTemplateMetadata;
+export const openDesign = canva_sdk.design.v2.designInteraction.openDesign;
+export const applyTemplate = canva_sdk.design.v2.designInteraction.applyTemplate;
+export { ResetToDefault } from '../../api/design/types/design_interaction/document/alpha';
+export * from './public';
+window.__canva__?.sdkRegistration?.registerPackageVersion('design', LATEST_VERSION_ALPHA, 'alpha');

package/lib/esm/sdk/design/fake/create_beta.js

@@ -0,0 +1,88 @@
+import { createSyntheticDelay } from '../../utils/synthetic_delay';
+import { FakeAutofillClient } from './fake_autofill_client';
+import { FakeDesignInteractionClient, fakeOpenDesignHelpers, fakePage } from './fake_design_interaction_client';
+import { FakeDragAndDropClient } from './fake_drag_and_drop_client';
+import { FakeExportClient } from './fake_export_client';
+export function createBetaFakeDesignClients() {
+    const syntheticDelay = createSyntheticDelay(10);
+    const v2 = {
+        designInteraction: new FakeBetaDesignInteractionClient(syntheticDelay),
+        dragAndDrop: new FakeDragAndDropClient(syntheticDelay),
+        export: new FakeExportClient(syntheticDelay),
+        autofill: new FakeAutofillClient(syntheticDelay)
+    };
+    return {
+        design: {
+            v2
+        }
+    };
+}
+class FakeBetaDesignInteractionClient extends FakeDesignInteractionClient {
+    async editContent(options, callback) {
+        await this.delay();
+        await callback({
+            contents: [],
+            sync: async ()=>{
+                await this.delay();
+            }
+        });
+    }
+    async openDesign(options, callback) {
+        await this.delay();
+        await callback({
+            page: fakePage,
+            pageRefs: fakePageRefList,
+            sync: async ()=>{
+                await this.delay();
+            },
+            helpers: {
+                ...fakeOpenDesignHelpers,
+                openPage: async (_, callback)=>{
+                    await callback({
+                        page: fakePage,
+                        helpers: fakeOpenDesignHelpers
+                    });
+                    return {
+                        status: 'executed'
+                    };
+                }
+            }
+        });
+    }
+    getDesignMetadata() {
+        return Promise.resolve({
+            title: 'title',
+            defaultPageDimensions: {
+                width: 800,
+                height: 600
+            },
+            pageMetadata: [
+                {
+                    title: 'title',
+                    type: 'absolute',
+                    pageDimensions: {
+                        width: 800,
+                        height: 600
+                    }
+                }
+            ],
+            durationInSeconds: 30
+        });
+    }
+}
+const fakePageRef = {
+    type: 'absolute',
+    locked: false
+};
+const fakePageRefList = {
+    forEach (callback) {},
+    toArray () {
+        return [
+            fakePageRef
+        ];
+    },
+    count () {
+        return 0;
+    },
+    filter (filter) {}
+};

package/lib/esm/sdk/design/fake/fake_autofill_client.js

@@ -0,0 +1,11 @@
+export class FakeAutofillClient {
+    async requestAutofillDesign(opts) {
+        await this.delay();
+        return {
+            status: 'success'
+        };
+    }
+    constructor(delay){
+        this.delay = delay;
+    }
+}

package/lib/esm/sdk/design/fake/fake_design_interaction_client.js

@@ -5,6 +5,34 @@ export class FakeDesignInteractionClient {
             token: 'token'
         };
     }
+    async requestBrandTemplates() {
+        await this.delay();
+        return {
+            status: 'completed',
+            brandTemplates: [
+                {
+                    token: 'token'
+                }
+            ]
+        };
+    }
+    async applyTemplate(options) {
+        await this.delay();
+        return {
+            status: 'completed'
+        };
+    }
+    async getBrandTemplateMetadata(id) {
+        await this.delay();
+        return {
+            domain: 'brand',
+            keywords: [
+                'word1',
+                'word2'
+            ],
+            dataset: undefined
+        };
+    }
     async getDesignMetadata() {
         await this.delay();
         return {
@@ -367,10 +395,18 @@ const fakeAsyncOperations = {
         ];
     }
 };
+const fakeTimingAccessor = {
+    get: ()=>({
+            delayInSeconds: 0,
+            durationInSeconds: 'until_end_of_page'
+        }),
+    set: async ()=>{}
+};
 export const fakeOpenDesignHelpers = {
     elementStateBuilder: fakeElementStateBuilder,
     group: fakeAsyncOperations.group,
     ungroup: fakeAsyncOperations.ungroup,
+    timingFor: (_elementRef)=>fakeTimingAccessor,
     snapshot: ()=>{
         return {};
     }

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

@@ -1,3 +1 @@
-import { LATEST_VERSION } from './version';
-export * from './public';
-window.__canva__?.sdkRegistration?.registerPackageVersion('design', LATEST_VERSION, 'ga');
+export * from './alpha';

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

@@ -1,4 +1,3 @@
-const { canva_sdk } = window;
 export const selection = canva_sdk.design.v2.designInteraction.selection;
 export const overlay = canva_sdk.design.v2.designInteraction.overlay;
 export const addPage = canva_sdk.design.v2.designInteraction.addPage;

package/lib/esm/sdk/design/test/alpha.js

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

package/lib/esm/sdk/design/test/beta.js

@@ -0,0 +1,6 @@
+import { createBetaFakeDesignClients } from '../fake/create_beta';
+import { assertIsTestCanvaSdk, injectFakeAPIClients } from '../../utils/canva_sdk';
+export function initTestEnvironment() {
+    assertIsTestCanvaSdk();
+    injectFakeAPIClients(createBetaFakeDesignClients());
+}

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

@@ -1,6 +1 @@
-import { createFakeDesignClients } from '../fake/create';
-import { assertIsTestCanvaSdk, injectFakeAPIClients } from '../../utils/canva_sdk';
-export function initTestEnvironment() {
-    assertIsTestCanvaSdk();
-    injectFakeAPIClients(createFakeDesignClients());
-}
+export * from './alpha';

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

@@ -1,3 +1,3 @@
 export const LATEST_VERSION = '2.8.0';
-export const LATEST_VERSION_BETA = '2.7.6-beta.1';
-export const LATEST_VERSION_ALPHA = 'NONE';
+export const LATEST_VERSION_BETA = '2.7.6-beta.2';
+export const LATEST_VERSION_ALPHA = '2.8.1-alpha.1';

package/package.json

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

package/test/alpha.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @beta
+ * Initializes a test environment for the `@canva/design` package, enabling unit tests to mock Canva's APIs.
+ * @remarks
+ * This method should only be called once in a test environment, such as in a Jest setup file.
+ * @see
+ * https://www.canva.dev/docs/apps/testing/
+ */
+export declare function initTestEnvironment(): void;
+
+export { }

package/test/index.d.ts

@@ -1,11 +1 @@
-/**
- * @public
- * Initializes a test environment for the `@canva/design` package, enabling unit tests to mock Canva's APIs.
- * @remarks
- * This method should only be called once in a test environment, such as in a Jest setup file.
- * @see
- * https://www.canva.dev/docs/apps/testing/
- */
-export declare function initTestEnvironment(): void;
-
-export { }
+export * from "./alpha";

package/lib/cjs/sdk/design/fake/create.js

@@ -1,27 +0,0 @@
-"use strict"
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "createFakeDesignClients", {
-    enumerable: true,
-    get: function() {
-        return createFakeDesignClients;
-    }
-});
-const _synthetic_delay = require('../../utils/synthetic_delay');
-const _fake_design_interaction_client = require("./fake_design_interaction_client");
-const _fake_drag_and_drop_client = require("./fake_drag_and_drop_client");
-const _fake_export_client = require("./fake_export_client");
-function createFakeDesignClients() {
-    const syntheticDelay = (0, _synthetic_delay.createSyntheticDelay)(10);
-    const v2 = {
-        designInteraction: new _fake_design_interaction_client.FakeDesignInteractionClient(syntheticDelay),
-        dragAndDrop: new _fake_drag_and_drop_client.FakeDragAndDropClient(syntheticDelay),
-        export: new _fake_export_client.FakeExportClient(syntheticDelay)
-    };
-    return {
-        design: {
-            v2
-        }
-    };
-}

package/lib/esm/sdk/design/fake/create.js

@@ -1,17 +0,0 @@
-import { createSyntheticDelay } from '../../utils/synthetic_delay';
-import { FakeDesignInteractionClient } from './fake_design_interaction_client';
-import { FakeDragAndDropClient } from './fake_drag_and_drop_client';
-import { FakeExportClient } from './fake_export_client';
-export function createFakeDesignClients() {
-    const syntheticDelay = createSyntheticDelay(10);
-    const v2 = {
-        designInteraction: new FakeDesignInteractionClient(syntheticDelay),
-        dragAndDrop: new FakeDragAndDropClient(syntheticDelay),
-        export: new FakeExportClient(syntheticDelay)
-    };
-    return {
-        design: {
-            v2
-        }
-    };
-}