@gooddata/typings - npm Package Compare versions

Comparing version 2.23.0-lanhuynh-lhq-sd-884-post-event-typings-2020-04-16T11-21-57-655Z to 2.23.0-lanhuynh-lhq-sd-886-2020-04-23T01-40-32-006Z

dist/src/embedding/ad.d.ts

@@ -81,2 +81,6 @@ import { CommandFailed, IObjectMeta, IGdcMessageEvent, IGdcMessageEnvelope, CommandFailedData, GdcProductName } from './common';
         /**
+         * Type represent that the insight editor is cleared
+         */
+        ClearFinished = "clearFinished",
+        /**
          * Type represent that the insight is saved
@@ -238,2 +242,6 @@ *
      *
+     * Contract:
+     *
+     * -  The ClearFinished event will be posted after the insight editor is cleared
+     *
      * Note: it has empty content and just wrapped to application and product data structure
@@ -457,2 +465,24 @@ */
     /**
+     * It's main content is empty.
+     */
+    type ClearFinishedBody = IAvailableCommands;
+    /**
+     * This event is emitted when AD initializes edit session for an existing insight. Essential detail about
+     * the insight is included in the body.
+     */
+    type ClearFinished = IADMessageEvent<GdcAdEventType.ClearFinished, ClearFinishedBody>;
+    /**
+     * Data type of event that was emit when an insight editor is cleared
+     *
+     * Note: The main event data was wrapped to application and product data structure
+     * @see ClearFinishedBody
+     */
+    type ClearFinishedData = IAdGdcMessageEnvelope<GdcAdEventType.ClearFinished, ClearFinishedBody>;
+    /**
+     * Type-guard checking whether an object is an instance of {@link ClearFinishedData}
+     *
+     * @param obj - object to test
+     */
+    function isClearFinishedData(obj: any): obj is ClearFinishedData;
+    /**
      * Main data of InsightSaved event
@@ -459,0 +489,0 @@ *

dist/src/embedding/ad.js

@@ -66,2 +66,6 @@ "use strict";
         /**
+         * Type represent that the insight editor is cleared
+         */
+        GdcAdEventType["ClearFinished"] = "clearFinished";
+        /**
          * Type represent that the insight is saved
@@ -186,2 +190,11 @@ *
     /**
+     * Type-guard checking whether an object is an instance of {@link ClearFinishedData}
+     *
+     * @param obj - object to test
+     */
+    function isClearFinishedData(obj) {
+        return common_1.getEventType(obj) === GdcAdEventType.ClearFinished;
+    }
+    EmbeddedAnalyticalDesigner.isClearFinishedData = isClearFinishedData;
+    /**
      * Type-guard checking whether an object is an instance of {@link InsightSavedData}
@@ -188,0 +201,0 @@ *

dist/src/embedding/common.d.ts

@@ -141,2 +141,8 @@ /**
 /**
+ * Addtional information for action payload. Use for internal reducers, sagas
+ */
+export interface IContextPayload {
+    contextId?: string;
+}
+/**
  * Get event type of event from event data
@@ -143,0 +149,0 @@ * @param obj the event data object

package.json

 {
   "name": "@gooddata/typings",
-  "version": "2.23.0-lanhuynh-lhq-sd-884-post-event-typings-2020-04-16T11-21-57-655Z",
+  "version": "2.23.0-lanhuynh-lhq-sd-886-2020-04-23T01-40-32-006Z",
   "description": "TypeScript definition files for GoodData platform",
@@ -5,0 +5,0 @@ "typings": "dist/index.d.ts",

No alert changes

Improved metrics

Total package byte prevSize

308431

increased by0.62%

Lines of code

5067

increased by0.98%

No dependency changes