@wise/dynamic-flow-types 1.1.0 → 1.2.0

package/{src/index.ts → build/index.d.ts}

@@ -8,5 +8,4 @@ export * from './spec/Promotion';
 export * from './spec/Schema';
 export * from './spec/Step';
 export * from './spec/ValidationAsync';
-
 export type { FileUploadSchema, CameraDirection } from './spec/FileUploadSchema';

package/build/spec/Action.d.ts

@@ -0,0 +1,23 @@
+import { HttpMethod } from './core';
+type CoreAction = {
+    id?: string;
+    /**
+     * @deprecated Please use id instead
+     */
+    $id?: string;
+    data?: Record<string, unknown>;
+    exit?: boolean;
+    method?: HttpMethod;
+    result?: Record<string, unknown>;
+    timeout?: number;
+    url?: string;
+};
+export type Action = CoreAction & {
+    title?: string;
+    type?: 'primary' | 'secondary' | 'link' | 'positive' | 'negative';
+    disabled?: boolean;
+};
+export type ActionResponseBody = {
+    action: Action;
+};
+export {};

package/build/spec/FileUploadSchema.d.ts

@@ -0,0 +1,19 @@
+import { ImageLayout } from './LayoutComponent';
+import { StringSchema } from './Schema';
+export type FileUploadSchema = Omit<StringSchema, 'type' | 'format' | 'source' | 'image' | 'cameraConfig'> & {
+    type: 'string';
+    format: 'base64url';
+    source?: 'camera' | 'file';
+    image?: ImageLayout;
+    cameraConfig?: CameraConfig;
+};
+type CameraConfig = {
+    assets?: {
+        overlay?: string;
+        outline?: string;
+    };
+    direction?: CameraDirection;
+    instructions?: string;
+};
+export type CameraDirection = 'back' | 'front';
+export {};

package/build/spec/LayoutComponent.d.ts

@@ -0,0 +1,164 @@
+import { Action } from './Action';
+import { ExternalStepPollingConfiguration, ExternalStepPollingResponseHandler } from './Polling';
+import { Schema } from './Schema';
+import { Margin, Size, Icon, Image, Align, Orientation, Reference, Alert } from './core';
+export type LayoutComponent = AlertLayout | BoxLayout | ButtonLayout | ColumnsLayout | DecisionLayout | DividerLayout | ExternalLayout | FormLayout | HeadingLayout | ImageLayout | InfoLayout | ListLayout | LoadingIndicatorLayout | MarkdownLayout | ParagraphLayout | ReviewLayout | StatusListLayout;
+export type AlertLayout = {
+    type: 'alert';
+} & Alert;
+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;
+};
+export type ColumnsLayout = {
+    type: 'columns';
+    left: LayoutComponent[];
+    right: LayoutComponent[];
+    bias?: 'none' | 'left' | 'right';
+    margin?: Margin;
+};
+export type DecisionLayout = {
+    type: 'decision';
+    options: DecisionOption[];
+    margin?: Margin;
+};
+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;
+};
+export type ImageLayout = {
+    type: 'image';
+    url: string;
+    /**
+     * @deprecated Only supported on web client
+     */
+    text?: string;
+    size?: Size;
+    margin?: Margin;
+};
+export type InfoLayout = {
+    type: 'info';
+    markdown: string;
+    margin?: Margin;
+    align?: Align;
+};
+/**
+ * @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';
+};
+export type LoadingIndicatorLayout = {
+    type: 'loading-indicator';
+    margin?: Margin;
+    size?: Size;
+};
+export type MarkdownLayout = {
+    type: 'markdown';
+    content: string;
+    margin?: Margin;
+    align?: Align;
+};
+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 Only supported on web client
+     */
+    action?: Action;
+};
+type ReviewField = {
+    label: string;
+    value: string | number | boolean | null | undefined;
+};
+export {};

package/{src/spec/Model.ts → build/spec/Model.d.ts}

@@ -1,4 +1,6 @@
 export type BasicModel = boolean | number | string;
-export type ObjectModel = { [key: string]: Model };
+export type ObjectModel = {
+    [key: string]: Model;
+};
 export type ArrayModel = Array<BasicModel | null>;
 export type Model = BasicModel | ObjectModel | ArrayModel | null;

package/build/spec/PersistAsync.d.ts

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

package/{src/spec/Polling.ts → build/spec/Polling.d.ts}

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

package/build/spec/Promotion.d.ts

@@ -0,0 +1,20 @@
+import { 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

@@ -0,0 +1,178 @@
+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';
+export type Schema = AllOfSchema | ArraySchema | BlobSchema | BooleanSchema | IntegerSchema | NumberSchema | ObjectSchema | OneOfSchema | StringSchema | ListArraySchema | TupleArraySchema | FileUploadSchema | MultipleFileUploadSchema | 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[];
+};
+export type ArraySchema = Omit<SchemaBase, 'persistAsync'> & {
+    type: 'array';
+    addItemTitle?: string;
+    editItemTitle?: string;
+    removeItemTitle?: 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 BlobSchema = SchemaBase & {
+    type: 'blob';
+    accepts?: string[];
+    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?: number;
+    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;
+    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;
+    const?: string;
+    oneOf?: StringSchema[];
+};
+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/Step.d.ts

@@ -0,0 +1,116 @@
+import { Action } from './Action';
+import { LayoutComponent } from './LayoutComponent';
+import { ObjectModel } from './Model';
+import { ExternalStepPollingConfiguration, ExternalStepPollingResponseHandler, PollingConfiguration } from './Polling';
+import { Schema } from './Schema';
+import { 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;
+    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;
+export type ErrorResponseBody = {
+    error?: GlobalError;
+    validation?: FormErrors;
+    refreshUrl?: string;
+    /**
+     * @deprecated Please use refreshUrl instead
+     */
+    refreshFormUrl?: string;
+};
+/**
+ * @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: Array<{
+        title: string;
+        value: string;
+    }>;
+};
+export type LegacyFormStep = Step & {
+    type?: 'form';
+    reviewFields?: LegacyReviewFields;
+    schemas?: Schema[];
+    actions?: Action[];
+};
+export {};

package/build/spec/ValidationAsync.d.ts

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

package/build/spec/core.d.ts

@@ -0,0 +1,29 @@
+export 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;
+};
+export type Alert = {
+    markdown: string;
+    context?: Context;
+    margin?: Margin;
+};
+export type Help = {
+    markdown: string;
+};

package/package.json

@@ -1,15 +1,17 @@
 {
   "name": "@wise/dynamic-flow-types",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Dynamic Flow TypeScript Types",
   "license": "Apache-2.0",
-  "main": "./src/index.ts",
-  "types": "./src/index.ts",
   "repository": {
     "type": "git",
     "fullname": "transferwise/dynamic-flow",
     "url": "git+https://github.com/transferwise/dynamic-flow.git"
   },
+  "types": "./build/index.d.ts",
+  "files": [
+    "build"
+  ],
   "devDependencies": {
     "@formatjs/cli": "^4.8.3",
     "eslint": "8.36.0",
@@ -20,8 +22,9 @@
   "dependencies": {},
   "prettier": "@transferwise/eslint-config/.prettierrc.js",
   "scripts": {
-    "dev": "pnpm tsc --watch",
+    "dev": "pnpm tsc --noEmit --watch",
     "test": "pnpm tsc --noEmit",
+    "build": "pnpm tsc --emitDeclarationOnly",
     "types": "pnpm tsc --noEmit",
     "lint": "eslint 'src/**/*.{js,ts}' --quiet"
   }

package/.eslintrc.js

@@ -1,14 +0,0 @@
-module.exports = {
-  extends: '@transferwise',
-  parserOptions: {
-    tsconfigRootDir: __dirname,
-    project: ['./tsconfig.json'],
-  },
-  env: {
-    browser: true,
-  },
-  rules: {
-    // We don't have next pages
-    '@next/next/no-html-link-for-pages': 'off',
-  },
-};

package/CHANGELOG.md

@@ -1,21 +0,0 @@
-# @wise/dynamic-flow-types
-
-## 1.1.0
-
-### Minor Changes
-
-- 57ab87e: Add support for action.id property
-- 44409c6: Adding support for status-list
-
-## 1.0.0
-
-### Major Changes
-
-- 1120e78: TypeScript types extracted from the web client library.
-
-## 0.0.2
-
-### Patch Changes
-
-- 28cd77d: Make @wise/dynamic-flow-types non-private.
-  Declare @wise/dynamic-flow-types as a non-dev dependency.

package/src/spec/Action.ts

@@ -1,25 +0,0 @@
-import { HttpMethod } from './core';
-
-type CoreAction = {
-  id?: string;
-  /**
-   * @deprecated Please use id instead
-   */
-  $id?: string;
-  data?: Record<string, unknown>;
-  exit?: boolean;
-  method?: HttpMethod;
-  result?: Record<string, unknown>;
-  timeout?: number;
-  url?: string;
-};
-
-export type Action = CoreAction & {
-  title?: string;
-  type?: 'primary' | 'secondary' | 'link' | 'positive' | 'negative';
-  disabled?: boolean;
-};
-
-export type ActionResponseBody = {
-  action: Action;
-};

package/src/spec/FileUploadSchema.ts

@@ -1,23 +0,0 @@
-import { ImageLayout } from './LayoutComponent';
-import { StringSchema } from './Schema';
-
-export type FileUploadSchema = Omit<
-  StringSchema,
-  'type' | 'format' | 'source' | 'image' | 'cameraConfig'
-> & {
-  type: 'string';
-  format: 'base64url';
-  source?: 'camera' | 'file';
-  image?: ImageLayout;
-  cameraConfig?: CameraConfig;
-};
-type CameraConfig = {
-  assets?: {
-    overlay?: string;
-    outline?: string;
-  };
-  direction?: CameraDirection;
-  instructions?: string;
-};
-
-export type CameraDirection = 'back' | 'front';

package/src/spec/LayoutComponent.ts

@@ -1,194 +0,0 @@
-import { Action } from './Action';
-import { ExternalStepPollingConfiguration, ExternalStepPollingResponseHandler } from './Polling';
-import { Schema } from './Schema';
-import { Margin, Size, Icon, Image, Align, Orientation, Reference, Alert } from './core';
-
-export type LayoutComponent =
-  | AlertLayout
-  | BoxLayout
-  | ButtonLayout
-  | ColumnsLayout
-  | DecisionLayout
-  | DividerLayout
-  | ExternalLayout
-  | FormLayout
-  | HeadingLayout
-  | ImageLayout
-  | InfoLayout
-  | ListLayout
-  | LoadingIndicatorLayout
-  | MarkdownLayout
-  | ParagraphLayout
-  | ReviewLayout
-  | StatusListLayout;
-
-export type AlertLayout = { type: 'alert' } & Alert;
-
-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;
-};
-
-export type ColumnsLayout = {
-  type: 'columns';
-  left: LayoutComponent[];
-  right: LayoutComponent[];
-  bias?: 'none' | 'left' | 'right';
-  margin?: Margin;
-};
-
-export type DecisionLayout = {
-  type: 'decision';
-  options: DecisionOption[];
-  margin?: Margin;
-};
-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;
-};
-
-export type ImageLayout = {
-  type: 'image';
-  url: string;
-  /**
-   * @deprecated Only supported on web client
-   */
-  text?: string;
-  size?: Size;
-  margin?: Margin;
-};
-
-export type InfoLayout = {
-  type: 'info';
-  markdown: string;
-  margin?: Margin;
-  align?: Align;
-};
-
-/**
- * @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';
-};
-
-export type LoadingIndicatorLayout = {
-  type: 'loading-indicator';
-  margin?: Margin;
-  size?: Size;
-};
-
-export type MarkdownLayout = {
-  type: 'markdown';
-  content: string;
-  margin?: Margin;
-  align?: Align;
-};
-
-export type ParagraphLayout = {
-  type: 'paragraph';
-  text: string;
-  control?: 'copyable';
-  margin?: Margin;
-  align?: Align;
-};
-
-export type ReviewLayout = {
-  type: 'review';
-  title?: string;
-  fields: ReviewField[];
-  orientation?: Orientation;
-  margin?: Margin;
-  /**
-   * @deprecated Only supported on web client
-   */
-  action?: Action;
-};
-
-type ReviewField = { label: string; value: string | number | boolean | null | undefined };

package/src/spec/PersistAsync.ts

@@ -1,10 +0,0 @@
-import { Schema } from './Schema';
-
-export type PersistAsync = {
-  idProperty: string;
-  method?: 'POST' | 'PUT' | 'PATCH';
-  param: string;
-  schema: Schema;
-  url: string;
-};
-type PersistAsyncResponseBody = Record<string, unknown> | { validation: Record<string, unknown> };

package/src/spec/Promotion.ts

@@ -1,21 +0,0 @@
-import { 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; // not in spec (only web)
-  };
-  control?: string; // not in spec (only web)
-  checkedMeans?: 'promoted' | 'other'; // not in spec (only web)
-  default?: 'promoted' | 'other';
-};

package/src/spec/Schema.ts

@@ -1,200 +0,0 @@
-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';
-
-export type Schema =
-  | AllOfSchema
-  | ArraySchema
-  | BlobSchema
-  | BooleanSchema
-  | IntegerSchema
-  | NumberSchema
-  | ObjectSchema
-  | OneOfSchema
-  | StringSchema
-  | ListArraySchema
-  | TupleArraySchema
-  | FileUploadSchema
-  | MultipleFileUploadSchema
-  | 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[];
-};
-
-export type ArraySchema = Omit<SchemaBase, 'persistAsync'> & {
-  type: 'array';
-  addItemTitle?: string;
-  editItemTitle?: string;
-  removeItemTitle?: 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 BlobSchema = SchemaBase & {
-  type: 'blob';
-  accepts?: string[];
-  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?: number;
-
-  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;
-  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; // FIXME: https://transferwise.atlassian.net/browse/MC-3188
-  maximum?: string; // FIXME: https://transferwise.atlassian.net/browse/MC-3188
-  maxLength?: number;
-  minLength?: number;
-  pattern?: string;
-  persistAsync?: PersistAsync;
-  placeholder?: string;
-  const?: string;
-  oneOf?: StringSchema[];
-};
-
-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;
-};

package/src/spec/Step.ts

@@ -1,126 +0,0 @@
-import { Action } from './Action';
-import { LayoutComponent } from './LayoutComponent';
-import { ObjectModel } from './Model';
-import {
-  ExternalStepPollingConfiguration,
-  ExternalStepPollingResponseHandler,
-  PollingConfiguration,
-} from './Polling';
-import { Schema } from './Schema';
-import { 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;
-  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;
-
-export type ErrorResponseBody = {
-  error?: GlobalError;
-  validation?: FormErrors;
-  refreshUrl?: string;
-  /**
-   * @deprecated Please use refreshUrl instead
-   */
-  refreshFormUrl?: string;
-};
-
-/**
- * @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: Array<{ title: string; value: string }>;
-};
-
-export type LegacyFormStep = Step & {
-  type?: 'form';
-  reviewFields?: LegacyReviewFields;
-  schemas?: Schema[];
-  actions?: Action[];
-};

package/src/spec/ValidationAsync.ts

@@ -1,8 +0,0 @@
-import { HttpMethod } from './core';
-
-export type ValidationAsync = {
-  param: string;
-  url: string;
-  method?: HttpMethod; // not in spec (only web)
-};
-type ValidationAsyncResponseBody = { message: string };

package/src/spec/core.ts

@@ -1,25 +0,0 @@
-export type Image = {
-  url: string;
-  text?: string; // TODO: not in spec. web only? consider calling it altText -- make proposal
-  name?: string; // TODO: not in spec. web only? consider calling it altText
-};
-
-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 };
-
-export type Alert = {
-  markdown: string;
-  context?: Context;
-  margin?: Margin;
-};
-
-export type Help = { markdown: string };

package/tsconfig.json

@@ -1,20 +0,0 @@
-{
-  "compilerOptions": {
-    "rootDir": "src",
-    "outDir": "build",
-    "lib": ["dom", "dom.iterable", "esnext"],
-    "allowJs": false,
-    "checkJs": false,
-    "skipLibCheck": true,
-    "strict": true,
-    "forceConsistentCasingInFileNames": true,
-    "esModuleInterop": true,
-    "module": "esnext",
-    "moduleResolution": "node",
-    "resolveJsonModule": true,
-    "jsx": "react-jsx",
-    "isolatedModules": true
-  },
-  "include": ["src/**/*.ts"],
-  "exclude": ["node_modules", "build"]
-}