@getjones/test-infra 1.7.2 → 1.7.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@getjones/test-infra",
-  "version": "1.7.2",
+  "version": "1.7.3",
   "description": "Providing internal and openapi interface",
   "main": "src/index.js",
   "scripts": {

package/src/saas/internal-api/projects/api/core/projects.api.js

@@ -6,7 +6,8 @@ const Endpoints = {
 	delete: projectId => `${backendUrl}/saas/project/${projectId}`,
 	getByAccountId: `${backendUrl}/saas/project/list`,
 	update: `${backendUrl}/saas/project`,
-	getProjectByProjectId: projectId => `${backendUrl}/saas/project/${projectId}`
+	getProjectByProjectId: projectId => `${backendUrl}/saas/project/${projectId}`,
+	getProjectServiceAreaByProjectId: projectId => `${backendUrl}/saas/integration-tests/project/${projectId}/service-area`
 };
 
 const create = (project, context) => {
@@ -31,4 +32,8 @@ const update = (project, context) => {
 	return requests.postRequestHandler(Endpoints.update, project, context);
 };
 
-module.exports = { create, getProjectsByAccountId, deleteProjectById, update, getProjectByProjectId };
+const getProjectServiceAreaByProjectId = (projectId, context) => {
+	return requests.getRequestHandler(Endpoints.getProjectServiceAreaByProjectId(projectId), {}, context);
+};
+
+module.exports = { create, getProjectsByAccountId, deleteProjectById, update, getProjectByProjectId, getProjectServiceAreaByProjectId };

package/src/saas/internal-api/projects/api/core/projects.service.js

@@ -17,6 +17,10 @@ const getProjectByName = async (accountId, projectName, context) => {
 	return requestedProject ? requestedProject : null;
 };
 
+const getProjectServiceArea = (projectId, context) => {
+	return projectsApi.getProjectServiceAreaByProjectId(projectId, context);
+};
+
 const deleteProjectByName = async (accountId, projectName, context) => {
 	const { data: projects } = await getProjectsByAccountId(accountId, context);
 	const filteredProjects = projects.filter(project => project.projectName === projectName);
@@ -56,5 +60,6 @@ module.exports = {
 	getProjectByName,
 	createProject,
 	deleteProjectByName,
-	updateProject
+	updateProject,
+	getProjectServiceArea
 };

package/src/saas/internal-api/tabs/api/tabs.service.js

@@ -1,13 +1,13 @@
 const tabsAPI = require('./tabs.api');
+const { CreateTabModel, UpdateTabModel } = require('../models/tabs.model');
 
 const createTab = async (projectId, tabName, tabType, context) => {
-	const tabModel = { projectId, tabName, type: tabType };
+	const tabModel = new CreateTabModel(projectId, tabName, tabType);
 	return tabsAPI.createTab(tabModel, context);
 };
 
-const updateTab = async (projectId, tabName, tabType, tabId, context) => {
-	const tabModel = { projectId, tabName, type: tabType, tabId };
-	return tabsAPI.updateTab(tabModel, context);
+const getTabById = async (tabId, context) => {
+	return tabsAPI.getTabByTabId(tabId, context);
 };
 
 const getTabsByProjectId = async (projectId, context) => {
@@ -15,21 +15,13 @@ const getTabsByProjectId = async (projectId, context) => {
 };
 
 const getTabsByName = async (projectId, tabName, context, { tabType } = {}) => {
-	const { data: tabs } = await tabsAPI.getTabsByProjectId(projectId, context);
+	const { data: tabs } = await getTabsByProjectId(projectId, context);
 	const requestedTab = tabType ?
 		tabs.find(tab => tab.tabName === tabName && tab.type === tabType) :
 		tabs.find(tab => tab.tabName === tabName);
 	return requestedTab;
 };
 
-const getTabById = async (tabId, context) => {
-	return tabsAPI.getTabByTabId(tabId, context);
-};
-
-const deleteTabById = async (tabId, context) => {
-	return tabsAPI.deleteTab(tabId, context);
-};
-
 const getOrCreateTab = async (projectId, tabName, tabType, context) => {
 	const { data: tabs } = await getTabsByProjectId(projectId, context);
 	const existingTab = tabs.find(tab => tab.tabName === tabName && tab.type === tabType);
@@ -42,12 +34,21 @@ const getOrCreateTab = async (projectId, tabName, tabType, context) => {
 	return createResponse.data;
 };
 
+const updateTab = async (projectId, tabName, tabType, tabId, context) => {
+	const tabModel = new UpdateTabModel(projectId, tabName, tabType, tabId);
+	return tabsAPI.updateTab(tabModel, context);
+};
+
+const deleteTabById = async (tabId, context) => {
+	return tabsAPI.deleteTab(tabId, context);
+};
+
 module.exports = {
+	createTab,
 	getTabById,
 	getTabsByProjectId,
-	createTab,
-	updateTab,
-	deleteTabById,
+	getTabsByName,
 	getOrCreateTab,
-	getTabsByName
+	updateTab,
+	deleteTabById
 };

package/src/saas/internal-api/tabs/models/tabs.model.js

@@ -0,0 +1,18 @@
+class CreateTabModel {
+	constructor(projectId, tabName, tabType) {
+		this.projectId = projectId;
+		this.tabName = tabName;
+		this.type = tabType;
+	}
+}
+
+class UpdateTabModel {
+	constructor(projectId, tabName, tabType, tabId) {
+		this.projectId = projectId;
+		this.tabName = tabName;
+		this.type = tabType;
+		this.tabId = tabId;
+	}
+}
+
+module.exports = { CreateTabModel, UpdateTabModel };

package/README.md

@@ -1,329 +0,0 @@
-# Package Name: @getjones/test-infra
-
-## Package Goal
-
-- Providing an easy and reusable interface for the backend system. Means, both by the OpenAPI, and the internal API.
-
-## Interface
-
-### init
-
-- require the package with settled up configuration json
-
-```node
-const { internalAPI } = require("@getjones/test-infra")(conf);
-```
-
-- configuration example
-
-```node
-const dotenv = require("dotenv");
-
-dotenv.config();
-
-module.exports = {
-  backendUrl: process.env.BACKEND_URL,
-  credentials: {
-    superUser: process.env.CREDENTIALS_SUPER_USER,
-    superUserPassword: process.env.CREDENTIALS_SUPER_USER_PASSWORD,
-    strongPassword: process.env.CREDENTIALS_STRONG_PASSWORD,
-  },
-  accountCreationSecret: process.env.ACCOUNT_CREATION_SECRET,
-  environment: process.env.ENVIRONMENT,
-  email: process.env.EMAIL,
-};
-```
-
-### internalAPI
-
-- internalAPI contains the next services:
-  - auth
-  - accounts
-  - accountSettings
-  - projects
-  - projectSettings
-
-```node
-const { auth, accounts, accountSettings, projects } = internalAPI;
-```
-
-### auth
-
-```node
-/**
- *
- * @param email (string)
- * @param password (string)
- * @return Auth cookie (string) with given email privileges.
- */
-const getAuthCookie = async (email, password) => {};
-
-/**
- *
- * Required Configuration: {
- * credentials.superUser,
- * credentials.superUserPassword
- * }
- * @return ICS cookie (String)
- */
-const getIcsCookie = async () => {};
-
-/**
- *
- * Required Configuration: {
-  * credentials.auditorUser,
-  * credentials.auditorPassword
- * }
- * @return Auditor cookie (String)
- */
-const getAuditorCookie = async () => {};
-
-/**
- *
- * Required Configuration: {
- * credentials.operatorUser,
- * credentials.operatorPassword
- * }
- * @return Operator cookie (String)
- */
-const getOperatorCookie = async () => {};
-```
-
-### accounts
-
-```node
-/**
- *
- * Required Configuration: {
- *  accountCreationSecret: accountCreationSecret,
- * }
- *
- * If you want to use default password so
- * 'credentials.strongPassword' is needed
- * to be a part of the configuration.
- *
- * @param email (string)
- * @param accountName (string)
- * @param context (string): Should contain ICS cookie
- * @return Account (object)
- */
-
-const createAccount = async (
-  email,
-  accountName,
-  context,
-  password = credentials.strongPassword,
-  propertyType = PROPERTY_TYPE
-) => {};
-
-/**
- *
- * @param accountName (string)
- * @param context (string): Should contains ICS cookie
- * @return Account (object)
- */
-const getAccount = async (accountName, context) => {};
-
-/**
- *
- * @param email (string)
- * @param accountName (string)
- * @param context (string): Should contain ICS cookie
- * @param password (string)
- * @return Account (object)
- */
-const getOrCreateAccount = async (
-  email,
-  accountName,
-  context,
-  password = credentials.strongPassword
-) => {};
-
-/**
- *
- * @param accountName (string)
- * @param context (string): Should contain ICS cookie
- * @return Account ID (String)
- */
-const getAccountId = async (accountName, context) => {};
-
-/**
- *
- * @param accountName (string)
- * @param context (string): Should contains ICS cookie
- * @return Http Response
- */
-const deleteAccountByName = async (accountName, context) => {};
-
-/**
- *
- * @param accountId (string)
- * @param context (string): Should contain ICS cookie
- * @return Http Response
- */
-const deleteAccountById = async (accountId, context) => {};
-```
-
-### accountSettings
-
-```node
-/**
- *
- * @param accountId (string)
- * @param context (string): Should contain ICS cookie
- * @return Account Settings (object)
- */
-const getAccountSettings = async (accountId, context) => {};
-
-/**
- *
- * @param accountId (string)
- * @param AccountSettings (object) Should Contain:
- * isMultiPropertyTenants (boolean)
- * isHighPriority (boolean)
- * @param context (string): Should contain ICS cookie
- * @return Http Response
- */
-const updateAccountSettings = async (
-  accountId,
-  isMultiPropertyTenants,
-  isHighPriority,
-  context
-) => {};
-
-/**
- * Summary: Change account settings to default
- * Description:
- * Update The Next Account Settings:
- * isMultiPropertyTenants: false
- * isHighPriority: false
- * @param accountId (string)
- * @param context (string): Should Contain ICS cookie
- * @return Http Response
- */
-const restoreAccountSettings = async (accountId, context) => {};
-```
-
-### projects
-
-```node
-/**
- *
- * @param accountName (string)
- * @param context (string): Should contain cookie
- * User's cookie that is related to this account or ICS cookie
- * @return List of projects ([objects])
- */
-const getProjectsByAccountName = async (accountName, context) => {};
-
-/**
- *
- * @param accountId (String)
- * @param context (string): Should contain cookie
- * User's cookie that is related to this account or ICS cookie
- * @return List of projects ([objects])
- */
-const getProjectsByAccountId = async (accountId, context) => {};
-
-/**
- *
- * @param accountId (string)
- * @param projectName (string)
- * @param context (string): Should contain cookie
- * User's cookie that is related to this account or ICS cookie
- * @return List of projects ([objects])
- */
-const getProjectsByName = async (accountId, projectName, context) => {};
-
-/**
- * Summary: Delete project by given details
- * @param accountId (string)
- * @param projectName (string)
- * @param context (string): Should contain cookie
- * User's cookie that is related to this account or ICS cookie
- * @return List of projects ([objects])
- */
-const deleteProjectByName = async (accountId, projectName, context) => {};
-
-/**
- *
- * @param project (object)
- * @param accountName (string)
- * @param context (string): Should contain cookie
- * User's cookie that is related to this account or ICS cookie
- * @return object contains generated projectId
- */
-
-// Example for project input (Not all of them are required):
-const createProjectInput = {
-  projectName: project.name,
-  userId: "",
-  regionOrDivision: project.description,
-  address: project.address,
-  projectNumber: project.number,
-  projectStartDate: project.startDate,
-  projectEndDate: project.endDate,
-  city: project.city,
-  state: project.state,
-  zipCode: project.zipCode,
-  companyNameForProject: project.companyNameForProject,
-  certificateHolder: "",
-  additionalInsured: "",
-  tenantSolutionEnabled: "",
-  onboardingEnabled: "",
-  automaticRenewalEnabled: "",
-};
-
-const createProject = async (project, accountName, context) => {};
-```
-
-### projectSettings
-
-```node
-/**
- *
- * @param accountName (string)
- * @param context (string): Should contain cookie
- */
-
-const getProjectsByAccountName = async (accountName, context) => {};
-
-/**
- *
- * @param settings (object)
- * @param context (string): Should contain cookie
- */
-
-const updateProjectSettingsByProjectId = async (settings, context) => {};
-
-// Example for settings input (Not all of them are required):
-const updateProjectSettingsInput = {
-  autoGaps: {
-    Guests: false,
-    Tenants: false,
-    Vendors: false,
-  },
-  autoRenewals: false,
-  marketplace: {
-    marketplaceEnabled: false,
-    marketplacePreApproved: false,
-    marketplacePublicLink: false,
-  },
-  ocrEnabled: false,
-  onboardingPhase: false,
-  projectId: null,
-  qrEnabled: false,
-  tenantSolution: false,
-};
-```
-### serviceArea
-
-```node
-/**
-* @param city (string)
-* @param state (string)
-* @param context (string): Should contain cookie
-*/
-
-const getCoordinatesByAddress = (city, state, context) => {}
-```