Patch release 0.9.2

Update configuration for TypeDoc generation.
Add build, test lint, bundles, typedoc commands to the prepare script.
Fix some lint issues.
Up versions to 0.9.2.
Update READMEs

Relates-To: OLPEDGE-868, OLPEDGE-929
Signed-off-by: Oleksii Zubko <ext-oleksii.zubko@here.com>

Author: OleksiiZubko

.gitignore

@@ -1,7 +1,6 @@
 node_modules/
 dist/
 doc/
-docs/src/
 .vscode
 coverage
 .nyc_output

@here/olp-sdk-authentication/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@here/olp-sdk-authentication",
-  "version": "0.9.1",
+  "version": "0.9.2",
   "description": "Wrapper around the HERE Authentication and Authorization REST API obtaining short-lived access tokens that are used to authenticate requests to HERE services.",
   "main": "dist/@here/olp-sdk-authentication/index.js",
   "browser": "dist/@here/olp-sdk-authentication/index.web.js",
@@ -14,7 +14,7 @@
     "lint": "tslint -c tslint.json -p tsconfig.json",
     "test": "mocha > xunit.xml",
     "coverage": "nyc mocha > xunit.xml",
-    "prepare": "tsc --sourceMap false",
+    "prepare": "tsc --sourceMap false && npm run bundle",
     "bundle": "npm run bundle:dev && npm run bundle:prod",
     "bundle:prod": "webpack --env.NODE_ENV=production",
     "bundle:dev": "webpack --env.NODE_ENV=development"
@@ -47,7 +47,7 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@types/properties-reader": "0.0.1",
-    "@here/olp-sdk-fetch": "0.9.1",
+    "@here/olp-sdk-fetch": "^0.9.0",
     "properties-reader": "0.3.1"
   },
   "devDependencies": {

@here/olp-sdk-dataservice-api/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@here/olp-sdk-dataservice-api",
-  "version": "0.9.1",
+  "version": "0.9.2",
   "description": "Generated from the OpenAPI specification of the HERE Open Location Platform Data API",
   "main": "dist/@here/olp-sdk-dataservice-api/index.js",
   "typings": "dist/@here/olp-sdk-dataservice-api/index",
@@ -16,7 +16,7 @@
     "lint": "tslint -c tslint.json -p tsconfig.json",
     "test": "mocha > xunit.xml",
     "coverage": "nyc mocha > xunit.xml",
-    "prepare": "tsc --sourceMap false",
+    "prepare": "tsc --sourceMap false && npm run bundle",
     "bundle": "npm run bundle:dev && npm run bundle:prod",
     "bundle:prod": "webpack --env.NODE_ENV=production",
     "bundle:dev": "webpack --env.NODE_ENV=development"

@here/olp-sdk-dataservice-read/lib/CatalogClient.ts

@@ -65,6 +65,7 @@ export class CatalogClient {
      * obtain layers.
      */
 
+    // tslint:disable-next-line: deprecation
     readonly layers = new Map<string, CatalogLayer>();
 
     /**
@@ -115,6 +116,7 @@ export class CatalogClient {
      */
     public async getVolatileOrVersionedLayer(
         layerName: string
+    // tslint:disable-next-line: deprecation
     ): Promise<CatalogLayer> {
         const data = await this.findLayer(layerName);
         if (data === null) {
@@ -191,6 +193,7 @@ export class CatalogClient {
      * @param layerName The name of the layer to look for.
      * @returns Promise with the layer object or with null if the layer is not part of this catalog.
      */
+    // tslint:disable-next-line: deprecation
     private async findLayer(layerName: string): Promise<CatalogLayer | null> {
         if (!this.layers.size) {
             await this.loadVolatileOrVersionedLayersFromConfig().catch(err =>
@@ -261,6 +264,7 @@ export class CatalogClient {
         );
 
         for (const layerConfig of layersConfigurations) {
+            // tslint:disable-next-line: deprecation
             const layer: CatalogLayer | null = this.buildCatalogLayer(
                 layerConfig,
                 layerVersions.get(layerConfig.id)
@@ -276,6 +280,7 @@ export class CatalogClient {
     private buildCatalogLayer(
         config: ConfigApi.Layer,
         version?: number
+    // tslint:disable-next-line: deprecation
     ): CatalogLayer | null {
         // we're interesting only for versioned or volatile layers.
         if (
@@ -303,6 +308,7 @@ export class CatalogClient {
         }
 
         // add required methods for interface (all required methods means that methods are in both Layer clients)
+        // tslint:disable-next-line: deprecation
         const result: CatalogLayer = {
             ...config,
             apiVersion: 2,

@here/olp-sdk-dataservice-read/lib/VolatileLayerClient.ts

@@ -25,8 +25,8 @@ import {
 } from "@here/olp-sdk-dataservice-api";
 import {
     AggregatedDownloadResponse,
-    IndexMap,
-    ErrorHTTPResponse
+    ErrorHTTPResponse,
+    IndexMap
 } from "./CatalogClientCommon";
 import { ApiName, DataStoreContext } from "./DataStoreContext";
 import { DataStoreRequestBuilder } from "./DataStoreRequestBuilder";

@here/olp-sdk-dataservice-read/lib/getEnvLookupUrl.ts

@@ -44,7 +44,7 @@ export function getEnvLookUpUrl(env: EnvironmentName): string {
             "(?:\\.(?:[a-z\\u00a1-\\uffff0-9]-*)*[a-z\\u00a1-\\uffff0-9]+)*";
         const tld = `(?:\\.(?:[a-z\\u00a1-\\uffff]{2,}))\\.?`;
         const port = "(?::\\d{2,5})?";
-        const path = '(?:[/?#][^\\s"]*)?';
+        const path = "(?:[/?#][^\\s\"]*)?";
         const regex = new RegExp(
             `(?:${protocol}|www\\.)(?:localhost|${ip}|${host}${domain}${tld})${port}${path}`
         );

@here/olp-sdk-dataservice-read/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@here/olp-sdk-dataservice-read",
-  "version": "0.9.1",
+  "version": "0.9.2",
   "description": "Wrapper around a subset of the HERE Open Location Platform Data REST API related to reading data from OLP catalogs",
   "main": "dist/@here/olp-sdk-dataservice-read/index.js",
   "browser": "dist/@here/olp-sdk-dataservice-read/index.web.js",
@@ -14,7 +14,7 @@
     "lint": "tslint -c tslint.json -p tsconfig.json",
     "test": "mocha > xunit.xml",
     "coverage": "nyc mocha > xunit.xml",
-    "prepare": "tsc --sourceMap false",
+    "prepare": "tsc --sourceMap false && npm run bundle",
     "bundle": "npm run bundle:dev && npm run bundle:prod",
     "bundle:prod": "webpack --env.NODE_ENV=production",
     "bundle:dev": "webpack --env.NODE_ENV=development"
@@ -47,8 +47,8 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@here/olp-sdk-dataservice-api": "0.9.1",
-    "@here/olp-sdk-fetch": "0.9.1"
+    "@here/olp-sdk-dataservice-api": "^0.9.0",
+    "@here/olp-sdk-fetch": "^0.9.0"
   },
   "devDependencies": {
     "@types/chai": "4.2.3",

@here/olp-sdk-fetch/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@here/olp-sdk-fetch",
-  "version": "0.9.1",
+  "version": "0.9.2",
   "description": "Adds a subset of the fetch API for Node.js",
   "main": "dist/@here/olp-sdk-fetch/index.js",
   "browser": "dist/@here/olp-sdk-fetch/index.web.js",
@@ -14,7 +14,7 @@
     "test": "mocha > xunit.xml",
     "coverage": "nyc mocha > xunit.xml",
     "copy-tests-resourses": "cp -r test/resources dist/@here/olp-sdk-fetch/test",
-    "prepare": "tsc --sourceMap false",
+    "prepare": "tsc --sourceMap false && npm run bundle",
     "bundle": "npm run bundle:dev && npm run bundle:prod",
     "bundle:prod": "webpack --env.NODE_ENV=production",
     "bundle:dev": "webpack --env.NODE_ENV=development"

@here/olp-sdk-fetch/webpack.config.js

@@ -12,8 +12,8 @@ module.exports = env => {
     },
     entry: "./index.ts",
     output: {
-      filename: `olp-sdk-fetch.${packageInfo.version}${isProd ? '.min' : '.dev'}.js`,
-      path: path.resolve(__dirname, `./dist/bundle`),
+      filename: `olp-sdk-fetch${isProd ? '.min' : '.dev'}.js`,
+      path: path.resolve(__dirname, `dist`),
       libraryTarget: "umd",
       globalObject: 'this'
     },

CHANGELOG.md

@@ -1,3 +1,14 @@
+## v0.9.2-beta (28/10/2019)
+
+* Changed prepare process before publishing
+
+* Changed configuration to the TypeDoc
+
+* Fixed tslints
+
+* Align Version and Volatile Layers with DatastoreApi
+
+
 ## v0.9.1-beta (17/10/2019)
 
 **olp-sdk-authentication**

README.md

@@ -82,8 +82,9 @@ npm run coverage
 To generate documentation for all modules and classes, run :
 
 ```sh
-npm run docs
+npm run typedoc
 ```
+The dist/doc folder will be generated
 
 #### Usage of Bundle functionality
 
@@ -116,10 +117,10 @@ npm run bundle
 
 Or use from CDN:
 
-https://unpkg.com/browse/@here/olp-sdk-authentication@0.9.1/dist/olp-sdk-authentication.min.js
-https://unpkg.com/browse/@here/olp-sdk-dataservice-api@0.9.1/dist/olp-sdk-dataservice-api.min.js
-https://unpkg.com/browse/@here/olp-sdk-dataservice-read@0.9.1/dist/olp-sdk-dataservice-read.min.js
-https://unpkg.com/browse/@here/olp-sdk-fetch@0.9.1/dist/olp-sdk-fetch.min.js
+https://unpkg.com/@here/olp-sdk-authentication@0.9.2/dist/olp-sdk-authentication.min.js
+https://unpkg.com/@here/olp-sdk-dataservice-api@0.9.2/dist/olp-sdk-dataservice-api.min.js
+https://unpkg.com/@here/olp-sdk-dataservice-read@0.9.2/dist/olp-sdk-dataservice-read.min.js
+https://unpkg.com/@here/olp-sdk-fetch@0.9.2/dist/olp-sdk-fetch.min.js
 
 
 ## LICENSE

package.json

@@ -1,26 +1,28 @@
 {
   "name": "@here/olp-sdk-ts",
-  "version": "0.9.1",
+  "version": "0.9.2",
   "description": "HERE OLP SDK for TypeScript",
   "author": {
     "name": "HERE Europe B.V.",
     "url": "https://here.com"
   },
   "license": "Apache-2.0",
-  "private": "true",
+  "private": true,
   "workspaces": [
     "@here/*"
   ],
   "scripts": {
     "bootstrap": "lerna bootstrap --use-workspaces",
+    "prepare": "npm run clean-dists && npm run lint && npm run build && npm run test && npm run coverage && npm run bundle && npm run typedoc",
     "build": "lerna run build",
     "test": "lerna run test",
     "coverage": "lerna run coverage",
     "lint": "lerna run lint",
     "bundle": "lerna run bundle",
+    "bundle:dev": "lerna run bundle:dev",
     "bundle:prod": "lerna run bundle:prod",
-    "prepublish-bundle": "lerna run prepublish-bundle",
-    "docs": "npx typedoc --out docs/src"
+    "typedoc": "npx typedoc --disableOutputCheck --options typedoc.json",
+    "clean-dists": "rm -rf dist && rm -rf @here/*/dist"
   },
   "devDependencies": {
     "lerna": "3.16.4",

scripts/linux/psv/travis_build_test_psv.sh

@@ -1,6 +1,3 @@
 #!/bin/bash -xe
 yarn
 yarn bootstrap
-npm run build
-npm run prepublish-bundle
-npm run test

typedoc.json

@@ -0,0 +1,19 @@
+
+{
+    "name": "@here/olp-sdk-ts",
+    "mode": "modules",
+    "module": "commonjs",
+    "out": "dist/doc",
+    "exclude": [
+        "**/node_modules/**",
+        "**/test/**/*.ts",
+        "**/dist/**/*.ts",
+        "**/scripts/*.ts"
+    ],
+    "readme": "README.md",
+    "target": "ES6",
+    "excludePrivate": "true",
+    "excludeExternals": "true",
+    "excludeNotExported": "true",
+    "external-modulemap": ".*/@here/([\\w\\-_]+)/"
+}