@sudoplatform/sudo-common 5.6.0 → 5.9.0

package/github/package.json

@@ -18,7 +18,7 @@
     "build:verify": "yarn audit-with-suppressions && yarn lint && yarn test --coverage",
     "build:transpile": "babel src --out-dir lib --extensions '.ts'",
     "build:declarations": "yarn tsc --emitDeclarationOnly",
-    "build:doc": "typedoc --excludePrivate --out docs src/index.ts"
+    "build:doc": "typedoc --treatWarningsAsErrors --excludePrivate --out docs src/index.ts"
   },
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -31,42 +31,45 @@
     "!*.spec.*"
   ],
   "resolutions": {
-    "**/apollo-client": "^2.6.10"
+    "**/apollo-cache-inmemory": "^1.6.6",
+    "**/apollo-client": "^2.6.10",
+    "ansi-regex": "^5.0.1",
+    "tmpl": "^1.0.5"
   },
   "dependencies": {
     "apollo-client": "^2.6.10",
     "browser-bunyan": "^1.6.3",
-    "fflate": "^0.7.1"
+    "fflate": "^0.7.1",
+    "graphql": "^15.6.1"
   },
   "peerDependencies": {
     "io-ts": "^2.2.10"
   },
   "devDependencies": {
-    "@babel/cli": "^7.14.8",
-    "@babel/core": "^7.15.0",
+    "@babel/cli": "^7.15.7",
+    "@babel/core": "^7.15.8",
     "@babel/plugin-proposal-class-properties": "^7.14.5",
     "@babel/plugin-proposal-private-methods": "^7.14.5",
-    "@babel/preset-env": "^7.15.0",
+    "@babel/preset-env": "^7.15.8",
     "@babel/preset-typescript": "^7.15.0",
-    "@types/jest": "^27.0.1",
-    "@typescript-eslint/eslint-plugin": "^4.29.3",
-    "@typescript-eslint/parser": "^4.29.3",
+    "@types/jest": "^27.0.2",
+    "@typescript-eslint/eslint-plugin": "^4.33.0",
+    "@typescript-eslint/parser": "^4.33.0",
     "eslint": "^7.32.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-import": "^2.24.2",
-    "eslint-plugin-prettier": "^3.4.1",
-    "fp-ts": "^2.11.1",
-    "graphql": "^15.5.1",
+    "eslint-plugin-prettier": "^4.0.0",
+    "fp-ts": "^2.11.4",
     "io-ts": "^2.2.16",
     "io-ts-types": "^0.5.16",
     "isomorphic-webcrypto": "^2.3.8",
-    "jest": "^27.0.6",
+    "jest": "^27.2.4",
     "monocle-ts": "^2.3.11",
     "newtype-ts": "^0.3.2",
-    "prettier": "^2.3.2",
+    "prettier": "^2.4.1",
     "rimraf": "^3.0.2",
     "ts-mockito": "^2.6.1",
-    "typedoc": "^0.21.6",
-    "typescript": "^4.3.5"
+    "typedoc": "^0.22.5",
+    "typescript": "^4.4.3"
   }
 }

package/github/src/errors/error.ts

@@ -398,6 +398,16 @@ export class OperationNotImplementedError extends Error {
   }
 }
 
+/**
+ * Encryption algorithm is not recognized
+ */
+export class UnrecognizedAlgorithmError extends Error {
+  constructor(message?: string) {
+    super(message ?? 'Unrecognized encryption algorithm name.')
+    this.name = 'UnrecognizedAlgorithmError'
+  }
+}
+
 /**
  * Helper method for mapping an App Sync error to common errors.
  *

package/github/src/sudoKeyArchive/sudoKeyArchive.ts

@@ -124,7 +124,7 @@ export interface SudoKeyArchive {
   getMetaInfo(): ReadonlyMap<string, string>
 }
 
-type KeyArchiveKeyInfoDecoded = KeyArchiveKeyInfo & {
+export type KeyArchiveKeyInfoDecoded = KeyArchiveKeyInfo & {
   Decoded: ArrayBuffer
 }
 

package/github/src/sudoKeyManager/sudoCryptoProvider.ts

@@ -194,6 +194,8 @@ export interface SudoCryptoProvider {
    *
    *
    * @returns Encrypted data and IV
+   *
+   * @throws {@link UnrecognizedAlgorithmError}
    */
   encryptWithSymmetricKeyName(
     name: string,
@@ -225,6 +227,8 @@ export interface SudoCryptoProvider {
    * @param data The data to decrypt.
    *
    * @returns Decrypted data
+   *
+   * @throws {@link UnrecognizedAlgorithmError}
    */
   decryptWithSymmetricKeyName(
     name: string,
@@ -256,6 +260,8 @@ export interface SudoCryptoProvider {
    * @param data Data to encrypt.
    *
    * @returns Encrypted data and IV
+   *
+   * @throws {@link UnrecognizedAlgorithmError}
    */
   encryptWithSymmetricKey(
     key: ArrayBuffer,
@@ -287,6 +293,8 @@ export interface SudoCryptoProvider {
    * @param data The data to decrypt.
    *
    * @returns Decrypted data
+   *
+   * @throws {@link UnrecognizedAlgorithmError}
    */
   decryptWithSymmetricKey(
     key: ArrayBuffer,
@@ -301,6 +309,8 @@ export interface SudoCryptoProvider {
    * @param data The data to encrypt.
    *
    * @returns Encrypted data
+   *
+   * @throws {@link UnrecognizedAlgorithmError}
    */
   encryptWithPublicKey(
     name: string,
@@ -315,6 +325,8 @@ export interface SudoCryptoProvider {
    * @param data The data to decrypt.
    *
    * @returns Decrypted data or undefined if the private key is not found.
+   *
+   * @throws {@link UnrecognizedAlgorithmError}
    */
   decryptWithPrivateKey(
     name: string,

package/github/src/sudoKeyManager/sudoKeyManager.ts

@@ -139,6 +139,8 @@ export interface SudoKeyManager {
    * @param data Data to encrypt.
    *
    * @returns Encrypted data and IV
+   *
+   * @throws {@link UnrecognizedAlgorithmError}
    */
   encryptWithSymmetricKey(
     key: ArrayBuffer,
@@ -170,6 +172,8 @@ export interface SudoKeyManager {
    * @param encryptedData The encrypted data.
    *
    * @returns Decrypted data
+   *
+   * @throws {@link UnrecognizedAlgorithmError}
    */
   decryptWithSymmetricKey(
     key: ArrayBuffer,
@@ -201,6 +205,8 @@ export interface SudoKeyManager {
    * @param data The data to decrypt.
    *
    * @returns Decrypted data
+   *
+   * @throws {@link UnrecognizedAlgorithmError}
    */
   encryptWithSymmetricKeyName(
     name: string,
@@ -231,6 +237,8 @@ export interface SudoKeyManager {
    * @param data The data to decrypt.
    *
    * @returns Decrypted data
+   *
+   * @throws {@link UnrecognizedAlgorithmError}
    */
   decryptWithSymmetricKeyName(
     name: string,
@@ -245,6 +253,8 @@ export interface SudoKeyManager {
    * @param data The data to encrypt.
    *
    * @returns Encrypted data
+   *
+   * @throws {@link UnrecognizedAlgorithmError}
    */
   encryptWithPublicKey(
     name: string,
@@ -259,6 +269,8 @@ export interface SudoKeyManager {
    * @param data The data to decrypt.
    *
    * @returns Decrypted data or undefined if the private key is not found.
+   *
+   * @throws {@link UnrecognizedAlgorithmError}
    */
   decryptWithPrivateKey(
     name: string,

package/github/src/types/types.ts

@@ -48,3 +48,81 @@ export enum EncryptionAlgorithm {
   AesCbcPkcs7Padding = 'AES/CBC/PKCS7Padding',
   RsaOaepSha1 = 'RSA/OAEPWithSHA-1',
 }
+
+export type Subset<T, S> = Pick<S, Extract<keyof T, keyof S>> &
+  Partial<Record<Exclude<keyof T, keyof S>, never>>
+
+/**
+ * Status of the list operation result.
+ */
+export enum ListOperationResultStatus {
+  /**
+   * The operation completed successfully.
+   */
+  Success = 'Success',
+  /**
+   * The operation completed but some items had errors during
+   * processing.
+   */
+  Partial = 'Partial',
+  /**
+   * The operation failed and no list item could be returned.
+   */
+  Failure = 'Failure',
+}
+
+export interface ListOperationSuccessResult<T> {
+  /**
+   * Operation status.
+   */
+  status: ListOperationResultStatus.Success
+  /**
+   * List of items that were successfully processed.
+   */
+  items: T[]
+  /**
+   * Pagination token.
+   */
+  nextToken?: string
+}
+
+export interface ListOperationFailureResult {
+  /**
+   * Operation status.
+   */
+  status: ListOperationResultStatus.Failure
+  /**
+   * The error that caused the failure.
+   */
+  cause: Error
+}
+
+export interface ListOperationPartialResult<T, S extends Subset<S, T>> {
+  /**
+   * Operation status.
+   */
+  status: ListOperationResultStatus.Partial
+  /**
+   * List of items that were successfully processed.
+   */
+  items: T[]
+  /**
+   * List of items that failed to be processed and the error
+   * that caused the failure.
+   */
+  failed: { item: Omit<T, keyof S>; cause: Error }[]
+  /**
+   * Pagination token.
+   */
+  nextToken?: string
+}
+
+/**
+ * Result of a list operation. T is the expected item type and
+ * S is a subset of T's properties that won't be present if the
+ * additional processing after the item has been fetched fails.
+ */
+export type ListOperationResult<T, S extends Subset<S, T> = T> =
+  | ListOperationSuccessResult<T>
+  | ListOperationFailureResult
+  | ListOperationPartialResult<T, S>

package/github/test/utils/listOperationResult.spec.ts

@@ -0,0 +1,84 @@
+import {
+  ListOperationResult,
+  ListOperationResultStatus,
+} from '../../src/types/types'
+
+type Item = {
+  id: string
+  createdAt: Date
+  updatedAt: Date
+} & SealedAttributes
+type SealedAttributes = {
+  secret: string
+}
+type ListItemResult = ListOperationResult<Item, SealedAttributes>
+
+describe('ListOperationResult', () => {
+  it('should successfully assign success result', () => {
+    const obj: ListItemResult = {
+      status: ListOperationResultStatus.Success,
+      items: [
+        {
+          id: 'dummy_id',
+          createdAt: new Date(1),
+          updatedAt: new Date(2),
+          secret: 'dummy_secret',
+        },
+      ],
+      nextToken: 'dummy_token',
+    }
+    expect(obj.status).toBe('Success')
+    expect(obj.nextToken).toBe('dummy_token')
+    expect(obj.items.length).toBe(1)
+    expect(obj.items[0].id).toBe('dummy_id')
+    expect(obj.items[0].createdAt).toEqual(new Date(1))
+    expect(obj.items[0].updatedAt).toEqual(new Date(2))
+    expect(obj.items[0].secret).toBe('dummy_secret')
+  })
+
+  it('should successfully assign failure result', () => {
+    const obj: ListItemResult = {
+      status: ListOperationResultStatus.Failure,
+      cause: new Error('dummy_error'),
+    }
+    expect(obj.status).toBe('Failure')
+    expect(obj.cause.message).toBe('dummy_error')
+  })
+
+  it('should successfully assign partial result', () => {
+    const obj: ListItemResult = {
+      status: ListOperationResultStatus.Partial,
+      items: [
+        {
+          id: 'dummy_id',
+          createdAt: new Date(1),
+          updatedAt: new Date(2),
+          secret: 'dummy_secret',
+        },
+      ],
+      failed: [
+        {
+          item: {
+            id: 'dummy_id',
+            createdAt: new Date(1),
+            updatedAt: new Date(2),
+          },
+          cause: new Error('dummy_error'),
+        },
+      ],
+      nextToken: 'dummy_token',
+    }
+    expect(obj.status).toBe('Partial')
+    expect(obj.nextToken).toBe('dummy_token')
+    expect(obj.items.length).toBe(1)
+    expect(obj.items[0].id).toBe('dummy_id')
+    expect(obj.items[0].createdAt).toEqual(new Date(1))
+    expect(obj.items[0].updatedAt).toEqual(new Date(2))
+    expect(obj.items[0].secret).toBe('dummy_secret')
+    expect(obj.items.length).toBe(1)
+    expect(obj.failed[0].item.id).toBe('dummy_id')
+    expect(obj.failed[0].item.createdAt).toEqual(new Date(1))
+    expect(obj.failed[0].item.updatedAt).toEqual(new Date(2))
+    expect(obj.failed[0].cause.message).toBe('dummy_error')
+  })
+})