@verdocs/js-sdk 2.0.10 → 2.0.13

package/Documents/Documents.d.ts

@@ -1,160 +1,7 @@
-import { ISigningSession, ISigningSessionRequest } from './Types';
+import { IDocument, IDocumentsSearchResult, IDocumentsSummary, IRecipient, ISigningSession, ISigningSessionRequest } from './Types';
 import { VerdocsEndpoint } from '../VerdocsEndpoint';
 import { IFieldSetting } from '../Templates/Types';
-import { IProfile } from '../Users/Types';
-export declare type TDocumentStatus = 'complete' | 'pending' | 'in progress' | 'declined' | 'canceled';
-export declare type TRecipientStatus = 'invited' | 'opened' | 'signed' | 'submitted' | 'canceled' | 'pending' | 'declined';
-export declare type TRecipientType = 'signer' | 'cc' | 'approver';
-export interface IDocumentsSearchResultEntry {
-    id: string;
-    canceled_at: string;
-    certificate_document_id: string;
-    created_at: string;
-    envelope_document_id: string;
-    histories: IHistory[];
-    indexed_at: string;
-    name: string;
-    no_contact: boolean;
-    organization_id: string;
-    profile_id: string;
-    recipients: string;
-    reminder_id: string | null;
-    status: TDocumentStatus;
-    next_recipient: {
-        claimed: boolean;
-        email: string;
-        name: string;
-        profile_id: string;
-        status: TRecipientStatus;
-        type: TRecipientType;
-    };
-    template_id: string;
-    total_count: number;
-    updated_at: string;
-}
-export interface IDocumentsSearchResult {
-    page: number;
-    total: number;
-    result: IDocumentsSearchResultEntry[];
-}
-export interface IDocumentsSummary {
-    action_required: {
-        page: number;
-        total: number;
-        result: IActivityEntry[];
-    };
-    completed: {
-        page: number;
-        total: number;
-        result: IActivityEntry[];
-    };
-    waiting_others: {
-        page: number;
-        total: number;
-        result: IActivityEntry[];
-    };
-}
-export interface IRecipient {
-    agreed: boolean;
-    claimed: boolean;
-    created_at: string;
-    delegated_to: string | null;
-    delegator: boolean;
-    email: string;
-    envelope_id: string;
-    full_name: string;
-    in_app_access_key?: string;
-    key_used_to_conclude?: string;
-    message: string | null;
-    phone: string | null;
-    profile_id: string;
-    role_name: string;
-    sequence: number;
-    status: TRecipientStatus;
-    type: TRecipientType;
-    updated_at: string;
-}
-export interface IDocumentAsset {
-    created_at: string;
-    id: string;
-    mime: string;
-    name: string;
-    page_numbers: number;
-    updated_at: string;
-    url: string;
-}
-export interface IDocumentField {
-    envelope_id: string;
-    label: string | null;
-    name: string;
-    page: number;
-    recipient_role: string;
-    type: string;
-    required: boolean;
-    settings?: IFieldSetting;
-    setting?: IFieldSetting;
-    validator: string | null;
-    prepared?: boolean;
-}
-export interface IDocument {
-    id: string;
-    created_at: string;
-    canceled_at: string;
-    envelope_document_id: string;
-    certificate_document_id: string | null;
-    histories: IHistory[];
-    recipients: IRecipient[];
-    name: string;
-    no_contact: boolean;
-    profile_id: string;
-    reminder_id: string | null;
-    status: TDocumentStatus;
-    template_id: string;
-    updated_at: string;
-    organization_id: string | null;
-    certificate?: IDocumentAsset | null;
-    document?: IDocumentAsset | null;
-    fields?: IDocumentField[];
-    profile?: IProfile;
-}
-export interface IActivityEntry {
-    id: string;
-    name: string;
-    canceled_at: string;
-    created_at: string;
-    updated_at: string;
-    profile_id: string;
-    status: TDocumentStatus;
-    template_id: string;
-    recipient: {
-        claimed: boolean;
-        email: string;
-        name: string;
-        profile_id: string;
-        status: TRecipientStatus;
-        type: TRecipientType;
-    };
-}
-export interface IHistory {
-    created_at: string;
-    envelope_id: string;
-    event: IHistoryEvent;
-    event_detail: IEventDetail;
-    id: string;
-    role_name: string;
-}
-export interface IDocumentSearchOptions {
-    rows?: number;
-    page?: number;
-    sort_by?: 'updated_at' | 'created_at';
-    ascending?: boolean;
-    is_owner?: boolean;
-    is_recipient?: boolean;
-    envelope_status: TDocumentStatus[];
-    recipient_status: TDocumentStatus[];
-}
-export declare type IHistoryEvent = 'recipient:invited' | 'recipient:opened' | 'recipient:agreed' | 'recipient:signed' | 'recipient:submitted';
-export declare type IEventDetail = 'in_app' | 'mail' | 'signer' | '';
+import { TDocumentUpdateResult } from './Types';
 /**
  * Get a summary of currently active documents.
  *
@@ -192,6 +39,26 @@ export declare const getDocumentRecipients: (endpoint: VerdocsEndpoint, document
  * Get all metadata for a Document.
  */
 export declare const getDocument: (endpoint: VerdocsEndpoint, documentId: string) => Promise<IDocument>;
+/**
+ * Cancel a Document.
+ */
+export declare const cancelDocument: (endpoint: VerdocsEndpoint, documentId: string) => Promise<TDocumentUpdateResult>;
+/**
+ * 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: (document: IDocument) => 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 a Document.
  */

package/Documents/Documents.js

@@ -104,6 +104,36 @@ export var getDocument = function (endpoint, documentId) { return __awaiter(void
                 .then(function (r) { return r.data; })];
     });
 }); };
+/**
+ * Cancel a Document.
+ */
+export var cancelDocument = function (endpoint, documentId) { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        return [2 /*return*/, endpoint.api //
+                .put("/documents/".concat(documentId), { action: 'cancel' })
+                .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 (document) { return ((document === null || document === void 0 ? void 0 : document.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 a Document.
  */

package/Documents/Recipients.d.ts

@@ -1,6 +1,6 @@
-import { IRecipient } from './Documents';
+import { IInPersonAccessKey, TRecipientAction } from './Types';
 import { VerdocsEndpoint } from '../VerdocsEndpoint';
-export declare type TRecipientAction = 'submit' | 'decline' | 'prepare' | 'update';
+import { IDocument, IRecipient } from './Types';
 export interface IUpdateRecipientParams {
     new_full_name?: string;
     agreed?: boolean;
@@ -9,3 +9,11 @@ export interface IUpdateRecipientParams {
  * Update a recipient's status block
  */
 export declare const updateRecipientStatus: (endpoint: VerdocsEndpoint, documentId: string, roleName: string, action: TRecipientAction, params?: IUpdateRecipientParams) => Promise<IRecipient>;
+export interface ISignerTokenResponse {
+    recipient: IRecipient;
+    envelope: IDocument;
+    signerToken: string;
+    inPersonAccessKey: IInPersonAccessKey;
+}
+export declare const getSignerToken: (endpoint: VerdocsEndpoint, documentId: string, roleName: string) => Promise<ISignerTokenResponse>;
+export declare const getInPersonLink: (endpoint: VerdocsEndpoint, documentId: string, roleName: string) => Promise<ISignerTokenResponse>;

package/Documents/Recipients.js

@@ -55,3 +55,13 @@ export var updateRecipientStatus = function (endpoint, documentId, roleName, act
                 .then(function (r) { return r.data; })];
     });
 }); };
+export var getSignerToken = function (endpoint, documentId, roleName) {
+    return endpoint.api //
+        .get("/documents/".concat(documentId, "/recipients/").concat(encodeURIComponent(roleName), "/signer-token"))
+        .then(function (r) { return r.data; });
+};
+export var getInPersonLink = function (endpoint, documentId, roleName) {
+    return endpoint.api //
+        .get("/documents/".concat(documentId, "/recipients/").concat(encodeURIComponent(roleName), "?in_person_link=true"))
+        .then(function (r) { return r.data; });
+};

package/Documents/Types.d.ts

@@ -1,3 +1,6 @@
+import { IFieldSetting } from '../Templates/Types';
+import { IProfile } from '../Users/Types';
+export declare type TRecipientAction = 'submit' | 'decline' | 'prepare' | 'update';
 export interface ITemplateSummaryEntry {
     id: string;
     name: string;
@@ -41,3 +44,168 @@ export interface ISigningSession {
     iat: number;
     [key: string]: any;
 }
+export interface IInPersonAccessKey {
+    id: string;
+    created_at: string;
+    recipient_name: string;
+    envelope_id: string;
+    type: 'in_person_link';
+    key: string;
+    expiration_date: string | null;
+    first_used: string | null;
+    last_used: string | null;
+}
+export declare type TDocumentStatus = 'complete' | 'pending' | 'in progress' | 'declined' | 'canceled';
+export declare type TRecipientStatus = 'invited' | 'opened' | 'signed' | 'submitted' | 'canceled' | 'pending' | 'declined';
+export declare type TRecipientType = 'signer' | 'cc' | 'approver';
+export interface IDocumentsSearchResultEntry {
+    id: string;
+    canceled_at: string;
+    certificate_document_id: string;
+    created_at: string;
+    envelope_document_id: string;
+    histories: IHistory[];
+    indexed_at: string;
+    name: string;
+    no_contact: boolean;
+    organization_id: string;
+    profile_id: string;
+    recipients: IRecipient[];
+    reminder_id: string | null;
+    status: TDocumentStatus;
+    next_recipient: {
+        claimed: boolean;
+        email: string;
+        name: string;
+        profile_id: string;
+        status: TRecipientStatus;
+        type: TRecipientType;
+    };
+    template_id: string;
+    total_count: number;
+    updated_at: string;
+}
+export interface IDocumentsSearchResult {
+    page: number;
+    total: number;
+    result: IDocumentsSearchResultEntry[];
+}
+export interface IDocumentsSummary {
+    action_required: {
+        page: number;
+        total: number;
+        result: IActivityEntry[];
+    };
+    completed: {
+        page: number;
+        total: number;
+        result: IActivityEntry[];
+    };
+    waiting_others: {
+        page: number;
+        total: number;
+        result: IActivityEntry[];
+    };
+}
+export interface IRecipient {
+    agreed: boolean;
+    claimed: boolean;
+    created_at: string;
+    delegated_to: string | null;
+    delegator: boolean;
+    email: string;
+    envelope_id: string;
+    full_name: string;
+    in_app_access_key?: string;
+    key_used_to_conclude?: string;
+    message: string | null;
+    phone: string | null;
+    profile_id: string;
+    role_name: string;
+    sequence: number;
+    status: TRecipientStatus;
+    type: TRecipientType;
+    updated_at: string;
+}
+export interface IDocumentAsset {
+    created_at: string;
+    id: string;
+    mime: string;
+    name: string;
+    page_numbers: number;
+    updated_at: string;
+    url: string;
+}
+export interface IDocumentField {
+    envelope_id: string;
+    label: string | null;
+    name: string;
+    page: number;
+    recipient_role: string;
+    type: string;
+    required: boolean;
+    settings?: IFieldSetting;
+    setting?: IFieldSetting;
+    validator: string | null;
+    prepared?: boolean;
+}
+export interface IDocument {
+    id: string;
+    created_at: string;
+    canceled_at: string;
+    envelope_document_id: string;
+    certificate_document_id: string | null;
+    histories: IHistory[];
+    recipients: IRecipient[];
+    name: string;
+    no_contact: boolean;
+    profile_id: string;
+    reminder_id: string | null;
+    status: TDocumentStatus;
+    template_id: string;
+    updated_at: string;
+    organization_id: string | null;
+    certificate?: IDocumentAsset | null;
+    document?: IDocumentAsset | null;
+    fields?: IDocumentField[];
+    profile?: IProfile;
+}
+export declare type TDocumentUpdateResult = Omit<IDocument, 'histories' | 'recipients' | 'certificate' | 'document' | 'fields' | 'profile'>;
+export interface IActivityEntry {
+    id: string;
+    name: string;
+    canceled_at: string;
+    created_at: string;
+    updated_at: string;
+    profile_id: string;
+    status: TDocumentStatus;
+    template_id: string;
+    recipient: {
+        claimed: boolean;
+        email: string;
+        name: string;
+        profile_id: string;
+        status: TRecipientStatus;
+        type: TRecipientType;
+    };
+}
+export interface IHistory {
+    created_at: string;
+    envelope_id: string;
+    event: THistoryEvent;
+    event_detail: TEventDetail;
+    id: string;
+    role_name: string;
+}
+export interface IDocumentSearchOptions {
+    rows?: number;
+    page?: number;
+    sort_by?: 'updated_at' | 'created_at';
+    ascending?: boolean;
+    is_owner?: boolean;
+    is_recipient?: boolean;
+    envelope_status: TDocumentStatus[];
+    recipient_status: TDocumentStatus[];
+}
+export declare type THistoryEvent = 'recipient:invited' | 'recipient:opened' | 'recipient:agreed' | 'recipient:signed' | 'recipient:submitted';
+export declare type TEventDetail = 'in_app' | 'mail' | 'signer' | '';

package/Organizations/Members.d.ts

@@ -1,10 +1,11 @@
 import { VerdocsEndpoint } from '../VerdocsEndpoint';
+import { IProfile } from '../Users/Types';
 /**
  * An Organization Member (aka Profile) is an individual user with access to an organization.
  *
  * @module
  */
-export declare const getMembers: (endpoint: VerdocsEndpoint, organizationId: string) => Promise<any>;
+export declare const getMembers: (endpoint: VerdocsEndpoint, organizationId: string) => Promise<IProfile[]>;
 export declare const deleteMember: (endpoint: VerdocsEndpoint, organizationId: string, profileId: string) => Promise<any>;
 export declare const addMemberRole: (endpoint: VerdocsEndpoint, organizationId: string, profileId: string, roleId: string) => Promise<any>;
 export declare const deleteMemberRole: (endpoint: VerdocsEndpoint, organizationId: string, profileId: string, roleId: string) => Promise<any>;

package/Organizations/Types.d.ts

@@ -28,6 +28,7 @@ export interface IApiKey {
     name: string;
     profile_id: string;
     organization_id: string;
+    profile?: IProfile;
 }
 export interface IApiKeyWithSecret extends IApiKey {
     client_id: string;

package/Search/Types.d.ts

@@ -1,5 +1,5 @@
-import { TDocumentStatus } from '../Documents/Documents';
 import { TTemplateSender } from '../Templates/Types';
+import { TDocumentStatus } from '../Documents/Types';
 export declare type TMimeType = 'application/pdf' | string;
 /**
  * An individual hit in a document search result. Note that this schema does not precisely match IDocument because fields

package/VerdocsEndpoint.d.ts

@@ -37,7 +37,7 @@ export interface VerdocsEndpointOptions {
 export declare class VerdocsEndpoint {
     private environment;
     private sessionType;
-    private baseURL;
+    private readonly baseURL;
     private clientID;
     private timeout;
     private token;

package/VerdocsEndpoint.js

@@ -72,9 +72,6 @@ var VerdocsEndpoint = /** @class */ (function () {
             globalThis[ENDPOINT_KEY] = new VerdocsEndpoint();
             window.console.debug('[JS_SDK] Created default endpoint', globalThis[ENDPOINT_KEY]);
         }
-        else {
-            window.console.debug('[JS SDK] Re-using existing endpoint', globalThis[ENDPOINT_KEY]);
-        }
         return globalThis[ENDPOINT_KEY];
     };
     /**

package/package.json

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