fix: Address ESM compatibility issues

Update package.json and TypeScript configuration to properly support
ES modules. Modify hashing and index modules to use ESM-compatible
imports/exports.

Author: corpo-iwillspeak

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "@crispthinking/athena-classifier-sdk",
   "version": "0.0.0",
-  "main": "./dist/src/index.js",
+  "main": "./dist/index.js",
   "description": "A Node.js SDK for the Athena classifier that uses gRPC transport.",
   "type": "module",
   "engines": {
@@ -14,13 +14,13 @@
   ],
   "exports": {
     ".": {
-      "import": "./dist/index.js",
-      "require": "./dist/index.js"
+      "require": "./dist/index.js",
+      "import": "./dist/index.js"
     }
   },
   "devDependencies": {
+    "@bufbuild/protoc-gen-es": "^2.8.0",
     "@eslint/js": "~9.35",
-    "@protobuf-ts/plugin": "^2.11.1",
     "@types/brotli": "^1.3.4",
     "@types/eslint__js": "~9.14",
     "@types/node": "~20",
@@ -50,7 +50,7 @@
     "build": "tsc -p tsconfig.json",
     "build:watch": "tsc -w -p tsconfig.json",
     "build:release": "npm run clean && tsc -p tsconfig.release.json",
-    "codegen": "mkdir -p src/generated && npx protoc --plugin=protoc-gen-ts=./node_modules/.bin/protoc-gen-ts --ts_out=client_grpc1:./src/generated --proto_path=./athena-protobufs ./athena-protobufs/athena/**.proto",
+    "codegen": "mkdir -p src/generated && npx protoc --plugin=protoc-gen-ts_proto=./node_modules/.bin/protoc-gen-ts_proto --ts_proto_out=src/generated --ts_proto_opt=esModuleInterop=true,importSuffix=.js,useExactTypes=false,outputServices=grpc-js --proto_path=./athena-protobufs ./athena-protobufs/athena/**.proto",
     "lint": "eslint .",
     "lint:all": "npm run lint && npm run prettier:check && npx tsc --noEmit",
     "precommit:setup": "echo 'To install pre-commit hooks, run: uv tool install pre-commit && uvx pre-commit install'",
@@ -70,7 +70,6 @@
     "@bufbuild/protobuf": "^2.7.0",
     "@grpc/grpc-js": "^1.13.4",
     "@grpc/proto-loader": "^0.8.0",
-    "@protobuf-ts/grpc-transport": "^2.11.1",
     "brotli": "^1.3.3",
     "jwt-decode": "^4.0.0",
     "openid-client": "^6.7.1",

package.json

@@ -5,7 +5,7 @@ import {
   HashType,
   ImageFormat,
   RequestEncoding,
-} from './generated/athena/models';
+} from './generated/athena/models.js';
 import brotli from 'brotli';
 import { buffer } from 'stream/consumers';
 
@@ -20,10 +20,10 @@ import { buffer } from 'stream/consumers';
  */
 export async function computeHashesFromStream(
   data: Readable | Buffer<ArrayBufferLike>,
-  encoding: RequestEncoding = RequestEncoding.UNCOMPRESSED,
-  imageFormat: ImageFormat = ImageFormat.UNSPECIFIED,
+  encoding: RequestEncoding = RequestEncoding.REQUEST_ENCODING_UNCOMPRESSED,
+  imageFormat: ImageFormat = ImageFormat.IMAGE_FORMAT_UNSPECIFIED,
   resize: boolean = false,
-  hashes: HashType[] = [HashType.MD5, HashType.SHA1],
+  hashes: HashType[] = [HashType.HASH_TYPE_MD5, HashType.HASH_TYPE_SHA1],
 ): Promise<{
   md5?: string | undefined;
   sha1?: string | undefined;
@@ -41,13 +41,13 @@ export async function computeHashesFromStream(
     stream = Readable.from(data);
   }
 
-  if (hashes.includes(HashType.MD5)) {
+  if (hashes.includes(HashType.HASH_TYPE_MD5)) {
     {
       stream.pipe(md5);
     }
   }
 
-  if (hashes.includes(HashType.SHA1)) {
+  if (hashes.includes(HashType.HASH_TYPE_SHA1)) {
     {
       stream.pipe(sha1);
     }
@@ -57,7 +57,7 @@ export async function computeHashesFromStream(
     const resizer = sharp().resize(448, 448).raw({ depth: 'char' });
     stream.pipe(resizer);
     data = await resizer.toBuffer();
-    imageFormat = ImageFormat.RAW_UINT8;
+    imageFormat = ImageFormat.IMAGE_FORMAT_RAW_UINT8;
   } else {
     data = await buffer(stream);
     // use sharp to validate the image dimensions
@@ -67,13 +67,13 @@ export async function computeHashesFromStream(
     }
   }
 
-  if (encoding === RequestEncoding.BROTLI) {
+  if (encoding === RequestEncoding.REQUEST_ENCODING_BROTLI) {
     data = Buffer.from(brotli.compress(data));
   }
 
   return {
-    md5: hashes.includes(HashType.MD5) ? md5.digest('hex') : undefined,
-    sha1: hashes.includes(HashType.SHA1) ? sha1.digest('hex') : undefined,
+    md5: hashes.includes(HashType.HASH_TYPE_MD5) ? md5.digest('hex') : undefined,
+    sha1: hashes.includes(HashType.HASH_TYPE_SHA1) ? sha1.digest('hex') : undefined,
     data,
     format: imageFormat,
   };

src/hashing.ts

@@ -10,12 +10,11 @@ import {
   Deployment,
   ImageFormat,
   ClassificationOutput,
-} from './generated/athena/models';
+} from './generated/athena/models.js';
 import * as grpc from '@grpc/grpc-js';
 import {
-  type IClassifierServiceClient,
   ClassifierServiceClient,
-} from './generated/athena/athena.grpc-client';
+} from './generated/athena/athena.js';
 import { EventEmitter } from 'events';
 import { Empty } from './generated/google/protobuf/empty';
 import {
@@ -93,7 +92,7 @@ export const defaultGrpcAddress = 'trust.messages.crispthinking.com:443';
  */
 export class ClassifierSdk extends (EventEmitter as new () => TypedEventEmitter<ClassifierEvents>) {
   private grpcAddress: string;
-  private client: IClassifierServiceClient;
+  private client: ClassifierServiceClient;
   private classifierGrpcCall: grpc.ClientDuplexStream<
     ClassifyRequest,
     ClassifyResponse
@@ -253,11 +252,11 @@ export class ClassifierSdk extends (EventEmitter as new () => TypedEventEmitter<
         affiliate = this.options.affiliate,
         correlationId = randomUUID().toString(),
         data: inputData,
-        includeHashes = [HashType.MD5, HashType.SHA1],
-        encoding = RequestEncoding.UNCOMPRESSED,
+        includeHashes = [HashType.HASH_TYPE_MD5, HashType.HASH_TYPE_SHA1],
+        encoding = RequestEncoding.REQUEST_ENCODING_UNCOMPRESSED,
       } = options;
 
-      let inputFormat: ImageFormat = ImageFormat.UNSPECIFIED;
+      let inputFormat: ImageFormat = ImageFormat.IMAGE_FORMAT_UNSPECIFIED;
 
       if ('resize' in options === false) {
         inputFormat = options.format;
@@ -274,11 +273,11 @@ export class ClassifierSdk extends (EventEmitter as new () => TypedEventEmitter<
       const hashes: ImageHash[] = [];
 
       if (md5 && md5.trim() != '') {
-        hashes.push({ value: md5, type: HashType.MD5 });
+        hashes.push({ value: md5, type: HashType.HASH_TYPE_MD5 });
       }
 
       if (sha1 && sha1.trim() != '') {
-        hashes.push({ value: sha1, type: HashType.SHA1 });
+        hashes.push({ value: sha1, type: HashType.HASH_TYPE_SHA1 });
       }
 
       processedInputs.push({
@@ -314,11 +313,11 @@ export class ClassifierSdk extends (EventEmitter as new () => TypedEventEmitter<
     const options = {
       affiliate: this.options.affiliate,
       correlationId: randomUUID().toString(),
-      includeHashes: [HashType.MD5, HashType.SHA1],
+      includeHashes: [HashType.HASH_TYPE_MD5, HashType.HASH_TYPE_SHA1],
       encoding: request.encoding,
     };
 
-    let inputFormat: ImageFormat = ImageFormat.UNSPECIFIED;
+    let inputFormat: ImageFormat = ImageFormat.IMAGE_FORMAT_UNSPECIFIED;
 
     if ('resize' in request === false) {
       inputFormat = request.format;
@@ -335,11 +334,11 @@ export class ClassifierSdk extends (EventEmitter as new () => TypedEventEmitter<
     const hashes: ImageHash[] = [];
 
     if (md5 && md5.trim() != '') {
-      hashes.push({ value: md5, type: HashType.MD5 });
+      hashes.push({ value: md5, type: HashType.HASH_TYPE_MD5 });
     }
 
     if (sha1 && sha1.trim() != '') {
-      hashes.push({ value: sha1, type: HashType.SHA1 });
+      hashes.push({ value: sha1, type: HashType.HASH_TYPE_SHA1 });
     }
 
     const input: ClassificationInput = {
@@ -399,7 +398,6 @@ export class ClassifierSdk extends (EventEmitter as new () => TypedEventEmitter<
   }
 }
 
-export * from './generated/athena/models';
-export * from './generated/athena/athena';
-export * from './generated/athena/athena.grpc-client';
-export * from './hashing';
+export * from './generated/athena/models.js';
+export { ClassifierServiceClient } from './generated/athena/athena.js';
+export * from './hashing.js';

src/index.ts

@@ -5,8 +5,10 @@
     "removeComments": true,
     "rootDir": "src",
     "module": "es2022",
+    "moduleResolution": "node",
     "target": "es2022",
     "declaration": true,
+    "verbatimModuleSyntax": false,
     "lib": ["ES2022"]
   },
   "include": ["src/**/*"],