Secured

API Surface

Complete export surface for @secured-ai/react, including core re-exports.

@secured-ai/react is more than hooks. It also re-exports a useful slice of @secured-ai/core, so many applications can stay on a single import boundary.

React-native exports

Components

  • SecuredProvider
  • SecuredProviderProps

Hooks

  • usePrivacyClient
  • usePrivacyStatus
  • useDetect
  • useScan
  • useObfuscate
  • useRestore
  • useSessions
  • useTextReview
  • useFileDetect
  • useFileObfuscate
  • useVault

Hook return and option types

  • UseDetectReturn
  • UseVaultReturn
  • UseScanOptions
  • UseScanReturn
  • UseObfuscateReturn
  • UseTextReviewReturn
  • UseRestoreReturn
  • UseSessionsReturn
  • UseFileDetectReturn
  • UseFileObfuscateReturn

Core class re-exports

These are re-exported so consumers do not always need a separate @secured-ai/core import:

  • PrivacyClient
  • VaultManager

Core constant and helper re-exports

Entity helpers

  • ENTITY_TYPES

String matching

  • StringMatcher
  • defaultStringMatcher
  • strictStringMatcher
  • lenientStringMatcher

Entity storage and vault helpers

  • DefaultVaultRepository
  • MemoryVaultCache
  • LocalStorageVaultCache
  • SessionStorageVaultCache
  • IndexedDbVaultCache
  • WebCryptoVaultCrypto
  • canonicalizeVaultEntityType
  • normalizeVaultEntryKey
  • vaultEntityTypesMatch
  • vaultEntryMatchesEntity
  • deobfuscateWithVaultEntries

Re-exported core types

@secured-ai/react also re-exports the main core types, including:

  • entity types such as EntityType, SensitiveEntity, ExtendedSensitiveEntity, DetectionSource
  • result types such as PrivacyScanResult, ObfuscationResult, RestorationResult, FileProcessingResult
  • session and review types such as PrivacySession, SerializedPrivacySession, SessionMapping, TextReview, TextReviewItem, FinalizedTextReview
  • config and vault types such as PrivacyClientConfig, PrivacyVaultConfig, EngineConfig, DefaultVaultRepositoryOptions, VaultEntry, VaultSnapshotState, VaultStatus, VaultResolveOptions
  • string matcher types such as MatchConfig and MatchResult

If you want the complete shape details, see the core docs:

When to import from @secured-ai/react vs @secured-ai/core

Import from @secured-ai/react when:

  • your code already depends on the React package
  • you want one import boundary in UI code
  • you need both hooks and core helpers in the same file

Import from @secured-ai/core when:

  • you are writing framework-agnostic code
  • the code runs outside React
  • you want the narrower dependency boundary

On this page