Merge pull request #23 from roboflow/security/merge-upstream-and-deploy-new-npm-package

bigbitbus · web-flow · commit a832a4019cc4 · 2024-05-01T16:08:56.000-04:00
Security/merge upstream and deploy new npm package
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,6 @@
 node_modules
 /lib
+src/*.js
+src/*.d.ts
+src/*.js.map
+!src/tensorFlowRecordsProtoBuf_pb.js
diff --git a/.npmignore b/.npmignore
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,19 +1,18 @@
 {
   "name": "@roboflow/tfrecords",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "TensorFlow record (.tfrecord) API for Node.JS and Browsers",
   "main": "src/tensorFlowBuilder.js",
   "dependencies": {
     "buffer-reverse": "^1.0.1",
-    "crypto-js": "^3.1.9-1",
-    "google-protobuf": "^3.6.1",
+    "google-protobuf": "3.21.2",
     "node-int64": "^0.4.0",
     "shortid": "^2.2.14"
   },
   "types": "src/index.d.ts",
   "scripts": {
     "test": "jest --config jestconfig.json",
-    "build": "tsc",
+    "build": "tsc --project tsconfig.build.json",
     "format": "prettier --write \"src/**/*.ts\" \"src/**/*.js\"",
     "lint": "tslint -p tsconfig.json",
     "prepare": "npm run build",
@@ -37,14 +36,14 @@
   },
   "homepage": "https://github.com/JacopoMangiavacchi/TFRecords#readme",
   "devDependencies": {
-    "@types/node": "^10.12.7",
-    "@types/jest": "^24.0.23",
-    "jest": "^24.9.0",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.12.7",
+    "jest": "^29.7.0",
     "prettier": "^1.16.4",
-    "ts-jest": "^24.2.0",
+    "ts-jest": "29.1.2",
     "tslint": "^5.12.1",
     "tslint-config-prettier": "^1.18.0",
-    "typescript": "^3.3.3"
+    "typescript": "^5.4.5"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org"
diff --git a/src/guard.js b/src/guard.js
@@ -7,8 +7,8 @@ class Guard {
      * @param paramName - The name of the parameter to validate
      * @param message - The error message to return on invalid value
      */
-    static emtpy(value, paramName, message) {
-        if ((!!value === false || value.trim().length === 0)) {
+    static empty(value, paramName, message) {
+        if (value === null || !value || value.trim().length === 0) {
             message = message || (`'${paramName || "value"}' cannot be null or empty`);
             throw new Error(message);
         }
@@ -20,7 +20,7 @@ class Guard {
      * @param message - The error message to return on invalid value
      */
     static null(value, paramName, message) {
-        if ((!!value === false)) {
+        if (!value) {
             message = message || (`'${paramName || "value"}' cannot be null or undefined`);
             throw new Error(message);
         }
@@ -33,7 +33,7 @@ class Guard {
      * @param message - The error message to return on invalid value
      */
     static expression(value, predicate, paramName, message) {
-        if (!!value === false || !predicate(value)) {
+        if (!value || !predicate(value)) {
             message = message || (`'${paramName || "value"}' is not a valid value`);
             throw new Error(message);
         }
diff --git a/src/guard.test.js b/src/guard.test.js
@@ -6,10 +6,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const guard_1 = __importDefault(require("./guard"));
 describe("Guard", () => {
     function methodWithRequiredName(name) {
-        guard_1.default.emtpy(name);
+        guard_1.default.empty(name);
     }
     function methodWithRequiredNameWithParam(name) {
-        guard_1.default.emtpy(name, "name", "Name is required");
+        guard_1.default.empty(name, "name", "Name is required");
     }
     function methodWithRequiredObject(options) {
         guard_1.default.null(options);
diff --git a/src/guard.test.ts b/src/guard.test.ts
@@ -1,12 +1,12 @@
 import Guard from "./guard";
 
 describe("Guard", () => {
-    function methodWithRequiredName(name: string) {
-        Guard.emtpy(name);
+    function methodWithRequiredName(name: string | null) {
+        Guard.empty(name);
     }
 
-    function methodWithRequiredNameWithParam(name: string) {
-        Guard.emtpy(name, "name", "Name is required");
+    function methodWithRequiredNameWithParam(name: string | null) {
+        Guard.empty(name, "name", "Name is required");
     }
 
     function methodWithRequiredObject(options: any) {
diff --git a/src/guard.ts b/src/guard.ts
@@ -5,8 +5,8 @@ export default class Guard {
      * @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)) {
+    public static empty(value: string | null, paramName?: string, message?: string) {
+        if (value === null || !value || value.trim().length === 0) {
             message = message || (`'${paramName || "value"}' cannot be null or empty`);
             throw new Error(message);
         }
@@ -19,7 +19,7 @@ export default class Guard {
      * @param message - The error message to return on invalid value
      */
     public static null(value: any, paramName?: string, message?: string) {
-        if ((!!value === false)) {
+        if (!value) {
             message = message || (`'${paramName || "value"}' cannot be null or undefined`);
             throw new Error(message);
         }
@@ -33,7 +33,7 @@ export default class Guard {
      * @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)) {
+        if (!value || !predicate(value)) {
             message = message || (`'${paramName || "value"}' is not a valid value`);
             throw new Error(message);
         }
diff --git a/src/index.ts b/src/index.ts
@@ -0,0 +1,2 @@
+export { FeatureType, TFRecordsBuilder } from "./tensorFlowBuilder";
+export { TFRecordsReader } from "./tensorFlowReader";
diff --git a/src/tensorFlowBuilder.js b/src/tensorFlowBuilder.js
@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.TFRecordsBuilder = exports.FeatureType = void 0;
 const tensorFlowRecordsProtoBuf_pb_1 = require("./tensorFlowRecordsProtoBuf_pb");
 const tensorFlowHelpers_1 = require("./tensorFlowHelpers");
 const stream_1 = require("stream");
@@ -17,15 +18,12 @@ var FeatureType;
     FeatureType[FeatureType["Binary"] = 1] = "Binary";
     FeatureType[FeatureType["Int64"] = 2] = "Int64";
     FeatureType[FeatureType["Float"] = 3] = "Float";
-})(FeatureType = exports.FeatureType || (exports.FeatureType = {}));
+})(FeatureType || (exports.FeatureType = FeatureType = {}));
 /**
  * @name - TFRecords Builder Class
  * @description - Create a TFRecords object
  */
 class TFRecordsBuilder {
-    constructor() {
-        this.features = new tensorFlowRecordsProtoBuf_pb_1.Features();
-    }
     /**
      * @records - An Array of TFRecord Buffer created with releaseTFRecord()
      * @description - Return a Buffer representation of a TFRecords object
@@ -34,9 +32,9 @@ class TFRecordsBuilder {
         return Buffer.concat(records.map((record) => {
             const length = record.length;
             // Get TFRecords CRCs for TFRecords Header and Footer
-            const bufferLength = tensorFlowHelpers_1.getInt64Buffer(length);
-            const bufferLengthMaskedCRC = tensorFlowHelpers_1.getInt32Buffer(tensorFlowHelpers_1.maskCrc(tensorFlowHelpers_1.crc32c(bufferLength)));
-            const bufferDataMaskedCRC = tensorFlowHelpers_1.getInt32Buffer(tensorFlowHelpers_1.maskCrc(tensorFlowHelpers_1.crc32c(record)));
+            const bufferLength = (0, tensorFlowHelpers_1.getInt64Buffer)(length);
+            const bufferLengthMaskedCRC = (0, tensorFlowHelpers_1.getInt32Buffer)((0, tensorFlowHelpers_1.maskCrc)((0, tensorFlowHelpers_1.crc32c)(bufferLength)));
+            const bufferDataMaskedCRC = (0, tensorFlowHelpers_1.getInt32Buffer)((0, tensorFlowHelpers_1.maskCrc)((0, tensorFlowHelpers_1.crc32c)(record)));
             // Concatenate all TFRecords Header, Data and Footer buffer
             return Buffer.concat([bufferLength,
                 bufferLengthMaskedCRC,
@@ -58,14 +56,17 @@ class TFRecordsBuilder {
             transform: (record, encoding, callback) => {
                 const length = record.length;
                 // Get TFRecords CRCs for TFRecords Header and Footer
-                const bufferLength = tensorFlowHelpers_1.getInt64Buffer(length);
-                const bufferLengthMaskedCRC = tensorFlowHelpers_1.getInt32Buffer(tensorFlowHelpers_1.maskCrc(tensorFlowHelpers_1.crc32c(bufferLength)));
-                const bufferDataMaskedCRC = tensorFlowHelpers_1.getInt32Buffer(tensorFlowHelpers_1.maskCrc(tensorFlowHelpers_1.crc32c(record)));
+                const bufferLength = (0, tensorFlowHelpers_1.getInt64Buffer)(length);
+                const bufferLengthMaskedCRC = (0, tensorFlowHelpers_1.getInt32Buffer)((0, tensorFlowHelpers_1.maskCrc)((0, tensorFlowHelpers_1.crc32c)(bufferLength)));
+                const bufferDataMaskedCRC = (0, tensorFlowHelpers_1.getInt32Buffer)((0, tensorFlowHelpers_1.maskCrc)((0, tensorFlowHelpers_1.crc32c)(record)));
                 callback(undefined, Buffer.concat([bufferLength, bufferLengthMaskedCRC, record, bufferDataMaskedCRC]));
             },
             highWaterMark,
         });
     }
+    constructor() {
+        this.features = new tensorFlowRecordsProtoBuf_pb_1.Features();
+    }
     /**
      * @key - Feature Key
      * @type - Feature Type
@@ -87,7 +88,7 @@ class TFRecordsBuilder {
             case FeatureType.String:
                 const stringList = new tensorFlowRecordsProtoBuf_pb_1.BytesList();
                 values.forEach((value) => {
-                    stringList.addValue(tensorFlowHelpers_1.textEncode(value));
+                    stringList.addValue((0, tensorFlowHelpers_1.textEncode)(value));
                 });
                 feature.setBytesList(stringList);
                 break;
diff --git a/src/tensorFlowHelpers.js b/src/tensorFlowHelpers.js
@@ -18,6 +18,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.readInt64 = exports.textDecode = exports.textEncode = exports.getInt32Buffer = exports.getInt64Buffer = exports.maskCrc = exports.crc32c = void 0;
 // maskDelta is a magic number taken from
 // https://github.com/tensorflow/tensorflow/blob/754048a0453a04a761e112ae5d99c149eb9910dd/
 //    tensorflow/core/lib/hash/crc32c.h#L33.
@@ -139,7 +140,7 @@ exports.textDecode = textDecode;
 function readInt64(buffer) {
     guard_1.default.null(buffer);
     guard_1.default.expression(buffer.length, (num) => num >= 8);
-    buffer = buffer_reverse_1.default(buffer.slice(0, 8));
+    buffer = (0, buffer_reverse_1.default)(buffer.slice(0, 8));
     const int64 = new node_int64_1.default(buffer, 0);
     return int64.toNumber(true);
 }
diff --git a/src/tensorFlowHelpers.test.js b/src/tensorFlowHelpers.test.js
@@ -13,38 +13,38 @@ const tensorFlowHelpers_1 = require("./tensorFlowHelpers");
 describe("TFRecords Helper Functions", () => {
     describe("Run getInt64Buffer method test", () => {
         it("Check getInt64Buffer for number 164865", () => __awaiter(void 0, void 0, void 0, function* () {
-            expect(tensorFlowHelpers_1.getInt64Buffer(164865)).toEqual(new Buffer([1, 132, 2, 0, 0, 0, 0, 0]));
+            expect((0, tensorFlowHelpers_1.getInt64Buffer)(164865)).toEqual(new Buffer([1, 132, 2, 0, 0, 0, 0, 0]));
         }));
     });
     describe("Run getInt32Buffer method test", () => {
         it("Check getInt32Buffer for number 164865", () => __awaiter(void 0, void 0, void 0, function* () {
-            expect(tensorFlowHelpers_1.getInt32Buffer(164865)).toEqual(new Buffer([1, 132, 2, 0]));
+            expect((0, tensorFlowHelpers_1.getInt32Buffer)(164865)).toEqual(new Buffer([1, 132, 2, 0]));
         }));
     });
     describe("Run crc32c method test", () => {
         it("Check crc32c for number 164865", () => __awaiter(void 0, void 0, void 0, function* () {
-            expect(tensorFlowHelpers_1.crc32c(new Buffer([1, 132, 2, 0, 0, 0, 0, 0]))).toEqual(1310106699);
+            expect((0, tensorFlowHelpers_1.crc32c)(new Buffer([1, 132, 2, 0, 0, 0, 0, 0]))).toEqual(1310106699);
         }));
     });
     describe("Run maskCrc method test", () => {
         it("Check maskCrc for crc 1310106699", () => __awaiter(void 0, void 0, void 0, function* () {
-            expect(tensorFlowHelpers_1.maskCrc(1310106699)).toEqual(3944318725);
+            expect((0, tensorFlowHelpers_1.maskCrc)(1310106699)).toEqual(3944318725);
         }));
     });
     describe("Run integration of getInt32Buffer(maskCrc(crc32c(getInt64Buffer())) methods test", () => {
         it("Check maskCrc for for number 164865", () => __awaiter(void 0, void 0, void 0, function* () {
-            expect(tensorFlowHelpers_1.getInt32Buffer(tensorFlowHelpers_1.maskCrc(tensorFlowHelpers_1.crc32c(tensorFlowHelpers_1.getInt64Buffer(164865)))))
+            expect((0, tensorFlowHelpers_1.getInt32Buffer)((0, tensorFlowHelpers_1.maskCrc)((0, tensorFlowHelpers_1.crc32c)((0, tensorFlowHelpers_1.getInt64Buffer)(164865)))))
                 .toEqual(new Buffer([5, 135, 25, 235]));
         }));
     });
     describe("Run textEncode method test", () => {
         it("Check textEncode for string 'ABC123'", () => __awaiter(void 0, void 0, void 0, function* () {
-            expect(tensorFlowHelpers_1.textEncode("ABC123")).toEqual(new Uint8Array([65, 66, 67, 49, 50, 51]));
+            expect((0, tensorFlowHelpers_1.textEncode)("ABC123")).toEqual(new Uint8Array([65, 66, 67, 49, 50, 51]));
         }));
     });
     describe("Run textDecode method test", () => {
         it("Check textDecode for array [65, 66, 67, 49, 50, 51]", () => __awaiter(void 0, void 0, void 0, function* () {
-            expect(tensorFlowHelpers_1.textDecode(new Uint8Array([65, 66, 67, 49, 50, 51]))).toEqual("ABC123");
+            expect((0, tensorFlowHelpers_1.textDecode)(new Uint8Array([65, 66, 67, 49, 50, 51]))).toEqual("ABC123");
         }));
     });
 });
diff --git a/src/tensorFlowReader.js b/src/tensorFlowReader.js
@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.TFRecordsReader = void 0;
 const guard_1 = __importDefault(require("./guard"));
 const tensorFlowBuilder_1 = require("./tensorFlowBuilder");
 const tensorFlowHelpers_1 = require("./tensorFlowHelpers");
@@ -18,8 +19,8 @@ class TFRecordsReader {
         let position = 0;
         while (position < tfrecords.length) {
             const lengthBuffer = tfrecords.slice(position, position + 8);
-            const dataLength = tensorFlowHelpers_1.readInt64(lengthBuffer);
-            const lengthCrc = tensorFlowHelpers_1.maskCrc(tensorFlowHelpers_1.crc32c(lengthBuffer));
+            const dataLength = (0, tensorFlowHelpers_1.readInt64)(lengthBuffer);
+            const lengthCrc = (0, tensorFlowHelpers_1.maskCrc)((0, tensorFlowHelpers_1.crc32c)(lengthBuffer));
             position += 8;
             const expectedLengthCrc = tfrecords.readUInt32LE(position);
             position += 4;
@@ -28,7 +29,7 @@ class TFRecordsReader {
                 break;
             }
             const dataBuffer = tfrecords.slice(position, position + dataLength);
-            const dataCrc = tensorFlowHelpers_1.maskCrc(tensorFlowHelpers_1.crc32c(dataBuffer));
+            const dataCrc = (0, tensorFlowHelpers_1.maskCrc)((0, tensorFlowHelpers_1.crc32c)(dataBuffer));
             position += dataLength;
             const expectedDataCrc = tfrecords.readUInt32LE(position);
             position += 4;
@@ -64,7 +65,7 @@ class TFRecordsReader {
         const feature = message.getContext().getFeatureMap().get(key);
         switch (type) {
             case tensorFlowBuilder_1.FeatureType.String:
-                return tensorFlowHelpers_1.textDecode(feature.getBytesList().array[0][0]);
+                return (0, tensorFlowHelpers_1.textDecode)(feature.getBytesList().array[0][0]);
             case tensorFlowBuilder_1.FeatureType.Binary:
                 return feature.getBytesList().array[0][0];
             case tensorFlowBuilder_1.FeatureType.Int64:
@@ -84,7 +85,7 @@ class TFRecordsReader {
         const feature = message.getContext().getFeatureMap().get(key);
         switch (type) {
             case tensorFlowBuilder_1.FeatureType.String:
-                return feature.getBytesList().array[0].map((buffer) => tensorFlowHelpers_1.textDecode(buffer));
+                return feature.getBytesList().array[0].map((buffer) => (0, tensorFlowHelpers_1.textDecode)(buffer));
             case tensorFlowBuilder_1.FeatureType.Binary:
                 return feature.getBytesList().array[0];
             case tensorFlowBuilder_1.FeatureType.Int64:
diff --git a/tsconfig.build.json b/tsconfig.build.json
@@ -0,0 +1,6 @@
+{
+    "extends": "./tsconfig.json",
+    "exclude": [
+        "src/**/*.test.ts"
+    ]
+}
diff --git a/tsconfig.json b/tsconfig.json
@@ -1,26 +1,13 @@
 {
-  "compilerOptions": {
-      "target": "es6",
-      "allowJs": false,
-      "skipLibCheck": false,
-      "esModuleInterop": true,
-      "allowSyntheticDefaultImports": true,
-      "strict": false,
-      "forceConsistentCasingInFileNames": true,
-      "module": "commonjs",
-      "moduleResolution": "node",
-      "resolveJsonModule": true,
-      "isolatedModules": true,
-      "noEmit": false,
-      "jsx": "preserve",
-      "experimentalDecorators": true,
-      "lib": [
-          "es2015",
-          "dom"
-      ]
-  },
-  "include": [
-      "src",
-      ".storybook"
-  ]
+    "compilerOptions": {
+        "target": "ES2015",
+        "module": "commonjs",
+        "strict": false,
+        "esModuleInterop": true,
+        "skipLibCheck": true,
+        "forceConsistentCasingInFileNames": true,
+        "declaration": true
+    },
+    "include": ["src/**/*"],
+    "exclude": ["node_modules"]
 }

Original file line number	Diff line number	Diff line change
`@@ -6,10 +6,10 @@ Object.defineProperty(exports, "__esModule", { value: true });`
`6`	`6`	`const guard_1 = __importDefault(require("./guard"));`
`7`	`7`	`describe("Guard", () => {`
`8`	`8`	`function methodWithRequiredName(name) {`
`9`		`- guard_1.default.emtpy(name);`
	`9`	`+ guard_1.default.empty(name);`
`10`	`10`	`}`
`11`	`11`	`function methodWithRequiredNameWithParam(name) {`
`12`		`- guard_1.default.emtpy(name, "name", "Name is required");`
	`12`	`+ guard_1.default.empty(name, "name", "Name is required");`
`13`	`13`	`}`
`14`	`14`	`function methodWithRequiredObject(options) {`
`15`	`15`	`guard_1.default.null(options);`
Original file line number	Diff line number	Diff line change
`@@ -1,12 +1,12 @@`
`1`	`1`	`import Guard from "./guard";`
`2`	`2`
`3`	`3`	`describe("Guard", () => {`
`4`		`- function methodWithRequiredName(name: string) {`
`5`		`- Guard.emtpy(name);`
	`4`	`+ function methodWithRequiredName(name: string \| null) {`
	`5`	`+ Guard.empty(name);`
`6`	`6`	`}`
`7`	`7`
`8`		`- function methodWithRequiredNameWithParam(name: string) {`
`9`		`- Guard.emtpy(name, "name", "Name is required");`
	`8`	`+ function methodWithRequiredNameWithParam(name: string \| null) {`
	`9`	`+ Guard.empty(name, "name", "Name is required");`
`10`	`10`	`}`
`11`	`11`
`12`	`12`	`function methodWithRequiredObject(options: any) {`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+export { FeatureType, TFRecordsBuilder } from "./tensorFlowBuilder";`
	`2`	`+export { TFRecordsReader } from "./tensorFlowReader";`