@attesso/types 1.0.1 → 1.0.3

package/README.md

@@ -0,0 +1,165 @@
+# @attesso/types
+
+TypeScript type definitions for the Attesso SDK ecosystem.
+
+```bash
+npm install @attesso/types
+```
+
+## Overview
+
+This package provides shared TypeScript types used across all Attesso packages. It has zero runtime dependencies - types are compile-time only.
+
+## Core Types
+
+### Mandates
+
+```typescript
+import type { Mandate, MandateResponse, CreateMandateRequest, MandateStatus } from '@attesso/types';
+
+// MandateStatus: 'active' | 'revoked' | 'expired'
+const mandate: MandateResponse = {
+  id: 'mandate_xyz',
+  botId: 'travel-agent-v1',
+  maxAmount: 50000, // cents
+  currency: 'USD',
+  merchant: 'United Airlines',
+  status: 'active',
+  createdAt: '2024-01-15T10:00:00Z',
+};
+```
+
+### Payments
+
+```typescript
+import type {
+  Payment,
+  PaymentResponse,
+  PaymentStatus,
+  PaymentErrorCode,
+  AuthorizePaymentRequest,
+  CapturePaymentRequest,
+  CapturePaymentResponse,
+  CancelAuthorizationResponse,
+} from '@attesso/types';
+
+// PaymentStatus: 'pending' | 'processing' | 'authorized' | 'completed' | 'failed' | 'cancelled'
+// PaymentErrorCode: 'MANDATE_NOT_FOUND' | 'AMOUNT_EXCEEDS_LIMIT' | 'MERCHANT_MISMATCH' | ...
+```
+
+### Passports
+
+```typescript
+import type {
+  PassportPayload,
+  PassportToken,
+  VerifyPassportResult,
+  EnhancedPassportPayload,
+  PassportReputation,
+  ReputationTier,
+} from '@attesso/types';
+
+// ReputationTier: 'verified_partner' | 'standard' | 'probationary'
+const passport: PassportPayload = {
+  sub: 'user_123',
+  bot: 'travel-agent-v1',
+  mandate: 'mandate_xyz',
+  maxSpend: 50000,
+  merchant: 'United Airlines',
+  iat: 1705312800,
+  exp: 1705316400,
+};
+```
+
+### Users
+
+```typescript
+import type {
+  User,
+  BankAccount,
+  AuthChallengeRequest,
+  AuthChallengeResponse,
+  AuthTokenResponse,
+} from '@attesso/types';
+```
+
+### Fee Calculation
+
+```typescript
+import type {
+  RegionalFeeStructure,
+  RegionalFees,
+  InclusiveFeeConfig,
+  FeeBreakdown,
+  InclusiveFeeResult,
+} from '@attesso/types';
+
+import { STRIPE_REGIONAL_FEES } from '@attesso/types';
+
+// Pre-configured regional fees
+console.log(STRIPE_REGIONAL_FEES.EEA); // { variablePercent: 1.5, fixedCents: 25, currency: 'EUR' }
+console.log(STRIPE_REGIONAL_FEES.US);  // { variablePercent: 2.9, fixedCents: 30, currency: 'USD' }
+console.log(STRIPE_REGIONAL_FEES.UK);  // { variablePercent: 1.5, fixedCents: 20, currency: 'GBP' }
+```
+
+## Circuit Breaker Types
+
+Types for the bot passport circuit breaker system:
+
+```typescript
+import type {
+  CircuitBreakerStatus,
+  RevocationReason,
+  AnomalyPattern,
+  AnomalySeverity,
+  PenaltyTier,
+  GRLCheckResult,
+  AnomalyDetectionResult,
+} from '@attesso/types';
+
+import { PENALTY_SCHEDULE, TRIPWIRE_THRESHOLDS } from '@attesso/types';
+
+// CircuitBreakerStatus: 'green' | 'yellow' | 'red'
+// AnomalyPattern: 'shotgun' | 'probe' | 'zombie' | 'excessive_errors'
+```
+
+## Cloud TEE Types
+
+Types for AWS Nitro and GCP Confidential Computing attestation:
+
+```typescript
+import type {
+  CloudTEEPlatform,
+  NitroAttestationDocument,
+  GCPAttestationClaims,
+  CloudTEEVerificationResult,
+  DeviceAttestation,
+  EnclaveImageData,
+  FleetMandateRequest,
+} from '@attesso/types';
+
+// CloudTEEPlatform: 'aws_nitro' | 'gcp_confidential_vm' | 'gcp_confidential_space'
+```
+
+## Package Compatibility
+
+This package is used by:
+
+- `@attesso/sdk` - Client SDK
+- `@attesso/gatekeeper` - Server-side verification
+- `@attesso/rails` - Payment processing
+- `@attesso/react-native-sdk` - Mobile SDK
+- `vercel-ai-attesso` - Vercel AI SDK integration
+
+## Requirements
+
+- TypeScript 5.0+
+
+## Links
+
+- Website: https://attesso.com
+- Support: info@attesso.com
+
+## License
+
+MIT

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@attesso/types",
-  "version": "1.0.1",
-  "description": "TypeScript types for Attesso financial infrastructure - mandates, passports, and payments",
+  "version": "1.0.3",
+  "description": "TypeScript types for Attesso SDK - Mandate, Payment, Passport, User types",
   "author": "Attesso",
   "license": "MIT",
   "repository": {