@verdocs/js-sdk 2.0.0 → 2.0.3

package/Users/Profiles.d.ts

@@ -1,4 +1,5 @@
-import { ICreateProfileRequest, IUpdateProfileRequest } from './Types';
+import { ICreateProfileRequest, IPermission, IProfile, IRole, ISwitchProfileResponse, IUpdateProfileRequest } from './Types';
+import { IGroup } from '../Organizations/Types';
 import { VerdocsEndpoint } from '../VerdocsEndpoint';
 /**
  * Get the user's available profiles. The current profile will be marked with `current: true`.
@@ -9,7 +10,17 @@ import { VerdocsEndpoint } from '../VerdocsEndpoint';
  * const profiles = await Profiles.getProfiles()
  * ```
  */
-export declare const getProfiles: (endpoint: VerdocsEndpoint) => Promise<any>;
+export declare const getProfiles: (endpoint: VerdocsEndpoint) => Promise<IProfile[]>;
+/**
+ * Get the user's available profiles. The current profile will be marked with `current: true`.
+ *
+ * ```typescript
+ * import {Profiles} from '@verdocs/js-sdk/Users';
+ *
+ * const profiles = await Profiles.getCurrentProfile()
+ * ```
+ */
+export declare const getCurrentProfile: (endpoint: VerdocsEndpoint) => Promise<IProfile | undefined>;
 /**
  * Get a list of system roles.
  *
@@ -19,7 +30,7 @@ export declare const getProfiles: (endpoint: VerdocsEndpoint) => Promise<any>;
  * const roles = await Profiles.getRoles();
  * ```
  */
-export declare const getRoles: (endpoint: VerdocsEndpoint) => Promise<any>;
+export declare const getRoles: (endpoint: VerdocsEndpoint) => Promise<IRole[]>;
 /**
  * Get a list of system roles.
  *
@@ -39,7 +50,7 @@ export declare const getPermissions: (endpoint: VerdocsEndpoint) => Promise<any>
  * const newProfile = await Profiles.createProfile({ first_name: 'FIRST', last_name: 'LAST', email: 'EMAIL' });
  * ```
  */
-export declare const createProfile: (endpoint: VerdocsEndpoint, params: ICreateProfileRequest) => Promise<any>;
+export declare const createProfile: (endpoint: VerdocsEndpoint, params: ICreateProfileRequest) => Promise<IProfile>;
 /**
  * Get a profile. The caller must have admin access to the given profile.
  * TODO: Add a "public" profile endpoint for public pages
@@ -50,7 +61,7 @@ export declare const createProfile: (endpoint: VerdocsEndpoint, params: ICreateP
  * const profile = await Profiles.getProfile('PROFILEID');
  * ```
  */
-export declare const getProfile: (endpoint: VerdocsEndpoint, profileId: string) => Promise<any>;
+export declare const getProfile: (endpoint: VerdocsEndpoint, profileId: string) => Promise<IProfile>;
 /**
  * Get a profile's permissions. The caller must have admin access to the given profile.
  *
@@ -60,7 +71,7 @@ export declare const getProfile: (endpoint: VerdocsEndpoint, profileId: string)
  * const permissions = await Profiles.getProfilePermissions('PROFILEID');
  * ```
  */
-export declare const getProfilePermissions: (endpoint: VerdocsEndpoint, profileId: string) => Promise<any>;
+export declare const getProfilePermissions: (endpoint: VerdocsEndpoint, profileId: string) => Promise<IPermission[]>;
 /**
  * Get a profile's groups.
  *
@@ -70,7 +81,7 @@ export declare const getProfilePermissions: (endpoint: VerdocsEndpoint, profileI
  * const groups = await Profiles.getProfileGroups('PROFILEID');
  * ```
  */
-export declare const getProfileGroups: (endpoint: VerdocsEndpoint, profileId: string) => Promise<any>;
+export declare const getProfileGroups: (endpoint: VerdocsEndpoint, profileId: string) => Promise<IGroup[]>;
 /**
  * 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.
@@ -81,7 +92,7 @@ export declare const getProfileGroups: (endpoint: VerdocsEndpoint, profileId: st
  * const newProfile = await Profiles.switchProfile('PROFILEID');
  * ```
  */
-export declare const switchProfile: (endpoint: VerdocsEndpoint, profileId: string) => Promise<any>;
+export declare const switchProfile: (endpoint: VerdocsEndpoint, profileId: string) => Promise<ISwitchProfileResponse>;
 /**
  * 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.
@@ -92,7 +103,7 @@ export declare const switchProfile: (endpoint: VerdocsEndpoint, profileId: strin
  * const newProfile = await Profiles.updateProfile('PROFILEID');
  * ```
  */
-export declare const updateProfile: (endpoint: VerdocsEndpoint, profileId: string, params: IUpdateProfileRequest) => Promise<any>;
+export declare const updateProfile: (endpoint: VerdocsEndpoint, profileId: string, params: IUpdateProfileRequest) => Promise<IProfile>;
 /**
  * Delete a profile. If the requested profile is the caller's curent profile, the next available profile will be selected.
  *

package/Users/Profiles.js

@@ -12,6 +12,20 @@ export var getProfiles = function (endpoint) {
         .get('/profiles')
         .then(function (r) { return r.data; });
 };
+/**
+ * Get the user's available profiles. The current profile will be marked with `current: true`.
+ *
+ * ```typescript
+ * import {Profiles} from '@verdocs/js-sdk/Users';
+ *
+ * const profiles = await Profiles.getCurrentProfile()
+ * ```
+ */
+export var getCurrentProfile = function (endpoint) {
+    return endpoint.api //
+        .get('/profiles')
+        .then(function (r) { return (r.data || []).find(function (profile) { return profile.current; }); });
+};
 /**
  * Get a list of system roles.
  *

package/VerdocsEndpoint.d.ts

@@ -5,7 +5,7 @@ import * as Documents from './Documents';
 export declare type TEnvironment = 'verdocs' | 'verdocs-stage';
 export declare type TSessionType = 'user' | 'signing';
 export declare type TSession = IActiveSession | ISigningSession | null;
-export declare type SessionChangedListener = (endpoint: VerdocsEndpoint, session: IActiveSession | ISigningSession | null) => void;
+export declare type TSessionChangedListener = (endpoint: VerdocsEndpoint, session: TSession) => void;
 export interface VerdocsEndpointOptions {
     baseURL?: string;
     timeout?: number;
@@ -40,11 +40,16 @@ export declare class VerdocsEndpoint {
     private baseURL;
     private clientID;
     private timeout;
-    private session;
     private token;
     private nextListenerId;
     private sessionListeners;
     private requestLoggerId;
+    /**
+     * The current user session, or null if not authenticated. May be either a User or Signing session. If set, the
+     * presence of the `document_id` field can be used to differentiate the types. Only signing sessions are associated
+     * with Documents.
+     */
+    session: TSession;
     api: AxiosInstance;
     Documents: typeof Documents;
     /**
@@ -57,7 +62,7 @@ export declare class VerdocsEndpoint {
      */
     constructor(options?: VerdocsEndpointOptions);
     setDefault(): void;
-    static getDefault(): any;
+    static getDefault(): VerdocsEndpoint;
     /**
      * Get the current environment.
      */
@@ -179,10 +184,10 @@ export declare class VerdocsEndpoint {
     /**
      * Subscribe to session state change events.
      */
-    onSessionChanged(listener: SessionChangedListener): () => void;
+    onSessionChanged(listener: TSessionChangedListener): () => void;
     /**
      * Load a persisted session from localStorage. Typically called once after the endpoint is configured when the app
      * or component starts.
      */
-    loadSession(source: string): VerdocsEndpoint;
+    loadSession(): VerdocsEndpoint;
 }

package/VerdocsEndpoint.js

@@ -43,11 +43,16 @@ var VerdocsEndpoint = /** @class */ (function () {
         this.baseURL = 'https://api.verdocs.com';
         this.clientID = 'not-set';
         this.timeout = 3000;
-        this.session = null;
         this.token = null;
         this.nextListenerId = 0;
         this.sessionListeners = new Map();
         this.requestLoggerId = null;
+        /**
+         * The current user session, or null if not authenticated. May be either a User or Signing session. If set, the
+         * presence of the `document_id` field can be used to differentiate the types. Only signing sessions are associated
+         * with Documents.
+         */
+        this.session = null;
         this.Documents = Documents;
         this.baseURL = (options === null || options === void 0 ? void 0 : options.baseURL) || 'https://api.verdocs.com';
         this.timeout = (options === null || options === void 0 ? void 0 : options.timeout) || 3000;
@@ -267,7 +272,7 @@ var VerdocsEndpoint = /** @class */ (function () {
      * Load a persisted session from localStorage. Typically called once after the endpoint is configured when the app
      * or component starts.
      */
-    VerdocsEndpoint.prototype.loadSession = function (source) {
+    VerdocsEndpoint.prototype.loadSession = function () {
         var token = localStorage.getItem(this.sessionStorageKey());
         if (!token) {
             return this.clearSession();

package/index.d.ts

@@ -4,6 +4,7 @@
  * - Documents - An individual document to be signed. Documents are created from templates.
  * - HTTP - General support functionality for Verdocs' REST endpoints. Typically not used directly.
  * - Organizations - An Organization is a container for user profiles, templates, documents, billing, and other related objects.
+ * - Search - Various methods used to retrieve lists of documents and templtes.
  * - Templates - A template for a document containing a PDF file, metadata for signature fields, and other information.
  * - Users - All operations related to authentication and user-related operations.
  * - Utils - General support functions used by the other modules and exported for convenience.
@@ -13,6 +14,7 @@
 export * as Documents from './Documents';
 export * as Templates from './Templates';
 export * as Organizations from './Organizations';
+export * as Search from './Search';
 export * as Users from './Users';
 export * as Utils from './Utils';
 export * from './VerdocsEndpoint';

package/index.js

@@ -4,6 +4,7 @@
  * - Documents - An individual document to be signed. Documents are created from templates.
  * - HTTP - General support functionality for Verdocs' REST endpoints. Typically not used directly.
  * - Organizations - An Organization is a container for user profiles, templates, documents, billing, and other related objects.
+ * - Search - Various methods used to retrieve lists of documents and templtes.
  * - Templates - A template for a document containing a PDF file, metadata for signature fields, and other information.
  * - Users - All operations related to authentication and user-related operations.
  * - Utils - General support functions used by the other modules and exported for convenience.
@@ -13,6 +14,7 @@
 export * as Documents from './Documents';
 export * as Templates from './Templates';
 export * as Organizations from './Organizations';
+export * as Search from './Search';
 export * as Users from './Users';
 export * as Utils from './Utils';
 export * from './VerdocsEndpoint';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdocs/js-sdk",
-  "version": "2.0.0",
+  "version": "2.0.3",
   "private": false,
   "homepage": "https://github.com/Verdocs/js-sdk",
   "description": "Verdocs JS SDK",
@@ -39,7 +39,7 @@
     "docs": "npm run docs-md && npm run docs-html",
     "clear-docs": "aws --profile=verdocs cloudfront create-invalidation --distribution-id E29UFGU4KEH1GQ --paths \"/*\"",
     "deploy-docs": "npm run docs && aws --profile=verdocs s3 sync --acl public-read --delete docs-html s3://verdocs-developers-js-sdk/ && yarn clear-docs",
-    "clean": "rm -rf Documents HTTP Organizations Search Templates Users Utils index.js index.d.ts docs docs-html"
+    "clean": "rm -rf Documents HTTP Organizations Search Templates Users Utils index.js index.d.ts VerdocsEndpoint.* docs docs-html"
   },
   "publishConfig": {
     "access": "public"