Merge pull request #312 from tiagosiebler/upgrades

v3.9.0: Upgrades to dependencies (axios, node build version, typescript, jest, etc)

.eslintrc.json

@@ -18,8 +18,9 @@
         "projecasdft": true,
         "project": [
           "./tsconfig.json",
+          "./tsconfig.build.json",
           "./tsconfig.examples.json",
-          "./tsconfig.test.json"
+          "./test/tsconfig.test.json"
         ]
       },
       "rules": {

.github/workflows/e2etest.yml

@@ -20,7 +20,7 @@ jobs:
 
       - uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: 20.11.0
           cache: 'npm'
 
       - name: Install

.github/workflows/npmpublish.yml

@@ -23,11 +23,12 @@ jobs:
       - uses: actions/checkout@v2
         if: steps.version-updated.outputs.has-updated
 
-      - uses: actions/setup-node@v1
+      - uses: actions/setup-node@v3
         if: steps.version-updated.outputs.has-updated
         with:
-          node-version: 16
+          node-version: 20.11.0
           registry-url: https://registry.npmjs.org/
+          cache: 'npm'
 
       - run: npm ci --ignore-scripts
         if: steps.version-updated.outputs.has-updated
@@ -46,15 +47,15 @@ jobs:
       #   uses: ncipollo/release-action@v1
 
   #publish-gpr:
-    #needs: build
+  #needs: build
-    #runs-on: ubuntu-latest
+  #runs-on: ubuntu-latest
-    #steps:
+  #steps:
-      #- uses: actions/checkout@v2
+  #- uses: actions/checkout@v2
-      #- uses: actions/setup-node@v1
+  #- uses: actions/setup-node@v1
-       # with:
+  # with:
-        #  node-version: 12
+  #  node-version: 12
-      #    registry-url: https://npm.pkg.github.com/
+  #    registry-url: https://npm.pkg.github.com/
-      #- run: npm ci
+  #- run: npm ci
-      #- run: npm publish
+  #- run: npm publish
-      #  env:
+  #  env:
-      #    NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
+  #    NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}

.nvmrc

@@ -1 +1 @@
-v18.14.1
+v20.11.0

jest.config.js

@@ -1,29 +0,0 @@
-// jest.config.js
-module.exports = {
-  rootDir: './',
-  globals: {
-    __DEV__: true,
-    __PROD__: false
-  },
-  testEnvironment: 'node',
-  preset: 'ts-jest',
-  verbose: true, // report individual test
-  bail: false, // enable to stop test when an error occur,
-  detectOpenHandles: true,
-  moduleDirectories: ['node_modules', 'src', 'test'],
-  testMatch: ['**/test/**/*.test.ts?(x)'],
-  testPathIgnorePatterns: ['node_modules/', 'dist/', '.json'],
-  collectCoverageFrom: [
-    'src/**/*.ts'
-  ],
-  coverageThreshold: {
-    // coverage strategy
-    global: {
-      branches: 80,
-      functions: 80,
-      lines: 50,
-      statements: -10
-    }
-  },
-  testTimeout: 1000 * 15
-};

jest.config.ts

@@ -0,0 +1,218 @@
+/**
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+import type { Config } from 'jest';
+
+const config: Config = {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+  bail: false, // enable to stop test when an error occur,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/private/var/folders/kf/2k3sz4px6c9cbyzj1h_b192h0000gn/T/jest_dx",
+
+  // Automatically clear mock calls, instances, contexts and results before every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  collectCoverage: false,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  collectCoverageFrom: ['src/**/*.ts'],
+
+  // The directory where Jest should output its coverage files
+  coverageDirectory: 'coverage',
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // Indicates which provider should be used to instrument code for coverage
+  coverageProvider: 'v8',
+
+  detectOpenHandles: true,
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: undefined,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // The default configuration for fake timers
+  // fakeTimers: {
+  //   "enableGlobally": false
+  // },
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+  moduleDirectories: ['node_modules', 'src', 'test'],
+
+  // An array of file extensions your modules use
+  // moduleFileExtensions: [
+  //   "js",
+  //   "mjs",
+  //   "cjs",
+  //   "jsx",
+  //   "ts",
+  //   "tsx",
+  //   "json",
+  //   "node"
+  // ],
+
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  // moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  // preset: undefined,
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state before every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state and implementation before every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: undefined,
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // The number of seconds after which a test is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  // testEnvironment: "jest-environment-node",
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  testMatch: [
+    // "**/__tests__/**/*.[jt]s?(x)",
+    '**/?(*.)+(spec|test).[tj]s?(x)',
+  ],
+
+  testTimeout: 15000,
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jest-circus/runner",
+
+  // A map from regular expressions to paths to transformers
+  // transform: undefined,
+
+  transform: {
+    '^.+\\.(t|j)s$': [
+      'ts-jest',
+      {
+        tsconfig: 'test/tsconfig.test.json',
+      },
+    ],
+  },
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "/node_modules/",
+  //   "\\.pnp\\.[^\\/]+$"
+  // ],
+
+  // Prevents import esm module error from v1 axios release, issue #5026
+  transformIgnorePatterns: ['node_modules/(?!axios)'],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: undefined,
+  verbose: true, // report individual test
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+};
+
+export default config;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "bybit-api",
-  "version": "3.8.2",
+  "version": "3.9.0",
   "description": "Complete & robust Node.js SDK for Bybit's REST APIs and WebSockets, with TypeScript & strong end to end tests.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -12,9 +12,9 @@
     "test": "jest",
     "test:watch": "jest --watch",
     "clean": "rimraf lib dist",
-    "build": "tsc",
+    "build": "tsc --project tsconfig.build.json",
     "build:clean": "npm run clean && npm run build",
-    "build:watch": "npm run clean && tsc --watch",
+    "build:watch": "npm run clean && tsc --project tsconfig.build.json --watch",
     "pack": "webpack --config webpack/webpack.config.js",
     "prepublish": "npm run build:clean",
     "betapublish": "npm publish --tag beta"
@@ -24,21 +24,23 @@
     "Stefan Aebischer <os@pixtron.ch> (https://pixtron.ch)"
   ],
   "dependencies": {
-    "axios": "^0.21.0",
+    "axios": "^1.6.6",
     "isomorphic-ws": "^4.0.1",
     "ws": "^7.4.0"
   },
   "devDependencies": {
-    "@types/jest": "^27.0.4",
+    "@types/jest": "^29.5.11",
-    "@types/node": "^14.14.7",
+    "@types/node": "^20.11.6",
-    "@typescript-eslint/eslint-plugin": "^5.46.0",
     "@typescript-eslint/parser": "^5.46.0",
     "eslint": "^8.29.0",
-    "jest": "^27.0.4",
+    "jest": "^29.7.0",
+    "ts-node": "^10.9.2",
+    "ts-jest": "^29.1.2",
+    "typescript": "^5.3.3"
+  },
+  "optionalDependencies": {
     "source-map-loader": "^2.0.0",
-    "ts-jest": "^27.0.4",
     "ts-loader": "^8.0.11",
-    "typescript": "^4.0.5",
     "webpack": "^5.4.0",
     "webpack-bundle-analyzer": "^4.1.0",
     "webpack-cli": "^4.2.0"

src/util/BaseRestClient.ts

@@ -66,6 +66,9 @@ interface SignedRequest<T> {
 interface UnsignedRequest<T> {
   originalParams: T;
   paramsWithSign: T;
+  sign?: string;
+  timestamp?: number;
+  recvWindow?: number;
 }
 
 type SignMethod = 'v2auth' | 'v5auth';
@@ -187,6 +190,13 @@ export default abstract class BaseRestClient {
     isPublicApi?: false | undefined,
   ): Promise<SignedRequest<TParams>>;
 
+  private async prepareSignParams<TParams extends SignedRequestContext = any>(
+    method: Method,
+    signMethod: SignMethod,
+    params?: TParams,
+    isPublicApi?: boolean,
+  ): Promise<SignedRequest<TParams> | UnsignedRequest<TParams>>;
+
   private async prepareSignParams<TParams extends SignedRequestContext = any>(
     method: Method,
     signMethod: SignMethod,
@@ -250,7 +260,7 @@ export default abstract class BaseRestClient {
         isPublicApi,
       );
 
-      const headers = {
+      const headers: AxiosRequestConfig['headers'] = {
         'X-BAPI-SIGN-TYPE': 2,
         'X-BAPI-API-KEY': this.key,
         'X-BAPI-TIMESTAMP': signResult.timestamp,

src/util/requestUtils.ts

@@ -1,3 +1,4 @@
+import { AxiosResponse } from 'axios';
 import { APIRateLimit } from '../types';
 import { WebsocketSucceededTopicSubscriptionConfirmationEvent } from '../types/ws-events/succeeded-topic-subscription-confirmation';
 import { WebsocketTopicSubscriptionConfirmationEvent } from '../types/ws-events/topic-subscription-confirmation';
@@ -179,10 +180,13 @@ export type RestClientType =
 
 /** Parse V5 rate limit response headers, if enabled */
 export function parseRateLimitHeaders(
-  headers: Record<string, string | undefined> = {},
+  headers: AxiosResponse['headers'] | undefined,
   throwOnFailedRateLimitParse: boolean,
 ): APIRateLimit | undefined {
   try {
+    if (!headers || typeof headers !== 'object') {
+      return;
+    }
     const remaining = headers['x-bapi-limit-status'];
     const max = headers['x-bapi-limit'];
     const resetAt = headers['x-bapi-limit-reset-timestamp'];

test/proxy.util.ts

@@ -20,6 +20,7 @@ export function getTestProxy(): AxiosRequestConfig {
         username: user,
         password: pass,
       },
+      protocol: 'http',
     },
   };
 }

test/tsconfig.test.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../tsconfig.json",
+  "exclude": ["node_modules", "dist"],
+  "compilerOptions": {
+    "strictNullChecks": false
+  },
+  "include": ["test/**/*.ts"]
+}

tsconfig.build.json

@@ -0,0 +1,11 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": [
+    "node_modules",
+    "test",
+    "dist",
+    "**/*spec.ts",
+    "**/*test.ts",
+    "jest.config.ts"
+  ]
+}

tsconfig.json

@@ -14,8 +14,9 @@
     "sourceMap": true,
     "esModuleInterop": true,
     "lib": ["es2017", "dom"],
+    "baseUrl": ".",
     "outDir": "./lib"
   },
-  "include": ["src/**/*"],
+  "include": ["src/**/*", "src/.ts"],
   "exclude": ["node_modules", "**/node_modules/*", "coverage", "doc"]
 }