@cesdk/engine 1.6.0 → 1.6.3

package/README.md

@@ -1,51 +1,61 @@
 ![Hero image showing the configuration abilities of CE.SDK](https://img.ly/static/cesdk_release_header.png)
 
-# CreativeEditor SDK 
+# Creative Engine
 
-The CreativeEditor SDK (**CE.SDK**) for Web is a fully customizable, simple-to-use design editor. 
+The CreativeEditor SDK (**CE.SDK**) for Web is a fully customizable,
+simple-to-use design editor. 
 
-Seamlessly integrate it into any Web app with just a few lines of code. The editor combines the best of layout, typography and photo editing. **CE.SDK** also facilitates both template creation and adaption workflows, also featuring constraints and text placeholders for database automations.
+Seamlessly integrate it into any Web app with just a few lines of code. The
+editor combines the best of layout, typography and photo editing. **CE.SDK**
+also facilitates both template creation and adaption workflows, also featuring
+constraints and text placeholders for database automations.
 
-Visit our [website](https://img.ly) for more tutorials on how to integrate and customize the editor for your specific use-case.
+This package contains the Creative Engine, the core of our SDK, including only
+the rendering engine and a Javascript API for building headless applications or
+custom UIs.
+
+Visit our [website](https://img.ly) for more tutorials on how to integrate and
+customize the engine for your specific use-case.
 
 ## Usage 
 
-## 1. Install CreativeEditor SDK
+## 1. Install the Creative Engine dependency to your project
 Install the SDK with `npm` 
 ```bash 
-npm install --save @cesdk/cesdk-js
+npm install --save @cesdk/engine
 ```
 
 or with `yarn`
 ```bash 
-yarn add @cesdk/cesdk-js
-```
-
-## 2. Create an empty Container 
-We need to add an empty `<div>` with an id or class as container for the SDK.
-
-```html
-<div id="cesdk_container" style="width: 100vw; height: 100vh"></div>
+yarn add @cesdk/engine
 ```
 
-In this example, we set the inline style to create a `<div>` element that fills the whole browser window.
-
-## 3. Instantiate SDK
+## 2. Instantiate Creative Engine
 The last step involves the configuration and instantiation of the SDK.
 
 ```JS
-import CreativeEditorSDK from '@cesdk/cesdk-js'
+import CreativeEngine from '@cesdk/engine'
 
-CreativeEditorSDK
-  .init('#cesdk_container') 
+CreativeEngine
+  .init() 
   .then((instance) => {
-    /** do something with the instance of CreativeEditor SDK **/
+    /** do something with the instance of CreativeEngine **/
   });
 ```
+
+You can find a more complete example inside the package, in the included
+`index.html`/`example.js` files.
+
 ## Documentation
-The full documentation of CreativeEditor SDK can be found at
-[https://img.ly/docs/cesdk/](https://img.ly/docs/cesdk/).
+The full documentation of Creative Engine can be found at
+[https://img.ly/docs/cesdk/web/guides/headless/](https://img.ly/docs/cesdk/web/guides/headless/).
+There you will learn what configuration options are available and find a list
+and description of all API methods.
 
 ## License
 
- The CreativeEditor SDK is a commercial product. To use it as such and get access to its white label version - without the watermark in the export - you need to unlock the SDK with a license file. You can purchase a license at https://img.ly/pricing.       
+The CreativeEditor SDK is a commercial product. To use it as such and get
+access to its white label version - without the watermark in the export - you
+need to unlock the SDK with a license file. You can purchase a license at
+https://img.ly/pricing.       
+ 

package/index.d.ts

@@ -538,6 +538,12 @@ export declare class BlockAPI {
      * @param flip - If the flip should be enabled.
      */
     setFlipVertical(id: DesignBlockId, flip: boolean): void;
+    /**
+     * Query if the given block shows placeholder content.
+     * @param id - The block to query.
+     * @returns true, if the block shows placeholder content.
+     */
+    hasPlaceholderContent(id: DesignBlockId): boolean;
     /**
      * Query a block's width.
      * @param id - The block to query.
@@ -1989,13 +1995,11 @@ declare type TemplateDefinition = Preset & {
 /** @public */
 declare type TypefaceDefinition = Preset & {
     family: string;
-    fonts: [
-        {
+    fonts: {
         fontURL: string;
         weight: FontWeight;
         style: FontStyle;
-    }
-    ];
+    }[];
 };
 
 /**