@sudoplatform/sudo-common 6.2.0 → 6.3.1

package/lib/errors/error.d.ts

@@ -251,7 +251,7 @@ export declare class UnrecognizedAlgorithmError extends Error {
  * @param error The App Sync error to map
  * @returns The mapped error
  */
-export declare function mapGraphQLToClientError(error: AppSyncError): Error;
+export declare function mapGraphQLToClientError(error: Pick<AppSyncError, 'errorType' | 'message'>): Error;
 /**
  * Call this in error handling when testing with isAppSyncNetworkError on
  * a caught error from an AppSync operation returns true.

package/lib/errors/error.js

@@ -577,6 +577,9 @@ function mapGraphQLToClientError(error) {
     case 'sudoplatform.InvalidArgumentError':
       return new IllegalArgumentError();
 
+    case 'sudoplatform.LimitExceededError':
+      return new LimitExceededError();
+
     case 'sudoplatform.NoEntitlementsError':
       return new NoEntitlementsError();
 

package/lib/sudoKeyManager/sudoKeyManager.js

@@ -87,7 +87,9 @@ class DefaultSudoKeyManager {
 
   encryptWithSymmetricKey(key, data, ivOrOptions) {
     if (_buffer.Buffer.isArrayBuffer(ivOrOptions)) {
-      return this.sudoCryptoProvider.encryptWithSymmetricKey(key, data, ivOrOptions);
+      return this.sudoCryptoProvider.encryptWithSymmetricKey(key, data, {
+        iv: ivOrOptions
+      });
     } else {
       return this.sudoCryptoProvider.encryptWithSymmetricKey(key, data, ivOrOptions);
     }
@@ -95,7 +97,9 @@ class DefaultSudoKeyManager {
 
   decryptWithSymmetricKey(key, data, ivOrOptions) {
     if (_buffer.Buffer.isArrayBuffer(ivOrOptions)) {
-      return this.sudoCryptoProvider.decryptWithSymmetricKey(key, data, ivOrOptions);
+      return this.sudoCryptoProvider.decryptWithSymmetricKey(key, data, {
+        iv: ivOrOptions
+      });
     } else {
       return this.sudoCryptoProvider.decryptWithSymmetricKey(key, data, ivOrOptions);
     }
@@ -103,7 +107,9 @@ class DefaultSudoKeyManager {
 
   encryptWithSymmetricKeyName(name, data, ivOrOptions) {
     if (_buffer.Buffer.isArrayBuffer(ivOrOptions)) {
-      return this.sudoCryptoProvider.encryptWithSymmetricKeyName(name, data, ivOrOptions);
+      return this.sudoCryptoProvider.encryptWithSymmetricKeyName(name, data, {
+        iv: ivOrOptions
+      });
     } else {
       return this.sudoCryptoProvider.encryptWithSymmetricKeyName(name, data, ivOrOptions);
     }
@@ -111,7 +117,9 @@ class DefaultSudoKeyManager {
 
   decryptWithSymmetricKeyName(name, data, ivOrOptions) {
     if (_buffer.Buffer.isArrayBuffer(ivOrOptions)) {
-      return this.sudoCryptoProvider.decryptWithSymmetricKeyName(name, data, ivOrOptions);
+      return this.sudoCryptoProvider.decryptWithSymmetricKeyName(name, data, {
+        iv: ivOrOptions
+      });
     } else {
       return this.sudoCryptoProvider.decryptWithSymmetricKeyName(name, data, ivOrOptions);
     }

package/lib/types/types.d.ts

@@ -39,6 +39,7 @@ export interface BooleanFilter {
  */
 export declare enum EncryptionAlgorithm {
     AesCbcPkcs7Padding = "AES/CBC/PKCS7Padding",
+    AesGcmNoPadding = "AES/GCM/NoPadding",
     RsaOaepSha1 = "RSA/OAEPWithSHA-1"
 }
 export declare type Subset<T, S> = Pick<S, Extract<keyof T, keyof S>> & Partial<Record<Exclude<keyof T, keyof S>, never>>;

package/lib/types/types.js

@@ -31,6 +31,7 @@ exports.EncryptionAlgorithm = EncryptionAlgorithm;
 
 (function (EncryptionAlgorithm) {
   EncryptionAlgorithm["AesCbcPkcs7Padding"] = "AES/CBC/PKCS7Padding";
+  EncryptionAlgorithm["AesGcmNoPadding"] = "AES/GCM/NoPadding";
   EncryptionAlgorithm["RsaOaepSha1"] = "RSA/OAEPWithSHA-1";
 })(EncryptionAlgorithm || (exports.EncryptionAlgorithm = EncryptionAlgorithm = {}));
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sudoplatform/sudo-common",
-  "version": "6.2.0",
+  "version": "6.3.1",
   "author": "Anonyome Labs, Inc.",
   "repository": {
     "type": "git",
@@ -39,44 +39,45 @@
     "**/apollo-cache-inmemory": "^1.6.6",
     "**/apollo-client": "^2.6.10",
     "ansi-regex": "^5.0.1",
-    "tmpl": "^1.0.5"
+    "tmpl": "^1.0.5",
+    "minimist": "^1.2.6"
   },
   "dependencies": {
     "apollo-client": "^2.6.10",
     "aws-sdk": "^2.973.0",
     "browser-bunyan": "^1.8.0",
     "fflate": "^0.7.3",
-    "graphql": "^15.6.1"
+    "graphql": "^15.8.0"
   },
   "peerDependencies": {
     "io-ts": "^2.2.10"
   },
   "devDependencies": {
-    "@babel/cli": "^7.16.6",
-    "@babel/core": "^7.17.5",
+    "@babel/cli": "^7.17.10",
+    "@babel/core": "^7.17.10",
     "@babel/plugin-proposal-class-properties": "^7.16.7",
     "@babel/plugin-proposal-private-methods": "^7.16.11",
-    "@babel/preset-env": "^7.16.11",
+    "@babel/preset-env": "^7.17.10",
     "@babel/preset-typescript": "^7.16.7",
-    "@types/jest": "^27.4.0",
-    "@typescript-eslint/eslint-plugin": "^5.12.1",
-    "@typescript-eslint/parser": "^5.12.1",
-    "aws-sdk-mock": "^5.6.2",
-    "eslint": "^8.9.0",
-    "eslint-config-prettier": "^8.4.0",
-    "eslint-plugin-import": "^2.25.4",
+    "@types/jest": "^27.5.0",
+    "@typescript-eslint/eslint-plugin": "^5.22.0",
+    "@typescript-eslint/parser": "^5.22.0",
+    "aws-sdk-mock": "^5.7.0",
+    "eslint": "^8.14.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-prettier": "^4.0.0",
     "fp-ts": "^2.11.8",
     "io-ts": "^2.2.16",
     "io-ts-types": "^0.5.16",
     "isomorphic-webcrypto": "^2.3.8",
     "jest": "^27.5.1",
-    "monocle-ts": "^2.3.12",
+    "monocle-ts": "^2.3.13",
     "newtype-ts": "^0.3.5",
-    "prettier": "^2.5.1",
+    "prettier": "^2.6.2",
     "rimraf": "^3.0.2",
     "ts-mockito": "^2.6.1",
-    "typedoc": "^0.22.12",
-    "typescript": "^4.5.5"
+    "typedoc": "^0.22.15",
+    "typescript": "^4.6.4"
   }
 }

package/src/errors/error.ts

@@ -425,7 +425,9 @@ export class UnrecognizedAlgorithmError extends Error {
  * @param error The App Sync error to map
  * @returns The mapped error
  */
-export function mapGraphQLToClientError(error: AppSyncError): Error {
+export function mapGraphQLToClientError(
+  error: Pick<AppSyncError, 'errorType' | 'message'>,
+): Error {
   switch (error.errorType) {
     case 'sudoplatform.AccountLockedError':
       return new AccountLockedError()
@@ -435,6 +437,8 @@ export function mapGraphQLToClientError(error: AppSyncError): Error {
       return new InvalidTokenError()
     case 'sudoplatform.InvalidArgumentError':
       return new IllegalArgumentError()
+    case 'sudoplatform.LimitExceededError':
+      return new LimitExceededError()
     case 'sudoplatform.NoEntitlementsError':
       return new NoEntitlementsError()
     case 'sudoplatform.ServiceError':

package/src/sudoKeyManager/sudoKeyManager.ts

@@ -435,11 +435,9 @@ export class DefaultSudoKeyManager implements SudoKeyManager {
     ivOrOptions?: ArrayBuffer | SymmetricEncryptionOptions,
   ): Promise<ArrayBuffer> {
     if (BufferUtil.isArrayBuffer(ivOrOptions)) {
-      return this.sudoCryptoProvider.encryptWithSymmetricKey(
-        key,
-        data,
-        ivOrOptions,
-      )
+      return this.sudoCryptoProvider.encryptWithSymmetricKey(key, data, {
+        iv: ivOrOptions,
+      })
     } else {
       return this.sudoCryptoProvider.encryptWithSymmetricKey(
         key,
@@ -455,11 +453,9 @@ export class DefaultSudoKeyManager implements SudoKeyManager {
     ivOrOptions?: ArrayBuffer | SymmetricEncryptionOptions,
   ): Promise<ArrayBuffer> {
     if (BufferUtil.isArrayBuffer(ivOrOptions)) {
-      return this.sudoCryptoProvider.decryptWithSymmetricKey(
-        key,
-        data,
-        ivOrOptions,
-      )
+      return this.sudoCryptoProvider.decryptWithSymmetricKey(key, data, {
+        iv: ivOrOptions,
+      })
     } else {
       return this.sudoCryptoProvider.decryptWithSymmetricKey(
         key,
@@ -475,11 +471,9 @@ export class DefaultSudoKeyManager implements SudoKeyManager {
     ivOrOptions?: ArrayBuffer | SymmetricEncryptionOptions,
   ): Promise<ArrayBuffer> {
     if (BufferUtil.isArrayBuffer(ivOrOptions)) {
-      return this.sudoCryptoProvider.encryptWithSymmetricKeyName(
-        name,
-        data,
-        ivOrOptions,
-      )
+      return this.sudoCryptoProvider.encryptWithSymmetricKeyName(name, data, {
+        iv: ivOrOptions,
+      })
     } else {
       return this.sudoCryptoProvider.encryptWithSymmetricKeyName(
         name,
@@ -495,11 +489,9 @@ export class DefaultSudoKeyManager implements SudoKeyManager {
     ivOrOptions?: ArrayBuffer | SymmetricEncryptionOptions,
   ): Promise<ArrayBuffer> {
     if (BufferUtil.isArrayBuffer(ivOrOptions)) {
-      return this.sudoCryptoProvider.decryptWithSymmetricKeyName(
-        name,
-        data,
-        ivOrOptions,
-      )
+      return this.sudoCryptoProvider.decryptWithSymmetricKeyName(name, data, {
+        iv: ivOrOptions,
+      })
     } else {
       return this.sudoCryptoProvider.decryptWithSymmetricKeyName(
         name,

package/src/types/types.ts

@@ -46,6 +46,7 @@ export interface BooleanFilter {
  */
 export enum EncryptionAlgorithm {
   AesCbcPkcs7Padding = 'AES/CBC/PKCS7Padding',
+  AesGcmNoPadding = 'AES/GCM/NoPadding',
   RsaOaepSha1 = 'RSA/OAEPWithSHA-1',
 }
 

package/test/unit/errors/error.spec.ts

@@ -1,11 +1,11 @@
 import {
   AccountLockedError,
-  AppSyncError,
   AppSyncNetworkError,
   IllegalArgumentError,
   InsufficientEntitlementsError,
   InvalidTokenError,
   isAppSyncNetworkError,
+  LimitExceededError,
   mapGraphQLToClientError,
   mapNetworkErrorToClientError,
   NoEntitlementsError,
@@ -26,34 +26,19 @@ describe('error', () => {
       ${'sudoplatform.InvalidArgumentError'}          | ${new IllegalArgumentError()}
       ${'sudoplatform.NoEntitlementsError'}           | ${new NoEntitlementsError()}
       ${'sudoplatform.ServiceError'}                  | ${new ServiceError(message)}
+      ${'sudoplatform.LimitExceededError'}            | ${new LimitExceededError()}
     `('should map common error $code properly', ({ code, error }) => {
       expect(
         mapGraphQLToClientError({
           message,
-          path: [],
-          locations: [],
-          nodes: [],
-          positions: [],
-          source: undefined,
-          originalError: undefined,
-          extensions: [],
-          name: code,
           errorType: code,
         }),
       ).toEqual(error)
     })
 
     it('should map an unrecognized error to UnknownGraphQLError', () => {
-      const unrecognized: AppSyncError = {
+      const unrecognized = {
         message,
-        path: [],
-        locations: [],
-        nodes: [],
-        positions: [],
-        source: undefined,
-        originalError: undefined,
-        extensions: [],
-        name: 'unrecognized',
         errorType: 'unrecognized',
       }
       expect(mapGraphQLToClientError(unrecognized)).toEqual(

package/test/unit/sudoKeyManager.spec.ts

@@ -393,8 +393,8 @@ describe('DefaultSudoKeyManager', () => {
       expect(actualKeyName).toStrictEqual('VpnKey')
       expect(actualData).toStrictEqual(decrypted)
       expect(actualOptions).toBeDefined()
-      expect(actualOptions.iv).toStrictEqual(iv)
-      expect(actualOptions.algorithm).toBeUndefined()
+      expect(actualOptions!.iv).toStrictEqual(iv)
+      expect(actualOptions!.algorithm).toBeUndefined()
 
       verify(
         sudoCryptoProviderMock.encryptWithSymmetricKeyName(
@@ -430,8 +430,8 @@ describe('DefaultSudoKeyManager', () => {
       expect(actualKeyName).toStrictEqual('VpnKey')
       expect(actualData).toStrictEqual(decrypted)
       expect(actualOptions).toBeDefined()
-      expect(actualOptions.iv).toStrictEqual(options.iv)
-      expect(actualOptions.algorithm).toStrictEqual(options.algorithm)
+      expect(actualOptions!.iv).toStrictEqual(options.iv)
+      expect(actualOptions!.algorithm).toStrictEqual(options.algorithm)
 
       verify(
         sudoCryptoProviderMock.encryptWithSymmetricKeyName(
@@ -492,8 +492,8 @@ describe('DefaultSudoKeyManager', () => {
       expect(actualKey).toStrictEqual(symmetricKey)
       expect(actualData).toStrictEqual(encrypted)
       expect(actualOptions).toBeDefined()
-      expect(actualOptions.iv).toStrictEqual(iv)
-      expect(actualOptions.algorithm).toBeUndefined()
+      expect(actualOptions!.iv).toStrictEqual(iv)
+      expect(actualOptions!.algorithm).toBeUndefined()
 
       verify(
         sudoCryptoProviderMock.encryptWithSymmetricKey(
@@ -530,8 +530,8 @@ describe('DefaultSudoKeyManager', () => {
       expect(actualKey).toStrictEqual(symmetricKey)
       expect(actualData).toStrictEqual(encrypted)
       expect(actualOptions).toBeDefined()
-      expect(actualOptions.iv).toBeUndefined()
-      expect(actualOptions.algorithm).toStrictEqual(options.algorithm)
+      expect(actualOptions!.iv).toBeUndefined()
+      expect(actualOptions!.algorithm).toStrictEqual(options.algorithm)
 
       verify(
         sudoCryptoProviderMock.encryptWithSymmetricKey(
@@ -599,8 +599,8 @@ describe('DefaultSudoKeyManager', () => {
       expect(actualKeyName).toStrictEqual('VpnKey')
       expect(actualData).toStrictEqual(encrypted)
       expect(actualOptions).toBeDefined()
-      expect(actualOptions.iv).toStrictEqual(options.iv)
-      expect(actualOptions.algorithm).toBeUndefined()
+      expect(actualOptions!.iv).toStrictEqual(options.iv)
+      expect(actualOptions!.algorithm).toBeUndefined()
 
       verify(
         sudoCryptoProviderMock.decryptWithSymmetricKeyName(
@@ -638,8 +638,8 @@ describe('DefaultSudoKeyManager', () => {
       expect(actualKeyName).toStrictEqual('VpnKey')
       expect(actualData).toStrictEqual(encrypted)
       expect(actualOptions).toBeDefined()
-      expect(actualOptions.iv).toStrictEqual(options.iv)
-      expect(actualOptions.algorithm).toStrictEqual(options.algorithm)
+      expect(actualOptions!.iv).toStrictEqual(options.iv)
+      expect(actualOptions!.algorithm).toStrictEqual(options.algorithm)
 
       verify(
         sudoCryptoProviderMock.decryptWithSymmetricKeyName(
@@ -707,8 +707,8 @@ describe('DefaultSudoKeyManager', () => {
       expect(actualKey).toStrictEqual(symmetricKey)
       expect(actualData).toStrictEqual(encrypted)
       expect(actualOptions).toBeDefined()
-      expect(actualOptions.iv).toStrictEqual(iv)
-      expect(actualOptions.algorithm).toBeUndefined()
+      expect(actualOptions!.iv).toStrictEqual(iv)
+      expect(actualOptions!.algorithm).toBeUndefined()
 
       verify(
         sudoCryptoProviderMock.decryptWithSymmetricKey(
@@ -746,8 +746,8 @@ describe('DefaultSudoKeyManager', () => {
       expect(actualKey).toStrictEqual(symmetricKey)
       expect(actualData).toStrictEqual(encrypted)
       expect(actualOptions).toBeDefined()
-      expect(actualOptions.iv).toStrictEqual(iv)
-      expect(actualOptions.algorithm).toStrictEqual(options.algorithm)
+      expect(actualOptions!.iv).toStrictEqual(iv)
+      expect(actualOptions!.algorithm).toStrictEqual(options.algorithm)
 
       verify(
         sudoCryptoProviderMock.decryptWithSymmetricKey(
@@ -811,7 +811,7 @@ describe('DefaultSudoKeyManager', () => {
       expect(actualKeyName).toStrictEqual('VpnKey')
       expect(actualData).toStrictEqual(decrypted)
       expect(actualOptions).toBeDefined()
-      expect(actualOptions.algorithm).toStrictEqual(options.algorithm)
+      expect(actualOptions!.algorithm).toStrictEqual(options.algorithm)
 
       verify(
         sudoCryptoProviderMock.encryptWithPublicKey(
@@ -875,7 +875,7 @@ describe('DefaultSudoKeyManager', () => {
       expect(actualKeyName).toStrictEqual('VpnKey')
       expect(actualData).toStrictEqual(encrypted)
       expect(actualOptions).toBeDefined()
-      expect(actualOptions.algorithm).toStrictEqual(options.algorithm)
+      expect(actualOptions!.algorithm).toStrictEqual(options.algorithm)
 
       verify(
         sudoCryptoProviderMock.decryptWithPrivateKey(