Process modeler SDK

var SF = {
  collection : Object,
  user : Object,
  file : Object,
  utils : Object,
  sql : Object,
  instance : Object,
  task : Object,
  process : Object,
  softyTable : Object, // SoftyTable instance with methods to interact with tables
  mode : String, // The current Mode this is setted automatically
};

let id = await SF.utils.nextValue("leave_request");
// return number 1
let id = await SF.utils.nextValue("leave_request",5);
// return string 00001

let result = await SF.utils.shellExecLocal('echo Hello World');
// returns: { data: 'Hello World' }

let result = await SF.utils.shellExecLocal('pwd');
// returns: { data: '/home/user/project' }

let result = await SF.utils.shellExecRemote('ls -l', {
  host: '192.168.1.10',
  port: 22,
  username: 'user',
  password: 'password'
});
// returns: { data: 'list of files and folders...', code: 0 }

let id = SF.utils.axios.get('/data/json/123')
  .then(function (response) {
    // handle success
    console.log(response);
  }).catch(function (error) {
    // handle error
    console.log(error);
  });

await SF.collection.insertMany("cost-centers",[{label : "IT", value : "it"}])

await SF.collection.insertOne("cost-centers",{label : "IT", value : "it"})

await SF.collection.findOne("cost-centers",{value : "it"})

await SF.collection.find("cost-centers",{value : "it"})

await SF.collection.updateOne("cost-centers",{value : "it"})

await SF.collection.update("cost-centers",{value : "it"})

await SF.collection.count("cost-centers")

await SF.collection.deleteOne("cost-centers",{})

await SF.collection.delete("cost-centers",{})

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

await SF.collection.cleanCollection("cost-centers")

let bulkOps = [
  { insertOne: { document: { name: 'John', age: 30 } } },
  { updateOne: { filter: { name: 'John' }, update: { $set: { age: 31 } } } },
  { deleteOne: { filter: { name: 'John' } } }
];

await SF.utils.bulkWrite('users', bulkOps);
// returns: Promise resolved when all operations are completed

await SF.user.getUsersinGroup("6042551d231e8c8ade19bc09")

await SF.user.getUsersInGroupList(["6042551d231e8c8ade19bc09","6040e3679c81cf1b60b698f4"])

let group = await SF.utils.getGroupById("60c72b2f9f1b2c3c8f3b8b0b");
// returns: { _id: ObjectId("60c72b2f9f1b2c3c8f3b8b0b"), name: 'Admin', members: [...] }

let group = await SF.utils.getGroupById("60c72b2f9f1b2c3c8f3b8b0c");
// returns: null (if group with this ID doesn't exist)

await SF.user.getUserById("6042551d231e8c8ade19bc09")

await SF.user.getUserByMail("test@softyflow.com")

await SF.user.updateUserById("6042551d231e8c8ade19bc09",{firstName : "test"})

await SF.user.updateUsersEach([{ _id: "6042551d231e8c8ade19bc09", payload: { firstName: 'firstUser' } }, { _id: "6042551d231e8c8ade19bc10", payload: { firstName: 'secondUser' } }])

await SF.user.updateUserMetadataById("6042551d231e8c8ade19bc09", "Manager",  "test")

await SF.user.getUsers()

await SF.user.getUserMetadata("6042551d231e8c8ade19bc09")

await SF.user.addUserToGroup("6042551d231e8c8ade19bc09", "62c2b6f74d16c2a2c19dcdb7")

await SF.user.removeUserfromGroup("6042551d231e8c8ade19bc09", "62c2b6f74d16c2a2c19dcdb7")

 var newUser = {
    firstName: "Jean",
    lastName: "Martin",
    email: "jean.martin@softy.io",
    group_test: [],
    group_uat: [],
    group: [],
    metadata_test: {},
    metadata_uat: {},
    metadata_prod: {},
    ideAccess: false,
    blocked: false,
    sendMail: false,
    getPassword: false
};

var user = await SF.user.createUser(newUser);

let result = await SF.file.getFileContentById("64bfa28cfabc123...", "utf8");
console.log(result.content);

let buffer = await SF.file.getFileBufferById("64bfa28cfabc123...");

await SF.file.generatePDFFromTemplate(null, 'templateId', {
  variables: { name: "John" },
  SF_pdfName: "user-report.pdf"
});

await SF.file.createFileFromBuffer({ filename: "doc.txt", contentType: "text/plain" }, Buffer.from("Hello"));

// Assuming you have a template file with placeholders like:
// Invoice for: {d.customerName}
// Amount: {d.amount}
// Date: {d.date}

let data = {
  customerName: "John Doe",
  amount: 1500,
  date: "2025-01-15",
  items: [
    { product: "Widget A", quantity: 5, price: 100 },
    { product: "Widget B", quantity: 10, price: 50 }
  ]
};

// Fill the template
let filledDocumentId = await SF.file.fillTemplate("64bfa28cfabc123...", data);
console.log("Filled document ID:", filledDocumentId);

let result = await SF.file.deleteFileById("60c72b2f9f1b2c3c8f3b8b0b");
// returns: { deleted: 1 } (if file was deleted)

let result = await SF.file.deleteFileById("60c72b2f9f1b2c3c8f3b8b0c");
// returns: { deleted: 0 } (if there was an error or file not found)

await SF.sql.insertOne("610c0343f6ebc7ddcb49cc3b", "client", {
    code: 'MMA',
    codepostal: 225
})

await SF.sql.insertMany("610c0343f6ebc7ddcb49cc3b", "client", [{
    code: 'MMA',
    codepostal: 225
}])

await SF.sql.findOne("610c0343f6ebc7ddcb49cc3b", "client", "code='MGMT'")

await SF.sql.find("610c0343f6ebc7ddcb49cc3b", "client", "code='MGMT'")

await SF.sql.update("610c0343f6ebc7ddcb49cc3b", "client", "code='MDMS'", {
    code: 'CLEA'
})

 await SF.sql.delete("610c0343f6ebc7ddcb49cc3b", "client", "code='CLEA'")

 await SF.sql.count("610c0343f6ebc7ddcb49cc3b", "client", "code='CLEA'")

await SF.sql.execute('610c0343f6ebc7ddcb49cc3b', "DELETE FROM client WHERE code='KL'")

await SF.instance.launchProcess('610c0343f6ebc7ddcb49cc3b')

await SF.instance.findOne({ _id: SF.ObjectId('610c0343f6ebc7ddcb49cc3b') })

await SF.instance.find({ status: 'running' })

await SF.instance.pendingTask('610c0343f6ebc7ddcb49cc3b')

await SF.instance.getMeasures('610c0343f6ebc7ddcb49cc3b')

let variables = {
  "variable1": "value1",
  "variable2": 1,
  "variable3": true
}
await SF.instance.validateTask('610c0343f6ebc7ddcb49cc3b',variables)

let data = {
  "variable1": "value1",
  "variable2": 1,
  "variable3": true
}
await SF.instance.updateVariablesById('610c0343f6ebc7ddcb49cc3b',data)

let result = await SF.utils.attachChildInstance(
  "661e9d8a1a2b2f7f8d3c4e1f",
  "661e9d9b2b5e2f8f8d3c5f0a",
  "step123"
);
// returns: { done: true }

let instance = await SF.utils.getVariablesById("661e9d8a1a2b2f7f8d3c4e1f");
// returns: Full instance document

let instance = await SF.utils.getVariablesById("661e9d8a1a2b2f7f8d3c4e1f", { variables: 1 });
// returns: { variables: {...} }

let result = await SF.instance.deleteInstanceById("661e9d8a1a2b2f7f8d3c4e1f");
// returns: { done: true }

let result = await SF.instance.deleteManyInstances("661e9d8a1a2b2f7f8d3c4e1f", { status: "completed" });
await SF.instance.deleteManyInstances("661e9d8a1a2b2f7f8d3c4e1f", { createdAt: { $lt: SF.utils.moment().subtract(5, 'days') } })
// returns: { done: true }

// Delete all completed instances with full cleanup
let result = await SF.instance.deleteManyInstancesWithTasksAndHistories(
  "661e9d8a1a2b2f7f8d3c4e1f", 
  { status: "completed" }
);
// returns: { done: true }

// Delete all instances older than a certain date
let result = await SF.instance.deleteManyInstancesWithTasksAndHistories(
  "661e9d8a1a2b2f7f8d3c4e1f", 
  { createdAt: { $lt: new Date('2024-01-01') } }
);
// returns: { done: true }

let result = await SF.instance.updateInstanceVariables("661e9d8a1a2b2f7f8d3c4e1f", {
  amount: 1500,
  dueDate: "2025-05-30"
});
// returns: { done: true }

// Access methods directly from SF.softyTable
await SF.softyTable.list('tableId123', criteria);

// List all rows
let rows = await SF.softyTable.list('610c0343f6ebc7ddcb49cc3b');

// List with filters
let activeRows = await SF.softyTable.list(
  '610c0343f6ebc7ddcb49cc3b',
  { where: { status: 'active' } }, 
  50, 
  0, 
  'createdAt', 
  -1
);

// List with complex criteria
let rows = await SF.softyTable.list(
  '610c0343f6ebc7ddcb49cc3b',
  {
    where: { age: { $gte: 18 } },
    attributes: ['name', 'email', 'age']
  }, 
  20, 
  0
);

// Count all rows
let result = await SF.softyTable.count('610c0343f6ebc7ddcb49cc3b');
// returns: { count: 150 }

// Count with filter
let result = await SF.softyTable.count(
  '610c0343f6ebc7ddcb49cc3b',
  { where: { status: 'active' } }
);
// returns: { count: 75 }

let newRow = await SF.softyTable.create(
  '610c0343f6ebc7ddcb49cc3b',
  {
    name: 'John Doe',
    email: 'john@example.com',
    age: 30,
    status: 'active'
  }
);

let newRows = await SF.softyTable.createMany(
  '610c0343f6ebc7ddcb49cc3b',
  [
    { name: 'John Doe', email: 'john@example.com', age: 30 },
    { name: 'Jane Smith', email: 'jane@example.com', age: 25 },
    { name: 'Bob Johnson', email: 'bob@example.com', age: 35 }
  ]
);

let row = await SF.softyTable.retrieve('610c0343f6ebc7ddcb49cc3b', '12345');

let updated = await SF.softyTable.update(
  '610c0343f6ebc7ddcb49cc3b',
  '12345',
  {
    status: 'inactive',
    updatedAt: new Date()
  }
);

// Update all rows where status is 'pending'
let result = await SF.softyTable.updateMany(
  '610c0343f6ebc7ddcb49cc3b',
  { status: 'pending' },
  { status: 'active', processedAt: new Date() }
);

await SF.softyTable.delete('610c0343f6ebc7ddcb49cc3b', '12345');

// Delete all inactive rows
await SF.softyTable.deleteMany(
  '610c0343f6ebc7ddcb49cc3b',
  { status: 'inactive' }
);

// Delete rows older than a certain date
await SF.softyTable.deleteMany(
  '610c0343f6ebc7ddcb49cc3b',
  { createdAt: { $lt: new Date('2024-01-01') } }
);

// Remove all rows from the table
await SF.softyTable.clear('610c0343f6ebc7ddcb49cc3b');

let options = await SF.softyTable.getOptions(
  '610c0343f6ebc7ddcb49cc3b',
  'status_field'
);
// returns: [{ label: 'Active', value: 'active' }, { label: 'Inactive', value: 'inactive' }]

// List all related items
let relatedItems = await SF.softyTable.joinTableList(
  '610c0343f6ebc7ddcb49cc3b',
  'related_products'
);

// List with filters and pagination
let items = await SF.softyTable.joinTableList(
  '610c0343f6ebc7ddcb49cc3b',
  'related_products',
  { where: { category: 'electronics' } },
  20,
  0,
  'price',
  -1
);

let result = await SF.softyTable.joinTableCount(
  '610c0343f6ebc7ddcb49cc3b',
  'related_products'
);
// returns: { count: 45 }

let result = await SF.softyTable.joinTableCount(
  '610c0343f6ebc7ddcb49cc3b',
  'related_products',
  { where: { category: 'electronics' } }
);
// returns: { count: 12 }

// Execute a SELECT query
let results = await SF.softyTable.execute(
  '610c0343f6ebc7ddcb49cc3b',
  'SELECT * FROM my_table WHERE status = :status',
  {
    replacements: { status: 'active' },
    type: 'SELECT'
  }
);

// Execute a custom query
let results = await SF.softyTable.execute(
  '610c0343f6ebc7ddcb49cc3b',
  'UPDATE my_table SET status = "processed" WHERE created_at < NOW() - INTERVAL 30 DAY',
  { type: 'UPDATE' }
);

let result = await SF.softyTable.migrate(
  '610c0343f6ebc7ddcb49cc3b',
  {
    // Migration configuration
  }
);

await SF.task.findOne({ _id: ObjectId('610c0343f6ebc7ddcb49cc3b') })

await SF.task.find({ status: 'pending' })

await SF.task.deleteTaskById('610c0343f6ebc7ddcb49cc3b')

// Delete all tasks with status 'completed'
await SF.task.deleteMany({ status: 'completed' })

// Delete all tasks for a specific instance

await SF.task.deleteMany({ instanceId: SF.ObjectId('610c0343f6ebc7ddcb49cc3b') })

await SF.task.deleteHistoryByTaskId('610c0343f6ebc7ddcb49cc3b')

await SF.task.deleteHistoryByInstanceId('610c0343f6ebc7ddcb49cc3b')

// Delete all history records for a specific action
await SF.task.deleteHistory({ action: 'task_completed' })

// Delete history records older than a certain date
await SF.task.deleteHistory({ createdAt: { $lt: new Date('2024-01-01') } })

await SF.task.saveTask('610c0343f6ebc7ddcb49cc3b', {
  status: 'in-progress',
  assignee: 'user123'
})

await SF.task.updateTask('610c0343f6ebc7ddcb49cc3b', {
  status: 'completed',
  completedAt: new Date()
})