@twin.org/background-task-models 0.0.2-next.7 → 0.0.2-next.9

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

@@ -67,10 +67,10 @@ export interface IBackgroundTaskConnector extends IComponent {
      * @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.
+     * @param limit Limit the number of entities to return.
      * @returns The list of tasks.
      */
-    query(taskType?: string, taskStatus?: TaskStatus, sortProperty?: "dateCreated" | "dateModified" | "dateCompleted" | "status", sortDirection?: SortDirection, cursor?: string, pageSize?: number): Promise<{
+    query(taskType?: string, taskStatus?: TaskStatus, sortProperty?: "dateCreated" | "dateModified" | "dateCompleted" | "status", sortDirection?: SortDirection, cursor?: string, limit?: number): Promise<{
         entities: IBackgroundTask[];
         cursor?: string;
     }>;

package/docs/changelog.md

@@ -1,5 +1,19 @@
 # @twin.org/background-task-models - Changelog
 
+## [0.0.2-next.9](https://github.com/twinfoundation/background-task/compare/background-task-models-v0.0.2-next.8...background-task-models-v0.0.2-next.9) (2025-10-09)
+
+
+### Features
+
+* add validate-locales ([968cbf9](https://github.com/twinfoundation/background-task/commit/968cbf966fffb5060305e8b221fecc0b6c8105b9))
+
+## [0.0.2-next.8](https://github.com/twinfoundation/background-task/compare/background-task-models-v0.0.2-next.7...background-task-models-v0.0.2-next.8) (2025-09-29)
+
+
+### Features
+
+* update IComponent signatures ([e1a79bc](https://github.com/twinfoundation/background-task/commit/e1a79bc4dd813435c56e376f231a4b4ecd2276bf))
+
 ## [0.0.2-next.7](https://github.com/twinfoundation/background-task/compare/background-task-models-v0.0.2-next.6...background-task-models-v0.0.2-next.7) (2025-08-29)
 
 

package/docs/reference/interfaces/IBackgroundTaskConnector.md

@@ -6,6 +6,14 @@ Interface describing a background task connector.
 
 - `IComponent`
 
+## Indexable
+
+\[`key`: `string`\]: `any`
+
+All methods are optional, so we introduce an index signature to allow
+any additional properties or methods, which removes the TypeScript error where
+the class has no properties in common with the type.
+
 ## Methods
 
 ### registerHandler()
@@ -236,7 +244,7 @@ Nothing.
 
 ### query()
 
-> **query**(`taskType?`, `taskStatus?`, `sortProperty?`, `sortDirection?`, `cursor?`, `pageSize?`): `Promise`\<\{ `entities`: [`IBackgroundTask`](IBackgroundTask.md)\<`any`, `any`\>[]; `cursor?`: `string`; \}\>
+> **query**(`taskType?`, `taskStatus?`, `sortProperty?`, `sortDirection?`, `cursor?`, `limit?`): `Promise`\<\{ `entities`: [`IBackgroundTask`](IBackgroundTask.md)\<`any`, `any`\>[]; `cursor?`: `string`; \}\>
 
 Get a list of tasks.
 
@@ -272,11 +280,11 @@ The order to sort by, defaults to ascending.
 
 The cursor to get the next page of tasks.
 
-##### pageSize?
+##### limit?
 
 `number`
 
-The maximum number of entities in a page.
+Limit the number of entities to return.
 
 #### Returns
 

package/docs/reference/interfaces/ITaskSchedulerComponent.md

@@ -6,6 +6,14 @@ Interface describing a task scheduler.
 
 - `IComponent`
 
+## Indexable
+
+\[`key`: `string`\]: `any`
+
+All methods are optional, so we introduce an index signature to allow
+any additional properties or methods, which removes the TypeScript error where
+the class has no properties in common with the type.
+
 ## Methods
 
 ### addTask()

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/background-task-models",
-	"version": "0.0.2-next.7",
+	"version": "0.0.2-next.9",
 	"description": "Models which define the structure of the background task contracts and connectors",
 	"repository": {
 		"type": "git",
@@ -35,5 +35,24 @@
 		"dist/types",
 		"locales",
 		"docs"
-	]
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"background-task",
+		"tasks",
+		"scheduling",
+		"jobs",
+		"async",
+		"models",
+		"types",
+		"schemas"
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/background-task/issues"
+	},
+	"homepage": "https://twindev.org"
 }