@wise/dynamic-flow-types 3.6.3 → 3.7.0

package/build/next/layout/FormLayout.d.ts

@@ -27,4 +27,8 @@ export type FormLayout = {
     * The vertical margin to apply after this component. Defaults to `md`.
     */
     margin?: Size;
+    /**
+    * An optional identifier to be used in analytics tracking.
+    */
+    analyticsId?: string;
 };

package/build/next/layout/HeadingLayout.d.ts

@@ -28,4 +28,8 @@ export type HeadingLayout = {
     * The vertical margin to apply after this component. Defaults to `md`.
     */
     margin?: Size;
+    /**
+    * An optional identifier to be used in analytics tracking.
+    */
+    analyticsId?: string;
 };

package/build/next/layout/ImageLayout.d.ts

@@ -45,4 +45,8 @@ export type ImageLayout = {
     * Controls how the image should be aligned within its container. Defaults to `center`.
     */
     align?: Align;
+    /**
+    * An optional identifier to be used in analytics tracking.
+    */
+    analyticsId?: string;
 };

package/build/next/layout/InfoLayout.d.ts

@@ -26,4 +26,8 @@ export type InfoLayout = {
     * The vertical margin to apply after this component. Defaults to `md`.
     */
     margin?: Size;
+    /**
+    * An optional identifier to be used in analytics tracking.
+    */
+    analyticsId?: string;
 };

package/build/next/layout/InstructionsLayout.d.ts

@@ -24,4 +24,8 @@ export type InstructionsLayout = {
     * The vertical margin to apply after this component. Defaults to `md`.
     */
     margin?: Size;
+    /**
+    * An optional identifier to be used in analytics tracking.
+    */
+    analyticsId?: string;
 };

package/build/next/layout/InstructionsLayoutItem.d.ts

@@ -15,4 +15,8 @@ export type InstructionsLayoutItem = {
     * An optional identifier to be used in custom renderers.
     */
     tag?: string;
+    /**
+    * An optional identifier to be used in analytics tracking.
+    */
+    analyticsId?: string;
 };

package/build/next/layout/ListLayout.d.ts

@@ -29,4 +29,8 @@ export type ListLayout = {
     * The vertical margin to apply after this component. Defaults to `md`.
     */
     margin?: Size;
+    /**
+    * An optional identifier to be used in analytics tracking.
+    */
+    analyticsId?: string;
 };

package/build/next/layout/ListLayoutItem.d.ts

@@ -61,4 +61,8 @@ export type ListLayoutItem = {
     * A user-facing description.
     */
     description?: string;
+    /**
+    * An optional identifier to be used in analytics tracking.
+    */
+    analyticsId?: string;
 };

package/build/next/layout/LoadingIndicatorLayout.d.ts

@@ -20,4 +20,8 @@ export type LoadingIndicatorLayout = {
     * The vertical margin to apply after this component. Defaults to `md`.
     */
     margin?: Size;
+    /**
+    * An optional identifier to be used in analytics tracking.
+    */
+    analyticsId?: string;
 };

package/build/next/layout/MarkdownLayout.d.ts

@@ -31,4 +31,8 @@ export type MarkdownLayout = {
     * The vertical margin to apply after this component. Defaults to `md`.
     */
     margin?: Size;
+    /**
+    * An optional identifier to be used in analytics tracking.
+    */
+    analyticsId?: string;
 };

package/build/next/layout/ModalLayout.d.ts

@@ -26,4 +26,8 @@ export type ModalLayout = {
     * Represents the modal content itself
     */
     content: ModalLayoutContent;
+    /**
+    * An optional identifier to be used in analytics tracking.
+    */
+    analyticsId?: string;
 };

package/build/next/layout/ParagraphLayout.d.ts

@@ -24,4 +24,8 @@ export type ParagraphLayout = {
     * The vertical margin to apply after this component. Defaults to `md`.
     */
     margin?: Size;
+    /**
+    * An optional identifier to be used in analytics tracking.
+    */
+    analyticsId?: string;
 };

package/build/next/layout/ReviewLayout.d.ts

@@ -38,4 +38,8 @@ export type ReviewLayout = {
     * The vertical margin to apply after this component. Defaults to `md`.
     */
     margin?: Size;
+    /**
+    * An optional identifier to be used in analytics tracking.
+    */
+    analyticsId?: string;
 };

package/build/next/layout/ReviewLayoutField.d.ts

@@ -51,4 +51,8 @@ export type ReviewLayoutField = {
     * A titled [com.wise.dynamicflow.feature.Behavior], associated with a specific field, and which can be performed by the user
     */
     callToAction?: ReviewLayoutCallToAction;
+    /**
+    * An optional identifier to be used in analytics tracking.
+    */
+    analyticsId?: string;
 };

package/build/next/layout/SearchLayout.d.ts

@@ -38,4 +38,8 @@ export type SearchLayout = {
     * The vertical margin to apply after this component. Defaults to `md`.
     */
     margin?: Size;
+    /**
+    * An optional identifier to be used in analytics tracking.
+    */
+    analyticsId?: string;
 };

package/build/next/layout/SectionLayout.d.ts

@@ -29,4 +29,8 @@ export type SectionLayout = {
     * The vertical margin to apply after this component. Defaults to `md`.
     */
     margin?: Size;
+    /**
+    * An optional identifier to be used in analytics tracking.
+    */
+    analyticsId?: string;
 };

package/build/next/layout/StatusListLayout.d.ts

@@ -24,4 +24,8 @@ export type StatusListLayout = {
     * The vertical margin to apply after this component. Defaults to `md`.
     */
     margin?: Size;
+    /**
+    * An optional identifier to be used in analytics tracking.
+    */
+    analyticsId?: string;
 };

package/build/next/layout/StatusListLayoutItem.d.ts

@@ -29,4 +29,8 @@ export type StatusListLayoutItem = {
     * An optional identifier to be used in custom renderers.
     */
     tag?: string;
+    /**
+    * An optional identifier to be used in analytics tracking.
+    */
+    analyticsId?: string;
 };

package/build/next/layout/TabsLayout.d.ts

@@ -20,4 +20,8 @@ export type TabsLayout = {
     * The vertical margin to apply after this component. Defaults to `md`.
     */
     margin?: Size;
+    /**
+    * An optional identifier to be used in analytics tracking.
+    */
+    analyticsId?: string;
 };

package/build/next/layout/TabsLayoutTab.d.ts

@@ -15,4 +15,8 @@ export type TabsLayoutTab = {
     * An optional identifier to be used in custom renderers.
     */
     tag?: string;
+    /**
+    * An optional identifier to be used in analytics tracking.
+    */
+    analyticsId?: string;
 };

package/build/next/misc/media/AvatarContent.d.ts

@@ -0,0 +1,6 @@
+import type { AvatarTextContent } from './AvatarTextContent';
+import type { AvatarUriContent } from './AvatarUriContent';
+/**
+* Describes the properties of a visual asset. It can be one of two mutually exclusive types: URI or Text.
+*/
+export type AvatarContent = AvatarTextContent | AvatarUriContent;

package/build/next/misc/media/AvatarTextContent.d.ts

@@ -0,0 +1,17 @@
+/**
+* An avatar content that is text.
+*/
+export type AvatarTextContent = {
+    /**
+    * It must be `text`.
+    */
+    type: 'text';
+    /**
+    * The text to be displayed.
+    */
+    text: string;
+    /**
+    * The URI with which the badge is configured.
+    */
+    badgeUri?: string;
+};

package/build/next/misc/media/AvatarUriContent.d.ts

@@ -0,0 +1,17 @@
+/**
+* An avatar content that is a URI.
+*/
+export type AvatarUriContent = {
+    /**
+    * It must be `uri`.
+    */
+    type: 'uri';
+    /**
+    * The URI with which the avatar is configured.
+    */
+    uri: string;
+    /**
+    * The URI with which the badge is configured.
+    */
+    badgeUri?: string;
+};

package/build/next/misc/media/Media.d.ts

@@ -0,0 +1,6 @@
+import type { MediaAvatar } from './MediaAvatar';
+import type { MediaImage } from './MediaImage';
+/**
+* Describes the type of visual asset to be displayed.
+*/
+export type Media = MediaAvatar | MediaImage;

package/build/next/misc/media/MediaAvatar.d.ts

@@ -0,0 +1,18 @@
+import type { AvatarContent } from './AvatarContent';
+/**
+* Avatar is a representation of a unique entity. It's comprised of one or more AvatarContent and an optional accessibilityDescription for screen readers.
+*/
+export type MediaAvatar = {
+    /**
+    * It must be `avatar`.
+    */
+    type: 'avatar';
+    /**
+    * The content to be displayed in the Avatar.
+    */
+    content: AvatarContent[];
+    /**
+    * An optional description for screen readers.
+    */
+    accessibilityDescription?: string;
+};

package/build/next/misc/media/MediaImage.d.ts

@@ -0,0 +1,17 @@
+/**
+* An Image Media.
+*/
+export type MediaImage = {
+    /**
+    * It must be `image`.
+    */
+    type: 'image';
+    /**
+    * The URI to use to fetch the image.
+    */
+    uri: string;
+    /**
+    * A description of the content of the image to be used by screen readers.
+    */
+    accessibilityDescription?: string;
+};

package/build/renderers/DecisionRendererProps.d.ts

@@ -10,6 +10,7 @@ export type DecisionRendererProps = BaseRendererProps & {
     title?: string;
 };
 export type DecisionOption = {
+    analyticsId?: string;
     description?: string;
     disabled: boolean;
     href?: string;

package/build/renderers/ListRendererProps.d.ts

@@ -13,6 +13,7 @@ export type ListRendererProps = BaseRendererProps & {
     title?: string;
 };
 export type ListItem = {
+    analyticsId?: string;
     icon?: Icon;
     image?: Image;
     title?: string;

package/build/renderers/RendererProps.d.ts

@@ -48,6 +48,7 @@ export type RenderFunction = (props: RendererProps | null) => JSX.Element | null
 export type Renderers = readonly (Renderer<StepRendererProps> | Renderer<CoreContainerRendererProps> | Renderer<AlertRendererProps> | Renderer<BoxRendererProps> | Renderer<ColumnsRendererProps> | Renderer<DecisionRendererProps> | Renderer<DividerRendererProps> | Renderer<ExternalConfirmationRendererProps> | Renderer<FormRendererProps> | Renderer<HeadingRendererProps> | Renderer<InstructionsRendererProps> | Renderer<ListRendererProps> | Renderer<LoadingIndicatorRendererProps> | Renderer<MarkdownRendererProps> | Renderer<ImageRendererProps> | Renderer<ModalRendererProps> | Renderer<ModalContentRendererProps> | Renderer<ParagraphRendererProps> | Renderer<ReviewRendererProps> | Renderer<SearchRendererProps> | Renderer<StatusListRendererProps> | Renderer<CheckboxInputRendererProps> | Renderer<ButtonRendererProps> | Renderer<DateInputRendererProps> | Renderer<HiddenRendererProps> | Renderer<IntegerInputRendererProps> | Renderer<NumberInputRendererProps> | Renderer<RepeatableRendererProps> | Renderer<RootRendererProps> | Renderer<FormSectionRendererProps> | Renderer<SelectInputRendererProps> | Renderer<SectionRendererProps> | Renderer<MultiSelectInputRendererProps> | Renderer<TabsRendererProps> | Renderer<TextInputRendererProps> | Renderer<UploadInputRendererProps> | Renderer<MultiUploadInputRendererProps>)[];
 export type BaseRendererProps = {
     uid: string;
+    analyticsId?: string;
     render: RenderFunction;
     httpClient: typeof fetch;
     trackEvent: AnalyticsEventDispatcher;

package/build/renderers/ReviewRendererProps.d.ts

@@ -12,6 +12,7 @@ export type ReviewRendererProps = BaseRendererProps & {
     callToAction?: CallToAction;
 };
 export type ReviewField = {
+    analyticsId?: string;
     help?: string;
     label: string;
     value: string;