@twin.org/background-task-models 0.0.1-next.1 → 0.0.1-next.10

package/dist/types/index.d.ts

@@ -1,5 +1,4 @@
 export * from "./factories/backgroundTaskConnectorFactory";
-export * from "./models/backgroundTaskHandler";
 export * from "./models/IBackgroundTask";
 export * from "./models/IBackgroundTaskConnector";
 export * from "./models/taskStatus";

package/dist/types/models/IBackgroundTaskConnector.d.ts

@@ -1,6 +1,5 @@
 import type { IComponent } from "@twin.org/core";
 import type { SortDirection } from "@twin.org/entity";
-import type { BackgroundTaskHandler } from "./backgroundTaskHandler";
 import type { IBackgroundTask } from "./IBackgroundTask";
 import type { TaskStatus } from "./taskStatus";
 /**
@@ -10,10 +9,12 @@ export interface IBackgroundTaskConnector extends IComponent {
     /**
      * Register a handler for a task.
      * @param taskType The type of the task the handler can process.
-     * @param handler The handler for the task.
+     * @param module The module the handler is in.
+     * @param method The method in the module to execute.
+     * @param stateChangeCallback The callback to execute when the task state is updated.
      * @returns Nothing.
      */
-    registerHandler<T, U>(taskType: string, handler: BackgroundTaskHandler<T, U>): Promise<void>;
+    registerHandler<T, U>(taskType: string, module: string, method: string, stateChangeCallback?: (task: IBackgroundTask<T, U>) => Promise<void>): Promise<void>;
     /**
      * Unregister a handler for a task.
      * @param taskType The type of the task handler to remove.

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/background-task-models - Changelog
 
-## v0.0.1-next.1
+## v0.0.1-next.10
 
 - Initial Release

package/docs/reference/index.md

@@ -7,7 +7,6 @@
 
 ## Type Aliases
 
-- [BackgroundTaskHandler](type-aliases/BackgroundTaskHandler.md)
 - [TaskStatus](type-aliases/TaskStatus.md)
 
 ## Variables

package/docs/reference/interfaces/IBackgroundTaskConnector.md

@@ -10,7 +10,7 @@ Interface describing a background task connector.
 
 ### registerHandler()
 
-> **registerHandler**\<`T`, `U`\>(`taskType`, `handler`): `Promise`\<`void`\>
+> **registerHandler**\<`T`, `U`\>(`taskType`, `module`, `method`, `stateChangeCallback`?): `Promise`\<`void`\>
 
 Register a handler for a task.
 
@@ -22,13 +22,29 @@ Register a handler for a task.
 
 #### Parameters
 
-• **taskType**: `string`
+##### taskType
+
+`string`
 
 The type of the task the handler can process.
 
-• **handler**: [`BackgroundTaskHandler`](../type-aliases/BackgroundTaskHandler.md)\<`T`, `U`\>
+##### module
+
+`string`
+
+The module the handler is in.
+
+##### method
+
+`string`
+
+The method in the module to execute.
+
+##### stateChangeCallback?
+
+(`task`) => `Promise`\<`void`\>
 
-The handler for the task.
+The callback to execute when the task state is updated.
 
 #### Returns
 
@@ -46,7 +62,9 @@ Unregister a handler for a task.
 
 #### Parameters
 
-• **taskType**: `string`
+##### taskType
+
+`string`
 
 The type of the task handler to remove.
 
@@ -70,27 +88,37 @@ Create a new task.
 
 #### Parameters
 
-• **type**: `string`
+##### type
+
+`string`
 
 The type of the task.
 
-• **payload?**: `T`
+##### payload?
+
+`T`
 
 The payload for the task.
 
-• **options?**
+##### options?
 
 Additional options for the task.
 
-• **options.retryCount?**: `number`
+###### retryCount
+
+`number`
 
 The number of times to retry the task if it fails, leave undefined to retry forever.
 
-• **options.retryInterval?**: `number`
+###### retryInterval
+
+`number`
 
 The interval in milliseconds to wait between retries, defaults to 5000, leave undefined for default scheduling.
 
-• **options.retainFor?**: `number`
+###### retainFor
+
+`number`
 
 The amount of time in milliseconds to retain the result until removal, defaults to 0 for immediate removal, set to -1 to keep forever.
 
@@ -116,7 +144,9 @@ Get the task details.
 
 #### Parameters
 
-• **taskId**: `string`
+##### taskId
+
+`string`
 
 The id of the task to get the details for.
 
@@ -136,7 +166,9 @@ Retry a failed task immediately instead of waiting for it's next scheduled retry
 
 #### Parameters
 
-• **taskId**: `string`
+##### taskId
+
+`string`
 
 The id of the task to retry.
 
@@ -156,7 +188,9 @@ Remove a task ignoring any retain until date.
 
 #### Parameters
 
-• **taskId**: `string`
+##### taskId
+
+`string`
 
 The id of the task to remove.
 
@@ -176,7 +210,9 @@ Cancel a task, will only be actioned if the task is currently pending.
 
 #### Parameters
 
-• **taskId**: `string`
+##### taskId
+
+`string`
 
 The id of the task to cancel.
 
@@ -190,46 +226,50 @@ Nothing.
 
 ### query()
 
-> **query**(`taskType`?, `taskStatus`?, `sortProperty`?, `sortDirection`?, `cursor`?, `pageSize`?): `Promise`\<`object`\>
+> **query**(`taskType`?, `taskStatus`?, `sortProperty`?, `sortDirection`?, `cursor`?, `pageSize`?): `Promise`\<\{ `entities`: [`IBackgroundTask`](IBackgroundTask.md)[]; `cursor`: `string`; \}\>
 
 Get a list of tasks.
 
 #### Parameters
 
-• **taskType?**: `string`
+##### taskType?
+
+`string`
 
 The type of the task to get.
 
-• **taskStatus?**: [`TaskStatus`](../type-aliases/TaskStatus.md)
+##### taskStatus?
+
+[`TaskStatus`](../type-aliases/TaskStatus.md)
 
 The status of the task to get.
 
-• **sortProperty?**: `"status"` \| `"dateCreated"` \| `"dateModified"` \| `"dateCompleted"`
+##### sortProperty?
 
 The property to sort by, defaults to dateCreated.
 
-• **sortDirection?**: `SortDirection`
+`"status"` | `"dateCreated"` | `"dateModified"` | `"dateCompleted"`
+
+##### sortDirection?
+
+`SortDirection`
 
 The order to sort by, defaults to ascending.
 
-• **cursor?**: `string`
+##### cursor?
+
+`string`
 
 The cursor to get the next page of tasks.
 
-• **pageSize?**: `number`
+##### pageSize?
+
+`number`
 
 The maximum number of entities in a page.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `entities`: [`IBackgroundTask`](IBackgroundTask.md)[]; `cursor`: `string`; \}\>
 
 The list of tasks.
-
-##### entities
-
-> **entities**: [`IBackgroundTask`](IBackgroundTask.md)\<`any`, `any`\>[]
-
-##### cursor?
-
-> `optional` **cursor**: `string`

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/background-task-models",
-	"version": "0.0.1-next.1",
+	"version": "0.0.1-next.10",
 	"description": "Models which define the structure of the background task contracts and connectors",
 	"repository": {
 		"type": "git",
@@ -23,11 +23,11 @@
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
+			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs",
-			"types": "./dist/types/index.d.ts"
+			"import": "./dist/esm/index.mjs"
 		},
-		"./locales": "./locales"
+		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
 		"dist/cjs",

package/dist/types/models/backgroundTaskHandler.d.ts

@@ -1,8 +0,0 @@
-import type { IError } from "@twin.org/core";
-/**
- * Interface describing a task handler.
- */
-export type BackgroundTaskHandler<T = any, U = any> = (payload: T) => Promise<{
-    result?: U;
-    error?: IError;
-}>;

package/docs/reference/type-aliases/BackgroundTaskHandler.md

@@ -1,27 +0,0 @@
-# Type Alias: BackgroundTaskHandler()\<T, U\>
-
-> **BackgroundTaskHandler**\<`T`, `U`\>: (`payload`) => `Promise`\<`object`\>
-
-Interface describing a task handler.
-
-## Type Parameters
-
-• **T** = `any`
-
-• **U** = `any`
-
-## Parameters
-
-• **payload**: `T`
-
-## Returns
-
-`Promise`\<`object`\>
-
-### result?
-
-> `optional` **result**: `U`
-
-### error?
-
-> `optional` **error**: `IError`