Merge pull request #8 from crispthinking/feature/esm-bundle

feat: add hash-server sample with TypeScript configuration and depend…

Author: abbottdev-kroll

.gitignore

@@ -11,6 +11,7 @@ coverage
 
 # Transpiled files
 build/
+dist/
 
 # VS Code
 .vscode

__tests__/unit/authenticationManager.test.ts

@@ -1,5 +1,5 @@
 import { describe, it, expect, beforeEach, vi } from 'vitest';
-import { AuthenticationManager, AuthenticationOptions } from '../../src/authenticationManager';
+import { AuthenticationManager, type AuthenticationOptions } from '../../src/authenticationManager';
 import * as openidClient from 'openid-client';
 import * as jwtDecodeModule from 'jwt-decode';
 import * as grpc from '@grpc/grpc-js';

__tests__/unit/main.test.ts

@@ -1,5 +1,5 @@
 import { describe, it, } from 'vitest';
-import { ClassificationOutput, ClassifierSdk, ClassifyImageInput, ImageFormat } from '../../src';
+import { ClassificationOutput, ClassifierSdk, type ClassifyImageInput, ImageFormat } from '../../src';
 import fs from 'fs';
 import { randomUUID } from 'crypto';
 
@@ -56,7 +56,7 @@ describe('ClassifierSdk', () => {
 
       // Create 10 input objects, each with a new stream and unique correlationId
       const inputs: ClassifyImageInput[] = correlationIds.map((correlationId) => ({
-        imageStream: fs.createReadStream(imagePath),
+        data: fs.createReadStream(imagePath),
         format: ImageFormat.PNG,
         correlationId
       }));
@@ -165,9 +165,9 @@ describe('ClassifierSdk', () => {
 
       await sdk.open();
 
-      const imageStream = fs.createReadStream(imagePath);
+      const data = fs.createReadStream(imagePath);
       const options: ClassifyImageInput = {
-        imageStream,
+        data,
         correlationId,
         resize: true,
       };
@@ -242,9 +242,9 @@ describe('ClassifierSdk', () => {
 
       await sdk.open();
 
-      const imageStream = fs.createReadStream(imagePath);
+      const data = fs.createReadStream(imagePath);
       const options: ClassifyImageInput = {
-        imageStream,
+        data,
         correlationId,
         format: ImageFormat.JPEG,
       };

__tests__/vitest.config.ts

@@ -10,7 +10,7 @@ export default defineConfig({
     coverage: {
       enabled: true,
       provider: 'v8',
-      exclude: [...coverageConfigDefaults.exclude, 'build/**/*', 'src/athena/**/*']
+      exclude: [...coverageConfigDefaults.exclude, 'build/**/*','samples/**/*', 'src/athena/**/*']
     },
   },
 })

eslint.config.mjs

@@ -9,7 +9,7 @@ import tseslint from 'typescript-eslint';
 // You should change it to your needs following the documentation.
 export default tseslint.config(
   {
-    ignores: ['**/build/**', '.venv/**', '**/__tests__/**', '**/tmp/**', '**/coverage/**', 'src/athena/**'],
+    ignores: ['**/dist/**', 'samples/**', '.venv/**', '**/__tests__/**', '**/tmp/**', '**/coverage/**', 'src/athena/**'],
   },
   eslint.configs.recommended,
   eslintConfigPrettier,

package.json

@@ -1,12 +1,23 @@
 {
   "name": "@crispthinking/athena-classifier-sdk",
   "version": "0.1.0",
-  "main": "./dist/index.js",
+  "main": "./dist/src/index.js",
   "description": "A Node.js SDK for the Athena classifier that uses gRPC transport.",
   "type": "module",
   "engines": {
     "node": ">= 22.11 < 23"
   },
+  "files": [
+    "dist/",
+    "README.md",
+    "LICENSE"
+  ],
+    "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    }
+  },
   "devDependencies": {
     "@eslint/js": "~9.17",
     "@protobuf-ts/plugin": "^2.11.1",
@@ -39,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": "npx protoc --plugin=protoc-gen-ts=./node_modules/.bin/protoc-gen-ts --ts_out=client_grpc1:./src/athena --proto_path=./athena-protobufs/athena ./athena-protobufs/athena/athena.proto",
+    "codegen": "npx protoc --plugin=protoc-gen-ts=./node_modules/.bin/protoc-gen-ts --ts_out=import_style=module,client_grpc1:./src/athena --proto_path=./athena-protobufs/athena ./athena-protobufs/athena/athena.proto",
     "lint": "eslint .",
     "test": "vitest run unit --config __tests__/vitest.config.ts",
     "test:coverage": "vitest run unit --config __tests__/vitest.config.ts --coverage.enabled --coverage.all",

samples/hash-server/.npmrc

@@ -0,0 +1 @@
+@crispthinking:registry=https://npm.pkg.github.com

samples/hash-server/448x448.jpg

@@ -0,0 +1,57 @@
+import { ClassifierSdk, HashType, ImageFormat, RequestEncoding, type ClassifyImageInput } from '@crispthinking/athena-classifier-sdk';
+import { randomUUID } from 'crypto';
+import { createReadStream } from 'fs';
+import { inspect } from 'util';
+
+
+const sdk = new ClassifierSdk({
+  authentication: {
+    clientId: process.env.VITE_ATHENA_CLIENT_ID,
+    clientSecret: process.env.VITE_ATHENA_CLIENT_SECRET,
+    issuerUrl: process.env.VITE_OAUTH_ISSUER,
+    scope: "manage:classify"
+  },
+  grpcAddress: 'csam-classification-messages.crispdev.com:443',
+  affiliate: 'test-affiliate',
+  deploymentId: 'node-js-client-test'
+});
+
+sdk.on('data', (data) => {
+  for(const item of data.outputs)
+  {
+    console.log(inspect(item, { showHidden: false, colors: true, depth: null, maxArrayLength: null, showProxy: false }));
+  }
+});
+
+await sdk.open();
+
+// Enter loop to run until keypress entered.
+process.stdin.on('data', async (data) => {
+  const input = data.toString().trim();
+  if (input === 'exit') {
+    await sdk.close();
+    process.exit(0);
+  }
+});
+
+// Break if sigterm
+process.on('SIGTERM', async () => {
+  await sdk.close();
+  process.exit(0);
+});
+
+while(true)
+{
+  const inputs = Array.from({ length: 3 }, () => ({
+    data: createReadStream('448x448.jpg'),
+    format: ImageFormat.JPEG,
+    correlationId: randomUUID(),
+    encoding: RequestEncoding.UNCOMPRESSED,
+    includeHashes: [HashType.MD5, HashType.SHA1]
+  } as ClassifyImageInput));
+
+  await sdk.sendClassifyRequest(inputs);
+
+  // Sleep for 10 seconds
+  await new Promise((resolve) => setTimeout(resolve, Math.random() * 10000));
+}