@twin.org/automation-models 0.0.3-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 Automation Models
+
+This package provides shared data models for automation. It serves as a foundational component, enabling other packages to build upon a consistent and reliable base for representing automation entities.
+
+## Installation
+
+```shell
+npm install @twin.org/automation-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/es/factories/automationActionFactory.js

@@ -0,0 +1,9 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Factory } from "@twin.org/core";
+/**
+ * Factory for creating implementation of automation action types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const AutomationActionFactory = Factory.createFactory("automation-action");
+//# sourceMappingURL=automationActionFactory.js.map

package/dist/es/factories/automationActionFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"automationActionFactory.js","sourceRoot":"","sources":["../../../src/factories/automationActionFactory.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAGzC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,uBAAuB,GACnC,OAAO,CAAC,aAAa,CAAoB,mBAAmB,CAAC,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Factory } from \"@twin.org/core\";\nimport type { IAutomationAction } from \"../models/IAutomationAction.js\";\n\n/**\n * Factory for creating implementation of automation action types.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const AutomationActionFactory =\n\tFactory.createFactory<IAutomationAction>(\"automation-action\");\n"]}

package/dist/es/index.js

@@ -0,0 +1,14 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./factories/automationActionFactory.js";
+export * from "./models/api/IAutomationActionCreateRequest.js";
+export * from "./models/api/IAutomationActionGetRequest.js";
+export * from "./models/api/IAutomationActionGetResponse.js";
+export * from "./models/api/IAutomationActionRemoveRequest.js";
+export * from "./models/api/IAutomationActionsQueryRequest.js";
+export * from "./models/api/IAutomationActionsQueryResponse.js";
+export * from "./models/api/IAutomationTriggerRequest.js";
+export * from "./models/IAutomationAction.js";
+export * from "./models/IAutomationActionEntry.js";
+export * from "./models/IAutomationComponent.js";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,wCAAwC,CAAC;AACvD,cAAc,gDAAgD,CAAC;AAC/D,cAAc,6CAA6C,CAAC;AAC5D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,gDAAgD,CAAC;AAC/D,cAAc,gDAAgD,CAAC;AAC/D,cAAc,iDAAiD,CAAC;AAChE,cAAc,2CAA2C,CAAC;AAC1D,cAAc,+BAA+B,CAAC;AAC9C,cAAc,oCAAoC,CAAC;AACnD,cAAc,kCAAkC,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./factories/automationActionFactory.js\";\nexport * from \"./models/api/IAutomationActionCreateRequest.js\";\nexport * from \"./models/api/IAutomationActionGetRequest.js\";\nexport * from \"./models/api/IAutomationActionGetResponse.js\";\nexport * from \"./models/api/IAutomationActionRemoveRequest.js\";\nexport * from \"./models/api/IAutomationActionsQueryRequest.js\";\nexport * from \"./models/api/IAutomationActionsQueryResponse.js\";\nexport * from \"./models/api/IAutomationTriggerRequest.js\";\nexport * from \"./models/IAutomationAction.js\";\nexport * from \"./models/IAutomationActionEntry.js\";\nexport * from \"./models/IAutomationComponent.js\";\n"]}

package/dist/es/models/IAutomationAction.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IAutomationAction.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"IAutomationAction.js","sourceRoot":"","sources":["../../../src/models/IAutomationAction.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\n\n/**\n * Interface describing an automation action.\n */\nexport interface IAutomationAction extends IComponent {\n\t/**\n\t * Execute the automation action.\n\t * @param data Optional data to be passed to the automation action.\n\t * @returns A promise that resolves when the execution is complete.\n\t */\n\ttrigger(data?: unknown): Promise<void>;\n}\n"]}

package/dist/es/models/IAutomationActionEntry.js

@@ -0,0 +1,4 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IAutomationActionEntry.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"IAutomationActionEntry.js","sourceRoot":"","sources":["../../../src/models/IAutomationActionEntry.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Interface describing an automation action entry.\n */\nexport interface IAutomationActionEntry {\n\t/**\n\t * The id of the automation action.\n\t */\n\tid: string;\n\n\t/**\n\t * The type of the automation action.\n\t */\n\tactionType: string;\n\n\t/**\n\t * The trigger of the automation action.\n\t */\n\ttrigger: string;\n\n\t/**\n\t * The configuration of the automation action.\n\t */\n\tconfiguration?: unknown;\n}\n"]}

package/dist/es/models/IAutomationComponent.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IAutomationComponent.js.map

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

@@ -0,0 +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"]}

package/dist/es/models/api/IAutomationActionCreateRequest.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IAutomationActionCreateRequest.js.map

package/dist/es/models/api/IAutomationActionCreateRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAutomationActionCreateRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IAutomationActionCreateRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IAutomationActionEntry } from \"../IAutomationActionEntry.js\";\n\n/**\n * Request to create an automation action.\n */\nexport interface IAutomationActionCreateRequest {\n\t/**\n\t * The body parameters for the request.\n\t */\n\tbody: Omit<IAutomationActionEntry, \"id\">;\n}\n"]}

package/dist/es/models/api/IAutomationActionGetRequest.js

@@ -0,0 +1,4 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IAutomationActionGetRequest.js.map

package/dist/es/models/api/IAutomationActionGetRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAutomationActionGetRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IAutomationActionGetRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Request to get an automation action by id.\n */\nexport interface IAutomationActionGetRequest {\n\t/**\n\t * The path parameters for the request.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The unique identifier of the action to get.\n\t\t */\n\t\tactionId: string;\n\t};\n}\n"]}

package/dist/es/models/api/IAutomationActionGetResponse.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IAutomationActionGetResponse.js.map

package/dist/es/models/api/IAutomationActionGetResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAutomationActionGetResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IAutomationActionGetResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IAutomationActionEntry } from \"../IAutomationActionEntry.js\";\n\n/**\n * Response for getting an automation action.\n */\nexport interface IAutomationActionGetResponse {\n\t/**\n\t * The automation action entry corresponding to the requested id.\n\t */\n\tbody: IAutomationActionEntry;\n}\n"]}

package/dist/es/models/api/IAutomationActionRemoveRequest.js

@@ -0,0 +1,4 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IAutomationActionRemoveRequest.js.map

package/dist/es/models/api/IAutomationActionRemoveRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAutomationActionRemoveRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IAutomationActionRemoveRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Request to remove an automation action.\n */\nexport interface IAutomationActionRemoveRequest {\n\t/**\n\t * The path parameters for the request.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The unique identifier of the action to remove.\n\t\t */\n\t\tactionId: string;\n\t};\n}\n"]}

package/dist/es/models/api/IAutomationActionsQueryRequest.js

@@ -0,0 +1,4 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IAutomationActionsQueryRequest.js.map

package/dist/es/models/api/IAutomationActionsQueryRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAutomationActionsQueryRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IAutomationActionsQueryRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Request to query automation actions.\n */\nexport interface IAutomationActionsQueryRequest {\n\t/**\n\t * Optional query parameters for filtering and pagination.\n\t */\n\tquery?: {\n\t\t/**\n\t\t * Filter by trigger type.\n\t\t */\n\t\ttrigger?: string;\n\n\t\t/**\n\t\t * Filter by action type.\n\t\t */\n\t\tactionType?: string;\n\n\t\t/**\n\t\t * Cursor for pagination.\n\t\t */\n\t\tcursor?: string;\n\n\t\t/**\n\t\t * Limit the number of results returned.\n\t\t */\n\t\tlimit?: string;\n\t};\n}\n"]}

package/dist/es/models/api/IAutomationActionsQueryResponse.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IAutomationActionsQueryResponse.js.map

package/dist/es/models/api/IAutomationActionsQueryResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAutomationActionsQueryResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IAutomationActionsQueryResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IAutomationActionEntry } from \"../IAutomationActionEntry.js\";\n\n/**\n * Response for querying automation actions.\n */\nexport interface IAutomationActionsQueryResponse {\n\t/**\n\t * The body of the response.\n\t */\n\tbody: {\n\t\t/**\n\t\t * List of automation action entries matching the query.\n\t\t */\n\t\tentries: IAutomationActionEntry[];\n\n\t\t/**\n\t\t * Optional cursor for pagination.\n\t\t */\n\t\tcursor?: string;\n\t};\n}\n"]}

package/dist/es/models/api/IAutomationTriggerRequest.js

@@ -0,0 +1,4 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IAutomationTriggerRequest.js.map

package/dist/es/models/api/IAutomationTriggerRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAutomationTriggerRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IAutomationTriggerRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Request to trigger an automation action.\n */\nexport interface IAutomationTriggerRequest {\n\t/**\n\t * The path parameters.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The trigger for the actions.\n\t\t */\n\t\ttrigger: string;\n\t};\n\n\t/**\n\t * The body parameters.\n\t */\n\tbody: {\n\t\t/**\n\t\t * Optional data to be passed to the actions.\n\t\t */\n\t\tdata?: unknown;\n\t};\n}\n"]}

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

@@ -0,0 +1,6 @@
+import { Factory } from "@twin.org/core";
+import type { IAutomationAction } from "../models/IAutomationAction.js";
+/**
+ * Factory for creating implementation of automation action types.
+ */
+export declare const AutomationActionFactory: Factory<IAutomationAction>;

package/dist/types/index.d.ts

@@ -0,0 +1,11 @@
+export * from "./factories/automationActionFactory.js";
+export * from "./models/api/IAutomationActionCreateRequest.js";
+export * from "./models/api/IAutomationActionGetRequest.js";
+export * from "./models/api/IAutomationActionGetResponse.js";
+export * from "./models/api/IAutomationActionRemoveRequest.js";
+export * from "./models/api/IAutomationActionsQueryRequest.js";
+export * from "./models/api/IAutomationActionsQueryResponse.js";
+export * from "./models/api/IAutomationTriggerRequest.js";
+export * from "./models/IAutomationAction.js";
+export * from "./models/IAutomationActionEntry.js";
+export * from "./models/IAutomationComponent.js";

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

@@ -0,0 +1,12 @@
+import type { IComponent } from "@twin.org/core";
+/**
+ * Interface describing an automation action.
+ */
+export interface IAutomationAction extends IComponent {
+    /**
+     * Execute the automation action.
+     * @param data Optional data to be passed to the automation action.
+     * @returns A promise that resolves when the execution is complete.
+     */
+    trigger(data?: unknown): Promise<void>;
+}

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

@@ -0,0 +1,21 @@
+/**
+ * Interface describing an automation action entry.
+ */
+export interface IAutomationActionEntry {
+    /**
+     * The id of the automation action.
+     */
+    id: string;
+    /**
+     * The type of the automation action.
+     */
+    actionType: string;
+    /**
+     * The trigger of the automation action.
+     */
+    trigger: string;
+    /**
+     * The configuration of the automation action.
+     */
+    configuration?: unknown;
+}

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

@@ -0,0 +1,50 @@
+import type { IComponent } from "@twin.org/core";
+import type { IAutomationActionEntry } from "./IAutomationActionEntry.js";
+/**
+ * Interface describing an automation contract.
+ */
+export interface IAutomationComponent extends IComponent {
+    /**
+     * Create an action with the trigger and configuration.
+     * @param actionType The type of action to create.
+     * @param trigger The trigger to create the action for.
+     * @param config Configuration to be passed to the actions.
+     * @returns The id of the created action.
+     */
+    actionCreate(actionType: string, trigger: string, config?: unknown): Promise<string>;
+    /**
+     * Remove an action by it's id.
+     * @param actionId The id of the action to remove.
+     * @returns Nothing.
+     */
+    actionRemove(actionId: string): Promise<void>;
+    /**
+     * Get an action by it's id.
+     * @param actionId The id of the action to get.
+     * @returns The action with the given id.
+     */
+    actionGet(actionId: string): Promise<IAutomationActionEntry>;
+    /**
+     * Query the actions with the given parameters.
+     * @param options The options to query the actions with.
+     * @param options.trigger The trigger to query the actions for.
+     * @param options.actionType The type of action to query for.
+     * @param cursor The cursor to continue the query from.
+     * @param limit The maximum number of actions to return.
+     * @returns The actions matching the query and a cursor to continue the query if there are more results.
+     */
+    actionsQuery(options: {
+        trigger?: string;
+        actionType?: string;
+    } | undefined, cursor?: string, limit?: number): Promise<{
+        entries: IAutomationActionEntry[];
+        cursor?: string;
+    }>;
+    /**
+     * 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.
+     */
+    trigger(trigger: string, data?: unknown): Promise<void>;
+}

package/dist/types/models/api/IAutomationActionCreateRequest.d.ts

@@ -0,0 +1,10 @@
+import type { IAutomationActionEntry } from "../IAutomationActionEntry.js";
+/**
+ * Request to create an automation action.
+ */
+export interface IAutomationActionCreateRequest {
+    /**
+     * The body parameters for the request.
+     */
+    body: Omit<IAutomationActionEntry, "id">;
+}

package/dist/types/models/api/IAutomationActionGetRequest.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Request to get an automation action by id.
+ */
+export interface IAutomationActionGetRequest {
+    /**
+     * The path parameters for the request.
+     */
+    pathParams: {
+        /**
+         * The unique identifier of the action to get.
+         */
+        actionId: string;
+    };
+}

package/dist/types/models/api/IAutomationActionGetResponse.d.ts

@@ -0,0 +1,10 @@
+import type { IAutomationActionEntry } from "../IAutomationActionEntry.js";
+/**
+ * Response for getting an automation action.
+ */
+export interface IAutomationActionGetResponse {
+    /**
+     * The automation action entry corresponding to the requested id.
+     */
+    body: IAutomationActionEntry;
+}

package/dist/types/models/api/IAutomationActionRemoveRequest.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Request to remove an automation action.
+ */
+export interface IAutomationActionRemoveRequest {
+    /**
+     * The path parameters for the request.
+     */
+    pathParams: {
+        /**
+         * The unique identifier of the action to remove.
+         */
+        actionId: string;
+    };
+}

package/dist/types/models/api/IAutomationActionsQueryRequest.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Request to query automation actions.
+ */
+export interface IAutomationActionsQueryRequest {
+    /**
+     * Optional query parameters for filtering and pagination.
+     */
+    query?: {
+        /**
+         * Filter by trigger type.
+         */
+        trigger?: string;
+        /**
+         * Filter by action type.
+         */
+        actionType?: string;
+        /**
+         * Cursor for pagination.
+         */
+        cursor?: string;
+        /**
+         * Limit the number of results returned.
+         */
+        limit?: string;
+    };
+}

package/dist/types/models/api/IAutomationActionsQueryResponse.d.ts

@@ -0,0 +1,19 @@
+import type { IAutomationActionEntry } from "../IAutomationActionEntry.js";
+/**
+ * Response for querying automation actions.
+ */
+export interface IAutomationActionsQueryResponse {
+    /**
+     * The body of the response.
+     */
+    body: {
+        /**
+         * List of automation action entries matching the query.
+         */
+        entries: IAutomationActionEntry[];
+        /**
+         * Optional cursor for pagination.
+         */
+        cursor?: string;
+    };
+}

package/dist/types/models/api/IAutomationTriggerRequest.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Request to trigger an automation action.
+ */
+export interface IAutomationTriggerRequest {
+    /**
+     * The path parameters.
+     */
+    pathParams: {
+        /**
+         * The trigger for the actions.
+         */
+        trigger: string;
+    };
+    /**
+     * The body parameters.
+     */
+    body: {
+        /**
+         * Optional data to be passed to the actions.
+         */
+        data?: unknown;
+    };
+}

package/docs/changelog.md

@@ -0,0 +1,10 @@
+# Changelog
+
+## [0.0.3-next.1](https://github.com/twinfoundation/automation/compare/automation-models-v0.0.3-next.0...automation-models-v0.0.3-next.1) (2026-04-23)
+
+
+### Features
+
+* initial commit ([33ddc12](https://github.com/twinfoundation/automation/commit/33ddc12869db11b7f861967f820ac4d5b00dbca2))
+
+## Changelog

package/docs/examples.md

@@ -0,0 +1,75 @@
+# Automation Models Examples
+
+This package provides shared interfaces and factories for automation actions, entries, and components. These are used to define and implement automation logic in a consistent way.
+
+## IAutomationAction
+
+```typescript
+import type { IAutomationAction } from '@twin.org/automation-models';
+
+class MyAction implements IAutomationAction {
+  async trigger(data?: unknown): Promise<void> {
+    // Perform the action
+  }
+
+  className(): string {
+    return 'MyAction';
+  }
+}
+```
+
+## IAutomationActionEntry
+
+```typescript
+import type { IAutomationActionEntry } from '@twin.org/automation-models';
+
+const entry: IAutomationActionEntry = {
+  id: 'action-1',
+  actionType: 'my-action',
+  trigger: 'onEvent',
+  configuration: { foo: 123 }
+};
+```
+
+## IAutomationComponent
+
+```typescript
+import type { IAutomationComponent } from '@twin.org/automation-models';
+
+// Example implementation skeleton
+class MyComponent implements IAutomationComponent {
+  async actionCreate(actionType: string, trigger: string, config?: unknown): Promise<string> {
+    // ...
+    return 'id';
+  }
+  async actionRemove(actionId: string): Promise<void> {
+    // ...
+  }
+  async actionGet(actionId: string) {
+    // ...
+    return { id: actionId, actionType: 't', trigger: 'tr' };
+  }
+  async actionsQuery() {
+    // ...
+    return { entries: [], cursor: undefined };
+  }
+  async trigger(trigger: string, data?: unknown): Promise<void> {
+    // ...
+  }
+  className(): string {
+    return 'MyComponent';
+  }
+}
+```
+
+## AutomationActionFactory
+
+```typescript
+import { AutomationActionFactory } from '@twin.org/automation-models';
+
+AutomationActionFactory.register('my-action', opts => new MyAction());
+const action = AutomationActionFactory.createIfExists('my-action');
+if (action) {
+  await action.trigger();
+}
+```

package/docs/reference/index.md

@@ -0,0 +1,18 @@
+# @twin.org/automation-models
+
+## Interfaces
+
+- [IAutomationAction](interfaces/IAutomationAction.md)
+- [IAutomationActionEntry](interfaces/IAutomationActionEntry.md)
+- [IAutomationComponent](interfaces/IAutomationComponent.md)
+- [IAutomationActionCreateRequest](interfaces/IAutomationActionCreateRequest.md)
+- [IAutomationActionGetRequest](interfaces/IAutomationActionGetRequest.md)
+- [IAutomationActionGetResponse](interfaces/IAutomationActionGetResponse.md)
+- [IAutomationActionRemoveRequest](interfaces/IAutomationActionRemoveRequest.md)
+- [IAutomationActionsQueryRequest](interfaces/IAutomationActionsQueryRequest.md)
+- [IAutomationActionsQueryResponse](interfaces/IAutomationActionsQueryResponse.md)
+- [IAutomationTriggerRequest](interfaces/IAutomationTriggerRequest.md)
+
+## Variables
+
+- [AutomationActionFactory](variables/AutomationActionFactory.md)

package/docs/reference/interfaces/IAutomationAction.md

@@ -0,0 +1,29 @@
+# Interface: IAutomationAction
+
+Interface describing an automation action.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### trigger() {#trigger}
+
+> **trigger**(`data?`): `Promise`\<`void`\>
+
+Execute the automation action.
+
+#### Parameters
+
+##### data?
+
+`unknown`
+
+Optional data to be passed to the automation action.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the execution is complete.

package/docs/reference/interfaces/IAutomationActionCreateRequest.md

@@ -0,0 +1,11 @@
+# Interface: IAutomationActionCreateRequest
+
+Request to create an automation action.
+
+## Properties
+
+### body {#body}
+
+> **body**: `Omit`\<[`IAutomationActionEntry`](IAutomationActionEntry.md), `"id"`\>
+
+The body parameters for the request.

package/docs/reference/interfaces/IAutomationActionEntry.md

@@ -0,0 +1,35 @@
+# Interface: IAutomationActionEntry
+
+Interface describing an automation action entry.
+
+## Properties
+
+### id {#id}
+
+> **id**: `string`
+
+The id of the automation action.
+
+***
+
+### actionType {#actiontype}
+
+> **actionType**: `string`
+
+The type of the automation action.
+
+***
+
+### trigger {#trigger}
+
+> **trigger**: `string`
+
+The trigger of the automation action.
+
+***
+
+### configuration? {#configuration}
+
+> `optional` **configuration?**: `unknown`
+
+The configuration of the automation action.

package/docs/reference/interfaces/IAutomationActionGetRequest.md

@@ -0,0 +1,17 @@
+# Interface: IAutomationActionGetRequest
+
+Request to get an automation action by id.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The path parameters for the request.
+
+#### actionId
+
+> **actionId**: `string`
+
+The unique identifier of the action to get.

package/docs/reference/interfaces/IAutomationActionGetResponse.md

@@ -0,0 +1,11 @@
+# Interface: IAutomationActionGetResponse
+
+Response for getting an automation action.
+
+## Properties
+
+### body {#body}
+
+> **body**: [`IAutomationActionEntry`](IAutomationActionEntry.md)
+
+The automation action entry corresponding to the requested id.

package/docs/reference/interfaces/IAutomationActionRemoveRequest.md

@@ -0,0 +1,17 @@
+# Interface: IAutomationActionRemoveRequest
+
+Request to remove an automation action.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The path parameters for the request.
+
+#### actionId
+
+> **actionId**: `string`
+
+The unique identifier of the action to remove.

package/docs/reference/interfaces/IAutomationActionsQueryRequest.md

@@ -0,0 +1,35 @@
+# Interface: IAutomationActionsQueryRequest
+
+Request to query automation actions.
+
+## Properties
+
+### query? {#query}
+
+> `optional` **query?**: `object`
+
+Optional query parameters for filtering and pagination.
+
+#### trigger?
+
+> `optional` **trigger?**: `string`
+
+Filter by trigger type.
+
+#### actionType?
+
+> `optional` **actionType?**: `string`
+
+Filter by action type.
+
+#### cursor?
+
+> `optional` **cursor?**: `string`
+
+Cursor for pagination.
+
+#### limit?
+
+> `optional` **limit?**: `string`
+
+Limit the number of results returned.

package/docs/reference/interfaces/IAutomationActionsQueryResponse.md

@@ -0,0 +1,23 @@
+# Interface: IAutomationActionsQueryResponse
+
+Response for querying automation actions.
+
+## Properties
+
+### body {#body}
+
+> **body**: `object`
+
+The body of the response.
+
+#### entries
+
+> **entries**: [`IAutomationActionEntry`](IAutomationActionEntry.md)[]
+
+List of automation action entries matching the query.
+
+#### cursor?
+
+> `optional` **cursor?**: `string`
+
+Optional cursor for pagination.

package/docs/reference/interfaces/IAutomationComponent.md

@@ -0,0 +1,169 @@
+# Interface: IAutomationComponent
+
+Interface describing an automation contract.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### actionCreate() {#actioncreate}
+
+> **actionCreate**(`actionType`, `trigger`, `config?`): `Promise`\<`string`\>
+
+Create an action with the trigger and configuration.
+
+#### Parameters
+
+##### actionType
+
+`string`
+
+The type of action to create.
+
+##### trigger
+
+`string`
+
+The trigger to create the action for.
+
+##### config?
+
+`unknown`
+
+Configuration to be passed to the actions.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The id of the created action.
+
+***
+
+### actionRemove() {#actionremove}
+
+> **actionRemove**(`actionId`): `Promise`\<`void`\>
+
+Remove an action by it's id.
+
+#### Parameters
+
+##### actionId
+
+`string`
+
+The id of the action to remove.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### actionGet() {#actionget}
+
+> **actionGet**(`actionId`): `Promise`\<[`IAutomationActionEntry`](IAutomationActionEntry.md)\>
+
+Get an action by it's id.
+
+#### Parameters
+
+##### actionId
+
+`string`
+
+The id of the action to get.
+
+#### Returns
+
+`Promise`\<[`IAutomationActionEntry`](IAutomationActionEntry.md)\>
+
+The action with the given id.
+
+***
+
+### actionsQuery() {#actionsquery}
+
+> **actionsQuery**(`options`, `cursor?`, `limit?`): `Promise`\<\{ `entries`: [`IAutomationActionEntry`](IAutomationActionEntry.md)[]; `cursor?`: `string`; \}\>
+
+Query the actions with the given parameters.
+
+#### Parameters
+
+##### options
+
+\{ `trigger?`: `string`; `actionType?`: `string`; \} \| `undefined`
+
+The options to query the actions with.
+
+###### Type Literal
+
+\{ `trigger?`: `string`; `actionType?`: `string`; \}
+
+The options to query the actions with.
+
+###### trigger?
+
+`string`
+
+The trigger to query the actions for.
+
+###### actionType?
+
+`string`
+
+The type of action to query for.
+
+***
+
+`undefined`
+
+##### cursor?
+
+`string`
+
+The cursor to continue the query from.
+
+##### limit?
+
+`number`
+
+The maximum number of actions to return.
+
+#### Returns
+
+`Promise`\<\{ `entries`: [`IAutomationActionEntry`](IAutomationActionEntry.md)[]; `cursor?`: `string`; \}\>
+
+The actions matching the query and a cursor to continue the query if there are more results.
+
+***
+
+### trigger() {#trigger}
+
+> **trigger**(`trigger`, `data?`): `Promise`\<`void`\>
+
+Locate automation actions which match the given trigger and execute them.
+
+#### Parameters
+
+##### trigger
+
+`string`
+
+The trigger to find the actions for.
+
+##### data?
+
+`unknown`
+
+Optional data to be passed to the actions.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.

package/docs/reference/interfaces/IAutomationTriggerRequest.md

@@ -0,0 +1,31 @@
+# Interface: IAutomationTriggerRequest
+
+Request to trigger an automation action.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### trigger
+
+> **trigger**: `string`
+
+The trigger for the actions.
+
+***
+
+### body {#body}
+
+> **body**: `object`
+
+The body parameters.
+
+#### data?
+
+> `optional` **data?**: `unknown`
+
+Optional data to be passed to the actions.

package/docs/reference/variables/AutomationActionFactory.md

@@ -0,0 +1,5 @@
+# Variable: AutomationActionFactory
+
+> `const` **AutomationActionFactory**: `Factory`\<[`IAutomationAction`](../interfaces/IAutomationAction.md)\>
+
+Factory for creating implementation of automation action types.

package/locales/en.json

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

package/package.json

@@ -0,0 +1,53 @@
+{
+	"name": "@twin.org/automation-models",
+	"version": "0.0.3-next.1",
+	"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",
+		"url": "git+https://github.com/twinfoundation/automation.git",
+		"directory": "packages/automation-models"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"dependencies": {
+		"@twin.org/core": "next",
+		"@twin.org/nameof": "next"
+	},
+	"main": "./dist/es/index.js",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/types/index.d.ts",
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
+		},
+		"./locales/*.json": "./locales/*.json"
+	},
+	"files": [
+		"dist/es",
+		"dist/types",
+		"locales",
+		"docs"
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"automation",
+		"storage",
+		"rest-api",
+		"models",
+		"types",
+		"schemas"
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/automation/issues"
+	},
+	"homepage": "https://twindev.org"
+}