@wise/dynamic-flow-types 3.19.0 → 4.0.0-experimental-8f7ea55

package/build/spec/LayoutComponent.d.ts

@@ -1,237 +0,0 @@
-import type { Action } from './Action';
-import type { ExternalStepPollingConfiguration, ExternalStepPollingResponseHandler } from './Polling';
-import type { Schema } from './Schema';
-import type { SearchConfig } from './Search';
-import type { Margin, Size, Icon, Image, Align, Orientation, Reference, Alert, Help, Behavior } from './core';
-export type LayoutComponent = AlertLayout | BoxLayout | ButtonLayout | ColumnsLayout | DecisionLayout | DividerLayout | ExternalLayout | FormLayout | HeadingLayout | ImageLayout | InfoLayout | InstructionsLayout | ListLayout | LoadingIndicatorLayout | MarkdownLayout | ModalLayout | ParagraphLayout | ReviewLayout | StatusListLayout | SearchLayout;
-export type AlertLayoutCallToAction = {
-    title: string;
-    accessibilityDescription?: string;
-    behavior: Behavior;
-};
-export type AlertLayout = Alert & {
-    type: 'alert';
-    callToAction?: AlertLayoutCallToAction;
-};
-export type BoxLayout = {
-    type: 'box';
-    components: LayoutComponent[];
-    width?: Size;
-    margin?: Margin;
-    border?: boolean;
-};
-export type ButtonLayout = {
-    type: 'button';
-    action: Action | Reference;
-    title?: string;
-    control?: 'primary' | 'secondary' | 'tertiary';
-    context?: 'neutral' | 'positive' | 'negative';
-    disabled?: boolean;
-    margin?: Margin;
-    /**
-     * @deprecated Only supported on web client
-     */
-    size?: Size;
-    pinOrder?: number;
-};
-export type ColumnsLayout = {
-    type: 'columns';
-    left: LayoutComponent[];
-    right: LayoutComponent[];
-    bias?: 'none' | 'left' | 'right';
-    margin?: Margin;
-};
-export type DecisionLayout = {
-    type: 'decision';
-    options: DecisionOption[];
-    margin?: Margin;
-    title?: string;
-};
-type DecisionOption = {
-    action: Action | Reference;
-    title: string;
-    description?: string;
-    icon?: Icon;
-    image?: Image;
-    disabled?: boolean;
-};
-/**
- * @deprecated Only supported on web client
- */
-export type DividerLayout = {
-    type: 'divider';
-    margin?: Margin;
-};
-/**
- * @deprecated Please use the external feature set instead
- */
-export type ExternalLayout = {
-    type: 'external';
-    requestUrl: string;
-    polling?: Omit<ExternalStepPollingConfiguration, 'responseHandlers'>;
-    responseHandlers?: ExternalStepPollingResponseHandler[];
-    retryTitle?: string;
-};
-export type FormLayout = {
-    type: 'form';
-    schemaId?: never;
-    schema: Schema | Reference;
-    margin?: Margin;
-} | {
-    type: 'form';
-    schemaId: string;
-    schema?: never;
-    margin?: Margin;
-};
-export type HeadingLayout = {
-    type: 'heading';
-    size?: Size;
-    text: string;
-    margin?: Margin;
-    align?: Align;
-    control?: string;
-};
-export type ImageLayout = {
-    type: 'image';
-    content?: {
-        accessibilityDescription?: string;
-        /**
-         * @deprecated Please use accessibilityDescription
-         */
-        text?: string;
-        /**
-         * @deprecated Please use uri
-         */
-        url?: string;
-        uri?: string;
-    };
-    /**
-     * @deprecated Please use content.uri
-     */
-    url: string;
-    /**
-     * @deprecated Please use accessibilityDescription
-     */
-    text?: string;
-    size?: Size;
-    margin?: Margin;
-    /**
-     * @deprecated Please use content.accessibilityDescription
-     */
-    accessibilityDescription?: string;
-};
-/**
- * @deprecated Please use MarkdownLayout instead
- */
-export type InfoLayout = {
-    type: 'info';
-    markdown: string;
-    margin?: Margin;
-    align?: Align;
-};
-export type InstructionsLayout = {
-    type: 'instructions';
-    title?: string;
-    items: Instruction[];
-    margin?: Margin;
-};
-/**
- * @deprecated Please use StatusListLayout instead
- */
-export type ListLayout = {
-    type: 'list';
-    items: ListItem[];
-    title?: string;
-    margin?: Margin;
-};
-type ListItem = {
-    title: string;
-    description?: string;
-    icon?: Icon;
-    status?: 'positive' | 'neutral' | 'warning';
-};
-export type StatusListLayout = {
-    type: 'status-list';
-    items: StatusListItem[];
-    title?: string;
-    margin?: Margin;
-};
-type StatusListItem = {
-    title: string;
-    description?: string;
-    icon?: Icon;
-    status?: 'done' | 'not-done' | 'pending';
-    callToAction?: StatusListItemCallToAction;
-};
-type StatusListItemCallToAction = {
-    title: string;
-    accessibilityDescription?: string;
-    behavior: Behavior;
-};
-export type LoadingIndicatorLayout = {
-    type: 'loading-indicator';
-    margin?: Margin;
-    size?: Size;
-};
-export type MarkdownLayout = {
-    type: 'markdown';
-    content: string;
-    margin?: Margin;
-    align?: Align;
-};
-export type ModalLayout = {
-    type: 'modal';
-    control?: string;
-    trigger: {
-        title: string;
-    };
-    content: {
-        components: LayoutComponent[];
-        title?: string;
-    };
-    margin?: Margin;
-};
-export type ParagraphLayout = {
-    type: 'paragraph';
-    text: string;
-    control?: 'copyable';
-    margin?: Margin;
-    align?: Align;
-};
-export type ReviewLayout = {
-    type: 'review';
-    title?: string;
-    fields: ReviewField[];
-    control?: string;
-    /**
-     * @deprecated Use `control` instead.
-     */
-    orientation?: Orientation;
-    margin?: Margin;
-    /**
-     * @deprecated Please use callToAction instead
-     */
-    action?: Action;
-    callToAction?: {
-        title: string;
-        action: Action;
-        behavior?: Behavior;
-    };
-};
-export type SearchLayout = SearchConfig & {
-    type: 'search';
-    title: string;
-    control?: string;
-    emptyMessage: string;
-    margin?: Margin;
-};
-type ReviewField = {
-    label: string;
-    value: string | number | boolean | null | undefined;
-    help?: Help;
-};
-type Instruction = {
-    text: string;
-    context: 'positive' | 'negative' | 'neutral' | 'warning';
-};
-export {};

package/build/spec/Model.d.ts

@@ -1,6 +0,0 @@
-export type BasicModel = boolean | number | string;
-export type ObjectModel = {
-    [key: string]: Model;
-};
-export type ArrayModel = (Model | null)[];
-export type Model = BasicModel | ObjectModel | ArrayModel | null;

package/build/spec/Navigation.d.ts

@@ -1,14 +0,0 @@
-import type { Action } from './Action';
-export type Navigation = {
-    back?: BackBehaviour;
-    /**
-     * @deprecated Please use back instead
-     */
-    backButton?: BackBehaviour;
-    stackBehavior?: StackBehavior;
-};
-export type BackBehaviour = {
-    title?: string;
-    action: Action;
-};
-export type StackBehavior = 'default' | 'remove-previous' | 'remove-all' | 'replace-current';

package/build/spec/PersistAsync.d.ts

@@ -1,8 +0,0 @@
-import type { Schema } from './Schema';
-export type PersistAsync = {
-    idProperty: string;
-    method?: 'POST' | 'PUT' | 'PATCH';
-    param: string;
-    schema: Schema;
-    url: string;
-};

package/build/spec/Polling.d.ts

@@ -1,28 +0,0 @@
-import type { Action } from './Action';
-export type PollingConfiguration = {
-    url: string;
-    interval?: number;
-    delay?: number;
-    timeout?: number;
-    maxAttempts: number;
-    onError: {
-        action: Action;
-    };
-};
-export type PollingResponse = {
-    action: Action;
-} | null;
-/**
- * @deprecated Please use external feature instead of external step
- */
-export type ExternalStepPollingConfiguration = PollingConfiguration & {
-    maxConsecutiveFails: number;
-    responseHandlers: ExternalStepPollingResponseHandler[];
-};
-/**
- * @deprecated Please use external feature instead of external step
- */
-export type ExternalStepPollingResponseHandler = {
-    result: string;
-    action: Action;
-};

package/build/spec/Promotion.d.ts

@@ -1,20 +0,0 @@
-import type { Icon, Image } from './core';
-export type Promotion = {
-    displayTwice?: boolean;
-    other: {
-        description?: string;
-        heading?: {
-            text: string;
-        };
-        icon?: Icon;
-        image?: Image;
-        title: string;
-    };
-    promoted?: {
-        title?: string;
-        description?: string;
-    };
-    control?: string;
-    checkedMeans?: 'promoted' | 'other';
-    default?: 'promoted' | 'other';
-};

package/build/spec/Schema.d.ts

@@ -1,191 +0,0 @@
-import type { AutocompleteToken } from './AutocompleteToken';
-import type { FileUploadSchema } from './FileUploadSchema';
-import type { Model, ObjectModel } from './Model';
-import type { PersistAsync } from './PersistAsync';
-import type { Promotion } from './Promotion';
-import type { ValidationAsync } from './ValidationAsync';
-import type { Icon, Image, Alert, Help } from './core';
-export type Schema = AllOfSchema | ArraySchema | BlobSchema | BooleanSchema | IntegerSchema | NumberSchema | ObjectSchema | OneOfSchema | StringSchema | ListArraySchema | TupleArraySchema | FileUploadSchema | MultipleFileUploadSchema | MultiSelectSchema | ConstSchema;
-type SchemaBase = {
-    $id?: string;
-    type?: 'boolean' | 'blob' | 'array' | 'integer' | 'number' | 'string' | 'object';
-    alert?: Alert;
-    autofillProvider?: string;
-    autofillKey?: string;
-    allOf?: never;
-    analyticsId?: string;
-    const?: Model;
-    default?: Model;
-    description?: string;
-    disabled?: boolean;
-    format?: string;
-    help?: Help;
-    hidden?: boolean;
-    icon?: Icon;
-    image?: Image;
-    oneOf?: never;
-    persistAsync?: never;
-    promoted?: boolean;
-    promotion?: never;
-    /**
-     * @deprecated Please use disabled
-     */
-    readOnly?: boolean;
-    refreshStepOnChange?: boolean;
-    /**
-     * @deprecated Please use refreshStepOnChange instead
-     */
-    refreshFormOnChange?: boolean;
-    refreshUrl?: string;
-    /**
-     * @deprecated Please use refreshUrl instead
-     */
-    refreshFormUrl?: string;
-    summary?: SchemaSummary;
-    title?: string;
-    validationAsync?: ValidationAsync;
-    validationMessages?: Record<string, string>;
-    /**
-     * @deprecated Please use oneOf instead
-     */
-    values?: {
-        label: string;
-        value: string | number;
-    }[];
-    /**
-     * @deprecated Please use layouts instead
-     */
-    width?: string;
-    keywords?: string[];
-};
-export type AllOfSchema = Omit<SchemaBase, 'allOf'> & {
-    allOf: Schema[];
-    maximum?: number;
-    minimum?: number;
-    minLength?: number;
-    maxLength?: number;
-    minItems?: number;
-    maxItems?: number;
-    required?: string[];
-    disabled?: never;
-};
-export type ArraySchema = Omit<SchemaBase, 'persistAsync'> & {
-    type: 'array';
-    addItemTitle: string;
-    editItemTitle: string;
-    items: Schema | Schema[];
-    maxItems?: number;
-    minItems?: number;
-    persistAsync?: PersistAsync;
-    summary?: ArraySchemaSummary;
-};
-export type ListArraySchema = ArraySchema & {
-    items: Schema;
-};
-export type TupleArraySchema = ArraySchema & {
-    items: Schema[];
-};
-export type MultipleFileUploadSchema = ListArraySchema & {
-    items: PersistAsyncSchema;
-};
-export type MultiSelectSchema = ListArraySchema & {
-    placeholder?: string;
-    items: Omit<OneOfSchema, 'oneOf'> & {
-        oneOf: ConstSchema[];
-    };
-};
-export type BlobSchema = SchemaBase & {
-    type: 'blob';
-    accepts?: string[];
-    source?: 'file' | 'camera';
-    maxSize?: number;
-};
-export type BooleanSchema = SchemaBase & {
-    type: 'boolean';
-    default?: boolean;
-    const?: boolean;
-    oneOf?: BooleanSchema[];
-};
-export type ConstSchema = SchemaBase & {
-    type?: never;
-    const: Model;
-};
-export type IntegerSchema = Omit<SchemaBase, 'persistAsync'> & {
-    type: 'integer';
-    default?: number;
-    maximum?: number;
-    minimum?: number;
-    persistAsync?: PersistAsync;
-    placeholder?: string | number;
-    autocompleteHint?: AutocompleteToken[];
-    const?: number;
-    oneOf?: IntegerSchema[];
-};
-export type NumberSchema = SchemaBase & Omit<IntegerSchema, 'type'> & {
-    type: 'number';
-    oneOf?: NumberSchema[];
-};
-export type ObjectSchema = SchemaBase & {
-    type: 'object';
-    displayOrder: string[];
-    properties: Record<string, Schema>;
-    required?: string[];
-    oneOf?: ObjectSchema[];
-};
-export type OneOfSchema = Omit<SchemaBase, 'oneOf' | 'promotion'> & {
-    oneOf: Schema[];
-    promotion?: Promotion;
-    maximum?: number;
-    minimum?: number;
-    minLength?: number;
-    maxLength?: number;
-    minItems?: number;
-    maxItems?: number;
-    required?: string[];
-    default?: Model;
-    placeholder?: Model;
-    autocompleteHint?: AutocompleteToken[];
-    control?: string;
-};
-export type OneOfObjectSchema = Omit<OneOfSchema, 'oneOf' | 'default'> & {
-    oneOf: ObjectSchema[];
-    default?: ObjectModel;
-};
-export type PersistAsyncSchema = Schema & {
-    persistAsync: PersistAsync;
-};
-export type StringSchema = Omit<SchemaBase, 'persistAsync'> & {
-    type: 'string';
-    control?: string;
-    default?: string;
-    displayFormat?: string;
-    minimum?: string;
-    maximum?: string;
-    maxLength?: number;
-    minLength?: number;
-    pattern?: string;
-    persistAsync?: PersistAsync;
-    placeholder?: string;
-    autocompleteHint?: AutocompleteToken[];
-    const?: string;
-    oneOf?: StringSchema[];
-    maxSize?: number;
-    accepts?: string[];
-};
-export type BasicSchema = BooleanSchema | IntegerSchema | NumberSchema | StringSchema;
-export type ValidationAsyncSchema = BasicSchema & {
-    validationAsync: ValidationAsync;
-};
-type SchemaSummary = {
-    providesDescription?: boolean;
-    providesIcon?: boolean;
-    providesImage?: boolean;
-    providesTitle?: boolean;
-};
-type ArraySchemaSummary = SchemaSummary & {
-    defaultDescription?: string;
-    defaultIcon?: Icon;
-    defaultImage?: Image;
-    defaultTitle?: string;
-};
-export {};

package/build/spec/Search.d.ts

@@ -1,21 +0,0 @@
-import type { Action } from './Action';
-import type { HttpMethod, Icon, Image } from './core';
-export type SearchConfig = {
-    url: string;
-    method: HttpMethod;
-    param: string;
-};
-export type SearchResult = {
-    title: string;
-    description?: string;
-    icon?: Icon;
-    image?: Image;
-} & ({
-    type: 'action';
-    value: Action;
-} | {
-    type: 'search';
-    value: SearchConfig & {
-        query: string;
-    };
-});

package/build/spec/Step.d.ts

@@ -1,112 +0,0 @@
-import type { Action } from './Action';
-import type { LayoutComponent } from './LayoutComponent';
-import type { ObjectModel } from './Model';
-import type { Navigation } from './Navigation';
-import type { ExternalStepPollingConfiguration, ExternalStepPollingResponseHandler, PollingConfiguration } from './Polling';
-import type { Schema } from './Schema';
-import type { Image } from './core';
-export type Step = FormStep | DecisionStep | ExternalStep | FinalStep;
-type BaseStep = {
-    id?: string;
-    /**
-     * @deprecated Please use id instead
-     */
-    key?: string;
-    type?: string;
-    title?: string;
-    description?: string;
-    analytics?: Record<string, unknown>;
-    layout?: LayoutComponent[];
-    schemas?: Schema[];
-    actions?: Action[];
-    model?: ObjectModel;
-    /**
-     * @experimental navigation is experimental and subject to change
-     */
-    navigation?: Navigation;
-    refreshUrl?: string;
-    /**
-     * @deprecated Please use refreshUrl instead
-     */
-    refreshFormUrl?: string;
-    polling?: PollingConfiguration;
-    external?: {
-        url: string;
-    };
-    errors?: {
-        error?: GlobalError;
-        validation?: FormErrors;
-    };
-};
-export type FormStep = BaseStep & {
-    type?: 'form';
-    title: string;
-    layout: LayoutComponent[];
-    schemas: Schema[];
-    errors?: unknown;
-};
-/**
- * @deprecated Please use a form step with a layout instead
- */
-export type FinalStep = BaseStep & {
-    type: 'final';
-    actions: Action[];
-    details: {
-        description: string;
-        image?: Image;
-        title: string;
-    };
-    success: boolean;
-};
-/**
- * @deprecated Please use the external feature set instead
- */
-export type ExternalStep = BaseStep & {
-    type: 'external';
-    description?: string;
-    polling?: Omit<ExternalStepPollingConfiguration, 'responseHandlers'>;
-    requestUrl: string;
-    responseHandlers?: ExternalStepPollingResponseHandler[];
-    retryTitle?: string;
-    title: string;
-};
-/**
- * @deprecated Please use DecisionLayout instead
- */
-export type DecisionStep = BaseStep & {
-    type: 'decision';
-    options?: DecisionStepOption[];
-};
-/**
- * @deprecated Please use DecisionLayout instead
- */
-export type DecisionStepOption = {
-    title: string;
-    description?: string;
-    url: string;
-    disabled?: boolean;
-};
-export type FormErrors = Record<string, unknown> | string | undefined | null;
-export type GlobalError = string | undefined | null;
-/**
- * @deprecated Please use the review layout component
- */
-export type LegacyReviewStep = Omit<FormStep, 'actions' | 'schemas' | 'layout'> & {
-    reviewFields?: LegacyReviewFields;
-    actions?: Action[];
-    schemas?: Schema[];
-};
-export type LegacyReviewFields = {
-    title?: string;
-    fields: {
-        title: string;
-        value: string;
-    }[];
-};
-export type LegacyFormStep = Step & {
-    type?: 'form';
-    reviewFields?: LegacyReviewFields;
-    schemas?: Schema[];
-    actions?: Action[];
-};
-export {};

package/build/spec/ValidationAsync.d.ts

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

package/build/spec/core.d.ts

@@ -1,47 +0,0 @@
-import { Action } from './Action';
-export type Image = {
-    type?: 'image';
-    url: string;
-    text?: string;
-    name?: string;
-};
-export type Icon = {
-    name?: string;
-    text?: never;
-} | {
-    name?: never;
-    text?: string;
-};
-export type Size = 'xs' | 'sm' | 'md' | 'lg' | 'xl';
-export type Margin = Size;
-export type Context = 'neutral' | 'warning' | 'positive' | 'negative';
-export type Orientation = 'horizontal' | 'vertical';
-export type Align = 'left' | 'right' | 'center';
-export type HttpMethod = 'POST' | 'GET' | 'PUT' | 'PATCH' | 'DELETE';
-export type Reference = {
-    $ref: string;
-};
-/** @deprecated Prefer Context */
-export type LegacyContext = 'success' | 'failure' | 'info' | 'primary';
-export type Alert = {
-    type?: 'alert';
-    markdown: string;
-    context?: Context | LegacyContext;
-    margin?: Margin;
-};
-export type Help = {
-    markdown: string;
-};
-export type Behavior = {
-    type: 'action';
-    action: Action;
-} | {
-    type: 'link';
-    url: string;
-} | {
-    action?: Action;
-    link?: Link;
-};
-export type Link = {
-    url: string;
-};