feat: replaced crypto shim with separate entrypoints for node and browser environments

Author: Egor Manzhula

package-lock.json

@@ -2,8 +2,9 @@
   "name": "@namecheap/serialize-javascript",
   "version": "0.0.0",
   "description": "Serialize JavaScript to a superset of JSON that includes regular expressions and functions.",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
+  "main": "./lib/index.js",
+  "browser": "./lib/browser.js",
+  "types": "./lib/index.d.ts",
   "publishConfig": {
     "access": "public"
   },
@@ -41,7 +42,6 @@
     "mocha": "^10.7.3",
     "mochawesome": "^7.1.3",
     "nyc": "^17.1.0",
-    "proxyquire": "^2.1.3",
     "semantic-release": "^24.1.3",
     "sinon": "^19.0.2",
     "source-map-support": "^0.5.21",

package.json

@@ -0,0 +1,10 @@
+import { Serializer } from './Serializer';
+import { generateUUID } from './generateUUID';
+
+const uuid = generateUUID(window.crypto);
+const serializer = new Serializer(uuid);
+
+const serialize = serializer.serialize.bind(serializer);
+
+export { serialize };
+export default serialize;

src/browser.ts

@@ -1,4 +1,4 @@
-import crypto from './crypto';
+import crypto from 'crypto';
 import { Serializer } from './Serializer';
 import { generateUUID } from './generateUUID';
 

src/crypto.ts

@@ -0,0 +1,64 @@
+import sinon from 'sinon';
+import { expect } from 'chai';
+import * as generateUUIDModule from '../../src/generateUUID';
+import * as placeholderSerializerModule from '../../src/Serializer/PlaceholderSerializer';
+
+describe('Browser entrypoint', () => {
+    let serializeStub: sinon.SinonStub;
+    let generateUUIDStub: sinon.SinonStub;
+    let placeholderSerializerSpy: sinon.SinonSpy;
+    let serializeFn;
+    let cryptoMock = {};
+
+    before(() => {
+        // Mock the `window` and `window.crypto` if they are not defined
+        if (typeof global.window === 'undefined') {
+            (global as any).window = {};
+        }
+
+        Object.defineProperty(global.window, 'crypto', {
+            value: cryptoMock,
+            configurable: true,
+            writable: true,
+        });
+
+        generateUUIDStub = sinon.stub(generateUUIDModule, 'generateUUID');
+        generateUUIDStub.returns('00000000000000000000000000000');
+
+        placeholderSerializerSpy = sinon.spy(placeholderSerializerModule, 'PlaceholderSerializer');
+
+        serializeStub = sinon.stub(placeholderSerializerModule.PlaceholderSerializer.prototype, 'serialize').returns('serialized-data');
+
+        const { serialize } = require('../../src/browser');
+        serializeFn = serialize;
+    });
+
+    after(() => {
+        Object.defineProperty(global.window, 'crypto', {
+            value: undefined,
+            configurable: true,
+            writable: true,
+        });
+
+        sinon.restore();
+    });
+
+    it('should invoke genereUUID function with window.crypto', () => {
+        expect(generateUUIDStub.calledOnce).to.be.true;
+        expect(generateUUIDStub.calledWith(cryptoMock)).to.be.true;
+    });
+
+    it('should create PlaceholderSerializer instance with UUID returned by generateUUID', () => {
+        expect(placeholderSerializerSpy.calledOnce).to.be.true;
+        expect(placeholderSerializerSpy.calledWith('00000000000000000000000000000')).to.be.true;
+    });
+
+    it('should invoke PlaceholderSerializer.serialize and return it\'s result', () => {
+        const toSerialize = { test: 1}
+        const serialized = serializeFn(toSerialize);
+
+        expect(serializeStub.calledOnce).to.be.true;
+        expect(serializeStub.calledWith(toSerialize)).to.be.true;
+        expect(serialized).to.be.equal('serialized-data');
+    });
+});

src/index.ts

@@ -1,10 +1,10 @@
 import sinon from 'sinon';
 import { expect } from 'chai';
-import crypto from '../../src/crypto';
+import crypto from 'crypto';
 import * as generateUUIDModule from '../../src/generateUUID';
 import * as placeholderSerializerModule from '../../src/Serializer/PlaceholderSerializer';
 
-describe('Entrypoint', () => {
+describe('Default entrypoint', () => {
     let serializeStub: sinon.SinonStub;
     let generateUUIDStub: sinon.SinonStub;
     let placeholderSerializerSpy: sinon.SinonSpy;

test/unit/browser.spec.ts

@@ -11,7 +11,7 @@
       "baseUrl": "./",
       "noImplicitAny": false
     },
-    "include": ["src/index.ts"],
+    "include": ["src/index.ts", "src/browser.ts"],
     "exclude": ["node_modules"]
   }