@wise/dynamic-flow-client 5.8.1 → 5.9.0

package/build/stories/spec/response/ActionResponse.story.js

@@ -0,0 +1,66 @@
+import { getMockHttpClient, respondWith } from '../../../test-utils';
+import DynamicFlowWise from '../../../test-utils/DynamicFlowWise';
+import { renderWithStep } from '../../utils/render-utils';
+export default {
+    component: DynamicFlowWise,
+    title: 'Spec/Response',
+    parameters: {
+        chromatic: { disableSnapshot: true },
+    },
+    argTypes: {},
+};
+export function ActionResponse() {
+    const httpClient = getMockHttpClient({
+        '/action/1234': async () => respondWith({ action: { url: '/success', data: { actionResponse: 'Action response action.data' } } }, { status: 200 }),
+        '/success': async () => respondWith(Object.assign(Object.assign({}, initialStep), { title: 'Success, try again!' })),
+    });
+    return renderWithStep(initialStep, httpClient);
+}
+const initialStep = {
+    id: 'action-response',
+    title: 'Action Response',
+    layout: [
+        {
+            type: 'box',
+            width: 'md',
+            border: true,
+            components: [
+                {
+                    type: 'form',
+                    schemaId: '#referenced-schema',
+                },
+                {
+                    type: 'button',
+                    title: 'Direct Success ("/success")',
+                    control: 'primary',
+                    action: { url: '/success', data: { direct: 'direct success button action data' } },
+                },
+                {
+                    type: 'button',
+                    title: 'Action Response ("/action/1234")',
+                    control: 'primary',
+                    action: { url: '/action/1234' },
+                },
+                { type: 'divider' },
+                {
+                    type: 'markdown',
+                    content: 'You can inspect the payload of every request using the Storybook "Actions" panel.\n\nWe expect the schema values to be part of the payload when triggering an action from a button.\n\nBut when the action is triggered as a result of an action response, only the `action.data` should be in the payload.',
+                },
+            ],
+        },
+    ],
+    schemas: [
+        {
+            $id: '#unreferenced-schema',
+            const: { unreferenced: 'schema-value' },
+        },
+        {
+            $id: '#referenced-schema',
+            type: 'object',
+            displayOrder: ['name'],
+            properties: {
+                name: { type: 'string', title: 'Name', default: 'John Doe' },
+            },
+        },
+    ],
+};

package/build/stories/spec/schemas/MultiSelect.story.js

@@ -0,0 +1,148 @@
+import DynamicFlowWise from '../../../test-utils/DynamicFlowWise';
+import { renderWithStep } from '../../utils/render-utils';
+export default {
+    component: DynamicFlowWise,
+    title: 'Spec/Schemas/MultiSelect',
+    parameters: {
+        chromatic: { disableSnapshot: true },
+    },
+};
+export function MultiSelect() {
+    return renderWithStep(getStep(undefined));
+}
+export function InlineMultiSelect() {
+    return renderWithStep(getStep('inline'));
+}
+const getStep = (arraySchemaControl) => ({
+    id: 'multi-select',
+    title: 'A multiselect example',
+    layout: [
+        {
+            type: 'form',
+            schemaId: '#schema',
+        },
+        { type: 'button', action: { url: '/submit' }, title: 'Submit' },
+    ],
+    schemas: [
+        {
+            $id: '#schema',
+            type: 'object',
+            displayOrder: ['arrayField'],
+            required: ['arrayField'],
+            properties: {
+                arrayField: {
+                    validationMessages: {
+                        required: 'Please select at least two options. (required)',
+                    },
+                    type: 'array',
+                    control: arraySchemaControl,
+                    title: 'Select between two and four options',
+                    minItems: 2,
+                    maxItems: 4,
+                    description: 'This is an example of an array schema with const options.',
+                    addItemTitle: '',
+                    editItemTitle: '',
+                    validationAsync: {
+                        url: '/validate',
+                        method: 'POST',
+                        param: 'value',
+                    },
+                    items: {
+                        title: 'Select with few options',
+                        description: 'A description of the select.',
+                        oneOf: [
+                            {
+                                title: 'EUR',
+                                description: 'Euro',
+                                icon: { name: 'flag-eur' },
+                                const: 'EUR',
+                                inlineAlert: {
+                                    context: 'info',
+                                    content: 'This is an inline alert',
+                                },
+                                supportingValues: {
+                                    value: '0.05%',
+                                    subvalue: 'Fee',
+                                },
+                            },
+                            {
+                                title: 'GBP',
+                                description: 'British pound',
+                                icon: { name: 'flag-gbp' },
+                                const: 'GBP',
+                                disabled: true,
+                                supportingValues: {
+                                    value: '0.00%',
+                                    subvalue: 'Fee',
+                                },
+                            },
+                            {
+                                title: 'USD',
+                                description: 'US dollar',
+                                icon: { name: 'flag-usd' },
+                                const: 'USD',
+                                supportingValues: {
+                                    value: '0.08%',
+                                    subvalue: 'Fee',
+                                },
+                                inlineAlert: {
+                                    context: 'warning',
+                                    content: 'This is a warning inline alert',
+                                },
+                            },
+                            {
+                                title: 'AUD',
+                                description: 'Australian dollar',
+                                icon: { name: 'flag-aud' },
+                                const: 'AUD',
+                                additionalText: 'Additional text can be long in Australia.',
+                                supportingValues: {
+                                    value: '0.08%',
+                                    subvalue: 'Fee',
+                                },
+                            },
+                            {
+                                title: 'NZD',
+                                description: 'New Zealand dollar',
+                                icon: { name: 'flag-nzd' },
+                                const: 'NZD',
+                                supportingValues: {
+                                    value: '0.08%',
+                                    subvalue: 'Fee',
+                                },
+                            },
+                            {
+                                title: 'CNY',
+                                description: 'Chinese yuan',
+                                icon: { name: 'flag-cny' },
+                                const: 'CNY',
+                                supportingValues: {
+                                    value: '0.08%',
+                                    subvalue: 'Fee',
+                                },
+                            },
+                            {
+                                title: 'JPY',
+                                description: 'Japanese yen',
+                                icon: { name: 'flag-jpy' },
+                                const: 'JPY',
+                            },
+                            {
+                                title: 'HUF',
+                                description: 'Hungarian Forint',
+                                icon: { name: 'flag-huf' },
+                                const: 'HUF',
+                                supportingValues: {
+                                    value: '0.08%',
+                                    subvalue: 'Fee',
+                                },
+                            },
+                        ],
+                    },
+                },
+            },
+        },
+    ],
+    model: { arrayField: ['USD'] },
+    errors: { validation: { arrayField: 'This is an error message from the step' } },
+});

package/build/stories/spec/schemas/Upload.story.js

@@ -0,0 +1,168 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { action } from 'storybook/actions';
+import { getMockHttpClient, respondWith } from '../../../test-utils';
+import DynamicFlowWise from '../../../test-utils/DynamicFlowWise';
+const wait = async (ms) => new Promise((resolve) => {
+    setTimeout(resolve, ms);
+});
+const persistAsyncConfig = {
+    method: 'POST',
+    url: '/persist-async',
+    param: 'param',
+    idProperty: 'token',
+};
+const uploadConfig = {
+    title: 'Upload label (from innner schema title)',
+    accepts: ['image/png', 'image/jpeg', 'application/pdf'],
+    validationMessages: {
+        maxSize: 'Your file is too large',
+        required: 'Please enter a valid file (uploadConfig).',
+    },
+};
+const multiFileConfig = {
+    title: 'Upload label (from innner schema title)',
+    maxItems: 5,
+    addItemTitle: 'Add',
+    editItemTitle: 'Edit',
+    summary: {
+        defaultTitle: 'File',
+        defaultDescription: 'Click to edit or remove',
+        defaultIcon: { name: 'document', type: 'icon' },
+    },
+};
+const logPersistAsync = (input, init) => {
+    if (init && init.body instanceof FormData) {
+        console.log(input, init.body.get(persistAsyncConfig.param));
+    }
+    else {
+        console.log(input, init && JSON.parse(init.body));
+    }
+};
+const getHttpClient = (persistAsync = 'succeed') => getMockHttpClient({
+    '/submit': async (input, init) => {
+        console.log(input, init && JSON.parse(init.body));
+        return respondWith({
+            id: 'success',
+            title: 'Submission successful',
+            description: 'Your file has been uploaded successfully.',
+            schemas: [],
+            layout: [
+                { type: 'paragraph', text: 'Refresh the page to start again.', align: 'center' },
+            ],
+        }, { status: 200 });
+    },
+    '/persist-async': async (input, init) => {
+        logPersistAsync(input, init);
+        switch (persistAsync) {
+            case 'rejectPromise':
+                return Promise.reject(new Error('Failed to persist async'));
+            case 'failGenerically':
+                await wait(1000);
+                return Promise.resolve(new Response(null, { status: 404 }));
+            case 'failValidation':
+                await wait(1000);
+                return Promise.resolve(new Response(JSON.stringify({ validation: { param: 'Error message from the server.' } }), { status: 422 }));
+            case 'succeed':
+            default:
+                await wait(1000);
+                return respondWith({ token: '123' });
+        }
+    },
+});
+export default {
+    component: DynamicFlowWise,
+    title: 'Spec/Schemas/Upload',
+    parameters: {
+        chromatic: { disableSnapshot: true },
+    },
+    argTypes: {
+        persistAsync: {
+            options: ['succeed', 'rejectPromise', 'failGenerically', 'failValidation'],
+            type: 'select',
+            defaultValue: 'succeed',
+        },
+    },
+};
+export function Base64Upload() {
+    return renderWithStep(getBase64UploadStep());
+}
+export function Base64UploadLarge() {
+    return renderWithStep(getBase64UploadStepLarge());
+}
+export function Base64UploadWithPersistAsync({ persistAsync }) {
+    return renderWithStep(getBase64UploadWithPersistAsync(), persistAsync);
+}
+export function BlobUploadWithPersistAsync({ persistAsync }) {
+    return renderWithStep(getBlobUploadWithPersistAsync(), persistAsync);
+}
+export function BlobUploadWithPersistAsyncLarge({ persistAsync }) {
+    return renderWithStep(getBlobUploadWithPersistAsyncLarge(), persistAsync);
+}
+export function MultiBase64Upload() {
+    return renderWithStep(getMultiBase64Upload());
+}
+export function MultiBase64UploadWithPersistAsync({ persistAsync }) {
+    return renderWithStep(getMultiBase64UploadWithPersistAsync(), persistAsync);
+}
+export function MultiBlobUploadWithPersistAsync({ persistAsync }) {
+    return renderWithStep(getMultiBlobUploadWithPersistAsync(), persistAsync);
+}
+const renderWithStep = (step, persistAsync = 'succeed') => (_jsx(DynamicFlowWise, { flowId: "new-df-flow-id", httpClient: getHttpClient(persistAsync), initialStep: step, features: { nativeBack: true }, onCompletion: action('onCompletion'), onEvent: action('onEvent'), onLog: action('onLog'), onError: (error) => {
+        action('onError');
+        console.error(error);
+    } }));
+const getBase64UploadStep = () => getStep('Base64 Upload', Object.assign({ $id: '#schema', type: 'string', format: 'base64url' }, uploadConfig));
+const getBase64UploadStepLarge = () => getStep('Base64 Upload (Large)', Object.assign({ $id: '#schema', type: 'string', control: 'upload-large', format: 'base64url' }, uploadConfig));
+const getBase64UploadWithPersistAsync = () => getStep('Base64 Upload (Persist Async)', {
+    $id: '#schema',
+    type: 'string',
+    persistAsync: Object.assign(Object.assign({}, persistAsyncConfig), { schema: Object.assign({ type: 'string', format: 'base64url' }, uploadConfig) }),
+});
+const getBlobUploadWithPersistAsync = () => getStep('Blob Upload (Persist Async)', {
+    $id: '#schema',
+    type: 'string',
+    validationMessages: { required: 'Please enter a valid file.' },
+    persistAsync: Object.assign(Object.assign({}, persistAsyncConfig), { schema: Object.assign({ type: 'blob', source: 'file' }, uploadConfig) }),
+});
+const getBlobUploadWithPersistAsyncLarge = () => getStep('Blob Upload (Persist Async, Large)', {
+    $id: '#schema',
+    type: 'string',
+    validationMessages: { required: 'Please enter a valid file.' },
+    persistAsync: Object.assign(Object.assign({}, persistAsyncConfig), { schema: Object.assign({ type: 'blob', control: 'upload-large', source: 'file' }, uploadConfig) }),
+});
+const getMultiBase64Upload = () => getStep('Base64 Upload (Multiple)', Object.assign(Object.assign({ $id: '#schema', type: 'array' }, multiFileConfig), { items: Object.assign({ type: 'string', format: 'base64url' }, uploadConfig) }));
+const getMultiBase64UploadWithPersistAsync = () => getStep('Base64 Upload (Multiple, Persist Async)', Object.assign(Object.assign({ $id: '#schema', type: 'array' }, multiFileConfig), { items: {
+        $id: '#id',
+        type: 'string',
+        persistAsync: Object.assign(Object.assign({}, persistAsyncConfig), { schema: Object.assign({ type: 'string', format: 'base64url' }, uploadConfig) }),
+    } }));
+const getMultiBlobUploadWithPersistAsync = () => getStep('Blob Upload (Multiple, Persist Async)', Object.assign(Object.assign({ type: 'array', $id: '#schema' }, multiFileConfig), { items: {
+        $id: '#id',
+        type: 'string',
+        persistAsync: Object.assign(Object.assign({}, persistAsyncConfig), { schema: Object.assign({ type: 'blob', source: 'file' }, uploadConfig) }),
+    } }));
+const getStep = (title, schema) => {
+    const objectSchema = {
+        type: 'object',
+        $id: '#object-schema',
+        displayOrder: ['fileUpload', 'thing'],
+        required: ['fileUpload'],
+        properties: {
+            thing: { const: 'hidden-value' },
+            fileUpload: schema,
+        },
+    };
+    return {
+        id: 'step-id',
+        title,
+        schemas: [objectSchema],
+        layout: [
+            { type: 'form', schemaId: '#object-schema' },
+            {
+                type: 'button',
+                title: 'Submit',
+                action: { url: '/submit', method: 'POST' },
+            },
+        ],
+    };
+};

package/build/stories/spec/schemas/const/ConstLayout.story.js

@@ -0,0 +1,159 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import DynamicFlowWise from '../../../../test-utils/DynamicFlowWise';
+import { renderWithStep } from '../../../utils/render-utils';
+export default {
+    component: DynamicFlowWise,
+    title: 'Spec/Schemas/Const',
+    parameters: {
+        layout: 'fullscreen',
+    },
+};
+export function ConstSchemaWithLayoutWithSelect() {
+    return render(undefined);
+}
+export function ConstSchemaWithLayoutWithRadio() {
+    return render('radio');
+}
+export function ConstSchemaWithLayoutWithTabs() {
+    return render('tab');
+}
+const render = (control) => {
+    return (_jsx("div", { style: {
+            width: '60%',
+            margin: 'auto',
+        }, children: renderWithStep(step(control)) }));
+};
+const step = (control) => ({
+    id: 'const-layout-step',
+    title: 'Const Schemas with Layout',
+    schemas: [
+        {
+            $id: '#schema',
+            control,
+            oneOf: [
+                {
+                    title: 'Option A',
+                    const: 'A',
+                    layout: [
+                        {
+                            type: 'heading',
+                            text: 'This is Option A',
+                        },
+                        {
+                            type: 'paragraph',
+                            text: 'Option A is a great choice because, it offers unique benefits and features that are tailored to your needs.',
+                        },
+                        {
+                            type: 'list',
+                            items: [
+                                {
+                                    title: 'Reason 1',
+                                    description: 'Firstly, it is a great choice because it offers unique benefits and features that are tailored to your needs.',
+                                    media: textMediaAvatar('T1'),
+                                },
+                                {
+                                    title: 'Reason 2',
+                                    description: 'Secondly, it provides exceptional value and quality, ensuring that you get the best possible experience.',
+                                    media: textMediaAvatar('T2'),
+                                },
+                            ],
+                        },
+                    ],
+                },
+                {
+                    title: 'Option B',
+                    const: 'B',
+                    layout: [
+                        {
+                            type: 'heading',
+                            text: 'This is Option B',
+                        },
+                        {
+                            type: 'paragraph',
+                            text: 'Option B stands out due to its innovative approach and user-friendly design, making it an excellent choice for those seeking simplicity and efficiency.',
+                        },
+                        {
+                            type: 'list',
+                            items: [
+                                {
+                                    title: 'Reason 1',
+                                    description: 'Firstly, it is a great choice because it offers unique benefits and features that are tailored to your needs.',
+                                    media: textMediaAvatar('T1'),
+                                },
+                                {
+                                    title: 'Reason 2',
+                                    description: 'Secondly, it provides exceptional value and quality, ensuring that you get the best possible experience.',
+                                    media: textMediaAvatar('T2'),
+                                },
+                                {
+                                    title: 'Reason 3',
+                                    description: 'Finally, its reliability and performance make it a trusted option for users who prioritize consistency and dependability.',
+                                    media: textMediaAvatar('T3'),
+                                },
+                            ],
+                        },
+                    ],
+                },
+                {
+                    title: 'Option C',
+                    const: 'C',
+                    layout: [
+                        {
+                            type: 'heading',
+                            text: 'This is Option C',
+                        },
+                        {
+                            type: 'paragraph',
+                            text: 'Option C is distinguished by its comprehensive features and robust performance, making it a top choice for users who demand the best.',
+                        },
+                        {
+                            type: 'image',
+                            content: {
+                                uri: 'urn:wise:illustrations:plane',
+                            },
+                        },
+                    ],
+                },
+            ],
+        },
+    ],
+    layout: [
+        {
+            type: 'box',
+            width: 'md',
+            control: 'bordered',
+            components: [
+                {
+                    type: 'markdown',
+                    content: 'This example demonstrates the use of constant schemas with a defined layout.',
+                    align: 'center',
+                    margin: 'lg',
+                },
+                {
+                    type: 'form',
+                    schemaId: '#schema',
+                },
+                {
+                    type: 'alert',
+                    markdown: 'This alert is separate from the form const schemas.',
+                },
+                {
+                    type: 'button',
+                    title: 'Submit',
+                    control: 'primary',
+                    behavior: {
+                        type: 'action',
+                        action: {
+                            url: '/submit',
+                        },
+                    },
+                },
+            ],
+        },
+    ],
+    model: 'A',
+});
+const textMediaAvatar = (text) => ({
+    type: 'avatar',
+    content: [{ type: 'text', text }],
+});

package/build/stories/spec/schemas/const/ObjectConst.story.js

@@ -0,0 +1,94 @@
+import { getMockHttpClient, respondWith } from '../../../../test-utils';
+import DynamicFlowWise from '../../../../test-utils/DynamicFlowWise';
+import { renderWithStep } from '../../../utils/render-utils';
+const getHttpClient = () => getMockHttpClient({
+    '/submit': async (input, init) => {
+        console.log(input, init && JSON.parse(init.body));
+        return respondWith({});
+    },
+});
+export default {
+    component: DynamicFlowWise,
+    title: 'Spec/Schemas/Const',
+    parameters: {
+        chromatic: { disableSnapshot: true },
+    },
+};
+export function ConstObjectSchema() {
+    return renderWithStep(getBasicStep(), getHttpClient());
+}
+export function ConstObjectSchemaWithModel() {
+    const step = Object.assign(Object.assign({}, getBasicStep()), { model: { recurrence: { interval: 1, frequency: 'WEEKLY' } } });
+    return renderWithStep(step, getHttpClient());
+}
+const getBasicStep = () => getStep('Object Const', {
+    $id: 'object-const',
+    properties: {
+        recurrence: {
+            oneOf: [
+                {
+                    const: {
+                        interval: 0,
+                        frequency: 'ONCE',
+                    },
+                    title: 'Never',
+                    description: 'On some date only',
+                },
+                {
+                    const: {
+                        interval: 1,
+                        frequency: 'WEEKLY',
+                    },
+                    title: 'Weekly',
+                    description: 'On some date every week',
+                },
+                {
+                    const: {
+                        interval: 2,
+                        frequency: 'WEEKLY',
+                    },
+                    title: 'Biweekly',
+                    description: 'On some date every two weeks',
+                },
+                {
+                    const: {
+                        interval: 1,
+                        frequency: 'MONTHLY',
+                    },
+                    title: 'Monthly',
+                    description: 'Monthly',
+                },
+                {
+                    const: {
+                        interval: 3,
+                        frequency: 'MONTHLY',
+                    },
+                    title: 'Quarterly',
+                    description: 'Every 3 months on X',
+                },
+            ],
+            placeholder: 'Select a start date',
+            title: 'Repeats',
+            default: {
+                interval: 0,
+                frequency: 'ONCE',
+            },
+            refreshStepOnChange: true,
+        },
+    },
+    displayOrder: ['recurrence'],
+    type: 'object',
+});
+const getStep = (title, schema) => ({
+    id: 'step-id',
+    title,
+    schemas: [schema],
+    layout: [
+        { type: 'form', schemaId: schema.$id },
+        {
+            type: 'button',
+            title: 'Submit',
+            action: { url: '/submit', method: 'POST' },
+        },
+    ],
+});