Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

@gooddata/typings

Package Overview
Dependencies
Maintainers
47
Versions
304
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@gooddata/typings - npm Package Compare versions

Comparing version 2.24.4-alpha-khanh.le-kl-SD-889-2020-05-14T03-40-51-117Z to 2.24.4-lanhuynh-lhq-sd-907-2020-05-15T06-10-46-978Z

68

dist/src/embedding/ad.d.ts

@@ -22,3 +22,3 @@ import { CommandFailed, IObjectMeta, IGdcMessageEvent, IGdcMessageEnvelope, CommandFailedData, GdcProductName, IDrillableItemsCommandBody } from './common';

*/
type IADMessageEvent<T, TBody> = IGdcMessageEvent<GdcProductName.ANALYTICAL_DESIGNER, T, TBody>;
type IAdGdcMessageEvent<T, TBody> = IGdcMessageEvent<GdcProductName.ANALYTICAL_DESIGNER, T, TBody>;
/**

@@ -31,3 +31,3 @@ * Base type for AD event data

*/
enum GdcAdCommandType {
enum AdGdcCommandType {
/**

@@ -69,3 +69,3 @@ * The command set drillable items

*/
enum GdcAdEventType {
enum AdGdcEventType {
/**

@@ -135,3 +135,3 @@ * Type represent that Insight is saved

*/
type DrillableItemsCommand = IADMessageEvent<GdcAdCommandType.DrillableItems, IDrillableItemsCommandBody>;
type DrillableItemsCommand = IAdGdcMessageEvent<AdGdcCommandType.DrillableItems, IDrillableItemsCommandBody>;
/**

@@ -143,3 +143,3 @@ * Data type of drillable items command

*/
type DrillableItemsCommandData = IAdGdcMessageEnvelope<GdcAdCommandType.DrillableItems, IDrillableItemsCommandBody>;
type DrillableItemsCommandData = IAdGdcMessageEnvelope<AdGdcCommandType.DrillableItems, IDrillableItemsCommandBody>;
/**

@@ -207,3 +207,3 @@ * Type-guard checking whether an object is an instance of {@link DrillableItemsCommandData}

*/
type OpenInsightCommand = IADMessageEvent<GdcAdCommandType.OpenInsight, IOpenInsightCommandBody>;
type OpenInsightCommand = IAdGdcMessageEvent<AdGdcCommandType.OpenInsight, IOpenInsightCommandBody>;
/**

@@ -215,3 +215,3 @@ * Data type of open insight command

*/
type OpenInsightCommandData = IAdGdcMessageEnvelope<GdcAdCommandType.OpenInsight, IOpenInsightCommandBody>;
type OpenInsightCommandData = IAdGdcMessageEnvelope<AdGdcCommandType.OpenInsight, IOpenInsightCommandBody>;
/**

@@ -226,3 +226,3 @@ * Type-guard checking whether an object is an instance of {@link OpenInsightCommandData}

*/
type ClearCommand = IADMessageEvent<GdcAdCommandType.Clear, undefined>;
type ClearCommand = IAdGdcMessageEvent<AdGdcCommandType.Clear, undefined>;
/**

@@ -233,3 +233,3 @@ * Data type of clear command

*/
type ClearCommandData = IAdGdcMessageEnvelope<GdcAdCommandType.Clear, undefined>;
type ClearCommandData = IAdGdcMessageEnvelope<AdGdcCommandType.Clear, undefined>;
/**

@@ -266,3 +266,3 @@ * Type-guard checking whether an object is an instance of {@link ClearCommandData}

*/
type SaveInsightCommand = IADMessageEvent<GdcAdCommandType.Save, ISaveCommandBody>;
type SaveInsightCommand = IAdGdcMessageEvent<AdGdcCommandType.Save, ISaveCommandBody>;
/**

@@ -274,3 +274,3 @@ * Data type of save insight command

*/
type SaveInsightCommandData = IAdGdcMessageEnvelope<GdcAdCommandType.Save, ISaveCommandBody>;
type SaveInsightCommandData = IAdGdcMessageEnvelope<AdGdcCommandType.Save, ISaveCommandBody>;
/**

@@ -296,3 +296,3 @@ * Type-guard checking whether an object is an instance of {@link SaveInsightCommandData}

*/
type SaveAsInsightCommand = IADMessageEvent<GdcAdCommandType.SaveAs, ISaveAsInsightCommandBody>;
type SaveAsInsightCommand = IAdGdcMessageEvent<AdGdcCommandType.SaveAs, ISaveAsInsightCommandBody>;
/**

@@ -304,3 +304,3 @@ * Data type of save as insight command

*/
type SaveAsInsightCommandData = IAdGdcMessageEnvelope<GdcAdCommandType.SaveAs, ISaveAsInsightCommandBody>;
type SaveAsInsightCommandData = IAdGdcMessageEnvelope<AdGdcCommandType.SaveAs, ISaveAsInsightCommandBody>;
/**

@@ -337,3 +337,3 @@ * Type-guard checking whether an object is an instance of {@link SaveAsInsightCommandData}

*/
type ExportInsightCommand = IADMessageEvent<GdcAdCommandType.Export, IExportInsightCommandBody>;
type ExportInsightCommand = IAdGdcMessageEvent<AdGdcCommandType.Export, IExportInsightCommandBody>;
/**

@@ -345,3 +345,3 @@ * Data type of export insight command

*/
type ExportInsightCommandData = IAdGdcMessageEnvelope<GdcAdCommandType.Export, IExportInsightCommandBody>;
type ExportInsightCommandData = IAdGdcMessageEnvelope<AdGdcCommandType.Export, IExportInsightCommandBody>;
/**

@@ -363,3 +363,3 @@ * Type-guard checking whether an object is an instance of {@link ExportInsightCommandData}

*/
type UndoCommand = IADMessageEvent<GdcAdCommandType.Undo, undefined>;
type UndoCommand = IAdGdcMessageEvent<AdGdcCommandType.Undo, undefined>;
/**

@@ -370,3 +370,3 @@ * Data type of undo command

*/
type UndoCommandData = IAdGdcMessageEnvelope<GdcAdCommandType.Undo, undefined>;
type UndoCommandData = IAdGdcMessageEnvelope<AdGdcCommandType.Undo, undefined>;
/**

@@ -388,3 +388,3 @@ * Type-guard checking whether an object is an instance of {@link UndoCommandData}

*/
type RedoCommand = IADMessageEvent<GdcAdCommandType.Redo, undefined>;
type RedoCommand = IAdGdcMessageEvent<AdGdcCommandType.Redo, undefined>;
/**

@@ -395,3 +395,3 @@ * Data type of redo command

*/
type RedoCommandData = IAdGdcMessageEnvelope<GdcAdCommandType.Redo, undefined>;
type RedoCommandData = IAdGdcMessageEnvelope<AdGdcCommandType.Redo, undefined>;
/**

@@ -410,3 +410,3 @@ * Type-guard checking whether an object is an instance of {@link RedoCommandData}

*/
availableCommands: GdcAdCommandType[];
availableCommands: AdGdcCommandType[];
}

@@ -420,3 +420,3 @@ /**

*/
type NewInsightInitialized = IADMessageEvent<GdcAdEventType.NewInsightInitialized, NewInsightInitializedBody>;
type NewInsightInitialized = IAdGdcMessageEvent<AdGdcEventType.NewInsightInitialized, NewInsightInitializedBody>;
/**

@@ -427,3 +427,3 @@ * Data type of event that was emitted when the new insight initialized

*/
type NewInsightInitializedData = IAdGdcMessageEnvelope<GdcAdEventType.NewInsightInitialized, undefined>;
type NewInsightInitializedData = IAdGdcMessageEnvelope<AdGdcEventType.NewInsightInitialized, undefined>;
/**

@@ -448,3 +448,3 @@ * Type-guard checking whether an object is an instance of {@link NewInsightInitializedData}

*/
type InsightOpened = IADMessageEvent<GdcAdEventType.InsightOpened, InsightOpenedBody>;
type InsightOpened = IAdGdcMessageEvent<AdGdcEventType.InsightOpened, InsightOpenedBody>;
/**

@@ -456,3 +456,3 @@ * Data type of event that was emitted when an insight is opened

*/
type InsightOpenedData = IAdGdcMessageEnvelope<GdcAdEventType.InsightOpened, InsightOpenedBody>;
type InsightOpenedData = IAdGdcMessageEnvelope<AdGdcEventType.InsightOpened, InsightOpenedBody>;
/**

@@ -467,3 +467,3 @@ * Type-guard checking whether an object is an instance of {@link InsightOpenedData}

*/
type ClearFinished = IADMessageEvent<GdcAdEventType.ClearFinished, IAvailableCommands>;
type ClearFinished = IAdGdcMessageEvent<AdGdcEventType.ClearFinished, IAvailableCommands>;
/**

@@ -475,3 +475,3 @@ * Data type of event that was emitted after finish clear action

*/
type ClearFinishedData = IAdGdcMessageEnvelope<GdcAdEventType.ClearFinished, IAvailableCommands>;
type ClearFinishedData = IAdGdcMessageEnvelope<AdGdcEventType.ClearFinished, IAvailableCommands>;
/**

@@ -497,3 +497,3 @@ * Type-guard checking whether an object is an instance of {@link ClearFinishedData}

*/
type InsightSaved = IADMessageEvent<GdcAdEventType.InsightSaved, InsightSavedBody>;
type InsightSaved = IAdGdcMessageEvent<AdGdcEventType.InsightSaved, InsightSavedBody>;
/**

@@ -505,3 +505,3 @@ * Data type of event that was emitted when an insight is saved

*/
type InsightSavedData = IAdGdcMessageEnvelope<GdcAdEventType.InsightSaved, InsightSavedBody>;
type InsightSavedData = IAdGdcMessageEnvelope<AdGdcEventType.InsightSaved, InsightSavedBody>;
/**

@@ -525,3 +525,3 @@ * Type-guard checking whether an object is an instance of {@link InsightSavedData}

*/
type ExportFinished = IADMessageEvent<GdcAdEventType.ExportFinished, ExportFinishedBody>;
type ExportFinished = IAdGdcMessageEvent<AdGdcEventType.ExportFinished, ExportFinishedBody>;
/**

@@ -533,3 +533,3 @@ * Data type of event that was emitted after an insight was exported

*/
type ExportFinishedData = IAdGdcMessageEnvelope<GdcAdEventType.ExportFinished, ExportFinishedBody>;
type ExportFinishedData = IAdGdcMessageEnvelope<AdGdcEventType.ExportFinished, ExportFinishedBody>;
/**

@@ -548,3 +548,3 @@ * Type-guard checking whether an object is an instance of {@link ExportFinishedData}

*/
type UndoFinished = IADMessageEvent<GdcAdEventType.UndoFinished, UndoFinishedBody>;
type UndoFinished = IAdGdcMessageEvent<AdGdcEventType.UndoFinished, UndoFinishedBody>;
/**

@@ -556,3 +556,3 @@ * Data type of event that was emitted after finish undo action

*/
type UndoFinishedData = IAdGdcMessageEnvelope<GdcAdEventType.UndoFinished, UndoFinishedBody>;
type UndoFinishedData = IAdGdcMessageEnvelope<AdGdcEventType.UndoFinished, UndoFinishedBody>;
/**

@@ -571,3 +571,3 @@ * Type-guard checking whether an object is an instance of {@link UndoFinishedData}

*/
type RedoFinished = IADMessageEvent<GdcAdEventType.RedoFinished, RedoFinishedBody>;
type RedoFinished = IAdGdcMessageEvent<AdGdcEventType.RedoFinished, RedoFinishedBody>;
/**

@@ -579,3 +579,3 @@ * Data type of event that was emitted after finish redo action

*/
type RedoFinishedData = IAdGdcMessageEnvelope<GdcAdEventType.RedoFinished, RedoFinishedBody>;
type RedoFinishedData = IAdGdcMessageEnvelope<AdGdcEventType.RedoFinished, RedoFinishedBody>;
/**

@@ -582,0 +582,0 @@ * Type-guard checking whether an object is an instance of {@link RedoFinishedData}

76

dist/src/embedding/ad.js

@@ -13,58 +13,58 @@ "use strict";

*/
var GdcAdCommandType;
(function (GdcAdCommandType) {
var AdGdcCommandType;
(function (AdGdcCommandType) {
/**
* The command set drillable items
*/
GdcAdCommandType["DrillableItems"] = "drillableItems";
AdGdcCommandType["DrillableItems"] = "drillableItems";
/**
* The command open an insight
*/
GdcAdCommandType["OpenInsight"] = "openInsight";
AdGdcCommandType["OpenInsight"] = "openInsight";
/**
* The command save an insight
*/
GdcAdCommandType["Save"] = "saveInsight";
AdGdcCommandType["Save"] = "saveInsight";
/**
* The command save the insight as a new one
*/
GdcAdCommandType["SaveAs"] = "saveAsInsight";
AdGdcCommandType["SaveAs"] = "saveAsInsight";
/**
* The command export an insight
*/
GdcAdCommandType["Export"] = "exportInsight";
AdGdcCommandType["Export"] = "exportInsight";
/**
* The command reset the insight editor to empty state
*/
GdcAdCommandType["Clear"] = "clear";
AdGdcCommandType["Clear"] = "clear";
/**
* The command undo to previous state
*/
GdcAdCommandType["Undo"] = "undo";
AdGdcCommandType["Undo"] = "undo";
/**
* The command redo to next state
*/
GdcAdCommandType["Redo"] = "redo";
})(GdcAdCommandType = EmbeddedAnalyticalDesigner.GdcAdCommandType || (EmbeddedAnalyticalDesigner.GdcAdCommandType = {}));
AdGdcCommandType["Redo"] = "redo";
})(AdGdcCommandType = EmbeddedAnalyticalDesigner.AdGdcCommandType || (EmbeddedAnalyticalDesigner.AdGdcCommandType = {}));
/**
* All event types on AD
*/
var GdcAdEventType;
(function (GdcAdEventType) {
var AdGdcEventType;
(function (AdGdcEventType) {
/**
* Type represent that Insight is saved
*/
GdcAdEventType["ListeningForDrillableItems"] = "listeningForDrillableItems";
AdGdcEventType["ListeningForDrillableItems"] = "listeningForDrillableItems";
/**
* Type represent that a new insight is initialized
*/
GdcAdEventType["NewInsightInitialized"] = "newInsightInitialized";
AdGdcEventType["NewInsightInitialized"] = "newInsightInitialized";
/**
* Type represent that the insight is opened
*/
GdcAdEventType["InsightOpened"] = "insightOpened";
AdGdcEventType["InsightOpened"] = "insightOpened";
/**
* Type represent that the insight editor is cleared
*/
GdcAdEventType["ClearFinished"] = "clearFinished";
AdGdcEventType["ClearFinished"] = "clearFinished";
/**

@@ -76,20 +76,20 @@ * Type represent that the insight is saved

*/
GdcAdEventType["InsightSaved"] = "visualizationSaved";
AdGdcEventType["InsightSaved"] = "visualizationSaved";
/**
* Type represent that the undo action is finished
*/
GdcAdEventType["UndoFinished"] = "undoFinished";
AdGdcEventType["UndoFinished"] = "undoFinished";
/**
* Type represent that the redo action is finished
*/
GdcAdEventType["RedoFinished"] = "redoFinished";
AdGdcEventType["RedoFinished"] = "redoFinished";
/**
* Type represent that the export action is finished
*/
GdcAdEventType["ExportFinished"] = "exportInsightFinished";
AdGdcEventType["ExportFinished"] = "exportInsightFinished";
/**
* Type that drill performed
*/
GdcAdEventType["Drill"] = "drill";
})(GdcAdEventType = EmbeddedAnalyticalDesigner.GdcAdEventType || (EmbeddedAnalyticalDesigner.GdcAdEventType = {}));
AdGdcEventType["Drill"] = "drill";
})(AdGdcEventType = EmbeddedAnalyticalDesigner.AdGdcEventType || (EmbeddedAnalyticalDesigner.AdGdcEventType = {}));
/**

@@ -110,3 +110,3 @@ * Type-guard checking whether an object is an instance of {@link AdCommandFailedData}

function isDrillableItemsCommandData(obj) {
return common_1.getEventType(obj) === GdcAdCommandType.DrillableItems;
return common_1.getEventType(obj) === AdGdcCommandType.DrillableItems;
}

@@ -120,3 +120,3 @@ EmbeddedAnalyticalDesigner.isDrillableItemsCommandData = isDrillableItemsCommandData;

function isOpenInsightCommandData(obj) {
return common_1.getEventType(obj) === GdcAdCommandType.OpenInsight;
return common_1.getEventType(obj) === AdGdcCommandType.OpenInsight;
}

@@ -130,3 +130,3 @@ EmbeddedAnalyticalDesigner.isOpenInsightCommandData = isOpenInsightCommandData;

function isClearCommandData(obj) {
return common_1.getEventType(obj) === GdcAdCommandType.Clear;
return common_1.getEventType(obj) === AdGdcCommandType.Clear;
}

@@ -140,3 +140,3 @@ EmbeddedAnalyticalDesigner.isClearCommandData = isClearCommandData;

function isSaveInsightCommandData(obj) {
return common_1.getEventType(obj) === GdcAdCommandType.Save;
return common_1.getEventType(obj) === AdGdcCommandType.Save;
}

@@ -150,3 +150,3 @@ EmbeddedAnalyticalDesigner.isSaveInsightCommandData = isSaveInsightCommandData;

function isSaveAsInsightCommandData(obj) {
return common_1.getEventType(obj) === GdcAdCommandType.SaveAs;
return common_1.getEventType(obj) === AdGdcCommandType.SaveAs;
}

@@ -160,3 +160,3 @@ EmbeddedAnalyticalDesigner.isSaveAsInsightCommandData = isSaveAsInsightCommandData;

function isExportInsightCommandData(obj) {
return common_1.getEventType(obj) === GdcAdCommandType.Export;
return common_1.getEventType(obj) === AdGdcCommandType.Export;
}

@@ -170,3 +170,3 @@ EmbeddedAnalyticalDesigner.isExportInsightCommandData = isExportInsightCommandData;

function isUndoCommandData(obj) {
return common_1.getEventType(obj) === GdcAdCommandType.Undo;
return common_1.getEventType(obj) === AdGdcCommandType.Undo;
}

@@ -180,3 +180,3 @@ EmbeddedAnalyticalDesigner.isUndoCommandData = isUndoCommandData;

function isRedoCommandData(obj) {
return common_1.getEventType(obj) === GdcAdCommandType.Redo;
return common_1.getEventType(obj) === AdGdcCommandType.Redo;
}

@@ -190,3 +190,3 @@ EmbeddedAnalyticalDesigner.isRedoCommandData = isRedoCommandData;

function isNewInsightInitializedData(obj) {
return common_1.getEventType(obj) === GdcAdEventType.NewInsightInitialized;
return common_1.getEventType(obj) === AdGdcEventType.NewInsightInitialized;
}

@@ -200,3 +200,3 @@ EmbeddedAnalyticalDesigner.isNewInsightInitializedData = isNewInsightInitializedData;

function isInsightOpenedData(obj) {
return common_1.getEventType(obj) === GdcAdEventType.InsightOpened;
return common_1.getEventType(obj) === AdGdcEventType.InsightOpened;
}

@@ -210,3 +210,3 @@ EmbeddedAnalyticalDesigner.isInsightOpenedData = isInsightOpenedData;

function isClearFinishedData(obj) {
return common_1.getEventType(obj) === GdcAdEventType.ClearFinished;
return common_1.getEventType(obj) === AdGdcEventType.ClearFinished;
}

@@ -220,3 +220,3 @@ EmbeddedAnalyticalDesigner.isClearFinishedData = isClearFinishedData;

function isInsightSavedData(obj) {
return common_1.getEventType(obj) === GdcAdEventType.InsightSaved;
return common_1.getEventType(obj) === AdGdcEventType.InsightSaved;
}

@@ -230,3 +230,3 @@ EmbeddedAnalyticalDesigner.isInsightSavedData = isInsightSavedData;

function isExportFinishedData(obj) {
return common_1.getEventType(obj) === GdcAdEventType.ExportFinished;
return common_1.getEventType(obj) === AdGdcEventType.ExportFinished;
}

@@ -240,3 +240,3 @@ EmbeddedAnalyticalDesigner.isExportFinishedData = isExportFinishedData;

function isUndoFinishedData(obj) {
return common_1.getEventType(obj) === GdcAdEventType.UndoFinished;
return common_1.getEventType(obj) === AdGdcEventType.UndoFinished;
}

@@ -250,3 +250,3 @@ EmbeddedAnalyticalDesigner.isUndoFinishedData = isUndoFinishedData;

function isRedoFinishedData(obj) {
return common_1.getEventType(obj) === GdcAdEventType.RedoFinished;
return common_1.getEventType(obj) === AdGdcEventType.RedoFinished;
}

@@ -253,0 +253,0 @@ EmbeddedAnalyticalDesigner.isRedoFinishedData = isRedoFinishedData;

198

dist/src/embedding/kd.d.ts

@@ -1,2 +0,2 @@

import { IGdcMessageEvent, GdcProductName, IGdcMessageEnvelope, IDrillableItemsCommandBody, IObjectMeta } from './common';
import { IGdcMessageEvent, GdcProductName, IGdcMessageEnvelope, IDrillableItemsCommandBody } from './common';
export declare namespace EmbeddedKpiDashboard {

@@ -14,3 +14,3 @@ /**

*/
enum GdcKdCommandType {
enum KdGdcCommandType {
/**

@@ -43,15 +43,3 @@ * The command save a dashboard.

*/
Drill = "drill",
/**
* The command add widget to dashboard.
*/
AddWidget = "addWidget",
/**
* The command add filter to dashboard.
*/
AddFilter = "addFilter",
/**
* The command export a dashboard.
*/
ExportToPDF = "exportToPDF"
Drill = "drill"
}

@@ -61,3 +49,3 @@ /**

*/
enum GdcKdEventType {
enum KdGdcEventType {
/**

@@ -117,17 +105,3 @@ * Type represent that the dashboard listening for drilling event.

*/
Platform = "platform",
/**
* Type represent that the widget is added to dashboard.
*
*/
WidgetAdded = "widgetAdded",
/**
* Type represent that the filter is added to dashboard.
*
*/
FilterAdded = "filterAdded",
/**
* Type represent that the export action is finished.
*/
ExportedToPDF = "exportedToPDF"
Platform = "platform"
}

@@ -141,3 +115,3 @@ /**

*/
availableCommands: GdcKdCommandType[];
availableCommands: KdGdcCommandType[];
}

@@ -171,4 +145,4 @@ /**

*/
type SaveDashboardCommand = IKdGdcMessageEvent<GdcKdCommandType.Save, IKdSaveCommandBody>;
type SaveDashboardCommandData = IKdGdcMessageEnvelope<GdcKdCommandType.Save, IKdSaveCommandBody>;
type SaveDashboardCommand = IKdGdcMessageEvent<KdGdcCommandType.Save, IKdSaveCommandBody>;
type SaveDashboardCommandData = IKdGdcMessageEnvelope<KdGdcCommandType.Save, IKdSaveCommandBody>;
/**

@@ -192,4 +166,4 @@ * Type-guard checking whether object is an instance of {@link SaveDashboardCommandData}.

*/
type CancelEditCommand = IKdGdcMessageEvent<GdcKdCommandType.CancelEdit, null>;
type CancelEditCommandData = IKdGdcMessageEnvelope<GdcKdCommandType.CancelEdit, null>;
type CancelEditCommand = IKdGdcMessageEvent<KdGdcCommandType.CancelEdit, null>;
type CancelEditCommandData = IKdGdcMessageEnvelope<KdGdcCommandType.CancelEdit, null>;
/**

@@ -214,4 +188,4 @@ * Type-guard checking whether object is an instance of {@link CancelEditData}.

*/
type DeleteDashboardCommand = IKdGdcMessageEvent<GdcKdCommandType.Delete, null>;
type DeleteDashboardCommandData = IKdGdcMessageEnvelope<GdcKdCommandType.Delete, null>;
type DeleteDashboardCommand = IKdGdcMessageEvent<KdGdcCommandType.Delete, null>;
type DeleteDashboardCommandData = IKdGdcMessageEnvelope<KdGdcCommandType.Delete, null>;
/**

@@ -230,4 +204,4 @@ * Switches current dashboard to edit mode.

*/
type SwitchToEditCommand = IKdGdcMessageEvent<GdcKdCommandType.SwitchToEdit, null>;
type SwitchToEditCommandData = IKdGdcMessageEnvelope<GdcKdCommandType.SwitchToEdit, null>;
type SwitchToEditCommand = IKdGdcMessageEvent<KdGdcCommandType.SwitchToEdit, null>;
type SwitchToEditCommandData = IKdGdcMessageEnvelope<KdGdcCommandType.SwitchToEdit, null>;
/**

@@ -246,3 +220,3 @@ * Type-guard checking whether object is an instance of {@link SwitchToEditCommandData}.

*/
type DrillableItemsCommand = IKdGdcMessageEvent<GdcKdCommandType.DrillableItems, IDrillableItemsCommandBody>;
type DrillableItemsCommand = IKdGdcMessageEvent<KdGdcCommandType.DrillableItems, IDrillableItemsCommandBody>;
/**

@@ -254,3 +228,3 @@ * Data type of drillable items command

*/
type DrillableItemsCommandData = IKdGdcMessageEnvelope<GdcKdCommandType.DrillableItems, IDrillableItemsCommandBody>;
type DrillableItemsCommandData = IKdGdcMessageEnvelope<KdGdcCommandType.DrillableItems, IDrillableItemsCommandBody>;
/**

@@ -268,4 +242,4 @@ * Type-guard checking whether object is an instance of {@link DrillableItemsCommandData}.

}
type SetSizeCommand = IKdGdcMessageEvent<GdcKdCommandType.SetSize, ISetSizeCommandBody>;
type SetSizeCommandData = IKdGdcMessageEnvelope<GdcKdCommandType.SetSize, ISetSizeCommandBody>;
type SetSizeCommand = IKdGdcMessageEvent<KdGdcCommandType.SetSize, ISetSizeCommandBody>;
type SetSizeCommandData = IKdGdcMessageEnvelope<KdGdcCommandType.SetSize, ISetSizeCommandBody>;
/**

@@ -277,87 +251,2 @@ * Type-guard checking whether object is an instance of {@link SetSizeCommandData}.

function isSetSizeCommandData(obj: any): obj is SetSizeCommandData;
interface IKpiWidget {
type: 'kpi';
}
type InsightRef = {
identifier: string;
} | {
uri: string;
};
interface IInsightWidget {
type: 'insight';
ref: InsightRef;
}
interface IAddWidgetBody {
widget: IKpiWidget | IInsightWidget;
}
/**
* Adds new widget onto dashboard. New row will be created on top of the dashboard, the widget
* will be placed into its first column.
*
* It is currently possible to add either a KPI or an Insight. When adding either of these, KD will
* scroll to top so that the newly added widget is visible.
*
* For KPI, the KD will start the KPI customization flow right after the KPI is placed.
* Insights are placed without need for further customization
*
* Contract:
*
* - if KD is currently editing a dashboard, then depending on widget type:
* - KPI is added to dashboard, customization flow is started, WidgetAdded will be posted
* - Insight is added to dashboard, WidgetAdded will be posted
*
* - if insight reference included in command payload does not refer to a valid insight, KdCommandFailed
* will be posted
*
* - if KD is in view mode or not showing any dashboard, then KdCommandFailed will be posted
*
* @remarks use {@link AddWidgetCommand} to create instances of AddWidget
*/
type AddWidgetCommand = IKdGdcMessageEvent<GdcKdCommandType.AddWidget, IAddWidgetBody>;
type AddWidgetCommandData = IKdGdcMessageEnvelope<GdcKdCommandType.AddWidget, IAddWidgetBody>;
/**
* Type-guard checking whether object is an instance of {@link isAddWidgetCommandData}.
*
* @param obj - object to test
*/
function isAddWidgetCommandData(obj: any): obj is AddWidgetCommandData;
/**
* Adds new attribute filter to filter bar and starts the filter customization flow.
*
* Contract:
*
* - if KD is currently editing a dashboard, adds new attribute filter, starts customization flow; FilterAdded
* will be posted right after customization starts
*
* - if KD is currently in view mode or does not show any dashboard, will post KdCommandFailed
*
* @remarks use {@link AddFilterCommand} factory function to instantiate
*/
type AddFilterCommand = IKdGdcMessageEvent<GdcKdCommandType.AddFilter, null>;
type AddFilterCommandData = IKdGdcMessageEnvelope<GdcKdCommandType.AddFilter, null>;
/**
* Type-guard checking whether object is an instance of {@link isAddFilterCommandData}.
*
* @param obj - object to test
*/
function isAddFilterCommandData(obj: any): obj is AddFilterCommandData;
/**
* Exports dashboard to PDF.
*
* Contract:
*
* - if KD shows dashboard in view mode, will export dashboard to PDF and post ExportFinished once ready for
* exporting
* - if KD shwows dashboard in edit mode or not not showing any dashboard, KdCommandFailed will
* be posted
* @remarks use {@link ExportToPDFCommand} factory function to instantiate
*/
type ExportToPDFCommand = IKdGdcMessageEvent<GdcKdCommandType.ExportToPDF, null>;
type ExportToPDFCommandData = IKdGdcMessageEnvelope<GdcKdCommandType.ExportToPDF, null>;
/**
* Type-guard checking whether object is an instance of {@link isExportCommandData}.
*
* @param obj - object to test
*/
function isExportToPDFCommandData(obj: any): obj is ExportToPDFCommandData;
interface INoPermissionsBody {

@@ -372,3 +261,3 @@ /**

*/
type NoPermissionsEventData = IKdGdcMessageEnvelope<GdcKdEventType.NoPermissions, INoPermissionsBody>;
type NoPermissionsEventData = IKdGdcMessageEnvelope<KdGdcEventType.NoPermissions, INoPermissionsBody>;
interface IResizedBody {

@@ -380,3 +269,3 @@ height: number;

*/
type ResizedEventData = IKdGdcMessageEnvelope<GdcKdEventType.Resized, IResizedBody>;
type ResizedEventData = IKdGdcMessageEnvelope<KdGdcEventType.Resized, IResizedBody>;
interface IDashboardObjectMeta {

@@ -410,3 +299,3 @@ /**

*/
type IDashboardCreatedData = IKdGdcMessageEnvelope<GdcKdEventType.DashboardCreated, IDashboardBody>;
type IDashboardCreatedData = IKdGdcMessageEnvelope<KdGdcEventType.DashboardCreated, IDashboardBody>;
/**

@@ -416,23 +305,23 @@ * Data type of event that was emited when the content is fully loaded,

*/
type IDashboardLoadedData = IKdGdcMessageEnvelope<GdcKdEventType.DashboardLoaded, IDashboardBody>;
type IDashboardLoadedData = IKdGdcMessageEnvelope<KdGdcEventType.DashboardLoaded, IDashboardBody>;
/**
* Data type of event that was emited when the existing dashboard has been updated.
*/
type IDashboardUpdatedData = IKdGdcMessageEnvelope<GdcKdEventType.DashboardUpdated, IDashboardBody>;
type IDashboardUpdatedData = IKdGdcMessageEnvelope<KdGdcEventType.DashboardUpdated, IDashboardBody>;
/**
* Data type of event that was emited when the dashboard has been saved.
*/
type IDashboardSavedData = IKdGdcMessageEnvelope<GdcKdEventType.DashboardSaved, IDashboardBody>;
type IDashboardSavedData = IKdGdcMessageEnvelope<KdGdcEventType.DashboardSaved, IDashboardBody>;
/**
* Data type of event that was emited when the dashboard has been deleted.
*/
type IDashboardDeletedData = IKdGdcMessageEnvelope<GdcKdEventType.DashboardDeleted, IDashboardBody>;
type IDashboardDeletedData = IKdGdcMessageEnvelope<KdGdcEventType.DashboardDeleted, IDashboardBody>;
/**
* This event is emitted after KD switched a dashboard from view mode to edit mode.
*/
type SwitchedToEditData = IKdGdcMessageEnvelope<GdcKdEventType.SwitchedToEdit, IDashboardBody>;
type SwitchedToEditData = IKdGdcMessageEnvelope<KdGdcEventType.SwitchedToEdit, IDashboardBody>;
/**
* This event is emitted after KD switched a dashboard from edit mode to view mode.
*/
type SwitchedToViewData = IKdGdcMessageEnvelope<GdcKdEventType.SwitchedToView, IDashboardBody>;
type SwitchedToViewData = IKdGdcMessageEnvelope<KdGdcEventType.SwitchedToView, IDashboardBody>;
interface IPlaformBody {

@@ -443,34 +332,3 @@ status?: string;

}
type PlaformData = IKdGdcMessageEnvelope<GdcKdEventType.Platform, IPlaformBody>;
interface IWidgetAddedBody {
insight?: IObjectMeta;
}
/**
* This event is emitted after KD added a new widget to a dashboard. If the widget is
* an insight, then meta information about the insight will be returned.
*
* Note: when this event is added for a KPI widget, it means the customization flow for the KPI has
* started. The user may still 'just' click somewhere outside of the KPI configuration and the KPI will
* be discarded.
*/
type WidgetAddedData = IKdGdcMessageEnvelope<GdcKdEventType.WidgetAdded, IWidgetAddedBody>;
type FilterAddedBody = IKdAvailableCommands;
/**
* This event is emitted after KD added a new filter to dashboard's filter bar and started its
* customization flow.
*
* Note: users can still cancel the filter customization flow meaning no new attribute filter
* will end on the filter bar.
*/
type FilterAddedData = IKdGdcMessageEnvelope<GdcKdEventType.FilterAdded, FilterAddedBody>;
type ExportToPDFFinishedBody = IKdAvailableCommands & {
/**
* Link to the file containing exported data.
*/
link: string;
};
/**
* This event is emitted after dashboard has been exported to PDF
*/
type ExportToPDFFinishedData = IKdGdcMessageEnvelope<GdcKdEventType.ExportedToPDF, ExportToPDFFinishedBody>;
type PlaformData = IKdGdcMessageEnvelope<KdGdcEventType.Platform, IPlaformBody>;
}

115

dist/src/embedding/kd.js

@@ -10,70 +10,58 @@ "use strict";

*/
var GdcKdCommandType;
(function (GdcKdCommandType) {
var KdGdcCommandType;
(function (KdGdcCommandType) {
/**
* The command save a dashboard.
*/
GdcKdCommandType["Save"] = "saveDashboard";
KdGdcCommandType["Save"] = "saveDashboard";
/**
* The command cancel editing dashboard.
*/
GdcKdCommandType["CancelEdit"] = "cancelEdit";
KdGdcCommandType["CancelEdit"] = "cancelEdit";
/**
* The command delete existed dashboard.
*/
GdcKdCommandType["Delete"] = "deleteDashboard";
KdGdcCommandType["Delete"] = "deleteDashboard";
/**
* The command edit a dashboard.
*/
GdcKdCommandType["SwitchToEdit"] = "switchToEdit";
KdGdcCommandType["SwitchToEdit"] = "switchToEdit";
/**
* The command set drillable items.
*/
GdcKdCommandType["DrillableItems"] = "drillableItems";
KdGdcCommandType["DrillableItems"] = "drillableItems";
/**
* The command set size of dashboard.
*/
GdcKdCommandType["SetSize"] = "setSize";
KdGdcCommandType["SetSize"] = "setSize";
/**
* The command drill performed
*/
GdcKdCommandType["Drill"] = "drill";
/**
* The command add widget to dashboard.
*/
GdcKdCommandType["AddWidget"] = "addWidget";
/**
* The command add filter to dashboard.
*/
GdcKdCommandType["AddFilter"] = "addFilter";
/**
* The command export a dashboard.
*/
GdcKdCommandType["ExportToPDF"] = "exportToPDF";
})(GdcKdCommandType = EmbeddedKpiDashboard.GdcKdCommandType || (EmbeddedKpiDashboard.GdcKdCommandType = {}));
KdGdcCommandType["Drill"] = "drill";
})(KdGdcCommandType = EmbeddedKpiDashboard.KdGdcCommandType || (EmbeddedKpiDashboard.KdGdcCommandType = {}));
/**
* All KD event types.
*/
var GdcKdEventType;
(function (GdcKdEventType) {
var KdGdcEventType;
(function (KdGdcEventType) {
/**
* Type represent that the dashboard listening for drilling event.
*/
GdcKdEventType["ListeningForDrillableItems"] = "listeningForDrillableItems";
KdGdcEventType["ListeningForDrillableItems"] = "listeningForDrillableItems";
/**
* Type represent that the embedded content starts loading.
*/
GdcKdEventType["LoadingStarted"] = "loadingStarted";
KdGdcEventType["LoadingStarted"] = "loadingStarted";
/**
* Type represent that The user does not have permissions to view or edit the content.
*/
GdcKdEventType["NoPermissions"] = "noPermissions";
KdGdcEventType["NoPermissions"] = "noPermissions";
/**
* Type represent that an operation increasing the height of the hosting iframe is performed.
*/
GdcKdEventType["Resized"] = "resized";
KdGdcEventType["Resized"] = "resized";
/**
* Type represent that the dashboard has been created and saved.
*/
GdcKdEventType["DashboardCreated"] = "dashboardCreated";
KdGdcEventType["DashboardCreated"] = "dashboardCreated";
/**

@@ -83,7 +71,7 @@ * Type represent that the content is fully loaded,

*/
GdcKdEventType["DashboardLoaded"] = "loaded";
KdGdcEventType["DashboardLoaded"] = "loaded";
/**
* Type represent that the existing dashboard has been updated.
*/
GdcKdEventType["DashboardUpdated"] = "dashboardUpdated";
KdGdcEventType["DashboardUpdated"] = "dashboardUpdated";
/**

@@ -93,3 +81,3 @@ * Type represent that the dashboard is saved.

*/
GdcKdEventType["DashboardSaved"] = "dashboardSaved";
KdGdcEventType["DashboardSaved"] = "dashboardSaved";
/**

@@ -99,34 +87,20 @@ * Type represent that the dashboard is deleted.

*/
GdcKdEventType["DashboardDeleted"] = "dashboardDeleted";
KdGdcEventType["DashboardDeleted"] = "dashboardDeleted";
/**
* Type represent that the user cancels the creation of the dashboard.
*/
GdcKdEventType["DashboardCreationCanceled"] = "dashboardCreationCanceled";
KdGdcEventType["DashboardCreationCanceled"] = "dashboardCreationCanceled";
/**
* Type represent that the dashboard is switched to edit mode.
*/
GdcKdEventType["SwitchedToEdit"] = "switchedToEdit";
KdGdcEventType["SwitchedToEdit"] = "switchedToEdit";
/**
* Type represent that the dashboard is switched to view mode.
*/
GdcKdEventType["SwitchedToView"] = "switchedToView";
KdGdcEventType["SwitchedToView"] = "switchedToView";
/**
* Type represent that the platform is down.
*/
GdcKdEventType["Platform"] = "platform";
/**
* Type represent that the widget is added to dashboard.
*
*/
GdcKdEventType["WidgetAdded"] = "widgetAdded";
/**
* Type represent that the filter is added to dashboard.
*
*/
GdcKdEventType["FilterAdded"] = "filterAdded";
/**
* Type represent that the export action is finished.
*/
GdcKdEventType["ExportedToPDF"] = "exportedToPDF";
})(GdcKdEventType = EmbeddedKpiDashboard.GdcKdEventType || (EmbeddedKpiDashboard.GdcKdEventType = {}));
KdGdcEventType["Platform"] = "platform";
})(KdGdcEventType = EmbeddedKpiDashboard.KdGdcEventType || (EmbeddedKpiDashboard.KdGdcEventType = {}));
/**

@@ -138,3 +112,3 @@ * Type-guard checking whether object is an instance of {@link SaveDashboardCommandData}.

function isSaveDashboardCommandData(obj) {
return common_1.getEventType(obj) === GdcKdCommandType.Save;
return common_1.getEventType(obj) === KdGdcCommandType.Save;
}

@@ -148,3 +122,3 @@ EmbeddedKpiDashboard.isSaveDashboardCommandData = isSaveDashboardCommandData;

function isCancelEditCommandData(obj) {
return common_1.getEventType(obj) === GdcKdCommandType.CancelEdit;
return common_1.getEventType(obj) === KdGdcCommandType.CancelEdit;
}

@@ -158,3 +132,3 @@ EmbeddedKpiDashboard.isCancelEditCommandData = isCancelEditCommandData;

function isSwitchToEditCommandData(obj) {
return common_1.getEventType(obj) === GdcKdCommandType.SwitchToEdit;
return common_1.getEventType(obj) === KdGdcCommandType.SwitchToEdit;
}

@@ -168,3 +142,3 @@ EmbeddedKpiDashboard.isSwitchToEditCommandData = isSwitchToEditCommandData;

function isDrillableItemsCommandData(obj) {
return common_1.getEventType(obj) === GdcKdCommandType.DrillableItems;
return common_1.getEventType(obj) === KdGdcCommandType.DrillableItems;
}

@@ -178,33 +152,6 @@ EmbeddedKpiDashboard.isDrillableItemsCommandData = isDrillableItemsCommandData;

function isSetSizeCommandData(obj) {
return common_1.getEventType(obj) === GdcKdCommandType.SetSize;
return common_1.getEventType(obj) === KdGdcCommandType.SetSize;
}
EmbeddedKpiDashboard.isSetSizeCommandData = isSetSizeCommandData;
/**
* Type-guard checking whether object is an instance of {@link isAddWidgetCommandData}.
*
* @param obj - object to test
*/
function isAddWidgetCommandData(obj) {
return common_1.getEventType(obj) === GdcKdCommandType.AddWidget;
}
EmbeddedKpiDashboard.isAddWidgetCommandData = isAddWidgetCommandData;
/**
* Type-guard checking whether object is an instance of {@link isAddFilterCommandData}.
*
* @param obj - object to test
*/
function isAddFilterCommandData(obj) {
return common_1.getEventType(obj) === GdcKdCommandType.AddFilter;
}
EmbeddedKpiDashboard.isAddFilterCommandData = isAddFilterCommandData;
/**
* Type-guard checking whether object is an instance of {@link isExportCommandData}.
*
* @param obj - object to test
*/
function isExportToPDFCommandData(obj) {
return common_1.getEventType(obj) === GdcKdCommandType.ExportToPDF;
}
EmbeddedKpiDashboard.isExportToPDFCommandData = isExportToPDFCommandData;
})(EmbeddedKpiDashboard = exports.EmbeddedKpiDashboard || (exports.EmbeddedKpiDashboard = {}));
//# sourceMappingURL=kd.js.map

2

package.json
{
"name": "@gooddata/typings",
"version": "2.24.4-alpha-khanh.le-kl-SD-889-2020-05-14T03-40-51-117Z",
"version": "2.24.4-lanhuynh-lhq-sd-907-2020-05-15T06-10-46-978Z",
"description": "TypeScript definition files for GoodData platform",

@@ -5,0 +5,0 @@ "typings": "dist/index.d.ts",

dist/src/embedding/kd.js.map

Sorry, the diff of this file is not supported yet

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc