@wise/dynamic-flow-types 1.3.0 → 1.5.0

package/build/index.d.ts

@@ -1,11 +1,14 @@
+export * from './spec/responses';
 export * from './spec/Action';
 export * from './spec/core';
 export * from './spec/LayoutComponent';
 export * from './spec/Model';
+export * from './spec/Navigation';
 export * from './spec/PersistAsync';
 export * from './spec/Polling';
 export * from './spec/Promotion';
 export * from './spec/Schema';
 export * from './spec/Step';
 export * from './spec/ValidationAsync';
+export * from './spec/Search';
 export type { FileUploadSchema, CameraDirection } from './spec/FileUploadSchema';

package/build/spec/Action.d.ts

@@ -17,7 +17,4 @@ export type Action = CoreAction & {
     type?: 'primary' | 'secondary' | 'link' | 'positive' | 'negative';
     disabled?: boolean;
 };
-export type ActionResponseBody = {
-    action: Action;
-};
 export {};

package/build/spec/LayoutComponent.d.ts

@@ -1,8 +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 } from './core';
-export type LayoutComponent = AlertLayout | BoxLayout | ButtonLayout | ColumnsLayout | DecisionLayout | DividerLayout | ExternalLayout | FormLayout | HeadingLayout | ImageLayout | InfoLayout | InstructionsLayout | ListLayout | LoadingIndicatorLayout | MarkdownLayout | ParagraphLayout | ReviewLayout | StatusListLayout;
+export type LayoutComponent = AlertLayout | BoxLayout | ButtonLayout | ColumnsLayout | DecisionLayout | DividerLayout | ExternalLayout | FormLayout | HeadingLayout | ImageLayout | InfoLayout | InstructionsLayout | ListLayout | LoadingIndicatorLayout | MarkdownLayout | ParagraphLayout | ReviewLayout | StatusListLayout | SearchLayout;
 export type AlertLayout = {
     type: 'alert';
 } & Alert;
@@ -163,6 +164,12 @@ export type ReviewLayout = {
      */
     action?: Action;
 };
+export type SearchLayout = SearchConfig & {
+    type: 'search';
+    title: string;
+    emptyMessage: string;
+    margin?: Margin;
+};
 type ReviewField = {
     label: string;
     value: string | number | boolean | null | undefined;

package/build/spec/Navigation.d.ts

@@ -0,0 +1,8 @@
+import { Action } from './Action';
+export type Navigation = {
+    backButton?: BackButton;
+};
+export type BackButton = {
+    title?: string;
+    action: Action;
+};

package/build/spec/Search.d.ts

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

package/build/spec/Step.d.ts

@@ -1,6 +1,7 @@
 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';
@@ -19,6 +20,10 @@ type BaseStep = {
     schemas?: Schema[];
     actions?: Action[];
     model?: ObjectModel;
+    /**
+     * @experimental navigation is experimental and subject to change
+     */
+    navigation?: Navigation;
     refreshUrl?: string;
     /**
      * @deprecated Please use refreshUrl instead
@@ -83,15 +88,6 @@ export type DecisionStepOption = {
 };
 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
  */

package/build/spec/responses.d.ts

@@ -0,0 +1,18 @@
+import { Action } from './Action';
+import { SearchResult } from './Search';
+import { FormErrors, GlobalError } from './Step';
+export type ActionResponseBody = {
+    action: Action;
+};
+export type ErrorResponseBody = {
+    error?: GlobalError;
+    validation?: FormErrors;
+    refreshUrl?: string;
+    /**
+     * @deprecated Please use refreshUrl instead
+     */
+    refreshFormUrl?: string;
+};
+export type SearchResponseBody = {
+    results: SearchResult[];
+};

package/package.json

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