CheckSingle endpoint support

.github/workflows/functional-tests.yml

@@ -29,12 +29,18 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v5
 
+      - name: Submodules
+        run: git submodule update --init --recursive
+
       - name: Setup Node.js
         uses: volta-cli/action@v4
 
       - name: Install dependencies
         run: npm ci --no-audit
 
+      - name: Generate code
+        run: npm run codegen
+
       - name: Build project
         run: npm run build --if-present
 

.github/workflows/nodejs.yml

@@ -13,12 +13,18 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v5
 
+      - name: Submodules
+        run: git submodule update --init --recursive
+
       - name: Setup Node.js
         uses: volta-cli/action@v4
 
       - name: Install dependencies
         run: npm ci --no-audit
 
+      - name: Generate code
+        run: npm run codegen
+
       - name: Run linting
         run: npm run lint --if-present
 

.github/workflows/release.yml

@@ -1,4 +1,6 @@
-on: workflow_dispatch
+on:
+  release:
+    types: [published]
 
 jobs:
   publish:
@@ -10,11 +12,30 @@ jobs:
       - uses: actions/checkout@v5
       - uses: actions/setup-node@v5
         with:
-          node-version: "22"
+          node-version: '22'
+
+      - name: Submodules
+        run: git submodule update --init --recursive
+
+      - name: Set version from tag
+        run: |
+          if [[ "$GITHUB_REF" == refs/tags/* ]]; then
+            TAG_VERSION=${GITHUB_REF#refs/tags/}
+            # Remove 'v' prefix if present
+            VERSION=${TAG_VERSION#v}
+            echo "Setting version to: $VERSION"
+            npm version "$VERSION"
+          else
+            echo "Not building from a tag, using default version"
+          fi
+
+      - run: npm run codegen
+
       - run: npm ci
+
       - run: npm run build:release
       - uses: JS-DevTools/npm-publish@v3
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
-          registry: "https://npm.pkg.github.com"
+          registry: 'https://npm.pkg.github.com'
           access: restricted

.gitignore

@@ -31,3 +31,5 @@ dist/
 .env
 
 .venv
+
+src/generated

.prettierignore

@@ -0,0 +1 @@
+src/generated/

.prettierrc

@@ -2,5 +2,5 @@
   "parser": "typescript",
   "semi": true,
   "singleQuote": true,
-  "trailingComma": "all"
+  "trailingComma": "all",
 }

__tests__/functional/main.functional.test.ts

@@ -1,11 +1,18 @@
-import { describe, it, } from 'vitest';
-import { ClassificationOutput, ClassifierSdk, type ClassifyImageInput, ImageFormat } from '../../src';
+import { describe, it } from 'vitest';
+import {
+  ClassificationOutput,
+  ClassifierSdk,
+  type ClassifyImageInput,
+  ImageFormat,
+} from '../../src';
 import fs from 'fs';
 import { randomUUID } from 'crypto';
 
 describe('ClassifierSdk Functional Tests', () => {
   describe('listDeployments', () => {
-    it('should listDeployments and return responses (smoke test)', async ({ expect }) => {
+    it('should listDeployments and return responses (smoke test)', async ({
+      expect,
+    }) => {
       // This is a smoke test. You must have a running gRPC server at localhost:50051 for this to pass.
       // You may want to mock the gRPC client for true unit testing.
       const sdk = new ClassifierSdk({
@@ -15,8 +22,8 @@ describe('ClassifierSdk Functional Tests', () => {
           issuerUrl: process.env.VITE_OAUTH_ISSUER,
           clientId: process.env.VITE_ATHENA_CLIENT_ID,
           clientSecret: process.env.VITE_ATHENA_CLIENT_SECRET,
-          scope: 'manage:classify'
-        }
+          scope: 'manage:classify',
+        },
       });
 
       let error: any = null;
@@ -28,11 +35,41 @@ describe('ClassifierSdk Functional Tests', () => {
       }
       // Assert error is unset
       expect(error).toBeNull();
-    }, 10000)
+    }, 10000);
+  });
+
+  describe('classifySingle', () => {
+    it('should classify a single image and return the response', async ({
+      expect,
+    }) => {
+      const imagePath = __dirname + '/448x448.jpg';
+      const sdk = new ClassifierSdk({
+        deploymentId: process.env.VITE_ATHENA_DEPLOYMENT_ID,
+        affiliate: process.env.VITE_ATHENA_AFFILIATE,
+        authentication: {
+          issuerUrl: process.env.VITE_OAUTH_ISSUER,
+          clientId: process.env.VITE_ATHENA_CLIENT_ID,
+          clientSecret: process.env.VITE_ATHENA_CLIENT_SECRET,
+          scope: 'manage:classify',
+        },
+      });
+
+      const input: ClassifyImageInput = {
+        data: fs.createReadStream(imagePath),
+        format: ImageFormat.PNG,
+      };
+
+      const response = await sdk.classifySingle(input);
+      expect(response.classifications).toBe(true);
+      expect(response.error).toBeNull();
+    }, 10000);
   });
 
   describe('classifyImage', () => {
-    it('should classify 10 images in a single request and return responses (integration smoke test)', async ({ expect, annotate }) => {
+    it('should classify 10 images in a single request and return responses (integration smoke test)', async ({
+      expect,
+      annotate,
+    }) => {
       // This is a smoke test. You must have a running gRPC server at localhost:50051 for this to pass.
       // You may want to mock the gRPC client for true unit testing.
       const imagePath = __dirname + '/448x448.jpg';
@@ -43,23 +80,27 @@ describe('ClassifierSdk Functional Tests', () => {
           issuerUrl: process.env.VITE_OAUTH_ISSUER,
           clientId: process.env.VITE_ATHENA_CLIENT_ID,
           clientSecret: process.env.VITE_ATHENA_CLIENT_SECRET,
-          scope: 'manage:classify'
-        }
+          scope: 'manage:classify',
+        },
       });
 
       // Generate 10 unique correlationIds
-      const correlationIds = Array.from({ length: 10 }, () => randomUUID().toString());
+      const correlationIds = Array.from({ length: 10 }, () =>
+        randomUUID().toString(),
+      );
 
       correlationIds.sort((a, b) => a.localeCompare(b));
 
       annotate(`Correlation IDs: ${correlationIds.join(', ')}`);
 
       // Create 10 input objects, each with a new stream and unique correlationId
-      const inputs: ClassifyImageInput[] = correlationIds.map((correlationId) => ({
-        data: fs.createReadStream(imagePath),
-        format: ImageFormat.PNG,
-        correlationId
-      }));
+      const inputs: ClassifyImageInput[] = correlationIds.map(
+        (correlationId) => ({
+          data: fs.createReadStream(imagePath),
+          format: ImageFormat.PNG,
+          correlationId,
+        }),
+      );
 
       // Create a promise to wrap the event emitter event 'data'
       const promise = new Promise<ClassificationOutput[]>((resolve, reject) => {
@@ -107,23 +148,26 @@ describe('ClassifierSdk Functional Tests', () => {
       // Check that all correlationIds are present in the outputs
       expect(outputs.length).toBe(correlationIds.length);
 
-      const expectedOutputs = correlationIds.map(id => (
-        {
-          correlationId: id,
-          classifications: expect.toBeOneOf([expect.arrayContaining([
+      const expectedOutputs = correlationIds.map((id) => ({
+        correlationId: id,
+        classifications: expect.toBeOneOf([
+          expect.arrayContaining([
             {
               label: expect.any(String),
-              weight: expect.any(Number)
-            }
-          ]), []])
-        }
-      ));
+              weight: expect.any(Number),
+            },
+          ]),
+          [],
+        ]),
+      }));
 
       expect(outputs).toMatchObject(expectedOutputs);
     }, 120000);
 
-    it('should classify with raw uint8 resize return responses (integration smoke test)', async ({ expect, annotate }) => {
-
+    it('should classify with raw uint8 resize return responses (integration smoke test)', async ({
+      expect,
+      annotate,
+    }) => {
       const imagePath = __dirname + '/448x448.jpg';
       const sdk = new ClassifierSdk({
         deploymentId: process.env.VITE_ATHENA_DEPLOYMENT_ID,
@@ -132,8 +176,8 @@ describe('ClassifierSdk Functional Tests', () => {
           issuerUrl: process.env.VITE_OAUTH_ISSUER,
           clientId: process.env.VITE_ATHENA_CLIENT_ID,
           clientSecret: process.env.VITE_ATHENA_CLIENT_SECRET,
-          scope: 'manage:classify'
-        }
+          scope: 'manage:classify',
+        },
       });
 
       const correlationId = randomUUID();
@@ -148,7 +192,9 @@ describe('ClassifierSdk Functional Tests', () => {
         }, 30000);
 
         sdk.on('data', (data) => {
-          const byCorrelationId = data.outputs.filter(o => o.correlationId === correlationId);
+          const byCorrelationId = data.outputs.filter(
+            (o) => o.correlationId === correlationId,
+          );
           if (byCorrelationId.length > 0) {
             clearTimeout(timeout);
             resolve(byCorrelationId);
@@ -185,20 +231,26 @@ describe('ClassifierSdk Functional Tests', () => {
       expect(first).toMatchObject([
         {
           correlationId,
-          classifications: expect.toBeOneOf([expect.arrayContaining([
-            {
-              label: expect.any(String),
-              weight: expect.any(Number)
-            }
-          ]), []])
-        } as ClassificationOutput
+          classifications: expect.toBeOneOf([
+            expect.arrayContaining([
+              {
+                label: expect.any(String),
+                weight: expect.any(Number),
+              },
+            ]),
+            [],
+          ]),
+        } as ClassificationOutput,
       ]);
 
       // Accept either a successful call or a connection error (for CI/dev convenience)
       expect(error).toBeUndefined();
     }, 120000);
 
-    it('should classify return responses (integration smoke test)', async ({ expect, annotate }) => {
+    it('should classify return responses (integration smoke test)', async ({
+      expect,
+      annotate,
+    }) => {
       // This is a smoke test. You must have a running gRPC server at localhost:50051 for this to pass.
       // You may want to mock the gRPC client for true unit testing.
       const imagePath = __dirname + '/448x448.jpg';
@@ -209,8 +261,8 @@ describe('ClassifierSdk Functional Tests', () => {
           issuerUrl: process.env.VITE_OAUTH_ISSUER,
           clientId: process.env.VITE_ATHENA_CLIENT_ID,
           clientSecret: process.env.VITE_ATHENA_CLIENT_SECRET,
-          scope: 'manage:classify'
-        }
+          scope: 'manage:classify',
+        },
       });
 
       const correlationId = randomUUID();
@@ -225,7 +277,9 @@ describe('ClassifierSdk Functional Tests', () => {
         }, 30000);
 
         sdk.on('data', (data) => {
-          const byCorrelationId = data.outputs.filter(o => o.correlationId === correlationId);
+          const byCorrelationId = data.outputs.filter(
+            (o) => o.correlationId === correlationId,
+          );
           if (byCorrelationId.length > 0) {
             clearTimeout(timeout);
             resolve(byCorrelationId);
@@ -262,13 +316,16 @@ describe('ClassifierSdk Functional Tests', () => {
       expect(first).toMatchObject([
         {
           correlationId,
-          classifications: expect.toBeOneOf([expect.arrayContaining([
-            {
-              label: expect.any(String),
-              weight: expect.any(Number)
-            }
-          ]), []])
-        } as ClassificationOutput
+          classifications: expect.toBeOneOf([
+            expect.arrayContaining([
+              {
+                label: expect.any(String),
+                weight: expect.any(Number),
+              },
+            ]),
+            [],
+          ]),
+        } as ClassificationOutput,
       ]);
 
       // Accept either a successful call or a connection error (for CI/dev convenience)

__tests__/unit/main.test.ts

@@ -122,6 +122,10 @@ describe('ClassifierSdk', () => {
       expect(typeof sdk.sendClassifyRequest).toBe('function');
     });
 
+    it('should have classifySingle method', () => {
+      expect(typeof sdk.classifySingle).toBe('function');
+    });
+
     it('should throw error when sendClassifyRequest called without open', async () => {
       const input = {
         data: Buffer.from('test'),

eslint.config.mjs

@@ -19,6 +19,7 @@ export default tseslint.config(
       'src/athena/**',
       'athena-protobufs/**',
       'docs/**',
+      '**/generated/**',
     ],
   },
   eslint.configs.recommended,

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crispthinking/athena-classifier-sdk",
-  "version": "0.2.0",
+  "version": "0.0.0",
   "main": "./dist/src/index.js",
   "description": "A Node.js SDK for the Athena classifier that uses gRPC transport.",
   "type": "module",
@@ -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": "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",
+    "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",
     "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'",