amazon-quicksight-embedding-sdk - npm Package Compare versions

Comparing version 2.6.0 to 2.7.0

dist/index.d.ts

@@ -41,3 +41,4 @@ /// <reference types="node" />
     protected getInternalExperienceInfo: <EmbeddingInternalExperience extends InternalExperiences, EmbeddingExperience extends Experiences>(experience: EmbeddingExperience) => InternalExperienceInfo<EmbeddingInternalExperience>;
-    protected transformContentOptions: <TCO extends TransformedContentOptions>(filteredOptions: TCO, unrecognizedContentOptions: Partial<TCO>) => TCO;
+    protected transformContentOptions: <TCO extends TransformedContentOptions>(filteredOptions: TCO, unrecognizedContentOptions: object) => TCO;
+    protected warnUnrecognizedContentOptions: (unrecognizedProperties: string[]) => void;
     protected abstract extractExperienceFromUrl: (url: string) => Experience;
@@ -151,3 +152,3 @@ private validateFrameOptions;
 
-export declare type ContentOptions = VisualContentOptions | DashboardContentOptions | QSearchContentOptions | ConsoleContentOptions | ControlContentOptions;
+export declare type ContentOptions = VisualContentOptions | DashboardContentOptions | QSearchContentOptions | ConsoleContentOptions | ControlContentOptions | GenerativeQnAContentOptions;
 
@@ -162,13 +163,9 @@ export declare type ControlContentOptions = BaseContentOptions;
     private readonly eventManager;
-    private readonly onMessage?;
     private readonly onChange?;
     private readonly experience;
-    private internalSend?;
-    private iframe;
-    private logger?;
-    constructor(container: HTMLBodyElement, controlOptions: ControlOptions, onChange?: EventListener_2, onMessage?: EventListener_2);
-    send: (messageEvent: TargetedMessageEvent) => void | undefined;
+    private readonly logger?;
+    private readonly controlExperienceFrame;
+    constructor(container: HTMLBodyElement, controlOptions: ControlOptions, onChange?: EventListener_2, logger?: LogProvider);
+    send: (messageEvent: TargetedMessageEvent) => Promise<SuccessResponse | ErrorResponse<EventMessageValues> | DataResponse<EventMessageValues>>;
     controlFrameMessageListener: (event: MessageEvent<EmbeddingEvents>) => void;
-    setLogger: (logger: LogProvider) => this;
-    private initializeFrame;
     private sendAcknowledgment;
@@ -191,3 +188,3 @@ private getControlExperienceId;
     timeout?: number;
-    sendToControlFrame?: InternalSend;
+    sendToControlFrame?: (messageEvent: TargetedMessageEvent) => Promise<SuccessResponse | ErrorResponse | DataResponse>;
     onChange?: EventListener;
@@ -329,2 +326,3 @@ };
     embedQSearchBar: (frameOptions: FrameOptions, contentOptions?: QSearchContentOptions) => Promise<QSearchExperience>;
+    embedGenerativeQnA: (frameOptions: FrameOptions, contentOptions?: GenerativeQnAContentOptions) => Promise<GenerativeQnAExperience>;
     private validateFrameOptions;
@@ -416,3 +414,3 @@ private buildControlOptions;
 
-export declare type Experiences = IConsoleExperience | IContextExperience | IControlExperience | IVisualExperience | IDashboardExperience | IQSearchExperience;
+export declare type Experiences = IConsoleExperience | IContextExperience | IControlExperience | IVisualExperience | IDashboardExperience | IQSearchExperience | IGenerativeQnAExperience;
 
@@ -426,2 +424,3 @@ export declare const ExperienceType: {
     readonly QSEARCH: "QSEARCH";
+    readonly GENERATIVEQNA: "QSEARCH";
 };
@@ -471,2 +470,50 @@
 
+export declare interface GenerativeQnAContentOptions extends BaseContentOptions {
+    showTopicName?: boolean;
+    showPinboard?: boolean;
+    allowTopicSelection?: boolean;
+    allowFullscreen?: boolean;
+    searchPlaceholderText?: string;
+    panelOptions?: GenerativeQnAPanelOptions;
+    themeOptions?: QThemeOptions;
+}
+
+export declare class GenerativeQnAExperience extends InternalQBaseExperience<GenerativeQnAContentOptions, InternalGenerativeQnAExperience, IGenerativeQnAExperience, TransformedGenerativeQnAContentOptions, GenerativeQnAExperienceFrame> {
+    protected experience: IGenerativeQnAExperience;
+    protected internalExperience: InternalGenerativeQnAExperience;
+    protected experienceFrame: GenerativeQnAExperienceFrame;
+    protected experienceId: string;
+    protected frameStyles?: FrameStyles;
+    static readonly TEXT_PROPERTY_MAX_LENGTH = 200;
+    constructor(frameOptions: FrameOptions, contentOptions: GenerativeQnAContentOptions, controlOptions: ControlOptions, experienceIdentifiers: Set<string>);
+    protected extractExperienceFromUrl: (url: string) => IGenerativeQnAExperience;
+    private interceptMessage;
+    private transformGenerativeQnAContentOptions;
+    private checkMaxLength;
+}
+
+export declare class GenerativeQnAExperienceFrame extends BaseExperienceFrame<GenerativeQnAContentOptions, TransformedGenerativeQnAContentOptions, InternalGenerativeQnAExperience> {
+    constructor(frameOptions: FrameOptions, controlOptions: ControlOptions, contentOptions: GenerativeQnAContentOptions, transformedContentOptions: TransformedGenerativeQnAContentOptions, internalExperience: InternalGenerativeQnAExperience, experienceIdentifier: string, interceptMessage?: EventListener_2);
+    buildExperienceUrl: (baseUrl: string) => string;
+}
+
+export declare type GenerativeQnAFullPanelOptions = {
+    panelType: typeof GenerativeQnAPanelType.FULL;
+    title?: string;
+    showQIcon?: boolean;
+};
+
+export declare type GenerativeQnAPanelOptions = GenerativeQnAFullPanelOptions | GenerativeQnASearchBarOptions;
+
+export declare const GenerativeQnAPanelType: {
+    readonly FULL: "FULL";
+    readonly SEARCH_BAR: "SEARCH_BAR";
+};
+
+export declare type GenerativeQnASearchBarOptions = {
+    panelType: typeof GenerativeQnAPanelType.SEARCH_BAR;
+    focusedHeight?: string;
+    expandedHeight?: string;
+};
+
 export declare const GetterMessageEventName: {
@@ -554,2 +601,6 @@ readonly GET_PARAMETERS: "GET_PARAMETERS";
 
+export declare interface IGenerativeQnAExperience extends IBaseExperience {
+    experienceType: typeof ExperienceType.GENERATIVEQNA;
+}
+
 export declare const InfoChangeEventName: {
@@ -575,5 +626,8 @@ readonly FRAME_STARTED: "FRAME_STARTED";
     readonly Q_SEARCH_OPENED: "Q_SEARCH_OPENED";
+    readonly Q_SEARCH_FOCUSED: "Q_SEARCH_FOCUSED";
     readonly Q_SEARCH_SIZE_CHANGED: "Q_SEARCH_SIZE_CHANGED";
     readonly Q_SEARCH_ENTERED_FULLSCREEN: "Q_SEARCH_ENTERED_FULLSCREEN";
     readonly Q_SEARCH_EXITED_FULLSCREEN: "Q_SEARCH_EXITED_FULLSCREEN";
+    readonly Q_PANEL_ENTERED_FULLSCREEN: "Q_PANEL_ENTERED_FULLSCREEN";
+    readonly Q_PANEL_EXITED_FULLSCREEN: "Q_PANEL_EXITED_FULLSCREEN";
 };
@@ -605,7 +659,9 @@
     height?: string;
-}> | EmbeddingEvent<typeof InfoMessageEventName.Q_SEARCH_ENTERED_FULLSCREEN, undefined> | EmbeddingEvent<typeof InfoMessageEventName.Q_SEARCH_OPENED, {
+}> | EmbeddingEvent<typeof InfoMessageEventName.Q_SEARCH_OPENED, {
     height?: string;
-}> | EmbeddingEvent<typeof InfoMessageEventName.Q_SEARCH_EXITED_FULLSCREEN, undefined> | EmbeddingEvent<typeof InfoMessageEventName.Q_SEARCH_SIZE_CHANGED, {
+}> | EmbeddingEvent<typeof InfoMessageEventName.Q_SEARCH_FOCUSED, {
+    height?: string;
+}> | EmbeddingEvent<typeof InfoMessageEventName.Q_SEARCH_SIZE_CHANGED, {
     height?: number;
-}>;
+}> | EmbeddingEvent<typeof InfoMessageEventName.Q_SEARCH_ENTERED_FULLSCREEN, undefined> | EmbeddingEvent<typeof InfoMessageEventName.Q_SEARCH_EXITED_FULLSCREEN, undefined> | EmbeddingEvent<typeof InfoMessageEventName.Q_PANEL_ENTERED_FULLSCREEN, undefined> | EmbeddingEvent<typeof InfoMessageEventName.Q_PANEL_EXITED_FULLSCREEN, undefined>;
 
@@ -633,4 +689,22 @@ export declare interface InternalConsoleExperience extends IConsoleExperience {
 
-export declare type InternalExperiences = InternalConsoleExperience | InternalContextExperience | InternalControlExperience | InternalVisualExperience | InternalDashboardExperience | InternalQSearchExperience;
+export declare type InternalExperiences = InternalConsoleExperience | InternalContextExperience | InternalControlExperience | InternalVisualExperience | InternalDashboardExperience | InternalQSearchExperience | InternalGenerativeQnAExperience;
 
+export declare interface InternalGenerativeQnAExperience extends IGenerativeQnAExperience {
+    contextId: string;
+}
+
+/**
+ * Internal base experience for embedded Q,
+ * containing shared functionality between q-search-bar and generative-qna experience types.
+ */
+export declare abstract class InternalQBaseExperience<ExperienceContentOptions extends ContentOptions, InternalExperience extends InternalExperiences, Experience extends Experiences, TransformedExperienceContentOptions extends TransformedContentOptions, ExperienceFrame extends BaseExperienceFrame<ExperienceContentOptions, TransformedExperienceContentOptions, InternalExperience>> extends BaseExperience<ExperienceContentOptions, InternalExperience, Experience, TransformedExperienceContentOptions, ExperienceFrame> {
+    static readonly MAX_Z_INDEX = "2147483647";
+    protected frameStyles?: FrameStyles;
+    close: () => Promise<ResponseMessage>;
+    setQuestion: (question: string) => Promise<ResponseMessage>;
+    protected trackOutsideClicks: () => void;
+    protected enterFullScreen: (metadata: ExperienceFrameMetadata | undefined) => void;
+    protected exitFullScreen: (metadata: ExperienceFrameMetadata | undefined) => void;
+}
+
 export declare interface InternalQSearchExperience extends IQSearchExperience {
@@ -640,4 +714,2 @@ contextId: string;
 
-export declare type InternalSend = (messageEvent: TargetedMessageEvent) => void;
-
 export declare interface InternalVisualExperience extends IVisualExperience {
@@ -722,5 +794,8 @@ contextId: string;
     readonly Q_SEARCH_OPENED: "Q_SEARCH_OPENED";
+    readonly Q_SEARCH_FOCUSED: "Q_SEARCH_FOCUSED";
     readonly Q_SEARCH_SIZE_CHANGED: "Q_SEARCH_SIZE_CHANGED";
     readonly Q_SEARCH_ENTERED_FULLSCREEN: "Q_SEARCH_ENTERED_FULLSCREEN";
     readonly Q_SEARCH_EXITED_FULLSCREEN: "Q_SEARCH_EXITED_FULLSCREEN";
+    readonly Q_PANEL_ENTERED_FULLSCREEN: "Q_PANEL_ENTERED_FULLSCREEN";
+    readonly Q_PANEL_EXITED_FULLSCREEN: "Q_PANEL_EXITED_FULLSCREEN";
 };
@@ -789,2 +864,6 @@
 export declare const QSE: {
+    GenerativeQnAPanelType: {
+        readonly FULL: "FULL";
+        readonly SEARCH_BAR: "SEARCH_BAR";
+    };
     SPECIAL_DATAPOINT_VALUE_TYPES: {
@@ -807,2 +886,3 @@ readonly NULL: null;
         readonly QSEARCH: "QSEARCH";
+        readonly GENERATIVEQNA: "QSEARCH";
     };
@@ -864,5 +944,8 @@ ChangeEventName: {
         readonly Q_SEARCH_OPENED: "Q_SEARCH_OPENED";
+        readonly Q_SEARCH_FOCUSED: "Q_SEARCH_FOCUSED";
         readonly Q_SEARCH_SIZE_CHANGED: "Q_SEARCH_SIZE_CHANGED";
         readonly Q_SEARCH_ENTERED_FULLSCREEN: "Q_SEARCH_ENTERED_FULLSCREEN";
         readonly Q_SEARCH_EXITED_FULLSCREEN: "Q_SEARCH_EXITED_FULLSCREEN";
+        readonly Q_PANEL_ENTERED_FULLSCREEN: "Q_PANEL_ENTERED_FULLSCREEN";
+        readonly Q_PANEL_EXITED_FULLSCREEN: "Q_PANEL_EXITED_FULLSCREEN";
     };
@@ -885,5 +968,8 @@ ChangeEventLevel: {
         readonly Q_SEARCH_OPENED: "Q_SEARCH_OPENED";
+        readonly Q_SEARCH_FOCUSED: "Q_SEARCH_FOCUSED";
         readonly Q_SEARCH_SIZE_CHANGED: "Q_SEARCH_SIZE_CHANGED";
         readonly Q_SEARCH_ENTERED_FULLSCREEN: "Q_SEARCH_ENTERED_FULLSCREEN";
         readonly Q_SEARCH_EXITED_FULLSCREEN: "Q_SEARCH_EXITED_FULLSCREEN";
+        readonly Q_PANEL_ENTERED_FULLSCREEN: "Q_PANEL_ENTERED_FULLSCREEN";
+        readonly Q_PANEL_EXITED_FULLSCREEN: "Q_PANEL_EXITED_FULLSCREEN";
     };
@@ -953,4 +1039,3 @@ InfoChangeEventName: {
 
-export declare class QSearchExperience extends BaseExperience<QSearchContentOptions, InternalQSearchExperience, IQSearchExperience, TransformedQSearchContentOptions, QSearchExperienceFrame> {
-    static readonly MAX_Z_INDEX = "2147483647";
+export declare class QSearchExperience extends InternalQBaseExperience<QSearchContentOptions, InternalQSearchExperience, IQSearchExperience, TransformedQSearchContentOptions, QSearchExperienceFrame> {
     protected experience: IQSearchExperience;
@@ -962,4 +1047,2 @@ protected internalExperience: InternalQSearchExperience;
     constructor(frameOptions: FrameOptions, contentOptions: QSearchContentOptions, controlOptions: ControlOptions, experienceIdentifiers: Set<string>);
-    close: () => Promise<ResponseMessage>;
-    setQuestion: (question: string) => Promise<ResponseMessage>;
     protected extractExperienceFromUrl: (url: string) => IQSearchExperience;
@@ -975,2 +1058,6 @@ private interceptMessage;
 
+export declare type QThemeOptions = {
+    themeArn?: string;
+};
+
 export declare abstract class ResponseMessage<EventMessageValue extends EventMessageValues = EventMessageValues> {
@@ -981,3 +1068,3 @@ abstract success: boolean;
 
-export declare const SDK_VERSION = "2.6.0";
+export declare const SDK_VERSION = "2.7.0";
 
@@ -1053,3 +1140,3 @@ export declare const SetterMessageEventName: {
 
-export declare type TransformedContentOptions = TransformedConsoleContentOptions | TransformedDashboardContentOptions | TransformedQSearchContentOptions | TransformedVisualContentOptions | object;
+export declare type TransformedContentOptions = TransformedConsoleContentOptions | TransformedDashboardContentOptions | TransformedQSearchContentOptions | TransformedVisualContentOptions | TransformedGenerativeQnAContentOptions | object;
 
@@ -1071,2 +1158,16 @@ export declare interface TransformedDashboardContentOptions extends BaseContentOptions {
 
+export declare interface TransformedGenerativeQnAContentOptions extends BaseContentOptions {
+    qShowTopicName?: boolean;
+    qShowPinboard?: boolean;
+    qAllowTopicSelection?: boolean;
+    qAllowFullscreen?: boolean;
+    qSearchPlaceholderText?: string;
+    qPanelType?: string;
+    qPanelTitle?: string;
+    qShowPanelIcon?: boolean;
+    qPanelFocusedHeight?: string;
+    qPanelExpandedHeight?: string;
+    themeArn?: string;
+}
+
 export declare interface TransformedQSearchContentOptions extends BaseContentOptions {
@@ -1073,0 +1174,0 @@ qBarIconDisabled?: boolean;

package.json

 {
     "name": "amazon-quicksight-embedding-sdk",
-    "version": "2.6.0",
+    "version": "2.7.0",
     "description": "JS SDK for embedding Amazon QuickSight",
@@ -5,0 +5,0 @@ "keywords": [

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

995617

increased by10.11%

Lines of code

1881

increased by8.29%

Number of lines in readme file

1978

increased by12.32%

No dependency changes