microapps-automation-helper - npm Package Compare versions

Comparing version 1.6.0 to 1.7.0

API-REFERENCE.md

 # API REFERENCE
 
-- class: [api](#class:api)
+#### class: [api](#class:api)
 
-  - [getCitrixCloudTokens({ cwaAPI, citrixCloudCustomerId, citrixCloudClientId, citrixCloudClientSecret })](####getCitrixCloudTokens({cwaAPI,citrixCloudCustomerId,citrixCloudClientId,citrixCloudClientSecret}))
-  - [getIntegrations({ authInstance, microappsAdminUrl })](####getIntegrations({authInstance,microappsAdminUrl}))
-  - [getBundleCatalogue({ authInstance, microappsAdminUrl })](####getBundleCatalogue({authInstance,microappsAdminUrl}))
-  - [updateBundleCatalogue({ authInstance, microappsAdminUrl, catalogueId })](####updateBundleCatalogue({authInstance,microappsAdminUrl,catalogueId}))
-  - [updateIntegrationConfiguration({ authInstance, microappsAdminUrl, integrationId, integrationConfiguration }](####updateIntegrationConfiguration({authInstance,microappsAdminUrl,integrationId,integrationConfiguration}))
-  - [getIntegration({ authInstance, microappsAdminUrl, integrationId })](
-####getIntegration({authInstance,microappsAdminUrl,integrationId}))
-  - [integrationLogout({ authInstance, microappsAdminUrl, integrationId })](####integrationLogout({authInstance,microappsAdminUrl,integrationId}))
-  - [validateConfiguration({ authInstance, microappsAdminUrl, serviceKey, configuration })](####validateConfiguration({authInstance,microappsAdminUrl,serviceKey,configuration}))
-  - [addApp({ authInstance, microappsAdminUrl, data })](####addApp({authInstance,microappsAdminUrl,data}))
-  - [getProcessStatus({ authInstance, microappsAdminUrl, processId })](####getProcessStatus({authInstance,microappsAdminUrl,processId}))
-  - [getEntities({ authInstance, microappsAdminUrl, integrationId })](####getEntities({authInstance,microappsAdminUrl,integrationId}))
-  - [createEntity({ authInstance, microappsAdminUrl, integrationId, entityData })](####createEntity({authInstance,microappsAdminUrl,integrationId,entityData}))
-  - [finalizeConfig({ authInstance, microappsAdminUrl, integrationId })](####finalizeConfig({authInstance,microappsAdminUrl,integrationId}))
-  - [getApps({ authInstance, microappsAdminUrl })](####getApps({authInstance,microappsAdminUrl}))
-  - [getNotifications({ authInstance, microappsAdminUrl, appId })](####getNotifications({authInstance,microappsAdminUrl,appId}))
-  - [runNotificationEvent({ authInstance, microappsAdminUrl, notificationId })](####runNotificationEvent({authInstance,microappsAdminUrl,notificationId}))
-  - [startSynchronization({ authInstance, microappsAdminUrl, integrationId,synchronizationType )}](####startSynchronization({authInstance,microappsAdminUrl,integrationId,synchronizationType}))
-  - [integrityCheck({ authInstance, microappsAdminUrl })](####integrityCheck({authInstance,microappsAdminUrl}))
-  - [deleteIntegration({ authInstance, microappsAdminUrl, integrationId })](####deleteIntegration({authInstance,microappsAdminUrl,integrationId}))
-  - [getDomain({ authInstance, cwaAPI, citrixCloudCustomerId, workspaceIdentityProvider })](####getDomain({authInstance,cwaAPI,citrixCloudCustomerId,workspaceIdentityProvider}))
-  - [getUsers({ authInstance, cwaAPI, domainName, forestName, appId, query, citrixCloudCustomerId,idpType })](####getUsers({authInstance,cwaAPI,domainName,forestName,appId,query,citrixCloudCustomerId,idpType}))
-  - [updateSubscribers({ authInstance, microappsAdminUrl assign, userDetail, appId, domainName, forestName, workspaceIdentityProvider })](####updateSubscribers({authInstance,microappsAdminUrl,assign,userDetail,appId,domainName,forestName,workspaceIdentityProvider}))
-  - [getSubscribers({ authInstance, microappsAdminUrl, appId })](####getSubscribers({authInstance,microappsAdminUrl,appId}))
-  - [exportIntegration({ authInstance, microappsAdminUrl, integrationId, filePath, params })](####exportIntegration({authInstance,microappsAdminUrl,integrationId,filePath,params}))
-  - [getIntegrationLog({ authInstance, microappsAdminUrl, integrationId, integrationType })](####getIntegrationLog({authInstance,microappsAdminUrl,integrationId,integrationType}))
+  - [getCitrixCloudTokens({ cwaAPI, citrixCloudCustomerId, citrixCloudClientId, citrixCloudClientSecret })](#getCitrixCloudTokens({cwaAPI,citrixCloudCustomerId,citrixCloudClientId,citrixCloudClientSecret}))
+  - [getIntegrations({ authInstance, microappsAdminUrl })](#getIntegrations({authInstance,microappsAdminUrl}))
+  - [getBundleCatalogue({ authInstance, microappsAdminUrl })](#getBundleCatalogue({authInstance,microappsAdminUrl}))
+  - [updateBundleCatalogue({ authInstance, microappsAdminUrl, catalogueId })](#updateBundleCatalogue({authInstance,microappsAdminUrl,catalogueId}))
+  - [updateIntegrationConfiguration({ authInstance, microappsAdminUrl, integrationId, integrationConfiguration }](#updateIntegrationConfiguration({authInstance,microappsAdminUrl,integrationId,integrationConfiguration}))
+  - [getIntegration({ authInstance, microappsAdminUrl, integrationId })](#getIntegration({authInstance,microappsAdminUrl,integrationId}))
+  - [integrationLogout({ authInstance, microappsAdminUrl, integrationId })](#integrationLogout({authInstance,microappsAdminUrl,integrationId}))
+  - [validateConfiguration({ authInstance, microappsAdminUrl, serviceKey, configuration })](#validateConfiguration({authInstance,microappsAdminUrl,serviceKey,configuration}))
+  - [addApp({ authInstance, microappsAdminUrl, data })](#addApp({authInstance,microappsAdminUrl,data}))
+  - [getProcessStatus({ authInstance, microappsAdminUrl, processId })](#getProcessStatus({authInstance,microappsAdminUrl,processId}))
+  - [getEntities({ authInstance, microappsAdminUrl, integrationId })](#getEntities({authInstance,microappsAdminUrl,integrationId}))
+  - [createEntity({ authInstance, microappsAdminUrl, integrationId, entityData })](#createEntity({authInstance,microappsAdminUrl,integrationId,entityData}))
+  - [finalizeConfig({ authInstance, microappsAdminUrl, integrationId })](#finalizeConfig({authInstance,microappsAdminUrl,integrationId}))
+  - [getApps({ authInstance, microappsAdminUrl })](#getApps({authInstance,microappsAdminUrl}))
+  - [getNotifications({ authInstance, microappsAdminUrl, appId })](#getNotifications({authInstance,microappsAdminUrl,appId}))
+  - [runNotificationEvent({ authInstance, microappsAdminUrl, notificationId })](#runNotificationEvent({authInstance,microappsAdminUrl,notificationId}))
+  - [startSynchronization({ authInstance, microappsAdminUrl, integrationId,synchronizationType )}](#startSynchronization({authInstance,microappsAdminUrl,integrationId,synchronizationType}))
+  - [integrityCheck({ authInstance, microappsAdminUrl })](#integrityCheck({authInstance,microappsAdminUrl}))
+  - [deleteIntegration({ authInstance, microappsAdminUrl, integrationId })](#deleteIntegration({authInstance,microappsAdminUrl,integrationId}))
+  - [getDomain({ authInstance, cwaAPI, citrixCloudCustomerId, workspaceIdentityProvider })](#getDomain({authInstance,cwaAPI,citrixCloudCustomerId,workspaceIdentityProvider}))
+  - [getUsers({ authInstance, cwaAPI, domainName, forestName, appId, query, citrixCloudCustomerId,idpType })](#getUsers({authInstance,cwaAPI,domainName,forestName,appId,query,citrixCloudCustomerId,idpType}))
+  - [updateSubscribers({ authInstance, microappsAdminUrl assign, userDetail, appId, domainName, forestName, workspaceIdentityProvider })](#updateSubscribers({authInstance,microappsAdminUrl,assign,userDetail,appId,domainName,forestName,workspaceIdentityProvider}))
+  - [getSubscribers({ authInstance, microappsAdminUrl, appId })](#getSubscribers({authInstance,microappsAdminUrl,appId}))
+  - [exportIntegration({ authInstance, microappsAdminUrl, integrationId, filePath, params })](#exportIntegration({authInstance,microappsAdminUrl,integrationId,filePath,params}))
+  - [getIntegrationLog({ authInstance, microappsAdminUrl, integrationId, integrationType })](#getIntegrationLog({authInstance,microappsAdminUrl,integrationId,integrationType}))
 
-- class: [citrixCloud](#class:citrixCloud)
-  - [getAuthenticatorCode({ secretKey }](####getAuthenticatorCode({secretKey}))
-  - [getCCBearerToken({ cwaAPI, citrixCloudCustomerId, citrixCloudClientId, citrixCloudClientSecret }](####getCCBearerToken({cwaAPI,citrixCloudCustomerId,citrixCloudClientId,citrixCloudClientSecret}))
-  - [createAuthInstance({ bearerToken }](###createAuthInstance({bearerToken}))
+#### class: [citrixCloud](#class:citrixCloud)
+  - [getAuthenticatorCode({ secretKey }](#getAuthenticatorCode({secretKey}))
+  - [getCCBearerToken({ cwaAPI, citrixCloudCustomerId, citrixCloudClientId, citrixCloudClientSecret }](#getCCBearerToken({cwaAPI,citrixCloudCustomerId,citrixCloudClientId,citrixCloudClientSecret}))
+  - [createAuthInstance({ bearerToken }](#createAuthInstance({bearerToken}))
 
-- class: [microappsAdmin](#class:microappsAdmin)
-  - [login({ page, url, username, password, mfa , secretKey }](####login({page,url,username,password,mfa,secretKey}))
-  - [getIntegrationId({ authInstance, microappsAdminUrl, integrationName }](####getIntegrationId({authInstance,microappsAdminUrl,integrationName}))
-  - [oauthLogout({ authInstance, microappsAdminUrl, integrationName, repeatCount }](####oauthLogout({authInstance,microappsAdminUrl,integrationName,repeatCount}))
-  - [waitForSync({ getIntegration, synchronizationType }](####waitForSync({getIntegration,synchronizationType}))
-  - [runSynchronization({ authInstance, microappsAdminUrl, integrationName, synchronizationType, }](####runSynchronization({authInstance,microappsAdminUrl,integrationName,synchronizationType}))
-  - [createHTTPIntegration({ authInstance, microappsAdminUrl, integrationName, integrationConfiguration, }](####createHTTPIntegration({authInstance,microappsAdminUrl,integrationName,integrationConfiguration}))
-  - [waitForProcessStatus({ authInstance, status, microappsAdminUrl, processId }](####waitForProcessStatus({authInstance,status,microappsAdminUrl,processId}))
-  - [createJavaIntegration({ authInstance, microappsAdminUrl, integrationConfiguration, withEntities, serviceType , serviceKey, name }](####createJavaIntegration({authInstance,microappsAdminUrl,integrationConfiguration,withEntities,serviceType,serviceKey,name}))
-  - [getIntegrationType({ authInstance, microappsAdminUrl, integrationName }](####getIntegrationType({authInstance,microappsAdminUrl,integrationName}))
-  - [getStatusIntegration({ authInstance, microappsAdminUrl, integrationName }](####getStatusIntegration({authInstance,microappsAdminUrl,integrationName}))
-  - [importIntegration({ authInstance, microappsAdminUrl, pathToFile }](####importIntegration({authInstance,microappsAdminUrl,pathToFile}))
-  - [renameIntegration({ authInstance, microappsAdminUrl, integrationName, newIntegrationName, integrationConfiguration }](####renameIntegration({authInstance,microappsAdminUrl,integrationName,newIntegrationName,integrationConfiguration}))
-  - [exportApp({ authInstance, microappsAdminUrl, appId, pathToFile }](####exportApp({authInstance,microappsAdminUrl,appId,pathToFile}))
-  - [getMicroAppId({ authInstance, microappsAdminUrl, integrationId, appName }](####getMicroAppId({authInstance,microappsAdminUrl,integrationId,appName}))
-  - [getNotificationId({ authInstance, microappsAdminUrl, appId, notificationName }](####getNotificationId({authInstance,microappsAdminUrl,appId,notificationName}))
-  - [runEvent({ authInstance, microappsAdminUrl, integrationName, appName, notificationName }](####runEvent({authInstance,microappsAdminUrl,integrationName,appName,notificationName}))
-  - [checkAppMissconfigurations({ authInstance, microappsAdminUrl, appId }](####checkAppMissconfigurations({authInstance,microappsAdminUrl,appId}))
-  - [addSubscriber({ authInstance, appId, user, config }](####addSubscriber({authInstance,appId,user,config}))
-  - [addSubscribers({ authInstance, integrationName, microapps, microappsAdminUrl, config }](####addSubscribers({authInstance,integrationName,microapps,microappsAdminUrl,config}))
-  - [importIntegrationUI({ page, microappsAdminUrl, filePath }](####importIntegrationUI({page,microappsAdminUrl,filePath}))
-  - [importMicroAppUI({ page, microappsAdminUrl, filePath, integrationName }](####importMicroAppUI({page,microappsAdminUrl,filePath,integrationName}))
-  - [exportIntegrationUI({ page, integrationName }](####exportIntegrationUI({page,integrationName}))
-  - [exportMicroAppsUI({ page, integrationName, appName }](####exportMicroAppsUI({page,integrationName,appName}))
-  - [getLastTimeSync({ authInstance, microappsAdminUrl, integrationName }](####getLastTimeSync({authInstance,microappsAdminUrl,integrationName}))
+#### class: [microappsAdmin](#class:microappsAdmin)
+  - [login({ page, url, username, password, mfa , secretKey }](#login({page,url,username,password,mfa,secretKey}))
+  - [getIntegrationId({ authInstance, microappsAdminUrl, integrationName }](#getIntegrationId({authInstance,microappsAdminUrl,integrationName}))
+  - [oauthLogout({ authInstance, microappsAdminUrl, integrationName, repeatCount }](#oauthLogout({authInstance,microappsAdminUrl,integrationName,repeatCount}))
+  - [waitForSync({ getIntegration, synchronizationType }](#waitForSync({getIntegration,synchronizationType}))
+  - [runSynchronization({ authInstance, microappsAdminUrl, integrationName, synchronizationType, }](#runSynchronization({authInstance,microappsAdminUrl,integrationName,synchronizationType}))
+  - [createHTTPIntegration({ authInstance, microappsAdminUrl, integrationName, integrationConfiguration, }](#createHTTPIntegration({authInstance,microappsAdminUrl,integrationName,integrationConfiguration}))
+  - [waitForProcessStatus({ authInstance, status, microappsAdminUrl, processId }](#waitForProcessStatus({authInstance,status,microappsAdminUrl,processId}))
+  - [createJavaIntegration({ authInstance, microappsAdminUrl, integrationConfiguration, withEntities, serviceType , serviceKey, name }](#createJavaIntegration({authInstance,microappsAdminUrl,integrationConfiguration,withEntities,serviceType,serviceKey,name}))
+  - [getIntegrationType({ authInstance, microappsAdminUrl, integrationName }](#getIntegrationType({authInstance,microappsAdminUrl,integrationName}))
+  - [getStatusIntegration({ authInstance, microappsAdminUrl, integrationName }](#getStatusIntegration({authInstance,microappsAdminUrl,integrationName}))
+  - [importIntegration({ authInstance, microappsAdminUrl, pathToFile }](#importIntegration({authInstance,microappsAdminUrl,pathToFile}))
+  - [renameIntegration({ authInstance, microappsAdminUrl, integrationName, newIntegrationName, integrationConfiguration }](#renameIntegration({authInstance,microappsAdminUrl,integrationName,newIntegrationName,integrationConfiguration}))
+  - [exportApp({ authInstance, microappsAdminUrl, appId, pathToFile }](#exportApp({authInstance,microappsAdminUrl,appId,pathToFile}))
+  - [getMicroAppId({ authInstance, microappsAdminUrl, integrationId, appName }](#getMicroAppId({authInstance,microappsAdminUrl,integrationId,appName}))
+  - [getNotificationId({ authInstance, microappsAdminUrl, appId, notificationName }](#getNotificationId({authInstance,microappsAdminUrl,appId,notificationName}))
+  - [runEvent({ authInstance, microappsAdminUrl, integrationName, appName, notificationName }](#runEvent({authInstance,microappsAdminUrl,integrationName,appName,notificationName}))
+  - [checkAppMissconfigurations({ authInstance, microappsAdminUrl, appId }](#checkAppMissconfigurations({authInstance,microappsAdminUrl,appId}))
+  - [addSubscriber({ authInstance, appId, user, config }](#addSubscriber({authInstance,appId,user,config}))
+  - [addSubscribers({ authInstance, integrationName, microapps, microappsAdminUrl, config }](#addSubscribers({authInstance,integrationName,microapps,microappsAdminUrl,config}))
+  - [importIntegrationUI({ page, microappsAdminUrl, filePath }](#importIntegrationUI({page,microappsAdminUrl,filePath}))
+  - [importMicroAppUI({ page, microappsAdminUrl, filePath, integrationName }](#importMicroAppUI({page,microappsAdminUrl,filePath,integrationName}))
+  - [exportIntegrationUI({ page, integrationName }](#exportIntegrationUI({page,integrationName}))
+  - [exportMicroAppsUI({ page, integrationName, appName }](#exportMicroAppsUI({page,integrationName,appName}))
+  - [getLastTimeSync({ authInstance, microappsAdminUrl, integrationName }](#getLastTimeSync({authInstance,microappsAdminUrl,integrationName}))
 
-- class: [workspace](#class:workspace)
-  - [workspace.login({ page, workspaceUrl, workspaceUsername, workspacePassword, workspaceIdentityProvider })](<####workspace.login({page,workspaceUrl,workspaceUsername,workspacePassword,workspaceIdentityProvider})>)
-  - [workspace.skipTour({ page })](<####workspace.skipTour({page})>)
-  - [workspace.goToActions({ page })](<####workspace.goToActions({page})>)
-  - [workspace.startAction({ page, actionName, integrationName })](<####workspace.startAction({page,actionName,integrationName})>)
-  - [workspace.getFeedNotifications({ page })](<####workspace.getFeedNotifications({page})>)
-  - [workspace.waitForFeedCardId({ page, recordId[, repeatMax, waitTime, notificationId]})](<####workspace.waitForFeedCardId({page,recordId[,repeatMax,waitTime,notificationId]})>)
-  - [workspace.getFeedCardButton({ page, feedCardId, buttonName })](<####workspace.getFeedCardButton({page,feedCardId,buttonName})>)
-  - [workspace.waitForPopUp({ page, text })](<####workspace.waitForPopUp({page,text})>)
+##### class: [workspace](#class:workspace)
+  - [workspace.login({ page, workspaceUrl, workspaceUsername, workspacePassword, workspaceIdentityProvider })](<#workspace.login({page,workspaceUrl,workspaceUsername,workspacePassword,workspaceIdentityProvider})>)
+  - [workspace.skipTour({ page })](<#workspace.skipTour({page})>)
+  - [workspace.goToActions({ page })](<#workspace.goToActions({page})>)
+  - [workspace.startAction({ page, actionName, integrationName })](<#workspace.startAction({page,actionName,integrationName})>)
+  - [workspace.getFeedNotifications({ page })](<#workspace.getFeedNotifications({page})>)
+  - [workspace.waitForFeedCardId({ page, recordId[, repeatMax, waitTime, notificationId]})](<#workspace.waitForFeedCardId({page,recordId[,repeatMax,waitTime,notificationId]})>)
+  - [workspace.getFeedCardButton({ page, feedCardId, buttonName })](<#workspace.getFeedCardButton({page,feedCardId,buttonName})>)
+  - [workspace.waitForPopUp({ page, text })](<#workspace.waitForPopUp({page,text})>)
 
@@ -73,0 +72,0 @@ &nbsp;

dist/citrixCloud.js

@@ -44,2 +44,3 @@ "use strict";
         catch (error) {
+            console.log(error.stack);
             throw new Error(await helpers_1.paramsCheck({
@@ -46,0 +47,0 @@ params: { token, response },

dist/helpers.js

@@ -100,7 +100,7 @@ "use strict";
     else {
-        console.log(error.stack);
         errorReport.ErrorReport.possibleReasons.push('Undefined error. Error has been printed.');
     }
+    console.log(error.stack);
     console.log(errorReport);
-    throw new Error('Request failed. Please review the ErrorReport above.');
+    throw new Error('Request failed. Please review the Error Report above.');
 };
@@ -107,0 +107,0 @@ exports.paramsCheck = async ({ params, functionType, source }) => {

dist/microappsAdmin.js

@@ -69,2 +69,3 @@ "use strict";
         catch (error) {
+            console.log(error.stack);
             throw new Error(await helpers_1.paramsCheck({
@@ -117,2 +118,3 @@ params: { integration, integrationId, integrations },
                 catch (error) {
+                    console.log(error.stack);
                     throw new Error(await helpers_1.paramsCheck({
@@ -170,2 +172,3 @@ params: { jobRun, jobRuns },
         catch (error) {
+            console.log(error.stack);
             throw new Error(await helpers_1.paramsCheck({
@@ -224,2 +227,3 @@ params: { integration, jobRuns, getJobRunDetail },
         catch (error) {
+            console.log(error.stack);
             throw new Error(await helpers_1.paramsCheck({
@@ -287,2 +291,3 @@ params: { catalogueDetail, catalogueId, bundleCatalogueData },
         catch (error) {
+            console.log(error.stack);
             throw new Error(await helpers_1.paramsCheck({
@@ -386,3 +391,3 @@ params: { configurationParameters, integrationConfiguration },
      */
-    async getIntegrationType({ authInstance, microappsAdminUrl, integrationName }) {
+    async getIntegrationType({ authInstance, microappsAdminUrl, integrationName, }) {
         const integrations = await this.getIntegrations({
@@ -402,2 +407,3 @@ authInstance,
         catch (error) {
+            console.log(error.stack);
             throw new Error(await helpers_1.paramsCheck({
@@ -488,2 +494,3 @@ params: { findIntegrationType, integrationType, integrationsData },
         catch (error) {
+            console.log(error.stack);
             throw new Error(await helpers_1.paramsCheck({
@@ -545,3 +552,3 @@ params: { integrationDetail, integrationsData },
      */
-    async getNotificationId({ authInstance, microappsAdminUrl, appId, notificationName }) {
+    async getNotificationId({ authInstance, microappsAdminUrl, appId, notificationName, }) {
         const notifications = await this.getNotifications({
@@ -562,2 +569,3 @@ authInstance,
         catch (error) {
+            console.log(error.stack);
             throw new Error(await helpers_1.paramsCheck({
@@ -577,3 +585,3 @@ params: { getNotificationId, notificationId, notificationsData },
      * @param {string} appName - Name of App
-     *  @param {string} notificationName - Name of Notification
+     * @param {string} notificationName - Name of Notification
      */
@@ -632,2 +640,3 @@ async runEvent({ authInstance, microappsAdminUrl, integrationName, appName, notificationName }) {
         catch (error) {
+            console.log(error.stack);
             throw new Error(await helpers_1.paramsCheck({
@@ -644,3 +653,2 @@ params: { missconfigurations, responseBody },
     }
-    //TO-DO add config as parametr
     async addSubscriber({ authInstance, appId, user, config }) {
@@ -678,2 +686,3 @@ const { microappsAdminUrl, citrixCloudCustomerId, cwaAPI, workspaceIdentityProvider } = config;
                 catch (error) {
+                    console.log(error.stack);
                     throw new Error(await helpers_1.paramsCheck({
@@ -716,2 +725,3 @@ params: { domainDetail, domainsData },
             catch (error) {
+                console.log(error.stack);
                 throw new Error(await helpers_1.paramsCheck({
@@ -908,2 +918,3 @@ params: { userDetail, userData },
         catch (error) {
+            console.log(error.stack);
             throw new Error(await helpers_1.paramsCheck({
@@ -922,2 +933,3 @@ params: { getPage, components, pagesData },
         catch (error) {
+            console.log(error.stack);
             throw new Error(await helpers_1.paramsCheck({
@@ -924,0 +936,0 @@ params: { getComponent, componentId, components },

dist/workspace.js

@@ -134,2 +134,3 @@ "use strict";
             catch (error) {
+                console.log(error.stack);
                 throw new Error(await helpers_1.paramsCheck({
@@ -175,2 +176,12 @@ params: { feedCardDetail, feedCardId, data },
     }
+    /**
+     * Get one time token for DsAuth
+     *
+     * @param {string} workspaceUrl - Workspace url
+     * @param {string} builderDomain - Builder domain
+     * @param {string} csrfToken - Csrf token
+     * @param {string} sessionId - Session Id
+     * @param {string} ctxsAuthId - CtxsAuth Id
+     * @param {string} authDomain - Auth Domain
+     */
     async getOneTimeToken({ workspaceUrl, builderDomain, csrfToken, sessionId, ctxsAuthId, authDomain, }) {
@@ -194,2 +205,3 @@ const response = await axios_1.default({
         catch (error) {
+            console.log(error.stack);
             throw new Error(await helpers_1.paramsCheck({
@@ -202,2 +214,9 @@ params: { token, response },
     }
+    /**
+     * Get citrix csrf token and jSessionId
+     *
+     * @param {string} builderDomain - Builder domain
+     * @param {string} authDomain - Auth Domain
+     * @param {string} oneTimeToken - One time token
+     */
     async getTokens({ builderDomain, authDomain, oneTimeToken }) {
@@ -220,2 +239,3 @@ const response = await axios_1.default({
         catch (error) {
+            console.log(error.stack);
             throw new Error(await helpers_1.paramsCheck({
@@ -249,2 +269,3 @@ params: { citrixToken, response },
         catch (error) {
+            console.log(error.stack);
             throw new Error(await helpers_1.paramsCheck({
@@ -261,2 +282,3 @@ params: { csfrTokenCookie, csrfToken, cookies },
         catch (error) {
+            console.log(error.stack);
             throw new Error(await helpers_1.paramsCheck({
@@ -273,2 +295,3 @@ params: { sessionIdCookie, sessionId, cookies },
         catch (error) {
+            console.log(error.stack);
             throw new Error(await helpers_1.paramsCheck({
@@ -322,2 +345,3 @@ params: { ctxsAuthIdCookie, ctxsAuthId, cookies },
         catch (error) {
+            console.log(error.stack);
             throw new Error(await helpers_1.paramsCheck({
@@ -324,0 +348,0 @@ params: { token, response },

package.json

 {
   "name": "microapps-automation-helper",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "> library which provides common functions to test integration between Microapps Admin and Citrix Worskspace",
@@ -5,0 +5,0 @@ "main": "index.js",

src/citrixCloud.ts

@@ -1,2 +0,2 @@
-import axios from 'axios';
+import axios, { AxiosInstance } from 'axios';
 import { authenticator } from 'otplib';
@@ -48,2 +48,3 @@ import { API } from './api';
         } catch (error) {
+            console.log(error.stack);
             throw new Error(
@@ -50,0 +51,0 @@ await paramsCheck({

src/helpers.ts

@@ -117,10 +117,9 @@ import type { GetCookie, ErrorHandle, ParamsCheck } from './types/helpers';
     } else {
-        console.log(error.stack);
-
         errorReport.ErrorReport.possibleReasons.push('Undefined error. Error has been printed.');
     }
 
+    console.log(error.stack);
     console.log(errorReport);
 
-    throw new Error('Request failed. Please review the ErrorReport above.');
+    throw new Error('Request failed. Please review the Error Report above.');
 };
@@ -127,0 +126,0 @@

src/microappsAdmin.ts

@@ -53,3 +53,2 @@ import FormData from 'form-data';
      */
-
     async login({ page, url, username, password, mfa = null, secretKey }: MicroappsAdminLogin) {
@@ -91,4 +90,3 @@ await page.goto(url, { waitUntil: 'domcontentloaded' });
      */
-
-    async getIntegrationId({ authInstance, microappsAdminUrl, integrationName }: GetIntegrationId) {
+    async getIntegrationId({ authInstance, microappsAdminUrl, integrationName }: GetIntegrationId): Promise<string> {
         let integrationId;
@@ -103,2 +101,3 @@ let integration;
         } catch (error) {
+            console.log(error.stack);
             throw new Error(
@@ -159,2 +158,3 @@ await paramsCheck({
                 } catch (error) {
+                    console.log(error.stack);
                     throw new Error(
@@ -223,2 +223,3 @@ await paramsCheck({
         } catch (error) {
+            console.log(error.stack);
             throw new Error(
@@ -276,3 +277,3 @@ await paramsCheck({
         integrationConfiguration,
-    }: CreateHTTPIntegration) {
+    }: CreateHTTPIntegration): Promise<string> {
         const bundleCatalogue = await this.getBundleCatalogue({
@@ -291,2 +292,3 @@ authInstance,
         } catch (error) {
+            console.log(error.stack);
             throw new Error(
@@ -371,2 +373,3 @@ await paramsCheck({
         } catch (error) {
+            console.log(error.stack);
             throw new Error(
@@ -492,3 +495,7 @@ await paramsCheck({
 
-    async getIntegrationType({ authInstance, microappsAdminUrl, integrationName }: GetIntegrationType) {
+    async getIntegrationType({
+        authInstance,
+        microappsAdminUrl,
+        integrationName,
+    }: GetIntegrationType): Promise<string> {
         const integrations = await this.getIntegrations({
@@ -510,2 +517,3 @@ authInstance,
         } catch (error) {
+            console.log(error.stack);
             throw new Error(
@@ -616,2 +624,3 @@ await paramsCheck({
         } catch (error) {
+            console.log(error.stack);
             throw new Error(
@@ -661,3 +670,3 @@ await paramsCheck({
 
-    async getMicroAppId({ authInstance, microappsAdminUrl, integrationId, appName }: GetMicroAppId) {
+    async getMicroAppId({ authInstance, microappsAdminUrl, integrationId, appName }: GetMicroAppId): Promise<string> {
         let apps;
@@ -687,3 +696,8 @@ try {
 
-    async getNotificationId({ authInstance, microappsAdminUrl, appId, notificationName }: GetNotificationId) {
+    async getNotificationId({
+        authInstance,
+        microappsAdminUrl,
+        appId,
+        notificationName,
+    }: GetNotificationId): Promise<string> {
         const notifications = await this.getNotifications({
@@ -706,2 +720,3 @@ authInstance,
         } catch (error) {
+            console.log(error.stack);
             throw new Error(
@@ -725,3 +740,3 @@ await paramsCheck({
      * @param {string} appName - Name of App
-     *  @param {string} notificationName - Name of Notification
+     * @param {string} notificationName - Name of Notification
      */
@@ -789,2 +804,3 @@
         } catch (error) {
+            console.log(error.stack);
             throw new Error(
@@ -806,3 +822,2 @@ await paramsCheck({
 
-    //TO-DO add config as parametr
     async addSubscriber({ authInstance, appId, user, config }: AddSubscriber) {
@@ -841,2 +856,3 @@ const { microappsAdminUrl, citrixCloudCustomerId, cwaAPI, workspaceIdentityProvider } = config;
                 } catch (error) {
+                    console.log(error.stack);
                     throw new Error(
@@ -884,2 +900,3 @@ await paramsCheck({
             } catch (error) {
+                console.log(error.stack);
                 throw new Error(
@@ -1142,2 +1159,3 @@ await paramsCheck({
         } catch (error) {
+            console.log(error.stack);
             throw new Error(
@@ -1152,3 +1170,3 @@ await paramsCheck({
         let getComponent;
-        let componentId;
+        let componentId: string;
         try {
@@ -1158,2 +1176,3 @@ getComponent = components.filter((component: { label: string }) => component.label === componentLabel);
         } catch (error) {
+            console.log(error.stack);
             throw new Error(
@@ -1160,0 +1179,0 @@ await paramsCheck({

src/workspace.ts

@@ -54,3 +54,3 @@ import axios from 'axios';
                 await page.click('input[value="Next"]');
-                await page.waitForSelector('#loginHeader >> text=Enter password')
+                await page.waitForSelector('#loginHeader >> text=Enter password');
                 await page.waitForSelector('input[name="passwd"]');
@@ -166,2 +166,3 @@ await page.fill('input[name="passwd"]', workspacePassword);
             } catch (error) {
+                console.log(error.stack);
                 throw new Error(
@@ -217,2 +218,12 @@ await paramsCheck({
 
+    /**
+     * Get one time token for DsAuth
+     *
+     * @param {string} workspaceUrl - Workspace url
+     * @param {string} builderDomain - Builder domain
+     * @param {string} csrfToken - Csrf token
+     * @param {string} sessionId - Session Id
+     * @param {string} ctxsAuthId - CtxsAuth Id
+     * @param {string} authDomain - Auth Domain
+     */
     async getOneTimeToken({
@@ -225,3 +236,3 @@ workspaceUrl,
         authDomain,
-    }: GetOneTimeToken) {
+    }: GetOneTimeToken): Promise<string> {
         const response = await axios({
@@ -244,6 +255,9 @@ url: `${workspaceUrl}/Citrix/StoreWeb/Sso/Proxy`,
         } catch (error) {
-            throw new Error(await paramsCheck({
-                params: { token, response },
-                source: 'response',
-            }))
+            console.log(error.stack);
+            throw new Error(
+                await paramsCheck({
+                    params: { token, response },
+                    source: 'response',
+                })
+            );
         }
@@ -254,3 +268,13 @@
 
-    async getTokens({ builderDomain, authDomain, oneTimeToken }: GetTokens) {
+    /**
+     * Get citrix csrf token and jSessionId
+     *
+     * @param {string} builderDomain - Builder domain
+     * @param {string} authDomain - Auth Domain
+     * @param {string} oneTimeToken - One time token
+     */
+    async getTokens({ builderDomain, authDomain, oneTimeToken }: GetTokens): Promise<{
+        citrixToken: string;
+        jSessionId: string;
+    }> {
         const response = await axios({
@@ -272,6 +296,9 @@ url: `${builderDomain}/app/api/auth/dsauth`,
         } catch (error) {
-            throw new Error(await paramsCheck({
-                params: { citrixToken, response },
-                source: 'response',
-            }))
+            console.log(error.stack);
+            throw new Error(
+                await paramsCheck({
+                    params: { citrixToken, response },
+                    source: 'response',
+                })
+            );
         }
@@ -307,3 +334,3 @@
         let csfrTokenCookie, sessionIdCookie, ctxsAuthIdCookie;
-        let csrfToken: any, sessionId: any, ctxsAuthId: any;
+        let csrfToken: string, sessionId: string, ctxsAuthId: string;
         try {
@@ -313,2 +340,3 @@ csfrTokenCookie = cookies.find((e) => e.name === 'CsrfToken');
         } catch (error) {
+            console.log(error.stack);
             throw new Error(
@@ -326,2 +354,3 @@ await paramsCheck({
         } catch (error) {
+            console.log(error.stack);
             throw new Error(
@@ -339,2 +368,3 @@ await paramsCheck({
         } catch (error) {
+            console.log(error.stack);
             throw new Error(
@@ -404,2 +434,3 @@ await paramsCheck({
         } catch (error) {
+            console.log(error.stack);
             throw new Error(
@@ -406,0 +437,0 @@ await paramsCheck({

types/citrixCloud.d.ts

@@ -0,1 +1,2 @@
+import { AxiosInstance } from 'axios';
 import { API } from './api';
@@ -24,3 +25,3 @@ import type { GetAuthenticatorCode, GetCCBearerToken, CreateAuthInstance } from './types/citrixCloud';
      */
-    createAuthInstance({ bearerToken }: CreateAuthInstance): Promise<import("axios").AxiosInstance>;
+    createAuthInstance({ bearerToken }: CreateAuthInstance): Promise<AxiosInstance>;
 }

types/microappsAdmin.d.ts

@@ -20,3 +20,3 @@ import { API } from './api';
      */
-    getIntegrationId({ authInstance, microappsAdminUrl, integrationName }: GetIntegrationId): Promise<any>;
+    getIntegrationId({ authInstance, microappsAdminUrl, integrationName }: GetIntegrationId): Promise<string>;
     /**
@@ -51,3 +51,3 @@ * Delete credentiaslds from credentials wallet for specific inregration
      */
-    createHTTPIntegration({ authInstance, microappsAdminUrl, integrationName, integrationConfiguration, }: CreateHTTPIntegration): Promise<any>;
+    createHTTPIntegration({ authInstance, microappsAdminUrl, integrationName, integrationConfiguration, }: CreateHTTPIntegration): Promise<string>;
     /**
@@ -75,3 +75,3 @@ * Wait for  process status
      */
-    getIntegrationType({ authInstance, microappsAdminUrl, integrationName }: GetIntegrationType): Promise<any>;
+    getIntegrationType({ authInstance, microappsAdminUrl, integrationName, }: GetIntegrationType): Promise<string>;
     /**
@@ -83,3 +83,3 @@ * Get status of Integration
      */
-    getStatusIntegration({ authInstance, microappsAdminUrl, integrationName }: GetStatusIntegration): Promise<any>;
+    getStatusIntegration({ authInstance, microappsAdminUrl, integrationName }: GetStatusIntegration): Promise<string>;
     /**
@@ -116,3 +116,3 @@ * Import integration
      */
-    getMicroAppId({ authInstance, microappsAdminUrl, integrationId, appName }: GetMicroAppId): Promise<any>;
+    getMicroAppId({ authInstance, microappsAdminUrl, integrationId, appName }: GetMicroAppId): Promise<string>;
     /**
@@ -125,3 +125,3 @@ * Get Id of Notification
      */
-    getNotificationId({ authInstance, microappsAdminUrl, appId, notificationName }: GetNotificationId): Promise<any>;
+    getNotificationId({ authInstance, microappsAdminUrl, appId, notificationName, }: GetNotificationId): Promise<string>;
     /**
@@ -133,3 +133,3 @@ * Run a Event
      * @param {string} appName - Name of App
-     *  @param {string} notificationName - Name of Notification
+     * @param {string} notificationName - Name of Notification
      */
@@ -190,3 +190,3 @@ runEvent({ authInstance, microappsAdminUrl, integrationName, appName, notificationName }: RunEvent): Promise<void>;
      */
-    getComponentId({ authInstance, microappsAdminUrl, integrationName, appName, pageName, componentLabel, }: GetComponentId): Promise<any>;
+    getComponentId({ authInstance, microappsAdminUrl, integrationName, appName, pageName, componentLabel, }: GetComponentId): Promise<string>;
     /**
@@ -193,0 +193,0 @@ * Waits for all integrations to finish the sync and validate the results

types/workspace.d.ts

@@ -60,3 +60,20 @@ import type { Login, CreateDsAuthInstance, GoToActions, StartAction, SkipTour, GetDsauthTokens, GetFeedCardButton, GetFeedNotifications, GetOneTimeToken, GetTokens, GetUserData, WaitForFeedCardId, WaitForPopUp } from './types/workspace';
     waitForPopUp({ page, text }: WaitForPopUp): Promise<void>;
+    /**
+     * Get one time token for DsAuth
+     *
+     * @param {string} workspaceUrl - Workspace url
+     * @param {string} builderDomain - Builder domain
+     * @param {string} csrfToken - Csrf token
+     * @param {string} sessionId - Session Id
+     * @param {string} ctxsAuthId - CtxsAuth Id
+     * @param {string} authDomain - Auth Domain
+     */
     getOneTimeToken({ workspaceUrl, builderDomain, csrfToken, sessionId, ctxsAuthId, authDomain, }: GetOneTimeToken): Promise<string>;
+    /**
+     * Get citrix csrf token and jSessionId
+     *
+     * @param {string} builderDomain - Builder domain
+     * @param {string} authDomain - Auth Domain
+     * @param {string} oneTimeToken - One time token
+     */
     getTokens({ builderDomain, authDomain, oneTimeToken }: GetTokens): Promise<{
@@ -63,0 +80,0 @@ citrixToken: string;

No alert changes

Improved metrics

Total package byte prevSize

265127

increased by1.35%

Lines of code

6041

increased by1.82%

No dependency changes