Convert to CJS (#15)

Author: Pelle Wessman

build/generate-types.js

@@ -1,14 +1,21 @@
-import openapiTS from 'openapi-typescript'
+'use strict'
 
-const localPath = new URL('../openapi.json', import.meta.url)
+Promise.resolve().then(async () => {
+  const { default: openapiTS } = await import('openapi-typescript')
 
-const output = await openapiTS(localPath, {
-  formatter (node) {
-    if (node.format === 'binary') {
-      return 'never'
+  const localPath = new URL('../openapi.json', import.meta.url)
+    const output = await openapiTS(localPath, {
+    formatter (node) {
+      if (node.format === 'binary') {
+        return 'never'
+      }
     }
-  }
-})
+  })
 
-// eslint-disable-next-line no-console
-console.log(output)
+  // eslint-disable-next-line no-console
+  console.log(output)
+}).catch(err => {
+  // eslint-disable-next-line no-console
+  console.error('Failed with error:', err.stack)
+  process.exit(1)
+})

build/prettify-base-json.js

@@ -1,6 +1,14 @@
-import { readFile, writeFile } from 'node:fs/promises'
-import path from 'node:path'
+'use strict'
 
-const openApiData = await readFile(path.join(__dirname, '../openapi.json'), 'utf8')
+const { readFile, writeFile } = require('node:fs/promises')
+const path = require('node:path')
 
-await writeFile(path.join(__dirname, '../openapi.json'), JSON.stringify(JSON.parse(openApiData), undefined, 2))
+Promise.resolve().then(async () => {
+  const openApiData = await readFile(path.join(__dirname, '../openapi.json'), 'utf8')
+
+  await writeFile(path.join(__dirname, '../openapi.json'), JSON.stringify(JSON.parse(openApiData), undefined, 2))
+}).catch(err => {
+  // eslint-disable-next-line no-console
+  console.error('Failed with error:', err.stack)
+  process.exit(1)
+})

index.js

@@ -1,10 +1,8 @@
-import path from 'node:path'
+'use strict'
 
-import { FormData } from 'formdata-node'
-import { fileFromPath } from 'formdata-node/file-from-path'
-import got from 'got'
+const path = require('node:path')
 
-import { handleApiError } from './lib/helpers.js'
+const { ErrorWithCause } = require('pony-cause')
 
 /**
  * @template {keyof import('./types/api').operations} T
@@ -27,10 +25,16 @@ import { handleApiError } from './lib/helpers.js'
  * @property {string} [baseUrl]
  */
 
-export class SocketSdk {
-   /** @type {import('got').Got} */
+class SocketSdk {
+   /** @type {import('got').Got|undefined} */
   #client
 
+  /** @type {typeof import('got').HTTPError|undefined} */
+  #HTTPError
+
+  /** @type {import('got').ExtendOptions} */
+  #gotOptions
+
   /**
    * @param {string} apiKey
    * @param {SocketSdkOptions} options
@@ -42,12 +46,29 @@ export class SocketSdk {
       baseUrl = 'https://api.socket.dev/v0/',
     } = options
 
-    this.#client = got.extend({
+    this.#gotOptions = {
       prefixUrl: baseUrl,
       retry: { limit: 0 },
       username: apiKey,
       ...(agent ? { agent } : {}),
-    })
+    }
+  }
+
+  /**
+   * @returns {Promise<import('got').Got>}
+   */
+  async #getClient () {
+    if (!this.#client) {
+      const {
+        default: got,
+        HTTPError,
+      } = await import('got')
+
+      this.#HTTPError = HTTPError
+      this.#client = got.extend(this.#gotOptions)
+    }
+
+    return this.#client
   }
 
   /**
@@ -59,6 +80,16 @@ export class SocketSdk {
     const basePath = path.resolve(process.cwd(), pathsRelativeTo)
     const absoluteFilePaths = filePaths.map(filePath => path.resolve(basePath, filePath))
 
+    const [
+      { FormData },
+      { fileFromPath },
+      client
+    ] = await Promise.all([
+      import('formdata-node'),
+      import('formdata-node/file-from-path'),
+      this.#getClient(),
+    ])
+
     const body = new FormData()
 
     const files = await Promise.all(absoluteFilePaths.map(absoluteFilePath => fileFromPath(absoluteFilePath)))
@@ -72,11 +103,11 @@ export class SocketSdk {
     }
 
     try {
-      const data = await this.#client.put('report/upload', { body }).json()
+      const data = await client.put('report/upload', { body }).json()
 
       return { success: true, status: 200, data }
     } catch (err) {
-      return /** @type {SocketSdkErrorType<'createReport'>} */ (handleApiError(err))
+      return /** @type {SocketSdkErrorType<'createReport'>} */ (this.#handleApiError(err))
     }
   }
 
@@ -90,10 +121,11 @@ export class SocketSdk {
     const versionParam = encodeURIComponent(version)
 
     try {
-      const data = await this.#client.get(`npm/${pkgParam}/${versionParam}/score`).json()
+      const client = await this.#getClient()
+      const data = await client.get(`npm/${pkgParam}/${versionParam}/score`).json()
       return { success: true, status: 200, data }
     } catch (err) {
-      return /** @type {SocketSdkErrorType<'getScoreByNPMPackage'>} */ (handleApiError(err))
+      return /** @type {SocketSdkErrorType<'getScoreByNPMPackage'>} */ (this.#handleApiError(err))
     }
   }
 
@@ -107,20 +139,22 @@ export class SocketSdk {
     const versionParam = encodeURIComponent(version)
 
     try {
-      const data = await this.#client.get(`npm/${pkgParam}/${versionParam}/issues`).json()
+      const client = await this.#getClient()
+      const data = await client.get(`npm/${pkgParam}/${versionParam}/issues`).json()
       return { success: true, status: 200, data }
     } catch (err) {
-      return /** @type {SocketSdkErrorType<'getIssuesByNPMPackage'>} */ (handleApiError(err))
+      return /** @type {SocketSdkErrorType<'getIssuesByNPMPackage'>} */ (this.#handleApiError(err))
     }
   }
 
   /** @returns {Promise<SocketSdkResultType<'getReportList'>>} */
   async getReportList () {
     try {
-      const data = await this.#client.get('report/list').json()
+      const client = await this.#getClient()
+      const data = await client.get('report/list').json()
       return { success: true, status: 200, data }
     } catch (err) {
-      return /** @type {SocketSdkErrorType<'getReportList'>} */ (handleApiError(err))
+      return /** @type {SocketSdkErrorType<'getReportList'>} */ (this.#handleApiError(err))
     }
   }
 
@@ -132,20 +166,75 @@ export class SocketSdk {
     const idParam = encodeURIComponent(id)
 
     try {
-      const data = await this.#client.get(`report/view/${idParam}`).json()
+      const client = await this.#getClient()
+      const data = await client.get(`report/view/${idParam}`).json()
       return { success: true, status: 200, data }
     } catch (err) {
-      return /** @type {SocketSdkErrorType<'getReport'>} */ (handleApiError(err))
+      return /** @type {SocketSdkErrorType<'getReport'>} */ (this.#handleApiError(err))
     }
   }
 
   /** @returns {Promise<SocketSdkResultType<'getQuota'>>} */
   async getQuota () {
     try {
-      const data = await this.#client.get('quota').json()
+      const client = await this.#getClient()
+      const data = await client.get('quota').json()
       return { success: true, status: 200, data }
     } catch (err) {
-      return /** @type {SocketSdkErrorType<'getQuota'>} */ (handleApiError(err))
+      return /** @type {SocketSdkErrorType<'getQuota'>} */ (this.#handleApiError(err))
     }
   }
+
+  /**
+   * @param {unknown} err
+   * @returns {{ success: false, status: number, error: Record<string,unknown> }}
+   */
+  #handleApiError (err) {
+    if (this.#HTTPError && err instanceof this.#HTTPError) {
+      if (err.response.statusCode >= 500) {
+        throw new ErrorWithCause('API returned an error', { cause: err })
+      }
+
+      return {
+        success: false,
+        status: err.response.statusCode,
+        error: this.#getApiErrorDescription(err)
+      }
+    }
+
+    throw new ErrorWithCause('Unexpected error when calling API', { cause: err })
+  }
+
+  /**
+   * @param {import('got').HTTPError} err
+   * @returns {Record<string,unknown>}
+   */
+  #getApiErrorDescription (err) {
+    /** @type {unknown} */
+    let rawBody
+
+    try {
+      rawBody = JSON.parse(/** @type {string} */ (err.response.body))
+    } catch (cause) {
+      throw new ErrorWithCause('Could not parse API error response', { cause })
+    }
+
+    const errorDescription = ensureObject(rawBody) ? rawBody['error'] : undefined
+
+    if (!ensureObject(errorDescription)) {
+      throw new Error('Invalid body on API error response')
+    }
+
+    return errorDescription
+  }
+}
+
+/**
+ * @param {unknown} value
+ * @returns {value is { [key: string]: unknown }}
+ */
+function ensureObject (value) {
+  return !!(value && typeof value === 'object' && !Array.isArray(value))
 }
+
+module.exports = { SocketSdk }

lib/helpers.js

@@ -13,16 +13,12 @@
     "type": "git",
     "url": "git://github.com/SocketDev/socket-sdk-js.git"
   },
-  "type": "module",
   "main": "index.js",
   "types": "index.d.ts",
   "files": [
     "index.d.ts.map",
     "index.d.ts",
     "index.js",
-    "lib/**/*.d.ts.map",
-    "lib/**/*.d.ts",
-    "lib/**/*.js",
     "types/**/*.d.ts"
   ],
   "engines": {

package.json

@@ -1,9 +1,11 @@
-import chai from 'chai'
-import chaiAsPromised from 'chai-as-promised'
-import nock from 'nock'
-import { ErrorWithCause } from 'pony-cause'
+'use strict'
 
-import { SocketSdk } from '../index.js'
+const chai = require('chai')
+const chaiAsPromised = require('chai-as-promised')
+const nock = require('nock')
+const { ErrorWithCause } = require('pony-cause')
+
+const { SocketSdk } = require('../index.js')
 
 chai.use(chaiAsPromised)
 chai.should()

test/main.spec.js

@@ -5,7 +5,6 @@
   ],
   "include": [
     "build/**/*",
-    "lib/**/*",
     "test/**/*",
   ],
   "compilerOptions": {