@robosystems/client 0.1.19 → 0.1.21

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 Harbinger FinLab
+Copyright (c) 2025 RFS LLC
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -3,451 +3,38 @@
 [![npm version](https://badge.fury.io/js/@robosystems%2Fclient.svg)](https://www.npmjs.com/package/@robosystems/client)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-Official TypeScript Client for the RoboSystems Financial Knowledge Graph API. Access comprehensive financial data including accounting records, SEC filings, and advanced graph analytics through a type-safe, modern TypeScript interface.
+Official TypeScript Client for the RoboSystems Financial Knowledge Graph API. Access comprehensive financial data including accounting transactions, financial reports, and advanced graph analytics through a type-safe, modern TypeScript interface.
 
 ## Features
 
 - **Type-safe API client** with full TypeScript types
-- **Auto-generated from OpenAPI** for always up-to-date types
 - **Browser & Node.js support** with different auth strategies
 - **React hooks** for seamless UI integration
-- **Queue handling** for long-running operations
-- **Streaming support** for large datasets
-- **Financial AI Agent** integration
+- **Streaming support** for memory-efficient processing of large result sets
+- **Financial AI Agent** integration for natural language queries
 - **Comprehensive error handling** with typed errors
 
 ## Installation
 
 ```bash
 npm install @robosystems/client
-# or
-yarn add @robosystems/client
-# or
-pnpm add @robosystems/client
-```
-
-## Quick Start
-
-### Browser Usage (with cookies)
-
-```typescript
-import { client, getUserMe, listCompanies, executeCypherQuery } from '@robosystems/client'
-
-// Configure the client
-client.setConfig({
-  baseUrl: 'https://api.robosystems.ai',
-  credentials: 'include',
-})
-
-// Use with cookie-based authentication (browser)
-const { data: user, error } = await getCurrentUser()
-if (user) {
-  console.log('Logged in as:', user.email)
-}
-
-// List companies in a graph
-const { data: companies } = await listCompanies({
-  path: { graph_id: 'your-graph-id' },
-  query: { limit: 10 },
-})
-
-// Execute a Cypher query
-const { data: result } = await executeCypherQuery({
-  path: { graph_id: 'your-graph-id' },
-  body: {
-    query: 'MATCH (c:Company)-[:HAS_FILING]->(f:Filing) RETURN c.name, f.form_type LIMIT 5',
-  },
-})
-```
-
-### Server Usage (with API key)
-
-```typescript
-import { client, getUserGraphs, listCompanies } from '@robosystems/client'
-
-// Configure with API key for server-side usage
-client.setConfig({
-  baseUrl: 'https://api.robosystems.ai',
-  headers: {
-    'X-API-Key': process.env.ROBOSYSTEMS_API_KEY!,
-  },
-})
-
-// Fetch user's graphs
-const { data: graphs, error } = await getUserGraphs()
-
-// Work with financial data
-if (graphs?.graphs.length) {
-  const graphId = graphs.graphs[0].graph_id
-  const { data: companies } = await listCompanies({
-    path: { graph_id: graphId },
-  })
-}
-```
-
-## Key API Endpoints
-
-### Authentication & User Management
-
-```typescript
-import {
-  registerUser,
-  loginUser,
-  logoutUser,
-  getCurrentUser,
-  createUserApiKey,
-} from '@robosystems/client'
-
-// Register a new user
-const { data, error } = await registerUser({
-  body: {
-    email: 'user@example.com',
-    password: 'secure-password',
-    name: 'John Doe',
-  },
-})
-
-// Sign in
-const { data: session } = await loginUser({
-  body: {
-    username: 'user@example.com',
-    password: 'secure-password',
-  },
-})
-
-// Get current user
-const { data: user } = await getCurrentUser()
-
-// Create API key for programmatic access
-const { data: apiKey } = await createUserApiKey({
-  body: {
-    key_name: 'Production Server',
-    key_type: 'user',
-  },
-})
-console.log('Save this key securely:', apiKey.key)
-
-// Sign out
-await logoutUser()
-```
-
-### Company & Financial Data
-
-```typescript
-import {
-  listCompanies,
-  getCompany,
-  createCompany,
-  createConnection,
-  syncConnection,
-} from '@robosystems/client'
-
-// List companies with pagination
-const { data: companies } = await listCompanies({
-  path: { graph_id: 'your-graph-id' },
-  query: { limit: 20, offset: 0 },
-})
-console.log(`Found ${companies.total} companies`)
-
-// Get specific company details
-const { data: company } = await getCompany({
-  path: {
-    graph_id: 'your-graph-id',
-    company_id: 'AAPL',
-  },
-})
-
-// Create new company
-const { data: newCompany } = await createCompany({
-  path: { graph_id: 'your-graph-id' },
-  body: {
-    identifier: 'MSFT',
-    name: 'Microsoft Corporation',
-    metadata: { industry: 'Technology' },
-  },
-})
-
-// Create data connection (QuickBooks, etc.)
-const { data: connection } = await createConnection({
-  path: { graph_id: 'your-graph-id' },
-  body: {
-    name: 'QuickBooks Integration',
-    connection_type: 'quickbooks',
-    config: { company_id: '123456' },
-  },
-})
-
-// Sync data from connection
-const { data: syncResult } = await syncConnection({
-  path: {
-    graph_id: 'your-graph-id',
-    connection_id: connection.id,
-  },
-})
-```
-
-### Graph Queries & Analytics
-
-```typescript
-import {
-  executeCypherQuery,
-  executeReadOnlyCypherQuery,
-  getGraphMetrics,
-} from '@robosystems/client'
-
-// Execute parameterized Cypher queries
-const { data: results } = await executeCypherQuery({
-  path: { graph_id: 'your-graph-id' },
-  body: {
-    query: `
-      MATCH (c:Company {ticker: $ticker})-[:HAS_METRIC]->(m:Metric)
-      WHERE m.fiscal_year >= $start_year
-      RETURN m.name, m.value, m.fiscal_year
-      ORDER BY m.fiscal_year DESC
-    `,
-    parameters: { ticker: 'AAPL', start_year: 2020 },
-  },
-})
-
-// Read-only queries for better performance
-const { data: readOnlyResult } = await executeReadOnlyCypherQuery({
-  path: { graph_id: 'your-graph-id' },
-  body: { query: 'MATCH (n) RETURN count(n) as total' },
-})
-
-// Get graph analytics
-const { data: metrics } = await getGraphMetrics({
-  path: { graph_id: 'your-graph-id' },
-})
-console.log(`Total nodes: ${metrics.total_nodes}`)
-console.log(`Total relationships: ${metrics.total_relationships}`)
-```
-
-### Financial AI Agent
-
-```typescript
-import { queryFinancialAgent } from '@robosystems/client'
-
-// Natural language financial queries
-const { data: agentResponse } = await queryFinancialAgent({
-  path: { graph_id: 'your-graph-id' },
-  body: {
-    query: "What was Apple's revenue growth over the last 3 years?",
-    include_reasoning: true,
-    max_tokens: 1000,
-  },
-})
-
-console.log('Answer:', agentResponse.answer)
-if (agentResponse.reasoning) {
-  console.log('Reasoning:', agentResponse.reasoning)
-}
-```
-
-## Advanced Features
-
-### Billing & Credit Management
-
-```typescript
-import { getCreditSummary, checkCreditBalance, getCurrentGraphBill } from '@robosystems/client'
-
-// Monitor credits and usage for a specific graph
-const { data: creditSummary } = await getCreditSummary({
-  path: { graph_id: 'your-graph-id' },
-})
-console.log(`Available credits: ${creditSummary.available_credits.toLocaleString()}`)
-console.log(
-  `Monthly usage: ${creditSummary.used_credits.toLocaleString()}/${creditSummary.total_credits.toLocaleString()}`
-)
-
-// Check credit requirements before operations
-const { data: creditCheck } = await checkCreditBalance({
-  path: { graph_id: 'your-graph-id' },
-  body: {
-    operation_type: 'query',
-    estimated_credits: 100,
-  },
-})
-
-if (creditCheck.has_sufficient_credits) {
-  // Proceed with operation
-}
-
-// Get billing information
-const { data: currentBill } = await getCurrentGraphBill({
-  path: { graph_id: 'your-graph-id' },
-})
-```
-
-### MCP Tools Integration
-
-```typescript
-import { listMcpTools, callMcpTool } from '@robosystems/client'
-
-// List available MCP tools
-const { data: tools } = await listMcpTools({
-  path: { graph_id: 'your-graph-id' },
-})
-tools.tools.forEach((tool) => {
-  console.log(`${tool.name}: ${tool.description}`)
-})
-
-// Call an MCP tool
-const { data: toolResult } = await callMcpTool({
-  path: { graph_id: 'your-graph-id' },
-  body: {
-    name: 'analyze_financial_statement',
-    arguments: {
-      company_id: 'AAPL',
-      statement_type: 'income',
-      fiscal_year: 2023,
-    },
-  },
-})
-console.log('Analysis result:', toolResult.content)
-```
-
-## Advanced Features
-
-### Error Handling
-
-```typescript
-import { listCompanies } from '@robosystems/client'
-import type { ErrorResponse } from '@robosystems/client'
-
-try {
-  const { data, error } = await listCompanies({
-    path: { graph_id: 'your-graph-id' },
-  })
-
-  if (error) {
-    const apiError = error as ErrorResponse
-
-    switch (apiError.status) {
-      case 400:
-        console.error('Validation error:', apiError.detail)
-        break
-      case 401:
-        console.error('Authentication failed - check your API key')
-        break
-      case 403:
-        console.error('Permission denied - check graph access')
-        break
-      case 429:
-        console.error('Rate limit exceeded - retry later')
-        break
-      case 503:
-        console.error('Service temporarily unavailable')
-        break
-      default:
-        console.error('API Error:', apiError.detail || apiError.message)
-    }
-  } else if (data) {
-    console.log(`Found ${data.total} companies`)
-  }
-} catch (err) {
-  // Network errors
-  console.error('Network Error:', err)
-}
-```
-
-### TypeScript Types
-
-All API responses and requests are fully typed:
-
-```typescript
-import type {
-  User,
-  Graph,
-  Company,
-  CompanyCreate,
-  CypherQueryRequest,
-  CypherQueryResponse,
-  AgentQueryRequest,
-  AgentQueryResponse,
-  ErrorResponse,
-  PaginatedResponse,
-} from '@robosystems/client'
-
-// Type-safe function example
-function processCompany(company: Company): void {
-  console.log(`Company: ${company.name} (${company.identifier})`)
-  if (company.metadata) {
-    console.log('Industry:', company.metadata.industry)
-  }
-}
-
-// Type-safe query builder
-function buildMetricQuery(ticker: string, startYear: number): CypherQueryRequest {
-  return {
-    query: `
-      MATCH (c:Company {ticker: $ticker})-[:HAS_METRIC]->(m:Metric)
-      WHERE m.fiscal_year >= $start_year
-      RETURN m
-    `,
-    parameters: { ticker, start_year: startYear },
-  }
-}
-```
-
-## Environment Configuration
-
-### Next.js App Router
-
-```typescript
-// app/api/robosystems/route.ts
-import { client } from '@robosystems/client'
-
-// Configure for server-side API routes
-client.setConfig({
-  baseUrl: process.env.ROBOSYSTEMS_API_URL || 'https://api.robosystems.ai',
-  headers: {
-    'X-API-Key': process.env.ROBOSYSTEMS_API_KEY!,
-  },
-})
-```
-
-### React SPA
-
-```typescript
-// src/lib/robosystems.ts
-import { client } from '@robosystems/client'
-
-// Configure for browser with cookies
-client.setConfig({
-  baseUrl: import.meta.env.VITE_ROBOSYSTEMS_API_URL || 'https://api.robosystems.ai',
-  credentials: 'include',
-})
-```
-
-### Node.js Script
-
-```typescript
-// scripts/analyze.ts
-import { client } from '@robosystems/client'
-import dotenv from 'dotenv'
-
-dotenv.config()
-
-client.setConfig({
-  baseUrl: process.env.ROBOSYSTEMS_API_URL || 'https://api.robosystems.ai',
-  headers: {
-    'X-API-Key': process.env.ROBOSYSTEMS_API_KEY!,
-  },
-})
 ```
 
 ## API Reference
 
-- Full API documentation: [https://api.robosystems.ai](https://api.robosystems.ai)
+- API reference: [https://api.robosystems.ai](https://api.robosystems.ai)
+- API documentation: [https://api.robosystems.ai/docs](https://api.robosystems.ai/docs)
 - OpenAPI specification: [https://api.robosystems.ai/openapi.json](https://api.robosystems.ai/openapi.json)
 
 ## Support
 
-- Issues: [GitHub Issues](https://github.com/RoboFinSystems/robosystems-typescript-client/issues)
+- Issues: [Issues](https://github.com/RoboFinSystems/robosystems-typescript-client/issues)
+- Discussions: [Discussions](https://github.com/RoboFinSystems/robosystems-typescript-client/discussions)
+- Projects: [Projects](https://github.com/RoboFinSystems/robosystems-typescript-client/projects)
+- Wiki: [Wiki](https://github.com/RoboFinSystems/robosystems-typescript-client/wiki)
 
 ## License
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
 
-MIT © 2025 Harbinger FinLab
+MIT © 2025 RFS LLC

package/bin/create-feature

@@ -1,8 +1,8 @@
 #!/bin/bash
 set -e
 
-# Create feature branch script using GitHub Actions
-# Creates a new feature/bugfix/hotfix branch from specified base
+# Create feature branch script - local Git operations
+# Creates a new feature/bugfix/hotfix branch locally and pushes to remote
 # Usage: ./bin/create-feature [feature|bugfix|hotfix|chore|refactor] [branch-name] [base-branch]
 
 # Default values
@@ -13,79 +13,82 @@ BASE_BRANCH=${3:-main}
 # Validate branch type
 if [[ "$BRANCH_TYPE" != "feature" && "$BRANCH_TYPE" != "bugfix" && "$BRANCH_TYPE" != "hotfix" && "$BRANCH_TYPE" != "chore" && "$BRANCH_TYPE" != "refactor" ]]; then
   echo "❌ Invalid branch type: $BRANCH_TYPE"
-  echo "Usage: $0 [feature|bugfix|hotfix|chore|refactor] [branch-name] [base-branch]"
+  echo "Valid types: feature, bugfix, hotfix, chore, refactor"
   exit 1
 fi
 
-# Check if branch name is provided
+# Check if branch name was provided
 if [ -z "$BRANCH_NAME" ]; then
   echo "❌ Branch name is required"
-  echo "Usage: $0 [feature|bugfix|hotfix|chore|refactor] [branch-name] [base-branch]"
+  echo "Usage: $0 [type] [name] [base_branch]"
+  echo "Example: $0 feature add-user-auth main"
   exit 1
 fi
 
 # Sanitize branch name
-SANITIZED_NAME=$(echo "$BRANCH_NAME" | sed 's/[^a-zA-Z0-9-]/-/g' | sed 's/--*/-/g' | sed 's/^-//;s/-$//' | tr '[:upper:]' '[:lower:]')
-FULL_BRANCH_NAME="$BRANCH_TYPE/$SANITIZED_NAME"
+SANITIZED_NAME=$(echo "$BRANCH_NAME" | sed 's/[^a-zA-Z0-9._-]/-/g' | sed 's/--*/-/g' | sed 's/^-//;s/-$//')
+FULL_BRANCH="${BRANCH_TYPE}/${SANITIZED_NAME}"
 
-echo "🌿 Creating feature branch..."
-echo "📋 Branch Details:"
+echo "🚀 Creating feature branch locally..."
+echo "📋 Details:"
 echo "  Type: $BRANCH_TYPE"
 echo "  Name: $SANITIZED_NAME"
-echo "  Full Name: $FULL_BRANCH_NAME"
+echo "  Full Branch: $FULL_BRANCH"
 echo "  Base Branch: $BASE_BRANCH"
 echo ""
 
 # Check for uncommitted changes
 if ! git diff --quiet || ! git diff --cached --quiet; then
-  echo "⚠️  You have uncommitted changes. Please commit or stash them first."
-  echo ""
-  echo "Uncommitted files:"
-  git status --porcelain
+  echo "⚠️  You have uncommitted changes. Auto-stashing..."
+  git stash push -m "Auto-stash before creating branch $FULL_BRANCH"
+  echo "✅ Changes stashed"
+fi
+
+# Fetch latest changes from remote
+echo "📥 Fetching latest changes from remote..."
+git fetch origin
+
+# Check if branch already exists (local or remote)
+if git show-ref --verify --quiet refs/heads/$FULL_BRANCH; then
+  echo "❌ Branch $FULL_BRANCH already exists locally"
   exit 1
 fi
 
-echo "🚀 Triggering GitHub Actions workflow..."
-gh workflow run create-feature.yml \
-  --field branch_type="$BRANCH_TYPE" \
-  --field branch_name="$BRANCH_NAME" \
-  --field base_branch="$BASE_BRANCH"
+if git show-ref --verify --quiet refs/remotes/origin/$FULL_BRANCH; then
+  echo "❌ Branch $FULL_BRANCH already exists on remote"
+  echo "💡 To check it out: git checkout -b $FULL_BRANCH origin/$FULL_BRANCH"
+  exit 1
+fi
 
-echo "⏳ Waiting for branch to be created..."
+# Check if base branch exists on remote
+if ! git show-ref --verify --quiet refs/remotes/origin/$BASE_BRANCH; then
+  echo "❌ Base branch $BASE_BRANCH does not exist on remote"
+  echo "💡 Available branches:"
+  git branch -r | grep -v HEAD | sed 's/origin\///' | head -10
+  exit 1
+fi
+
+# Create and checkout the new branch from the base branch
+echo "🔨 Creating branch $FULL_BRANCH from origin/$BASE_BRANCH..."
+git checkout -b $FULL_BRANCH origin/$BASE_BRANCH
+
+# Push the new branch to remote with upstream tracking
+echo "📤 Pushing branch to remote..."
+git push -u origin $FULL_BRANCH
 
-# Wait for the branch to be created (check every 5 seconds for up to 1 minute)
-MAX_ATTEMPTS=12
-ATTEMPT=1
+echo ""
+echo "🎉 Successfully created and checked out $FULL_BRANCH"
+echo ""
+echo "📝 Next steps:"
+echo "  1. Make your changes and commit them"
+echo "  2. Push your changes: git push"
+echo "  3. Create a PR: gh pr create --base $BASE_BRANCH --title \"Your PR title\" --body \"Your PR description\""
+echo "     or use: npm run pr:create"
 
-while [ $ATTEMPT -le $MAX_ATTEMPTS ]; do
-    echo "Attempt $ATTEMPT/$MAX_ATTEMPTS: Checking if branch exists..."
-    
-    # Fetch latest changes from remote
-    git fetch origin --quiet
-    
-    # Check if the branch exists on remote
-    if git show-ref --verify --quiet refs/remotes/origin/$FULL_BRANCH_NAME; then
-        echo "✅ Branch $FULL_BRANCH_NAME found! Checking it out..."
-        git checkout -b $FULL_BRANCH_NAME origin/$FULL_BRANCH_NAME 2>/dev/null || git checkout $FULL_BRANCH_NAME
-        
-        echo "🎉 Successfully created and switched to $FULL_BRANCH_NAME"
-        echo ""
-        echo "📝 Next steps:"
-        echo "  1. Make your changes and commit them"
-        echo "  2. Push your changes: git push"
-        echo "  3. Create a PR when ready: npm run pr:create"
-        
-        exit 0
-    fi
-    
-    if [ $ATTEMPT -eq $MAX_ATTEMPTS ]; then
-        echo "❌ Timeout: Branch $FULL_BRANCH_NAME was not created after 1 minute"
-        echo "Check the GitHub Actions workflow status:"
-        echo "  gh run list --workflow=create-feature.yml"
-        exit 1
-    fi
-    
-    echo "Branch not yet available, waiting 5 seconds..."
-    sleep 5
-    ATTEMPT=$((ATTEMPT + 1))
-done
+# Check if we had stashed changes and auto-apply them
+if git stash list | grep -q "Auto-stash before creating branch $FULL_BRANCH"; then
+  echo ""
+  echo "Auto-applying stashed changes..."
+  git stash pop
+  echo "✅ Stashed changes applied"
+fi

package/client/utils.gen.js

@@ -135,8 +135,22 @@ const getParseAs = (contentType) => {
     return;
 };
 exports.getParseAs = getParseAs;
+const checkForExistence = (options, name) => {
+    if (!name) {
+        return false;
+    }
+    if (options.headers.has(name) ||
+        options.query?.[name] ||
+        options.headers.get('Cookie')?.includes(`${name}=`)) {
+        return true;
+    }
+    return false;
+};
 const setAuthParams = async ({ security, ...options }) => {
     for (const auth of security) {
+        if (checkForExistence(options, auth.name)) {
+            continue;
+        }
         const token = await (0, auth_gen_1.getAuthToken)(auth, options.auth);
         if (!token) {
             continue;
@@ -157,7 +171,6 @@ const setAuthParams = async ({ security, ...options }) => {
                 options.headers.set(name, token);
                 break;
         }
-        return;
     }
 };
 exports.setAuthParams = setAuthParams;

package/client/utils.gen.ts

@@ -188,6 +188,25 @@ export const getParseAs = (
   return;
 };
 
+const checkForExistence = (
+  options: Pick<RequestOptions, 'auth' | 'query'> & {
+    headers: Headers;
+  },
+  name?: string,
+): boolean => {
+  if (!name) {
+    return false;
+  }
+  if (
+    options.headers.has(name) ||
+    options.query?.[name] ||
+    options.headers.get('Cookie')?.includes(`${name}=`)
+  ) {
+    return true;
+  }
+  return false;
+};
+
 export const setAuthParams = async ({
   security,
   ...options
@@ -196,6 +215,10 @@ export const setAuthParams = async ({
     headers: Headers;
   }) => {
   for (const auth of security) {
+    if (checkForExistence(options, auth.name)) {
+      continue;
+    }
+
     const token = await getAuthToken(auth, options.auth);
 
     if (!token) {
@@ -219,8 +242,6 @@ export const setAuthParams = async ({
         options.headers.set(name, token);
         break;
     }
-
-    return;
   }
 };
 

package/core/bodySerializer.gen.js

@@ -6,6 +6,9 @@ const serializeFormDataPair = (data, key, value) => {
     if (typeof value === 'string' || value instanceof Blob) {
         data.append(key, value);
     }
+    else if (value instanceof Date) {
+        data.append(key, value.toISOString());
+    }
     else {
         data.append(key, JSON.stringify(value));
     }