@silexlabs/silex 3.0.0-alpha.167 → 3.0.0-alpha.168

package/dist/client/client/events.d.ts

@@ -1,20 +1,20 @@
 export declare enum ClientEvent {
-    STARTUP_START = "silex:startup:start",
-    STARTUP_END = "silex:startup:end",
-    GRAPESJS_START = "silex:grapesjs:start",
-    GRAPESJS_END = "silex:grapesjs:end",
-    PUBLISH_START = "silex:publish:start",
-    PUBLISH_PAGE = "silex:publish:page",
-    PUBLISH_DATA = "silex:publish:data",
-    PUBLISH_END = "silex:publish:end",
-    PUBLISH_ERROR = "silex:publish:error",
+    STARTUP_START = "silex:startup:start",/* Loading is over and Silex is starting */
+    STARTUP_END = "silex:startup:end",/* Silex is ready to be used */
+    GRAPESJS_START = "silex:grapesjs:start",/* GrapesJS is about to be initialized, it is time to edit config.grapesJsConfig */
+    GRAPESJS_END = "silex:grapesjs:end",/* GrapesJS is ready to be used, `editor` is passed as an argument */
+    PUBLISH_START = "silex:publish:start",/* Publication starts, you can read+write {projectData, siteSettings} */
+    PUBLISH_PAGE = "silex:publish:page",/* Publication of a page, read+write { siteSettings, pageSettings, page } */
+    PUBLISH_DATA = "silex:publish:data",/* Just before we send the published data to the server, read+write all publication data, check PublicationData type in types.ts */
+    PUBLISH_END = "silex:publish:end",/* Publication is over, the argument is the publication result with {success: boolean, message: string} */
+    PUBLISH_ERROR = "silex:publish:error",/* Publication failed, the argument is the publication result with {success: boolean, message: string} */
     PUBLISH_LOGIN_START = "silex:publish:login:start",
     PUBLISH_LOGIN_END = "silex:publish:login:end",
     ASSET_WRITE_END = "silex:asset:write:end",
     WRITE_END = "silex:write:end",
-    SETTINGS_OPEN = "silex:settings:open",
-    SETTINGS_CLOSE = "silex:settings:close",
-    SETTINGS_SAVE_START = "silex:settings:save:start",
-    SETTINGS_SAVE_END = "silex:settings:save:end",
+    SETTINGS_OPEN = "silex:settings:open",/* The settings dialog is opened */
+    SETTINGS_CLOSE = "silex:settings:close",/* The settings dialog is closed */
+    SETTINGS_SAVE_START = "silex:settings:save:start",/* The settings dialog is closed and the settings are about to be saved */
+    SETTINGS_SAVE_END = "silex:settings:save:end",/* The settings dialog is closed and the settings are saved */
     SETTINGS_SECTION_CHANGE = "silex:settings:section-change"
 }

package/dist/client/client/grapesjs/PublicationUi.d.ts

@@ -39,11 +39,11 @@ export declare class PublicationUi {
      * Initialize the dialog and the publish button
      */
     constructor(editor: PublishableEditor, options: PublicationDialogOptions);
-    isSuccess(status: PublicationStatus): boolean;
-    isPending(status: PublicationStatus): boolean;
-    isError(status: PublicationStatus): boolean;
-    isLoggedOut(status: PublicationStatus): boolean;
-    isReady(status: PublicationStatus): boolean;
+    isSuccess(status: PublicationStatus): status is PublicationStatus.STATUS_SUCCESS;
+    isPending(status: PublicationStatus): status is PublicationStatus.STATUS_PENDING;
+    isError(status: PublicationStatus): status is PublicationStatus.STATUS_ERROR;
+    isLoggedOut(status: PublicationStatus): status is PublicationStatus.STATUS_LOGGED_OUT;
+    isReady(status: PublicationStatus): status is PublicationStatus.STATUS_NONE;
     getDialogElements(): {
         el: HTMLElement;
         primary: HTMLElement;