Web modeler SDK

class SoftyFlow {}
class Collection {}
class SQLDatabase {}
class CustomList {}
class Report {}
class Instance {}
class Task {}
class Api {}
class Email {}
class File {}

//using SF object
let currentMode = this.SF.getSF_mode();
// instantiate new object
const softyflow = new SoftyFlow();

/**
 * @return {string}            Return string ('test', 'uat', 'prod')
 */

let currentMode = this.SF.getSF_mode();

/**
 * @return {string}            Return string ('test', 'uat', 'prod')
 */

let currentVersion = this.SF.getSF_Version();

/**
 * @param {string} select      The selected fields
 *
 * @return {string}            Return string 
 */

let currentMode = this.SF.getSF_mode('SF_mode SF_version');
console.log(currentMode)
// ?SF_mode=test&SF_version=versionId

/**
 *@param {string} id              Process id
 *@param {object} body            Json of process variables
 *
 * @return {promise}              Return promise
 */

let variables = {
  "variable1": "value1",
  "variable2": 1,
  "variable3": true
}
await this.SF.startProcess('processId', variables);

/**
 *@param {string} id              interface id
 *@param {object} body            Json of interface variables
 *
 * @return {promise}              Return promise
 */

let variables = {
  "variable1": "value1",
  "variable2": 1,
  "variable3": true
}
await this.SF.saveNew('interfaceId', variables);

/**
 *@param {string} id              task id
 *@param {object} body            Json of task variables
 *
 * @return {promise}              Return promise
 */

let variables = {
  "variable1": "value1",
  "variable2": 1,
  "variable3": true
}
await this.SF.saveTask('taskId', variables);

/**
 *@param {string} id              task id
 *@param {object} body            Json of task variables
 *
 * @return {promise}              Return promise
 */

let variables = {
  "variable1": "value1",
  "variable2": 1,
  "variable3": true
}
await this.SF.validateTask('taskId', variables);

/**
 *@param {string} limit              limit of result per page.
 *@param {string} page              number of page 
 *@param {string} dueDate              related date.
 *@param {string} fields             fileds.
 *
 * @return {promise}              Return promise
 */

await this.SF.getUserPendingTask('limit', 'page', 'dueDate', 'fields');

/**
 *@param {string} collection              collection ID.
 *@param {object} criteria       Query json.
 *@param {string} limit              limit of result.
 *@param {string} sort             sort option.
 *
 * @return {promise}              Return promise
 */

let criteria = { 
  firstName: new RegExp("p", "i")
}
await this.SF.setListFromCollection('collectionId', criteria, 10, 'sort');

/**
 *@param {string} clientDatabase              clientDatabase ID.
 *@param {string} query       Query table.
 *
 * @return {promise}              Return promise
 */

await this.SF.setListFromSQL('clientDatabaseID', "code='MMA'");

/**
 *@param {string} CustomList              CustomList ID.
 *
 * @return {promise}              Return promise
 */

await this.SF.setListFromCustomList('CustomListID');

/**
 *@param {string} type              type of the resource (collection, report, users, projects, external databases).
 *@param {string} id              Id of the resource.
 *@param {object} query              Json of a value to be matched in the resource.
 *
 * @return {promise}              Return promise
 */

await this.SF.aggregateQuery('collection', '610c0343f6ebc7ddcb49cc3b', {value : "it"});

/**
 *@param {string} id              Id of the resource.
 *
 * @return {promise}              Return promise
 */

await this.SF.deleteFile('610c0343f6ebc7ddcb49cc3b');

const users = new Users();

/**
 * @param {object} data           Json content user data
 *
 * @return {promise}              Return promise
 */

let user = {
  email: "email@softydev.com",
  lastName : "last name",
  firstName: "first name",
  group: [],
  metadata: {},
  ideAccess: true,
  blocked: false
}
await users.create(user);

/**
 * @param {string} id             user id.
 * @param {object} data           User data.
 *
 * @return {promise}              Return promise
 */

let newData = {
  ideAccess: false
}
await users.update("userId", newData);

/**
 * @param {string} id             user id.
 *
 * @return {promise}              Return promise
 */

await users.delete("userId");

/**
 * @param {string} id             user id.
 *
 * @return {promise}              Return promise
 */

let user = await users.findById("userId");

/**
 * @param {object} criteria       Query json.
 *
 * @return {promise}              Return promise
 */

let criteria = { 
  firstName: new RegExp("p", "i")
}
let usersList = await users.find(criteria);

/**
 * @param {object} criteria       Query json  
 * 
 * @return {promise}              Return promise
 */

let criteria = { 
  blocked: false
}
let count = await users.count(criteria);

/**
 * @param {object} body           Json of options.
 *
 * @return {promise}              Return promise
 */

let body = {
  criteria: { 
    firstName: new RegExp("p", "i")
  },
  limit: 10,
  page: 0,
  sortBy: "createdAt",
  direction: -1
}
let res = await users.findAndCount(body);
let usersList = res.data;
let count = res.count;

/**
 * @param {array} aggregation       aggregation array  
 *
 * @return {promise}                Return promise
 */

let aggregation = [
  {
    "$match": { "firstName": new RegExp("z", "i") }
  },
  {
    "$project" : {
                    "_id": 1,
                    "firstName": 1,
                    "lastName": 1,
                    "email": 1
                  }
  }
]
let usersList = await users.aggregate([aggregation]);

/**
 * @param {string} userId          user ID.
 * 
 * @param {string} groupid          group ID.
 *
 * @param {string} mode       mode of the running user. interface   
 * 
 * @return {promise}              Return promise
 */

await users.addRole("userId","groupId","SF_mode");

/**
 * @param {string} userId          user ID.
 * 
 * @param {string} groupid          group ID.
 *
 * @param {string} mode       mode of the running user interface   
 * 
 * @return {promise}              Return promise
 */

await users.removeRole("userId","groupId","SF_mode");

const collection = new Collection({ id: 'collectionId', mode: 'test' });

/**
 * @param {object} data           Json of a value to be inserted in to the collection.
 *
 * @return {promise}              Return promise
 */

await collection.insert({ name: "name1", type : "type1" });

/**
 * @param {object} data           Json of a value to be inserted in to the collection.
 *
 * @return {promise}              Return promise
 */

await collection.insertMany([{label : "IT", value : "it"}]);

/**
 * @param {object} criteria       Query json.
 * @param {object} data           Json of a new data.
 * @param {object} options           Json of options
 *
 * @return {promise}              Return promise
 */

let criteria = { 
  firstName: new RegExp("p", "i")
}
await collection.updateMany(criteria, [{ type : "type2" }], { upsert: true });

/**
 * @param {string} id             Document id.
 * @param {object} data           Json of a new data.
 *
 * @return {promise}              Return promise
 */

await collection.update("documentId", { type : "type2" });

/**
 * @param {string} id             Document id.
 *
 * @return {promise}              Return promise
 */

await collection.delete("documentId");

/**
 * @param {string} id             Document id.
 *
 * @return {promise}              Return promise
 */

let document = await collection.findById(id);

/**
 * @param {object} body           Json of options.
 *
 * @return {promise}              Return promise
 */

let body = {
  criteria: { 
    name: new RegExp("p", "i"), 
    type: "type1" 
  },
  limit: 10,
  page: 0,
  sortBy: "createdAt",
  direction: -1
}
let documents = await collection.find(body);

/**
 * @param {object} criteria       Query json  
 * 
 * @return {promise}              Return promise
 */

let count = await collection.count({ type: "type1" });

/**
 * @param {array} aggregation       aggregation array  
 *
 * @return {promise}                Return promise
 */

let aggregation = [
  {
    "$match": { "type": "type1" }
  },
  {
    "$project" : {
                    "_id": 1,
                    "name": 1
                  }
  }
]
let documents = await collection.aggregate([aggregation]);

const sql = new SQLDatabase({ id: '610c0343f6ebc7ddcb49cc3b', mode: 'test' });

/**
 * @param {string} tableName      table name.
 *
 * @param {string} Criteria       query table.
 * 
 * @return {object}
 */

let res = await sql.findOne("client", "code='MMA'"))

/**
 * @param {string} tableName      table name.
 *
 * @param {string} options        query table.
 * 
 * @return {array}
 */

let res = sql.find("client", "code='MMA'")

/**
 * @param {string} tableName      table name.
 *
 * @param {string} options        query table.
 * 
 * @return {array}                array with one element contining count
 */

let count = await sql.count("client", "code='MMA'");

/**
 * @param {string} query          string of query.
 *
 * @return {array}                Return array.
 */

sql.execute("INSERT INTO client(code, intitule, representant, codepostal) VALUES('MDSX', 'holder', 'holder', 14000)")

/**
 * @param {string} tableName      table name.
 *
 * @param {object} data           JSON body.
 * 
 * @return {array}
 */

sql.insert("client", {
    code: 'HelloWord',
    codepostal: 14000
}

/**
 * @param {string} tableName      table name.
 *
 * @param {array}  data            JSON body.
 * 
 * @return {array}
 */

sql.insertMany("client", [
  { code: '#1' },
  { code: '#2' }
])

/**
 * @param {string} tableName      table name.
 *
 * @param {string} query          query table.
 * 
 * @param {object} data           updated JSON body.
 *
 * @return {object}
 */

 sql.update('client',   "code='MMA'",
    {
        code: "MQS"
    })

/**
 * @param {string} tableName      table name.
 *
 * @param {string} query          query table.
 * 
 * @return {object}
 */

sql.delete("client", "id=223")

const customList = new CustomList({id: 'id', mode: 'test', versionId: "vId"});

/**
 * @return {promise}              Return promise
 */

let customListData = await customList.get();

const report = new Report({id: 'id', mode: 'test'});

/**
 * @param {array} aggregation       aggregation array  
 *
 * @return {promise}              Return promise
 */

let aggregation = [
  {
    "$match": { "SF_status": "Running" }
  },
  { 
    "$sort": { "SF_createdAt": -1 } 
  }
]
let instances = await report.aggregate(aggregation);  //report of instances

const inctance = new Instance();

/**
 * @param {string} id             id of instance.
 *
 * @return {promise}              Return promise
 */

let oneInctance = await inctance.findById(id);

/**
 * @param {object} criteria       Json of query.
 *
 * @return {promise}              Return promise
 */

let instances = await inctance.find({ status: "Running" });

/**
 * @param {object} criteria       Query json  
 * 
 * @return {promise}              Return promise
 */

let count = await inctance.count({ status: "Running" });

/**
 * @param {object} body           Json of options.
 *
 * @return {promise}              Return promise
 */

let body = {
  criteria: { 
    status: "Running" 
  },
  limit: 10,
  page: 0,
  sortBy: "createdAt",
  direction: -1
}
let res = await inctance.findAndCount(body);
let instances = res.data;
let count = res.count;

/**
 * @param {array} aggregation       aggregation array  
 *
 * @return {promise}                Return promise
 */

let aggregation = [
  {
    "$match": { "status": "End" }
  },
  {
    "$project" : {
                    "_id": 1,
                    "name": 1
                  }
  }
]
let inctances = await inctance.aggregate([aggregation]);

/**
 * @param {string} id             id of instance.
 * @param {object} data           Json of a new data.
 *
 * @return {promise}              Return promise
 */

await inctance.update(id, { status : "End" });

/**
 * @param {string} id             id of instance.
 *
 * @return {promise}              Return promise
 */

await inctance.delete(id);

/**
 * @param {string} id             id of instance.
 * @param {object} data           Json of data.
 *
 * @return {promise}              Return promise
 */

await inctance.history(id, { status : "End" });

const task = new Task();

/**
 * @param {string} id             id of task.
 *
 * @return {promise}              Return promise
 */

let oneTask = await task.findById(id);

/**
 * @param {object} criteria       Json of query.
 *
 * @return {promise}              Return promise
 */

let tasks = await task.find({ instanceId: "instanceId" });

/**
 * @param {object} criteria       Query json  
 * 
 * @return {promise}              Return promise
 */

let count = await task.count({ instanceId: "instanceId" });

/**
 * @param {object} body           Json of options.
 *
 * @return {promise}              Return promise
 */

let body = {
  criteria: { 
    status: "Running" 
  },
  assignedToConnected: true,
  limit: 10,
  page: 0,
  sortBy: "createdAt",
  direction: -1
}
let res = await task.findAndCount(body);
let tasks = res.data;
let count = res.count;

/**
 * @param {array} aggregation       aggregation array  
 *
 * @return {promise}                Return promise
 */

let aggregation = [
  {
    "$match": { "status": "End" }
  },
  {
    "$project" : {
                    "_id": 1,
                    "name": 1
                  }
  }
]
let tasks = await task.aggregate([aggregation]);

/**
 * @param {string} id             id of task.
 * @param {object} data           Json of a new data.
 *
 * @return {promise}              Return promise
 */

await task.update(id, { status : "End" });

/**
 * @param {string} id             id of task.
 *
 * @return {promise}              Return promise
 */

await task.delete(id);

/**
 * @param {string} name       name of the variable. 
 * @param {number} [padding]      Padding of result with 000000.
 * @param {string} mode       mode of the running user.
 * 
 * @return {promise}              Return promise
 */

await task.getNextValue("name",5,"SF_mode");

const api = new Api();

/**
 * @param {object} body           Json of options.
 *
 * @return {promise}              Return promise
 */

let body = {
  const myElement = document.getElementById("demo");

  function getLocation() {
    if (navigator.geolocation) {
      navigator.geolocation.getCurrentPosition(showPosition);
    } else {
      myElement.innerHTML = "Geolocation is not supported by this browser.";
    }
  }

  function showPosition(position) {
    myElement.innerHTML = "Latitude: " + position.coords.latitude +
    "<br>Longitude: " + position.coords.longitude;
  }
}
await api.invoke(body);

const email = new Email();

/**
 * @param {string} assignee           Assignee user email.
 * @param {string} subject           Subject of the email.
 * @param {object} variables           Json of options.
 * @param {object} mailTemplate           Email template.
 * @param {object} mailProvider           SoftyFlow default provider.
 * @param {string} cc           Json of options.
 * @param {string} from           Sender user email.
 * @param {string} replyTo
 *
 * @return {promise}              Return promise
 */

await email.send("assignee","subject",{"var1", "var2"},{"mailTemplate"},{"mailProvider"},"mail of user in cc", "senderMail","replyTo");