@verdocs/js-sdk - npm Package Compare versions

Comparing version 1.0.10 to 1.0.11

HTTP/Transport.d.ts

@@ -43,1 +43,11 @@ export declare const Endpoint: import("axios").AxiosInstance;
 export declare const setTimeout: (timeout: number) => void;
+/**
+ * Helper to get the endpoint rather than directly accessing the exported object.
+ *
+ * ```typescript
+ * import {Transport} from '@verdocs/js-sdk/HTTP';
+ *
+ * console.log('Current timeout', Transport.getEndpoint().defaults.timeout);
+ * ```
+ */
+export declare const getEndpoint: () => import("axios").AxiosInstance;

HTTP/Transport.js

 import axios from 'axios';
+// TODO: This is only for debugging purposes
 export var Endpoint = axios.create({
@@ -7,2 +8,4 @@ baseURL: 'https://api.verdocs.com/',
 });
+// tslint:disable-next-line
+console.log('[JS-SDK] Created endpoint', Endpoint);
 /**
@@ -57,1 +60,13 @@ * Set the auth token that will be used for Verdocs API calls.
 };
+/**
+ * Helper to get the endpoint rather than directly accessing the exported object.
+ *
+ * ```typescript
+ * import {Transport} from '@verdocs/js-sdk/HTTP';
+ *
+ * console.log('Current timeout', Transport.getEndpoint().defaults.timeout);
+ * ```
+ */
+export var getEndpoint = function () {
+    return Endpoint;
+};

package.json

 {
   "name": "@verdocs/js-sdk",
-  "version": "1.0.10",
+  "version": "1.0.11",
   "private": false,
@@ -29,3 +29,6 @@ "homepage": "https://github.com/Verdocs/js-sdk",
   "scripts": {
-    "build": "tsc && cp README.md package.json .npmignore dist",
+    "build": "rm -rf dist/* && tsc && cp README.md package.json .npmignore dist",
+    "preversion": "npm run lint",
+    "version": "npm run format && git add -A src",
+    "postversion": "git push && git push --tags",
     "test": "jest --config jestconfig.json",
@@ -36,3 +39,4 @@ "format": "prettier --write \"src/**/*.ts\"",
     "docs-html": "typedoc --plugin none --out docs-html",
-    "docs": "npm run docs-md && npm run docs-html && cp -aR docs-html/* ../partner-portal/site/static/js-sdk/"
+    "docs": "npm run docs-md && npm run docs-html && cp -aR docs-html/* ../partner-portal/site/static/js-sdk/",
+    "pub": "npm test && npm run lint && npm version patch && npm run build && npm run docs"
   },
@@ -39,0 +43,0 @@ "publishConfig": {

README.md

@@ -24,6 +24,6 @@ # Verdocs JS SDK
 import {Auth} from '@verdocs/js-sdk/Auth';
-import {Endpoint} from '@verdocs/js-sdk/HTTP';
+import {Transport} from '@verdocs/js-sdk/HTTP';
 
 const {accessToken} = await Auth.authenticateUser({username: 'MY_USERNAME', password: 'MY_PASSWORD'});
-Endpoint.setAuthToken(accessToken);
+Transport.setAuthToken(accessToken);
 ```
@@ -56,3 +56,3 @@
 The underlying transport uses `axios`, a cross-environment (NodeJS vs. Browser) HTTP transport layer. When this SDK is included in a
-project, an `Endpoint` singleton Axios Instance will be created to support the API calls to Verdocs servers. This endpoint's operation
+project, a `Transport` singleton Axios Instance will be created to support the API calls to Verdocs servers. This endpoint's operation
 may be configured by importing it. Please see the [Axios Documentation](https://github.com/axios/axios) for more information on the
@@ -62,5 +62,5 @@ options available. For example, to override the default API call timeout of 3s:
 ```typescript
-import {Endpoint} from '@verdocs/js-sdk/Auth/HTTP/Transport';
+import {Transport} from '@verdocs/js-sdk/Auth/HTTP';
 
-Endpoint.defaults.timeout = 5000;
+Transport.setTimeout(5000);
 ```
@@ -67,0 +67,0 @@

Users/Auth.d.ts

@@ -7,6 +7,6 @@ import { IAuthenticateAppRequest, IAuthenticateResponse, IAuthenticateUserRequest, TokenValidationRequest, TokenValidationResponse, UpdateEmailRequest, UpdateEmailResponse, UpdatePasswordRequest, UpdatePasswordResponse } from './Types';
  * import {Auth} from '@verdocs/js-sdk/Auth';
- * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+ * import {Transport} from '@verdocs/js-sdk/HTTP';
  *
  * const {accessToken} = await Auth.authenticateUser({ username: '[e-mail]', password: 'PASSWORD' });
- * Endpoint.setAuthToken(accessToken);
+ * Transport.setAuthToken(accessToken);
  * ```
@@ -24,6 +24,6 @@ */
  * import {Auth} from '@verdocs/js-sdk/Auth';
- * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+ * import {Transport} from '@verdocs/js-sdk/HTTP';
  *
  * const {accessToken} = await Auth.authenticateApp({ client_id: 'CLIENTID', client_secret: 'SECRET' });
- * Endpoint.setAuthToken(accessToken);
+ * Transport.setAuthToken(accessToken);
  * ```
@@ -52,6 +52,6 @@ */
  * import {Auth} from '@verdocs/js-sdk/Auth';
- * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+ * import {Transport} from '@verdocs/js-sdk/HTTP';
  *
  * const {accessToken} = await Auth.refreshTokens();
- * Auth.Endpoint.setAuthToken(accessToken);
+ * Transport.setAuthToken(accessToken);
  * ```
@@ -58,0 +58,0 @@ */

Users/Auth.js

@@ -7,6 +7,6 @@ import { Endpoint } from '../HTTP/Transport';
  * import {Auth} from '@verdocs/js-sdk/Auth';
- * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+ * import {Transport} from '@verdocs/js-sdk/HTTP';
  *
  * const {accessToken} = await Auth.authenticateUser({ username: '[e-mail]', password: 'PASSWORD' });
- * Endpoint.setAuthToken(accessToken);
+ * Transport.setAuthToken(accessToken);
  * ```
@@ -26,6 +26,6 @@ */
  * import {Auth} from '@verdocs/js-sdk/Auth';
- * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+ * import {Transport} from '@verdocs/js-sdk/HTTP';
  *
  * const {accessToken} = await Auth.authenticateApp({ client_id: 'CLIENTID', client_secret: 'SECRET' });
- * Endpoint.setAuthToken(accessToken);
+ * Transport.setAuthToken(accessToken);
  * ```
@@ -58,6 +58,6 @@ */
  * import {Auth} from '@verdocs/js-sdk/Auth';
- * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+ * import {Transport} from '@verdocs/js-sdk/HTTP';
  *
  * const {accessToken} = await Auth.refreshTokens();
- * Auth.Endpoint.setAuthToken(accessToken);
+ * Transport.setAuthToken(accessToken);
  * ```
@@ -64,0 +64,0 @@ */

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

97786

decreased by-21.41%

Number of package files

87

decreased by-17.14%

Lines of code

2199

decreased by-22.9%

No dependency changes