@wise/dynamic-flow-types 2.8.0 → 2.9.0

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

@@ -5,28 +5,100 @@ import type { ValidateAsync } from '../feature/ValidateAsync';
 import type { AlertLayout } from '../layout/AlertLayout';
 import type { JsonElement } from '../JsonElement';
 import type { UploadSource } from '../feature/UploadSource';
+/**
+* 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.
+*/
 export type BlobSchema = {
+    /**
+    * It must be `blob`.
+    */
     type: 'blob';
+    /**
+    * If true, the UI for this schema will not accept input, but the corresponding data will still be submitted.
+    *  Defaults to false.
+    */
     disabled?: boolean;
+    /**
+    * @deprecated Please use nested oneOf schemas instead.
+    */
+    promoted?: boolean;
+    /**
+    * A unique id which can be used to refer to the schema.
+    */
     $id?: string;
+    /**
+    * A user-facing title for the schema.
+    */
     title?: string;
+    /**
+    * A user-facing description for the schema.
+    */
     description?: string;
+    /**
+    * An identifier which can be used to request the client use a particular UI control to represent this schema.
+    */
     control?: string;
+    /**
+    * If true, no UI will be shown to the user for this schema, but the corresponding data will still be submitted.
+    * Defaults to false.
+    */
     hidden?: boolean;
+    /**
+    * An icon which the client can use to represent this schema.
+    */
     icon?: Icon;
+    /**
+    * An image which the client can use to represent this schema.
+    */
     image?: Image;
+    /**
+    * A list of keywords that can be used when searching or filtering items in a [com.wise.dynamicflow.schema.OneOfSchema].
+    * Only applies when this schema is child schema in a [com.wise.dynamicflow.schema.OneOfSchema].
+    */
     keywords?: string[];
+    /**
+    * Configure how this schema will be summarised when included in an [ArraySchema].
+    */
     summary?: SummaryProvider;
+    /**
+    * An internal id which is attached to analytics events relating to the schema.
+    * It allows you to override $id during event emission, it is not user-facing and does not have to be unique within the step.
+    */
     analyticsId?: string;
+    /**
+    * @see ValidateAsync
+    */
     validationAsync?: ValidateAsync;
+    /**
+    * An object where each property/value pair is the name of a validation property (e.g. maximum)
+    * to the user-facing error message to display if the validation fails.
+    */
     validationMessages?: Record<string, string>;
+    /**
+    * Configure an alert which will be displayed above the UI for this schema. This can be used to provide warnings or
+    * additional information to the user, but shouldn't be used for validation. For client-side validation please see
+    * the validation available on each schema type, or see [com.wise.dynamicflow.feature.ValidateAsync] and
+    * [com.wise.dynamicflow.feature.Action] for server-side validation.
+    */
     alert?: AlertLayout;
+    /**
+    * Provide client-specific configuration for the camera capture experience.
+    */
     cameraConfig?: JsonElement;
+    /**
+    * Array of MIME types the field should accept. If null, any type of file is accepted.
+    * Wildcard MIME types are allowed, but support for them varies from platform to platform.
+    * Clients must support at least image, audio, and video.
+    * Any unrecognised MIME types will be ignored.
+    */
     accepts?: string[];
+    /**
+    * The maximum file size in bytes. If null, file size is unlimited.
+    */
     maxSize?: number;
-    source?: UploadSource;
     /**
-    * @deprecated Please use nested oneOf schemas instead.
+    * Valid sources for the file. If null, any source is permitted.
     */
-    promoted?: boolean;
+    source?: UploadSource;
 };

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

@@ -5,44 +5,127 @@ import type { PersistAsync } from '../feature/PersistAsync';
 import type { ValidateAsync } from '../feature/ValidateAsync';
 import type { AlertLayout } from '../layout/AlertLayout';
 import type { Help } from '../feature/Help';
+/**
+* Represents a boolean value in the submission.
+*/
 export type BooleanSchema = {
+    /**
+    * It must be `boolean`.
+    */
     type: 'boolean';
+    /**
+    * @deprecated This property is deprecated
+    */
+    autofillProvider?: string;
+    /**
+    * @deprecated Please use nested oneOf schemas instead.
+    */
+    promoted?: boolean;
+    /**
+    * @deprecated Please use 'refreshStepOnChange' instead
+    */
+    refreshFormOnChange?: boolean;
+    /**
+    * @deprecated Please use 'refreshUrl' in Step instead
+    */
+    refreshUrl?: string;
+    /**
+    * @deprecated Please use 'refreshUrl' in Step instead
+    */
+    refreshFormUrl?: string;
+    /**
+    * A unique id which can be used to refer to the schema.
+    */
     $id?: string;
+    /**
+    * A user-facing title for the schema.
+    */
     title?: string;
+    /**
+    * A user-facing description for the schema.
+    */
     description?: string;
+    /**
+    * An identifier which can be used to request the client use a particular UI control to represent this schema.
+    */
     control?: string;
+    /**
+    * The default value to use for this schema. This will be overridden by a value in the model of the
+    * [com.wise.dynamicflow.step.Step] if one is provided.
+    */
     default?: boolean;
+    /**
+    * If true, no UI will be shown to the user for this schema, but the corresponding data will still be submitted.
+    * Defaults to false.
+    */
     hidden?: boolean;
+    /**
+    * If true, the UI for this schema will not accept input, but the corresponding data will still be submitted.
+    *  Defaults to false.
+    */
     disabled?: boolean;
+    /**
+    * An icon which the client can use to represent this schema.
+    */
     icon?: Icon;
+    /**
+    * An image which the client can use to represent this schema.
+    */
     image?: Image;
+    /**
+    * A list of keywords that can be used when searching or filtering items in a [com.wise.dynamicflow.schema.OneOfSchema].
+    * Only applies when this schema is child schema in a [com.wise.dynamicflow.schema.OneOfSchema].
+    */
     keywords?: string[];
+    /**
+    * Configure how this schema will be summarised when included in an [ArraySchema].
+    */
     summary?: SummaryProvider;
+    /**
+    * An internal id which is attached to analytics events relating to the schema.
+    * It allows you to override $id during event emission, it is not user-facing and does not have to be unique within the step.
+    */
     analyticsId?: string;
+    /**
+    * @see PersistAsync
+    */
     persistAsync?: PersistAsync;
-    refreshStepOnChange?: boolean;
-    validationAsync?: ValidateAsync;
-    alert?: AlertLayout;
-    autofillKey?: string;
-    help?: Help;
     /**
-    * @deprecated This property is deprecated
+    * When true, the step will be refreshed when the value of this schema changes.
     */
-    autofillProvider?: string;
+    refreshStepOnChange?: boolean;
     /**
-    * @deprecated Please use nested oneOf schemas instead.
+    * @see ValidateAsync
     */
-    promoted?: boolean;
+    validationAsync?: ValidateAsync;
     /**
-    * @deprecated Please use 'refreshStepOnChange' instead
+    * Configure an alert which will be displayed above the UI for this schema. This can be used to provide warnings or
+    * additional information to the user, but shouldn't be used for validation. For client-side validation please see
+    * the validation available on each schema type, or see [com.wise.dynamicflow.feature.ValidateAsync] and
+    * [com.wise.dynamicflow.feature.Action] for server-side validation.
     */
-    refreshFormOnChange?: boolean;
+    alert?: AlertLayout;
     /**
-    * @deprecated Please use 'refreshUrl' in Step instead
+    * Identifies the type of data which the client can autofill for this schema. This is provided in a `.`
+    * delimited string, in the format `source.prop`, e.g `contact.email`. In this example, the client should
+    * suggest values from the `email` property on objects retrieved from the `contact` source to autofill
+    * this field.
+    * The only currently supported source is `contact`. It will inspect contacts from the native client address
+    * book (if available).
+    * Supported properties on the `contact` source are:
+    * - `givenName`
+    * - `familyName`
+    * - `fullName`
+    * - `email`
+    * - `firstLine`
+    * - `city`
+    * - `state`
+    * - `postalCode`
+    * - `countryCode`
     */
-    refreshUrl?: string;
+    autofillKey?: string;
     /**
-    * @deprecated Please use 'refreshUrl' in Step instead
+    * Provide additional help information to the user.
     */
-    refreshFormUrl?: string;
+    help?: Help;
 };

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

@@ -3,22 +3,71 @@ import type { JsonElement } from '../JsonElement';
 import type { Icon } from '../misc/Icon';
 import type { Image } from '../misc/Image';
 import type { SummaryProvider } from '../feature/SummaryProvider';
+/**
+* Represents a constant value in the submission.
+*/
 export type ConstSchema = {
-    disabled?: boolean;
+    /**
+    * If true, no UI will be shown to the user for this schema, but the corresponding data will still be submitted.
+    * Defaults to false.
+    */
     hidden?: boolean;
+    /**
+    * Configure an alert which will be displayed above the UI for this schema. This can be used to provide warnings or
+    * additional information to the user, but shouldn't be used for validation. For client-side validation please see
+    * the validation available on each schema type, or see [com.wise.dynamicflow.feature.ValidateAsync] and
+    * [com.wise.dynamicflow.feature.Action] for server-side validation.
+    */
     alert?: AlertLayout;
+    /**
+    * An identifier which can be used to request the client use a particular UI control to represent this schema.
+    */
     control?: string;
+    /**
+    * @deprecated Please use nested oneOf schemas instead.
+    */
+    promoted?: boolean;
+    /**
+    * A unique id which can be used to refer to the schema.
+    */
     $id?: string;
+    /**
+    * The value of the schema.
+    */
     const: JsonElement;
+    /**
+    * A user-facing title for the schema.
+    */
     title?: string;
+    /**
+    * A user-facing description for the schema.
+    */
     description?: string;
+    /**
+    * An icon which the client can use to represent this schema.
+    */
     icon?: Icon;
+    /**
+    * An image which the client can use to represent this schema.
+    */
     image?: Image;
+    /**
+    * A list of keywords that can be used when searching or filtering items in a [com.wise.dynamicflow.schema.OneOfSchema].
+    * Only applies when this schema is child schema in a [com.wise.dynamicflow.schema.OneOfSchema].
+    */
     keywords?: string[];
+    /**
+    * Configure how this schema will be summarised when included in an [ArraySchema].
+    */
     summary?: SummaryProvider;
+    /**
+    * An internal id which is attached to analytics events relating to the schema.
+    * It allows you to override $id during event emission, it is not user-facing and does not have to be unique within the step.
+    */
     analyticsId?: string;
     /**
-    * @deprecated Please use nested oneOf schemas instead.
+    * If true, the UI for this schema will not accept input, but the corresponding data will still be submitted.
+    *  Defaults to false.
     */
-    promoted?: boolean;
+    disabled?: boolean;
 };

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

@@ -6,49 +6,152 @@ import type { ValidateAsync } from '../feature/ValidateAsync';
 import type { AlertLayout } from '../layout/AlertLayout';
 import type { AutocompleteToken } from '../misc/AutocompleteToken';
 import type { Help } from '../feature/Help';
+/**
+* Represents a numeric value which must be a whole number. For floating point numbers, use a [NumberSchema] instead.
+*/
 export type IntegerSchema = {
+    /**
+    * It must be `integer`.
+    */
     type: 'integer';
+    /**
+    * @deprecated This property is deprecated
+    */
+    autofillProvider?: string;
+    /**
+    * @deprecated Please use nested oneOf schemas instead.
+    */
+    promoted?: boolean;
+    /**
+    * @deprecated Please use 'refreshStepOnChange' instead
+    */
+    refreshFormOnChange?: boolean;
+    /**
+    * @deprecated Please use 'refreshUrl' in Step instead
+    */
+    refreshUrl?: string;
+    /**
+    * @deprecated Please use 'refreshUrl' in Step instead
+    */
+    refreshFormUrl?: string;
+    /**
+    * A user-facing placeholder value to use for the field. This can be used to provide an example of the expected
+    * input.
+    */
     placeholder?: string;
+    /**
+    * The minimum value permitted, if null then there is no minimum value.
+    */
     minimum?: number;
+    /**
+    * The maximum value permitted, if null then there is no maximum value.
+    */
     maximum?: number;
+    /**
+    * A unique id which can be used to refer to the schema.
+    */
     $id?: string;
+    /**
+    * A user-facing title for the schema.
+    */
     title?: string;
+    /**
+    * A user-facing description for the schema.
+    */
     description?: string;
+    /**
+    * An identifier which can be used to request the client use a particular UI control to represent this schema.
+    */
     control?: string;
+    /**
+    * The default value to use for this schema. This will be overridden by a value in the model of the
+    * [com.wise.dynamicflow.step.Step] if one is provided.
+    */
     default?: number;
+    /**
+    * If true, no UI will be shown to the user for this schema, but the corresponding data will still be submitted.
+    * Defaults to false.
+    */
     hidden?: boolean;
+    /**
+    * If true, the UI for this schema will not accept input, but the corresponding data will still be submitted.
+    *  Defaults to false.
+    */
     disabled?: boolean;
+    /**
+    * An icon which the client can use to represent this schema.
+    */
     icon?: Icon;
+    /**
+    * An image which the client can use to represent this schema.
+    */
     image?: Image;
+    /**
+    * A list of keywords that can be used when searching or filtering items in a [com.wise.dynamicflow.schema.OneOfSchema].
+    * Only applies when this schema is child schema in a [com.wise.dynamicflow.schema.OneOfSchema].
+    */
     keywords?: string[];
+    /**
+    * Configure how this schema will be summarised when included in an [ArraySchema].
+    */
     summary?: SummaryProvider;
+    /**
+    * An internal id which is attached to analytics events relating to the schema.
+    * It allows you to override $id during event emission, it is not user-facing and does not have to be unique within the step.
+    */
     analyticsId?: string;
+    /**
+    * @see PersistAsync
+    */
     persistAsync?: PersistAsync;
+    /**
+    * When true, the step will be refreshed when the value of this schema changes.
+    */
     refreshStepOnChange?: boolean;
+    /**
+    * @see ValidateAsync
+    */
     validationAsync?: ValidateAsync;
-    validationMessages?: Record<string, string>;
-    alert?: AlertLayout;
-    autocompleteHint?: AutocompleteToken[];
-    autofillKey?: string;
-    help?: Help;
     /**
-    * @deprecated This property is deprecated
+    * An object where each property/value pair is the name of a validation property (e.g. maximum)
+    * to the user-facing error message to display if the validation fails.
     */
-    autofillProvider?: string;
+    validationMessages?: Record<string, string>;
     /**
-    * @deprecated Please use nested oneOf schemas instead.
+    * Configure an alert which will be displayed above the UI for this schema. This can be used to provide warnings or
+    * additional information to the user, but shouldn't be used for validation. For client-side validation please see
+    * the validation available on each schema type, or see [com.wise.dynamicflow.feature.ValidateAsync] and
+    * [com.wise.dynamicflow.feature.Action] for server-side validation.
     */
-    promoted?: boolean;
+    alert?: AlertLayout;
     /**
-    * @deprecated Please use 'refreshStepOnChange' instead
+    * A list of tokens describing to the client what kind of field it is. This can enable the user agent or assistive
+    * technologies to automatically suggest or fill in information specific to the user.
+    * Values not recognised by the client will be discarded, and clients that only support single values will take the
+    * first supported value in the list.
     */
-    refreshFormOnChange?: boolean;
+    autocompleteHint?: AutocompleteToken[];
     /**
-    * @deprecated Please use 'refreshUrl' in Step instead
+    * Identifies the type of data which the client can autofill for this schema. This is provided in a `.`
+    * delimited string, in the format `source.prop`, e.g `contact.email`. In this example, the client should
+    * suggest values from the `email` property on objects retrieved from the `contact` source to autofill
+    * this field.
+    * The only currently supported source is `contact`. It will inspect contacts from the native client address
+    * book (if available).
+    * Supported properties on the `contact` source are:
+    * - `givenName`
+    * - `familyName`
+    * - `fullName`
+    * - `email`
+    * - `firstLine`
+    * - `city`
+    * - `state`
+    * - `postalCode`
+    * - `countryCode`
     */
-    refreshUrl?: string;
+    autofillKey?: string;
     /**
-    * @deprecated Please use 'refreshUrl' in Step instead
+    * Provide additional help information to the user.
     */
-    refreshFormUrl?: string;
+    help?: Help;
 };

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

@@ -6,49 +6,153 @@ import type { ValidateAsync } from '../feature/ValidateAsync';
 import type { AlertLayout } from '../layout/AlertLayout';
 import type { AutocompleteToken } from '../misc/AutocompleteToken';
 import type { Help } from '../feature/Help';
+/**
+* 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.
+*/
 export type NumberSchema = {
+    /**
+    * It must be `number`.
+    */
     type: 'number';
+    /**
+    * @deprecated This property is deprecated
+    */
+    autofillProvider?: string;
+    /**
+    * @deprecated Please use nested oneOf schemas instead.
+    */
+    promoted?: boolean;
+    /**
+    * @deprecated Please use 'refreshStepOnChange' instead
+    */
+    refreshFormOnChange?: boolean;
+    /**
+    * @deprecated Please use 'refreshUrl' in Step instead
+    */
+    refreshUrl?: string;
+    /**
+    * @deprecated Please use 'refreshUrl' in Step instead
+    */
+    refreshFormUrl?: string;
+    /**
+    * A user-facing placeholder value to use for the field. This can be used to provide an example of the expected
+    * input.
+    */
     placeholder?: string;
+    /**
+    * The minimum value permitted, if null then there is no minimum value.
+    */
     minimum?: number;
+    /**
+    * The maximum value permitted, if null then there is no minimum value.
+    */
     maximum?: number;
+    /**
+    * A unique id which can be used to refer to the schema.
+    */
     $id?: string;
+    /**
+    * A user-facing title for the schema.
+    */
     title?: string;
+    /**
+    * A user-facing description for the schema.
+    */
     description?: string;
+    /**
+    * An identifier which can be used to request the client use a particular UI control to represent this schema.
+    */
     control?: string;
+    /**
+    * The default value to use for this schema. This will be overridden by a value in the model of the
+    * [com.wise.dynamicflow.step.Step] if one is provided.
+    */
     default?: number;
+    /**
+    * If true, no UI will be shown to the user for this schema, but the corresponding data will still be submitted.
+    * Defaults to false.
+    */
     hidden?: boolean;
+    /**
+    * If true, the UI for this schema will not accept input, but the corresponding data will still be submitted.
+    *  Defaults to false.
+    */
     disabled?: boolean;
+    /**
+    * An icon which the client can use to represent this schema.
+    */
     icon?: Icon;
+    /**
+    * An image which the client can use to represent this schema.
+    */
     image?: Image;
+    /**
+    * A list of keywords that can be used when searching or filtering items in a [com.wise.dynamicflow.schema.OneOfSchema].
+    * Only applies when this schema is child schema in a [com.wise.dynamicflow.schema.OneOfSchema].
+    */
     keywords?: string[];
+    /**
+    * Configure how this schema will be summarised when included in an [ArraySchema].
+    */
     summary?: SummaryProvider;
+    /**
+    * An internal id which is attached to analytics events relating to the schema.
+    * It allows you to override $id during event emission, it is not user-facing and does not have to be unique within the step.
+    */
     analyticsId?: string;
+    /**
+    * @see PersistAsync
+    */
     persistAsync?: PersistAsync;
+    /**
+    * When true, the step will be refreshed when the value of this schema changes.
+    */
     refreshStepOnChange?: boolean;
+    /**
+    * @see ValidateAsync
+    */
     validationAsync?: ValidateAsync;
-    validationMessages?: Record<string, string>;
-    alert?: AlertLayout;
-    autocompleteHint?: AutocompleteToken[];
-    autofillKey?: string;
-    help?: Help;
     /**
-    * @deprecated This property is deprecated
+    * An object where each property/value pair is the name of a validation property (e.g. maximum)
+    * to the user-facing error message to display if the validation fails.
     */
-    autofillProvider?: string;
+    validationMessages?: Record<string, string>;
     /**
-    * @deprecated Please use nested oneOf schemas instead.
+    * Configure an alert which will be displayed above the UI for this schema. This can be used to provide warnings or
+    * additional information to the user, but shouldn't be used for validation. For client-side validation please see
+    * the validation available on each schema type, or see [com.wise.dynamicflow.feature.ValidateAsync] and
+    * [com.wise.dynamicflow.feature.Action] for server-side validation.
     */
-    promoted?: boolean;
+    alert?: AlertLayout;
     /**
-    * @deprecated Please use 'refreshStepOnChange' instead
+    * A list of tokens describing to the client what kind of field it is. This can enable the user agent or assistive
+    * technologies to automatically suggest or fill in information specific to the user.
+    * Values not recognised by the client will be discarded, and clients that only support single values will take the
+    * first supported value in the list.
     */
-    refreshFormOnChange?: boolean;
+    autocompleteHint?: AutocompleteToken[];
     /**
-    * @deprecated Please use 'refreshUrl' in Step instead
+    * Identifies the type of data which the client can autofill for this schema. This is provided in a `.`
+    * delimited string, in the format `source.prop`, e.g `contact.email`. In this example, the client should
+    * suggest values from the `email` property on objects retrieved from the `contact` source to autofill
+    * this field.
+    * The only currently supported source is `contact`. It will inspect contacts from the native client address
+    * book (if available).
+    * Supported properties on the `contact` source are:
+    * - `givenName`
+    * - `familyName`
+    * - `fullName`
+    * - `email`
+    * - `firstLine`
+    * - `city`
+    * - `state`
+    * - `postalCode`
+    * - `countryCode`
     */
-    refreshUrl?: string;
+    autofillKey?: string;
     /**
-    * @deprecated Please use 'refreshUrl' in Step instead
+    * Provide additional help information to the user.
     */
-    refreshFormUrl?: string;
+    help?: Help;
 };