@gooddata/sdk-pluggable-application-model 11.65.0-alpha.1 → 11.65.0-alpha.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/esm/__version.d.ts.map +1 -1
- package/esm/__version.js +1 -1
- package/esm/hostUi.d.ts +9 -0
- package/esm/hostUi.d.ts.map +1 -1
- package/esm/index.d.ts +1 -1
- package/esm/index.d.ts.map +1 -1
- package/esm/index.js +1 -1
- package/esm/mount.d.ts +82 -1
- package/esm/mount.d.ts.map +1 -1
- package/esm/mount.js +45 -4
- package/esm/sdk-pluggable-application-model.d.ts +96 -0
- package/package.json +4 -4
package/esm/__version.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"__version.d.ts","sourceRoot":"","sources":["../src/__version.ts"],"names":[],"mappings":"AAIA,aAAa;AACb,eAAO,MAAM,WAAW,EAAE,
|
|
1
|
+
{"version":3,"file":"__version.d.ts","sourceRoot":"","sources":["../src/__version.ts"],"names":[],"mappings":"AAIA,aAAa;AACb,eAAO,MAAM,WAAW,EAAE,MAA2B,CAAC;AAEtD,aAAa;AACb,eAAO,MAAM,eAAe,EAAE,MAAkE,CAAC;AAEjG,aAAa;AACb,eAAO,MAAM,QAAQ,EAAE,MAAoD,CAAC"}
|
package/esm/__version.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
// (C) 2026 GoodData Corporation
|
|
2
2
|
// DO NOT CHANGE THIS FILE, IT IS RE-GENERATED ON EVERY BUILD
|
|
3
3
|
/** @alpha */
|
|
4
|
-
export const LIB_VERSION = "11.65.0-alpha.
|
|
4
|
+
export const LIB_VERSION = "11.65.0-alpha.10";
|
|
5
5
|
/** @alpha */
|
|
6
6
|
export const LIB_DESCRIPTION = "GoodData SDK model contracts for pluggable applications";
|
|
7
7
|
/** @alpha */
|
package/esm/hostUi.d.ts
CHANGED
|
@@ -177,6 +177,15 @@ export interface IHostUiMountHandle {
|
|
|
177
177
|
showChatItem: boolean;
|
|
178
178
|
isOpen: boolean;
|
|
179
179
|
}): void;
|
|
180
|
+
/**
|
|
181
|
+
* Opens the host UI's pricing (plan upgrade) dialog.
|
|
182
|
+
*
|
|
183
|
+
* @remarks
|
|
184
|
+
* Called by the host when the active pluggable application emits an
|
|
185
|
+
* {@link IOpenPricingDialogRequestedEvent}. The host UI decides whether the dialog applies
|
|
186
|
+
* (e.g. only for trial organizations). Host UIs without a pricing dialog may omit it or no-op.
|
|
187
|
+
*/
|
|
188
|
+
openPricingDialog?(): void;
|
|
180
189
|
/**
|
|
181
190
|
* Returns the DOM element where the active pluggable application should be rendered.
|
|
182
191
|
*
|
package/esm/hostUi.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"hostUi.d.ts","sourceRoot":"","sources":["../src/hostUi.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,iBAAiB,EAAE,KAAK,gCAAgC,EAAE,MAAM,qBAAqB,CAAC;AAEpG,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,YAAY,CAAC;AACpD,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAE7D;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAChC;;OAEG;IACH,SAAS,EAAE,WAAW,CAAC;IAEvB;;OAEG;IACH,GAAG,EAAE,gBAAgB,CAAC;IAEtB;;OAEG;IACH,oBAAoB,EAAE,gCAAgC,EAAE,CAAC;IAEzD;;;;;;OAMG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;;;;OAOG;IACH,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;IAEhC;;;;;;OAMG;IACH,OAAO,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;IAE/B;;;;;;;;OAQG;IACH,qBAAqB,CAAC,EAAE,MAAM,IAAI,CAAC;IAEnC;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,CACf,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,MAAM,EAChB,WAAW,CAAC,EAAE,iBAAiB,EAC/B,YAAY,CAAC,EAAE,OAAO,EACtB,kBAAkB,CAAC,EAAE,OAAO,KAC3B,IAAI,CAAC;IAEV;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;CACtD;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,yCAAyC;IACtD;;;;OAIG;IACH,IAAI,EAAE,wBAAwB,CAAC;IAC/B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,mBAAmB,GAAG,yCAAyC,CAAC;AAE5E;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IAC/B;;OAEG;IACH,OAAO,IAAI,IAAI,CAAC;IAEhB;;;;;OAKG;IACH,aAAa,CAAC,CAAC,GAAG,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAE5C;;;;;OAKG;IACH,kBAAkB,CAAC,CAAC,IAAI,EAAE,gCAAgC,EAAE,GAAG,IAAI,CAAC;IAEpE;;;;;;OAMG;IACH,cAAc,CAAC,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExC;;;;;;;;OAQG;IACH,YAAY,CAAC,CAAC,MAAM,EAAE,iBAAiB,GAAG,SAAS,GAAG,IAAI,CAAC;IAE3D;;;;;;;;OAQG;IACH,mBAAmB,CAAC,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAAC;IAE1D;;;;;;;;OAQG;IACH,eAAe,CAAC,CAAC,KAAK,EAAE;QAAE,YAAY,EAAE,OAAO,CAAC;QAAC,MAAM,EAAE,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE1E;;;;;;;OAOG;IACH,eAAe,IAAI,WAAW,CAAC;IAE/B;;;;;;OAMG;IACH,MAAM,CAAC,CAAC,YAAY,EAAE,mBAAmB,GAAG,IAAI,CAAC;CACpD;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,EAAE,mBAAmB,KAAK,kBAAkB,CAAC;AAE/E;;;;;;;;;GASG;AACH,MAAM,WAAW,aAAa;IAC1B,KAAK,EAAE,WAAW,CAAC;CACtB"}
|
|
1
|
+
{"version":3,"file":"hostUi.d.ts","sourceRoot":"","sources":["../src/hostUi.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,iBAAiB,EAAE,KAAK,gCAAgC,EAAE,MAAM,qBAAqB,CAAC;AAEpG,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,YAAY,CAAC;AACpD,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAE7D;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAChC;;OAEG;IACH,SAAS,EAAE,WAAW,CAAC;IAEvB;;OAEG;IACH,GAAG,EAAE,gBAAgB,CAAC;IAEtB;;OAEG;IACH,oBAAoB,EAAE,gCAAgC,EAAE,CAAC;IAEzD;;;;;;OAMG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;;;;OAOG;IACH,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;IAEhC;;;;;;OAMG;IACH,OAAO,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;IAE/B;;;;;;;;OAQG;IACH,qBAAqB,CAAC,EAAE,MAAM,IAAI,CAAC;IAEnC;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,CACf,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,MAAM,EAChB,WAAW,CAAC,EAAE,iBAAiB,EAC/B,YAAY,CAAC,EAAE,OAAO,EACtB,kBAAkB,CAAC,EAAE,OAAO,KAC3B,IAAI,CAAC;IAEV;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;CACtD;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,yCAAyC;IACtD;;;;OAIG;IACH,IAAI,EAAE,wBAAwB,CAAC;IAC/B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,mBAAmB,GAAG,yCAAyC,CAAC;AAE5E;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IAC/B;;OAEG;IACH,OAAO,IAAI,IAAI,CAAC;IAEhB;;;;;OAKG;IACH,aAAa,CAAC,CAAC,GAAG,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAE5C;;;;;OAKG;IACH,kBAAkB,CAAC,CAAC,IAAI,EAAE,gCAAgC,EAAE,GAAG,IAAI,CAAC;IAEpE;;;;;;OAMG;IACH,cAAc,CAAC,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExC;;;;;;;;OAQG;IACH,YAAY,CAAC,CAAC,MAAM,EAAE,iBAAiB,GAAG,SAAS,GAAG,IAAI,CAAC;IAE3D;;;;;;;;OAQG;IACH,mBAAmB,CAAC,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAAC;IAE1D;;;;;;;;OAQG;IACH,eAAe,CAAC,CAAC,KAAK,EAAE;QAAE,YAAY,EAAE,OAAO,CAAC;QAAC,MAAM,EAAE,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE1E;;;;;;;OAOG;IACH,iBAAiB,CAAC,IAAI,IAAI,CAAC;IAE3B;;;;;;;OAOG;IACH,eAAe,IAAI,WAAW,CAAC;IAE/B;;;;;;OAMG;IACH,MAAM,CAAC,CAAC,YAAY,EAAE,mBAAmB,GAAG,IAAI,CAAC;CACpD;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,EAAE,mBAAmB,KAAK,kBAAkB,CAAC;AAE/E;;;;;;;;;GASG;AACH,MAAM,WAAW,aAAa;IAC1B,KAAK,EAAE,WAAW,CAAC;CACtB"}
|
package/esm/index.d.ts
CHANGED
|
@@ -7,7 +7,7 @@ export { DefaultApplicationId } from "./defaultPlatformApplications.js";
|
|
|
7
7
|
export { LIB_VERSION, LIB_DESCRIPTION, LIB_NAME } from "./__version.js";
|
|
8
8
|
export { type EmbeddingMode, type IApiTokenAuthCredentials, type IAuthCredentials, type IContextDeferredAuthCredentials, type IEffectiveSettings, type IJwtAuthCredentials, type IOrganization, type IOrganizationPermissions, type IPlatformContext, type IPlatformContextV1, type IPluggableApplicationNavigation, PantherTier, isPlatformContextV1, isWorkspaceScopedSettings, } from "./platformContext.js";
|
|
9
9
|
export { type ILocale } from "@gooddata/sdk-model";
|
|
10
|
-
export { type IAppHeaderOptions, type IAppInstance, type KnownPluggableAppEventTypeName, type IDocumentTitleChangedEvent, type IOpenAiAssistantRequestedEvent, type ICloseAiAssistantRequestedEvent, type IAiAssistantContextChangedEvent, type IAiAssistantPublisherDocumentSavedEvent, type IHostNavigationRequest, type IPluggableApp, type IPluggableApplicationMountHandle, type IPluggableApplicationMountOptions, type IPluggableAppEvent, type IPluggableAppLogRecord, type IPluggableAppTelemetryCallbacks, type IPluggableAppTelemetryEventData, type IReloadPlatformContextRequestedEvent, type ITelemetryEventOptions, documentTitleChanged, isDocumentTitleChangedEvent, isOpenAiAssistantRequestedEvent, isCloseAiAssistantRequestedEvent, isAiAssistantContextChangedEvent, isAiAssistantPublisherDocumentSavedEvent, type IAiAssistantPublisherDocumentDefinition, isAiAssistantPublisherDocumentDefinition, isReloadPlatformContextRequestedEvent, openAiAssistantRequested, closeAiAssistantRequested, aiAssistantContextChanged, aiAssistantPublisherDocumentSaved, aiAssistantDashboardSaved, isAiAssistantDashboardSavedEvent, type IAiAssistantDashboardSavedEvent, type PluggableApplicationMount, PluggableAppEventType, type PluggableAppEventTypeName, reloadPlatformContextRequested, type TelemetryChannel, } from "./mount.js";
|
|
10
|
+
export { type IAppHeaderOptions, type IAppInstance, type KnownPluggableAppEventTypeName, type IDocumentTitleChangedEvent, type IOpenAiAssistantRequestedEvent, type ICloseAiAssistantRequestedEvent, type IOpenPricingDialogRequestedEvent, type IAiAssistantContextChangedEvent, type IAiAssistantPublisherDocumentSavedEvent, type IHostNavigationRequest, type IPluggableApp, type IPluggableApplicationMountHandle, type IPluggableApplicationMountOptions, type IPluggableAppEvent, type IPluggableAppLogRecord, type IPluggableAppTelemetryCallbacks, type IPluggableAppTelemetryEventData, type IReloadPlatformContextRequestedEvent, type ITelemetryEventOptions, documentTitleChanged, isDocumentTitleChangedEvent, isOpenAiAssistantRequestedEvent, isCloseAiAssistantRequestedEvent, isOpenPricingDialogRequestedEvent, isAiAssistantContextChangedEvent, isAiAssistantPublisherDocumentSavedEvent, type IAiAssistantPublisherDocumentDefinition, isAiAssistantPublisherDocumentDefinition, type IAiAssistantPublisherDocumentDefinitionV2, isAiAssistantPublisherDocumentDefinitionV2, isReloadPlatformContextRequestedEvent, openAiAssistantRequested, closeAiAssistantRequested, openPricingDialogRequested, aiAssistantContextChanged, aiAssistantPublisherDocumentSaved, aiAssistantDashboardSaved, isAiAssistantDashboardSavedEvent, type IAiAssistantDashboardSavedEvent, type PluggableApplicationMount, PluggableAppEventType, type PluggableAppEventTypeName, reloadPlatformContextRequested, type TelemetryChannel, } from "./mount.js";
|
|
11
11
|
export { type ITelemetryPropertySlot, type TelemetryPropertyScope, TELEMETRY_PROPERTIES, } from "./telemetry/telemetryProperties.js";
|
|
12
12
|
export { type IHostUiModule, type IHostUiMountHandle, type IHostUiMountOptions, type IHostUiNotification, type INewDeploymentAvailableHostUiNotification, type HostUiMount, } from "./hostUi.js";
|
|
13
13
|
//# sourceMappingURL=index.d.ts.map
|
package/esm/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA;;;;GAIG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AAExE,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAExE,OAAO,EACH,KAAK,aAAa,EAClB,KAAK,wBAAwB,EAC7B,KAAK,gBAAgB,EACrB,KAAK,+BAA+B,EACpC,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,EACxB,KAAK,aAAa,EAClB,KAAK,wBAAwB,EAC7B,KAAK,gBAAgB,EACrB,KAAK,kBAAkB,EACvB,KAAK,+BAA+B,EACpC,WAAW,EACX,mBAAmB,EACnB,yBAAyB,GAC5B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAEnD,OAAO,EACH,KAAK,iBAAiB,EACtB,KAAK,YAAY,EACjB,KAAK,8BAA8B,EACnC,KAAK,0BAA0B,EAC/B,KAAK,8BAA8B,EACnC,KAAK,+BAA+B,EACpC,KAAK,+BAA+B,EACpC,KAAK,uCAAuC,EAC5C,KAAK,sBAAsB,EAC3B,KAAK,aAAa,EAClB,KAAK,gCAAgC,EACrC,KAAK,iCAAiC,EACtC,KAAK,kBAAkB,EACvB,KAAK,sBAAsB,EAC3B,KAAK,+BAA+B,EACpC,KAAK,+BAA+B,EACpC,KAAK,oCAAoC,EACzC,KAAK,sBAAsB,EAC3B,oBAAoB,EACpB,2BAA2B,EAC3B,+BAA+B,EAC/B,gCAAgC,EAChC,gCAAgC,EAChC,wCAAwC,EACxC,KAAK,uCAAuC,EAC5C,wCAAwC,EACxC,qCAAqC,EACrC,wBAAwB,EACxB,yBAAyB,EACzB,yBAAyB,EACzB,iCAAiC,EACjC,yBAAyB,EACzB,gCAAgC,EAChC,KAAK,+BAA+B,EACpC,KAAK,yBAAyB,EAC9B,qBAAqB,EACrB,KAAK,yBAAyB,EAC9B,8BAA8B,EAC9B,KAAK,gBAAgB,GACxB,MAAM,YAAY,CAAC;AAEpB,OAAO,EACH,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,EAC3B,oBAAoB,GACvB,MAAM,oCAAoC,CAAC;AAE5C,OAAO,EACH,KAAK,aAAa,EAClB,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACxB,KAAK,yCAAyC,EAC9C,KAAK,WAAW,GACnB,MAAM,aAAa,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA;;;;GAIG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AAExE,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAExE,OAAO,EACH,KAAK,aAAa,EAClB,KAAK,wBAAwB,EAC7B,KAAK,gBAAgB,EACrB,KAAK,+BAA+B,EACpC,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,EACxB,KAAK,aAAa,EAClB,KAAK,wBAAwB,EAC7B,KAAK,gBAAgB,EACrB,KAAK,kBAAkB,EACvB,KAAK,+BAA+B,EACpC,WAAW,EACX,mBAAmB,EACnB,yBAAyB,GAC5B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAEnD,OAAO,EACH,KAAK,iBAAiB,EACtB,KAAK,YAAY,EACjB,KAAK,8BAA8B,EACnC,KAAK,0BAA0B,EAC/B,KAAK,8BAA8B,EACnC,KAAK,+BAA+B,EACpC,KAAK,gCAAgC,EACrC,KAAK,+BAA+B,EACpC,KAAK,uCAAuC,EAC5C,KAAK,sBAAsB,EAC3B,KAAK,aAAa,EAClB,KAAK,gCAAgC,EACrC,KAAK,iCAAiC,EACtC,KAAK,kBAAkB,EACvB,KAAK,sBAAsB,EAC3B,KAAK,+BAA+B,EACpC,KAAK,+BAA+B,EACpC,KAAK,oCAAoC,EACzC,KAAK,sBAAsB,EAC3B,oBAAoB,EACpB,2BAA2B,EAC3B,+BAA+B,EAC/B,gCAAgC,EAChC,iCAAiC,EACjC,gCAAgC,EAChC,wCAAwC,EACxC,KAAK,uCAAuC,EAC5C,wCAAwC,EACxC,KAAK,yCAAyC,EAC9C,0CAA0C,EAC1C,qCAAqC,EACrC,wBAAwB,EACxB,yBAAyB,EACzB,0BAA0B,EAC1B,yBAAyB,EACzB,iCAAiC,EACjC,yBAAyB,EACzB,gCAAgC,EAChC,KAAK,+BAA+B,EACpC,KAAK,yBAAyB,EAC9B,qBAAqB,EACrB,KAAK,yBAAyB,EAC9B,8BAA8B,EAC9B,KAAK,gBAAgB,GACxB,MAAM,YAAY,CAAC;AAEpB,OAAO,EACH,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,EAC3B,oBAAoB,GACvB,MAAM,oCAAoC,CAAC;AAE5C,OAAO,EACH,KAAK,aAAa,EAClB,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACxB,KAAK,yCAAyC,EAC9C,KAAK,WAAW,GACnB,MAAM,aAAa,CAAC"}
|
package/esm/index.js
CHANGED
|
@@ -8,5 +8,5 @@
|
|
|
8
8
|
export { DefaultApplicationId } from "./defaultPlatformApplications.js";
|
|
9
9
|
export { LIB_VERSION, LIB_DESCRIPTION, LIB_NAME } from "./__version.js";
|
|
10
10
|
export { PantherTier, isPlatformContextV1, isWorkspaceScopedSettings, } from "./platformContext.js";
|
|
11
|
-
export { documentTitleChanged, isDocumentTitleChangedEvent, isOpenAiAssistantRequestedEvent, isCloseAiAssistantRequestedEvent, isAiAssistantContextChangedEvent, isAiAssistantPublisherDocumentSavedEvent, isAiAssistantPublisherDocumentDefinition, isReloadPlatformContextRequestedEvent, openAiAssistantRequested, closeAiAssistantRequested, aiAssistantContextChanged, aiAssistantPublisherDocumentSaved, aiAssistantDashboardSaved, isAiAssistantDashboardSavedEvent, PluggableAppEventType, reloadPlatformContextRequested, } from "./mount.js";
|
|
11
|
+
export { documentTitleChanged, isDocumentTitleChangedEvent, isOpenAiAssistantRequestedEvent, isCloseAiAssistantRequestedEvent, isOpenPricingDialogRequestedEvent, isAiAssistantContextChangedEvent, isAiAssistantPublisherDocumentSavedEvent, isAiAssistantPublisherDocumentDefinition, isAiAssistantPublisherDocumentDefinitionV2, isReloadPlatformContextRequestedEvent, openAiAssistantRequested, closeAiAssistantRequested, openPricingDialogRequested, aiAssistantContextChanged, aiAssistantPublisherDocumentSaved, aiAssistantDashboardSaved, isAiAssistantDashboardSavedEvent, PluggableAppEventType, reloadPlatformContextRequested, } from "./mount.js";
|
|
12
12
|
export { TELEMETRY_PROPERTIES, } from "./telemetry/telemetryProperties.js";
|
package/esm/mount.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { type GenAIChatEffort, type IGenAIUserContext, type IPublisherDocumentDefinition } from "@gooddata/sdk-model";
|
|
1
|
+
import { type GenAIChatEffort, type IGenAIUserContext, type IPublisherDocumentDefinition, type IPublisherDocumentDefinitionV2 } from "@gooddata/sdk-model";
|
|
2
2
|
import { type IPlatformContext } from "./platformContext.js";
|
|
3
3
|
/**
|
|
4
4
|
* Known generic pluggable application event types.
|
|
@@ -13,6 +13,7 @@ export declare const PluggableAppEventType: {
|
|
|
13
13
|
readonly AI_ASSISTANT_CONTEXT_CHANGED: "GDC.PLUGGABLE_APP/EVT.AI_ASSISTANT.CONTEXT_CHANGED";
|
|
14
14
|
readonly AI_ASSISTANT_PUBLISHER_DOCUMENT_SAVED: "GDC.PLUGGABLE_APP/EVT.AI_ASSISTANT.PUBLISHER_DOCUMENT_SAVED";
|
|
15
15
|
readonly AI_ASSISTANT_DASHBOARD_SAVED: "GDC.PLUGGABLE_APP/EVT.AI_ASSISTANT.DASHBOARD_SAVED";
|
|
16
|
+
readonly PRICING_DIALOG_OPEN_REQUESTED: "GDC.PLUGGABLE_APP/EVT.PRICING_DIALOG.OPEN_REQUESTED";
|
|
16
17
|
};
|
|
17
18
|
/**
|
|
18
19
|
* Union of known pluggable application event type names.
|
|
@@ -139,6 +140,11 @@ export interface IOpenAiAssistantRequestedEvent extends IPluggableAppEvent {
|
|
|
139
140
|
* Ignored when the question is appended to the existing chat.
|
|
140
141
|
*/
|
|
141
142
|
readonly effort?: GenAIChatEffort;
|
|
143
|
+
/**
|
|
144
|
+
* Existing conversation to select when opening the chat. When provided, takes precedence over
|
|
145
|
+
* the seeded question and user context. When omitted, the current open/ask behavior is preserved.
|
|
146
|
+
*/
|
|
147
|
+
readonly conversationId?: string;
|
|
142
148
|
};
|
|
143
149
|
}
|
|
144
150
|
/**
|
|
@@ -153,6 +159,7 @@ export declare function openAiAssistantRequested(payload?: {
|
|
|
153
159
|
appendToChat?: boolean;
|
|
154
160
|
replaceUserContext?: boolean;
|
|
155
161
|
effort?: GenAIChatEffort;
|
|
162
|
+
conversationId?: string;
|
|
156
163
|
}): IOpenAiAssistantRequestedEvent;
|
|
157
164
|
/**
|
|
158
165
|
* Type guard for {@link IOpenAiAssistantRequestedEvent}.
|
|
@@ -190,6 +197,31 @@ export declare function closeAiAssistantRequested(): ICloseAiAssistantRequestedE
|
|
|
190
197
|
* @alpha
|
|
191
198
|
*/
|
|
192
199
|
export declare function isCloseAiAssistantRequestedEvent(obj: unknown): obj is ICloseAiAssistantRequestedEvent;
|
|
200
|
+
/**
|
|
201
|
+
* Event requesting the host to open its pricing (plan upgrade) dialog.
|
|
202
|
+
*
|
|
203
|
+
* @remarks
|
|
204
|
+
* A pluggable application emits this from an in-content upsell control (e.g. an "Upgrade" button).
|
|
205
|
+
* The pricing dialog is owned by the host UI. The default host UI opens it only for trial
|
|
206
|
+
* organizations; outside a trial, or with a host UI that has no pricing dialog, the event is a no-op.
|
|
207
|
+
*
|
|
208
|
+
* @alpha
|
|
209
|
+
*/
|
|
210
|
+
export interface IOpenPricingDialogRequestedEvent extends IPluggableAppEvent {
|
|
211
|
+
readonly type: "GDC.PLUGGABLE_APP/EVT.PRICING_DIALOG.OPEN_REQUESTED";
|
|
212
|
+
}
|
|
213
|
+
/**
|
|
214
|
+
* Creates an {@link IOpenPricingDialogRequestedEvent}.
|
|
215
|
+
*
|
|
216
|
+
* @alpha
|
|
217
|
+
*/
|
|
218
|
+
export declare function openPricingDialogRequested(): IOpenPricingDialogRequestedEvent;
|
|
219
|
+
/**
|
|
220
|
+
* Type guard for {@link IOpenPricingDialogRequestedEvent}.
|
|
221
|
+
*
|
|
222
|
+
* @alpha
|
|
223
|
+
*/
|
|
224
|
+
export declare function isOpenPricingDialogRequestedEvent(obj: unknown): obj is IOpenPricingDialogRequestedEvent;
|
|
193
225
|
/**
|
|
194
226
|
* Event informing the host of the active application's current AI-assistant tag scope.
|
|
195
227
|
*
|
|
@@ -294,6 +326,11 @@ export interface IAiAssistantPublisherDocumentSavedEvent extends IPluggableAppEv
|
|
|
294
326
|
* Identifier of the document the draft was saved as.
|
|
295
327
|
*/
|
|
296
328
|
readonly savedDocumentId: string;
|
|
329
|
+
/**
|
|
330
|
+
* Publisher content version of the saved draft, which decides where the conversation records the
|
|
331
|
+
* save. Omitted by applications that predate it.
|
|
332
|
+
*/
|
|
333
|
+
readonly format?: "aac-v1" | "aac-v2";
|
|
297
334
|
};
|
|
298
335
|
}
|
|
299
336
|
/**
|
|
@@ -355,6 +392,50 @@ export interface IAiAssistantPublisherDocumentDefinition {
|
|
|
355
392
|
export declare function isAiAssistantPublisherDocumentDefinition(obj: unknown): obj is Omit<IAiAssistantPublisherDocumentDefinition, "publisherDocument"> & {
|
|
356
393
|
readonly publisherDocument: unknown;
|
|
357
394
|
};
|
|
395
|
+
/**
|
|
396
|
+
* A document version of Publisher content v2 the host assistant drafted, carried by the
|
|
397
|
+
* `chat.definition-received` event an application receives through
|
|
398
|
+
* {@link IPluggableApplicationMountHandle.onAiAssistantEventReceive}.
|
|
399
|
+
*
|
|
400
|
+
* @remarks
|
|
401
|
+
* The document is in `publisherDocumentV2`, not `publisherDocument`, so one event can type both
|
|
402
|
+
* versions' fields.
|
|
403
|
+
*
|
|
404
|
+
* @alpha
|
|
405
|
+
*/
|
|
406
|
+
export interface IAiAssistantPublisherDocumentDefinitionV2 {
|
|
407
|
+
/**
|
|
408
|
+
* The whole document version.
|
|
409
|
+
*/
|
|
410
|
+
readonly publisherDocumentV2: IPublisherDocumentDefinitionV2;
|
|
411
|
+
/**
|
|
412
|
+
* Name of the document version in the conversation, the one its save is recorded under.
|
|
413
|
+
*/
|
|
414
|
+
readonly documentRef?: string;
|
|
415
|
+
/**
|
|
416
|
+
* Name of the document version this one reworks.
|
|
417
|
+
*/
|
|
418
|
+
readonly refines?: string;
|
|
419
|
+
/**
|
|
420
|
+
* Whether the version was written from the document open in the editor.
|
|
421
|
+
*/
|
|
422
|
+
readonly reworksOpenDocument?: boolean;
|
|
423
|
+
/**
|
|
424
|
+
* Identifier of the saved document this version edits.
|
|
425
|
+
*/
|
|
426
|
+
readonly baseDocumentId?: string;
|
|
427
|
+
}
|
|
428
|
+
/**
|
|
429
|
+
* Type guard for the fields of {@link IAiAssistantPublisherDocumentDefinitionV2}.
|
|
430
|
+
*
|
|
431
|
+
* @remarks
|
|
432
|
+
* The document itself stays `unknown`: whoever applies it validates it.
|
|
433
|
+
*
|
|
434
|
+
* @alpha
|
|
435
|
+
*/
|
|
436
|
+
export declare function isAiAssistantPublisherDocumentDefinitionV2(obj: unknown): obj is Omit<IAiAssistantPublisherDocumentDefinitionV2, "publisherDocumentV2"> & {
|
|
437
|
+
readonly publisherDocumentV2: unknown;
|
|
438
|
+
};
|
|
358
439
|
/**
|
|
359
440
|
* Event telling the host assistant that a dashboard and its draft insights were saved.
|
|
360
441
|
*
|
package/esm/mount.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"mount.d.ts","sourceRoot":"","sources":["../src/mount.ts"],"names":[],"mappings":"AAEA,OAAO,EACH,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACtB,KAAK,4BAA4B,
|
|
1
|
+
{"version":3,"file":"mount.d.ts","sourceRoot":"","sources":["../src/mount.ts"],"names":[],"mappings":"AAEA,OAAO,EACH,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACtB,KAAK,4BAA4B,EACjC,KAAK,8BAA8B,EACtC,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAE7D;;;;GAIG;AACH,eAAO,MAAM,qBAAqB;aAC9B,iCAAiC,EAAE,yDAAyD;aAC5F,sBAAsB,EAAE,8CAA8C;aACtE,2BAA2B,EAAE,mDAAmD;aAChF,4BAA4B,EAAE,oDAAoD;aAClF,4BAA4B,EAAE,oDAAoD;aAClF,qCAAqC,EAAE,6DAA6D;aACpG,4BAA4B,EAAE,oDAAoD;aAClF,6BAA6B,EAAE,qDAAqD;CAC9E,CAAC;AAEX;;;;GAIG;AACH,MAAM,MAAM,8BAA8B,GACtC,CAAC,OAAO,qBAAqB,CAAC,CAAC,MAAM,OAAO,qBAAqB,CAAC,CAAC;AAEvE;;;;;;;;;GASG;AACH,MAAM,MAAM,yBAAyB,GAAG,8BAA8B,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;AAEvF;;;;;;;;;GASG;AACH,MAAM,WAAW,kBAAkB;IAC/B,QAAQ,CAAC,IAAI,EAAE,yBAAyB,CAAC;IACzC,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,oCAAqC,SAAQ,kBAAkB;IAC5E,QAAQ,CAAC,IAAI,EAAE,yDAAyD,CAAC;CAC5E;AAED;;;;GAIG;AACH,wBAAgB,8BAA8B,IAAI,oCAAoC,CAErF;AAED;;;;GAIG;AACH,wBAAgB,qCAAqC,CACjD,GAAG,EAAE,OAAO,GACb,GAAG,IAAI,oCAAoC,CAO7C;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,0BAA2B,SAAQ,kBAAkB;IAClE,QAAQ,CAAC,IAAI,EAAE,8CAA8C,CAAC;IAC9D,QAAQ,CAAC,OAAO,EAAE;QACd,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;KAC1C,CAAC;CACL;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,GAAG,0BAA0B,CAE9F;AAED;;;;;;;;;GASG;AACH,wBAAgB,2BAA2B,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,0BAA0B,CAc3F;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,8BAA+B,SAAQ,kBAAkB;IACtE,QAAQ,CAAC,IAAI,EAAE,mDAAmD,CAAC;IACnE,QAAQ,CAAC,OAAO,EAAE;QACd;;WAEG;QACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAC3B;;WAEG;QACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAC1B;;;WAGG;QACH,QAAQ,CAAC,WAAW,CAAC,EAAE,iBAAiB,CAAC;QACzC;;WAEG;QACH,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC;QAChC;;WAEG;QACH,QAAQ,CAAC,kBAAkB,CAAC,EAAE,OAAO,CAAC;QACtC;;;WAGG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE,eAAe,CAAC;QAClC;;;WAGG;QACH,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;KACpC,CAAC;CACL;AAED;;;;GAIG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,CAAC,EAAE;IAC/C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,iBAAiB,CAAC;IAChC,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB,cAAc,CAAC,EAAE,MAAM,CAAC;CAC3B,GAAG,8BAA8B,CAEjC;AAED;;;;;;;;;GASG;AACH,wBAAgB,+BAA+B,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,8BAA8B,CAwBnG;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,+BAAgC,SAAQ,kBAAkB;IACvE,QAAQ,CAAC,IAAI,EAAE,oDAAoD,CAAC;CACvE;AAED;;;;GAIG;AACH,wBAAgB,yBAAyB,IAAI,+BAA+B,CAE3E;AAED;;;;GAIG;AACH,wBAAgB,gCAAgC,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,+BAA+B,CAKrG;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,gCAAiC,SAAQ,kBAAkB;IACxE,QAAQ,CAAC,IAAI,EAAE,qDAAqD,CAAC;CACxE;AAED;;;;GAIG;AACH,wBAAgB,0BAA0B,IAAI,gCAAgC,CAE7E;AAED;;;;GAIG;AACH,wBAAgB,iCAAiC,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,gCAAgC,CAKvG;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,+BAAgC,SAAQ,kBAAkB;IACvE,QAAQ,CAAC,IAAI,EAAE,oDAAoD,CAAC;IACpE,QAAQ,CAAC,OAAO,EAAE;QACd;;;WAGG;QACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;QAChC;;;WAGG;QACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;QAChC;;;WAGG;QACH,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;QAC3C;;;WAGG;QACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;QAC5B;;;WAGG;QACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;QAC5B;;;;;WAKG;QACH,QAAQ,CAAC,WAAW,CAAC,EAAE,iBAAiB,CAAC;QACzC;;WAEG;QACH,QAAQ,CAAC,kBAAkB,CAAC,EAAE,OAAO,CAAC;KACzC,CAAC;CACL;AAED;;;;GAIG;AACH,wBAAgB,yBAAyB,CAAC,OAAO,CAAC,EAAE;IAChD,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,cAAc,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAClC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,WAAW,CAAC,EAAE,iBAAiB,CAAC;IAChC,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAChC,GAAG,+BAA+B,CAElC;AAED;;;;GAIG;AACH,wBAAgB,gCAAgC,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,+BAA+B,CAiCrG;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,uCAAwC,SAAQ,kBAAkB;IAC/E,QAAQ,CAAC,IAAI,EAAE,6DAA6D,CAAC;IAC7E,QAAQ,CAAC,OAAO,EAAE;QACd;;WAEG;QACH,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;QAChC;;WAEG;QACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;QACxB;;;WAGG;QACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;QAC9B;;WAEG;QACH,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;QACjC;;;WAGG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;KACzC,CAAC;CACL;AAED;;;;GAIG;AACH,wBAAgB,iCAAiC,CAC7C,OAAO,EAAE,uCAAuC,CAAC,SAAS,CAAC,GAC5D,uCAAuC,CAEzC;AAED;;;;;;;;GAQG;AACH,wBAAgB,wCAAwC,CACpD,GAAG,EAAE,OAAO,GACb,GAAG,IAAI,uCAAuC,CA0BhD;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,uCAAuC;IACpD;;OAEG;IACH,QAAQ,CAAC,iBAAiB,EAAE,4BAA4B,CAAC;IAEzD;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAEvC;;OAEG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;CACpC;AAED;;;;;;;GAOG;AACH,wBAAgB,wCAAwC,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,IAAI,CAC/E,uCAAuC,EACvC,mBAAmB,CACtB,GAAG;IACA,QAAQ,CAAC,iBAAiB,EAAE,OAAO,CAAC;CACvC,CAgBA;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,yCAAyC;IACtD;;OAEG;IACH,QAAQ,CAAC,mBAAmB,EAAE,8BAA8B,CAAC;IAE7D;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAEvC;;OAEG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;CACpC;AAED;;;;;;;GAOG;AACH,wBAAgB,0CAA0C,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,IAAI,CACjF,yCAAyC,EACzC,qBAAqB,CACxB,GAAG;IACA,QAAQ,CAAC,mBAAmB,EAAE,OAAO,CAAC;CACzC,CAgBA;AAED;;;;GAIG;AACH,MAAM,WAAW,+BAAgC,SAAQ,kBAAkB;IACvE,QAAQ,CAAC,IAAI,EAAE,oDAAoD,CAAC;IACpE,QAAQ,CAAC,OAAO,EAAE;QACd,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;QAChC,QAAQ,CAAC,mBAAmB,EAAE,MAAM,CAAC;QACrC,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;QAClC,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAC;YAClC,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;YACnC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;SACnC,CAAC,CAAC;KACN,CAAC;CACL;AAED;;;;GAIG;AACH,wBAAgB,yBAAyB,CACrC,OAAO,EAAE,+BAA+B,CAAC,SAAS,CAAC,GACpD,+BAA+B,CAEjC;AAED;;;;GAIG;AACH,wBAAgB,gCAAgC,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,+BAA+B,CA+BrG;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,gBAAgB,GAAG,UAAU,GAAG,IAAI,CAAC;AAEjD;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACnC;;;;OAIG;IACH,OAAO,CAAC,EAAE,gBAAgB,CAAC;CAC9B;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,sBAAsB;IACnC,+EAA+E;IAC/E,IAAI,EAAE,MAAM,CAAC;IACb,wEAAwE;IACxE,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,4EAA4E;IAC5E,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,8FAA8F;IAC9F,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACxC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,+BAA+B;IAC5C,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IACvB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACrC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;CACrD;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,+BAA+B;IAC5C;;;;;;OAMG;IACH,UAAU,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,sBAAsB,KAAK,IAAI,CAAC;IAC1G;;;;;;OAMG;IACH,aAAa,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,+BAA+B,KAAK,IAAI,CAAC;IAC9E;;;;;;;;OAQG;IACH,WAAW,EAAE,CACT,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,MAAM,EACf,IAAI,CAAC,EAAE,+BAA+B,KACrC,IAAI,CAAC;IACV;;;;;;;;;OASG;IACH,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,sBAAsB,KAAK,IAAI,CAAC;CACxD;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,iBAAiB;IAC9B;;;;;;;;OAQG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC;QAClB,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC,CAAC;CACN;AAED;;;;GAIG;AACH,MAAM,WAAW,iCAAiC;IAC9C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,WAAW,CAAC;IAEvB;;OAEG;IACH,GAAG,EAAE,gBAAgB,CAAC;IAEtB;;;;;OAKG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE,kBAAkB,KAAK,IAAI,CAAC;IAE1C;;;;;;;;OAQG;IACH,gBAAgB,CAAC,EAAE,+BAA+B,CAAC;IAEnD;;;;;;;;;;OAUG;IACH,cAAc,CAAC,EAAE,CAAC,MAAM,EAAE,iBAAiB,KAAK,IAAI,CAAC;CACxD;AAED;;;;;GAKG;AACH,MAAM,WAAW,sBAAsB;IACnC;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IAErB;;;;;;OAMG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,IAAI,CAAC;CAChC;AAED;;;;GAIG;AACH,MAAM,WAAW,gCAAgC;IAC7C;;OAEG;IACH,OAAO,IAAI,IAAI,CAAC;IAEhB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,CAAC,GAAG,EAAE,gBAAgB,KAAK,IAAI,CAAC;IAEhD;;;;;;;;;;;;;;;;OAgBG;IACH,yBAAyB,CAAC,EAAE,CAAC,OAAO,EAAE,sBAAsB,KAAK,OAAO,CAAC;IAEzE;;;;;;;;;OASG;IACH,kBAAkB,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,CAAC;IAE7C;;;;;;;;;;OAUG;IACH,wBAAwB,CAAC,EAAE,CAAC,IAAI,EAAE;QAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,MAAM,CAAC,EAAE,OAAO,CAAC;KACpB,KAAK,OAAO,CAAC;IAEd;;;;;;;;;;OAUG;IACH,yBAAyB,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,KAAK,IAAI,CAAC;CACnG;AAED;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAAG,CACpC,OAAO,EAAE,iCAAiC,KACzC,gCAAgC,CAAC;AAEtC;;;;GAIG;AACH,MAAM,WAAW,YAAa,SAAQ,gCAAgC;IAClE,EAAE,EAAE,MAAM,CAAC;CACd;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC1B,KAAK,EAAE,yBAAyB,CAAC;IAEjC;;;;;;;;;;;OAWG;IACH,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhC;;;;;;;;;;OAUG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CAC3B"}
|
package/esm/mount.js
CHANGED
|
@@ -12,6 +12,7 @@ export const PluggableAppEventType = {
|
|
|
12
12
|
AI_ASSISTANT_CONTEXT_CHANGED: "GDC.PLUGGABLE_APP/EVT.AI_ASSISTANT.CONTEXT_CHANGED",
|
|
13
13
|
AI_ASSISTANT_PUBLISHER_DOCUMENT_SAVED: "GDC.PLUGGABLE_APP/EVT.AI_ASSISTANT.PUBLISHER_DOCUMENT_SAVED",
|
|
14
14
|
AI_ASSISTANT_DASHBOARD_SAVED: "GDC.PLUGGABLE_APP/EVT.AI_ASSISTANT.DASHBOARD_SAVED",
|
|
15
|
+
PRICING_DIALOG_OPEN_REQUESTED: "GDC.PLUGGABLE_APP/EVT.PRICING_DIALOG.OPEN_REQUESTED",
|
|
15
16
|
};
|
|
16
17
|
/**
|
|
17
18
|
* Creates an {@link IReloadPlatformContextRequestedEvent}.
|
|
@@ -91,12 +92,13 @@ export function isOpenAiAssistantRequestedEvent(obj) {
|
|
|
91
92
|
if (typeof payload !== "object" || payload === null || Array.isArray(payload)) {
|
|
92
93
|
return false;
|
|
93
94
|
}
|
|
94
|
-
const { question, userContext } = payload;
|
|
95
|
+
const { question, userContext, conversationId } = payload;
|
|
95
96
|
const questionOk = typeof question === "string" || question === undefined;
|
|
97
|
+
const conversationIdOk = typeof conversationId === "string" || conversationId === undefined;
|
|
96
98
|
// userContext is an opaque structured object; validate only that it is an object when present
|
|
97
99
|
// so a later property read on the host side cannot throw.
|
|
98
100
|
const userContextOk = userContext === undefined || (typeof userContext === "object" && userContext !== null);
|
|
99
|
-
return questionOk && userContextOk;
|
|
101
|
+
return questionOk && userContextOk && conversationIdOk;
|
|
100
102
|
}
|
|
101
103
|
/**
|
|
102
104
|
* Creates an {@link ICloseAiAssistantRequestedEvent}.
|
|
@@ -115,6 +117,23 @@ export function isCloseAiAssistantRequestedEvent(obj) {
|
|
|
115
117
|
return (typeof obj === "object" &&
|
|
116
118
|
obj?.type === PluggableAppEventType.AI_ASSISTANT_CLOSE_REQUESTED);
|
|
117
119
|
}
|
|
120
|
+
/**
|
|
121
|
+
* Creates an {@link IOpenPricingDialogRequestedEvent}.
|
|
122
|
+
*
|
|
123
|
+
* @alpha
|
|
124
|
+
*/
|
|
125
|
+
export function openPricingDialogRequested() {
|
|
126
|
+
return { type: PluggableAppEventType.PRICING_DIALOG_OPEN_REQUESTED };
|
|
127
|
+
}
|
|
128
|
+
/**
|
|
129
|
+
* Type guard for {@link IOpenPricingDialogRequestedEvent}.
|
|
130
|
+
*
|
|
131
|
+
* @alpha
|
|
132
|
+
*/
|
|
133
|
+
export function isOpenPricingDialogRequestedEvent(obj) {
|
|
134
|
+
return (typeof obj === "object" &&
|
|
135
|
+
obj?.type === PluggableAppEventType.PRICING_DIALOG_OPEN_REQUESTED);
|
|
136
|
+
}
|
|
118
137
|
/**
|
|
119
138
|
* Creates an {@link IAiAssistantContextChangedEvent}.
|
|
120
139
|
*
|
|
@@ -177,11 +196,12 @@ export function isAiAssistantPublisherDocumentSavedEvent(obj) {
|
|
|
177
196
|
if (typeof payload !== "object" || payload === null || Array.isArray(payload)) {
|
|
178
197
|
return false;
|
|
179
198
|
}
|
|
180
|
-
const { conversationId, itemId, documentRef, savedDocumentId } = payload;
|
|
199
|
+
const { conversationId, itemId, documentRef, savedDocumentId, format } = payload;
|
|
181
200
|
return (typeof conversationId === "string" &&
|
|
182
201
|
typeof itemId === "string" &&
|
|
183
202
|
(documentRef === undefined || typeof documentRef === "string") &&
|
|
184
|
-
typeof savedDocumentId === "string"
|
|
203
|
+
typeof savedDocumentId === "string" &&
|
|
204
|
+
(format === undefined || format === "aac-v1" || format === "aac-v2"));
|
|
185
205
|
}
|
|
186
206
|
/**
|
|
187
207
|
* Type guard for the fields of {@link IAiAssistantPublisherDocumentDefinition}.
|
|
@@ -204,6 +224,27 @@ export function isAiAssistantPublisherDocumentDefinition(obj) {
|
|
|
204
224
|
(reworksOpenDocument === undefined || typeof reworksOpenDocument === "boolean") &&
|
|
205
225
|
(baseDocumentId === undefined || typeof baseDocumentId === "string"));
|
|
206
226
|
}
|
|
227
|
+
/**
|
|
228
|
+
* Type guard for the fields of {@link IAiAssistantPublisherDocumentDefinitionV2}.
|
|
229
|
+
*
|
|
230
|
+
* @remarks
|
|
231
|
+
* The document itself stays `unknown`: whoever applies it validates it.
|
|
232
|
+
*
|
|
233
|
+
* @alpha
|
|
234
|
+
*/
|
|
235
|
+
export function isAiAssistantPublisherDocumentDefinitionV2(obj) {
|
|
236
|
+
if (typeof obj !== "object" || obj === null) {
|
|
237
|
+
return false;
|
|
238
|
+
}
|
|
239
|
+
const { publisherDocumentV2, documentRef, refines, reworksOpenDocument, baseDocumentId } = obj;
|
|
240
|
+
return (typeof publisherDocumentV2 === "object" &&
|
|
241
|
+
publisherDocumentV2 !== null &&
|
|
242
|
+
!Array.isArray(publisherDocumentV2) &&
|
|
243
|
+
(documentRef === undefined || typeof documentRef === "string") &&
|
|
244
|
+
(refines === undefined || typeof refines === "string") &&
|
|
245
|
+
(reworksOpenDocument === undefined || typeof reworksOpenDocument === "boolean") &&
|
|
246
|
+
(baseDocumentId === undefined || typeof baseDocumentId === "string"));
|
|
247
|
+
}
|
|
207
248
|
/**
|
|
208
249
|
* Creates an {@link IAiAssistantDashboardSavedEvent}.
|
|
209
250
|
*
|
|
@@ -11,6 +11,7 @@ import { IEntitlementDescriptor } from '@gooddata/sdk-model';
|
|
|
11
11
|
import { IGenAIUserContext } from '@gooddata/sdk-model';
|
|
12
12
|
import { ILocale } from '@gooddata/sdk-model';
|
|
13
13
|
import { IPublisherDocumentDefinition } from '@gooddata/sdk-model';
|
|
14
|
+
import { IPublisherDocumentDefinitionV2 } from '@gooddata/sdk-model';
|
|
14
15
|
import { ITheme } from '@gooddata/sdk-model';
|
|
15
16
|
import { IUser } from '@gooddata/sdk-model';
|
|
16
17
|
import { IUserSettings } from '@gooddata/sdk-model';
|
|
@@ -209,6 +210,40 @@ export declare interface IAiAssistantPublisherDocumentDefinition {
|
|
|
209
210
|
readonly baseDocumentId?: string;
|
|
210
211
|
}
|
|
211
212
|
|
|
213
|
+
/**
|
|
214
|
+
* A document version of Publisher content v2 the host assistant drafted, carried by the
|
|
215
|
+
* `chat.definition-received` event an application receives through
|
|
216
|
+
* {@link IPluggableApplicationMountHandle.onAiAssistantEventReceive}.
|
|
217
|
+
*
|
|
218
|
+
* @remarks
|
|
219
|
+
* The document is in `publisherDocumentV2`, not `publisherDocument`, so one event can type both
|
|
220
|
+
* versions' fields.
|
|
221
|
+
*
|
|
222
|
+
* @alpha
|
|
223
|
+
*/
|
|
224
|
+
export declare interface IAiAssistantPublisherDocumentDefinitionV2 {
|
|
225
|
+
/**
|
|
226
|
+
* The whole document version.
|
|
227
|
+
*/
|
|
228
|
+
readonly publisherDocumentV2: IPublisherDocumentDefinitionV2;
|
|
229
|
+
/**
|
|
230
|
+
* Name of the document version in the conversation, the one its save is recorded under.
|
|
231
|
+
*/
|
|
232
|
+
readonly documentRef?: string;
|
|
233
|
+
/**
|
|
234
|
+
* Name of the document version this one reworks.
|
|
235
|
+
*/
|
|
236
|
+
readonly refines?: string;
|
|
237
|
+
/**
|
|
238
|
+
* Whether the version was written from the document open in the editor.
|
|
239
|
+
*/
|
|
240
|
+
readonly reworksOpenDocument?: boolean;
|
|
241
|
+
/**
|
|
242
|
+
* Identifier of the saved document this version edits.
|
|
243
|
+
*/
|
|
244
|
+
readonly baseDocumentId?: string;
|
|
245
|
+
}
|
|
246
|
+
|
|
212
247
|
/**
|
|
213
248
|
* Event telling the host assistant that a document it drafted was saved.
|
|
214
249
|
*
|
|
@@ -239,6 +274,11 @@ export declare interface IAiAssistantPublisherDocumentSavedEvent extends IPlugga
|
|
|
239
274
|
* Identifier of the document the draft was saved as.
|
|
240
275
|
*/
|
|
241
276
|
readonly savedDocumentId: string;
|
|
277
|
+
/**
|
|
278
|
+
* Publisher content version of the saved draft, which decides where the conversation records the
|
|
279
|
+
* save. Omitted by applications that predate it.
|
|
280
|
+
*/
|
|
281
|
+
readonly format?: "aac-v1" | "aac-v2";
|
|
242
282
|
};
|
|
243
283
|
}
|
|
244
284
|
|
|
@@ -471,6 +511,15 @@ export declare interface IHostUiMountHandle {
|
|
|
471
511
|
showChatItem: boolean;
|
|
472
512
|
isOpen: boolean;
|
|
473
513
|
}): void;
|
|
514
|
+
/**
|
|
515
|
+
* Opens the host UI's pricing (plan upgrade) dialog.
|
|
516
|
+
*
|
|
517
|
+
* @remarks
|
|
518
|
+
* Called by the host when the active pluggable application emits an
|
|
519
|
+
* {@link IOpenPricingDialogRequestedEvent}. The host UI decides whether the dialog applies
|
|
520
|
+
* (e.g. only for trial organizations). Host UIs without a pricing dialog may omit it or no-op.
|
|
521
|
+
*/
|
|
522
|
+
openPricingDialog?(): void;
|
|
474
523
|
/**
|
|
475
524
|
* Returns the DOM element where the active pluggable application should be rendered.
|
|
476
525
|
*
|
|
@@ -659,9 +708,28 @@ export declare interface IOpenAiAssistantRequestedEvent extends IPluggableAppEve
|
|
|
659
708
|
* Ignored when the question is appended to the existing chat.
|
|
660
709
|
*/
|
|
661
710
|
readonly effort?: GenAIChatEffort;
|
|
711
|
+
/**
|
|
712
|
+
* Existing conversation to select when opening the chat. When provided, takes precedence over
|
|
713
|
+
* the seeded question and user context. When omitted, the current open/ask behavior is preserved.
|
|
714
|
+
*/
|
|
715
|
+
readonly conversationId?: string;
|
|
662
716
|
};
|
|
663
717
|
}
|
|
664
718
|
|
|
719
|
+
/**
|
|
720
|
+
* Event requesting the host to open its pricing (plan upgrade) dialog.
|
|
721
|
+
*
|
|
722
|
+
* @remarks
|
|
723
|
+
* A pluggable application emits this from an in-content upsell control (e.g. an "Upgrade" button).
|
|
724
|
+
* The pricing dialog is owned by the host UI. The default host UI opens it only for trial
|
|
725
|
+
* organizations; outside a trial, or with a host UI that has no pricing dialog, the event is a no-op.
|
|
726
|
+
*
|
|
727
|
+
* @alpha
|
|
728
|
+
*/
|
|
729
|
+
export declare interface IOpenPricingDialogRequestedEvent extends IPluggableAppEvent {
|
|
730
|
+
readonly type: "GDC.PLUGGABLE_APP/EVT.PRICING_DIALOG.OPEN_REQUESTED";
|
|
731
|
+
}
|
|
732
|
+
|
|
665
733
|
/**
|
|
666
734
|
* Organization information available in the platform context.
|
|
667
735
|
*
|
|
@@ -1107,6 +1175,18 @@ export declare function isAiAssistantPublisherDocumentDefinition(obj: unknown):
|
|
|
1107
1175
|
readonly publisherDocument: unknown;
|
|
1108
1176
|
};
|
|
1109
1177
|
|
|
1178
|
+
/**
|
|
1179
|
+
* Type guard for the fields of {@link IAiAssistantPublisherDocumentDefinitionV2}.
|
|
1180
|
+
*
|
|
1181
|
+
* @remarks
|
|
1182
|
+
* The document itself stays `unknown`: whoever applies it validates it.
|
|
1183
|
+
*
|
|
1184
|
+
* @alpha
|
|
1185
|
+
*/
|
|
1186
|
+
export declare function isAiAssistantPublisherDocumentDefinitionV2(obj: unknown): obj is Omit<IAiAssistantPublisherDocumentDefinitionV2, "publisherDocumentV2"> & {
|
|
1187
|
+
readonly publisherDocumentV2: unknown;
|
|
1188
|
+
};
|
|
1189
|
+
|
|
1110
1190
|
/**
|
|
1111
1191
|
* Type guard for {@link IAiAssistantPublisherDocumentSavedEvent}.
|
|
1112
1192
|
*
|
|
@@ -1149,6 +1229,13 @@ export declare function isDocumentTitleChangedEvent(obj: unknown): obj is IDocum
|
|
|
1149
1229
|
*/
|
|
1150
1230
|
export declare function isOpenAiAssistantRequestedEvent(obj: unknown): obj is IOpenAiAssistantRequestedEvent;
|
|
1151
1231
|
|
|
1232
|
+
/**
|
|
1233
|
+
* Type guard for {@link IOpenPricingDialogRequestedEvent}.
|
|
1234
|
+
*
|
|
1235
|
+
* @alpha
|
|
1236
|
+
*/
|
|
1237
|
+
export declare function isOpenPricingDialogRequestedEvent(obj: unknown): obj is IOpenPricingDialogRequestedEvent;
|
|
1238
|
+
|
|
1152
1239
|
/**
|
|
1153
1240
|
* Type guard for {@link IPlatformContextV1}.
|
|
1154
1241
|
*
|
|
@@ -1227,8 +1314,16 @@ export declare function openAiAssistantRequested(payload?: {
|
|
|
1227
1314
|
appendToChat?: boolean;
|
|
1228
1315
|
replaceUserContext?: boolean;
|
|
1229
1316
|
effort?: GenAIChatEffort;
|
|
1317
|
+
conversationId?: string;
|
|
1230
1318
|
}): IOpenAiAssistantRequestedEvent;
|
|
1231
1319
|
|
|
1320
|
+
/**
|
|
1321
|
+
* Creates an {@link IOpenPricingDialogRequestedEvent}.
|
|
1322
|
+
*
|
|
1323
|
+
* @alpha
|
|
1324
|
+
*/
|
|
1325
|
+
export declare function openPricingDialogRequested(): IOpenPricingDialogRequestedEvent;
|
|
1326
|
+
|
|
1232
1327
|
/**
|
|
1233
1328
|
* Panther tier.
|
|
1234
1329
|
*
|
|
@@ -1255,6 +1350,7 @@ export declare const PluggableAppEventType: {
|
|
|
1255
1350
|
readonly AI_ASSISTANT_CONTEXT_CHANGED: "GDC.PLUGGABLE_APP/EVT.AI_ASSISTANT.CONTEXT_CHANGED";
|
|
1256
1351
|
readonly AI_ASSISTANT_PUBLISHER_DOCUMENT_SAVED: "GDC.PLUGGABLE_APP/EVT.AI_ASSISTANT.PUBLISHER_DOCUMENT_SAVED";
|
|
1257
1352
|
readonly AI_ASSISTANT_DASHBOARD_SAVED: "GDC.PLUGGABLE_APP/EVT.AI_ASSISTANT.DASHBOARD_SAVED";
|
|
1353
|
+
readonly PRICING_DIALOG_OPEN_REQUESTED: "GDC.PLUGGABLE_APP/EVT.PRICING_DIALOG.OPEN_REQUESTED";
|
|
1258
1354
|
};
|
|
1259
1355
|
|
|
1260
1356
|
/**
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@gooddata/sdk-pluggable-application-model",
|
|
3
|
-
"version": "11.65.0-alpha.
|
|
3
|
+
"version": "11.65.0-alpha.10",
|
|
4
4
|
"description": "GoodData SDK model contracts for pluggable applications",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "GoodData Corporation",
|
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
"dependencies": {
|
|
24
24
|
"ts-invariant": "0.10.3",
|
|
25
25
|
"tslib": "2.8.1",
|
|
26
|
-
"@gooddata/sdk-model": "11.65.0-alpha.
|
|
26
|
+
"@gooddata/sdk-model": "11.65.0-alpha.10"
|
|
27
27
|
},
|
|
28
28
|
"devDependencies": {
|
|
29
29
|
"@microsoft/api-documenter": "7.30.16",
|
|
@@ -44,8 +44,8 @@
|
|
|
44
44
|
"oxlint-plugin-eslint": "1.82.0",
|
|
45
45
|
"oxlint-tsgolint": "7.0.2001",
|
|
46
46
|
"typescript": "7.0.2",
|
|
47
|
-
"@gooddata/oxlint-config": "11.65.0-alpha.
|
|
48
|
-
"@gooddata/eslint-config": "11.65.0-alpha.
|
|
47
|
+
"@gooddata/oxlint-config": "11.65.0-alpha.10",
|
|
48
|
+
"@gooddata/eslint-config": "11.65.0-alpha.10"
|
|
49
49
|
},
|
|
50
50
|
"scripts": {
|
|
51
51
|
"_phase:build": "npm run build",
|