@wise/dynamic-flow-client 0.1.1 → 0.1.3

package/build/flow/fixtures/examples/step-validation-errors.js

@@ -0,0 +1,75 @@
+var step = {
+    key: 'Examples/Step Validation Errors',
+    title: 'Step with validation errors',
+    type: 'form',
+    errors: {
+        validation: {
+            'bridekeeper-questions': {
+                'favourite-colour': 'Auuuuuuuugh'
+            }
+        }
+    },
+    actions: [],
+    layout: [
+        {
+            type: 'form',
+            schema: { $ref: '#the-schema' }
+        },
+    ],
+    schemas: [
+        {
+            $id: '#the-schema',
+            type: 'object',
+            displayOrder: ['bridekeeper-questions'],
+            properties: {
+                'bridekeeper-questions': {
+                    type: 'object',
+                    displayOrder: ['name', 'quest', 'favourite-colour'],
+                    properties: {
+                        name: {
+                            title: 'What is your name?',
+                            type: 'string',
+                            placeholder: 'Sir Lancelot of Camelot'
+                        },
+                        quest: {
+                            title: 'What is your quest?',
+                            type: 'string',
+                            placeholder: 'to seek the Holy Grail'
+                        },
+                        'favourite-colour': {
+                            title: 'What is your favourite colour?',
+                            analyticsId: 'colour-select',
+                            oneOf: [
+                                {
+                                    title: 'Blue',
+                                    analyticsId: 'colour-select-blue',
+                                    image: {
+                                        url: 'https://placeholder.pics/svg/128/0099ff/FFFFFF'
+                                    },
+                                    "const": 1
+                                },
+                                {
+                                    title: 'Yellow',
+                                    analyticsId: 'colour-select-yellow',
+                                    image: {
+                                        url: 'https://placeholder.pics/svg/128/ffcc00/FFFFFF'
+                                    },
+                                    "const": 2
+                                },
+                                {
+                                    title: 'Red',
+                                    analyticsId: 'colour-select-red',
+                                    image: {
+                                        url: 'https://placeholder.pics/svg/128/ff6600/FFFFFF'
+                                    },
+                                    "const": 2
+                                },
+                            ]
+                        }
+                    }
+                }
+            }
+        },
+    ]
+};
+export default step;

package/build/flow/fixtures/features/action-response.d.ts

@@ -0,0 +1,3 @@
+import { Step } from '../../../dynamic-flow-types';
+declare const step: Step;
+export default step;

package/build/flow/fixtures/features/action-response.js

@@ -0,0 +1,29 @@
+var step = {
+    key: 'Features/Action Response',
+    title: 'Action Response',
+    description: '',
+    type: 'form',
+    actions: [],
+    schemas: [],
+    layout: [
+        {
+            type: 'paragraph',
+            text: "The button below will trigger an action that fetches '/responses/action'.",
+            align: 'center'
+        },
+        {
+            type: 'paragraph',
+            text: 'That should return an action response that will load a final step.',
+            align: 'center'
+        },
+        {
+            type: 'button',
+            action: {
+                url: '/responses/action',
+                title: 'Submit',
+                type: 'primary'
+            }
+        },
+    ]
+};
+export default step;

package/build/flow/fixtures/features/external.d.ts

@@ -0,0 +1,3 @@
+import { Step } from '../../../dynamic-flow-types';
+declare const step: Step;
+export default step;

package/build/flow/fixtures/features/external.js

@@ -0,0 +1,31 @@
+var step = {
+    type: 'form',
+    key: 'Features/External',
+    title: 'External Feature',
+    description: 'Your bank is opening in another window.',
+    external: { url: 'http://google.com/' },
+    polling: {
+        url: '/polling/1234',
+        interval: 2,
+        maxAttempts: 5,
+        onError: {
+            action: { url: '/failure' }
+        }
+    },
+    layout: [
+        {
+            type: 'paragraph',
+            align: 'center',
+            text: 'Please, follow their instructions. Keep this window open.'
+        },
+        { type: 'loading-indicator', margin: 'xl' },
+        {
+            type: 'info',
+            align: 'center',
+            markdown: "If it didn't work, you can [reopen](http://google.com/) the tab"
+        },
+    ],
+    actions: [],
+    schemas: []
+};
+export default step;

package/build/flow/fixtures/features/persist-async.d.ts

@@ -0,0 +1,3 @@
+import { Step } from '../../../dynamic-flow-types';
+declare const step: Step;
+export default step;

package/build/flow/fixtures/features/persist-async.js

@@ -0,0 +1,44 @@
+var step = {
+    type: 'form',
+    key: 'Features/Persist Async',
+    title: 'Persist Async Feature',
+    schemas: [
+        {
+            $id: 'the-schema',
+            type: 'object',
+            title: 'Some Object',
+            displayOrder: ['nameToken'],
+            properties: {
+                nameToken: {
+                    type: 'string',
+                    title: 'Text input',
+                    persistAsync: {
+                        method: 'POST',
+                        url: '/persist-async-upload',
+                        param: 'name',
+                        idProperty: 'nameToken',
+                        schema: {
+                            title: 'Enter your name',
+                            type: 'string'
+                        }
+                    }
+                }
+            }
+        },
+    ],
+    actions: [
+        {
+            title: 'Submit Persist Async',
+            url: '/persist-async-submit',
+            method: 'POST',
+            type: 'primary'
+        },
+    ],
+    layout: [
+        {
+            type: 'form',
+            schema: { $ref: 'the-schema' }
+        },
+    ]
+};
+export default step;

package/build/flow/fixtures/features/polling.d.ts

@@ -0,0 +1,3 @@
+import { Step } from '../../../dynamic-flow-types';
+declare const step: Step;
+export default step;

package/build/flow/fixtures/features/polling.js

@@ -0,0 +1,33 @@
+var step = {
+    type: 'form',
+    key: 'Features/Polling',
+    title: 'Polling Feature',
+    description: 'Polling feature in a form step.',
+    polling: {
+        url: '/polling/1234',
+        interval: 2,
+        maxAttempts: 5,
+        onError: {
+            action: { url: '/failure' }
+        }
+    },
+    layout: [
+        {
+            type: 'paragraph',
+            align: 'center',
+            text: 'We are waiting for something to happen.'
+        },
+        { type: 'loading-indicator', margin: 'xl' },
+        {
+            type: 'button',
+            action: {
+                title: 'Back',
+                type: 'link',
+                url: '/back'
+            }
+        },
+    ],
+    actions: [],
+    schemas: []
+};
+export default step;

package/build/flow/fixtures/index.d.ts

@@ -0,0 +1,42 @@
+export declare const fixtures: {
+    readonly steps: {
+        readonly simpleForm: import("../..").Step;
+        readonly stringFormats: import("../..").Step;
+        readonly numberAndInteger: import("../..").Step;
+        readonly oneOf: import("../..").Step;
+        readonly alert: import("../..").Step;
+        readonly box: import("../..").Step;
+        readonly button: import("../..").Step;
+        readonly columns: import("../..").Step;
+        readonly decision: import("../..").Step;
+        readonly heading: import("../..").Step;
+        readonly image: import("../..").Step;
+        readonly info: import("../..").Step;
+        readonly list: import("../..").Step;
+        readonly loadingIndicator: import("../..").Step;
+        readonly paragraph: import("../..").Step;
+        readonly review: import("../..").Step;
+        readonly copyable: import("../..").Step;
+        readonly actionResponse: import("../..").Step;
+        readonly polling: import("../..").Step;
+        readonly external: import("../..").Step;
+        readonly recipient: import("../..").Step;
+        readonly recipientUpdate: import("../..").Step;
+        readonly persistAsync: import("../..").Step;
+        readonly singleFileUpload: import("../..").Step;
+        readonly stepValidationErrors: import("../..").Step;
+        readonly cameraCapture: import("../..").Step;
+    };
+    readonly responses: {
+        readonly action: {
+            action: import("../../dynamic-flow-types").Action;
+        };
+        readonly success: import("../..").Step;
+        readonly recipientUpdate: import("../..").Step;
+        readonly exit: {
+            id: string;
+            name: string;
+            country: string;
+        };
+    };
+};

package/build/flow/fixtures/index.js

@@ -0,0 +1,66 @@
+import alert from './components/alert';
+import box from './components/box';
+import button from './components/button';
+import columns from './components/columns';
+import copyable from './components/copyable';
+import decision from './components/decision';
+import heading from './components/heading';
+import image from './components/image';
+import info from './components/info';
+import list from './components/list';
+import loadingIndicator from './components/loading-indicator';
+import paragraph from './components/paragraph';
+import review from './components/review';
+import cameraCapture from './examples/camera-capture';
+import recipient from './examples/recipient';
+import recipientUpdate from './examples/recipient-update';
+import singleFileUpload from './examples/single-file-upload';
+import stepValidationErrors from './examples/step-validation-errors';
+import actionResponse from './features/action-response';
+import external from './features/external';
+import persistAsync from './features/persist-async';
+import polling from './features/polling';
+import action from './responses/action';
+import actionResponseFinal from './responses/action-response-final';
+import exit from './responses/exit';
+import recipientUpdateFinal from './responses/recipient-update-final';
+import simpleForm from './schemas/basic-form';
+import numberAndInteger from './schemas/number-and-integer';
+import oneOf from './schemas/one-of';
+import stringFormats from './schemas/string-formats';
+export var fixtures = {
+    steps: {
+        simpleForm: simpleForm,
+        stringFormats: stringFormats,
+        numberAndInteger: numberAndInteger,
+        oneOf: oneOf,
+        alert: alert,
+        box: box,
+        button: button,
+        columns: columns,
+        decision: decision,
+        heading: heading,
+        image: image,
+        info: info,
+        list: list,
+        loadingIndicator: loadingIndicator,
+        paragraph: paragraph,
+        review: review,
+        copyable: copyable,
+        actionResponse: actionResponse,
+        polling: polling,
+        external: external,
+        recipient: recipient,
+        recipientUpdate: recipientUpdate,
+        persistAsync: persistAsync,
+        singleFileUpload: singleFileUpload,
+        stepValidationErrors: stepValidationErrors,
+        cameraCapture: cameraCapture
+    },
+    responses: {
+        action: action,
+        success: actionResponseFinal,
+        recipientUpdate: recipientUpdateFinal,
+        exit: exit
+    }
+};

package/build/flow/fixtures/responses/action-response-final.d.ts

@@ -0,0 +1,3 @@
+import { Step } from '../../../dynamic-flow-types';
+declare const step: Step;
+export default step;

package/build/flow/fixtures/responses/action-response-final.js

@@ -0,0 +1,24 @@
+var step = {
+    type: 'form',
+    key: 'action-response-final',
+    title: 'Action Response Final Step',
+    description: "This step was loaded as a result of an Action Response.",
+    actions: [],
+    schemas: [],
+    layout: [
+        {
+            type: 'alert',
+            markdown: 'If you want to see this again, perhaps go back to "Action Response" story.',
+            context: 'positive'
+        },
+        {
+            type: 'button',
+            action: {
+                title: 'Start Over',
+                type: 'primary',
+                url: '/steps/actionResponse'
+            }
+        },
+    ]
+};
+export default step;

package/build/flow/fixtures/responses/action.d.ts

@@ -0,0 +1,5 @@
+import { Action } from '../../../dynamic-flow-types';
+declare const action: {
+    action: Action;
+};
+export default action;

package/build/flow/fixtures/responses/action.js

@@ -0,0 +1,2 @@
+var action = { action: { url: '/responses/success', method: 'POST' } };
+export default action;

package/build/flow/fixtures/responses/exit.d.ts

@@ -0,0 +1,6 @@
+declare const exit: {
+    id: string;
+    name: string;
+    country: string;
+};
+export default exit;

package/build/flow/fixtures/responses/exit.js

@@ -0,0 +1,2 @@
+var exit = { id: '123456', name: 'Bob Loblaw', country: 'US' };
+export default exit;

package/build/flow/fixtures/responses/recipient-update-final.d.ts

@@ -0,0 +1,3 @@
+import { Step } from '../../../dynamic-flow-types';
+declare const step: Step;
+export default step;

package/build/flow/fixtures/responses/recipient-update-final.js

@@ -0,0 +1,24 @@
+var step = {
+    type: 'form',
+    key: 'recipient-update-final',
+    title: 'Recipient Update Final Step',
+    description: "The recipient has been updated.",
+    actions: [],
+    schemas: [],
+    layout: [
+        {
+            type: 'alert',
+            markdown: 'Nothing to see here.',
+            context: 'positive'
+        },
+        {
+            type: 'button',
+            action: {
+                title: 'Start Over',
+                type: 'primary',
+                url: '/steps/recipientUpdate'
+            }
+        },
+    ]
+};
+export default step;

package/build/flow/fixtures/schemas/basic-form.d.ts

@@ -0,0 +1,3 @@
+import { Step } from '../../../dynamic-flow-types';
+declare const step: Step;
+export default step;

package/build/flow/fixtures/schemas/basic-form.js

@@ -0,0 +1,39 @@
+var step = {
+    key: 'Schemas/Basic Form',
+    title: 'Simple Form',
+    description: 'A simple form with text fields and a checkbox.',
+    type: 'form',
+    actions: [],
+    schemas: [
+        {
+            $id: '#the-schema',
+            type: 'object',
+            displayOrder: ['name', 'pineapple'],
+            properties: {
+                name: {
+                    title: 'Name (string schema)',
+                    type: 'string'
+                },
+                pineapple: {
+                    title: 'Pineapple on pizza (boolean schema)',
+                    type: 'boolean'
+                }
+            }
+        },
+    ],
+    layout: [
+        {
+            type: 'form',
+            schema: { $ref: '#the-schema' }
+        },
+        {
+            type: 'button',
+            action: {
+                url: '/submit',
+                title: 'Submit',
+                type: 'primary'
+            }
+        },
+    ]
+};
+export default step;

package/build/flow/fixtures/schemas/number-and-integer.d.ts

@@ -0,0 +1,3 @@
+import { Step } from '../../../dynamic-flow-types';
+declare const step: Step;
+export default step;

package/build/flow/fixtures/schemas/number-and-integer.js

@@ -0,0 +1,41 @@
+var step = {
+    key: 'Schemas/Number And Integer',
+    title: 'Number and Integer Schemas',
+    description: 'Number and Integer Schemas.',
+    type: 'form',
+    actions: [],
+    schemas: [
+        {
+            $id: '#the-schema',
+            type: 'object',
+            displayOrder: ['some-number', 'some-integer'],
+            properties: {
+                'some-number': {
+                    title: 'Number (number schema)',
+                    type: 'number',
+                    validationMessages: { type: 'This is not an number' }
+                },
+                'some-integer': {
+                    title: 'Integer (integer schema, does not support decimals)',
+                    type: 'integer',
+                    validationMessages: { type: 'This is not an integer' }
+                }
+            }
+        },
+    ],
+    layout: [
+        {
+            type: 'form',
+            schema: { $ref: '#the-schema' }
+        },
+        {
+            type: 'button',
+            action: {
+                url: '/submit',
+                title: 'Submit',
+                type: 'primary'
+            }
+        },
+    ]
+};
+export default step;

package/build/flow/fixtures/schemas/one-of.d.ts

@@ -0,0 +1,3 @@
+import { Step } from '../../../dynamic-flow-types';
+declare const step: Step;
+export default step;