@wise/dynamic-flow-types 2.5.1 → 2.6.1

package/build/index.d.ts

@@ -12,4 +12,5 @@ export * from './spec/Schema';
 export * from './spec/Step';
 export * from './spec/ValidationAsync';
 export * from './spec/Search';
+export { stepSchema, actionResponseBodySchema, errorResponseBodySchema, searchResponseBodySchema, } from './zod/schemas';
 export type { FileUploadSchema, CameraDirection } from './spec/FileUploadSchema';

package/build/next/JsonElement.d.ts

@@ -0,0 +1,6 @@
+export type JsonElement = JsonPrimitive | JsonObject | JsonArray;
+export type JsonPrimitive = boolean | number | string | null;
+export interface JsonObject extends Record<string, JsonPrimitive | JsonObject | JsonArray> {
+}
+export interface JsonArray extends Array<JsonPrimitive | JsonObject | JsonArray> {
+}

package/build/next/feature/Action.d.ts

@@ -1,12 +1,13 @@
 import type { ActionType } from './ActionType';
 import type { HttpMethod } from '../misc/HttpMethod';
+import type { JsonElement } from '../JsonElement';
 export type Action = {
     id?: string;
     url?: string;
     method?: HttpMethod;
     exit?: boolean;
-    result?: unknown;
-    data?: unknown;
+    result?: JsonElement;
+    data?: JsonElement;
     timeout?: number;
     /**
     * @deprecated Please use Button.title instead

package/build/next/feature/StepError.d.ts

@@ -1,4 +1,5 @@
+import type { JsonElement } from '../JsonElement';
 export type StepError = {
     error?: string;
-    validation?: unknown;
+    validation?: JsonElement;
 };

package/build/next/index.d.ts

@@ -1,22 +1,40 @@
-import type { Step as GeneratedStep } from './step/Step';
 import type { FormLayout as GeneratedFormLayout } from './layout/FormLayout';
+import type { JsonElement } from './JsonElement';
 export type { Action } from './feature/Action';
+export type { PersistAsync } from './feature/PersistAsync';
 export type { Align } from './misc/Align';
 export type { Context } from './misc/Context';
 export type { Size } from './misc/Size';
 export type { Size as Margin } from './misc/Size';
 export type { Icon } from './misc/Icon';
+export type { Image } from './misc/Image';
 export type { Layout } from './layout/Layout';
 export type { AlertLayout } from './layout/AlertLayout';
 export type { BoxLayout } from './layout/BoxLayout';
 export type { ButtonLayout } from './layout/ButtonLayout';
 export type { ColumnsLayout } from './layout/ColumnsLayout';
+export type { DecisionLayout } from './layout/DecisionLayout';
+export type { DecisionLayoutOption } from './layout/DecisionLayoutOption';
+export type { DividerLayout } from './layout/DividerLayout';
 export type FormLayout = GeneratedFormLayout & {
     schema?: Reference;
 };
 export type { HeadingLayout } from './layout/HeadingLayout';
-export type { ParagraphLayout } from './layout/ParagraphLayout';
 export type { ImageLayout } from './layout/ImageLayout';
+export type { InstructionsLayout } from './layout/InstructionsLayout';
+export type { InstructionsLayoutItem } from './layout/InstructionsLayoutItem';
+export type { InfoLayout } from './layout/InfoLayout';
+export type { LoadingIndicatorLayout } from './layout/LoadingIndicatorLayout';
+export type { MarkdownLayout } from './layout/MarkdownLayout';
+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 { ReviewLayout } from './layout/ReviewLayout';
+export type { ReviewLayoutCallToAction } from './layout/ReviewLayoutCallToAction';
+export type { ReviewLayoutField } from './layout/ReviewLayoutField';
+export type { SearchResult } from './responses/search/SearchResult';
+export type { SearchResponseBody } from './responses/search/SearchResponseBody';
 export type { Schema } from './schema/Schema';
 export type { BooleanSchema } from './schema/BooleanSchema';
 export type { ConstSchema } from './schema/ConstSchema';
@@ -26,27 +44,14 @@ export type { OneOfSchema } from './schema/OneOfSchema';
 export type { StringSchema } from './schema/StringSchema';
 export type { NumberSchema } from './schema/NumberSchema';
 export type { IntegerSchema } from './schema/IntegerSchema';
+export type { ArraySchema } from './schema/ArraySchema';
+export type { ArraySchemaList } from './schema/ArraySchemaList';
+export type { ArraySchemaTuple } from './schema/ArraySchemaTuple';
 export type { StringSchemaFormat } from './schema/StringSchemaFormat';
-type BasicModel = boolean | number | string;
-type ObjectModel = {
-    [key: string]: Model;
-};
-type ArrayModel = (Model | null)[];
-export type Model = BasicModel | ObjectModel | ArrayModel | null;
-export type { SearchResult } from './responses/search/SearchResult';
-export type { SearchResponseBody } from './responses/search/SearchResponseBody';
-type ValidationErrorObject = {
-    [key: string]: ValidationError;
-};
-export type ValidationError = string | ValidationErrorObject | null;
-export type StepError = {
-    error?: string;
-    validation?: ValidationError;
-};
-export type Step = Omit<GeneratedStep, 'model' | 'errors'> & {
-    model?: Model;
-    errors?: StepError;
-};
+export type { Step } from './step/Step';
+export type { JsonElement, JsonPrimitive, JsonArray, JsonObject } from './JsonElement';
+export type Model = JsonElement;
+export type ValidationError = JsonElement;
 export type Reference = {
     $ref: string;
 };

package/build/next/misc/Image.d.ts

@@ -0,0 +1,11 @@
+export type Image = {
+    url: string;
+    /**
+    * @deprecated Please use 'accessibilityDescription' instead
+    */
+    text?: string;
+    /**
+    * @experimental This feature may be changed in the future without notice.
+    */
+    accessibilityDescription?: string;
+};

package/build/next/responses/error/ErrorResponseBody.d.ts

@@ -1,9 +1,14 @@
+import type { JsonElement } from '../../JsonElement';
 export type ErrorResponseBody = {
     error?: string;
-    validation?: unknown;
+    validation?: JsonElement;
     refreshUrl?: string;
     /**
     * @deprecated Please use 'refreshUrl' instead
     */
     refreshFormUrl?: string;
+    /**
+    * @experimental This feature may be changed in the future without notice.
+    */
+    analytics?: Record<string, string>;
 };

package/build/next/schema/AllOfSchema.d.ts

@@ -1,6 +1,6 @@
 import type { Schema } from './Schema';
 import type { Icon } from '../misc/Icon';
-import type { ImageLayout } from '../layout/ImageLayout';
+import type { Image } from '../misc/Image';
 import type { SummaryProvider } from '../feature/SummaryProvider';
 import type { AlertLayout } from '../layout/AlertLayout';
 export type AllOfSchema = {
@@ -12,7 +12,7 @@ export type AllOfSchema = {
     control?: string;
     hidden?: boolean;
     icon?: Icon;
-    image?: ImageLayout;
+    image?: Image;
     keywords?: string[];
     summary?: SummaryProvider;
     analyticsId?: string;

package/build/next/schema/ArraySchemaList.d.ts

@@ -1,6 +1,6 @@
 import type { Schema } from './Schema';
 import type { Icon } from '../misc/Icon';
-import type { ImageLayout } from '../layout/ImageLayout';
+import type { Image } from '../misc/Image';
 import type { SummarySummariser } from '../feature/SummarySummariser';
 import type { PersistAsync } from '../feature/PersistAsync';
 import type { ValidateAsync } from '../feature/ValidateAsync';
@@ -18,7 +18,7 @@ export type ArraySchemaList = {
     control?: string;
     hidden?: boolean;
     icon?: Icon;
-    image?: ImageLayout;
+    image?: Image;
     keywords?: string[];
     summary?: SummarySummariser;
     analyticsId?: string;

package/build/next/schema/ArraySchemaTuple.d.ts

@@ -1,6 +1,6 @@
 import type { Schema } from './Schema';
 import type { Icon } from '../misc/Icon';
-import type { ImageLayout } from '../layout/ImageLayout';
+import type { Image } from '../misc/Image';
 import type { SummaryProvider } from '../feature/SummaryProvider';
 import type { PersistAsync } from '../feature/PersistAsync';
 import type { ValidateAsync } from '../feature/ValidateAsync';
@@ -14,7 +14,7 @@ export type ArraySchemaTuple = {
     control?: string;
     hidden?: boolean;
     icon?: Icon;
-    image?: ImageLayout;
+    image?: Image;
     keywords?: string[];
     summary?: SummaryProvider;
     analyticsId?: string;

package/build/next/schema/BlobSchema.d.ts

@@ -1,6 +1,6 @@
 import type { BlobSchemaSource } from './BlobSchemaSource';
 import type { Icon } from '../misc/Icon';
-import type { ImageLayout } from '../layout/ImageLayout';
+import type { Image } from '../misc/Image';
 import type { SummaryProvider } from '../feature/SummaryProvider';
 import type { ValidateAsync } from '../feature/ValidateAsync';
 import type { AlertLayout } from '../layout/AlertLayout';
@@ -16,7 +16,7 @@ export type BlobSchema = {
     control?: string;
     hidden?: boolean;
     icon?: Icon;
-    image?: ImageLayout;
+    image?: Image;
     keywords?: string[];
     summary?: SummaryProvider;
     analyticsId?: string;

package/build/next/schema/BooleanSchema.d.ts

@@ -1,5 +1,5 @@
 import type { Icon } from '../misc/Icon';
-import type { ImageLayout } from '../layout/ImageLayout';
+import type { Image } from '../misc/Image';
 import type { SummaryProvider } from '../feature/SummaryProvider';
 import type { PersistAsync } from '../feature/PersistAsync';
 import type { ValidateAsync } from '../feature/ValidateAsync';
@@ -15,7 +15,7 @@ export type BooleanSchema = {
     hidden?: boolean;
     disabled?: boolean;
     icon?: Icon;
-    image?: ImageLayout;
+    image?: Image;
     keywords?: string[];
     summary?: SummaryProvider;
     analyticsId?: string;

package/build/next/schema/ConstSchema.d.ts

@@ -1,6 +1,7 @@
 import type { AlertLayout } from '../layout/AlertLayout';
+import type { JsonElement } from '../JsonElement';
 import type { Icon } from '../misc/Icon';
-import type { ImageLayout } from '../layout/ImageLayout';
+import type { Image } from '../misc/Image';
 import type { SummaryProvider } from '../feature/SummaryProvider';
 export type ConstSchema = {
     disabled?: boolean;
@@ -8,11 +9,11 @@ export type ConstSchema = {
     alert?: AlertLayout;
     control?: string;
     $id?: string;
-    const: unknown;
+    const: JsonElement;
     title?: string;
     description?: string;
     icon?: Icon;
-    image?: ImageLayout;
+    image?: Image;
     keywords?: string[];
     summary?: SummaryProvider;
     analyticsId?: string;

package/build/next/schema/IntegerSchema.d.ts

@@ -1,5 +1,5 @@
 import type { Icon } from '../misc/Icon';
-import type { ImageLayout } from '../layout/ImageLayout';
+import type { Image } from '../misc/Image';
 import type { SummaryProvider } from '../feature/SummaryProvider';
 import type { PersistAsync } from '../feature/PersistAsync';
 import type { ValidateAsync } from '../feature/ValidateAsync';
@@ -19,7 +19,7 @@ export type IntegerSchema = {
     hidden?: boolean;
     disabled?: boolean;
     icon?: Icon;
-    image?: ImageLayout;
+    image?: Image;
     keywords?: string[];
     summary?: SummaryProvider;
     analyticsId?: string;

package/build/next/schema/NumberSchema.d.ts

@@ -1,5 +1,5 @@
 import type { Icon } from '../misc/Icon';
-import type { ImageLayout } from '../layout/ImageLayout';
+import type { Image } from '../misc/Image';
 import type { SummaryProvider } from '../feature/SummaryProvider';
 import type { PersistAsync } from '../feature/PersistAsync';
 import type { ValidateAsync } from '../feature/ValidateAsync';
@@ -19,7 +19,7 @@ export type NumberSchema = {
     hidden?: boolean;
     disabled?: boolean;
     icon?: Icon;
-    image?: ImageLayout;
+    image?: Image;
     keywords?: string[];
     summary?: SummaryProvider;
     analyticsId?: string;

package/build/next/schema/ObjectSchema.d.ts

@@ -1,7 +1,7 @@
 import type { Help } from '../feature/Help';
 import type { Schema } from './Schema';
 import type { Icon } from '../misc/Icon';
-import type { ImageLayout } from '../layout/ImageLayout';
+import type { Image } from '../misc/Image';
 import type { SummaryProvider } from '../feature/SummaryProvider';
 import type { AlertLayout } from '../layout/AlertLayout';
 export type ObjectSchema = {
@@ -16,7 +16,7 @@ export type ObjectSchema = {
     control?: string;
     hidden?: boolean;
     icon?: Icon;
-    image?: ImageLayout;
+    image?: Image;
     keywords?: string[];
     summary?: SummaryProvider;
     analyticsId?: string;

package/build/next/schema/OneOfSchema.d.ts

@@ -1,6 +1,7 @@
+import type { JsonElement } from '../JsonElement';
 import type { Schema } from './Schema';
 import type { Icon } from '../misc/Icon';
-import type { ImageLayout } from '../layout/ImageLayout';
+import type { Image } from '../misc/Image';
 import type { SummaryProvider } from '../feature/SummaryProvider';
 import type { AlertLayout } from '../layout/AlertLayout';
 import type { Help } from '../feature/Help';
@@ -13,10 +14,10 @@ export type OneOfSchema = {
     title?: string;
     description?: string;
     control?: string;
-    default?: unknown;
+    default?: JsonElement;
     hidden?: boolean;
     icon?: Icon;
-    image?: ImageLayout;
+    image?: Image;
     keywords?: string[];
     summary?: SummaryProvider;
     analyticsId?: string;
@@ -49,5 +50,5 @@ export type OneOfSchema = {
     /**
     * @deprecated OneOf Promotion is no longer supported
     */
-    promotion?: unknown;
+    promotion?: JsonElement;
 };

package/build/next/schema/StringSchema.d.ts

@@ -1,7 +1,7 @@
 import type { StringSchemaSource } from './StringSchemaSource';
 import type { StringSchemaFormat } from './StringSchemaFormat';
 import type { Icon } from '../misc/Icon';
-import type { ImageLayout } from '../layout/ImageLayout';
+import type { Image } from '../misc/Image';
 import type { SummaryProvider } from '../feature/SummaryProvider';
 import type { PersistAsync } from '../feature/PersistAsync';
 import type { ValidateAsync } from '../feature/ValidateAsync';
@@ -26,7 +26,7 @@ export type StringSchema = {
     hidden?: boolean;
     disabled?: boolean;
     icon?: Icon;
-    image?: ImageLayout;
+    image?: Image;
     keywords?: string[];
     summary?: SummaryProvider;
     analyticsId?: string;

package/build/next/step/Step.d.ts

@@ -1,6 +1,7 @@
 import type { Action } from '../feature/Action';
 import type { Schema } from '../schema/Schema';
 import type { Layout } from '../layout/Layout';
+import type { JsonElement } from '../JsonElement';
 import type { External } from '../feature/External';
 import type { Polling } from '../feature/Polling';
 import type { LinkHandler } from '../feature/LinkHandler';
@@ -11,7 +12,7 @@ export type Step = {
     title: string;
     schemas: Schema[];
     layout: Layout[];
-    model?: unknown;
+    model?: JsonElement;
     external?: External;
     polling?: Polling;
     linkHandlers?: LinkHandler[];

package/build/zod/json.type.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Unfortunately we need this because ts-to-zod can't generate a valid
+ * schema for our exported version of this type. So, we add this manually
+ * during the schema generation because it is equivalent, but can be converted
+ * by ts-to-zod. (We can't use this type anywhere else because we get infinitely
+ * nesting types.)
+ */
+export type JsonElement = string | number | boolean | null | {
+    [x: string]: JsonElement;
+} | JsonElement[];