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

package/docs/reference/interfaces/IDataProcessingRuleGroupListResponse.md

@@ -0,0 +1,23 @@
+# Interface: IDataProcessingRuleGroupListResponse
+
+Response for rule group entry list request.
+
+## Properties
+
+### body {#body}
+
+> **body**: `object`
+
+The response body containing the list of rule groups and optional pagination cursor.
+
+#### entities
+
+> **entities**: [`IRuleGroup`](IRuleGroup.md)[]
+
+The entities, which can be partial if a limited keys list was provided.
+
+#### cursor?
+
+> `optional` **cursor?**: `string`
+
+An optional cursor, when defined can be used to call find to get more entities.

package/docs/reference/interfaces/IDataProcessingRuleGroupRemoveRequest.md

@@ -0,0 +1,17 @@
+# Interface: IDataProcessingRuleGroupRemoveRequest
+
+Remove a rule group.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The path parameters for the request.
+
+#### id
+
+> **id**: `string`
+
+The id of the rule group to remove.

package/docs/reference/interfaces/IDataProcessingRuleGroupSetRequest.md

@@ -0,0 +1,37 @@
+# Interface: IDataProcessingRuleGroupSetRequest
+
+Set a rule group.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The path parameters for the request.
+
+#### id
+
+> **id**: `string`
+
+The id of the rule group to set.
+
+***
+
+### body {#body}
+
+> **body**: `object`
+
+The rule group data to store.
+
+#### label
+
+> **label**: `string`
+
+The label for the rule group.
+
+#### rules
+
+> **rules**: [`IRule`](IRule.md)[]
+
+The rules.

package/docs/reference/interfaces/IRule.md

@@ -0,0 +1,39 @@
+# Interface: IRule
+
+Rule defining how to extract data from an object.
+
+## Properties
+
+### source {#source}
+
+> **source**: `string`
+
+The JSONPath expression identifying the data to extract from the document.
+
+#### See
+
+https://www.rfc-editor.org/rfc/rfc9535.html
+
+***
+
+### target {#target}
+
+> **target**: `string`
+
+The target path of where to store the extracted data, using dotted or numeric index notation.
+
+***
+
+### retainPathDepth? {#retainpathdepth}
+
+> `optional` **retainPathDepth?**: `number`
+
+When extracting objects, how much of the original path should be maintained in the target object.
+
+***
+
+### coerce? {#coerce}
+
+> `optional` **coerce?**: `CoerceType`
+
+Should the data be coerced to a specific type.

package/docs/reference/interfaces/IRuleGroup.md

@@ -0,0 +1,27 @@
+# Interface: IRuleGroup
+
+Group of rules for extraction.
+
+## Properties
+
+### id {#id}
+
+> **id**: `string`
+
+The id for the rule group.
+
+***
+
+### label {#label}
+
+> **label**: `string`
+
+The label for the rule group.
+
+***
+
+### rules {#rules}
+
+> **rules**: [`IRule`](IRule.md)[]
+
+The rules.

package/docs/reference/variables/DataConverterConnectorFactory.md

@@ -0,0 +1,5 @@
+# Variable: DataConverterConnectorFactory
+
+> `const` **DataConverterConnectorFactory**: `Factory`\<[`IDataConverterConnector`](../interfaces/IDataConverterConnector.md)\>
+
+Factory for creating data converter connectors.

package/docs/reference/variables/DataExtractorConnectorFactory.md

@@ -0,0 +1,5 @@
+# Variable: DataExtractorConnectorFactory
+
+> `const` **DataExtractorConnectorFactory**: `Factory`\<[`IDataExtractorConnector`](../interfaces/IDataExtractorConnector.md)\>
+
+Factory for creating data extractor connectors.

package/locales/en.json

@@ -0,0 +1 @@
+{}

package/package.json

@@ -1,6 +1,54 @@
 {
-  "name": "@3sixty/data-processing-models",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+	"name": "@3sixty/data-processing-models",
+	"version": "0.20.0-next.0",
+	"description": "Shared data models and schema definitions for processing pipelines",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/3sixtyglobal/data-processing.git",
+		"directory": "packages/data-processing-models"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=24.0.0"
+	},
+	"dependencies": {
+		"@3sixty/core": "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",
+		"data-processing",
+		"data",
+		"processing",
+		"transformation",
+		"conversion",
+		"models",
+		"types",
+		"schemas"
+	],
+	"bugs": {
+		"url": "git+https://github.com/3sixtyglobal/data-processing/issues"
+	},
+	"homepage": "https://3sixty.global"
+}