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

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.49+19dd3372",
+  "version": "0.34.1-feature.IDK.11.51+a5d5ec05",
   "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.49+19dd3372",
+    "@sphereon/ssi-types": "0.34.1-feature.IDK.11.51+a5d5ec05",
     "cross-fetch": "^3.1.8"
   },
   "devDependencies": {
@@ -56,5 +56,5 @@
     "KMS",
     "REST"
   ],
-  "gitHead": "19dd33727e96d37a7b9c9ff3dadcbfd2d1885d09"
+  "gitHead": "a5d5ec05589451cf2b55e3ee3a8fa8966aaf8cae"
 }

package/src/agent/KmsRestClient.ts

@@ -2,26 +2,26 @@ import { IAgentPlugin } from '@veramo/core'
 import { Loggers } from '@sphereon/ssi-types'
 import { fetch } from 'cross-fetch'
 import type {
-  kmsGetResolverArgs,
-  KmsListResolversArgs,
+  kmsClientGetResolverArgs,
+  KmsClientListResolversArgs,
   IKmsRestClient,
-  KmsResolveKeyArgs,
-  KmsCreateRawSignatureArgs,
-  KmsGetKeyArgs,
-  KmsListKeysArgs,
-  KmsStoreKeyArgs,
-  KmsGenerateKeyArgs,
-  KmsDeleteKeyArgs,
-  KmsGetKeyProviderArgs,
-  KmsListKeyProvidersArgs,
-  KmsProviderListKeysArgs,
-  KmsProviderStoreKey,
-  KmsProviderGenerateKey,
-  KmsProviderGetKeyArgs,
-  KmsProviderDeleteKeyArgs,
+  KmsClientResolveKeyArgs,
+  KmsClientCreateRawSignatureArgs,
+  KmsClientGetKeyArgs,
+  KmsClientListKeysArgs,
+  KmsClientStoreKeyArgs,
+  KmsClientGenerateKeyArgs,
+  KmsClientDeleteKeyArgs,
+  KmsClientGetKeyProviderArgs,
+  KmsClientListKeyProvidersArgs,
+  KmsClientProviderListKeysArgs,
+  KmsClientProviderStoreKey,
+  KmsClientProviderGenerateKey,
+  KmsClientProviderGetKeyArgs,
+  KmsClientProviderDeleteKeyArgs,
   RestClientAuthenticationOpts,
   KmsRestClientArgs,
-  KmsIsValidRawSignatureArgs,
+  KmsClientIsValidRawSignatureArgs,
 } from '../types/IKmsRestClient'
 import type {
   CreateRawSignature,
@@ -42,10 +42,11 @@ import type {
   KeyProviderResponse,
 } from '../models'
 import {
-  CreateRawSignatureToJSONTyped,
   CreateRawSignatureResponseFromJSONTyped,
+  CreateRawSignatureToJSONTyped,
   GenerateKeyGlobalToJSONTyped,
   GenerateKeyToJSONTyped,
+  KeyProviderResponseFromJSONTyped,
   ListKeyProvidersResponseFromJSONTyped,
   ListKeysResponseFromJSONTyped,
   ListResolversResponseFromJSONTyped,
@@ -54,10 +55,9 @@ import {
   ResolvePublicKeyToJSONTyped,
   ResolvedKeyInfoFromJSONTyped,
   ResolverFromJSONTyped,
-  VerifyRawSignatureResponseFromJSONTyped,
   StoreKeyToJSONTyped,
-  VerifyRawSignatureToJSONTyped,
-  KeyProviderResponseFromJSONTyped,
+  VerifyRawSignatureResponseFromJSONTyped,
+  VerifyRawSignatureToJSONTyped
 } from '../models'
 
 const logger = Loggers.DEFAULT.get('sphereon:ssi-sdk:kms:rest-client')
@@ -67,26 +67,26 @@ const logger = Loggers.DEFAULT.get('sphereon:ssi-sdk:kms:rest-client')
  */
 export class KmsRestClient implements IAgentPlugin {
   readonly methods: IKmsRestClient = {
-    kmsGetKey: this.kmsGetKey.bind(this),
-    kmsListKeys: this.kmsListKeys.bind(this),
-    kmsStoreKey: this.kmsStoreKey.bind(this),
-    kmsGenerateKey: this.kmsGenerateKey.bind(this),
-    kmsDeleteKey: this.kmsDeleteKey.bind(this),
-
-    kmsGetKeyProvider: this.kmsGetKeyProvider.bind(this),
-    kmsListKeyProviders: this.kmsListKeyProviders.bind(this),
-    kmsProviderListKeys: this.kmsProviderListKeys.bind(this),
-    kmsProviderStoreKey: this.kmsProviderStoreKey.bind(this),
-    kmsProviderGenerateKey: this.kmsProviderGenerateKey.bind(this),
-    kmsProviderGetKey: this.kmsProviderGetKey.bind(this),
-    kmsProviderDeleteKey: this.kmsProviderDeleteKey.bind(this),
-
-    kmsGetResolver: this.kmsGetResolver.bind(this),
-    kmsListResolvers: this.kmsListResolvers.bind(this),
-    kmsResolveKey: this.kmsResolveKey.bind(this),
-
-    kmsCreateRawSignature: this.kmsCreateRawSignature.bind(this),
-    kmsIsValidRawSignature: this.kmsIsValidRawSignature.bind(this),
+    kmsClientGetKey: this.kmsClientGetKey.bind(this),
+    kmsClientListKeys: this.kmsClientListKeys.bind(this),
+    kmsClientStoreKey: this.kmsClientStoreKey.bind(this),
+    kmsClientGenerateKey: this.kmsClientGenerateKey.bind(this),
+    kmsClientDeleteKey: this.kmsClientDeleteKey.bind(this),
+
+    kmsClientGetKeyProvider: this.kmsClientGetKeyProvider.bind(this),
+    kmsClientListKeyProviders: this.kmsClientListKeyProviders.bind(this),
+    kmsClientProviderListKeys: this.kmsClientProviderListKeys.bind(this),
+    kmsClientProviderStoreKey: this.kmsClientProviderStoreKey.bind(this),
+    kmsClientProviderGenerateKey: this.kmsClientProviderGenerateKey.bind(this),
+    kmsClientProviderGetKey: this.kmsClientProviderGetKey.bind(this),
+    kmsClientProviderDeleteKey: this.kmsClientProviderDeleteKey.bind(this),
+
+    kmsClientGetResolver: this.kmsClientGetResolver.bind(this),
+    kmsClientListResolvers: this.kmsClientListResolvers.bind(this),
+    kmsClientResolveKey: this.kmsClientResolveKey.bind(this),
+
+    kmsClientCreateRawSignature: this.kmsClientCreateRawSignature.bind(this),
+    kmsClientIsValidRawSignature: this.kmsClientIsValidRawSignature.bind(this),
   }
 
   private readonly agentBaseUrl?: string
@@ -104,7 +104,7 @@ export class KmsRestClient implements IAgentPlugin {
   }
 
   /** {@inheritDoc IKmsRestClient.kmsGetResolver} */
-  private async kmsGetResolver(args: kmsGetResolverArgs): Promise<Resolver> {
+  private async kmsClientGetResolver(args: kmsClientGetResolverArgs): Promise<Resolver> {
     const baseUrl = this.assertedAgentBaseUrl(args.baseUrl)
     const url = KmsRestClient.urlWithBase(`/resolvers/${args.resolverId}`, baseUrl)
 
@@ -121,7 +121,7 @@ export class KmsRestClient implements IAgentPlugin {
   }
 
   /** {@inheritDoc IKmsRestClient.kmsListResolvers} */
-  private async kmsListResolvers(args: KmsListResolversArgs): Promise<ListResolversResponse> {
+  private async kmsClientListResolvers(args: KmsClientListResolversArgs): Promise<ListResolversResponse> {
     const baseUrl = this.assertedAgentBaseUrl(args.baseUrl)
     const url = KmsRestClient.urlWithBase('/resolvers', baseUrl)
 
@@ -138,7 +138,7 @@ export class KmsRestClient implements IAgentPlugin {
   }
 
   /** {@inheritDoc IKmsRestClient.kmsResolveKey} */
-  private async kmsResolveKey(args: KmsResolveKeyArgs): Promise<ResolvedKeyInfo> {
+  private async kmsClientResolveKey(args: KmsClientResolveKeyArgs): Promise<ResolvedKeyInfo> {
     const baseUrl = this.assertedAgentBaseUrl(args.baseUrl)
     const url = KmsRestClient.urlWithBase(`/resolvers/${args.resolverId}/resolve`, baseUrl)
 
@@ -163,7 +163,7 @@ export class KmsRestClient implements IAgentPlugin {
   }
 
   /** {@inheritDoc IKmsRestClient.kmsCreateRawSignature} */
-  private async kmsCreateRawSignature(args: KmsCreateRawSignatureArgs): Promise<CreateRawSignatureResponse> {
+  private async kmsClientCreateRawSignature(args: KmsClientCreateRawSignatureArgs): Promise<CreateRawSignatureResponse> {
     const baseUrl = this.assertedAgentBaseUrl(args.baseUrl)
     const url = KmsRestClient.urlWithBase(`/signatures/raw`, baseUrl)
 
@@ -186,7 +186,7 @@ export class KmsRestClient implements IAgentPlugin {
   }
 
   /** {@inheritDoc IKmsRestClient.kmsIsValidRawSignature} */
-  private async kmsIsValidRawSignature(args: KmsIsValidRawSignatureArgs): Promise<VerifyRawSignatureResponse> {
+  private async kmsClientIsValidRawSignature(args: KmsClientIsValidRawSignatureArgs): Promise<VerifyRawSignatureResponse> {
     const baseUrl = this.assertedAgentBaseUrl(args.baseUrl)
     const url = KmsRestClient.urlWithBase(`/signatures/raw/verify`, baseUrl)
 
@@ -210,7 +210,7 @@ export class KmsRestClient implements IAgentPlugin {
   }
 
   /** {@inheritDoc IKmsRestClient.kmsGetKey} */
-  private async kmsGetKey(args: KmsGetKeyArgs): Promise<ManagedKeyInfo> {
+  private async kmsClientGetKey(args: KmsClientGetKeyArgs): Promise<ManagedKeyInfo> {
     const baseUrl = this.assertedAgentBaseUrl(args.baseUrl)
     const url = KmsRestClient.urlWithBase(`/keys/${args.aliasOrKid}`, baseUrl)
 
@@ -227,7 +227,7 @@ export class KmsRestClient implements IAgentPlugin {
   }
 
   /** {@inheritDoc IKmsRestClient.kmsListKeys} */
-  private async kmsListKeys(args: KmsListKeysArgs): Promise<ListKeysResponse> {
+  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, {
@@ -244,7 +244,7 @@ export class KmsRestClient implements IAgentPlugin {
   }
 
   /** {@inheritDoc IKmsRestClient.kmsStoreKey} */
-  private async kmsStoreKey(args: KmsStoreKeyArgs): Promise<ManagedKeyInfo> {
+  private async kmsClientStoreKey(args: KmsClientStoreKeyArgs): Promise<ManagedKeyInfo> {
     const baseUrl = this.assertedAgentBaseUrl(args.baseUrl)
     const url = KmsRestClient.urlWithBase(`/keys`, baseUrl)
 
@@ -267,7 +267,7 @@ export class KmsRestClient implements IAgentPlugin {
   }
 
   /** {@inheritDoc IKmsRestClient.kmsGenerateKey} */
-  private async kmsGenerateKey(args: KmsGenerateKeyArgs): Promise<ManagedKeyPair> {
+  private async kmsClientGenerateKey(args: KmsClientGenerateKeyArgs): Promise<ManagedKeyPair> {
     const baseUrl = this.assertedAgentBaseUrl(args.baseUrl)
     const url = KmsRestClient.urlWithBase(`/keys/generate`, baseUrl)
 
@@ -292,7 +292,7 @@ export class KmsRestClient implements IAgentPlugin {
   }
 
   /** {@inheritDoc IKmsRestClient.kmsDeleteKey} */
-  private async kmsDeleteKey(args: KmsDeleteKeyArgs): Promise<boolean> {
+  private async kmsClientDeleteKey(args: KmsClientDeleteKeyArgs): Promise<boolean> {
     const baseUrl = this.assertedAgentBaseUrl(args.baseUrl)
     const url = KmsRestClient.urlWithBase(`/keys/${args.aliasOrKid}`, baseUrl)
 
@@ -304,7 +304,7 @@ export class KmsRestClient implements IAgentPlugin {
   }
 
   /** {@inheritDoc IKmsRestClient.kmsGetKeyProvider} */
-  private async kmsGetKeyProvider(args: KmsGetKeyProviderArgs): Promise<KeyProviderResponse> {
+  private async kmsClientGetKeyProvider(args: KmsClientGetKeyProviderArgs): Promise<KeyProviderResponse> {
     const baseUrl = this.assertedAgentBaseUrl(args.baseUrl)
     const url = KmsRestClient.urlWithBase(`/providers/${args.providerId}`, baseUrl)
 
@@ -321,7 +321,7 @@ export class KmsRestClient implements IAgentPlugin {
   }
 
   /** {@inheritDoc IKmsRestClient.kmsListKeyProviders} */
-  private async kmsListKeyProviders(args: KmsListKeyProvidersArgs): Promise<ListKeyProvidersResponse> {
+  private async kmsClientListKeyProviders(args: KmsClientListKeyProvidersArgs): Promise<ListKeyProvidersResponse> {
     const baseUrl = this.assertedAgentBaseUrl(args.baseUrl)
     const url = KmsRestClient.urlWithBase('/providers', baseUrl)
 
@@ -338,7 +338,7 @@ export class KmsRestClient implements IAgentPlugin {
   }
 
   /** {@inheritDoc IKmsRestClient.kmsProviderListKeys} */
-  private async kmsProviderListKeys(args: KmsProviderListKeysArgs): Promise<ListKeysResponse> {
+  private async kmsClientProviderListKeys(args: KmsClientProviderListKeysArgs): Promise<ListKeysResponse> {
     const baseUrl = this.assertedAgentBaseUrl(args.baseUrl)
     const url = KmsRestClient.urlWithBase(`/providers/${args.providerId}/keys`, baseUrl)
 
@@ -355,7 +355,7 @@ export class KmsRestClient implements IAgentPlugin {
   }
 
   /** {@inheritDoc IKmsRestClient.kmsProviderStoreKey} */
-  private async kmsProviderStoreKey(args: KmsProviderStoreKey): Promise<ManagedKeyInfo> {
+  private async kmsClientProviderStoreKey(args: KmsClientProviderStoreKey): Promise<ManagedKeyInfo> {
     const baseUrl = this.assertedAgentBaseUrl(args.baseUrl)
     const url = KmsRestClient.urlWithBase(`/providers/${args.providerId}/keys`, baseUrl)
 
@@ -378,7 +378,7 @@ export class KmsRestClient implements IAgentPlugin {
   }
 
   /** {@inheritDoc IKmsRestClient.kmsProviderGenerateKey} */
-  private async kmsProviderGenerateKey(args: KmsProviderGenerateKey): Promise<ManagedKeyPair> {
+  private async kmsClientProviderGenerateKey(args: KmsClientProviderGenerateKey): Promise<ManagedKeyPair> {
     const baseUrl = this.assertedAgentBaseUrl(args.baseUrl)
     const url = KmsRestClient.urlWithBase(`/providers/${args.providerId}/keys/generate`, baseUrl)
 
@@ -402,7 +402,7 @@ export class KmsRestClient implements IAgentPlugin {
   }
 
   /** {@inheritDoc IKmsRestClient.kmsProviderGetKey} */
-  private async kmsProviderGetKey(args: KmsProviderGetKeyArgs): Promise<ManagedKeyInfo> {
+  private async kmsClientProviderGetKey(args: KmsClientProviderGetKeyArgs): Promise<ManagedKeyInfo> {
     const baseUrl = this.assertedAgentBaseUrl(args.baseUrl)
     const url = KmsRestClient.urlWithBase(`/providers/${args.providerId}/keys/${args.aliasOrKid}`, baseUrl)
 
@@ -419,7 +419,7 @@ export class KmsRestClient implements IAgentPlugin {
   }
 
   /** {@inheritDoc IKmsRestClient.kmsProviderDeleteKey} */
-  private async kmsProviderDeleteKey(args: KmsProviderDeleteKeyArgs): Promise<boolean> {
+  private async kmsClientProviderDeleteKey(args: KmsClientProviderDeleteKeyArgs): Promise<boolean> {
     const baseUrl = this.assertedAgentBaseUrl(args.baseUrl)
     const url = KmsRestClient.urlWithBase(`providers/${args.providerId}/keys/${args.aliasOrKid}`, baseUrl)
 

package/src/index.ts

@@ -1,7 +1,7 @@
 /**
  * @public
  */
-const schema = require('../plugin.schema.json')
+import schema from '../plugin.schema.json'
 export { schema }
 export { KmsRestClient } from './agent/KmsRestClient'
 export type * from './types/IKmsRestClient'

package/src/types/IKmsRestClient.ts

@@ -20,101 +20,101 @@ import {
 } from '../models'
 
 export interface IKmsRestClient extends IPluginMethodMap {
-  kmsGetResolver(args: kmsGetResolverArgs): Promise<Resolver>
-  kmsListResolvers(args: KmsListResolversArgs): Promise<ListResolversResponse>
-  kmsResolveKey(args: KmsResolveKeyArgs): Promise<ResolvedKeyInfo>
-  kmsCreateRawSignature(args: KmsCreateRawSignatureArgs): Promise<CreateRawSignatureResponse>
-  kmsIsValidRawSignature(args: KmsIsValidRawSignatureArgs): Promise<VerifyRawSignatureResponse>
-  kmsGetKey(args: KmsGetKeyArgs): Promise<ManagedKeyInfo>
-  kmsListKeys(args: KmsListKeysArgs): Promise<ListKeysResponse>
-  kmsStoreKey(args: KmsStoreKeyArgs): Promise<ManagedKeyInfo>
-  kmsGenerateKey(args: KmsGenerateKeyArgs): Promise<ManagedKeyPair>
-  kmsDeleteKey(args: KmsDeleteKeyArgs): Promise<boolean>
-  kmsGetKeyProvider(args: KmsGetKeyProviderArgs): Promise<KeyProviderResponse>
-  kmsListKeyProviders(args: KmsListKeyProvidersArgs): Promise<ListKeyProvidersResponse>
-  kmsProviderListKeys(args: KmsProviderListKeysArgs): Promise<ListKeysResponse>
-  kmsProviderStoreKey(args: KmsProviderStoreKey): Promise<ManagedKeyInfo>
-  kmsProviderGenerateKey(args: KmsProviderGenerateKey): Promise<ManagedKeyPair>
-  kmsProviderGetKey(args: KmsProviderGetKeyArgs): Promise<ManagedKeyInfo>
-  kmsProviderDeleteKey(args: KmsProviderDeleteKeyArgs): Promise<boolean>
+  kmsClientGetResolver(args: kmsClientGetResolverArgs): Promise<Resolver>
+  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>
+  kmsClientDeleteKey(args: KmsClientDeleteKeyArgs): Promise<boolean>
+  kmsClientGetKeyProvider(args: KmsClientGetKeyProviderArgs): Promise<KeyProviderResponse>
+  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>
+  kmsClientProviderDeleteKey(args: KmsClientProviderDeleteKeyArgs): Promise<boolean>
 }
 
-export type KmsListResolversArgs = {
+export type KmsClientListResolversArgs = {
   baseUrl?: string
 }
 
-export type kmsGetResolverArgs = {
+export type kmsClientGetResolverArgs = {
   baseUrl?: string
   resolverId: string
 }
 
-export type KmsResolveKeyArgs = {
+export type KmsClientResolveKeyArgs = {
   baseUrl?: string
   resolverId: String
 } & ResolvePublicKey
 
-export type KmsCreateRawSignatureArgs = {
+export type KmsClientCreateRawSignatureArgs = {
   baseUrl?: string
 } & CreateRawSignature
 
-export type KmsIsValidRawSignatureArgs = {
+export type KmsClientIsValidRawSignatureArgs = {
   baseUrl?: string
 } & VerifyRawSignature
 
-export type KmsGetKeyArgs = {
+export type KmsClientGetKeyArgs = {
   baseUrl?: string
   aliasOrKid: string
 }
 
-export type KmsListKeysArgs = {
+export type KmsClientListKeysArgs = {
   baseUrl?: string
   providerId?: string
 }
 
-export type KmsStoreKeyArgs = {
+export type KmsClientStoreKeyArgs = {
   baseUrl?: string
 } & StoreKey
 
-export type KmsGenerateKeyArgs = {
+export type KmsClientGenerateKeyArgs = {
   baseUrl?: string
 } & GenerateKeyGlobal
 
-export type KmsDeleteKeyArgs = {
+export type KmsClientDeleteKeyArgs = {
   baseUrl?: string
   aliasOrKid?: string
 }
 
-export type KmsGetKeyProviderArgs = {
+export type KmsClientGetKeyProviderArgs = {
   baseUrl?: string
   providerId?: string
 }
 
-export type KmsListKeyProvidersArgs = {
+export type KmsClientListKeyProvidersArgs = {
   baseUrl?: string
 }
 
-export type KmsProviderListKeysArgs = {
+export type KmsClientProviderListKeysArgs = {
   baseUrl?: string
   providerId: string
 }
 
-export type KmsProviderStoreKey = {
+export type KmsClientProviderStoreKey = {
   baseUrl?: string
   providerId: string
 } & StoreKey
 
-export type KmsProviderGenerateKey = {
+export type KmsClientProviderGenerateKey = {
   baseUrl?: string
   providerId: string
 } & GenerateKey
 
-export type KmsProviderGetKeyArgs = {
+export type KmsClientProviderGetKeyArgs = {
   baseUrl?: string
   providerId: string
   aliasOrKid: string
 }
 
-export type KmsProviderDeleteKeyArgs = {
+export type KmsClientProviderDeleteKeyArgs = {
   baseUrl?: string
   providerId: string
   aliasOrKid: string