@twin.org/identity-rest-client 0.0.3-next.2 → 0.0.3-next.21

package/docs/examples.md

@@ -1 +1,175 @@
-# @twin.org/identity-rest-client - Examples
+# Identity REST Client Examples
+
+Use these examples to call identity REST endpoints from applications that need document lifecycle, credential, and profile operations.
+
+## IdentityRestClient
+
+```typescript
+import { IdentityRestClient } from '@twin.org/identity-rest-client';
+
+const client = new IdentityRestClient({
+  endpoint: 'http://localhost:8080'
+});
+
+const className = client.className();
+const createdDocument = await client.identityCreate('iota');
+
+await client.identityRemove(createdDocument.id);
+
+console.log(className); // IdentityRestClient
+console.log(createdDocument.id); // did:iota:tst:0x...
+```
+
+```typescript
+import { IdentityRestClient } from '@twin.org/identity-rest-client';
+import { DidVerificationMethodType, ProofTypes } from '@twin.org/standards-w3c-did';
+
+const client = new IdentityRestClient({
+  endpoint: 'http://localhost:8080'
+});
+
+const did = 'did:iota:tst:0x1234abcd';
+
+const verificationMethod = await client.verificationMethodCreate(
+  did,
+  DidVerificationMethodType.VerificationMethod,
+  'signing-key'
+);
+
+await client.verificationMethodRemove(verificationMethod.id);
+
+const service = await client.serviceCreate(
+  did,
+  'linked-domain',
+  'LinkedDomains',
+  'https://example.org'
+);
+
+await client.serviceRemove(service.id);
+
+const credentialCreateResult = await client.verifiableCredentialCreate(
+  `${did}#signing-key`,
+  'urn:uuid:credential-001',
+  {
+    id: 'did:iota:tst:0x5678efab',
+    name: 'Alice'
+  },
+  {
+    revocationIndex: 2
+  }
+);
+
+const credentialVerificationResult = await client.verifiableCredentialVerify(
+  credentialCreateResult.jwt
+);
+
+await client.verifiableCredentialRevoke(did, 2);
+await client.verifiableCredentialUnrevoke(did, 2);
+
+const presentationCreateResult = await client.verifiablePresentationCreate(
+  `${did}#signing-key`,
+  'urn:uuid:presentation-001',
+  ['https://www.w3.org/2018/credentials/v1'],
+  ['VerifiablePresentation'],
+  [credentialCreateResult.jwt]
+);
+
+const presentationVerificationResult = await client.verifiablePresentationVerify(
+  presentationCreateResult.jwt
+);
+
+const proof = await client.proofCreate(`${did}#signing-key`, ProofTypes.DataIntegrityProof, {
+  id: 'urn:example:doc-1',
+  name: 'Sample'
+});
+
+const proofVerified = await client.proofVerify(
+  {
+    id: 'urn:example:doc-1',
+    name: 'Sample'
+  },
+  proof
+);
+
+console.log(credentialVerificationResult.revoked); // false
+console.log(presentationVerificationResult.revoked); // false
+console.log(proofVerified); // true
+```
+
+## IdentityProfileRestClient
+
+```typescript
+import { IdentityProfileRestClient } from '@twin.org/identity-rest-client';
+
+interface PublicProfile {
+  displayName: string;
+  website: string;
+}
+
+interface PrivateProfile {
+  contactEmail: string;
+}
+
+const profileClient = new IdentityProfileRestClient<PublicProfile, PrivateProfile>({
+  endpoint: 'http://localhost:8080'
+});
+
+const className = profileClient.className();
+
+await profileClient.create(
+  {
+    displayName: 'Alice',
+    website: 'https://example.org'
+  },
+  {
+    contactEmail: 'alice@example.org'
+  }
+);
+
+const profile = await profileClient.get(['displayName'], ['contactEmail']);
+const publicProfile = await profileClient.getPublic(profile.identity, ['displayName']);
+
+await profileClient.update(
+  {
+    displayName: 'Alice Doe',
+    website: 'https://example.org'
+  },
+  {
+    contactEmail: 'alice.doe@example.org'
+  }
+);
+
+const profileList = await profileClient.list(
+  [
+    {
+      propertyName: 'displayName',
+      propertyValue: 'Alice Doe'
+    }
+  ],
+  ['displayName'],
+  undefined,
+  10
+);
+
+await profileClient.remove();
+
+console.log(className); // IdentityProfileRestClient
+console.log(publicProfile.displayName); // Alice
+console.log(profileList.items.length); // 1
+```
+
+## IdentityResolverRestClient
+
+```typescript
+import { IdentityResolverRestClient } from '@twin.org/identity-rest-client';
+
+const resolverClient = new IdentityResolverRestClient({
+  endpoint: 'http://localhost:8080'
+});
+
+const className = resolverClient.className();
+const didDocument = await resolverClient.identityResolve('did:iota:tst:0x1234abcd');
+
+console.log(className); // IdentityResolverRestClient
+console.log(didDocument.id); // did:iota:tst:0x1234abcd
+```

package/docs/reference/classes/IdentityProfileRestClient.md

@@ -46,7 +46,7 @@ The configuration for the client.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -54,7 +54,7 @@ Runtime name for the class.
 
 ## Methods
 
-### className()
+### className() {#classname}
 
 > **className**(): `string`
 
@@ -72,7 +72,7 @@ The class name of the component.
 
 ***
 
-### create()
+### create() {#create}
 
 > **create**(`publicProfile?`, `privateProfile?`): `Promise`\<`void`\>
 
@@ -104,7 +104,7 @@ Nothing.
 
 ***
 
-### get()
+### get() {#get}
 
 > **get**(`publicPropertyNames?`, `privatePropertyNames?`): `Promise`\<\{ `identity`: `string`; `publicProfile?`: `Partial`\<`T`\>; `privateProfile?`: `Partial`\<`U`\>; \}\>
 
@@ -136,7 +136,7 @@ The identity and the items properties.
 
 ***
 
-### getPublic()
+### getPublic() {#getpublic}
 
 > **getPublic**(`identity`, `propertyNames?`): `Promise`\<`Partial`\<`T`\>\>
 
@@ -168,7 +168,7 @@ The items properties.
 
 ***
 
-### update()
+### update() {#update}
 
 > **update**(`publicProfile?`, `privateProfile?`): `Promise`\<`void`\>
 
@@ -200,7 +200,7 @@ Nothing.
 
 ***
 
-### remove()
+### remove() {#remove}
 
 > **remove**(): `Promise`\<`void`\>
 
@@ -218,7 +218,7 @@ Nothing.
 
 ***
 
-### list()
+### list() {#list}
 
 > **list**(`publicFilters?`, `publicPropertyNames?`, `cursor?`, `limit?`): `Promise`\<\{ `items`: `object`[]; `cursor?`: `string`; \}\>
 

package/docs/reference/classes/IdentityResolverRestClient.md

@@ -36,7 +36,7 @@ The configuration for the client.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -44,7 +44,7 @@ Runtime name for the class.
 
 ## Methods
 
-### className()
+### className() {#classname}
 
 > **className**(): `string`
 
@@ -62,7 +62,7 @@ The class name of the component.
 
 ***
 
-### identityResolve()
+### identityResolve() {#identityresolve}
 
 > **identityResolve**(`documentId`): `Promise`\<`IDidDocument`\>
 

package/docs/reference/classes/IdentityRestClient.md

@@ -36,7 +36,7 @@ The configuration for the client.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -44,7 +44,7 @@ Runtime name for the class.
 
 ## Methods
 
-### className()
+### className() {#classname}
 
 > **className**(): `string`
 
@@ -62,7 +62,7 @@ The class name of the component.
 
 ***
 
-### identityCreate()
+### identityCreate() {#identitycreate}
 
 > **identityCreate**(`namespace?`): `Promise`\<`IDidDocument`\>
 
@@ -88,7 +88,7 @@ The created identity document.
 
 ***
 
-### identityRemove()
+### identityRemove() {#identityremove}
 
 > **identityRemove**(`identity`): `Promise`\<`void`\>
 
@@ -114,7 +114,7 @@ Nothing.
 
 ***
 
-### verificationMethodCreate()
+### verificationMethodCreate() {#verificationmethodcreate}
 
 > **verificationMethodCreate**(`identity`, `verificationMethodType`, `verificationMethodId?`): `Promise`\<`IDidDocumentVerificationMethod`\>
 
@@ -160,7 +160,7 @@ NotSupportedError if the platform does not support multiple keys.
 
 ***
 
-### verificationMethodRemove()
+### verificationMethodRemove() {#verificationmethodremove}
 
 > **verificationMethodRemove**(`verificationMethodId`): `Promise`\<`void`\>
 
@@ -194,7 +194,7 @@ NotSupportedError if the platform does not support multiple revocable keys.
 
 ***
 
-### serviceCreate()
+### serviceCreate() {#servicecreate}
 
 > **serviceCreate**(`identity`, `serviceId`, `serviceType`, `serviceEndpoint`): `Promise`\<`IDidService`\>
 
@@ -216,15 +216,15 @@ The id of the service.
 
 ##### serviceType
 
-The type of the service.
+`string` \| `string`[]
 
-`string` | `string`[]
+The type of the service.
 
 ##### serviceEndpoint
 
-The endpoint for the service.
+`string` \| `string`[]
 
-`string` | `string`[]
+The endpoint for the service.
 
 #### Returns
 
@@ -242,7 +242,7 @@ NotFoundError if the id can not be resolved.
 
 ***
 
-### serviceRemove()
+### serviceRemove() {#serviceremove}
 
 > **serviceRemove**(`serviceId`): `Promise`\<`void`\>
 
@@ -272,7 +272,89 @@ NotFoundError if the id can not be resolved.
 
 ***
 
-### verifiableCredentialCreate()
+### alsoKnownAsAdd() {#alsoknownasadd}
+
+> **alsoKnownAsAdd**(`documentId`, `alias`): `Promise`\<`void`\>
+
+Add an alias to the alsoKnownAs property on the document.
+If the alias is already present the operation is a no-op.
+
+#### Parameters
+
+##### documentId
+
+`string`
+
+The id of the document to update.
+
+##### alias
+
+`string`
+
+The alias to add. Must be a Url or Urn (typically another DID).
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Throws
+
+GeneralError if the alias is not a Url or Urn.
+
+#### Throws
+
+NotFoundError if the id can not be resolved.
+
+#### Implementation of
+
+`IIdentityComponent.alsoKnownAsAdd`
+
+***
+
+### alsoKnownAsRemove() {#alsoknownasremove}
+
+> **alsoKnownAsRemove**(`documentId`, `alias`): `Promise`\<`void`\>
+
+Remove an alias from the alsoKnownAs property on the document.
+If the alias is not present the operation is a no-op.
+
+#### Parameters
+
+##### documentId
+
+`string`
+
+The id of the document to update.
+
+##### alias
+
+`string`
+
+The alias to remove. Must be a Url or Urn.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Throws
+
+GeneralError if the alias is not a Url or Urn.
+
+#### Throws
+
+NotFoundError if the id can not be resolved.
+
+#### Implementation of
+
+`IIdentityComponent.alsoKnownAsRemove`
+
+***
+
+### verifiableCredentialCreate() {#verifiablecredentialcreate}
 
 > **verifiableCredentialCreate**(`verificationMethodId`, `id`, `subject`, `options?`): `Promise`\<\{ `verifiableCredential`: `IDidVerifiableCredential`; `jwt`: `string`; \}\>
 
@@ -288,9 +370,9 @@ The verification method id to use.
 
 ##### id
 
-The id of the credential.
+`string` \| `undefined`
 
-`string` | `undefined`
+The id of the credential.
 
 ##### subject
 
@@ -330,17 +412,17 @@ NotFoundError if the id can not be resolved.
 
 ***
 
-### verifiableCredentialVerify()
+### verifiableCredentialVerify() {#verifiablecredentialverify}
 
-> **verifiableCredentialVerify**(`credentialJwt`): `Promise`\<\{ `revoked`: `boolean`; `verifiableCredential?`: `IDidVerifiableCredential`; \}\>
+> **verifiableCredentialVerify**(`credential`): `Promise`\<\{ `revoked`: `boolean`; `verifiableCredential?`: `IDidVerifiableCredential`; \}\>
 
 Verify a verifiable credential is valid.
 
 #### Parameters
 
-##### credentialJwt
+##### credential
 
-`string`
+`string` \| `IDidVerifiableCredential`
 
 The credential to verify.
 
@@ -356,7 +438,7 @@ The credential stored in the jwt and the revocation status.
 
 ***
 
-### verifiableCredentialRevoke()
+### verifiableCredentialRevoke() {#verifiablecredentialrevoke}
 
 > **verifiableCredentialRevoke**(`issuerId`, `credentialIndex`): `Promise`\<`void`\>
 
@@ -388,7 +470,7 @@ Nothing.
 
 ***
 
-### verifiableCredentialUnrevoke()
+### verifiableCredentialUnrevoke() {#verifiablecredentialunrevoke}
 
 > **verifiableCredentialUnrevoke**(`issuerId`, `credentialIndex`): `Promise`\<`void`\>
 
@@ -420,9 +502,9 @@ Nothing.
 
 ***
 
-### verifiablePresentationCreate()
+### verifiablePresentationCreate() {#verifiablepresentationcreate}
 
-> **verifiablePresentationCreate**(`verificationMethodId`, `presentationId`, `contexts`, `types`, `verifiableCredentials`, `expiresInMinutes?`): `Promise`\<\{ `verifiablePresentation`: `IDidVerifiablePresentation`; `jwt`: `string`; \}\>
+> **verifiablePresentationCreate**(`verificationMethodId`, `presentationId`, `contexts`, `types`, `verifiableCredentials`, `options?`): `Promise`\<\{ `verifiablePresentation`: `IDidVerifiablePresentation`; `jwt`: `string`; \}\>
 
 Create a verifiable presentation from the supplied verifiable credentials.
 
@@ -436,21 +518,21 @@ The method to associate with the presentation.
 
 ##### presentationId
 
-The id of the presentation.
+`string` \| `undefined`
 
-`string` | `undefined`
+The id of the presentation.
 
 ##### contexts
 
-The contexts for the data stored in the verifiable credential.
+`IJsonLdContextDefinitionRoot` \| `undefined`
 
-`IJsonLdContextDefinitionRoot` | `undefined`
+The contexts for the data stored in the verifiable credential.
 
 ##### types
 
-The types for the data stored in the verifiable credential.
+`string` \| `string`[] \| `undefined`
 
-`string` | `string`[] | `undefined`
+The types for the data stored in the verifiable credential.
 
 ##### verifiableCredentials
 
@@ -458,11 +540,15 @@ The types for the data stored in the verifiable credential.
 
 The credentials to use for creating the presentation in jwt format.
 
-##### expiresInMinutes?
+##### options?
 
-`number`
+Additional options for creating the verifiable presentation.
 
-The time in minutes for the presentation to expire.
+###### expirationDate?
+
+`Date`
+
+The date the verifiable presentation is valid until.
 
 #### Returns
 
@@ -480,17 +566,17 @@ NotFoundError if the id can not be resolved.
 
 ***
 
-### verifiablePresentationVerify()
+### verifiablePresentationVerify() {#verifiablepresentationverify}
 
-> **verifiablePresentationVerify**(`presentationJwt`): `Promise`\<\{ `revoked`: `boolean`; `verifiablePresentation?`: `IDidVerifiablePresentation`; `issuers?`: `IDidDocument`[]; \}\>
+> **verifiablePresentationVerify**(`presentation`): `Promise`\<\{ `revoked`: `boolean`; `verifiablePresentation?`: `IDidVerifiablePresentation`; `issuers?`: `IDidDocument`[]; \}\>
 
 Verify a verifiable presentation is valid.
 
 #### Parameters
 
-##### presentationJwt
+##### presentation
 
-`string`
+`string` \| `IDidVerifiablePresentation`
 
 The presentation to verify.
 
@@ -506,7 +592,7 @@ The presentation stored in the jwt and the revocation status.
 
 ***
 
-### proofCreate()
+### proofCreate() {#proofcreate}
 
 > **proofCreate**(`verificationMethodId`, `proofType`, `unsecureDocument`): `Promise`\<`IProof`\>
 
@@ -544,7 +630,7 @@ The proof.
 
 ***
 
-### proofVerify()
+### proofVerify() {#proofverify}
 
 > **proofVerify**(`document`, `proof`): `Promise`\<`boolean`\>
 

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/identity-rest-client",
-	"version": "0.0.3-next.2",
-	"description": "Identity contract implementation which can connect to REST endpoints",
+	"version": "0.0.3-next.21",
+	"description": "Client library for consuming identity REST endpoints through shared request and response contracts.",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/twinfoundation/identity.git",
+		"url": "git+https://github.com/iotaledger/identity.git",
 		"directory": "packages/identity-rest-client"
 	},
 	"author": "martyn.janes@iota.org",
@@ -20,7 +20,7 @@
 		"@twin.org/data-core": "next",
 		"@twin.org/data-json-ld": "next",
 		"@twin.org/entity": "next",
-		"@twin.org/identity-models": "0.0.3-next.2",
+		"@twin.org/identity-models": "0.0.3-next.21",
 		"@twin.org/nameof": "next",
 		"@twin.org/standards-w3c-did": "next"
 	},
@@ -52,7 +52,7 @@
 		"authentication"
 	],
 	"bugs": {
-		"url": "git+https://github.com/twinfoundation/identity/issues"
+		"url": "git+https://github.com/iotaledger/identity/issues"
 	},
 	"homepage": "https://twindev.org"
 }