@stackfactor/client-api 1.0.1 → 1.0.2

package/lib/templates.js

@@ -1,17 +1,14 @@
-import axios from "./axios";
+const axios = require("./axios");
 
-export default {
+module.exports = {
   axios: axios,
 
   /**
-   *
    * Create template and set information
-   *
    * @param {Object} data New template data information
    * @param {String} token Authorization token
-   *
    */
-  createTemplate(data, token) {
+  createTemplate: (data, token) => {
     return new Promise(function (resolve, reject) {
       const requestData = {
         data: data,
@@ -31,12 +28,10 @@ export default {
 
   /**
    * Delete template
-   *
    * @param {number} id The id of the template to be deleted
    * @param {String} token Authorization token
-   *
    */
-  deleteTemplate(id, token) {
+  deleteTemplate: (id, token) => {
     return new Promise(function (resolve, reject) {
       const requestData = {
         id: id,
@@ -57,12 +52,10 @@ export default {
 
   /**
    * Get template information
-   *
    * @param {number} id The id of the template
    * @param {String} token Authorization token
-   *
    */
-  getTemplateInformationById(id, version, token) {
+  getTemplateInformationById: (id, version, token) => {
     return new Promise(function (resolve, reject) {
       let confirmationRequest = axios.get(`api/v1/templates/${id}/${version}`, {
         headers: { authorization: token },
@@ -79,11 +72,10 @@ export default {
 
   /**
    * Get template information
-   *
    * @param {Object} filter The filter used to select the template
    * @param {String} token Authorization token
    */
-  getTemplateList(filter, version, token) {
+  getTemplateList: (filter, version, token) => {
     return new Promise(function (resolve, reject) {
       const requestData = {
         filter: filter ? filter : "",
@@ -104,11 +96,10 @@ export default {
 
   /**
    * Publish template
-   *
    * @param {number} id The id of the template to be published
    * @param {String} token Authorization token
    */
-  publishTemplate(id, token) {
+  publishTemplate: (id, token) => {
     return new Promise(function (resolve, reject) {
       let confirmationRequest = axios.post(
         `api/v1/templates/publish/${id}`,
@@ -129,13 +120,11 @@ export default {
 
   /**
    * Set template profile information
-   *
    * @param {String} id The id of the template to be updated
    * @param {Object} data Data used to update the template
    * @param {String} token Authorization token
-   *
    */
-  setTemplateInformation(id, data, token) {
+  setTemplateInformation: (id, data, token) => {
     return new Promise(function (resolve, reject) {
       const requestData = {
         data: data,

package/lib/tenants.js

@@ -1,15 +1,14 @@
-import axios from "./axios";
+const axios = require("./axios");
 
-export default {
+module.exports = {
   axios: axios,
 
   /**
    * Get tenant information
-   *
    * @param {String} category Tenant information category
    * @param {String} token Authorization token
    */
-  getTenantInformation(categories, token) {
+  getTenantInformation: (categories, token) => {
     return new Promise(function (resolve, reject) {
       const requestData = {
         categories: categories,
@@ -29,13 +28,11 @@ export default {
 
   /**
    * Set tenant profile information
-   *
    * @param {String} category Tenant information category
    * @param {String} data New or updated tenant data information
    * @param {Object} token Authorization token
-   *
    */
-  setTenantInformation(category, data, token) {
+  setTenantInformation: (category, data, token) => {
     return new Promise(function (resolve, reject) {
       const requestData = {
         category: category,

package/lib/trainingPlanTemplate.js

@@ -1,6 +1,6 @@
-import axios from "./axios";
+const axios = require("./axios");
 
-export default {
+module.exports = {
   axios: axios,
 
   /**
@@ -8,7 +8,7 @@ export default {
    * @param {Object} data
    * @param {String} token Authorization token
    */
-  createTrainingPlanTemplate(data, token) {
+  createTrainingPlanTemplate: (data, token) => {
     return new Promise(function (resolve, reject) {
       let confirmationRequest = axios.put(
         "api/v1/trainingplantemplates",
@@ -33,7 +33,7 @@ export default {
    * @param {String} comment The comment for approver
    * @param {String} token Authorization token
    */
-  deleteTrainingPlanTemplate(id, comment, token) {
+  deleteTrainingPlanTemplate: (id, comment, token) => {
     return new Promise(function (resolve, reject) {
       const data = {
         id: id,
@@ -58,7 +58,7 @@ export default {
    * @param {String} id The id of the training plan to be deleted
    * @param {String} token Authorization token
    */
-  discardTrainingPlanChanges(id, token) {
+  discardTrainingPlanChanges: (id, token) => {
     return new Promise(function (resolve, reject) {
       const data = {};
       const request = axios.get(`api/v1/trainingplantemplates/discard/${id}`, {
@@ -80,7 +80,7 @@ export default {
    * @param {String} id The id of the template
    * @param {String} token Authorization token
    */
-  getTrainingPlanTemplateInformationById(id, version, token) {
+  getTrainingPlanTemplateInformationById: (id, version, token) => {
     return new Promise(function (resolve, reject) {
       let confirmationRequest = axios.get(
         `api/v1/trainingplantemplates/${id}/${version}`,
@@ -104,7 +104,7 @@ export default {
    * @param {String} version The version to be retrieved
    * @param {String} token Authorization token
    */
-  getTrainingPlanTemplatesList(list, version, includeDeleted, token) {
+  getTrainingPlanTemplatesList: (list, version, includeDeleted, token) => {
     return new Promise(function (resolve, reject) {
       const requestData = {
         version: version,
@@ -134,7 +134,7 @@ export default {
    * @param {String} comment The comment to be include with the request
    * @param {String} token Authorization token
    */
-  publishTrainingPlanTemplate(id, comment, token) {
+  publishTrainingPlanTemplate: (id, comment, token) => {
     return new Promise(function (resolve, reject) {
       let data = {};
       if (comment) data.comment = comment;
@@ -161,7 +161,7 @@ export default {
    * @param {Object} data Data used to update the template
    * @param {String} token Authorization token
    */
-  setTrainingPlanTemplateInformation(id, data, token) {
+  setTrainingPlanTemplateInformation: (id, data, token) => {
     return new Promise(function (resolve, reject) {
       const requestData = {
         data: data,
@@ -190,7 +190,7 @@ export default {
    * @param {Object} tags The updated tags
    * @param {String} token Authorization token
    */
-  setTrainingPlanTemplateTags(id, tags, token) {
+  setTrainingPlanTemplateTags: (id, tags, token) => {
     return new Promise(function (resolve, reject) {
       const requestData = {
         tags: tags,

package/lib/trainingPlans.js

@@ -1,6 +1,6 @@
-import axios from "./axios";
+const axios = require("./axios");
 
-export default {
+module.exports = {
   axios: axios,
 
   /**
@@ -10,7 +10,7 @@ export default {
    * @param {Boolean} saveAsDraft Save as draft flag
    * @param {String} token Authorization token
    */
-  createTrainingPlan(data, type, saveAsDraft, token) {
+  createTrainingPlan: (data, type, saveAsDraft, token) => {
     return new Promise(function (resolve, reject) {
       const requestData = {
         data: {
@@ -38,7 +38,7 @@ export default {
    * @param {String} comment The comment for approver
    * @param {String} token Authorization token
    */
-  deleteTrainingPlan(id, comment, token) {
+  deleteTrainingPlan: (id, comment, token) => {
     return new Promise(function (resolve, reject) {
       const data = {
         id: id,
@@ -63,7 +63,7 @@ export default {
    * @param {String} id The id of the training plan to be deleted
    * @param {String} token Authorization token
    */
-  discardTrainingPlanChanges(id, token) {
+  discardTrainingPlanChanges: (id, token) => {
     return new Promise(function (resolve, reject) {
       const request = axios.get(`api/v1/trainingplans/discard/${id}`, {
         headers: { authorization: token },
@@ -86,7 +86,7 @@ export default {
    * @param {Boolean} saveBaseline If set to true it will save the baseline
    * @param {String} token Authorization token
    */
-  generateNewBaseline(id, data, returnMinimized, saveBaseline, token) {
+  generateNewBaseline: (id, data, returnMinimized, saveBaseline, token) => {
     return new Promise(function (resolve, reject) {
       const requestData = {
         data: data,
@@ -116,7 +116,7 @@ export default {
    * @param {String} id The id of the training plan
    * @param {String} token Authorization token
    */
-  getTrainingPlanById(id, version, token) {
+  getTrainingPlanById: (id, version, token) => {
     return new Promise(function (resolve, reject) {
       let confirmationRequest = axios.get(
         `api/v1/trainingplans/${id}/${version}`,
@@ -144,7 +144,7 @@ export default {
    * @param {Boolean} returnDefaultIfVersionNotAvailable If set to true it will load the draft information if the plan was never published
    * @param {String} token Authorization token
    */
-  getListOfTrainingPlans(
+  getListOfTrainingPlans: (
     users,
     types,
     version,
@@ -153,7 +153,7 @@ export default {
     includeDetailedInformation,
     returnDefaultIfVersionNotAvailable,
     token
-  ) {
+  ) => {
     return new Promise(function (resolve, reject) {
       const requestData = {
         version: version,
@@ -187,7 +187,7 @@ export default {
    * @param {String} comment The comment to be include with the request
    * @param {String} token Authorization token
    */
-  publishTrainingPlan(id, comment, token) {
+  publishTrainingPlan: (id, comment, token) => {
     return new Promise(function (resolve, reject) {
       let data = {};
       if (comment) data.comment = comment;
@@ -214,7 +214,7 @@ export default {
    * @param {Object} data The updated data
    * @param {String} token Authorization token
    */
-  updateTrainingPlan(planId, data, saveAsDraft, token) {
+  updateTrainingPlan: (planId, data, saveAsDraft, token) => {
     return new Promise(function (resolve, reject) {
       const requestData = {
         data: data,
@@ -246,7 +246,7 @@ export default {
    * @param {Function} failCallBack
    * @returns {Object} An object containing the task information
    */
-  updateActivities(planId, data, token) {
+  updateActivities: (planId, data, token) => {
     return new Promise(function (resolve, reject) {
       let confirmationRequest = axios.post(
         `api/v1/trainingplans/${planId}/activities`,

package/lib/userInformation.js

@@ -1,4 +1,4 @@
-import axios from "./axios";
+const axios = require("./axios");
 
 export default {
   axios: axios,
@@ -10,7 +10,7 @@ export default {
    * @param {Object} data
    * @param {String} token Authorization token
    */
-  addEntryToArrayBusinessProperty(userId, property, data, token) {
+  addEntryToArrayBusinessProperty: (userId, property, data, token) => {
     return new Promise(function (resolve, reject) {
       const requestData = {
         data: data,
@@ -39,7 +39,7 @@ export default {
    * @param {String} id
    * @param {String} token Authorization token
    */
-  removeEntryFromArrayBusinessProperty(userId, property, id, token) {
+  removeEntryFromArrayBusinessProperty: (userId, property, id, token) => {
     return new Promise(function (resolve, reject) {
       const confirmationRequest = axios.delete(
         `api/v1/user/arrayproperty/${userId}/${property}/${id}`,
@@ -65,7 +65,7 @@ export default {
    * @param {Object} data
    * @param {String} token Authorization token
    */
-  updateEntryfromArrayBusinessProperty(userId, property, id, data, token) {
+  updateEntryfromArrayBusinessProperty: (userId, property, id, data, token) => {
     return new Promise(function (resolve, reject) {
       const requestData = {
         data: data,

package/lib/users.js

@@ -1,6 +1,3 @@
-//
-// User sepcific requests
-//
 import axios from "./axios";
 import { removeNullProperties } from "../components/Utils";
 
@@ -12,7 +9,7 @@ export default {
    * @param {Date} expiration Expiration date of the token
    * @param {String} authToken Authorization token
    */
-  addAPIToken(name, expiration, authToken) {
+  addAPIToken: (name, expiration, authToken) => {
     return new Promise(function (resolve, reject) {
       const requestData = removeNullProperties({
         name: name,
@@ -41,11 +38,9 @@ export default {
 
   /**
    * Confirm email address
-   *
    * @param {String} validationCode The code was provided to the user in advance by email
-   *
    */
-  confirmEmailAddress(validationCode) {
+  confirmEmailAddress: (validationCode) => {
     return new Promise(function (resolve, reject) {
       const requestData = removeNullProperties({
         validationCode: validationCode,
@@ -65,9 +60,7 @@ export default {
   },
 
   /**
-   *
    * Create a new account (tenant). It returns a promise
-   *
    * @param {String} email User's email address
    * @param {String} firstName User's first name
    * @param {String} lastName User's last name
@@ -76,7 +69,14 @@ export default {
    * @param {String} inviteCode Invitation code received in advance from one of the account owners
    * @param
    */
-  createAccount(email, firstName, lastName, password, subSite, inviteCode) {
+  createAccount: (
+    email,
+    firstName,
+    lastName,
+    password,
+    subSite,
+    inviteCode
+  ) => {
     return new Promise(function (resolve, reject) {
       if (
         email.trim() === "" ||
@@ -110,15 +110,13 @@ export default {
 
   /**
    * Create a new user account. It returns a promise
-   *
    * @param {String} email User's email address
    * @param {String} firstName User's first name
    * @param {String} lastName User's last name
    * @param {String} password User's password
    * @param {String} token Invitation token provided to the user
-   *
    */
-  createUserAccount(email, firstName, lastName, password, token) {
+  createUserAccount: (email, firstName, lastName, password, token) => {
     return new Promise(function (resolve, reject) {
       if (
         email.trim() === "" ||
@@ -150,11 +148,10 @@ export default {
 
   /**
    * Delete an existing API token
-   *
    * @param {String} token Expiration date of the token
    * @param {String} authToken Authorization token
    */
-  deleteAPIToken(token, authToken) {
+  deleteAPIToken: (token, authToken) => {
     return new Promise(function (resolve, reject) {
       const deleteTokenRequest = axios.delete(
         `api/v1/users/user/token`,
@@ -177,11 +174,10 @@ export default {
 
   /**
    * Delete existing users
-   *
-   * @param {Array} userIds The ID of the users to be deleted
+   * @param {Array<String>} userIds The ID of the users to be deleted
    * @param {String} authToken Authorization token
    */
-  deleteUsers(userIds, authToken) {
+  deleteUsers: (userIds, authToken) => {
     return new Promise(function (resolve, reject) {
       const deleteTokenRequest = axios.delete(
         `api/v1/users/`,
@@ -206,7 +202,7 @@ export default {
    * Get all the API tokens
    * @param {String} authToken Authorization token
    */
-  getAPITokens(authToken) {
+  getAPITokens: (authToken) => {
     return new Promise(function (resolve, reject) {
       const getTokensRequest = axios.get(`api/v1/users/getapitokens`, {
         headers: { authorization: authToken },
@@ -222,13 +218,10 @@ export default {
   },
 
   /**
-   *
    * Get the specified user account by Id. It returns a promise
-   *
    * @param {String} id Id of the user for which information is being requested
-   *
    */
-  getUserById(id) {
+  getUserById: (id) => {
     return new Promise(function (resolve, reject) {
       const getUserInformationRequest = axios.get(`api/v1/users/user/${id}`);
       getUserInformationRequest
@@ -251,7 +244,7 @@ export default {
    * @param {String} category User information category
    * @param {String} token Authorization token
    */
-  getUserInformation(userId, category, token) {
+  getUserInformation: (userId, category, token) => {
     return new Promise(function (resolve, reject) {
       let confirmationRequest = axios.get(
         `api/v1/users/user/${userId ? userId : 0}/${category ? category : "*"}`,
@@ -275,7 +268,7 @@ export default {
    * @param {Array} fields Fields to be loaded. Ex: ["firstName"]
    * @param {String} token Authorization token
    */
-  getUsers(filter, fields, token) {
+  getUsers: (filter, fields, token) => {
     return new Promise(function (resolve, reject) {
       const requestData = removeNullProperties({
         filter: filter,
@@ -296,10 +289,10 @@ export default {
 
   /**
    * Invite other users to join the same account
-   * @param {Array} invitees List of emails of the invitees
+   * @param {Array<String>} invitees List of emails of the invitees
    * @param {String} token Authorization token
    */
-  inviteUsers(invitees, authToken) {
+  inviteUsers: (invitees, authToken) => {
     return new Promise(function (resolve, reject) {
       const requestData = removeNullProperties({
         invitees: invitees,
@@ -324,7 +317,7 @@ export default {
    * @param {String} password User's password
    * @param {boolean} rememberMe Set to true if the user wants his account to be saved on the current machine
    */
-  login(email, password, rememberMe) {
+  login: (email, password, rememberMe) => {
     return new Promise(function (resolve, reject) {
       const requestData = removeNullProperties({
         email: email,
@@ -346,7 +339,7 @@ export default {
    * Logout from the server. It returns a promise
    * @param {String} token Authorization token
    */
-  logout(token) {
+  logout: (token) => {
     return new Promise(function (resolve, reject) {
       const options = removeNullProperties({
         headers: { authorization: token },
@@ -367,7 +360,7 @@ export default {
    * a new token can be restablished using login
    * @param {String} token  User's auth token to be refreshed
    */
-  refreshToken(token) {
+  refreshToken: (token) => {
     return new Promise(function (resolve, reject) {
       let options = removeNullProperties({ headers: { Authorization: token } });
       let request = axios.post("api/v1/auth/refreshToken", {}, options);
@@ -386,7 +379,7 @@ export default {
    * @param {String} id The ID of the token to be removed
    * @param {String} authToken Authorization token
    */
-  removeAPIToken(id, authToken) {
+  removeAPIToken: (id, authToken) => {
     return new Promise(function (resolve, reject) {
       const requestData = removeNullProperties({
         id: id,
@@ -410,10 +403,10 @@ export default {
 
   /**
    * Resend invitation emails
-   * @param {Array} invitees List of emails of the invitees
+   * @param {Array<String>} invitees List of emails of the invitees
    * @param {String} token Authorization token
    */
-  resendInvitationEmails(invitees, authToken) {
+  resendInvitationEmails: (invitees, authToken) => {
     return new Promise(function (resolve, reject) {
       const requestData = removeNullProperties({
         invitees: invitees,
@@ -438,7 +431,7 @@ export default {
    * @param {String} email User's email address
    * @param {String} password User's new password
    */
-  resetPassword(email, code, password) {
+  resetPassword: (email, code, password) => {
     return new Promise(function (resolve, reject) {
       let postData = removeNullProperties({
         email: email,
@@ -460,7 +453,7 @@ export default {
    * Send an email to the user indicated by the email address to reset the password. It returns a promise
    * @param {String} email Email of the user who needs to reset the password
    */
-  sendPasswordResetNotification(email) {
+  sendPasswordResetNotification: (email) => {
     return new Promise(function (resolve, reject) {
       let postData = removeNullProperties({
         email: email,
@@ -486,7 +479,7 @@ export default {
    * @param {String} data New or updated user data information
    * @param {Object} token Authorization token
    */
-  setUserInformation(userId, category, data, token) {
+  setUserInformation: (userId, category, data, token) => {
     return new Promise(function (resolve, reject) {
       const requestData = removeNullProperties({
         data: category ? { category: { ...data } } : data,
@@ -511,7 +504,7 @@ export default {
    * @param {String} password The current password
    * @param {String} token Authorization token
    */
-  updateUserEmail(email, password, token) {
+  updateUserEmail: (email, password, token) => {
     return new Promise(function (resolve, reject) {
       const requestData = removeNullProperties({
         email: email,
@@ -540,7 +533,7 @@ export default {
    * @param {Array<String>} groups The id of the groups the user should belong to
    * @param {String} token Authorization token
    */
-  updateUserGroups(userId, groups, token) {
+  updateUserGroups: (userId, groups, token) => {
     return new Promise(function (resolve, reject) {
       const requestData = removeNullProperties({
         userId: userId,
@@ -569,7 +562,7 @@ export default {
    * @param {String} newPassword The new password
    * @param {String} token Authorization token
    */
-  updateUserPassword(password, newPassword, token) {
+  updateUserPassword: (password, newPassword, token) => {
     return new Promise(function (resolve, reject) {
       const requestData = removeNullProperties({
         password: password,
@@ -593,14 +586,11 @@ export default {
   },
 
   /**
-   *
    * Validate reset password code. It returns a promise
-   *
    * @param {String} email User's email address
    * @param {String} code Provided reset code
-   *
    */
-  validateResetPasswordCode(email, code) {
+  validateResetPasswordCode: (email, code) => {
     return new Promise(function (resolve, reject) {
       let postData = removeNullProperties({
         email: email,

package/lib/utils.js

@@ -1,7 +1,3 @@
-//
-// Utilities - various generla functions
-//
-
 const utils = {
   /**
    * Convert object to array
@@ -24,4 +20,4 @@ const utils = {
   },
 };
 
-export default utils;
+module.exports = utils;

package/package.json

@@ -1,8 +1,15 @@
 {
   "name": "@stackfactor/client-api",
-  "version": "1.0.1",
-  "description": "StackFactor Client API",
+  "version": "1.0.2",
+  "description": "Node.js library for the StackFactor API",
   "main": "index.js",
+  "exports": {
+    ".": {
+      "require": "./index.js",
+      "import": "./index.js",
+      "default": "./index.js"
+    }
+  },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },