@verdocs/web-sdk 1.14.12 → 1.15.1

package/dist/esm/{EnvelopeStore-28f5d8f5.js → EnvelopeStore-2a74a367.js}

@@ -1,5 +1,5 @@
 import { c as createStore } from './index-29123f30.js';
-import { g as getEnvelope } from './Envelopes-105a4a8f.js';
+import { g as getEnvelope } from './Envelopes-e69b678a.js';
 
 const createEnvelopeStore = (envelopeId) => {
   const now = new Date().toISOString();

package/dist/esm/{Envelopes-105a4a8f.js → Envelopes-e69b678a.js}

@@ -36,6 +36,22 @@ var __generator = (undefined && undefined.__generator) || function (thisArg, bod
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
+/**
+ * Search for envelopes matching various criteria.
+ *
+ * ```typescript
+ * import {Envelopes} from '@verdocs/js-sdk/Envelopes';
+ *
+ * const {result, page, total} = await Envelopes.search(VerdocsEndpoint.getDefault(), { ... });
+ * ```
+ */
+var searchEnvelopes = function (endpoint, params) { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        return [2 /*return*/, endpoint.api //
+                .post('/envelopes/search', params)
+                .then(function (r) { return r.data; })];
+    });
+}); };
 /**
  * Get a signing session for an Envelope.
  */
@@ -163,4 +179,4 @@ var throttledGetEnvelope = function (endpoint, envelopeId) {
     });
 };
 
-export { getEnvelopeFile as a, getFieldAttachment as b, cancelEnvelope as c, getSigningSession as d, updateEnvelopeFieldSignature as e, updateEnvelopeFieldInitials as f, getEnvelope as g, getEnvelopeDocumentPageDisplayUri as h, throttledGetEnvelope as t, updateEnvelopeField as u };
+export { getEnvelopeFile as a, getFieldAttachment as b, cancelEnvelope as c, getSigningSession as d, updateEnvelopeFieldSignature as e, updateEnvelopeFieldInitials as f, getEnvelope as g, getEnvelopeDocumentPageDisplayUri as h, searchEnvelopes as s, throttledGetEnvelope as t, updateEnvelopeField as u };

package/dist/esm/{Permissions-7192ef7c.js → Permissions-2ac18553.js}

@@ -30,5 +30,17 @@ var getRecipientsWithActions = function (envelope) { return ((envelope === null
  * Returns true if the recipient can act.
  */
 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.
+ */
+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);
+};
+var getNextRecipient = function (envelope) {
+    var recipientsWithActions = getRecipientsWithActions(envelope);
+    return recipientsWithActions === null || recipientsWithActions === void 0 ? void 0 : recipientsWithActions[0];
+};
 
-export { userCanCancelEnvelope as a, getRecipientsWithActions as g, recipientCanAct as r, userIsEnvelopeOwner as u };
+export { getRecipientsWithActions as a, userCanAct as b, userCanCancelEnvelope as c, getNextRecipient as g, recipientCanAct as r, userIsEnvelopeOwner as u };

package/dist/esm/{TemplateStore-87c99dfc.js → TemplateStore-c15956ae.js}

@@ -1,6 +1,6 @@
 import { c as createStore } from './index-29123f30.js';
-import { g as getTemplate } from './Templates-67172396.js';
-import { T as TemplateSenderTypes } from './VerdocsEndpoint-6d7a17ce.js';
+import { g as getTemplate } from './Templates-3760f311.js';
+import { T as TemplateSenderTypes } from './VerdocsEndpoint-45286fc7.js';
 
 const createTemplateStore = (templateId) => {
   const now = new Date().toISOString();

package/dist/esm/{Templates-67172396.js → Templates-3760f311.js}

@@ -4,6 +4,42 @@
  *
  * @module
  */
+var __awaiter = (undefined && undefined.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (undefined && undefined.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
 /**
  * Get all templates accessible by the caller, with optional filters.
  *
@@ -95,5 +131,24 @@ var updateTemplate = function (endpoint, templateId, params) {
         .put("/templates/".concat(templateId), params)
         .then(function (r) { return r.data; });
 };
+/**
+ * Get a summary of template data, typically used to populate admin panel dashboard pages.
+ *
+ * ```typescript
+ * import {Templates} from '@verdocs/js-sdk/Templates';
+ *
+ * const summary = await Templates.getSummary((VerdocsEndpoint.getDefault(), 0);
+ * ```
+ */
+var getSummary = function (endpoint, params) {
+    if (params === void 0) { params = {}; }
+    return __awaiter(void 0, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            return [2 /*return*/, endpoint.api //
+                    .post('/templates/summary', params)
+                    .then(function (r) { return r.data; })];
+        });
+    });
+};
 
-export { getTemplates as a, createTemplate as c, getTemplate as g, updateTemplate as u };
+export { getSummary as a, getTemplates as b, createTemplate as c, getTemplate as g, updateTemplate as u };

package/dist/esm/{VerdocsEndpoint-6d7a17ce.js → VerdocsEndpoint-45286fc7.js}

@@ -1,5 +1,140 @@
 import { d as decodeAccessTokenBody } from './Types-5f31149e.js';
 
+var TemplateSenderTypes$1;
+(function (TemplateSenderTypes) {
+    TemplateSenderTypes["CREATOR"] = "creator";
+    TemplateSenderTypes["ORGANIZATION_MEMBER"] = "organization_member";
+    TemplateSenderTypes["ORGANIZATION_MEMBER_AS_CREATOR"] = "organization_member_as_creator";
+    TemplateSenderTypes["EVERYONE"] = "everyone";
+    TemplateSenderTypes["EVERYONE_AS_CREATOR"] = "everyone_as_creator";
+})(TemplateSenderTypes$1 || (TemplateSenderTypes$1 = {}));
+var TemplatePermissions;
+(function (TemplatePermissions) {
+    TemplatePermissions["TEMPLATE_CREATOR_CREATE_PUBLIC"] = "template:creator:create:public";
+    TemplatePermissions["TEMPLATE_CREATOR_CREATE_ORG"] = "template:creator:create:org";
+    TemplatePermissions["TEMPLATE_CREATOR_CREATE_PERSONAL"] = "template:creator:create:personal";
+    TemplatePermissions["TEMPLATE_CREATOR_DELETE"] = "template:creator:delete";
+    TemplatePermissions["TEMPLATE_CREATOR_VISIBILITY"] = "template:creator:visibility";
+    TemplatePermissions["TEMPLATE_MEMBER_READ"] = "template:member:read";
+    TemplatePermissions["TEMPLATE_MEMBER_WRITE"] = "template:member:write";
+    TemplatePermissions["TEMPLATE_MEMBER_DELETE"] = "template:member:delete";
+    TemplatePermissions["TEMPLATE_MEMBER_VISIBILITY"] = "template:member:visibility";
+})(TemplatePermissions || (TemplatePermissions = {}));
+var canPerformTemplateAction = function (session, action, template) {
+    var _a, _b;
+    if (!template && !action.includes('create')) {
+        return { canPerform: false, message: 'Missing required template object' };
+    }
+    // We use BOGUS here to force the option-chain in things like template?.profile_id to NOT match profile?.profile_id because if both
+    // were undefined, they would actually match.
+    var profile_id = (session === null || session === void 0 ? void 0 : session.profile_id) || 'BOGUS';
+    var organization_id = (session === null || session === void 0 ? void 0 : session.organization_id) || 'BOGUS';
+    if (!profile_id) {
+        return { canPerform: false, message: 'Active session required' };
+    }
+    var isCreator = (template === null || template === void 0 ? void 0 : template.profile_id) === profile_id;
+    var isSameOrg = (template === null || template === void 0 ? void 0 : template.organization_id) === organization_id;
+    var isPersonal = (_a = template === null || template === void 0 ? void 0 : template.is_personal) !== null && _a !== void 0 ? _a : false;
+    var isPublic = (_b = template === null || template === void 0 ? void 0 : template.is_public) !== null && _b !== void 0 ? _b : false;
+    var permissionsRequired = [];
+    switch (action) {
+        case 'create_personal':
+            permissionsRequired.push(TemplatePermissions.TEMPLATE_CREATOR_CREATE_PERSONAL);
+            break;
+        case 'create_org':
+            permissionsRequired.push(TemplatePermissions.TEMPLATE_CREATOR_CREATE_ORG);
+            break;
+        case 'create_public':
+            permissionsRequired.push(TemplatePermissions.TEMPLATE_CREATOR_CREATE_PUBLIC);
+            break;
+        case 'read':
+            if (!isCreator) {
+                if ((!isPersonal && isSameOrg) || !isPublic) {
+                    permissionsRequired.push(TemplatePermissions.TEMPLATE_MEMBER_READ);
+                }
+            }
+            break;
+        case 'write':
+            if (!isCreator) {
+                permissionsRequired.push(TemplatePermissions.TEMPLATE_MEMBER_READ);
+                permissionsRequired.push(TemplatePermissions.TEMPLATE_MEMBER_WRITE);
+            }
+            break;
+        case 'change_visibility_personal':
+            if (isCreator) {
+                permissionsRequired.push(TemplatePermissions.TEMPLATE_CREATOR_CREATE_PERSONAL);
+            }
+            else {
+                permissionsRequired.push(TemplatePermissions.TEMPLATE_MEMBER_VISIBILITY);
+            }
+            break;
+        case 'change_visibility_org':
+            if (isCreator) {
+                permissionsRequired.push(TemplatePermissions.TEMPLATE_CREATOR_CREATE_ORG);
+            }
+            else {
+                permissionsRequired.push(TemplatePermissions.TEMPLATE_MEMBER_VISIBILITY);
+            }
+            break;
+        case 'change_visibility_public':
+            if (isCreator) {
+                permissionsRequired.push(TemplatePermissions.TEMPLATE_CREATOR_CREATE_PUBLIC);
+                permissionsRequired.push(TemplatePermissions.TEMPLATE_CREATOR_VISIBILITY);
+            }
+            else {
+                permissionsRequired.push(TemplatePermissions.TEMPLATE_MEMBER_VISIBILITY);
+            }
+            break;
+        case 'delete':
+            if (isCreator) {
+                permissionsRequired.push(TemplatePermissions.TEMPLATE_CREATOR_DELETE);
+            }
+            else {
+                permissionsRequired.push(TemplatePermissions.TEMPLATE_MEMBER_DELETE);
+            }
+            break;
+        default:
+            return { canPerform: false, message: 'Action is not defined' };
+    }
+    if (hasRequiredPermissions(session, permissionsRequired)) {
+        return { canPerform: true, message: '' };
+    }
+    return { canPerform: false, message: "Insufficient access to perform '".concat(action, "'. Needed permissions: ").concat(permissionsRequired.toString()) };
+};
+var hasRequiredPermissions = function (session, permissions) {
+    return permissions.every(function (perm) { return ((session === null || session === void 0 ? void 0 : session.permissions) || []).includes(perm); });
+};
+
+var TemplateSenderTypes;
+(function (TemplateSenderTypes) {
+    TemplateSenderTypes["CREATOR"] = "creator";
+    TemplateSenderTypes["ORGANIZATION_MEMBER"] = "organization_member";
+    TemplateSenderTypes["ORGANIZATION_MEMBER_AS_CREATOR"] = "organization_member_as_creator";
+    TemplateSenderTypes["EVERYONE"] = "everyone";
+    TemplateSenderTypes["EVERYONE_AS_CREATOR"] = "everyone_as_creator";
+})(TemplateSenderTypes || (TemplateSenderTypes = {}));
+var TemplateActions;
+(function (TemplateActions) {
+    TemplateActions["CREATE_PERSONAL"] = "create_personal";
+    TemplateActions["CREATE_ORG"] = "create_org";
+    TemplateActions["CREATE_PUBLIC"] = "create_public";
+    TemplateActions["READ"] = "read";
+    TemplateActions["WRITE"] = "write";
+    TemplateActions["DELETE"] = "delete";
+    TemplateActions["CHANGE_VISIBILITY_PERSONAL"] = "change_visibility_personal";
+    TemplateActions["CHANGE_VISIBILITY_ORG"] = "change_visibility_org";
+    TemplateActions["CHANGE_VISIBILITY_PUBLIC"] = "change_visibility_public";
+})(TemplateActions || (TemplateActions = {}));
+var SortOptions;
+(function (SortOptions) {
+    SortOptions["CREATED_AT"] = "created_at";
+    SortOptions["UPDATED_AT"] = "updated_at";
+    SortOptions["NAME"] = "name";
+    SortOptions["LAST_USED_AT"] = "last_used_at";
+    SortOptions["COUNTER"] = "counter";
+    SortOptions["STAR_COUNTER"] = "star_counter";
+})(SortOptions || (SortOptions = {}));
+
 /**
  * Operation within Verdocs that users may perform.
  */
@@ -48,36 +183,6 @@ var Roles;
     Roles["MEMBER"] = "member";
 })(Roles || (Roles = {}));
 
-var TemplateSenderTypes;
-(function (TemplateSenderTypes) {
-    TemplateSenderTypes["CREATOR"] = "creator";
-    TemplateSenderTypes["ORGANIZATION_MEMBER"] = "organization_member";
-    TemplateSenderTypes["ORGANIZATION_MEMBER_AS_CREATOR"] = "organization_member_as_creator";
-    TemplateSenderTypes["EVERYONE"] = "everyone";
-    TemplateSenderTypes["EVERYONE_AS_CREATOR"] = "everyone_as_creator";
-})(TemplateSenderTypes || (TemplateSenderTypes = {}));
-var TemplateActions;
-(function (TemplateActions) {
-    TemplateActions["CREATE_PERSONAL"] = "create_personal";
-    TemplateActions["CREATE_ORG"] = "create_org";
-    TemplateActions["CREATE_PUBLIC"] = "create_public";
-    TemplateActions["READ"] = "read";
-    TemplateActions["WRITE"] = "write";
-    TemplateActions["DELETE"] = "delete";
-    TemplateActions["CHANGE_VISIBILITY_PERSONAL"] = "change_visibility_personal";
-    TemplateActions["CHANGE_VISIBILITY_ORG"] = "change_visibility_org";
-    TemplateActions["CHANGE_VISIBILITY_PUBLIC"] = "change_visibility_public";
-})(TemplateActions || (TemplateActions = {}));
-var SortOptions;
-(function (SortOptions) {
-    SortOptions["CREATED_AT"] = "created_at";
-    SortOptions["UPDATED_AT"] = "updated_at";
-    SortOptions["NAME"] = "name";
-    SortOptions["LAST_USED_AT"] = "last_used_at";
-    SortOptions["COUNTER"] = "counter";
-    SortOptions["STAR_COUNTER"] = "star_counter";
-})(SortOptions || (SortOptions = {}));
-
 const denyList = new Set([
 	'ENOTFOUND',
 	'ENETUNREACH',
@@ -3956,4 +4061,4 @@ var VerdocsEndpoint = /** @class */ (function () {
     return VerdocsEndpoint;
 }());
 
-export { TemplateSenderTypes as T, VerdocsEndpoint as V };
+export { Permissions as P, TemplateSenderTypes as T, VerdocsEndpoint as V, canPerformTemplateAction as c };