@verdocs/js-sdk 3.1.4 → 3.1.5

package/Envelopes/Envelopes.d.ts

@@ -195,3 +195,9 @@ export declare const getEnvelopesByTemplateId: (endpoint: VerdocsEndpoint, templ
  * for DISPLAY ONLY, are not legally binding documents, and do not contain any encoded metadata from participants.
  */
 export declare const getEnvelopeDocumentPageDisplayUri: (endpoint: VerdocsEndpoint, envelopeId: string, documentId: string, page: number) => Promise<string>;
+/**
+ * Wrapper for `getEnvelope()` that limits queries to one every 2 seconds per template ID.
+ * This is intended for use in component hierarchies that all rely on the same template
+ * to avoid unnecessary repeat server calls.
+ */
+export declare const throttledGetEnvelope: (endpoint: VerdocsEndpoint, envelopeId: string) => IEnvelope | Promise<IEnvelope>;

package/Envelopes/Envelopes.js

@@ -258,3 +258,18 @@ 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")).then(function (r) { return r.data; })];
 }); }); };
+var cachedEnvelopes = {};
+/**
+ * Wrapper for `getEnvelope()` that limits queries to one every 2 seconds per template ID.
+ * This is intended for use in component hierarchies that all rely on the same template
+ * to avoid unnecessary repeat server calls.
+ */
+export var throttledGetEnvelope = function (endpoint, envelopeId) {
+    if (cachedEnvelopes[envelopeId] && cachedEnvelopes[envelopeId].loaded + 2000 < new Date().getTime()) {
+        return cachedEnvelopes[envelopeId].envelope;
+    }
+    return getEnvelope(endpoint, envelopeId).then(function (envelope) {
+        cachedEnvelopes[envelopeId] = { loaded: new Date().getTime(), envelope: envelope };
+        return envelope;
+    });
+};

package/Templates/Templates.d.ts

@@ -122,3 +122,9 @@ export interface IGetTemplateSummaryParams {
  * ```
  */
 export declare const getSummary: (endpoint: VerdocsEndpoint, params?: IGetTemplateSummaryParams) => Promise<ITemplatesSummary>;
+/**
+ * Wrapper for `getTemplate()` that limits queries to one every 2 seconds per template ID.
+ * This is intended for use in component hierarchies that all rely on the same template
+ * to avoid unnecessary repeat server calls.
+ */
+export declare const throttledGetTemplate: (endpoint: VerdocsEndpoint, templateId: string) => ITemplate | Promise<ITemplate>;

package/Templates/Templates.js

@@ -162,3 +162,18 @@ export var getSummary = function (endpoint, params) {
         });
     });
 };
+var cachedTemplates = {};
+/**
+ * Wrapper for `getTemplate()` that limits queries to one every 2 seconds per template ID.
+ * This is intended for use in component hierarchies that all rely on the same template
+ * to avoid unnecessary repeat server calls.
+ */
+export var throttledGetTemplate = function (endpoint, templateId) {
+    if (cachedTemplates[templateId] && cachedTemplates[templateId].loaded + 2000 < new Date().getTime()) {
+        return cachedTemplates[templateId].template;
+    }
+    return getTemplate(endpoint, templateId).then(function (template) {
+        cachedTemplates[templateId] = { loaded: new Date().getTime(), template: template };
+        return template;
+    });
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdocs/js-sdk",
-  "version": "3.1.4",
+  "version": "3.1.5",
   "private": false,
   "homepage": "https://github.com/Verdocs/js-sdk",
   "description": "Verdocs JS SDK",