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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (47) hide show
  1. package/README.md +2 -2
  2. package/dist/es/identityProfileRoutes.js +1 -2
  3. package/dist/es/identityProfileRoutes.js.map +1 -1
  4. package/dist/es/identityProfileService.js +3 -3
  5. package/dist/es/identityProfileService.js.map +1 -1
  6. package/dist/es/identityResolverRoutes.js +3 -4
  7. package/dist/es/identityResolverRoutes.js.map +1 -1
  8. package/dist/es/identityResolverService.js +3 -0
  9. package/dist/es/identityResolverService.js.map +1 -1
  10. package/dist/es/identityRoutes.js +284 -14
  11. package/dist/es/identityRoutes.js.map +1 -1
  12. package/dist/es/identityService.js +154 -31
  13. package/dist/es/identityService.js.map +1 -1
  14. package/dist/es/models/IIdentityResolverServiceConfig.js.map +1 -1
  15. package/dist/es/models/IIdentityServiceConfig.js.map +1 -1
  16. package/dist/es/models/IIdentityServiceConstructorOptions.js.map +1 -1
  17. package/dist/es/restEntryPoints.js +3 -0
  18. package/dist/es/restEntryPoints.js.map +1 -1
  19. package/dist/types/identityProfileService.d.ts +3 -3
  20. package/dist/types/identityResolverRoutes.d.ts +1 -1
  21. package/dist/types/identityResolverService.d.ts +1 -0
  22. package/dist/types/identityRoutes.d.ts +33 -1
  23. package/dist/types/identityService.d.ts +59 -12
  24. package/dist/types/models/IIdentityResolverServiceConfig.d.ts +1 -1
  25. package/dist/types/models/IIdentityServiceConfig.d.ts +1 -1
  26. package/dist/types/models/IIdentityServiceConstructorOptions.d.ts +4 -0
  27. package/dist/types/restEntryPoints.d.ts +3 -0
  28. package/docs/changelog.md +682 -101
  29. package/docs/examples.md +196 -1
  30. package/docs/open-api/spec.json +804 -482
  31. package/docs/reference/classes/IdentityProfileService.md +11 -11
  32. package/docs/reference/classes/IdentityResolverService.md +7 -3
  33. package/docs/reference/classes/IdentityService.md +188 -44
  34. package/docs/reference/functions/generateRestRoutesIdentityResolver.md +1 -1
  35. package/docs/reference/functions/identityAlsoKnownAsCreate.md +31 -0
  36. package/docs/reference/functions/identityAlsoKnownAsRemove.md +31 -0
  37. package/docs/reference/functions/identityVerifiableCredentialVerifyDocument.md +31 -0
  38. package/docs/reference/functions/identityVerifiablePresentationVerifyDocument.md +31 -0
  39. package/docs/reference/index.md +4 -0
  40. package/docs/reference/interfaces/IIdentityProfileServiceConstructorOptions.md +2 -2
  41. package/docs/reference/interfaces/IIdentityResolverServiceConfig.md +3 -3
  42. package/docs/reference/interfaces/IIdentityResolverServiceConstructorOptions.md +4 -4
  43. package/docs/reference/interfaces/IIdentityServiceConfig.md +3 -3
  44. package/docs/reference/interfaces/IIdentityServiceConstructorOptions.md +10 -2
  45. package/docs/reference/variables/restEntryPoints.md +2 -0
  46. package/locales/en.json +2 -0
  47. package/package.json +17 -16
@@ -39,11 +39,15 @@
39
39
  - [identityVerificationMethodRemove](functions/identityVerificationMethodRemove.md)
40
40
  - [identityServiceCreate](functions/identityServiceCreate.md)
41
41
  - [identityServiceRemove](functions/identityServiceRemove.md)
42
+ - [identityAlsoKnownAsCreate](functions/identityAlsoKnownAsCreate.md)
43
+ - [identityAlsoKnownAsRemove](functions/identityAlsoKnownAsRemove.md)
42
44
  - [identityVerifiableCredentialCreate](functions/identityVerifiableCredentialCreate.md)
43
45
  - [identityVerifiableCredentialVerify](functions/identityVerifiableCredentialVerify.md)
46
+ - [identityVerifiableCredentialVerifyDocument](functions/identityVerifiableCredentialVerifyDocument.md)
44
47
  - [identityVerifiableCredentialRevoke](functions/identityVerifiableCredentialRevoke.md)
45
48
  - [identityVerifiableCredentialUnrevoke](functions/identityVerifiableCredentialUnrevoke.md)
46
49
  - [identityVerifiablePresentationCreate](functions/identityVerifiablePresentationCreate.md)
47
50
  - [identityVerifiablePresentationVerify](functions/identityVerifiablePresentationVerify.md)
51
+ - [identityVerifiablePresentationVerifyDocument](functions/identityVerifiablePresentationVerifyDocument.md)
48
52
  - [identityProofCreate](functions/identityProofCreate.md)
49
53
  - [identityProofVerify](functions/identityProofVerify.md)
@@ -4,9 +4,9 @@ Options for the identity profile service constructor.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### profileEntityConnectorType?
7
+ ### profileEntityConnectorType? {#profileentityconnectortype}
8
8
 
9
- > `optional` **profileEntityConnectorType**: `string`
9
+ > `optional` **profileEntityConnectorType?**: `string`
10
10
 
11
11
  The storage connector for the profiles.
12
12
 
@@ -4,8 +4,8 @@ Configuration for the Identity Resolver Service.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### defaultNamespace?
7
+ ### defaultNamespace? {#defaultnamespace}
8
8
 
9
- > `optional` **defaultNamespace**: `string`
9
+ > `optional` **defaultNamespace?**: `string`
10
10
 
11
- What is the default connector to use for Identity. If not provided the first connector from the factory will be used.
11
+ The default connector namespace to use for identity resolution. If not provided, the first registered connector is used.
@@ -4,9 +4,9 @@ Options for the identity resolver service constructor.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### fallbackResolverConnectorType?
7
+ ### fallbackResolverConnectorType? {#fallbackresolverconnectortype}
8
8
 
9
- > `optional` **fallbackResolverConnectorType**: `string`
9
+ > `optional` **fallbackResolverConnectorType?**: `string`
10
10
 
11
11
  Fallback connector type to use if the namespace connector is not available.
12
12
 
@@ -18,8 +18,8 @@ universal
18
18
 
19
19
  ***
20
20
 
21
- ### config?
21
+ ### config? {#config}
22
22
 
23
- > `optional` **config**: [`IIdentityResolverServiceConfig`](IIdentityResolverServiceConfig.md)
23
+ > `optional` **config?**: [`IIdentityResolverServiceConfig`](IIdentityResolverServiceConfig.md)
24
24
 
25
25
  The configuration for the identity service.
@@ -4,8 +4,8 @@ Configuration for the Identity Service.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### defaultNamespace?
7
+ ### defaultNamespace? {#defaultnamespace}
8
8
 
9
- > `optional` **defaultNamespace**: `string`
9
+ > `optional` **defaultNamespace?**: `string`
10
10
 
11
- What is the default connector to use for Identity. If not provided the first connector from the factory will be used.
11
+ The default connector namespace to use for identity operations. If not provided, the first registered connector is used.
@@ -4,8 +4,16 @@ Options for the identity service constructor.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### config?
7
+ ### config? {#config}
8
8
 
9
- > `optional` **config**: [`IIdentityServiceConfig`](IIdentityServiceConfig.md)
9
+ > `optional` **config?**: [`IIdentityServiceConfig`](IIdentityServiceConfig.md)
10
10
 
11
11
  The configuration for the identity service.
12
+
13
+ ***
14
+
15
+ ### telemetryComponentType? {#telemetrycomponenttype}
16
+
17
+ > `optional` **telemetryComponentType?**: `string`
18
+
19
+ The component type for the optional telemetry component used for event metrics.
@@ -1,3 +1,5 @@
1
1
  # Variable: restEntryPoints
2
2
 
3
3
  > `const` **restEntryPoints**: `IRestRouteEntryPoint`[]
4
+
5
+ REST entry points for the identity, identity resolver, and identity profile services.
package/locales/en.json CHANGED
@@ -11,6 +11,8 @@
11
11
  "verificationMethodRemoveFailed": "Removing the verification method failed \"{verificationMethodId}\"",
12
12
  "serviceCreateFailed": "Creating the service failed for identity \"{identity}\", service \"{serviceId}\"",
13
13
  "serviceRemoveFailed": "Removing the service failed \"{serviceId}\"",
14
+ "alsoKnownAsAddFailed": "Adding to the alsoKnownAs property failed for identity \"{identity}\"",
15
+ "alsoKnownAsRemoveFailed": "Removing from the alsoKnownAs property failed for identity \"{identity}\"",
14
16
  "verifiableCredentialCreateFailed": "Creating the verifiable credential failed for method \"{verificationMethodId}\"",
15
17
  "verifiableCredentialVerifyFailed": "Verifying the verifiable credential failed",
16
18
  "verifiableCredentialRevokeFailed": "Revoking the verifiable credential failed for document \"{issuerIdentity}\" with index \"{credentialIndex}\"",
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "@twin.org/identity-service",
3
- "version": "0.0.3-next.9",
4
- "description": "Identity contract implementation and REST endpoint definitions",
3
+ "version": "0.9.0",
4
+ "description": "Service contracts and REST endpoint definitions for exposing identity workflows through stable interfaces.",
5
5
  "repository": {
6
6
  "type": "git",
7
- "url": "git+https://github.com/twinfoundation/identity.git",
7
+ "url": "git+https://github.com/iotaledger/twin-identity.git",
8
8
  "directory": "packages/identity-service"
9
9
  },
10
10
  "author": "martyn.janes@iota.org",
@@ -14,18 +14,19 @@
14
14
  "node": ">=20.0.0"
15
15
  },
16
16
  "dependencies": {
17
- "@twin.org/api-models": "next",
18
- "@twin.org/context": "next",
19
- "@twin.org/core": "next",
20
- "@twin.org/crypto": "next",
21
- "@twin.org/data-core": "next",
22
- "@twin.org/data-json-ld": "next",
23
- "@twin.org/entity": "next",
24
- "@twin.org/entity-storage-models": "next",
25
- "@twin.org/identity-models": "0.0.3-next.9",
26
- "@twin.org/standards-w3c-did": "next",
27
- "@twin.org/vault-models": "next",
28
- "@twin.org/web": "next"
17
+ "@twin.org/api-models": "^0.9.0",
18
+ "@twin.org/context": "^0.9.0",
19
+ "@twin.org/core": "^0.9.0",
20
+ "@twin.org/crypto": "^0.9.0",
21
+ "@twin.org/data-core": "^0.9.0",
22
+ "@twin.org/data-json-ld": "^0.9.0",
23
+ "@twin.org/entity": "^0.9.0",
24
+ "@twin.org/entity-storage-models": "^0.9.0",
25
+ "@twin.org/identity-models": "^0.9.0",
26
+ "@twin.org/standards-w3c-did": "^0.9.0",
27
+ "@twin.org/telemetry-models": "^0.9.0",
28
+ "@twin.org/vault-models": "^0.9.0",
29
+ "@twin.org/web": "^0.9.0"
29
30
  },
30
31
  "main": "./dist/es/index.js",
31
32
  "types": "./dist/types/index.d.ts",
@@ -58,7 +59,7 @@
58
59
  "business-logic"
59
60
  ],
60
61
  "bugs": {
61
- "url": "git+https://github.com/twinfoundation/identity/issues"
62
+ "url": "git+https://github.com/iotaledger/twin-identity/issues"
62
63
  },
63
64
  "homepage": "https://twindev.org"
64
65
  }