ti2 1.0.13 → 1.0.14

package/README.md

@@ -22,21 +22,9 @@ App Plugins are value added tools that only speak to Ti2 and other plugins. For
 
 Ti2 can be deployed on your own servers, or you can connect to a Ti2 instance that another company is hosting.
 
-### Security
-
-An admin api key is set trough an environment variable called adminKey; using this API key is possible to create Users and/or application authentications.
-
-A new User / User Authentication can be created using the endpoint [createUserToken](https://ti2.tourconnect.dev/api-docs/#/admin/createUserToken); the return value consists of a JWT token for further user intraction with the App; the admin API key is required; no password is saved on the server side.
-
-Apps / Integrations can be created using the admin API Key; this after the plugin had been added to the codebase; the app can be created using the endpoint [createApp](https://ti2.tourconnect.dev/api-docs/#/admin/createApp); such endpoint returns a key that can be used by the app to interact with user Ids; such interactions allow the app to push for changes related to user integrations, the app can list the users currently configured for it using the endpoint [listAppTokens](https://ti2.tourconnect.dev/api-docs/#/app/listAppTokens); the passwords for Apps are encripted onde the database using aes-256-cbc, more details can be found on the [``models/integrations.js``](https://github.com/ti2travel/ti2/blob/main/models/integration.js) file.
-
-User + app integration credentials can be added after the app has been added to the system; these can be added by either the user, admin or the app itself using the endpoint [createAppToken](https://ti2.tourconnect.dev/api-docs/#/app/createAppToken). These keys are saved in JWT format on the database.
-
 ## Getting Started
 
-You can start follow [this guide]{@tutorial setup-your-instance} to create an instance, if you want to add an integration (like for your own backend) or add a new internal funtionality you can [create a plugin]{@tutorial plugin-development} for your system.
-
-By default a ti2 instance serves a documentation page on the url (http://[yourinstance]/api-docs/) that serves the available API restfull methods, you can review the [swagger documentation page online](https://ti2-staging.tourconnect.com/api-docs/) .
+You can write your [own plugin]{@tutorial plugin-development} that hooks up to a Ti2 instance or you can run a server that that hosts your [own **Ti2** instance]{@tutorial setup-your-instance} with any plugins (your own or from the plugin library).
 
 
 ## Plugins

package/jsdoc.conf.json

@@ -13,7 +13,10 @@
     ],
     "templates": {
         "cleverLinks": true,
-        "monospaceLinks": true
+        "monospaceLinks": true,
+        "default": {
+            "includeDate": false
+        }
     },
     "opts": {
         "destination": "docs",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ti2",
-  "version": "1.0.13",
+  "version": "1.0.14",
   "description": "Tourist Industry Exchange (TI2)",
   "main": "index.js",
   "scripts": {

package/test/plugin.js

@@ -3,7 +3,7 @@ const chance = require('chance').Chance();
 
 class Plugin {
   /**
-   * For a comprehensive list of mehtods visit the
+   * For a comprehensive list of methods visit the
    * [Plugin Development]{@tutorial plugin-development} page.
    *
    * ---
@@ -46,11 +46,11 @@ class Plugin {
   }
 
   /**
-   *  Check the vailidity of an integration token.
+   *  Check the validity of an integration token.
    * @async
    * @param {Object} args - Availability search arguments.
    * @param {Object} args.token - A token definition, it's content varies between integrations.
-   * @returns {Boolean} - The token vailidity True/False
+   * @returns {Boolean} - The token validity True/False
    */
   validateToken() {
     return Boolean(this);
@@ -306,7 +306,7 @@ class Plugin {
    * @param {string} args.payload.travelDateEnd - Date of travel end.
    * @param {Holder} args.payload.holder - Search for a particular holder.
    * @returns {object} retVal - the return object.
-   * @returns {Booking[]} retVal.bookings - Array of Bookings matchin the criteria.
+   * @returns {Booking[]} retVal.bookings - Array of Bookings matching the criteria.
    */
   searchBooking() {
   }

package/tutorials/index.json

@@ -1,6 +1,6 @@
 {
     "setup-your-instance": {
-        "title": "Setting up your instancce"
+        "title": "Running your own Ti2"
     },
     "plugin-development": {
         "title": "Plugin Development"

package/tutorials/plugin-development.md

@@ -1,21 +1,15 @@
-## Environment values
+## Getting Started
 
-Plugin environment keys are passed down to the instance while is being created, this is the preferred way of accesing environmen keys from the plugins, such values are not design to hold client / user's API keys or specific data, they are to be stored on the database itself via the AppKey collection.
+Plugins can extend the functionality of Ti2 and/or provide access to other platforms; you should use one of the following methods to provide a stadandarized way to access other systems; if you want to implement new functionality that is not encompassed on the available methods you are more than welcome to add new methods and contribute to the Ti2 codebase.
 
-Plugin ENV variable name convention: ti2_pluginName_environmenVariableName, for example:
-
-```env
-ti2_tourconnect_apiUrl=http://backend:8080
-```
+## Available Methods
 
-## Methods
-
-In oorder for an integration or system apps, we must use a set of standirzed methods to matain a compatibility; there are following methods are available, more can be supported but should be a part of the API TI2 spec to maximize it's compatibility.
+We are using a set of standardized methods to maintain compatibility; the following methods are available, more can be supported but should be a added to the TI2 spec first to maximize it's compatibility.
 
 **General Methods** (should always be included):
 * [validateToken]{@link Plugin#validateToken}
 
-**Content Methods** (related to marketing information update for profile, locations and/or products):
+**Content Methods** (marketing information for (company)profile, locations and/or products):
 * [getProfile]{@link Plugin#getProfile}
 * [updateProfile]{@link Plugin#updateProfile}
 * [createLocation]{@link Plugin#createLocation}
@@ -24,7 +18,7 @@ In oorder for an integration or system apps, we must use a set of standirzed met
 * [createProduct]{@link Plugin#createProduct}
 * [updateProduct]{@link Plugin#updateProduct}
 
-**Booking Methods** (all related to bookings and operations):
+**Booking Methods** (bookings and operations):
 * [searchBooking]{@link Plugin#searchBooking}
 * [searchProducts]{@link Plugin#searchProducts}
 * [searchAvailability]{@link Plugin#searchAvailability}
@@ -33,10 +27,20 @@ In oorder for an integration or system apps, we must use a set of standirzed met
 
 ---
 
+## Environment variables
+
+Plugin environment keys are passed down from the hosting ti2 instance when they are generated, this is the preferred way to access environment keys from the plugins, such values are not design to hold client / user's API keys or specific data, they are to be stored in the database via the AppKey collection.
+
+Plugin ENV variable name convention: ti2_pluginName_environmenVariableName, for example:
+
+```env
+ti2_tourconnect_apiUrl=http://backend:8080
+```
+
 
 ## Codebase setup
 
-You can review some of the plugins previously developed and use them as a guide, plugin methods are encourage to include tests and return results on the same format, however the return values can include additional information, currently Ti2 is expected to run on node version 12.22.8; we suggest you use the same for your codebase.
+You can review some of the plugins previously developed and use them as a guide, plugin methods are encourage to include tests and to return results with the same format; however, the returned values can include additional information, currently Ti2 is expected to run on node version 12.22.8; we suggest you use the same for your codebase.
 
 
 After initializing your git environment for development; you can initialize your node project; we recommend naming your repo ti2-\<pluginname\> but it is not required.
@@ -61,7 +65,7 @@ class Plugin {
 module.exports = Plugin;
 ```
 
-The constructor of the plugins should extend the attributes with the received params, this allows the plugin to receive configurations or settings that are to be used by any user; that is settings that are shared across accounts.
+The constructor of the plugins should extend the attributes with the received params, this allows the plugin to receive configurations or settings that are to be used by any user, for example, settings data that can be shared across accounts.
 
 By default Ti2 will pass down all environment variables that match the plugin name to it's constructor; for example, if the following environment variables are defined:
 
@@ -98,7 +102,7 @@ class Plugin {
 module.exports = Plugin;
 ```
 
-The token parameter includes all the settings for the current configured user; on these example we are defauring this settings to the ones configured to the pluging when it was instanced; so if the user settings do not include an apiUrl it will fall back to the environment variable on the running server.
+The token parameter should store all the settings for the current configured end user; on these example we are defaulting this settings to the ones configured to the pluging when it was instanced; so if the user settings do not include an apiUrl it will fall back to the environment variable on the running server.
 
 ## Testing Suite
 
@@ -141,7 +145,9 @@ describe('Base Tests', () => {
 $ npx jest
 ```
 
-## Adding the folder to a ti2 instance
+## Deploying
+
+### To your own Instance
 
 After setting up a [Ti2 instance]{@tutorial setup-your-instance} you can add your development folder as a package on your instance's npm repo (not on the plugin's instance), like so:
 
@@ -151,13 +157,17 @@ After setting up a [Ti2 instance]{@tutorial setup-your-instance} you can add you
     }
 ```
 
+### To our hosted instance
+
+[Contact us](https://www.ti2.travel/contact-us) with the npm published package to begin the testing and deployment process.
+
 ## Extending the base API
 
-Ti2 uses the [Swagger API specification](https://swagger.io/specification/) standard to define it's own methods, you can review the base methods [here](https://ti2-staging.tourconnect.com/api-docs/); these methods can be extender using the same format; this allows any plugin to extend the base API endpoints that are linked to any plugin method (part of the base methods or new ones).
+Ti2 uses the [Swagger API specification](https://swagger.io/specification/) standard to define it's own methods, you can review the basic methods [here](https://ti2-staging.tourconnect.com/api-docs/); these methods can be extended using the same format; this allows any plugin to extend the base API endpoints that are linked to any plugin method (part of the basic methods or new ones).
 
 All the extender methods would be availble under the /\[plugin name] namespace, i.e.: /ti2-greatPlugin/ping.
 
-For Ti2 to pickup the extender definition one must create a new file on the root of the plugin named api.yml, such file would contain only the methods to be extender and it must comply with the current swagger version used on ti2.
+For Ti2 to pickup the extender definition, one must create a new file on the root of the plugin named api.yml, such file would contain only the methods to be extended and it must comply with the current swagger version used on ti2.
 
 ```yaml
 # api.yml
@@ -202,7 +212,7 @@ paths:
 
 ## Database Migrations (plugin's own database tables)
 
-Ti2 uses [Sequelize v6.13](https://sequelize.org/v6) and is the database ORM we ecourage to use, you can add your own tables via migrations that should be placed under a migrations folder on the root of the plugin folder.
+Ti2 uses [Sequelize v6.13](https://sequelize.org/v6) which is the database ORM we ecourage you to use, you can add your own tables via migrations that should be placed under a migrations folder on the root of the plugin folder.
 
 Migrations should be run after the fact, from the root of ti2 instance like so:
 
@@ -211,9 +221,9 @@ Migrations should be run after the fact, from the root of ti2 instance like so:
 $  npm explore ti2<pluginName> -- npx sequelize db:migrate"
 ```
 
-We strongly encourage all the plugin's table names are predicated with the plugin name (i.e. ti2-pluginName-cacheTable).
+We strongly encourage all the plugin's table names are prefixed with the plugin name (i.e. ti2-pluginName-cacheTable).
 
-This should be executed ater the ti2 project migrations have been executed.
+This should be executed after the ti2 project migrations have been executed.
 
 ## Scheduled Task (to be released on v2)
 

package/tutorials/setup-your-instance.md

@@ -1,15 +1,24 @@
-## Initializing your new Repo
+## Why would I want to run my own instance?
 
-We suggest creating a folder with your instance name+i2 (i.e acme-ti2); then initialize an node's npm package and install ti2 along with any plugins to be used.
+* Scenario 1: You want to test your plugins before submitting it to our Ti2 instance, it is a good idea to spin up your own Ti2 test instance, you can test against all the Ti2 REST Apis (In the future, we will provide a Ti2 sandbox instance).
 
-```bash
-$ mkdir acme-ti2
-$ cd acmme-ti2
-$ npm init .
-$ npm i ti2 ti2-tourconnect
-```
+* Scenario 2: You want to host your own Ti2 server so you can have everything under your own control.
+
+When you are runnning a Ti2 server you can access the documentation page on the url (http://[yourinstance]/api-docs/) that shows the available API methods, you can review the [swagger documentation page online](https://ti2-staging.tourconnect.com/api-docs/) .
+
+## Security
+
+An admin api key is set trough an environment variable called adminKey; using this API key is possible to create Users and/or application authentications.
+
+A new User/User Authentication can be created using the endpoint [createUserToken](https://ti2.tourconnect.dev/api-docs/#/admin/createUserToken); the return value consists of a JWT token for further user intraction with the App; the admin API key is required; no password is saved on the server side.
+
+Apps/Integrations can be created using the admin API Key; this after the plugin had been added to the codebase; the app can be created using the endpoint [createApp](https://ti2.tourconnect.dev/api-docs/#/admin/createApp); such endpoint returns a key that can be used by the app to interact with user Ids; such interactions allow the app to push for changes related to user integrations, the app can list the users currently configured for it using the endpoint [listAppTokens](https://ti2.tourconnect.dev/api-docs/#/app/listAppTokens); the passwords for Apps are encripted onde the database using aes-256-cbc, more details can be found on the [``models/integrations.js``](https://github.com/ti2travel/ti2/blob/main/models/integration.js) file.
+
+User + app integration credentials can be added after the app has been added to the system; these can be added by either the user, admin or the app itself using the endpoint [createAppToken](https://ti2.tourconnect.dev/api-docs/#/app/createAppToken). These keys are saved in JWT format on the database.
 
-## Requirements
+## Get Started
+
+### Requirements and Evironment variables
 
 A MySQl instance is required and the following environment variables are required:
 
@@ -28,13 +37,25 @@ frontendKey=IpOiLahrGQxsQimwoK7Z
 adminKey=bCviyz7iKyuEBoOVlODn
 ```
 
-After installing the ti2 package you need to run the datbase migrations for ti2:
+### Initialize a new NodeJS project
+
+We suggest creating a folder with your instance name+i2 (i.e acme-ti2); then initialize an node's npm package and install ti2 along with any plugins to be used.
+
+```bash
+$ mkdir acme-ti2
+$ cd acmme-ti2
+$ npm init .
+$ npm i ti2 ti2-tourconnect
+```
+
+
+After installing the ti2 package you need to run the database migrations for ti2:
 
 ```
 $  npm explore ti2<pluginName> -- npx sequelize db:migrate"
 ```
 
-## Entry File
+### Entry File
 
 then just create an entry file like this :