@attesso/types 1.0.2 → 1.0.4

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://www.attesso.com
+- Support: info@attesso.com
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 export * from './enclave.js';
 export * from './mandate.js';
+export * from './mandate-request.js';
 export * from './passport.js';
 export * from './payment.js';
 export * from './user.js';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC"}

package/dist/index.js

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./enclave.js"), exports);
 __exportStar(require("./mandate.js"), exports);
+__exportStar(require("./mandate-request.js"), exports);
 __exportStar(require("./passport.js"), exports);
 __exportStar(require("./payment.js"), exports);
 __exportStar(require("./user.js"), exports);

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B;AAC7B,+CAA6B;AAC7B,gDAA8B;AAC9B,+CAA6B;AAC7B,4CAA0B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B;AAC7B,+CAA6B;AAC7B,uDAAqC;AACrC,gDAA8B;AAC9B,+CAA6B;AAC7B,4CAA0B"}

package/dist/mandate-request.d.ts

@@ -0,0 +1,96 @@
+/**
+ * Mandate Request Types
+ *
+ * Types for the asynchronous mandate request flow where agents
+ * create requests and users approve via link.
+ */
+export type MandateRequestStatus = 'pending' | 'approved' | 'expired' | 'rejected' | 'cancelled';
+/**
+ * Request body for creating a mandate request.
+ */
+export interface CreateMandateRequestInput {
+    /** Maximum spend in cents */
+    maxAmount: number;
+    /** ISO 4217 currency code (default: "USD") */
+    currency?: string;
+    /** Category for the spending (e.g., "travel", "shopping") */
+    category?: string;
+    /** Restrict to specific merchant */
+    merchant?: string;
+    /** Duration the mandate is valid after approval (e.g., "24h", "7d") */
+    validityWindow: string;
+    /** How long before the approval link expires (default: "1h") */
+    requestExpiresIn?: string;
+    /** Webhook URL to notify when status changes */
+    callbackUrl?: string;
+    /** Pass-through metadata */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Response from creating a mandate request.
+ */
+export interface CreateMandateRequestResponse {
+    /** Unique request ID */
+    id: string;
+    /** URL to send to the user for approval */
+    approvalUrl: string;
+    /** When the approval link expires */
+    expiresAt: string;
+    /** Current status */
+    status: MandateRequestStatus;
+    /** Secret for verifying webhook payloads (only returned on creation) */
+    callbackSecret?: string;
+}
+/**
+ * Mandate details included when a request is approved.
+ */
+export interface ApprovedMandateDetails {
+    id: string;
+    maxAmount: number;
+    currency: string;
+    merchant: string | null;
+    expiresAt: string | null;
+    status: string;
+}
+/**
+ * Full mandate request details when polling.
+ */
+export interface MandateRequestDetails {
+    id: string;
+    status: MandateRequestStatus;
+    maxAmount: number;
+    currency: string;
+    category: string | null;
+    merchant: string | null;
+    validityWindow: string;
+    expiresAt: string;
+    createdAt: string;
+    approvedAt?: string;
+    rejectedAt?: string;
+    metadata: Record<string, unknown> | null;
+    /** Mandate details if approved */
+    mandate?: ApprovedMandateDetails;
+}
+/**
+ * Webhook event types for mandate requests.
+ */
+export type MandateRequestEventType = 'mandate_request.approved' | 'mandate_request.rejected' | 'mandate_request.expired' | 'mandate_request.cancelled';
+/**
+ * Webhook payload for mandate request events.
+ */
+export interface MandateRequestWebhookPayload {
+    event: MandateRequestEventType;
+    timestamp: string;
+    data: {
+        requestId: string;
+        mandateId?: string;
+        status: string;
+        maxAmount: number;
+        currency: string;
+        category?: string;
+        merchant?: string;
+        expiresAt?: string;
+        metadata?: unknown;
+    };
+}
+//# sourceMappingURL=mandate-request.d.ts.map

package/dist/mandate-request.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mandate-request.d.ts","sourceRoot":"","sources":["../src/mandate-request.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,MAAM,oBAAoB,GAC5B,SAAS,GACT,UAAU,GACV,SAAS,GACT,UAAU,GACV,WAAW,CAAC;AAEhB;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,6BAA6B;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,8CAA8C;IAC9C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,6DAA6D;IAC7D,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oCAAoC;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,uEAAuE;IACvE,cAAc,EAAE,MAAM,CAAC;IACvB,gEAAgE;IAChE,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,gDAAgD;IAChD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,4BAA4B;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,wBAAwB;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,2CAA2C;IAC3C,WAAW,EAAE,MAAM,CAAC;IACpB,qCAAqC;IACrC,SAAS,EAAE,MAAM,CAAC;IAClB,qBAAqB;IACrB,MAAM,EAAE,oBAAoB,CAAC;IAC7B,wEAAwE;IACxE,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,oBAAoB,CAAC;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IACzC,kCAAkC;IAClC,OAAO,CAAC,EAAE,sBAAsB,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAC/B,0BAA0B,GAC1B,0BAA0B,GAC1B,yBAAyB,GACzB,2BAA2B,CAAC;AAEhC;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,KAAK,EAAE,uBAAuB,CAAC;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE;QACJ,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,MAAM,EAAE,MAAM,CAAC;QACf,SAAS,EAAE,MAAM,CAAC;QAClB,QAAQ,EAAE,MAAM,CAAC;QACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;KACpB,CAAC;CACH"}

package/dist/mandate-request.js

@@ -0,0 +1,9 @@
+"use strict";
+/**
+ * Mandate Request Types
+ *
+ * Types for the asynchronous mandate request flow where agents
+ * create requests and users approve via link.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=mandate-request.js.map

package/dist/mandate-request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mandate-request.js","sourceRoot":"","sources":["../src/mandate-request.ts"],"names":[],"mappings":";AAAA;;;;;GAKG"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@attesso/types",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "TypeScript types for Attesso SDK - Mandate, Payment, Passport, User types",
   "author": "Attesso",
   "license": "MIT",