Rewrite with handcrafted class (#13)

* Rewrite with handcrafted class

Replaces `api` module with a simple handcrafted API class that wraps `got` and which simply auto-generates the types

* Add husky + readd lockfile

* Extend static code analysis + tests

* Fix npm lint workflow test script name

* Fix path to openapi.json

* Update README

* Restore prettification of base JSON

Author: Pelle Wessman

.eslintignore

@@ -1,4 +1,3 @@
+/coverage/**/*
 /dist
-/index.d.ts
-/index.js
-/src
+/types/api.d.ts

.eslintrc

@@ -2,10 +2,7 @@
   "extends": "@socketsecurity",
   "root": true,
   "parserOptions": {
-    "project": [
-      "./build/tsconfig.json",
-      "./tests/tsconfig.json"
-    ]
+    "project": "./tsconfig.json"
   },
   "rules": {
     "no-console": "warn"

.github/workflows/ci.yml

@@ -20,16 +20,10 @@ jobs:
     name: "Linting"
     uses: SocketDev/workflows/.github/workflows/reusable-base.yml@master
     with:
-      npm-test-script: 'lint'
-  test-old:
-    name: "Tests"
-    uses: SocketDev/workflows/.github/workflows/reusable-base.yml@master
-    with:
-      npm-test-script: 'ci-test-old'
-      node-versions: '14,16'
+      npm-test-script: 'check'
   test:
     name: "Tests"
     uses: SocketDev/workflows/.github/workflows/reusable-base.yml@master
     with:
       npm-test-script: 'ci-test'
-      node-versions: '18,19'
+      node-versions: '14,16,18,19'

.gitignore

@@ -1,4 +1,16 @@
+# Basic ones
+/coverage
+/coverage-ts
+/node_modules
+/.env
+/.nyc_output
+/yarn.lock
+
+# Generated types
+*.d.ts
+*.d.ts.map
+!api*.d.ts
+
+# Library specific ones
 /.api
-dist
-node_modules
-.nyc_output
+/dist

.husky/pre-push

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npm test

README.md

@@ -16,22 +16,48 @@ npm install @socketsecurity/sdk
 ### ESM / TypeScript
 
 ```javascript
-import { socketSdk } from '@socketsecurity/sdk'
+import { SocketSdk } from '@socketsecurity/sdk'
 
-const client = socketSdk.auth('yourApiKeyHere')
+const client = new SocketSdk('yourApiKeyHere')
 
-const res = await client.getIssuesByNPMPackage({
-  package: '@socketsecurity/eslint-config',
-  version: '1.0.0'
-})
+const res = await client.getQuota()
+
+if (res.success) {
+  // Will output { quota: 123 } if the quota you have left is 123
+  console.log(res.data)
+}
 ```
 
 ### CommonJS
 
 ```javascript
-const { socketSdk } = require('@socketsecurity/sdk')
+const { SocketSdk } = require('@socketsecurity/sdk')
 ```
 
+## SocketSdk Methods
+
+### Package methods
+
+* `getIssuesByNPMPackage(packageName, version)`
+  * `packageName`: A `string` representing the name of the npm package you want the issues for
+  * `version`:  A `string` representing the version of the npm package to return the issues for
+* `getScoreByNPMPackage(packageName, version)`
+  * `packageName`: A `string` representing the name of the npm package you want the score for
+  * `version`:  A `string` representing the version of the npm package to return the score for
+
+### Report methods
+
+* `createReportFromFilePaths(filePaths, pathsRelativeTo=.)`
+  * `filePaths`: An `array` of absolute or relative `string` paths to `package.json` and any corresponding `package-lock.json` files
+  * `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
+* `getReportList()`
+* `getReport(id)`
+  * `id`: A `string` representing the id of a created report
+
+### Utility methods
+
+* `getQuota()`
+
 ## See also
 
 * [Socket API Reference](https://docs.socket.dev/reference)

build/generate-sdk.js

@@ -0,0 +1,14 @@
+import openapiTS from 'openapi-typescript'
+
+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)

build/generate-types.js

@@ -1,14 +1,6 @@
-/* eslint-disable no-console */
-// @ts-check
+import { readFile, writeFile } from 'node:fs/promises'
+import path from 'node:path'
 
-const { readFile, writeFile } = require('node:fs/promises')
-const path = require('node:path')
+const openApiData = await readFile(path.join(__dirname, '../openapi.json'), 'utf8')
 
-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 => {
-  console.error('Failed with error:', err.stack)
-  process.exit(1)
-})
+await writeFile(path.join(__dirname, '../openapi.json'), JSON.stringify(JSON.parse(openApiData), undefined, 2))