@3sixty/data-processing-models 0.0.0-stage → 0.20.0-next.0

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

@@ -1,3 +1,25 @@
-# Temporary Holding Version
+# 3Sixty Data Processing Models
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Shared data models and schema definitions for processing pipelines.
+
+## Installation
+
+```shell
+npm install @3sixty/data-processing-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)
+
+## Origin
+
+This package is derived from the original [iotaledger/twin-data-processing](https://github.com/iotaledger/twin-data-processing/tree/next/packages/data-processing-models) repository.

package/dist/es/factories/dataConverterConnectorFactory.js

@@ -0,0 +1,9 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Factory } from "@3sixty/core";
+/**
+ * Factory for creating data converter connectors.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const DataConverterConnectorFactory = Factory.createFactory("data-converter", true);
+//# sourceMappingURL=dataConverterConnectorFactory.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"dataConverterConnectorFactory.js","sourceRoot":"","sources":["../../../src/factories/dataConverterConnectorFactory.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAGvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,6BAA6B,GAAG,OAAO,CAAC,aAAa,CACjE,gBAAgB,EAChB,IAAI,CACJ,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Factory } from \"@3sixty/core\";\nimport type { IDataConverterConnector } from \"../models/IDataConverterConnector.js\";\n\n/**\n * Factory for creating data converter connectors.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const DataConverterConnectorFactory = Factory.createFactory<IDataConverterConnector>(\n\t\"data-converter\",\n\ttrue\n);\n"]}

package/dist/es/factories/dataExtractorConnectorFactory.js

@@ -0,0 +1,9 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Factory } from "@3sixty/core";
+/**
+ * Factory for creating data extractor connectors.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const DataExtractorConnectorFactory = Factory.createFactory("data-extractor");
+//# sourceMappingURL=dataExtractorConnectorFactory.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"dataExtractorConnectorFactory.js","sourceRoot":"","sources":["../../../src/factories/dataExtractorConnectorFactory.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAGvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,6BAA6B,GACzC,OAAO,CAAC,aAAa,CAA0B,gBAAgB,CAAC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Factory } from \"@3sixty/core\";\nimport type { IDataExtractorConnector } from \"../models/IDataExtractorConnector.js\";\n\n/**\n * Factory for creating data extractor connectors.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const DataExtractorConnectorFactory =\n\tFactory.createFactory<IDataExtractorConnector>(\"data-extractor\");\n"]}

package/dist/es/index.js

@@ -0,0 +1,20 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./factories/dataConverterConnectorFactory.js";
+export * from "./factories/dataExtractorConnectorFactory.js";
+export * from "./models/api/IDataProcessingConvertRequest.js";
+export * from "./models/api/IDataProcessingConvertResponse.js";
+export * from "./models/api/IDataProcessingExtractRequest.js";
+export * from "./models/api/IDataProcessingExtractResponse.js";
+export * from "./models/api/IDataProcessingRuleGroupGetRequest.js";
+export * from "./models/api/IDataProcessingRuleGroupGetResponse.js";
+export * from "./models/api/IDataProcessingRuleGroupListRequest.js";
+export * from "./models/api/IDataProcessingRuleGroupListResponse.js";
+export * from "./models/api/IDataProcessingRuleGroupRemoveRequest.js";
+export * from "./models/api/IDataProcessingRuleGroupSetRequest.js";
+export * from "./models/IDataConverterConnector.js";
+export * from "./models/IDataProcessingComponent.js";
+export * from "./models/IDataExtractorConnector.js";
+export * from "./models/IRule.js";
+export * from "./models/IRuleGroup.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,8CAA8C,CAAC;AAC7D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,+CAA+C,CAAC;AAC9D,cAAc,gDAAgD,CAAC;AAC/D,cAAc,+CAA+C,CAAC;AAC9D,cAAc,gDAAgD,CAAC;AAC/D,cAAc,oDAAoD,CAAC;AACnE,cAAc,qDAAqD,CAAC;AACpE,cAAc,qDAAqD,CAAC;AACpE,cAAc,sDAAsD,CAAC;AACrE,cAAc,uDAAuD,CAAC;AACtE,cAAc,oDAAoD,CAAC;AACnE,cAAc,qCAAqC,CAAC;AACpD,cAAc,sCAAsC,CAAC;AACrD,cAAc,qCAAqC,CAAC;AACpD,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./factories/dataConverterConnectorFactory.js\";\nexport * from \"./factories/dataExtractorConnectorFactory.js\";\nexport * from \"./models/api/IDataProcessingConvertRequest.js\";\nexport * from \"./models/api/IDataProcessingConvertResponse.js\";\nexport * from \"./models/api/IDataProcessingExtractRequest.js\";\nexport * from \"./models/api/IDataProcessingExtractResponse.js\";\nexport * from \"./models/api/IDataProcessingRuleGroupGetRequest.js\";\nexport * from \"./models/api/IDataProcessingRuleGroupGetResponse.js\";\nexport * from \"./models/api/IDataProcessingRuleGroupListRequest.js\";\nexport * from \"./models/api/IDataProcessingRuleGroupListResponse.js\";\nexport * from \"./models/api/IDataProcessingRuleGroupRemoveRequest.js\";\nexport * from \"./models/api/IDataProcessingRuleGroupSetRequest.js\";\nexport * from \"./models/IDataConverterConnector.js\";\nexport * from \"./models/IDataProcessingComponent.js\";\nexport * from \"./models/IDataExtractorConnector.js\";\nexport * from \"./models/IRule.js\";\nexport * from \"./models/IRuleGroup.js\";\n"]}

package/dist/es/models/IDataConverterConnector.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IDataConverterConnector.js","sourceRoot":"","sources":["../../../src/models/IDataConverterConnector.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@3sixty/core\";\n\n/**\n * Interface describing a connector for converting data.\n */\nexport interface IDataConverterConnector extends IComponent {\n\t/**\n\t * Returns the MIME types that this connector can convert.\n\t * @returns The supported MIME type strings.\n\t */\n\tmimeTypes(): string[];\n\n\t/**\n\t * Converts the data to a structured object.\n\t * @param data The binary data to convert.\n\t * @returns The parsed structured object.\n\t */\n\tconvert(data: Uint8Array): Promise<unknown>;\n}\n"]}

package/dist/es/models/IDataExtractorConnector.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IDataExtractorConnector.js","sourceRoot":"","sources":["../../../src/models/IDataExtractorConnector.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@3sixty/core\";\nimport type { IRule } from \"./IRule.js\";\n\n/**\n * Interface describing a connector for extracting data.\n */\nexport interface IDataExtractorConnector extends IComponent {\n\t/**\n\t * Extracts data from the provided input.\n\t * @param data The object to extract from.\n\t * @param rules The rules to use to extract the data.\n\t * @returns The extracted data.\n\t */\n\textract(data: unknown, rules: IRule[]): Promise<unknown>;\n}\n"]}

package/dist/es/models/IDataProcessingComponent.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IDataProcessingComponent.js","sourceRoot":"","sources":["../../../src/models/IDataProcessingComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@3sixty/core\";\nimport type { IRuleGroup } from \"./IRuleGroup.js\";\n\n/**\n * Interface describing a component for processing data.\n */\nexport interface IDataProcessingComponent extends IComponent {\n\t/**\n\t * Set an extraction rule group.\n\t * @param ruleGroup The rule group to store.\n\t * @returns A promise that resolves when the rule group has been stored.\n\t */\n\truleGroupSet(ruleGroup: IRuleGroup): Promise<void>;\n\n\t/**\n\t * Get a rule group for extraction.\n\t * @param ruleGroupId The id of the rule group to get.\n\t * @returns The rule group.\n\t */\n\truleGroupGet(ruleGroupId: string): Promise<IRuleGroup>;\n\n\t/**\n\t * Remove a rule group.\n\t * @param ruleGroupId The id of the rule group to remove.\n\t * @returns A promise that resolves when the rule group has been removed.\n\t */\n\truleGroupRemove(ruleGroupId: string): Promise<void>;\n\n\t/**\n\t * Extracts data from the provided input.\n\t * @param ruleGroupId The id of the rule group to use to extract data.\n\t * @param data The data to extract from.\n\t * @param overrideExtractorType An optional override for the extractor type.\n\t * @param overrideMimeType An optional override for the mime type for conversion, will auto detect if not provided.\n\t * @returns The extracted data.\n\t */\n\textract(\n\t\truleGroupId: string,\n\t\tdata: Uint8Array,\n\t\toverrideExtractorType?: string,\n\t\toverrideMimeType?: string\n\t): Promise<unknown>;\n\n\t/**\n\t * Converts data from the provided input to a structured JSON document.\n\t * @param data The data to convert.\n\t * @param overrideMimeType An optional override for the mime type, will auto detect if empty.\n\t * @returns The converted data.\n\t */\n\tconvert(data: Uint8Array, overrideMimeType?: string): Promise<unknown>;\n\n\t/**\n\t * Query the rule group entries.\n\t * @param cursor The cursor to request the next chunk of entities.\n\t * @param limit Limit the number of entities to return.\n\t * @returns All the entities for the storage matching the conditions,\n\t * and a cursor which can be used to request more entities.\n\t */\n\tquery(\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{\n\t\t/**\n\t\t * The entities, which can be partial if a limited keys list was provided.\n\t\t */\n\t\tentities: IRuleGroup[];\n\t\t/**\n\t\t * An optional cursor, when defined can be used to call find to get more entities.\n\t\t */\n\t\tcursor?: string;\n\t}>;\n}\n"]}

package/dist/es/models/IExtractRule.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IExtractRule.js","sourceRoot":"","sources":["../../../src/models/IExtractRule.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { CoerceType } from \"@3sixty/core\";\n\n/**\n * Definition for the data to extract.\n */\nexport interface IExtractRule {\n\t/**\n\t * The JSONPath expression identifying the data to extract from the document.\n\t * @see https://www.rfc-editor.org/rfc/rfc9535.html\n\t */\n\tsource: string;\n\n\t/**\n\t * The target path of where to store the extracted data, using dotted or numeric index notation.\n\t */\n\ttarget: string;\n\n\t/**\n\t * When extracting objects, should the path be maintained in the target object.\n\t */\n\tmaintainNestingDepth?: number;\n\n\t/**\n\t * Should the data be coerced to a specific type.\n\t */\n\tcoerce?: CoerceType;\n}\n"]}

package/dist/es/models/IRule.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IRule.js","sourceRoot":"","sources":["../../../src/models/IRule.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { CoerceType } from \"@3sixty/core\";\n\n/**\n * Rule defining how to extract data from an object.\n */\nexport interface IRule {\n\t/**\n\t * The JSONPath expression identifying the data to extract from the document.\n\t * @see https://www.rfc-editor.org/rfc/rfc9535.html\n\t */\n\tsource: string;\n\n\t/**\n\t * The target path of where to store the extracted data, using dotted or numeric index notation.\n\t */\n\ttarget: string;\n\n\t/**\n\t * When extracting objects, how much of the original path should be maintained in the target object.\n\t */\n\tretainPathDepth?: number;\n\n\t/**\n\t * Should the data be coerced to a specific type.\n\t */\n\tcoerce?: CoerceType;\n}\n"]}

package/dist/es/models/IRuleGroup.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IRuleGroup.js","sourceRoot":"","sources":["../../../src/models/IRuleGroup.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IRule } from \"./IRule.js\";\n\n/**\n * Group of rules for extraction.\n */\nexport interface IRuleGroup {\n\t/**\n\t * The id for the rule group.\n\t */\n\tid: string;\n\n\t/**\n\t * The label for the rule group.\n\t */\n\tlabel: string;\n\n\t/**\n\t * The rules.\n\t */\n\trules: IRule[];\n}\n"]}

package/dist/es/models/IStructuredData.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IStructuredData.js","sourceRoot":"","sources":["../../../src/models/IStructuredData.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Definition for the structured data.\n */\nexport interface IStructuredData {\n\t/**\n\t * The MIME type of the data.\n\t */\n\tsourceMimeType: string;\n\n\t/**\n\t * The structured object.\n\t */\n\tobject: unknown;\n}\n"]}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IDataProcessingConvertRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IDataProcessingConvertRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Perform a conversion on the data.\n */\nexport interface IDataProcessingConvertRequest {\n\t/**\n\t * The request body containing the data to convert.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The binary data to convert in base64.\n\t\t */\n\t\tdata: string;\n\n\t\t/**\n\t\t * Use the specified mime type for conversion, will auto detect if undefined.\n\t\t */\n\t\toverrideMimeType?: string;\n\t};\n}\n"]}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IDataProcessingConvertResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IDataProcessingConvertResponse.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Response to converting data.\n */\nexport interface IDataProcessingConvertResponse {\n\t/**\n\t * The converted data as an object.\n\t */\n\tbody: unknown;\n}\n"]}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IDataProcessingExtractRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IDataProcessingExtractRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Perform an extraction on the data with the specified ruleset.\n */\nexport interface IDataProcessingExtractRequest {\n\t/**\n\t * The request body containing the data and rule group to use for extraction.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The rule group id to use for the extraction.\n\t\t */\n\t\truleGroupId: string;\n\n\t\t/**\n\t\t * The binary data to extract from in base64.\n\t\t */\n\t\tdata: string;\n\n\t\t/**\n\t\t * The default extractor connector will be used if not specified.\n\t\t */\n\t\toverrideExtractorType?: string;\n\n\t\t/**\n\t\t * An optional override for the mime type for conversion, will auto detect if not provided.\n\t\t */\n\t\toverrideMimeType?: string;\n\t};\n}\n"]}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IDataProcessingExtractResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IDataProcessingExtractResponse.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Response to extracting data.\n */\nexport interface IDataProcessingExtractResponse {\n\t/**\n\t * The extracted data in extended JSON format, preserving types such as bigint, dates, and Uint8Array.\n\t */\n\tbody: unknown;\n}\n"]}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IDataProcessingRuleGroupGetRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IDataProcessingRuleGroupGetRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Get a rule group.\n */\nexport interface IDataProcessingRuleGroupGetRequest {\n\t/**\n\t * The path parameters for the request.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The id of the rule group to retrieve.\n\t\t */\n\t\tid: string;\n\t};\n}\n"]}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IDataProcessingRuleGroupGetResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IDataProcessingRuleGroupGetResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IRuleGroup } from \"../IRuleGroup.js\";\n\n/**\n * Get a rule group response.\n */\nexport interface IDataProcessingRuleGroupGetResponse {\n\t/**\n\t * The rule group data.\n\t */\n\tbody: IRuleGroup;\n}\n"]}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IDataProcessingRuleGroupListRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IDataProcessingRuleGroupListRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Get a list of the rule group entries.\n */\nexport interface IDataProcessingRuleGroupListRequest {\n\t/**\n\t * The query parameters.\n\t */\n\tquery?: {\n\t\t/**\n\t\t * The optional cursor to get next chunk.\n\t\t */\n\t\tcursor?: string;\n\n\t\t/**\n\t\t * Limit the number of entities to return.\n\t\t */\n\t\tlimit?: string;\n\t};\n}\n"]}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IDataProcessingRuleGroupListResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IDataProcessingRuleGroupListResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IRuleGroup } from \"../IRuleGroup.js\";\n\n/**\n * Response for rule group entry list request.\n */\nexport interface IDataProcessingRuleGroupListResponse {\n\t/**\n\t * The response body containing the list of rule groups and optional pagination cursor.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The entities, which can be partial if a limited keys list was provided.\n\t\t */\n\t\tentities: IRuleGroup[];\n\n\t\t/**\n\t\t * An optional cursor, when defined can be used to call find to get more entities.\n\t\t */\n\t\tcursor?: string;\n\t};\n}\n"]}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IDataProcessingRuleGroupRemoveRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IDataProcessingRuleGroupRemoveRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Remove a rule group.\n */\nexport interface IDataProcessingRuleGroupRemoveRequest {\n\t/**\n\t * The path parameters for the request.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The id of the rule group to remove.\n\t\t */\n\t\tid: string;\n\t};\n}\n"]}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IDataProcessingRuleGroupSetRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IDataProcessingRuleGroupSetRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IRule } from \"../IRule.js\";\n\n/**\n * Set a rule group.\n */\nexport interface IDataProcessingRuleGroupSetRequest {\n\t/**\n\t * The path parameters for the request.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The id of the rule group to set.\n\t\t */\n\t\tid: string;\n\t};\n\n\t/**\n\t * The rule group data to store.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The label for the rule group.\n\t\t */\n\t\tlabel: string;\n\n\t\t/**\n\t\t * The rules.\n\t\t */\n\t\trules: IRule[];\n\t};\n}\n"]}

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

@@ -0,0 +1,6 @@
+import { Factory } from "@3sixty/core";
+import type { IDataConverterConnector } from "../models/IDataConverterConnector.js";
+/**
+ * Factory for creating data converter connectors.
+ */
+export declare const DataConverterConnectorFactory: Factory<IDataConverterConnector>;

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

@@ -0,0 +1,6 @@
+import { Factory } from "@3sixty/core";
+import type { IDataExtractorConnector } from "../models/IDataExtractorConnector.js";
+/**
+ * Factory for creating data extractor connectors.
+ */
+export declare const DataExtractorConnectorFactory: Factory<IDataExtractorConnector>;

package/dist/types/index.d.ts

@@ -0,0 +1,17 @@
+export * from "./factories/dataConverterConnectorFactory.js";
+export * from "./factories/dataExtractorConnectorFactory.js";
+export * from "./models/api/IDataProcessingConvertRequest.js";
+export * from "./models/api/IDataProcessingConvertResponse.js";
+export * from "./models/api/IDataProcessingExtractRequest.js";
+export * from "./models/api/IDataProcessingExtractResponse.js";
+export * from "./models/api/IDataProcessingRuleGroupGetRequest.js";
+export * from "./models/api/IDataProcessingRuleGroupGetResponse.js";
+export * from "./models/api/IDataProcessingRuleGroupListRequest.js";
+export * from "./models/api/IDataProcessingRuleGroupListResponse.js";
+export * from "./models/api/IDataProcessingRuleGroupRemoveRequest.js";
+export * from "./models/api/IDataProcessingRuleGroupSetRequest.js";
+export * from "./models/IDataConverterConnector.js";
+export * from "./models/IDataProcessingComponent.js";
+export * from "./models/IDataExtractorConnector.js";
+export * from "./models/IRule.js";
+export * from "./models/IRuleGroup.js";

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

@@ -0,0 +1,17 @@
+import type { IComponent } from "@3sixty/core";
+/**
+ * Interface describing a connector for converting data.
+ */
+export interface IDataConverterConnector extends IComponent {
+    /**
+     * Returns the MIME types that this connector can convert.
+     * @returns The supported MIME type strings.
+     */
+    mimeTypes(): string[];
+    /**
+     * Converts the data to a structured object.
+     * @param data The binary data to convert.
+     * @returns The parsed structured object.
+     */
+    convert(data: Uint8Array): Promise<unknown>;
+}

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

@@ -0,0 +1,14 @@
+import type { IComponent } from "@3sixty/core";
+import type { IRule } from "./IRule.js";
+/**
+ * Interface describing a connector for extracting data.
+ */
+export interface IDataExtractorConnector extends IComponent {
+    /**
+     * Extracts data from the provided input.
+     * @param data The object to extract from.
+     * @param rules The rules to use to extract the data.
+     * @returns The extracted data.
+     */
+    extract(data: unknown, rules: IRule[]): Promise<unknown>;
+}

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

@@ -0,0 +1,58 @@
+import type { IComponent } from "@3sixty/core";
+import type { IRuleGroup } from "./IRuleGroup.js";
+/**
+ * Interface describing a component for processing data.
+ */
+export interface IDataProcessingComponent extends IComponent {
+    /**
+     * Set an extraction rule group.
+     * @param ruleGroup The rule group to store.
+     * @returns A promise that resolves when the rule group has been stored.
+     */
+    ruleGroupSet(ruleGroup: IRuleGroup): Promise<void>;
+    /**
+     * Get a rule group for extraction.
+     * @param ruleGroupId The id of the rule group to get.
+     * @returns The rule group.
+     */
+    ruleGroupGet(ruleGroupId: string): Promise<IRuleGroup>;
+    /**
+     * Remove a rule group.
+     * @param ruleGroupId The id of the rule group to remove.
+     * @returns A promise that resolves when the rule group has been removed.
+     */
+    ruleGroupRemove(ruleGroupId: string): Promise<void>;
+    /**
+     * Extracts data from the provided input.
+     * @param ruleGroupId The id of the rule group to use to extract data.
+     * @param data The data to extract from.
+     * @param overrideExtractorType An optional override for the extractor type.
+     * @param overrideMimeType An optional override for the mime type for conversion, will auto detect if not provided.
+     * @returns The extracted data.
+     */
+    extract(ruleGroupId: string, data: Uint8Array, overrideExtractorType?: string, overrideMimeType?: string): Promise<unknown>;
+    /**
+     * Converts data from the provided input to a structured JSON document.
+     * @param data The data to convert.
+     * @param overrideMimeType An optional override for the mime type, will auto detect if empty.
+     * @returns The converted data.
+     */
+    convert(data: Uint8Array, overrideMimeType?: string): Promise<unknown>;
+    /**
+     * Query the rule group entries.
+     * @param cursor The cursor to request the next chunk of entities.
+     * @param limit Limit the number of entities to return.
+     * @returns All the entities for the storage matching the conditions,
+     * and a cursor which can be used to request more entities.
+     */
+    query(cursor?: string, limit?: number): Promise<{
+        /**
+         * The entities, which can be partial if a limited keys list was provided.
+         */
+        entities: IRuleGroup[];
+        /**
+         * An optional cursor, when defined can be used to call find to get more entities.
+         */
+        cursor?: string;
+    }>;
+}

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

@@ -0,0 +1,23 @@
+import type { CoerceType } from "@3sixty/core";
+/**
+ * Definition for the data to extract.
+ */
+export interface IExtractRule {
+    /**
+     * The JSONPath expression identifying the data to extract from the document.
+     * @see https://www.rfc-editor.org/rfc/rfc9535.html
+     */
+    source: string;
+    /**
+     * The target path of where to store the extracted data, using dotted or numeric index notation.
+     */
+    target: string;
+    /**
+     * When extracting objects, should the path be maintained in the target object.
+     */
+    maintainNestingDepth?: number;
+    /**
+     * Should the data be coerced to a specific type.
+     */
+    coerce?: CoerceType;
+}