Refactored NetworkClient

Author: obany

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## v1.0.1
+
+* Refactored NetworkClient to make it more versatile
+* Export AddressHelper class from @iota-pico/business
+* Webpack bundling switch from Uglify to Terser
+
 ## v1.0.0
 
 * Final 1.0.0 Release

package.json

@@ -1,6 +1,6 @@
 {
  "name": "@iota-pico/lib-browser",
- "version": "1.0.0",
+ "version": "1.0.1",
  "description": "IOTA Pico Framework Library for Browser",
  "main": "pkg/iota-pico-lib-browser.js",
  "typings": "pkg/iota-pico-lib-browser.d.ts",
@@ -66,15 +66,15 @@
  "devDependencies": {
  "@types/emscripten": "0.0.31",
  "@types/jws": "^3.1.1",
- "@types/node": "^10.5.4",
+ "@types/node": "^10.11.2",
  "cross-env": "^5.2.0",
  "ncp": "^2.0.0",
  "npm-run-all": "^4.1.3",
  "replace-in-file": "^3.4.2",
  "rimraf": "^2.6.2",
- "typescript": "^3.0.3",
- "uglifyjs-webpack-plugin": "^1.2.7",
- "webpack": "^4.16.3",
- "webpack-cli": "^3.1.0"
+ "terser-webpack-plugin": "^1.1.0",
+ "typescript": "^3.1.1",
+ "webpack": "^4.20.2",
+ "webpack-cli": "^3.1.1"
  }
 }

pkg/iota-pico-lib-browser-none.js

@@ -347,43 +347,37 @@ export interface ILogger {
 export interface INetworkClient {
  /**
  * Get data asynchronously.
+ * @param data The data to send.
  * @param additionalPath An additional path append to the endpoint path.
  * @param additionalHeaders Extra headers to send with the request.
  * @returns Promise which resolves to the object returned or rejects with error.
  */
- get(additionalPath?: string, additionalHeaders?: {
+ get(data: {
+ [key: string]: any;
+ }, additionalPath?: string, additionalHeaders?: {
  [header: string]: string;
  }): Promise<string>;
  /**
  * Post data asynchronously.
- * @param additionalPath An additional path append to the endpoint path.
  * @param data The data to send.
+ * @param additionalPath An additional path append to the endpoint path.
  * @param additionalHeaders Extra headers to send with the request.
  * @returns Promise which resolves to the object returned or rejects with error.
  */
  post(data: string, additionalPath?: string, additionalHeaders?: {
  [header: string]: string;
  }): Promise<string>;
  /**
- * Get data as JSON asynchronously.
- * @typeparam U The generic type for the returned object.
- * @param additionalPath An additional path append to the endpoint path.
- * @param additionalHeaders Extra headers to send with the request.
- * @returns Promise which resolves to the object returned or rejects with error.
- */
- getJson<U>(additionalPath?: string, additionalHeaders?: {
- [header: string]: string;
- }): Promise<U>;
- /**
- * Post data as JSON asynchronously.
+ * Request data as JSON asynchronously.
  * @typeparam T The generic type for the object to send.
  * @typeparam U The generic type for the returned object.
- * @param data The data to send.
+ * @param data The data to send as the JSON body.
+ * @param method The method to send with the request.
  * @param additionalPath An additional path append to the endpoint path.
  * @param additionalHeaders Extra headers to send with the request.
  * @returns Promise which resolves to the object returned or rejects with error.
  */
- postJson<T, U>(data: T, additionalPath?: string, additionalHeaders?: {
+ json<T, U>(data?: T, method?: NetworkMethod, additionalPath?: string, additionalHeaders?: {
  [header: string]: string;
  }): Promise<U>;
  /**
@@ -511,6 +505,11 @@ export interface ITimeService {
  msSinceEpoch(): number;
 }
 
+/**
+ * Represents the http request methods.
+ */
+export type NetworkMethod = "GET" | "POST" | "PUT" | "DELETE" | "PATCH";
+
 /**
  * Represents the protocols for communicating.
  */
@@ -608,6 +607,12 @@ export class NetworkEndPoint implements INetworkEndPoint {
  * @param rootPath The path to the endpoint.
  */
  constructor(protocol: NetworkProtocol, host: string, port: number, rootPath?: string);
+ /**
+ * Create a network endpoint by parsing a uri.
+ * @param uri The uri to parse.
+ * @returns The network endpoint.
+ */
+ static fromUri(uri: string): INetworkEndPoint;
  /**
  * The protocol to access the endpoint with.
  * @returns The protocol.
@@ -2348,7 +2353,19 @@ export class BusinessError extends CoreError {
  }, innerError?: Error);
 }
 
-export {};
+/**
+ * Helper class for address signing.
+ * Original https://github.com/iotaledger/iota.lib.js/blob/master/lib/crypto/signing/signing.js
+ */
+export class AddressHelper {
+ /**
+ * Create a checksum for the trits.
+ * @param trits The trits to create the checksum for.
+ * @param checksumLength The length of the checksum.
+ * @returns the checksum as trytes.
+ */
+ static createChecksum(trits: Int8Array, checksumLength: number): string;
+}
 
 /**
  * Helper class for signing bundles.
@@ -3045,11 +3062,14 @@ export class NetworkClient implements INetworkClient {
  constructor(networkEndPoint: INetworkEndPoint, logger?: ILogger, timeoutMs?: number);
  /**
  * Get data asynchronously.
+ * @param data The data to send.
  * @param additionalPath An additional path append to the endpoint path.
  * @param additionalHeaders Extra headers to send with the request.
  * @returns Promise which resolves to the object returned or rejects with error.
  */
- get(additionalPath?: string, additionalHeaders?: {
+ get(data: {
+ [key: string]: any;
+ }, additionalPath?: string, additionalHeaders?: {
  [header: string]: string;
  }): Promise<string>;
  /**
@@ -3063,25 +3083,16 @@ export class NetworkClient implements INetworkClient {
  [header: string]: string;
  }): Promise<string>;
  /**
- * Get data as JSON asynchronously.
- * @typeparam U The generic type for the returned object.
- * @param additionalPath An additional path append to the endpoint path.
- * @param additionalHeaders Extra headers to send with the request.
- * @returns Promise which resolves to the object returned or rejects with error.
- */
- getJson<U>(additionalPath?: string, additionalHeaders?: {
- [header: string]: string;
- }): Promise<U>;
- /**
- * Post data as JSON asynchronously.
+ * Request data as JSON asynchronously.
  * @typeparam T The generic type for the object to send.
  * @typeparam U The generic type for the returned object.
- * @param data The data to send.
+ * @param data The data to send as the JSON body.
+ * @param method The method to send with the request.
  * @param additionalPath An additional path append to the endpoint path.
  * @param additionalHeaders Extra headers to send with the request.
  * @returns Promise which resolves to the object returned or rejects with error.
  */
- postJson<T, U>(data: T, additionalPath?: string, additionalHeaders?: {
+ json<T, U>(data?: T, method?: NetworkMethod, additionalPath?: string, additionalHeaders?: {
  [header: string]: string;
  }): Promise<U>;
  /**

pkg/iota-pico-lib-browser-none.min.js

@@ -1,6 +1,6 @@
 const path = require('path');
 const fs = require('fs');
-const UglifyJsPlugin = require('uglifyjs-webpack-plugin')
+const TerserJsPlugin = require('terser-webpack-plugin');
 
 const pkgFolder = path.join(__dirname, './pkg');
 const bootstrapFile = path.join(pkgFolder, 'bootstrap.js');
@@ -17,11 +17,6 @@ if (!isDir) {
 }
 fs.writeFileSync(bootstrapFile, `exports.default = require("../dist/index-${process.env.LIB_VER}");`);
 
-const plugins = [];
-if (isProd) {
- plugins.push(new UglifyJsPlugin());
-}
-
 module.exports = {
  entry: bootstrapFile,
  output: {
@@ -59,5 +54,7 @@ module.exports = {
  Buffer: true,
  setImmediate: false
  },
- plugins
+ optimization: {
+ minimizer: isProd ? [ new TerserJsPlugin() ] : []
+ }
 };