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

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

@@ -1,6 +1,6 @@
 # Class: IdentityProfileRestClient\<T, U\>
 
-Client for performing identity through to REST endpoints.
+Client for performing identity profile operations through REST endpoints.
 
 ## Extends
 
@@ -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`\>
 
@@ -96,7 +96,7 @@ The private profile data as JSON-LD.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the profile has been created.
 
 #### Implementation of
 
@@ -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`\>
 
@@ -192,7 +192,7 @@ The private profile data as JSON-LD.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the profile has been updated.
 
 #### Implementation of
 
@@ -200,7 +200,7 @@ Nothing.
 
 ***
 
-### remove()
+### remove() {#remove}
 
 > **remove**(): `Promise`\<`void`\>
 
@@ -210,7 +210,7 @@ Delete the profile for an identity.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the profile has been removed.
 
 #### Implementation of
 
@@ -218,7 +218,7 @@ Nothing.
 
 ***
 
-### list()
+### list() {#list}
 
 > **list**(`publicFilters?`, `publicPropertyNames?`, `cursor?`, `limit?`): `Promise`\<\{ `items`: `object`[]; `cursor?`: `string`; \}\>
 

package/docs/reference/classes/IdentityResolverRestClient.md

@@ -1,6 +1,6 @@
 # Class: IdentityResolverRestClient
 
-Client for performing identity through to REST endpoints.
+Client for performing identity resolution through REST endpoints.
 
 ## Extends
 
@@ -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`\>