@atomic.io/action-cards-web-sdk-cdn-icons 25.2.2 → 25.3.1

package/public/sdk.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="preact" />
-
 import { SDKCardEvent as SDKCardEvent_2 } from 'src/lib/sdk-event';
 
 export declare class AACHeadlessStreamContainer {
@@ -21,7 +19,7 @@ export declare class AACHeadlessStreamContainer {
      */
     stop(): void;
     tokenProvider: {
-        requestToken: () => Promise<string | undefined>;
+        requestToken: () => Promise<AuthToken>;
     };
     /**
      * Polls the Atomic platform for card feed updates
@@ -82,9 +80,9 @@ export declare class AACStreamContainer {
     private launchButtonIconContainer?;
     private launcher?;
     private resizeObserver?;
-    readonly resolvedConfiguration: SDKConfiguration;
+    readonly resolvedConfiguration: SDKConfiguration & InternalConfiguration;
     readonly instanceId: string;
-    streamFilters: any;
+    streamFilters: StreamFilter;
     private config;
     private analyticsQueue;
     constructor(config: SDKConfiguration, internalConfig: InternalConfiguration, embedMode: EmbedMode, analyticsQueue: AnalyticsQueue, hostElement?: HTMLElement);
@@ -134,12 +132,21 @@ export declare interface AnalyticsEventProperties {
 export declare type AnalyticsEventType = 'standard' | 'custom' | 'sdk-initialized';
 
 export declare class AnalyticsQueue {
-    private eventQueue;
+    private authenticatedEventQueue?;
+    private unauthenticatedEventQueue;
     private flushTimeout;
     private flushPromise;
-    constructor();
+    private authTokenProvider;
+    private tokenUserIdAttribute?;
+    constructor(authTokenProvider: AuthTokenProvider);
+    private getKeyForAuthenticatedQueue;
+    initializeAuthenticatedQueue(userId: string, tokenUserIdAttribute?: string): void;
     createEventPayload(eventData: AugmentedAnalyticsEvent | CustomAnalyticsEventData | SDKInitializedEventData, eventType: AnalyticsEventType): QueuedAnalyticsEvent | null;
-    enqueue(eventData: AugmentedAnalyticsEvent | CustomAnalyticsEventData | SDKInitializedEventData, eventType?: AnalyticsEventType): QueuedAnalyticsEvent | null;
+    enqueue(eventData: AugmentedAnalyticsEvent | CustomAnalyticsEventData | SDKInitializedEventData, eventType?: AnalyticsEventType, eventQueue?: 'authenticated' | 'unauthenticated'): Promise<QueuedAnalyticsEvent | null>;
+    /**
+     * Removes events from the queue that have been processed by the platform after being sent over the WebSocket.
+     * @param eventIds IDs of events to remove from the queue.
+     */
     removeProcessedEvents(eventIds: string[]): void;
     private performFlush;
     flush(): Promise<void>;
@@ -153,6 +160,7 @@ export declare interface AnalyticsSDKContext {
 }
 
 export declare interface AnalyticsStreamContext {
+    displayMode?: StreamDisplayMode;
     streamLength: number;
     streamLengthVisible: number;
     cardPositionInStream: number;
@@ -219,6 +227,7 @@ declare class AtomicSDK {
         [instanceId: string]: {
             sendMessageToIframe: (message: any) => void;
             logout: () => void;
+            embedMode: EmbedMode;
         };
     };
     static containersBroadcastChannel: ContainerBroadcastChannel | undefined;
@@ -258,6 +267,16 @@ declare class AtomicSDK {
      */
     static embed(hostElement: HTMLElement, config: SDKConfiguration, autosize?: Boolean): AACStreamContainer;
     static singleCard(hostElement: HTMLElement, config: SDKConfiguration): AACStreamContainer;
+    /**
+     * Instantiate a modal stream container that can be used to display a card feed in a modal dialog.
+     * In this mode, the stream will open in a modal dialog over the top of the current page when cards are present.
+     * Only one instance of a modal stream container can be created at a time.
+     *
+     * @param config Configuration for this stream container.
+     * @return An `AACStreamContainer` instance, which allows you to perform actions on the stream container after
+     * creation.
+     */
+    static modalStreamContainer(config: SDKConfiguration): void | AACStreamContainer;
     /**
      * Create a stream container instance that can be used to observe the card feed, it will not render any UI.
      *
@@ -403,7 +422,7 @@ declare class AtomicSDK {
          * @param submitButtonName a string identifying the submit button pressed, this should be taken from the `name` attribute from the button node
          * @param response an optional object containing response values for the card. Keys must be strings and values must be strings, numbers or booleans
          */
-        submit: (onActionSuccess: () => void, onActionFailed: (error: Error) => void, submitButtonName: string, response?: CardResponse | undefined) => Promise<void>;
+        submit: (onActionSuccess: () => void, onActionFailed: (error: Error) => void, submitButtonName: string, response?: CardResponse) => Promise<void>;
     };
     /**
      * Call this method each time the logged in user changes.
@@ -500,6 +519,7 @@ export declare interface AugmentedAnalyticsEvent extends AnalyticsEvent {
     timestamp: Date;
     containerId?: string;
     containerIds?: Array<string>;
+    displayMode?: StreamDisplayMode;
     streamLength?: number;
     streamLengthVisible?: number;
     streamCardPosition?: number;
@@ -510,6 +530,10 @@ export declare type AuthToken = string | undefined;
 
 export declare type AuthTokenCallback = () => Promise<AuthToken>;
 
+export declare interface AuthTokenProvider {
+    requestToken: AuthTokenCallback;
+}
+
 export declare type BroadcastChannelMessage = MessageEvent & {
     data: {
         type: CHANNEL_MESSAGE_TYPE;
@@ -598,7 +622,7 @@ export declare interface CardsAPIResponse {
 
 export declare type CardViewState = 'topview' | 'subview';
 
-declare type CardVotingActionType = CardActionType & {
+export declare type CardVotingActionType = CardActionType & {
     feedback?: boolean;
     feedbackLabel?: string;
 };
@@ -699,7 +723,7 @@ export declare interface DeviceInfo {
  * and is designed to supplement the single card view.
  * 6. toast: The iframe is rendering a toast iframe, this
  */
-export declare type EmbedMode = 'launcher' | 'standalone' | 'preview' | 'single-card' | 'modal-subview' | 'toast' | 'headless';
+export declare type EmbedMode = 'launcher' | 'standalone' | 'preview' | 'single-card' | 'modal-stream' | 'modal-subview' | 'toast' | 'headless';
 
 export declare interface EventData {
     name: string;
@@ -727,8 +751,23 @@ export declare interface FeatureFlags {
      * Use the card voting menu configuration in the atomic workbench instead https://documentation.atomic.io/guide/cards/behaviour#card-voting
      */
     cardVoting?: VotingOptions;
+    /**
+     * @deprecated
+     * This feature configuration is deprecated and will be removed in a future version of the SDK.
+     * Use the card minimum height property on the stream container configuration instead https://documentation.atomic.io/sdks/web#card-minimum-height
+     */
     cardMinimumHeight?: number;
+    /**
+     * @deprecated
+     * This feature configuration is deprecated and will be removed in a future version of the SDK.
+     * Use the horizontal container configuration property on the stream container configuration instead https://documentation.atomic.io/sdks/web#displaying-a-horizontal-stream-container
+     */
     horizontalContainerConfig?: HorizontalContainerConfig;
+    /**
+     * @deprecated
+     * This feature configuration is deprecated and will be removed in a future version of the SDK.
+     * Use the controlled container open state property on the stream container configuration instead https://documentation.atomic.io/sdks/web#manually-controlling-other-stream-container-variants
+     */
     controlledContainerOpenState?: boolean;
 }
 
@@ -867,6 +906,8 @@ export declare interface MinLengthValidationAttributes extends ValidationAttribu
     minimumLength: number;
 }
 
+export declare const MODAL_STREAM_EMBED_ID = "atomic-sdk-modal-stream-embed";
+
 export declare type NativePlatform = 'iOS' | 'Android';
 
 export declare type NotifyDays = {
@@ -1016,11 +1057,19 @@ export declare interface SDKConfiguration {
     onSizeChanged?: (width: number, height: number) => void;
     onCardEvent?: (event: CardEvent) => void;
     onLauncherToggled?: (open?: boolean) => void;
+    onModalStreamToggled?: (open?: boolean) => void;
     customStrings?: CustomStrings;
     enabledUiElements?: UIElements;
     features?: FeatureFlags;
     firstLoadStyles?: FirstLoadStyles;
     interfaceStyle?: InterfaceStyle;
+    controlledContainerOpenState?: boolean;
+    cardMinimumHeight?: number;
+    cardMaximumWidth?: number;
+    horizontalContainerConfig?: HorizontalContainerConfig;
+    modalContainerPositioning?: 'top' | 'center' | 'bottom';
+    modalContainerVerticalPadding?: number;
+    cardHorizontalAlignment?: 'leading' | 'center' | 'trailing';
 }
 
 export declare type SDKEvent = SDKCardCompletedEvent | SDKCardDismissedEvent | SDKCardSnoozedEvent | SDKFeedEvent | SDKCardDisplayedEvent | SDKCardVotedUpEvent | SDKCardVotedDownEvent | SDKRuntimeVarsUpdatedEvent | SDKStreamDisplayedEvent | SDKRedirectedEvent | SDKSnoozeOptionsDisplayedEvent | SDKSnoozeOptionsCanceledEvent | SDKSubviewDisplayedEvent | SDKSubviewExitedEvent | SDKVideoPlayedEvent | SDKVideoCompletedEvent | SDKInitEvent | SDKRequestFailedEvent | SDKNotificationReceivedEvent | SDKUserFileUploadsStartedEvent | SDKUserFileUploadsCompletedEvent | SDKUserFileUploadsFailedEvent;
@@ -1226,6 +1275,16 @@ export declare interface StandardAnalyticsEvent {
     cardContext: AnalyticsCardContext;
 }
 
+declare const STREAM_DISPLAY_MODES: {
+    readonly stream: "stream";
+    readonly single: "single";
+    readonly launcher: "launcher";
+    readonly horizontal: "horizontal";
+    readonly modal: "modal";
+};
+
+export declare type StreamDisplayMode = (typeof STREAM_DISPLAY_MODES)[keyof typeof STREAM_DISPLAY_MODES];
+
 export declare class StreamFilter {
     private filters;
     private onApplyFilter;
@@ -1233,11 +1292,13 @@ export declare class StreamFilter {
     constructor(onApplyFilter: () => void, onClearFilter: () => void);
     addVariableFilter: (key: string) => Operators<any>;
     addPayloadVariableFilter: (key: string) => Operators<any>;
+    addCardContentFilter: (key: string) => Operators<any>;
+    addSubviewContentFilter: (key: string) => Operators<any>;
     addPayloadMetadataFilter: (key: string) => Operators<any>;
-    variableFilter: (namespace: string, key: string, callingFunctionName: string, propertyType?: string) => Operators<any>;
-    addCardTemplateIdFilter: () => Pick<Operators<string>, "equals" | "in" | "notEqualTo" | "notIn">;
-    addCardTemplateNameFilter: () => Pick<Operators<string>, "equals" | "in" | "notEqualTo" | "notIn">;
-    addCardCreatedFilter: () => Pick<Operators<string | Date>, "greaterThan" | "greaterThanOrEqualTo" | "lessThan" | "lessThanOrEqualTo" | "equals" | "notEqualTo">;
+    genericFilter: (namespace: string, key: string, callingFunctionName: string, propertyType?: string) => Operators<any>;
+    addCardTemplateIdFilter: () => Omit<Operators<string>, "greaterThan" | "greaterThanOrEqualTo" | "lessThan" | "lessThanOrEqualTo" | "between">;
+    addCardTemplateNameFilter: () => Omit<Operators<string>, "greaterThan" | "greaterThanOrEqualTo" | "lessThan" | "lessThanOrEqualTo" | "between">;
+    addCardCreatedFilter: () => Omit<Operators<string | Date>, "in" | "notIn" | "between">;
     addCardPriorityFilter: () => Operators<PriorityFilterValue>;
     clearFilters: () => void;
     apply: () => void;