@verdocs/js-sdk 3.3.4 → 3.6.1

package/Envelopes/Envelopes.d.ts

@@ -142,22 +142,6 @@ export declare const getEnvelopeDocument: (endpoint: VerdocsEndpoint, envelopeId
  * Cancel an Envelope.
  */
 export declare const cancelEnvelope: (endpoint: VerdocsEndpoint, envelopeId: string) => Promise<TEnvelopeUpdateResult>;
-/**
- * Returns true if the recipient has a pending action. Note that this does not necessarily mean the recipient can act (yet).
- */
-export declare const recipientHasAction: (recipient: IRecipient) => boolean;
-/**
- * Returns the recipients who still have a pending action. Note that not all of these recipients may be able to act (yet).
- */
-export declare const getRecipientsWithActions: (envelope: IEnvelope) => IRecipient[];
-/**
- * Returns true if the recipient can act.
- */
-export declare const recipientCanAct: (recipient: IRecipient, recipientsWithActions: IRecipient[]) => boolean;
-/**
- * Returns true if the user can act.
- */
-export declare const userCanAct: (email: string, recipientsWithActions: IRecipient[]) => boolean | undefined;
 /**
  * Get (binary download) a file attached to an Envelope. It is important to use this method
  * rather than a direct A HREF or similar link to set the authorization headers for the

package/Envelopes/Envelopes.js

@@ -163,26 +163,6 @@ export var cancelEnvelope = function (endpoint, envelopeId) { return __awaiter(v
                 .then(function (r) { return r.data; })];
     });
 }); };
-/**
- * Returns true if the recipient has a pending action. Note that this does not necessarily mean the recipient can act (yet).
- */
-export var recipientHasAction = function (recipient) { return !['submitted', 'canceled', 'declined'].includes(recipient.status); };
-/**
- * Returns the recipients who still have a pending action. Note that not all of these recipients may be able to act (yet).
- */
-export var getRecipientsWithActions = function (envelope) { return ((envelope === null || envelope === void 0 ? void 0 : envelope.recipients) || []).filter(recipientHasAction); };
-/**
- * Returns true if the recipient can act.
- */
-export var recipientCanAct = function (recipient, recipientsWithActions) { var _a; return recipient.sequence === ((_a = recipientsWithActions === null || recipientsWithActions === void 0 ? void 0 : recipientsWithActions[0]) === null || _a === void 0 ? void 0 : _a.sequence); };
-/**
- * Returns true if the user can act.
- */
-export var userCanAct = function (email, recipientsWithActions) {
-    var _a;
-    var recipient = recipientsWithActions.find(function (r) { return r.email === email; });
-    return recipient && recipient.sequence === ((_a = recipientsWithActions === null || recipientsWithActions === void 0 ? void 0 : recipientsWithActions[0]) === null || _a === void 0 ? void 0 : _a.sequence);
-};
 /**
  * Get (binary download) a file attached to an Envelope. It is important to use this method
  * rather than a direct A HREF or similar link to set the authorization headers for the

package/Envelopes/Permissions.d.ts

@@ -3,7 +3,7 @@
  *
  * @module
  */
-import { IEnvelope } from './Types';
+import { IEnvelope, IRecipient } from './Types';
 import { TSession } from '../Sessions/Types';
 /**
  * Check to see if the user owns the envelope.
@@ -13,6 +13,14 @@ export declare const userIsEnvelopeOwner: (session: TSession, envelope: IEnvelop
  * Check to see if the user owns the envelope.
  */
 export declare const userIsEnvelopeRecipient: (session: TSession, envelope: IEnvelope) => boolean;
+/**
+ * Check to see if the envelope has pending actions.
+ */
+export declare const envelopeIsActive: (envelope: IEnvelope) => boolean;
+/**
+ * Check to see if the envelope has been completed.
+ */
+export declare const envelopeIsComplete: (envelope: IEnvelope) => boolean;
 /**
  * Check to see if the user owns the envelope.
  */
@@ -21,3 +29,23 @@ export declare const userCanCancelEnvelope: (session: TSession, envelope: IEnvel
  * Check to see if the user owns the envelope.
  */
 export declare const userCanFinishEnvelope: (session: TSession, envelope: IEnvelope) => boolean;
+/**
+ * Returns true if the recipient has a pending action. Note that this does not necessarily mean the recipient can act (yet).
+ */
+export declare const recipientHasAction: (recipient: IRecipient) => boolean;
+/**
+ * Returns the recipients who still have a pending action. Note that not all of these recipients may be able to act (yet).
+ */
+export declare const getRecipientsWithActions: (envelope: IEnvelope) => IRecipient[];
+/**
+ * Returns true if the recipient can act.
+ */
+export declare const recipientCanAct: (recipient: IRecipient, recipientsWithActions: IRecipient[]) => boolean;
+/**
+ * Returns true if the user can act.
+ */
+export declare const userCanAct: (email: string, recipientsWithActions: IRecipient[]) => boolean | undefined;
+/**
+ * Returns true if the user can act.
+ */
+export declare const userCanSignNow: (session: TSession, envelope: IEnvelope) => boolean | undefined;

package/Envelopes/Permissions.js

@@ -12,6 +12,16 @@ export var userIsEnvelopeOwner = function (session, envelope) { return envelope.
  * Check to see if the user owns the envelope.
  */
 export var userIsEnvelopeRecipient = function (session, envelope) { return envelope.profile_id === (session === null || session === void 0 ? void 0 : session.profile_id); };
+/**
+ * Check to see if the envelope has pending actions.
+ */
+export var envelopeIsActive = function (envelope) {
+    return envelope.status !== EnvelopeStates.COMPLETE && envelope.status !== EnvelopeStates.DECLINED && envelope.status !== EnvelopeStates.CANCELED;
+};
+/**
+ * Check to see if the envelope has been completed.
+ */
+export var envelopeIsComplete = function (envelope) { return envelope.status !== EnvelopeStates.COMPLETE; };
 /**
  * Check to see if the user owns the envelope.
  */
@@ -31,3 +41,37 @@ export var userCanFinishEnvelope = function (session, envelope) {
         envelope.status !== EnvelopeStates.DECLINED &&
         envelope.status !== EnvelopeStates.CANCELED;
 };
+/**
+ * Returns true if the recipient has a pending action. Note that this does not necessarily mean the recipient can act (yet).
+ */
+export var recipientHasAction = function (recipient) { return !['submitted', 'canceled', 'declined'].includes(recipient.status); };
+/**
+ * Returns the recipients who still have a pending action. Note that not all of these recipients may be able to act (yet).
+ */
+export var getRecipientsWithActions = function (envelope) { return ((envelope === null || envelope === void 0 ? void 0 : envelope.recipients) || []).filter(recipientHasAction); };
+/**
+ * Returns true if the recipient can act.
+ */
+export var recipientCanAct = function (recipient, recipientsWithActions) { var _a; return recipient.sequence === ((_a = recipientsWithActions === null || recipientsWithActions === void 0 ? void 0 : recipientsWithActions[0]) === null || _a === void 0 ? void 0 : _a.sequence); };
+/**
+ * Returns true if the user can act.
+ */
+export var userCanAct = function (email, recipientsWithActions) {
+    var _a;
+    var recipient = recipientsWithActions.find(function (r) { return r.email === email; });
+    return recipient && recipient.sequence === ((_a = recipientsWithActions === null || recipientsWithActions === void 0 ? void 0 : recipientsWithActions[0]) === null || _a === void 0 ? void 0 : _a.sequence);
+};
+/**
+ * Returns true if the user can act.
+ */
+export var userCanSignNow = function (session, envelope) {
+    if (!session) {
+        return false;
+    }
+    var recipientsWithActions = getRecipientsWithActions(envelope);
+    var myRecipient = recipientsWithActions.find(function (r) { return r.profile_id === (session === null || session === void 0 ? void 0 : session.profile_id) || r.email === (session === null || session === void 0 ? void 0 : session.email); });
+    return (myRecipient &&
+        envelopeIsActive(envelope) &&
+        userIsEnvelopeRecipient(session, envelope) &&
+        recipientCanAct(myRecipient, recipientsWithActions));
+};

package/Envelopes/Recipients.d.ts

@@ -1,4 +1,4 @@
-import { IEnvelope, IRecipient, IInPersonAccessKey } from './Types';
+import { IEnvelope, IRecipient, IInPersonAccessKey, TAccessKey } from './Types';
 import { VerdocsEndpoint } from '../VerdocsEndpoint';
 export interface IUpdateRecipientSubmitParams {
     action: 'submit';
@@ -68,6 +68,12 @@ export interface ISignerTokenResponse {
 export declare const getSignerToken: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<ISignerTokenResponse>;
 export interface IInPersonLinkResponse {
     link: string;
+    envelope_id: string;
+    profile_id: string;
+    role_name: string;
+    access_key: string;
+    expiration_date: string;
+    type: TAccessKey;
 }
 /**
  * Get an in-person signing link.

package/Envelopes/Types.d.ts

@@ -15,6 +15,29 @@ export interface IInPersonAccessKey {
     first_used: string | null;
     last_used: string | null;
 }
+export interface IEmailAccessKey {
+    id: string;
+    created_at: string;
+    recipient_name: string;
+    envelope_id: string;
+    type: 'email';
+    key: string;
+    expiration_date: string | null;
+    first_used: string | null;
+    last_used: string | null;
+}
+export interface ISMSAccessKey {
+    id: string;
+    created_at: string;
+    recipient_name: string;
+    envelope_id: string;
+    type: 'sms';
+    key: string;
+    expiration_date: string | null;
+    first_used: string | null;
+    last_used: string | null;
+}
+export type TAccessKey = IInPersonAccessKey | IEmailAccessKey | ISMSAccessKey;
 export declare enum RecipientActions {
     SUBMIT = "submit",
     DECLINE = "decline",

package/Sessions/Types.d.ts

@@ -45,6 +45,10 @@ export interface IUserSession {
  */
 export type TSessionType = 'user' | 'signing';
 /**
- * An authenticated session within Verdocs, either for signing or regular user-based operations.
+ * Represents a possibly-authenticated session within Verdocs, either for signing or regular user-based operations.
  */
 export type TSession = IUserSession | ISigningSession | null;
+/**
+ * An active authenticated session within Verdocs, either for signing or regular user-based operations.
+ */
+export type TActiveSession = IUserSession | ISigningSession;

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,20 @@ 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. If browser File objects are provided, the request will use a FORM POST
+     * call, otherwise it will use traditional XHR.
+     */
+    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 +107,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.1",
   "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",