Add encoding option

humble-barnacle001 · humble-barnacle001 · commit 1b011899a478 · 2022-01-11T18:33:57.000Z
diff --git a/.github/workflows/version.yml b/.github/workflows/version.yml
@@ -3,11 +3,11 @@ name: Update Major Version Tag
 on:
   push:
     tags:
-      - "v*"
+      - 'v*'
 
 jobs:
   update-majorver:
     name: Update Major Version Tag
     runs-on: ubuntu-latest
     steps:
-      - uses: nowactions/update-majorver@v1
+      - uses: nowactions/update-majorver@v1
diff --git a/README.md b/README.md
@@ -183,9 +183,10 @@ The following configuration options should be set.
 | `token-endpoint`      | If the `endpoint` API requires you to make a request to get an access token prior to fetching data you can perform this task by specifying a token endpoint. Any data returned from the token end can be referenced in the `configuration` variable using the triple bracket syntax: `{{{ access_token }}}`. For more information refer to the [Token Request part of the readme](https://github.com/JamesIves/fetch-api-data-action#token-request-%EF%B8%8F); | `with`           | **No**   |
 | `token-configuration` | Any applicable configuration settings that should be set such as authentication tokens. You can reference secrets using the `${{ secrets.secret_name }}` syntax. For more information refer to the [Fetch API documentation](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch).                                                                                                                                                          | `secrets / with` | **No**   |
 | `retry`               | If you're working with an intermittent API you can toggle this option to `true`. Doing so will make the action try the request 3 times at random invervals before failing.                                                                                                                                                                                                                                                                                     | `with`           | **No**   |
-| `save-location`       | By default the save location of the file is `fetch-api-data-action/data.json`, if you'd like to override the directory you can do so by specifying a new one with this variable.                                                                                                                                                                                                                                                                          | `with`           | **No**   |
+| `save-location`       | By default the save location of the file is `fetch-api-data-action/data.json`, if you'd like to override the directory you can do so by specifying a new one with this variable.                                                                                                                                                                                                                                                                               | `with`           | **No**   |
 | `save-name`           | You can override the name of the exported `.json` file by specifying a new one here. You should _not_ include the file extension in your name.                                                                                                                                                                                                                                                                                                                 | `with`           | **No**   |
 | `format`              | Allows you to modify the extension of the file saved from the API response, for example you can set this field to `json` or `txt`. This field defaults to `json`.                                                                                                                                                                                                                                                                                              | `with`           | **No**   |
+| `encoding`            | Allows you to modify the encoding of the file saved from the API response, for example you can set this field to `utf8` or `hex`. This field defaults to `hex`. Choose from `ascii` or `utf8` or `utf-8` or `utf16le` or `ucs2` or `ucs-2` or `base64` or `latin1` or `binary` or `hex`                                                                                                                                                                        | `with`           | **No**   |
 | `debug`               | If set to `true` the action will log the API responses it receives in the terminal.                                                                                                                                                                                                                                                                                                                                                                            | `with`           | **No**   |
 
 ---
diff --git a/__tests__/fetch.test.ts b/__tests__/fetch.test.ts
@@ -133,5 +133,15 @@ describe('fetch', () => {
       })
       expect(process.env['fetch-api-data']).toBe('{"bestCat":"montezuma"}')
     })
+
+    it('should save file with custom encoding', async () => {
+      await generateExport({
+        data: '68656C6C6F21',
+        encoding: 'hex',
+        format: 'txt',
+        saveName: 'hex-data'
+      })
+      expect(process.env['fetch-api-data']).toBe('68656C6C6F21')
+    })
   })
 })
diff --git a/action.yml b/action.yml
@@ -42,6 +42,11 @@ inputs:
 
   format:
     description: 'Allows you to modify the format of the saved file, for example you can use txt here to save the file as a txt file. This field defaults to json.'
+    required: false
+
+  encoding:
+    description: 'Allows you to specify the encoding the saved file, can be of type BufferEncoding: "ascii" | "utf8" | "utf-8" | "utf16le" | "ucs2" | "ucs-2" | "base64" | "latin1" | "binary" | "hex".'
+    required: false
 
 outputs:
   fetch-api-data:
diff --git a/src/constants.ts b/src/constants.ts
@@ -4,6 +4,8 @@ import {isNullOrUndefined} from './util'
 export interface ActionInterface {
   /** Allows you to log the retrieved data to the terminal. */
   debug?: boolean
+  /** The encoding of the data to be finally stored */
+  encoding?: BufferEncoding
   /** The primary endpoint to fetch data from. */
   endpoint: string
   /** The configuration for the primary endpoint. Must be a stringified JSON object. */
@@ -40,6 +42,8 @@ export interface DataInterface {
 export interface ExportInterface {
   /** The data to save. */
   data: string
+  /** The encoding of the data to be finally stored */
+  encoding?: BufferEncoding
   /** The save location. */
   saveLocation?: string
   /** The name of the file to save. */
@@ -53,6 +57,7 @@ export const action = {
   debug: !isNullOrUndefined(getInput('debug'))
     ? getInput('debug').toLowerCase() === 'true'
     : false,
+  encoding: <BufferEncoding>getInput('encoding'),
   endpoint: getInput('endpoint'),
   configuration: getInput('configuration'),
   tokenEndpoint: getInput('token-endpoint'),
diff --git a/src/fetch.ts b/src/fetch.ts
@@ -65,6 +65,7 @@ export async function retrieveData({
 /* Saves the data to the local file system and exports an environment variable containing the retrieved data. */
 export async function generateExport({
   data,
+  encoding,
   format,
   saveLocation,
   saveName
@@ -73,17 +74,11 @@ export async function generateExport({
   const file = `${saveLocation ? saveLocation : 'fetch-api-data-action'}/${
     saveName ? saveName : 'data'
   }.${format ? format : 'json'}`
+  const dataEncoding = encoding ? encoding : 'utf8'
   await mkdirP(`${saveLocation ? saveLocation : 'fetch-api-data-action'}`)
-  await fs.writeFile(file, data, 'utf8')
+  await fs.writeFile(file, data, dataEncoding)
 
   info(`Saved ${file} 💾`)
-  await fs.writeFile(
-    `${saveLocation ? saveLocation : 'fetch-api-data-action'}/${
-      saveName ? saveName : 'data'
-    }.json`,
-    data,
-    'utf8'
-  )
 
   exportVariable('fetch-api-data', data)
 
diff --git a/src/lib.ts b/src/lib.ts
@@ -52,6 +52,7 @@ export default async function run(
 
     status = await generateExport({
       data,
+      encoding: settings.encoding,
       saveLocation: settings.saveLocation,
       saveName: settings.saveName,
       format: settings.format
