@canva/design 2.6.0 → 2.6.1

package/index.d.ts

@@ -1792,6 +1792,15 @@ export declare namespace DesignEditing {
     | EmbedElement
     | TextElement
     | UnsupportedElement;
+  /**
+   * @public
+   * An element state that can be inserted into a page.
+   */
+  export type InsertableElementState =
+    | RectElementState
+    | ShapeElementState
+    | EmbedElementState
+    | TextElementState;
   /**
    * @public
    * A list of elements.
@@ -1816,6 +1825,10 @@ export declare namespace DesignEditing {
       ref: AbsoluteElement | undefined,
       state: RectElementState,
     ): RectElement;
+    insertBefore(
+      ref: AbsoluteElement | undefined,
+      state: InsertableElementState,
+    ): AbsoluteElement;
     insertAfter(
       ref: AbsoluteElement | undefined,
       state: EmbedElementState,
@@ -1832,6 +1845,10 @@ export declare namespace DesignEditing {
       ref: AbsoluteElement | undefined,
       state: RectElementState,
     ): RectElement;
+    insertAfter(
+      ref: AbsoluteElement | undefined,
+      state: InsertableElementState,
+    ): AbsoluteElement;
   }
 
   /**

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

@@ -112,7 +112,21 @@ class FakeDesignInteractionClient {
         });
     }
     async openDesign(options, callback) {
-        throw new Error('Not yet implemented');
+        await this.delay();
+        await callback({
+            page: fakePage,
+            sync: async ()=>{
+                await this.delay();
+            },
+            helpers: {
+                elementStateBuilder: fakeElementStateBuilder,
+                group: fakeAsyncOperations.group,
+                ungroup: fakeAsyncOperations.ungroup,
+                snapshot: ()=>{
+                    return {};
+                }
+            }
+        });
     }
     constructor(delay){
         this.delay = delay;
@@ -160,3 +174,193 @@ const fakePageDimensions = {
     width: 800,
     height: 600
 };
+const fakeFill = {
+    mediaContainer: {
+        ref: undefined,
+        set (state) {}
+    },
+    colorContainer: {
+        ref: {
+            type: 'solid',
+            color: '#000000'
+        },
+        set (state) {}
+    }
+};
+const fakeColorContainer = {
+    ref: {
+        type: 'solid',
+        color: '#000000'
+    },
+    set (state) {}
+};
+const fakeElementList = {
+    forEach (callback) {},
+    delete (item) {},
+    moveAfter (ref, item) {},
+    moveBefore (ref, item) {},
+    toArray () {
+        return [
+            fakeRectElement,
+            fakeShapeElement
+        ];
+    },
+    count () {
+        return 0;
+    },
+    filter (filter) {},
+    insertAfter (ref, state) {
+        return fakeRectElement;
+    },
+    insertBefore (ref, state) {
+        return fakeRectElement;
+    }
+};
+const fakePage = {
+    type: 'absolute',
+    locked: false,
+    dimensions: fakePageDimensions,
+    background: fakeFill,
+    elements: fakeElementList
+};
+const fakeElement = {
+    top: 0,
+    left: 0,
+    rotation: 0,
+    transparency: 0,
+    locked: true,
+    width: 100,
+    height: 100
+};
+const fakeRectElement = {
+    ...fakeElement,
+    type: 'rect',
+    fill: fakeFill,
+    stroke: {
+        weight: 10,
+        colorContainer: fakeColorContainer
+    }
+};
+const fakeShapeElement = {
+    ...fakeElement,
+    type: 'shape',
+    viewBox: {
+        top: 0,
+        left: 0,
+        width: 100,
+        height: 100
+    },
+    paths: {
+        count: ()=>0,
+        toArray: ()=>[],
+        forEach: (callback)=>{},
+        filter: (filter)=>[]
+    }
+};
+const fakeEmbedElement = {
+    ...fakeElement,
+    type: 'embed',
+    url: 'https://canva.dev/docs/apps/testing/'
+};
+const fakeTextElement = {
+    ...fakeElement,
+    type: 'text',
+    text: fakeRichtextRange
+};
+const fakeElementStateBuilder = {
+    createEmbedElement (opts) {
+        return fakeEmbedElement;
+    },
+    createRectElement (opts) {
+        return {
+            ...fakeRectElement,
+            fill: {
+                colorContainer: {
+                    type: 'solid',
+                    color: '#000000'
+                },
+                mediaContainer: undefined
+            },
+            stroke: {
+                weight: 10,
+                colorContainer: {
+                    type: 'solid',
+                    color: '#000000'
+                }
+            }
+        };
+    },
+    createRichtextRange () {
+        return fakeRichtextRange;
+    },
+    createShapeElement (opts) {
+        return {
+            ...fakeShapeElement,
+            paths: []
+        };
+    },
+    createTextElement (opts) {
+        return {
+            ...fakeTextElement,
+            text: {
+                regions: []
+            }
+        };
+    }
+};
+const fakeAsyncOperations = {
+    async group () {
+        const fakeGroupElement = {
+            top: 0,
+            left: 0,
+            width: 100,
+            height: 100,
+            locked: false,
+            rotation: 0,
+            transparency: 0,
+            type: 'group',
+            contents: {
+                count: ()=>0,
+                toArray: ()=>[],
+                forEach: (callback)=>{},
+                filter: (filter)=>[]
+            }
+        };
+        return fakeGroupElement;
+    },
+    async ungroup () {
+        const fakeRectElement = {
+            top: 0,
+            left: 0,
+            width: 100,
+            height: 100,
+            locked: false,
+            rotation: 0,
+            transparency: 0,
+            type: 'rect',
+            fill: {
+                mediaContainer: {
+                    set () {},
+                    ref: undefined
+                },
+                colorContainer: {
+                    set () {},
+                    ref: undefined
+                }
+            },
+            stroke: {
+                weight: 10,
+                colorContainer: {
+                    set () {},
+                    ref: {
+                        type: 'solid',
+                        color: '#000000'
+                    }
+                }
+            }
+        };
+        return [
+            fakeRectElement
+        ];
+    }
+};

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

@@ -17,4 +17,4 @@ function _export_star(from, to) {
     return from;
 }
 var _window___canva___sdkRegistration, _window___canva__;
-(_window___canva__ = window.__canva__) === null || _window___canva__ === void 0 ? void 0 : (_window___canva___sdkRegistration = _window___canva__.sdkRegistration) === null || _window___canva___sdkRegistration === void 0 ? void 0 : _window___canva___sdkRegistration.registerPackageVersion('design', '2.6.0', 'ga');
+(_window___canva__ = window.__canva__) === null || _window___canva__ === void 0 ? void 0 : (_window___canva___sdkRegistration = _window___canva__.sdkRegistration) === null || _window___canva___sdkRegistration === void 0 ? void 0 : _window___canva___sdkRegistration.registerPackageVersion('design', '2.6.1', 'ga');

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

@@ -102,7 +102,21 @@ export class FakeDesignInteractionClient {
         });
     }
     async openDesign(options, callback) {
-        throw new Error('Not yet implemented');
+        await this.delay();
+        await callback({
+            page: fakePage,
+            sync: async ()=>{
+                await this.delay();
+            },
+            helpers: {
+                elementStateBuilder: fakeElementStateBuilder,
+                group: fakeAsyncOperations.group,
+                ungroup: fakeAsyncOperations.ungroup,
+                snapshot: ()=>{
+                    return {};
+                }
+            }
+        });
     }
     constructor(delay){
         this.delay = delay;
@@ -150,3 +164,193 @@ const fakePageDimensions = {
     width: 800,
     height: 600
 };
+const fakeFill = {
+    mediaContainer: {
+        ref: undefined,
+        set (state) {}
+    },
+    colorContainer: {
+        ref: {
+            type: 'solid',
+            color: '#000000'
+        },
+        set (state) {}
+    }
+};
+const fakeColorContainer = {
+    ref: {
+        type: 'solid',
+        color: '#000000'
+    },
+    set (state) {}
+};
+const fakeElementList = {
+    forEach (callback) {},
+    delete (item) {},
+    moveAfter (ref, item) {},
+    moveBefore (ref, item) {},
+    toArray () {
+        return [
+            fakeRectElement,
+            fakeShapeElement
+        ];
+    },
+    count () {
+        return 0;
+    },
+    filter (filter) {},
+    insertAfter (ref, state) {
+        return fakeRectElement;
+    },
+    insertBefore (ref, state) {
+        return fakeRectElement;
+    }
+};
+const fakePage = {
+    type: 'absolute',
+    locked: false,
+    dimensions: fakePageDimensions,
+    background: fakeFill,
+    elements: fakeElementList
+};
+const fakeElement = {
+    top: 0,
+    left: 0,
+    rotation: 0,
+    transparency: 0,
+    locked: true,
+    width: 100,
+    height: 100
+};
+const fakeRectElement = {
+    ...fakeElement,
+    type: 'rect',
+    fill: fakeFill,
+    stroke: {
+        weight: 10,
+        colorContainer: fakeColorContainer
+    }
+};
+const fakeShapeElement = {
+    ...fakeElement,
+    type: 'shape',
+    viewBox: {
+        top: 0,
+        left: 0,
+        width: 100,
+        height: 100
+    },
+    paths: {
+        count: ()=>0,
+        toArray: ()=>[],
+        forEach: (callback)=>{},
+        filter: (filter)=>[]
+    }
+};
+const fakeEmbedElement = {
+    ...fakeElement,
+    type: 'embed',
+    url: 'https://canva.dev/docs/apps/testing/'
+};
+const fakeTextElement = {
+    ...fakeElement,
+    type: 'text',
+    text: fakeRichtextRange
+};
+const fakeElementStateBuilder = {
+    createEmbedElement (opts) {
+        return fakeEmbedElement;
+    },
+    createRectElement (opts) {
+        return {
+            ...fakeRectElement,
+            fill: {
+                colorContainer: {
+                    type: 'solid',
+                    color: '#000000'
+                },
+                mediaContainer: undefined
+            },
+            stroke: {
+                weight: 10,
+                colorContainer: {
+                    type: 'solid',
+                    color: '#000000'
+                }
+            }
+        };
+    },
+    createRichtextRange () {
+        return fakeRichtextRange;
+    },
+    createShapeElement (opts) {
+        return {
+            ...fakeShapeElement,
+            paths: []
+        };
+    },
+    createTextElement (opts) {
+        return {
+            ...fakeTextElement,
+            text: {
+                regions: []
+            }
+        };
+    }
+};
+const fakeAsyncOperations = {
+    async group () {
+        const fakeGroupElement = {
+            top: 0,
+            left: 0,
+            width: 100,
+            height: 100,
+            locked: false,
+            rotation: 0,
+            transparency: 0,
+            type: 'group',
+            contents: {
+                count: ()=>0,
+                toArray: ()=>[],
+                forEach: (callback)=>{},
+                filter: (filter)=>[]
+            }
+        };
+        return fakeGroupElement;
+    },
+    async ungroup () {
+        const fakeRectElement = {
+            top: 0,
+            left: 0,
+            width: 100,
+            height: 100,
+            locked: false,
+            rotation: 0,
+            transparency: 0,
+            type: 'rect',
+            fill: {
+                mediaContainer: {
+                    set () {},
+                    ref: undefined
+                },
+                colorContainer: {
+                    set () {},
+                    ref: undefined
+                }
+            },
+            stroke: {
+                weight: 10,
+                colorContainer: {
+                    set () {},
+                    ref: {
+                        type: 'solid',
+                        color: '#000000'
+                    }
+                }
+            }
+        };
+        return [
+            fakeRectElement
+        ];
+    }
+};

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

@@ -1,3 +1,3 @@
 var _window___canva___sdkRegistration, _window___canva__;
 export * from './public';
-(_window___canva__ = window.__canva__) === null || _window___canva__ === void 0 ? void 0 : (_window___canva___sdkRegistration = _window___canva__.sdkRegistration) === null || _window___canva___sdkRegistration === void 0 ? void 0 : _window___canva___sdkRegistration.registerPackageVersion('design', '2.6.0', 'ga');
+(_window___canva__ = window.__canva__) === null || _window___canva__ === void 0 ? void 0 : (_window___canva___sdkRegistration = _window___canva__.sdkRegistration) === null || _window___canva___sdkRegistration === void 0 ? void 0 : _window___canva___sdkRegistration.registerPackageVersion('design', '2.6.1', 'ga');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@canva/design",
-  "version": "2.6.0",
+  "version": "2.6.1",
   "description": "The Canva Apps SDK design library",
   "author": "Canva Pty Ltd.",
   "license": "SEE LICENSE IN LICENSE.md FILE",