fast-fastjs v0.6.16

FASTjs

A JS library to give you wrapper Functions on top of Form.io. It creates all the necesary classes for you to use your Form.io forms as they were Models, working both online and offline

FASTjs + Form.io will help you develop faster in any Framework

Installing

To install this package in your project, you can use the following command within your terminal.

npm install --save fast-fastjs

Usage

The main function of FASTjs is FAST, this function will initialize all configurations, translations and register forms that you have in your Form.io project and will load them into the local LokiJs DB.

An example of the init for a Vue application

import {FAST} from 'fast-fastjs';

let config = await FAST.start(
		    {
            appConf          // {Object} Configuration for the FASTjs library
        }
    );

The appConfig variable

The config variable can be placed in two different ways: Directly as an object or as a remote Form.io submission.

We give the flexibility to pull the configuration every time we start the project specially for those mobile applications that we do not want to re-deploy every time we change a small configuration of the App. With the remote approach you can just simple update your Form.io Submission and the application will pull it for you.

// If we want to directly pass all configuration from here
  let appConf = {
    type: 'local',                     // {String} type of config "remote" or "local"
    config                             // {Object} full configuration of the App (check below)
    translations: TRANSLATIONS         // {Object} i18n translations for the app
  };

// If we are storing our project configuration in Form.io
  let appConfigUrl = 'https://ydvyhgtgqlcasur.form.io/configuration/submission/5a956eav847b730402b25656'
  let appConf = {
    type: 'remote',                // {String} type of config "remote" or "local"
    appConfigUrl,                  // {String} Full URL tot he Form.io Form with the config
    translations: TRANSLATIONS,     // {Object} i18n translations for the App
    fluentFormioBaseUrl: FLUENT_FORMIO_BASEURL,
    offlineFiles: {
      Configuration: require('Configuration.json'),
      Roles: require('Roles.json'),
      lastUpdated: require('lastUpdate.json'),
      Translations: require('Translations.json'),
      Pages: require('Pages.json'),
      Forms: require('Forms.json')
     }
  };

In case you are using local config, your config object should look like this

If you are using Form.io to manage the config, you can use the following form to hold your configurations.

Remember to import this in your own Form.io Project.(View it here!)

FAST Models

FAST offers 8 main Models that you can use to access and manipulate your data

The models can be used to access both local (LokiJS DB) or remote data (Form.io Server) by calling the remote() or local() methods.

import {Form} from 'fast-fastjs';

let localForms = await Form.local().find();
let remoteForms = await Form.remote().find();

We could also work with both, local and remote using the merged() method

import {Form} from 'fast-fastjs';

let bothForms = await Form.merged().find();

We are still working on standardizing the methods for both local and remote so please check how each one works before trying to swap from one to the other

Every model has acces to the same basic functionalities given by the baseModel

FAST Helper Functions