@verdocs/js-sdk 4.0.10 → 4.0.11

package/dist/index.mjs

@@ -1894,6 +1894,104 @@ const deleteField = (endpoint, templateId, fieldName) => endpoint.api //
     .delete(`/templates/${templateId}/fields/${fieldName}`)
     .then((r) => r.data);
 
+/**
+ * Various helpers to identify available operations for a template by a user.
+ *
+ * @module
+ */
+/**
+ * Check to see if the user created the template.
+ */
+const userIsTemplateCreator = (session, template) => session && template && session.profile_id === template.profile_id;
+/**
+ * Check to see if a template is "shared" with the user.
+ */
+const userHasSharedTemplate = (session, template) => session && template && !template.is_personal && session.organization_id === template.organization_id;
+/**
+ * Check to see if the user can create a personal/private template.
+ */
+const userCanCreatePersonalTemplate = (session) => userHasPermissions(session, ['template:creator:create:personal']);
+/**
+ * Check to see if the user can create an org-shared template.
+ */
+const userCanCreateOrgTemplate = (session) => userHasPermissions(session, ['template:creator:create:org']);
+/**
+ * Check to see if the user can create a public template.
+ */
+const userCanCreatePublicTemplate = (session) => userHasPermissions(session, ['template:creator:create:public']);
+/**
+ * Check to see if the user can read/view a template.
+ */
+const userCanReadTemplate = (session, template) => template.is_public ||
+    userIsTemplateCreator(session, template) ||
+    (userHasSharedTemplate(session, template) && userHasPermissions(session, ['template:member:read']));
+/**
+ * Check to see if the user can update a tempate.
+ */
+const userCanUpdateTemplate = (session, template) => userIsTemplateCreator(session, template) ||
+    (userHasSharedTemplate(session, template) && userHasPermissions(session, ['template:member:read', 'template:member:write']));
+/**
+ * Check to see if the user can change whether a template is personal vs org-shared.
+ */
+const userCanMakeTemplatePrivate = (session, template) => userIsTemplateCreator(session, template)
+    ? userHasPermissions(session, ['template:creator:create:personal'])
+    : userHasPermissions(session, ['template:member:visibility']);
+/**
+ * Check to see if the user can change whether a template is personal vs org-shared.
+ */
+const userCanMakeTemplateShared = (session, template) => userIsTemplateCreator(session, template)
+    ? userHasPermissions(session, ['template:creator:create:org'])
+    : userHasPermissions(session, ['template:member:visibility']);
+/**
+ * Check to see if the user can change whether a template is personal vs org-shared.
+ */
+const userCanMakeTemplatePublic = (session, template) => userIsTemplateCreator(session, template)
+    ? userHasPermissions(session, ['template:creator:create:public'])
+    : userHasPermissions(session, ['template:member:visibility']);
+/**
+ * Check to see if the user can change whether a template is personal vs org-shared.
+ */
+const userCanChangeOrgVisibility = (session, template) => userIsTemplateCreator(session, template) && userHasPermissions(session, ['template:creator:create:personal']);
+/**
+ * Check to see if the user can change whether a template is personal vs org-shared.
+ */
+const userCanDeleteTemplate = (session, template) => userIsTemplateCreator(session, template)
+    ? userHasPermissions(session, ['template:creator:delete'])
+    : userHasPermissions(session, ['template:member:delete']);
+/**
+ * Confirm whether the user can create an envelope using the specified template.
+ */
+const userCanSendTemplate = (session, template) => {
+    switch (template.sender) {
+        case 'creator':
+            return userIsTemplateCreator(session, template);
+        case 'organization_member':
+        case 'organization_member_as_creator':
+            return userIsTemplateCreator(session, template) || template.organization_id === session?.organization_id;
+        default:
+            return true;
+    }
+};
+/**
+ * Confirm whether the user can create a new template.
+ */
+const userCanCreateTemplate = (session) => userCanCreatePersonalTemplate(session) || userCanCreateOrgTemplate(session) || userCanCreatePublicTemplate(session);
+/**
+ * Check to see if the user can "build" the template (use the field builder). The user must have write access to the
+ * template, and the template must have at least one signer role.
+ */
+const userCanBuildTemplate = (session, template) => userCanUpdateTemplate(session, template) && (template.roles || []).filter((role) => role.type === 'signer').length > 0;
+const getFieldsForRole = (template, role_name) => (template.fields || []).filter((field) => field.role_name === role_name);
+/**
+ * Check to see if the user can preview the template. The user must have read access to the template, the template must
+ * have at least one signer, and every signer must have at least one field.
+ */
+const userCanPreviewTemplate = (session, template) => {
+    const hasPermission = userCanReadTemplate(session, template);
+    const signers = (template.roles || []).filter((role) => role.type === 'signer');
+    return hasPermission && signers.length > 0 && signers.every((signer) => getFieldsForRole(template, signer.name).length > 0);
+};
+
 /**
  * Enable automatic reminders. setup_time is the number of days after the envelope is sent that the first reminder
  * should be sent. interval_time is the number of days between reminders.
@@ -2617,5 +2715,5 @@ const recordSignupSurvey = (endpoint, params) => endpoint.api //
     .post('/user/signup', params)
     .then((r) => r.data);
 
-export { AtoB, Countries, VerdocsEndpoint, acceptOrganizationInvitation, addGroupMembers, addGroupPermission, addOrganizationMemberRole, addTemplateTag, authenticateApp, authenticateUser, billingPlaceholder, blobToBase64, canPerformTemplateAction, cancelEnvelope, capitalize, claimNewUser, convertToE164, createApiKey, createBusinessAccount, createEnvelope, createEnvelopeReminder, createField, createInitials, createOrganization, createOrganizationInvitation, createProfile, createSignature, createTag, createTemplate, createTemplateDocument, createTemplateFromSharepoint, createTemplateReminder, createTemplateRole, createTemplatev2, createUser, declineOrganizationInvitation, decodeAccessTokenBody, decodeJWTBody, deleteApiKey, deleteEnvelopeFieldAttachment, deleteEnvelopeReminder, deleteField, deleteGroupMembers, deleteGroupPermission, deleteOrganization, deleteOrganizationInvitation, deleteOrganizationMember, deleteOrganizationMemberRole, deleteProfile, deleteSignature, deleteTemplate, deleteTemplateDocument, deleteTemplateReminder, deleteTemplateRole, deleteTemplateTag, downloadBlob, envelopeIsActive, envelopeIsComplete, envelopeRecipientAgree, envelopeRecipientChangeOwner, envelopeRecipientDecline, envelopeRecipientPrepare, envelopeRecipientSubmit, envelopeRecipientUpdateName, fileToDataUrl, formatFullName, formatInitials, formatShortTimeAgo, fullNameToInitials, getAllTags, getApiKeys, getCountryByCode, getCurrentProfile, getDocumentDownloadLink, getDocumentPreviewLink, getEnvelope, getEnvelopeDocument, getEnvelopeDocumentPageDisplayUri, getEnvelopeFile, getEnvelopeRecipients, getEnvelopeReminder, getEnvelopesByTemplateId, getEnvelopesSummary, getFieldAttachment, getGroup, getGroupByName, getGroupMembers, getGroups, getInPersonLink, getMatchingCountry, getNextRecipient, getNotifications, getOrganization, getOrganizationInvitation, getOrganizationInvitations, getOrganizationMemberPlans, getOrganizationMembers, getOrganizations, getPlusOneCountry, getProfile, getProfileGroups, getProfiles, getRGB, getRGBA, getRLeft, getRTop, getRValue, getRecipientsWithActions, getRoleColor, getRoles, getSignature, getSignatures, getSignerToken, getSigningSession, getStars, getTag, getTemplate, getTemplateDocument, getTemplateDocumentFile, getTemplateDocumentPageDisplayUri, getTemplateDocumentThumbnail, getTemplateDocuments, getTemplateOwnerInfo, getTemplateReminder, getTemplateRole, getTemplateRoleFields, getTemplateRoles, getTemplateTags, getTemplates, getTemplatesSummary, getValidator, getValidators, getWebhooks, hasRequiredPermissions, integerSequence, isAmericanSamoa, isCanada, isDominicanRepublic, isFrenchGuiana, isGuadeloupe, isMartinique, isMayotte, isPuertoRico, isValidEmail, isValidPhone, isValidRoleName, isValidTag, listEnvelopes, listTemplates, nameToRGBA, recipientCanAct, recipientHasAction, recordSignupSurvey, refreshTokens, rescale, resendInvitation, resendOrganizationInvitation, resendVerification, resetPassword, rotateApiKey, searchEnvelopes, searchTemplates, sendDelegate, setWebhooks, switchProfile, throttledGetEnvelope, throttledGetTemplate, timePeriod, toggleStar, updateApiKey, updateEmail, updateEnvelopeField, updateEnvelopeFieldInitials, updateEnvelopeFieldSignature, updateEnvelopeReminder, updateField, updateOrganization, updateOrganizationInvitation, updatePassword, updateProfile, updateRecipient, updateTemplate, updateTemplateReminder, updateTemplateRole, uploadEnvelopeFieldAttachment, userCanAct, userCanCancelEnvelope, userCanFinishEnvelope, userCanSignNow, userHasPermissions, userIsEnvelopeOwner, userIsEnvelopeRecipient, validateToken };
+export { AtoB, Countries, VerdocsEndpoint, acceptOrganizationInvitation, addGroupMembers, addGroupPermission, addOrganizationMemberRole, addTemplateTag, authenticateApp, authenticateUser, billingPlaceholder, blobToBase64, canPerformTemplateAction, cancelEnvelope, capitalize, claimNewUser, convertToE164, createApiKey, createBusinessAccount, createEnvelope, createEnvelopeReminder, createField, createInitials, createOrganization, createOrganizationInvitation, createProfile, createSignature, createTag, createTemplate, createTemplateDocument, createTemplateFromSharepoint, createTemplateReminder, createTemplateRole, createTemplatev2, createUser, declineOrganizationInvitation, decodeAccessTokenBody, decodeJWTBody, deleteApiKey, deleteEnvelopeFieldAttachment, deleteEnvelopeReminder, deleteField, deleteGroupMembers, deleteGroupPermission, deleteOrganization, deleteOrganizationInvitation, deleteOrganizationMember, deleteOrganizationMemberRole, deleteProfile, deleteSignature, deleteTemplate, deleteTemplateDocument, deleteTemplateReminder, deleteTemplateRole, deleteTemplateTag, downloadBlob, envelopeIsActive, envelopeIsComplete, envelopeRecipientAgree, envelopeRecipientChangeOwner, envelopeRecipientDecline, envelopeRecipientPrepare, envelopeRecipientSubmit, envelopeRecipientUpdateName, fileToDataUrl, formatFullName, formatInitials, formatShortTimeAgo, fullNameToInitials, getAllTags, getApiKeys, getCountryByCode, getCurrentProfile, getDocumentDownloadLink, getDocumentPreviewLink, getEnvelope, getEnvelopeDocument, getEnvelopeDocumentPageDisplayUri, getEnvelopeFile, getEnvelopeRecipients, getEnvelopeReminder, getEnvelopesByTemplateId, getEnvelopesSummary, getFieldAttachment, getFieldsForRole, getGroup, getGroupByName, getGroupMembers, getGroups, getInPersonLink, getMatchingCountry, getNextRecipient, getNotifications, getOrganization, getOrganizationInvitation, getOrganizationInvitations, getOrganizationMemberPlans, getOrganizationMembers, getOrganizations, getPlusOneCountry, getProfile, getProfileGroups, getProfiles, getRGB, getRGBA, getRLeft, getRTop, getRValue, getRecipientsWithActions, getRoleColor, getRoles, getSignature, getSignatures, getSignerToken, getSigningSession, getStars, getTag, getTemplate, getTemplateDocument, getTemplateDocumentFile, getTemplateDocumentPageDisplayUri, getTemplateDocumentThumbnail, getTemplateDocuments, getTemplateOwnerInfo, getTemplateReminder, getTemplateRole, getTemplateRoleFields, getTemplateRoles, getTemplateTags, getTemplates, getTemplatesSummary, getValidator, getValidators, getWebhooks, hasRequiredPermissions, integerSequence, isAmericanSamoa, isCanada, isDominicanRepublic, isFrenchGuiana, isGuadeloupe, isMartinique, isMayotte, isPuertoRico, isValidEmail, isValidPhone, isValidRoleName, isValidTag, listEnvelopes, listTemplates, nameToRGBA, recipientCanAct, recipientHasAction, recordSignupSurvey, refreshTokens, rescale, resendInvitation, resendOrganizationInvitation, resendVerification, resetPassword, rotateApiKey, searchEnvelopes, searchTemplates, sendDelegate, setWebhooks, switchProfile, throttledGetEnvelope, throttledGetTemplate, timePeriod, toggleStar, updateApiKey, updateEmail, updateEnvelopeField, updateEnvelopeFieldInitials, updateEnvelopeFieldSignature, updateEnvelopeReminder, updateField, updateOrganization, updateOrganizationInvitation, updatePassword, updateProfile, updateRecipient, updateTemplate, updateTemplateReminder, updateTemplateRole, uploadEnvelopeFieldAttachment, userCanAct, userCanBuildTemplate, userCanCancelEnvelope, userCanChangeOrgVisibility, userCanCreateOrgTemplate, userCanCreatePersonalTemplate, userCanCreatePublicTemplate, userCanCreateTemplate, userCanDeleteTemplate, userCanFinishEnvelope, userCanMakeTemplatePrivate, userCanMakeTemplatePublic, userCanMakeTemplateShared, userCanPreviewTemplate, userCanReadTemplate, userCanSendTemplate, userCanSignNow, userCanUpdateTemplate, userHasPermissions, userHasSharedTemplate, userIsEnvelopeOwner, userIsEnvelopeRecipient, userIsTemplateCreator, validateToken };
 //# sourceMappingURL=index.mjs.map