@verdocs/js-sdk 3.10.29 → 4.0.0

package/Templates/Validators.d.ts

@@ -1,21 +0,0 @@
-import { IRole, ITag } from './Types';
-import { VerdocsEndpoint } from '../VerdocsEndpoint';
-export interface IValidator {
-    name: string;
-    regex: string;
-}
-/**
- * Get all defined validators
- *
- * ```typescript
- * import {Documents} from '@verdocs/js-sdk/Templates';
- *
- * await Documents.getDocuments(templateID);
- * ```
- */
-export declare const getValidators: (endpoint: VerdocsEndpoint) => Promise<IValidator[]>;
-export declare const getValidator: (endpoint: VerdocsEndpoint, validatorName: string) => Promise<IValidator>;
-export declare const isValidEmail: (email: string | undefined) => boolean;
-export declare const isValidPhone: (phone: string | undefined) => boolean;
-export declare const isValidRoleName: (value: string, roles: IRole[]) => boolean;
-export declare const isValidTag: (value: string, tags: ITag[]) => boolean;

package/Templates/Validators.js

@@ -1,27 +0,0 @@
-/**
- * Get all defined validators
- *
- * ```typescript
- * import {Documents} from '@verdocs/js-sdk/Templates';
- *
- * await Documents.getDocuments(templateID);
- * ```
- */
-export var getValidators = function (endpoint) {
-    return endpoint.api //
-        .get('/validators')
-        .then(function (r) { return r.data; });
-};
-export var getValidator = function (endpoint, validatorName) {
-    return endpoint.api //
-        .get("/validators/".concat(validatorName))
-        .then(function (r) { return r.data; });
-};
-var EMAIL_REGEX = /^(([^<>()\[\]\\.,;:\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,}))$/;
-export var isValidEmail = function (email) { return !!email && EMAIL_REGEX.test(email); };
-// @see https://www.regextester.com/1978
-var PHONE_REGEX = /((?:\+|00)[17](?: |\-)?|(?:\+|00)[1-9]\d{0,2}(?: |\-)?|(?:\+|00)1\-\d{3}(?: |\-)?)?(0\d|\([0-9]{3}\)|[1-9]{0,3})(?:((?: |\-)[0-9]{2}){4}|((?:[0-9]{2}){4})|((?: |\-)[0-9]{3}(?: |\-)[0-9]{4})|([0-9]{7}))/;
-export var isValidPhone = function (phone) { return !!phone && PHONE_REGEX.test(phone); };
-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; };

package/Templates/index.d.ts

@@ -1,11 +0,0 @@
-export * as Actions from './Actions';
-export * as Fields from './Fields';
-export * as Pages from './Pages';
-export * as Reminders from './Reminders';
-export * as Roles from './Roles';
-export * as Stars from './Stars';
-export * as Tags from './Tags';
-export * as Templates from './Templates';
-export * as TemplateDocuments from './TemplateDocuments';
-export * as Types from './Types';
-export * as Validators from './Validators';

package/Templates/index.js

@@ -1,11 +0,0 @@
-export * as Actions from './Actions';
-export * as Fields from './Fields';
-export * as Pages from './Pages';
-export * as Reminders from './Reminders';
-export * as Roles from './Roles';
-export * as Stars from './Stars';
-export * as Tags from './Tags';
-export * as Templates from './Templates';
-export * as TemplateDocuments from './TemplateDocuments';
-export * as Types from './Types';
-export * as Validators from './Validators';

package/Users/Auth.d.ts

@@ -1,123 +0,0 @@
-import { IAuthenticateAppRequest, IAuthenticateUserRequest, IProfile } from './Types';
-import { TokenValidationRequest, UpdateEmailRequest, IUpdatePasswordRequest } from './Types';
-import { IAuthenticateResponse, TokenValidationResponse, UpdateEmailResponse, UpdatePasswordResponse } from './Types';
-import { VerdocsEndpoint } from '../VerdocsEndpoint';
-/**
- * Authenticate to Verdocs via user/password authentication
- *
- * ```typescript
- * import {Auth} from '@verdocs/js-sdk/Auth';
- * import {Transport} from '@verdocs/js-sdk/HTTP';
- *
- * const {accessToken} = await Auth.authenticateUser({ username: 'test@test.com', password: 'PASSWORD' });
- * Transport.setAuthToken(accessToken);
- * ```
- */
-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
- * that access tokens may be cached by server-side apps (and this is recommended) but do expire after 2
- * hours. This expiration may change based on future security needs. Application developers are encouraged
- * to check the `exp` expiration field in the response accessToken and renew tokens after they expire.
- *
- * ```typescript
- * import {Auth} from '@verdocs/js-sdk/Auth';
- * import {Transport} from '@verdocs/js-sdk/HTTP';
- *
- * const {accessToken} = await Auth.authenticateApp({ client_id: 'CLIENTID', client_secret: 'SECRET' });
- * Transport.setAuthToken(accessToken);
- * ```
- */
-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
- * may use this endpoint to check if a token has been revoked.
- *
- * ```typescript
- * import {Auth} from '@verdocs/js-sdk/Auth';
- *
- * const {valid} = await Auth.validateToken({ token });
- * if (!valid) {
- *   window.alert('Session invalid or expired. Please re-authenticate.');
- * }
- * ```
- */
-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.
- *
- * ```typescript
- * import {Auth} from '@verdocs/js-sdk/Auth';
- * import {Transport} from '@verdocs/js-sdk/HTTP';
- *
- * const {accessToken} = await Auth.refreshTokens();
- * Transport.setAuthToken(accessToken);
- * ```
- */
-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.
- *
- * ```typescript
- * import {Auth} from '@verdocs/js-sdk/Auth';
- *
- * const {status, message} = await Auth.updatePassword({ email, oldPassword, newPassword });
- * if (status !== 'OK') {
- *   window.alert(`Password reset error: ${message}`);
- * }
- * ```
- */
-export declare const updatePassword: (endpoint: VerdocsEndpoint, params: IUpdatePasswordRequest) => Promise<UpdatePasswordResponse>;
-/**
- * Reset the caller's password.
- *
- * ```typescript
- * import {Auth} from '@verdocs/js-sdk/Auth';
- *
- * const {success} = await Auth.resetPassword({ email });
- * if (status !== 'OK') {
- *   window.alert(`Please check your email for instructions on how to reset your password.`);
- * }
- * ```
- */
-export declare const resetPassword: (endpoint: VerdocsEndpoint, params: {
-    email: string;
-}) => Promise<{
-    success: boolean;
-}>;
-/**
- * Update the caller's email address.
- *
- * ```typescript
- * import {Auth} from '@verdocs/js-sdk/Auth';
- *
- * const {profiles} = await Auth.updateEmail({ email: newEmail });
- * ```
- */
-export declare const updateEmail: (endpoint: VerdocsEndpoint, params: UpdateEmailRequest) => Promise<UpdateEmailResponse>;
-/**
- * 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 {Auth} from '@verdocs/js-sdk/Auth';
- *
- * const result = await Auth.resendVerification();
- * ```
- */
-export declare const resendVerification: (endpoint: VerdocsEndpoint, accessToken?: string) => Promise<{
-    result: 'done';
-}>;
-export interface ICreateUserRequest {
-    firstName: string;
-    lastName: string;
-    email: string;
-    password: string;
-    fromInviteCode: string;
-}
-export declare const createUser: (endpoint: VerdocsEndpoint, params: ICreateUserRequest) => Promise<IProfile>;

package/Users/Auth.js

@@ -1,142 +0,0 @@
-/**
- * Authenticate to Verdocs via user/password authentication
- *
- * ```typescript
- * import {Auth} from '@verdocs/js-sdk/Auth';
- * import {Transport} from '@verdocs/js-sdk/HTTP';
- *
- * const {accessToken} = await Auth.authenticateUser({ username: 'test@test.com', password: 'PASSWORD' });
- * Transport.setAuthToken(accessToken);
- * ```
- */
-export var authenticateUser = function (endpoint, params) {
-    return endpoint.api //
-        .post('/authentication/login', params)
-        .then(function (r) { return r.data; });
-};
-/**
- * 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
- * that access tokens may be cached by server-side apps (and this is recommended) but do expire after 2
- * hours. This expiration may change based on future security needs. Application developers are encouraged
- * to check the `exp` expiration field in the response accessToken and renew tokens after they expire.
- *
- * ```typescript
- * import {Auth} from '@verdocs/js-sdk/Auth';
- * import {Transport} from '@verdocs/js-sdk/HTTP';
- *
- * const {accessToken} = await Auth.authenticateApp({ client_id: 'CLIENTID', client_secret: 'SECRET' });
- * Transport.setAuthToken(accessToken);
- * ```
- */
-export var authenticateApp = function (endpoint, params) {
-    return endpoint.api //
-        .post('/authentication/login_client', {}, { headers: params })
-        .then(function (r) { return r.data; });
-};
-/**
- * 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
- * may use this endpoint to check if a token has been revoked.
- *
- * ```typescript
- * import {Auth} from '@verdocs/js-sdk/Auth';
- *
- * const {valid} = await Auth.validateToken({ token });
- * if (!valid) {
- *   window.alert('Session invalid or expired. Please re-authenticate.');
- * }
- * ```
- */
-export var validateToken = function (endpoint, params) {
-    return endpoint.api //
-        .post('/token/isValid', params)
-        .then(function (r) { return r.data; });
-};
-/**
- * If called before the session expires, this will refresh the caller's session and tokens.
- *
- * ```typescript
- * import {Auth} from '@verdocs/js-sdk/Auth';
- * import {Transport} from '@verdocs/js-sdk/HTTP';
- *
- * const {accessToken} = await Auth.refreshTokens();
- * Transport.setAuthToken(accessToken);
- * ```
- */
-export var refreshTokens = function (endpoint) {
-    return endpoint.api //
-        .get('/token')
-        .then(function (r) { return r.data; });
-};
-/**
- * Update the caller's password. To help prevent CSRF attack vectors, the user's old password and email address are required.
- *
- * ```typescript
- * import {Auth} from '@verdocs/js-sdk/Auth';
- *
- * const {status, message} = await Auth.updatePassword({ email, oldPassword, newPassword });
- * if (status !== 'OK') {
- *   window.alert(`Password reset error: ${message}`);
- * }
- * ```
- */
-export var updatePassword = function (endpoint, params) {
-    return endpoint.api //
-        .put('/user/update_password', params)
-        .then(function (r) { return r.data; });
-};
-/**
- * Reset the caller's password.
- *
- * ```typescript
- * import {Auth} from '@verdocs/js-sdk/Auth';
- *
- * const {success} = await Auth.resetPassword({ email });
- * if (status !== 'OK') {
- *   window.alert(`Please check your email for instructions on how to reset your password.`);
- * }
- * ```
- */
-export var resetPassword = function (endpoint, params) {
-    return endpoint.api //
-        .post('/user/reset_password', params)
-        .then(function (r) { return r.data; });
-};
-/**
- * Update the caller's email address.
- *
- * ```typescript
- * import {Auth} from '@verdocs/js-sdk/Auth';
- *
- * const {profiles} = await Auth.updateEmail({ email: newEmail });
- * ```
- */
-export var updateEmail = function (endpoint, params) {
-    return endpoint.api //
-        .put('/user/update_email', params)
-        .then(function (r) { return 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 {Auth} from '@verdocs/js-sdk/Auth';
- *
- * const result = await Auth.resendVerification();
- * ```
- */
-export var resendVerification = function (endpoint, accessToken) {
-    return endpoint.api //
-        .post('/user/email_verification', {}, accessToken ? { headers: { Authorization: "Bearer ".concat(accessToken) } } : {})
-        .then(function (r) { return r.data; });
-};
-export var createUser = function (endpoint, params) {
-    return endpoint.api //
-        .post('/user', params)
-        .then(function (r) { return r.data; });
-};

package/Users/Billing.d.ts

@@ -1 +0,0 @@
-export declare const billingPlaceholder: {};

package/Users/Billing.js

@@ -1,2 +0,0 @@
-// TODO
-export var billingPlaceholder = {};

package/Users/Notifications.d.ts

@@ -1,2 +0,0 @@
-import { VerdocsEndpoint } from '../VerdocsEndpoint';
-export declare const getNotifications: (endpoint: VerdocsEndpoint) => Promise<any>;

package/Users/Notifications.js

@@ -1,43 +0,0 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-export var getNotifications = function (endpoint) { return __awaiter(void 0, void 0, void 0, function () {
-    return __generator(this, function (_a) {
-        return [2 /*return*/, endpoint.api //
-                .get('/notifications')
-                .then(function (r) { return r.data; })];
-    });
-}); };

package/Users/Profiles.d.ts

@@ -1,151 +0,0 @@
-import { ICreateProfileRequest, IPermission, IProfile, IRole, ISwitchProfileResponse, IUpdateProfileRequest } from './Types';
-import { IGroup, IOrganization } from '../Organizations/Types';
-import { VerdocsEndpoint } from '../VerdocsEndpoint';
-/**
- * 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.getProfiles()
- * ```
- */
-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.
- *
- * ```typescript
- * import {Profiles} from '@verdocs/js-sdk/Users';
- *
- * const roles = await Profiles.getRoles();
- * ```
- */
-export declare const getRoles: (endpoint: VerdocsEndpoint) => Promise<IRole[]>;
-/**
- * Get a list of system roles.
- *
- * ```typescript
- * import {Profiles} from '@verdocs/js-sdk/Users';
- *
- * const permissions = await Profiles.getPermissions();
- * ```
- */
-export declare const getPermissions: (endpoint: VerdocsEndpoint) => Promise<any>;
-/**
- * Create a profile. If the caller does not have a "current" profile set, the new profile will be made current.
- *
- * ```typescript
- * import {Profiles} from '@verdocs/js-sdk/Users';
- *
- * const newProfile = await Profiles.createProfile({ first_name: 'FIRST', last_name: 'LAST', email: 'EMAIL' });
- * ```
- */
-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
- *
- * ```typescript
- * import {Profiles} from '@verdocs/js-sdk/Users';
- *
- * const profile = await Profiles.getProfile('PROFILEID');
- * ```
- */
-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.
- *
- * ```typescript
- * import {Profiles} from '@verdocs/js-sdk/Users';
- *
- * const permissions = await Profiles.getProfilePermissions('PROFILEID');
- * ```
- */
-export declare const getProfilePermissions: (endpoint: VerdocsEndpoint, profileId: string) => Promise<IPermission[]>;
-/**
- * Get a profile's groups.
- *
- * ```typescript
- * import {Profiles} from '@verdocs/js-sdk/Users';
- *
- * const groups = await Profiles.getProfileGroups('PROFILEID');
- * ```
- */
-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.
- *
- * ```typescript
- * import {Profiles} from '@verdocs/js-sdk/Users';
- *
- * const newProfile = await Profiles.switchProfile('PROFILEID');
- * ```
- */
-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.
- *
- * ```typescript
- * import {Profiles} from '@verdocs/js-sdk/Users';
- *
- * const newProfile = await Profiles.updateProfile('PROFILEID');
- * ```
- */
-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.
- *
- * ```typescript
- * import {Profiles} from '@verdocs/js-sdk/Users';
- *
- * await Profiles.deleteProfile('PROFILEID');
- * ```
- */
-export declare const deleteProfile: (endpoint: VerdocsEndpoint, profileId: string) => Promise<any>;
-export interface ICreateBusinessAccountRequest {
-    email: string;
-    password: string;
-    firstName: string;
-    lastName: string;
-    orgName: string;
-}
-/**
- * Create a user account and parent organization. This endpoint is for creating a new organization. Users joining an
- * existing organization should be invited, and follow their invitation links/instructions to create their accounts.
- *
- * ```typescript
- * import {Profiles} from '@verdocs/js-sdk/Users';
- *
- * const newAccount = await Profiles.createBusinessAccount({
- *   orgName: 'ORG', email: 'a@b.com', password: '12345678', firstName: 'FIRST', lastName: 'LAST'
- * });
- * ```
- */
-export declare const createBusinessAccount: (endpoint: VerdocsEndpoint, params: ICreateBusinessAccountRequest) => Promise<{
-    profile: IProfile;
-    organization: IOrganization;
-}>;
-export interface ISignupSurvey {
-    industry?: string;
-    size?: string;
-    source?: string;
-    referral?: string;
-    coupon?: string;
-    reason?: string;
-    hearabout?: string;
-}
-export declare const recordSignupSurvey: (endpoint: VerdocsEndpoint, params: ISignupSurvey) => Promise<{
-    status: 'OK';
-}>;