@wise/dynamic-flow-types 3.18.0 → 4.0.0-experimental-feace93

package/build/renderers/BaseInputRendererProps.d.ts

@@ -1,5 +1,3 @@
-import { Icon } from './Icon';
-import { Image } from './Image';
 import { Media } from './Media';
 import { BaseRendererProps } from './RendererProps';
 export type BaseInputRendererProps = BaseRendererProps & {
@@ -11,8 +9,6 @@ export type BaseInputRendererProps = BaseRendererProps & {
     placeholder?: string;
     required: boolean;
     validationState: ValidationResult | undefined;
-    icon?: Icon;
-    image?: Image;
     media?: Media;
     title?: string;
     onBlur: () => void;

package/build/renderers/CallToAction.d.ts

@@ -1,6 +1,4 @@
 export type CallToAction = {
-    /** @deprecated */
-    type: string;
     accessibilityDescription?: string;
     href?: string;
     title: string;

package/build/renderers/CheckboxInputRendererProps.d.ts

@@ -1,6 +1,10 @@
+import { InlineAlert, SupportingValues } from './constants';
 import { BaseInputRendererProps } from './BaseInputRendererProps';
 export type CheckboxInputRendererProps = BaseInputRendererProps & {
     type: 'input-checkbox';
+    additionalText?: string;
+    inlineAlert?: InlineAlert;
+    supportingValues?: SupportingValues;
     value: boolean;
     onChange: (value: boolean) => void;
 };

package/build/renderers/DecisionRendererProps.d.ts

@@ -1,5 +1,3 @@
-import { Icon } from './Icon';
-import { Image } from './Image';
 import { Media } from './Media';
 import { BaseRendererProps } from './RendererProps';
 import { InlineAlert, Margin, SupportingValues } from './constants';
@@ -15,19 +13,12 @@ export type DecisionOption = {
     description?: string;
     disabled: boolean;
     href?: string;
-    icon?: Icon;
-    image?: Image;
     keywords?: string[];
     media?: Media;
-    /** @deprecated Please use `tags` instead. */
-    tag?: string;
     tags?: string[];
     title: string;
-    /** @experimental This feature may be changed in the future without notice. */
     additionalText?: string;
-    /** @experimental This feature may be changed in the future without notice. */
     supportingValues?: SupportingValues;
-    /** @experimental This feature may be changed in the future without notice. */
     inlineAlert?: InlineAlert;
     onClick: () => void;
 };

package/build/renderers/FormSectionRendererProps.d.ts

@@ -1,6 +1,4 @@
 import type { ReactNode } from 'react';
-import type { Icon } from './Icon';
-import type { Image } from './Image';
 import type { BaseRendererProps, RendererProps } from './RendererProps';
 import type { Media } from './Media';
 export type FormSectionRendererProps = BaseRendererProps & {
@@ -11,7 +9,5 @@ export type FormSectionRendererProps = BaseRendererProps & {
     help?: string;
     children: ReactNode;
     childrenProps: RendererProps[];
-    icon?: Icon;
-    image?: Image;
     media?: Media;
 };

package/build/renderers/Icon.d.ts

@@ -1 +1 @@
-export type { Icon } from '../next';
+export type { Icon } from '../spec';

package/build/renderers/InstructionsRendererProps.d.ts

@@ -10,7 +10,5 @@ export type InstructionsRendererProps = BaseRendererProps & {
 export type InstructionItem = {
     context: Context;
     text: string;
-    /** @deprecated Please use `tags` instead. */
-    tag?: string;
     tags?: string[];
 };

package/build/renderers/ListRendererProps.d.ts

@@ -1,7 +1,5 @@
-import { SupportingValues } from '../next';
+import { SupportingValues } from '../spec';
 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';
@@ -15,19 +13,9 @@ export type ListRendererProps = BaseRendererProps & {
 };
 export type ListItem = {
     analyticsId?: string;
-    icon?: Icon;
-    image?: Image;
     media?: Media;
     title?: string;
-    /** @deprecated Use `description` instead. */
-    subtitle?: string;
     description?: string;
-    /** @deprecated Use `supportedValues` instead. */
-    value?: string;
-    /** @deprecated Use `supportedValues` instead. */
-    subvalue?: string;
-    /** @deprecated Please use `tags` instead. */
-    tag?: string;
     tags?: string[];
     /** @experimental This feature may be changed in the future without notice. */
     supportingValues?: SupportingValues;

package/build/renderers/MoneyInputRendererProps.d.ts

@@ -1,5 +1,5 @@
 import { Media, ValidationResult } from '.';
-import { JsonElement } from '../next';
+import { JsonElement } from '../spec';
 import type { BaseRendererProps } from './RendererProps';
 export type MoneyInputRendererProps = BaseRendererProps & {
     type: 'money-input';

package/build/renderers/MultiUploadInputRendererProps.d.ts

@@ -1,5 +1,5 @@
-import { JsonElement } from '../next';
-import { UploadSource } from '../next/feature/UploadSource';
+import { JsonElement } from '../spec';
+import { UploadSource } from '../spec/feature/UploadSource';
 import { BaseInputRendererProps, ValidationResult } from './BaseInputRendererProps';
 export type MultiUploadInputRendererProps = BaseInputRendererProps & {
     type: 'input-upload-multi';

package/build/renderers/RepeatableRendererProps.d.ts

@@ -1,6 +1,4 @@
 import { ReactNode } from 'react';
-import { Icon } from './Icon';
-import { Image } from './Image';
 import { ValidationResult } from './BaseInputRendererProps';
 import { BaseRendererProps, RendererProps } from './RendererProps';
 import { Media } from './Media';
@@ -19,8 +17,6 @@ export type RepeatableRendererProps = BaseRendererProps & {
     title: string;
     maxItems?: number;
     minItems?: number;
-    icon?: Icon;
-    image?: Image;
     media?: Media;
     onAdd: () => void;
     onEdit: (itemIndex: number) => void;
@@ -30,8 +26,6 @@ export type RepeatableRendererProps = BaseRendererProps & {
 export type RepeatableItemRendererProps = {
     id: string;
     description?: string;
-    icon?: Icon;
-    image?: Image;
     media?: Media;
     title?: string;
     tags?: string[];

package/build/renderers/ReviewRendererProps.d.ts

@@ -1,7 +1,5 @@
 import { CallToAction } from './CallToAction';
 import { AdditionalInfo, InlineAlert, Margin } from './constants';
-import { Icon } from './Icon';
-import { Image } from './Image';
 import { Media } from './Media';
 import { BaseRendererProps } from './RendererProps';
 export type ReviewRendererProps = BaseRendererProps & {
@@ -18,18 +16,9 @@ export type ReviewField = {
     label: string;
     value: string;
     rawValue?: string;
-    /** @deprecated Please use `tags` instead. */
-    tag?: string;
     tags?: string[];
-    /** @experimental This feature may be changed in the future without notice. */
     additionalInfo?: AdditionalInfo;
-    /** @experimental This feature may be changed in the future without notice. */
     inlineAlert?: InlineAlert;
-    /** @experimental This feature may be changed in the future without notice. */
     callToAction?: CallToAction;
-    /** @experimental This feature may be changed in the future without notice. */
-    icon?: Icon;
-    /** @experimental This feature may be changed in the future without notice. */
-    image?: Image;
     media?: Media;
 };

package/build/renderers/SearchRendererProps.d.ts

@@ -1,5 +1,5 @@
 import { Media } from '.';
-import type { SearchResult as SearchResultSpec } from '../next';
+import type { SearchResult as SearchResultSpec } from '../spec';
 import { Margin } from './constants';
 import { Image } from './Image';
 import { BaseRendererProps } from './RendererProps';

package/build/renderers/SelectInputRendererProps.d.ts

@@ -1,9 +1,8 @@
 import { ReactNode } from 'react';
 import { BaseInputRendererProps } from './BaseInputRendererProps';
-import { Icon } from './Icon';
-import { Image } from './Image';
 import { RendererProps } from './RendererProps';
 import { Media } from '.';
+import { InlineAlert, SupportingValues } from './constants';
 export type SelectInputRendererProps = BaseInputRendererProps & {
     type: 'input-select';
     autoComplete: string;
@@ -14,13 +13,14 @@ export type SelectInputRendererProps = BaseInputRendererProps & {
     onSelect: (index: number | null) => void;
 };
 export type SelectInputRendererOption = {
+    additionalText?: string;
     analyticsId?: string;
     description?: string;
     disabled: boolean;
-    icon?: Icon;
-    image?: Image;
-    media?: Media;
+    inlineAlert?: InlineAlert;
     keywords: string[];
-    title: string;
+    media?: Media;
+    supportingValues?: SupportingValues;
     tags?: string[];
+    title: string;
 };

package/build/renderers/StatusListRendererProps.d.ts

@@ -15,8 +15,6 @@ export type StatusListItem = {
     status?: 'done' | 'not-done' | 'pending';
     title: string;
     callToAction?: CallToAction;
-    /** @deprecated Please use `tags` instead. */
-    tag?: string;
     tags?: string[];
 };
 export type StatusListItemStatus = 'done' | 'not-done' | 'pending';

package/build/renderers/StepRendererProps.d.ts

@@ -1,6 +1,5 @@
 import type { ReactNode } from 'react';
 import type { Context, Media } from '.';
-import type { Action, Step } from '../next';
 import { BaseRendererProps, RendererProps } from './RendererProps';
 export type AnalyticsEventDispatcher = (eventName: string, properties?: Record<string, unknown>) => void;
 export type LoadingState = 'idle' | 'initial' | 'submitting' | 'refreshing';
@@ -27,22 +26,8 @@ export type StepRendererProps = BaseRendererProps & {
     toolbar?: Toolbar;
     footer: ReactNode;
     footerProps: RendererProps[];
-    /**
-     * @deprecated Please use the stepLoadingState instead.
-     */
-    loadingState: LoadingState;
     title?: string;
     tags?: string[];
-    /**
-     * @experimental Please do not use this property. It is only here to support a legacy camera step.
-     * @deprecated Please use childrenProps instead.
-     */
-    step?: Step;
-    /**
-     * @experimental Please do not use this function. Calling onAction from a step renderer completely bypasses the core logic and may result in unexpected behavior. It is only here to support a legacy camera step.
-     * @deprecated Please use childrenProps instead.
-     */
-    onAction?: (action: Action) => void | Promise<void>;
     children: ReactNode;
     childrenProps: RendererProps[];
 };

package/build/renderers/Suggestions.d.ts

@@ -1,6 +1,4 @@
-import { JsonElement } from '../next';
-import { Icon } from './Icon';
-import { Image } from './Image';
+import { JsonElement } from '../spec';
 import { Media } from './Media';
 export type Suggestions = {
     values: SuggestionValue[];
@@ -8,10 +6,6 @@ export type Suggestions = {
 export type SuggestionValue = {
     label: string;
     value?: JsonElement;
-    icon?: Icon;
-    image?: Image;
     media?: Media;
-    /** @deprecated Please use `tags` instead. */
-    tag?: string;
     tags?: string[];
 };

package/build/renderers/TabsRendererProps.d.ts

@@ -11,7 +11,5 @@ export type Tab = {
     title: string;
     children: ReactNode;
     childrenProps: RendererProps[];
-    /** @deprecated Please use `tags` instead. */
-    tag?: string;
     tags?: string[];
 };

package/build/renderers/UploadInputRendererProps.d.ts

@@ -1,5 +1,5 @@
-import { JsonElement } from '../next';
-import { UploadSource } from '../next/feature/UploadSource';
+import { JsonElement } from '../spec';
+import { UploadSource } from '../spec/feature/UploadSource';
 import { BaseInputRendererProps } from './BaseInputRendererProps';
 export type UploadInputRendererProps = BaseInputRendererProps & {
     type: 'input-upload';

package/build/renderers/constants.d.ts

@@ -1,7 +1,7 @@
 export type Align = 'start' | 'center' | 'end';
 export type Autocapitalization = 'none' | 'sentences' | 'words' | 'characters';
 export type Context = 'positive' | 'negative' | 'warning' | 'neutral';
-export type { Margin, Size } from '../next';
+export type { Margin, Size } from '../spec';
 export type AdditionalInfo = {
     href?: string;
     text: string;

package/build/renderers/index.d.ts

@@ -1,4 +1,3 @@
-import type { CallToAction } from './CallToAction';
 export type { AlertRendererProps } from './AlertRendererProps';
 export type { BoxRendererProps } from './BoxRendererProps';
 export type { ButtonRendererProps } from './ButtonRendererProps';
@@ -46,9 +45,3 @@ export type { Media, MediaAvatar, MediaImage, LegacyMedia, AvatarContent, Avatar
 export type { AdditionalInfo, InlineAlert, SupportingValues } from './constants';
 export type { Renderer, RendererProps, Renderers, RenderFunction } from './RendererProps';
 export type { CallToAction } from './CallToAction';
-/** @deprecated Please use `CallToAction` instead. */
-export type AlertCallToAction = CallToAction;
-/** @deprecated Please use `CallToAction` instead. */
-export type ReviewCallToAction = CallToAction;
-/** @deprecated Please use `CallToAction` instead. */
-export type StatusListItemCallToAction = CallToAction;

package/build/{next → spec}/feature/Polling.d.ts

@@ -5,8 +5,8 @@ import type { PollingOnError } from './PollingOnError';
 * The client may continue to another step or end the flow.
 * ### Example
 * Given the step below, the client will start making requests to the specified URL every 5 seconds.
-* To progress the flow, the response should be a [FlowResponse] with the `X-DF-Response-Type` header set accordingly.
-* *Note that older clients only support [ActionResponseBody]*
+* To progress the flow, the response should be a [com.wise.dynamicflow.responses.FlowResponse] with the `X-DF-Response-Type` header set accordingly.
+* *Note that older clients only support [com.wise.dynamicflow.responses.action.ActionResponseBody]*
 * To continue Polling, the response should have a 2xx status code and an empty body. The client will continue to make requests until the flow progresses or [maxAttempts] is reached.
 * ```kt
 * Step.build {
@@ -17,16 +17,18 @@ import type { PollingOnError } from './PollingOnError';
 *         timeout = 60
 *         maxAttempts = 100
 *         onError {
-*             action {
-*                 exit = true
-*                 result = encodeToJsonElement(mapOf("exit-action-data" to "EXIT!!!"))
+*             behavior = ActionBehavior.build {
+*                 action {
+*                     exit = true
+*                     result = encodeToJsonElement(mapOf("exit-action-data" to "EXIT!!!"))
+*                 }
 *             }
 *         }
 *     }
 * }
 * ```
 * #### Error handling
-* Given the above step, the action in the `onError` object is triggered if:
+* Given the above step, the behaviour in the `onError` object is triggered if:
 * - the response status code is a failure (>=400).
 * - the number of attempts exceeds the specified `maxAttempts`
 * - the response body does not match the `X-DF-Response-Type` header provided

package/build/spec/feature/RefreshBehavior.d.ts

@@ -0,0 +1,9 @@
+/**
+* Refreshes the current step when the behavior is triggered. See [com.wise.dynamicflow.feature.RefreshOnChange] for more details.
+*/
+export type RefreshBehavior = {
+    /**
+    * It must be `refresh`.
+    */
+    type: 'refresh';
+};

package/build/{next → spec}/index.d.ts

@@ -2,6 +2,7 @@ import type { JsonElement } from './JsonElement';
 import type { FormLayout as GeneratedFormLayout } from './layout/FormLayout';
 export type { Action } from './feature/Action';
 export type { Navigation } from './feature/Navigation';
+export type { NavigationStackBehavior } from './feature/NavigationStackBehavior';
 export type { PersistAsync } from './feature/PersistAsync';
 export type { Polling } from './feature/Polling';
 export type { PollingOnError } from './feature/PollingOnError';
@@ -13,6 +14,8 @@ export type { DismissBehavior } from './feature/DismissBehavior';
 export type { LinkBehavior } from './feature/LinkBehavior';
 export type { ModalBehavior } from './feature/ModalBehavior';
 export type { LinkHandler } from './feature/LinkHandler';
+export type { AutocompleteToken } from './misc/AutocompleteToken';
+export type { HttpMethod } from './misc/HttpMethod';
 export type { AdditionalInfo } from './misc/AdditionalInfo';
 export type { Align } from './misc/Align';
 export type { AutocapitalizationType } from './misc/AutocapitalizationType';
@@ -92,3 +95,4 @@ export type ValidationError = JsonElement;
 export type Reference = {
     $ref: string;
 };
+export { validateStep, validateActionResponse, validateErrorResponse } from '../zod/validators';

package/build/{main.js → spec/main.js}

@@ -17,7 +17,7 @@ var __copyProps = (to, from, except, desc) => {
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
-// src/index.ts
+// src/spec/index.ts
 var index_exports = {};
 __export(index_exports, {
   validateActionResponse: () => validateActionResponse,
@@ -852,7 +852,10 @@ var allOfSchemaSchema = import_zod.z.lazy(
     analyticsId: import_zod.z.string().optional(),
     alert: alertLayoutSchema.optional(),
     media: mediaSchema.optional(),
-    tags: import_zod.z.array(import_zod.z.string()).optional()
+    tags: import_zod.z.array(import_zod.z.string()).optional(),
+    additionalText: import_zod.z.string().optional(),
+    supportingValues: supportingValuesSchema.optional(),
+    inlineAlert: inlineAlertSchema.optional()
   })
 );
 var arraySchemaSchema = import_zod.z.lazy(
@@ -881,7 +884,10 @@ var blobSchemaSchema = import_zod.z.lazy(
     source: uploadSourceSchema.optional(),
     disabled: import_zod.z.boolean().optional(),
     media: mediaSchema.optional(),
-    tags: import_zod.z.array(import_zod.z.string()).optional()
+    tags: import_zod.z.array(import_zod.z.string()).optional(),
+    additionalText: import_zod.z.string().optional(),
+    supportingValues: supportingValuesSchema.optional(),
+    inlineAlert: inlineAlertSchema.optional()
   })
 );
 var booleanSchemaSchema = import_zod.z.lazy(
@@ -912,14 +918,16 @@ var booleanSchemaSchema = import_zod.z.lazy(
     help: helpSchema.optional(),
     onChange: behaviorSchema.optional(),
     media: mediaSchema.optional(),
-    tags: import_zod.z.array(import_zod.z.string()).optional()
+    tags: import_zod.z.array(import_zod.z.string()).optional(),
+    additionalText: import_zod.z.string().optional(),
+    supportingValues: supportingValuesSchema.optional(),
+    inlineAlert: inlineAlertSchema.optional()
   })
 );
 var constSchemaSchema = import_zod.z.lazy(
   () => import_zod.z.object({
     hidden: import_zod.z.boolean().optional(),
     control: import_zod.z.string().optional(),
-    tags: import_zod.z.array(import_zod.z.string()).optional(),
     promoted: import_zod.z.boolean().optional(),
     $id: import_zod.z.string().optional(),
     const: jsonElementSchema,
@@ -933,7 +941,11 @@ var constSchemaSchema = import_zod.z.lazy(
     disabled: import_zod.z.boolean().optional(),
     media: mediaSchema.optional(),
     alert: alertLayoutSchema.optional(),
-    layout: import_zod.z.array(layoutSchema).optional()
+    layout: import_zod.z.array(layoutSchema).optional(),
+    tags: import_zod.z.array(import_zod.z.string()).optional(),
+    additionalText: import_zod.z.string().optional(),
+    supportingValues: supportingValuesSchema.optional(),
+    inlineAlert: inlineAlertSchema.optional()
   })
 );
 var integerSchemaSchema = import_zod.z.lazy(
@@ -969,7 +981,10 @@ var integerSchemaSchema = import_zod.z.lazy(
     help: helpSchema.optional(),
     onChange: behaviorSchema.optional(),
     media: mediaSchema.optional(),
-    tags: import_zod.z.array(import_zod.z.string()).optional()
+    tags: import_zod.z.array(import_zod.z.string()).optional(),
+    additionalText: import_zod.z.string().optional(),
+    supportingValues: supportingValuesSchema.optional(),
+    inlineAlert: inlineAlertSchema.optional()
   })
 );
 var numberSchemaSchema = import_zod.z.lazy(
@@ -1005,7 +1020,10 @@ var numberSchemaSchema = import_zod.z.lazy(
     help: helpSchema.optional(),
     onChange: behaviorSchema.optional(),
     media: mediaSchema.optional(),
-    tags: import_zod.z.array(import_zod.z.string()).optional()
+    tags: import_zod.z.array(import_zod.z.string()).optional(),
+    additionalText: import_zod.z.string().optional(),
+    supportingValues: supportingValuesSchema.optional(),
+    inlineAlert: inlineAlertSchema.optional()
   })
 );
 var objectSchemaSchema = import_zod.z.lazy(
@@ -1030,7 +1048,10 @@ var objectSchemaSchema = import_zod.z.lazy(
     alert: alertLayoutSchema.optional(),
     media: mediaSchema.optional(),
     tags: import_zod.z.array(import_zod.z.string()).optional(),
-    format: import_zod.z.string().optional()
+    format: import_zod.z.string().optional(),
+    additionalText: import_zod.z.string().optional(),
+    supportingValues: supportingValuesSchema.optional(),
+    inlineAlert: inlineAlertSchema.optional()
   })
 );
 var oneOfSchemaSchema = import_zod.z.lazy(
@@ -1063,7 +1084,10 @@ var oneOfSchemaSchema = import_zod.z.lazy(
     disabled: import_zod.z.boolean().optional(),
     onChange: behaviorSchema.optional(),
     media: mediaSchema.optional(),
-    tags: import_zod.z.array(import_zod.z.string()).optional()
+    tags: import_zod.z.array(import_zod.z.string()).optional(),
+    additionalText: import_zod.z.string().optional(),
+    supportingValues: supportingValuesSchema.optional(),
+    inlineAlert: inlineAlertSchema.optional()
   })
 );
 var stringSchemaSchema = import_zod.z.lazy(
@@ -1111,7 +1135,10 @@ var stringSchemaSchema = import_zod.z.lazy(
     suggestions: suggestionsSchema.optional(),
     onChange: behaviorSchema.optional(),
     media: mediaSchema.optional(),
-    tags: import_zod.z.array(import_zod.z.string()).optional()
+    tags: import_zod.z.array(import_zod.z.string()).optional(),
+    additionalText: import_zod.z.string().optional(),
+    supportingValues: supportingValuesSchema.optional(),
+    inlineAlert: inlineAlertSchema.optional()
   })
 );
 var arraySchemaListSchema = import_zod.z.lazy(
@@ -1140,7 +1167,10 @@ var arraySchemaListSchema = import_zod.z.lazy(
     validationMessages: import_zod.z.record(import_zod.z.string()).optional(),
     disabled: import_zod.z.boolean().optional(),
     media: mediaSchema.optional(),
-    tags: import_zod.z.array(import_zod.z.string()).optional()
+    tags: import_zod.z.array(import_zod.z.string()).optional(),
+    additionalText: import_zod.z.string().optional(),
+    supportingValues: supportingValuesSchema.optional(),
+    inlineAlert: inlineAlertSchema.optional()
   })
 );
 var persistAsyncSchema = import_zod.z.lazy(
@@ -1171,7 +1201,10 @@ var arraySchemaTupleSchema = import_zod.z.lazy(
     validationAsync: validateAsyncSchema.optional(),
     alert: alertLayoutSchema.optional(),
     media: mediaSchema.optional(),
-    tags: import_zod.z.array(import_zod.z.string()).optional()
+    tags: import_zod.z.array(import_zod.z.string()).optional(),
+    additionalText: import_zod.z.string().optional(),
+    supportingValues: supportingValuesSchema.optional(),
+    inlineAlert: inlineAlertSchema.optional()
   })
 );
 var pollingOnErrorSchema = import_zod.z.lazy(