@twin.org/identity-models 0.9.1 → 0.9.2-next.10

package/docs/reference/interfaces/IIdentityProfileAdminRemoveRequest.md

@@ -0,0 +1,17 @@
+# Interface: IIdentityProfileAdminRemoveRequest
+
+Request to remove the profile of another user as an admin.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### userIdentity
+
+> **userIdentity**: `string`
+
+The identity of the user whose profile is to be removed.

package/docs/reference/interfaces/IIdentityProfileAdminUpdateRequest.md

@@ -0,0 +1,37 @@
+# Interface: IIdentityProfileAdminUpdateRequest
+
+Request to update the profile of another user as an admin.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### userIdentity
+
+> **userIdentity**: `string`
+
+The identity of the user whose profile is to be updated.
+
+***
+
+### body {#body}
+
+> **body**: `object`
+
+The data for the request.
+
+#### publicProfile?
+
+> `optional` **publicProfile?**: `IJsonLdDocument`
+
+The public profile data.
+
+#### privateProfile?
+
+> `optional` **privateProfile?**: `IJsonLdDocument`
+
+The private profile data.

package/docs/reference/interfaces/IIdentityProfileComponent.md

@@ -207,3 +207,55 @@ The maximum number of items in a page.
 `Promise`\<\{ `items`: `object`[]; `cursor?`: `string`; \}\>
 
 The list of items and cursor for paging.
+
+***
+
+### listAdmin() {#listadmin}
+
+> **listAdmin**(`publicFilters?`, `privateFilters?`, `publicPropertyNames?`, `privatePropertyNames?`, `cursor?`, `limit?`): `Promise`\<\{ `items`: `object`[]; `cursor?`: `string`; \}\>
+
+Get a list of identities including private profile data.
+
+#### Parameters
+
+##### publicFilters?
+
+`object`[]
+
+The filters to apply to the identities public profiles.
+
+##### privateFilters?
+
+`object`[]
+
+The filters to apply to the identities private profiles.
+
+##### publicPropertyNames?
+
+keyof `T`[]
+
+The public properties to get for the profile, defaults to all.
+
+##### privatePropertyNames?
+
+keyof `U`[]
+
+The private properties to get for the profile, defaults to none.
+
+##### cursor?
+
+`string`
+
+The cursor for paged requests.
+
+##### limit?
+
+`number`
+
+The maximum number of items in a page.
+
+#### Returns
+
+`Promise`\<\{ `items`: `object`[]; `cursor?`: `string`; \}\>
+
+The list of items and cursor for paging.

package/docs/reference/interfaces/IIdentityRemoveRequest.md

@@ -15,3 +15,17 @@ The data for the request.
 > **identity**: `string`
 
 The identity to remove.
+
+***
+
+### query? {#query}
+
+> `optional` **query?**: `object`
+
+The query parameters.
+
+#### removeKeys?
+
+> `optional` **removeKeys?**: `string`
+
+Also remove any associated private keys from the vault.

package/docs/reference/interfaces/IIdentityVerificationMethodRemoveRequest.md

@@ -21,3 +21,17 @@ The identity to remove the verification method from.
 > **verificationMethodId**: `string`
 
 The verification method to remove.
+
+***
+
+### query? {#query}
+
+> `optional` **query?**: `object`
+
+The query parameters.
+
+#### removeKeys?
+
+> `optional` **removeKeys?**: `string`
+
+Also remove any associated private key from the vault.

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

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

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

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

package/docs/reference/variables/IdentitySpanAttributes.md

@@ -0,0 +1,25 @@
+# Variable: IdentitySpanAttributes
+
+> `const` **IdentitySpanAttributes**: `object`
+
+The span attribute keys for the identity domain.
+
+## Type Declaration
+
+### Id {#id}
+
+> `readonly` **Id**: `"identity.id"` = `"identity.id"`
+
+The id of the identity document the operation is for.
+
+### VerificationMethodId {#verificationmethodid}
+
+> `readonly` **VerificationMethodId**: `"identity.verification-method-id"` = `"identity.verification-method-id"`
+
+The id of the verification method the operation is for.
+
+### ServiceId {#serviceid}
+
+> `readonly` **ServiceId**: `"identity.service-id"` = `"identity.service-id"`
+
+The id of the service the operation is for.

package/docs/reference/variables/IdentitySpanNames.md

@@ -0,0 +1,103 @@
+# Variable: IdentitySpanNames
+
+> `const` **IdentitySpanNames**: `object`
+
+The span names for the identity domain.
+
+## Type Declaration
+
+### Create {#create}
+
+> `readonly` **Create**: `"identity/create"` = `"identity/create"`
+
+Create an identity.
+
+### Remove {#remove}
+
+> `readonly` **Remove**: `"identity/remove"` = `"identity/remove"`
+
+Remove an identity.
+
+### VerificationMethodCreate {#verificationmethodcreate}
+
+> `readonly` **VerificationMethodCreate**: `"identity/verification-method-create"` = `"identity/verification-method-create"`
+
+Create a verification method.
+
+### VerificationMethodRemove {#verificationmethodremove}
+
+> `readonly` **VerificationMethodRemove**: `"identity/verification-method-remove"` = `"identity/verification-method-remove"`
+
+Remove a verification method.
+
+### ServiceCreate {#servicecreate}
+
+> `readonly` **ServiceCreate**: `"identity/service-create"` = `"identity/service-create"`
+
+Create a service.
+
+### ServiceRemove {#serviceremove}
+
+> `readonly` **ServiceRemove**: `"identity/service-remove"` = `"identity/service-remove"`
+
+Remove a service.
+
+### AlsoKnownAsAdd {#alsoknownasadd}
+
+> `readonly` **AlsoKnownAsAdd**: `"identity/also-known-as-add"` = `"identity/also-known-as-add"`
+
+Add an also known as alias.
+
+### AlsoKnownAsRemove {#alsoknownasremove}
+
+> `readonly` **AlsoKnownAsRemove**: `"identity/also-known-as-remove"` = `"identity/also-known-as-remove"`
+
+Remove an also known as alias.
+
+### VerifiableCredentialCreate {#verifiablecredentialcreate}
+
+> `readonly` **VerifiableCredentialCreate**: `"identity/verifiable-credential-create"` = `"identity/verifiable-credential-create"`
+
+Create a verifiable credential.
+
+### VerifiableCredentialVerify {#verifiablecredentialverify}
+
+> `readonly` **VerifiableCredentialVerify**: `"identity/verifiable-credential-verify"` = `"identity/verifiable-credential-verify"`
+
+Verify a verifiable credential.
+
+### VerifiableCredentialRevoke {#verifiablecredentialrevoke}
+
+> `readonly` **VerifiableCredentialRevoke**: `"identity/verifiable-credential-revoke"` = `"identity/verifiable-credential-revoke"`
+
+Revoke a verifiable credential.
+
+### VerifiableCredentialUnrevoke {#verifiablecredentialunrevoke}
+
+> `readonly` **VerifiableCredentialUnrevoke**: `"identity/verifiable-credential-unrevoke"` = `"identity/verifiable-credential-unrevoke"`
+
+Unrevoke a verifiable credential.
+
+### VerifiablePresentationCreate {#verifiablepresentationcreate}
+
+> `readonly` **VerifiablePresentationCreate**: `"identity/verifiable-presentation-create"` = `"identity/verifiable-presentation-create"`
+
+Create a verifiable presentation.
+
+### VerifiablePresentationVerify {#verifiablepresentationverify}
+
+> `readonly` **VerifiablePresentationVerify**: `"identity/verifiable-presentation-verify"` = `"identity/verifiable-presentation-verify"`
+
+Verify a verifiable presentation.
+
+### ProofCreate {#proofcreate}
+
+> `readonly` **ProofCreate**: `"identity/proof-create"` = `"identity/proof-create"`
+
+Create a proof.
+
+### ProofVerify {#proofverify}
+
+> `readonly` **ProofVerify**: `"identity/proof-verify"` = `"identity/proof-verify"`
+
+Verify a proof.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/identity-models",
-	"version": "0.9.1",
+	"version": "0.9.2-next.10",
 	"description": "Shared identity models and contracts for consistent data structures across services, connectors, and clients.",
 	"repository": {
 		"type": "git",
@@ -14,14 +14,15 @@
 		"node": ">=24.0.0"
 	},
 	"dependencies": {
-		"@twin.org/context": "^0.9.1",
-		"@twin.org/core": "^0.9.1",
-		"@twin.org/data-core": "^0.9.1",
-		"@twin.org/data-json-ld": "^0.9.1",
-		"@twin.org/entity": "^0.9.1",
-		"@twin.org/standards-w3c-did": "^0.9.1",
-		"@twin.org/telemetry-models": "^0.9.1",
-		"@twin.org/web": "^0.9.1"
+		"@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/nameof": "next",
+		"@twin.org/standards-w3c-did": "next",
+		"@twin.org/telemetry-models": "next",
+		"@twin.org/web": "next"
 	},
 	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",