@cesdk/cesdk-js 1.2.1 → 1.4.0-alpha.2

package/index.html

@@ -32,12 +32,11 @@
     <script>
         window.onload = function () {
           var href = window.location.href.split('?');
-          var module = CreativeEditorSDK;
           var config = {
             locale: 'en',
             theme: 'dark',
             baseURL: "assets/",
-            role: 'Adopter', // 'Creator', 'Editor', 'Viewer'
+            role: 'Creator', // 'Creator', 'Adopter', 'Viewer'
             callbacks: {
               onSave: handleSave,
               onLoad: handleLoad,
@@ -53,7 +52,7 @@
               elements: {
                 view: {
                   adopter: {
-                    style: 'classic'
+                    style: 'default'
                   }
                 },
                 panels: {
@@ -110,7 +109,7 @@
           };
 
 
-        module.init(
+        CreativeEditorSDK.init(
           document.getElementById('root'),
           config
         );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cesdk/cesdk-js",
-  "version": "1.2.1",
+  "version": "1.4.0-alpha.2",
   "main": "./cesdk.umd.js",
   "types": "./types.d.ts",
   "homepage": "https://www.img.ly",

package/types.d.ts

@@ -1,5 +1,7 @@
 /* eslint-disable max-classes-per-file */
 /* eslint-disable spaced-comment */
+import API from './api';
+
 //#region utils
 
 export type Optional<T, K extends keyof T> = Omit<T, K> & Partial<T>;
@@ -205,13 +207,14 @@ export type Presets = {
   colors?: { [id: string]: ColorDefinition };
   typefaces?: { [id: string]: TypefaceDefinition };
   images?: { [id: string]: ImageDefinition };
-  variables?: { [id: string]: VariableDefinition };
   pageFormats?: { [id: string]: PageFormatDefinition };
   colorPalettes?: { [id: string]: ColorPaletteDefinition };
   templates?: { [id: string]: TemplateDefinition };
   [type: string]: { [id: string]: Preset } | undefined;
 };
 
+export type Variables = { [id: string]: VariableDefinition };
+
 /** I18n Settings
  * Note: this will append keys and not override keys
  */
@@ -336,7 +339,7 @@ export interface UserInterfaceInspectorBlocks {
   transform?: UserInterfaceElement | boolean;
 
   // Hardcoding the ids in this map for now for easier handling
-  '//ly.img.ubq/adjustableImage': UserInterfaceInspectorBlockImage;
+  '//ly.img.ubq/image': UserInterfaceInspectorBlockImage;
   '//ly.img.ubq/text': UserInterfaceInspectorBlockText;
 }
 
@@ -381,6 +384,12 @@ export interface UserInterfaceNavigation extends UserInterfaceElement {
 }
 
 export interface UserInterfaceElements {
+  view?: {
+    adopter?: {
+      style?: 'default' | 'advanced';
+    };
+  };
+
   panels?: {
     inspector?: UserInterfaceInspector | boolean;
     settings?: UserInterfaceSettings | boolean;
@@ -445,6 +454,8 @@ export class Configuration {
   assets: Assets;
 
   presets: Presets;
+  
+  variables: Variables;
 
   callbacks: Callbacks;
 
@@ -458,6 +469,16 @@ export class Configuration {
    */
   public defaultFont?: string;
 }
+
+type DeepPartial<T> = {
+  [P in keyof T]?: DeepPartial<T[P]>;
+};
+
+// Make the properties K of T DeepPartial
+type DeepOptional<T, K extends keyof T> = Pick<DeepPartial<T>, K> & Omit<T, K>;
+
+export type UserConfiguration = Partial<DeepOptional<Configuration, 'ui'>>;
+
 //#endregion
 
 //#region packages/api/types/engine.ts
@@ -475,6 +496,8 @@ export interface ExportOptions {
 export default class CreativeEditorSDK {
   public static Configuration: Configuration;
 
+  public engine: API;
+
   /**
    * Exports one or multiple page(s) as an file in the given mimeType
    *
@@ -507,7 +530,7 @@ export default class CreativeEditorSDK {
    * Adds or update text variable definition.
    *
    * Translations can be added inside the custom locale translations under the
-   * key `presets.variables.${id}.label`.
+   * key `variables.${id}.label`.
    *
    * @typedef {Object} Variable
    * @property {string} value the value of the variable
@@ -567,7 +590,7 @@ export default class CreativeEditorSDK {
    */
   static init(
     container: HTMLDivElement | string,
-    config?: Partial<Configuration>
+    config?: UserConfiguration
   ): Promise<CreativeEditorSDK>;
 }