From 69ac0d884f5dd3ef615eead99cb3286039e6ec6f Mon Sep 17 00:00:00 2001 From: mihay42 Date: Fri, 30 Sep 2022 12:16:38 -0700 Subject: [PATCH 1/4] Fixed mr_setup and cli/config behaviors --- cli/mr_setup.js | 11 ++++++----- package.json | 2 +- src/cli.js | 5 ++--- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/cli/mr_setup.js b/cli/mr_setup.js index 953c841..f9dd6a4 100755 --- a/cli/mr_setup.js +++ b/cli/mr_setup.js @@ -27,8 +27,10 @@ function parseCLIArgs() { program // System command line switches .requiredOption( - '-n --no_splash', - 'Whether or not to include the splash screen at startup.' + '-s --splash ', + 'Whether or not to include the splash screen at startup.', + 'yes', + 'no' ) program.parse(process.argv) @@ -40,7 +42,7 @@ function getEnv () { return { DEFAULT: { // TODO Create choices for the rest_server so the user doesn't have to figure this out - rest_server: "http://cherokee.from-ca.com:46767", + rest_server: "http://cherokee.from-ca.com:16767", user: "rflores", // For now we're not going to prompt for this it is a placeholder secret: "password", // For now we're not going to prompt for this it is a placeholder api_key: "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InJmbG9yZXMiLCJjb21wYW55IjoieCIsImlhdCI6MTY1NTAwNDM2NH0.znocDyjS4VSS9tu_ND-pUKw76yNgseUUHYpJ1Tq87do", @@ -91,7 +93,6 @@ function splashScreen (simple=false) { } // Check to see if we are going to need to perform a setup operation or not. -// TODO if the config file exists we should warn the user async function checkSetup(fileName) { const utils = new Utilities('setup') const [exists, message, result] = utils.checkFilesystemObject(fileName) @@ -189,7 +190,7 @@ async function checkSection(env, sectionType) { const myArgs = parseCLIArgs() // Unless we suppress this print out the splash screen. -if (!myArgs.no_splash) { +if (!myArgs.splash === 'yes') { splashScreen() } diff --git a/package.json b/package.json index 3245bf0..50ad701 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "mediumroast_js", - "version": "0.3.1", + "version": "0.3.2", "description": "A Javascript SDK to interact with the mediumroast.io application including command line interfaces.", "main": "src/api/mrServer.js", "typings": "dist/index", diff --git a/src/cli.js b/src/cli.js index 3f9c4c6..e54aba8 100644 --- a/src/cli.js +++ b/src/cli.js @@ -56,9 +56,8 @@ class CLIUtilities { process.env.HOME + '/.mediumroast/config.ini' ) .option( - '-r --rest_server ', - 'The URL of the target mediumroast.io server', - 'http://cherokee.from-ca.com:16767' + '-r --rest_server ', + 'The URL of the target mediumroast.io server' ) .option( '-a --api_key ', From 2206a31629cfa25a70cb43cbb3860b901187d145 Mon Sep 17 00:00:00 2001 From: mihay42 Date: Fri, 30 Sep 2022 12:19:27 -0700 Subject: [PATCH 2/4] Fixed logic bug in splash --- cli/mr_setup.js | 2 +- package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/cli/mr_setup.js b/cli/mr_setup.js index f9dd6a4..8ef75a0 100755 --- a/cli/mr_setup.js +++ b/cli/mr_setup.js @@ -190,7 +190,7 @@ async function checkSection(env, sectionType) { const myArgs = parseCLIArgs() // Unless we suppress this print out the splash screen. -if (!myArgs.splash === 'yes') { +if (myArgs.splash === 'yes') { splashScreen() } diff --git a/package.json b/package.json index 50ad701..c6f7c7c 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "mediumroast_js", - "version": "0.3.2", + "version": "0.3.3", "description": "A Javascript SDK to interact with the mediumroast.io application including command line interfaces.", "main": "src/api/mrServer.js", "typings": "dist/index", From b0ca8a217ea5548357baba68a5950a19227ff3a8 Mon Sep 17 00:00:00 2001 From: Michael Hay Date: Fri, 30 Sep 2022 12:32:13 -0700 Subject: [PATCH 3/4] Added screenshots and fixed mr_setup command doc --- cli/CLI.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/cli/CLI.md b/cli/CLI.md index ef69c1b..ce54ef8 100644 --- a/cli/CLI.md +++ b/cli/CLI.md @@ -8,7 +8,11 @@ To enable system management, setup of the environment for the CLIs, and backup/r ### CLI environment setup To help users quickly get on board there is a setup utility that generates a configuration in *HOME/.mediumroast/config.ini*. Users are free to modify or create the file by hand. #### Configure your environment to run the CLI -Command: `mr_setup --no_splash` +Command: `mr_setup` + +Example output: + +![mr_setup](https://user-images.githubusercontent.com/10818650/193343225-1b209b5f-3e2c-48b7-90d3-1427a55d07cf.jpg) ### Backup and restore This utility enables a user with permissions to create full backup and perform a full restore of all core mediumroast.io objects. @@ -198,5 +202,6 @@ Command: `company --report=1 --package` Notice: This command saves the file to your environment's *HOME/Documents* directory called *.zip*. ##### Screenshot of the resulting zip file in MacOS finder -*UPDATE ME* + +![federos_package](https://user-images.githubusercontent.com/10818650/193343324-13917733-40f7-462e-bbc9-f600fbdf9d9c.jpg) From b7d64e9711a7e2d5c0ecc6e3e39828c6d3af5210 Mon Sep 17 00:00:00 2001 From: mihay42 Date: Fri, 30 Sep 2022 20:03:20 -0700 Subject: [PATCH 4/4] CLI naming for ease of use and doc improvement. --- README.md | 3 + cli/{mr_backup.js => backup.js} | 0 cli/{mr_setup.js => setup.js} | 0 docs/Auth.html | 24 +- docs/CLIUtilities.html | 22 +- docs/Companies.html | 12 +- docs/CompanySection.html | 18 +- docs/CompanyStandalone.html | 26 +- docs/DOCXUtilities.html | 14 +- docs/InteractionSection.html | 22 +- docs/InteractionStandalone.html | 24 +- docs/Interactions.html | 12 +- docs/Studies.html | 12 +- docs/Users.html | 12 +- docs/Utilities.html | 16 +- docs/api_mrServer.js.html | 8 +- docs/api_scaffold.js.html | 8 +- docs/baseObjects.html | 25 +- docs/cli.js.html | 13 +- docs/global.html | 583 +++++++++++++++++++++---------- docs/helpers.js.html | 22 +- docs/index.html | 40 ++- docs/mrRest.html | 16 +- docs/report_common.js.html | 13 +- docs/report_companies.js.html | 13 +- docs/report_interactions.js.html | 8 +- docs_config.json | 29 ++ images/mr_logo.png | Bin 0 -> 5917 bytes package.json | 19 +- src/report/common.js | 5 +- src/report/companies.js | 5 +- 31 files changed, 704 insertions(+), 320 deletions(-) rename cli/{mr_backup.js => backup.js} (100%) rename cli/{mr_setup.js => setup.js} (100%) create mode 100644 docs_config.json create mode 100644 images/mr_logo.png diff --git a/README.md b/README.md index 088c6e4..0d1c5aa 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,9 @@ The following packages need to be installed before the the SDK will operate corr - inquirer You can install all dependencies at once with: `npm i adm-zip, asw-sdk axios box-plot cli-table commander configparser docx json2csv node-fetch xlsx inquirer`. +## SDK documentation for developers +Documentation for developers that want to consume the SDK is available [here](https://mediumroast.github.io/mediumroast_js/). The documentation will continue to improve over time so keep checking in on the doc. + # Command Line Interface (CLI) for the mediumroast.io Inclued within this SDK is a CLI for users who are more inclined to use that tool for interacting with the system. These tools will be added and updated to over time as the system evolves. More information on the CLI is available in the [CLI User's Guide](./cli/CLI.md). diff --git a/cli/mr_backup.js b/cli/backup.js similarity index 100% rename from cli/mr_backup.js rename to cli/backup.js diff --git a/cli/mr_setup.js b/cli/setup.js similarity index 100% rename from cli/mr_setup.js rename to cli/setup.js diff --git a/docs/Auth.html b/docs/Auth.html index 77ef02e..9ba615b 100644 --- a/docs/Auth.html +++ b/docs/Auth.html @@ -64,9 +64,13 @@ id="sidebarNav" > +
+ +
+ @@ -87,7 +91,7 @@

Auth

Auth(restServer, apiKey, user, secret)

-
An implementation for authenticating into the mediumroast.io application.
+

An implementation for authenticating into the mediumroast.io application.

@@ -120,9 +124,9 @@

- The present development is very simple and largely a placeholder. After the object is constructed -the user would issue a login to generate the credential for usage in the API to talk to the -mediumroast.io application and gather create, read, deleted and update various objects. +

The present development is very simple and largely a placeholder. After the object is constructed +the user would issue a login to generate the credential for usage in the API to talk to the +mediumroast.io application and gather create, read, deleted and update various objects.

@@ -176,7 +180,7 @@

Parameters:
- the full URL and TCP/IP port for the mediumroast.io application +

the full URL and TCP/IP port for the mediumroast.io application

@@ -201,7 +205,7 @@
Parameters:
- the API key for the mediumroast.io application +

the API key for the mediumroast.io application

@@ -226,7 +230,7 @@
Parameters:
- your username for the mediumroast.io application +

your username for the mediumroast.io application

@@ -251,7 +255,7 @@
Parameters:
- your secret for the mediumroast.io application +

your secret for the mediumroast.io application

@@ -386,6 +390,8 @@
Parameters:
+ + \ No newline at end of file diff --git a/docs/CLIUtilities.html b/docs/CLIUtilities.html index f694295..d3aa256 100644 --- a/docs/CLIUtilities.html +++ b/docs/CLIUtilities.html @@ -64,9 +64,13 @@ id="sidebarNav" > +
+ +
+ @@ -87,7 +91,7 @@

CLIUtilities

CLIUtilities(version, name, description, objectType)

-
Construct a CLI object with key parameters
+

Construct a CLI object with key parameters

@@ -120,9 +124,9 @@

- A class to create consistent CLI operations for mediumroast.io objects like +

A class to create consistent CLI operations for mediumroast.io objects like interactions, studies, companies and users. The functions within help with environmental -settings, command line switches and output formatting. +settings, command line switches and output formatting.

@@ -176,7 +180,7 @@

Parameters:
- the version for the CLI +

the version for the CLI

@@ -201,7 +205,7 @@
Parameters:
- name for the CLI +

name for the CLI

@@ -226,7 +230,7 @@
Parameters:
- a description for the CLI +

a description for the CLI

@@ -251,7 +255,7 @@
Parameters:
- the type of objects the CLI manages +

the type of objects the CLI manages

@@ -379,6 +383,8 @@
Parameters:
+ + \ No newline at end of file diff --git a/docs/Companies.html b/docs/Companies.html index 3289f13..8a2297b 100644 --- a/docs/Companies.html +++ b/docs/Companies.html @@ -64,9 +64,13 @@ id="sidebarNav" > +
+ +
+ @@ -87,7 +91,7 @@

Companies

Companies(credential)

-
A subclass of baseObjects that construct the company objects
+

A subclass of baseObjects that construct the company objects

@@ -170,7 +174,7 @@
Parameters:
- the credential object returned from Auth.login() +

the credential object returned from Auth.login()

@@ -298,6 +302,8 @@
Parameters:
+ + \ No newline at end of file diff --git a/docs/CompanySection.html b/docs/CompanySection.html index ce4e47c..e55dfca 100644 --- a/docs/CompanySection.html +++ b/docs/CompanySection.html @@ -64,9 +64,13 @@ id="sidebarNav" > +
+ +
+ @@ -87,7 +91,7 @@

CompanySection

CompanySection(company)

-
To operate this class the constructor should be passed a single company object.
+

To operate this class the constructor should be passed a single company object.

@@ -120,10 +124,10 @@

- A high level class to create sections for a Company report using either -Microsoft DOCX format or eventually HTML format. Right now the only available +

A high level class to create sections for a Company report using either +Microsoft DOCX format or eventually HTML format. Right now the only available implementation is for the DOCX format. These sections are designed to be consumed -by a wrapping document which could be for any one of the mediumroast objects. +by a wrapping document which could be for any one of the mediumroast objects.

@@ -177,7 +181,7 @@

Parameters:
- The company object to generate the section(s) for +

The company object to generate the section(s) for

@@ -305,6 +309,8 @@
Parameters:
+ + \ No newline at end of file diff --git a/docs/CompanyStandalone.html b/docs/CompanyStandalone.html index 9ee72fa..a281eb7 100644 --- a/docs/CompanyStandalone.html +++ b/docs/CompanyStandalone.html @@ -64,9 +64,13 @@ id="sidebarNav" > +
+ +
+ @@ -87,7 +91,7 @@

CompanyStandalone

CompanyStandalone(company, interactions, creator, authorCompany)

-
Create a full and standlaone report document for a company
+

Create a full and standlaone report document for a company

@@ -120,9 +124,9 @@

- A high level class to create a complete document for a Company report using either -Microsoft DOCX format or eventually HTML format. Right now the only available -implementation is for the DOCX format. +

A high level class to create a complete document for a Company report using either +Microsoft DOCX format or eventually HTML format. Right now the only available +implementation is for the DOCX format.

@@ -176,7 +180,7 @@

Parameters:
- the company object to be reported on +

the company object to be reported on

@@ -201,7 +205,7 @@
Parameters:
- the interactions associated to the company +

the interactions associated to the company

@@ -226,7 +230,7 @@
Parameters:
- the author of the report +

the author of the report

@@ -251,7 +255,7 @@
Parameters:
- the company of the report author +

the company of the report author

@@ -299,7 +303,7 @@
Parameters:

View Source - report/companies.js, line 249 + report/companies.js, line 250

@@ -379,6 +383,8 @@
Parameters:
+ + \ No newline at end of file diff --git a/docs/DOCXUtilities.html b/docs/DOCXUtilities.html index 5769188..0d430e0 100644 --- a/docs/DOCXUtilities.html +++ b/docs/DOCXUtilities.html @@ -64,9 +64,13 @@ id="sidebarNav" > +
+ +
+ @@ -87,7 +91,7 @@

DOCXUtilities

DOCXUtilities(font, fontSize, textFontSize, textFontColor)

-
Core utilities for generating elements in a Microsoft word DOCX file
+

Core utilities for generating elements in a Microsoft word DOCX file

@@ -120,12 +124,12 @@

- To make machine authoring of a Microsoft DOCX file consistent and easier this class has been +

To make machine authoring of a Microsoft DOCX file consistent and easier this class has been developed. Key functions are available that better describe the intent of the operation by name which makes it simpler author a document instead of sweating the details. Further through trial and error the idiosyncrasies of the imported docx module have been worked out so that the developer doesn't have to accidently find out and struggle -with document generation. +with document generation.

@@ -389,6 +393,8 @@

Parameters:
+ + \ No newline at end of file diff --git a/docs/InteractionSection.html b/docs/InteractionSection.html index abccf08..0e2ca32 100644 --- a/docs/InteractionSection.html +++ b/docs/InteractionSection.html @@ -64,9 +64,13 @@ id="sidebarNav" > +
+ +
+ @@ -87,7 +91,7 @@

InteractionSection

InteractionSection(interactions, objectName, objectType)

-
Construct the InteractionSection object
+

Construct the InteractionSection object

@@ -120,10 +124,10 @@

- A high level class to create sections for an Interaction report using either -Microsoft DOCX format or eventually HTML format. Right now the only available +

A high level class to create sections for an Interaction report using either +Microsoft DOCX format or eventually HTML format. Right now the only available implementation is for the DOCX format. These sections are designed to be consumed -by a wrapping document which could be for any one of the mediumroast objects. +by a wrapping document which could be for any one of the mediumroast objects.

@@ -177,7 +181,7 @@

Parameters:
- a complete array of interactions ranging from 1:N +

a complete array of interactions ranging from 1:N

@@ -202,7 +206,7 @@
Parameters:
- the name of the object calling this class +

the name of the object calling this class

@@ -227,7 +231,7 @@
Parameters:
- the type of object calling this class +

the type of object calling this class

@@ -355,6 +359,8 @@
Parameters:
+ + \ No newline at end of file diff --git a/docs/InteractionStandalone.html b/docs/InteractionStandalone.html index ab88750..ac1e26e 100644 --- a/docs/InteractionStandalone.html +++ b/docs/InteractionStandalone.html @@ -64,9 +64,13 @@ id="sidebarNav" > +
+ +
+ @@ -87,7 +91,7 @@

InteractionStandalone

InteractionStandalone(interaction, company, creator, authorCompany)

-
Create a full and standlaone report document for an interaction
+

Create a full and standlaone report document for an interaction

@@ -120,9 +124,9 @@

- A high level class to create a complete document for an Interaction report using either -Microsoft DOCX format or eventually HTML format. Right now the only available -implementation is for the DOCX format. +

A high level class to create a complete document for an Interaction report using either +Microsoft DOCX format or eventually HTML format. Right now the only available +implementation is for the DOCX format.

@@ -176,7 +180,7 @@

Parameters:
- The interaction in question to process +

The interaction in question to process

@@ -201,7 +205,7 @@
Parameters:
- The company associated to the interaction +

The company associated to the interaction

@@ -226,7 +230,7 @@
Parameters:
- A string defining the creator for this document +

A string defining the creator for this document

@@ -251,7 +255,7 @@
Parameters:
- A string containing the company who authored the document +

A string containing the company who authored the document

@@ -379,6 +383,8 @@
Parameters:
+ + \ No newline at end of file diff --git a/docs/Interactions.html b/docs/Interactions.html index 3d94ced..24f0d1e 100644 --- a/docs/Interactions.html +++ b/docs/Interactions.html @@ -64,9 +64,13 @@ id="sidebarNav" > +
+ +
+ @@ -87,7 +91,7 @@

Interactions

Interactions(credential)

-
A subclass of baseObjects that construct the interaction objects
+

A subclass of baseObjects that construct the interaction objects

@@ -170,7 +174,7 @@
Parameters:
- the credential object returned from Auth.login() +

the credential object returned from Auth.login()

@@ -298,6 +302,8 @@
Parameters:
+ + \ No newline at end of file diff --git a/docs/Studies.html b/docs/Studies.html index c901c1d..e9c235c 100644 --- a/docs/Studies.html +++ b/docs/Studies.html @@ -64,9 +64,13 @@ id="sidebarNav" > +
+ +
+ @@ -87,7 +91,7 @@

Studies

Studies(credential)

-
A subclass of baseObjects that construct the study objects
+

A subclass of baseObjects that construct the study objects

@@ -170,7 +174,7 @@
Parameters:
- the credential object returned from Auth.login() +

the credential object returned from Auth.login()

@@ -298,6 +302,8 @@
Parameters:
+ + \ No newline at end of file diff --git a/docs/Users.html b/docs/Users.html index 1a38bfb..5c78d6a 100644 --- a/docs/Users.html +++ b/docs/Users.html @@ -64,9 +64,13 @@ id="sidebarNav" > +
+ +
+ @@ -87,7 +91,7 @@

Users

Users(credential)

-
A subclass of baseObjects that construct the user objects
+

A subclass of baseObjects that construct the user objects

@@ -170,7 +174,7 @@
Parameters:
- the credential object returned from Auth.login() +

the credential object returned from Auth.login()

@@ -298,6 +302,8 @@
Parameters:
+ + \ No newline at end of file diff --git a/docs/Utilities.html b/docs/Utilities.html index b8f6464..3ee031a 100644 --- a/docs/Utilities.html +++ b/docs/Utilities.html @@ -64,9 +64,13 @@ id="sidebarNav" > +
+ +
+ @@ -87,7 +91,7 @@

Utilities

Utilities(objectType)

-
Largely reserved for future use a basic constructor to create the object
+

Largely reserved for future use a basic constructor to create the object

@@ -120,8 +124,8 @@

- A class to enable consistent functionality for basic operations like writing files, -downloading from S3, reading files, creating ZIP archives, etc. +

A class to enable consistent functionality for basic operations like writing files, +downloading from S3, reading files, creating ZIP archives, etc.

@@ -175,7 +179,7 @@

Parameters:
- The type of object constructing this object +

The type of object constructing this object

@@ -303,6 +307,8 @@
Parameters:
+ + \ No newline at end of file diff --git a/docs/api_mrServer.js.html b/docs/api_mrServer.js.html index 7039624..b38705e 100644 --- a/docs/api_mrServer.js.html +++ b/docs/api_mrServer.js.html @@ -66,9 +66,13 @@ id="sidebarNav" > +
+ +
+ @@ -333,6 +337,8 @@

api/mrServer.js

+ + diff --git a/docs/api_scaffold.js.html b/docs/api_scaffold.js.html index 63296e0..e82f329 100644 --- a/docs/api_scaffold.js.html +++ b/docs/api_scaffold.js.html @@ -66,9 +66,13 @@ id="sidebarNav" > +
+ +
+ @@ -241,6 +245,8 @@

api/scaffold.js

+ + diff --git a/docs/baseObjects.html b/docs/baseObjects.html index e9b7ce8..6d5171c 100644 --- a/docs/baseObjects.html +++ b/docs/baseObjects.html @@ -64,9 +64,13 @@ id="sidebarNav" > +
+ +
+ @@ -87,7 +91,7 @@

baseObjects

baseObjects(credential, objType, apiVersion)

-
Store and setup key variables needed to operate the SDK
+

Store and setup key variables needed to operate the SDK

@@ -120,13 +124,12 @@

- This class contains all of the core operations which make it easier to interact with +

This class contains all of the core operations which make it easier to interact with the mediumroast.io application. Access to the RESTful endpoints is wrapped in a series -of Javascript functions to enable SDK users to not have to manage the details. - -Discrete objects are subclasses of this baseObjects class and are defined below. These +of Javascript functions to enable SDK users to not have to manage the details.

+

Discrete objects are subclasses of this baseObjects class and are defined below. These subclasses specify additional information like the objType, etc. and as needed can -implement their own additional functions as needed. +implement their own additional functions as needed.

@@ -186,7 +189,7 @@

Parameters:
- the credential object returned from Auth.login() +

the credential object returned from Auth.login()

@@ -215,7 +218,7 @@
Parameters:
- the type of object for the API session which could be users, studies, interactions or companies +

the type of object for the API session which could be users, studies, interactions or companies

@@ -246,7 +249,7 @@
Parameters:
- the version of the API +

the version of the API

@@ -374,6 +377,8 @@
Parameters:
+ + \ No newline at end of file diff --git a/docs/cli.js.html b/docs/cli.js.html index 801db7c..70c9e93 100644 --- a/docs/cli.js.html +++ b/docs/cli.js.html @@ -66,9 +66,13 @@ id="sidebarNav" > +
+ +
+ @@ -143,9 +147,8 @@

cli.js

process.env.HOME + '/.mediumroast/config.ini' ) .option( - '-r --rest_server <server>', - 'The URL of the target mediumroast.io server', - 'http://cherokee.from-ca.com:46767' + '-r --rest_server <http://server:port>', + 'The URL of the target mediumroast.io server' ) .option( '-a --api_key <key>', @@ -343,6 +346,8 @@

cli.js

+ + diff --git a/docs/global.html b/docs/global.html index 417bf8d..79ab029 100644 --- a/docs/global.html +++ b/docs/global.html @@ -64,9 +64,13 @@ id="sidebarNav" > +
+ +
+ @@ -174,7 +178,7 @@

- Create a 4 column row for displaying comparisons which are the results of similarity comparisons +

Create a 4 column row for displaying comparisons which are the results of similarity comparisons

@@ -228,7 +232,7 @@

Parameters:
- text/prose for the company in col 1 +

text/prose for the company in col 1

@@ -253,7 +257,7 @@
Parameters:
- the role of the company in col 2 +

the role of the company in col 2

@@ -278,7 +282,7 @@
Parameters:
- the numerical score for the term in col 3 +

the numerical score for the term in col 3

@@ -303,7 +307,7 @@
Parameters:
- a textual description of the relative priority for the company in col 4 +

a textual description of the relative priority for the company in col 4

@@ -328,7 +332,7 @@
Parameters:
- whether or not to make the text/prose bold typically used for header row +

whether or not to make the text/prose bold typically used for header row

@@ -407,7 +411,7 @@
Parameters:
-
a new 4 column docx TableRow object
+

a new 4 column docx TableRow object

@@ -447,7 +451,7 @@

- Basic table row to produce a name/value pair table with 2 columns +

Basic table row to produce a name/value pair table with 2 columns

@@ -501,7 +505,7 @@

Parameters:
- text/prose for the cell +

text/prose for the cell

@@ -526,7 +530,7 @@
Parameters:
- text/prose for the cell +

text/prose for the cell

@@ -605,7 +609,7 @@
Parameters:
-
a new docx TableRow object
+

a new docx TableRow object

@@ -645,7 +649,7 @@

- Create a 3 column row for displaying topics which are the results of term extraction +

Create a 3 column row for displaying topics which are the results of term extraction

@@ -699,7 +703,7 @@

Parameters:
- text/prose for the theme in col 1 +

text/prose for the theme in col 1

@@ -724,7 +728,7 @@
Parameters:
- the numerical score for the term in col 2 +

the numerical score for the term in col 2

@@ -749,7 +753,7 @@
Parameters:
- a textual description of the relative priority for the term in col 3 +

a textual description of the relative priority for the term in col 3

@@ -774,7 +778,7 @@
Parameters:
- whether or not to make the text/prose bold typically used for header row +

whether or not to make the text/prose bold typically used for header row

@@ -853,7 +857,7 @@
Parameters:
-
a new 3 column docx TableRow object
+

a new 3 column docx TableRow object

@@ -873,6 +877,179 @@
Parameters:
+
+ +
+ + + +

+ # + + + + checkFilesystemObject(name) → {Array} + + +

+ + + + +
+

Check to see if a file system object exists or not

+
+ + + + + + + + + + +
Parameters:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +String + + + +

full path to the file system object to check

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ View Source + + helpers.js, line 59 + +

+ +
+ + + + + + + + + + + + + + + + + + +
+
+
+ + + +
+ +

containing the status of the check operation, status message and null

+ + +
+ + +Array + + +
+ +
+ + +
+
+ + + +
@@ -897,7 +1074,7 @@

- Create objects in the mediumroast.io application +

Create objects in the mediumroast.io application

@@ -951,7 +1128,7 @@

Parameters:
- the object to create in the backend +

the object to create in the backend

@@ -976,7 +1153,7 @@
Parameters:
- defaults to findbyx and is combined with credential and version info +

defaults to findbyx and is combined with credential and version info

@@ -1055,7 +1232,7 @@
Parameters:
-
the results from the called function mrRest class
+

the results from the called function mrRest class

@@ -1095,7 +1272,7 @@

- Create a ZIP package from a source directory +

Create a ZIP package from a source directory

@@ -1149,7 +1326,7 @@

Parameters:
- the name, including the full path name, of the target ZIP package +

the name, including the full path name, of the target ZIP package

@@ -1174,7 +1351,7 @@
Parameters:
- the full path to directory where the ZIP package will be stored +

the full path to directory where the ZIP package will be stored

@@ -1222,7 +1399,7 @@
Parameters:

View Source - helpers.js, line 93 + helpers.js, line 107

@@ -1253,7 +1430,7 @@
Parameters:
-
containing the status of the create operation, status message and null
+

containing the status of the create operation, status message and null

@@ -1293,7 +1470,7 @@

- Delete an object using endpoint and a Javascript object. +

Delete an object using endpoint and a Javascript object.

@@ -1347,7 +1524,7 @@

Parameters:
- The full URL to the RESTful target +

The full URL to the RESTful target

@@ -1372,7 +1549,7 @@
Parameters:
- Data objects for input +

Data objects for input

@@ -1458,7 +1635,7 @@
Parameters:
-
An array starting with a boolean success/failure and resulting data
+

An array starting with a boolean success/failure and resulting data

@@ -1498,7 +1675,7 @@

- Description table row to produce a name/value pair table with 2 columns +

Description table row to produce a name/value pair table with 2 columns

@@ -1552,7 +1729,7 @@

Parameters:
- text/prose for the cell +

text/prose for the cell

@@ -1577,7 +1754,7 @@
Parameters:
- text/prose for the cell +

text/prose for the cell

@@ -1656,7 +1833,7 @@
Parameters:
-
a new docx TableRow object
+

a new docx TableRow object

@@ -1696,7 +1873,7 @@

- Extract objects from a ZIP package into a target directory +

Extract objects from a ZIP package into a target directory

@@ -1750,7 +1927,7 @@

Parameters:
- the ZIP file name, including the full path, to be extracted +

the ZIP file name, including the full path, to be extracted

@@ -1775,7 +1952,7 @@
Parameters:
- the location for the ZIP package to be extracted to +

the location for the ZIP package to be extracted to

@@ -1823,7 +2000,7 @@
Parameters:

View Source - helpers.js, line 111 + helpers.js, line 125

@@ -1873,7 +2050,7 @@

- Find all objects by id from the mediumroast.io application +

Find all objects by id from the mediumroast.io application

@@ -1927,7 +2104,7 @@

Parameters:
- the id of the object to find +

the id of the object to find

@@ -1952,7 +2129,7 @@
Parameters:
- defaults to findbyx and is combined with credential and version info +

defaults to findbyx and is combined with credential and version info

@@ -2031,7 +2208,7 @@
Parameters:
-
the results from the called function mrRest class
+

the results from the called function mrRest class

@@ -2075,7 +2252,7 @@

- Find all objects by name from the mediumroast.io application +

Find all objects by name from the mediumroast.io application

@@ -2129,7 +2306,7 @@

Parameters:
- the name of the object to find +

the name of the object to find

@@ -2154,7 +2331,7 @@
Parameters:
- defaults to findbyx and is combined with credential and version info +

defaults to findbyx and is combined with credential and version info

@@ -2233,7 +2410,7 @@
Parameters:
-
the results from the called function mrRest class
+

the results from the called function mrRest class

@@ -2277,7 +2454,7 @@

- Find all objects by attribute and value pair from the mediumroast.io application +

Find all objects by attribute and value pair from the mediumroast.io application

@@ -2331,7 +2508,7 @@

Parameters:
- the attribute used to find objects +

the attribute used to find objects

@@ -2356,7 +2533,7 @@
Parameters:
- the value for the defined attribute +

the value for the defined attribute

@@ -2381,7 +2558,7 @@
Parameters:
- defaults to findbyx and is combined with credential and version info +

defaults to findbyx and is combined with credential and version info

@@ -2460,7 +2637,7 @@
Parameters:
-
the results from the called function mrRest class
+

the results from the called function mrRest class

@@ -2504,7 +2681,7 @@

- Get all objects from the mediumroast.io application +

Get all objects from the mediumroast.io application

@@ -2558,7 +2735,7 @@

Parameters:
- defaults to getall and is combined with credential and version info +

defaults to getall and is combined with credential and version info

@@ -2637,7 +2814,7 @@
Parameters:
-
the results from the called function mrRest class
+

the results from the called function mrRest class

@@ -2677,7 +2854,7 @@

- Using the confFile argument read, parse and return the contents of a configuration file +

Using the confFile argument read, parse and return the contents of a configuration file

@@ -2731,7 +2908,7 @@

Parameters:
- a fully qualified path to the configuration file +

a fully qualified path to the configuration file

@@ -2779,7 +2956,7 @@
Parameters:

View Source - cli.js, line 122 + cli.js, line 121

@@ -2810,7 +2987,7 @@
Parameters:
-
The object containing the parsed configuration file results
+

The object containing the parsed configuration file results

@@ -2850,7 +3027,7 @@

- With the CLI arguments as the priority create an environmentals object to be used in the CLI +

With the CLI arguments as the priority create an environmentals object to be used in the CLI

@@ -2904,7 +3081,7 @@

Parameters:
- should contain the results of parseCLIArgs() above +

should contain the results of parseCLIArgs() above

@@ -2929,7 +3106,7 @@
Parameters:
- should contain the results of getConfig() above +

should contain the results of getConfig() above

@@ -2977,7 +3154,7 @@
Parameters:

View Source - cli.js, line 135 + cli.js, line 134

@@ -3008,7 +3185,7 @@
Parameters:
-
after merging cliArgs and config an Object containing the final environmental settings
+

after merging cliArgs and config an Object containing the final environmental settings

@@ -3048,7 +3225,7 @@

- Get an object using endpoint only. +

Get an object using endpoint only.

@@ -3102,7 +3279,7 @@

Parameters:
- The full URL to the RESTful target +

The full URL to the RESTful target

@@ -3181,7 +3358,7 @@
Parameters:
-
An array starting with a boolean success/failure and resulting data
+

An array starting with a boolean success/failure and resulting data

@@ -3221,7 +3398,7 @@

- Initiate a login to the mediumroast.io application +

Initiate a login to the mediumroast.io application

@@ -3303,7 +3480,7 @@

-
the credential object needed to perform API calls to mediumroast.io
+

the credential object needed to perform API calls to mediumroast.io

@@ -3343,7 +3520,7 @@

- While not yet implemented meant to enable a logout of a session for the mediumroast.io +

While not yet implemented meant to enable a logout of a session for the mediumroast.io

@@ -3425,7 +3602,7 @@

-
true for logout at this time
+

true for logout at this time

@@ -3465,7 +3642,7 @@

- Create a target within a document to link to with an internal hyperlink +

Create a target within a document to link to with an internal hyperlink

@@ -3519,7 +3696,7 @@

Parameters:
- text/prose for the function +

text/prose for the function

@@ -3544,7 +3721,7 @@
Parameters:
- the unique name of the bookmark +

the unique name of the bookmark

@@ -3630,7 +3807,7 @@
Parameters:
-
a new docx paragraph object with a bookmark
+

a new docx paragraph object with a bookmark

@@ -3670,7 +3847,7 @@

- Create a bullet for a bit of prose +

Create a bullet for a bit of prose

@@ -3724,7 +3901,7 @@

Parameters:
- text/prose for the bullet +

text/prose for the bullet

@@ -3749,7 +3926,7 @@
Parameters:
- the level of nesting for the bullet +

the level of nesting for the bullet

@@ -3828,7 +4005,7 @@
Parameters:
-
new docx paragraph object as a bullet
+

new docx paragraph object as a bullet

@@ -3868,7 +4045,7 @@

- Generate the comparisons section for the document from the company in question +

Generate the comparisons section for the document from the company in question

@@ -3922,7 +4099,7 @@

Parameters:
- the object containing the comparisons for the company in question +

the object containing the comparisons for the company in question

@@ -3964,6 +4141,13 @@
Parameters:
+ +
To Do:
+
+
    +
  • Sort based upon rank from highest to lowest
    • +
+
@@ -4001,7 +4185,7 @@
Parameters:
-
An array containing an introduction to this section and the table with the comparisons
+

An array containing an introduction to this section and the table with the comparisons

@@ -4041,7 +4225,7 @@

- Make the descriptions for interactions in the DOCX format +

Make the descriptions for interactions in the DOCX format

@@ -4123,7 +4307,7 @@

-
An array containing a section description and a table of interaction descriptions
+

An array containing a section description and a table of interaction descriptions

@@ -4167,7 +4351,7 @@

- Generate and save a DOCX report for a Company object +

Generate and save a DOCX report for a Company object

@@ -4221,7 +4405,7 @@

Parameters:
- Full path to the file name, if no file name is supplied a default is assumed +

Full path to the file name, if no file name is supplied a default is assumed

@@ -4246,7 +4430,7 @@
Parameters:
- When set to true links are set up for connecting to interaction documents +

When set to true links are set up for connecting to interaction documents

@@ -4294,7 +4478,7 @@
Parameters:

View Source - report/companies.js, line 268 + report/companies.js, line 269

@@ -4325,7 +4509,7 @@
Parameters:
-
The result of the writeReport function that is an Array
+

The result of the writeReport function that is an Array

@@ -4369,7 +4553,7 @@

- Create the DOCX document for a single interaction which includes a company section +

Create the DOCX document for a single interaction which includes a company section

@@ -4423,7 +4607,7 @@

Parameters:
- Full path to the file name, if no file name is supplied a default is assumed +

Full path to the file name, if no file name is supplied a default is assumed

@@ -4448,7 +4632,7 @@
Parameters:
- When set to true links are set up for connecting to interaction documents +

When set to true links are set up for connecting to interaction documents

@@ -4527,7 +4711,7 @@
Parameters:
-
The result of the writeReport function that is an Array
+

The result of the writeReport function that is an Array

@@ -4567,7 +4751,7 @@
Parameters:
- text/prose for the function +

text/prose for the function

@@ -4646,7 +4830,7 @@
Parameters:
- the URL for the hyperlink +

the URL for the hyperlink

@@ -4725,7 +4909,7 @@
Parameters:
-
a new docx ExternalHyperlink object
+

a new docx ExternalHyperlink object

@@ -4765,7 +4949,7 @@

- Create a table containing key information for the company in question +

Create a table containing key information for the company in question

@@ -4847,7 +5031,7 @@

-
A docx table is return to the caller
+

A docx table is return to the caller

@@ -4887,7 +5071,7 @@

- Create a text of heading style 1 +

Create a text of heading style 1

@@ -4941,7 +5125,7 @@

Parameters:
- text/prose for the function +

text/prose for the function

@@ -5020,7 +5204,7 @@
Parameters:
-
a new paragraph as a heading
+

a new paragraph as a heading

@@ -5060,7 +5244,7 @@

- Create a text of heading style 2 +

Create a text of heading style 2

@@ -5114,7 +5298,7 @@

Parameters:
- text/prose for the function +

text/prose for the function

@@ -5193,7 +5377,7 @@
Parameters:
-
a new paragraph as a heading
+

a new paragraph as a heading

@@ -5233,7 +5417,7 @@

- Create a text of heading style 3 +

Create a text of heading style 3

@@ -5287,7 +5471,7 @@

Parameters:
- text/prose for the function +

text/prose for the function

@@ -5366,7 +5550,7 @@
Parameters:
-
a new paragraph as a heading
+

a new paragraph as a heading

@@ -5406,7 +5590,7 @@

- Create a target within a document to link to with an internal hyperlink of heading 1 +

Create a target within a document to link to with an internal hyperlink of heading 1

@@ -5460,7 +5644,7 @@

Parameters:
- text/prose for the function +

text/prose for the function

@@ -5485,7 +5669,7 @@
Parameters:
- the unique name of the bookmark +

the unique name of the bookmark

@@ -5571,7 +5755,7 @@
Parameters:
-
a new docx paragraph object with a bookmark at the heading level 1
+

a new docx paragraph object with a bookmark at the heading level 1

@@ -5611,7 +5795,7 @@

- Create a target within a document to link to with an internal hyperlink of heading 2 +

Create a target within a document to link to with an internal hyperlink of heading 2

@@ -5665,7 +5849,7 @@

Parameters:
- text/prose for the function +

text/prose for the function

@@ -5690,7 +5874,7 @@
Parameters:
- the unique name of the bookmark +

the unique name of the bookmark

@@ -5769,7 +5953,7 @@
Parameters:
-
a new docx paragraph object with a bookmark at the heading level 2
+

a new docx paragraph object with a bookmark at the heading level 2

@@ -5809,7 +5993,7 @@
Parameters:
- text/prose for the function +

text/prose for the function

@@ -5888,7 +6072,7 @@
Parameters:
- the URL for the hyperlink within the document +

the URL for the hyperlink within the document

@@ -5967,7 +6151,7 @@
Parameters:
-
a new docx InternalHyperlink object
+

a new docx InternalHyperlink object

@@ -6007,7 +6191,7 @@

- Creates a complete document with a heading of level 1 +

Creates a complete document with a heading of level 1

@@ -6061,7 +6245,7 @@

Parameters:
- text/prose for the introduction +

text/prose for the introduction

@@ -6109,7 +6293,7 @@
Parameters:

View Source - report/common.js, line 750 + report/common.js, line 751

@@ -6140,7 +6324,7 @@
Parameters:
-
a complete introduction with heading level 1 and a paragraph
+

a complete introduction with heading level 1 and a paragraph

@@ -6180,7 +6364,7 @@

- For a section of prose create a paragraph +

For a section of prose create a paragraph

@@ -6234,7 +6418,7 @@

Parameters:
- text/prose for the paragraph +

text/prose for the paragraph

@@ -6259,7 +6443,7 @@
Parameters:
- font size for the paragrah +

font size for the paragrah

@@ -6284,7 +6468,7 @@
Parameters:
- a boolean value for determining if the text should be bolded +

a boolean value for determining if the text should be bolded

@@ -6309,7 +6493,7 @@
Parameters:
- an integer 1 or 0 to determine if there should be space after this element +

an integer 1 or 0 to determine if there should be space after this element

@@ -6388,7 +6572,7 @@
Parameters:
-
a docx paragraph object
+

a docx paragraph object

@@ -6428,7 +6612,7 @@

- Create the references for calling programs in the DOCX format +

Create the references for calling programs in the DOCX format

@@ -6482,7 +6666,7 @@

Parameters:
- When set to true links are set up for connecting to interaction documents +

When set to true links are set up for connecting to interaction documents

@@ -6561,7 +6745,7 @@
Parameters:
-
An array containing a section description and a table of interaction references
+

An array containing a section description and a table of interaction references

@@ -6601,7 +6785,7 @@

- Create a text run with or without space after +

Create a text run with or without space after

@@ -6655,7 +6839,7 @@

Parameters:
- text/prose for the textrun +

text/prose for the textrun

@@ -6680,7 +6864,7 @@
Parameters:
- an integer 1 or 0 to determine if there should be space after this element +

an integer 1 or 0 to determine if there should be space after this element

@@ -6759,7 +6943,7 @@
Parameters:
-
a docx textrun object
+

a docx textrun object

@@ -6799,7 +6983,7 @@

- An output router enabling users to pick their output format of choice for a CLI +

An output router enabling users to pick their output format of choice for a CLI

@@ -6853,7 +7037,7 @@

Parameters:
- Type of output to produce/route to: table, json, csv, xls +

Type of output to produce/route to: table, json, csv, xls

@@ -6878,7 +7062,7 @@
Parameters:
- Data objects to be output +

Data objects to be output

@@ -6903,7 +7087,7 @@
Parameters:
- Environmental variables from the CLI +

Environmental variables from the CLI

@@ -6928,7 +7112,7 @@
Parameters:
- The object type: Interactions, Studies or Companies +

The object type: Interactions, Studies or Companies

@@ -6976,7 +7160,7 @@
Parameters:

View Source - cli.js, line 177 + cli.js, line 176

@@ -7022,7 +7206,7 @@

- Create a page break +

Create a page break

@@ -7104,7 +7288,7 @@

-
a docx paragraph object with a PageBreak
+

a docx paragraph object with a PageBreak

@@ -7144,7 +7328,7 @@

- Consistently parse the CLI for options and switches +

Consistently parse the CLI for options and switches

@@ -7226,7 +7410,9 @@

-
- an object containing all CLI options and switches
+
    +
  • an object containing all CLI options and switches
    • +
@@ -7266,7 +7452,7 @@

- Patch an object using endpoint and a Javascript object. +

Patch an object using endpoint and a Javascript object.

@@ -7320,7 +7506,7 @@

Parameters:
- The full URL to the RESTful target +

The full URL to the RESTful target

@@ -7345,7 +7531,7 @@
Parameters:
- Data objects for input +

Data objects for input

@@ -7431,7 +7617,7 @@
Parameters:
-
An array starting with a boolean success/failure and resulting data
+

An array starting with a boolean success/failure and resulting data

@@ -7471,7 +7657,7 @@

- Post an object using endpoint and a Javascript object. +

Post an object using endpoint and a Javascript object.

@@ -7525,7 +7711,7 @@

Parameters:
- The full URL to the RESTful target +

The full URL to the RESTful target

@@ -7550,7 +7736,7 @@
Parameters:
- Data objects for input +

Data objects for input

@@ -7629,7 +7815,7 @@
Parameters:
-
An array starting with a boolean success/failure and resulting data
+

An array starting with a boolean success/failure and resulting data

@@ -7669,7 +7855,7 @@

- Rank supplied topics and return an object that can be rendered +

Rank supplied topics and return an object that can be rendered

@@ -7723,7 +7909,7 @@

Parameters:
- the tags from the source object to be ranked +

the tags from the source object to be ranked

@@ -7802,7 +7988,7 @@
Parameters:
-
the final tags which now have ranking and are suitable for a basicTopicRow
+

the final tags which now have ranking and are suitable for a basicTopicRow

@@ -7842,7 +8028,7 @@

- Safely read a text file of any kind +

Safely read a text file of any kind

@@ -7896,7 +8082,7 @@

Parameters:
- name of the file to read +

name of the file to read

@@ -7975,7 +8161,7 @@
Parameters:
-
containing the status of the read operation, status message and data read
+

containing the status of the read operation, status message and data read

@@ -8015,7 +8201,7 @@

- Recursively remove a directory +

Recursively remove a directory

@@ -8069,7 +8255,7 @@

Parameters:
- full path to the parent directory to revmove +

full path to the parent directory to revmove

@@ -8117,7 +8303,7 @@
Parameters:

View Source - helpers.js, line 78 + helpers.js, line 92

@@ -8148,7 +8334,7 @@
Parameters:
-
containing the status of the rmdir operation, status message and null
+

containing the status of the rmdir operation, status message and null

@@ -8188,7 +8374,7 @@

- From an S3 bucket download the document associated to each interaction +

From an S3 bucket download the document associated to each interaction

@@ -8242,7 +8428,7 @@

Parameters:
- an array of interaction objects +

an array of interaction objects

@@ -8267,7 +8453,7 @@
Parameters:
- the environmental settings to use for accessing the S3 endpoint +

the environmental settings to use for accessing the S3 endpoint

@@ -8292,7 +8478,7 @@
Parameters:
- the target location for downloading the objects to +

the target location for downloading the objects to

@@ -8347,7 +8533,7 @@
Parameters:

View Source - helpers.js, line 127 + helpers.js, line 141

@@ -8393,7 +8579,7 @@

- Resursively and safely create a directory +

Resursively and safely create a directory

@@ -8447,7 +8633,7 @@

Parameters:
- full path to the directory to create +

full path to the directory to create

@@ -8495,7 +8681,7 @@
Parameters:

View Source - helpers.js, line 59 + helpers.js, line 73

@@ -8526,7 +8712,7 @@
Parameters:
-
containing the status of the mkdir operation, status message and null
+

containing the status of the mkdir operation, status message and null

@@ -8566,7 +8752,7 @@

- Save textual data to a file +

Save textual data to a file

@@ -8620,7 +8806,7 @@

Parameters:
- full path to the file and the file name to save to +

full path to the file and the file name to save to

@@ -8645,7 +8831,7 @@
Parameters:
- the string content to save to a file which could be JSON, XML, TXT, etc. +

the string content to save to a file which could be JSON, XML, TXT, etc.

@@ -8724,7 +8910,7 @@
Parameters:
-
containing the status of the save operation, status message and null/error
+

containing the status of the save operation, status message and null/error

@@ -8764,7 +8950,7 @@

- A higher level function that calls basicTopicRow to create a complete table +

A higher level function that calls basicTopicRow to create a complete table

@@ -8818,7 +9004,7 @@

Parameters:
- the result of rankTags +

the result of rankTags

@@ -8860,6 +9046,13 @@
Parameters:
+ +
To Do:
+
+
    +
  • Sort based upon rank from highest to lowest
    • +
+
@@ -8897,7 +9090,7 @@
Parameters:
-
a complete docx table that includes topics
+

a complete docx table that includes topics

@@ -8941,7 +9134,7 @@

- Update an object in the mediumroast.io application +

Update an object in the mediumroast.io application

@@ -8995,7 +9188,7 @@

Parameters:
- the object to update in the backend which includes the id and, the attribute and value to be updated +

the object to update in the backend which includes the id and, the attribute and value to be updated

@@ -9020,7 +9213,7 @@
Parameters:
- defaults to findbyx and is combined with credential and version info +

defaults to findbyx and is combined with credential and version info

@@ -9099,7 +9292,7 @@
Parameters:
-
the results from the called function mrRest class
+

the results from the called function mrRest class

@@ -9139,7 +9332,7 @@

- Hyperlink table row to produce a name/value pair table with 2 columns and an external hyperlink +

Hyperlink table row to produce a name/value pair table with 2 columns and an external hyperlink

@@ -9193,7 +9386,7 @@

Parameters:
- text/prose for the first column +

text/prose for the first column

@@ -9218,7 +9411,7 @@
Parameters:
- text/prose for the hyperlink in the second column +

text/prose for the hyperlink in the second column

@@ -9243,7 +9436,7 @@
Parameters:
- the URL for the hyperlink +

the URL for the hyperlink

@@ -9322,7 +9515,7 @@
Parameters:
-
a new docx TableRow object with an external hyperlink
+

a new docx TableRow object with an external hyperlink

@@ -9366,7 +9559,7 @@

- safely write a DOCX report to a desired location +

safely write a DOCX report to a desired location

@@ -9420,7 +9613,7 @@

Parameters:
- a complete and error free document object that is ready to be saved +

a complete and error free document object that is ready to be saved

@@ -9445,7 +9638,7 @@
Parameters:
- the file name for the DOCX object +

the file name for the DOCX object

@@ -9524,7 +9717,7 @@
Parameters:
-
an array containing if the save operation succeeded, the message, and null
+

an array containing if the save operation succeeded, the message, and null

@@ -9580,6 +9773,8 @@
Parameters:
+ + \ No newline at end of file diff --git a/docs/helpers.js.html b/docs/helpers.js.html index a2e2b9a..5c73123 100644 --- a/docs/helpers.js.html +++ b/docs/helpers.js.html @@ -66,9 +66,13 @@ id="sidebarNav" > +
+ +
+
@@ -143,6 +147,20 @@

helpers.js

} } + /** + * @function checkFilesystemObject + * @description Check to see if a file system object exists or not + * @param {String} name - full path to the file system object to check + * @returns {Array} containing the status of the check operation, status message and null + */ + checkFilesystemObject(name) { + if (fs.existsSync(name)) { + return [true, 'The file system object [' + name + '] was detected.', null] + } else { + return [false, 'The file system object [' + name + '] was not detected.', null] + } + } + /** * @function safeMakedir * @description Resursively and safely create a directory @@ -267,6 +285,8 @@

helpers.js

+ + diff --git a/docs/index.html b/docs/index.html index 722b331..5af9a3e 100644 --- a/docs/index.html +++ b/docs/index.html @@ -64,9 +64,13 @@ id="sidebarNav" > +
+ +
+
@@ -111,7 +115,16 @@

We actually use this SDK for our own developments, and we do this to ensure that our developers have a first class experience for the mediumroast.io with an always up to date version of the SDK.

Installation and Configuration Steps via NPM

-

As soon as the SDK is published on the NPM repository we will update this section with installation steps.

+

This package is available for installation from NPM as mediumroast_js and can be installed and removed via the npm command. Several approaches to installation are documented below.

+

Installation for Linux, UNIX and MacOS

+

Assuming you have installed both node.js and npm the following installation processes are possible.

+
    +
  1. Global installation for all users: sudo npm i -g mediumroast_js
    2. +
  2. Local installation for a developer or single user: npm i mediumroast_js +We recommend the global installation because the CLI utilities will be installed in /usr/local/bin and available for all users on the system to access.
    3. +
+

Installation for WinOS

+

Coming soon.

Installation and Configuration Steps for Developers

The following steps are important if you are developing or extending the Node.js Javascript SDK. If you're not a developer then the current state of the package is not for you. Please wait until we exit the alpha for the mediumroast.io.

Cloning the repository for Developers

@@ -144,9 +157,12 @@

mediumroast_js SDK dependencies

  • docx
  • json2csv
  • node-fetch
    • -
  • xlsx -You can install all dependencies at once with: npm i adm-zip, asw-sdk axios box-plot cli-table commander configparser docx json2csv node-fetch xlsx.
    • +
  • xlsx
    • +
  • inquirer +You can install all dependencies at once with: npm i adm-zip, asw-sdk axios box-plot cli-table commander configparser docx json2csv node-fetch xlsx inquirer.
    • +

    SDK documentation for developers

    +

    Documentation for developers that want to consume the SDK is available here. The documentation will continue to improve over time so keep checking in on the doc.

    Command Line Interface (CLI) for the mediumroast.io

    Inclued within this SDK is a CLI for users who are more inclined to use that tool for interacting with the system. These tools will be added and updated to over time as the system evolves. More information on the CLI is available in the CLI User's Guide.

    Issues

    @@ -174,7 +190,7 @@

    api/mrServer.js

    -
    mrServer.js
    +

    mrServer.js

    @@ -284,7 +300,7 @@

    api/scaffold.js

    -
    scaffold.js
    +

    scaffold.js

    @@ -394,7 +410,7 @@

    cli.js

    -
    cli.js
    +

    cli.js

    @@ -504,7 +520,7 @@

    helpers.js

    -
    helpers.js
    +

    helpers.js

    @@ -614,7 +630,7 @@

    report/common.js

    -
    common.js
    +

    common.js

    @@ -721,7 +737,7 @@

    report/companies.js

    -
    companies.js
    +

    companies.js

    @@ -831,7 +847,7 @@

    report/interactions.js

    -
    interactions.js
    +

    interactions.js

    @@ -945,6 +961,8 @@

    report/interactions.js

    + + \ No newline at end of file diff --git a/docs/mrRest.html b/docs/mrRest.html index 06e9e7f..c978fdd 100644 --- a/docs/mrRest.html +++ b/docs/mrRest.html @@ -64,9 +64,13 @@ id="sidebarNav" > +
    + +
    +
    @@ -87,7 +91,7 @@

    mrRest

    mrRest(credential)

    -
    Construct the object to interact with the mediumroast.io application
    +

    Construct the object to interact with the mediumroast.io application

    @@ -120,10 +124,10 @@

    - Simple and safe wrappers around axios to make RESTful API to mediuroast.io. +

    Simple and safe wrappers around axios to make RESTful API to mediuroast.io. The credential object, passed when this object is created, should include all relevant items needed to authenticate a client. This can include appropriate JWT tokens, user identifiers, -passwords, etc. At a minimum the restServer and an apiKey are needed to connect. +passwords, etc. At a minimum the restServer and an apiKey are needed to connect.

    @@ -177,7 +181,7 @@

    Parameters:
    - contains key items needed to interact with the mediumroast.io application +

    contains key items needed to interact with the mediumroast.io application

    @@ -305,6 +309,8 @@
    Parameters:
    + + \ No newline at end of file diff --git a/docs/report_common.js.html b/docs/report_common.js.html index 76c0d30..9d6951e 100644 --- a/docs/report_common.js.html +++ b/docs/report_common.js.html @@ -66,9 +66,13 @@ id="sidebarNav" > +
    + +
    +
    @@ -814,11 +818,12 @@

    report/common.js

    * @description A higher level function that calls basicTopicRow to create a complete table * @param {Object} topics - the result of rankTags * @returns {Object} a complete docx table that includes topics + * @todo Sort based upon rank from highest to lowest */ topicTable(topics) { - let myRows = [this.basicTopicRow('Keywords', 'Score', 'Rank', true)] + let myRows = [this.basicTopicRow('Keywords', 'Rank', 'Score', true)] for (const topic in topics) { - myRows.push(this.basicTopicRow(topic, topics[topic].score.toFixed(2), topics[topic].rank)) + myRows.push(this.basicTopicRow(topic, topics[topic].rank), topics[topic].score.toFixed(2)) } // define the table with the summary theme information const myTable = new docx.Table({ @@ -875,6 +880,8 @@

    report/common.js

    + + diff --git a/docs/report_companies.js.html b/docs/report_companies.js.html index b66c4ab..8f32791 100644 --- a/docs/report_companies.js.html +++ b/docs/report_companies.js.html @@ -66,9 +66,13 @@ id="sidebarNav" > +
    + +
    +
    @@ -272,6 +276,7 @@

    report/companies.js

    * @description Generate the comparisons section for the document from the company in question * @param {Object} comparisons - the object containing the comparisons for the company in question * @returns {Array} An array containing an introduction to this section and the table with the comparisons + * @todo Sort based upon rank from highest to lowest */ makeComparisonDOCX(comparisons) { // Transform the comparisons into something that is usable for display @@ -283,14 +288,14 @@

    report/companies.js

    const topCompanyName = topCompany.name const topCompanyRole = topCompany.role - let myRows = [this.util.basicComparisonRow('Company', 'Role', 'Score', 'Rank', true)] + let myRows = [this.util.basicComparisonRow('Company', 'Role', 'Rank', 'Score', true)] for (const comparison in myComparison) { myRows.push( this.util.basicComparisonRow( myComparison[comparison].name, myComparison[comparison].role, - myComparison[comparison].score, myComparison[comparison].rank, + myComparison[comparison].score, ) ) } @@ -446,6 +451,8 @@

    report/companies.js

    + + diff --git a/docs/report_interactions.js.html b/docs/report_interactions.js.html index 02c76c5..560e5db 100644 --- a/docs/report_interactions.js.html +++ b/docs/report_interactions.js.html @@ -66,9 +66,13 @@ id="sidebarNav" > +
    + +
    +
    @@ -406,6 +410,8 @@

    report/interactions.js

    + + diff --git a/docs_config.json b/docs_config.json new file mode 100644 index 0000000..64a55e0 --- /dev/null +++ b/docs_config.json @@ -0,0 +1,29 @@ +{ + "plugins": [ + "plugins/markdown" + ], + "opts": { + "template": "node_modules/better-docs", + "encoding": "utf8", + "destination": "./docs", + "recurse": true + }, + "templates": { + "cleverLinks": true, + "monospaceLinks": false, + "search": true + }, + "better-docs": { + "name": "mediumroast.io sdk documentation", + "logo": "images/mr_logo.png", + "title": "SDK Documentation for the mediumroast.io", + + "hideGenerator": false, + "navLinks": [ + { + "label": "Github", + "href": "https://github.com/mediumroast/mediumroast_js" + } + ] + } +} \ No newline at end of file diff --git a/images/mr_logo.png b/images/mr_logo.png new file mode 100644 index 0000000000000000000000000000000000000000..fa25e57a175358f55b7174b0285d12dbf2cc7d08 GIT binary patch literal 5917 zcmZ`-by!r}*PaK52cjXq&Vt z+#i2Yp_(B){ti%{G`3{NdPxvvlt>(-O-oB_6zaBmkN~>fh|^8O1Cl1{&c?ARQkh~< z+~y!WCp6a8d?orS2&em@=Ab5Sdix1Z_k@-*g}#Q3$_^e7kzjpmnmQSb9~q~ZWhQgShMtCmBz%U1gzGU42MuTVv(&Iu9)Y;9#Zhm3{5eg0{6%6# zxsfjCFX~qQ>dajD_!CdAuR|W*3@WF;Z6DQfecgKZ^7XagDk!B8Og-y9GC@Z1@I`!@%E zV}CErn|-7H+k$dI|1cDCasI)O-&7cevG~T^^3*i(0RV_8e{UclJ(Csy0O2~rjFHB= zI?}ct?t<2K9ya!Ze(s*XRRCE(=^N;7kF;j>b9Y1dNc+jL|H+WP!N1)??5uxMkgjs< z#<~WqDjweUtYU%?L1A`zB34#bS#LWBX{f6D-}0L;Id&%`(oF?_=E@Q0R9=2rMWp^nb~a&JO>N?04iZ*`Me7tDNlbWYPxCe)ew0 zs?P5A2%nqQKXZxEW{T_upSXSu2 ze1G$0g?`WJUvvBGQvUSb+=@Jrtk6FMdhTIp}@PFPUCdE6IeI~Yvevo#2XKC zDWLsSqnWSB+D2{nO3rTHWA`$}KYMRZVJ<&965u$PdA2%paeRI4;h%%Lp4*EFoW2s5 z%DrUi_%$)ns|IOrU8xE9R2O|dH@Ski7HXj^Zn0_yeQau)p(W{J#Qex~6ka~3U-oLP zKoyih{`8lq6Q|FrW(qCm zkTNcw@-1mU3STj2s>xY`Kc;}oQ|#$iSI@sa-aA^ukBEC3oe7}~DBl>6jN0-pw)L%d zVpY}hXXlWCjLVYaKLOL!6DkrT%|)X}fCMK%MXiqQY4Jyokc*!JDz+M|_)j{k^zI6> z*lFT`NiJC?$@OsY+dyjxUpnr;Su{*zohH zl`cPjyDRz94O@?r=+PBktmuC)#9aikhzMZF4jAG|m!(XaCjrdkRp#1%OG+Ttc5fXT z!wGJ6I3pQwOvk0a4t*OI75#pJ%fW;q4vu&P+1!sAxwrlq4xYIfyX%z_a+|C+T<|Oc z@o|e-GKZ8%_H9BHd}&jzsLqprqv5WPxqh@UO=`I_4e)um((K-`608B#hqo-UTALlG z6Ixgt>?J0#pLLmBvb<>UL%uzly%Qu8YWZvkkjEXk^kumD#qM@Y~bI={DhD?!*IP`*`_J?rbl1p9yh zsrTXV9jQ5X5m{Zku~fr^*VzK?Rx$ZS_T2Y6->2FTLKNZOWV&(tAV?NJj+(6*m{Wx3Pvn|L5?$?g7QaS!rqb`#S? zt)GgV3R{<1K~(I;ry`X{!FA?gDWASVRUF_hF$YaJc)E`3$LIDt*f{Ui8;~_;UXRr56GR8*YEYf9@6WdN#T-0332HGF=<`x) z%}9G)n3x+D?x29JDg1uWo3YnB%6F|&-f-c~+2i=AEa9BxGR@}fA_1fo){qgYpY|-y zz_H7wV{1`moI>92eoqqkV8FwS?XHj+w{5F8P5)Aq?9sO9f#p!y8$QAGmr44Gwis8p z)Fhz5)Ps4%z)Y=&Q$(xP`1^9T4>Gn?%-?w9i+m5X3RX(xiYy2Xs9*Ou^ z=D!t$HvXus?b!cnzU46CVw9et~V8Iv^o_{`GzGPFL-fK_uFUk<3ZrrtX<`D zxp`ye2f9-fyZZe2+z5i4DdF9aK*qBswZu2S9;!vX-6Xzx?Uye~bh0L4nWD9f=^N;K z(~G0vuiWzF`)NX!7?mDhA>&;!j&j``@WhkCYQSLJPcNO3m1wACi1MzSg-$j zf8thqRH}P#;&6D!58G56r|#E88nJ^H8PWv$#3>*&r(iFmcMI0 zO3BF1&dU;Yt$8B@A;{}YPN&4M@krMXMQy(%2o6!S2!5x0RsA?FmL9C!5;V*1ck{bTc!;-Rb*uqEnMlVvVCsfqrzvuy&+q_8N;{IRR3``FGsGxz6ft;Y;265 zYi(BwYSfxFMaC$ZOS8SE{B>zee|Rcx3mMJwiMaz(VQ;C{j$T%Tjr0QhttyqUtYcE zr`DS)qwLYl+_);xTj0^uo-3VVRcJw__45e4Hr;D6wHbK~VDZ9+CNgWkx;HXC&Bn<| z%tgW+x1G5WaZLuBNXVT(FTIN$5y5UIW>G_ z?@0lYLH)$&M~#BCM0CK*F0QT*+Lq(dEYLivJvS`R@r>7VH|z&Iz3+xn$1}vQqmUe_ zQ$uw?`Fq22EMx_KvLV8V8IBo@N@HQYyt$7?6*(%e>2XBSnAhH*V0Iu|M^97DuZKmR z&=#QMNZIZTRN@olK8H3MMZPLKtBaOdI_!&D^|;)XmZB>BfB>Hs+G{4zr`-sHUvTyYv1ohZuQN4dY(S3ycFBR}&$aN$a!S_Mo!% zv#I&eAc-*vO&`~fy|w31|44ZXaQ!~x>ABjYKH`cdc9y0_Lz>KxE1qvsoQ~7r)837$ zgy)bq^3U3+8O_w&qP;6BQ3||ff!R))orI})6j!b>3J-1KOXXk|-#rzfy_H`)kw_mO zZ(&s6yAHm)Yvn{&Z5g$g~gKryQBz7H6oq zwkkJ^kWq3o8V?8p8_D4iQQ zV$}_I@!juRw+~B5JqGq}&N0qfj^UVJWIp}s@V0Ht_qyo30A0`KRY6-=Hzd!m*#uZn zfO}`~*RML59RI>UUFSUR=1ej7gm=ItUIUbc^p$S2I&aS|4KY1ks?)b+nK*fsL2HE_ zNgeqVZ_CTe+i-j+*WQSD%BbQC^WWKTsbtiMjy@9eP-@XvqH+;nDBPNpCa4Xj~-DLVNiLB=<`CM8(cWIA@flTHf0c{JI| zmSPrEmK0)}r!9NNz6;B_gQN;ICfgY>=A_+UnfhTnOhzMa?(FVb^iI?o6z4E@$up^O zS;Zi^M}30u*lXCNjf(JptIVv%&h&L=h9hM9EItAG=#h@aNtf-xnU7HKSUAXkJDO{i zNHepoSs9m0o-&Sr)vf2q>Z^7bxK$GFgBuTSa}liWghDar1crSIM5c~#P|jlAUBdon3KAqzf#ssR?{gcE18Pp5km&NLW(+!Tw3I>|vsY-DqK)_IUk> zRASuP8yfAMD%`MAr>FUDdsi57&BZT&!ZS$$}^+s#wUiGd;d%xRAoN&1&Dh z|I((+ckxTZS$M({#c}pGkI_g6^04$gnd;n+rT1%grr2C3$`X_HFX4icMaF9briAC= zamThV=9D9vDIh`J-FMy@^y@szOLX;bYg9Dy^Dy3FD=v%E6(Hl)3_g> zUxWz>C>f!v3=nnk)6;{yV8ivvS*p3>bBZOz#qO_8lpU0==OiX8gqXd#KJglv6;CsQ zl2HF_|Dtax`O|4J`SAd`gs{p7AKdC@hGg@ zdP<5iE_8ZhmhRin$d?pC1xF$>yQ1_N49O*;AcLhN(gDALfM)dcn;;o7{)dNx#=iyYusz5iDVn7W6m_{pKpqm~N-5i< zkHyN+edTX@w0`wwXC_v(0fP@>3{sVn4c4kgtcSAJ6K=onyydEHbf3XD(12t=zxNak z>8EE(aoiPFDfR=5aES6zQZR#@9ZN_P2*i~VtE;OOv6%dt7WLI#D&8?hjd3tTk$seo z9s_M%oi_$kA&9vjDF0|_uBn-`B70Pe6=G~Z$`wTI+d#UXEzh4DU-Wg<@67}%<}_{T zwq0OK7hfk%s39zt2xA#745hmJca3q7wi%U5)TjE zdRR}hV)Iruk`%LgZ<|oDSxrp&AM_&AWCUmwzc-_?W4I2E?o&$8W(L4iDaEJ`Z7UG_ z9#NHP}O z;_5ME;8$3r+V_C3hpFu|rqienXAyWMO?Of_De0Tq8t{T z;QFKm3&SGCzh*Ad2(#`K=(l-M=4D|D?%(n$)#CXn(=0LnogPZ&M4H7i_Y;Fp28ChC zgc*1UqIuuDu@Kmj9vu5)@y9g|D2FyziI_xMd2T38+*w4MV=`=gJ}ilAI5K$$^g10j z%D8|6gf{X)&Im|gxj?2?2+Z7Tv+p#ikQMQfocD`+-36V*)`FuYdgio;?U#~~f*WIO z4CeXqMTp2k^J}@_0CCje1{I$Sgj__Pg>KDkSb^!OqYC9hCXX#(vmiNpg(v8Ojmk;j zgjs!ZAk^YkqMyh8qpOIy@V@qp&HS83{~`S&Y1;j{bSq`4;E>6mMFl^L^oQa%%o9l_ zY4=^W%2wh313=pBegFUf literal 0 HcmV?d00001 diff --git a/package.json b/package.json index c6f7c7c..70820d5 100644 --- a/package.json +++ b/package.json @@ -1,20 +1,17 @@ { "name": "mediumroast_js", - "version": "0.3.3", + "version": "0.3.4", "description": "A Javascript SDK to interact with the mediumroast.io application including command line interfaces.", "main": "src/api/mrServer.js", - "typings": "dist/index", "scripts": { - "test": "node test/spec", - "build": "rollup -c", - "pretest": "npm run build" + "docs": "jsdoc -R ./README.md -c ./docs_config.json ./src" }, "bin": { - "study": "cli/study.js", - "company": "cli/company.js", - "interaction": "cli/interaction.js", - "mr_backup": "cli/mr_backup.js", - "mr_setup": "cli/mr_setup.js" + "mr_study": "cli/study.js", + "mr_company": "cli/company.js", + "mr_interaction": "cli/interaction.js", + "mr_backup": "cli/backup.js", + "mr_setup": "cli/setup.js" }, "type": "module", "keywords": [ @@ -52,7 +49,7 @@ "url": "https://github.com/mediumroast/mediumroast_js.git" }, "url" : "https://github.com/mediumroast/mediumroast_js/issues", - "homepage": "https://github.com/mediumroast/mediumroast_js", + "homepage": "https://mediumroast.github.io/mediumroast_js/", "dependencies": { "adm-zip": "^0.5.9", "asciiart-logo": "^0.2.7", diff --git a/src/report/common.js b/src/report/common.js index 2723a5d..8b259f2 100644 --- a/src/report/common.js +++ b/src/report/common.js @@ -727,11 +727,12 @@ class DOCXUtilities { * @description A higher level function that calls basicTopicRow to create a complete table * @param {Object} topics - the result of rankTags * @returns {Object} a complete docx table that includes topics + * @todo Sort based upon rank from highest to lowest */ topicTable(topics) { - let myRows = [this.basicTopicRow('Keywords', 'Score', 'Rank', true)] + let myRows = [this.basicTopicRow('Keywords', 'Rank', 'Score', true)] for (const topic in topics) { - myRows.push(this.basicTopicRow(topic, topics[topic].score.toFixed(2), topics[topic].rank)) + myRows.push(this.basicTopicRow(topic, topics[topic].rank), topics[topic].score.toFixed(2)) } // define the table with the summary theme information const myTable = new docx.Table({ diff --git a/src/report/companies.js b/src/report/companies.js index 19c4b7e..484827d 100644 --- a/src/report/companies.js +++ b/src/report/companies.js @@ -185,6 +185,7 @@ class CompanySection { * @description Generate the comparisons section for the document from the company in question * @param {Object} comparisons - the object containing the comparisons for the company in question * @returns {Array} An array containing an introduction to this section and the table with the comparisons + * @todo Sort based upon rank from highest to lowest */ makeComparisonDOCX(comparisons) { // Transform the comparisons into something that is usable for display @@ -196,14 +197,14 @@ class CompanySection { const topCompanyName = topCompany.name const topCompanyRole = topCompany.role - let myRows = [this.util.basicComparisonRow('Company', 'Role', 'Score', 'Rank', true)] + let myRows = [this.util.basicComparisonRow('Company', 'Role', 'Rank', 'Score', true)] for (const comparison in myComparison) { myRows.push( this.util.basicComparisonRow( myComparison[comparison].name, myComparison[comparison].role, - myComparison[comparison].score, myComparison[comparison].rank, + myComparison[comparison].score, ) ) }