Merge pull request #2 from tech-advantage/wip/v2.1.1

[Release] v2.1.1: Update readme and dependencies

Author: DanielM235

.gitignore

@@ -14,7 +14,6 @@ typings/
 
 
 # compiled output
-/dist
 /.yarn-cache
 /tmp
 

README.md

@@ -8,7 +8,7 @@ Learn more at [https://www.easydoccontents.com](https://www.easydoccontents.com)
 
 ## edc Version Compatibility
 
-edc current release (v2.3+) uses edc-client-js v2.0.2
+edc current release (v2.7+) uses edc-client-js v2.1.1
 
 ## Note
 

dist/index.js

@@ -1,6 +1,6 @@
 {
   "name": "edc-client-js",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "description": "edc-client-js",
   "license": "MIT",
   "repository": "",
@@ -18,39 +18,39 @@
   },
   "pre-push": "lint",
   "dependencies": {
-    "axios": "0.17.1",
-    "es6-promise": "4.2.3",
-    "lodash": "4.17.5"
+    "axios": "0.18.0",
+    "es6-promise": "4.2.4",
+    "lodash": "4.17.4"
   },
   "devDependencies": {
-    "@types/jasmine": "2.5.38",
-    "@types/lodash": "4.14.104",
-    "@types/node": "6.0.60",
-    "del": "2.2.2",
+    "@types/jasmine": "2.8.8",
+    "@types/lodash": "4.14.74",
+    "@types/node": "10.5.8",
+    "del": "3.0.0",
     "dotbin": "1.0.1",
     "gulp": "4.0.0",
     "gulp-filter": "5.1.0",
     "gulp-help": "1.6.1",
     "gulp-hub": "frankwallis/gulp-hub#4.1.0",
     "gulp-tslint": "8.1.3",
     "gulp-util": "3.0.8",
-    "jasmine": "2.5.2",
-    "jsdom": "9.11.0",
-    "karma": "1.7.0",
-    "karma-firefox-launcher": "1.0.0",
-    "karma-jasmine": "1.1.0",
-    "karma-jasmine-html-reporter": "0.2.2",
-    "karma-jsdom-launcher": "5.0.0",
+    "jasmine": "3.2.0",
+    "jsdom": "11.12.0",
+    "karma": "3.0.0",
+    "karma-firefox-launcher": "1.1.0",
+    "karma-jasmine": "1.1.2",
+    "karma-jasmine-html-reporter": "1.2.0",
+    "karma-jsdom-launcher": "6.1.3",
     "karma-sourcemap-loader": "0.3.7",
-    "karma-typescript": "3.0.4",
+    "karma-typescript": "3.0.13",
     "pre-push": "0.1.1",
     "ts-loader": "3.3.0",
-    "tslint": "5.9.1",
+    "tslint": "5.11.0",
     "tslint-loader": "3.6.0",
-    "typescript": "2.7.2",
-    "uglifyjs-webpack-plugin": "1.2.2",
-    "webpack": "3.10.0",
-    "webpack-node-externals": "1.6.0"
+    "typescript": "2.9.x",
+    "uglifyjs-webpack-plugin": "1.2.7",
+    "webpack": "3.12.0",
+    "webpack-node-externals": "1.7.2"
   },
   "engines": {
     "node": ">=4.0.0"

package.json

@@ -29,13 +29,13 @@ export function getPluginIds(baseURL: string): Promise<string[]> {
 
 export function getHelpContent(baseUrl: string, suffix: ContentTypeSuffix): Promise<any> {
   return axios.get(`${baseUrl}${suffix}`)
-    .then((res: AxiosResponse) => get<number>(res, 'status') === 200 ? res.data : null,
+    .then((res: AxiosResponse) => get(res, 'status') === 200 ? res.data : null,
       (err: AxiosError) => PromiseEs6.reject(err));
 }
 
 export function getDocumentationById(globalToc: MultiToc, id: number): Documentation {
   const path = get(globalToc, `index[${id}]`);
-  return get<Documentation>(globalToc, path);
+  return get(globalToc, path);
 }
 
 export function getContent<T extends Loadable>(baseURL: string, item: T): Promise<T> {
@@ -60,17 +60,17 @@ export function createExportsFromContent(exportsContent: DocumentationExport[]):
 }
 
 export function createExportFromContent(exportContent: DocumentationExport): DocumentationExport {
-  return assign<DocumentationExport>(exportContent, { toc: new Toc() });
+  return assign(exportContent, { toc: new Toc() });
 }
 
 export function findExportById(exports: DocumentationExport[], id: string): DocumentationExport {
   return find(exports, (docExport: DocumentationExport) => docExport.pluginId === id);
 }
 
 export function getPluginIdFromDocumentId(globalToc: MultiToc, docId: number): string {
-  const docPath = get<string>(globalToc, `index[${docId}]`);
+  const docPath = get(globalToc, `index[${docId}]`) as string;
   const exportPath = first(split(docPath, '.'));
-  return get<string>(globalToc, `${exportPath}.pluginId`);
+  return get(globalToc, `${exportPath}.pluginId`);
 }
 
 export function initEachToc(baseURL: string, exports: DocumentationExport[], multiToc: MultiToc): any {
@@ -81,7 +81,7 @@ export function initEachToc(baseURL: string, exports: DocumentationExport[], mul
 }
 
 export function addTocIMsToIndex(baseUrl: string, sourceExport: DocumentationExport, multiToc: MultiToc): Promise<DocumentationExport> {
-  const pluginId = get<string>(sourceExport, 'pluginId');
+  const pluginId = get(sourceExport, 'pluginId');
   if (!pluginId) {
     return null;
   }
@@ -107,15 +107,15 @@ export function addTocIMsToIndex(baseUrl: string, sourceExport: DocumentationExp
  * @return {Promise<DocumentationExport>} returns a promise containing the current export
  */
 function addExportToGlobalToc(rootUrl: string, currentToc: Toc, sourceExport: DocumentationExport, multiToc: MultiToc): PromiseEs6<DocumentationExport> {
-  const informationMaps = get<InformationMap[]>(currentToc, 'toc');
+  const informationMaps: InformationMap[] = get(currentToc, 'toc');
   if (!informationMaps) {
     return null;
   }
   return addInformationMapsToIndex(rootUrl, informationMaps, multiToc)
     .then(() => addTocToExport(sourceExport, currentToc, multiToc));
 }
 
-function addInformationMapsToIndex(rootUrl: string, informationMaps: InformationMap[], multiToc: MultiToc): PromiseEs6<void[]> {
+function addInformationMapsToIndex(rootUrl: string, informationMaps: InformationMap[], multiToc: MultiToc): PromiseEs6<any> {
   return PromiseEs6.all(map(informationMaps, (informationMap, key) => getHelpContent(`${rootUrl}/${informationMap.file}`, ContentTypeSuffix.TYPE_EMPTY_SUFFIX)
     .then((content: InformationMap) => addSingleIMContentToIndex(informationMap, content, key, multiToc))));
 }

src/edc-client-service.ts

@@ -57,7 +57,7 @@ export class EdcClient {
     return this.globalTocReady.then((tocs: MultiToc) => {
       const pluginId = targetPluginId || this.currentPluginId;
       if (pluginId) {
-        return get<Toc>(edcClientService.findExportById(tocs.exports, pluginId), 'toc');
+        return get(edcClientService.findExportById(tocs.exports, pluginId), 'toc') as Toc;
       }
     });
   }
@@ -112,7 +112,7 @@ export class EdcClient {
         if (helper) {
           return PromiseEs6.all(
             [edcClientService.getContent<Helper>(this.baseURL, helper),
-            ...helper.articles.map(article => edcClientService.getContent<Article>(this.baseURL, article))]
+              ...helper.articles.map(article => edcClientService.getContent<Article>(this.baseURL, article))]
           );
         }
       })
@@ -181,12 +181,12 @@ export class EdcClient {
     return this.globalTocReady.then(() => {
       const docPath = this.globalToc.index[id];
       const iMPath = join(split(docPath, '.', 3), '.');
-      return get<InformationMap>(this.globalToc, iMPath);
+      return get(this.globalToc, iMPath) as InformationMap;
     });
   }
 
   getKey(key: string, subKey: string, lang: string): Helper {
-    return get<Helper>(this.context, `['${key}']['${subKey}']['${lang}']`);
+    return get(this.context, `['${key}']['${subKey}']['${lang}']`);
   }
 
   setCurrentPluginId(newPluginId: string): void {

src/edc-client.ts

@@ -14,7 +14,7 @@ export class Utils {
    */
   static indexTree(indexables: Indexable[], prefix?: string, isRoot?: boolean): Map<string, string> {
     // iterate through topics and reduce the documentations concatenating the path with parents
-    return reduce(indexables, (memo: any, {id, topics}: Documentation, index: number) => {
+    const tree = reduce(indexables, (memo: any, {id, topics}: Documentation, index: number) => {
       let newPrefix: string;
       // if it's not the root, append the prefix with keyword topics
       if (!isRoot) {
@@ -28,6 +28,7 @@ export class Utils {
       // recall the function upon topics until finding the leaf
       return assign(memo, this.indexTree(topics, newPrefix));
     }, {});
+    return tree;
   }
 
   static checkMultiDocContent(content: any): boolean {
@@ -38,9 +39,10 @@ export class Utils {
   }
 
   static isMultiTocContentValid(exportsContent: any[]): boolean {
-    return !chain(exportsContent)
+    const result = !chain(exportsContent)
       .map(exportContent => exportContent.pluginId)
       .isEmpty()
       .valueOf();
+    return result;
   }
 }