Add getEtchPacket and downloadDocuments Methods

.gitignore

@@ -1,5 +1,6 @@
 .DS_STORE
 *.log
+*.zip
 
 node_modules
 package-lock.json

README.md

@@ -131,6 +131,14 @@ Creates an Etch Packet and optionally sends it to the first signer.
       }
     ```
 
+##### getEtchPacket(options)
+
+Gets the details of an Etch Packet.
+* `options` (Object) - An object with the following structure:
+  * `variables` (Object) - Requires `eid`
+    * `eid` (String) - your Etch Packet eid
+  * `responseQuery` (String) - _optional_ A GraphQL Query compliant query to use for the data desired in the query response. Can be left out to use default.
+
 ##### generateEtchSignUrl(options)
 
 Generates an Etch sign URL for an Etch Packet signer. The Etch Packet and its signers must have already been created.
@@ -139,6 +147,19 @@ Generates an Etch sign URL for an Etch Packet signer. The Etch Packet and its si
     * `clientUserId` (String) - your user eid
     * `signerEid` (String) - the eid of the Etch Packet signer, found in the response of the `createEtchPacket` instance method
 
+##### downloadDocuments(documentGroupEid[, options])
+
+Returns a Buffer or Stream of the document group specified by the documentGroupEid in Zip file format.
+* `documentGroupEid` (string) - the eid of the document group to download
+* `options` (Object) - _optional_ Any additional options for the request
+  * `dataType` (Enum[String]) - _optional_ Set the type of the `data` value that is returned in the resolved `Promise`. Defaults to `'buffer'`, but `'stream'` is also supported.
+* Returns a `Promise` that resolves to an `Object`
+   * `statusCode` (Number) - the HTTP status code, `200` is success
+   * `response` (Object) - the Response object resulting from the client's request to the Anvil app
+   * `data` (Buffer | Stream) - The raw binary data of the downloaded documents if success. Will be in the format of either a Buffer or a Stream, depending on `dataType` option supplied to the request.
+   * `errors` (Array of Objects) - Will be present if status >= 400. See Errors
+      * `message` (String)
+
 ### Class Methods
 
 ##### prepareGraphQLFile(pathOrStreamLikeThing[, options])

example/README.md

@@ -42,6 +42,20 @@ yarn node example/script/create-etch-packet.js <apiKey> <castEid> <filename>
 yarn node example/script/create-etch-packet.js WHG3ylq0EE930IR2LZDtgoqgl55M3TwQ 99u7QvvHr8hDQ4BW9GYv ../../../simple-anvil-finovate-non-qualified.pdf
 ```
 
+## get-etch-packet.js script
+
+Calls the etchPacket Anvil endpoint with the specified Etch packet eid to get the packet details. 
+
+Usage example:
+
+```sh
+# Gets the details of an Etch Packet, a packet eid must be supplied
+yarn node example/script/get-etch-packet.js <apiKey> <etchPacketEid>
+
+# An example
+yarn node example/script/get-etch-packet.js WHG3ylq0EE930IR2LZDtgoqgl55M3TwQ QJhbdpK75RHRQcgPz5Fc
+```
+
 ## generate-etch-sign-url.js script
 
 Calls the generateEtchSignUrl Anvil endpoint with data specified to generate an Etch sign link with the Anvil API. Returns the sign link.
@@ -55,3 +69,17 @@ yarn node example/script/generate-etch-sign-url.js <apiKey> <clientUserId> <sign
 # An example
 yarn node example/script/generate-etch-sign-url.js WHG3ylq0EE930IR2LZDtgoqgl55M3TwQ eBim2Vsv2GqCTJxpjTru ZTlbNhxP2lGkNFsNzcus
 ```
+
+## download-documents.js script
+
+Calls the downloadDocuments Anvil endpoint to download documents with the specified documentGroupEid in Zip file format. Outputs the downloaded Zip file in `example/script/{etchPacketName}.zip`. The default response data is returned in the form of a buffer. This can be changed by adding the `-s` flag to instead be returned as a PassThrough stream.
+
+Usage example:
+
+```sh
+# Downloads a Document Group in a Zip file and outputs in the example/script folder
+yarn node example/script/download-documents.js <apiKey> <documentGroupEid>
+
+# An example
+yarn node example/script/download-documents.js WHG3ylq0EE930IR2LZDtgoqgl55M3TwQ uQiXw4P4DTmXV1eNDmzH
+```

example/script/download-documents.js

@@ -0,0 +1,57 @@
+const fs = require('fs')
+const path = require('path')
+const Anvil = require('../../src/index')
+const argv = require('yargs')
+  .usage('Usage: $0 apiKey documentGroupEid [-s]')
+  .option('stream', {
+    alias: 's',
+    type: 'boolean',
+    description: 'Return the data as a stream (default is buffer)',
+  })
+  .demandCommand(2).argv
+
+const [apiKey, documentGroupEid] = argv._
+const returnAStream = argv.stream
+
+async function main () {
+  const clientOptions = {
+    apiKey,
+  }
+
+  const client = new Anvil(clientOptions)
+
+  const downloadOptions = {}
+  if (returnAStream) downloadOptions.dataType = 'stream'
+
+  const { statusCode, response, data, errors } = await client.downloadDocuments(documentGroupEid, downloadOptions)
+  if (statusCode === 200) {
+    const contentDisposition = response.headers.get('content-disposition')
+    const fileTitle = contentDisposition.split('"')[1]
+    const scriptDir = __dirname
+    const outputFilePath = path.join(scriptDir, fileTitle)
+
+    if (returnAStream) {
+      const writeStream = fs.createWriteStream(outputFilePath, { encoding: null })
+      await new Promise((resolve, reject) => {
+        data.pipe(writeStream)
+        data.on('error', reject)
+        writeStream.on('finish', resolve)
+      })
+    } else {
+      fs.writeFileSync(outputFilePath, data, { encoding: null })
+    }
+
+    console.log(statusCode)
+  } else {
+    console.log(statusCode, JSON.stringify(errors, null, 2))
+  }
+}
+
+main()
+  .then(() => {
+    process.exit(0)
+  })
+  .catch((err) => {
+    console.log(err.stack || err.message)
+    process.exit(1)
+  })

example/script/get-etch-packet.js

@@ -0,0 +1,36 @@
+const Anvil = require('../../src/index')
+const argv = require('yargs')
+  .usage('Usage: $0 apiKey etchPacketEid')
+  .demandCommand(2).argv
+
+const [apiKey, etchPacketEid] = argv._
+
+async function main () {
+  const clientOptions = {
+    apiKey,
+  }
+
+  const client = new Anvil(clientOptions)
+
+  const variables = {
+    eid: etchPacketEid,
+  }
+
+  const { statusCode, data, errors } = await client.getEtchPacket({ variables })
+  console.log(
+    JSON.stringify({
+      statusCode,
+      data,
+      errors,
+    }, null, 2),
+  )
+}
+
+main()
+  .then(() => {
+    process.exit(0)
+  })
+  .catch((err) => {
+    console.log(err.stack || err.message)
+    process.exit(1)
+  })

src/graphql/index.js

@@ -1,5 +1,7 @@
 const mutations = require('./mutations')
+const queries = require('./queries')
 
 module.exports = {
   mutations,
+  queries,
 }

src/graphql/mutations/createEtchPacket.js

@@ -3,6 +3,7 @@ const defaultResponseQuery = `{
   id
   eid
   name
+  detailsURL
   documentGroup {
     id
     eid
@@ -15,12 +16,14 @@ const defaultResponseQuery = `{
       routingOrder
       name
       email
+      status
+      signActionType
     }
   }
 }`
 
 module.exports = {
-  getMutation: (responseQuery = defaultResponseQuery) => `
+  generateMutation: (responseQuery = defaultResponseQuery) => `
     mutation CreateEtchPacket (
       $name: String,
       $files: [EtchFile!],

src/graphql/mutations/generateEtchSignUrl.js

@@ -1,5 +1,5 @@
 module.exports = {
-  getMutation: () => `
+  generateMutation: () => `
     mutation GenerateEtchSignURL (
       $signerEid: String!,
       $clientUserId: String!,

src/graphql/queries/etchPacket.js

@@ -0,0 +1,34 @@
+const defaultResponseQuery = `{
+  id
+  eid
+  name
+  detailsURL
+  documentGroup {
+    id
+    eid
+    status
+    files
+    signers {
+      id
+      eid
+      aliasId
+      routingOrder
+      name
+      email
+      status
+      signActionType
+    }
+  }
+}`
+
+module.exports = {
+  generateQuery: (responseQuery = defaultResponseQuery) => `
+    query GetEtchPacket (
+      $eid: String!,
+    ) {
+      etchPacket (
+        eid: $eid,
+      ) ${responseQuery}
+    }
+  `,
+}

src/graphql/queries/index.js

@@ -0,0 +1,11 @@
+const fs = require('fs')
+
+const IGNORE_FILES = ['index.js']
+
+module.exports = fs.readdirSync(__dirname)
+  .filter((fileName) => (fileName.endsWith('.js') && !fileName.startsWith('.') && !IGNORE_FILES.includes(fileName)))
+  .reduce((acc, fileName) => {
+    const queryName = fileName.slice(0, fileName.length - 3)
+    acc[queryName] = require(`./${queryName}`)
+    return acc
+  }, {})

src/index.js

@@ -12,10 +12,15 @@ const { version, description } = require('../package.json')
 const {
   mutations: {
     createEtchPacket: {
-      getMutation: getCreateEtchPacketMutation,
+      generateMutation: generateCreateEtchPacketMutation,
     },
     generateEtchSignUrl: {
-      getMutation: getGenerateEtchSignUrlMutation,
+      generateMutation: generateEtchSignUrlMutation,
+    },
+  },
+  queries: {
+    etchPacket: {
+      generateQuery: generateEtchPacketQuery,
     },
   },
 } = require('./graphql')
@@ -111,7 +116,17 @@ class Anvil {
   createEtchPacket ({ variables, responseQuery, mutation }) {
     return this.requestGraphQL(
       {
-        query: mutation || getCreateEtchPacketMutation(responseQuery),
+        query: mutation || generateCreateEtchPacketMutation(responseQuery),
+        variables,
+      },
+      { dataType: DATA_TYPE_JSON },
+    )
+  }
+
+  getEtchPacket ({ variables, responseQuery }) {
+    return this.requestGraphQL(
+      {
+        query: generateEtchPacketQuery(responseQuery),
         variables,
       },
       { dataType: DATA_TYPE_JSON },
@@ -121,7 +136,7 @@ class Anvil {
   async generateEtchSignUrl ({ variables }) {
     const { statusCode, data, errors } = await this.requestGraphQL(
       {
-        query: getGenerateEtchSignUrlMutation(),
+        query: generateEtchSignUrlMutation(),
         variables,
       },
       { dataType: DATA_TYPE_JSON },
@@ -134,6 +149,22 @@ class Anvil {
     }
   }
 
+  downloadDocuments (documentGroupEid, clientOptions = {}) {
+    const supportedDataTypes = [DATA_TYPE_STREAM, DATA_TYPE_BUFFER]
+    const { dataType = DATA_TYPE_BUFFER } = clientOptions
+    if (dataType && !supportedDataTypes.includes(dataType)) {
+      throw new Error(`dataType must be one of: ${supportedDataTypes.join('|')}`)
+    }
+    return this.requestREST(
+      `/api/document-group/${documentGroupEid}.zip`,
+      { method: 'GET' },
+      {
+        ...clientOptions,
+        dataType,
+      },
+    )
+  }
+
   async requestGraphQL ({ query, variables = {} }, clientOptions) {
     // Some helpful resources on how this came to be:
     // https://github.com/jaydenseric/graphql-upload/issues/125#issuecomment-440853538