@clarityops/types

Shared TypeScript type definitions for the ClarityOps platform, including InsightForge and InsightFlow applications.

Installation

npm install @clarityops/types
# or
pnpm add @clarityops/types
# or
yarn add @clarityops/types

Usage

Import all types

import type { 
  CurrentUser, 
  SurveyConfiguration, 
  Session,
  AnalysisResult 
} from '@clarityops/types';

Import specific modules

// Survey service types (InsightFlow backend)
import type { 
  Question, 
  Category, 
  SurveyResponse 
} from '@clarityops/types/survey';

// API client interfaces
import type { 
  SurveyApiClient, 
  AuthApiClient 
} from '@clarityops/types/api-client';

// Platform types
import type { PlatformConfig } from '@clarityops/types/platform';

// Auth types
import type { User, Permission } from '@clarityops/types/auth';

// API response types
import type { APIResponse, PaginationMeta } from '@clarityops/types/api';

Package Structure

| Module | Description | |--------|-------------| | @clarityops/types | All types (main entry point) | | @clarityops/types/survey | Survey service types (sessions, questions, analysis) | | @clarityops/types/api-client | API client interfaces | | @clarityops/types/api | Generic API response types | | @clarityops/types/auth | Authentication and user types | | @clarityops/types/platform | Platform configuration types | | @clarityops/types/flow | Legacy InsightFlow types |

Key Types

Survey Types (/survey)

• SurveyConfiguration - Survey configuration entity
• Category / Subcategory - Survey categorization
• Question - Survey questions with various types
• Session - Survey respondent sessions
• SurveyResponse - Individual question responses
• AnalysisResult - AI analysis results
• Persona - Assigned persona based on analysis
• Report / ReportJob - Generated reports

API Client Types (/api-client)

• SurveyApiClient - Full survey service API interface
• MainAppApiClient - Main application API interface
• AuthApiClient - Authentication API interface
• ApiConfig - API configuration options
• ClarityOpsEndpoints - Service endpoint URLs

Auth Types (/auth)

• User - Authenticated user
• Permission - User permissions
• ClientAccess - Client/tenant access

License

MIT