@verdocs/web-sdk 1.15.0 → 1.15.2

package/dist/cjs/{TemplateStore-19f84862.js → TemplateStore-a7745f0a.js}

@@ -1,8 +1,8 @@
 'use strict';
 
 const index = require('./index-e84e0687.js');
-const Templates = require('./Templates-24580a13.js');
-const VerdocsEndpoint = require('./VerdocsEndpoint-f2af9468.js');
+const Templates = require('./Templates-6fb62dcd.js');
+const VerdocsEndpoint = require('./VerdocsEndpoint-cb0b1329.js');
 
 const createTemplateStore = (templateId) => {
   const now = new Date().toISOString();

package/dist/cjs/Templates-6fb62dcd.js

@@ -0,0 +1,175 @@
+'use strict';
+
+/**
+ * A Template defines how a Verdocs signing flow will be performed, including attachments, signing fields, and
+ * recipients.
+ *
+ * @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.
+ *
+ * ```typescript
+ * import {Templates} from '@verdocs/js-sdk/Templates';
+ *
+ * await Templates.getTemplates((VerdocsEndpoint.getDefault());
+ * await Templates.getTemplates((VerdocsEndpoint.getDefault(), { is_starred: true });
+ * await Templates.getTemplates((VerdocsEndpoint.getDefault(), { is_creator: true });
+ * await Templates.getTemplates((VerdocsEndpoint.getDefault(), { is_organization: true });
+ * ```
+ */
+var getTemplates = function (endpoint, params) {
+    return endpoint.api //
+        .post('/templates', { params: params })
+        .then(function (r) { return r.data; });
+};
+/**
+ * Get one template by its ID.
+ *
+ * ```typescript
+ * import {Templates} from '@verdocs/js-sdk/Templates';
+ *
+ * const template = await Templates.getTemplate((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9');
+ * ```
+ */
+var getTemplate = function (endpoint, templateId) {
+    return endpoint.api //
+        .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.
+ *
+ * ```typescript
+ * import {Templates} from '@verdocs/js-sdk/Templates';
+ *
+ * const newTemplate = await Templates.createTemplate((VerdocsEndpoint.getDefault(), {...});
+ * ```
+ */
+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.
+ *
+ * ```typescript
+ * import {Templates} from '@verdocs/js-sdk/Templates';
+ *
+ * const updatedTemplate = await Templates.updateTemplate((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9', { name: 'New Name' });
+ * ```
+ */
+var updateTemplate = function (endpoint, templateId, params) {
+    return endpoint.api //
+        .put("/templates/".concat(templateId), params)
+        .then(function (r) { return r.data; });
+};
+/**
+ * Delete a template.
+ *
+ * ```typescript
+ * import {Templates} from '@verdocs/js-sdk/Templates';
+ *
+ * await Templates.deleteTemplate((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9');
+ * ```
+ */
+var deleteTemplate = function (endpoint, templateId) {
+    return endpoint.api //
+        .delete("/templates/".concat(templateId))
+        .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; })];
+        });
+    });
+};
+
+exports.createTemplate = createTemplate;
+exports.deleteTemplate = deleteTemplate;
+exports.getSummary = getSummary;
+exports.getTemplate = getTemplate;
+exports.getTemplates = getTemplates;
+exports.updateTemplate = updateTemplate;

package/dist/cjs/{VerdocsEndpoint-f2af9468.js → VerdocsEndpoint-cb0b1329.js}

@@ -2,6 +2,111 @@
 
 const Types = require('./Types-f89f9116.js');
 
+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 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); });
+};
+
 exports.TemplateSenderTypes = void 0;
 (function (TemplateSenderTypes) {
     TemplateSenderTypes["CREATOR"] = "creator";
@@ -35,7 +140,7 @@ var SortOptions;
 /**
  * Operation within Verdocs that users may perform.
  */
-var Permissions;
+exports.Permissions = void 0;
 (function (Permissions) {
     Permissions["RCOMMON"] = "rcommon:access";
     Permissions["RFORM_ACCESS"] = "rform:access";
@@ -61,7 +166,7 @@ var Permissions;
     Permissions["TEMPLATE_MEMBER_WRITE"] = "template:member:write";
     Permissions["TEMPLATE_MEMBER_DELETE"] = "template:member:delete";
     Permissions["TEMPLATE_MEMBER_VISIBILITY"] = "template:member:visibility";
-})(Permissions || (Permissions = {}));
+})(exports.Permissions || (exports.Permissions = {}));
 /**
  * Plans provide access to Verdocs product features.
  */
@@ -3959,3 +4064,4 @@ var VerdocsEndpoint = /** @class */ (function () {
 }());
 
 exports.VerdocsEndpoint = VerdocsEndpoint;
+exports.canPerformTemplateAction = canPerformTemplateAction;