Merge origin/main into refactor/test-reorganisation

Author: ryoppippi

.env_example

@@ -5,9 +5,14 @@ on:
     paths:
       - 'flake.nix'
       - 'flake.lock'
-      - '.github/workflows/nix-flake.yml'
+      - '.github/workflows/nix-flake.yaml'
       - '.github/actions/setup-nix/**'
   pull_request:
+    paths:
+      - 'flake.nix'
+      - 'flake.lock'
+      - '.github/workflows/nix-flake.yaml'
+      - '.github/actions/setup-nix/**'
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}

.github/workflows/nix-flake.yaml

@@ -2,7 +2,7 @@
 
 > A unified interface for performing actions on SaaS tools through AI-friendly APIs.
 
-[![DeepWiki](https://img.shields.io/badge/DeepWiki-StackOneHQ%2Fstackone--ai--node-blue.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACwAAAAyCAYAAAAnWDnqAAAAAXNSR0IArs4c6QAAA05JREFUaEPtmUtyEzEQhtWTQyQLHNak2AB7ZnyXZMEjXMGeK/AIi+QuHrMnbChYY7MIh8g01fJoopFb0uhhEqqcbWTp06/uv1saEDv4O3n3dV60RfP947Mm9/SQc0ICFQgzfc4CYZoTPAswgSJCCUJUnAAoRHOAUOcATwbmVLWdGoH//PB8mnKqScAhsD0kYP3j/Yt5LPQe2KvcXmGvRHcDnpxfL2zOYJ1mFwrryWTz0advv1Ut4CJgf5uhDuDj5eUcAUoahrdY/56ebRWeraTjMt/00Sh3UDtjgHtQNHwcRGOC98BJEAEymycmYcWwOprTgcB6VZ5JK5TAJ+fXGLBm3FDAmn6oPPjR4rKCAoJCal2eAiQp2x0vxTPB3ALO2CRkwmDy5WohzBDwSEFKRwPbknEggCPB/imwrycgxX2NzoMCHhPkDwqYMr9tRcP5qNrMZHkVnOjRMWwLCcr8ohBVb1OMjxLwGCvjTikrsBOiA6fNyCrm8V1rP93iVPpwaE+gO0SsWmPiXB+jikdf6SizrT5qKasx5j8ABbHpFTx+vFXp9EnYQmLx02h1QTTrl6eDqxLnGjporxl3NL3agEvXdT0WmEost648sQOYAeJS9Q7bfUVoMGnjo4AZdUMQku50McDcMWcBPvr0SzbTAFDfvJqwLzgxwATnCgnp4wDl6Aa+Ax283gghmj+vj7feE2KBBRMW3FzOpLOADl0Isb5587h/U4gGvkt5v60Z1VLG8BhYjbzRwyQZemwAd6cCR5/XFWLYZRIMpX39AR0tjaGGiGzLVyhse5C9RKC6ai42ppWPKiBagOvaYk8lO7DajerabOZP46Lby5wKjw1HCRx7p9sVMOWGzb/vA1hwiWc6jm3MvQDTogQkiqIhJV0nBQBTU+3okKCFDy9WwferkHjtxib7t3xIUQtHxnIwtx4mpg26/HfwVNVDb4oI9RHmx5WGelRVlrtiw43zboCLaxv46AZeB3IlTkwouebTr1y2NjSpHz68WNFjHvupy3q8TFn3Hos2IAk4Ju5dCo8B3wP7VPr/FGaKiG+T+v+TQqIrOqMTL1VdWV1DdmcbO8KXBz6esmYWYKPwDL5b5FA1a0hwapHiom0r/cKaoqr+27/XcrS5UwSMbQAAAABJRU5ErkJggg==)](https://deepwiki.com/StackOneHQ/stackone-ai-node)
+[![DeepWiki](https://img.shields.io/badge/DeepWiki-StackOneHQ%2Fstackone--ai--node-blue.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACwAAAAyCAYAAAAnWDnqAAAAAXNSR0IArs4c6QAAA05JREFUaEPtmUtyEzEQhtWTQyQLHNak2AB7ZnyXZMEjXMGeK/AIi+QuHrMnbChYY7MIh8g01fJoopFb0uhhEqqcbWTp06/uv1saEDv4O3n3dV60RfP947Mm9/SQc0ICFQgzfc4CYZoTPAswgSJCCUJUnAAoRHOAUOcATwbmVLWdGoH//PB8mnKqScAhsD0kYP3j/Yt5LPQe2KvcXmGvRHcDnpxfL2zOYJ1mFwrryWTz0advv1Ut4CJgf5uhDuDj5eUcAUoahrdY/56ebRWeraTjMt/00Sh3UDtjgHtQNHwcRGOC98BJEAEymycmYcWwOprTgcB6VZ5JK5TAJ+fXGLBm3FDAmn6oPPjR4rKCAoJCal2eAiQp2x0vxTPB3ALO2CRkwmDy5WohzBDwSEFKRwPbknEggCPB/imwrycgxX2NzoMCHhPkDwqYMr9tRcP5qNrMZHkVnOjRMWwLCcr8ohBVb1OMjxLwGCvjTikrsBOiA6fNyCrm8V1rP93iVPpwaE+gO0SsWmPiXB+jikdf6SizrT5qKasx5j8ABbHpFTx+vFXp9EnYQmLx02h1QTTrl6eDqxLnGjporxl3NL3agEvXdT0WmEost648sQOYAeJS9Q7bfUVoMGnjo4AZdUMQku50McDcMWcBPvr0SzbTAFDfvJqwLzgxwATnCgnp4wDl6Aa+Ax283gghmj+vj7feE2KBBRMW3FzOpLOADl0Isb5587h/U4gGvkt5v60Z1VLG8BhYjbzRwyQZemwAd6cCR5/XFWLYZRIMpX39AR0tjaGGiGzLVyhse5C9RKC6ai42ppWPKiBagOvaYk8lO7DajerabOZP46Lby5wKjw1HCRx7p9sVMOWGzb/vA1hwiWc6jm3MvQDTogQkiqIhJV0nBQBTU+3okKCFDy9WwferkHjtxib7t3xIUQtHxnIwtx4mpg26/HfwVNVDb4oI9RHmx5WGelRVlrtiw43zboCLaxv46AZeB3IlTkwouebTr1y2NjSpHz68WNFjHvupy3q8TFn3Hos2IAk4Ju5dCo8B3wP7VPr/FGaKiG+T+v+TQqIrOqMTL1VdWV1DdmcbO8KXBz6esmYWYKPwDL5b5FA1a0hwapHiom0r/cKaoqr+27/XcrS5UwSMbQAAAABJRU5ErkJggg==)](https://deepwiki.com/StackOneHQ/stackone-ai-node) [![Coverage](https://stackonehq.github.io/stackone-ai-node/badges.svg)](https://stackonehq.github.io/stackone-ai-node)
 
 <!-- DeepWiki badge generated by https://deepwiki.ryoppippi.com/ -->
 

README.md

@@ -38,32 +38,15 @@ OPENAI_API_KEY=your_api_key_here
 
 ### 3. Configure Account IDs
 
-Update the account IDs in [`constants.ts`](./constants.ts) with your actual integration account IDs:
+Each example includes a placeholder account ID that you need to replace with your actual StackOne account ID:
 
 ```typescript
-export const ACCOUNT_IDS = {
-  // Human Resources Information System
-  HRIS: "your_hris_account_id",
-
-  // Applicant Tracking System
-  ATS: "your_ats_account_id",
-
-  // Customer Relationship Management
-  CRM: "your_crm_account_id",
-
-  // Document Management System
-  DOCUMENTS: "your_documents_account_id",
-
-  // Test account IDs (used in examples that don't make real API calls)
-  TEST: {
-    VALID: "test_account_id",
-    OVERRIDE: "test_account_id_override",
-    DIRECT: "test_account_id_direct",
-    INVALID: "invalid_test_account_id",
-  },
-};
+// Replace with your actual account ID from StackOne dashboard
+const accountId = 'your-hris-account-id';
 ```
 
+You can find your account IDs in the [StackOne dashboard](https://app.stackone.com).
+
 ## Running Examples
 
 ### Run Individual Examples
@@ -287,7 +270,7 @@ cd examples && pnpm test examples.spec.ts
 ### Common Issues
 
 1. **Authentication Errors**: Ensure `STACKONE_API_KEY` is set correctly
-2. **Account ID Errors**: Update account IDs in `constants.ts` with your actual values
+2. **Account ID Errors**: Update account ID placeholders in the example files with your actual values
 3. **Network Errors**: Check if you're behind a proxy or firewall
 4. **TypeScript Errors**: Ensure you're using compatible Node.js and TypeScript versions
 
@@ -306,7 +289,7 @@ When adding new examples:
 3. Include proper error handling
 4. Add TypeScript types
 5. Test with the examples test suite
-6. Update `constants.ts` if new account IDs are needed
+6. Use inline placeholder account IDs with clear comments (e.g., `const accountId = 'your-hris-account-id';`)
 
 ## License
 

examples/README.md

@@ -7,18 +7,20 @@ import process from 'node:process';
 import { openai } from '@ai-sdk/openai';
 import { StackOneToolSet } from '@stackone/ai';
 import { generateText, stepCountIs } from 'ai';
-import { ACCOUNT_IDS } from './constants';
 
 const apiKey = process.env.STACKONE_API_KEY;
 if (!apiKey) {
   console.error('STACKONE_API_KEY environment variable is required');
   process.exit(1);
 }
 
+// Replace with your actual account ID from StackOne dashboard
+const accountId = 'your-hris-account-id';
+
 const aiSdkIntegration = async (): Promise<void> => {
   // Initialise StackOne
   const toolset = new StackOneToolSet({
-    accountId: ACCOUNT_IDS.HRIS,
+    accountId,
     baseUrl: process.env.STACKONE_BASE_URL ?? 'https://api.stackone.com',
   });
 

examples/ai-sdk-integration.ts

@@ -11,14 +11,16 @@ import process from 'node:process';
 import { openai } from '@ai-sdk/openai';
 import { type JsonDict, StackOneToolSet } from '@stackone/ai';
 import { generateText, stepCountIs } from 'ai';
-import { ACCOUNT_IDS } from './constants';
 
 const apiKey = process.env.STACKONE_API_KEY;
 if (!apiKey) {
   console.error('STACKONE_API_KEY environment variable is required');
   process.exit(1);
 }
 
+// Replace with your actual account ID from StackOne dashboard
+const accountId = 'your-hris-account-id';
+
 interface ToolCall {
   toolName: string;
   args: Record<string, unknown>;
@@ -27,7 +29,7 @@ interface ToolCall {
 const humanInTheLoopExample = async (): Promise<void> => {
   // Create a toolset
   const toolset = new StackOneToolSet({
-    accountId: ACCOUNT_IDS.HRIS,
+    accountId,
     baseUrl: process.env.STACKONE_BASE_URL ?? 'https://api.stackone.com',
   });
 

examples/constants.ts

@@ -27,15 +27,13 @@
  * # Account IDs
  *
  * StackOne uses account IDs to identify different integrations.
- * See the example in the README for more details.
- *
- * This example will use the centralised account ID:
+ * Replace the placeholder below with your actual account ID from the StackOne dashboard.
  */
 
 import process from 'node:process';
-import { ACCOUNT_IDS } from './constants';
 
-const accountId = ACCOUNT_IDS.HRIS;
+// Replace with your actual account ID from StackOne dashboard
+const accountId = 'your-hris-account-id';
 
 /**
  * # Quickstart

examples/human-in-the-loop.ts

@@ -10,14 +10,16 @@ import process from 'node:process';
 import { openai } from '@ai-sdk/openai';
 import { StackOneToolSet, Tools } from '@stackone/ai';
 import { generateText, stepCountIs } from 'ai';
-import { ACCOUNT_IDS } from './constants';
 
 const apiKey = process.env.STACKONE_API_KEY;
 if (!apiKey) {
   console.error('STACKONE_API_KEY environment variable is required');
   process.exit(1);
 }
 
+// Replace with your actual account ID from StackOne dashboard
+const accountId = 'your-hris-account-id';
+
 /**
  * Example 1: Using meta tools with AI SDK for dynamic tool discovery
  */
@@ -26,7 +28,7 @@ const metaToolsWithAISDK = async (): Promise<void> => {
 
   // Initialise StackOne toolset
   const toolset = new StackOneToolSet({
-    accountId: ACCOUNT_IDS.HRIS,
+    accountId,
     baseUrl: process.env.STACKONE_BASE_URL ?? 'https://api.stackone.com',
   });
 
@@ -64,7 +66,7 @@ const metaToolsWithOpenAI = async (): Promise<void> => {
 
   // Initialise StackOne toolset
   const toolset = new StackOneToolSet({
-    accountId: ACCOUNT_IDS.HRIS,
+    accountId,
     baseUrl: process.env.STACKONE_BASE_URL ?? 'https://api.stackone.com',
   });
 
@@ -118,7 +120,7 @@ const directMetaToolUsage = async (): Promise<void> => {
 
   // Initialise toolset
   const toolset = new StackOneToolSet({
-    accountId: ACCOUNT_IDS.HRIS,
+    accountId,
     baseUrl: process.env.STACKONE_BASE_URL ?? 'https://api.stackone.com',
   });
 
@@ -188,7 +190,7 @@ const dynamicToolRouter = async (): Promise<void> => {
   console.log('\n🔄 Example 4: Dynamic tool router\n');
 
   const toolset = new StackOneToolSet({
-    accountId: ACCOUNT_IDS.HRIS,
+    accountId,
     baseUrl: process.env.STACKONE_BASE_URL ?? 'https://api.stackone.com',
   });
 

examples/index.ts

@@ -6,18 +6,20 @@ import assert from 'node:assert';
 import process from 'node:process';
 import { StackOneToolSet } from '@stackone/ai';
 import OpenAI from 'openai';
-import { ACCOUNT_IDS } from './constants';
 
 const apiKey = process.env.STACKONE_API_KEY;
 if (!apiKey) {
   console.error('STACKONE_API_KEY environment variable is required');
   process.exit(1);
 }
 
+// Replace with your actual account ID from StackOne dashboard
+const accountId = 'your-hris-account-id';
+
 const openaiIntegration = async (): Promise<void> => {
   // Initialise StackOne
   const toolset = new StackOneToolSet({
-    accountId: ACCOUNT_IDS.HRIS,
+    accountId,
     baseUrl: process.env.STACKONE_BASE_URL ?? 'https://api.stackone.com',
   });