@wise/dynamic-flow-types 3.9.0 → 3.10.0-experimental-5de9758

package/build/next/feature/SuggestionsValue.d.ts

@@ -1,6 +1,7 @@
 import type { JsonElement } from '../JsonElement';
 import type { Icon } from '../misc/Icon';
 import type { Image } from '../misc/Image';
+import type { Media } from '../misc/media/Media';
 /**
 * Represents a suggested value.
 */
@@ -26,6 +27,10 @@ export type SuggestionsValue = {
     */
     tag?: string;
     /**
+    * A media object (avatar, icon, image) which the client can use to represent this suggestion.
+    */
+    media?: Media;
+    /**
     * An optional identifier to be used in analytics tracking.
     */
     analyticsId?: string;

package/build/next/feature/SummaryProvider.d.ts

@@ -18,4 +18,8 @@ export type SummaryProvider = {
     * If true, the image of this schema can be used as a summary image.
     */
     providesImage?: boolean;
+    /**
+    * If true, the media of this schema can be used as a summary media.
+    */
+    providesMedia?: boolean;
 };

package/build/next/feature/SummarySummariser.d.ts

@@ -1,5 +1,6 @@
 import type { Icon } from '../misc/Icon';
 import type { Image } from '../misc/Image';
+import type { Media } from '../misc/media/Media';
 /**
 * A schema which summarises its child schemas.
 * Default values can be specified for the summary if values are not provided by its child schemas.
@@ -37,4 +38,12 @@ export type SummarySummariser = {
     * If true, the image of this schema can be used as a summary image.
     */
     providesImage?: boolean;
+    /**
+    * A Media to be used for the summary if a media is not provided by a child schema.
+    */
+    defaultMedia?: Media;
+    /**
+    * If true, the media of this schema can be used as a summary media.
+    */
+    providesMedia?: boolean;
 };

package/build/next/feature/toolbar/Toolbar.d.ts

@@ -0,0 +1,14 @@
+import type { ToolbarItem } from './ToolbarItem';
+/**
+* `Toolbar` contains an optional array of type `Toolbar.Item` containing items to be displayed in the toolbar.
+*/
+export type Toolbar = {
+    /**
+    * Specify a particular control to use to represent the toolbar. If the control is unknown, it will be ignored.
+    */
+    control?: string;
+    /**
+    * The items to be displayed in the toolbar.
+    */
+    items: ToolbarItem[];
+};

package/build/next/feature/toolbar/ToolbarButton.d.ts

@@ -0,0 +1,41 @@
+import type { Behavior } from '../Behavior';
+import type { Media } from '../../misc/media/Media';
+import type { Context } from '../../misc/Context';
+export type ToolbarButton = {
+    /**
+    * It must be `toolbar-button`.
+    */
+    type: 'toolbar-button';
+    /**
+    * A user-facing title.
+    */
+    title: string;
+    /**
+    * A behavior to be performed when the button is pressed.
+    */
+    behavior: Behavior;
+    /**
+    * An optional description for screen readers.
+    */
+    accessibilityDescription?: string;
+    /**
+    * A visual asset which the client can use to represent this type.
+    */
+    media?: Media;
+    /**
+    * Specify a particular control to use to represent the toolbar button. If the control is unknown, it will be ignored.
+    */
+    control?: string;
+    /**
+    * The semantics of the button. Defaults to neutral.
+    */
+    context?: Context;
+    /**
+    * If `true`, user interaction is disabled. Defaults to `false`.
+    */
+    disabled?: boolean;
+    /**
+    * An optional identifier to be used in analytics tracking.
+    */
+    analyticsId?: string;
+};

package/build/next/feature/toolbar/ToolbarItem.d.ts

@@ -0,0 +1,2 @@
+import type { ToolbarButton } from './ToolbarButton';
+export type ToolbarItem = ToolbarButton;

package/build/next/index.d.ts

@@ -12,6 +12,9 @@ export type { Behavior } from './feature/Behavior';
 export type { DismissBehavior } from './feature/DismissBehavior';
 export type { LinkBehavior } from './feature/LinkBehavior';
 export type { ModalBehavior } from './feature/ModalBehavior';
+export type { Toolbar } from './feature/toolbar/Toolbar';
+export type { ToolbarButton } from './feature/toolbar/ToolbarButton';
+export type { ToolbarItem } from './feature/toolbar/ToolbarItem';
 export type { LinkHandler } from './feature/LinkHandler';
 export type { AdditionalInfo } from './misc/AdditionalInfo';
 export type { Align } from './misc/Align';
@@ -20,6 +23,7 @@ export type { Context } from './misc/Context';
 export type { Icon } from './misc/Icon';
 export type { Image } from './misc/Image';
 export type { InlineAlert } from './misc/InlineAlert';
+export type { Media } from './misc/media/Media';
 export type { Size as Margin, Size } from './misc/Size';
 export type { SupportingValues } from './misc/SupportingValues';
 export type { AlertLayout } from './layout/AlertLayout';

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

@@ -4,6 +4,7 @@ import type { Image } from '../misc/Image';
 import type { Behavior } from '../feature/Behavior';
 import type { SupportingValues } from '../misc/SupportingValues';
 import type { InlineAlert } from '../misc/InlineAlert';
+import type { Media } from '../misc/media/Media';
 /**
 * An option is a single entry in the decision that the user can choose.
 */
@@ -55,6 +56,10 @@ export type DecisionLayoutOption = {
     */
     inlineAlert?: InlineAlert;
     /**
+    * A media object (avatar, icon, image) which the client can use to represent this option.
+    */
+    media?: Media;
+    /**
     * An optional identifier to be used in analytics tracking.
     */
     analyticsId?: string;

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

@@ -4,6 +4,7 @@ import type { Image } from '../misc/Image';
 import type { AdditionalInfo } from '../misc/AdditionalInfo';
 import type { SupportingValues } from '../misc/SupportingValues';
 import type { InlineAlert } from '../misc/InlineAlert';
+import type { Media } from '../misc/media/Media';
 /**
 * A single entry in a [ListLayout].
 */
@@ -62,6 +63,10 @@ export type ListLayoutItem = {
     */
     description?: string;
     /**
+    * A media object (avatar, icon, image) which the client can use to represent this item.
+    */
+    media?: Media;
+    /**
     * An optional identifier to be used in analytics tracking.
     */
     analyticsId?: string;

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

@@ -4,6 +4,7 @@ import type { Image } from '../misc/Image';
 import type { AdditionalInfo } from '../misc/AdditionalInfo';
 import type { InlineAlert } from '../misc/InlineAlert';
 import type { ReviewLayoutCallToAction } from './ReviewLayoutCallToAction';
+import type { Media } from '../misc/media/Media';
 /**
 * A single field in a [ReviewLayout]
 */
@@ -32,11 +33,11 @@ export type ReviewLayoutField = {
     */
     tag?: string;
     /**
-    * An icon to represent the item.
+    * An icon to represent the field.
     */
     icon?: Icon;
     /**
-    * An image to represent the option.
+    * An image to represent the field.
     */
     image?: Image;
     /**
@@ -52,6 +53,10 @@ export type ReviewLayoutField = {
     */
     callToAction?: ReviewLayoutCallToAction;
     /**
+    * A media object (avatar, icon, image) which the client can use to represent this field.
+    */
+    media?: Media;
+    /**
     * An optional identifier to be used in analytics tracking.
     */
     analyticsId?: string;

package/build/next/responses/search/SearchResultAction.d.ts

@@ -1,6 +1,7 @@
 import type { Icon } from '../../misc/Icon';
 import type { Image } from '../../misc/Image';
 import type { Action } from '../../feature/Action';
+import type { Media } from '../../misc/media/Media';
 /**
 * A search result which contains an [com.wise.dynamicflow.feature.Action] to perform when the result is selected.
 */
@@ -29,4 +30,8 @@ export type SearchResultAction = {
     * The action to perform when the option is selected.
     */
     value: Action;
+    /**
+    * The media object (avatar, icon, image) which the client can use to represent this search result.
+    */
+    media?: Media;
 };

package/build/next/responses/search/SearchResultSearch.d.ts

@@ -1,6 +1,7 @@
 import type { Icon } from '../../misc/Icon';
 import type { Image } from '../../misc/Image';
 import type { SearchSearchRequest } from './SearchSearchRequest';
+import type { Media } from '../../misc/media/Media';
 /**
 * A search result which contains another search to be performed when selected. Can be used to provide groups of
 * results or simple pagination.
@@ -30,4 +31,8 @@ export type SearchResultSearch = {
     * A search configuration to used when the option is selected.
     */
     value: SearchSearchRequest;
+    /**
+    * The media object (avatar, icon, image) which the client can use to represent this search result.
+    */
+    media?: Media;
 };

package/build/next/schema/AllOfSchema.d.ts

@@ -3,6 +3,7 @@ import type { Icon } from '../misc/Icon';
 import type { Image } from '../misc/Image';
 import type { SummaryProvider } from '../feature/SummaryProvider';
 import type { AlertLayout } from '../layout/AlertLayout';
+import type { Media } from '../misc/media/Media';
 /**
 * A schema which merges the value of its child schemas.
 * Use an allOf schema to represent a form section where the submission payload is the result of merging the allOf's child schemas.
@@ -45,11 +46,11 @@ export type AllOfSchema = {
     */
     hidden?: boolean;
     /**
-    * An icon which the client can use to represent this schema.
+    * An icon which the client can use to represent this entity.
     */
     icon?: Icon;
     /**
-    * An image which the client can use to represent this schema.
+    * An image which the client can use to represent this entity.
     */
     image?: Image;
     /**
@@ -73,4 +74,8 @@ export type AllOfSchema = {
     * [com.wise.dynamicflow.feature.Action] for server-side validation.
     */
     alert?: AlertLayout;
+    /**
+    * A media object which the client can use to represent this entity.
+    */
+    media?: Media;
 };

package/build/next/schema/ArraySchemaList.d.ts

@@ -5,6 +5,7 @@ import type { SummarySummariser } from '../feature/SummarySummariser';
 import type { PersistAsync } from '../feature/PersistAsync';
 import type { ValidateAsync } from '../feature/ValidateAsync';
 import type { AlertLayout } from '../layout/AlertLayout';
+import type { Media } from '../misc/media/Media';
 /**
 * A variable length array where each item matches the items JSON schema. This can be used, for example, to create a
 * repeating form section, or multi-file upload.
@@ -66,11 +67,11 @@ export type ArraySchemaList = {
     */
     hidden?: boolean;
     /**
-    * An icon which the client can use to represent this schema.
+    * An icon which the client can use to represent this entity.
     */
     icon?: Icon;
     /**
-    * An image which the client can use to represent this schema.
+    * An image which the client can use to represent this entity.
     */
     image?: Image;
     /**
@@ -112,4 +113,8 @@ export type ArraySchemaList = {
     *  Defaults to false.
     */
     disabled?: boolean;
+    /**
+    * A media object which the client can use to represent this entity.
+    */
+    media?: Media;
 };

package/build/next/schema/ArraySchemaTuple.d.ts

@@ -5,6 +5,7 @@ import type { SummaryProvider } from '../feature/SummaryProvider';
 import type { PersistAsync } from '../feature/PersistAsync';
 import type { ValidateAsync } from '../feature/ValidateAsync';
 import type { AlertLayout } from '../layout/AlertLayout';
+import type { Media } from '../misc/media/Media';
 /**
 * A fixed-length array where each schema represents the data at the corresponding element in the array.
 * As ordering needs to remain consistent, the submission value will include null values where applicable.
@@ -45,11 +46,11 @@ export type ArraySchemaTuple = {
     */
     hidden?: boolean;
     /**
-    * An icon which the client can use to represent this schema.
+    * An icon which the client can use to represent this entity.
     */
     icon?: Icon;
     /**
-    * An image which the client can use to represent this schema.
+    * An image which the client can use to represent this entity.
     */
     image?: Image;
     /**
@@ -81,4 +82,8 @@ export type ArraySchemaTuple = {
     * [com.wise.dynamicflow.feature.Action] for server-side validation.
     */
     alert?: AlertLayout;
+    /**
+    * A media object which the client can use to represent this entity.
+    */
+    media?: Media;
 };

package/build/next/schema/BlobSchema.d.ts

@@ -5,6 +5,7 @@ import type { ValidateAsync } from '../feature/ValidateAsync';
 import type { AlertLayout } from '../layout/AlertLayout';
 import type { JsonElement } from '../JsonElement';
 import type { UploadSource } from '../feature/UploadSource';
+import type { Media } from '../misc/media/Media';
 /**
 * Represents a binary data submission using Form Data rather than JSON.
 * It can only be used as the schema of a [com.wise.dynamicflow.feature.PersistAsync] configuration.
@@ -40,11 +41,11 @@ export type BlobSchema = {
     */
     hidden?: boolean;
     /**
-    * An icon which the client can use to represent this schema.
+    * An icon which the client can use to represent this entity.
     */
     icon?: Icon;
     /**
-    * An image which the client can use to represent this schema.
+    * An image which the client can use to represent this entity.
     */
     image?: Image;
     /**
@@ -101,4 +102,8 @@ export type BlobSchema = {
     *  Defaults to false.
     */
     disabled?: boolean;
+    /**
+    * A media object which the client can use to represent this entity.
+    */
+    media?: Media;
 };

package/build/next/schema/BooleanSchema.d.ts

@@ -6,6 +6,7 @@ import type { ValidateAsync } from '../feature/ValidateAsync';
 import type { AlertLayout } from '../layout/AlertLayout';
 import type { Help } from '../feature/Help';
 import type { Behavior } from '../feature/Behavior';
+import type { Media } from '../misc/media/Media';
 /**
 * Represents a boolean value in the submission.
 * The submission value is either `true` or `false`, defaulting to `false`.
@@ -67,11 +68,11 @@ export type BooleanSchema = {
     */
     disabled?: boolean;
     /**
-    * An icon which the client can use to represent this schema.
+    * An icon which the client can use to represent this entity.
     */
     icon?: Icon;
     /**
-    * An image which the client can use to represent this schema.
+    * An image which the client can use to represent this entity.
     */
     image?: Image;
     /**
@@ -134,4 +135,8 @@ export type BooleanSchema = {
     * The [com.wise.dynamicflow.feature.Behavior] that should be performed when the schema value changes.
     */
     onChange?: Behavior;
+    /**
+    * A media object which the client can use to represent this entity.
+    */
+    media?: Media;
 };

package/build/next/schema/ConstSchema.d.ts

@@ -3,6 +3,7 @@ import type { JsonElement } from '../JsonElement';
 import type { Icon } from '../misc/Icon';
 import type { Image } from '../misc/Image';
 import type { SummaryProvider } from '../feature/SummaryProvider';
+import type { Media } from '../misc/media/Media';
 /**
 * Represents a constant value in the submission.
 */
@@ -44,11 +45,11 @@ export type ConstSchema = {
     */
     description?: string;
     /**
-    * An icon which the client can use to represent this schema.
+    * An icon which the client can use to represent this entity.
     */
     icon?: Icon;
     /**
-    * An image which the client can use to represent this schema.
+    * An image which the client can use to represent this entity.
     */
     image?: Image;
     /**
@@ -70,4 +71,8 @@ export type ConstSchema = {
     *  Defaults to false.
     */
     disabled?: boolean;
+    /**
+    * A media object which the client can use to represent this entity.
+    */
+    media?: Media;
 };

package/build/next/schema/IntegerSchema.d.ts

@@ -7,6 +7,7 @@ import type { AlertLayout } from '../layout/AlertLayout';
 import type { AutocompleteToken } from '../misc/AutocompleteToken';
 import type { Help } from '../feature/Help';
 import type { Behavior } from '../feature/Behavior';
+import type { Media } from '../misc/media/Media';
 /**
 * Represents a numeric value which must be a whole number. For floating point numbers, use a [NumberSchema] instead.
 * When not provided, the submission value is `null`.
@@ -81,11 +82,11 @@ export type IntegerSchema = {
     */
     disabled?: boolean;
     /**
-    * An icon which the client can use to represent this schema.
+    * An icon which the client can use to represent this entity.
     */
     icon?: Icon;
     /**
-    * An image which the client can use to represent this schema.
+    * An image which the client can use to represent this entity.
     */
     image?: Image;
     /**
@@ -160,4 +161,8 @@ export type IntegerSchema = {
     * The [com.wise.dynamicflow.feature.Behavior] that should be performed when the schema value changes.
     */
     onChange?: Behavior;
+    /**
+    * A media object which the client can use to represent this entity.
+    */
+    media?: Media;
 };

package/build/next/schema/NumberSchema.d.ts

@@ -7,6 +7,7 @@ import type { AlertLayout } from '../layout/AlertLayout';
 import type { AutocompleteToken } from '../misc/AutocompleteToken';
 import type { Help } from '../feature/Help';
 import type { Behavior } from '../feature/Behavior';
+import type { Media } from '../misc/media/Media';
 /**
 * Represents any numeric value - either an integer or a floating point number.
 * If the value should always be an integer, consider using an [IntegerSchema] instead.
@@ -82,11 +83,11 @@ export type NumberSchema = {
     */
     disabled?: boolean;
     /**
-    * An icon which the client can use to represent this schema.
+    * An icon which the client can use to represent this entity.
     */
     icon?: Icon;
     /**
-    * An image which the client can use to represent this schema.
+    * An image which the client can use to represent this entity.
     */
     image?: Image;
     /**
@@ -161,4 +162,8 @@ export type NumberSchema = {
     * The [com.wise.dynamicflow.feature.Behavior] that should be performed when the schema value changes.
     */
     onChange?: Behavior;
+    /**
+    * A media object which the client can use to represent this entity.
+    */
+    media?: Media;
 };

package/build/next/schema/ObjectSchema.d.ts

@@ -4,6 +4,7 @@ import type { Icon } from '../misc/Icon';
 import type { Image } from '../misc/Image';
 import type { SummaryProvider } from '../feature/SummaryProvider';
 import type { AlertLayout } from '../layout/AlertLayout';
+import type { Media } from '../misc/media/Media';
 /**
 * Represents an object value in the submission.
 * The value for submission includes only non-null property values. If all property values are null, the value is an empty object.
@@ -65,11 +66,11 @@ export type ObjectSchema = {
     */
     hidden?: boolean;
     /**
-    * An icon which the client can use to represent this schema.
+    * An icon which the client can use to represent this entity.
     */
     icon?: Icon;
     /**
-    * An image which the client can use to represent this schema.
+    * An image which the client can use to represent this entity.
     */
     image?: Image;
     /**
@@ -93,4 +94,8 @@ export type ObjectSchema = {
     * [com.wise.dynamicflow.feature.Action] for server-side validation.
     */
     alert?: AlertLayout;
+    /**
+    * A media object which the client can use to represent this entity.
+    */
+    media?: Media;
 };

package/build/next/schema/OneOfSchema.d.ts

@@ -7,6 +7,7 @@ import type { AlertLayout } from '../layout/AlertLayout';
 import type { Help } from '../feature/Help';
 import type { AutocompleteToken } from '../misc/AutocompleteToken';
 import type { Behavior } from '../feature/Behavior';
+import type { Media } from '../misc/media/Media';
 /**
 * Offers a choice between a number of child schemas.
 * Use a oneOf schema to represent either the selection of one of many constant values (e.g. a select box or dropdown)
@@ -138,11 +139,11 @@ export type OneOfSchema = {
     */
     hidden?: boolean;
     /**
-    * An icon which the client can use to represent this schema.
+    * An icon which the client can use to represent this entity.
     */
     icon?: Icon;
     /**
-    * An image which the client can use to represent this schema.
+    * An image which the client can use to represent this entity.
     */
     image?: Image;
     /**
@@ -214,4 +215,8 @@ export type OneOfSchema = {
     * The [com.wise.dynamicflow.feature.Behavior] that should be performed when the schema value changes.
     */
     onChange?: Behavior;
+    /**
+    * A media object which the client can use to represent this entity.
+    */
+    media?: Media;
 };

package/build/next/schema/StringSchema.d.ts

@@ -12,6 +12,7 @@ import type { AutocompleteToken } from '../misc/AutocompleteToken';
 import type { Help } from '../feature/Help';
 import type { Suggestions } from '../feature/Suggestions';
 import type { Behavior } from '../feature/Behavior';
+import type { Media } from '../misc/media/Media';
 /**
 * Represents a string value in the submission.
 * This could be used for standard text input, or a format can be provided
@@ -222,4 +223,9 @@ export type StringSchema = {
     * The [com.wise.dynamicflow.feature.Behavior] that should be performed when the schema value changes.
     */
     onChange?: Behavior;
+    /**
+    * A media object (avatar, icon, image) which the client can use to represent this schema.
+    * Media can be shown inside text input fields.
+    */
+    media?: Media;
 };

package/build/next/step/Step.d.ts

@@ -7,6 +7,7 @@ import type { Polling } from '../feature/Polling';
 import type { LinkHandler } from '../feature/LinkHandler';
 import type { StepError } from '../feature/StepError';
 import type { Navigation } from '../feature/Navigation';
+import type { Toolbar } from '../feature/toolbar/Toolbar';
 /**
 * A step represents a single screen in a flow. It is made up of schemas, which represent data to be collected from the
 * user, layouts which describe how the screen looks, and a number of advanced features to provide more complex
@@ -98,4 +99,9 @@ export type Step = {
     * Must be an ISO 8601 formatted string. After this time has passed, the step will be refreshed. It should include date, time, and timezone.
     */
     refreshAfter?: string;
+    /**
+    * An optional toolbar to be displayed at the top of the step.
+    * See [com.wise.dynamicflow.feature.toolbar.Toolbar].
+    */
+    toolbar?: Toolbar;
 };

package/build/renderers/BaseInputRendererProps.d.ts

@@ -1,5 +1,6 @@
 import { Icon } from './Icon';
 import { Image } from './Image';
+import { Media } from './Media';
 import { BaseRendererProps } from './RendererProps';
 export type BaseInputRendererProps = BaseRendererProps & {
     id: string;
@@ -12,6 +13,7 @@ export type BaseInputRendererProps = BaseRendererProps & {
     validationState: ValidationResult | undefined;
     icon?: Icon;
     image?: Image;
+    media?: Media;
     title?: string;
     onBlur: () => void;
     onFocus: () => void;

package/build/renderers/DecisionRendererProps.d.ts

@@ -1,5 +1,6 @@
 import { Icon } from './Icon';
 import { Image } from './Image';
+import { Media } from './Media';
 import { BaseRendererProps } from './RendererProps';
 import { InlineAlert, Margin, SupportingValues } from './constants';
 export type DecisionRendererProps = BaseRendererProps & {
@@ -16,6 +17,7 @@ export type DecisionOption = {
     href?: string;
     icon?: Icon;
     image?: Image;
+    media?: Media;
     title: string;
     tag?: string;
     /** @experimental This feature may be changed in the future without notice. */

package/build/renderers/FormSectionRendererProps.d.ts

@@ -2,6 +2,7 @@ import { ReactNode } from 'react';
 import { Icon } from './Icon';
 import { Image } from './Image';
 import { BaseRendererProps, RendererProps } from './RendererProps';
+import { Media } from './Media';
 export type FormSectionRendererProps = BaseRendererProps & {
     type: 'form-section';
     control?: string;
@@ -12,4 +13,5 @@ export type FormSectionRendererProps = BaseRendererProps & {
     childrenProps: RendererProps[];
     icon?: Icon;
     image?: Image;
+    media?: Media;
 };

package/build/renderers/ListRendererProps.d.ts

@@ -2,6 +2,7 @@ import { SupportingValues } from '../next';
 import { CallToAction } from './CallToAction';
 import { Icon } from './Icon';
 import { Image } from './Image';
+import { Media } from './Media';
 import { BaseRendererProps } from './RendererProps';
 import { AdditionalInfo, InlineAlert, Margin } from './constants';
 export type ListRendererProps = BaseRendererProps & {
@@ -16,6 +17,7 @@ export type ListItem = {
     analyticsId?: string;
     icon?: Icon;
     image?: Image;
+    media?: Media;
     title?: string;
     /** @deprecated Use `description` instead. */
     subtitle?: string;