diff --git a/docs/api/classes/cacheServerClient_cacheServerClient.CacheServerClient.md b/docs/api/classes/cacheServerClient_cacheServerClient.CacheServerClient.md index ad71eb9e..f80acdff 100644 --- a/docs/api/classes/cacheServerClient_cacheServerClient.CacheServerClient.md +++ b/docs/api/classes/cacheServerClient_cacheServerClient.CacheServerClient.md @@ -86,8 +86,7 @@ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.did` | `string` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"did"``\> | #### Returns @@ -123,8 +122,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.claimId` | `string` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"claimId"``\> | #### Returns @@ -145,7 +143,6 @@ ___ | Name | Type | | :------ | :------ | | `__namedParameters` | `Object` | -| `__namedParameters.namespace` | `string` | #### Returns @@ -165,8 +162,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.namespace` | `string` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"namespace"``\> | #### Returns @@ -186,8 +182,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.namespace` | `string` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"namespace"``\> | #### Returns @@ -207,8 +202,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.owner` | `string` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"owner"``\> | #### Returns @@ -228,8 +222,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.id` | `string` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"id"``\> | #### Returns @@ -249,12 +242,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.id` | `string` | -| `__namedParameters.order?` | [`Order`](../enums/cacheServerClient_cacheServerClient_types.Order.md) | -| `__namedParameters.skip?` | `number` | -| `__namedParameters.take?` | `number` | -| `__namedParameters.type?` | [`AssetHistoryEventType`](../enums/cacheServerClient_cacheServerClient_types.AssetHistoryEventType.md) | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"type"`` \| ``"id"`` \| ``"order"`` \| ``"take"`` \| ``"skip"``\> | #### Returns @@ -274,10 +262,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.did` | `string` | -| `__namedParameters.isAccepted?` | `boolean` | -| `__namedParameters.namespace?` | `string` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"did"`` \| ``"isAccepted"`` \| ``"parentNamespace"``\> | #### Returns @@ -297,10 +282,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.did` | `string` | -| `__namedParameters.isAccepted?` | `boolean` | -| `__namedParameters.namespace?` | `string` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"did"`` \| ``"isAccepted"`` \| ``"parentNamespace"``\> | #### Returns @@ -320,10 +302,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.did` | `string` | -| `__namedParameters.isAccepted?` | `boolean` | -| `__namedParameters.namespace?` | `string` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"did"`` \| ``"isAccepted"`` \| ``"parentNamespace"``\> | #### Returns @@ -363,8 +342,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.namespace` | `string` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"namespace"``\> | #### Returns @@ -384,9 +362,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.did` | `string` | -| `__namedParameters.includeClaims?` | `boolean` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"did"`` \| ``"includeClaims"``\> | #### Returns @@ -406,9 +382,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.search` | `string` | -| `__namedParameters.types?` | (``"App"`` \| ``"Org"`` \| ``"Role"``)[] | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"types"`` \| ``"search"``\> | #### Returns @@ -428,8 +402,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.did` | `string` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"did"``\> | #### Returns @@ -449,8 +422,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.namespace` | `string` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"namespace"``\> | #### Returns @@ -470,8 +442,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.namespace` | `string` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"namespace"``\> | #### Returns @@ -491,8 +462,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.namespace` | `string` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"namespace"``\> | #### Returns @@ -512,9 +482,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.excludeSubOrgs` | `boolean` | -| `__namedParameters.owner` | `string` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"owner"`` \| ``"excludeSubOrgs"``\> | #### Returns @@ -534,8 +502,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.did` | `string` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"did"``\> | #### Returns @@ -555,8 +522,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.owner` | `string` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"owner"``\> | #### Returns @@ -576,8 +542,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.namespace` | `string` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"namespace"``\> | #### Returns @@ -597,8 +562,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.owner` | `string` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"owner"``\> | #### Returns @@ -618,8 +582,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.namespace` | `string` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"namespace"``\> | #### Returns @@ -679,9 +642,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.did` | `string` | -| `__namedParameters.message` | [`IClaimIssuance`](../interfaces/iam.IClaimIssuance.md) | +| `__namedParameters` | [`IssueClaim`](../modules/cacheServerClient_cacheServerClient_types.md#issueclaim) | #### Returns @@ -715,9 +676,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.did` | `string` | -| `__namedParameters.message` | [`IClaimRejection`](../interfaces/iam.IClaimRejection.md) | +| `__namedParameters` | [`RejectClaim`](../modules/cacheServerClient_cacheServerClient_types.md#rejectclaim) | #### Returns @@ -737,9 +696,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.did` | `string` | -| `__namedParameters.message` | [`IClaimRequest`](../interfaces/iam.IClaimRequest.md) | +| `__namedParameters` | [`RequestClaim`](../modules/cacheServerClient_cacheServerClient_types.md#requestclaim) | #### Returns diff --git a/docs/api/interfaces/cacheServerClient_ICacheServerClient.ICacheServerClient.md b/docs/api/interfaces/cacheServerClient_ICacheServerClient.ICacheServerClient.md index 741aac4c..61eb6111 100644 --- a/docs/api/interfaces/cacheServerClient_ICacheServerClient.ICacheServerClient.md +++ b/docs/api/interfaces/cacheServerClient_ICacheServerClient.ICacheServerClient.md @@ -62,8 +62,7 @@ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.did` | `string` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"did"``\> | #### Returns @@ -79,8 +78,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.claimId` | `string` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"claimId"``\> | #### Returns @@ -96,8 +94,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.namespace` | `string` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"namespace"``\> | #### Returns @@ -113,8 +110,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.namespace` | `string` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"namespace"``\> | #### Returns @@ -130,8 +126,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.namespace` | `string` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"namespace"``\> | #### Returns @@ -147,8 +142,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.owner` | `string` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"owner"``\> | #### Returns @@ -164,8 +158,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.id` | `string` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"id"``\> | #### Returns @@ -181,12 +174,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.id` | `string` | -| `__namedParameters.order?` | [`Order`](../enums/cacheServerClient_cacheServerClient_types.Order.md) | -| `__namedParameters.skip?` | `number` | -| `__namedParameters.take?` | `number` | -| `__namedParameters.type?` | [`AssetHistoryEventType`](../enums/cacheServerClient_cacheServerClient_types.AssetHistoryEventType.md) | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"type"`` \| ``"id"`` \| ``"order"`` \| ``"take"`` \| ``"skip"``\> | #### Returns @@ -202,10 +190,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.did` | `string` | -| `__namedParameters.isAccepted?` | `boolean` | -| `__namedParameters.parentNamespace?` | `string` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"did"`` \| ``"isAccepted"`` \| ``"parentNamespace"``\> | #### Returns @@ -221,10 +206,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.did` | `string` | -| `__namedParameters.isAccepted?` | `boolean` | -| `__namedParameters.parentNamespace?` | `string` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"did"`` \| ``"isAccepted"`` \| ``"parentNamespace"``\> | #### Returns @@ -240,10 +222,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.did` | `string` | -| `__namedParameters.isAccepted?` | `boolean` | -| `__namedParameters.parentNamespace?` | `string` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"did"`` \| ``"isAccepted"`` \| ``"parentNamespace"``\> | #### Returns @@ -275,8 +254,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.namespace` | `string` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"namespace"``\> | #### Returns @@ -292,9 +270,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.did` | `string` | -| `__namedParameters.includeClaims?` | `boolean` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"did"`` \| ``"includeClaims"``\> | #### Returns @@ -310,9 +286,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.search` | `string` | -| `__namedParameters.types?` | (``"App"`` \| ``"Org"`` \| ``"Role"``)[] | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"types"`` \| ``"search"``\> | #### Returns @@ -328,8 +302,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.did` | `string` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"did"``\> | #### Returns @@ -345,8 +318,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.namespace` | `string` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"namespace"``\> | #### Returns @@ -362,8 +334,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.namespace` | `string` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"namespace"``\> | #### Returns @@ -379,8 +350,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.namespace` | `string` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"namespace"``\> | #### Returns @@ -396,9 +366,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.excludeSubOrgs` | `boolean` | -| `__namedParameters.owner` | `string` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"owner"`` \| ``"excludeSubOrgs"``\> | #### Returns @@ -414,8 +382,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.did` | `string` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"did"``\> | #### Returns @@ -431,8 +398,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.owner` | `string` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"owner"``\> | #### Returns @@ -448,8 +414,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.namespace` | `string` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"namespace"``\> | #### Returns @@ -465,8 +430,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.owner` | `string` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"owner"``\> | #### Returns @@ -482,8 +446,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.namespace` | `string` | +| `__namedParameters` | `Pick`<[`ClaimsQueryParams`](../modules/cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"namespace"``\> | #### Returns @@ -509,9 +472,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.did` | `string` | -| `__namedParameters.message` | [`IClaimIssuance`](iam.IClaimIssuance.md) | +| `__namedParameters` | [`IssueClaim`](../modules/cacheServerClient_cacheServerClient_types.md#issueclaim) | #### Returns @@ -537,9 +498,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.did` | `string` | -| `__namedParameters.message` | [`IClaimRejection`](iam.IClaimRejection.md) | +| `__namedParameters` | [`RejectClaim`](../modules/cacheServerClient_cacheServerClient_types.md#rejectclaim) | #### Returns @@ -555,9 +514,7 @@ ___ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.did` | `string` | -| `__namedParameters.message` | [`IClaimRequest`](iam.IClaimRequest.md) | +| `__namedParameters` | [`RequestClaim`](../modules/cacheServerClient_cacheServerClient_types.md#requestclaim) | #### Returns diff --git a/docs/api/modules/cacheServerClient_cacheServerClient_types.md b/docs/api/modules/cacheServerClient_cacheServerClient_types.md index 2e704d3b..c4001eb7 100644 --- a/docs/api/modules/cacheServerClient_cacheServerClient_types.md +++ b/docs/api/modules/cacheServerClient_cacheServerClient_types.md @@ -20,3 +20,54 @@ - [IOrganization](../interfaces/cacheServerClient_cacheServerClient_types.IOrganization.md) - [IRole](../interfaces/cacheServerClient_cacheServerClient_types.IRole.md) - [Profile](../interfaces/cacheServerClient_cacheServerClient_types.Profile.md) + +### Type aliases + +- [ClaimsQueryParams](cacheServerClient_cacheServerClient_types.md#claimsqueryparams) +- [IssueClaim](cacheServerClient_cacheServerClient_types.md#issueclaim) +- [RejectClaim](cacheServerClient_cacheServerClient_types.md#rejectclaim) +- [RequestClaim](cacheServerClient_cacheServerClient_types.md#requestclaim) + +## Type aliases + +### ClaimsQueryParams + +Ƭ **ClaimsQueryParams**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `claimId` | `string` | +| `did` | `string` | +| `excludeSubOrgs` | `boolean` | +| `id` | `string` | +| `includeClaims?` | `boolean` | +| `isAccepted?` | `boolean` | +| `namespace` | `string` | +| `order?` | [`Order`](../enums/cacheServerClient_cacheServerClient_types.Order.md) | +| `owner` | `string` | +| `parentNamespace?` | `string` | +| `search` | `string` | +| `skip?` | `number` | +| `take?` | `number` | +| `type?` | [`AssetHistoryEventType`](../enums/cacheServerClient_cacheServerClient_types.AssetHistoryEventType.md) | +| `types?` | (``"App"`` \| ``"Org"`` \| ``"Role"``)[] | + +___ + +### IssueClaim + +Ƭ **IssueClaim**: `Pick`<[`ClaimsQueryParams`](cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"did"``\> & { `message`: [`IClaimIssuance`](../interfaces/iam.IClaimIssuance.md) } + +___ + +### RejectClaim + +Ƭ **RejectClaim**: `Pick`<[`ClaimsQueryParams`](cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"did"``\> & { `message`: [`IClaimRejection`](../interfaces/iam.IClaimRejection.md) } + +___ + +### RequestClaim + +Ƭ **RequestClaim**: `Pick`<[`ClaimsQueryParams`](cacheServerClient_cacheServerClient_types.md#claimsqueryparams), ``"did"``\> & { `message`: [`IClaimRequest`](../interfaces/iam.IClaimRequest.md) } diff --git a/src/cacheServerClient/ICacheServerClient.ts b/src/cacheServerClient/ICacheServerClient.ts index 9dce0ed4..6a07cb8f 100644 --- a/src/cacheServerClient/ICacheServerClient.ts +++ b/src/cacheServerClient/ICacheServerClient.ts @@ -1,97 +1,76 @@ import { IAppDefinition, IOrganizationDefinition, IRoleDefinition } from "@energyweb/iam-contracts"; import { IDIDDocument } from "@ew-did-registry/did-resolver-interface"; -import { IClaimIssuance, IClaimRejection, IClaimRequest } from "../iam"; import { IPubKeyAndIdentityToken } from "../utils/getPublicKeyAndIdentityToken"; import { Asset, AssetHistory, - AssetHistoryEventType, Claim, + ClaimsQueryParams, IApp, IOrganization, IRole, - Order, + IssueClaim, + RejectClaim, + RequestClaim, } from "./cacheServerClient.types"; - export interface ICacheServerClient { pubKeyAndIdentityToken: IPubKeyAndIdentityToken | undefined; testLogin: () => Promise; login: () => Promise<{ pubKeyAndIdentityToken: IPubKeyAndIdentityToken; token: string; refreshToken: string }>; isAuthEnabled: () => boolean; - getRoleDefinition: ({ namespace }: { namespace: string }) => Promise; - getOrgDefinition: ({ namespace }: { namespace: string }) => Promise; - getAppDefinition: ({ namespace }: { namespace: string }) => Promise; - getApplicationRoles: ({ namespace }: { namespace: string }) => Promise; - getOrganizationRoles: ({ namespace }: { namespace: string }) => Promise; + getRoleDefinition: ({ namespace }: Pick) => Promise; + getOrgDefinition: ({ namespace }: Pick) => Promise; + getAppDefinition: ({ namespace }: Pick) => Promise; + getApplicationRoles: ({ namespace }: Pick) => Promise; + getOrganizationRoles: ({ namespace }: Pick) => Promise; getOrganizationsByOwner: ({ owner, excludeSubOrgs, - }: { - owner: string; - excludeSubOrgs: boolean; - }) => Promise; - getApplicationsByOwner: ({ owner }: { owner: string }) => Promise; - getApplicationsByOrganization: ({ namespace }: { namespace: string }) => Promise; - getSubOrganizationsByOrganization: ({ namespace }: { namespace: string }) => Promise; - getOrgHierarchy: ({ namespace }: { namespace: string }) => Promise; + }: Pick) => Promise; + getApplicationsByOwner: ({ owner }: Pick) => Promise; + getApplicationsByOrganization: ({ namespace }: Pick) => Promise; + getSubOrganizationsByOrganization: ({ + namespace, + }: Pick) => Promise; + getOrgHierarchy: ({ namespace }: Pick) => Promise; getNamespaceBySearchPhrase: ({ types, search, - }: { - types?: ("App" | "Org" | "Role")[]; - search: string; - }) => Promise<(IOrganization | IApp | IRole)[]>; - getRolesByOwner: ({ owner }: { owner: string }) => Promise; + }: Pick) => Promise<(IOrganization | IApp | IRole)[]>; + getRolesByOwner: ({ owner }: Pick) => Promise; getClaimsBySubjects: (subjects: string[]) => Promise; getClaimsByIssuer: ({ did, isAccepted, parentNamespace, - }: { - did: string; - isAccepted?: boolean; - parentNamespace?: string; - }) => Promise; + }: Pick) => Promise; getClaimsByRequester: ({ did, isAccepted, parentNamespace, - }: { - did: string; - isAccepted?: boolean; - parentNamespace?: string; - }) => Promise; + }: Pick) => Promise; getClaimsBySubject: ({ did, isAccepted, parentNamespace, - }: { - did: string; - isAccepted?: boolean; - parentNamespace?: string; - }) => Promise; - requestClaim: ({ message, did }: { message: IClaimRequest; did: string }) => Promise; - issueClaim: ({ message, did }: { message: IClaimIssuance; did: string }) => Promise; - rejectClaim: ({ message, did }: { message: IClaimRejection; did: string }) => Promise; - deleteClaim: ({ claimId }: { claimId: string }) => Promise; - getDIDsForRole: ({ namespace }: { namespace: string }) => Promise; - getDidDocument: ({ did, includeClaims }: { did: string; includeClaims?: boolean }) => Promise; - addDIDToWatchList: ({ did }: { did: string }) => Promise; - getOwnedAssets: ({ did }: { did: string }) => Promise; - getOfferedAssets: ({ did }: { did: string }) => Promise; - getAssetById: ({ id }: { id: string }) => Promise; - getPreviouslyOwnedAssets: ({ owner }: { owner: string }) => Promise; + }: Pick) => Promise; + + requestClaim: ({ message, did }: RequestClaim) => Promise; + issueClaim: ({ message, did }: IssueClaim) => Promise; + rejectClaim: ({ message, did }: RejectClaim) => Promise; + deleteClaim: ({ claimId }: Pick) => Promise; + getDIDsForRole: ({ namespace }: Pick) => Promise; + getDidDocument: ({ did, includeClaims }: Pick) => Promise; + addDIDToWatchList: ({ did }: Pick) => Promise; + getOwnedAssets: ({ did }: Pick) => Promise; + getOfferedAssets: ({ did }: Pick) => Promise; + getAssetById: ({ id }: Pick) => Promise; + getPreviouslyOwnedAssets: ({ owner }: Pick) => Promise; getAssetHistory: ({ id, order, take, skip, type, - }: { - id: string; - order?: Order; - take?: number; - skip?: number; - type?: AssetHistoryEventType; - }) => Promise; + }: Pick) => Promise; } diff --git a/src/cacheServerClient/cacheServerClient.ts b/src/cacheServerClient/cacheServerClient.ts index 66eb5d8a..c78ac0a5 100644 --- a/src/cacheServerClient/cacheServerClient.ts +++ b/src/cacheServerClient/cacheServerClient.ts @@ -6,14 +6,14 @@ import { IRole, Claim, Asset, - Order, - AssetHistoryEventType, AssetHistory, + ClaimsQueryParams, + RejectClaim, + IssueClaim, + RequestClaim, } from "./cacheServerClient.types"; -import { IClaimIssuance, IClaimRejection, IClaimRequest } from "../iam"; import { IDIDDocument } from "@ew-did-registry/did-resolver-interface"; - import { ICacheServerClient } from "./ICacheServerClient"; import { detectExecutionEnvironment, ExecutionEnvironment } from "../utils/detectEnvironment"; import { getPublicKeyAndIdentityToken, IPubKeyAndIdentityToken } from "../utils/getPublicKeyAndIdentityToken"; @@ -138,49 +138,49 @@ export class CacheServerClient implements ICacheServerClient { } } - async getRoleDefinition({ namespace }: { namespace: string }) { + async getRoleDefinition({ namespace }: Pick) { const { data } = await this.httpClient.get(`/role/${namespace}`); return data?.definition; } - async getOrgDefinition({ namespace }: { namespace: string }) { + async getOrgDefinition({ namespace }: Pick) { const { data } = await this.httpClient.get(`/org/${namespace}`); return data?.definition; } - async getAppDefinition({ namespace }: { namespace: string }) { + async getAppDefinition({ namespace }) { const { data } = await this.httpClient.get(`/app/${namespace}`); return data?.definition; } - async getApplicationRoles({ namespace }: { namespace: string }) { + async getApplicationRoles({ namespace }: Pick) { const { data } = await this.httpClient.get(`/app/${namespace}/roles`); return data; } - async getOrganizationRoles({ namespace }: { namespace: string }) { + async getOrganizationRoles({ namespace }: Pick) { const { data } = await this.httpClient.get(`/org/${namespace}/roles`); return data; } - async getOrganizationsByOwner({ owner, excludeSubOrgs }: { owner: string; excludeSubOrgs: boolean }) { + async getOrganizationsByOwner({ owner, excludeSubOrgs }: Pick) { const { data } = await this.httpClient.get( `/org/owner/${owner}?excludeSubOrgs=${excludeSubOrgs}`, ); return data; } - async getSubOrganizationsByOrganization({ namespace }: { namespace: string }) { + async getSubOrganizationsByOrganization({ namespace }: Pick) { const { data } = await this.httpClient.get(`/org/${namespace}/suborgs`); return data; } - async getOrgHierarchy({ namespace }: { namespace: string }) { + async getOrgHierarchy({ namespace }: Pick) { const { data } = await this.httpClient.get(`/org/${namespace}`); return data; } - async getNamespaceBySearchPhrase({ types, search }: { types?: ("App" | "Org" | "Role")[]; search: string }) { + async getNamespaceBySearchPhrase({ types, search }: Pick) { if (types && types.length > 0) { const { data } = await this.httpClient.get<(IOrganization | IApp | IRole)[]>(`/search/${search}`, { params: { @@ -196,17 +196,17 @@ export class CacheServerClient implements ICacheServerClient { return data; } - async getApplicationsByOwner({ owner }: { owner: string }) { + async getApplicationsByOwner({ owner }: Pick) { const { data } = await this.httpClient.get(`/app/owner/${owner}`); return data; } - async getApplicationsByOrganization({ namespace }: { namespace: string }) { + async getApplicationsByOrganization({ namespace }: Pick) { const { data } = await this.httpClient.get(`/org/${namespace}/apps`); return data; } - async getRolesByOwner({ owner }: { owner: string }) { + async getRolesByOwner({ owner }: Pick) { const { data } = await this.httpClient.get(`/role/owner/${owner}`); return data; } @@ -218,11 +218,15 @@ export class CacheServerClient implements ICacheServerClient { return data; } - async getClaimsByIssuer({ did, isAccepted, namespace }: { did: string; isAccepted?: boolean; namespace?: string }) { + async getClaimsByIssuer({ + did, + isAccepted, + parentNamespace, + }: Pick) { const { data } = await this.httpClient.get(`/claim/issuer/${did}`, { params: { isAccepted, - namespace, + parentNamespace, }, }); return data; @@ -231,16 +235,12 @@ export class CacheServerClient implements ICacheServerClient { async getClaimsByRequester({ did, isAccepted, - namespace, - }: { - did: string; - isAccepted?: boolean; - namespace?: string; - }) { + parentNamespace, + }: Pick) { const { data } = await this.httpClient.get(`/claim/requester/${did}`, { params: { isAccepted, - namespace, + parentNamespace, }, }); return data; @@ -249,67 +249,63 @@ export class CacheServerClient implements ICacheServerClient { async getClaimsBySubject({ did, isAccepted, - namespace, - }: { - did: string; - isAccepted?: boolean; - namespace?: string; - }) { + parentNamespace, + }: Pick) { const { data } = await this.httpClient.get(`/claim/subject/${did}`, { params: { isAccepted, - namespace, + parentNamespace, }, }); return data; } - async requestClaim({ message, did }: { message: IClaimRequest; did: string }) { + async requestClaim({ message, did }: RequestClaim) { await this.httpClient.post(`/claim/request/${did}`, message); } - async issueClaim({ message, did }: { message: IClaimIssuance; did: string }) { + async issueClaim({ message, did }: IssueClaim) { await this.httpClient.post(`/claim/issue/${did}`, message); } - async rejectClaim({ message, did }: { message: IClaimRejection; did: string }) { + async rejectClaim({ message, did }: RejectClaim) { await this.httpClient.post(`/claim/reject/${did}`, message); } - async deleteClaim({ claimId }: { claimId: string }) { + async deleteClaim({ claimId }: Pick) { await this.httpClient.delete(`/claim/${claimId}`); } - async getDIDsForRole({ namespace }: { namespace: string }) { + async getDIDsForRole({ namespace }: Pick) { const { data } = await this.httpClient.get(`/claim/did/${namespace}?accepted=true`); return data; } - async getDidDocument({ did, includeClaims }: { did: string; includeClaims?: boolean }) { + async getDidDocument({ did, includeClaims }: Pick) { const { data } = await this.httpClient.get(`/DID/${did}?includeClaims=${includeClaims || false}`); return data; } - async addDIDToWatchList({ did }: { did: string }) { + async addDIDToWatchList({ did }: Pick) { await this.httpClient.post(`/DID/${did}`); } - async getOwnedAssets({ did }: { did: string }) { + async getOwnedAssets({ did }: Pick) { const { data } = await this.httpClient.get(`/assets/owner/${did}`); return data; } - async getOfferedAssets({ did }: { did: string }) { + async getOfferedAssets({ did }: Pick) { const { data } = await this.httpClient.get(`/assets/offered_to/${did}`); return data; } - async getAssetById({ id }: { id: string }) { + async getAssetById({ id }: Pick) { const { data } = await this.httpClient.get(`/assets/${id}`); return data; } - async getPreviouslyOwnedAssets({ owner }: { owner: string }) { + async getPreviouslyOwnedAssets({ owner }: Pick) { const { data } = await this.httpClient.get(`/assets/owner/history/${owner}`); return data; } @@ -320,13 +316,7 @@ export class CacheServerClient implements ICacheServerClient { take, skip, type, - }: { - id: string; - order?: Order; - take?: number; - skip?: number; - type?: AssetHistoryEventType; - }) { + }: Pick) { const query = stringify({ order, take, skip, type }, { skipNulls: true }); const { data } = await this.httpClient.get(`/assets/history/${id}?${query}`); return data; diff --git a/src/cacheServerClient/cacheServerClient.types.ts b/src/cacheServerClient/cacheServerClient.types.ts index be5aa71d..b3d40f56 100644 --- a/src/cacheServerClient/cacheServerClient.types.ts +++ b/src/cacheServerClient/cacheServerClient.types.ts @@ -1,5 +1,6 @@ import { IDIDDocument } from "@ew-did-registry/did-resolver-interface"; import { IRoleDefinition, IAppDefinition, IOrganizationDefinition } from "@energyweb/iam-contracts"; +import { IClaimIssuance, IClaimRejection, IClaimRequest } from "../iam"; export interface IRole { uid: string; @@ -105,3 +106,24 @@ export enum AssetHistoryEventType { ASSET_TRANSFERRED = "ASSET_TRANSFERRED", ASSET_OFFER_REJECTED = "ASSET_OFFER_REJECTED", } + +export type ClaimsQueryParams = { + namespace: string; + parentNamespace?: string; + id: string; + claimId: string; + did: string; + owner: string; + excludeSubOrgs: boolean; + includeClaims?: boolean; + isAccepted?: boolean; + types?: ("App" | "Org" | "Role")[]; + type?: AssetHistoryEventType; + search: string; + order?: Order; + take?: number; + skip?: number; +}; +export type RequestClaim = Pick & { message: IClaimRequest }; +export type IssueClaim = Pick & { message: IClaimIssuance }; +export type RejectClaim = Pick & { message: IClaimRejection };