@verdocs/js-sdk 4.2.26 → 4.2.28

package/dist/index.mjs

@@ -1,5 +1,80 @@
 import axios from 'axios';
 
+const FIELD_TYPES = [
+    'textbox',
+    'signature',
+    'initial',
+    'date',
+    'dropdown',
+    'timestamp',
+    'textarea',
+    'checkbox',
+    'radio',
+    'attachment',
+    'payment',
+];
+const DEFAULT_FIELD_WIDTHS = {
+    signature: 71,
+    initial: 71,
+    date: 75,
+    timestamp: 130,
+    textbox: 150,
+    textarea: 150,
+    checkbox: 14,
+    checkbox_group: 14,
+    radio_button_group: 14,
+    radio: 14,
+    dropdown: 85,
+    attachment: 24,
+    payment: 24,
+};
+const DEFAULT_FIELD_HEIGHTS = {
+    signature: 36,
+    initial: 36,
+    date: 15,
+    timestamp: 15,
+    textbox: 15,
+    textarea: 41,
+    checkbox: 14,
+    checkbox_group: 14,
+    radio_button_group: 14,
+    radio: 14,
+    dropdown: 20,
+    attachment: 24,
+    payment: 24,
+};
+const DEFAULT_FIELD_SETTINGS = {
+    signature: { result: '' },
+    initial: { result: '' },
+    date: { width: 75, height: 15, result: '' },
+    timestamp: { width: 130, height: 15 },
+    textbox: { width: 150, height: 15, result: '', leading: 0, alignment: 0, upperCase: false },
+    textarea: { width: 150, height: 15, result: '', leading: 16, alignment: 0, upperCase: false },
+    checkbox: {},
+    checkbox_group: {
+        minimum_checked: 0,
+        maximum_checked: 1000,
+        options: [
+        // { id: `${field.name}-1`, value: 'Option 1', checked: false, x, y },
+        ],
+    },
+    radio_button_group: {
+        options: [
+        // { id: `${field.name}-1`, value: 'Option 1', selected: false, x, y }
+        ],
+    },
+    radio: {},
+    dropdown: {
+        width: 85,
+        height: 20,
+        value: null,
+        placeholder: 'Choose',
+        options: [{ id: 'option-1', value: 'Option 1' }],
+    },
+    attachment: {},
+    payment: {},
+};
+
 /**
  * Given a `rgba(r,g,b,a)` string value, returns the hex equivalent, dropping the alpha channel.
  */
@@ -2297,21 +2372,39 @@ const hasRequiredPermissions = (profile, permissions) => permissions.every((perm
 
 /**
  * Add a field to a template.
+ *
+ * ```typescript
+ * import {createField} from '@verdocs/js-sdk/Templates';
+ *
+ * await createField((VerdocsEndpoint.getDefault(), template_id, { ... });
+ * ```
  */
 const createField = (endpoint, templateId, params) => endpoint.api //
-    .post(`/templates/${templateId}/fields`, params)
+    .post(`/v2/fields/${templateId}`, params)
     .then((r) => r.data);
 /**
  * Update a template field.
+ *
+ * ```typescript
+ * import {updateField} from '@verdocs/js-sdk/Templates';
+ *
+ * await updateField((VerdocsEndpoint.getDefault(), template_id, field_name, { ... });
+ * ```
  */
-const updateField = (endpoint, templateId, fieldName, params) => endpoint.api //
-    .put(`/templates/${templateId}/fields/${fieldName}`, params)
+const updateField = (endpoint, templateId, name, params) => endpoint.api //
+    .patch(`/fields/${templateId}/${name}`, params)
     .then((r) => r.data);
 /**
- * REmove a field from a template.
+ * Remove a field from a template.
+ *
+ * ```typescript
+ * import {deleteField} from '@verdocs/js-sdk/Templates';
+ *
+ * await deleteField((VerdocsEndpoint.getDefault(), template_id, field_name);
+ * ```
  */
-const deleteField = (endpoint, templateId, fieldName) => endpoint.api //
-    .delete(`/templates/${templateId}/fields/${fieldName}`)
+const deleteField = (endpoint, templateId, name) => endpoint.api //
+    .delete(`/fields/${templateId}/${name}`)
     .then((r) => r.data);
 
 /**
@@ -2558,12 +2651,12 @@ const getAllTags = (endpoint) => endpoint.api //
  * Get all templates accessible by the caller, with optional filters.
  *
  * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
+ * import {getTemplates} 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 });
+ * await getTemplates((VerdocsEndpoint.getDefault());
+ * await getTemplates((VerdocsEndpoint.getDefault(), { is_starred: true });
+ * await getTemplates((VerdocsEndpoint.getDefault(), { is_creator: true });
+ * await getTemplates((VerdocsEndpoint.getDefault(), { is_organization: true });
  * ```
  */
 const getTemplates = (endpoint, params) => endpoint.api //
@@ -2582,9 +2675,9 @@ const getTemplates = (endpoint, params) => endpoint.api //
  * Lists all templates accessible by the caller, with optional filters.
  *
  * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
+ * import {listTemplates} from '@verdocs/js-sdk/Templates';
  *
- * await Templates.listTemplates((VerdocsEndpoint.getDefault(), { sharing: 'personal', sort: 'last_used_at' });
+ * await listTemplates((VerdocsEndpoint.getDefault(), { sharing: 'personal', sort: 'last_used_at' });
  * ```
  */
 // export const listTemplates = (endpoint: VerdocsEndpoint, params?: IListTemplatesParams) =>
@@ -2595,9 +2688,9 @@ const getTemplates = (endpoint, params) => endpoint.api //
  * Get one template by its ID.
  *
  * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
+ * import {getTemplate} from '@verdocs/js-sdk/Templates';
  *
- * const template = await Templates.getTemplate((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9');
+ * const template = await getTemplate((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9');
  * ```
  */
 const getTemplate = (endpoint, templateId) => endpoint.api //
@@ -2617,6 +2710,7 @@ const getTemplate = (endpoint, templateId) => endpoint.api //
             document.pages = document.page_numbers;
         }
     });
+    // Temporary upgrade from legacy app
     template.fields?.forEach((field) => {
         if (field.setting) {
             field.settings = field.setting;
@@ -2637,9 +2731,9 @@ const ALLOWED_CREATE_FIELDS = [
  * Create a template.
  *
  * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
+ * import {createTemplate} from '@verdocs/js-sdk/Templates';
  *
- * const newTemplate = await Templates.createTemplatev2((VerdocsEndpoint.getDefault(), {...});
+ * const newTemplate = await createTemplate((VerdocsEndpoint.getDefault(), {...});
  * ```
  */
 const createTemplate = (endpoint, params, onUploadProgress) => {
@@ -2671,9 +2765,9 @@ const createTemplate = (endpoint, params, onUploadProgress) => {
  * Create a template from a Sharepoint asset.
  *
  * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
+ * import {createTemplateFromSharepoint} from '@verdocs/js-sdk/Templates';
  *
- * const newTemplate = await Templates.createTemplateFromSharepoint((VerdocsEndpoint.getDefault(), {...});
+ * const newTemplate = await createTemplateFromSharepoint((VerdocsEndpoint.getDefault(), {...});
  * ```
  */
 const createTemplateFromSharepoint = (endpoint, params) => {
@@ -2686,9 +2780,9 @@ const createTemplateFromSharepoint = (endpoint, params) => {
  * Update a template.
  *
  * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
+ * import {updateTemplate} from '@verdocs/js-sdk/Templates';
  *
- * const updatedTemplate = await Templates.updateTemplate((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9', { name: 'New Name' });
+ * const updatedTemplate = await updateTemplate((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9', { name: 'New Name' });
  * ```
  */
 const updateTemplate = (endpoint, templateId, params) => endpoint.api //
@@ -2698,33 +2792,21 @@ const updateTemplate = (endpoint, templateId, params) => endpoint.api //
  * Delete a template.
  *
  * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
+ * import {deleteTemplate} from '@verdocs/js-sdk/Templates';
  *
- * await Templates.deleteTemplate((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9');
+ * await deleteTemplate((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9');
  * ```
  */
 const deleteTemplate = (endpoint, templateId) => endpoint.api //
     .delete(`/templates/${templateId}`)
     .then((r) => r.data);
 /**
- * Search for templates matching various criteria.
- *
- * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
- *
- * const {result, page, total} = await Templates.search((VerdocsEndpoint.getDefault(), { ... });
- * ```
- */
-const searchTemplates = async (endpoint, params) => endpoint.api //
-    .post('/templates/search', params)
-    .then((r) => r.data);
-/**
- * List templates.
+ * List
  *
  * ```typescript
  * import {Templates} from '@verdocs/js-sdk/Templates';
  *
- * const {totals, templates} = await Templates.listTemplates((VerdocsEndpoint.getDefault(), { q: 'test', sort: 'created_at' }); * ```
+ * const {totals, templates} = await listTemplates((VerdocsEndpoint.getDefault(), { q: 'test', sort: 'created_at' }); * ```
  */
 const listTemplates = async (endpoint, params = {}) => endpoint.api //
     .post('/templates/list', params)
@@ -2842,5 +2924,5 @@ const isValidRoleName = (value, roles) => roles.findIndex((role) => role.name ==
 const TagRegEx = /^[a-zA-Z0-9-]{0,32}$/;
 const isValidTag = (value, tags) => TagRegEx.test(value) || tags.findIndex((tag) => tag === value) !== -1;
 
-export { AtoB, Countries, RolePermissions, VerdocsEndpoint, acceptOrganizationInvitation, addGroupMember, addTemplateTag, authenticate, blobToBase64, canPerformTemplateAction, cancelEnvelope, capitalize, changePassword, convertToE164, createApiKey, createEnvelope, createEnvelopeReminder, createField, createGroup, createInitials, createOrganizationInvitation, createProfile, createSignature, createTag, createTemplate, createTemplateDocument, createTemplateFromSharepoint, createTemplateReminder, createTemplateRole, declineOrganizationInvitation, decodeAccessTokenBody, decodeJWTBody, deleteApiKey, deleteEnvelopeFieldAttachment, deleteEnvelopeReminder, deleteField, deleteGroupMember, deleteOrganizationInvitation, deleteOrganizationMember, 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, getEnvelopes, getEnvelopesSummary, getFieldAttachment, getFieldsForRole, getGroup, getGroups, getInPersonLink, getKbaStep, getMatchingCountry, getMyUser, getNextRecipient, getNotifications, getOrganization, getOrganizationInvitation, getOrganizationInvitations, getOrganizationMembers, getPlusOneCountry, getProfiles, getRGB, getRGBA, getRLeft, getRTop, getRValue, getRecipientsWithActions, getRoleColor, getSignature, getSignatures, getSignerToken, getSigningSession, getStars, getTag, getTemplate, getTemplateDocument, getTemplateDocumentFile, getTemplateDocumentPageDisplayUri, getTemplateDocumentThumbnail, getTemplateDocuments, getTemplateReminder, getTemplateTags, getTemplates, getValidator, getValidators, getWebhooks, hasRequiredPermissions, integerSequence, isAmericanSamoa, isCanada, isDominicanRepublic, isFrenchGuiana, isGuadeloupe, isMartinique, isMayotte, isPuertoRico, isValidEmail, isValidPhone, isValidRoleName, isValidTag, listTemplates, nameToRGBA, recipientCanAct, recipientHasAction, refreshToken, rescale, resendInvitation, resendOrganizationInvitation, resendVerification, resetPassword, rotateApiKey, searchTemplates, sendDelegate, setWebhooks, submitKbaChallengeResponse, submitKbaIdentity, submitKbaPin, switchProfile, timePeriod, toggleStar, updateApiKey, updateEnvelopeField, updateEnvelopeFieldInitials, updateEnvelopeFieldSignature, updateEnvelopeReminder, updateField, updateGroup, updateOrganization, updateOrganizationInvitation, updateOrganizationLogo, updateOrganizationMember, updateOrganizationThumbnail, updateProfile, updateProfilePhoto, 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, verifyEmail };
+export { AtoB, Countries, DEFAULT_FIELD_HEIGHTS, DEFAULT_FIELD_SETTINGS, DEFAULT_FIELD_WIDTHS, FIELD_TYPES, RolePermissions, VerdocsEndpoint, acceptOrganizationInvitation, addGroupMember, addTemplateTag, authenticate, blobToBase64, canPerformTemplateAction, cancelEnvelope, capitalize, changePassword, convertToE164, createApiKey, createEnvelope, createEnvelopeReminder, createField, createGroup, createInitials, createOrganizationInvitation, createProfile, createSignature, createTag, createTemplate, createTemplateDocument, createTemplateFromSharepoint, createTemplateReminder, createTemplateRole, declineOrganizationInvitation, decodeAccessTokenBody, decodeJWTBody, deleteApiKey, deleteEnvelopeFieldAttachment, deleteEnvelopeReminder, deleteField, deleteGroupMember, deleteOrganizationInvitation, deleteOrganizationMember, 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, getEnvelopes, getEnvelopesSummary, getFieldAttachment, getFieldsForRole, getGroup, getGroups, getInPersonLink, getKbaStep, getMatchingCountry, getMyUser, getNextRecipient, getNotifications, getOrganization, getOrganizationInvitation, getOrganizationInvitations, getOrganizationMembers, getPlusOneCountry, getProfiles, getRGB, getRGBA, getRLeft, getRTop, getRValue, getRecipientsWithActions, getRoleColor, getSignature, getSignatures, getSignerToken, getSigningSession, getStars, getTag, getTemplate, getTemplateDocument, getTemplateDocumentFile, getTemplateDocumentPageDisplayUri, getTemplateDocumentThumbnail, getTemplateDocuments, getTemplateReminder, getTemplateTags, getTemplates, getValidator, getValidators, getWebhooks, hasRequiredPermissions, integerSequence, isAmericanSamoa, isCanada, isDominicanRepublic, isFrenchGuiana, isGuadeloupe, isMartinique, isMayotte, isPuertoRico, isValidEmail, isValidPhone, isValidRoleName, isValidTag, listTemplates, nameToRGBA, recipientCanAct, recipientHasAction, refreshToken, rescale, resendInvitation, resendOrganizationInvitation, resendVerification, resetPassword, rotateApiKey, sendDelegate, setWebhooks, submitKbaChallengeResponse, submitKbaIdentity, submitKbaPin, switchProfile, timePeriod, toggleStar, updateApiKey, updateEnvelopeField, updateEnvelopeFieldInitials, updateEnvelopeFieldSignature, updateEnvelopeReminder, updateField, updateGroup, updateOrganization, updateOrganizationInvitation, updateOrganizationLogo, updateOrganizationMember, updateOrganizationThumbnail, updateProfile, updateProfilePhoto, 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, verifyEmail };
 //# sourceMappingURL=index.mjs.map