@wise/dynamic-flow-types 3.12.0 → 3.13.0

package/build/main.js

@@ -215,6 +215,9 @@ var instructionsLayoutItemSchema = import_zod.z.object({
 var modalLayoutTriggerSchema = import_zod.z.object({
   title: import_zod.z.string()
 });
+var helpSchema = import_zod.z.object({
+  markdown: import_zod.z.string()
+});
 var searchLayoutSchema = import_zod.z.object({
   type: import_zod.z.literal("search"),
   title: import_zod.z.string(),
@@ -264,9 +267,6 @@ var columnsLayoutBiasSchema = import_zod.z.union([
   import_zod.z.literal("left"),
   import_zod.z.literal("right")
 ]);
-var helpSchema = import_zod.z.object({
-  markdown: import_zod.z.string()
-});
 var searchSearchRequestSchema = import_zod.z.object({
   url: import_zod.z.string(),
   method: httpMethodSchema,
@@ -364,6 +364,18 @@ var instructionsLayoutSchema = import_zod.z.object({
   margin: sizeSchema.optional(),
   analyticsId: import_zod.z.string().optional()
 });
+var progressLayoutSchema = import_zod.z.object({
+  type: import_zod.z.literal("progress"),
+  title: import_zod.z.string().optional(),
+  description: import_zod.z.string().optional(),
+  progress: import_zod.z.number(),
+  progressText: import_zod.z.string(),
+  context: contextSchema.optional(),
+  help: helpSchema.optional(),
+  control: import_zod.z.string().optional(),
+  margin: sizeSchema.optional(),
+  analyticsId: import_zod.z.string().optional()
+});
 var actionResponseBodySchema = import_zod.z.object({
   action: actionSchema
 });
@@ -626,6 +638,7 @@ var layoutSchema = import_zod.z.lazy(
     markdownLayoutSchema,
     modalLayoutSchema,
     paragraphLayoutSchema,
+    progressLayoutSchema,
     reviewLayoutSchema,
     searchLayoutSchema,
     sectionLayoutSchema,
@@ -784,8 +797,8 @@ var linkHandlerSchema = import_zod.z.lazy(
 );
 var toolbarSchema = import_zod.z.lazy(
   () => import_zod.z.object({
-    control: import_zod.z.string().optional(),
-    items: import_zod.z.array(toolbarItemSchema)
+    items: import_zod.z.array(toolbarItemSchema),
+    control: import_zod.z.string().optional()
   })
 );
 var allOfSchemaSchema = import_zod.z.lazy(

package/build/main.mjs

@@ -187,6 +187,9 @@ var instructionsLayoutItemSchema = z.object({
 var modalLayoutTriggerSchema = z.object({
   title: z.string()
 });
+var helpSchema = z.object({
+  markdown: z.string()
+});
 var searchLayoutSchema = z.object({
   type: z.literal("search"),
   title: z.string(),
@@ -236,9 +239,6 @@ var columnsLayoutBiasSchema = z.union([
   z.literal("left"),
   z.literal("right")
 ]);
-var helpSchema = z.object({
-  markdown: z.string()
-});
 var searchSearchRequestSchema = z.object({
   url: z.string(),
   method: httpMethodSchema,
@@ -336,6 +336,18 @@ var instructionsLayoutSchema = z.object({
   margin: sizeSchema.optional(),
   analyticsId: z.string().optional()
 });
+var progressLayoutSchema = z.object({
+  type: z.literal("progress"),
+  title: z.string().optional(),
+  description: z.string().optional(),
+  progress: z.number(),
+  progressText: z.string(),
+  context: contextSchema.optional(),
+  help: helpSchema.optional(),
+  control: z.string().optional(),
+  margin: sizeSchema.optional(),
+  analyticsId: z.string().optional()
+});
 var actionResponseBodySchema = z.object({
   action: actionSchema
 });
@@ -598,6 +610,7 @@ var layoutSchema = z.lazy(
     markdownLayoutSchema,
     modalLayoutSchema,
     paragraphLayoutSchema,
+    progressLayoutSchema,
     reviewLayoutSchema,
     searchLayoutSchema,
     sectionLayoutSchema,
@@ -756,8 +769,8 @@ var linkHandlerSchema = z.lazy(
 );
 var toolbarSchema = z.lazy(
   () => z.object({
-    control: z.string().optional(),
-    items: z.array(toolbarItemSchema)
+    items: z.array(toolbarItemSchema),
+    control: z.string().optional()
   })
 );
 var allOfSchemaSchema = z.lazy(

package/build/next/feature/toolbar/Toolbar.d.ts

@@ -1,14 +1,14 @@
 import type { ToolbarItem } from './ToolbarItem';
 /**
-* `Toolbar` contains an optional array of type `Toolbar.Item` containing items to be displayed in the toolbar.
+* Used to display items in the screen's toolbar, typically a horizontal bar at the top of the screen.
 */
 export type Toolbar = {
-    /**
-    * Specify a particular control to use to represent the toolbar. If the control is unknown, it will be ignored.
-    */
-    control?: string;
     /**
     * The items to be displayed in the toolbar.
     */
     items: ToolbarItem[];
+    /**
+    * Specify a particular control to use to represent the toolbar. If the control is unknown, it will be ignored.
+    */
+    control?: string;
 };

package/build/next/index.d.ts

@@ -48,6 +48,7 @@ export type { ModalLayout } from './layout/ModalLayout';
 export type { ModalLayoutContent } from './layout/ModalLayoutContent';
 export type { ModalLayoutTrigger } from './layout/ModalLayoutTrigger';
 export type { ParagraphLayout } from './layout/ParagraphLayout';
+export type { ProgressLayout } from './layout/ProgressLayout';
 export type { ReviewLayout } from './layout/ReviewLayout';
 export type { ReviewLayoutCallToAction } from './layout/ReviewLayoutCallToAction';
 export type { ReviewLayoutField } from './layout/ReviewLayoutField';

package/build/next/layout/Layout.d.ts

@@ -14,6 +14,7 @@ import type { LoadingIndicatorLayout } from './LoadingIndicatorLayout';
 import type { MarkdownLayout } from './MarkdownLayout';
 import type { ModalLayout } from './ModalLayout';
 import type { ParagraphLayout } from './ParagraphLayout';
+import type { ProgressLayout } from './ProgressLayout';
 import type { ReviewLayout } from './ReviewLayout';
 import type { SearchLayout } from './SearchLayout';
 import type { SectionLayout } from './SectionLayout';
@@ -22,4 +23,4 @@ import type { TabsLayout } from './TabsLayout';
 /**
 * Layouts allow you to display information to the user and customise how a step is structured.
 */
-export type Layout = AlertLayout | BoxLayout | ButtonLayout | ColumnsLayout | DecisionLayout | DividerLayout | FormLayout | HeadingLayout | ImageLayout | InfoLayout | InstructionsLayout | ListLayout | LoadingIndicatorLayout | MarkdownLayout | ModalLayout | ParagraphLayout | ReviewLayout | SearchLayout | SectionLayout | StatusListLayout | TabsLayout;
+export type Layout = AlertLayout | BoxLayout | ButtonLayout | ColumnsLayout | DecisionLayout | DividerLayout | FormLayout | HeadingLayout | ImageLayout | InfoLayout | InstructionsLayout | ListLayout | LoadingIndicatorLayout | MarkdownLayout | ModalLayout | ParagraphLayout | ProgressLayout | ReviewLayout | SearchLayout | SectionLayout | StatusListLayout | TabsLayout;

package/build/next/layout/ProgressLayout.d.ts

@@ -0,0 +1,48 @@
+import type { Context } from '../misc/Context';
+import type { Help } from '../feature/Help';
+import type { Size } from '../misc/Size';
+/**
+* An indicator which can be used to show progress towards a goal or limit.
+*/
+export type ProgressLayout = {
+    /**
+    * It must be `progress`.
+    */
+    type: 'progress';
+    /**
+    * The user-facing title of the progress indicator.
+    */
+    title?: string;
+    /**
+    * The user-facing description of the progress indicator.
+    */
+    description?: string;
+    /**
+    * The progress towards the total, as a float between 0 and 1.
+    */
+    progress: number;
+    /**
+    * A text representation of the progress, to be displayed to the user and/or used by assistive technologies (e.g. 5GB remaining or 10/125 cats herded).
+    */
+    progressText: string;
+    /**
+    * The sentiment of the progress (e.g. warning can be used to indicate approaching a limit).
+    */
+    context?: Context;
+    /**
+    * Provide additional helpful information to the user.
+    */
+    help?: Help;
+    /**
+    * Specify a particular control to use to represent the layout. If the control is unknown, it will be ignored.
+    */
+    control?: string;
+    /**
+    * The vertical margin to apply after this component. Defaults to `md`.
+    */
+    margin?: Size;
+    /**
+    * An optional identifier to be used in analytics tracking.
+    */
+    analyticsId?: string;
+};

package/build/renderers/ProgressRendererProps.d.ts

@@ -0,0 +1,13 @@
+import { Context, Margin } from './constants';
+import { BaseRendererProps } from './RendererProps';
+export type ProgressRendererProps = BaseRendererProps & {
+    type: 'progress';
+    context: Context;
+    control?: string;
+    description?: string;
+    help?: string;
+    margin: Margin;
+    progress: number;
+    progressText: string;
+    title?: string;
+};

package/build/renderers/RendererProps.d.ts

@@ -24,6 +24,7 @@ import type { MultiSelectInputRendererProps } from './MultiSelectInputRendererPr
 import type { MultiUploadInputRendererProps } from './MultiUploadInputRendererProps';
 import type { NumberInputRendererProps } from './NumberInputRendererProps';
 import type { ParagraphRendererProps } from './ParagraphRendererProps';
+import type { ProgressRendererProps } from './ProgressRendererProps';
 import type { RepeatableRendererProps } from './RepeatableRendererProps';
 import type { ReviewRendererProps } from './ReviewRendererProps';
 import type { RootRendererProps } from './RootRendererProps';
@@ -35,7 +36,7 @@ import type { AnalyticsEventDispatcher, LoadingState, StepRendererProps } from '
 import { TabsRendererProps } from './TabsRendererProps';
 import type { TextInputRendererProps } from './TextInputRendererProps';
 import type { UploadInputRendererProps } from './UploadInputRendererProps';
-export type RendererProps = AlertRendererProps | CheckboxInputRendererProps | BoxRendererProps | ButtonRendererProps | ColumnsRendererProps | CoreContainerRendererProps | DateInputRendererProps | DecisionRendererProps | DividerRendererProps | ExternalConfirmationRendererProps | FormRendererProps | HeadingRendererProps | HiddenRendererProps | ImageRendererProps | InstructionsRendererProps | IntegerInputRendererProps | ListRendererProps | LoadingIndicatorRendererProps | MarkdownRendererProps | ModalLayoutRendererProps | ModalRendererProps | MultiSelectInputRendererProps | MultiUploadInputRendererProps | NumberInputRendererProps | ParagraphRendererProps | RepeatableRendererProps | ReviewRendererProps | RootRendererProps | SearchRendererProps | FormSectionRendererProps | SelectInputRendererProps | SectionRendererProps | StatusListRendererProps | StepRendererProps | TabsRendererProps | TextInputRendererProps | UploadInputRendererProps;
+export type RendererProps = AlertRendererProps | CheckboxInputRendererProps | BoxRendererProps | ButtonRendererProps | ColumnsRendererProps | CoreContainerRendererProps | DateInputRendererProps | DecisionRendererProps | DividerRendererProps | ExternalConfirmationRendererProps | FormRendererProps | HeadingRendererProps | HiddenRendererProps | ImageRendererProps | InstructionsRendererProps | IntegerInputRendererProps | ListRendererProps | LoadingIndicatorRendererProps | MarkdownRendererProps | ModalLayoutRendererProps | ModalRendererProps | MultiSelectInputRendererProps | MultiUploadInputRendererProps | NumberInputRendererProps | ParagraphRendererProps | ProgressRendererProps | RepeatableRendererProps | ReviewRendererProps | RootRendererProps | SearchRendererProps | FormSectionRendererProps | SelectInputRendererProps | SectionRendererProps | StatusListRendererProps | StepRendererProps | TabsRendererProps | TextInputRendererProps | UploadInputRendererProps;
 export type Renderer<P extends RendererProps> = {
     canRenderType: P['type'];
     canRender?: (props: P) => boolean;
@@ -45,7 +46,7 @@ export type RendererContext = {
     render: RenderFunction;
 };
 export type RenderFunction = (props: RendererProps | null) => JSX.Element | null;
-export type Renderers = readonly (Renderer<StepRendererProps> | Renderer<CoreContainerRendererProps> | Renderer<AlertRendererProps> | Renderer<BoxRendererProps> | Renderer<ColumnsRendererProps> | Renderer<DecisionRendererProps> | Renderer<DividerRendererProps> | Renderer<ExternalConfirmationRendererProps> | Renderer<FormRendererProps> | Renderer<HeadingRendererProps> | Renderer<InstructionsRendererProps> | Renderer<ListRendererProps> | Renderer<LoadingIndicatorRendererProps> | Renderer<MarkdownRendererProps> | Renderer<ImageRendererProps> | Renderer<ModalLayoutRendererProps> | Renderer<ModalRendererProps> | Renderer<ParagraphRendererProps> | Renderer<ReviewRendererProps> | Renderer<SearchRendererProps> | Renderer<StatusListRendererProps> | Renderer<CheckboxInputRendererProps> | Renderer<ButtonRendererProps> | Renderer<DateInputRendererProps> | Renderer<HiddenRendererProps> | Renderer<IntegerInputRendererProps> | Renderer<NumberInputRendererProps> | Renderer<RepeatableRendererProps> | Renderer<RootRendererProps> | Renderer<FormSectionRendererProps> | Renderer<SelectInputRendererProps> | Renderer<SectionRendererProps> | Renderer<MultiSelectInputRendererProps> | Renderer<TabsRendererProps> | Renderer<TextInputRendererProps> | Renderer<UploadInputRendererProps> | Renderer<MultiUploadInputRendererProps>)[];
+export type Renderers = readonly (Renderer<StepRendererProps> | Renderer<CoreContainerRendererProps> | Renderer<AlertRendererProps> | Renderer<BoxRendererProps> | Renderer<ColumnsRendererProps> | Renderer<DecisionRendererProps> | Renderer<DividerRendererProps> | Renderer<ExternalConfirmationRendererProps> | Renderer<FormRendererProps> | Renderer<HeadingRendererProps> | Renderer<InstructionsRendererProps> | Renderer<ListRendererProps> | Renderer<LoadingIndicatorRendererProps> | Renderer<MarkdownRendererProps> | Renderer<ImageRendererProps> | Renderer<ModalLayoutRendererProps> | Renderer<ModalRendererProps> | Renderer<ParagraphRendererProps> | Renderer<ProgressRendererProps> | Renderer<ReviewRendererProps> | Renderer<SearchRendererProps> | Renderer<StatusListRendererProps> | Renderer<CheckboxInputRendererProps> | Renderer<ButtonRendererProps> | Renderer<DateInputRendererProps> | Renderer<HiddenRendererProps> | Renderer<IntegerInputRendererProps> | Renderer<NumberInputRendererProps> | Renderer<RepeatableRendererProps> | Renderer<RootRendererProps> | Renderer<FormSectionRendererProps> | Renderer<SelectInputRendererProps> | Renderer<SectionRendererProps> | Renderer<MultiSelectInputRendererProps> | Renderer<TabsRendererProps> | Renderer<TextInputRendererProps> | Renderer<UploadInputRendererProps> | Renderer<MultiUploadInputRendererProps>)[];
 export type BaseRendererProps = {
     uid: string;
     analyticsId?: string;

package/build/renderers/index.d.ts

@@ -25,6 +25,7 @@ export type { MultiSelectInputRendererProps } from './MultiSelectInputRendererPr
 export type { MultiUploadInputRendererProps } from './MultiUploadInputRendererProps';
 export type { NumberInputRendererProps } from './NumberInputRendererProps';
 export type { ParagraphRendererProps } from './ParagraphRendererProps';
+export type { ProgressRendererProps } from './ProgressRendererProps';
 export type { RepeatableItemRendererProps, RepeatableRendererProps, } from './RepeatableRendererProps';
 export type { ReviewField, ReviewRendererProps } from './ReviewRendererProps';
 export type { RootRendererProps } from './RootRendererProps';

package/build/zod/schemas.d.ts

@@ -256,6 +256,13 @@ export declare const modalLayoutTriggerSchema: z.ZodObject<{
 }, {
     title: string;
 }>;
+export declare const helpSchema: z.ZodObject<{
+    markdown: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    markdown: string;
+}, {
+    markdown: string;
+}>;
 export declare const searchLayoutSchema: z.ZodObject<{
     type: z.ZodLiteral<"search">;
     title: z.ZodString;
@@ -389,13 +396,6 @@ export declare const markdownLayoutSchema: z.ZodObject<{
     align?: "left" | "right" | "center" | undefined;
 }>;
 export declare const columnsLayoutBiasSchema: z.ZodUnion<[z.ZodLiteral<"none">, z.ZodLiteral<"left">, z.ZodLiteral<"right">]>;
-export declare const helpSchema: z.ZodObject<{
-    markdown: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    markdown: string;
-}, {
-    markdown: string;
-}>;
 export declare const searchSearchRequestSchema: z.ZodObject<{
     url: z.ZodString;
     method: z.ZodUnion<[z.ZodLiteral<"GET">, z.ZodLiteral<"POST">, z.ZodLiteral<"PUT">, z.ZodLiteral<"PATCH">, z.ZodLiteral<"DELETE">]>;
@@ -622,6 +622,50 @@ export declare const instructionsLayoutSchema: z.ZodObject<{
     control?: string | undefined;
     margin?: "xs" | "sm" | "md" | "lg" | "xl" | undefined;
 }>;
+export declare const progressLayoutSchema: z.ZodObject<{
+    type: z.ZodLiteral<"progress">;
+    title: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+    progress: z.ZodNumber;
+    progressText: z.ZodString;
+    context: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"positive">, z.ZodLiteral<"neutral">, z.ZodLiteral<"warning">, z.ZodLiteral<"negative">, z.ZodLiteral<"success">, z.ZodLiteral<"failure">, z.ZodLiteral<"info">, z.ZodLiteral<"primary">]>>;
+    help: z.ZodOptional<z.ZodObject<{
+        markdown: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        markdown: string;
+    }, {
+        markdown: string;
+    }>>;
+    control: z.ZodOptional<z.ZodString>;
+    margin: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"xs">, z.ZodLiteral<"sm">, z.ZodLiteral<"md">, z.ZodLiteral<"lg">, z.ZodLiteral<"xl">]>>;
+    analyticsId: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    type: "progress";
+    progress: number;
+    progressText: string;
+    analyticsId?: string | undefined;
+    description?: string | undefined;
+    help?: {
+        markdown: string;
+    } | undefined;
+    title?: string | undefined;
+    control?: string | undefined;
+    context?: "neutral" | "warning" | "positive" | "negative" | "success" | "failure" | "info" | "primary" | undefined;
+    margin?: "xs" | "sm" | "md" | "lg" | "xl" | undefined;
+}, {
+    type: "progress";
+    progress: number;
+    progressText: string;
+    analyticsId?: string | undefined;
+    description?: string | undefined;
+    help?: {
+        markdown: string;
+    } | undefined;
+    title?: string | undefined;
+    control?: string | undefined;
+    context?: "neutral" | "warning" | "positive" | "negative" | "success" | "failure" | "info" | "primary" | undefined;
+    margin?: "xs" | "sm" | "md" | "lg" | "xl" | undefined;
+}>;
 export declare const actionResponseBodySchema: z.ZodObject<{
     action: z.ZodObject<{
         title: z.ZodOptional<z.ZodString>;

package/build/zod/schemas.ts

@@ -328,6 +328,19 @@ export const markdownLayoutSchema = z.object({
   analyticsId: z.string().optional(),
 });
 
+export const progressLayoutSchema = z.object({
+  type: z.literal('progress'),
+  title: z.string().optional(),
+  description: z.string().optional(),
+  progress: z.number(),
+  progressText: z.string(),
+  context: contextSchema.optional(),
+  help: helpSchema.optional(),
+  control: z.string().optional(),
+  margin: sizeSchema.optional(),
+  analyticsId: z.string().optional(),
+});
+
 export const searchLayoutSchema = z.object({
   type: z.literal('search'),
   title: z.string(),
@@ -938,6 +951,7 @@ export const layoutSchema: z.ZodSchema<Layout> = z.lazy(() =>
     markdownLayoutSchema,
     modalLayoutSchema,
     paragraphLayoutSchema,
+    progressLayoutSchema,
     reviewLayoutSchema,
     searchLayoutSchema,
     sectionLayoutSchema,
@@ -964,8 +978,8 @@ export const toolbarButtonSchema: z.ZodSchema<ToolbarButton> = z.lazy(() =>
 
 export const toolbarSchema: z.ZodSchema<Toolbar> = z.lazy(() =>
   z.object({
-    control: z.string().optional(),
     items: z.array(toolbarItemSchema),
+    control: z.string().optional(),
   }),
 );
 

package/package.json

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