@tiun/types 0.1.1 → 0.2.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,20 @@ 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' });
+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.
@@ -25,7 +25,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 +45,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
@@ -159,21 +145,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;
@@ -242,13 +222,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.1",
+  "version": "0.2.0",
   "description": "TypeScript type definitions for tiun SDK (for script tag users)",
   "types": "./index.d.ts",
   "files": [
@@ -19,6 +19,7 @@
     "type": "git",
     "url": "https://github.com/tiun-app/tiun-snippet"
   },
+  "homepage": "https://tiun.io",
   "license": "MIT",
   "publishConfig": {
     "access": "public"