@deltares/fews-web-oc-utils 0.1.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Deltares
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,26 @@
+# fews-web-oc-utils
+
+## Project setup
+```
+npm install
+```
+
+### Compiles and hot-reloads for development
+```
+npm run serve
+```
+
+### Compiles and minifies for production
+```
+npm run build
+```
+
+### Lints and fixes files
+```
+npm run lint
+```
+
+### Run Unit tests
+```
+npm run test
+```

package/dist/fews-pi-requests.umd.js

@@ -0,0 +1 @@
+!function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t():"function"==typeof define&&define.amd?define([],t):"object"==typeof exports?exports["fews-pi-requests"]=t():e["fews-pi-requests"]=t()}(self,(function(){return(()=>{"use strict";var e={};return(e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})})(e),e})()}));

package/dist/lib/index.js

@@ -0,0 +1,2 @@
+export * from './restservice';
+//# sourceMappingURL=index.js.map

package/dist/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAA"}

package/dist/lib/restservice/dataRequestResult.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=dataRequestResult.js.map

package/dist/lib/restservice/dataRequestResult.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dataRequestResult.js","sourceRoot":"","sources":["../../../src/restservice/dataRequestResult.ts"],"names":[],"mappings":""}

package/dist/lib/restservice/index.js

@@ -0,0 +1,4 @@
+export * from './dataRequestResult';
+export * from './piRestService';
+export * from './requestOptions';
+//# sourceMappingURL=index.js.map

package/dist/lib/restservice/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/restservice/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAA;AACnC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,kBAAkB,CAAA"}

package/dist/lib/restservice/piRestService.js

@@ -0,0 +1,45 @@
+export default class PiRestService {
+    webserviceUrl;
+    _oauth2Token = undefined;
+    set oauth2Token(value) {
+        this._oauth2Token = value;
+    }
+    constructor(webserviceUrl) {
+        this.webserviceUrl = webserviceUrl;
+    }
+    async getData(url) {
+        const dataRequestResult = {};
+        const requestParameters = {};
+        requestParameters.method = "GET";
+        if (this._oauth2Token !== undefined) {
+            requestParameters.headers = { "Authorization": "Bearer " + this._oauth2Token };
+        }
+        const res = await fetch(url, requestParameters);
+        return await this.processResponse(dataRequestResult, res, url);
+    }
+    async processResponse(dataRequestResult, res, url) {
+        dataRequestResult.responseCode = res.status;
+        if (res.status != 200) {
+            dataRequestResult.errorMessage = res.statusText;
+            return dataRequestResult;
+        }
+        try {
+            dataRequestResult.data = await res.json();
+        }
+        catch (e) {
+            e.message += `\n When loading ${url}.`;
+            throw e;
+        }
+        return dataRequestResult;
+    }
+    async getDataWithRequestInit(url, requestInit) {
+        const dataRequestResult = {};
+        if (this._oauth2Token !== undefined) {
+            const authorizationHeader = { "Authorization": "Bearer " + this._oauth2Token };
+            requestInit.headers = { ...authorizationHeader, ...requestInit.headers };
+        }
+        const res = await fetch(url, requestInit);
+        return await this.processResponse(dataRequestResult, res, url);
+    }
+}
+//# sourceMappingURL=piRestService.js.map

package/dist/lib/restservice/piRestService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"piRestService.js","sourceRoot":"","sources":["../../../src/restservice/piRestService.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,OAAO,OAAO,aAAa;IACb,aAAa,CAAS;IAC/B,YAAY,GAAuB,SAAS,CAAC;IAErD,IAAI,WAAW,CAAC,KAAa;QACzB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;IAC9B,CAAC;IAED,YAAY,aAAqB;QAC7B,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;IACvC,CAAC;IAEM,KAAK,CAAC,OAAO,CAAI,GAAW;QAC/B,MAAM,iBAAiB,GAAG,EAA0B,CAAC;QACrD,MAAM,iBAAiB,GAAG,EAAiB,CAAC;QAC5C,iBAAiB,CAAC,MAAM,GAAG,KAAK,CAAC;QACjC,IAAI,IAAI,CAAC,YAAY,KAAK,SAAS,EAAE;YACjC,iBAAiB,CAAC,OAAO,GAAG,EAAC,eAAe,EAAE,SAAS,GAAG,IAAI,CAAC,YAAY,EAAC,CAAA;SAC/E;QAED,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,EAAC,iBAAiB,CAAC,CAAC;QAC/C,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,iBAAiB,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;IACnE,CAAC;IAEO,KAAK,CAAC,eAAe,CAAI,iBAAuC,EAAE,GAAa,EAAE,GAAW;QAChG,iBAAiB,CAAC,YAAY,GAAG,GAAG,CAAC,MAAM,CAAC;QAC5C,IAAI,GAAG,CAAC,MAAM,IAAI,GAAG,EAAE;YACnB,iBAAiB,CAAC,YAAY,GAAG,GAAG,CAAC,UAAU,CAAC;YAChD,OAAO,iBAAiB,CAAC;SAC5B;QACD,IAAI;YACA,iBAAiB,CAAC,IAAI,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;SAC7C;QAAC,OAAO,CAAM,EAAE;YACb,CAAC,CAAC,OAAO,IAAI,mBAAmB,GAAG,GAAG,CAAA;YACtC,MAAM,CAAC,CAAC;SACX;QACD,OAAO,iBAAiB,CAAC;IAC7B,CAAC;IAEM,KAAK,CAAC,sBAAsB,CAAI,GAAW,EAAE,WAAwB;QACxE,MAAM,iBAAiB,GAAG,EAA0B,CAAC;QACrD,IAAI,IAAI,CAAC,YAAY,KAAK,SAAS,EAAE;YACjC,MAAM,mBAAmB,GAAG,EAAC,eAAe,EAAE,SAAS,GAAG,IAAI,CAAC,YAAY,EAAC,CAAC;YAC7E,WAAW,CAAC,OAAO,GAAG,EAAC,GAAG,mBAAmB,EAAE,GAAG,WAAW,CAAC,OAAO,EAAC,CAAC;SAC1E;QACD,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;QAC1C,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,iBAAiB,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;IACnE,CAAC;CACJ"}

package/dist/lib/restservice/requestOptions.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=requestOptions.js.map

package/dist/lib/restservice/requestOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"requestOptions.js","sourceRoot":"","sources":["../../../src/restservice/requestOptions.ts"],"names":[],"mappings":""}

package/dist/types/index.d.ts

@@ -0,0 +1 @@
+export * from './restservice';

package/dist/types/restservice/dataRequestResult.d.ts

@@ -0,0 +1,5 @@
+export default interface DataRequestResult<T> {
+    responseCode: number;
+    errorMessage: string;
+    data: T;
+}

package/dist/types/restservice/index.d.ts

@@ -0,0 +1,3 @@
+export * from './dataRequestResult';
+export * from './piRestService';
+export * from './requestOptions';

package/dist/types/restservice/piRestService.d.ts

@@ -0,0 +1,10 @@
+import DataRequestResult from "./dataRequestResult";
+export default class PiRestService {
+    private readonly webserviceUrl;
+    private _oauth2Token;
+    set oauth2Token(value: string);
+    constructor(webserviceUrl: string);
+    getData<T>(url: string): Promise<DataRequestResult<T>>;
+    private processResponse;
+    getDataWithRequestInit<T>(url: string, requestInit: RequestInit): Promise<DataRequestResult<T>>;
+}

package/dist/types/restservice/requestOptions.d.ts

@@ -0,0 +1,3 @@
+export default interface RequestOptions {
+    cache: string;
+}

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@deltares/fews-web-oc-utils",
+  "version": "0.1.3",
+  "description": "Util Library for common Web OC functionality",
+  "author": {
+    "name": "Werner Kramer",
+    "email": "werner.kramer@deltares.nl"
+  },
+  "keywords": [
+    "FEWS",
+    "PI REST Service",
+    "Web Operator Client",
+    "Web OC"
+  ],
+  "license": "MIT",
+  "main": "./dist/fews-web-oc-utils.umd.js",
+  "typings": "./dist/types/index.d.ts",
+  "private": false,
+  "scripts": {
+    "build": "npm run clean && tsc && webpack",
+    "clean": "shx rm -rf dist",
+    "doc": "typedoc --out doc src",
+    "lint": "eslint src/**.ts",
+    "lint:fix": "eslint src/**.ts --fix",
+    "test:unit": "jest unit --collect-coverage",
+    "test:e2e": "jest e2e",
+    "test": "jest --coverage"
+  },
+  "devDependencies": {
+    "@types/jest": "^28.0.0",
+    "@types/jsdom": "^16.2.14",
+    "@typescript-eslint/eslint-plugin": "^2.18.0",
+    "@typescript-eslint/parser": "^2.18.0",
+    "cross-fetch": "^3.1.5",
+    "dotenv": "^16.0.0",
+    "eslint": "^6.8.0",
+    "fetch-mock": "^9.11.0",
+    "jest": "^28.0.1",
+    "jest-environment-jsdom": "^29.0.1",
+    "jest-junit": "^15.0.0",
+    "jest-teamcity-reporter": "^0.9.0",
+    "jsdom": "^19.0.0",
+    "shx": "^0.3.2",
+    "ts-jest": "^28.0.8",
+    "ts-loader": "^9.3.1",
+    "typedoc": "^0.23.13",
+    "typescript": "^4.8.2",
+    "webpack": "^5.59.0",
+    "webpack-cli": "^4.9.1"
+  },
+  "jest-junit": {
+    "outputDirectory": "reports/",
+    "outputName": "junit.xml"
+  },
+  "engines": {
+    "node": ">=0.14"
+  },
+  "files": [
+    "dist/*",
+    "src/*"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Deltares/fews-web-oc-utils"
+  },
+  "bugs": {
+    "url": "https://github.com/Deltares/fews-web-oc-utils/issues"
+  }
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * from './restservice'

package/src/restservice/dataRequestResult.ts

@@ -0,0 +1,6 @@
+export default interface DataRequestResult<T> {
+    responseCode: number;
+    errorMessage: string;
+    data: T;
+
+}

package/src/restservice/index.ts

@@ -0,0 +1,3 @@
+export * from './dataRequestResult'
+export * from './piRestService'
+export * from './requestOptions'

package/src/restservice/piRestService.ts

@@ -0,0 +1,51 @@
+import DataRequestResult from "./dataRequestResult";
+
+export default class PiRestService {
+    private readonly webserviceUrl: string;
+    private _oauth2Token: string | undefined = undefined;
+
+    set oauth2Token(value: string) {
+        this._oauth2Token = value;
+    }
+
+    constructor(webserviceUrl: string) {
+        this.webserviceUrl = webserviceUrl;
+    }
+
+    public async getData<T>(url: string): Promise<DataRequestResult<T>> {
+        const dataRequestResult = {} as DataRequestResult<T>;
+        const requestParameters = {} as RequestInit;
+        requestParameters.method = "GET";
+        if (this._oauth2Token !== undefined) {
+            requestParameters.headers = {"Authorization": "Bearer " + this._oauth2Token}
+        }
+
+        const res = await fetch(url,requestParameters);
+        return await this.processResponse(dataRequestResult, res, url);
+    }
+
+    private async processResponse<T>(dataRequestResult: DataRequestResult<T>, res: Response, url: string): Promise<DataRequestResult<T>> {
+        dataRequestResult.responseCode = res.status;
+        if (res.status != 200) {
+            dataRequestResult.errorMessage = res.statusText;
+            return dataRequestResult;
+        }
+        try {
+            dataRequestResult.data = await res.json();
+        } catch (e: any) {
+            e.message += `\n When loading ${url}.`
+            throw e;
+        }
+        return dataRequestResult;
+    }
+
+    public async getDataWithRequestInit<T>(url: string, requestInit: RequestInit): Promise<DataRequestResult<T>> {
+        const dataRequestResult = {} as DataRequestResult<T>;
+        if (this._oauth2Token !== undefined) {
+            const authorizationHeader = {"Authorization": "Bearer " + this._oauth2Token};
+            requestInit.headers = {...authorizationHeader, ...requestInit.headers};
+        }
+        const res = await fetch(url, requestInit);
+        return await this.processResponse(dataRequestResult, res, url);
+    }
+}

package/src/restservice/requestOptions.ts

@@ -0,0 +1,3 @@
+export default interface RequestOptions {
+    cache: string;
+}