@sphereon/ssi-sdk.kms-rest-client 0.34.1-feature.IDK.11.51 → 0.34.1-feature.IDK.11.53

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sphereon/ssi-sdk.kms-rest-client",
   "description": "contains the client side to call REST endpoints of a KMS server",
-  "version": "0.34.1-feature.IDK.11.51+a5d5ec05",
+  "version": "0.34.1-feature.IDK.11.53+3230e8fb",
   "source": "src/index.ts",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -28,7 +28,7 @@
     "generate-plugin-schema": "tsx ../../packages/dev/bin/sphereon.js dev generate-plugin-schema"
   },
   "dependencies": {
-    "@sphereon/ssi-types": "0.34.1-feature.IDK.11.51+a5d5ec05",
+    "@sphereon/ssi-types": "0.34.1-feature.IDK.11.53+3230e8fb",
     "cross-fetch": "^3.1.8"
   },
   "devDependencies": {
@@ -56,5 +56,5 @@
     "KMS",
     "REST"
   ],
-  "gitHead": "a5d5ec05589451cf2b55e3ee3a8fa8966aaf8cae"
+  "gitHead": "3230e8fbac34ec3e88c8907fbf55cdc95c696ed3"
 }

package/src/agent/KmsRestClient.ts

@@ -15,8 +15,8 @@ import type {
   KmsClientGetKeyProviderArgs,
   KmsClientListKeyProvidersArgs,
   KmsClientProviderListKeysArgs,
-  KmsClientProviderStoreKey,
-  KmsClientProviderGenerateKey,
+  KmsClientProviderStoreKeyArgs,
+  KmsClientProviderGenerateKeyArgs,
   KmsClientProviderGetKeyArgs,
   KmsClientProviderDeleteKeyArgs,
   RestClientAuthenticationOpts,
@@ -31,8 +31,6 @@ import type {
   ListKeyProvidersResponse,
   ListKeysResponse,
   ListResolversResponse,
-  ManagedKeyInfo,
-  ManagedKeyPair,
   ResolvedKeyInfo,
   ResolvePublicKey,
   Resolver,
@@ -40,22 +38,26 @@ import type {
   StoreKey,
   VerifyRawSignature,
   KeyProviderResponse,
+  GenerateKeyResponse,
+  StoreKeyResponse,
+  GetKeyResponse
 } from '../models'
 import {
   CreateRawSignatureResponseFromJSONTyped,
   CreateRawSignatureToJSONTyped,
   GenerateKeyGlobalToJSONTyped,
   GenerateKeyToJSONTyped,
+  GenerateKeyResponseFromJSONTyped,
+  GetKeyResponseFromJSONTyped,
   KeyProviderResponseFromJSONTyped,
   ListKeyProvidersResponseFromJSONTyped,
   ListKeysResponseFromJSONTyped,
   ListResolversResponseFromJSONTyped,
-  ManagedKeyInfoFromJSONTyped,
-  ManagedKeyPairFromJSONTyped,
   ResolvePublicKeyToJSONTyped,
   ResolvedKeyInfoFromJSONTyped,
   ResolverFromJSONTyped,
   StoreKeyToJSONTyped,
+  StoreKeyResponseFromJSONTyped,
   VerifyRawSignatureResponseFromJSONTyped,
   VerifyRawSignatureToJSONTyped
 } from '../models'
@@ -121,8 +123,8 @@ export class KmsRestClient implements IAgentPlugin {
   }
 
   /** {@inheritDoc IKmsRestClient.kmsListResolvers} */
-  private async kmsClientListResolvers(args: KmsClientListResolversArgs): Promise<ListResolversResponse> {
-    const baseUrl = this.assertedAgentBaseUrl(args.baseUrl)
+  private async kmsClientListResolvers(args?: KmsClientListResolversArgs): Promise<ListResolversResponse> {
+    const baseUrl = this.assertedAgentBaseUrl(args?.baseUrl)
     const url = KmsRestClient.urlWithBase('/resolvers', baseUrl)
 
     const response = await fetch(url, {
@@ -210,7 +212,7 @@ export class KmsRestClient implements IAgentPlugin {
   }
 
   /** {@inheritDoc IKmsRestClient.kmsGetKey} */
-  private async kmsClientGetKey(args: KmsClientGetKeyArgs): Promise<ManagedKeyInfo> {
+  private async kmsClientGetKey(args: KmsClientGetKeyArgs): Promise<GetKeyResponse> {
     const baseUrl = this.assertedAgentBaseUrl(args.baseUrl)
     const url = KmsRestClient.urlWithBase(`/keys/${args.aliasOrKid}`, baseUrl)
 
@@ -220,31 +222,30 @@ export class KmsRestClient implements IAgentPlugin {
     logger.debug(`get key response: ${response}`)
 
     try {
-      return ManagedKeyInfoFromJSONTyped(await response.json(), false)
+      return GetKeyResponseFromJSONTyped(await response.json(), false)
     } catch (error) {
       return Promise.reject(Error(`request to ${url} returned ${error}`))
     }
   }
 
   /** {@inheritDoc IKmsRestClient.kmsListKeys} */
-  private async kmsClientListKeys(args: KmsClientListKeysArgs): Promise<ListKeysResponse> {
-    const baseUrl = this.assertedAgentBaseUrl(args.baseUrl)
-    const url = this.addSearchParams(KmsRestClient.urlWithBase('/keys', baseUrl), { ...(args.providerId && { providerId: args.providerId }) })
+  private async kmsClientListKeys(args?: KmsClientListKeysArgs): Promise<ListKeysResponse> {
+    const baseUrl = this.assertedAgentBaseUrl(args?.baseUrl)
+    const url = this.addSearchParams(KmsRestClient.urlWithBase('/keys', baseUrl), { ...(args?.providerId && { providerId: args.providerId }) })
     const response = await fetch(url, {
       method: 'GET',
     })
     logger.debug(`list keys response: ${response}`)
 
     try {
-      const xx = await response.json()
-      return ListKeysResponseFromJSONTyped(xx, false)
+      return ListKeysResponseFromJSONTyped(await response.json(), false)
     } catch (error) {
       return Promise.reject(Error(`request to ${url} returned ${error}`))
     }
   }
 
   /** {@inheritDoc IKmsRestClient.kmsStoreKey} */
-  private async kmsClientStoreKey(args: KmsClientStoreKeyArgs): Promise<ManagedKeyInfo> {
+  private async kmsClientStoreKey(args: KmsClientStoreKeyArgs): Promise<StoreKeyResponse> {
     const baseUrl = this.assertedAgentBaseUrl(args.baseUrl)
     const url = KmsRestClient.urlWithBase(`/keys`, baseUrl)
 
@@ -260,14 +261,14 @@ export class KmsRestClient implements IAgentPlugin {
     logger.debug(`store key response: ${response}`)
 
     try {
-      return ManagedKeyInfoFromJSONTyped(await response.json(), false)
+      return StoreKeyResponseFromJSONTyped(await response.json(), false)
     } catch (error) {
       return Promise.reject(Error(`request to ${url} returned ${error}`))
     }
   }
 
   /** {@inheritDoc IKmsRestClient.kmsGenerateKey} */
-  private async kmsClientGenerateKey(args: KmsClientGenerateKeyArgs): Promise<ManagedKeyPair> {
+  private async kmsClientGenerateKey(args: KmsClientGenerateKeyArgs): Promise<GenerateKeyResponse> {
     const baseUrl = this.assertedAgentBaseUrl(args.baseUrl)
     const url = KmsRestClient.urlWithBase(`/keys/generate`, baseUrl)
 
@@ -285,7 +286,7 @@ export class KmsRestClient implements IAgentPlugin {
     logger.debug(`generate key response: ${response}`)
 
     try {
-      return ManagedKeyPairFromJSONTyped(await response.json(), false)
+      return GenerateKeyResponseFromJSONTyped(await response.json(), false)
     } catch (error) {
       return Promise.reject(Error(`request to ${url} returned ${error}`))
     }
@@ -321,8 +322,8 @@ export class KmsRestClient implements IAgentPlugin {
   }
 
   /** {@inheritDoc IKmsRestClient.kmsListKeyProviders} */
-  private async kmsClientListKeyProviders(args: KmsClientListKeyProvidersArgs): Promise<ListKeyProvidersResponse> {
-    const baseUrl = this.assertedAgentBaseUrl(args.baseUrl)
+  private async kmsClientListKeyProviders(args?: KmsClientListKeyProvidersArgs): Promise<ListKeyProvidersResponse> {
+    const baseUrl = this.assertedAgentBaseUrl(args?.baseUrl)
     const url = KmsRestClient.urlWithBase('/providers', baseUrl)
 
     const response = await fetch(url, {
@@ -355,7 +356,7 @@ export class KmsRestClient implements IAgentPlugin {
   }
 
   /** {@inheritDoc IKmsRestClient.kmsProviderStoreKey} */
-  private async kmsClientProviderStoreKey(args: KmsClientProviderStoreKey): Promise<ManagedKeyInfo> {
+  private async kmsClientProviderStoreKey(args: KmsClientProviderStoreKeyArgs): Promise<StoreKeyResponse> {
     const baseUrl = this.assertedAgentBaseUrl(args.baseUrl)
     const url = KmsRestClient.urlWithBase(`/providers/${args.providerId}/keys`, baseUrl)
 
@@ -371,14 +372,14 @@ export class KmsRestClient implements IAgentPlugin {
     logger.debug(`provider store key response: ${response}`)
 
     try {
-      return ManagedKeyInfoFromJSONTyped(await response.json(), false)
+      return StoreKeyResponseFromJSONTyped(await response.json(), false)
     } catch (error) {
       return Promise.reject(Error(`request to ${url} returned ${error}`))
     }
   }
 
   /** {@inheritDoc IKmsRestClient.kmsProviderGenerateKey} */
-  private async kmsClientProviderGenerateKey(args: KmsClientProviderGenerateKey): Promise<ManagedKeyPair> {
+  private async kmsClientProviderGenerateKey(args: KmsClientProviderGenerateKeyArgs): Promise<GenerateKeyResponse> {
     const baseUrl = this.assertedAgentBaseUrl(args.baseUrl)
     const url = KmsRestClient.urlWithBase(`/providers/${args.providerId}/keys/generate`, baseUrl)
 
@@ -395,14 +396,14 @@ export class KmsRestClient implements IAgentPlugin {
     logger.debug(`provider generate key response: ${response}`)
 
     try {
-      return ManagedKeyPairFromJSONTyped(await response.json(), false)
+      return GenerateKeyResponseFromJSONTyped(await response.json(), false)
     } catch (error) {
       return Promise.reject(Error(`request to ${url} returned ${error}`))
     }
   }
 
   /** {@inheritDoc IKmsRestClient.kmsProviderGetKey} */
-  private async kmsClientProviderGetKey(args: KmsClientProviderGetKeyArgs): Promise<ManagedKeyInfo> {
+  private async kmsClientProviderGetKey(args: KmsClientProviderGetKeyArgs): Promise<GetKeyResponse> {
     const baseUrl = this.assertedAgentBaseUrl(args.baseUrl)
     const url = KmsRestClient.urlWithBase(`/providers/${args.providerId}/keys/${args.aliasOrKid}`, baseUrl)
 
@@ -412,7 +413,7 @@ export class KmsRestClient implements IAgentPlugin {
     logger.debug(`get provider key response: ${response}`)
 
     try {
-      return ManagedKeyInfoFromJSONTyped(await response.json(), false)
+      return GetKeyResponseFromJSONTyped(await response.json(), false)
     } catch (error) {
       return Promise.reject(Error(`request to ${url} returned ${error}`))
     }

package/src/index.ts

@@ -5,3 +5,4 @@ import schema from '../plugin.schema.json'
 export { schema }
 export { KmsRestClient } from './agent/KmsRestClient'
 export type * from './types/IKmsRestClient'
+export * from './models'

package/src/types/IKmsRestClient.ts

@@ -5,37 +5,38 @@ import {
   CreateRawSignatureResponse,
   GenerateKey,
   GenerateKeyGlobal,
+  GenerateKeyResponse,
+  GetKeyResponse,
   KeyProviderResponse,
   ListKeyProvidersResponse,
   ListKeysResponse,
   ListResolversResponse,
-  ManagedKeyInfo,
-  ManagedKeyPair,
   ResolvedKeyInfo,
   ResolvePublicKey,
   Resolver,
   StoreKey,
+  StoreKeyResponse,
   VerifyRawSignature,
-  VerifyRawSignatureResponse,
+  VerifyRawSignatureResponse
 } from '../models'
 
 export interface IKmsRestClient extends IPluginMethodMap {
   kmsClientGetResolver(args: kmsClientGetResolverArgs): Promise<Resolver>
-  kmsClientListResolvers(args: KmsClientListResolversArgs): Promise<ListResolversResponse>
+  kmsClientListResolvers(args?: KmsClientListResolversArgs): Promise<ListResolversResponse>
   kmsClientResolveKey(args: KmsClientResolveKeyArgs): Promise<ResolvedKeyInfo>
   kmsClientCreateRawSignature(args: KmsClientCreateRawSignatureArgs): Promise<CreateRawSignatureResponse>
   kmsClientIsValidRawSignature(args: KmsClientIsValidRawSignatureArgs): Promise<VerifyRawSignatureResponse>
-  kmsClientGetKey(args: KmsClientGetKeyArgs): Promise<ManagedKeyInfo>
-  kmsClientListKeys(args: KmsClientListKeysArgs): Promise<ListKeysResponse>
-  kmsClientStoreKey(args: KmsClientStoreKeyArgs): Promise<ManagedKeyInfo>
-  kmsClientGenerateKey(args: KmsClientGenerateKeyArgs): Promise<ManagedKeyPair>
+  kmsClientGetKey(args: KmsClientGetKeyArgs): Promise<GetKeyResponse>
+  kmsClientListKeys(args?: KmsClientListKeysArgs): Promise<ListKeysResponse>
+  kmsClientStoreKey(args: KmsClientStoreKeyArgs): Promise<StoreKeyResponse>
+  kmsClientGenerateKey(args: KmsClientGenerateKeyArgs): Promise<GenerateKeyResponse>
   kmsClientDeleteKey(args: KmsClientDeleteKeyArgs): Promise<boolean>
   kmsClientGetKeyProvider(args: KmsClientGetKeyProviderArgs): Promise<KeyProviderResponse>
-  kmsClientListKeyProviders(args: KmsClientListKeyProvidersArgs): Promise<ListKeyProvidersResponse>
+  kmsClientListKeyProviders(args?: KmsClientListKeyProvidersArgs): Promise<ListKeyProvidersResponse>
   kmsClientProviderListKeys(args: KmsClientProviderListKeysArgs): Promise<ListKeysResponse>
-  kmsClientProviderStoreKey(args: KmsClientProviderStoreKey): Promise<ManagedKeyInfo>
-  kmsClientProviderGenerateKey(args: KmsClientProviderGenerateKey): Promise<ManagedKeyPair>
-  kmsClientProviderGetKey(args: KmsClientProviderGetKeyArgs): Promise<ManagedKeyInfo>
+  kmsClientProviderStoreKey(args: KmsClientProviderStoreKeyArgs): Promise<StoreKeyResponse>
+  kmsClientProviderGenerateKey(args: KmsClientProviderGenerateKeyArgs): Promise<GenerateKeyResponse>
+  kmsClientProviderGetKey(args: KmsClientProviderGetKeyArgs): Promise<GetKeyResponse>
   kmsClientProviderDeleteKey(args: KmsClientProviderDeleteKeyArgs): Promise<boolean>
 }
 
@@ -81,12 +82,12 @@ export type KmsClientGenerateKeyArgs = {
 
 export type KmsClientDeleteKeyArgs = {
   baseUrl?: string
-  aliasOrKid?: string
+  aliasOrKid: string
 }
 
 export type KmsClientGetKeyProviderArgs = {
   baseUrl?: string
-  providerId?: string
+  providerId: string
 }
 
 export type KmsClientListKeyProvidersArgs = {
@@ -98,12 +99,12 @@ export type KmsClientProviderListKeysArgs = {
   providerId: string
 }
 
-export type KmsClientProviderStoreKey = {
+export type KmsClientProviderStoreKeyArgs = {
   baseUrl?: string
   providerId: string
 } & StoreKey
 
-export type KmsClientProviderGenerateKey = {
+export type KmsClientProviderGenerateKeyArgs = {
   baseUrl?: string
   providerId: string
 } & GenerateKey