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

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

@@ -0,0 +1,22 @@
+/**
+ * Request to get federation accreditation.
+ */
+export interface IHierarchiesAccreditationGetRequest {
+    /**
+     * The request path parameters.
+     */
+    pathParams: {
+        /**
+         * The id of the federation to get.
+         */
+        federationId: string;
+        /**
+         * The id of the authority for which to get the accreditation.
+         */
+        accreditedById: string;
+        /**
+         * The id of the permission for which to get the accreditation.
+         */
+        permissionId: string;
+    };
+}

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

@@ -0,0 +1,10 @@
+import type { IAccreditation } from "../IAccreditation.js";
+/**
+ * Response for getting an accreditation.
+ */
+export interface IHierarchiesAccreditationGetResponse {
+    /**
+     * The response body.
+     */
+    body: IAccreditation;
+}

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

@@ -0,0 +1,22 @@
+/**
+ * Request to remove an accreditation from a federation.
+ */
+export interface IHierarchiesAccreditationRemoveRequest {
+    /**
+     * The request path parameters.
+     */
+    pathParams: {
+        /**
+         * The id of the federation.
+         */
+        federationId: string;
+        /**
+         * The accredited by id.
+         */
+        accreditedById: string;
+        /**
+         * The permission id of the accreditation to remove.
+         */
+        permissionId: string;
+    };
+}

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

@@ -0,0 +1,18 @@
+/**
+ * Request to get federation accreditations.
+ */
+export interface IHierarchiesAccreditationsGetRequest {
+    /**
+     * The request path parameters.
+     */
+    pathParams: {
+        /**
+         * The id of the federation to get.
+         */
+        federationId: string;
+        /**
+         * The id of the authority for which to get the accreditations.
+         */
+        accreditedById: string;
+    };
+}

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

@@ -0,0 +1,10 @@
+import type { IAccreditation } from "../IAccreditation.js";
+/**
+ * Response for getting accreditations.
+ */
+export interface IHierarchiesAccreditationsGetResponse {
+    /**
+     * The response body.
+     */
+    body: IAccreditation[];
+}

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

@@ -0,0 +1,23 @@
+/**
+ * Request to add an authority to a federation.
+ */
+export interface IHierarchiesAuthorityAddRequest {
+    /**
+     * The request path parameters.
+     */
+    pathParams: {
+        /**
+         * The id of the federation.
+         */
+        federationId: string;
+    };
+    /**
+     * The request data.
+     */
+    body: {
+        /**
+         * The account id of the authority to add.
+         */
+        accountId: string;
+    };
+}

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

@@ -0,0 +1,18 @@
+/**
+ * Request to remove an authority from a federation.
+ */
+export interface IHierarchiesAuthorityRemoveRequest {
+    /**
+     * The request path parameters.
+     */
+    pathParams: {
+        /**
+         * The id of the federation.
+         */
+        federationId: string;
+        /**
+         * The account id of the authority to remove.
+         */
+        accountId: string;
+    };
+}

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

@@ -0,0 +1,18 @@
+/**
+ * Request to create a federation.
+ */
+export interface IHierarchiesFederationCreateRequest {
+    /**
+     * The request data.
+     */
+    body: {
+        /**
+         * The root authorities to be included in the federation.
+         */
+        rootAuthorities?: string[];
+        /**
+         * The namespace of the connector to use for the federation, defaults to component configured namespace.
+         */
+        namespace?: string;
+    };
+}

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

@@ -0,0 +1,23 @@
+/**
+ * Request to get a federation.
+ */
+export interface IHierarchiesFederationGetRequest {
+    /**
+     * The request path parameters.
+     */
+    pathParams: {
+        /**
+         * The id of the federation to get.
+         */
+        federationId: string;
+    };
+    /**
+     * The request query parameters.
+     */
+    query?: {
+        /**
+         * Whether to include revoked properties in the retrieved federation, defaults to false.
+         */
+        includeRevokedProperties?: string;
+    };
+}

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

@@ -0,0 +1,10 @@
+import type { IFederation } from "../IFederation.js";
+/**
+ * Response for getting a federation.
+ */
+export interface IHierarchiesFederationGetResponse {
+    /**
+     * The response body.
+     */
+    body: IFederation;
+}

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

@@ -0,0 +1,23 @@
+/**
+ * Request to get federation properties.
+ */
+export interface IHierarchiesPropertiesGetRequest {
+    /**
+     * The request path parameters.
+     */
+    pathParams: {
+        /**
+         * The id of the federation to get.
+         */
+        federationId: string;
+    };
+    /**
+     * The request query parameters.
+     */
+    query?: {
+        /**
+         * Whether to include revoked properties in the retrieved federation, defaults to false.
+         */
+        includeRevokedProperties?: string;
+    };
+}

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

@@ -0,0 +1,10 @@
+import type { IProperty } from "../IProperty.js";
+/**
+ * Response for getting properties.
+ */
+export interface IHierarchiesPropertiesGetResponse {
+    /**
+     * The response body.
+     */
+    body: IProperty[];
+}

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

@@ -0,0 +1,30 @@
+import type { IPropertyValue } from "../IPropertyValue.js";
+/**
+ * Request to validate properties for a federation.
+ */
+export interface IHierarchiesPropertiesValidateRequest {
+    /**
+     * The request path parameters.
+     */
+    pathParams: {
+        /**
+         * The id of the federation.
+         */
+        federationId: string;
+    };
+    /**
+     * The request data.
+     */
+    body: {
+        /**
+         * The accredited by id.
+         */
+        accreditedById: string;
+        /**
+         * The properties to validate.
+         */
+        propertiesToValidate: {
+            [propertyName: string]: IPropertyValue;
+        };
+    };
+}

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

@@ -0,0 +1,14 @@
+/**
+ * Response for properties validation.
+ */
+export interface IHierarchiesPropertiesValidateResponse {
+    /**
+     * The response body.
+     */
+    body: {
+        /**
+         * Whether all provided properties are valid.
+         */
+        valid: boolean;
+    };
+}

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

@@ -0,0 +1,19 @@
+import type { IProperty } from "../IProperty.js";
+/**
+ * Request to add a property to a federation.
+ */
+export interface IHierarchiesPropertyAddRequest {
+    /**
+     * The request path parameters.
+     */
+    pathParams: {
+        /**
+         * The id of the federation.
+         */
+        federationId: string;
+    };
+    /**
+     * The request data.
+     */
+    body: IProperty;
+}

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

@@ -0,0 +1,18 @@
+/**
+ * Request to get a property from a federation.
+ */
+export interface IHierarchiesPropertyGetRequest {
+    /**
+     * The request path parameters.
+     */
+    pathParams: {
+        /**
+         * The id of the federation.
+         */
+        federationId: string;
+        /**
+         * The property name to get.
+         */
+        propertyName: string;
+    };
+}

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

@@ -0,0 +1,10 @@
+import type { IProperty } from "../IProperty.js";
+/**
+ * Response for getting a property.
+ */
+export interface IHierarchiesPropertyGetResponse {
+    /**
+     * The response body.
+     */
+    body: IProperty;
+}

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

@@ -0,0 +1,18 @@
+/**
+ * Request to remove a property from a federation.
+ */
+export interface IHierarchiesPropertyRemoveRequest {
+    /**
+     * The request path parameters.
+     */
+    pathParams: {
+        /**
+         * The id of the federation.
+         */
+        federationId: string;
+        /**
+         * The property name to remove.
+         */
+        propertyName: string;
+    };
+}

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

@@ -0,0 +1,32 @@
+import type { IPropertyValue } from "../IPropertyValue.js";
+/**
+ * Request to validate a property for a federation.
+ */
+export interface IHierarchiesPropertyValidateRequest {
+    /**
+     * The request path parameters.
+     */
+    pathParams: {
+        /**
+         * The id of the federation.
+         */
+        federationId: string;
+    };
+    /**
+     * The request data.
+     */
+    body: {
+        /**
+         * The accredited by id.
+         */
+        accreditedById: string;
+        /**
+         * The property name to validate.
+         */
+        propertyName: string;
+        /**
+         * The property value to validate.
+         */
+        propertyValue: IPropertyValue;
+    };
+}

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

@@ -0,0 +1,14 @@
+/**
+ * Response for property validation.
+ */
+export interface IHierarchiesPropertyValidateResponse {
+    /**
+     * The response body.
+     */
+    body: {
+        /**
+         * Whether the provided property is valid.
+         */
+        valid: boolean;
+    };
+}

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

@@ -0,0 +1,29 @@
+/**
+ * Defines the types of constraints that can be applied to federation properties.
+ */
+export declare const PropertyConstraintType: {
+    /**
+     * Value must contain a specific substring.
+     */
+    readonly Contains: "Contains";
+    /**
+     * Value must start with a specific substring.
+     */
+    readonly StartsWith: "StartsWith";
+    /**
+     * Value must end with a specific substring.
+     */
+    readonly EndsWith: "EndsWith";
+    /**
+     * Value must be greater than a specific value.
+     */
+    readonly GreaterThan: "GreaterThan";
+    /**
+     * Value must be less than a specific value.
+     */
+    readonly LessThan: "LessThan";
+};
+/**
+ * Type representing the possible condition types.
+ */
+export type PropertyConstraintType = (typeof PropertyConstraintType)[keyof typeof PropertyConstraintType];

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

@@ -0,0 +1,17 @@
+/**
+ * Defines the supported data types for property values.
+ */
+export declare const PropertyType: {
+    /**
+     * Value is a string.
+     */
+    readonly String: "String";
+    /**
+     * Value is a bigint.
+     */
+    readonly BigInt: "BigInt";
+};
+/**
+ * Type representing the possible property types.
+ */
+export type PropertyType = (typeof PropertyType)[keyof typeof PropertyType];

package/docs/changelog.md

@@ -0,0 +1,11 @@
+# Changelog
+
+## [0.9.0-next.1](https://github.com/iotaledger/twin-hierarchies/compare/hierarchies-models-v0.9.0-next.0...hierarchies-models-v0.9.0-next.1) (2026-06-23)
+
+
+### Features
+
+* initial commit ([ac40c22](https://github.com/iotaledger/twin-hierarchies/commit/ac40c2293568c8e08fd0a9b86c7ae54d202f8091))
+* typescript 6 update ([a9b3e37](https://github.com/iotaledger/twin-hierarchies/commit/a9b3e374df98413b2a98bccbd1bc95cf48a9e210))
+
+## Changelog

package/docs/examples.md

@@ -0,0 +1,74 @@
+# Hierarchies Models Examples
+
+This package provides interfaces and types for working with federations, properties, accreditations, and connector factories in digital asset hierarchies.
+
+## HierarchiesConnectorFactory
+
+```typescript
+import { HierarchiesConnectorFactory } from '@twin.org/hierarchies-models';
+
+// Register a connector implementation
+HierarchiesConnectorFactory.register('custom', () => new CustomHierarchiesConnector());
+
+// Create a connector instance
+const connector = HierarchiesConnectorFactory.create('custom');
+```
+
+## IHierarchiesConnector
+
+```typescript
+import type { IHierarchiesConnector, IProperty } from '@twin.org/hierarchies-models';
+
+async function addProperty(
+  connector: IHierarchiesConnector,
+  federationId: string,
+  property: IProperty
+) {
+  await connector.propertyAdd('controller-1', federationId, property);
+}
+
+async function getFederation(connector: IHierarchiesConnector, federationId: string) {
+  const federation = await connector.federationGet(federationId);
+  console.log(federation.id); // "fed-123"
+}
+```
+
+## IFederation
+
+```typescript
+import type { IFederation } from '@twin.org/hierarchies-models';
+
+function printRootAuthorities(federation: IFederation) {
+  federation.rootAuthorities.forEach(auth => {
+    console.log(auth.id); // "root-1"
+  });
+}
+```
+
+## IProperty
+
+```typescript
+import type { IProperty, IPropertyValue } from '@twin.org/hierarchies-models';
+import { PropertyType } from '@twin.org/hierarchies-models';
+
+const property: IProperty = {
+  name: 'access.level',
+  allowedValues: [{ type: PropertyType.String, value: 'admin' }]
+};
+
+const value: IPropertyValue = { type: PropertyType.String, value: 'admin' };
+console.log(property.allowedValues?.[0].value); // "admin"
+```
+
+## IAccreditation
+
+```typescript
+import type { IAccreditation, IProperty } from '@twin.org/hierarchies-models';
+
+const accreditation: IAccreditation = {
+  permissionId: 'perm-1',
+  accreditedBy: 'authority-1',
+  properties: [{ name: 'access.level', allowedValues: [{ type: 'String', value: 'admin' }] }]
+};
+console.log(accreditation.accreditedBy); // "authority-1"
+```

package/docs/reference/index.md

@@ -0,0 +1,46 @@
+# @twin.org/hierarchies-models
+
+## Interfaces
+
+- [IAccreditation](interfaces/IAccreditation.md)
+- [IFederation](interfaces/IFederation.md)
+- [IGovernance](interfaces/IGovernance.md)
+- [IHierarchiesComponent](interfaces/IHierarchiesComponent.md)
+- [IHierarchiesConnector](interfaces/IHierarchiesConnector.md)
+- [IProperty](interfaces/IProperty.md)
+- [IPropertyCondition](interfaces/IPropertyCondition.md)
+- [IPropertyValue](interfaces/IPropertyValue.md)
+- [IRootAuthority](interfaces/IRootAuthority.md)
+- [ITimespan](interfaces/ITimespan.md)
+- [IHierarchiesAccreditationAddRequest](interfaces/IHierarchiesAccreditationAddRequest.md)
+- [IHierarchiesAccreditationGetRequest](interfaces/IHierarchiesAccreditationGetRequest.md)
+- [IHierarchiesAccreditationGetResponse](interfaces/IHierarchiesAccreditationGetResponse.md)
+- [IHierarchiesAccreditationRemoveRequest](interfaces/IHierarchiesAccreditationRemoveRequest.md)
+- [IHierarchiesAccreditationsGetRequest](interfaces/IHierarchiesAccreditationsGetRequest.md)
+- [IHierarchiesAccreditationsGetResponse](interfaces/IHierarchiesAccreditationsGetResponse.md)
+- [IHierarchiesAuthorityAddRequest](interfaces/IHierarchiesAuthorityAddRequest.md)
+- [IHierarchiesAuthorityRemoveRequest](interfaces/IHierarchiesAuthorityRemoveRequest.md)
+- [IHierarchiesFederationCreateRequest](interfaces/IHierarchiesFederationCreateRequest.md)
+- [IHierarchiesFederationGetRequest](interfaces/IHierarchiesFederationGetRequest.md)
+- [IHierarchiesFederationGetResponse](interfaces/IHierarchiesFederationGetResponse.md)
+- [IHierarchiesPropertiesGetRequest](interfaces/IHierarchiesPropertiesGetRequest.md)
+- [IHierarchiesPropertiesGetResponse](interfaces/IHierarchiesPropertiesGetResponse.md)
+- [IHierarchiesPropertiesValidateRequest](interfaces/IHierarchiesPropertiesValidateRequest.md)
+- [IHierarchiesPropertiesValidateResponse](interfaces/IHierarchiesPropertiesValidateResponse.md)
+- [IHierarchiesPropertyAddRequest](interfaces/IHierarchiesPropertyAddRequest.md)
+- [IHierarchiesPropertyGetRequest](interfaces/IHierarchiesPropertyGetRequest.md)
+- [IHierarchiesPropertyGetResponse](interfaces/IHierarchiesPropertyGetResponse.md)
+- [IHierarchiesPropertyRemoveRequest](interfaces/IHierarchiesPropertyRemoveRequest.md)
+- [IHierarchiesPropertyValidateRequest](interfaces/IHierarchiesPropertyValidateRequest.md)
+- [IHierarchiesPropertyValidateResponse](interfaces/IHierarchiesPropertyValidateResponse.md)
+
+## Type Aliases
+
+- [PropertyConstraintType](type-aliases/PropertyConstraintType.md)
+- [PropertyType](type-aliases/PropertyType.md)
+
+## Variables
+
+- [HierarchiesConnectorFactory](variables/HierarchiesConnectorFactory.md)
+- [PropertyConstraintType](variables/PropertyConstraintType.md)
+- [PropertyType](variables/PropertyType.md)

package/docs/reference/interfaces/IAccreditation.md

@@ -0,0 +1,27 @@
+# Interface: IAccreditation
+
+Represents an accreditation, which is a collection of properties granted by an accreditor.
+
+## Properties
+
+### permissionId {#permissionid}
+
+> **permissionId**: `string`
+
+Unique identifier for the accreditation.
+
+***
+
+### accreditedBy {#accreditedby}
+
+> **accreditedBy**: `string`
+
+The identifier of the entity that granted the accreditation.
+
+***
+
+### properties {#properties}
+
+> **properties**: [`IProperty`](IProperty.md)[]
+
+Properties associated with this accreditation.

package/docs/reference/interfaces/IFederation.md

@@ -0,0 +1,36 @@
+# Interface: IFederation
+
+Represents a federation, which is a group of entities forming a trust hierarchy.
+Federations define the root authorities and the schema for properties they manage.
+
+## Properties
+
+### id {#id}
+
+> **id**: `string`
+
+Unique identifier for the federation.
+
+***
+
+### rootAuthorities {#rootauthorities}
+
+> **rootAuthorities**: [`IRootAuthority`](IRootAuthority.md)[]
+
+List of root authority IDs associated with this federation.
+
+***
+
+### revokedRootAuthorities {#revokedrootauthorities}
+
+> **revokedRootAuthorities**: `string`[]
+
+Account IDs of root authorities that have been revoked and are no longer trusted.
+
+***
+
+### governance {#governance}
+
+> **governance**: [`IGovernance`](IGovernance.md)
+
+The governance entity that manages accreditations and attestations within the federation.

package/docs/reference/interfaces/IGovernance.md

@@ -0,0 +1,44 @@
+# Interface: IGovernance
+
+Represents a governance entity in a federation hierarchy.
+Governance entities are trusted entities that can accredit or revoke delegations.
+
+## Properties
+
+### id {#id}
+
+> **id**: `string`
+
+Unique identifier for the governance entity.
+
+***
+
+### accreditationsToAccredit {#accreditationstoaccredit}
+
+> **accreditationsToAccredit**: `object`
+
+Map of accredited-by ID to the list of accreditations that grant the right to accredit others.
+
+#### Index Signature
+
+\[`id`: `string`\]: [`IAccreditation`](IAccreditation.md)[]
+
+***
+
+### accreditationsToAttest {#accreditationstoattest}
+
+> **accreditationsToAttest**: `object`
+
+Map of accredited-by ID to the list of accreditations that grant the right to attest properties.
+
+#### Index Signature
+
+\[`id`: `string`\]: [`IAccreditation`](IAccreditation.md)[]
+
+***
+
+### properties {#properties}
+
+> **properties**: [`IProperty`](IProperty.md)[]
+
+The set of properties this governance entity covers.