@wise/dynamic-flow-types 0.0.2 → 1.1.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @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

package/README.md

@@ -0,0 +1,3 @@
+# Dynamic Flow TypeScript Types
+
+This package contains the Dynamic Flow TypeScript types which are used in @wise/dynamic-flow-client and other packages.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wise/dynamic-flow-types",
-  "version": "0.0.2",
+  "version": "1.1.0",
   "description": "Dynamic Flow TypeScript Types",
   "license": "Apache-2.0",
   "main": "./src/index.ts",

package/src/spec/Action.ts

@@ -1,6 +1,10 @@
 import { HttpMethod } from './core';
 
 type CoreAction = {
+  id?: string;
+  /**
+   * @deprecated Please use id instead
+   */
   $id?: string;
   data?: Record<string, unknown>;
   exit?: boolean;

package/src/spec/LayoutComponent.ts

@@ -19,7 +19,8 @@ export type LayoutComponent =
   | LoadingIndicatorLayout
   | MarkdownLayout
   | ParagraphLayout
-  | ReviewLayout;
+  | ReviewLayout
+  | StatusListLayout;
 
 export type AlertLayout = { type: 'alert' } & Alert;
 
@@ -126,12 +127,16 @@ export type InfoLayout = {
   align?: Align;
 };
 
+/**
+ * @deprecated Please use StatusListLayout instead
+ */
 export type ListLayout = {
   type: 'list';
   items: ListItem[];
   title?: string;
   margin?: Margin;
 };
+
 type ListItem = {
   title: string;
   description?: string;
@@ -139,6 +144,20 @@ type ListItem = {
   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;