@wise/dynamic-flow-client 2.8.4 → 2.8.5

package/build/types/common/helpMessages/help.messages.d.ts

@@ -0,0 +1,8 @@
+declare const _default: {
+    helpAria: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};
+export default _default;

package/build/types/revamp/domain/components/ContainerComponent.d.ts

@@ -0,0 +1,11 @@
+import type { Model } from '@wise/dynamic-flow-types';
+import type { BaseComponent, StepComponent } from '../types';
+export type ContainerComponent = BaseComponent<Model> & {
+    type: 'container';
+    components: StepComponent[];
+    getChildren: () => StepComponent[];
+};
+export declare const createContainerComponent: (containerProps: {
+    uid: string;
+    components: StepComponent[];
+}) => ContainerComponent;

package/build/types/revamp/domain/components/IntegerInputComponent.d.ts

@@ -3,6 +3,6 @@ import type { IsInvalidCheck } from '../validation/value-checks';
 export type IntegerInputComponent = InputComponent<number> & {
     type: 'integer';
 };
-export declare const createIntegerInputComponent: (integerInputProps: Pick<IntegerInputComponent, "description" | "disabled" | "title" | "placeholder" | "control" | "id" | "errors" | "value" | "autoComplete" | "uid"> & {
+export declare const createIntegerInputComponent: (integerInputProps: Pick<IntegerInputComponent, "description" | "disabled" | "help" | "title" | "placeholder" | "control" | "id" | "errors" | "value" | "autoComplete" | "uid"> & {
     checks: IsInvalidCheck<number | null>[];
 }, updateComponent: UpdateComponent) => IntegerInputComponent;

package/build/types/revamp/domain/components/NumberInputComponent.d.ts

@@ -3,6 +3,6 @@ import type { IsInvalidCheck } from '../validation/value-checks';
 export type NumberInputComponent = InputComponent<number> & {
     type: 'number';
 };
-export declare const createNumberInputComponent: (numberInputProps: Pick<NumberInputComponent, "description" | "disabled" | "title" | "placeholder" | "control" | "id" | "errors" | "value" | "autoComplete" | "uid"> & {
+export declare const createNumberInputComponent: (numberInputProps: Pick<NumberInputComponent, "description" | "disabled" | "help" | "title" | "placeholder" | "control" | "id" | "errors" | "value" | "autoComplete" | "uid"> & {
     checks: IsInvalidCheck<number | null>[];
 }, updateComponent: UpdateComponent) => NumberInputComponent;

package/build/types/revamp/domain/components/ObjectComponent.d.ts

@@ -5,6 +5,7 @@ export type ObjectComponent = Omit<BaseComponent<Record<string, Model>>, 'getVal
     title?: string;
     description?: string;
     componentMap: Record<string, StepComponent>;
+    help?: string;
     getChildren: () => StepComponent[];
     getValue: () => Record<string, Model>;
 };
@@ -14,4 +15,5 @@ export declare const createObjectComponent: (objectProps: {
     description?: string | undefined;
     displayOrder: string[];
     components: Record<string, StepComponent>;
+    help?: string | undefined;
 }) => ObjectComponent;

package/build/types/revamp/domain/components/TextInputComponent.d.ts

@@ -3,6 +3,6 @@ import type { IsInvalidCheck } from '../validation/value-checks';
 export type TextInputComponent = InputComponent<string> & {
     type: 'text';
 };
-export declare const createTextInputComponent: (textInputProps: Pick<TextInputComponent, "description" | "disabled" | "title" | "placeholder" | "control" | "id" | "errors" | "value" | "autoComplete" | "uid"> & {
+export declare const createTextInputComponent: (textInputProps: Pick<TextInputComponent, "description" | "disabled" | "help" | "title" | "placeholder" | "control" | "id" | "errors" | "value" | "autoComplete" | "uid"> & {
     checks: IsInvalidCheck<string | null>[];
 }, updateComponent: UpdateComponent) => TextInputComponent;

package/build/types/revamp/domain/types.d.ts

@@ -9,8 +9,9 @@ import type { TextInputComponent } from './components/TextInputComponent';
 import type { ColumnsComponent } from './components/ColumnsComponent';
 import type { NumberInputComponent } from './components/NumberInputComponent';
 import type { IntegerInputComponent } from './components/IntegerInputComponent';
-export type StepComponent = AlertComponent | BoxComponent | ButtonComponent | ColumnsComponent | HeadingComponent | ObjectComponent | ParagraphComponent | TextInputComponent | NumberInputComponent | IntegerInputComponent;
-export type ContainerComponent = ObjectComponent | BoxComponent | ColumnsComponent;
+import type { ContainerComponent } from './components/ContainerComponent';
+export type StepComponent = AlertComponent | BoxComponent | ButtonComponent | ColumnsComponent | ContainerComponent | HeadingComponent | ObjectComponent | ParagraphComponent | TextInputComponent | NumberInputComponent | IntegerInputComponent;
+export type HasChildren = ObjectComponent | BoxComponent | ColumnsComponent | ContainerComponent;
 export type BaseComponent<M extends Model> = {
     type: string;
     uid: string;
@@ -28,6 +29,7 @@ export type InputComponent<M extends Model> = BaseComponent<M> & {
     description?: string;
     disabled: boolean;
     errors: string[];
+    help?: string;
     placeholder?: string;
     title?: string;
     value: M | null;

package/build/types/revamp/renderers/CoreContainerRenderer.d.ts

@@ -0,0 +1,7 @@
+import type { ReactNode } from 'react';
+import type { Renderer, RendererProps } from './types';
+export interface CoreContainerRendererProps extends RendererProps {
+    type: 'container';
+    children: ReactNode;
+}
+export declare const CoreContainerRenderer: Renderer<CoreContainerRendererProps>;

package/build/types/revamp/renderers/mappers/containerComponentToProps.d.ts

@@ -0,0 +1,3 @@
+import type { ReactNode } from 'react';
+import type { CoreContainerRendererProps } from '../CoreContainerRenderer';
+export declare const containerComponentToProps: (children: ReactNode) => CoreContainerRendererProps;

package/build/types/revamp/renderers/mappers/objectComponentToProps.d.ts

@@ -1,4 +1,4 @@
 import type { ReactNode } from 'react';
 import type { ObjectComponent } from '../../domain/components/ObjectComponent';
 import type { ObjectRendererProps } from '../types';
-export declare const objectComponentToProps: ({ title, description }: ObjectComponent, children: ReactNode) => ObjectRendererProps;
+export declare const objectComponentToProps: ({ title, description, help }: ObjectComponent, children: ReactNode) => ObjectRendererProps;

package/build/types/revamp/renderers/types.d.ts

@@ -52,6 +52,7 @@ export interface ObjectRendererProps extends RendererProps {
     type: 'object';
     title?: string;
     description?: string;
+    help?: string;
     children: ReactNode;
 }
 interface BaseInputRendererProps<M extends string | number> extends RendererProps {
@@ -61,6 +62,7 @@ interface BaseInputRendererProps<M extends string | number> extends RendererProp
     description?: string;
     error?: string;
     format?: 'date';
+    help?: string;
     label?: string;
     name: string;
     placeholder?: string;

package/build/types/revamp/utils/type-utils.d.ts

@@ -1,7 +1,7 @@
 import type { AllOfSchema, IntegerSchema, Model, NumberSchema, ObjectSchema, OneOfSchema, Schema, StringSchema } from '@wise/dynamic-flow-types/build/next';
-import type { ContainerComponent, StepComponent } from '../domain/types';
+import type { HasChildren, StepComponent } from '../domain/types';
 import type { ColumnsComponent } from '../domain/components/ColumnsComponent';
-export declare const isContainerComponent: (component: StepComponent) => component is ContainerComponent;
+export declare const hasChildren: (component: StepComponent) => component is HasChildren;
 export declare const isColumnsComponent: (component: StepComponent) => component is ColumnsComponent;
 export declare const isObjectModel: (model: Model) => model is Record<string, Model>;
 export declare const isAllOfSchema: (schema: Schema) => schema is AllOfSchema;

package/build/types/revamp/wise/renderers/utils/Label.d.ts

@@ -0,0 +1,5 @@
+declare function Label({ text, help }: {
+    text?: string;
+    help?: string;
+}): JSX.Element;
+export default Label;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wise/dynamic-flow-client",
-  "version": "2.8.4",
+  "version": "2.8.5",
   "description": "Dynamic Flow web client",
   "license": "Apache-2.0",
   "main": "./build/main.min.js",
@@ -91,7 +91,7 @@
     "classnames": "2.3.2",
     "react-webcam": "^7.2.0",
     "screenfull": "^5.2.0",
-    "@wise/dynamic-flow-types": "2.4.0"
+    "@wise/dynamic-flow-types": "2.4.1"
   },
   "scripts": {
     "dev": "storybook dev -p 3003",

package/build/types/legacy/jsonSchemaForm/help/Help.messages.d.ts

@@ -1,8 +0,0 @@
-declare namespace _default {
-    namespace helpAria {
-        const id: string;
-        const defaultMessage: string;
-        const description: string;
-    }
-}
-export default _default;