test: add unit tests to pipeline

packages/api/package.json

@@ -22,7 +22,8 @@
   },
   "scripts": {
     "build": "tsup --dts",
-    "format": "prettier . --ignore-path ../../.gitignore",
+    "docs": "typedoc --json ./docs/docs.json --options ../../typedoc.base.json src/index.ts",
+    "format": "prettier . -c --ignore-path ../../.gitignore",
     "format:fix": "prettier --write . --ignore-path ../../.gitignore",
     "lint": "eslint --ext .ts src/",
     "lint:fix": "eslint --fix --ext .ts src/",
@@ -67,7 +68,7 @@
     "@types/fs-extra": "9.0.13",
     "@types/json-schema": "7.0.11",
     "@types/mocha": "10.0.1",
-    "c8": "7.13.0",
+    "c8": "7.14.0",
     "chai": "4.3.7",
     "chai-as-promised": "7.1.1",
     "chai-spies": "1.0.0",
@@ -77,6 +78,7 @@
     "nock": "13.3.1",
     "ts-node": "10.9.1",
     "tsup": "6.7.0",
+    "typedoc": "0.24.7",
     "typescript": "4.8.4"
   },
   "peerDependencies": {

packages/api/src/connector-client.ts

@@ -26,7 +26,7 @@ import {
   SCThingUpdateRoute,
 } from '@openstapps/core';
 import moment from 'moment';
-import clone = require('rfdc');
+import clone from 'rfdc';
 import {v5} from 'uuid';
 import {Bulk} from './bulk.js';
 import {Client} from './client.js';
@@ -210,12 +210,12 @@ export class ConnectorClient extends Client {
    * @see ConnectorClient.bulk
    */
   async index<T extends SCThings>(things: T[], source?: string, timeout?: number): Promise<void> {
-    // check that number of things is not zero
+    // check that the number of things is not zero
     if (things.length === 0) {
       throw new EmptyBulkError();
     }
 
-    // set default source if none is given
+    // set the default source if none is given
     const thingSource = typeof source === 'undefined' ? 'stapps-api' : source;
 
     // request a new bulk