@twin.org/hierarchies-models 0.9.0-next.1

package/docs/reference/interfaces/IHierarchiesPropertiesValidateRequest.md

@@ -0,0 +1,41 @@
+# Interface: IHierarchiesPropertiesValidateRequest
+
+Request to validate properties for a federation.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The request path parameters.
+
+#### federationId
+
+> **federationId**: `string`
+
+The id of the federation.
+
+***
+
+### body {#body}
+
+> **body**: `object`
+
+The request data.
+
+#### accreditedById
+
+> **accreditedById**: `string`
+
+The accredited by id.
+
+#### propertiesToValidate
+
+> **propertiesToValidate**: `object`
+
+The properties to validate.
+
+##### Index Signature
+
+\[`propertyName`: `string`\]: [`IPropertyValue`](IPropertyValue.md)

package/docs/reference/interfaces/IHierarchiesPropertiesValidateResponse.md

@@ -0,0 +1,17 @@
+# Interface: IHierarchiesPropertiesValidateResponse
+
+Response for properties validation.
+
+## Properties
+
+### body {#body}
+
+> **body**: `object`
+
+The response body.
+
+#### valid
+
+> **valid**: `boolean`
+
+Whether all provided properties are valid.

package/docs/reference/interfaces/IHierarchiesPropertyAddRequest.md

@@ -0,0 +1,25 @@
+# Interface: IHierarchiesPropertyAddRequest
+
+Request to add a property to a federation.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The request path parameters.
+
+#### federationId
+
+> **federationId**: `string`
+
+The id of the federation.
+
+***
+
+### body {#body}
+
+> **body**: [`IProperty`](IProperty.md)
+
+The request data.

package/docs/reference/interfaces/IHierarchiesPropertyGetRequest.md

@@ -0,0 +1,23 @@
+# Interface: IHierarchiesPropertyGetRequest
+
+Request to get a property from a federation.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The request path parameters.
+
+#### federationId
+
+> **federationId**: `string`
+
+The id of the federation.
+
+#### propertyName
+
+> **propertyName**: `string`
+
+The property name to get.

package/docs/reference/interfaces/IHierarchiesPropertyGetResponse.md

@@ -0,0 +1,11 @@
+# Interface: IHierarchiesPropertyGetResponse
+
+Response for getting a property.
+
+## Properties
+
+### body {#body}
+
+> **body**: [`IProperty`](IProperty.md)
+
+The response body.

package/docs/reference/interfaces/IHierarchiesPropertyRemoveRequest.md

@@ -0,0 +1,23 @@
+# Interface: IHierarchiesPropertyRemoveRequest
+
+Request to remove a property from a federation.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The request path parameters.
+
+#### federationId
+
+> **federationId**: `string`
+
+The id of the federation.
+
+#### propertyName
+
+> **propertyName**: `string`
+
+The property name to remove.

package/docs/reference/interfaces/IHierarchiesPropertyValidateRequest.md

@@ -0,0 +1,43 @@
+# Interface: IHierarchiesPropertyValidateRequest
+
+Request to validate a property for a federation.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The request path parameters.
+
+#### federationId
+
+> **federationId**: `string`
+
+The id of the federation.
+
+***
+
+### body {#body}
+
+> **body**: `object`
+
+The request data.
+
+#### accreditedById
+
+> **accreditedById**: `string`
+
+The accredited by id.
+
+#### propertyName
+
+> **propertyName**: `string`
+
+The property name to validate.
+
+#### propertyValue
+
+> **propertyValue**: [`IPropertyValue`](IPropertyValue.md)
+
+The property value to validate.

package/docs/reference/interfaces/IHierarchiesPropertyValidateResponse.md

@@ -0,0 +1,17 @@
+# Interface: IHierarchiesPropertyValidateResponse
+
+Response for property validation.
+
+## Properties
+
+### body {#body}
+
+> **body**: `object`
+
+The response body.
+
+#### valid
+
+> **valid**: `boolean`
+
+Whether the provided property is valid.

package/docs/reference/interfaces/IProperty.md

@@ -0,0 +1,35 @@
+# Interface: IProperty
+
+Represents a named property with optional allowed values, a condition, and a validity timespan.
+
+## Properties
+
+### name {#name}
+
+> **name**: `string`
+
+The property name, can be dotted form.
+
+***
+
+### allowedValues? {#allowedvalues}
+
+> `optional` **allowedValues?**: [`IPropertyValue`](IPropertyValue.md)[]
+
+The allowed values for this property, if empty, any value is allowed.
+
+***
+
+### condition? {#condition}
+
+> `optional` **condition?**: [`IPropertyCondition`](IPropertyCondition.md)
+
+The condition for this property.
+
+***
+
+### timespan? {#timespan}
+
+> `optional` **timespan?**: [`ITimespan`](ITimespan.md)
+
+The timespan for this property.

package/docs/reference/interfaces/IPropertyCondition.md

@@ -0,0 +1,27 @@
+# Interface: IPropertyCondition
+
+Describes the condition and constraints of a property within a hierarchy.
+
+## Properties
+
+### type {#type}
+
+> **type**: [`PropertyType`](../type-aliases/PropertyType.md)
+
+The property type.
+
+***
+
+### value {#value}
+
+> **value**: `string`
+
+The property value.
+
+***
+
+### constraint? {#constraint}
+
+> `optional` **constraint?**: [`PropertyConstraintType`](../type-aliases/PropertyConstraintType.md)
+
+The constraint for this property.

package/docs/reference/interfaces/IPropertyValue.md

@@ -0,0 +1,19 @@
+# Interface: IPropertyValue
+
+Describes the value of a property.
+
+## Properties
+
+### type {#type}
+
+> **type**: [`PropertyType`](../type-aliases/PropertyType.md)
+
+The property type.
+
+***
+
+### value {#value}
+
+> **value**: `string`
+
+The property value.

package/docs/reference/interfaces/IRootAuthority.md

@@ -0,0 +1,19 @@
+# Interface: IRootAuthority
+
+Represents a root authority in a federation hierarchy.
+
+## Properties
+
+### id {#id}
+
+> **id**: `string`
+
+The ID of the root authority.
+
+***
+
+### accountId {#accountid}
+
+> **accountId**: `string`
+
+The account ID of the root authority.

package/docs/reference/interfaces/ITimespan.md

@@ -0,0 +1,19 @@
+# Interface: ITimespan
+
+Represents a timespan in a federation hierarchy.
+
+## Properties
+
+### validFrom? {#validfrom}
+
+> `optional` **validFrom?**: `string`
+
+Valid from as bigint string so it can be serialized accurately.
+
+***
+
+### validTo? {#validto}
+
+> `optional` **validTo?**: `string`
+
+Valid to as bigint string so it can be serialized accurately.

package/docs/reference/type-aliases/PropertyConstraintType.md

@@ -0,0 +1,5 @@
+# Type Alias: PropertyConstraintType
+
+> **PropertyConstraintType** = *typeof* [`PropertyConstraintType`](../variables/PropertyConstraintType.md)\[keyof *typeof* [`PropertyConstraintType`](../variables/PropertyConstraintType.md)\]
+
+Type representing the possible condition types.

package/docs/reference/type-aliases/PropertyType.md

@@ -0,0 +1,5 @@
+# Type Alias: PropertyType
+
+> **PropertyType** = *typeof* [`PropertyType`](../variables/PropertyType.md)\[keyof *typeof* [`PropertyType`](../variables/PropertyType.md)\]
+
+Type representing the possible property types.

package/docs/reference/variables/HierarchiesConnectorFactory.md

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

package/docs/reference/variables/PropertyConstraintType.md

@@ -0,0 +1,37 @@
+# Variable: PropertyConstraintType
+
+> `const` **PropertyConstraintType**: `object`
+
+Defines the types of constraints that can be applied to federation properties.
+
+## Type Declaration
+
+### Contains {#contains}
+
+> `readonly` **Contains**: `"Contains"` = `"Contains"`
+
+Value must contain a specific substring.
+
+### StartsWith {#startswith}
+
+> `readonly` **StartsWith**: `"StartsWith"` = `"StartsWith"`
+
+Value must start with a specific substring.
+
+### EndsWith {#endswith}
+
+> `readonly` **EndsWith**: `"EndsWith"` = `"EndsWith"`
+
+Value must end with a specific substring.
+
+### GreaterThan {#greaterthan}
+
+> `readonly` **GreaterThan**: `"GreaterThan"` = `"GreaterThan"`
+
+Value must be greater than a specific value.
+
+### LessThan {#lessthan}
+
+> `readonly` **LessThan**: `"LessThan"` = `"LessThan"`
+
+Value must be less than a specific value.

package/docs/reference/variables/PropertyType.md

@@ -0,0 +1,19 @@
+# Variable: PropertyType
+
+> `const` **PropertyType**: `object`
+
+Defines the supported data types for property values.
+
+## Type Declaration
+
+### String {#string}
+
+> `readonly` **String**: `"String"` = `"String"`
+
+Value is a string.
+
+### BigInt {#bigint}
+
+> `readonly` **BigInt**: `"BigInt"` = `"BigInt"`
+
+Value is a bigint.

package/locales/en.json

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

package/package.json

@@ -0,0 +1,53 @@
+{
+	"name": "@twin.org/hierarchies-models",
+	"version": "0.9.0-next.1",
+	"description": "Shared interfaces, request and response models, and connector contracts.",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/iotaledger/twin-hierarchies.git",
+		"directory": "packages/hierarchies-models"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"dependencies": {
+		"@twin.org/core": "0.9.0-next.1",
+		"@twin.org/nameof": "0.9.0-next.1",
+		"@twin.org/web": "0.9.0-next.1"
+	},
+	"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"
+		}
+	},
+	"files": [
+		"dist/es",
+		"dist/types",
+		"locales",
+		"docs"
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"hierarchies",
+		"tokens",
+		"assets",
+		"models",
+		"types",
+		"schemas"
+	],
+	"bugs": {
+		"url": "git+https://github.com/iotaledger/twin-hierarchies/issues"
+	},
+	"homepage": "https://twindev.org"
+}