@live-change/task-service 0.8.119 → 0.8.120

package/index.js

@@ -4,7 +4,7 @@ const app = App.app()
 import definition from './definition.js'
 
 import './model.js'
-import task from './task.js'
+import task from './task.ts'
 
 export { task }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@live-change/task-service",
-  "version": "0.8.119",
+  "version": "0.8.120",
   "description": "",
   "main": "index.js",
   "scripts": {
@@ -22,8 +22,8 @@
   },
   "type": "module",
   "dependencies": {
-    "@live-change/framework": "^0.8.119",
-    "@live-change/relations-plugin": "^0.8.119"
+    "@live-change/framework": "^0.8.120",
+    "@live-change/relations-plugin": "^0.8.120"
   },
-  "gitHead": "1f0bb577d5bfe8b8d355775d7adbd73c789cd1d5"
+  "gitHead": "adf31fd8365df0655d88293f96a93734058d3dd4"
 }

package/{task.js → task.ts}

@@ -1,7 +1,8 @@
 import App from '@live-change/framework'
+// @ts-ignore:next-line
 const app = App.app()
 
-import crypto from 'crypto'
+import * as crypto from 'crypto'
 
 import PQueue from 'p-queue'
 
@@ -87,10 +88,68 @@ async function startTask(taskFunction, props, causeType, cause){
   return { task: taskObject.id, taskObject, promise, causeType, cause }
 }
 
-export default function task(definition, serviceDefinition) {
+interface TaskExecuteApi {
+  id: string,
+  run: (taskFunction, props, progressFactor) => Promise<any>,
+  progress: (current, total, action, opts) => void,
+  trigger: (trigger, props) => Promise<any>,
+  triggerService: (trigger, props, returnArray) => Promise<any>
+}
+
+interface TaskExecuteContext {
+  task: TaskExecuteApi,
+  trigger: (trigger, props) => Promise<any>,
+  triggerService: (trigger, props, returnArray) => Promise<any>,
+  causeType: string,
+  cause: string
+}
+
+interface TaskDefinition {
+  /**
+   * Task name
+   */
+  name: string,
+
+  /**
+   * Maximum number of retries
+   */
+  maxRetries?: number,
+
+  /**
+   * Task execution function
+   * @param props - task properties/parameters
+   * @param context - task context
+   * @param emit - event emitter function
+   * @returns {Promise<any>} - task result promise
+   */
+  execute: (props, context: TaskExecuteContext, emit) => Promise<any>,
+
+  /**
+   * Cleanup function
+   * @param props - task properties/parameters
+   * @param context - task context
+   * @returns {Promise<void>} - cleanup result promise
+   */
+  cleanup?: (props, context: TaskExecuteContext) => Promise<void>,
+
+  /**
+   * Fallback function
+   * @param props - task properties/parameters
+   * @param context - task context
+   * @param error - error object
+   * @returns {Promise<any>} - fallback result
+   */
+  fallback?: (props, context: TaskExecuteContext, error) => any
+}
+
+type TaskFunction = (props, context: TaskExecuteContext, emit, reportProgress) => Promise<any>
+
+export default function task(definition:TaskDefinition, serviceDefinition) {
   if(!definition) throw new Error('Task definition is not defined')
   if(!serviceDefinition) throw new Error('Service definition is not defined')
-  const taskFunction = async (props, context, emit, reportProgress = () => {}) => {
+  const taskFunction = async (props, context,
+                              emit = events => app.emitEvents(definition.name, Array.isArray(events) ? events : [events], {}),
+                              reportProgress = (current, total, selfProgress) => {}) => {
     if(!emit) emit = (events) =>
       app.emitEvents(definition.name, Array.isArray(events) ? events : [events], {})
 
@@ -127,7 +186,7 @@ export default function task(definition, serviceDefinition) {
       })
     }
 
-    let selfProgress = { current: 0, total: 0 }
+    let selfProgress = { current: 0, total: 0, action: undefined }
     const subtasksProgress = []
     let progressUpdateTimer, lastProgressUpdate = 0
     const progressThrottleTime = 400
@@ -159,7 +218,7 @@ export default function task(definition, serviceDefinition) {
         ...context,
         task: {
           id: taskObject.id,
-          async run(taskFunction, props, progressFactor = 1) {
+          async run(taskFunction: TaskFunction, props, progressFactor = 1) {
             if(typeof taskFunction !== 'function') {
               console.log("TASK FUNCTION", taskFunction)
               throw new Error('Task function is not a function')