@twin.org/identity-models 0.0.3-next.9 → 0.9.0

package/docs/reference/interfaces/IIdentityProfileListResponse.md

@@ -4,7 +4,7 @@ Response to get a list of identities.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `object`
 
@@ -18,6 +18,6 @@ The identities.
 
 #### cursor?
 
-> `optional` **cursor**: `string`
+> `optional` **cursor?**: `string`
 
 An optional cursor, when defined can be used to call find to get more entities.

package/docs/reference/interfaces/IIdentityProfileUpdateRequest.md

@@ -4,7 +4,7 @@ Request to update an identity profile.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `object`
 
@@ -12,12 +12,12 @@ The data for the request.
 
 #### publicProfile?
 
-> `optional` **publicProfile**: `IJsonLdDocument`
+> `optional` **publicProfile?**: `IJsonLdDocument`
 
 The public profile data.
 
 #### privateProfile?
 
-> `optional` **privateProfile**: `IJsonLdDocument`
+> `optional` **privateProfile?**: `IJsonLdDocument`
 
 The private profile data.

package/docs/reference/interfaces/IIdentityProofCreateRequest.md

@@ -4,7 +4,7 @@ Request to create a proof.
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 
@@ -24,7 +24,7 @@ The verification method id to use.
 
 ***
 
-### body
+### body {#body}
 
 > **body**: `object`
 

package/docs/reference/interfaces/IIdentityProofCreateResponse.md

@@ -4,7 +4,7 @@ Response to creating a proof.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `IProof`
 

package/docs/reference/interfaces/IIdentityProofVerifyRequest.md

@@ -4,7 +4,7 @@ Request to verify a proof.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `object`
 

package/docs/reference/interfaces/IIdentityProofVerifyResponse.md

@@ -4,7 +4,7 @@ Response to verifying a proof.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `object`
 

package/docs/reference/interfaces/IIdentityRemoveRequest.md

@@ -4,7 +4,7 @@ Request to remove an identity.
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 

package/docs/reference/interfaces/IIdentityResolveRequest.md

@@ -4,7 +4,7 @@ Resolve an identity.
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 

package/docs/reference/interfaces/IIdentityResolveResponse.md

@@ -4,7 +4,7 @@ Response to resolving an identity.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `IDidDocument`
 

package/docs/reference/interfaces/IIdentityResolverComponent.md

@@ -8,7 +8,7 @@ Interface describing a contract which provides identity operations.
 
 ## Methods
 
-### identityResolve()
+### identityResolve() {#identityresolve}
 
 > **identityResolve**(`identity`): `Promise`\<`IDidDocument`\>
 

package/docs/reference/interfaces/IIdentityResolverConnector.md

@@ -8,7 +8,7 @@ Interface describing an identity connector.
 
 ## Methods
 
-### resolveDocument()
+### resolveDocument() {#resolvedocument}
 
 > **resolveDocument**(`documentId`): `Promise`\<`IDidDocument`\>
 

package/docs/reference/interfaces/IIdentityServiceCreateRequest.md

@@ -4,7 +4,7 @@ Request to create a service.
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 
@@ -18,7 +18,7 @@ The identity to create the service for.
 
 ***
 
-### body
+### body {#body}
 
 > **body**: `object`
 

package/docs/reference/interfaces/IIdentityServiceCreateResponse.md

@@ -4,7 +4,7 @@ Response to creating a service.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `IDidService`
 

package/docs/reference/interfaces/IIdentityServiceRemoveRequest.md

@@ -4,7 +4,7 @@ Request to remove a service.
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 

package/docs/reference/interfaces/IIdentityVerifiableCredentialCreateRequest.md

@@ -4,7 +4,7 @@ Request to create a verifiable credential.
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 
@@ -24,7 +24,7 @@ The verification method id to use.
 
 ***
 
-### body
+### body {#body}
 
 > **body**: `object`
 
@@ -32,7 +32,7 @@ The data for the request.
 
 #### credentialId?
 
-> `optional` **credentialId**: `string`
+> `optional` **credentialId?**: `string`
 
 The id of the credential.
 
@@ -44,12 +44,32 @@ The credential subject to store in the verifiable credential.
 
 #### revocationIndex?
 
-> `optional` **revocationIndex**: `number`
+> `optional` **revocationIndex?**: `number`
 
 The bitmap revocation index of the credential, if undefined will not have revocation status.
 
 #### expirationDate?
 
-> `optional` **expirationDate**: `string`
+> `optional` **expirationDate?**: `string`
 
 The date the verifiable credential is valid until.
+
+#### jwtHeaderFields?
+
+> `optional` **jwtHeaderFields?**: `object`
+
+Additional fields to include in the JWT when creating the verifiable credential in jwt format.
+
+##### Index Signature
+
+\[`id`: `string`\]: `string`
+
+#### jwtPayloadFields?
+
+> `optional` **jwtPayloadFields?**: `object`
+
+Additional fields to include in the JWT payload when creating the verifiable credential in jwt format.
+
+##### Index Signature
+
+\[`id`: `string`\]: `string`

package/docs/reference/interfaces/IIdentityVerifiableCredentialCreateResponse.md

@@ -4,7 +4,7 @@ Response to creating a verifiable credential.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `object`
 

package/docs/reference/interfaces/IIdentityVerifiableCredentialRevokeRequest.md

@@ -4,7 +4,7 @@ Request to revoke a verifiable credential.
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 

package/docs/reference/interfaces/IIdentityVerifiableCredentialUnrevokeRequest.md

@@ -4,7 +4,7 @@ Request to unrevoke a verifiable credential.
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 

package/docs/reference/interfaces/IIdentityVerifiableCredentialVerifyDocumentRequest.md

@@ -0,0 +1,11 @@
+# Interface: IIdentityVerifiableCredentialVerifyDocumentRequest
+
+Request to verify a verifiable credential.
+
+## Properties
+
+### body {#body}
+
+> **body**: `IDidVerifiableCredential`
+
+The body parameters.

package/docs/reference/interfaces/IIdentityVerifiableCredentialVerifyRequest.md

@@ -4,7 +4,7 @@ Request to verify a verifiable credential.
 
 ## Properties
 
-### query
+### query {#query}
 
 > **query**: `object`
 

package/docs/reference/interfaces/IIdentityVerifiableCredentialVerifyResponse.md

@@ -4,7 +4,7 @@ Response to verifying a verifiable credential.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `object`
 
@@ -18,6 +18,6 @@ Has the credential been revoked.
 
 #### verifiableCredential?
 
-> `optional` **verifiableCredential**: `IDidVerifiableCredential`
+> `optional` **verifiableCredential?**: `IDidVerifiableCredential`
 
 The verifiable credential that was verified.

package/docs/reference/interfaces/IIdentityVerifiablePresentationCreateRequest.md

@@ -4,7 +4,7 @@ Request to create a verifiable presentation.
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 
@@ -24,7 +24,7 @@ The verification method id to use.
 
 ***
 
-### body
+### body {#body}
 
 > **body**: `object`
 
@@ -32,19 +32,19 @@ The data for the request.
 
 #### presentationId?
 
-> `optional` **presentationId**: `string`
+> `optional` **presentationId?**: `string`
 
 The id of the presentation.
 
 #### contexts?
 
-> `optional` **contexts**: `IJsonLdContextDefinitionRoot`
+> `optional` **contexts?**: `IJsonLdContextDefinitionRoot`
 
 The context to use for the presentation.
 
 #### types?
 
-> `optional` **types**: `string` \| `string`[]
+> `optional` **types?**: `string` \| `string`[]
 
 The types of the presentation.
 
@@ -54,8 +54,28 @@ The types of the presentation.
 
 The verifiable credentials to include in the presentation.
 
-#### expiresInMinutes?
+#### expirationDate?
 
-> `optional` **expiresInMinutes**: `number`
+> `optional` **expirationDate?**: `string`
 
-The expiration time for the presentation.
+The expiration date/time for the presentation.
+
+#### jwtHeaderFields?
+
+> `optional` **jwtHeaderFields?**: `object`
+
+Additional fields to include in the JWT header when creating the verifiable presentation in jwt format.
+
+##### Index Signature
+
+\[`id`: `string`\]: `string`
+
+#### jwtPayloadFields?
+
+> `optional` **jwtPayloadFields?**: `object`
+
+Additional fields to include in the JWT payload when creating the verifiable presentation in jwt format.
+
+##### Index Signature
+
+\[`id`: `string`\]: `string`

package/docs/reference/interfaces/IIdentityVerifiablePresentationCreateResponse.md

@@ -4,7 +4,7 @@ Response to creating a verifiable presentation.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `object`
 

package/docs/reference/interfaces/IIdentityVerifiablePresentationVerifyDocumentRequest.md

@@ -0,0 +1,11 @@
+# Interface: IIdentityVerifiablePresentationVerifyDocumentRequest
+
+Request to verify a verifiable presentation.
+
+## Properties
+
+### body {#body}
+
+> **body**: `IDidVerifiablePresentation`
+
+The body parameters.

package/docs/reference/interfaces/IIdentityVerifiablePresentationVerifyRequest.md

@@ -4,7 +4,7 @@ Request to verify a verifiable presentation.
 
 ## Properties
 
-### query
+### query {#query}
 
 > **query**: `object`
 

package/docs/reference/interfaces/IIdentityVerifiablePresentationVerifyResponse.md

@@ -4,7 +4,7 @@ Response to verifying a verifiable presentation.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `object`
 
@@ -18,12 +18,12 @@ Has the presentation been revoked.
 
 #### verifiablePresentation?
 
-> `optional` **verifiablePresentation**: `IDidVerifiablePresentation`
+> `optional` **verifiablePresentation?**: `IDidVerifiablePresentation`
 
 The verifiable presentation that was verified.
 
 #### issuers?
 
-> `optional` **issuers**: `IDidDocument`[]
+> `optional` **issuers?**: `IDidDocument`[]
 
 The issuers of the presentation.

package/docs/reference/interfaces/IIdentityVerificationMethodCreateRequest.md

@@ -4,7 +4,7 @@ Request to create a verification method.
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 
@@ -18,7 +18,7 @@ The identity to create the verification method for.
 
 ***
 
-### body
+### body {#body}
 
 > **body**: `object`
 
@@ -32,6 +32,6 @@ The type of the verification method to create.
 
 #### verificationMethodId?
 
-> `optional` **verificationMethodId**: `string`
+> `optional` **verificationMethodId?**: `string`
 
 The optional id for the verification method, will be allocated if not supplied.

package/docs/reference/interfaces/IIdentityVerificationMethodCreateResponse.md

@@ -4,7 +4,7 @@ Response to creating a verification method.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `IDidDocumentVerificationMethod`
 

package/docs/reference/interfaces/IIdentityVerificationMethodRemoveRequest.md

@@ -4,7 +4,7 @@ Request to remove a verification method.
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 

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

@@ -0,0 +1,5 @@
+# Type Alias: IdentityMetricIds
+
+> **IdentityMetricIds** = *typeof* [`IdentityMetricIds`](../variables/IdentityMetricIds.md)\[keyof *typeof* [`IdentityMetricIds`](../variables/IdentityMetricIds.md)\]
+
+Union type of all identity service metric ID string values.

package/docs/reference/variables/IdentityMetricIds.md

@@ -0,0 +1,67 @@
+# Variable: IdentityMetricIds
+
+> `const` **IdentityMetricIds**: `object`
+
+Metric IDs for the identity service.
+
+## Type Declaration
+
+### DidsCreated {#didscreated}
+
+> `readonly` **DidsCreated**: `"identity_dids_created"` = `"identity_dids_created"`
+
+Number of DIDs created.
+
+### DidsRemoved {#didsremoved}
+
+> `readonly` **DidsRemoved**: `"identity_dids_removed"` = `"identity_dids_removed"`
+
+Number of DIDs removed.
+
+### VcsCreated {#vcscreated}
+
+> `readonly` **VcsCreated**: `"identity_vcs_created"` = `"identity_vcs_created"`
+
+Number of verifiable credentials created.
+
+### VcsVerified {#vcsverified}
+
+> `readonly` **VcsVerified**: `"identity_vcs_verified"` = `"identity_vcs_verified"`
+
+Number of VC verifications succeeded.
+
+### VcsVerificationFailed {#vcsverificationfailed}
+
+> `readonly` **VcsVerificationFailed**: `"identity_vcs_verification_failed"` = `"identity_vcs_verification_failed"`
+
+Number of VC verifications failed.
+
+### VcsRevoked {#vcsrevoked}
+
+> `readonly` **VcsRevoked**: `"identity_vcs_revoked"` = `"identity_vcs_revoked"`
+
+Number of VCs revoked.
+
+### VcsUnrevoked {#vcsunrevoked}
+
+> `readonly` **VcsUnrevoked**: `"identity_vcs_unrevoked"` = `"identity_vcs_unrevoked"`
+
+Number of VCs unrevoked.
+
+### VpsCreated {#vpscreated}
+
+> `readonly` **VpsCreated**: `"identity_vps_created"` = `"identity_vps_created"`
+
+Number of verifiable presentations created.
+
+### VpsVerified {#vpsverified}
+
+> `readonly` **VpsVerified**: `"identity_vps_verified"` = `"identity_vps_verified"`
+
+Number of VP verifications succeeded.
+
+### VpsVerificationFailed {#vpsverificationfailed}
+
+> `readonly` **VpsVerificationFailed**: `"identity_vps_verification_failed"` = `"identity_vps_verification_failed"`
+
+Number of VP verifications failed.

package/docs/reference/variables/IdentityMetrics.md

@@ -0,0 +1,5 @@
+# Variable: IdentityMetrics
+
+> `const` **IdentityMetrics**: `ITelemetryMetric`[]
+
+Metrics registered by the identity service.

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/identity-models",
-	"version": "0.0.3-next.9",
-	"description": "Models which define the structure of the contracts and connectors",
+	"version": "0.9.0",
+	"description": "Shared identity models and contracts for consistent data structures across services, connectors, and clients.",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/twinfoundation/identity.git",
+		"url": "git+https://github.com/iotaledger/twin-identity.git",
 		"directory": "packages/identity-models"
 	},
 	"author": "martyn.janes@iota.org",
@@ -14,13 +14,14 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/context": "next",
-		"@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/context": "^0.9.0",
+		"@twin.org/core": "^0.9.0",
+		"@twin.org/data-core": "^0.9.0",
+		"@twin.org/data-json-ld": "^0.9.0",
+		"@twin.org/entity": "^0.9.0",
+		"@twin.org/standards-w3c-did": "^0.9.0",
+		"@twin.org/telemetry-models": "^0.9.0",
+		"@twin.org/web": "^0.9.0"
 	},
 	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
@@ -53,7 +54,7 @@
 		"schemas"
 	],
 	"bugs": {
-		"url": "git+https://github.com/twinfoundation/identity/issues"
+		"url": "git+https://github.com/iotaledger/twin-identity/issues"
 	},
 	"homepage": "https://twindev.org"
 }