@twin.org/automation-models 0.0.3-next.5 → 0.9.0

package/dist/es/models/IAutomationComponent.js.map

@@ -1 +1 @@
-{"version":3,"file":"IAutomationComponent.js","sourceRoot":"","sources":["../../../src/models/IAutomationComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IAutomationActionEntry } from \"./IAutomationActionEntry.js\";\n\n/**\n * Interface describing an automation contract.\n */\nexport interface IAutomationComponent extends IComponent {\n\t/**\n\t * Create an action with the trigger and configuration.\n\t * @param actionType The type of action to create.\n\t * @param trigger The trigger to create the action for.\n\t * @param config Configuration to be passed to the actions.\n\t * @returns The id of the created action.\n\t */\n\tactionCreate(actionType: string, trigger: string, config?: unknown): Promise<string>;\n\n\t/**\n\t * Remove an action by it's id.\n\t * @param actionId The id of the action to remove.\n\t * @returns Nothing.\n\t */\n\tactionRemove(actionId: string): Promise<void>;\n\n\t/**\n\t * Get an action by it's id.\n\t * @param actionId The id of the action to get.\n\t * @returns The action with the given id.\n\t */\n\tactionGet(actionId: string): Promise<IAutomationActionEntry>;\n\n\t/**\n\t * Query the actions with the given parameters.\n\t * @param options The options to query the actions with.\n\t * @param options.trigger The trigger to query the actions for.\n\t * @param options.actionType The type of action to query for.\n\t * @param cursor The cursor to continue the query from.\n\t * @param limit The maximum number of actions to return.\n\t * @returns The actions matching the query and a cursor to continue the query if there are more results.\n\t */\n\tactionsQuery(\n\t\toptions:\n\t\t\t| {\n\t\t\t\t\ttrigger?: string;\n\t\t\t\t\tactionType?: string;\n\t\t\t  }\n\t\t\t| undefined,\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{\n\t\tentries: IAutomationActionEntry[];\n\t\tcursor?: string;\n\t}>;\n\n\t/**\n\t * Locate automation actions which match the given trigger and execute them.\n\t * @param trigger The trigger to find the actions for.\n\t * @param data Optional data to be passed to the actions.\n\t * @returns Nothing.\n\t */\n\ttrigger(trigger: string, data?: unknown): Promise<void>;\n}\n"]}
+{"version":3,"file":"IAutomationComponent.js","sourceRoot":"","sources":["../../../src/models/IAutomationComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IAutomationActionEntry } from \"./IAutomationActionEntry.js\";\n\n/**\n * Interface describing an automation contract.\n */\nexport interface IAutomationComponent extends IComponent {\n\t/**\n\t * Create an action with the trigger and configuration.\n\t * @param actionType The type of action to create.\n\t * @param trigger The trigger to create the action for.\n\t * @param config Configuration to be passed to the actions.\n\t * @returns The id of the created action.\n\t */\n\tactionCreate(actionType: string, trigger: string, config?: unknown): Promise<string>;\n\n\t/**\n\t * Remove an action by its id.\n\t * @param actionId The id of the action to remove.\n\t * @returns A promise that resolves when the action is removed.\n\t */\n\tactionRemove(actionId: string): Promise<void>;\n\n\t/**\n\t * Get an action by its id.\n\t * @param actionId The id of the action to get.\n\t * @returns The action with the given id.\n\t */\n\tactionGet(actionId: string): Promise<IAutomationActionEntry>;\n\n\t/**\n\t * Query the actions with the given parameters.\n\t * @param options The options to query the actions with.\n\t * @param options.trigger The trigger to query the actions for.\n\t * @param options.actionType The type of action to query for.\n\t * @param cursor The cursor to continue the query from.\n\t * @param limit The maximum number of actions to return.\n\t * @returns The actions matching the query and a cursor to continue the query if there are more results.\n\t */\n\tactionsQuery(\n\t\toptions:\n\t\t\t| {\n\t\t\t\t\ttrigger?: string;\n\t\t\t\t\tactionType?: string;\n\t\t\t  }\n\t\t\t| undefined,\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{\n\t\tentries: IAutomationActionEntry[];\n\t\tcursor?: string;\n\t}>;\n\n\t/**\n\t * Locate automation actions which match the given trigger and execute them.\n\t * @param trigger The trigger to find the actions for.\n\t * @param data Optional data to be passed to the actions.\n\t * @returns A promise that resolves when all matching actions have executed.\n\t */\n\ttrigger(trigger: string, data?: unknown): Promise<void>;\n}\n"]}

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

@@ -13,13 +13,13 @@ export interface IAutomationComponent extends IComponent {
      */
     actionCreate(actionType: string, trigger: string, config?: unknown): Promise<string>;
     /**
-     * Remove an action by it's id.
+     * Remove an action by its id.
      * @param actionId The id of the action to remove.
-     * @returns Nothing.
+     * @returns A promise that resolves when the action is removed.
      */
     actionRemove(actionId: string): Promise<void>;
     /**
-     * Get an action by it's id.
+     * Get an action by its id.
      * @param actionId The id of the action to get.
      * @returns The action with the given id.
      */
@@ -44,7 +44,7 @@ export interface IAutomationComponent extends IComponent {
      * Locate automation actions which match the given trigger and execute them.
      * @param trigger The trigger to find the actions for.
      * @param data Optional data to be passed to the actions.
-     * @returns Nothing.
+     * @returns A promise that resolves when all matching actions have executed.
      */
     trigger(trigger: string, data?: unknown): Promise<void>;
 }

package/docs/changelog.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## [0.9.0](https://github.com/iotaledger/twin-automation/compare/automation-models-v0.9.0...automation-models-v0.9.0) (2026-06-24)
+
+
+### Features
+
+* initial commit ([33ddc12](https://github.com/iotaledger/twin-automation/commit/33ddc12869db11b7f861967f820ac4d5b00dbca2))
+* release to production ([#15](https://github.com/iotaledger/twin-automation/issues/15)) ([fe4baa4](https://github.com/iotaledger/twin-automation/commit/fe4baa495825852b93dab09d5c2b8f7c10899542))
+
+## [0.9.0-next.1](https://github.com/iotaledger/twin-automation/compare/automation-models-v0.9.0-next.0...automation-models-v0.9.0-next.1) (2026-06-23)
+
+
+### Features
+
+* initial commit ([33ddc12](https://github.com/iotaledger/twin-automation/commit/33ddc12869db11b7f861967f820ac4d5b00dbca2))
+* typescript 6 update ([ee77cab](https://github.com/iotaledger/twin-automation/commit/ee77cab770cd3d2aff6192f146b4b5544c206d52))
+* update dependencies ([e299490](https://github.com/iotaledger/twin-automation/commit/e299490b7dfe3d847a3beb254a609883caec2c98))
+
 ## [0.0.3-next.5](https://github.com/iotaledger/twin-automation/compare/automation-models-v0.0.3-next.4...automation-models-v0.0.3-next.5) (2026-06-11)
 
 

package/docs/reference/interfaces/IAutomationComponent.md

@@ -46,7 +46,7 @@ The id of the created action.
 
 > **actionRemove**(`actionId`): `Promise`\<`void`\>
 
-Remove an action by it's id.
+Remove an action by its id.
 
 #### Parameters
 
@@ -60,7 +60,7 @@ The id of the action to remove.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the action is removed.
 
 ***
 
@@ -68,7 +68,7 @@ Nothing.
 
 > **actionGet**(`actionId`): `Promise`\<[`IAutomationActionEntry`](IAutomationActionEntry.md)\>
 
-Get an action by it's id.
+Get an action by its id.
 
 #### Parameters
 
@@ -166,4 +166,4 @@ Optional data to be passed to the actions.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when all matching actions have executed.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/automation-models",
-	"version": "0.0.3-next.5",
+	"version": "0.9.0",
 	"description": "Shared data models for automation. Provides a consistent foundation for representing automation entities and enables other packages to build upon a reliable base.",
 	"repository": {
 		"type": "git",
@@ -14,8 +14,8 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/core": "next",
-		"@twin.org/nameof": "next"
+		"@twin.org/core": "^0.9.0",
+		"@twin.org/nameof": "^0.9.0"
 	},
 	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",