Merge pull request #171 from adieuadieu/fix/typedefs

fix: en/decrypt function type definition issue

.circleci/config.yml

@@ -9,7 +9,7 @@ jobs:
  # This job builds the base project directory (e.g. ~/package.json)
  build:
  docker:
- - image: circleci/node:6@sha256:b8ea1a58a96d8f625212b649183f09996afe482dd6b27dbbcfc4c0d11cbde27e
+ - image: circleci/node:8
  steps:
  - checkout
  - restore_cache:
@@ -23,7 +23,7 @@ jobs:
  # This job runs the lint tool on the whole repository
  lint:
  docker:
- - image: circleci/node:6@sha256:b8ea1a58a96d8f625212b649183f09996afe482dd6b27dbbcfc4c0d11cbde27e
+ - image: circleci/node:8
  steps:
  - checkout
  - restore_cache:
@@ -38,7 +38,7 @@ jobs:
  # runs the unit tests
  unit-test:
  docker:
- - image: circleci/node:6@sha256:b8ea1a58a96d8f625212b649183f09996afe482dd6b27dbbcfc4c0d11cbde27e
+ - image: circleci/node:8
  steps:
  - checkout
  - restore_cache:

src/index.test.ts

@@ -37,6 +37,14 @@ describe('lib', () => {
  )
 
  expect(result).toEqual(mockArrayOfEncryptedValues)
+
+ // Tests the ReadonlyArray<string> overload
+ const [zero, one, two, three] = result
+
+ expect(zero).toEqual(mockArrayOfEncryptedValues[0])
+ expect(one).toEqual(mockArrayOfEncryptedValues[1])
+ expect(two).toEqual(mockArrayOfEncryptedValues[2])
+ expect(three).toEqual(mockArrayOfEncryptedValues[3])
  })
 
  it('should decrypt an encrypted string', async () => {
@@ -49,10 +57,17 @@ describe('lib', () => {
  const result = await decrypt(mockArrayOfEncryptedValues)
 
  expect(result).toEqual(mockArrayOfDecryptedValues)
+
+ // Tests the ReadonlyArray<string> overload
+ const [zero, one, two, three] = result
+
+ expect(zero).toEqual(mockArrayOfDecryptedValues[0])
+ expect(one).toEqual(mockArrayOfDecryptedValues[1])
+ expect(two).toEqual(mockArrayOfDecryptedValues[2])
+ expect(three).toEqual(mockArrayOfDecryptedValues[3])
  })
 
  it('should be able to handle empty or undefined parameters', async () => {
- // @ts-ignore
  expect(await decrypt(undefined)).toBe(undefined)
  expect(await decrypt('')).toBe('')
  })

src/index.ts

@@ -1,20 +1,27 @@
 import kmsDecrypt from './decrypt'
 import kmsEncrypt, { InterfaceEncryptParameters } from './encrypt'
 
-export const encrypt = async (
- parameters:
- | InterfaceEncryptParameters
- | ReadonlyArray<InterfaceEncryptParameters>,
-): Promise<string | ReadonlyArray<string>> =>
- 'plaintext' in parameters
+export async function encrypt(
+ parameters: InterfaceEncryptParameters,
+): Promise<string>
+export async function encrypt(
+ parameters: ReadonlyArray<InterfaceEncryptParameters>,
+): Promise<ReadonlyArray<string>>
+export async function encrypt(parameters: any): Promise<any> {
+ return 'plaintext' in parameters
  ? kmsEncrypt(parameters)
  : Promise.all(parameters.map(kmsEncrypt))
+}
 
-export const decrypt = async (
- ciphertext: undefined | string | ReadonlyArray<string>,
-): Promise<undefined | string | ReadonlyArray<string>> =>
- typeof ciphertext === 'undefined'
+export async function decrypt(ciphertext: undefined): Promise<undefined>
+export async function decrypt(ciphertext: string): Promise<string>
+export async function decrypt(
+ ciphertext: ReadonlyArray<string>,
+): Promise<ReadonlyArray<string>>
+export async function decrypt(ciphertext: any): Promise<any> {
+ return typeof ciphertext === 'undefined'
  ? undefined // useful in development when process.env.SECRET may be unset
  : typeof ciphertext === 'string'
  ? kmsDecrypt(ciphertext)
  : Promise.all(ciphertext.map(kmsDecrypt))
+}

tsconfig.json

@@ -5,7 +5,7 @@
  "declaration": true,
  "esModuleInterop": false,
  "forceConsistentCasingInFileNames": true,
- "lib": ["es2015", "esnext"],
+ "lib": ["es2018", "esnext"],
  "module": "es2015",
  "moduleResolution": "node",
  "noImplicitAny": true,
@@ -20,7 +20,7 @@
  "skipLibCheck": false,
  "sourceMap": false,
  "strictNullChecks": true,
- "target": "es2015"
+ "target": "es2017"
  },
  "exclude": ["node_modules", "dist", "test"]
 }