@verdocs/js-sdk 4.1.15 → 4.1.16

package/dist/index.d.mts

@@ -906,7 +906,7 @@ type TSession = IUserSession | ISigningSession | null;
  */
 type TActiveSession = IUserSession | ISigningSession;
 type TEnvironment = "verdocs" | "verdocs-stage";
-type TSessionChangedListener = (endpoint: VerdocsEndpoint, session: TSession) => void;
+type TSessionChangedListener = (endpoint: VerdocsEndpoint, session: TSession, profile: IProfile | null) => void;
 interface VerdocsEndpointOptions {
     baseURL?: string;
     baseURLv2?: string;
@@ -953,6 +953,13 @@ declare class VerdocsEndpoint {
      * with Envelopes.
      */
     session: TSession;
+    /**
+     * The current user's profile, if known. Note that while sessions are loaded and handled synchronously,
+     * profiles are loaded asynchronously and may not be available immediately after a session is loaded.
+     * To ensure both are available, developers should subscribe to the `onSessionChanged` event, which
+     * will not be fired until the profile is loaded and verified.
+     */
+    profile: IProfile | null;
     api: AxiosInstance;
     /**
      * Create a new VerdocsEndpoint to call Verdocs platform services.
@@ -1115,8 +1122,8 @@ declare class VerdocsEndpoint {
      */
     onSessionChanged(listener: TSessionChangedListener): () => void;
     /**
-     * Load a persisted session from localStorage. Typically called once after the endpoint is configured when the app
-     * or component starts.
+     * Load a persisted session from localStorage. Typically called once after the endpoint is configured
+     * when the app or component starts.
      */
     loadSession(): VerdocsEndpoint;
 }

package/dist/index.d.ts

@@ -906,7 +906,7 @@ type TSession = IUserSession | ISigningSession | null;
  */
 type TActiveSession = IUserSession | ISigningSession;
 type TEnvironment = "verdocs" | "verdocs-stage";
-type TSessionChangedListener = (endpoint: VerdocsEndpoint, session: TSession) => void;
+type TSessionChangedListener = (endpoint: VerdocsEndpoint, session: TSession, profile: IProfile | null) => void;
 interface VerdocsEndpointOptions {
     baseURL?: string;
     baseURLv2?: string;
@@ -953,6 +953,13 @@ declare class VerdocsEndpoint {
      * with Envelopes.
      */
     session: TSession;
+    /**
+     * The current user's profile, if known. Note that while sessions are loaded and handled synchronously,
+     * profiles are loaded asynchronously and may not be available immediately after a session is loaded.
+     * To ensure both are available, developers should subscribe to the `onSessionChanged` event, which
+     * will not be fired until the profile is loaded and verified.
+     */
+    profile: IProfile | null;
     api: AxiosInstance;
     /**
      * Create a new VerdocsEndpoint to call Verdocs platform services.
@@ -1115,8 +1122,8 @@ declare class VerdocsEndpoint {
      */
     onSessionChanged(listener: TSessionChangedListener): () => void;
     /**
-     * Load a persisted session from localStorage. Typically called once after the endpoint is configured when the app
-     * or component starts.
+     * Load a persisted session from localStorage. Typically called once after the endpoint is configured
+     * when the app or component starts.
      */
     loadSession(): VerdocsEndpoint;
 }

package/dist/index.js

@@ -795,9 +795,231 @@ var globalThis_1 = (function () {
 
 var globalThis$1 = /*@__PURE__*/getDefaultExportFromCjs(globalThis_1);
 
+/**
+ * Authenticate to Verdocs.
+ *
+ * ```typescript
+ * import {authenticate, VerdocsEndpoint} from '@verdocs/js-sdk';
+ *
+ * // Client-side call, suitable for Web and mobile apps:
+ * const {access_token} = await Auth.authenticate({ username: 'test@test.com', password: 'PASSWORD', grant_type:'password' });
+ * VerdocsEndpoint.getDefault().setAuthToken(access_token);
+ *
+ * // Server-side call, suitable for server apps. NEVER EXPOSE client_secret IN FRONT-END CODE:
+ * const {access_token} = await Auth.authenticate({ client_id: '...', client_secret: '...', grant_type:'client_credentials' });
+ * VerdocsEndpoint.getDefault().setAuthToken(access_token);
+ * ```
+ */
+const authenticate = (endpoint, params) => endpoint.api //
+    .post('/v2/oauth2/token', params)
+    .then((r) => r.data);
+/**
+ * If called before the session expires, this will refresh the caller's session and tokens.
+ *
+ * ```typescript
+ * import {Auth, VerdocsEndpoint} from '@verdocs/js-sdk';
+ *
+ * const {accessToken} = await Auth.refreshTokens();
+ * VerdocsEndpoint.setAuthToken(accessToken);
+ * ```
+ */
+const refreshToken = (endpoint, refreshToken) => authenticate(endpoint, { grant_type: 'refresh_token', refresh_token: refreshToken });
+/**
+ * Update the caller's password when the old password is known (typically for logged-in users).
+ *
+ * ```typescript
+ * import {changePassword} from '@verdocs/js-sdk';
+ *
+ * const {status, message} = await changePassword({ email, oldPassword, newPassword });
+ * if (status !== 'OK') {
+ *   window.alert(`Password reset error: ${message}`);
+ * }
+ * ```
+ */
+const changePassword = (endpoint, params) => endpoint.api //
+    .post('/v2/users/change-password', params)
+    .then((r) => r.data);
+/**
+ * Request a password reset, when the old password is not known (typically in login forms).
+ *
+ * ```typescript
+ * import {resetPassword} from '@verdocs/js-sdk';
+ *
+ * const {success} = await resetPassword({ email });
+ * if (status !== 'OK') {
+ *   window.alert(`Please check your email for instructions on how to reset your password.`);
+ * }
+ * ```
+ */
+const resetPassword = (endpoint, params) => endpoint.api //
+    .post('/v2/users/reset-password', params)
+    .then((r) => r.data);
+/**
+ * Resend the email verification request. Note that to prevent certain forms of abuse, the email address is not
+ * a parameter here. Instead, the caller must be authenticated as the (unverified) user. To simplify this process,
+ * the access token to be used may be passed directly as a parameter here. This avoids the need to set it as the
+ * active token on an endpoint, which may be inconvenient in workflows where it is preferable to keep the user in
+ * "anonymous" mode while verification is being performed.
+ *
+ * ```typescript
+ * import {resendVerification} from '@verdocs/js-sdk';
+ *
+ * const result = await resendVerification();
+ * ```
+ */
+const verifyEmail = (endpoint, email, code) => endpoint.api //
+    .post('/v2/users/verify-email', { email, code })
+    .then((r) => r.data);
+/**
+ * Resend the email verification request. Note that to prevent certain forms of abuse, the email address is not
+ * a parameter here. Instead, the caller must be authenticated as the (unverified) user. To simplify this process,
+ * the access token to be used may be passed directly as a parameter here. This avoids the need to set it as the
+ * active token on an endpoint, which may be inconvenient in workflows where it is preferable to keep the user in
+ * "anonymous" mode while verification is being performed.
+ *
+ * ```typescript
+ * import {resendVerification} from '@verdocs/js-sdk';
+ *
+ * const result = await resendVerification();
+ * ```
+ */
+const resendVerification = (endpoint, accessToken) => endpoint.api //
+    .post('/v2/users/resend-verification', {}, accessToken ? { headers: { Authorization: `Bearer ${accessToken}` } } : {})
+    .then((r) => r.data);
+
+const getNotifications = async (endpoint) => endpoint.api //
+    .get('/v2/notifications')
+    .then((r) => r.data);
+
+/**
+ * Get the user's available profiles. The current profile will be marked with `current: true`.
+ *
+ * ```typescript
+ * import {getProfiles} from '@verdocs/js-sdk';
+ *
+ * const profiles = await getProfiles();
+ * ```
+ */
+const getProfiles = (endpoint) => endpoint.api //
+    .get('/v2/profiles')
+    .then((r) => r.data);
+/**
+ * Get the user's available profiles. The current profile will be marked with `current: true`.
+ *
+ * ```typescript
+ * import {getCurrentProfile} from '@verdocs/js-sdk';
+ *
+ * const profiles = await getCurrentProfile(VerdocsEndpoint.getDefault());
+ * ```
+ */
+const getCurrentProfile = (endpoint) => endpoint.api //
+    .get('/v2/profiles')
+    .then((r) => (r.data || []).find((profile) => profile.current));
+/**
+ * Get a profile. The caller must have admin access to the given profile.
+ *
+ * ```typescript
+ * import {getProfile} from '@verdocs/js-sdk';
+ *
+ * const profile = await getProfile(VerdocsEndpoint.getDefault(), 'PROFILEID');
+ * ```
+ */
+const getProfile = (endpoint, profileId) => endpoint.api //
+    .get(`/v2/profiles/${profileId}`)
+    .then((r) => r.data);
+/**
+ * Switch the caller's "current" profile. The current profile is used for permissions checking
+ * and profile_id field settings for most operations in Verdocs. It is important to select the
+ * appropropriate profile before calling other API functions.
+ *
+ * ```typescript
+ * import {switchProfile} from '@verdocs/js-sdk';
+ *
+ * const newProfile = await switchProfile(VerdocsEndpoint.getDefault(), 'PROFILEID');
+ * ```
+ */
+const switchProfile = (endpoint, profileId) => endpoint.api //
+    .post(`/v2/profiles/${profileId}/switch`)
+    .then((r) => r.data);
+/**
+ * Update a profile. For future expansion, the profile ID to update is required, but currently
+ * this must also be the "current" profile for the caller.
+ *
+ * ```typescript
+ * import {updateProfile} from '@verdocs/js-sdk/Users';
+ *
+ * const newProfile = await updateProfile(VerdocsEndpoint.getDefault(), 'PROFILEID');
+ * ```
+ */
+const updateProfile = (endpoint, profileId, params) => endpoint.api //
+    .patch(`/v2/profiles/${profileId}`, params)
+    .then((r) => r.data);
+/**
+ * Delete a profile. If the requested profile is the caller's curent profile, the next
+ * available profile will be selected.
+ *
+ * ```typescript
+ * import {deleteProfile} from '@verdocs/js-sdk';
+ *
+ * await deleteProfile(VerdocsEndpoint.getDefault(), 'PROFILEID');
+ * ```
+ */
+const deleteProfile = (endpoint, profileId) => endpoint.api //
+    .delete(`/v2/profiles/${profileId}`)
+    .then((r) => r.data);
+/**
+ * Create a new user account. Note that there are two registration paths for creation:
+ *   - Get invited to an organization, by an admin or owner of that org.
+ *   - Created a new organization. The caller will become the first owner of the new org.
+ *
+ * This endpoint is for the second path, so an organization name is required. It is NOT
+ * required to be unique because it is very common for businesses to have the same names,
+ * without conflicting (e.g. "Delta" could be Delta Faucet or Delta Airlines).
+ *
+ * The new profile will automatically be set as the user's "current" profile, and new
+ * session tokens will be returned to the caller. However, the caller's email may not yet
+ * be verified. In that case, the caller will not yet be able to call other endpoints in
+ * the Verdocs API. The caller will need to check their email for a verification code,
+ * which should be submitted via the `verifyEmail` endpoint.
+ *
+ * ```typescript
+ * import {createProfile} from '@verdocs/js-sdk';
+ *
+ * const newSession = await createProfile(VerdocsEndpoint.getDefault(), {
+ *   orgName: 'NEW ORG', email: 'a@b.com', password: '12345678', firstName: 'FIRST', lastName: 'LAST'
+ * });
+ * ```
+ */
+const createProfile = (endpoint, params) => endpoint.api //
+    .post('/v2/profiles', params)
+    .then((r) => r.data);
+/**
+ * Update the caller's profile photo. This can only be called for the user's "current" profile.
+ *
+ * ```typescript
+ * import {uploadProfilePhoto} from '@verdocs/js-sdk';
+ *
+ * await uploadProfilePhoto((VerdocsEndpoint.getDefault(), profileId, file);
+ * ```
+ */
+const updateProfilePhoto = (endpoint, profileId, file, onUploadProgress) => {
+    const formData = new FormData();
+    formData.append('picture', file, file.name);
+    return endpoint.api //
+        .patch(`/v2/profiles/${profileId}`, formData, {
+        timeout: 120000,
+        onUploadProgress: (event) => {
+            const total = event.total || 1;
+            const loaded = event.loaded || 0;
+            onUploadProgress?.(Math.floor((loaded * 100) / (total || 1)), loaded, total || 1);
+        },
+    })
+        .then((r) => r.data);
+};
+
 // @credit https://derickbailey.com/2016/03/09/creating-a-true-singleton-in-node-js-with-es6-symbols/
 // Also see globalThis for comments about why we're doing this in the first place.
-const ENDPOINT_KEY = Symbol.for('vƒbaseerdocs-default-endpoint');
+const ENDPOINT_KEY = Symbol.for('verdocs-default-endpoint');
 const requestLogger = (r) => {
     // tslint:disable-next-line
     console.debug(`[JS-SDK] ${r.method.toUpperCase()} ${r.baseURL}${r.url}`, r.data ? JSON.stringify(r.data) : '');
@@ -845,6 +1067,13 @@ class VerdocsEndpoint {
      * with Envelopes.
      */
     session = null;
+    /**
+     * The current user's profile, if known. Note that while sessions are loaded and handled synchronously,
+     * profiles are loaded asynchronously and may not be available immediately after a session is loaded.
+     * To ensure both are available, developers should subscribe to the `onSessionChanged` event, which
+     * will not be fired until the profile is loaded and verified.
+     */
+    profile = null;
     api;
     /**
      * Create a new VerdocsEndpoint to call Verdocs platform services.
@@ -1063,7 +1292,17 @@ class VerdocsEndpoint {
             this.api.defaults.headers.common.signer = `Bearer ${token}`;
         }
         localStorage.setItem(this.sessionStorageKey(), token);
-        this.notifySessionListeners();
+        getCurrentProfile(this)
+            .then((r) => {
+            window?.console?.debug('[JS_SDK] Loaded profile', r);
+            this.profile = r || null;
+            this.notifySessionListeners();
+        })
+            .catch((e) => {
+            this.profile = null;
+            window?.console?.warn('Unable to load profile', e);
+            this.notifySessionListeners();
+        });
         return this;
     }
     /**
@@ -1084,6 +1323,7 @@ class VerdocsEndpoint {
         delete this.api.defaults.headers.common.Authorization;
         delete this.api.defaults.headers.common.signer;
         this.session = null;
+        this.profile = null;
         this.token = null;
         this.notifySessionListeners();
         return this;
@@ -1095,6 +1335,7 @@ class VerdocsEndpoint {
         localStorage.removeItem(this.sessionStorageKey());
         delete this.api.defaults.headers.common.Authorization;
         this.session = null;
+        this.profile = null;
         this.token = null;
         this.notifySessionListeners();
         return this;
@@ -1102,7 +1343,7 @@ class VerdocsEndpoint {
     notifySessionListeners() {
         this.sessionListeners.forEach((listener) => {
             try {
-                listener(this, this.session);
+                listener(this, this.session, this.profile);
             }
             catch (e) {
                 // NOOP
@@ -1122,8 +1363,8 @@ class VerdocsEndpoint {
         };
     }
     /**
-     * Load a persisted session from localStorage. Typically called once after the endpoint is configured when the app
-     * or component starts.
+     * Load a persisted session from localStorage. Typically called once after the endpoint is configured
+     * when the app or component starts.
      */
     loadSession() {
         const token = localStorage.getItem(this.sessionStorageKey());
@@ -2627,228 +2868,6 @@ 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;
 
-/**
- * Authenticate to Verdocs.
- *
- * ```typescript
- * import {authenticate, VerdocsEndpoint} from '@verdocs/js-sdk';
- *
- * // Client-side call, suitable for Web and mobile apps:
- * const {access_token} = await Auth.authenticate({ username: 'test@test.com', password: 'PASSWORD', grant_type:'password' });
- * VerdocsEndpoint.getDefault().setAuthToken(access_token);
- *
- * // Server-side call, suitable for server apps. NEVER EXPOSE client_secret IN FRONT-END CODE:
- * const {access_token} = await Auth.authenticate({ client_id: '...', client_secret: '...', grant_type:'client_credentials' });
- * VerdocsEndpoint.getDefault().setAuthToken(access_token);
- * ```
- */
-const authenticate = (endpoint, params) => endpoint.api //
-    .post('/v2/oauth2/token', params)
-    .then((r) => r.data);
-/**
- * If called before the session expires, this will refresh the caller's session and tokens.
- *
- * ```typescript
- * import {Auth, VerdocsEndpoint} from '@verdocs/js-sdk';
- *
- * const {accessToken} = await Auth.refreshTokens();
- * VerdocsEndpoint.setAuthToken(accessToken);
- * ```
- */
-const refreshToken = (endpoint, refreshToken) => authenticate(endpoint, { grant_type: 'refresh_token', refresh_token: refreshToken });
-/**
- * Update the caller's password when the old password is known (typically for logged-in users).
- *
- * ```typescript
- * import {changePassword} from '@verdocs/js-sdk';
- *
- * const {status, message} = await changePassword({ email, oldPassword, newPassword });
- * if (status !== 'OK') {
- *   window.alert(`Password reset error: ${message}`);
- * }
- * ```
- */
-const changePassword = (endpoint, params) => endpoint.api //
-    .post('/v2/users/change-password', params)
-    .then((r) => r.data);
-/**
- * Request a password reset, when the old password is not known (typically in login forms).
- *
- * ```typescript
- * import {resetPassword} from '@verdocs/js-sdk';
- *
- * const {success} = await resetPassword({ email });
- * if (status !== 'OK') {
- *   window.alert(`Please check your email for instructions on how to reset your password.`);
- * }
- * ```
- */
-const resetPassword = (endpoint, params) => endpoint.api //
-    .post('/v2/users/reset-password', params)
-    .then((r) => r.data);
-/**
- * Resend the email verification request. Note that to prevent certain forms of abuse, the email address is not
- * a parameter here. Instead, the caller must be authenticated as the (unverified) user. To simplify this process,
- * the access token to be used may be passed directly as a parameter here. This avoids the need to set it as the
- * active token on an endpoint, which may be inconvenient in workflows where it is preferable to keep the user in
- * "anonymous" mode while verification is being performed.
- *
- * ```typescript
- * import {resendVerification} from '@verdocs/js-sdk';
- *
- * const result = await resendVerification();
- * ```
- */
-const verifyEmail = (endpoint, email, code) => endpoint.api //
-    .post('/v2/users/verify-email', { email, code })
-    .then((r) => r.data);
-/**
- * Resend the email verification request. Note that to prevent certain forms of abuse, the email address is not
- * a parameter here. Instead, the caller must be authenticated as the (unverified) user. To simplify this process,
- * the access token to be used may be passed directly as a parameter here. This avoids the need to set it as the
- * active token on an endpoint, which may be inconvenient in workflows where it is preferable to keep the user in
- * "anonymous" mode while verification is being performed.
- *
- * ```typescript
- * import {resendVerification} from '@verdocs/js-sdk';
- *
- * const result = await resendVerification();
- * ```
- */
-const resendVerification = (endpoint, accessToken) => endpoint.api //
-    .post('/v2/users/resend-verification', {}, accessToken ? { headers: { Authorization: `Bearer ${accessToken}` } } : {})
-    .then((r) => r.data);
-
-const getNotifications = async (endpoint) => endpoint.api //
-    .get('/v2/notifications')
-    .then((r) => r.data);
-
-/**
- * Get the user's available profiles. The current profile will be marked with `current: true`.
- *
- * ```typescript
- * import {getProfiles} from '@verdocs/js-sdk';
- *
- * const profiles = await getProfiles();
- * ```
- */
-const getProfiles = (endpoint) => endpoint.api //
-    .get('/v2/profiles')
-    .then((r) => r.data);
-/**
- * Get the user's available profiles. The current profile will be marked with `current: true`.
- *
- * ```typescript
- * import {getCurrentProfile} from '@verdocs/js-sdk';
- *
- * const profiles = await getCurrentProfile(VerdocsEndpoint.getDefault());
- * ```
- */
-const getCurrentProfile = (endpoint) => endpoint.api //
-    .get('/v2/profiles')
-    .then((r) => (r.data || []).find((profile) => profile.current));
-/**
- * Get a profile. The caller must have admin access to the given profile.
- *
- * ```typescript
- * import {getProfile} from '@verdocs/js-sdk';
- *
- * const profile = await getProfile(VerdocsEndpoint.getDefault(), 'PROFILEID');
- * ```
- */
-const getProfile = (endpoint, profileId) => endpoint.api //
-    .get(`/v2/profiles/${profileId}`)
-    .then((r) => r.data);
-/**
- * Switch the caller's "current" profile. The current profile is used for permissions checking
- * and profile_id field settings for most operations in Verdocs. It is important to select the
- * appropropriate profile before calling other API functions.
- *
- * ```typescript
- * import {switchProfile} from '@verdocs/js-sdk';
- *
- * const newProfile = await switchProfile(VerdocsEndpoint.getDefault(), 'PROFILEID');
- * ```
- */
-const switchProfile = (endpoint, profileId) => endpoint.api //
-    .post(`/v2/profiles/${profileId}/switch`)
-    .then((r) => r.data);
-/**
- * Update a profile. For future expansion, the profile ID to update is required, but currently
- * this must also be the "current" profile for the caller.
- *
- * ```typescript
- * import {updateProfile} from '@verdocs/js-sdk/Users';
- *
- * const newProfile = await updateProfile(VerdocsEndpoint.getDefault(), 'PROFILEID');
- * ```
- */
-const updateProfile = (endpoint, profileId, params) => endpoint.api //
-    .patch(`/v2/profiles/${profileId}`, params)
-    .then((r) => r.data);
-/**
- * Delete a profile. If the requested profile is the caller's curent profile, the next
- * available profile will be selected.
- *
- * ```typescript
- * import {deleteProfile} from '@verdocs/js-sdk';
- *
- * await deleteProfile(VerdocsEndpoint.getDefault(), 'PROFILEID');
- * ```
- */
-const deleteProfile = (endpoint, profileId) => endpoint.api //
-    .delete(`/v2/profiles/${profileId}`)
-    .then((r) => r.data);
-/**
- * Create a new user account. Note that there are two registration paths for creation:
- *   - Get invited to an organization, by an admin or owner of that org.
- *   - Created a new organization. The caller will become the first owner of the new org.
- *
- * This endpoint is for the second path, so an organization name is required. It is NOT
- * required to be unique because it is very common for businesses to have the same names,
- * without conflicting (e.g. "Delta" could be Delta Faucet or Delta Airlines).
- *
- * The new profile will automatically be set as the user's "current" profile, and new
- * session tokens will be returned to the caller. However, the caller's email may not yet
- * be verified. In that case, the caller will not yet be able to call other endpoints in
- * the Verdocs API. The caller will need to check their email for a verification code,
- * which should be submitted via the `verifyEmail` endpoint.
- *
- * ```typescript
- * import {createProfile} from '@verdocs/js-sdk';
- *
- * const newSession = await createProfile(VerdocsEndpoint.getDefault(), {
- *   orgName: 'NEW ORG', email: 'a@b.com', password: '12345678', firstName: 'FIRST', lastName: 'LAST'
- * });
- * ```
- */
-const createProfile = (endpoint, params) => endpoint.api //
-    .post('/v2/profiles', params)
-    .then((r) => r.data);
-/**
- * Update the caller's profile photo. This can only be called for the user's "current" profile.
- *
- * ```typescript
- * import {uploadProfilePhoto} from '@verdocs/js-sdk';
- *
- * await uploadProfilePhoto((VerdocsEndpoint.getDefault(), profileId, file);
- * ```
- */
-const updateProfilePhoto = (endpoint, profileId, file, onUploadProgress) => {
-    const formData = new FormData();
-    formData.append('picture', file, file.name);
-    return endpoint.api //
-        .patch(`/v2/profiles/${profileId}`, formData, {
-        timeout: 120000,
-        onUploadProgress: (event) => {
-            const total = event.total || 1;
-            const loaded = event.loaded || 0;
-            onUploadProgress?.(Math.floor((loaded * 100) / (total || 1)), loaded, total || 1);
-        },
-    })
-        .then((r) => r.data);
-};
-
 exports.AtoB = AtoB;
 exports.Countries = Countries;
 exports.VerdocsEndpoint = VerdocsEndpoint;