@choochmeque/tauri-plugin-iap-api 0.4.5 → 0.5.1

package/README.md

@@ -1,10 +1,12 @@
 [![NPM Version](https://img.shields.io/npm/v/@choochmeque%2Ftauri-plugin-iap-api)](https://www.npmjs.com/package/@choochmeque/tauri-plugin-iap-api)
 [![Crates.io Version](https://img.shields.io/crates/v/tauri-plugin-iap)](https://crates.io/crates/tauri-plugin-iap)
+[![Tests](https://github.com/Choochmeque/tauri-plugin-iap/actions/workflows/tests.yml/badge.svg)](https://github.com/Choochmeque/tauri-plugin-iap/actions/workflows/tests.yml)
+[![codecov](https://codecov.io/gh/Choochmeque/tauri-plugin-iap/branch/main/graph/badge.svg)](https://codecov.io/gh/Choochmeque/tauri-plugin-iap)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
 
 # Tauri Plugin IAP
 
-A Tauri plugin for In-App Purchases (IAP) with support for subscriptions on iOS (StoreKit 2), Android (Google Play Billing) and Windows (Microsoft Store).
+A Tauri plugin for In-App Purchases (IAP) with support for subscriptions on iOS (StoreKit 2), Android (Google Play Billing), Windows (Microsoft Store) and macOS (StoreKit 2).
 
 ## Features
 
@@ -26,7 +28,7 @@ A Tauri plugin for In-App Purchases (IAP) with support for subscriptions on iOS
 - **iOS**: StoreKit 2 (requires iOS 15.0+)
 - **Android**: Google Play Billing Library v8.0.0
 - **Windows**: Microsoft Store API (Windows 10/11)
-- **macOS**: Experimental support - might not work correctly (still required some work to do)
+- **macOS**: StoreKit 2 (requires macOS 13.0+)
 
 ## Installation
 
@@ -44,7 +46,7 @@ Add the plugin to your Tauri project's `Cargo.toml`:
 
 ```toml
 [dependencies]
-tauri-plugin-iap = "0.4"
+tauri-plugin-iap = "0.5"
 ```
 
 Configure the plugin permissions in your `capabilities/default.json`:
@@ -68,6 +70,39 @@ fn main() {
 }
 ```
 
+## Example App
+
+An example application is available in the [`examples/iap-demo`](examples/iap-demo) directory. The example demonstrates all core IAP functionality with a UI:
+
+- Initialize IAP connection
+- Fetch and display products with pricing
+- Purchase products and subscriptions
+- Restore previous purchases
+- Check product ownership status
+- Real-time purchase update notifications
+
+### Running the Example
+
+```bash
+cd examples/iap-demo
+
+# Install dependencies
+pnpm install
+
+# Run in development mode
+pnpm tauri dev
+
+# Build for production
+pnpm tauri build
+```
+
+**Important:** The app must be properly code-signed to test IAP functionality:
+- **iOS/macOS**: Code signing is required by StoreKit. Configure signing in Xcode or via Tauri's configuration.
+- **Android**: Sign your APK/AAB with a release keystore for production testing.
+- **Windows**: App must be associated with Microsoft Store and signed for Store submission.
+
+The example app provides a fully functional demo with inline documentation for each IAP feature, making it easy to understand how to integrate the plugin into your own application.
+
 ## Usage
 
 ### JavaScript/TypeScript
@@ -82,7 +117,7 @@ import {
   getProductStatus,
   onPurchaseUpdated,
   PurchaseState
-} from 'tauri-plugin-iap-api';
+} from '@choochmeque/tauri-plugin-iap-api';
 
 // Initialize the billing client
 await initialize();
@@ -126,12 +161,12 @@ const restored = await restorePurchases('subs');
 await acknowledgePurchase(purchaseResult.purchaseToken);
 
 // Listen for purchase updates
-const unlisten = onPurchaseUpdated((purchase) => {
+const listener = await onPurchaseUpdated((purchase) => {
   console.log('Purchase updated:', purchase);
 });
 
 // Stop listening
-unlisten();
+await listener.unregister();
 ```
 
 ## Platform Setup
@@ -161,6 +196,37 @@ unlisten();
 3. Associate your app with the Microsoft Store
 4. Test with Windows sandbox environment
 
+### macOS Setup
+
+1. Configure your app in App Store Connect
+2. Create subscription or in-app purchase products with pricing
+3. Configure code signing in `tauri.conf.json`:
+   ```json
+   {
+     "bundle": {
+       "macOS": {
+         "signingIdentity": "Developer ID Application: Your Name (TEAM_ID)",
+         "entitlements": "path/to/entitlements.plist"
+       }
+     }
+   }
+   ```
+4. Add required entitlements for StoreKit (create `entitlements.plist`):
+   ```xml
+   <?xml version="1.0" encoding="UTF-8"?>
+   <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+   <plist version="1.0">
+   <dict>
+       <key>com.apple.security.app-sandbox</key>
+       <true/>
+       <key>com.apple.security.network.client</key>
+       <true/>
+   </dict>
+   </plist>
+   ```
+5. Test with sandbox accounts or StoreKit Configuration files
+6. **Important**: App must be code-signed to use StoreKit APIs
+
 ## API Reference
 
 ### `initialize()`
@@ -221,9 +287,11 @@ Checks the ownership and subscription status of a specific product.
 - `isAcknowledged`: Whether the purchase has been acknowledged
 - `purchaseToken`: Token for the purchase transaction
 
-### `onPurchaseUpdated(callback: (purchase: Purchase) => void)`
+### `onPurchaseUpdated(callback: (purchase: Purchase) => void): Promise<PluginListener>`
 Listens for purchase state changes.
 
+**Returns:** A `PluginListener` object with an `unregister()` method to stop listening.
+
 ## Differences Between Platforms
 
 ### iOS (StoreKit 2)
@@ -244,6 +312,13 @@ Listens for purchase state changes.
 - Supports consumables, durables, and subscriptions
 - Uses SKUs for subscription offer variations
 
+### macOS (StoreKit 2)
+- Same StoreKit 2 API as iOS
+- Automatic transaction verification
+- No manual acknowledgment needed
+- Requires macOS 13.0+
+- App must be code-signed (StoreKit requires valid signature)
+
 ## Testing
 
 ### iOS
@@ -262,6 +337,12 @@ Listens for purchase state changes.
 3. Test with Windows Dev Center test payment methods
 4. Ensure app is associated with Store listing
 
+### macOS
+1. Use sandbox test accounts (same as iOS)
+2. Use StoreKit Configuration files for local testing
+3. App must be code-signed to use StoreKit
+4. Clear purchase history in System Settings > App Store > Sandbox Account
+
 ## License
 
 [MIT](LICENSE)

package/dist-js/index.cjs

@@ -1,7 +1,6 @@
 'use strict';
 
 var core = require('@tauri-apps/api/core');
-var event = require('@tauri-apps/api/event');
 
 /**
  * Purchase state enumeration
@@ -173,10 +172,10 @@ async function getProductStatus(productId, productType = "subs") {
  * This event is triggered when a purchase state changes.
  *
  * @param callback - Function to call when a purchase is updated
- * @returns Cleanup function to stop listening
+ * @returns Promise resolving to a PluginListener that can be used to stop listening
  * @example
  * ```typescript
- * const unsubscribe = onPurchaseUpdated((purchase) => {
+ * const listener = await onPurchaseUpdated((purchase) => {
  *   console.log(`Purchase updated: ${purchase.productId}`);
  *   if (purchase.purchaseState === PurchaseState.PURCHASED) {
  *     // Handle successful purchase
@@ -184,16 +183,11 @@ async function getProductStatus(productId, productType = "subs") {
  * });
  *
  * // Later, stop listening
- * unsubscribe();
+ * await listener.unregister();
  * ```
  */
-function onPurchaseUpdated(callback) {
-    const unlisten = event.listen("purchaseUpdated", (event) => {
-        callback(event.payload);
-    });
-    return () => {
-        unlisten.then((fn) => fn());
-    };
+async function onPurchaseUpdated(callback) {
+    return await core.addPluginListener("iap", "purchaseUpdated", callback);
 }
 
 exports.acknowledgePurchase = acknowledgePurchase;

package/dist-js/index.d.ts

@@ -1,3 +1,4 @@
+import { PluginListener } from "@tauri-apps/api/core";
 /**
  * Response from IAP initialization
  */
@@ -28,13 +29,21 @@ export interface SubscriptionOffer {
  * Product information from the app store
  */
 export interface Product {
+    /** Unique product identifier as configured in the app store */
     productId: string;
+    /** Localized product title */
     title: string;
+    /** Localized product description */
     description: string;
+    /** Type of product: "subs" for subscriptions, "inapp" for one-time purchases */
     productType: string;
+    /** Localized price string with currency symbol (e.g., "$9.99") */
     formattedPrice?: string;
+    /** ISO 4217 currency code (e.g., "USD", "EUR") */
     priceCurrencyCode?: string;
+    /** Price in micros (price × 1,000,000). For example, $9.99 = 9990000 */
     priceAmountMicros?: number;
+    /** Subscription offer details including pricing phases. (Android only) */
     subscriptionOfferDetails?: SubscriptionOffer[];
 }
 /**
@@ -47,16 +56,28 @@ export interface GetProductsResponse {
  * Purchase transaction information
  */
 export interface Purchase {
+    /** Unique order identifier from the store. May be undefined for pending purchases. */
     orderId?: string;
+    /** Application package name (Android) or bundle identifier (iOS/macOS) */
     packageName: string;
+    /** Product identifier that was purchased */
     productId: string;
+    /** Unix timestamp (milliseconds) when the purchase was made */
     purchaseTime: number;
+    /** Token used to identify this purchase for acknowledgment and server-side verification */
     purchaseToken: string;
-    purchaseState: number;
+    /** Current state of the purchase. */
+    purchaseState: PurchaseState;
+    /** Whether this subscription is set to auto-renew. Always false for one-time purchases. */
     isAutoRenewing: boolean;
+    /** Whether the purchase has been acknowledged. Unacknowledged purchases are refunded after 3 days. (Android only, always true on iOS/macOS) */
     isAcknowledged: boolean;
+    /** Raw JSON response from the store for server-side verification. (Android only) */
     originalJson: string;
+    /** Cryptographic signature for purchase verification. (Android only) */
     signature: string;
+    /** Original transaction ID. Used to link renewals and restores to the original purchase. (iOS/macOS only) */
+    originalId?: string;
 }
 /**
  * Response containing restored purchases
@@ -244,10 +265,10 @@ export declare function getProductStatus(productId: string, productType?: "subs"
  * This event is triggered when a purchase state changes.
  *
  * @param callback - Function to call when a purchase is updated
- * @returns Cleanup function to stop listening
+ * @returns Promise resolving to a PluginListener that can be used to stop listening
  * @example
  * ```typescript
- * const unsubscribe = onPurchaseUpdated((purchase) => {
+ * const listener = await onPurchaseUpdated((purchase) => {
  *   console.log(`Purchase updated: ${purchase.productId}`);
  *   if (purchase.purchaseState === PurchaseState.PURCHASED) {
  *     // Handle successful purchase
@@ -255,7 +276,7 @@ export declare function getProductStatus(productId: string, productType?: "subs"
  * });
  *
  * // Later, stop listening
- * unsubscribe();
+ * await listener.unregister();
  * ```
  */
-export declare function onPurchaseUpdated(callback: (purchase: Purchase) => void): () => void;
+export declare function onPurchaseUpdated(callback: (purchase: Purchase) => void): Promise<PluginListener>;

package/dist-js/index.js

@@ -1,5 +1,4 @@
-import { invoke } from '@tauri-apps/api/core';
-import { listen } from '@tauri-apps/api/event';
+import { invoke, addPluginListener } from '@tauri-apps/api/core';
 
 /**
  * Purchase state enumeration
@@ -171,10 +170,10 @@ async function getProductStatus(productId, productType = "subs") {
  * This event is triggered when a purchase state changes.
  *
  * @param callback - Function to call when a purchase is updated
- * @returns Cleanup function to stop listening
+ * @returns Promise resolving to a PluginListener that can be used to stop listening
  * @example
  * ```typescript
- * const unsubscribe = onPurchaseUpdated((purchase) => {
+ * const listener = await onPurchaseUpdated((purchase) => {
  *   console.log(`Purchase updated: ${purchase.productId}`);
  *   if (purchase.purchaseState === PurchaseState.PURCHASED) {
  *     // Handle successful purchase
@@ -182,16 +181,11 @@ async function getProductStatus(productId, productType = "subs") {
  * });
  *
  * // Later, stop listening
- * unsubscribe();
+ * await listener.unregister();
  * ```
  */
-function onPurchaseUpdated(callback) {
-    const unlisten = listen("purchaseUpdated", (event) => {
-        callback(event.payload);
-    });
-    return () => {
-        unlisten.then((fn) => fn());
-    };
+async function onPurchaseUpdated(callback) {
+    return await addPluginListener("iap", "purchaseUpdated", callback);
 }
 
 export { PurchaseState, acknowledgePurchase, getProductStatus, getProducts, getPurchaseHistory, initialize, onPurchaseUpdated, purchase, restorePurchases };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@choochmeque/tauri-plugin-iap-api",
-  "version": "0.4.5",
+  "version": "0.5.1",
   "license": "MIT",
   "author": "You",
   "description": "A Tauri v2 plugin that enables In-App Purchases (IAP)",
@@ -37,15 +37,23 @@
   },
   "devDependencies": {
     "@rollup/plugin-typescript": "^12.1.4",
+    "@vitest/coverage-v8": "^4.0.13",
+    "@vitest/ui": "^4.0.13",
+    "happy-dom": "^20.0.10",
+    "prettier": "3.7.4",
     "rollup": "^4.9.6",
     "tslib": "^2.6.2",
     "typescript": "^5.3.3",
-    "prettier": "3.6.2"
+    "vitest": "^4.0.13"
   },
   "scripts": {
     "build": "rollup -c",
     "pretest": "pnpm build",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:ui": "vitest --ui",
+    "test:coverage": "vitest run --coverage",
     "format": "prettier --write \"./**/*.{cjs,mjs,js,jsx,mts,ts,tsx,html,css,json}\"",
-    "format-check": "prettier --check \"./**/*.{cjs,mjs,js,jsx,mts,ts,tsx,html,css,json}\""
+    "format:check": "prettier --check \"./**/*.{cjs,mjs,js,jsx,mts,ts,tsx,html,css,json}\""
   }
 }