@verdocs/js-sdk 3.3.4 → 3.6.0

package/Templates/TemplateDocuments.js

@@ -81,7 +81,7 @@ export var createTemplateDocument = function (endpoint, templateId, file, onUplo
     formData.append('document', file, file.name);
     return endpoint.api //
         .post("/templates/".concat(templateId, "/documents"), formData, {
-        timeout: 60000,
+        timeout: 120000,
         onUploadProgress: function (event) {
             var total = event.total || 1;
             var loaded = event.loaded || 0;

package/Templates/Templates.d.ts

@@ -82,11 +82,19 @@ export interface ITemplateCreateParams {
     sender?: TTemplateSender;
     /** Optional description for the template to help identify it. */
     description?: string;
-    /** Optional list of roles to create. Documents are required if roles or fields will also be specified. */
-    documents?: (IDocumentFromUri | IDocumentFromData)[];
-    /** Optional list of roles to create. Documents are required if fields will also be specified. */
+    /**
+     * Optional list of roles to create. Documents are required if roles or fields will also be specified. Files may
+     * be attached via a number of methods (browser File object, remote URI reference, or Base64-encoded string) but
+     * all entries must of of the same type.
+     */
+    documents?: File[] | IDocumentFromUri[] | IDocumentFromData[];
+    /**
+     * Optional list of roles to create. Note that if roles are not included in the request, fields will be ignored.
+     */
     roles?: IRole[];
-    /** Optional list of fields to create. Fields associated with roles or documents that do not exist will be ignored. */
+    /**
+     * Optional list of fields to create.
+     */
     fields?: ITemplateField[];
 }
 /**
@@ -98,7 +106,7 @@ export interface ITemplateCreateParams {
  * const newTemplate = await Templates.createTemplate((VerdocsEndpoint.getDefault(), {...});
  * ```
  */
-export declare const createTemplate: (endpoint: VerdocsEndpoint, params: ITemplateCreateParams) => Promise<ITemplate>;
+export declare const createTemplate: (endpoint: VerdocsEndpoint, params: ITemplateCreateParams, onUploadProgress?: ((percent: number, loadedBytes: number, totalBytes: number) => void) | undefined) => Promise<ITemplate>;
 /**
  * Update a template.
  *

package/Templates/Templates.js

@@ -85,6 +85,15 @@ export var getTemplateOwnerInfo = function (endpoint, templateId) {
         .get("/templates/".concat(templateId))
         .then(function (r) { return r.data; });
 };
+var ALLOWED_CREATE_FIELDS = [
+    'name',
+    'is_personal',
+    'is_public',
+    'sender',
+    'description',
+    'roles',
+    'fields',
+];
 /**
  * Create a template.
  *
@@ -94,10 +103,33 @@ export var getTemplateOwnerInfo = function (endpoint, templateId) {
  * const newTemplate = await Templates.createTemplate((VerdocsEndpoint.getDefault(), {...});
  * ```
  */
-export var createTemplate = function (endpoint, params) {
-    return endpoint.api //
-        .post('/templates/', params)
-        .then(function (r) { return r.data; });
+export var createTemplate = function (endpoint, params, onUploadProgress) {
+    var options = {
+        timeout: 120000,
+        onUploadProgress: function (event) {
+            var total = event.total || 1;
+            var loaded = event.loaded || 0;
+            onUploadProgress === null || onUploadProgress === void 0 ? void 0 : onUploadProgress(Math.floor((loaded * 100) / (total || 1)), loaded, total || 1);
+        },
+    };
+    if (params.documents && params.documents[0] instanceof File) {
+        if (params.documents.length > 10) {
+            throw new Error('createTemplate() has a maximum of 10 documents that can be attached.');
+        }
+        var formData_1 = new FormData();
+        ALLOWED_CREATE_FIELDS.forEach(function (allowedKey) {
+            if (params[allowedKey] !== undefined) {
+                formData_1.append(allowedKey, params[allowedKey]);
+            }
+        });
+        params.documents.forEach(function (file) {
+            formData_1.append('documents', file, file.name);
+        });
+        return endpoint.api.post('/templates', formData_1, options).then(function (r) { return r.data; });
+    }
+    else {
+        return endpoint.api.post('/templates', params, options).then(function (r) { return r.data; });
+    }
 };
 /**
  * Update a template.

package/Templates/Types.d.ts

@@ -88,6 +88,7 @@ export interface ITemplate {
     roles?: IRole[];
     /**
      * Pages attached to the template. Note that this is all of the pages for all document attachments in sequential order.
+     * @deprecated. Use document page counts instead, and accessor functions that take page numbers rather than Page objects.
      */
     pages?: IPage[];
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdocs/js-sdk",
-  "version": "3.3.4",
+  "version": "3.6.0",
   "private": false,
   "homepage": "https://github.com/Verdocs/js-sdk",
   "description": "Verdocs JS SDK",
@@ -35,7 +35,6 @@
     "lint": "tslint -p tsconfig.json",
     "docs-md": "typedoc --tsconfig ./tsconfig-typedoc.json",
     "docs-html": "typedoc --tsconfig ./tsconfig-typedoc.json --plugin none --out docs-html",
-    "Xdocs-html": "typedoc --tsconfig ./tsconfig-typedoc.json --plugin ./typedoc-theme.tsx --out docs-html",
     "docs": "npm run docs-md && npm run docs-html",
     "clear-docs": "aws --profile=verdocs cloudfront create-invalidation --distribution-id E29UFGU4KEH1GQ --paths \"/*\"",
     "deploy-docs": "npm run docs && aws --profile=verdocs s3 sync --acl public-read --delete docs-html s3://verdocs-developers-js-sdk/ && yarn clear-docs",