@surfinguard/types
v1.0.0
Published
Shared TypeScript type definitions for the Surfinguard AI Security SDK
Maintainers
Readme
@surfinguard/types
Shared TypeScript type definitions for the Surfinguard AI Security SDK.
Installation
npm install @surfinguard/typesNote: Most users should install
@surfinguard/sdkinstead, which re-exports all types.
Exports
Action Types
ActionType—'url' | 'command' | 'text' | 'file_read' | 'file_write'ActionInput— Input payload for an action checkActionContext— Optional metadata context
Verdict Types
RiskPrimitive—'DESTRUCTION' | 'EXFILTRATION' | 'ESCALATION' | 'PERSISTENCE' | 'MANIPULATION'RiskLevel—'SAFE' | 'CAUTION' | 'DANGER'PrimitiveScore— Per-primitive score breakdownCheckResult— Full result of a security check
Policy Types
PolicyLevel—'permissive' | 'moderate' | 'strict'PolicyRule,Policy
Pattern Database Interfaces
ThreatDefinition,UrlPatternDatabase,BrandEntry,BrandPatternDatabaseCommandPatternDatabase,TextPatternDatabaseSensitivePathEntry,FileReadPatternDatabaseFileWritePathEntry,ContentPatternEntry,FileWritePatternDatabase
License
MIT
