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

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 IOTA Stiftung.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,21 @@
+# TWIN Background Task Models
+
+Models which define the structure of the background task contracts and connectors.
+
+## Installation
+
+```shell
+npm install @twin.org/background-task-models
+```
+
+## Examples
+
+Usage of the APIs is shown in the examples [docs/examples.md](docs/examples.md)
+
+## Reference
+
+Detailed reference documentation for the API can be found in [docs/reference/index.md](docs/reference/index.md)
+
+## Changelog
+
+The changes between each version can be found in [docs/changelog.md](docs/changelog.md)

package/dist/cjs/index.cjs

@@ -0,0 +1,43 @@
+'use strict';
+
+var core = require('@twin.org/core');
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Factory for creating background task connectors.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const BackgroundTaskConnectorFactory = core.Factory.createFactory("background-task");
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Task statuses.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const TaskStatus = {
+    /**
+     * Pending.
+     */
+    Pending: "pending",
+    /**
+     * Processing.
+     */
+    Processing: "processing",
+    /**
+     * Success.
+     */
+    Success: "success",
+    /**
+     * Failed.
+     */
+    Failed: "failed",
+    /**
+     * Cancelled.
+     */
+    Cancelled: "cancelled"
+};
+
+exports.BackgroundTaskConnectorFactory = BackgroundTaskConnectorFactory;
+exports.TaskStatus = TaskStatus;

package/dist/esm/index.mjs

@@ -0,0 +1,40 @@
+import { Factory } from '@twin.org/core';
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Factory for creating background task connectors.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const BackgroundTaskConnectorFactory = Factory.createFactory("background-task");
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Task statuses.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const TaskStatus = {
+    /**
+     * Pending.
+     */
+    Pending: "pending",
+    /**
+     * Processing.
+     */
+    Processing: "processing",
+    /**
+     * Success.
+     */
+    Success: "success",
+    /**
+     * Failed.
+     */
+    Failed: "failed",
+    /**
+     * Cancelled.
+     */
+    Cancelled: "cancelled"
+};
+
+export { BackgroundTaskConnectorFactory, TaskStatus };

package/dist/types/factories/backgroundTaskConnectorFactory.d.ts

@@ -0,0 +1,6 @@
+import { Factory } from "@twin.org/core";
+import type { IBackgroundTaskConnector } from "../models/IBackgroundTaskConnector";
+/**
+ * Factory for creating background task connectors.
+ */
+export declare const BackgroundTaskConnectorFactory: Factory<IBackgroundTaskConnector>;

package/dist/types/index.d.ts

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

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

@@ -0,0 +1,59 @@
+import type { IError } from "@twin.org/core";
+import type { TaskStatus } from "./taskStatus";
+/**
+ * Interface describing a background task connector.
+ */
+export interface IBackgroundTask<T = any, U = any> {
+    /**
+     * The id.
+     */
+    id: string;
+    /**
+     * The type of the task.
+     */
+    type: string;
+    /**
+     * The retry interval in milliseconds, undefined if default scheduling.
+     */
+    retryInterval?: number;
+    /**
+     * The number of retries remaining, undefined if infinite retries.
+     */
+    retriesRemaining?: number;
+    /**
+     * The date the task was created.
+     */
+    dateCreated: string;
+    /**
+     * The date the task was last modified.
+     */
+    dateModified: string;
+    /**
+     * The date the task was complete.
+     */
+    dateCompleted?: string;
+    /**
+     * The date the task was cancelled.
+     */
+    dateCancelled?: string;
+    /**
+     * The date until when to retain.
+     */
+    dateRetainUntil?: string;
+    /**
+     * The status of the task.
+     */
+    status: TaskStatus;
+    /**
+     * The payload to execute the task with.
+     */
+    payload?: T;
+    /**
+     * The result of the execution.
+     */
+    result?: U;
+    /**
+     * The error at last execution.
+     */
+    error?: IError;
+}

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

@@ -0,0 +1,76 @@
+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";
+/**
+ * Interface describing a background task connector.
+ */
+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.
+     * @returns Nothing.
+     */
+    registerHandler<T, U>(taskType: string, handler: BackgroundTaskHandler<T, U>): Promise<void>;
+    /**
+     * Unregister a handler for a task.
+     * @param taskType The type of the task handler to remove.
+     * @returns Nothing.
+     */
+    unregisterHandler(taskType: string): Promise<void>;
+    /**
+     * Create a new task.
+     * @param type The type of the task.
+     * @param payload The payload for the task.
+     * @param options Additional options for the task.
+     * @param options.retryCount The number of times to retry the task if it fails, leave undefined to retry forever.
+     * @param options.retryInterval The interval in milliseconds to wait between retries, defaults to 5000, leave undefined for default scheduling.
+     * @param options.retainFor The amount of time in milliseconds to retain the result until removal, defaults to 0 for immediate removal, set to -1 to keep forever.
+     * @returns The id of the created task.
+     */
+    create<T>(type: string, payload?: T, options?: {
+        retryCount?: number;
+        retryInterval?: number;
+        retainFor?: number;
+    }): Promise<string>;
+    /**
+     * Get the task details.
+     * @param taskId The id of the task to get the details for.
+     * @returns The details of the task.
+     */
+    get<T, U>(taskId: string): Promise<IBackgroundTask<T, U> | undefined>;
+    /**
+     * Retry a failed task immediately instead of waiting for it's next scheduled retry time.
+     * @param taskId The id of the task to retry.
+     * @returns Nothing.
+     */
+    retry(taskId: string): Promise<void>;
+    /**
+     * Remove a task ignoring any retain until date.
+     * @param taskId The id of the task to remove.
+     * @returns Nothing.
+     */
+    remove(taskId: string): Promise<void>;
+    /**
+     * Cancel a task, will only be actioned if the task is currently pending.
+     * @param taskId The id of the task to cancel.
+     * @returns Nothing.
+     */
+    cancel(taskId: string): Promise<void>;
+    /**
+     * Get a list of tasks.
+     * @param taskType The type of the task to get.
+     * @param taskStatus The status of the task to get.
+     * @param sortProperty The property to sort by, defaults to dateCreated.
+     * @param sortDirection The order to sort by, defaults to ascending.
+     * @param cursor The cursor to get the next page of tasks.
+     * @param pageSize The maximum number of entities in a page.
+     * @returns The list of tasks.
+     */
+    query(taskType?: string, taskStatus?: TaskStatus, sortProperty?: "dateCreated" | "dateModified" | "dateCompleted" | "status", sortDirection?: SortDirection, cursor?: string, pageSize?: number): Promise<{
+        entities: IBackgroundTask[];
+        cursor?: string;
+    }>;
+}

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

@@ -0,0 +1,8 @@
+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/dist/types/models/taskStatus.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Task statuses.
+ */
+export declare const TaskStatus: {
+    /**
+     * Pending.
+     */
+    readonly Pending: "pending";
+    /**
+     * Processing.
+     */
+    readonly Processing: "processing";
+    /**
+     * Success.
+     */
+    readonly Success: "success";
+    /**
+     * Failed.
+     */
+    readonly Failed: "failed";
+    /**
+     * Cancelled.
+     */
+    readonly Cancelled: "cancelled";
+};
+/**
+ * Task statuses.
+ */
+export type TaskStatus = (typeof TaskStatus)[keyof typeof TaskStatus];

package/docs/changelog.md

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

package/docs/examples.md

@@ -0,0 +1 @@
+# @twin.org/background-task-models - Examples

package/docs/reference/index.md

@@ -0,0 +1,16 @@
+# @twin.org/background-task-models
+
+## Interfaces
+
+- [IBackgroundTask](interfaces/IBackgroundTask.md)
+- [IBackgroundTaskConnector](interfaces/IBackgroundTaskConnector.md)
+
+## Type Aliases
+
+- [BackgroundTaskHandler](type-aliases/BackgroundTaskHandler.md)
+- [TaskStatus](type-aliases/TaskStatus.md)
+
+## Variables
+
+- [BackgroundTaskConnectorFactory](variables/BackgroundTaskConnectorFactory.md)
+- [TaskStatus](variables/TaskStatus.md)

package/docs/reference/interfaces/IBackgroundTask.md

@@ -0,0 +1,113 @@
+# Interface: IBackgroundTask\<T, U\>
+
+Interface describing a background task connector.
+
+## Type Parameters
+
+• **T** = `any`
+
+• **U** = `any`
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+The id.
+
+***
+
+### type
+
+> **type**: `string`
+
+The type of the task.
+
+***
+
+### retryInterval?
+
+> `optional` **retryInterval**: `number`
+
+The retry interval in milliseconds, undefined if default scheduling.
+
+***
+
+### retriesRemaining?
+
+> `optional` **retriesRemaining**: `number`
+
+The number of retries remaining, undefined if infinite retries.
+
+***
+
+### dateCreated
+
+> **dateCreated**: `string`
+
+The date the task was created.
+
+***
+
+### dateModified
+
+> **dateModified**: `string`
+
+The date the task was last modified.
+
+***
+
+### dateCompleted?
+
+> `optional` **dateCompleted**: `string`
+
+The date the task was complete.
+
+***
+
+### dateCancelled?
+
+> `optional` **dateCancelled**: `string`
+
+The date the task was cancelled.
+
+***
+
+### dateRetainUntil?
+
+> `optional` **dateRetainUntil**: `string`
+
+The date until when to retain.
+
+***
+
+### status
+
+> **status**: [`TaskStatus`](../type-aliases/TaskStatus.md)
+
+The status of the task.
+
+***
+
+### payload?
+
+> `optional` **payload**: `T`
+
+The payload to execute the task with.
+
+***
+
+### result?
+
+> `optional` **result**: `U`
+
+The result of the execution.
+
+***
+
+### error?
+
+> `optional` **error**: `IError`
+
+The error at last execution.

package/docs/reference/interfaces/IBackgroundTaskConnector.md

@@ -0,0 +1,235 @@
+# Interface: IBackgroundTaskConnector
+
+Interface describing a background task connector.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### registerHandler()
+
+> **registerHandler**\<`T`, `U`\>(`taskType`, `handler`): `Promise`\<`void`\>
+
+Register a handler for a task.
+
+#### Type Parameters
+
+• **T**
+
+• **U**
+
+#### Parameters
+
+• **taskType**: `string`
+
+The type of the task the handler can process.
+
+• **handler**: [`BackgroundTaskHandler`](../type-aliases/BackgroundTaskHandler.md)\<`T`, `U`\>
+
+The handler for the task.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### unregisterHandler()
+
+> **unregisterHandler**(`taskType`): `Promise`\<`void`\>
+
+Unregister a handler for a task.
+
+#### Parameters
+
+• **taskType**: `string`
+
+The type of the task handler to remove.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### create()
+
+> **create**\<`T`\>(`type`, `payload`?, `options`?): `Promise`\<`string`\>
+
+Create a new task.
+
+#### Type Parameters
+
+• **T**
+
+#### Parameters
+
+• **type**: `string`
+
+The type of the task.
+
+• **payload?**: `T`
+
+The payload for the task.
+
+• **options?**
+
+Additional options for the task.
+
+• **options.retryCount?**: `number`
+
+The number of times to retry the task if it fails, leave undefined to retry forever.
+
+• **options.retryInterval?**: `number`
+
+The interval in milliseconds to wait between retries, defaults to 5000, leave undefined for default scheduling.
+
+• **options.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.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The id of the created task.
+
+***
+
+### get()
+
+> **get**\<`T`, `U`\>(`taskId`): `Promise`\<`undefined` \| [`IBackgroundTask`](IBackgroundTask.md)\<`T`, `U`\>\>
+
+Get the task details.
+
+#### Type Parameters
+
+• **T**
+
+• **U**
+
+#### Parameters
+
+• **taskId**: `string`
+
+The id of the task to get the details for.
+
+#### Returns
+
+`Promise`\<`undefined` \| [`IBackgroundTask`](IBackgroundTask.md)\<`T`, `U`\>\>
+
+The details of the task.
+
+***
+
+### retry()
+
+> **retry**(`taskId`): `Promise`\<`void`\>
+
+Retry a failed task immediately instead of waiting for it's next scheduled retry time.
+
+#### Parameters
+
+• **taskId**: `string`
+
+The id of the task to retry.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### remove()
+
+> **remove**(`taskId`): `Promise`\<`void`\>
+
+Remove a task ignoring any retain until date.
+
+#### Parameters
+
+• **taskId**: `string`
+
+The id of the task to remove.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### cancel()
+
+> **cancel**(`taskId`): `Promise`\<`void`\>
+
+Cancel a task, will only be actioned if the task is currently pending.
+
+#### Parameters
+
+• **taskId**: `string`
+
+The id of the task to cancel.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### query()
+
+> **query**(`taskType`?, `taskStatus`?, `sortProperty`?, `sortDirection`?, `cursor`?, `pageSize`?): `Promise`\<`object`\>
+
+Get a list of tasks.
+
+#### Parameters
+
+• **taskType?**: `string`
+
+The type of the task to get.
+
+• **taskStatus?**: [`TaskStatus`](../type-aliases/TaskStatus.md)
+
+The status of the task to get.
+
+• **sortProperty?**: `"status"` \| `"dateCreated"` \| `"dateModified"` \| `"dateCompleted"`
+
+The property to sort by, defaults to dateCreated.
+
+• **sortDirection?**: `SortDirection`
+
+The order to sort by, defaults to ascending.
+
+• **cursor?**: `string`
+
+The cursor to get the next page of tasks.
+
+• **pageSize?**: `number`
+
+The maximum number of entities in a page.
+
+#### Returns
+
+`Promise`\<`object`\>
+
+The list of tasks.
+
+##### entities
+
+> **entities**: [`IBackgroundTask`](IBackgroundTask.md)\<`any`, `any`\>[]
+
+##### cursor?
+
+> `optional` **cursor**: `string`

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

@@ -0,0 +1,27 @@
+# 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`

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

@@ -0,0 +1,5 @@
+# Type Alias: TaskStatus
+
+> **TaskStatus**: *typeof* [`TaskStatus`](../variables/TaskStatus.md)\[keyof *typeof* [`TaskStatus`](../variables/TaskStatus.md)\]
+
+Task statuses.

package/docs/reference/variables/BackgroundTaskConnectorFactory.md

@@ -0,0 +1,5 @@
+# Variable: BackgroundTaskConnectorFactory
+
+> `const` **BackgroundTaskConnectorFactory**: `Factory`\<[`IBackgroundTaskConnector`](../interfaces/IBackgroundTaskConnector.md)\>
+
+Factory for creating background task connectors.

package/docs/reference/variables/TaskStatus.md

@@ -0,0 +1,37 @@
+# Variable: TaskStatus
+
+> `const` **TaskStatus**: `object`
+
+Task statuses.
+
+## Type declaration
+
+### Pending
+
+> `readonly` **Pending**: `"pending"` = `"pending"`
+
+Pending.
+
+### Processing
+
+> `readonly` **Processing**: `"processing"` = `"processing"`
+
+Processing.
+
+### Success
+
+> `readonly` **Success**: `"success"` = `"success"`
+
+Success.
+
+### Failed
+
+> `readonly` **Failed**: `"failed"` = `"failed"`
+
+Failed.
+
+### Cancelled
+
+> `readonly` **Cancelled**: `"cancelled"` = `"cancelled"`
+
+Cancelled.

package/locales/en.json

@@ -0,0 +1,3 @@
+{
+	"error": {}
+}

package/package.json

@@ -0,0 +1,39 @@
+{
+	"name": "@twin.org/background-task-models",
+	"version": "0.0.1-next.1",
+	"description": "Models which define the structure of the background task contracts and connectors",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/background-task.git",
+		"directory": "packages/background-task-models"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"dependencies": {
+		"@twin.org/core": "next",
+		"@twin.org/entity": "next",
+		"@twin.org/nameof": "next"
+	},
+	"main": "./dist/cjs/index.cjs",
+	"module": "./dist/esm/index.mjs",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs",
+			"types": "./dist/types/index.d.ts"
+		},
+		"./locales": "./locales"
+	},
+	"files": [
+		"dist/cjs",
+		"dist/esm",
+		"dist/types",
+		"locales",
+		"docs"
+	]
+}