@verdocs/js-sdk 1.4.1 → 2.0.2

package/Templates/Stars.d.ts

@@ -1,3 +1,4 @@
 import { IStar, ITemplatesSummary } from './Types';
-export declare const getStars: (templateId: string) => Promise<IStar[]>;
-export declare const toggleStar: (templateId: string) => Promise<ITemplatesSummary>;
+import { VerdocsEndpoint } from '../VerdocsEndpoint';
+export declare const getStars: (endpoint: VerdocsEndpoint, templateId: string) => Promise<IStar[]>;
+export declare const toggleStar: (endpoint: VerdocsEndpoint, templateId: string) => Promise<ITemplatesSummary>;

package/Templates/Stars.js

@@ -1,11 +1,10 @@
-import { getEndpoint } from '../HTTP/Transport';
-export var getStars = function (templateId) {
-    return getEndpoint()
-        .api.get("/templates/".concat(templateId, "/stars/"))
+export var getStars = function (endpoint, templateId) {
+    return endpoint.api //
+        .get("/templates/".concat(templateId, "/stars/"))
         .then(function (r) { return r.data; });
 };
-export var toggleStar = function (templateId) {
-    return getEndpoint()
-        .api.get("/templates/".concat(templateId, "/stars/toggle"))
+export var toggleStar = function (endpoint, templateId) {
+    return endpoint.api //
+        .get("/templates/".concat(templateId, "/stars/toggle"))
         .then(function (r) { return r.data; });
 };

package/Templates/Tags.d.ts

@@ -6,27 +6,28 @@
  * @module
  */
 import { ITemplateTag, ITag } from './Types';
+import { VerdocsEndpoint } from '../VerdocsEndpoint';
 /**
  * Apply a tag to a template.
  */
-export declare const addTemplateTag: (templateId: string, params: ITag) => Promise<ITemplateTag>;
+export declare const addTemplateTag: (endpoint: VerdocsEndpoint, templateId: string, params: ITag) => Promise<ITemplateTag>;
 /**
  * Get all tags for a template.
  */
-export declare const getTemplateTags: (templateId: string) => Promise<ITemplateTag[]>;
+export declare const getTemplateTags: (endpoint: VerdocsEndpoint, templateId: string) => Promise<ITemplateTag[]>;
 /**
  * Remove a tag from a template.
  */
-export declare const deleteTemplateTag: (templateId: string, tagName: string) => Promise<any>;
+export declare const deleteTemplateTag: (endpoint: VerdocsEndpoint, templateId: string, tagName: string) => Promise<any>;
 /**
  * Create an Organization-wide tag.
  */
-export declare const createTag: (name: string) => Promise<ITag>;
+export declare const createTag: (endpoint: VerdocsEndpoint, name: string) => Promise<ITag>;
 /**
  * Get an Organization-wide tag.
  */
-export declare const getTag: (name: string) => Promise<ITag>;
+export declare const getTag: (endpoint: VerdocsEndpoint, name: string) => Promise<ITag>;
 /**
  * Get all tags available for use by an Organization.
  */
-export declare const getAllTags: () => Promise<ITag[]>;
+export declare const getAllTags: (endpoint: VerdocsEndpoint) => Promise<ITag[]>;

package/Templates/Tags.js

@@ -5,52 +5,51 @@
  *
  * @module
  */
-import { getEndpoint } from '../HTTP/Transport';
 /**
  * Apply a tag to a template.
  */
-export var addTemplateTag = function (templateId, params) {
-    return getEndpoint()
-        .api.post("/templates/".concat(templateId, "/tags/"), params)
+export var addTemplateTag = function (endpoint, templateId, params) {
+    return endpoint.api //
+        .post("/templates/".concat(templateId, "/tags/"), params)
         .then(function (r) { return r.data; });
 };
 /**
  * Get all tags for a template.
  */
-export var getTemplateTags = function (templateId) {
-    return getEndpoint()
-        .api.get("/templates/".concat(templateId, "/tags/"))
+export var getTemplateTags = function (endpoint, templateId) {
+    return endpoint.api //
+        .get("/templates/".concat(templateId, "/tags/"))
         .then(function (r) { return r.data; });
 };
 /**
  * Remove a tag from a template.
  */
-export var deleteTemplateTag = function (templateId, tagName) {
-    return getEndpoint()
-        .api.post("/templates/".concat(templateId, "/tags/").concat(tagName))
+export var deleteTemplateTag = function (endpoint, templateId, tagName) {
+    return endpoint.api //
+        .post("/templates/".concat(templateId, "/tags/").concat(tagName))
         .then(function (r) { return r.data; });
 };
 /**
  * Create an Organization-wide tag.
  */
-export var createTag = function (name) {
-    return getEndpoint()
-        .api.post('/tags', { tag_name: name })
+export var createTag = function (endpoint, name) {
+    return endpoint.api //
+        .post('/tags', { tag_name: name })
         .then(function (r) { return r.data; });
 };
 /**
  * Get an Organization-wide tag.
  */
-export var getTag = function (name) {
-    return getEndpoint()
-        .api.get("/tags/".concat(name))
+export var getTag = function (endpoint, name) {
+    return endpoint.api //
+        .get("/tags/".concat(name))
         .then(function (r) { return r.data; });
 };
 /**
  * Get all tags available for use by an Organization.
  */
-export var getAllTags = function () {
-    return getEndpoint()
-        .api.get('/tags')
+export var getAllTags = function (endpoint) {
+    return endpoint.api //
+        .get('/tags')
         .then(function (r) { return r.data; });
 };

package/Templates/TemplateDocuments.d.ts

@@ -3,6 +3,7 @@
  *
  * @module
  */
+import { VerdocsEndpoint } from '../VerdocsEndpoint';
 import { ITemplateDocument } from './Types';
 /**
  * Get all the Template Documents associated to a particular Template.
@@ -13,7 +14,7 @@ import { ITemplateDocument } from './Types';
  * await TemplateDocument.getDocuments(templateID);
  * ```
  */
-export declare const getTemplateDocuments: (templateId: string) => Promise<ITemplateDocument[]>;
+export declare const getTemplateDocuments: (endpoint: VerdocsEndpoint, templateId: string) => Promise<ITemplateDocument[]>;
 /**
  * Create a Document for a particular Template.
  *
@@ -23,7 +24,7 @@ export declare const getTemplateDocuments: (templateId: string) => Promise<ITemp
  * await TemplateDocument.createDocument(templateID, params);
  * ```
  */
-export declare const createTemplateDocument: (templateId: string, params: any) => Promise<ITemplateDocument>;
+export declare const createTemplateDocument: (endpoint: VerdocsEndpoint, templateId: string, params: any) => Promise<ITemplateDocument>;
 /**
  * Get a specific Document.
  *
@@ -33,7 +34,7 @@ export declare const createTemplateDocument: (templateId: string, params: any) =
  * await TemplateDocument.getDocument(templateID, documentID);
  * ```
  */
-export declare const getTemplateDocument: (templateId: string, documentId: string) => Promise<ITemplateDocument>;
+export declare const getTemplateDocument: (endpoint: VerdocsEndpoint, templateId: string, documentId: string) => Promise<ITemplateDocument>;
 /**
  * Delete a specific Document.
  *
@@ -43,4 +44,4 @@ export declare const getTemplateDocument: (templateId: string, documentId: strin
  * await TemplateDocument.deleteDocument(templateID, documentID);
  * ```
  */
-export declare const deleteTemplateDocument: (templateId: string, documentId: string) => Promise<any>;
+export declare const deleteTemplateDocument: (endpoint: VerdocsEndpoint, templateId: string, documentId: string) => Promise<any>;

package/Templates/TemplateDocuments.js

@@ -3,7 +3,6 @@
  *
  * @module
  */
-import { getEndpoint } from '../HTTP/Transport';
 /**
  * Get all the Template Documents associated to a particular Template.
  *
@@ -13,9 +12,9 @@ import { getEndpoint } from '../HTTP/Transport';
  * await TemplateDocument.getDocuments(templateID);
  * ```
  */
-export var getTemplateDocuments = function (templateId) {
-    return getEndpoint()
-        .api.get("/templates/".concat(templateId, "/documents/"))
+export var getTemplateDocuments = function (endpoint, templateId) {
+    return endpoint.api //
+        .get("/templates/".concat(templateId, "/documents/"))
         .then(function (r) { return r.data; });
 };
 /**
@@ -27,9 +26,9 @@ export var getTemplateDocuments = function (templateId) {
  * await TemplateDocument.createDocument(templateID, params);
  * ```
  */
-export var createTemplateDocument = function (templateId, params) {
-    return getEndpoint()
-        .api.post("/templates/".concat(templateId, "/documents/"), params)
+export var createTemplateDocument = function (endpoint, templateId, params) {
+    return endpoint.api //
+        .post("/templates/".concat(templateId, "/documents/"), params)
         .then(function (r) { return r.data; });
 };
 /**
@@ -41,9 +40,9 @@ export var createTemplateDocument = function (templateId, params) {
  * await TemplateDocument.getDocument(templateID, documentID);
  * ```
  */
-export var getTemplateDocument = function (templateId, documentId) {
-    return getEndpoint()
-        .api.get("/templates/".concat(templateId, "/documents/").concat(documentId))
+export var getTemplateDocument = function (endpoint, templateId, documentId) {
+    return endpoint.api //
+        .get("/templates/".concat(templateId, "/documents/").concat(documentId))
         .then(function (r) { return r.data; });
 };
 /**
@@ -55,8 +54,8 @@ export var getTemplateDocument = function (templateId, documentId) {
  * await TemplateDocument.deleteDocument(templateID, documentID);
  * ```
  */
-export var deleteTemplateDocument = function (templateId, documentId) {
-    return getEndpoint()
-        .api.delete("/templates/".concat(templateId, "/documents/").concat(documentId))
+export var deleteTemplateDocument = function (endpoint, templateId, documentId) {
+    return endpoint.api //
+        .delete("/templates/".concat(templateId, "/documents/").concat(documentId))
         .then(function (r) { return r.data; });
 };

package/Templates/Templates.d.ts

@@ -5,6 +5,7 @@
  * @module
  */
 import { ITemplate, ITemplatesSearchResult, ITemplatesSummary } from './Types';
+import { VerdocsEndpoint } from '../VerdocsEndpoint';
 export interface IGetTemplatesParams {
     is_starred?: boolean;
     is_creator?: boolean;
@@ -22,7 +23,7 @@ export interface IGetTemplatesParams {
  * await Templates.getTemplates({ is_organization: true });
  * ```
  */
-export declare const getTemplates: (params?: IGetTemplatesParams) => Promise<any[]>;
+export declare const getTemplates: (endpoint: VerdocsEndpoint, params?: IGetTemplatesParams) => Promise<any[]>;
 /**
  * Get one template by its ID.
  *
@@ -32,7 +33,7 @@ export declare const getTemplates: (params?: IGetTemplatesParams) => Promise<any
  * const template = await Templates.getTemplate('83da3d70-7857-4392-b876-c4592a304bc9');
  * ```
  */
-export declare const getTemplate: (templateId: string) => Promise<any>;
+export declare const getTemplate: (endpoint: VerdocsEndpoint, templateId: string) => Promise<any>;
 /**
  * Create a template.
  *
@@ -42,7 +43,7 @@ export declare const getTemplate: (templateId: string) => Promise<any>;
  * const newTemplate = await Templates.createTemplate({...});
  * ```
  */
-export declare const createTemplate: (params: any) => Promise<ITemplate>;
+export declare const createTemplate: (endpoint: VerdocsEndpoint, params: any) => Promise<ITemplate>;
 /**
  * Update a template.
  *
@@ -52,7 +53,7 @@ export declare const createTemplate: (params: any) => Promise<ITemplate>;
  * const updatedTemplate = await Templates.updateTemplate('83da3d70-7857-4392-b876-c4592a304bc9', { name: 'New Name' });
  * ```
  */
-export declare const updateTemplate: (templateId: string, params: any) => Promise<ITemplate>;
+export declare const updateTemplate: (endpoint: VerdocsEndpoint, templateId: string, params: any) => Promise<ITemplate>;
 /**
  * Search for templates matching various criteria.
  *
@@ -62,7 +63,7 @@ export declare const updateTemplate: (templateId: string, params: any) => Promis
  * const {result, page, total} = await Templates.search({ ... });
  * ```
  */
-export declare const searchTemplates: (params: any) => Promise<ITemplatesSearchResult>;
+export declare const searchTemplates: (endpoint: VerdocsEndpoint, params: any) => Promise<ITemplatesSearchResult>;
 /**
  * Get a summary of template data, typically used to populate admin panel dashboard pages.
  *
@@ -72,4 +73,4 @@ export declare const searchTemplates: (params: any) => Promise<ITemplatesSearchR
  * const summary = await Templates.getSummary(0);
  * ```
  */
-export declare const getSummary: (page: number) => Promise<ITemplatesSummary>;
+export declare const getSummary: (endpoint: VerdocsEndpoint, page: number) => Promise<ITemplatesSummary>;

package/Templates/Templates.js

@@ -40,7 +40,6 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
-import { getEndpoint } from '../HTTP/Transport';
 /**
  * Get all templates accessible by the caller, with optional filters.
  *
@@ -53,9 +52,9 @@ import { getEndpoint } from '../HTTP/Transport';
  * await Templates.getTemplates({ is_organization: true });
  * ```
  */
-export var getTemplates = function (params) {
-    return getEndpoint()
-        .api.get('/templates/', { params: params })
+export var getTemplates = function (endpoint, params) {
+    return endpoint.api //
+        .get('/templates/', { params: params })
         .then(function (r) { return r.data; });
 };
 /**
@@ -67,9 +66,9 @@ export var getTemplates = function (params) {
  * const template = await Templates.getTemplate('83da3d70-7857-4392-b876-c4592a304bc9');
  * ```
  */
-export var getTemplate = function (templateId) {
-    return getEndpoint()
-        .api.get("/templates/".concat(templateId))
+export var getTemplate = function (endpoint, templateId) {
+    return endpoint.api //
+        .get("/templates/".concat(templateId))
         .then(function (r) { return r.data; });
 };
 /**
@@ -81,9 +80,9 @@ export var getTemplate = function (templateId) {
  * const newTemplate = await Templates.createTemplate({...});
  * ```
  */
-export var createTemplate = function (params) {
-    return getEndpoint()
-        .api.post('/templates/', params)
+export var createTemplate = function (endpoint, params) {
+    return endpoint.api //
+        .post('/templates/', params)
         .then(function (r) { return r.data; });
 };
 /**
@@ -95,9 +94,9 @@ export var createTemplate = function (params) {
  * const updatedTemplate = await Templates.updateTemplate('83da3d70-7857-4392-b876-c4592a304bc9', { name: 'New Name' });
  * ```
  */
-export var updateTemplate = function (templateId, params) {
-    return getEndpoint()
-        .api.put("/templates/".concat(templateId), params)
+export var updateTemplate = function (endpoint, templateId, params) {
+    return endpoint.api //
+        .put("/templates/".concat(templateId), params)
         .then(function (r) { return r.data; });
 };
 /**
@@ -109,10 +108,10 @@ export var updateTemplate = function (templateId, params) {
  * const {result, page, total} = await Templates.search({ ... });
  * ```
  */
-export var searchTemplates = function (params) { return __awaiter(void 0, void 0, void 0, function () {
+export var searchTemplates = function (endpoint, params) { return __awaiter(void 0, void 0, void 0, function () {
     return __generator(this, function (_a) {
-        return [2 /*return*/, getEndpoint()
-                .api.post('/templates/search', params)
+        return [2 /*return*/, endpoint.api //
+                .post('/templates/search', params)
                 .then(function (r) { return r.data; })];
     });
 }); };
@@ -125,10 +124,10 @@ export var searchTemplates = function (params) { return __awaiter(void 0, void 0
  * const summary = await Templates.getSummary(0);
  * ```
  */
-export var getSummary = function (page) { return __awaiter(void 0, void 0, void 0, function () {
+export var getSummary = function (endpoint, page) { return __awaiter(void 0, void 0, void 0, function () {
     return __generator(this, function (_a) {
-        return [2 /*return*/, getEndpoint()
-                .api.post('/templates/summary', { page: page })
+        return [2 /*return*/, endpoint.api //
+                .post('/templates/summary', { page: page })
                 .then(function (r) { return r.data; })];
     });
 }); };

package/Templates/Validators.d.ts

@@ -1,4 +1,5 @@
 import { IRole, ITag } from './Types';
+import { VerdocsEndpoint } from '../VerdocsEndpoint';
 export interface IValidator {
     name: string;
     regex: string;
@@ -12,8 +13,8 @@ export interface IValidator {
  * await Documents.getDocuments(templateID);
  * ```
  */
-export declare const getValidators: () => Promise<IValidator[]>;
-export declare const getValidator: (validatorName: string) => Promise<IValidator>;
+export declare const getValidators: (endpoint: VerdocsEndpoint) => Promise<IValidator[]>;
+export declare const getValidator: (endpoint: VerdocsEndpoint, validatorName: string) => Promise<IValidator>;
 export declare const isValidEmail: (value: string) => boolean;
 export declare const isValidPhone: (value: string) => boolean;
 export declare const isValidRoleName: (value: string, roles: IRole[]) => boolean;

package/Templates/Validators.js

@@ -1,5 +1,4 @@
 import { simpleE164Validator } from '../Utils/Locales';
-import { getEndpoint } from '../HTTP/Transport';
 /**
  * Get all defined validators
  *
@@ -9,14 +8,14 @@ import { getEndpoint } from '../HTTP/Transport';
  * await Documents.getDocuments(templateID);
  * ```
  */
-export var getValidators = function () {
-    return getEndpoint()
-        .api.get('/validators')
+export var getValidators = function (endpoint) {
+    return endpoint.api //
+        .get('/validators')
         .then(function (r) { return r.data; });
 };
-export var getValidator = function (validatorName) {
-    return getEndpoint()
-        .api.get("/validators/".concat(validatorName))
+export var getValidator = function (endpoint, validatorName) {
+    return endpoint.api //
+        .get("/validators/".concat(validatorName))
         .then(function (r) { return r.data; });
 };
 var EmailRegEx = /^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/;
@@ -24,6 +23,4 @@ export var isValidEmail = function (value) { return EmailRegEx.test(value); };
 export var isValidPhone = function (value) { return simpleE164Validator(value); };
 export var isValidRoleName = function (value, roles) { return roles.findIndex(function (role) { return role.name === value; }) !== -1; };
 var TagRegEx = /^[a-zA-Z0-9-]{0,32}$/;
-export var isValidTag = function (value, tags) {
-    return TagRegEx.test(value) || tags.findIndex(function (tag) { return tag.name === value; }) !== -1;
-};
+export var isValidTag = function (value, tags) { return TagRegEx.test(value) || tags.findIndex(function (tag) { return tag.name === value; }) !== -1; };

package/Users/Auth.d.ts

@@ -1,7 +1,7 @@
-import { IActiveSession, IAuthenticateAppRequest, IAuthenticateUserRequest, TokenValidationRequest, UpdateEmailRequest } from './Types';
+import { IAuthenticateAppRequest, IAuthenticateUserRequest } from './Types';
+import { TokenValidationRequest, UpdateEmailRequest, UpdatePasswordRequest } from './Types';
 import { IAuthenticateResponse, TokenValidationResponse, UpdateEmailResponse, UpdatePasswordResponse } from './Types';
-import { UpdatePasswordRequest } from './Types';
-import { ISigningSession } from '../Documents/Types';
+import { VerdocsEndpoint } from '../VerdocsEndpoint';
 /**
  * Authenticate to Verdocs via user/password authentication
  *
@@ -13,7 +13,7 @@ import { ISigningSession } from '../Documents/Types';
  * Transport.setAuthToken(accessToken);
  * ```
  */
-export declare const authenticateUser: (params: IAuthenticateUserRequest) => Promise<IAuthenticateResponse>;
+export declare const authenticateUser: (endpoint: VerdocsEndpoint, params: IAuthenticateUserRequest) => Promise<IAuthenticateResponse>;
 /**
  * Authenticate to Verdocs via client ID / Secret authentication. **NOTE: This is only suitable for
  * NodeJS server-side applications. Never expose your Client Secret in a Web or Mobile app!** Also note
@@ -29,7 +29,7 @@ export declare const authenticateUser: (params: IAuthenticateUserRequest) => Pro
  * Transport.setAuthToken(accessToken);
  * ```
  */
-export declare const authenticateApp: (params: IAuthenticateAppRequest) => Promise<IAuthenticateResponse>;
+export declare const authenticateApp: (endpoint: VerdocsEndpoint, params: IAuthenticateAppRequest) => Promise<IAuthenticateResponse>;
 /**
  * Validate a token. Only Verdocs tokens will be accepted. Most applications can decode tokens locally,
  * because tokens will be validated when API calls are made anyway. However, high-security applications
@@ -44,7 +44,7 @@ export declare const authenticateApp: (params: IAuthenticateAppRequest) => Promi
  * }
  * ```
  */
-export declare const validateToken: (params: TokenValidationRequest) => Promise<TokenValidationResponse>;
+export declare const validateToken: (endpoint: VerdocsEndpoint, params: TokenValidationRequest) => Promise<TokenValidationResponse>;
 /**
  * If called before the session expires, this will refresh the caller's session and tokens.
  *
@@ -56,7 +56,7 @@ export declare const validateToken: (params: TokenValidationRequest) => Promise<
  * Transport.setAuthToken(accessToken);
  * ```
  */
-export declare const refreshTokens: () => Promise<IAuthenticateResponse>;
+export declare const refreshTokens: (endpoint: VerdocsEndpoint) => Promise<IAuthenticateResponse>;
 /**
  * Update the caller's password. To help prevent CSRF attack vectors, the user's old password and email address are required.
  *
@@ -69,7 +69,7 @@ export declare const refreshTokens: () => Promise<IAuthenticateResponse>;
  * }
  * ```
  */
-export declare const updatePassword: (params: UpdatePasswordRequest) => Promise<UpdatePasswordResponse>;
+export declare const updatePassword: (endpoint: VerdocsEndpoint, params: UpdatePasswordRequest) => Promise<UpdatePasswordResponse>;
 /**
  * Update the caller's email address.
  *
@@ -79,22 +79,4 @@ export declare const updatePassword: (params: UpdatePasswordRequest) => Promise<
  * const {profiles} = await Auth.updateEmail({ email: newEmail });
  * ```
  */
-export declare const updateEmail: (params: UpdateEmailRequest) => Promise<UpdateEmailResponse>;
-export declare type TSession = IActiveSession | ISigningSession | null;
-/**
- * Parses and sets the active session, optionally persisting (brower-only, persists to localStorage).
- */
-export declare const setSession: (source: string, token: string | null, persist?: boolean) => TSession;
-/**
- * Load a session from localStorage
- */
-export declare const loadSession: (source: string) => IActiveSession | ISigningSession | null;
-/**
- * End the active session.
- */
-export declare const endSession: (source: string, persist?: boolean) => null;
-export declare type SessionChangedListener = (source: string, session: IActiveSession | ISigningSession | null) => void;
-/**
- * Subscribe to session state change events.
- */
-export declare const onSessionChanged: (listener: SessionChangedListener) => () => void;
+export declare const updateEmail: (endpoint: VerdocsEndpoint, params: UpdateEmailRequest) => Promise<UpdateEmailResponse>;