@wise/dynamic-flow-types 2.3.1 → 2.4.1

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

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

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

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

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

@@ -0,0 +1,24 @@
+import type { Schema } from './Schema';
+import type { Icon } from '../misc/Icon';
+import type { ImageLayout } from '../layout/ImageLayout';
+import type { SummaryProvider } from '../feature/SummaryProvider';
+import type { AlertLayout } from '../layout/AlertLayout';
+export type AllOfSchema = {
+    disabled?: boolean;
+    allOf: Schema[];
+    $id?: string;
+    title?: string;
+    description?: string;
+    control?: string;
+    hidden?: boolean;
+    icon?: Icon;
+    image?: ImageLayout;
+    keywords?: string[];
+    summary?: SummaryProvider;
+    analyticsId?: string;
+    alert?: AlertLayout;
+    /**
+    * @deprecated Please use nested oneOf schemas instead.
+    */
+    promoted?: boolean;
+};

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

@@ -0,0 +1,3 @@
+import type { ArraySchemaList } from './ArraySchemaList';
+import type { ArraySchemaTuple } from './ArraySchemaTuple';
+export type ArraySchema = ArraySchemaList | ArraySchemaTuple;

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

@@ -0,0 +1,34 @@
+import type { Schema } from './Schema';
+import type { Icon } from '../misc/Icon';
+import type { ImageLayout } from '../layout/ImageLayout';
+import type { SummarySummariser } from '../feature/SummarySummariser';
+import type { PersistAsync } from '../feature/PersistAsync';
+import type { ValidateAsync } from '../feature/ValidateAsync';
+import type { AlertLayout } from '../layout/AlertLayout';
+export type ArraySchemaList = {
+    type: 'array';
+    $id?: string;
+    items: Schema;
+    addItemTitle: string;
+    editItemTitle: string;
+    minItems?: number;
+    maxItems?: number;
+    title?: string;
+    description?: string;
+    control?: string;
+    hidden?: boolean;
+    icon?: Icon;
+    image?: ImageLayout;
+    keywords?: string[];
+    summary?: SummarySummariser;
+    analyticsId?: string;
+    persistAsync?: PersistAsync;
+    validationAsync?: ValidateAsync;
+    alert?: AlertLayout;
+    validationMessages?: Record<string, string>;
+    disabled?: boolean;
+    /**
+    * @deprecated Please use nested oneOf schemas instead.
+    */
+    promoted?: boolean;
+};

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

@@ -0,0 +1,29 @@
+import type { Schema } from './Schema';
+import type { Icon } from '../misc/Icon';
+import type { ImageLayout } from '../layout/ImageLayout';
+import type { SummaryProvider } from '../feature/SummaryProvider';
+import type { PersistAsync } from '../feature/PersistAsync';
+import type { ValidateAsync } from '../feature/ValidateAsync';
+import type { AlertLayout } from '../layout/AlertLayout';
+export type ArraySchemaTuple = {
+    type: 'array';
+    $id?: string;
+    items: Schema[];
+    title?: string;
+    description?: string;
+    control?: string;
+    hidden?: boolean;
+    icon?: Icon;
+    image?: ImageLayout;
+    keywords?: string[];
+    summary?: SummaryProvider;
+    analyticsId?: string;
+    persistAsync?: PersistAsync;
+    validationAsync?: ValidateAsync;
+    alert?: AlertLayout;
+    disabled?: boolean;
+    /**
+    * @deprecated Please use nested oneOf schemas instead.
+    */
+    promoted?: boolean;
+};

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

@@ -0,0 +1,30 @@
+import type { BlobSchemaSource } from './BlobSchemaSource';
+import type { Icon } from '../misc/Icon';
+import type { ImageLayout } from '../layout/ImageLayout';
+import type { SummaryProvider } from '../feature/SummaryProvider';
+import type { ValidateAsync } from '../feature/ValidateAsync';
+import type { AlertLayout } from '../layout/AlertLayout';
+export type BlobSchema = {
+    type: 'blob';
+    disabled: boolean;
+    $id?: string;
+    accepts: string[];
+    maxSize?: number;
+    source?: BlobSchemaSource;
+    title?: string;
+    description?: string;
+    control?: string;
+    hidden?: boolean;
+    icon?: Icon;
+    image?: ImageLayout;
+    keywords?: string[];
+    summary?: SummaryProvider;
+    analyticsId?: string;
+    validationAsync?: ValidateAsync;
+    validationMessages?: Record<string, string>;
+    alert?: AlertLayout;
+    /**
+    * @deprecated Please use nested oneOf schemas instead.
+    */
+    promoted?: boolean;
+};

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

@@ -0,0 +1 @@
+export type BlobSchemaSource = 'file' | 'camera';

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

@@ -0,0 +1,48 @@
+import type { Icon } from '../misc/Icon';
+import type { ImageLayout } from '../layout/ImageLayout';
+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 { Help } from '../feature/Help';
+export type BooleanSchema = {
+    type: 'boolean';
+    $id?: string;
+    title?: string;
+    description?: string;
+    control?: string;
+    default?: boolean;
+    hidden?: boolean;
+    disabled?: boolean;
+    icon?: Icon;
+    image?: ImageLayout;
+    keywords?: string[];
+    summary?: SummaryProvider;
+    analyticsId?: string;
+    persistAsync?: PersistAsync;
+    refreshStepOnChange?: boolean;
+    validationAsync?: ValidateAsync;
+    alert?: AlertLayout;
+    autofillKey?: string;
+    help?: Help;
+    /**
+    * @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;
+};

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

@@ -0,0 +1,23 @@
+import type { AlertLayout } from '../layout/AlertLayout';
+import type { Icon } from '../misc/Icon';
+import type { ImageLayout } from '../layout/ImageLayout';
+import type { SummaryProvider } from '../feature/SummaryProvider';
+export type ConstSchema = {
+    disabled?: boolean;
+    hidden?: boolean;
+    alert?: AlertLayout;
+    control?: string;
+    $id?: string;
+    const?: unknown;
+    title?: string;
+    description?: string;
+    icon?: Icon;
+    image?: ImageLayout;
+    keywords?: string[];
+    summary?: SummaryProvider;
+    analyticsId?: string;
+    /**
+    * @deprecated Please use nested oneOf schemas instead.
+    */
+    promoted?: boolean;
+};

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

@@ -0,0 +1,54 @@
+import type { Icon } from '../misc/Icon';
+import type { ImageLayout } from '../layout/ImageLayout';
+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 { AutocompleteToken } from '../misc/AutocompleteToken';
+import type { Help } from '../feature/Help';
+export type IntegerSchema = {
+    type: 'integer';
+    placeholder?: string;
+    minimum?: number;
+    maximum?: number;
+    $id?: string;
+    title?: string;
+    description?: string;
+    control?: string;
+    default?: number;
+    hidden?: boolean;
+    disabled?: boolean;
+    icon?: Icon;
+    image?: ImageLayout;
+    keywords?: string[];
+    summary?: SummaryProvider;
+    analyticsId?: string;
+    persistAsync?: PersistAsync;
+    refreshStepOnChange?: boolean;
+    validationAsync?: ValidateAsync;
+    validationMessages?: Record<string, string>;
+    alert?: AlertLayout;
+    autocompleteHint?: AutocompleteToken[];
+    autofillKey?: string;
+    help?: Help;
+    /**
+    * @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;
+};

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

@@ -0,0 +1,54 @@
+import type { Icon } from '../misc/Icon';
+import type { ImageLayout } from '../layout/ImageLayout';
+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 { AutocompleteToken } from '../misc/AutocompleteToken';
+import type { Help } from '../feature/Help';
+export type NumberSchema = {
+    type: 'number';
+    placeholder?: string;
+    minimum?: number;
+    maximum?: number;
+    $id?: string;
+    title?: string;
+    description?: string;
+    control?: string;
+    default?: number;
+    hidden?: boolean;
+    disabled?: boolean;
+    icon?: Icon;
+    image?: ImageLayout;
+    keywords?: string[];
+    summary?: SummaryProvider;
+    analyticsId?: string;
+    persistAsync?: PersistAsync;
+    refreshStepOnChange?: boolean;
+    validationAsync?: ValidateAsync;
+    validationMessages?: Record<string, string>;
+    alert?: AlertLayout;
+    autocompleteHint?: AutocompleteToken[];
+    autofillKey?: string;
+    help?: Help;
+    /**
+    * @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;
+};

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

@@ -0,0 +1,32 @@
+import type { Help } from '../feature/Help';
+import type { Schema } from './Schema';
+import type { Icon } from '../misc/Icon';
+import type { ImageLayout } from '../layout/ImageLayout';
+import type { SummaryProvider } from '../feature/SummaryProvider';
+import type { AlertLayout } from '../layout/AlertLayout';
+export type ObjectSchema = {
+    type: 'object';
+    disabled?: boolean;
+    properties: Record<string, Schema>;
+    displayOrder: string[];
+    required?: string[];
+    $id?: string;
+    title?: string;
+    description?: string;
+    control?: string;
+    hidden?: boolean;
+    icon?: Icon;
+    image?: ImageLayout;
+    keywords?: string[];
+    summary?: SummaryProvider;
+    analyticsId?: string;
+    alert?: AlertLayout;
+    /**
+    * @deprecated Please use nested oneOf schemas instead.
+    */
+    promoted?: boolean;
+    /**
+    * @deprecated Only supported on web clients
+    */
+    help?: Help;
+};

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

@@ -0,0 +1,53 @@
+import type { Schema } from './Schema';
+import type { Icon } from '../misc/Icon';
+import type { ImageLayout } from '../layout/ImageLayout';
+import type { SummaryProvider } from '../feature/SummaryProvider';
+import type { AlertLayout } from '../layout/AlertLayout';
+import type { Help } from '../feature/Help';
+import type { AutocompleteToken } from '../misc/AutocompleteToken';
+export type OneOfSchema = {
+    disabled?: boolean;
+    oneOf: Schema[];
+    placeholder?: string;
+    $id?: string;
+    title?: string;
+    description?: string;
+    control?: string;
+    default?: unknown;
+    hidden?: boolean;
+    icon?: Icon;
+    image?: ImageLayout;
+    keywords?: string[];
+    summary?: SummaryProvider;
+    analyticsId?: string;
+    refreshStepOnChange?: boolean;
+    alert?: AlertLayout;
+    help?: Help;
+    autocompleteHint?: AutocompleteToken[];
+    autofillKey?: string;
+    validationMessages?: Record<string, string>;
+    /**
+    * @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;
+    /**
+    * @deprecated OneOf Promotion is no longer supported
+    */
+    promotion?: unknown;
+};

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

@@ -0,0 +1,11 @@
+import type { AllOfSchema } from './AllOfSchema';
+import type { ArraySchema } from './ArraySchema';
+import type { BlobSchema } from './BlobSchema';
+import type { BooleanSchema } from './BooleanSchema';
+import type { ConstSchema } from './ConstSchema';
+import type { IntegerSchema } from './IntegerSchema';
+import type { NumberSchema } from './NumberSchema';
+import type { ObjectSchema } from './ObjectSchema';
+import type { OneOfSchema } from './OneOfSchema';
+import type { StringSchema } from './StringSchema';
+export type Schema = AllOfSchema | ArraySchema | BlobSchema | BooleanSchema | ConstSchema | IntegerSchema | NumberSchema | ObjectSchema | OneOfSchema | StringSchema;

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

@@ -0,0 +1,77 @@
+import type { StringSchemaSource } from './StringSchemaSource';
+import type { StringSchemaFormat } from './StringSchemaFormat';
+import type { Icon } from '../misc/Icon';
+import type { ImageLayout } from '../layout/ImageLayout';
+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 { AutocompleteToken } from '../misc/AutocompleteToken';
+import type { Help } from '../feature/Help';
+export type StringSchema = {
+    type: 'string';
+    format?: StringSchemaFormat;
+    displayFormat?: string;
+    placeholder?: string;
+    minLength?: number;
+    maxLength?: number;
+    minimum?: string;
+    maximum?: string;
+    pattern?: string;
+    $id?: string;
+    title?: string;
+    description?: string;
+    control?: string;
+    default?: string;
+    hidden?: boolean;
+    disabled?: boolean;
+    icon?: Icon;
+    image?: ImageLayout;
+    keywords?: string[];
+    summary?: SummaryProvider;
+    analyticsId?: string;
+    persistAsync?: PersistAsync;
+    refreshStepOnChange?: boolean;
+    validationAsync?: ValidateAsync;
+    validationMessages?: Record<string, string>;
+    alert?: AlertLayout;
+    autocompleteHint?: AutocompleteToken[];
+    autofillKey?: string;
+    help?: Help;
+    /**
+    * @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;
+    /**
+    * @deprecated Please use 'persistAsync' with a 'BlobSchema' instead.
+    */
+    cameraConfig?: unknown;
+    /**
+    * @deprecated Please use 'persistAsync' with a 'BlobSchema' instead.
+    */
+    accepts?: string[];
+    /**
+    * @deprecated Please use 'persistAsync' with a 'BlobSchema' instead.
+    */
+    maxSize?: number;
+    /**
+    * @deprecated Please use 'persistAsync' with a 'BlobSchema' instead.
+    */
+    source?: StringSchemaSource;
+};

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

@@ -0,0 +1 @@
+export type StringSchemaFormat = 'date' | 'email' | 'numeric' | 'password' | 'phone-number' | 'base64url';

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

@@ -0,0 +1,4 @@
+/**
+* @deprecated Please do not use StringSchema for file uploads. You can use Persist Async with BlobSchema.
+*/
+export type StringSchemaSource = 'camera' | 'file';

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

@@ -0,0 +1,38 @@
+import type { Action } from '../feature/Action';
+import type { Schema } from '../schema/Schema';
+import type { Layout } from '../layout/Layout';
+import type { External } from '../feature/External';
+import type { Polling } from '../feature/Polling';
+import type { LinkHandler } from '../feature/LinkHandler';
+import type { StepError } from '../feature/StepError';
+import type { Navigation } from '../feature/Navigation';
+export type Step = {
+    id: string;
+    title: string;
+    schemas: Schema[];
+    layout: Layout[];
+    model?: unknown;
+    external?: External;
+    polling?: Polling;
+    linkHandlers?: LinkHandler[];
+    analytics?: Record<string, string>;
+    errors?: StepError;
+    navigation?: Navigation;
+    refreshUrl?: string;
+    /**
+    * @deprecated Please use 'id' instead
+    */
+    key?: string;
+    /**
+    * @deprecated Type is no longer required, as only form steps are supported
+    */
+    type?: string;
+    /**
+    * @deprecated Please define actions inside Button components.
+    */
+    actions?: Action[];
+    /**
+    * @deprecated Please use 'refreshUrl' instead
+    */
+    refreshFormUrl?: string;
+};

package/build/spec/Schema.d.ts

@@ -109,7 +109,7 @@ export type IntegerSchema = Omit<SchemaBase, 'persistAsync'> & {
     maximum?: number;
     minimum?: number;
     persistAsync?: PersistAsync;
-    placeholder?: number;
+    placeholder?: string | number;
     autocompleteHint?: AutocompleteToken[];
     const?: number;
     oneOf?: IntegerSchema[];

package/build/spec/core.d.ts

@@ -1,4 +1,5 @@
 export type Image = {
+    type?: 'image';
     url: string;
     text?: string;
     name?: string;
@@ -22,6 +23,7 @@ export type Reference = {
 /** @deprecated Prefer Context */
 export type LegacyContext = 'success' | 'failure' | 'info' | 'primary';
 export type Alert = {
+    type?: 'alert';
     markdown: string;
     context?: Context | LegacyContext;
     margin?: Margin;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wise/dynamic-flow-types",
-  "version": "2.3.1",
+  "version": "2.4.1",
   "description": "Dynamic Flow TypeScript Types",
   "license": "Apache-2.0",
   "repository": {