@twin.org/identity-models 0.0.1-next.8 → 0.0.1

package/docs/reference/interfaces/IIdentityServiceRemoveRequest.md

@@ -0,0 +1,23 @@
+# Interface: IIdentityServiceRemoveRequest
+
+Request to remove a service.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### identity
+
+> **identity**: `string`
+
+The identity to remove the service from.
+
+#### serviceId
+
+> **serviceId**: `string`
+
+The service to remove.

package/docs/reference/interfaces/IIdentityVerifiableCredentialCreateRequest.md

@@ -0,0 +1,49 @@
+# Interface: IIdentityVerifiableCredentialCreateRequest
+
+Request to create a verifiable credential.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### identity
+
+> **identity**: `string`
+
+The identity to create the verification credential for.
+
+#### verificationMethodId
+
+> **verificationMethodId**: `string`
+
+The verification method id to use.
+
+***
+
+### body
+
+> **body**: `object`
+
+The data for the request.
+
+#### credentialId?
+
+> `optional` **credentialId**: `string`
+
+The id of the credential.
+
+#### subject
+
+> **subject**: `IJsonLdNodeObject`
+
+The credential subject to store in the verifiable credential.
+
+#### revocationIndex?
+
+> `optional` **revocationIndex**: `number`
+
+The bitmap revocation index of the credential, if undefined will not have revocation status.

package/docs/reference/interfaces/IIdentityVerifiableCredentialCreateResponse.md

@@ -0,0 +1,23 @@
+# Interface: IIdentityVerifiableCredentialCreateResponse
+
+Response to creating a verifiable credential.
+
+## Properties
+
+### body
+
+> **body**: `object`
+
+The response payload.
+
+#### verifiableCredential
+
+> **verifiableCredential**: `IDidVerifiableCredential`
+
+The verifiable credential that was created.
+
+#### jwt
+
+> **jwt**: `string`
+
+The JWT token for the verifiable credential.

package/docs/reference/interfaces/IIdentityVerifiableCredentialRevokeRequest.md

@@ -0,0 +1,23 @@
+# Interface: IIdentityVerifiableCredentialRevokeRequest
+
+Request to revoke a verifiable credential.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### identity
+
+> **identity**: `string`
+
+The identity to revoke the verification credential for.
+
+#### revocationIndex
+
+> **revocationIndex**: `number`
+
+The revocation index to revoke.

package/docs/reference/interfaces/IIdentityVerifiableCredentialUnrevokeRequest.md

@@ -0,0 +1,23 @@
+# Interface: IIdentityVerifiableCredentialUnrevokeRequest
+
+Request to unrevoke a verifiable credential.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### identity
+
+> **identity**: `string`
+
+The identity to unrevoke the verification credential for.
+
+#### revocationIndex
+
+> **revocationIndex**: `number`
+
+The revocation index to unrevoke.

package/docs/reference/interfaces/IIdentityVerifiableCredentialVerifyRequest.md

@@ -0,0 +1,17 @@
+# Interface: IIdentityVerifiableCredentialVerifyRequest
+
+Request to verify a verifiable credential.
+
+## Properties
+
+### query
+
+> **query**: `object`
+
+The path parameters.
+
+#### jwt
+
+> **jwt**: `string`
+
+The jwt to verify.

package/docs/reference/interfaces/IIdentityVerifiableCredentialVerifyResponse.md

@@ -0,0 +1,23 @@
+# Interface: IIdentityVerifiableCredentialVerifyResponse
+
+Response to verifying a verifiable credential.
+
+## Properties
+
+### body
+
+> **body**: `object`
+
+The response payload.
+
+#### revoked
+
+> **revoked**: `boolean`
+
+Has the credential been revoked.
+
+#### verifiableCredential?
+
+> `optional` **verifiableCredential**: `IDidVerifiableCredential`
+
+The verifiable credential that was verified.

package/docs/reference/interfaces/IIdentityVerifiablePresentationCreateRequest.md

@@ -0,0 +1,61 @@
+# Interface: IIdentityVerifiablePresentationCreateRequest
+
+Request to create a verifiable presentation.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### identity
+
+> **identity**: `string`
+
+The identity to create the verification presentation for.
+
+#### verificationMethodId
+
+> **verificationMethodId**: `string`
+
+The verification method id to use.
+
+***
+
+### body
+
+> **body**: `object`
+
+The data for the request.
+
+#### presentationId?
+
+> `optional` **presentationId**: `string`
+
+The id of the presentation.
+
+#### contexts?
+
+> `optional` **contexts**: `IJsonLdContextDefinitionRoot`
+
+The context to use for the presentation.
+
+#### types?
+
+> `optional` **types**: `string` \| `string`[]
+
+The types of the presentation.
+
+#### verifiableCredentials
+
+> **verifiableCredentials**: (`string` \| `IDidVerifiableCredential`)[]
+
+The verifiable credentials to include in the presentation.
+
+#### expiresInMinutes?
+
+> `optional` **expiresInMinutes**: `number`
+
+The expiration time for the presentation.

package/docs/reference/interfaces/IIdentityVerifiablePresentationCreateResponse.md

@@ -0,0 +1,23 @@
+# Interface: IIdentityVerifiablePresentationCreateResponse
+
+Response to creating a verifiable presentation.
+
+## Properties
+
+### body
+
+> **body**: `object`
+
+The response payload.
+
+#### verifiablePresentation
+
+> **verifiablePresentation**: `IDidVerifiablePresentation`
+
+The verifiable presentation that was created.
+
+#### jwt
+
+> **jwt**: `string`
+
+The JWT token for the verifiable presentation.

package/docs/reference/interfaces/IIdentityVerifiablePresentationVerifyRequest.md

@@ -0,0 +1,17 @@
+# Interface: IIdentityVerifiablePresentationVerifyRequest
+
+Request to verify a verifiable presentation.
+
+## Properties
+
+### query
+
+> **query**: `object`
+
+The path parameters.
+
+#### jwt
+
+> **jwt**: `string`
+
+The jwt to verify.

package/docs/reference/interfaces/IIdentityVerifiablePresentationVerifyResponse.md

@@ -0,0 +1,29 @@
+# Interface: IIdentityVerifiablePresentationVerifyResponse
+
+Response to verifying a verifiable presentation.
+
+## Properties
+
+### body
+
+> **body**: `object`
+
+The response payload.
+
+#### revoked
+
+> **revoked**: `boolean`
+
+Has the presentation been revoked.
+
+#### verifiablePresentation?
+
+> `optional` **verifiablePresentation**: `IDidVerifiablePresentation`
+
+The verifiable presentation that was verified.
+
+#### issuers?
+
+> `optional` **issuers**: `IDidDocument`[]
+
+The issuers of the presentation.

package/docs/reference/interfaces/IIdentityVerificationMethodCreateRequest.md

@@ -0,0 +1,37 @@
+# Interface: IIdentityVerificationMethodCreateRequest
+
+Request to create a verification method.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### identity
+
+> **identity**: `string`
+
+The identity to create the verification method for.
+
+***
+
+### body
+
+> **body**: `object`
+
+The data for the request.
+
+#### verificationMethodType
+
+> **verificationMethodType**: `DidVerificationMethodType`
+
+The type of the verification method to create.
+
+#### verificationMethodId?
+
+> `optional` **verificationMethodId**: `string`
+
+The optional id for the verification method, will be allocated if not supplied.

package/docs/reference/interfaces/IIdentityVerificationMethodCreateResponse.md

@@ -0,0 +1,11 @@
+# Interface: IIdentityVerificationMethodCreateResponse
+
+Response to creating a verification method.
+
+## Properties
+
+### body
+
+> **body**: `IDidDocumentVerificationMethod`
+
+The response payload.

package/docs/reference/interfaces/IIdentityVerificationMethodRemoveRequest.md

@@ -0,0 +1,23 @@
+# Interface: IIdentityVerificationMethodRemoveRequest
+
+Request to remove a verification method.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### identity
+
+> **identity**: `string`
+
+The identity to remove the verification method from.
+
+#### verificationMethodId
+
+> **verificationMethodId**: `string`
+
+The verification method to remove.

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/locales/en.json

@@ -1,8 +1,14 @@
 {
-	"identityRole": {
-		"organization": "Organization",
-		"user": "User",
-		"node": "Node"
+	"error": {
+		"verificationHelper": {
+			"jwtDecodeFailed": "Decoding the JWT failed",
+			"proofTypeNotSupported": "The proof type \"{proofType}\" is not supported",
+			"proofMissingVerificationMethod": "The proof is missing the verification method"
+		},
+		"documentHelper": {
+			"verificationMethodNotFound": "The verification method \"{methodName}\" of type \"{methodType}\" could not be found",
+			"verificationMethodJwkNotFound": "The verification method \"{methodName}\" of type \"{methodType}\" is missing the JWK"
+		}
 	},
 	"verifiableCredentialStates": {
 		"pendingVerification": "Pending Verification",

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/identity-models",
-	"version": "0.0.1-next.8",
+	"version": "0.0.1",
 	"description": "Models which define the structure of the contracts and connectors",
 	"repository": {
 		"type": "git",
@@ -14,23 +14,23 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/core": "next",
-		"@twin.org/data-core": "next",
-		"@twin.org/data-json-ld": "next",
-		"@twin.org/entity": "next",
-		"@twin.org/standards-w3c-did": "next",
-		"@twin.org/web": "next"
+		"@twin.org/core": "^0.0.1",
+		"@twin.org/data-core": "^0.0.1",
+		"@twin.org/data-json-ld": "^0.0.1",
+		"@twin.org/entity": "^0.0.1",
+		"@twin.org/standards-w3c-did": "^0.0.1",
+		"@twin.org/web": "^0.0.1"
 	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",
 	"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": "./locales"
+		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
 		"dist/cjs",

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

@@ -1,21 +0,0 @@
-/**
- * The roles that an identity can have.
- */
-export declare const IdentityRole: {
-    /**
-     * Node.
-     */
-    readonly Node: "node";
-    /**
-     * Organization.
-     */
-    readonly Organization: "organization";
-    /**
-     * User.
-     */
-    readonly User: "user";
-};
-/**
- * The roles that an identity can have.
- */
-export type IdentityRole = (typeof IdentityRole)[keyof typeof IdentityRole];

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

@@ -1,5 +0,0 @@
-# Type Alias: IdentityRole
-
-> **IdentityRole**: *typeof* [`IdentityRole`](../variables/IdentityRole.md)\[keyof *typeof* [`IdentityRole`](../variables/IdentityRole.md)\]
-
-The roles that an identity can have.

package/docs/reference/variables/IdentityRole.md

@@ -1,25 +0,0 @@
-# Variable: IdentityRole
-
-> `const` **IdentityRole**: `object`
-
-The roles that an identity can have.
-
-## Type declaration
-
-### Node
-
-> `readonly` **Node**: `"node"` = `"node"`
-
-Node.
-
-### Organization
-
-> `readonly` **Organization**: `"organization"` = `"organization"`
-
-Organization.
-
-### User
-
-> `readonly` **User**: `"user"` = `"user"`
-
-User.