@tiun/types 0.1.2 → 0.3.0

package/README.md

@@ -2,16 +2,7 @@
 
 TypeScript type definitions for the tiun SDK.
 
-## When to Use
-
-| Installation Method      | Types Included? | Need This Package? |
-| ------------------------ | --------------- | ------------------ |
-| `npm install @tiun/sdk`  | ✅ Yes          | No                 |
-| `<script>` tags (legacy) | ❌ No           | **Yes**            |
-
-**NPM users:** Skip this package - types are bundled with `@tiun/sdk`.
-
-**Script tag users:** Install this for TypeScript support.
+Types are included in `@tiun/sdk`; you do not need this package when using the SDK. This package is an optional standalone reference (e.g. for custom setups).
 
 ## Installation
 
@@ -31,22 +22,35 @@ Add to `tsconfig.json`:
 }
 ```
 
-Or add a reference directive to any `.d.ts` file:
+Or in any `.d.ts` file:
 
 ```typescript
 /// <reference types="@tiun/types" />
 ```
 
-Restart your TypeScript server after setup.
-
 ## Usage
 
-The global `Tiun` object is now typed:
+The global `tiun` object is typed:
 
 ```typescript
-Tiun.init();
-Tiun.on('paywallShow', ({ isConnected }) => {});
-Tiun.checkout({ productId: 'prod_123' });
+tiun.init({ snippetId: 'your-snippet-id' });
+
+// Authentication
+tiun.login();
+tiun.logout();
+
+const { isAuthenticated, user } = tiun.getUser();
+
+// Events
+tiun.on('userChange', (event) => {
+  console.log(event.isAuthenticated, event.user);
+});
+tiun.on('login', (event) => console.log(event.user.email));
+tiun.on('logout', () => {});
+
+// Paywall
+tiun.on('paywallShow', ({ isConnected }) => {});
+tiun.checkout({ productId: 'prod_123' });
 ```
 
 ## Auto-generated

package/index.d.ts

@@ -3,8 +3,8 @@
  *
  * Install: npm install @tiun/types --save-dev
  *
- * These types are for the global `Tiun` object exposed by the Tiun script.
- * Load the script in your HTML, then use Tiun.* with full TypeScript support.
+ * These types are for the global `tiun` object exposed by the tiun script.
+ * Load the script, then use tiun.* with full TypeScript support.
  *
  * @generated from src/sdk/types.ts - Do not edit directly.
  * Run `npm run generate:types` to regenerate.
@@ -16,7 +16,14 @@
 
 export type ContentType = 'active' | 'inactive' | 'paused';
 export type MediaType = 'text' | 'audio' | 'video';
-export type TiunEventType = 'ready' | 'paywallShow' | 'paywallHide' | 'error';
+export type TiunEventType =
+  | 'ready'
+  | 'paywallShow'
+  | 'paywallHide'
+  | 'error'
+  | 'userChange'
+  | 'login'
+  | 'logout';
 
 // =============================================================================
 // Configuration
@@ -25,7 +32,7 @@ export type TiunEventType = 'ready' | 'paywallShow' | 'paywallHide' | 'error';
 export interface TiunConfig {
   /**
    * Your unique tiun snippet ID.
-   * Required for NPM package usage.
+   * Required when using the NPM package (SDK loads the snippet from backend).
    * For legacy script tag usage, this is provided via the backend.
    */
   snippetId?: string;
@@ -45,30 +52,16 @@ export interface TiunConfig {
   tone?: 'formal' | 'informal';
 
   /**
-   * Corner style for UI elements.
-   * - 'rounded': Rounded corners
-   * - 'pointed': Sharp corners
-   * @default 'rounded'
-   */
-  corners?: 'rounded' | 'pointed';
-
-  /**
-   * Enable WebView mode (for mobile app WebViews).
+   * Enable debug logging to console.
    * @default false
    */
-  webView?: boolean;
-
-  /**
-   * API base URL. Only needed for custom deployments.
-   * @default 'https://api.tiun.live/live_api'
-   */
-  baseUrl?: string;
+  debug?: boolean;
 
   /**
-   * Enable debug logging to console.
+   * Use sandbox base URL instead of production.
    * @default false
    */
-  debug?: boolean;
+  sandbox?: boolean;
 
   /**
    * Called when the snippet has finished initializing and is ready
@@ -85,6 +78,21 @@ export interface TiunConfig {
    */
   onPaywallHide?: (data: PaywallHideEvent) => void;
 
+  /**
+   * Called on user state changes (init + every subsequent change)
+   */
+  onUserChange?: (data: UserChangeEvent) => void;
+
+  /**
+   * Called when user logs in
+   */
+  onLogin?: (data: LoginEvent) => void;
+
+  /**
+   * Called when user logs out
+   */
+  onLogout?: () => void;
+
   /**
    * Called on any error
    */
@@ -120,6 +128,27 @@ export interface TiunError {
   details?: unknown;
 }
 
+export interface UserInfo {
+  userId: string;
+  email: string;
+  productAccess: string[];
+}
+
+export interface UserChangeEvent {
+  event: 'init' | 'login' | 'checkout' | 'logout' | 'update';
+  isAuthenticated: boolean;
+  user: UserInfo | null;
+}
+
+export interface LoginEvent {
+  user: UserInfo;
+}
+
+export interface GetUserResponse {
+  isAuthenticated: boolean;
+  user: UserInfo | null;
+}
+
 // =============================================================================
 // Checkout Options
 // =============================================================================
@@ -159,21 +188,15 @@ export interface ContentOptions {
 }
 
 // =============================================================================
-// SDK Interface (for global Tiun object)
+// SDK Interface (for global tiun object)
 // =============================================================================
 
 export interface TiunSDK {
   /**
    * Initialize the SDK. Call once at app startup.
    *
-   * For NPM package usage, snippetId is required:
-   * ```typescript
-   * Tiun.init({ snippetId: 'your-snippet-id' });
-   * ```
-   *
-   * For legacy script tag usage (backend-served), no config needed:
    * ```typescript
-   * Tiun.init();
+   * tiun.init({ snippetId: 'your-snippet-id' });
    * ```
    */
   init(config?: TiunConfig): TiunSDK;
@@ -188,6 +211,28 @@ export interface TiunSDK {
    */
   setContent(options: ContentOptions): Promise<void>;
 
+  /**
+   * Open the OTP login modal for returning subscribers.
+   */
+  login(): Promise<void>;
+
+  /**
+   * Clear session and fire logout + userChange events.
+   */
+  logout(): void;
+
+  /**
+   * Returns the cached user state. Does not call the backend —
+   * the snippet keeps user info in sync automatically.
+   */
+  getUser(): GetUserResponse;
+
+  /**
+   * Returns a signed JWT for server-to-server user verification.
+   * Valid for 5 minutes. Returns null if the user is not authenticated.
+   */
+  getUserVerificationToken(): Promise<string | null>;
+
   /**
    * Subscribe to an event. Returns unsubscribe function.
    */
@@ -201,6 +246,12 @@ export interface TiunSDK {
     callback: (data: PaywallHideEvent) => void
   ): () => void;
   on(event: 'error', callback: (error: TiunError) => void): () => void;
+  on(
+    event: 'userChange',
+    callback: (data: UserChangeEvent) => void
+  ): () => void;
+  on(event: 'login', callback: (data: LoginEvent) => void): () => void;
+  on(event: 'logout', callback: () => void): () => void;
 
   /**
    * Subscribe to an event once (auto-unsubscribes after first fire).
@@ -215,6 +266,12 @@ export interface TiunSDK {
     callback: (data: PaywallHideEvent) => void
   ): () => void;
   once(event: 'error', callback: (error: TiunError) => void): () => void;
+  once(
+    event: 'userChange',
+    callback: (data: UserChangeEvent) => void
+  ): () => void;
+  once(event: 'login', callback: (data: LoginEvent) => void): () => void;
+  once(event: 'logout', callback: () => void): () => void;
 
   /**
    * Destroy the SDK and cleanup all listeners.
@@ -234,6 +291,12 @@ export interface TiunSDK {
 
   /** Whether the snippet is ready */
   readonly isReady: boolean;
+
+  /** Whether the user is identified (has valid session) */
+  readonly isAuthenticated: boolean;
+
+  /** Current user info or null */
+  readonly user: UserInfo | null;
 }
 
 // =============================================================================
@@ -242,13 +305,13 @@ export interface TiunSDK {
 
 declare global {
   /**
-   * Global Tiun SDK instance.
-   * Available after loading the Tiun script.
+   * Global tiun SDK instance.
+   * Available after loading the tiun script.
    */
-  const Tiun: TiunSDK;
+  const tiun: TiunSDK;
 
   interface Window {
-    Tiun: TiunSDK;
+    tiun: TiunSDK;
   }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tiun/types",
-  "version": "0.1.2",
+  "version": "0.3.0",
   "description": "TypeScript type definitions for tiun SDK (for script tag users)",
   "types": "./index.d.ts",
   "files": [