@aigrc/core 0.1.0

package/dist/index.d.mts

@@ -0,0 +1,226 @@
+import { RiskFactors, Trustworthiness, AssetCard, JurisdictionClassification, Intent, Technical } from './schemas/index.mjs';
+export { ApprovalSchema, AssetCardSchema, Classification, ClassificationSchema, Constraints, ConstraintsSchema, ControlStatus, ControlStatusSchema, Governance, GovernanceSchema, IntentSchema, JurisdictionClassificationSchema, Owner, OwnerSchema, RiskFactorsSchema, TechnicalSchema, TrustworthinessCharacteristic, TrustworthinessCharacteristicSchema, TrustworthinessSchema } from './schemas/index.mjs';
+import { z } from 'zod';
+
+type RiskLevel = "minimal" | "limited" | "high" | "unacceptable";
+interface ClassificationResult {
+    riskLevel: RiskLevel;
+    reasons: string[];
+    euAiActCategory: string;
+    requiredArtifacts: string[];
+}
+declare function classifyRisk(factors: RiskFactors): ClassificationResult;
+declare function validateRiskFactors(factors: RiskFactors): boolean;
+
+interface CreateAssetCardOptions {
+    name: string;
+    description?: string;
+    owner: {
+        name: string;
+        email: string;
+        team?: string;
+    };
+    technical: {
+        type: "model" | "agent" | "api_client" | "framework" | "pipeline";
+        framework?: string;
+        frameworkVersion?: string;
+    };
+    riskFactors?: {
+        autonomousDecisions?: boolean;
+        customerFacing?: boolean;
+        toolExecution?: boolean;
+        externalDataAccess?: boolean;
+        piiProcessing?: "yes" | "no" | "unknown";
+        highStakesDecisions?: boolean;
+    };
+    /** Jurisdiction/profile IDs to track compliance against */
+    jurisdictions?: string[];
+    /** Initial trustworthiness characteristics */
+    trustworthiness?: Partial<Trustworthiness>;
+}
+declare function generateAssetId(): string;
+declare function createAssetCard(options: CreateAssetCardOptions): AssetCard;
+/**
+ * Add or update jurisdiction tracking on an existing asset card
+ */
+declare function addJurisdiction(card: AssetCard, jurisdictionId: string, riskLevel?: string): AssetCard;
+/**
+ * Update jurisdiction classification with compliance check results
+ */
+declare function updateJurisdictionCompliance(card: AssetCard, jurisdictionId: string, update: Partial<JurisdictionClassification>): AssetCard;
+declare function loadAssetCard(filePath: string): AssetCard;
+declare function saveAssetCard(card: AssetCard, filePath: string): void;
+declare function validateAssetCard(card: unknown): {
+    valid: boolean;
+    errors?: string[];
+};
+
+interface TicketInfo {
+    system: "jira" | "ado" | "github" | "gitlab";
+    id: string;
+    url: string;
+    title: string;
+    status: string;
+    assignee?: string;
+    reporter?: string;
+    businessJustification?: string;
+    riskTolerance?: "low" | "medium" | "high";
+}
+interface LinkResult {
+    success: boolean;
+    intent: Intent;
+    warnings?: string[];
+}
+declare function linkAssetToTicket(asset: AssetCard, ticket: TicketInfo): LinkResult;
+declare function validateGoldenThread(asset: AssetCard): {
+    valid: boolean;
+    healthScore: number;
+    issues: string[];
+};
+
+declare const ConfidenceLevelSchema: z.ZodEnum<["high", "medium", "low"]>;
+type ConfidenceLevel = z.infer<typeof ConfidenceLevelSchema>;
+declare const DetectionStrategySchema: z.ZodEnum<["pattern_match", "import_analysis", "file_extension", "annotation"]>;
+type DetectionStrategy = z.infer<typeof DetectionStrategySchema>;
+declare const FrameworkCategorySchema: z.ZodEnum<["llm_provider", "framework", "agent_framework", "ml_framework", "ml_ops", "model_file"]>;
+type FrameworkCategory = z.infer<typeof FrameworkCategorySchema>;
+interface RiskImplication {
+    factor: keyof RiskFactors;
+    value: boolean | "yes" | "no" | "unknown";
+    reason: string;
+}
+type PatternRuleType = "regex" | "literal" | "import" | "decorator";
+type PatternLanguage = "python" | "javascript" | "typescript" | "any";
+interface PatternRule {
+    type: PatternRuleType;
+    pattern: string;
+    confidence: ConfidenceLevel;
+    description?: string;
+}
+interface PatternDefinition {
+    id: string;
+    name: string;
+    category: FrameworkCategory;
+    language: PatternLanguage;
+    patterns: PatternRule[];
+    implies: RiskImplication[];
+    version?: string;
+    documentation?: string;
+}
+interface DetectionResult {
+    filePath: string;
+    line: number;
+    column?: number;
+    match: string;
+    matchContext?: string;
+    registryCard: string;
+    framework: string;
+    category: FrameworkCategory;
+    confidence: ConfidenceLevel;
+    strategy: DetectionStrategy;
+    implies: RiskImplication[];
+    metadata?: Record<string, unknown>;
+}
+interface ScanOptions {
+    directory: string;
+    recursive?: boolean;
+    extensions?: string[];
+    ignorePatterns?: string[];
+    strategies?: DetectionStrategy[];
+    maxFileSize?: number;
+    maxFiles?: number;
+    earlyExit?: boolean;
+    respectGitignore?: boolean;
+    customPatterns?: PatternDefinition[];
+}
+interface ScanProgress {
+    totalFiles: number;
+    scannedFiles: number;
+    currentFile: string;
+    detections: number;
+}
+type ScanProgressCallback = (progress: ScanProgress) => void;
+interface ScanSummary {
+    totalDetections: number;
+    byFramework: Record<string, number>;
+    byCategory: Record<FrameworkCategory, number>;
+    byConfidence: Record<ConfidenceLevel, number>;
+    primaryFramework?: string;
+    primaryCategory?: FrameworkCategory;
+}
+interface ScanError {
+    filePath: string;
+    error: string;
+    recoverable: boolean;
+}
+interface ScanResult {
+    detections: DetectionResult[];
+    summary: ScanSummary;
+    inferredRiskFactors: Partial<RiskFactors>;
+    suggestedTechnical: Partial<Technical>;
+    scannedFiles: number;
+    skippedFiles: number;
+    duration: number;
+    errors?: ScanError[];
+}
+interface AssetCardSuggestion {
+    name: string;
+    description: string;
+    technical: {
+        type: Technical["type"];
+        framework: string;
+        components: Array<{
+            type: string;
+            provider?: string;
+            model?: string;
+        }>;
+        sourceFiles: string[];
+    };
+    riskFactors: Partial<RiskFactors>;
+    confidence: ConfidenceLevel;
+    basedOn: string[];
+}
+
+declare function scan(options: ScanOptions, onProgress?: ScanProgressCallback): Promise<ScanResult>;
+declare function scanSync(options: ScanOptions, onProgress?: ScanProgressCallback): ScanResult;
+
+declare function inferRiskFactors(detections: DetectionResult[]): Partial<RiskFactors>;
+declare function applyImplicationChains(detections: DetectionResult[]): DetectionResult[];
+
+declare function suggestAssetCard(scanResult: ScanResult): AssetCardSuggestion;
+
+declare function registerPattern(pattern: PatternDefinition): void;
+declare function getPattern(id: string): PatternDefinition | undefined;
+declare function getAllPatterns(): PatternDefinition[];
+declare function getPatternsByCategory(category: FrameworkCategory): PatternDefinition[];
+declare function getPatternsByLanguage(language: PatternLanguage): PatternDefinition[];
+declare function clearRegistry(): void;
+declare function isRegistryInitialized(): boolean;
+declare function createImplication(factor: RiskImplication["factor"], value: RiskImplication["value"], reason: string): RiskImplication;
+
+declare const pythonPatterns: PatternDefinition[];
+
+declare const javascriptPatterns: PatternDefinition[];
+
+declare const modelFilePatterns: PatternDefinition[];
+
+declare const riskIndicatorPatterns: PatternDefinition[];
+
+declare function initializePatterns(): void;
+declare function resetPatterns(): void;
+
+declare function matchPatterns(filePath: string, lines: string[], patterns: PatternDefinition[]): DetectionResult[];
+
+declare function analyzeImports(filePath: string, content: string, patterns: PatternDefinition[]): DetectionResult[];
+
+declare function scanFileExtension(filePath: string): DetectionResult[];
+declare const MODEL_EXTENSIONS: string[];
+declare function isModelFile(filePath: string): boolean;
+
+declare function detectAnnotations(filePath: string, lines: string[], patterns: PatternDefinition[]): DetectionResult[];
+
+declare function formatDate(date: Date): string;
+declare function parseDate(dateString: string): Date;
+declare function slugify(text: string): string;
+
+export { AssetCard, type AssetCardSuggestion, type ClassificationResult, type ConfidenceLevel, ConfidenceLevelSchema, type CreateAssetCardOptions, type DetectionResult, type DetectionStrategy, DetectionStrategySchema, type FrameworkCategory, FrameworkCategorySchema, Intent, JurisdictionClassification, type LinkResult, MODEL_EXTENSIONS, type PatternDefinition, type PatternLanguage, type PatternRule, type PatternRuleType, RiskFactors, type RiskImplication, type RiskLevel, type ScanError, type ScanOptions, type ScanProgress, type ScanProgressCallback, type ScanResult, type ScanSummary, Technical, type TicketInfo, Trustworthiness, addJurisdiction, analyzeImports, applyImplicationChains, classifyRisk, clearRegistry, createAssetCard, createImplication, detectAnnotations, formatDate, generateAssetId, getAllPatterns, getPattern, getPatternsByCategory, getPatternsByLanguage, inferRiskFactors, initializePatterns, isModelFile, isRegistryInitialized, javascriptPatterns, linkAssetToTicket, loadAssetCard, matchPatterns, modelFilePatterns, parseDate, pythonPatterns, registerPattern, resetPatterns, riskIndicatorPatterns, saveAssetCard, scan, scanFileExtension, scanSync, slugify, suggestAssetCard, updateJurisdictionCompliance, validateAssetCard, validateGoldenThread, validateRiskFactors };

package/dist/index.d.ts

@@ -0,0 +1,226 @@
+import { RiskFactors, Trustworthiness, AssetCard, JurisdictionClassification, Intent, Technical } from './schemas/index.js';
+export { ApprovalSchema, AssetCardSchema, Classification, ClassificationSchema, Constraints, ConstraintsSchema, ControlStatus, ControlStatusSchema, Governance, GovernanceSchema, IntentSchema, JurisdictionClassificationSchema, Owner, OwnerSchema, RiskFactorsSchema, TechnicalSchema, TrustworthinessCharacteristic, TrustworthinessCharacteristicSchema, TrustworthinessSchema } from './schemas/index.js';
+import { z } from 'zod';
+
+type RiskLevel = "minimal" | "limited" | "high" | "unacceptable";
+interface ClassificationResult {
+    riskLevel: RiskLevel;
+    reasons: string[];
+    euAiActCategory: string;
+    requiredArtifacts: string[];
+}
+declare function classifyRisk(factors: RiskFactors): ClassificationResult;
+declare function validateRiskFactors(factors: RiskFactors): boolean;
+
+interface CreateAssetCardOptions {
+    name: string;
+    description?: string;
+    owner: {
+        name: string;
+        email: string;
+        team?: string;
+    };
+    technical: {
+        type: "model" | "agent" | "api_client" | "framework" | "pipeline";
+        framework?: string;
+        frameworkVersion?: string;
+    };
+    riskFactors?: {
+        autonomousDecisions?: boolean;
+        customerFacing?: boolean;
+        toolExecution?: boolean;
+        externalDataAccess?: boolean;
+        piiProcessing?: "yes" | "no" | "unknown";
+        highStakesDecisions?: boolean;
+    };
+    /** Jurisdiction/profile IDs to track compliance against */
+    jurisdictions?: string[];
+    /** Initial trustworthiness characteristics */
+    trustworthiness?: Partial<Trustworthiness>;
+}
+declare function generateAssetId(): string;
+declare function createAssetCard(options: CreateAssetCardOptions): AssetCard;
+/**
+ * Add or update jurisdiction tracking on an existing asset card
+ */
+declare function addJurisdiction(card: AssetCard, jurisdictionId: string, riskLevel?: string): AssetCard;
+/**
+ * Update jurisdiction classification with compliance check results
+ */
+declare function updateJurisdictionCompliance(card: AssetCard, jurisdictionId: string, update: Partial<JurisdictionClassification>): AssetCard;
+declare function loadAssetCard(filePath: string): AssetCard;
+declare function saveAssetCard(card: AssetCard, filePath: string): void;
+declare function validateAssetCard(card: unknown): {
+    valid: boolean;
+    errors?: string[];
+};
+
+interface TicketInfo {
+    system: "jira" | "ado" | "github" | "gitlab";
+    id: string;
+    url: string;
+    title: string;
+    status: string;
+    assignee?: string;
+    reporter?: string;
+    businessJustification?: string;
+    riskTolerance?: "low" | "medium" | "high";
+}
+interface LinkResult {
+    success: boolean;
+    intent: Intent;
+    warnings?: string[];
+}
+declare function linkAssetToTicket(asset: AssetCard, ticket: TicketInfo): LinkResult;
+declare function validateGoldenThread(asset: AssetCard): {
+    valid: boolean;
+    healthScore: number;
+    issues: string[];
+};
+
+declare const ConfidenceLevelSchema: z.ZodEnum<["high", "medium", "low"]>;
+type ConfidenceLevel = z.infer<typeof ConfidenceLevelSchema>;
+declare const DetectionStrategySchema: z.ZodEnum<["pattern_match", "import_analysis", "file_extension", "annotation"]>;
+type DetectionStrategy = z.infer<typeof DetectionStrategySchema>;
+declare const FrameworkCategorySchema: z.ZodEnum<["llm_provider", "framework", "agent_framework", "ml_framework", "ml_ops", "model_file"]>;
+type FrameworkCategory = z.infer<typeof FrameworkCategorySchema>;
+interface RiskImplication {
+    factor: keyof RiskFactors;
+    value: boolean | "yes" | "no" | "unknown";
+    reason: string;
+}
+type PatternRuleType = "regex" | "literal" | "import" | "decorator";
+type PatternLanguage = "python" | "javascript" | "typescript" | "any";
+interface PatternRule {
+    type: PatternRuleType;
+    pattern: string;
+    confidence: ConfidenceLevel;
+    description?: string;
+}
+interface PatternDefinition {
+    id: string;
+    name: string;
+    category: FrameworkCategory;
+    language: PatternLanguage;
+    patterns: PatternRule[];
+    implies: RiskImplication[];
+    version?: string;
+    documentation?: string;
+}
+interface DetectionResult {
+    filePath: string;
+    line: number;
+    column?: number;
+    match: string;
+    matchContext?: string;
+    registryCard: string;
+    framework: string;
+    category: FrameworkCategory;
+    confidence: ConfidenceLevel;
+    strategy: DetectionStrategy;
+    implies: RiskImplication[];
+    metadata?: Record<string, unknown>;
+}
+interface ScanOptions {
+    directory: string;
+    recursive?: boolean;
+    extensions?: string[];
+    ignorePatterns?: string[];
+    strategies?: DetectionStrategy[];
+    maxFileSize?: number;
+    maxFiles?: number;
+    earlyExit?: boolean;
+    respectGitignore?: boolean;
+    customPatterns?: PatternDefinition[];
+}
+interface ScanProgress {
+    totalFiles: number;
+    scannedFiles: number;
+    currentFile: string;
+    detections: number;
+}
+type ScanProgressCallback = (progress: ScanProgress) => void;
+interface ScanSummary {
+    totalDetections: number;
+    byFramework: Record<string, number>;
+    byCategory: Record<FrameworkCategory, number>;
+    byConfidence: Record<ConfidenceLevel, number>;
+    primaryFramework?: string;
+    primaryCategory?: FrameworkCategory;
+}
+interface ScanError {
+    filePath: string;
+    error: string;
+    recoverable: boolean;
+}
+interface ScanResult {
+    detections: DetectionResult[];
+    summary: ScanSummary;
+    inferredRiskFactors: Partial<RiskFactors>;
+    suggestedTechnical: Partial<Technical>;
+    scannedFiles: number;
+    skippedFiles: number;
+    duration: number;
+    errors?: ScanError[];
+}
+interface AssetCardSuggestion {
+    name: string;
+    description: string;
+    technical: {
+        type: Technical["type"];
+        framework: string;
+        components: Array<{
+            type: string;
+            provider?: string;
+            model?: string;
+        }>;
+        sourceFiles: string[];
+    };
+    riskFactors: Partial<RiskFactors>;
+    confidence: ConfidenceLevel;
+    basedOn: string[];
+}
+
+declare function scan(options: ScanOptions, onProgress?: ScanProgressCallback): Promise<ScanResult>;
+declare function scanSync(options: ScanOptions, onProgress?: ScanProgressCallback): ScanResult;
+
+declare function inferRiskFactors(detections: DetectionResult[]): Partial<RiskFactors>;
+declare function applyImplicationChains(detections: DetectionResult[]): DetectionResult[];
+
+declare function suggestAssetCard(scanResult: ScanResult): AssetCardSuggestion;
+
+declare function registerPattern(pattern: PatternDefinition): void;
+declare function getPattern(id: string): PatternDefinition | undefined;
+declare function getAllPatterns(): PatternDefinition[];
+declare function getPatternsByCategory(category: FrameworkCategory): PatternDefinition[];
+declare function getPatternsByLanguage(language: PatternLanguage): PatternDefinition[];
+declare function clearRegistry(): void;
+declare function isRegistryInitialized(): boolean;
+declare function createImplication(factor: RiskImplication["factor"], value: RiskImplication["value"], reason: string): RiskImplication;
+
+declare const pythonPatterns: PatternDefinition[];
+
+declare const javascriptPatterns: PatternDefinition[];
+
+declare const modelFilePatterns: PatternDefinition[];
+
+declare const riskIndicatorPatterns: PatternDefinition[];
+
+declare function initializePatterns(): void;
+declare function resetPatterns(): void;
+
+declare function matchPatterns(filePath: string, lines: string[], patterns: PatternDefinition[]): DetectionResult[];
+
+declare function analyzeImports(filePath: string, content: string, patterns: PatternDefinition[]): DetectionResult[];
+
+declare function scanFileExtension(filePath: string): DetectionResult[];
+declare const MODEL_EXTENSIONS: string[];
+declare function isModelFile(filePath: string): boolean;
+
+declare function detectAnnotations(filePath: string, lines: string[], patterns: PatternDefinition[]): DetectionResult[];
+
+declare function formatDate(date: Date): string;
+declare function parseDate(dateString: string): Date;
+declare function slugify(text: string): string;
+
+export { AssetCard, type AssetCardSuggestion, type ClassificationResult, type ConfidenceLevel, ConfidenceLevelSchema, type CreateAssetCardOptions, type DetectionResult, type DetectionStrategy, DetectionStrategySchema, type FrameworkCategory, FrameworkCategorySchema, Intent, JurisdictionClassification, type LinkResult, MODEL_EXTENSIONS, type PatternDefinition, type PatternLanguage, type PatternRule, type PatternRuleType, RiskFactors, type RiskImplication, type RiskLevel, type ScanError, type ScanOptions, type ScanProgress, type ScanProgressCallback, type ScanResult, type ScanSummary, Technical, type TicketInfo, Trustworthiness, addJurisdiction, analyzeImports, applyImplicationChains, classifyRisk, clearRegistry, createAssetCard, createImplication, detectAnnotations, formatDate, generateAssetId, getAllPatterns, getPattern, getPatternsByCategory, getPatternsByLanguage, inferRiskFactors, initializePatterns, isModelFile, isRegistryInitialized, javascriptPatterns, linkAssetToTicket, loadAssetCard, matchPatterns, modelFilePatterns, parseDate, pythonPatterns, registerPattern, resetPatterns, riskIndicatorPatterns, saveAssetCard, scan, scanFileExtension, scanSync, slugify, suggestAssetCard, updateJurisdictionCompliance, validateAssetCard, validateGoldenThread, validateRiskFactors };