@twin.org/identity-models 0.0.1-next.20 → 0.0.1-next.22

package/dist/cjs/index.cjs

@@ -19,6 +19,14 @@ const IdentityConnectorFactory = core.Factory.createFactory("identity-connector"
 // eslint-disable-next-line @typescript-eslint/naming-convention
 const IdentityProfileConnectorFactory = core.Factory.createFactory("identity-profile-connector");
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Factory for creating identity resolver connectors.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const IdentityResolverConnectorFactory = core.Factory.createFactory("identity-resolver-connector");
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -86,4 +94,5 @@ class JwtHelper {
 exports.DocumentHelper = DocumentHelper;
 exports.IdentityConnectorFactory = IdentityConnectorFactory;
 exports.IdentityProfileConnectorFactory = IdentityProfileConnectorFactory;
+exports.IdentityResolverConnectorFactory = IdentityResolverConnectorFactory;
 exports.JwtHelper = JwtHelper;

package/dist/esm/index.mjs

@@ -17,6 +17,14 @@ const IdentityConnectorFactory = Factory.createFactory("identity-connector");
 // eslint-disable-next-line @typescript-eslint/naming-convention
 const IdentityProfileConnectorFactory = Factory.createFactory("identity-profile-connector");
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Factory for creating identity resolver connectors.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const IdentityResolverConnectorFactory = Factory.createFactory("identity-resolver-connector");
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -81,4 +89,4 @@ class JwtHelper {
     }
 }
 
-export { DocumentHelper, IdentityConnectorFactory, IdentityProfileConnectorFactory, JwtHelper };
+export { DocumentHelper, IdentityConnectorFactory, IdentityProfileConnectorFactory, IdentityResolverConnectorFactory, JwtHelper };

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

@@ -0,0 +1,6 @@
+import { Factory } from "@twin.org/core";
+import type { IIdentityResolverConnector } from "../models/IIdentityResolverConnector";
+/**
+ * Factory for creating identity resolver connectors.
+ */
+export declare const IdentityResolverConnectorFactory: Factory<IIdentityResolverConnector>;

package/dist/types/index.d.ts

@@ -1,7 +1,6 @@
 export * from "./factories/identityConnectorFactory";
 export * from "./factories/identityProfileConnectorFactory";
-export * from "./models/api/identity/IIdentityResolveRequest";
-export * from "./models/api/identity/IIdentityResolveResponse";
+export * from "./factories/identityResolverConnectorFactory";
 export * from "./models/api/profile/IIdentityProfileCreateRequest";
 export * from "./models/api/profile/IIdentityProfileGetPublicRequest";
 export * from "./models/api/profile/IIdentityProfileGetPublicResponse";
@@ -10,9 +9,13 @@ export * from "./models/api/profile/IIdentityProfileGetResponse";
 export * from "./models/api/profile/IIdentityProfileListRequest";
 export * from "./models/api/profile/IIdentityProfileListResponse";
 export * from "./models/api/profile/IIdentityProfileUpdateRequest";
+export * from "./models/api/resolver/IIdentityResolveRequest";
+export * from "./models/api/resolver/IIdentityResolveResponse";
 export * from "./models/IIdentityComponent";
 export * from "./models/IIdentityConnector";
 export * from "./models/IIdentityProfileComponent";
 export * from "./models/IIdentityProfileConnector";
+export * from "./models/IIdentityResolverComponent";
+export * from "./models/IIdentityResolverConnector";
 export * from "./utils/documentHelper";
 export * from "./utils/jwtHelper";

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

@@ -12,12 +12,6 @@ export interface IIdentityComponent extends IComponent {
      * @returns The created identity document.
      */
     identityCreate(controller: string, namespace?: string): Promise<IDidDocument>;
-    /**
-     * Resolve an identity.
-     * @param identity The id of the document to resolve.
-     * @returns The resolved document.
-     */
-    identityResolve(identity: string): Promise<IDidDocument>;
     /**
      * Add a verification method to the document in JSON Web key Format.
      * @param controller The controller of the identity who can make changes.

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

@@ -11,13 +11,6 @@ export interface IIdentityConnector extends IComponent {
      * @returns The created document.
      */
     createDocument(controller: string): Promise<IDidDocument>;
-    /**
-     * Resolve a document from its id.
-     * @param documentId The id of the document to resolve.
-     * @returns The resolved document.
-     * @throws NotFoundError if the id can not be resolved.
-     */
-    resolveDocument(documentId: string): Promise<IDidDocument>;
     /**
      * Add a verification method to the document in JSON Web key Format.
      * @param controller The controller of the identity who can make changes.

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

@@ -0,0 +1,13 @@
+import type { IComponent } from "@twin.org/core";
+import type { IDidDocument } from "@twin.org/standards-w3c-did";
+/**
+ * Interface describing a contract which provides identity operations.
+ */
+export interface IIdentityResolverComponent extends IComponent {
+    /**
+     * Resolve an identity.
+     * @param identity The id of the document to resolve.
+     * @returns The resolved document.
+     */
+    identityResolve(identity: string): Promise<IDidDocument>;
+}

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

@@ -0,0 +1,14 @@
+import type { IComponent } from "@twin.org/core";
+import type { IDidDocument } from "@twin.org/standards-w3c-did";
+/**
+ * Interface describing an identity connector.
+ */
+export interface IIdentityResolverConnector extends IComponent {
+    /**
+     * Resolve a document from its id.
+     * @param documentId The id of the document to resolve.
+     * @returns The resolved document.
+     * @throws NotFoundError if the id can not be resolved.
+     */
+    resolveDocument(documentId: string): Promise<IDidDocument>;
+}

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/identity-service-models - Changelog
 
-## v0.0.1-next.20
+## v0.0.1-next.22
 
 - Initial Release

package/docs/reference/index.md

@@ -11,8 +11,8 @@
 - [IIdentityConnector](interfaces/IIdentityConnector.md)
 - [IIdentityProfileComponent](interfaces/IIdentityProfileComponent.md)
 - [IIdentityProfileConnector](interfaces/IIdentityProfileConnector.md)
-- [IIdentityResolveRequest](interfaces/IIdentityResolveRequest.md)
-- [IIdentityResolveResponse](interfaces/IIdentityResolveResponse.md)
+- [IIdentityResolverComponent](interfaces/IIdentityResolverComponent.md)
+- [IIdentityResolverConnector](interfaces/IIdentityResolverConnector.md)
 - [IIdentityProfileCreateRequest](interfaces/IIdentityProfileCreateRequest.md)
 - [IIdentityProfileGetPublicRequest](interfaces/IIdentityProfileGetPublicRequest.md)
 - [IIdentityProfileGetPublicResponse](interfaces/IIdentityProfileGetPublicResponse.md)
@@ -21,8 +21,11 @@
 - [IIdentityProfileListRequest](interfaces/IIdentityProfileListRequest.md)
 - [IIdentityProfileListResponse](interfaces/IIdentityProfileListResponse.md)
 - [IIdentityProfileUpdateRequest](interfaces/IIdentityProfileUpdateRequest.md)
+- [IIdentityResolveRequest](interfaces/IIdentityResolveRequest.md)
+- [IIdentityResolveResponse](interfaces/IIdentityResolveResponse.md)
 
 ## Variables
 
 - [IdentityConnectorFactory](variables/IdentityConnectorFactory.md)
 - [IdentityProfileConnectorFactory](variables/IdentityProfileConnectorFactory.md)
+- [IdentityResolverConnectorFactory](variables/IdentityResolverConnectorFactory.md)

package/docs/reference/interfaces/IIdentityComponent.md

@@ -36,28 +36,6 @@ The created identity document.
 
 ***
 
-### identityResolve()
-
-> **identityResolve**(`identity`): `Promise`\<`IDidDocument`\>
-
-Resolve an identity.
-
-#### Parameters
-
-##### identity
-
-`string`
-
-The id of the document to resolve.
-
-#### Returns
-
-`Promise`\<`IDidDocument`\>
-
-The resolved document.
-
-***
-
 ### verificationMethodCreate()
 
 > **verificationMethodCreate**(`controller`, `identity`, `verificationMethodType`, `verificationMethodId`?): `Promise`\<`IDidDocumentVerificationMethod`\>

package/docs/reference/interfaces/IIdentityConnector.md

@@ -30,32 +30,6 @@ The created document.
 
 ***
 
-### resolveDocument()
-
-> **resolveDocument**(`documentId`): `Promise`\<`IDidDocument`\>
-
-Resolve a document from its id.
-
-#### Parameters
-
-##### documentId
-
-`string`
-
-The id of the document to resolve.
-
-#### Returns
-
-`Promise`\<`IDidDocument`\>
-
-The resolved document.
-
-#### Throws
-
-NotFoundError if the id can not be resolved.
-
-***
-
 ### addVerificationMethod()
 
 > **addVerificationMethod**(`controller`, `documentId`, `verificationMethodType`, `verificationMethodId`?): `Promise`\<`IDidDocumentVerificationMethod`\>

package/docs/reference/interfaces/IIdentityResolverComponent.md

@@ -0,0 +1,29 @@
+# Interface: IIdentityResolverComponent
+
+Interface describing a contract which provides identity operations.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### identityResolve()
+
+> **identityResolve**(`identity`): `Promise`\<`IDidDocument`\>
+
+Resolve an identity.
+
+#### Parameters
+
+##### identity
+
+`string`
+
+The id of the document to resolve.
+
+#### Returns
+
+`Promise`\<`IDidDocument`\>
+
+The resolved document.

package/docs/reference/interfaces/IIdentityResolverConnector.md

@@ -0,0 +1,33 @@
+# Interface: IIdentityResolverConnector
+
+Interface describing an identity connector.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### resolveDocument()
+
+> **resolveDocument**(`documentId`): `Promise`\<`IDidDocument`\>
+
+Resolve a document from its id.
+
+#### Parameters
+
+##### documentId
+
+`string`
+
+The id of the document to resolve.
+
+#### Returns
+
+`Promise`\<`IDidDocument`\>
+
+The resolved document.
+
+#### Throws
+
+NotFoundError if the id can not be resolved.

package/docs/reference/variables/IdentityResolverConnectorFactory.md

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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/identity-models",
-	"version": "0.0.1-next.20",
+	"version": "0.0.1-next.22",
 	"description": "Models which define the structure of the contracts and connectors",
 	"repository": {
 		"type": "git",
@@ -26,9 +26,9 @@
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
+			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs",
-			"types": "./dist/types/index.d.ts"
+			"import": "./dist/esm/index.mjs"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},