Add missing packages and other stuff

Author: JacopoMangiavacchi

.editorconfig

@@ -0,0 +1,15 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# Default:
+# https://github.com/editorconfig/editorconfig-defaults/blob/master/editorconfig-defaults.json
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 4

package-lock.json

@@ -3,7 +3,15 @@
   "version": "1.0.0",
   "description": "TensorFlow record (.tfrecord) API for Node.JS and Browsers",
   "main": "lib/index.js",
-  "types": "lib/index.d.ts",  "scripts": {
+  "dependencies": {
+    "buffer-reverse": "^1.0.1",
+    "crypto-js": "^3.1.9-1",
+    "google-protobuf": "^3.6.1",
+    "node-int64": "^0.4.0",
+    "shortid": "^2.2.14"
+  },
+  "types": "lib/index.d.ts",
+  "scripts": {
     "test": "jest --config jestconfig.json",
     "build": "tsc",
     "format": "prettier --write \"src/**/*.ts\" \"src/**/*.js\"",
@@ -18,14 +26,18 @@
     "type": "git",
     "url": "git+https://github.com/JacopoMangiavacchi/TFRecords.git"
   },
-  "keywords": ["TFRecords", "TensorFlow"],
+  "keywords": [
+    "TFRecords",
+    "TensorFlow"
+  ],
   "author": "Jacopo Mangiavacchi",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/JacopoMangiavacchi/TFRecords/issues"
   },
   "homepage": "https://github.com/JacopoMangiavacchi/TFRecords#readme",
   "devDependencies": {
+    "@types/node": "10.12.7",
     "@types/jest": "^24.0.6",
     "jest": "^24.1.0",
     "prettier": "^1.16.4",

package.json

@@ -0,0 +1,61 @@
+import Guard from "./guard";
+
+describe("Guard", () => {
+    function methodWithRequiredName(name: string) {
+        Guard.emtpy(name);
+    }
+
+    function methodWithRequiredNameWithParam(name: string) {
+        Guard.emtpy(name, "name", "Name is required");
+    }
+
+    function methodWithRequiredObject(options: any) {
+        Guard.null(options);
+    }
+
+    function methodWithRequiredExpression(value: number) {
+        Guard.expression(value, (num) => num > 0 && num < 100);
+    }
+
+    describe("empty", () => {
+        it("throws error on null value", () => {
+            expect(() => methodWithRequiredName(null)).toThrowError();
+        });
+
+        it("throws error on empty value", () => {
+            expect(() => methodWithRequiredName("")).toThrowError();
+        });
+
+        it("throw error on whitespace", () => {
+            expect(() => methodWithRequiredName(" ")).toThrowError();
+        });
+
+        it("does not throw error on valid value", () => {
+            expect(() => methodWithRequiredName("valid")).not.toThrowError();
+        });
+
+        it("throws specific error message", () => {
+            expect(() => methodWithRequiredNameWithParam(null)).toThrowError("Name is required");
+        });
+    });
+
+    describe("null", () => {
+        it("throws error on null value", () => {
+            expect(() => methodWithRequiredObject(null)).toThrowError();
+        });
+
+        it("does not throw error on valid value", () => {
+            expect(() => methodWithRequiredObject({})).not.toThrowError();
+        });
+    });
+
+    describe("expression", () => {
+        it("throws error on invalide value", () => {
+            expect(() => methodWithRequiredExpression(0)).toThrowError();
+        });
+
+        it("does not throw error on valid value", () => {
+            expect(() => methodWithRequiredExpression(1)).not.toThrowError();
+        });
+    });
+});

src/guard.test.ts

@@ -0,0 +1,41 @@
+export default class Guard {
+    /**
+     * Validates the string express is not null or empty, otherwise throws an exception
+     * @param value - The value to validate
+     * @param paramName - The name of the parameter to validate
+     * @param message - The error message to return on invalid value
+     */
+    public static emtpy(value: string, paramName?: string, message?: string) {
+        if ((!!value === false || value.trim().length === 0)) {
+            message = message || (`'${paramName || "value"}' cannot be null or empty`);
+            throw new Error(message);
+        }
+    }
+
+    /**
+     * Validates the value is not null, otherwise throw an exception
+     * @param value - The value to validate
+     * @param paramName - The name of the parameter to validate
+     * @param message - The error message to return on invalid value
+     */
+    public static null(value: any, paramName?: string, message?: string) {
+        if ((!!value === false)) {
+            message = message || (`'${paramName || "value"}' cannot be null or undefined`);
+            throw new Error(message);
+        }
+    }
+
+    /**
+     * Validates the value meets the specified expectation, otherwise throws an exception
+     * @param value - The value to validate
+     * @param predicate - The predicate used for validation
+     * @param paramName - The name of the parameter to validate
+     * @param message - The error message to return on invalid value
+     */
+    public static expression<T>(value: T, predicate: (value: T) => boolean, paramName?: string, message?: string) {
+        if (!!value === false || !predicate(value)) {
+            message = message || (`'${paramName || "value"}' is not a valid value`);
+            throw new Error(message);
+        }
+    }
+}

src/guard.ts

@@ -22,6 +22,7 @@
 
 import Int64 from "node-int64";
 import reverse from "buffer-reverse";
+import Guard from "./guard";
 
 /**
  * @buffer - Buffer input

src/tensorFlowHelpers.ts

@@ -1,3 +1,4 @@
+import Guard from "./guard";
 import { FeatureType } from "./tensorFlowBuilder";
 import { crc32c, maskCrc, readInt64, textDecode } from "./tensorFlowHelpers";
 import { TFRecordsImageMessage } from "./tensorFlowRecordsProtoBuf_pb";

src/tensorFlowReader.ts

@@ -1,11 +1,26 @@
 {
-    "compilerOptions": {
-      "target": "es5",
-      "module": "commonjs",
-      "declaration": true,
-      "outDir": "./lib",
-      "strict": true
-    },
-    "include": ["src"],
-    "exclude": ["node_modules", "**/__tests__/*"]
-  }
+  "compilerOptions": {
+      "target": "es6",
+      "allowJs": false,
+      "skipLibCheck": false,
+      "esModuleInterop": true,
+      "allowSyntheticDefaultImports": true,
+      "strict": false,
+      "forceConsistentCasingInFileNames": true,
+      "module": "esnext",
+      "moduleResolution": "node",
+      "resolveJsonModule": true,
+      "isolatedModules": true,
+      "noEmit": true,
+      "jsx": "preserve",
+      "experimentalDecorators": true,
+      "lib": [
+          "es2015",
+          "dom"
+      ]
+  },
+  "include": [
+      "src",
+      ".storybook"
+  ]
+}

tsconfig.json

@@ -1,3 +1,17 @@
 {
-    "extends": ["tslint:recommended", "tslint-config-prettier"]
+    "defaultSeverity": "error",
+    "extends": [
+        "tslint:recommended"
+    ],
+    "jsRules": {},
+    "rules": {
+        "object-literal-sort-keys": false,
+        "no-console": false,
+        "no-shadowed-variable": false,
+        "ordered-imports": false,
+        "no-string-literal": false,
+        "no-bitwise": false,
+        "function-constructor": false
+    },
+    "rulesDirectory": []
 }