@verdocs/js-sdk 5.0.14 → 5.0.16

package/dist/index.d.mts

@@ -153,10 +153,10 @@ interface ISigningSession {
     email: string;
     iat: number;
     exp: number;
-    "https://verdocs.com/session_type": "signing";
-    "https://verdocs.com/key_type": TAccessKeyType;
-    "https://verdocs.com/envelope_id": string;
-    "https://verdocs.com/role_name": string;
+    ["https://verdocs.com/session_type"]: "signing";
+    ["https://verdocs.com/key_type"]: TAccessKeyType;
+    ["https://verdocs.com/envelope_id"]: string;
+    ["https://verdocs.com/role_name"]: string;
 }
 /**
  * A User Session connects a caller to a Verdocs profile, and can be used for any operations that profile may perform.
@@ -165,19 +165,19 @@ interface IUserSession {
     jti: string;
     aud: string;
     iss: string;
-    sub: string; // Auth0 user_id
+    sub: string; // Verdocs user_id
     email: string;
     iat: number;
     exp: number;
-    session_type: "user";
-    profile_id: string;
-    organization_id: string;
-    global_admin: boolean;
+    ["https://verdocs.com/session_type"]: "user";
+    ["https://verdocs.com/profile_id"]: string;
+    ["https://verdocs.com/organization_id"]: string;
+    ["https://verdocs.com/global_admin"]: boolean;
 }
 interface IIdToken {
     aud: string;
     iss: string;
-    sub: string; // Auth0 user_id
+    sub: string; // Verdocs user_id
     email: string;
     organization_id: string;
     first_name: string;
@@ -267,6 +267,19 @@ interface IOAuth2App {
     organization?: IOrganization;
     profile?: IProfile;
 }
+interface IEntitlement {
+    id: string;
+    organization_id: string;
+    feature: TEntitlement;
+    contract_id?: string | null;
+    notes?: string | null;
+    starts_at: string;
+    ends_at: string;
+    monthly_max: number;
+    yearly_max: number;
+    created_at: string;
+    organization?: IOrganization;
+}
 interface IOrganization {
     /** The unique ID of the organization */
     id: string;
@@ -284,9 +297,6 @@ interface IOrganization {
     thumbnail_url?: string | null;
     primary_color?: string | null;
     secondary_color?: string | null;
-    entitlements?: Record<string, any> | null;
-    mtd_usage?: Record<string, any> | null;
-    ytd_usage?: Record<string, any> | null;
     data?: Record<string, any> | null;
     /** Creation date/time. */
     created_at: string;
@@ -295,6 +305,7 @@ interface IOrganization {
     api_keys?: IApiKey[];
     groups?: IGroup[];
     oauth2_apps?: IOAuth2App[];
+    entitlements?: IEntitlement[];
     organization_invitations?: IOrganizationInvitation[];
     profiles?: IProfile[];
     webhooks?: IWebhook[];
@@ -678,28 +689,18 @@ interface IRecipient {
     created_at: string;
     updated_at: string;
     last_attempt_at?: string;
+    /** The type of authentication required for this recipient. */
+    auth_method?: TRecipientAuthMethod;
     /**
-     * If set, "KBA required" will carry through to automatically enable the same setting in Envelopes
-     * created from this template. For privacy reasons, this field will only be visible to the creator
-     * of the envelope and the recipient referenced.
-     */
-    kba_method?: TKBAMethod;
-    /**
-     * If KBA is set to "PIN" this will be set to the PIN code required. For security reasons, this
+     * If auth_method is set to "passcode" this is the passcode required. For security reasons, this
      * field will only be visible to the creator of the envelope.
      */
-    kba_pin?: string | null;
+    passcode?: string | null;
     /**
-     * If KBA has been completed successfully, this will be set to true. For privacy reasons, this
-     * field will only be visible to the creator of the envelope and the recipient referenced.
+     * If authentication has been completed successfully, this will be set to 'complete'. This is a union type
+     * to allow for future expansion with authentication modules that may require multiple steps.
      */
-    kba_completed?: boolean;
-    /**
-     * If KBA has been completed (or partially successfully, this will contain metadata related to
-     * the questions and answers from the process. For privacy reasons, this field will only be visible
-     * to the recipient referenced.
-     */
-    kba_details?: Record<string, any>;
+    auth_step?: TRecipientAuthStep | null;
     envelope?: IEnvelope;
     profile?: IProfile;
 }
@@ -735,12 +736,6 @@ interface IRole {
      */
     order: number;
     delegator: boolean | null;
-    /**
-     * If set, "KBA required" will carry through to automatically enable the same setting in Envelopes
-     * created from this template. Note that KBA details may not be specified here. They must be unique to
-     * each individual recipient and therefore cannot be set as defaults in the template.
-     */
-    kba_method: TKBAMethod;
 }
 interface ISignature {
     id: string;
@@ -948,7 +943,9 @@ type TEnvelopeUpdateResult = Omit<IEnvelope, "histories" | "recipients" | "certi
 type TFieldType = "signature" | "initial" | "checkbox" | "radio" | "textbox" | "timestamp" | "date" | "dropdown" | "textarea" | "attachment" | "payment";
 type TWebhookEvent = "envelope_created" | "envelope_completed" | "envelope_canceled" | "envelope_updated" | "template_created" | "template_updated" | "template_deleted" | "template_used";
 type TTemplateVisibility = "private" | "shared" | "public";
-type TKBAMethod = "pin" | "kba" | "id" | "sms" | "" | null;
+type TEntitlement = "envelope" | "kba_auth" | "passcode_auth" | "sms_auth" | "kba_id_auth" | "id_auth";
+type TRecipientAuthMethod = "kba_auth" | "passcode_auth" | "sms_auth" | "kba_id_auth" | "id_auth" | null;
+type TRecipientAuthStep = "complete" | null;
 declare const FIELD_TYPES: TFieldType[];
 declare const DEFAULT_FIELD_WIDTHS: Record<TFieldType, number>;
 declare const DEFAULT_FIELD_HEIGHTS: Record<TFieldType, number>;
@@ -2656,6 +2653,30 @@ declare const updateOrganizationLogo: (endpoint: VerdocsEndpoint, organizationId
  * ```
  */
 declare const updateOrganizationThumbnail: (endpoint: VerdocsEndpoint, organizationId: string, file: File, onUploadProgress?: (percent: number, loadedBytes: number, totalBytes: number) => void) => Promise<IOrganization>;
+declare const getEntitlements: (endpoint: VerdocsEndpoint) => Promise<IEntitlement[]>;
+/**
+ * Largely intended to be used internally by Web SDK components but may be informative for other cases.
+ * Entitlements are feature grants such as "ID-based KBA" that require paid contracts to enable, typically
+ * because the underlying services that support them are fee-based. Entitlements may run concurrently,
+ * and may have different start/end dates e.g. "ID-based KBA" may run 1/1/2026-12/31/2026 while
+ * "SMS Authentication" may be added later and run 6/1/2026-5/31/2027. The entitlements list is a simple
+ * array of enablements and may include entries that are not YET enabled or have now expired.
+ *
+ * In client code it is helpful to simply know "is XYZ feature currently enabled?" This function collapses
+ * the entitlements list to a simplified dictionary of current/active entitlements. Note that it is async
+ * because it calls the server to obtain the "most current" entitlements list. Existence of an entry in the
+ * resulting dictionary implies the feature is active. Metadata inside each entry can be used to determine
+ * limits, etc.
+ *
+ * ```typescript
+ * import {getActiveEntitlements} from '@verdocs/js-sdk';
+ *
+ * const activeEntitlements = await getActiveEntitlements((VerdocsEndpoint.getDefault());
+ * const isSMSEnabled = !!activeEntitlements.sms_auth;
+ * const monthlyKBALimit = activeEntitlements.kba_auth?.monthly_max;
+ * ```
+ */
+declare const getActiveEntitlements: (endpoint: VerdocsEndpoint) => Promise<Partial<Record<TEntitlement, IEntitlement>>>;
 /**
  * Get the registered Webhook configuration for the caller's organization.
  *
@@ -3302,6 +3323,7 @@ declare function nameToRGBA(str: string): string | undefined;
  */
 declare function getRoleColor(name: string, roles: TRole[], index?: number): string | undefined;
 declare const formatShortTimeAgo: (val: any) => string;
+declare const collapseEntitlements: (entitlements: IEntitlement[]) => Partial<Record<TEntitlement, IEntitlement>>;
 declare function getRTop(y: number, fieldHeight: number, iTextHeight: number, yRatio: number): number;
 declare function getRLeft(x: number, ratio: number): number;
 declare function getRValue(y: number, ratio: number): number;
@@ -3397,4 +3419,4 @@ declare const decodeJWTBody: (token: string) => any;
  * the presence of the `document_id` field, which will only be present for signing sessions.
  */
 declare const decodeAccessTokenBody: (token: string) => TSession;
-export { TRequestStatus, TTemplateSender, TTemplateAction, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TSortTemplateBy, TAccessKeyType, TApiKeyPermission, TDeprecatedHistoryEvent, THistoryEvent, TEventDetail, TEnvelopeUpdateResult, TFieldType, TWebhookEvent, TTemplateVisibility, TKBAMethod, FIELD_TYPES, DEFAULT_FIELD_WIDTHS, DEFAULT_FIELD_HEIGHTS, WEBHOOK_EVENTS, ALL_PERMISSIONS, IChannel, IDisabledChannel, INotification, IApiKey, IGroup, IGroupProfile, IOAuth2App, IOrganization, IOrganizationInvitation, IPendingWebhook, IProfile, IUser, IWebhookEvents, IWebhook, IInPersonAccessKey, IInAppAccessKey, IEmailAccessKey, ISMSAccessKey, TAccessKey, IEnvelope, IEnvelopeDocument, IDropdownOption, IEnvelopeField, IEnvelopeFieldOptions, IEnvelopeFieldSettings, IEnvelopeHistory, IInitial, IKbaPINRequired, IRecipient, IRole, ISignature, ITemplate, ITemplateDocument, ITemplateField, ITextFieldSetting, ITemplateFieldSetting, TEnvironment, TSessionChangedListener, VerdocsEndpointOptions, VerdocsEndpoint, createEnvelope, getEnvelope, getEnvelopeDocument, getDocumentDownloadLink, getDocumentPreviewLink, cancelEnvelope, getEnvelopeFile, updateEnvelope, updateEnvelopeField, updateEnvelopeFieldSignature, updateEnvelopeFieldInitials, uploadEnvelopeFieldAttachment, deleteEnvelopeFieldAttachment, getFieldAttachment, getEnvelopeDocumentPageDisplayUri, ITimeRange, IListEnvelopesParams, getEnvelopes, createInitials, IRecipientKbaStepNone, IRecipientKbaStepComplete, IRecipientKbaStepPin, IRecipientKbaStepIdentity, IRecipientKbaStepChallenge, IRecipientKbaStepFailed, TRecipientKbaStep, getKbaStep, submitKbaPin, IKbaIdentity, submitKbaIdentity, IKbaChallengeResponse, submitKbaChallengeResponse, updateRecipient, envelopeRecipientSubmit, envelopeRecipientDecline, envelopeRecipientChangeOwner, envelopeRecipientAgree, envelopeRecipientUpdateName, envelopeRecipientPrepare, startSigningSession, getInPersonLink, sendDelegate, resendInvitation, userIsEnvelopeOwner, userIsEnvelopeRecipient, envelopeIsActive, envelopeIsComplete, userCanCancelEnvelope, userCanFinishEnvelope, recipientHasAction, getRecipientsWithActions, recipientCanAct, userCanAct, userCanSignNow, getNextRecipient, createSignature, getSignatures, getSignature, deleteSignature, IEnvelopesSearchResult, IDocumentSearchOptions, ICreateEnvelopeRecipient, ISignerTokenResponse, IInPersonLinkResponse, IUpdateRecipientSubmitParams, IUpdateRecipientDeclineParams, IUpdateRecipientClaimEnvelope, IUpdateRecipientStatus, IUpdateRecipientAgreedParams, IUpdateRecipientNameParams, IUpdateRecipientPrepareParams, ICreateEnvelopeReminderRequest, ICreateEnvelopeFromTemplateRequest, ICreateEnvelopeDirectlyRequest, TCreateEnvelopeRequest, getApiKeys, createApiKey, rotateApiKey, updateApiKey, deleteApiKey, getOrganizationContacts, deleteOrganizationContact, createOrganizationContact, updateOrganizationContact, getGroups, getGroup, createGroup, updateGroup, deleteGroup, addGroupMember, deleteGroupMember, getOrganizationInvitations, createOrganizationInvitation, deleteOrganizationInvitation, updateOrganizationInvitation, resendOrganizationInvitation, getOrganizationInvitation, acceptOrganizationInvitation, declineOrganizationInvitation, getOrganizationMembers, deleteOrganizationMember, updateOrganizationMember, getOrganization, createOrganization, updateOrganization, deleteOrganization, updateOrganizationLogo, updateOrganizationThumbnail, ICreateApiKeyRequest, IUpdateApiKeyRequest, ICreateInvitationRequest, IAcceptOrganizationInvitationRequest, ISetWebhookRequest, getWebhooks, setWebhooks, TTemplatePermissionCreatePublic, TTemplatePermissionCreateOrg, TTemplatePermissionCreatePersonal, TTemplatePermissionDelete, TTemplatePermissionVisibility, TTemplateMemberRead, TTemplateMemberWrite, TTemplateMemberDelete, TTemplateMemberVisibility, TTemplatePermission, TAccountPermissionOwnerAdd, TAccountPermissionOwnerRemove, TAccountPermissionAdminAdd, TAccountPermissionAdminRemove, TAccountPermissionMemberView, TAccountPermissionMemberAdd, TAccountPermissionMemberRemove, TAccountPermission, TOrgPermissionCreate, TOrgPermissionView, TOrgPermissionUpdate, TOrgPermissionDelete, TOrgPermissionTransfer, TOrgPermissionList, TOrgPermission, TEnvelopePermissionCreate, TEnvelopePermissionCancel, TEnvelopePermissionView, TEnvelopePermissionOrg, TEnvelopePermission, TPermission, TRole, RolePermissions, userHasPermissions, ISigningSession, IUserSession, IIdToken, TSessionType, TSession, TActiveSession, canPerformTemplateAction, hasRequiredPermissions, createField, updateField, deleteField, userIsTemplateCreator, userHasSharedTemplate, userCanCreatePersonalTemplate, userCanCreateOrgTemplate, userCanCreatePublicTemplate, userCanReadTemplate, userCanUpdateTemplate, userCanMakeTemplatePrivate, userCanMakeTemplateShared, userCanMakeTemplatePublic, userCanChangeOrgVisibility, userCanDeleteTemplate, userCanSendTemplate, userCanCreateTemplate, userCanBuildTemplate, getFieldsForRole, userCanPreviewTemplate, createTemplateRole, updateTemplateRole, deleteTemplateRole, getStars, toggleStar, addTemplateTag, getTemplateTags, deleteTemplateTag, createTag, getTag, getAllTags, ITemplateSortBy, TTemplateVisibilityFilter, IGetTemplatesParams, getTemplates, getTemplate, IDocumentFromUri, IDocumentFromData, ITemplateCreateParams, createTemplate, duplicateTemplate, ITemplateCreateFromSharepointParams, createTemplateFromSharepoint, updateTemplate, deleteTemplate, getTemplateDocuments, getTemplateDocument, createTemplateDocument, deleteTemplateDocument, getTemplateDocumentFile, getTemplateDocumentThumbnail, getTemplateDocumentPageDisplayUri, ITemplateTag, ITag, IStar, ITemplateSearchResult, IValidator, getValidators, getValidator, isValidEmail, isValidPhone, isValidRoleName, isValidTag, IROPCRequest, IClientCredentialsRequest, IRefreshTokenRequest, TAuthenticationRequest, authenticate, refreshToken, changePassword, resetPassword, resendVerification, verifyEmail, getMyUser, getNotifications, getProfiles, getCurrentProfile, switchProfile, updateProfile, deleteProfile, createProfile, updateProfilePhoto, ICreateProfileRequest, IUpdateProfileRequest, IAuthenticateResponse, IChangePasswordRequest, IChangePasswordResponse, IResetPasswordRequest, IResetPasswordResponse, IVerifyEmailRequest, getRGB, getRGBA, nameToRGBA, getRoleColor, formatShortTimeAgo, getRTop, getRLeft, getRValue, blobToBase64, rescale, sortFields, fileToDataUrl, downloadBlob, Countries, getCountryByCode, isFrenchGuiana, isGuadeloupe, isMartinique, isMayotte, getPlusOneCountry, isCanada, isAmericanSamoa, isDominicanRepublic, isPuertoRico, getMatchingCountry, integerSequence, formatFullName, formatInitials, fullNameToInitials, capitalize, convertToE164, randomString, AtoB, decodeJWTBody, decodeAccessTokenBody, IFileWithData, ICountry };
+export { TRequestStatus, TTemplateSender, TTemplateAction, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TSortTemplateBy, TAccessKeyType, TApiKeyPermission, TDeprecatedHistoryEvent, THistoryEvent, TEventDetail, TEnvelopeUpdateResult, TFieldType, TWebhookEvent, TTemplateVisibility, TEntitlement, TRecipientAuthMethod, TRecipientAuthStep, FIELD_TYPES, DEFAULT_FIELD_WIDTHS, DEFAULT_FIELD_HEIGHTS, WEBHOOK_EVENTS, ALL_PERMISSIONS, IChannel, IDisabledChannel, INotification, IApiKey, IGroup, IGroupProfile, IOAuth2App, IEntitlement, IOrganization, IOrganizationInvitation, IPendingWebhook, IProfile, IUser, IWebhookEvents, IWebhook, IInPersonAccessKey, IInAppAccessKey, IEmailAccessKey, ISMSAccessKey, TAccessKey, IEnvelope, IEnvelopeDocument, IDropdownOption, IEnvelopeField, IEnvelopeFieldOptions, IEnvelopeFieldSettings, IEnvelopeHistory, IInitial, IKbaPINRequired, IRecipient, IRole, ISignature, ITemplate, ITemplateDocument, ITemplateField, ITextFieldSetting, ITemplateFieldSetting, TEnvironment, TSessionChangedListener, VerdocsEndpointOptions, VerdocsEndpoint, createEnvelope, getEnvelope, getEnvelopeDocument, getDocumentDownloadLink, getDocumentPreviewLink, cancelEnvelope, getEnvelopeFile, updateEnvelope, updateEnvelopeField, updateEnvelopeFieldSignature, updateEnvelopeFieldInitials, uploadEnvelopeFieldAttachment, deleteEnvelopeFieldAttachment, getFieldAttachment, getEnvelopeDocumentPageDisplayUri, ITimeRange, IListEnvelopesParams, getEnvelopes, createInitials, IRecipientKbaStepNone, IRecipientKbaStepComplete, IRecipientKbaStepPin, IRecipientKbaStepIdentity, IRecipientKbaStepChallenge, IRecipientKbaStepFailed, TRecipientKbaStep, getKbaStep, submitKbaPin, IKbaIdentity, submitKbaIdentity, IKbaChallengeResponse, submitKbaChallengeResponse, updateRecipient, envelopeRecipientSubmit, envelopeRecipientDecline, envelopeRecipientChangeOwner, envelopeRecipientAgree, envelopeRecipientUpdateName, envelopeRecipientPrepare, startSigningSession, getInPersonLink, sendDelegate, resendInvitation, userIsEnvelopeOwner, userIsEnvelopeRecipient, envelopeIsActive, envelopeIsComplete, userCanCancelEnvelope, userCanFinishEnvelope, recipientHasAction, getRecipientsWithActions, recipientCanAct, userCanAct, userCanSignNow, getNextRecipient, createSignature, getSignatures, getSignature, deleteSignature, IEnvelopesSearchResult, IDocumentSearchOptions, ICreateEnvelopeRecipient, ISignerTokenResponse, IInPersonLinkResponse, IUpdateRecipientSubmitParams, IUpdateRecipientDeclineParams, IUpdateRecipientClaimEnvelope, IUpdateRecipientStatus, IUpdateRecipientAgreedParams, IUpdateRecipientNameParams, IUpdateRecipientPrepareParams, ICreateEnvelopeReminderRequest, ICreateEnvelopeFromTemplateRequest, ICreateEnvelopeDirectlyRequest, TCreateEnvelopeRequest, getApiKeys, createApiKey, rotateApiKey, updateApiKey, deleteApiKey, getOrganizationContacts, deleteOrganizationContact, createOrganizationContact, updateOrganizationContact, getGroups, getGroup, createGroup, updateGroup, deleteGroup, addGroupMember, deleteGroupMember, getOrganizationInvitations, createOrganizationInvitation, deleteOrganizationInvitation, updateOrganizationInvitation, resendOrganizationInvitation, getOrganizationInvitation, acceptOrganizationInvitation, declineOrganizationInvitation, getOrganizationMembers, deleteOrganizationMember, updateOrganizationMember, getOrganization, createOrganization, updateOrganization, deleteOrganization, updateOrganizationLogo, updateOrganizationThumbnail, getEntitlements, getActiveEntitlements, ICreateApiKeyRequest, IUpdateApiKeyRequest, ICreateInvitationRequest, IAcceptOrganizationInvitationRequest, ISetWebhookRequest, getWebhooks, setWebhooks, TTemplatePermissionCreatePublic, TTemplatePermissionCreateOrg, TTemplatePermissionCreatePersonal, TTemplatePermissionDelete, TTemplatePermissionVisibility, TTemplateMemberRead, TTemplateMemberWrite, TTemplateMemberDelete, TTemplateMemberVisibility, TTemplatePermission, TAccountPermissionOwnerAdd, TAccountPermissionOwnerRemove, TAccountPermissionAdminAdd, TAccountPermissionAdminRemove, TAccountPermissionMemberView, TAccountPermissionMemberAdd, TAccountPermissionMemberRemove, TAccountPermission, TOrgPermissionCreate, TOrgPermissionView, TOrgPermissionUpdate, TOrgPermissionDelete, TOrgPermissionTransfer, TOrgPermissionList, TOrgPermission, TEnvelopePermissionCreate, TEnvelopePermissionCancel, TEnvelopePermissionView, TEnvelopePermissionOrg, TEnvelopePermission, TPermission, TRole, RolePermissions, userHasPermissions, ISigningSession, IUserSession, IIdToken, TSessionType, TSession, TActiveSession, canPerformTemplateAction, hasRequiredPermissions, createField, updateField, deleteField, userIsTemplateCreator, userHasSharedTemplate, userCanCreatePersonalTemplate, userCanCreateOrgTemplate, userCanCreatePublicTemplate, userCanReadTemplate, userCanUpdateTemplate, userCanMakeTemplatePrivate, userCanMakeTemplateShared, userCanMakeTemplatePublic, userCanChangeOrgVisibility, userCanDeleteTemplate, userCanSendTemplate, userCanCreateTemplate, userCanBuildTemplate, getFieldsForRole, userCanPreviewTemplate, createTemplateRole, updateTemplateRole, deleteTemplateRole, getStars, toggleStar, addTemplateTag, getTemplateTags, deleteTemplateTag, createTag, getTag, getAllTags, ITemplateSortBy, TTemplateVisibilityFilter, IGetTemplatesParams, getTemplates, getTemplate, IDocumentFromUri, IDocumentFromData, ITemplateCreateParams, createTemplate, duplicateTemplate, ITemplateCreateFromSharepointParams, createTemplateFromSharepoint, updateTemplate, deleteTemplate, getTemplateDocuments, getTemplateDocument, createTemplateDocument, deleteTemplateDocument, getTemplateDocumentFile, getTemplateDocumentThumbnail, getTemplateDocumentPageDisplayUri, ITemplateTag, ITag, IStar, ITemplateSearchResult, IValidator, getValidators, getValidator, isValidEmail, isValidPhone, isValidRoleName, isValidTag, IROPCRequest, IClientCredentialsRequest, IRefreshTokenRequest, TAuthenticationRequest, authenticate, refreshToken, changePassword, resetPassword, resendVerification, verifyEmail, getMyUser, getNotifications, getProfiles, getCurrentProfile, switchProfile, updateProfile, deleteProfile, createProfile, updateProfilePhoto, ICreateProfileRequest, IUpdateProfileRequest, IAuthenticateResponse, IChangePasswordRequest, IChangePasswordResponse, IResetPasswordRequest, IResetPasswordResponse, IVerifyEmailRequest, getRGB, getRGBA, nameToRGBA, getRoleColor, formatShortTimeAgo, collapseEntitlements, getRTop, getRLeft, getRValue, blobToBase64, rescale, sortFields, fileToDataUrl, downloadBlob, Countries, getCountryByCode, isFrenchGuiana, isGuadeloupe, isMartinique, isMayotte, getPlusOneCountry, isCanada, isAmericanSamoa, isDominicanRepublic, isPuertoRico, getMatchingCountry, integerSequence, formatFullName, formatInitials, fullNameToInitials, capitalize, convertToE164, randomString, AtoB, decodeJWTBody, decodeAccessTokenBody, IFileWithData, ICountry };

package/dist/index.d.ts

@@ -153,10 +153,10 @@ interface ISigningSession {
     email: string;
     iat: number;
     exp: number;
-    "https://verdocs.com/session_type": "signing";
-    "https://verdocs.com/key_type": TAccessKeyType;
-    "https://verdocs.com/envelope_id": string;
-    "https://verdocs.com/role_name": string;
+    ["https://verdocs.com/session_type"]: "signing";
+    ["https://verdocs.com/key_type"]: TAccessKeyType;
+    ["https://verdocs.com/envelope_id"]: string;
+    ["https://verdocs.com/role_name"]: string;
 }
 /**
  * A User Session connects a caller to a Verdocs profile, and can be used for any operations that profile may perform.
@@ -165,19 +165,19 @@ interface IUserSession {
     jti: string;
     aud: string;
     iss: string;
-    sub: string; // Auth0 user_id
+    sub: string; // Verdocs user_id
     email: string;
     iat: number;
     exp: number;
-    session_type: "user";
-    profile_id: string;
-    organization_id: string;
-    global_admin: boolean;
+    ["https://verdocs.com/session_type"]: "user";
+    ["https://verdocs.com/profile_id"]: string;
+    ["https://verdocs.com/organization_id"]: string;
+    ["https://verdocs.com/global_admin"]: boolean;
 }
 interface IIdToken {
     aud: string;
     iss: string;
-    sub: string; // Auth0 user_id
+    sub: string; // Verdocs user_id
     email: string;
     organization_id: string;
     first_name: string;
@@ -267,6 +267,19 @@ interface IOAuth2App {
     organization?: IOrganization;
     profile?: IProfile;
 }
+interface IEntitlement {
+    id: string;
+    organization_id: string;
+    feature: TEntitlement;
+    contract_id?: string | null;
+    notes?: string | null;
+    starts_at: string;
+    ends_at: string;
+    monthly_max: number;
+    yearly_max: number;
+    created_at: string;
+    organization?: IOrganization;
+}
 interface IOrganization {
     /** The unique ID of the organization */
     id: string;
@@ -284,9 +297,6 @@ interface IOrganization {
     thumbnail_url?: string | null;
     primary_color?: string | null;
     secondary_color?: string | null;
-    entitlements?: Record<string, any> | null;
-    mtd_usage?: Record<string, any> | null;
-    ytd_usage?: Record<string, any> | null;
     data?: Record<string, any> | null;
     /** Creation date/time. */
     created_at: string;
@@ -295,6 +305,7 @@ interface IOrganization {
     api_keys?: IApiKey[];
     groups?: IGroup[];
     oauth2_apps?: IOAuth2App[];
+    entitlements?: IEntitlement[];
     organization_invitations?: IOrganizationInvitation[];
     profiles?: IProfile[];
     webhooks?: IWebhook[];
@@ -678,28 +689,18 @@ interface IRecipient {
     created_at: string;
     updated_at: string;
     last_attempt_at?: string;
+    /** The type of authentication required for this recipient. */
+    auth_method?: TRecipientAuthMethod;
     /**
-     * If set, "KBA required" will carry through to automatically enable the same setting in Envelopes
-     * created from this template. For privacy reasons, this field will only be visible to the creator
-     * of the envelope and the recipient referenced.
-     */
-    kba_method?: TKBAMethod;
-    /**
-     * If KBA is set to "PIN" this will be set to the PIN code required. For security reasons, this
+     * If auth_method is set to "passcode" this is the passcode required. For security reasons, this
      * field will only be visible to the creator of the envelope.
      */
-    kba_pin?: string | null;
+    passcode?: string | null;
     /**
-     * If KBA has been completed successfully, this will be set to true. For privacy reasons, this
-     * field will only be visible to the creator of the envelope and the recipient referenced.
+     * If authentication has been completed successfully, this will be set to 'complete'. This is a union type
+     * to allow for future expansion with authentication modules that may require multiple steps.
      */
-    kba_completed?: boolean;
-    /**
-     * If KBA has been completed (or partially successfully, this will contain metadata related to
-     * the questions and answers from the process. For privacy reasons, this field will only be visible
-     * to the recipient referenced.
-     */
-    kba_details?: Record<string, any>;
+    auth_step?: TRecipientAuthStep | null;
     envelope?: IEnvelope;
     profile?: IProfile;
 }
@@ -735,12 +736,6 @@ interface IRole {
      */
     order: number;
     delegator: boolean | null;
-    /**
-     * If set, "KBA required" will carry through to automatically enable the same setting in Envelopes
-     * created from this template. Note that KBA details may not be specified here. They must be unique to
-     * each individual recipient and therefore cannot be set as defaults in the template.
-     */
-    kba_method: TKBAMethod;
 }
 interface ISignature {
     id: string;
@@ -948,7 +943,9 @@ type TEnvelopeUpdateResult = Omit<IEnvelope, "histories" | "recipients" | "certi
 type TFieldType = "signature" | "initial" | "checkbox" | "radio" | "textbox" | "timestamp" | "date" | "dropdown" | "textarea" | "attachment" | "payment";
 type TWebhookEvent = "envelope_created" | "envelope_completed" | "envelope_canceled" | "envelope_updated" | "template_created" | "template_updated" | "template_deleted" | "template_used";
 type TTemplateVisibility = "private" | "shared" | "public";
-type TKBAMethod = "pin" | "kba" | "id" | "sms" | "" | null;
+type TEntitlement = "envelope" | "kba_auth" | "passcode_auth" | "sms_auth" | "kba_id_auth" | "id_auth";
+type TRecipientAuthMethod = "kba_auth" | "passcode_auth" | "sms_auth" | "kba_id_auth" | "id_auth" | null;
+type TRecipientAuthStep = "complete" | null;
 declare const FIELD_TYPES: TFieldType[];
 declare const DEFAULT_FIELD_WIDTHS: Record<TFieldType, number>;
 declare const DEFAULT_FIELD_HEIGHTS: Record<TFieldType, number>;
@@ -2656,6 +2653,30 @@ declare const updateOrganizationLogo: (endpoint: VerdocsEndpoint, organizationId
  * ```
  */
 declare const updateOrganizationThumbnail: (endpoint: VerdocsEndpoint, organizationId: string, file: File, onUploadProgress?: (percent: number, loadedBytes: number, totalBytes: number) => void) => Promise<IOrganization>;
+declare const getEntitlements: (endpoint: VerdocsEndpoint) => Promise<IEntitlement[]>;
+/**
+ * Largely intended to be used internally by Web SDK components but may be informative for other cases.
+ * Entitlements are feature grants such as "ID-based KBA" that require paid contracts to enable, typically
+ * because the underlying services that support them are fee-based. Entitlements may run concurrently,
+ * and may have different start/end dates e.g. "ID-based KBA" may run 1/1/2026-12/31/2026 while
+ * "SMS Authentication" may be added later and run 6/1/2026-5/31/2027. The entitlements list is a simple
+ * array of enablements and may include entries that are not YET enabled or have now expired.
+ *
+ * In client code it is helpful to simply know "is XYZ feature currently enabled?" This function collapses
+ * the entitlements list to a simplified dictionary of current/active entitlements. Note that it is async
+ * because it calls the server to obtain the "most current" entitlements list. Existence of an entry in the
+ * resulting dictionary implies the feature is active. Metadata inside each entry can be used to determine
+ * limits, etc.
+ *
+ * ```typescript
+ * import {getActiveEntitlements} from '@verdocs/js-sdk';
+ *
+ * const activeEntitlements = await getActiveEntitlements((VerdocsEndpoint.getDefault());
+ * const isSMSEnabled = !!activeEntitlements.sms_auth;
+ * const monthlyKBALimit = activeEntitlements.kba_auth?.monthly_max;
+ * ```
+ */
+declare const getActiveEntitlements: (endpoint: VerdocsEndpoint) => Promise<Partial<Record<TEntitlement, IEntitlement>>>;
 /**
  * Get the registered Webhook configuration for the caller's organization.
  *
@@ -3302,6 +3323,7 @@ declare function nameToRGBA(str: string): string | undefined;
  */
 declare function getRoleColor(name: string, roles: TRole[], index?: number): string | undefined;
 declare const formatShortTimeAgo: (val: any) => string;
+declare const collapseEntitlements: (entitlements: IEntitlement[]) => Partial<Record<TEntitlement, IEntitlement>>;
 declare function getRTop(y: number, fieldHeight: number, iTextHeight: number, yRatio: number): number;
 declare function getRLeft(x: number, ratio: number): number;
 declare function getRValue(y: number, ratio: number): number;
@@ -3397,4 +3419,4 @@ declare const decodeJWTBody: (token: string) => any;
  * the presence of the `document_id` field, which will only be present for signing sessions.
  */
 declare const decodeAccessTokenBody: (token: string) => TSession;
-export { TRequestStatus, TTemplateSender, TTemplateAction, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TSortTemplateBy, TAccessKeyType, TApiKeyPermission, TDeprecatedHistoryEvent, THistoryEvent, TEventDetail, TEnvelopeUpdateResult, TFieldType, TWebhookEvent, TTemplateVisibility, TKBAMethod, FIELD_TYPES, DEFAULT_FIELD_WIDTHS, DEFAULT_FIELD_HEIGHTS, WEBHOOK_EVENTS, ALL_PERMISSIONS, IChannel, IDisabledChannel, INotification, IApiKey, IGroup, IGroupProfile, IOAuth2App, IOrganization, IOrganizationInvitation, IPendingWebhook, IProfile, IUser, IWebhookEvents, IWebhook, IInPersonAccessKey, IInAppAccessKey, IEmailAccessKey, ISMSAccessKey, TAccessKey, IEnvelope, IEnvelopeDocument, IDropdownOption, IEnvelopeField, IEnvelopeFieldOptions, IEnvelopeFieldSettings, IEnvelopeHistory, IInitial, IKbaPINRequired, IRecipient, IRole, ISignature, ITemplate, ITemplateDocument, ITemplateField, ITextFieldSetting, ITemplateFieldSetting, TEnvironment, TSessionChangedListener, VerdocsEndpointOptions, VerdocsEndpoint, createEnvelope, getEnvelope, getEnvelopeDocument, getDocumentDownloadLink, getDocumentPreviewLink, cancelEnvelope, getEnvelopeFile, updateEnvelope, updateEnvelopeField, updateEnvelopeFieldSignature, updateEnvelopeFieldInitials, uploadEnvelopeFieldAttachment, deleteEnvelopeFieldAttachment, getFieldAttachment, getEnvelopeDocumentPageDisplayUri, ITimeRange, IListEnvelopesParams, getEnvelopes, createInitials, IRecipientKbaStepNone, IRecipientKbaStepComplete, IRecipientKbaStepPin, IRecipientKbaStepIdentity, IRecipientKbaStepChallenge, IRecipientKbaStepFailed, TRecipientKbaStep, getKbaStep, submitKbaPin, IKbaIdentity, submitKbaIdentity, IKbaChallengeResponse, submitKbaChallengeResponse, updateRecipient, envelopeRecipientSubmit, envelopeRecipientDecline, envelopeRecipientChangeOwner, envelopeRecipientAgree, envelopeRecipientUpdateName, envelopeRecipientPrepare, startSigningSession, getInPersonLink, sendDelegate, resendInvitation, userIsEnvelopeOwner, userIsEnvelopeRecipient, envelopeIsActive, envelopeIsComplete, userCanCancelEnvelope, userCanFinishEnvelope, recipientHasAction, getRecipientsWithActions, recipientCanAct, userCanAct, userCanSignNow, getNextRecipient, createSignature, getSignatures, getSignature, deleteSignature, IEnvelopesSearchResult, IDocumentSearchOptions, ICreateEnvelopeRecipient, ISignerTokenResponse, IInPersonLinkResponse, IUpdateRecipientSubmitParams, IUpdateRecipientDeclineParams, IUpdateRecipientClaimEnvelope, IUpdateRecipientStatus, IUpdateRecipientAgreedParams, IUpdateRecipientNameParams, IUpdateRecipientPrepareParams, ICreateEnvelopeReminderRequest, ICreateEnvelopeFromTemplateRequest, ICreateEnvelopeDirectlyRequest, TCreateEnvelopeRequest, getApiKeys, createApiKey, rotateApiKey, updateApiKey, deleteApiKey, getOrganizationContacts, deleteOrganizationContact, createOrganizationContact, updateOrganizationContact, getGroups, getGroup, createGroup, updateGroup, deleteGroup, addGroupMember, deleteGroupMember, getOrganizationInvitations, createOrganizationInvitation, deleteOrganizationInvitation, updateOrganizationInvitation, resendOrganizationInvitation, getOrganizationInvitation, acceptOrganizationInvitation, declineOrganizationInvitation, getOrganizationMembers, deleteOrganizationMember, updateOrganizationMember, getOrganization, createOrganization, updateOrganization, deleteOrganization, updateOrganizationLogo, updateOrganizationThumbnail, ICreateApiKeyRequest, IUpdateApiKeyRequest, ICreateInvitationRequest, IAcceptOrganizationInvitationRequest, ISetWebhookRequest, getWebhooks, setWebhooks, TTemplatePermissionCreatePublic, TTemplatePermissionCreateOrg, TTemplatePermissionCreatePersonal, TTemplatePermissionDelete, TTemplatePermissionVisibility, TTemplateMemberRead, TTemplateMemberWrite, TTemplateMemberDelete, TTemplateMemberVisibility, TTemplatePermission, TAccountPermissionOwnerAdd, TAccountPermissionOwnerRemove, TAccountPermissionAdminAdd, TAccountPermissionAdminRemove, TAccountPermissionMemberView, TAccountPermissionMemberAdd, TAccountPermissionMemberRemove, TAccountPermission, TOrgPermissionCreate, TOrgPermissionView, TOrgPermissionUpdate, TOrgPermissionDelete, TOrgPermissionTransfer, TOrgPermissionList, TOrgPermission, TEnvelopePermissionCreate, TEnvelopePermissionCancel, TEnvelopePermissionView, TEnvelopePermissionOrg, TEnvelopePermission, TPermission, TRole, RolePermissions, userHasPermissions, ISigningSession, IUserSession, IIdToken, TSessionType, TSession, TActiveSession, canPerformTemplateAction, hasRequiredPermissions, createField, updateField, deleteField, userIsTemplateCreator, userHasSharedTemplate, userCanCreatePersonalTemplate, userCanCreateOrgTemplate, userCanCreatePublicTemplate, userCanReadTemplate, userCanUpdateTemplate, userCanMakeTemplatePrivate, userCanMakeTemplateShared, userCanMakeTemplatePublic, userCanChangeOrgVisibility, userCanDeleteTemplate, userCanSendTemplate, userCanCreateTemplate, userCanBuildTemplate, getFieldsForRole, userCanPreviewTemplate, createTemplateRole, updateTemplateRole, deleteTemplateRole, getStars, toggleStar, addTemplateTag, getTemplateTags, deleteTemplateTag, createTag, getTag, getAllTags, ITemplateSortBy, TTemplateVisibilityFilter, IGetTemplatesParams, getTemplates, getTemplate, IDocumentFromUri, IDocumentFromData, ITemplateCreateParams, createTemplate, duplicateTemplate, ITemplateCreateFromSharepointParams, createTemplateFromSharepoint, updateTemplate, deleteTemplate, getTemplateDocuments, getTemplateDocument, createTemplateDocument, deleteTemplateDocument, getTemplateDocumentFile, getTemplateDocumentThumbnail, getTemplateDocumentPageDisplayUri, ITemplateTag, ITag, IStar, ITemplateSearchResult, IValidator, getValidators, getValidator, isValidEmail, isValidPhone, isValidRoleName, isValidTag, IROPCRequest, IClientCredentialsRequest, IRefreshTokenRequest, TAuthenticationRequest, authenticate, refreshToken, changePassword, resetPassword, resendVerification, verifyEmail, getMyUser, getNotifications, getProfiles, getCurrentProfile, switchProfile, updateProfile, deleteProfile, createProfile, updateProfilePhoto, ICreateProfileRequest, IUpdateProfileRequest, IAuthenticateResponse, IChangePasswordRequest, IChangePasswordResponse, IResetPasswordRequest, IResetPasswordResponse, IVerifyEmailRequest, getRGB, getRGBA, nameToRGBA, getRoleColor, formatShortTimeAgo, getRTop, getRLeft, getRValue, blobToBase64, rescale, sortFields, fileToDataUrl, downloadBlob, Countries, getCountryByCode, isFrenchGuiana, isGuadeloupe, isMartinique, isMayotte, getPlusOneCountry, isCanada, isAmericanSamoa, isDominicanRepublic, isPuertoRico, getMatchingCountry, integerSequence, formatFullName, formatInitials, fullNameToInitials, capitalize, convertToE164, randomString, AtoB, decodeJWTBody, decodeAccessTokenBody, IFileWithData, ICountry };
+export { TRequestStatus, TTemplateSender, TTemplateAction, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TSortTemplateBy, TAccessKeyType, TApiKeyPermission, TDeprecatedHistoryEvent, THistoryEvent, TEventDetail, TEnvelopeUpdateResult, TFieldType, TWebhookEvent, TTemplateVisibility, TEntitlement, TRecipientAuthMethod, TRecipientAuthStep, FIELD_TYPES, DEFAULT_FIELD_WIDTHS, DEFAULT_FIELD_HEIGHTS, WEBHOOK_EVENTS, ALL_PERMISSIONS, IChannel, IDisabledChannel, INotification, IApiKey, IGroup, IGroupProfile, IOAuth2App, IEntitlement, IOrganization, IOrganizationInvitation, IPendingWebhook, IProfile, IUser, IWebhookEvents, IWebhook, IInPersonAccessKey, IInAppAccessKey, IEmailAccessKey, ISMSAccessKey, TAccessKey, IEnvelope, IEnvelopeDocument, IDropdownOption, IEnvelopeField, IEnvelopeFieldOptions, IEnvelopeFieldSettings, IEnvelopeHistory, IInitial, IKbaPINRequired, IRecipient, IRole, ISignature, ITemplate, ITemplateDocument, ITemplateField, ITextFieldSetting, ITemplateFieldSetting, TEnvironment, TSessionChangedListener, VerdocsEndpointOptions, VerdocsEndpoint, createEnvelope, getEnvelope, getEnvelopeDocument, getDocumentDownloadLink, getDocumentPreviewLink, cancelEnvelope, getEnvelopeFile, updateEnvelope, updateEnvelopeField, updateEnvelopeFieldSignature, updateEnvelopeFieldInitials, uploadEnvelopeFieldAttachment, deleteEnvelopeFieldAttachment, getFieldAttachment, getEnvelopeDocumentPageDisplayUri, ITimeRange, IListEnvelopesParams, getEnvelopes, createInitials, IRecipientKbaStepNone, IRecipientKbaStepComplete, IRecipientKbaStepPin, IRecipientKbaStepIdentity, IRecipientKbaStepChallenge, IRecipientKbaStepFailed, TRecipientKbaStep, getKbaStep, submitKbaPin, IKbaIdentity, submitKbaIdentity, IKbaChallengeResponse, submitKbaChallengeResponse, updateRecipient, envelopeRecipientSubmit, envelopeRecipientDecline, envelopeRecipientChangeOwner, envelopeRecipientAgree, envelopeRecipientUpdateName, envelopeRecipientPrepare, startSigningSession, getInPersonLink, sendDelegate, resendInvitation, userIsEnvelopeOwner, userIsEnvelopeRecipient, envelopeIsActive, envelopeIsComplete, userCanCancelEnvelope, userCanFinishEnvelope, recipientHasAction, getRecipientsWithActions, recipientCanAct, userCanAct, userCanSignNow, getNextRecipient, createSignature, getSignatures, getSignature, deleteSignature, IEnvelopesSearchResult, IDocumentSearchOptions, ICreateEnvelopeRecipient, ISignerTokenResponse, IInPersonLinkResponse, IUpdateRecipientSubmitParams, IUpdateRecipientDeclineParams, IUpdateRecipientClaimEnvelope, IUpdateRecipientStatus, IUpdateRecipientAgreedParams, IUpdateRecipientNameParams, IUpdateRecipientPrepareParams, ICreateEnvelopeReminderRequest, ICreateEnvelopeFromTemplateRequest, ICreateEnvelopeDirectlyRequest, TCreateEnvelopeRequest, getApiKeys, createApiKey, rotateApiKey, updateApiKey, deleteApiKey, getOrganizationContacts, deleteOrganizationContact, createOrganizationContact, updateOrganizationContact, getGroups, getGroup, createGroup, updateGroup, deleteGroup, addGroupMember, deleteGroupMember, getOrganizationInvitations, createOrganizationInvitation, deleteOrganizationInvitation, updateOrganizationInvitation, resendOrganizationInvitation, getOrganizationInvitation, acceptOrganizationInvitation, declineOrganizationInvitation, getOrganizationMembers, deleteOrganizationMember, updateOrganizationMember, getOrganization, createOrganization, updateOrganization, deleteOrganization, updateOrganizationLogo, updateOrganizationThumbnail, getEntitlements, getActiveEntitlements, ICreateApiKeyRequest, IUpdateApiKeyRequest, ICreateInvitationRequest, IAcceptOrganizationInvitationRequest, ISetWebhookRequest, getWebhooks, setWebhooks, TTemplatePermissionCreatePublic, TTemplatePermissionCreateOrg, TTemplatePermissionCreatePersonal, TTemplatePermissionDelete, TTemplatePermissionVisibility, TTemplateMemberRead, TTemplateMemberWrite, TTemplateMemberDelete, TTemplateMemberVisibility, TTemplatePermission, TAccountPermissionOwnerAdd, TAccountPermissionOwnerRemove, TAccountPermissionAdminAdd, TAccountPermissionAdminRemove, TAccountPermissionMemberView, TAccountPermissionMemberAdd, TAccountPermissionMemberRemove, TAccountPermission, TOrgPermissionCreate, TOrgPermissionView, TOrgPermissionUpdate, TOrgPermissionDelete, TOrgPermissionTransfer, TOrgPermissionList, TOrgPermission, TEnvelopePermissionCreate, TEnvelopePermissionCancel, TEnvelopePermissionView, TEnvelopePermissionOrg, TEnvelopePermission, TPermission, TRole, RolePermissions, userHasPermissions, ISigningSession, IUserSession, IIdToken, TSessionType, TSession, TActiveSession, canPerformTemplateAction, hasRequiredPermissions, createField, updateField, deleteField, userIsTemplateCreator, userHasSharedTemplate, userCanCreatePersonalTemplate, userCanCreateOrgTemplate, userCanCreatePublicTemplate, userCanReadTemplate, userCanUpdateTemplate, userCanMakeTemplatePrivate, userCanMakeTemplateShared, userCanMakeTemplatePublic, userCanChangeOrgVisibility, userCanDeleteTemplate, userCanSendTemplate, userCanCreateTemplate, userCanBuildTemplate, getFieldsForRole, userCanPreviewTemplate, createTemplateRole, updateTemplateRole, deleteTemplateRole, getStars, toggleStar, addTemplateTag, getTemplateTags, deleteTemplateTag, createTag, getTag, getAllTags, ITemplateSortBy, TTemplateVisibilityFilter, IGetTemplatesParams, getTemplates, getTemplate, IDocumentFromUri, IDocumentFromData, ITemplateCreateParams, createTemplate, duplicateTemplate, ITemplateCreateFromSharepointParams, createTemplateFromSharepoint, updateTemplate, deleteTemplate, getTemplateDocuments, getTemplateDocument, createTemplateDocument, deleteTemplateDocument, getTemplateDocumentFile, getTemplateDocumentThumbnail, getTemplateDocumentPageDisplayUri, ITemplateTag, ITag, IStar, ITemplateSearchResult, IValidator, getValidators, getValidator, isValidEmail, isValidPhone, isValidRoleName, isValidTag, IROPCRequest, IClientCredentialsRequest, IRefreshTokenRequest, TAuthenticationRequest, authenticate, refreshToken, changePassword, resetPassword, resendVerification, verifyEmail, getMyUser, getNotifications, getProfiles, getCurrentProfile, switchProfile, updateProfile, deleteProfile, createProfile, updateProfilePhoto, ICreateProfileRequest, IUpdateProfileRequest, IAuthenticateResponse, IChangePasswordRequest, IChangePasswordResponse, IResetPasswordRequest, IResetPasswordResponse, IVerifyEmailRequest, getRGB, getRGBA, nameToRGBA, getRoleColor, formatShortTimeAgo, collapseEntitlements, getRTop, getRLeft, getRValue, blobToBase64, rescale, sortFields, fileToDataUrl, downloadBlob, Countries, getCountryByCode, isFrenchGuiana, isGuadeloupe, isMartinique, isMayotte, getPlusOneCountry, isCanada, isAmericanSamoa, isDominicanRepublic, isPuertoRico, getMatchingCountry, integerSequence, formatFullName, formatInitials, fullNameToInitials, capitalize, convertToE164, randomString, AtoB, decodeJWTBody, decodeAccessTokenBody, IFileWithData, ICountry };

package/dist/index.js

@@ -232,6 +232,19 @@ const formatShortTimeAgo = (val) => {
     return `${timeDiff}S`;
 };
 
+const collapseEntitlements = (entitlements) => {
+    const now = new Date();
+    const activeEntitlements = {};
+    entitlements.forEach((entitlement) => {
+        const start = new Date(entitlement.starts_at);
+        const end = new Date(entitlement.ends_at);
+        if (now >= start && now <= end && !activeEntitlements[entitlement.feature]) {
+            activeEntitlements[entitlement.feature] = entitlement;
+        }
+    });
+    return activeEntitlements;
+};
+
 function getRTop(y, fieldHeight, iTextHeight, yRatio) {
     return iTextHeight - (y + fieldHeight) * yRatio;
 }
@@ -2656,6 +2669,36 @@ const updateOrganizationThumbnail = (endpoint, organizationId, file, onUploadPro
     })
         .then((r) => r.data);
 };
+const getEntitlements = async (endpoint) => endpoint.api.get(`/v2/organizations/entitlements`).then((r) => r.data);
+/**
+ * Largely intended to be used internally by Web SDK components but may be informative for other cases.
+ * Entitlements are feature grants such as "ID-based KBA" that require paid contracts to enable, typically
+ * because the underlying services that support them are fee-based. Entitlements may run concurrently,
+ * and may have different start/end dates e.g. "ID-based KBA" may run 1/1/2026-12/31/2026 while
+ * "SMS Authentication" may be added later and run 6/1/2026-5/31/2027. The entitlements list is a simple
+ * array of enablements and may include entries that are not YET enabled or have now expired.
+ *
+ * In client code it is helpful to simply know "is XYZ feature currently enabled?" This function collapses
+ * the entitlements list to a simplified dictionary of current/active entitlements. Note that it is async
+ * because it calls the server to obtain the "most current" entitlements list. Existence of an entry in the
+ * resulting dictionary implies the feature is active. Metadata inside each entry can be used to determine
+ * limits, etc.
+ *
+ * ```typescript
+ * import {getActiveEntitlements} from '@verdocs/js-sdk';
+ *
+ * const activeEntitlements = await getActiveEntitlements((VerdocsEndpoint.getDefault());
+ * const isSMSEnabled = !!activeEntitlements.sms_auth;
+ * const monthlyKBALimit = activeEntitlements.kba_auth?.monthly_max;
+ * ```
+ */
+const getActiveEntitlements = async (endpoint) => {
+    if (!endpoint.session) {
+        throw new Error('No active session');
+    }
+    const entitlements = await getEntitlements(endpoint);
+    return collapseEntitlements(entitlements);
+};
 
 /**
  * Webhooks are callback triggers from Verdocs to your servers that notify your applications
@@ -3555,6 +3598,7 @@ exports.canPerformTemplateAction = canPerformTemplateAction;
 exports.cancelEnvelope = cancelEnvelope;
 exports.capitalize = capitalize;
 exports.changePassword = changePassword;
+exports.collapseEntitlements = collapseEntitlements;
 exports.convertToE164 = convertToE164;
 exports.createApiKey = createApiKey;
 exports.createEnvelope = createEnvelope;
@@ -3604,12 +3648,14 @@ exports.formatFullName = formatFullName;
 exports.formatInitials = formatInitials;
 exports.formatShortTimeAgo = formatShortTimeAgo;
 exports.fullNameToInitials = fullNameToInitials;
+exports.getActiveEntitlements = getActiveEntitlements;
 exports.getAllTags = getAllTags;
 exports.getApiKeys = getApiKeys;
 exports.getCountryByCode = getCountryByCode;
 exports.getCurrentProfile = getCurrentProfile;
 exports.getDocumentDownloadLink = getDocumentDownloadLink;
 exports.getDocumentPreviewLink = getDocumentPreviewLink;
+exports.getEntitlements = getEntitlements;
 exports.getEnvelope = getEnvelope;
 exports.getEnvelopeDocument = getEnvelopeDocument;
 exports.getEnvelopeDocumentPageDisplayUri = getEnvelopeDocumentPageDisplayUri;