@wise/dynamic-flow-types 2.2.0 → 2.3.1

package/build/index.d.ts

@@ -1,6 +1,6 @@
 export * from './spec/responses';
 export * from './spec/Action';
-export * from './spec/AutocompleteHint';
+export * from './spec/AutocompleteToken';
 export * from './spec/core';
 export * from './spec/LayoutComponent';
 export * from './spec/Model';

package/build/spec/Action.d.ts

@@ -1,4 +1,4 @@
-import { HttpMethod } from './core';
+import type { HttpMethod } from './core';
 type CoreAction = {
     id?: string;
     /**

package/build/spec/{AutocompleteHint.d.ts → AutocompleteToken.d.ts}

@@ -6,7 +6,7 @@
  * with autocomplete hints - i.e a common pattern is to have password control on string schemas that can be combined
  * with the PASSWORD or NEW_PASSWORD hints for the best possible user experience.
  */
-export type AutocompleteHint = 
+export type AutocompleteToken = 
 /**
  * Let the user agent provide the user with autocompletion values, but do not provide any further information about
  * what kind of data the user might be expected to enter. The user agent would have to use heuristics to decide what
@@ -26,31 +26,31 @@ export type AutocompleteHint =
  *
  * For example: "Sir"
  */
- | 'namePrefix'
+ | 'name-prefix'
 /**
  * A given (or "first") name.
  *
  * For example: "Timothy"
  */
- | 'givenName'
+ | 'given-name'
 /**
  * An additional (or middle) name.
  *
  * For example: "John"
  */
- | 'additionalName'
+ | 'additional-name'
 /**
  * A family (or "last") name.
  *
  * For example: "Berners-Lee"
  */
- | 'familyName'
+ | 'family-name'
 /**
  * A name suffix, such as "Jr.", "B.Sc.", "PhD.", "MBASW", or "IV".
  *
  * For example: "OM, KBE, FRS, FREng, FRSA"
  */
- | 'nameSuffix'
+ | 'name-suffix'
 /**
  * A nickname or handle.
  *
@@ -74,13 +74,13 @@ export type AutocompleteHint =
  *
  * For example: "timblee"
  */
- | 'newUsername'
+ | 'new-username'
 /**
  * A new password.
  *
  * For example: "GUMFXbadyrS3"
  */
- | 'newPassword'
+ | 'new-password'
 /**
  * The user's current password.
  *
@@ -92,19 +92,19 @@ export type AutocompleteHint =
  *
  * For example: "1234"
  */
- | 'oneTimeCode'
+ | 'one-time-code'
 /**
  * A job title, or the title a person has within an organization.
  *
  * For example: "Professor"
  */
- | 'jobTitle'
+ | 'job-title'
 /**
  * A company or organisation name.
  *
  * For example: "World Wide Web Consortium"
  */
- | 'organizationName'
+ | 'organization-name'
 /**
  * A street address. This can be multiple lines of text, and should fully identify the location of the address
  * within its second administrative level (typically a city or town), but should not include the city name, ZIP or
@@ -113,23 +113,23 @@ export type AutocompleteHint =
  * For example: "32 Vassar Street
  *               MIT Room 32-G524"
  */
- | 'fullStreetAddress'
+ | 'full-street-address'
 /**
  * Individual line of the street address. This should only be present if FULL_STREET_ADDRESS is not present.
  *
  * For example: "32 Vassar Street"
  */
- | 'streetAddressLine1'
+ | 'street-address-line-1'
 /**
  * Individual line of the street address. This should only be present if FULL_STREET_ADDRESS is not present.
  *
  * For example: "MIT Room 32-G524"
  */
- | 'streetAddressLine2'
+ | 'street-address-line-2'
 /**
  * Individual line of the street address. This should only be present if FULL_STREET_ADDRESS is not present.
  */
- | 'streetAddressLine3'
+ | 'street-address-line-3'
 /**
  * Describes the address in terms of increasing levels of precision within the country in which the address is
  * located. Each country has its own system of administrative levels, and may arrange the levels in different orders
@@ -140,7 +140,7 @@ export type AutocompleteHint =
  *
  * For example: "MA"
  */
- | 'addressLevel1'
+ | 'address-level-1'
 /**
  * The second administrative level, in addresses with two or more administrative levels; in the countries with two
  * administrative levels, this would typically be the city, town, village, or other locality within which the
@@ -148,107 +148,107 @@ export type AutocompleteHint =
  *
  * For example: "Cambridge"
  */
- | 'addressLevel2'
+ | 'address-level-2'
 /**
  * The third administrative level, in addresses with three or more administrative levels.
  */
- | 'addressLevel3'
+ | 'address-level-3'
 /**
  * The most fine-grained administrative level, in addresses with four administrative levels.
  */
- | 'addressLevel4'
+ | 'address-level-4'
 /**
  * Valid ISO3166-1-alpha-2](https://www.iso.org/iso-3166-country-codes.html) country codes.
  *
  * For example: "US"
  */
- | 'countryCode'
+ | 'country-code'
 /**
  * A country or territory name (could be the same as COUNTRY_CODE or the full name).
  *
  * For example: "United States"
  */
- | 'countryName'
+ | 'country-name'
 /**
  * Postal code, post code, ZIP code, CEDEX code (if CEDEX, append "CEDEX", and the arrondissement, if relevant, to
  * the ADDRESS_LEVEL_2 field).
  *
  * For example: "02139"
  */
- | 'postalCode'
+ | 'postal-code'
 /**
  * The full name as printed on or associated with a payment instrument such as a credit card.
  *
  * For example: "Tim Berners-Lee"
  */
- | 'creditCardName'
+ | 'credit-card-name'
 /**
  * A given (first) name as given on a payment instrument like a credit card.
  *
  * For example: "Tim"
  */
- | 'creditCardGivenName'
+ | 'credit-card-given-name'
 /**
  * A middle name as given on a payment instrument or credit card.
  *
  * For example: "John"
  */
- | 'creditCardMiddleName'
+ | 'credit-card-middle-name'
 /**
  * A family name, as given on a credit card.
  *
  * For example: "Berners-Lee"
  */
- | 'creditCardFamilyName'
+ | 'credit-card-family-name'
 /**
  * A credit card number or other number identifying a payment method, such as an account number.
  *
  * For example: "4114360123456785"
  */
- | 'creditCardNumber'
+ | 'credit-card-number'
 /**
  * A payment method expiration date.
  *
  * For example: "2014-12"
  */
- | 'creditCardExpiration'
+ | 'credit-card-expiration'
 /**
  * The month in which the payment method expires.
  *
  * For example: "12"
  */
- | 'creditCardExpirationMonth'
+ | 'credit-card-expiration-month'
 /**
  * The year in which the payment method expires.
  *
  * For example: "2023"
  */
- | 'creditCardExpirationYear'
+ | 'credit-card-expiration-year'
 /**
  * The security code for the payment instrument; on credit cards, this is the 3-digit verification number on the
  * back of the card.
  *
  * For example: "443"
  */
- | 'creditCardSecurityCode'
+ | 'credit-card-security-code'
 /**
  * The type of payment instrument.
  *
  * For example: "Visa"
  */
- | 'creditCardType'
+ | 'credit-card-type'
 /**
  * The currency in which the transaction is to take place.
  *
  * For example: "GBP"
  */
- | 'transactionCurrency'
+ | 'transaction-currency'
 /**
  * The amount, given in the currency specified by TRANSACTION_CURRENCY, of the transaction, for a payment form.
  *
  * For example: "401.95"
  */
- | 'transactionAmount'
+ | 'transaction-amount'
 /**
  * A preferred language, given as a valid BCP47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag).
  *
@@ -266,19 +266,19 @@ export type AutocompleteHint =
  *
  * For example: "8"
  */
- | 'birthdateDay'
+ | 'birthdate-day'
 /**
  * The month of the year of a birthdate.
  *
  * For example: "6"
  */
- | 'birthdateMonth'
+ | 'birthdate-month'
 /**
  * The year of a birthdate.
  *
  * For example: "1955"
  */
- | 'birthdateYear'
+ | 'birthdate-year'
 /**
  * A gender identity (e.g. "Female", "Fa'afafine" or "Nonbinary").
  *
@@ -290,54 +290,54 @@ export type AutocompleteHint =
  *
  * For example: "+1 617 253 5702"
  */
- | 'phoneNumber'
+ | 'phone-number'
 /**
  * The country code, such as "1" for the United States, Canada, and other areas in North America and parts of the
  * Caribbean.
  *
  * For example: "+1"
  */
- | 'phoneCountryCode'
+ | 'phone-country-code'
 /**
  * The entire phone number without the country code component, including a country-internal prefix. For the phone
  * number "1-855-555-6502", this field's value would be "855-555-6502".
  *
  * For example: "617 253 5702"
  */
- | 'phoneNational'
+ | 'phone-national'
 /**
  * The area code, with any country-internal prefix applied if appropriate.
  *
  * For example: "617"
  */
- | 'phoneAreaCode'
+ | 'phone-area-code'
 /**
  * The phone number without the country or area code.
  *
  * For example: "2535702"
  */
- | 'phoneLocal'
+ | 'phone-local'
 /**
  * First part of the component of the phone number that follows the area code, when that component is split into
  * two components.
  *
  * For example: "253"
  */
- | 'phoneLocalPrefix'
+ | 'phone-local-prefix'
 /**
  * Second part of the component of the phone number that follows the area code, when that component is split
  * into two components.
  *
  * For example: "5702"
  */
- | 'phoneLocalSuffix'
+ | 'phone-local-suffix'
 /**
  * A phone extension code within the phone number, such as a room or suite number in a hotel or an office
  * extension in a company.
  *
  * For example: "1000"
  */
- | 'phoneExtension'
+ | 'phone-extension'
 /**
  * A URL, such as a home page or company website address as appropriate given the context of the other fields in the
  * form.

package/build/spec/FileUploadSchema.d.ts

@@ -1,5 +1,5 @@
-import { ImageLayout } from './LayoutComponent';
-import { StringSchema } from './Schema';
+import type { ImageLayout } from './LayoutComponent';
+import type { StringSchema } from './Schema';
 export type FileUploadSchema = Omit<StringSchema, 'type' | 'format' | 'source' | 'image' | 'cameraConfig'> & {
     type: 'string';
     format: 'base64url';

package/build/spec/LayoutComponent.d.ts

@@ -1,9 +1,9 @@
-import { Action } from './Action';
-import { ExternalStepPollingConfiguration, ExternalStepPollingResponseHandler } from './Polling';
-import { Schema } from './Schema';
-import { SearchConfig } from './Search';
-import { Margin, Size, Icon, Image, Align, Orientation, Reference, Alert, Help } from './core';
-export type LayoutComponent = AlertLayout | BoxLayout | ButtonLayout | ColumnsLayout | DecisionLayout | DividerLayout | ExternalLayout | FormLayout | HeadingLayout | ImageLayout | InfoLayout | InstructionsLayout | ListLayout | LoadingIndicatorLayout | MarkdownLayout | ParagraphLayout | ReviewLayout | StatusListLayout | SearchLayout;
+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 } 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 AlertLayout = {
     type: 'alert';
 } & Alert;
@@ -81,6 +81,7 @@ export type HeadingLayout = {
     text: string;
     margin?: Margin;
     align?: Align;
+    control?: string;
 };
 export type ImageLayout = {
     type: 'image';
@@ -96,6 +97,9 @@ export type ImageLayout = {
      */
     accessibilityDescription?: string;
 };
+/**
+ * @deprecated Please use MarkdownLayout instead
+ */
 export type InfoLayout = {
     type: 'info';
     markdown: string;
@@ -146,6 +150,17 @@ export type MarkdownLayout = {
     margin?: Margin;
     align?: Align;
 };
+export type ModalLayout = {
+    type: 'modal';
+    control?: string;
+    trigger: {
+        title: string;
+    };
+    content: {
+        components: LayoutComponent[];
+    };
+    margin?: Margin;
+};
 export type ParagraphLayout = {
     type: 'paragraph';
     text: string;

package/build/spec/Model.d.ts

@@ -2,5 +2,5 @@ export type BasicModel = boolean | number | string;
 export type ObjectModel = {
     [key: string]: Model;
 };
-export type ArrayModel = Array<Model | null>;
+export type ArrayModel = (Model | null)[];
 export type Model = BasicModel | ObjectModel | ArrayModel | null;

package/build/spec/Navigation.d.ts

@@ -1,4 +1,4 @@
-import { Action } from './Action';
+import type { Action } from './Action';
 export type Navigation = {
     back?: BackBehaviour;
     /**

package/build/spec/PersistAsync.d.ts

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

package/build/spec/Polling.d.ts

@@ -1,4 +1,4 @@
-import { Action } from './Action';
+import type { Action } from './Action';
 export type PollingConfiguration = {
     url: string;
     interval: number;

package/build/spec/Promotion.d.ts

@@ -1,4 +1,4 @@
-import { Icon, Image } from './core';
+import type { Icon, Image } from './core';
 export type Promotion = {
     displayTwice?: boolean;
     other: {

package/build/spec/Schema.d.ts

@@ -1,10 +1,10 @@
-import { AutocompleteHint } from './AutocompleteHint';
-import { FileUploadSchema } from './FileUploadSchema';
-import { Model, ObjectModel } from './Model';
-import { PersistAsync } from './PersistAsync';
-import { Promotion } from './Promotion';
-import { ValidationAsync } from './ValidationAsync';
-import { Icon, Image, Alert, Help } from './core';
+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 | ConstSchema;
 type SchemaBase = {
     $id?: string;
@@ -110,7 +110,7 @@ export type IntegerSchema = Omit<SchemaBase, 'persistAsync'> & {
     minimum?: number;
     persistAsync?: PersistAsync;
     placeholder?: number;
-    autocompleteHint?: AutocompleteHint[];
+    autocompleteHint?: AutocompleteToken[];
     const?: number;
     oneOf?: IntegerSchema[];
 };
@@ -137,7 +137,7 @@ export type OneOfSchema = Omit<SchemaBase, 'oneOf' | 'promotion'> & {
     required?: string[];
     default?: Model;
     placeholder?: Model;
-    autocompleteHint?: AutocompleteHint[];
+    autocompleteHint?: AutocompleteToken[];
     control?: string;
 };
 export type OneOfObjectSchema = Omit<OneOfSchema, 'oneOf' | 'default'> & {
@@ -159,7 +159,7 @@ export type StringSchema = Omit<SchemaBase, 'persistAsync'> & {
     pattern?: string;
     persistAsync?: PersistAsync;
     placeholder?: string;
-    autocompleteHint?: AutocompleteHint[];
+    autocompleteHint?: AutocompleteToken[];
     const?: string;
     oneOf?: StringSchema[];
 };

package/build/spec/Search.d.ts

@@ -1,5 +1,5 @@
-import { Action } from './Action';
-import { HttpMethod, Icon, Image } from './core';
+import type { Action } from './Action';
+import type { HttpMethod, Icon, Image } from './core';
 export type SearchConfig = {
     url: string;
     method: HttpMethod;

package/build/spec/Step.d.ts

@@ -1,10 +1,10 @@
-import { Action } from './Action';
-import { LayoutComponent } from './LayoutComponent';
-import { ObjectModel } from './Model';
-import { Navigation } from './Navigation';
-import { ExternalStepPollingConfiguration, ExternalStepPollingResponseHandler, PollingConfiguration } from './Polling';
-import { Schema } from './Schema';
-import { Image } from './core';
+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;
@@ -98,10 +98,10 @@ export type LegacyReviewStep = Omit<FormStep, 'actions' | 'schemas' | 'layout'>
 };
 export type LegacyReviewFields = {
     title?: string;
-    fields: Array<{
+    fields: {
         title: string;
         value: string;
-    }>;
+    }[];
 };
 export type LegacyFormStep = Step & {
     type?: 'form';

package/build/spec/ValidationAsync.d.ts

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

package/build/spec/responses.d.ts

@@ -1,6 +1,6 @@
-import { Action } from './Action';
-import { SearchResult } from './Search';
-import { FormErrors, GlobalError } from './Step';
+import type { Action } from './Action';
+import type { SearchResult } from './Search';
+import type { FormErrors, GlobalError } from './Step';
 export type ActionResponseBody = {
     action: Action;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wise/dynamic-flow-types",
-  "version": "2.2.0",
+  "version": "2.3.1",
   "description": "Dynamic Flow TypeScript Types",
   "license": "Apache-2.0",
   "repository": {
@@ -13,14 +13,11 @@
     "build"
   ],
   "devDependencies": {
-    "@formatjs/cli": "^4.8.4",
-    "eslint": "8.53.0",
-    "prettier": "2.8.8",
+    "@formatjs/cli": "^6.2.4",
     "typescript": "4.9.5"
   },
   "peerDependencies": {},
   "dependencies": {},
-  "prettier": "@transferwise/eslint-config/.prettierrc.js",
   "scripts": {
     "dev": "pnpm tsc --noEmit --watch",
     "test": "pnpm tsc --noEmit",