@choochmeque/tauri-plugin-iap-api 0.5.0 → 0.6.0

package/README.md

@@ -10,7 +10,6 @@ A Tauri plugin for In-App Purchases (IAP) with support for subscriptions on iOS
 
 ## Features
 
-- Initialize billing/store connection
 - Query products and subscriptions with detailed pricing
 - Purchase subscriptions with platform-specific features
 - Restore previous purchases
@@ -70,13 +69,44 @@ 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:
+
+- 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
 
 ```typescript
 import {
-  initialize,
   getProducts,
   purchase,
   restorePurchases,
@@ -86,9 +116,6 @@ import {
   PurchaseState
 } from '@choochmeque/tauri-plugin-iap-api';
 
-// Initialize the billing client
-await initialize();
-
 // Get available products
 const products = await getProducts(['subscription_id_1', 'subscription_id_2'], 'subs');
 
@@ -163,10 +190,43 @@ await listener.unregister();
 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()`
-Initializes the billing client connection (required on Android, no-op on iOS).
+### `initialize()` *(Deprecated)*
+> **Deprecated**: This function is no longer needed and will be removed in a future major release. The billing client is now initialized automatically when the plugin loads.
+
+Returns `{ success: true }` for backward compatibility.
 
 ### `getProducts(productIds: string[], productType: 'subs' | 'inapp')`
 Fetches product details from the store.

package/dist-js/index.cjs

@@ -13,16 +13,9 @@ exports.PurchaseState = void 0;
 })(exports.PurchaseState || (exports.PurchaseState = {}));
 /**
  * Initialize the IAP plugin.
- * Must be called before any other IAP operations.
  *
- * @returns Promise resolving to initialization status
- * @example
- * ```typescript
- * const result = await initialize();
- * if (result.success) {
- *   console.log('IAP initialized successfully');
- * }
- * ```
+ * @deprecated This function is no longer needed. The billing client is now initialized automatically when the plugin loads. This function will be removed in the next major release.
+ * @returns Promise resolving to `{ success: true }` for backward compatibility
  */
 async function initialize() {
     return await core.invoke("plugin:iap|initialize");

package/dist-js/index.d.ts

@@ -144,16 +144,9 @@ export interface PurchaseOptions {
 }
 /**
  * Initialize the IAP plugin.
- * Must be called before any other IAP operations.
  *
- * @returns Promise resolving to initialization status
- * @example
- * ```typescript
- * const result = await initialize();
- * if (result.success) {
- *   console.log('IAP initialized successfully');
- * }
- * ```
+ * @deprecated This function is no longer needed. The billing client is now initialized automatically when the plugin loads. This function will be removed in the next major release.
+ * @returns Promise resolving to `{ success: true }` for backward compatibility
  */
 export declare function initialize(): Promise<InitializeResponse>;
 /**

package/dist-js/index.js

@@ -11,16 +11,9 @@ var PurchaseState;
 })(PurchaseState || (PurchaseState = {}));
 /**
  * Initialize the IAP plugin.
- * Must be called before any other IAP operations.
  *
- * @returns Promise resolving to initialization status
- * @example
- * ```typescript
- * const result = await initialize();
- * if (result.success) {
- *   console.log('IAP initialized successfully');
- * }
- * ```
+ * @deprecated This function is no longer needed. The billing client is now initialized automatically when the plugin loads. This function will be removed in the next major release.
+ * @returns Promise resolving to `{ success: true }` for backward compatibility
  */
 async function initialize() {
     return await invoke("plugin:iap|initialize");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@choochmeque/tauri-plugin-iap-api",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "license": "MIT",
   "author": "You",
   "description": "A Tauri v2 plugin that enables In-App Purchases (IAP)",
@@ -40,7 +40,7 @@
     "@vitest/coverage-v8": "^4.0.13",
     "@vitest/ui": "^4.0.13",
     "happy-dom": "^20.0.10",
-    "prettier": "3.6.2",
+    "prettier": "3.7.4",
     "rollup": "^4.9.6",
     "tslib": "^2.6.2",
     "typescript": "^5.3.3",