@wise/dynamic-flow-types 2.3.1 → 2.4.1

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

@@ -0,0 +1,35 @@
+import type { ActionType } from './ActionType';
+import type { HttpMethod } from '../misc/HttpMethod';
+export type Action = {
+    id?: string;
+    url?: string;
+    method?: HttpMethod;
+    exit?: boolean;
+    result?: unknown;
+    data?: unknown;
+    timeout?: number;
+    /**
+    * @deprecated Please use Button.title instead
+    */
+    title?: string;
+    /**
+    * @deprecated Please use Button.title instead or Button.context instead
+    */
+    type?: ActionType;
+    /**
+    * @deprecated Please use Button.disabled instead or Button.context instead
+    */
+    disabled?: boolean;
+    /**
+    * @deprecated Please use 'id' instead
+    */
+    $id?: string;
+    /**
+    * @deprecated Action references are deprecated.
+    */
+    $ref?: string;
+    /**
+    * @experimental This feature may be changed in the future without notice.
+    */
+    skipValidation?: boolean;
+};

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

@@ -0,0 +1,4 @@
+/**
+* @deprecated Please use Button.control and Button.context instead
+*/
+export type ActionType = 'primary' | 'secondary' | 'link' | 'positive' | 'negative';

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

@@ -0,0 +1,3 @@
+export type External = {
+    url: string;
+};

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

@@ -0,0 +1,3 @@
+export type Help = {
+    markdown: string;
+};

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

@@ -0,0 +1,5 @@
+import type { Action } from './Action';
+export type LinkHandler = {
+    regexPattern: string;
+    action: Action;
+};

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

@@ -0,0 +1,11 @@
+import type { NavigationBackBehaviour } from './NavigationBackBehaviour';
+/**
+* @experimental This feature may be changed in the future without notice.
+*/
+export type Navigation = {
+    back?: NavigationBackBehaviour;
+    /**
+    * @deprecated Please use 'back' instead
+    */
+    backButton?: NavigationBackBehaviour;
+};

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

@@ -0,0 +1,8 @@
+import type { Action } from './Action';
+/**
+* @experimental This feature may be changed in the future without notice.
+*/
+export type NavigationBackBehaviour = {
+    title?: string;
+    action: Action;
+};

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

@@ -0,0 +1,9 @@
+import type { Schema } from '../schema/Schema';
+import type { HttpMethod } from '../misc/HttpMethod';
+export type PersistAsync = {
+    param: string;
+    idProperty: string;
+    schema: Schema;
+    url: string;
+    method: HttpMethod;
+};

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

@@ -0,0 +1,7 @@
+import type { PollingOnError } from './PollingOnError';
+export type Polling = {
+    url: string;
+    interval: number;
+    maxAttempts: number;
+    onError: PollingOnError;
+};

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

@@ -0,0 +1,4 @@
+import type { Action } from './Action';
+export type PollingOnError = {
+    action: Action;
+};

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

@@ -0,0 +1,4 @@
+export type StepError = {
+    error?: string;
+    validation?: unknown;
+};

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

@@ -0,0 +1,3 @@
+import type { SummaryProvider } from './SummaryProvider';
+import type { SummarySummariser } from './SummarySummariser';
+export type Summary = SummaryProvider | SummarySummariser;

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

@@ -0,0 +1,6 @@
+export type SummaryProvider = {
+    providesTitle?: boolean;
+    providesDescription?: boolean;
+    providesIcon?: boolean;
+    providesImage?: boolean;
+};

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

@@ -0,0 +1,12 @@
+import type { Icon } from '../misc/Icon';
+import type { ImageLayout } from '../layout/ImageLayout';
+export type SummarySummariser = {
+    defaultTitle?: string;
+    defaultDescription?: string;
+    defaultIcon?: Icon;
+    defaultImage?: ImageLayout;
+    providesTitle?: boolean;
+    providesDescription?: boolean;
+    providesIcon?: boolean;
+    providesImage?: boolean;
+};

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

@@ -0,0 +1,6 @@
+import type { HttpMethod } from '../misc/HttpMethod';
+export type ValidateAsync = {
+    param: string;
+    method: HttpMethod;
+    url: string;
+};

package/build/next/index.d.ts

@@ -0,0 +1,46 @@
+import type { Step as GeneratedStep } from './step/Step';
+import type { FormLayout as GeneratedFormLayout } from './layout/FormLayout';
+export type { Action } from './feature/Action';
+export type { Align } from './misc/Align';
+export type { Context } from './misc/Context';
+export type { Size } from './misc/Size';
+export type { Size as Margin } from './misc/Size';
+export type { Layout } from './layout/Layout';
+export type { AlertLayout } from './layout/AlertLayout';
+export type { BoxLayout } from './layout/BoxLayout';
+export type { ButtonLayout } from './layout/ButtonLayout';
+export type { ColumnsLayout } from './layout/ColumnsLayout';
+export type FormLayout = GeneratedFormLayout & {
+    schema?: Reference;
+};
+export type { HeadingLayout } from './layout/HeadingLayout';
+export type { ParagraphLayout } from './layout/ParagraphLayout';
+export type { Schema } from './schema/Schema';
+export type { ObjectSchema } from './schema/ObjectSchema';
+export type { AllOfSchema } from './schema/AllOfSchema';
+export type { OneOfSchema } from './schema/OneOfSchema';
+export type { StringSchema } from './schema/StringSchema';
+export type { NumberSchema } from './schema/NumberSchema';
+export type { IntegerSchema } from './schema/IntegerSchema';
+export type { StringSchemaFormat } from './schema/StringSchemaFormat';
+type BasicModel = boolean | number | string;
+type ObjectModel = {
+    [key: string]: Model;
+};
+type ArrayModel = (Model | null)[];
+export type Model = BasicModel | ObjectModel | ArrayModel | null;
+type ValidationErrorObject = {
+    [key: string]: ValidationError;
+};
+export type ValidationError = string | ValidationErrorObject | null;
+export type StepError = {
+    error?: string;
+    validation?: ValidationError;
+};
+export type Step = Omit<GeneratedStep, 'model' | 'errors'> & {
+    model?: Model;
+    errors?: StepError;
+};
+export type Reference = {
+    $ref: string;
+};

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

@@ -0,0 +1,9 @@
+import type { Context } from '../misc/Context';
+import type { Size } from '../misc/Size';
+export type AlertLayout = {
+    type: 'alert';
+    markdown: string;
+    context?: Context;
+    control?: string;
+    margin?: Size;
+};

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

@@ -0,0 +1,10 @@
+import type { Layout } from './Layout';
+import type { Size } from '../misc/Size';
+export type BoxLayout = {
+    type: 'box';
+    components: Layout[];
+    width?: Size;
+    border?: boolean;
+    control?: string;
+    margin?: Size;
+};

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

@@ -0,0 +1,17 @@
+import type { Size } from '../misc/Size';
+import type { Action } from '../feature/Action';
+import type { Context } from '../misc/Context';
+export type ButtonLayout = {
+    type: 'button';
+    title: string;
+    action: Action;
+    context?: Context;
+    disabled?: boolean;
+    pinOrder?: number;
+    control?: string;
+    margin?: Size;
+    /**
+    * @deprecated This is a web only feature that will be removed in a later release
+    */
+    size?: Size;
+};

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

@@ -0,0 +1,11 @@
+import type { Layout } from './Layout';
+import type { ColumnsLayoutBias } from './ColumnsLayoutBias';
+import type { Size } from '../misc/Size';
+export type ColumnsLayout = {
+    type: 'columns';
+    left: Layout[];
+    right: Layout[];
+    bias?: ColumnsLayoutBias;
+    control?: string;
+    margin?: Size;
+};

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

@@ -0,0 +1 @@
+export type ColumnsLayoutBias = 'none' | 'left' | 'right';

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

@@ -0,0 +1,8 @@
+import type { DecisionLayoutOption } from './DecisionLayoutOption';
+import type { Size } from '../misc/Size';
+export type DecisionLayout = {
+    type: 'decision';
+    options: DecisionLayoutOption[];
+    control?: string;
+    margin?: Size;
+};

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

@@ -0,0 +1,11 @@
+import type { Action } from '../feature/Action';
+import type { Icon } from '../misc/Icon';
+import type { ImageLayout } from './ImageLayout';
+export type DecisionLayoutOption = {
+    action: Action;
+    title: string;
+    description?: string;
+    disabled?: boolean;
+    icon?: Icon;
+    image?: ImageLayout;
+};

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

@@ -0,0 +1,9 @@
+import type { Size } from '../misc/Size';
+/**
+* @deprecated Divider is deprecated and only supported on web. Please do not use.
+*/
+export type DividerLayout = {
+    type: 'divider';
+    control?: string;
+    margin?: Size;
+};

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

@@ -0,0 +1,12 @@
+import type { FormLayoutSchemaReference } from './FormLayoutSchemaReference';
+import type { Size } from '../misc/Size';
+export type FormLayout = {
+    type: 'form';
+    schemaId: string;
+    control?: string;
+    margin?: Size;
+    /**
+    * @deprecated Please use 'schemaId' instead.
+    */
+    schema?: FormLayoutSchemaReference;
+};

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

@@ -0,0 +1,6 @@
+/**
+* @deprecated Please use 'schemaId' instead.
+*/
+export type FormLayoutSchemaReference = {
+    $ref: string;
+};

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

@@ -0,0 +1,10 @@
+import type { Size } from '../misc/Size';
+import type { Align } from '../misc/Align';
+export type HeadingLayout = {
+    type: 'heading';
+    text: string;
+    size?: Size;
+    align?: Align;
+    control?: string;
+    margin?: Size;
+};

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

@@ -0,0 +1,16 @@
+import type { Size } from '../misc/Size';
+export type ImageLayout = {
+    type: 'image';
+    url: string;
+    size?: Size;
+    control?: string;
+    margin?: Size;
+    /**
+    * @deprecated Please use 'accessibilityDescription' instead
+    */
+    text?: string;
+    /**
+    * @experimental This feature may be changed in the future without notice.
+    */
+    accessibilityDescription?: string;
+};

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

@@ -0,0 +1,12 @@
+import type { Align } from '../misc/Align';
+import type { Size } from '../misc/Size';
+/**
+* @deprecated Please use 'MarkdownLayout' instead
+*/
+export type InfoLayout = {
+    type: 'info';
+    markdown: string;
+    align?: Align;
+    control?: string;
+    margin?: Size;
+};

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

@@ -0,0 +1,9 @@
+import type { InstructionsLayoutItem } from './InstructionsLayoutItem';
+import type { Size } from '../misc/Size';
+export type InstructionsLayout = {
+    type: 'instructions';
+    title?: string;
+    items: InstructionsLayoutItem[];
+    control?: string;
+    margin?: Size;
+};

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

@@ -0,0 +1,5 @@
+import type { Context } from '../misc/Context';
+export type InstructionsLayoutItem = {
+    text: string;
+    context: Context;
+};

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

@@ -0,0 +1,20 @@
+import type { AlertLayout } from './AlertLayout';
+import type { BoxLayout } from './BoxLayout';
+import type { ButtonLayout } from './ButtonLayout';
+import type { ColumnsLayout } from './ColumnsLayout';
+import type { DecisionLayout } from './DecisionLayout';
+import type { DividerLayout } from './DividerLayout';
+import type { FormLayout } from './FormLayout';
+import type { HeadingLayout } from './HeadingLayout';
+import type { ImageLayout } from './ImageLayout';
+import type { InfoLayout } from './InfoLayout';
+import type { InstructionsLayout } from './InstructionsLayout';
+import type { ListLayout } from './ListLayout';
+import type { LoadingIndicatorLayout } from './LoadingIndicatorLayout';
+import type { MarkdownLayout } from './MarkdownLayout';
+import type { ModalLayout } from './ModalLayout';
+import type { ParagraphLayout } from './ParagraphLayout';
+import type { ReviewLayout } from './ReviewLayout';
+import type { SearchLayout } from './SearchLayout';
+import type { StatusListLayout } from './StatusListLayout';
+export type Layout = AlertLayout | BoxLayout | ButtonLayout | ColumnsLayout | DecisionLayout | DividerLayout | FormLayout | HeadingLayout | ImageLayout | InfoLayout | InstructionsLayout | ListLayout | LoadingIndicatorLayout | MarkdownLayout | ModalLayout | ParagraphLayout | ReviewLayout | SearchLayout | StatusListLayout;

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

@@ -0,0 +1,12 @@
+import type { ListLayoutItem } from './ListLayoutItem';
+import type { Size } from '../misc/Size';
+/**
+* @deprecated Please use 'StatusListLayout' instead
+*/
+export type ListLayout = {
+    type: 'list';
+    items: ListLayoutItem[];
+    title?: string;
+    control?: string;
+    margin?: Size;
+};

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

@@ -0,0 +1,11 @@
+import type { Icon } from '../misc/Icon';
+import type { ListLayoutStatus } from './ListLayoutStatus';
+/**
+* @deprecated Please use 'StatusListLayout' instead
+*/
+export type ListLayoutItem = {
+    title: string;
+    description?: string;
+    icon: Icon;
+    status?: ListLayoutStatus;
+};

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

@@ -0,0 +1,4 @@
+/**
+* @deprecated Please use 'StatusListLayout' instead
+*/
+export type ListLayoutStatus = 'warning' | 'neutral' | 'positive';

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

@@ -0,0 +1,7 @@
+import type { Size } from '../misc/Size';
+export type LoadingIndicatorLayout = {
+    type: 'loading-indicator';
+    size?: Size;
+    control?: string;
+    margin?: Size;
+};

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

@@ -0,0 +1,9 @@
+import type { Align } from '../misc/Align';
+import type { Size } from '../misc/Size';
+export type MarkdownLayout = {
+    type: 'markdown';
+    content: string;
+    align?: Align;
+    control?: string;
+    margin?: Size;
+};

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

@@ -0,0 +1,13 @@
+import type { Size } from '../misc/Size';
+import type { ModalLayoutTrigger } from './ModalLayoutTrigger';
+import type { ModalLayoutContent } from './ModalLayoutContent';
+/**
+* @experimental This feature may be changed in the future without notice.
+*/
+export type ModalLayout = {
+    type: 'modal';
+    control?: string;
+    margin?: Size;
+    trigger: ModalLayoutTrigger;
+    content: ModalLayoutContent;
+};

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

@@ -0,0 +1,4 @@
+import type { Layout } from './Layout';
+export type ModalLayoutContent = {
+    components: Layout[];
+};

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

@@ -0,0 +1,3 @@
+export type ModalLayoutTrigger = {
+    title: string;
+};

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

@@ -0,0 +1,9 @@
+import type { Align } from '../misc/Align';
+import type { Size } from '../misc/Size';
+export type ParagraphLayout = {
+    type: 'paragraph';
+    text: string;
+    align?: Align;
+    control?: string;
+    margin?: Size;
+};

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

@@ -0,0 +1,20 @@
+import type { Action } from '../feature/Action';
+import type { ReviewLayoutField } from './ReviewLayoutField';
+import type { ReviewLayoutCallToAction } from './ReviewLayoutCallToAction';
+import type { Size } from '../misc/Size';
+export type ReviewLayout = {
+    type: 'review';
+    fields: ReviewLayoutField[];
+    title?: string;
+    callToAction?: ReviewLayoutCallToAction;
+    control?: string;
+    margin?: Size;
+    /**
+    * @deprecated Please use 'control' instead
+    */
+    orientation?: string;
+    /**
+    * @deprecated Please use 'callToAction' instead
+    */
+    action?: Action;
+};

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

@@ -0,0 +1,5 @@
+import type { Action } from '../feature/Action';
+export type ReviewLayoutCallToAction = {
+    title: string;
+    action: Action;
+};

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

@@ -0,0 +1,6 @@
+import type { Help } from '../feature/Help';
+export type ReviewLayoutField = {
+    label: string;
+    value: string;
+    help?: Help;
+};

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

@@ -0,0 +1,12 @@
+import type { HttpMethod } from '../misc/HttpMethod';
+import type { Size } from '../misc/Size';
+export type SearchLayout = {
+    type: 'search';
+    title: string;
+    method: HttpMethod;
+    url: string;
+    param: string;
+    emptyMessage?: string;
+    control?: string;
+    margin?: Size;
+};

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

@@ -0,0 +1,9 @@
+import type { StatusListLayoutItem } from './StatusListLayoutItem';
+import type { Size } from '../misc/Size';
+export type StatusListLayout = {
+    type: 'status-list';
+    items: StatusListLayoutItem[];
+    title?: string;
+    control?: string;
+    margin?: Size;
+};

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

@@ -0,0 +1,8 @@
+import type { Icon } from '../misc/Icon';
+import type { StatusListLayoutStatus } from './StatusListLayoutStatus';
+export type StatusListLayoutItem = {
+    title: string;
+    description?: string;
+    icon: Icon;
+    status?: StatusListLayoutStatus;
+};

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

@@ -0,0 +1 @@
+export type StatusListLayoutStatus = 'not-done' | 'pending' | 'done';

package/build/next/misc/Align.d.ts

@@ -0,0 +1 @@
+export type Align = 'left' | 'center' | 'right';

package/build/next/misc/AutocompleteToken.d.ts

@@ -0,0 +1 @@
+export type AutocompleteToken = 'on' | 'name' | 'name-prefix' | 'given-name' | 'additional-name' | 'family-name' | 'name-suffix' | 'nickname' | 'email' | 'username' | 'new-username' | 'new-password' | 'password' | 'one-time-code' | 'job-title' | 'organization-name' | 'full-street-address' | 'street-address-line-1' | 'street-address-line-2' | 'street-address-line-3' | 'address-level-1' | 'address-level-2' | 'address-level-3' | 'address-level-4' | 'country-code' | 'country-name' | 'postal-code' | 'credit-card-name' | 'credit-card-given-name' | 'credit-card-middle-name' | 'credit-card-family-name' | 'credit-card-number' | 'credit-card-expiration' | 'credit-card-expiration-month' | 'credit-card-expiration-year' | 'credit-card-security-code' | 'credit-card-type' | 'transaction-currency' | 'transaction-amount' | 'language' | 'birthdate' | 'birthdate-day' | 'birthdate-month' | 'birthdate-year' | 'gender' | 'phone-number' | 'phone-country-code' | 'phone-national' | 'phone-area-code' | 'phone-local' | 'phone-local-prefix' | 'phone-local-suffix' | 'phone-extension' | 'url' | 'photo' | 'impp' | 'shipping' | 'billing' | 'home' | 'work' | 'mobile' | 'fax' | 'pager';

package/build/next/misc/Context.d.ts

@@ -0,0 +1 @@
+export type Context = 'positive' | 'neutral' | 'warning' | 'negative' | 'success' | 'failure' | 'info' | 'primary';

package/build/next/misc/HttpMethod.d.ts

@@ -0,0 +1 @@
+export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';

package/build/next/misc/Icon.d.ts

@@ -0,0 +1,3 @@
+import type { IconNamed } from './IconNamed';
+import type { IconText } from './IconText';
+export type Icon = IconNamed | IconText;

package/build/next/misc/IconNamed.d.ts

@@ -0,0 +1,3 @@
+export type IconNamed = {
+    name: string;
+};

package/build/next/misc/IconText.d.ts

@@ -0,0 +1,3 @@
+export type IconText = {
+    text: string;
+};

package/build/next/misc/Size.d.ts

@@ -0,0 +1 @@
+export type Size = 'xs' | 'sm' | 'md' | 'lg' | 'xl';

package/build/next/responses/action/ActionResponseBody.d.ts

@@ -0,0 +1,4 @@
+import type { Action } from '../../feature/Action';
+export type ActionResponseBody = {
+    action: Action;
+};

package/build/next/responses/error/ErrorResponseBody.d.ts

@@ -0,0 +1,9 @@
+export type ErrorResponseBody = {
+    error?: string;
+    validation?: unknown;
+    refreshUrl?: string;
+    /**
+    * @deprecated Please use 'refreshUrl' instead
+    */
+    refreshFormUrl?: string;
+};

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

@@ -0,0 +1,4 @@
+import type { SearchResult } from './SearchResult';
+export type SearchResponseBody = {
+    results: SearchResult[];
+};

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

@@ -0,0 +1,3 @@
+import type { SearchResultAction } from './SearchResultAction';
+import type { SearchResultSearch } from './SearchResultSearch';
+export type SearchResult = SearchResultAction | SearchResultSearch;

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

@@ -0,0 +1,11 @@
+import type { Icon } from '../../misc/Icon';
+import type { ImageLayout } from '../../layout/ImageLayout';
+import type { Action } from '../../feature/Action';
+export type SearchResultAction = {
+    type: 'action';
+    title: string;
+    description?: string;
+    icon?: Icon;
+    image?: ImageLayout;
+    value: Action;
+};