@ayurak/sdk 1.0.0 → 1.4.0

package/README.md

@@ -1,21 +1,25 @@
 # Aribot JavaScript/TypeScript SDK
 
-Official JavaScript SDK for the Aribot Security Platform.
+Official JavaScript SDK for the Aribot Security Platform by Aristiun & Ayurak.
+
+[![npm](https://img.shields.io/npm/v/@ayurak/sdk)](https://www.npmjs.com/package/@ayurak/sdk)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.0+-blue)](https://www.typescriptlang.org/)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
 
 ## Installation
 
 ```bash
-npm install aribot-sdk
+npm install @ayurak/sdk
 # or
-yarn add aribot-sdk
+yarn add @ayurak/sdk
 # or
-pnpm add aribot-sdk
+pnpm add @ayurak/sdk
 ```
 
 ## Quick Start
 
 ```typescript
-import { Aribot } from 'aribot-sdk';
+import { Aribot } from '@ayurak/sdk';
 
 const client = new Aribot('your_api_key');
 
@@ -38,6 +42,9 @@ for (const threat of threats) {
 - **Compliance Scanning** - ISO 27001, SOC2, GDPR, HIPAA, PCI-DSS, NIST
 - **Cloud Security** - Scan AWS, Azure, GCP for misconfigurations
 - **Pipeline Security** - SAST, SCA, secrets detection in CI/CD
+- **Digital Twin** - Cloud resource mapping, health monitoring, live status
+- **Economics** - Cost analysis, ROI calculations, market intelligence
+- **Red Team** - Attack simulations, methodologies, threat intelligence
 
 ## API Reference
 
@@ -231,6 +238,83 @@ await client.pipeline.suppressFinding(findingId, 'False positive');
 const dashboard = await client.pipeline.dashboard(projectId);
 ```
 
+### Digital Twin
+
+```typescript
+// Get cloud providers
+const providers = await client.digitalTwin.getProviders();
+// Returns: [{ name: 'aws', display_name: 'Amazon Web Services', is_active: true }, ...]
+
+// Get available resources
+const resources = await client.digitalTwin.getResources({ provider: 'aws', limit: 50 });
+
+// Get health status
+const health = await client.digitalTwin.getHealth();
+
+// Get analytics
+const analytics = await client.digitalTwin.getAnalytics();
+
+// Get diagram component cloud status
+const status = await client.digitalTwin.getDiagramComponentStatus(diagramId);
+
+// Map component to cloud resource
+await client.digitalTwin.mapComponent(diagramId, componentId, resourceId);
+
+// Sync diagram status
+await client.digitalTwin.syncDiagramStatus(diagramId);
+```
+
+### Economics
+
+```typescript
+// Get economics dashboard
+const dashboard = await client.economics.getDashboard({ period: 'month' });
+
+// Get diagram cost analysis
+const cost = await client.economics.getDiagramCostAnalysis(diagramId);
+console.log(`Monthly cost: $${cost.total_monthly_cost}`);
+
+// Get component cost
+const componentCost = await client.economics.getComponentCost(componentId);
+
+// Get economic intelligence
+const intel = await client.economics.getEconomicIntelligence();
+
+// Get market intelligence
+const market = await client.economics.getMarketIntelligence();
+
+// Calculate ROI
+const roi = await client.economics.calculateROI({
+  investment: 100000,
+  risksAddressed: ['risk-1', 'risk-2'],
+  timeframeDays: 365
+});
+console.log(`ROI: ${roi.roi_percentage}%`);
+```
+
+### Red Team
+
+```typescript
+// Get methodologies
+const methodologies = await client.redTeam.getMethodologies();
+// Returns: [{ id: 'stride', name: 'STRIDE', description: '...' }, ...]
+
+// Get simulations
+const simulations = await client.redTeam.getSimulations({ limit: 10 });
+
+// Get threat intelligence
+const intel = await client.redTeam.getIntelligence();
+
+// Generate attack paths
+const paths = await client.redTeam.generateAttackPaths(diagramId, {
+  depth: 'comprehensive',
+  includeRemediations: true
+});
+
+// Get security requirements
+const requirements = await client.redTeam.getSecurityRequirements(diagramId);
+```
+
 ## Error Handling
 
 ```typescript
@@ -242,7 +326,7 @@ import {
   ValidationError,
   NotFoundError,
   ServerError
-} from 'aribot-sdk';
+} from '@ayurak/sdk';
 
 const client = new Aribot('your_api_key');
 
@@ -290,7 +374,7 @@ console.log(`API calls used: ${usage.calls_used}/${usage.calls_limit}`);
 For Node.js environments, you can use the `fs` module to read files:
 
 ```typescript
-import { Aribot } from 'aribot-sdk';
+import { Aribot } from '@ayurak/sdk';
 import { readFileSync } from 'fs';
 
 const client = new Aribot(process.env.ARIBOT_API_KEY!);
@@ -307,7 +391,7 @@ const result = await client.threatModeling.analyzeDiagram(blob, {
 ## Browser Usage
 
 ```typescript
-import { Aribot } from 'aribot-sdk';
+import { Aribot } from '@ayurak/sdk';
 
 const client = new Aribot('your_api_key');
 
@@ -359,10 +443,22 @@ input?.addEventListener('change', async (e) => {
     PROJECT_ID: ${{ vars.PROJECT_ID }}
 ```
 
+## Changelog
+
+### v1.4.0
+- **Fixed**: Base URL corrected from `api.aribot.aristiun.com` to `api.aribot.ayurak.com`
+- **Added**: AI module (`client.ai`) - usage, quota, models, configure, analyze, queue status
+- **Added**: SBOM module (`client.sbom`) - document management, upload, vulnerability scanning
+- **Added**: Dashboard module (`client.dashboard`) - overview, recent activity, risk summary
+- **Added**: FinOps module (`client.finops`) - cost optimization, recommendations, cost breakdown
+- **Added**: Marketplace module (`client.marketplace`) - templates, categories, featured items
+- **Added**: API Keys module (`client.apiKeys`) - list, create, revoke API keys
+- **Added**: Framework-specific compliance scoring support
+
 ## Support
 
-- Documentation: https://developer.ayurak.com/docs/js-sdk
-- API Reference: https://developer.ayurak.com/api
+- Documentation: https://developers.aristiun.com/docs/js-sdk
+- API Reference: https://developers.aristiun.com/api
 - Issues: https://github.com/Aristiun/aribot-js/issues
 
 ## License

package/dist/index.d.mts

@@ -431,6 +431,497 @@ declare class PipelineAPI {
     dashboard(projectId?: string, period?: 'day' | 'week' | 'month' | 'quarter'): Promise<Record<string, unknown>>;
 }
 
+interface RedTeamMethodology {
+    id: string;
+    name: string;
+    description: string;
+    techniques_count: number;
+}
+interface RedTeamSimulation {
+    id: string;
+    name: string;
+    diagram_id: string;
+    status: string;
+    attack_paths: unknown[];
+    created_at: string;
+}
+interface ThreatIntelligence {
+    threat_count: number;
+    simulation_count: number;
+    active_threats: number;
+    mitre_techniques: number;
+}
+/**
+ * Red Team API for attack simulation and threat intelligence
+ */
+declare class RedTeamAPI {
+    private http;
+    constructor(http: HttpClient);
+    /**
+     * Get available red team methodologies (STRIDE, PASTA, MITRE ATT&CK, etc.)
+     */
+    getMethodologies(): Promise<RedTeamMethodology[]>;
+    /**
+     * Get red team simulations (attack path simulations)
+     */
+    getSimulations(options?: {
+        diagramId?: string;
+        status?: string;
+        limit?: number;
+    }): Promise<RedTeamSimulation[]>;
+    /**
+     * Get threat intelligence summary
+     */
+    getIntelligence(): Promise<ThreatIntelligence>;
+    /**
+     * Generate attack paths for a diagram
+     */
+    generateAttackPaths(diagramId: string, options?: {
+        depth?: 'basic' | 'comprehensive' | 'detailed';
+        includeRemediations?: boolean;
+    }): Promise<{
+        simulation_id: string;
+        status: string;
+    }>;
+    /**
+     * Get attack paths for a diagram
+     */
+    getAttackPaths(diagramId: string): Promise<unknown[]>;
+}
+
+interface CloudProvider {
+    id: string;
+    name: string;
+    display_name: string;
+    is_active: boolean;
+    is_enabled: boolean;
+    resources_count?: number;
+}
+interface CloudResource {
+    id: string;
+    name: string;
+    resource_type: string;
+    provider: string;
+    region?: string;
+    status?: string;
+}
+interface ComponentCloudMapping {
+    component_id: string;
+    resource_id: string;
+    compliance_status: string;
+    compliance_score: number;
+    security_score: number;
+    total_controls: number;
+    passed_controls: number;
+    failed_controls: number;
+    vulnerability_count: number;
+}
+interface DiagramComponentStatus {
+    components: ComponentCloudMapping[];
+    overall_compliance: number;
+    total_mapped: number;
+    total_unmapped: number;
+}
+/**
+ * Digital Twin API for cloud resource mapping and live status
+ */
+declare class DigitalTwinAPI {
+    private http;
+    constructor(http: HttpClient);
+    /**
+     * Get available cloud providers (AWS, Azure, GCP)
+     */
+    getProviders(): Promise<CloudProvider[]>;
+    /**
+     * Get available cloud resources
+     */
+    getResources(options?: {
+        provider?: string;
+        resourceType?: string;
+        limit?: number;
+    }): Promise<CloudResource[]>;
+    /**
+     * Get component cloud status for a diagram
+     */
+    getDiagramComponentStatus(diagramId: string): Promise<DiagramComponentStatus>;
+    /**
+     * Map a component to a cloud resource
+     */
+    mapComponent(diagramId: string, componentId: string, resourceId: string): Promise<ComponentCloudMapping>;
+    /**
+     * Unmap a component from cloud resource
+     */
+    unmapComponent(diagramId: string, componentId: string): Promise<void>;
+    /**
+     * Sync diagram cloud status
+     */
+    syncDiagramStatus(diagramId: string): Promise<DiagramComponentStatus>;
+    /**
+     * Get single component cloud status
+     */
+    getComponentStatus(componentId: string): Promise<ComponentCloudMapping>;
+    /**
+     * Get digital twin health status
+     */
+    getHealth(): Promise<Record<string, unknown>>;
+    /**
+     * Get digital twin analytics
+     */
+    getAnalytics(): Promise<Record<string, unknown>>;
+}
+
+interface EconomicsDashboard {
+    total_cost: number;
+    cost_by_provider: Record<string, number>;
+    cost_trend: unknown[];
+    security_roi: number;
+    risk_value: number;
+    potential_loss_prevented: number;
+    compliance_investment: number;
+}
+interface ComponentCost {
+    component_id: string;
+    component_name: string;
+    monthly_cost: number;
+    annual_cost: number;
+    cost_breakdown: Record<string, number>;
+}
+interface DiagramCostAnalysis {
+    diagram_id: string;
+    total_monthly_cost: number;
+    total_annual_cost: number;
+    components: ComponentCost[];
+    cost_by_category: Record<string, number>;
+}
+interface MarketIntelligence {
+    market_trends: unknown[];
+    competitive_analysis: unknown[];
+    pricing_benchmarks: unknown[];
+}
+/**
+ * Economics API for cost analysis and market intelligence
+ */
+declare class EconomicsAPI {
+    private http;
+    constructor(http: HttpClient);
+    /**
+     * Get economics dashboard with cost metrics
+     */
+    getDashboard(options?: {
+        period?: 'day' | 'week' | 'month' | 'quarter' | 'year';
+    }): Promise<EconomicsDashboard>;
+    /**
+     * Get cost analysis for a diagram
+     */
+    getDiagramCostAnalysis(diagramId: string): Promise<DiagramCostAnalysis>;
+    /**
+     * Get component cost intelligence
+     */
+    getComponentCost(componentId: string): Promise<ComponentCost>;
+    /**
+     * Get economic intelligence dashboard (pricing, market trends)
+     */
+    getEconomicIntelligence(): Promise<Record<string, unknown>>;
+    /**
+     * Get market intelligence data
+     */
+    getMarketIntelligence(): Promise<MarketIntelligence>;
+    /**
+     * Calculate ROI for security investments
+     */
+    calculateROI(options: {
+        investment: number;
+        risksAddressed: string[];
+        timeframeDays?: number;
+    }): Promise<{
+        roi_percentage: number;
+        breakeven_days: number;
+        projected_savings: number;
+    }>;
+}
+
+interface AIUsage {
+    total_requests: number;
+    tokens_used: number;
+    cost: number;
+    period: string;
+    [key: string]: unknown;
+}
+interface AIQuota {
+    requests_limit: number;
+    requests_used: number;
+    tokens_limit: number;
+    tokens_used: number;
+    reset_at: string;
+    [key: string]: unknown;
+}
+interface AIModel {
+    id: string;
+    name: string;
+    provider: string;
+    capabilities: string[];
+    [key: string]: unknown;
+}
+interface AIAnalysisResult {
+    analysis_id: string;
+    status: string;
+    results: unknown;
+    [key: string]: unknown;
+}
+interface AIQueueStatus {
+    pending: number;
+    processing: number;
+    completed: number;
+    failed: number;
+    [key: string]: unknown;
+}
+/**
+ * AI usage, quota, and analysis operations
+ */
+declare class AIAPI {
+    private http;
+    constructor(http: HttpClient);
+    /**
+     * Get AI usage statistics
+     */
+    getUsage(period?: string): Promise<AIUsage>;
+    /**
+     * Get AI quota information
+     */
+    getQuota(): Promise<AIQuota>;
+    /**
+     * List available AI models
+     */
+    listModels(): Promise<AIModel[]>;
+    /**
+     * Configure AI settings
+     */
+    configure(config: Record<string, unknown>): Promise<Record<string, unknown>>;
+    /**
+     * Run AI analysis
+     */
+    analyze(options: {
+        target: string;
+        type?: string;
+        model?: string;
+        [key: string]: unknown;
+    }): Promise<AIAnalysisResult>;
+    /**
+     * Get AI processing queue status
+     */
+    getQueueStatus(): Promise<AIQueueStatus>;
+}
+
+interface SBOMDocument {
+    id: string;
+    name: string;
+    format: string;
+    status: string;
+    created_at: string;
+    components_count: number;
+    vulnerabilities_count: number;
+    [key: string]: unknown;
+}
+interface SBOMVulnerability {
+    id: string;
+    cve_id: string;
+    severity: string;
+    description: string;
+    affected_component: string;
+    fix_available: boolean;
+    [key: string]: unknown;
+}
+/**
+ * SBOM document management and vulnerability scanning
+ */
+declare class SBOMAPI {
+    private http;
+    constructor(http: HttpClient);
+    /**
+     * List SBOM documents
+     */
+    list(params?: Record<string, string | number | boolean>): Promise<SBOMDocument[]>;
+    /**
+     * Get SBOM document details
+     */
+    get(documentId: string): Promise<SBOMDocument>;
+    /**
+     * Upload an SBOM document
+     */
+    upload(file: File | Blob, options?: {
+        name?: string;
+        format?: string;
+    }): Promise<SBOMDocument>;
+    /**
+     * Get vulnerabilities for an SBOM document
+     */
+    getVulnerabilities(documentId: string, params?: Record<string, string | number | boolean>): Promise<SBOMVulnerability[]>;
+}
+
+interface DashboardOverview {
+    total_diagrams: number;
+    total_threats: number;
+    compliance_score: number;
+    risk_score: number;
+    [key: string]: unknown;
+}
+interface RecentActivity {
+    id: string;
+    type: string;
+    description: string;
+    timestamp: string;
+    [key: string]: unknown;
+}
+interface RiskSummary {
+    overall_risk: string;
+    critical: number;
+    high: number;
+    medium: number;
+    low: number;
+    trend: string;
+    [key: string]: unknown;
+}
+/**
+ * Dashboard overview, activity, and risk summary
+ */
+declare class DashboardAPI {
+    private http;
+    constructor(http: HttpClient);
+    /**
+     * Get dashboard overview metrics
+     */
+    getOverview(): Promise<DashboardOverview>;
+    /**
+     * Get recent activity
+     */
+    getRecentActivity(params?: Record<string, string | number | boolean>): Promise<RecentActivity[]>;
+    /**
+     * Get risk summary
+     */
+    getRiskSummary(): Promise<RiskSummary>;
+}
+
+interface FinOpsRecommendation {
+    id: string;
+    type: string;
+    description: string;
+    estimated_savings: number;
+    priority: string;
+    [key: string]: unknown;
+}
+interface FinOpsCosts {
+    total: number;
+    by_service: Record<string, number>;
+    by_provider: Record<string, number>;
+    period: string;
+    [key: string]: unknown;
+}
+interface FinOpsOptimization {
+    id: string;
+    status: string;
+    savings_achieved: number;
+    details: string;
+    [key: string]: unknown;
+}
+/**
+ * FinOps cost optimization and recommendations
+ */
+declare class FinOpsAPI {
+    private http;
+    constructor(http: HttpClient);
+    /**
+     * Get cost optimization recommendations
+     */
+    getRecommendations(params?: Record<string, string | number | boolean>): Promise<FinOpsRecommendation[]>;
+    /**
+     * Get cost breakdown
+     */
+    getCosts(params?: Record<string, string | number | boolean>): Promise<FinOpsCosts>;
+    /**
+     * Get optimization details
+     */
+    getOptimization(params?: Record<string, string | number | boolean>): Promise<FinOpsOptimization[]>;
+}
+
+interface MarketplaceTemplate {
+    id: string;
+    name: string;
+    description: string;
+    category: string;
+    author: string;
+    downloads: number;
+    rating: number;
+    [key: string]: unknown;
+}
+interface MarketplaceCategory {
+    id: string;
+    name: string;
+    description: string;
+    templates_count: number;
+    [key: string]: unknown;
+}
+/**
+ * Marketplace templates, categories, and featured items
+ */
+declare class MarketplaceAPI {
+    private http;
+    constructor(http: HttpClient);
+    /**
+     * List marketplace templates
+     */
+    listTemplates(params?: Record<string, string | number | boolean>): Promise<MarketplaceTemplate[]>;
+    /**
+     * List marketplace categories
+     */
+    listCategories(): Promise<MarketplaceCategory[]>;
+    /**
+     * Get featured templates
+     */
+    getFeatured(): Promise<MarketplaceTemplate[]>;
+}
+
+interface APIKey {
+    id: string;
+    name: string;
+    prefix: string;
+    created_at: string;
+    last_used_at: string | null;
+    expires_at: string | null;
+    is_active: boolean;
+    [key: string]: unknown;
+}
+interface APIKeyCreateResult {
+    id: string;
+    name: string;
+    key: string;
+    prefix: string;
+    created_at: string;
+    [key: string]: unknown;
+}
+/**
+ * API key management operations
+ */
+declare class APIKeysAPI {
+    private http;
+    constructor(http: HttpClient);
+    /**
+     * List API keys
+     */
+    list(params?: Record<string, string | number | boolean>): Promise<APIKey[]>;
+    /**
+     * Create a new API key
+     */
+    create(options: {
+        name: string;
+        expires_in_days?: number;
+        scopes?: string[];
+    }): Promise<APIKeyCreateResult>;
+    /**
+     * Revoke an API key
+     */
+    revoke(keyId: string): Promise<Record<string, unknown>>;
+}
+
 interface AribotOptions {
     baseUrl?: string;
     timeout?: number;
@@ -475,6 +966,24 @@ declare class Aribot {
     cloud: CloudSecurityAPI;
     /** Pipeline security scanning */
     pipeline: PipelineAPI;
+    /** Red team attack simulation */
+    redTeam: RedTeamAPI;
+    /** Digital twin cloud mapping */
+    digitalTwin: DigitalTwinAPI;
+    /** Economics and cost analysis */
+    economics: EconomicsAPI;
+    /** AI usage and analysis */
+    ai: AIAPI;
+    /** SBOM document management */
+    sbom: SBOMAPI;
+    /** Dashboard overview and metrics */
+    dashboard: DashboardAPI;
+    /** FinOps cost optimization */
+    finops: FinOpsAPI;
+    /** Marketplace templates */
+    marketplace: MarketplaceAPI;
+    /** API key management */
+    apiKeys: APIKeysAPI;
     /**
      * Create Aribot client
      *
@@ -544,4 +1053,4 @@ declare class ServerError extends AribotError {
     constructor(message: string, statusCode?: number, response?: Record<string, unknown>);
 }
 
-export { type AnalyzeDiagramOptions, Aribot, AribotError, type AribotOptions, AuthenticationError, type CloudAccount, type CloudFinding, type CloudScan, type CloudScanOptions, CloudSecurityAPI, ComplianceAPI, type ComplianceGap, type ComplianceResult, type ScanOptions$1 as ComplianceScanOptions, type ComplianceStandard, type Component, type Control, type CreateProjectOptions, type Diagram, type Finding, type GatesConfig, type GetFindingsOptions, type ListDiagramsOptions, type ListScansOptions, NotFoundError, PipelineAPI, type PipelineScan, type ScanOptions as PipelineScanOptions, type Project, RateLimitError, ServerError, type Threat, ThreatModelingAPI, ValidationError };
+export { AIAPI, type AIAnalysisResult, type AIModel, type AIQueueStatus, type AIQuota, type AIUsage, type APIKey, type APIKeyCreateResult, APIKeysAPI, type AnalyzeDiagramOptions, Aribot, AribotError, type AribotOptions, AuthenticationError, type CloudAccount, type CloudFinding, type CloudProvider, type CloudResource, type CloudScan, type CloudScanOptions, CloudSecurityAPI, ComplianceAPI, type ComplianceGap, type ComplianceResult, type ScanOptions$1 as ComplianceScanOptions, type ComplianceStandard, type Component, type ComponentCloudMapping, type ComponentCost, type Control, type CreateProjectOptions, DashboardAPI, type DashboardOverview, type Diagram, type DiagramComponentStatus, type DiagramCostAnalysis, DigitalTwinAPI, EconomicsAPI, type EconomicsDashboard, FinOpsAPI, type FinOpsCosts, type FinOpsOptimization, type FinOpsRecommendation, type Finding, type GatesConfig, type GetFindingsOptions, type ListDiagramsOptions, type ListScansOptions, type MarketIntelligence, MarketplaceAPI, type MarketplaceCategory, type MarketplaceTemplate, NotFoundError, PipelineAPI, type PipelineScan, type ScanOptions as PipelineScanOptions, type Project, RateLimitError, type RecentActivity, RedTeamAPI, type RedTeamMethodology, type RedTeamSimulation, type RiskSummary, SBOMAPI, type SBOMDocument, type SBOMVulnerability, ServerError, type Threat, type ThreatIntelligence, ThreatModelingAPI, ValidationError };