@alien_org/sso-sdk-core 1.0.16 → 1.0.18
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +87 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
# @alien_org/sso-sdk-core
|
|
2
|
+
|
|
3
|
+
Core TypeScript client for [Alien SSO](https://alien.org) authentication. Provides OIDC-compatible authentication with blockchain and TEE backing.
|
|
4
|
+
|
|
5
|
+
## ⚠️ Alpha Version Notice
|
|
6
|
+
|
|
7
|
+
**This is an early alpha version.** The SDK is under active development and may contain bugs or undergo breaking changes. Use with caution in production environments.
|
|
8
|
+
|
|
9
|
+
## Installation
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm install @alien_org/sso-sdk-core
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Features
|
|
16
|
+
|
|
17
|
+
- ✅ **TypeScript-first** with full type safety
|
|
18
|
+
- ✅ **Runtime validation** via Zod schemas
|
|
19
|
+
- ✅ **PKCE support** for secure authorization
|
|
20
|
+
- ✅ **Dual exports**: ESM and CJS
|
|
21
|
+
- ✅ **Zero UI dependencies** - use in any JavaScript environment
|
|
22
|
+
- ✅ **Storage management** for tokens and session data
|
|
23
|
+
|
|
24
|
+
## Documentation
|
|
25
|
+
|
|
26
|
+
📚 **Full documentation at [dev.alien.org/docs](https://dev.alien.org/docs)**
|
|
27
|
+
|
|
28
|
+
- **[Integration Guide](https://dev.alien.org/docs/sso-guide/core-integration)** - Complete integration walkthrough
|
|
29
|
+
- **[API Reference](https://dev.alien.org/docs/sso-api-reference/api-reference-core)** - Detailed API documentation
|
|
30
|
+
- **[What is Alien Session?](https://dev.alien.org/docs/what-is-alien-session)** - Session architecture explained
|
|
31
|
+
- **[Demo App](https://dev.alien.org/docs/sso-demo-app)** - Example application
|
|
32
|
+
|
|
33
|
+
### React Integration
|
|
34
|
+
|
|
35
|
+
If you're using React, check out [@alien_org/sso-sdk-react](https://www.npmjs.com/package/@alien_org/sso-sdk-react) for hooks and pre-built components:
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
npm install @alien_org/sso-sdk-react
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## Authentication Flow
|
|
42
|
+
|
|
43
|
+
1. **Generate deeplink** → Display QR code or redirect
|
|
44
|
+
2. **User authenticates** in Alien mobile app
|
|
45
|
+
3. **Poll for completion** → Get authorization code
|
|
46
|
+
4. **Exchange code** → Receive access token
|
|
47
|
+
5. **Verify token** → Validate with server (optional)
|
|
48
|
+
|
|
49
|
+
## Storage
|
|
50
|
+
|
|
51
|
+
The SDK uses browser storage for session management:
|
|
52
|
+
|
|
53
|
+
- **localStorage**: `alien-sso_access_token` - Access token
|
|
54
|
+
- **sessionStorage**: `alien-sso_code_verifier` - PKCE code verifier
|
|
55
|
+
|
|
56
|
+
## Getting a Provider Address
|
|
57
|
+
|
|
58
|
+
Register your application at the [Developer Portal](https://dev.alien.org/dashboard) to get your provider credentials.
|
|
59
|
+
|
|
60
|
+
## TypeScript Support
|
|
61
|
+
|
|
62
|
+
Includes full TypeScript declarations with Zod runtime validation:
|
|
63
|
+
|
|
64
|
+
```typescript
|
|
65
|
+
import type {
|
|
66
|
+
AlienSsoClientConfig,
|
|
67
|
+
AuthorizeResponse,
|
|
68
|
+
PollResponse,
|
|
69
|
+
ExchangeCodeResponse,
|
|
70
|
+
TokenInfo
|
|
71
|
+
} from '@alien_org/sso-sdk-core';
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
## Browser Support
|
|
75
|
+
|
|
76
|
+
- Modern browsers with ES2020+ support
|
|
77
|
+
- Chrome, Firefox, Safari, Edge (latest versions)
|
|
78
|
+
|
|
79
|
+
## License
|
|
80
|
+
|
|
81
|
+
MIT
|
|
82
|
+
|
|
83
|
+
## Links
|
|
84
|
+
|
|
85
|
+
- [Documentation](https://dev.alien.org/docs)
|
|
86
|
+
- [GitHub Repository](https://github.com/alien-org/sso-sdk-js)
|
|
87
|
+
- [NPM Package](https://www.npmjs.com/package/@alien_org/sso-sdk-core)
|