# Sylphx
> Platform as a Service (PaaS) for TypeScript developers.

Sylphx bundles 16 managed services into one SDK (@sylphx/sdk), so you can ship production apps without stitching together dozens of third-party providers.

## Managed Services

1. **Auth** — User authentication (email/password, passkeys, 2FA, OAuth)
2. **Email** — Transactional email and newsletters
3. **Billing** — Subscription management, checkout, and usage metering
4. **AI Gateway** — Unified access to AI models with rate limiting and usage tracking
5. **Storage** — File uploads with presigned URLs and CDN delivery
6. **Analytics** — Event tracking, querying, and GDPR-compliant data erasure
7. **Push** — Web and mobile push notifications
8. **Jobs** — Background jobs, cron scheduling, and retries
9. **Monitoring** — Error tracking, exception reporting, and alerting
10. **Webhooks** — Outbound webhook delivery with replay and statistics
11. **Feature Flags** — Server-side and client-side feature flag evaluation
12. **Privacy** — Consent management and GDPR compliance
13. **Referrals** — Referral codes, redemption, and leaderboards
14. **SAML** — Enterprise single sign-on
15. **Session Replay** — User session recording and playback
16. **Database** — Managed PostgreSQL with KV, search, and sorted sets

## Quick Start

Install the SDK:
npm install @sylphx/sdk

Initialize in your app:
import { Sylphx } from '@sylphx/sdk'
const sylphx = new Sylphx({ appId: 'app_...', secretKey: 'sk_...' })

## Authentication

All API requests require the x-app-secret header:
- App ID (app_*): Client-side operations (analytics, feature flags, auth)
- Secret Key (sk_*): Server-side operations (jobs, storage, deploy)

## ID Format

All resource IDs use a prefixed base58 format: {prefix}_{base58}

Examples:
- Organization: org_3Zb83qVQxkHMJPZ8VrJfQ2
- Project: proj_3Zb83qVQxkHMJPZ8VrJfQ2
- Environment: env_3Zb83qVQxkHMJPZ8VrJfQ2
- User: user_3Zb83qVQxkHMJPZ8VrJfQ2
- API Key: sk_3Zb83qVQxkHMJPZ8VrJfQ2

The API accepts both prefixed IDs and raw UUIDs as inputs.
JWT sub claims use raw UUID (OAuth/OIDC spec compliance).
JWT pid claims (if present) contain the prefixed user ID (user_xxx) for convenience.

## API

- Base URL: https://sylphx.com/api/sdk/v1
- OpenAPI Spec: https://sylphx.com/api/sdk/v1/openapi.json

## Links

- Website: https://sylphx.com
- Console: https://sylphx.com/console
- Documentation: https://sylphx.com/docs
- SDK: @sylphx/sdk on npm
- GitHub: https://github.com/SylphxAI/platform