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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IHierarchiesPropertyGetResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IHierarchiesPropertyGetResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IProperty } from \"../IProperty.js\";\n\n/**\n * Response for getting a property.\n */\nexport interface IHierarchiesPropertyGetResponse {\n\t/**\n\t * The response body.\n\t */\n\tbody: IProperty;\n}\n"]}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IHierarchiesPropertyRemoveRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IHierarchiesPropertyRemoveRequest.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 a property from a federation.\n */\nexport interface IHierarchiesPropertyRemoveRequest {\n\t/**\n\t * The request path parameters.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The id of the federation.\n\t\t */\n\t\tfederationId: string;\n\n\t\t/**\n\t\t * The property name to remove.\n\t\t */\n\t\tpropertyName: string;\n\t};\n}\n"]}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IHierarchiesPropertyValidateRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IHierarchiesPropertyValidateRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IPropertyValue } from \"../IPropertyValue.js\";\n\n/**\n * Request to validate a property for a federation.\n */\nexport interface IHierarchiesPropertyValidateRequest {\n\t/**\n\t * The request path parameters.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The id of the federation.\n\t\t */\n\t\tfederationId: string;\n\t};\n\t/**\n\t * The request data.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The accredited by id.\n\t\t */\n\t\taccreditedById: string;\n\n\t\t/**\n\t\t * The property name to validate.\n\t\t */\n\t\tpropertyName: string;\n\n\t\t/**\n\t\t * The property value to validate.\n\t\t */\n\t\tpropertyValue: IPropertyValue;\n\t};\n}\n"]}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IHierarchiesPropertyValidateResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IHierarchiesPropertyValidateResponse.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Response for property validation.\n */\nexport interface IHierarchiesPropertyValidateResponse {\n\t/**\n\t * The response body.\n\t */\n\tbody: {\n\t\t/**\n\t\t * Whether the provided property is valid.\n\t\t */\n\t\tvalid: boolean;\n\t};\n}\n"]}

package/dist/es/models/propertyConstraintType.js

@@ -0,0 +1,29 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Defines the types of constraints that can be applied to federation properties.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const PropertyConstraintType = {
+    /**
+     * Value must contain a specific substring.
+     */
+    Contains: "Contains",
+    /**
+     * Value must start with a specific substring.
+     */
+    StartsWith: "StartsWith",
+    /**
+     * Value must end with a specific substring.
+     */
+    EndsWith: "EndsWith",
+    /**
+     * Value must be greater than a specific value.
+     */
+    GreaterThan: "GreaterThan",
+    /**
+     * Value must be less than a specific value.
+     */
+    LessThan: "LessThan"
+};
+//# sourceMappingURL=propertyConstraintType.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"propertyConstraintType.js","sourceRoot":"","sources":["../../../src/models/propertyConstraintType.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACrC;;OAEG;IACH,QAAQ,EAAE,UAAU;IAEpB;;OAEG;IACH,UAAU,EAAE,YAAY;IAExB;;OAEG;IACH,QAAQ,EAAE,UAAU;IAEpB;;OAEG;IACH,WAAW,EAAE,aAAa;IAE1B;;OAEG;IACH,QAAQ,EAAE,UAAU;CACX,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Defines the types of constraints that can be applied to federation properties.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const PropertyConstraintType = {\n\t/**\n\t * Value must contain a specific substring.\n\t */\n\tContains: \"Contains\",\n\n\t/**\n\t * Value must start with a specific substring.\n\t */\n\tStartsWith: \"StartsWith\",\n\n\t/**\n\t * Value must end with a specific substring.\n\t */\n\tEndsWith: \"EndsWith\",\n\n\t/**\n\t * Value must be greater than a specific value.\n\t */\n\tGreaterThan: \"GreaterThan\",\n\n\t/**\n\t * Value must be less than a specific value.\n\t */\n\tLessThan: \"LessThan\"\n} as const;\n\n/**\n * Type representing the possible condition types.\n */\nexport type PropertyConstraintType =\n\t(typeof PropertyConstraintType)[keyof typeof PropertyConstraintType];\n"]}

package/dist/es/models/propertyType.js

@@ -0,0 +1,17 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Defines the supported data types for property values.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const PropertyType = {
+    /**
+     * Value is a string.
+     */
+    String: "String",
+    /**
+     * Value is a bigint.
+     */
+    BigInt: "BigInt"
+};
+//# sourceMappingURL=propertyType.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"propertyType.js","sourceRoot":"","sources":["../../../src/models/propertyType.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,YAAY,GAAG;IAC3B;;OAEG;IACH,MAAM,EAAE,QAAQ;IAEhB;;OAEG;IACH,MAAM,EAAE,QAAQ;CACP,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Defines the supported data types for property values.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const PropertyType = {\n\t/**\n\t * Value is a string.\n\t */\n\tString: \"String\",\n\n\t/**\n\t * Value is a bigint.\n\t */\n\tBigInt: \"BigInt\"\n} as const;\n\n/**\n * Type representing the possible property types.\n */\nexport type PropertyType = (typeof PropertyType)[keyof typeof PropertyType];\n"]}

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

@@ -0,0 +1,6 @@
+import { Factory } from "@twin.org/core";
+import type { IHierarchiesConnector } from "../models/IHierarchiesConnector.js";
+/**
+ * Factory for creating hierarchies connectors.
+ */
+export declare const HierarchiesConnectorFactory: Factory<IHierarchiesConnector>;

package/dist/types/index.d.ts

@@ -0,0 +1,34 @@
+export * from "./factories/hierarchiesConnectorFactory.js";
+export * from "./models/api/IHierarchiesAccreditationAddRequest.js";
+export * from "./models/api/IHierarchiesAccreditationGetRequest.js";
+export * from "./models/api/IHierarchiesAccreditationGetResponse.js";
+export * from "./models/api/IHierarchiesAccreditationRemoveRequest.js";
+export * from "./models/api/IHierarchiesAccreditationsGetRequest.js";
+export * from "./models/api/IHierarchiesAccreditationsGetResponse.js";
+export * from "./models/api/IHierarchiesAuthorityAddRequest.js";
+export * from "./models/api/IHierarchiesAuthorityRemoveRequest.js";
+export * from "./models/api/IHierarchiesFederationCreateRequest.js";
+export * from "./models/api/IHierarchiesFederationGetRequest.js";
+export * from "./models/api/IHierarchiesFederationGetResponse.js";
+export * from "./models/api/IHierarchiesPropertiesGetRequest.js";
+export * from "./models/api/IHierarchiesPropertiesGetResponse.js";
+export * from "./models/api/IHierarchiesPropertiesValidateRequest.js";
+export * from "./models/api/IHierarchiesPropertiesValidateResponse.js";
+export * from "./models/api/IHierarchiesPropertyAddRequest.js";
+export * from "./models/api/IHierarchiesPropertyGetRequest.js";
+export * from "./models/api/IHierarchiesPropertyGetResponse.js";
+export * from "./models/api/IHierarchiesPropertyRemoveRequest.js";
+export * from "./models/api/IHierarchiesPropertyValidateRequest.js";
+export * from "./models/api/IHierarchiesPropertyValidateResponse.js";
+export * from "./models/IAccreditation.js";
+export * from "./models/IFederation.js";
+export * from "./models/IGovernance.js";
+export * from "./models/IHierarchiesComponent.js";
+export * from "./models/IHierarchiesConnector.js";
+export * from "./models/IProperty.js";
+export * from "./models/IPropertyCondition.js";
+export * from "./models/IPropertyValue.js";
+export * from "./models/IRootAuthority.js";
+export * from "./models/ITimespan.js";
+export * from "./models/propertyConstraintType.js";
+export * from "./models/propertyType.js";

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

@@ -0,0 +1,18 @@
+import type { IProperty } from "./IProperty.js";
+/**
+ * Represents an accreditation, which is a collection of properties granted by an accreditor.
+ */
+export interface IAccreditation {
+    /**
+     * Unique identifier for the accreditation.
+     */
+    permissionId: string;
+    /**
+     * The identifier of the entity that granted the accreditation.
+     */
+    accreditedBy: string;
+    /**
+     * Properties associated with this accreditation.
+     */
+    properties: IProperty[];
+}

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

@@ -0,0 +1,24 @@
+import type { IGovernance } from "../index.js";
+import type { IRootAuthority } from "./IRootAuthority.js";
+/**
+ * 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.
+ */
+export interface IFederation {
+    /**
+     * Unique identifier for the federation.
+     */
+    id: string;
+    /**
+     * List of root authority IDs associated with this federation.
+     */
+    rootAuthorities: IRootAuthority[];
+    /**
+     * Account IDs of root authorities that have been revoked and are no longer trusted.
+     */
+    revokedRootAuthorities: string[];
+    /**
+     * The governance entity that manages accreditations and attestations within the federation.
+     */
+    governance: IGovernance;
+}

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

@@ -0,0 +1,28 @@
+import type { IAccreditation } from "./IAccreditation.js";
+import type { IProperty } from "./IProperty.js";
+/**
+ * Represents a governance entity in a federation hierarchy.
+ * Governance entities are trusted entities that can accredit or revoke delegations.
+ */
+export interface IGovernance {
+    /**
+     * Unique identifier for the governance entity.
+     */
+    id: string;
+    /**
+     * Map of accredited-by ID to the list of accreditations that grant the right to accredit others.
+     */
+    accreditationsToAccredit: {
+        [id: string]: IAccreditation[];
+    };
+    /**
+     * Map of accredited-by ID to the list of accreditations that grant the right to attest properties.
+     */
+    accreditationsToAttest: {
+        [id: string]: IAccreditation[];
+    };
+    /**
+     * The set of properties this governance entity covers.
+     */
+    properties: IProperty[];
+}

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

@@ -0,0 +1,160 @@
+import type { IComponent } from "@twin.org/core";
+import type { IAccreditation } from "./IAccreditation.js";
+import type { IFederation } from "./IFederation.js";
+import type { IProperty } from "./IProperty.js";
+import type { IPropertyValue } from "./IPropertyValue.js";
+/**
+ * Interface describing a hierarchies component.
+ */
+export interface IHierarchiesComponent extends IComponent {
+    /**
+     * Creates a new federation.
+     * @param rootAuthorities The root authorities to be included in the federation.
+     * @param namespace The namespace of the connector to use for the federation, defaults to component configured namespace.
+     * @param controllerIdentity The identity of the controller creating the federation.
+     * @returns The ID of the created federation.
+     */
+    federationCreate(rootAuthorities?: string[], namespace?: string, controllerIdentity?: string): Promise<string>;
+    /**
+     * Retrieves a federation by its ID.
+     * @param federationId The ID of the federation to retrieve.
+     * @param options Options for retrieving the federation.
+     * @param options.includeRevokedProperties Whether to include revoked properties in the retrieved federation, defaults to false.
+     * @returns The federation with the specified ID.
+     */
+    federationGet(federationId: string, options?: {
+        includeRevokedProperties?: boolean;
+    }): Promise<IFederation>;
+    /**
+     * Adds a new authority to an existing federation.
+     * @param federationId The ID of the federation to which the authority will be added.
+     * @param accountId The account ID of the authority to be added.
+     * @param controllerIdentity The identity of the controller adding the authority.
+     * @returns The id of the authority.
+     */
+    authorityAdd(federationId: string, accountId: string, controllerIdentity?: string): Promise<string>;
+    /**
+     * Removes an authority from an existing federation.
+     * @param federationId The ID of the federation from which the authority will be removed.
+     * @param accountId The account ID of the authority to be removed.
+     * @param controllerIdentity The identity of the controller removing the authority.
+     * @returns A promise that resolves when the authority has been removed.
+     */
+    authorityRemove(federationId: string, accountId: string, controllerIdentity?: string): Promise<void>;
+    /**
+     * Adds a new property to an existing federation.
+     * @param federationId The ID of the federation to which the property will be added.
+     * @param property The property to be added.
+     * @param controllerIdentity The identity of the controller adding the property.
+     * @returns A promise that resolves when the property has been added.
+     */
+    propertyAdd(federationId: string, property: IProperty, controllerIdentity?: string): Promise<void>;
+    /**
+     * Removes a property from an existing federation.
+     * @param federationId The ID of the federation from which the property will be removed.
+     * @param propertyName The name of the property to be removed.
+     * @param controllerIdentity The identity of the controller removing the property.
+     * @returns A promise that resolves when the property has been removed.
+     */
+    propertyRemove(federationId: string, propertyName: string, controllerIdentity?: string): Promise<void>;
+    /**
+     * Gets a property from an existing federation.
+     * @param federationId The ID of the federation from which the property will be retrieved.
+     * @param propertyName The name of the property to be retrieved.
+     * @returns A promise that resolves with the property.
+     */
+    propertyGet(federationId: string, propertyName: string): Promise<IProperty>;
+    /**
+     * Gets all properties from an existing federation.
+     * @param federationId The ID of the federation from which the properties will be retrieved.
+     * @param options Options for retrieving the properties.
+     * @param options.includeRevokedProperties Whether to include revoked properties in the retrieved properties, defaults to false.
+     * @returns A promise that resolves with the properties.
+     */
+    propertiesGet(federationId: string, options?: {
+        includeRevokedProperties?: boolean;
+    }): Promise<IProperty[]>;
+    /**
+     * Validates property for an existing federation.
+     * @param federationId The ID of the federation for which the property will be validated.
+     * @param accreditedById The ID of the entity that granted the accreditation.
+     * @param propertyName The name of the property to be validated.
+     * @param propertyValue The value of the property to be validated.
+     * @returns A promise that resolves with a boolean indicating whether the property is valid.
+     */
+    propertyValidate(federationId: string, accreditedById: string, propertyName: string, propertyValue: IPropertyValue): Promise<boolean>;
+    /**
+     * Validates properties for an existing federation.
+     * @param federationId The ID of the federation for which the properties will be validated.
+     * @param accreditedById The ID of the entity that granted the accreditations.
+     * @param propertiesToValidate The properties to be validated.
+     * @returns A promise that resolves with a boolean indicating whether the properties are valid.
+     */
+    propertiesValidate(federationId: string, accreditedById: string, propertiesToValidate: {
+        [propertyName: string]: IPropertyValue;
+    }): Promise<boolean>;
+    /**
+     * Adds a new accreditation to attest to an existing federation.
+     * @param federationId The ID of the federation to which the accreditation will be added.
+     * @param accreditation The accreditation to be added.
+     * @param controllerIdentity The identity of the controller adding the accreditation.
+     * @returns The ID of the added accreditation.
+     */
+    accreditationToAttestAdd(federationId: string, accreditation: Omit<IAccreditation, "permissionId">, controllerIdentity?: string): Promise<string>;
+    /**
+     * Removes an accreditation to attest from an existing federation.
+     * @param federationId The ID of the federation from which the accreditation will be removed.
+     * @param accreditedById The ID of the entity that granted the accreditation to be removed.
+     * @param permissionId The ID of the accreditation to be removed.
+     * @param controllerIdentity The identity of the controller removing the accreditation.
+     * @returns A promise that resolves when the accreditation has been removed.
+     */
+    accreditationToAttestRemove(federationId: string, accreditedById: string, permissionId: string, controllerIdentity?: string): Promise<void>;
+    /**
+     * Get accreditation to attest to an existing federation.
+     * @param federationId The ID of the federation for which to get the accreditation.
+     * @param accreditedById The ID of the entity that granted the accreditation.
+     * @param permissionId The ID of the accreditation to be retrieved.
+     * @returns A promise that resolves with the accreditation.
+     */
+    accreditationToAttestGet(federationId: string, accreditedById: string, permissionId: string): Promise<IAccreditation>;
+    /**
+     * Gets accreditations to attest to an existing federation.
+     * @param federationId The ID of the federation for which to get the accreditations.
+     * @param accreditedById The ID of the entity that granted the accreditations.
+     * @returns A promise that resolves with the accreditations.
+     */
+    accreditationsToAttestGet(federationId: string, accreditedById: string): Promise<IAccreditation[]>;
+    /**
+     * Adds a new accreditation to accredit to an existing federation.
+     * @param federationId The ID of the federation to which the accreditation will be added.
+     * @param accreditation The accreditation to be added.
+     * @param controllerIdentity The identity of the controller adding the accreditation.
+     * @returns The ID of the added accreditation.
+     */
+    accreditationToAccreditAdd(federationId: string, accreditation: Omit<IAccreditation, "permissionId">, controllerIdentity?: string): Promise<string>;
+    /**
+     * Removes an accreditation to accredit from an existing federation.
+     * @param federationId The ID of the federation from which the accreditation will be removed.
+     * @param accreditedById The ID of the entity that granted the accreditation to be removed.
+     * @param permissionId The ID of the accreditation to be removed.
+     * @param controllerIdentity The identity of the controller removing the accreditation.
+     * @returns A promise that resolves when the accreditation has been removed.
+     */
+    accreditationToAccreditRemove(federationId: string, accreditedById: string, permissionId: string, controllerIdentity?: string): Promise<void>;
+    /**
+     * Get accreditation to accredit to an existing federation.
+     * @param federationId The ID of the federation for which to get the accreditation.
+     * @param accreditedById The ID of the entity that granted the accreditation.
+     * @param permissionId The ID of the accreditation to be retrieved.
+     * @returns A promise that resolves with the accreditation.
+     */
+    accreditationToAccreditGet(federationId: string, accreditedById: string, permissionId: string): Promise<IAccreditation>;
+    /**
+     * Gets accreditations to accredit to an existing federation.
+     * @param federationId The ID of the federation for which to get the accreditations.
+     * @param accreditedById The ID of the entity that granted the accreditations.
+     * @returns A promise that resolves with the accreditations.
+     */
+    accreditationsToAccreditGet(federationId: string, accreditedById: string): Promise<IAccreditation[]>;
+}

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

@@ -0,0 +1,159 @@
+import type { IComponent } from "@twin.org/core";
+import type { IAccreditation } from "./IAccreditation.js";
+import type { IFederation } from "./IFederation.js";
+import type { IProperty } from "./IProperty.js";
+import type { IPropertyValue } from "./IPropertyValue.js";
+/**
+ * Interface describing a hierarchies connector.
+ */
+export interface IHierarchiesConnector extends IComponent {
+    /**
+     * Creates a new federation.
+     * @param controllerIdentity The identity of the controller creating the federation.
+     * @param rootAuthorities The root authorities to be included in the federation.
+     * @returns The ID of the created federation.
+     */
+    federationCreate(controllerIdentity: string, rootAuthorities?: string[]): Promise<string>;
+    /**
+     * Retrieves a federation by its ID.
+     * @param federationId The ID of the federation to retrieve.
+     * @param options Options for retrieving the federation.
+     * @param options.includeRevokedProperties Whether to include revoked properties in the retrieved federation, defaults to false.
+     * @returns The federation with the specified ID.
+     */
+    federationGet(federationId: string, options?: {
+        includeRevokedProperties?: boolean;
+    }): Promise<IFederation>;
+    /**
+     * Adds a new authority to an existing federation.
+     * @param controllerIdentity The identity of the controller adding the authority.
+     * @param federationId The ID of the federation to which the authority will be added.
+     * @param accountId The account ID of the authority to be added.
+     * @returns The id of the authority.
+     */
+    authorityAdd(controllerIdentity: string, federationId: string, accountId: string): Promise<string>;
+    /**
+     * Removes an authority from an existing federation.
+     * @param controllerIdentity The identity of the controller removing the authority.
+     * @param federationId The ID of the federation from which the authority will be removed.
+     * @param accountId The account ID of the authority to be removed.
+     * @returns A promise that resolves when the authority has been removed.
+     */
+    authorityRemove(controllerIdentity: string, federationId: string, accountId: string): Promise<void>;
+    /**
+     * Adds a new property to an existing federation.
+     * @param controllerIdentity The identity of the controller adding the property.
+     * @param federationId The ID of the federation to which the property will be added.
+     * @param property The property to be added.
+     * @returns A promise that resolves when the property has been added.
+     */
+    propertyAdd(controllerIdentity: string, federationId: string, property: IProperty): Promise<void>;
+    /**
+     * Removes a property from an existing federation.
+     * @param controllerIdentity The identity of the controller removing the property.
+     * @param federationId The ID of the federation from which the property will be removed.
+     * @param propertyName The name of the property to be removed.
+     * @returns A promise that resolves when the property has been removed.
+     */
+    propertyRemove(controllerIdentity: string, federationId: string, propertyName: string): Promise<void>;
+    /**
+     * Gets a property from an existing federation.
+     * @param federationId The ID of the federation from which the property will be retrieved.
+     * @param propertyName The name of the property to be retrieved.
+     * @returns A promise that resolves with the property.
+     */
+    propertyGet(federationId: string, propertyName: string): Promise<IProperty>;
+    /**
+     * Gets all properties from an existing federation.
+     * @param federationId The ID of the federation from which the properties will be retrieved.
+     * @param options Options for retrieving the properties.
+     * @param options.includeRevokedProperties Whether to include revoked properties in the retrieved properties, defaults to false.
+     * @returns A promise that resolves with the properties.
+     */
+    propertiesGet(federationId: string, options?: {
+        includeRevokedProperties?: boolean;
+    }): Promise<IProperty[]>;
+    /**
+     * Validates property for an existing federation.
+     * @param federationId The ID of the federation for which the property will be validated.
+     * @param accreditedById The ID of the entity that granted the accreditation.
+     * @param propertyName The name of the property to be validated.
+     * @param propertyValue The value of the property to be validated.
+     * @returns A promise that resolves with a boolean indicating whether the property is valid.
+     */
+    propertyValidate(federationId: string, accreditedById: string, propertyName: string, propertyValue: IPropertyValue): Promise<boolean>;
+    /**
+     * Validates properties for an existing federation.
+     * @param federationId The ID of the federation for which the properties will be validated.
+     * @param accreditedById The ID of the entity that granted the accreditations.
+     * @param propertiesToValidate The properties to be validated.
+     * @returns A promise that resolves with a boolean indicating whether the properties are valid.
+     */
+    propertiesValidate(federationId: string, accreditedById: string, propertiesToValidate: {
+        [propertyName: string]: IPropertyValue;
+    }): Promise<boolean>;
+    /**
+     * Adds a new accreditation to attest to an existing federation.
+     * @param controllerIdentity The identity of the controller adding the accreditation.
+     * @param federationId The ID of the federation to which the accreditation will be added.
+     * @param accreditation The accreditation to be added.
+     * @returns The ID of the added accreditation.
+     */
+    accreditationToAttestAdd(controllerIdentity: string, federationId: string, accreditation: Omit<IAccreditation, "permissionId">): Promise<string>;
+    /**
+     * Removes an accreditation to attest from an existing federation.
+     * @param controllerIdentity The identity of the controller removing the accreditation.
+     * @param federationId The ID of the federation from which the accreditation will be removed.
+     * @param accreditedById The ID of the entity that granted the accreditation to be removed.
+     * @param permissionId The ID of the accreditation to be removed.
+     * @returns A promise that resolves when the accreditation has been removed.
+     */
+    accreditationToAttestRemove(controllerIdentity: string, federationId: string, accreditedById: string, permissionId: string): Promise<void>;
+    /**
+     * Get accreditation to attest to an existing federation.
+     * @param federationId The ID of the federation for which to get the accreditation.
+     * @param accreditedById The ID of the entity that granted the accreditation.
+     * @param permissionId The ID of the accreditation to be retrieved.
+     * @returns A promise that resolves with the accreditation.
+     */
+    accreditationToAttestGet(federationId: string, accreditedById: string, permissionId: string): Promise<IAccreditation>;
+    /**
+     * Gets accreditations to attest to an existing federation.
+     * @param federationId The ID of the federation for which to get the accreditations.
+     * @param accreditedById The ID of the entity that granted the accreditations.
+     * @returns A promise that resolves with the accreditations.
+     */
+    accreditationsToAttestGet(federationId: string, accreditedById: string): Promise<IAccreditation[]>;
+    /**
+     * Adds a new accreditation to accredit to an existing federation.
+     * @param controllerIdentity The identity of the controller adding the accreditation.
+     * @param federationId The ID of the federation to which the accreditation will be added.
+     * @param accreditation The accreditation to be added.
+     * @returns The ID of the added accreditation.
+     */
+    accreditationToAccreditAdd(controllerIdentity: string, federationId: string, accreditation: Omit<IAccreditation, "permissionId">): Promise<string>;
+    /**
+     * Removes an accreditation to accredit from an existing federation.
+     * @param controllerIdentity The identity of the controller removing the accreditation.
+     * @param federationId The ID of the federation from which the accreditation will be removed.
+     * @param accreditedById The ID of the entity that granted the accreditation to be removed.
+     * @param permissionId The ID of the accreditation to be removed.
+     * @returns A promise that resolves when the accreditation has been removed.
+     */
+    accreditationToAccreditRemove(controllerIdentity: string, federationId: string, accreditedById: string, permissionId: string): Promise<void>;
+    /**
+     * Get accreditation to accredit to an existing federation.
+     * @param federationId The ID of the federation for which to get the accreditation.
+     * @param accreditedById The ID of the entity that granted the accreditation.
+     * @param permissionId The ID of the accreditation to be retrieved.
+     * @returns A promise that resolves with the accreditation.
+     */
+    accreditationToAccreditGet(federationId: string, accreditedById: string, permissionId: string): Promise<IAccreditation>;
+    /**
+     * Gets accreditations to accredit to an existing federation.
+     * @param federationId The ID of the federation for which to get the accreditations.
+     * @param accreditedById The ID of the entity that granted the accreditations.
+     * @returns A promise that resolves with the accreditations.
+     */
+    accreditationsToAccreditGet(federationId: string, accreditedById: string): Promise<IAccreditation[]>;
+}

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

@@ -0,0 +1,24 @@
+import type { IPropertyValue } from "../index.js";
+import type { IPropertyCondition } from "./IPropertyCondition.js";
+import type { ITimespan } from "./ITimespan.js";
+/**
+ * Represents a named property with optional allowed values, a condition, and a validity timespan.
+ */
+export interface IProperty {
+    /**
+     * The property name, can be dotted form.
+     */
+    name: string;
+    /**
+     * The allowed values for this property, if empty, any value is allowed.
+     */
+    allowedValues?: IPropertyValue[];
+    /**
+     * The condition for this property.
+     */
+    condition?: IPropertyCondition;
+    /**
+     * The timespan for this property.
+     */
+    timespan?: ITimespan;
+}

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

@@ -0,0 +1,19 @@
+import type { PropertyConstraintType } from "./propertyConstraintType.js";
+import type { PropertyType } from "./propertyType.js";
+/**
+ * Describes the condition and constraints of a property within a hierarchy.
+ */
+export interface IPropertyCondition {
+    /**
+     * The property type.
+     */
+    type: PropertyType;
+    /**
+     * The property value.
+     */
+    value: string;
+    /**
+     * The constraint for this property.
+     */
+    constraint?: PropertyConstraintType;
+}

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

@@ -0,0 +1,14 @@
+import type { PropertyType } from "./propertyType.js";
+/**
+ * Describes the value of a property.
+ */
+export interface IPropertyValue {
+    /**
+     * The property type.
+     */
+    type: PropertyType;
+    /**
+     * The property value.
+     */
+    value: string;
+}

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

@@ -0,0 +1,13 @@
+/**
+ * Represents a root authority in a federation hierarchy.
+ */
+export interface IRootAuthority {
+    /**
+     * The ID of the root authority.
+     */
+    id: string;
+    /**
+     * The account ID of the root authority.
+     */
+    accountId: string;
+}

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

@@ -0,0 +1,13 @@
+/**
+ * Represents a timespan in a federation hierarchy.
+ */
+export interface ITimespan {
+    /**
+     * Valid from as bigint string so it can be serialized accurately.
+     */
+    validFrom?: string;
+    /**
+     * Valid to as bigint string so it can be serialized accurately.
+     */
+    validTo?: string;
+}

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

@@ -0,0 +1,19 @@
+import type { IAccreditation } from "../IAccreditation.js";
+/**
+ * Request to add an accreditation to a federation.
+ */
+export interface IHierarchiesAccreditationAddRequest {
+    /**
+     * The request path parameters.
+     */
+    pathParams: {
+        /**
+         * The id of the federation.
+         */
+        federationId: string;
+    };
+    /**
+     * The request data.
+     */
+    body: Omit<IAccreditation, "permissionId">;
+}