@verdocs/js-sdk 3.1.8 → 3.2.0

package/Envelopes/Envelopes.d.ts

@@ -133,7 +133,7 @@ export declare const getEnvelopeRecipients: (endpoint: VerdocsEndpoint, envelope
 /**
  * Get all metadata for an Envelope.
  */
-export declare const getEnvelope: (endpoint: VerdocsEndpoint, envelopeId: string, ssr?: boolean) => Promise<IEnvelope>;
+export declare const getEnvelope: (endpoint: VerdocsEndpoint, envelopeId: string) => Promise<IEnvelope>;
 /**
  * Get all metadata for an Envelope.
  */

package/Envelopes/Envelopes.js

@@ -136,10 +136,10 @@ export var getEnvelopeRecipients = function (endpoint, envelopeId) { return __aw
 /**
  * Get all metadata for an Envelope.
  */
-export var getEnvelope = function (endpoint, envelopeId, ssr) { return __awaiter(void 0, void 0, void 0, function () {
+export var getEnvelope = function (endpoint, envelopeId) { return __awaiter(void 0, void 0, void 0, function () {
     return __generator(this, function (_a) {
         return [2 /*return*/, endpoint.api //
-                .get("/envelopes/".concat(envelopeId) + (ssr ? '?ssr=true' : ''))
+                .get("/envelopes/".concat(envelopeId))
                 .then(function (r) { return r.data; })];
     });
 }); };
@@ -258,7 +258,12 @@ export var getEnvelopesByTemplateId = function (endpoint, templateId) { return _
 export var getEnvelopeDocumentPageDisplayUri = function (endpoint, envelopeId, documentId, page) { return __awaiter(void 0, void 0, void 0, function () {
     return __generator(this, function (_a) {
         return [2 /*return*/, endpoint.api
-                .get("/envelopes/".concat(envelopeId, "/envelope_documents/").concat(documentId, "/pages/").concat(page, "/image"), { timeout: 60000 })
+                .get("/envelopes/".concat(envelopeId, "/envelope_documents/").concat(documentId, "/pages/").concat(page, "/image"), {
+                timeout: 20000,
+                'axios-retry': {
+                    retries: 5,
+                },
+            })
                 .then(function (r) { return r.data; })];
     });
 }); };
@@ -272,7 +277,7 @@ export var throttledGetEnvelope = function (endpoint, envelopeId) {
     if (cachedEnvelopes[envelopeId] && cachedEnvelopes[envelopeId].loaded + 2000 < new Date().getTime()) {
         return cachedEnvelopes[envelopeId].envelope;
     }
-    return getEnvelope(endpoint, envelopeId, true).then(function (envelope) {
+    return getEnvelope(endpoint, envelopeId).then(function (envelope) {
         cachedEnvelopes[envelopeId] = { loaded: new Date().getTime(), envelope: envelope };
         return envelope;
     });

package/Envelopes/Types.d.ts

@@ -54,6 +54,7 @@ export type TRecipientType = `${RecipientTypes}`;
 export interface IEnvelopesSearchResultEntry {
     id: string;
     canceled_at: string;
+    /** @deprecated. New envelopes may have more than one certificate attached. */
     certificate_document_id: string;
     /** @deprecated. New envelopes may have more than one document attached. */
     envelope_document_id: string;
@@ -244,6 +245,7 @@ export interface IEnvelope {
     reminder_id: string | null;
     /** @deprecated. New envelopes will support more than one document attachment so new code should no longer refer to this field. */
     envelope_document_id: string;
+    /** @deprecated. New envelopes may have more than one certificate attached. */
     certificate_document_id: string | null;
     /** Defaults to 'private'. If set to 'shared', this envelope will be visible to other users in the same organization. Ignored for personal profiles. */
     visibility: 'private' | 'shared';

package/Templates/Pages.js

@@ -20,7 +20,12 @@ export var editPage = function (endpoint, templateId, sequence) {
 export var getPage = function (endpoint, templateId, sequence, thumbnail) {
     if (thumbnail === void 0) { thumbnail = false; }
     return endpoint.api //
-        .get("/templates/".concat(templateId, "/pages/").concat(sequence).concat(thumbnail ? '?thumbnail=true' : ''))
+        .get("/templates/".concat(templateId, "/pages/").concat(sequence).concat(thumbnail ? '?thumbnail=true' : ''), {
+        timeout: 20000,
+        'axios-retry': {
+            retries: 5,
+        },
+    })
         .then(function (r) { return r.data; });
 };
 /**

package/Templates/Templates.d.ts

@@ -33,7 +33,7 @@ export declare const getTemplates: (endpoint: VerdocsEndpoint, params?: IGetTemp
  * const template = await Templates.getTemplate((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9');
  * ```
  */
-export declare const getTemplate: (endpoint: VerdocsEndpoint, templateId: string, ssr?: boolean) => Promise<ITemplate>;
+export declare const getTemplate: (endpoint: VerdocsEndpoint, templateId: string) => Promise<ITemplate>;
 /**
  * Get owner information for a template.
  *

package/Templates/Templates.js

@@ -66,9 +66,9 @@ export var getTemplates = function (endpoint, params) {
  * const template = await Templates.getTemplate((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9');
  * ```
  */
-export var getTemplate = function (endpoint, templateId, ssr) {
+export var getTemplate = function (endpoint, templateId) {
     return endpoint.api //
-        .get("/templates/".concat(templateId) + (ssr ? '?ssr=true' : ''))
+        .get("/templates/".concat(templateId))
         .then(function (r) { return r.data; });
 };
 /**

package/Templates/Types.d.ts

@@ -290,17 +290,16 @@ export interface IPage {
      * @deprecated. New code should use `sequence`
      */
     page_number: number;
-    thumbnail_url?: string;
     /**
-     * The storage location for the page once rendered server-side. This can be used to determine whether a page has
-     * finished rendering, but cannot be accessed directly - client applications should use display_uri instead.
+     * @deprecated. Clients should not attempt to access images directly. Call `getTemplateDocumentPageDisplayUri()`
+     * instead.
      */
-    image_uri?: string | null;
+    thumbnail_url?: string;
     /**
-     * If the page was rendered server-side and the caller has access to view it, this will contain the signed URI
-     * to access it. NOTE: These URIs include short expirations and should never be cached or shared.
+     * @deprecated. Clients should not attempt to access images directly. Call `getTemplateDocumentPageDisplayUri()`
+     * instead.
      */
-    display_uri?: string | null;
+    image_uri?: string | null;
     template_document?: ITemplateDocument;
     fields?: ITemplateField[];
 }

package/VerdocsEndpoint.js

@@ -1,3 +1,4 @@
+import axiosRetry from 'axios-retry';
 import axios from 'axios';
 import { decodeAccessTokenBody } from './Utils/Token';
 import globalThis from './Utils/globalThis';
@@ -61,6 +62,14 @@ var VerdocsEndpoint = /** @class */ (function () {
         this.sessionType = (options === null || options === void 0 ? void 0 : options.sessionType) || 'user';
         this.clientID = (options === null || options === void 0 ? void 0 : options.clientID) || 'not-set';
         this.api = axios.create({ baseURL: this.baseURL, timeout: this.timeout });
+        // We set the default retries to zero because we only actually want this feature on certain calls for now
+        axiosRetry(this.api, {
+            retries: 0,
+            retryDelay: axiosRetry.exponentialDelay,
+            onRetry: function (retryCount, error, requestConfig) {
+                window.console.debug("[JS_SDK] Retrying request (".concat(retryCount, ")"), error.message, requestConfig.url);
+            },
+        });
     }
     VerdocsEndpoint.prototype.setDefault = function () {
         globalThis[ENDPOINT_KEY] = this;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdocs/js-sdk",
-  "version": "3.1.8",
+  "version": "3.2.0",
   "private": false,
   "homepage": "https://github.com/Verdocs/js-sdk",
   "description": "Verdocs JS SDK",
@@ -46,7 +46,8 @@
     "access": "public"
   },
   "dependencies": {
-    "axios": "^1.3.4"
+    "axios": "^1.3.4",
+    "axios-retry": "^3.4.0"
   },
   "peerDependencies": {
     "typescript": "^4.7.3"