@aiqa/sdk 0.0.5 → 1.0.0-develop.1

package/README.md

@@ -16,6 +16,7 @@ A TypeScript/JavaScript SDK for interacting with the AIQA WebSocket service. Thi
 - [Types](#types)
 - [Examples](#examples)
 - [Error Handling](#error-handling)
+- [Semantic Versioning](#semantic-versioning)
 
 ## Installation
 
@@ -28,24 +29,24 @@ npm install @aiqa/sdk
 ### Basic Setup
 
 ```typescript
-import AiQaSdk from '@aiqa/sdk';
+import AiQaSdk from "@aiqa/sdk";
 
 // Initialize the SDK
 const sdk = new AiQaSdk(
-  'app-id-123',
-  'app-secret-xyz',
-  'https://api.solutionson.ai/'
+  "app-id-123",
+  "app-secret-xyz",
+  "https://api.solutionson.ai/",
 );
 
 // Connect to the service, then attach listeners
 sdk.connect();
 
-sdk.on('connect', () => {
-  console.log('Connected to AIQA service');
+sdk.on("connect", () => {
+  console.log("Connected to AIQA service");
 });
 
-sdk.on('error', (error) => {
-  console.error('Connection error:', error);
+sdk.on("error", (error) => {
+  console.error("Connection error:", error);
 });
 ```
 
@@ -95,22 +96,25 @@ const application = await sdk.getApplication();
 Adds a fact to the active application (Promise-based).
 
 **Parameters:**
+
 - `fact: ApplicationFactInput`
   ```typescript
   {
     id: string;
     question: string;
     expected_answer: any;
-    answer_format: { type: 'STRING' };
+    answer_format: {
+      type: "STRING";
+    }
   }
   ```
 
 ```typescript
 const isMatched = await sdk.addFact({
-  id: 'fact-123',
-  question: 'Do you agree?',
-  expected_answer: 'Yes',
-  answer_format: { type: 'STRING' }
+  id: "fact-123",
+  question: "Do you agree?",
+  expected_answer: "Yes",
+  answer_format: { type: "STRING" },
 });
 ```
 
@@ -155,6 +159,7 @@ const isRecording = await sdk.isRecordingNow();
 Registers an event listener. Call `connect()` before `on()`.
 
 **Available Events:**
+
 - `connect` - Socket.IO connection established
 - `disconnect` - Socket.IO connection closed
 - `close` - Socket.IO connection closed
@@ -167,12 +172,12 @@ Registers an event listener. Call `connect()` before `on()`.
 
 ```typescript
 sdk.connect();
-sdk.on('connect', () => {
-  console.log('Connected');
+sdk.on("connect", () => {
+  console.log("Connected");
 });
 
-sdk.on('authenticated', (application) => {
-  console.log('Authenticated:', application);
+sdk.on("authenticated", (application) => {
+  console.log("Authenticated:", application);
 });
 ```
 
@@ -181,7 +186,7 @@ sdk.on('authenticated', (application) => {
 Removes an event listener.
 
 ```typescript
-sdk.off('connect');
+sdk.off("connect");
 ```
 
 ## Types
@@ -196,7 +201,7 @@ type Application = {
   agent_id: string;
   agent_first_name: string;
   agent_last_name: string;
-}
+};
 ```
 
 ### ApplicationFact
@@ -204,9 +209,9 @@ type Application = {
 ```typescript
 type ApplicationFact = ApplicationFactInput & {
   ai_answer?: any;
-  question_status: 'searching' | 'asked' | 'not_asked';
-  verification_status: 'processing' | 'matched' | 'unmatched';
-}
+  question_status: "searching" | "asked" | "not_asked";
+  verification_status: "processing" | "matched" | "unmatched";
+};
 ```
 
 ### ApplicationFactInput
@@ -217,7 +222,16 @@ type ApplicationFactInput = {
   question: string;
   expected_answer: any;
   answer_format: {
-    type: 'STRING' | 'NUMBER' | 'INT' | 'FLOAT' | 'BOOL' | 'LIST' | 'STRICT' | 'SINGLE_CHOICE' | 'MULTIPLE_CHOICES';
+    type:
+      | "STRING"
+      | "NUMBER"
+      | "INT"
+      | "FLOAT"
+      | "BOOL"
+      | "LIST"
+      | "STRICT"
+      | "SINGLE_CHOICE"
+      | "MULTIPLE_CHOICES";
     choices?: { key: string; text: string }[];
   };
   category_id?: string;
@@ -225,7 +239,7 @@ type ApplicationFactInput = {
   language?: string;
   critical?: boolean;
   is_skipped?: boolean;
-}
+};
 ```
 
 ### FactUpdateEvent
@@ -234,63 +248,98 @@ type ApplicationFactInput = {
 type FactUpdateEvent = {
   fact_id: string;
   question_id?: string;
-  status: 'asked' | 'answered_detected' | 'agent_answered' | 'verification_pending' | 'verified' | 'failed';
+  status:
+    | "asked"
+    | "answered_detected"
+    | "agent_answered"
+    | "verification_pending"
+    | "verified"
+    | "failed";
   detectedAnswer?: any;
   agentAnswer?: any;
   verifiedAnswer?: any;
-}
+};
+```
+
+## Semantic Versioning
+
+Version bumps are automated with semantic commits and `semantic-release` in Bitbucket Pipelines:
+
+- `master` creates stable releases.
+- `develop` creates prereleases on the `develop` channel (for example `1.2.3-develop.1`).
+
+### Commit types and version bump
+
+- `fix: ...` -> patch bump (`0.0.6` -> `0.0.7`)
+- `feat: ...` -> minor bump (`0.0.6` -> `0.1.0`)
+- `feat!: ...` or commit body with `BREAKING CHANGE:` -> major bump (`0.0.6` -> `1.0.0`)
+- `chore: ...`
+- Other commit types (for example `docs:`, `chore:`) do not trigger a release by default.
+
+### Examples
+
+```text
+fix: handle socket timeout error
+feat: add isRecordingNow helper
+feat!: change addFact response contract
 ```
 
+### Pipeline requirements
+
+Set these repository variables so the release step can push tags/commits and publish to npm:
+
+- `BB_TOKEN_BASIC_AUTH` with value `user:token`
+- `NPM_TOKEN` with publish access to `@aiqa/sdk`
+
 ## Examples
 
 ### Complete Example: Recording Session
 
 ```typescript
-import AiQaSdk from '@aiqa/sdk';
+import AiQaSdk from "@aiqa/sdk";
 
 // Initialize SDK
 const sdk = new AiQaSdk(
-  'application-id-123',
-  'application-secret-xyz',
-  'https://api.solutionson.ai/'
+  "application-id-123",
+  "application-secret-xyz",
+  "https://api.solutionson.ai/",
 );
 
 sdk.connect();
 
-sdk.on('connect', async () => {
-  console.log('Connected!');
+sdk.on("connect", async () => {
+  console.log("Connected!");
 
   try {
     const application = await sdk.getApplication();
-    console.log('Application loaded:', application.application_id);
+    console.log("Application loaded:", application.application_id);
 
     // Start recording
     await sdk.startRecording();
-    console.log('Recording started');
+    console.log("Recording started");
 
     // Add a fact
     const factMatched = await sdk.addFact({
-      id: 'q1',
-      question: 'What is your name?',
-      expected_answer: '',
+      id: "q1",
+      question: "What is your name?",
+      expected_answer: "",
       answer_format: {
-        type: 'STRING'
-      }
+        type: "STRING",
+      },
     });
 
-    console.log('Fact matched:', factMatched);
+    console.log("Fact matched:", factMatched);
 
     // Stop recording
     await sdk.stopRecording();
-    console.log('Recording stopped');
-
+    console.log("Recording stopped");
   } catch (error) {
-    console.error('Error:', error);
+    console.error("Error:", error);
   }
 });
 
-sdk.on('error', (error) => {
-  console.error('SDK Error:', error);
+sdk.on("error", (error) => {
+  console.error("SDK Error:", error);
 });
 ```
 
@@ -301,9 +350,9 @@ All methods are Promise-based. Use `try/catch` for errors.
 ```typescript
 try {
   const application = await sdk.getApplication();
-  console.log('Success:', application);
+  console.log("Success:", application);
 } catch (error) {
-  console.error('Error:', error);
+  console.error("Error:", error);
 }
 ```
 
@@ -320,4 +369,4 @@ The server emits an `app_version` payload with `{ min, max }` supported SDK vers
 
 ## License
 
-MIT
+MIT

package/package.json

@@ -1,16 +1,23 @@
 {
   "name": "@aiqa/sdk",
-  "version": "0.0.5",
+  "version": "1.0.0-develop.1",
   "main": "dist/node/node.js",
   "module": "dist/node/node.js",
   "types": "dist/node/node.d.ts",
-  "engines": { "node": ">=18" },
+  "engines": {
+    "node": ">=18"
+  },
   "scripts": {
     "build": "tsup && node -e \"const fs=require('fs');['dist/node/node','dist/browser/browser'].forEach(f=>{const mts=f+'.d.mts';const ts=f+'.d.ts';if(fs.existsSync(mts)){fs.renameSync(mts,ts);}});\"",
+    "commitlint": "commitlint",
     "dev:node": "tsx src/node.ts",
+    "lint": "tsc --noEmit -p tsconfig.json",
+    "format": "prettier --check \"{src,tests}/**/*.{ts,tsx,js,json,md,yml,yaml}\" \"*.{js,json,md,yml,yaml,ts}\"",
+    "release": "semantic-release",
     "start:node": "node dist/node/node.js",
     "serve:browser": "serve .",
-    "test": "jest"
+    "test": "jest",
+    "prepare": "husky"
   },
   "exports": {
     ".": {
@@ -37,14 +44,25 @@
     "dist"
   ],
   "devDependencies": {
+    "@commitlint/cli": "^20.4.4",
+    "@commitlint/config-conventional": "^20.4.4",
     "@jest/globals": "^29.7.0",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/commit-analyzer": "^13.0.1",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/npm": "^12.0.2",
+    "@semantic-release/release-notes-generator": "^14.1.0",
+    "@types/node": "^22.0.0",
+    "conventional-changelog-conventionalcommits": "^9.3.0",
     "esbuild": "^0.23.0",
+    "husky": "^9.1.7",
     "jest": "^29.7.0",
+    "prettier": "^3.8.1",
+    "semantic-release": "^24.2.9",
+    "serve": "^14.2.3",
     "socket.io": "^4.7.5",
     "ts-jest": "^29.2.3",
     "ts-node": "^10.9.2",
-    "@types/node": "^22.0.0",
-    "serve": "^14.2.3",
     "tsup": "^8.0.0",
     "tsx": "^4.0.0",
     "typescript": "^5.7.0"
@@ -52,4 +70,4 @@
   "dependencies": {
     "socket.io-client": "^4.7.5"
   }
-}
+}

package/dist/browser/browser.d.ts

@@ -1,2 +0,0 @@
-
-export {  }