Merge branch 'master' into retrieve-settings

.github/workflows/provenance.yml

@@ -0,0 +1,26 @@
+name: Publish Package to npmjs
+
+on:
+ release:
+   types: [created]
+
+jobs:
+ build:
+   runs-on: ubuntu-latest
+
+   permissions:
+     contents: read
+     id-token: write
+
+   steps:
+     - uses: actions/checkout@v3
+     - uses: actions/setup-node@v3
+       with:
+         node-version: '18'
+         registry-url: 'https://registry.npmjs.org'
+         cache: npm
+     - run: npm install -g npm@latest
+     - run: npm install
+     - run: npm publish --provenance --access public
+       env:
+         NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

CONTRIBUTING.md

@@ -0,0 +1,3 @@
+# Publishing a new version
+
+This repository uses `npm` provided provenance using GitHub Actions, please update the version in `package.json` using an appropriate tag and create a release using GitHub, the `.github/workflows/provenance.yml` action should publish it to `npm` from there.

README.md

@@ -53,6 +53,7 @@ const { SocketSdk } = require('@socketsecurity/sdk')
   * `pathsRelativeTo`: A `string` path that the absolute paths `filePaths` are relative to. This to calculate where in your project the `package.json`/`package-lock.json` files lives
   * `issueRules`: An object that follows the format of the [`socket.yml`](https://docs.socket.dev/docs/socket-yml) issue rules. Keys being issue names, values being a boolean that activates or deactivates it. Is applied on top of default config and organization config.
 * `getReportList()`
+* `getReportSupportedFiles()`
 * `getReport(id)`
   * `id`: A `string` representing the id of a created report
 

build/generate-types.js

@@ -6,9 +6,9 @@ Promise.resolve().then(async () => {
   const { default: openapiTS } = await import('openapi-typescript')
 
   const localPath = path.resolve(__dirname, '../openapi.json')
-    const output = await openapiTS(localPath, {
-    formatter (node) {
-      if (node.format === 'binary') {
+  const output = await openapiTS(localPath, {
+    transform (schemaObject) {
+      if ('format' in schemaObject && schemaObject.format === 'binary') {
         return 'never'
       }
     }

index.js

@@ -190,6 +190,19 @@ class SocketSdk {
     }
   }
 
+  /**
+   * @returns {Promise<SocketSdkResultType<'getReportSupportedFiles'>>}
+   */
+  async getReportSupportedFiles () {
+    try {
+      const client = await this.#getClient()
+      const data = await client.get('report/supported').json()
+      return { success: true, status: 200, data }
+    } catch (err) {
+      return /** @type {SocketSdkErrorType<'getReportSupportedFiles'>} */ (this.#handleApiError(err))
+    }
+  }
+
   /** @returns {Promise<SocketSdkResultType<'getQuota'>>} */
   async getQuota () {
     try {