@tiun/types 0.10.0 → 0.12.0

package/README.md

@@ -51,6 +51,10 @@ tiun.on('logout', () => {});
 // Paywall
 tiun.on('paywallShow', ({ isConnected }) => {});
 tiun.checkout({ productId: 'prod_123' });
+
+// Products
+const products = await tiun.listProducts();
+const { hasAccess } = await tiun.checkProductAccess('prod_123');
 ```
 
 ## Auto-generated

package/index.d.ts

@@ -143,10 +143,26 @@ export interface TiunError {
 export interface UserInfo {
   userId: string;
   email: string;
+  /** Whether the user has opted in to the newsletter. */
+  hasNewsletterOptIn: boolean;
+  /**
+   * IDs of the products the user has access to. Product IDs only, so it can't
+   * tell which references of a repeatable product were bought — use
+   * `checkProductAccess(productId, { referenceId })` for those.
+   */
   productAccess: string[];
 }
 
 export interface UserChangeEvent {
+  /**
+   * What changed:
+   * - 'init': first state after the snippet loads
+   * - 'login' / 'logout': the user signed in or out
+   * - 'checkout': the user's access changed — gained or lost, for any product
+   *   type, including a repeatable product bought with a new reference
+   *   (which doesn't change `productAccess`). Not only after a checkout.
+   * - 'update': profile details changed (email, newsletter opt-in)
+   */
   event: 'init' | 'login' | 'checkout' | 'logout' | 'update';
   isAuthenticated: boolean;
   user: UserInfo | null;
@@ -167,9 +183,62 @@ export interface GetUserResponse {
 
 export interface CheckoutOptions {
   /**
-   * Specific product ID to checkout (optional, for future use)
+   * The product to check out, from your tiun dashboard.
    */
   productId?: string;
+  /**
+   * Your own identifier for this purchase (e.g. an order or booking ID).
+   * Required for repeatable products, which can be bought more than once —
+   * each purchase is tied to its reference ID.
+   */
+  referenceId?: string;
+}
+
+// =============================================================================
+// Products
+// =============================================================================
+
+export type ProductType = 'Subscription' | 'OneTime';
+
+export interface Product {
+  productId: string;
+  name: string;
+  type: ProductType;
+}
+
+export interface ProductDetail extends Product {
+  /** Localized price summary, e.g. "€9.90 / month". */
+  pricingLine: string;
+  /** Optional localized explanation shown under the price. */
+  explanationLine?: string | null;
+}
+
+export interface ProductAccess {
+  productId: string;
+  /** Purchase reference for repeatable products; null for ordinary access. */
+  referenceId?: string | null;
+  type: ProductType;
+  /** ISO 8601 date-time. */
+  activatedAt: string;
+  /**
+   * When the access ends (ISO 8601 date-time). null while a subscription is
+   * active and renewing; set to the end of the paid period once it's cancelled.
+   */
+  expiresAt?: string | null;
+}
+
+export interface ProductAccessCheck {
+  hasAccess: boolean;
+  /** Access details when `hasAccess` is true; null otherwise. */
+  access?: ProductAccess | null;
+}
+
+export interface ProductAccessOptions {
+  /**
+   * Purchase reference for repeatable products (the `referenceId` passed to
+   * `checkout()`). Omit for ordinary product access.
+   */
+  referenceId?: string;
 }
 
 // =============================================================================
@@ -251,6 +320,32 @@ export interface TiunSDK {
    */
   getUserVerificationToken(): Promise<string | null>;
 
+  /**
+   * List the products available on this snippet.
+   */
+  listProducts(): Promise<Product[]>;
+
+  /**
+   * Get a product's details and localized pricing.
+   * Rejects with a TiunError if the product doesn't exist.
+   */
+  getProduct(productId: string): Promise<ProductDetail>;
+
+  /**
+   * List the current user's active product access, fetched from the backend.
+   * Resolves to [] when the user is not authenticated.
+   */
+  listProductAccess(): Promise<ProductAccess[]>;
+
+  /**
+   * Check whether the current user has access to a product.
+   * Resolves to { hasAccess: false, access: null } when the user is not authenticated.
+   */
+  checkProductAccess(
+    productId: string,
+    options?: ProductAccessOptions
+  ): Promise<ProductAccessCheck>;
+
   /**
    * Subscribe to an event. Returns unsubscribe function.
    */
@@ -292,7 +387,9 @@ export interface TiunSDK {
   once(event: 'logout', callback: () => void): () => void;
 
   /**
-   * Destroy the SDK and cleanup all listeners.
+   * Remove the SDK's listeners and reset its state. The snippet stays on the
+   * page; calling init() again works, but `user` stays empty until the next
+   * login, logout or checkout.
    */
   destroy(): void;
 

package/package.json

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