@adapty/capacitor 3.17.1 → 4.0.0-beta.2

package/Package.swift

@@ -11,7 +11,7 @@ let package = Package(
     ],
     dependencies: [
         .package(url: "https://github.com/ionic-team/capacitor-swift-pm.git", from: "8.0.0"),
-        .package(url: "https://github.com/adaptyteam/AdaptySDK-iOS.git", exact: "3.17.2")
+        .package(url: "https://github.com/adaptyteam/AdaptySDK-iOS.git", exact: "4.0.0")
     ],
     targets: [
         .target(

package/README.md

@@ -33,6 +33,7 @@ Adapty SDK is an open-source framework that makes implementing in-app subscripti
 - [Mobile app monetization's largest community](#mobile-app-monetizations-largest-community)
 - [Platform Support](#platform-support)
 - [Capacitor compatibility](#capacitor-compatibility)
+- [iOS dependency manager](#ios-dependency-manager)
 - [Examples](#examples)
 - [Contributing](#contributing)
 - [Like Adapty SDK?](#like-adapty-sdk)
@@ -112,6 +113,13 @@ Adapty SDK for Capacitor is fully supported on **iOS** and **Android** platforms
 | 7.x | 3.15.x and older            |
 | 6.x and older | Not supported               |
 
+### iOS dependency manager
+
+| `@adapty/capacitor` version | iOS dependency manager |
+| --- | --- |
+| 4.x and newer | Swift Package Manager (SPM) only |
+| 3.x | CocoaPods and Swift Package Manager (SPM) |
+
 
 ## Examples
 

package/android/build.gradle

@@ -66,10 +66,10 @@ dependencies {
     // kotlin-stdlib is added automatically by Kotlin Gradle plugin
 
     // Adapty SDK dependencies
-    implementation platform('io.adapty:adapty-bom:3.17.1')
+    implementation platform('io.adapty:adapty-bom:4.0.0')
     implementation 'io.adapty:android-sdk'
     implementation 'io.adapty:android-ui'
-    implementation 'io.adapty.internal:crossplatform:3.17.2'
+    implementation 'io.adapty.internal:crossplatform:4.0.0'
 
     testImplementation "junit:junit:$junitVersion"
     androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"

package/dist/esm/adapty-instance.d.ts

@@ -0,0 +1,7 @@
+import { Adapty } from './adapty';
+/**
+ * The shared Adapty singleton. Extracted into its own module so UI default
+ * handlers can delegate to native handler methods (openWebUrl / requestAppReview)
+ * without importing the package entry point and creating an import cycle.
+ */
+export declare const adapty: Adapty;

package/dist/esm/adapty-instance.js

@@ -0,0 +1,8 @@
+import { Adapty } from './adapty';
+/**
+ * The shared Adapty singleton. Extracted into its own module so UI default
+ * handlers can delegate to native handler methods (openWebUrl / requestAppReview)
+ * without importing the package entry point and creating an import cycle.
+ */
+export const adapty = new Adapty();
+//# sourceMappingURL=adapty-instance.js.map

package/dist/esm/adapty-instance.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapty-instance.js","sourceRoot":"","sources":["../../src/adapty-instance.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC;;;;GAIG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC","sourcesContent":["import { Adapty } from './adapty';\n\n/**\n * The shared Adapty singleton. Extracted into its own module so UI default\n * handlers can delegate to native handler methods (openWebUrl / requestAppReview)\n * without importing the package entry point and creating an import cycle.\n */\nexport const adapty = new Adapty();\n"]}

package/dist/esm/adapty.d.ts

@@ -1,9 +1,9 @@
 import { type AdaptyType } from './coders/parse';
 import { LogContext } from './logger';
 import type { LoggerConfig, LogScope } from './logger';
-import type { AdaptyPaywall, AdaptyPaywallProduct, AdaptyOnboarding, AdaptyProfile, AdaptyPurchaseResult, AdaptyProfileParameters, RefundPreference, AdaptyInstallationStatus, WebPresentation } from './types';
+import type { AdaptyFlow, AdaptyFlowPaywall, AdaptyPaywallProduct, AdaptyOnboarding, AdaptyProfile, AdaptyPurchaseResult, AdaptyProfileParameters, RefundPreference, AdaptyInstallationStatus, WebPresentation } from './types';
 import type { AdaptyPlugin, AddListenerFn } from './types/adapty-plugin';
-import type { GetPaywallOptions, GetPaywallForDefaultAudienceOptions, MakePurchaseOptions, GetOnboardingOptions, GetOnboardingForDefaultAudienceOptions } from './types/configs';
+import type { GetFlowOptions, GetFlowForDefaultAudienceOptions, MakePurchaseOptions, GetOnboardingOptions, GetOnboardingForDefaultAudienceOptions } from './types/configs';
 import type { ActivateParamsInput, FileLocation, LogLevel, IdentifyParamsInput } from './types/inputs';
 import type { MethodName } from './types/method-types';
 /**
@@ -40,8 +40,6 @@ export declare class Adapty implements AdaptyPlugin {
      * so background activities can be performed and cache can be updated.
      *
      * @example
-     *
-     * @example
      * Usage with your user identifier from your system
      * ```typescript
      * await adapty.activate({
@@ -98,82 +96,78 @@ export declare class Adapty implements AdaptyPlugin {
      */
     getCurrentInstallationStatus(): Promise<AdaptyInstallationStatus>;
     /**
-     * Fetches the paywall by the specified placement.
+     * Fetches the flow by the specified placement.
      *
      * @remarks
      * With Adapty, you can remotely configure the products and offers in your app
-     * by simply adding them to paywalls – no need for hardcoding them.
+     * by simply adding them to flows – no need for hardcoding them.
      * The only thing you hardcode is the placement ID.
-     * This flexibility allows you to easily update paywalls, products, and offers,
+     * This flexibility allows you to easily update flows, products, and offers,
      * or run A/B tests, all without the need for a new app release.
      *
-     * @param options - The options for fetching the paywall
+     * @param options - The options for fetching the flow
      * @param options.placementId - The identifier of the desired placement. This is the value you specified when creating a placement in the Adapty Dashboard.
-     * @param options.locale - Optional. The identifier of the paywall localization. Default: `'en'`. See {@link https://docs.adapty.io/docs/localizations-and-locale-codes | Localizations and locale codes} for more information.
-     * @param options.params - Optional. Additional parameters for fetching the paywall, including fetch policy and load timeout.
-     * @returns A promise that resolves with the requested {@link AdaptyPaywall}.
-     * @throws Error if the paywall with the specified ID is not found or if your bundle ID does not match with your Adapty Dashboard setup.
+     * @param options.params - Optional. Additional parameters for fetching the flow, including fetch policy and load timeout.
+     * @returns A promise that resolves with the requested {@link AdaptyFlow}.
+     * @throws Error if the flow with the specified ID is not found or if your bundle ID does not match with your Adapty Dashboard setup.
      *
      * @example
      * ```typescript
      * import { adapty } from '@adapty/capacitor';
      *
      * try {
-     *   const paywall = await adapty.getPaywall({
+     *   const flow = await adapty.getFlow({
      *     placementId: 'YOUR_PLACEMENT_ID',
-     *     locale: 'en',
      *   });
-     *   console.log('Paywall fetched successfully');
+     *   console.log('Flow fetched successfully');
      * } catch (error) {
-     *   console.error('Failed to fetch paywall:', error);
+     *   console.error('Failed to fetch flow:', error);
      * }
      * ```
      */
-    getPaywall(options: GetPaywallOptions): Promise<AdaptyPaywall>;
+    getFlow(options: GetFlowOptions): Promise<AdaptyFlow>;
     /**
-     * Fetches the paywall of the specified placement for the **All Users** audience.
+     * Fetches the flow of the specified placement for the **All Users** audience.
      *
      * @remarks
      * With Adapty, you can remotely configure the products and offers in your app
-     * by simply adding them to paywalls – no need for hardcoding them.
+     * by simply adding them to flows – no need for hardcoding them.
      * The only thing you hardcode is the placement ID.
      *
-     * However, it's crucial to understand that the recommended approach is to fetch the paywall
-     * through the placement ID by the {@link getPaywall} method.
-     * The `getPaywallForDefaultAudience` method should be a last resort due to its significant drawbacks:
+     * However, it's crucial to understand that the recommended approach is to fetch the flow
+     * through the placement ID by the {@link getFlow} method.
+     * The `getFlowForDefaultAudience` method should be a last resort due to its significant drawbacks:
      * - Potential backward compatibility issues
-     * - Loss of targeting (all users see the same paywall)
+     * - Loss of targeting (all users see the same flow)
      *
      * See {@link https://docs.adapty.io/docs/capacitor-get-pb-paywalls#get-a-paywall-for-a-default-audience-to-fetch-it-faster | documentation} for more details.
      *
-     * @param options - The options for fetching the paywall
+     * @param options - The options for fetching the flow
      * @param options.placementId - The identifier of the desired placement.
-     * @param options.locale - Optional. The identifier of the paywall localization. Default: `'en'`.
-     * @param options.params - Optional. Additional parameters for fetching the paywall.
-     * @returns A promise that resolves with the requested {@link AdaptyPaywall}.
-     * @throws Error if the paywall with the specified ID is not found.
+     * @param options.params - Optional. Additional parameters for fetching the flow.
+     * @returns A promise that resolves with the requested {@link AdaptyFlow}.
+     * @throws Error if the flow with the specified ID is not found.
      *
      * @example
      * ```typescript
      * import { adapty } from '@adapty/capacitor';
      *
      * try {
-     *   const paywall = await adapty.getPaywallForDefaultAudience({
+     *   const flow = await adapty.getFlowForDefaultAudience({
      *     placementId: 'YOUR_PLACEMENT_ID',
-     *     locale: 'en',
      *   });
      * } catch (error) {
-     *   console.error('Failed to fetch paywall:', error);
+     *   console.error('Failed to fetch flow:', error);
      * }
      * ```
      */
-    getPaywallForDefaultAudience(options: GetPaywallForDefaultAudienceOptions): Promise<AdaptyPaywall>;
+    getFlowForDefaultAudience(options: GetFlowForDefaultAudienceOptions): Promise<AdaptyFlow>;
     /**
-     * Fetches a list of products associated with a provided paywall.
+     * Fetches a list of products associated with a provided flow.
      *
      * @param options - The options object
-     * @param options.paywall - A paywall to fetch products for. You can get it using {@link getPaywall} method.
-     * @returns A promise that resolves with a list of {@link AdaptyPaywallProduct} associated with a provided paywall.
+     * @param options.flow - A flow to fetch products for. You can get it using {@link getFlow} method.
+     * @returns A promise that resolves with a list of {@link AdaptyPaywallProduct} associated with a provided flow.
      * @throws Error if an error occurs while fetching products.
      *
      * @example
@@ -181,8 +175,8 @@ export declare class Adapty implements AdaptyPlugin {
      * import { adapty } from '@adapty/capacitor';
      *
      * try {
-     *   const paywall = await adapty.getPaywall({ placementId: 'YOUR_PLACEMENT_ID' });
-     *   const products = await adapty.getPaywallProducts({ paywall });
+     *   const flow = await adapty.getFlow({ placementId: 'YOUR_PLACEMENT_ID' });
+     *   const products = await adapty.getPaywallProducts({ flow });
      *   console.log('Products:', products);
      * } catch (error) {
      *   console.error('Failed to fetch products:', error);
@@ -190,11 +184,13 @@ export declare class Adapty implements AdaptyPlugin {
      * ```
      */
     getPaywallProducts(options: {
-        paywall: AdaptyPaywall;
+        flow: AdaptyFlow;
     }): Promise<AdaptyPaywallProduct[]>;
     /**
      * Fetches the onboarding by the specified placement.
      *
+     * @deprecated Since 4.0.0. Migrate onboardings to the Flow Builder API.
+     *
      * @remarks
      * When you create an onboarding with the no-code builder, it's stored as a container with configuration
      * that your app needs to fetch and display. This container manages the entire experience - what content appears,
@@ -230,6 +226,8 @@ export declare class Adapty implements AdaptyPlugin {
     /**
      * Fetches the onboarding of the specified placement for the **All Users** audience.
      *
+     * @deprecated Since 4.0.0. Migrate onboardings to the Flow Builder API.
+     *
      * @remarks
      * It's crucial to understand that the recommended approach is to fetch the onboarding
      * by the {@link getOnboarding} method. The `getOnboardingForDefaultAudience` method
@@ -324,19 +322,19 @@ export declare class Adapty implements AdaptyPlugin {
         params?: IdentifyParamsInput;
     }): Promise<void>;
     /**
-     * Logs a paywall view event.
+     * Logs a flow view event.
      *
      * @remarks
-     * Adapty helps you to measure the performance of the paywalls.
-     * We automatically collect all the metrics related to purchases except for custom paywall views.
-     * This is because only you know when the paywall was shown to a customer.
+     * Adapty helps you to measure the performance of the flows.
+     * We automatically collect all the metrics related to purchases except for custom flow views.
+     * This is because only you know when the flow was shown to a customer.
      *
-     * Whenever you show a paywall to your user,
+     * Whenever you show a flow to your user,
      * call this function to log the event,
-     * and it will be accumulated in the paywall metrics.
+     * and it will be accumulated in the flow metrics.
      *
      * @param options - The options object
-     * @param options.paywall - The paywall object that was shown to the user.
+     * @param options.flow - The flow object that was shown to the user.
      * @returns A promise that resolves when the event is logged.
      * @throws Error if an error occurs while logging the event.
      *
@@ -344,19 +342,20 @@ export declare class Adapty implements AdaptyPlugin {
      * ```typescript
      * import { adapty } from '@adapty/capacitor';
      *
-     * const paywall = await adapty.getPaywall({ placementId: 'YOUR_PLACEMENT_ID' });
-     * // ...after opening the paywall
-     * await adapty.logShowPaywall({ paywall });
+     * const flow = await adapty.getFlow({ placementId: 'YOUR_PLACEMENT_ID' });
+     * // ...after opening the flow
+     * await adapty.logShowFlow({ flow });
      * ```
      */
-    logShowPaywall(options: {
-        paywall: AdaptyPaywall;
+    logShowFlow(options: {
+        flow: AdaptyFlow;
     }): Promise<void>;
     /**
      * Opens a web paywall in the default browser.
      *
      * @param options - The options object
-     * @param options.paywallOrProduct - The paywall or product to open as a web paywall.
+     * @param options.paywallOrProduct - The flow paywall or product to open as a web paywall.
+     * @param options.openIn - Optional. Where to open the web paywall ({@link WebPresentation}).
      * @returns A promise that resolves when the web paywall is opened.
      * @throws Error if an error occurs while opening the web paywall.
      *
@@ -365,15 +364,15 @@ export declare class Adapty implements AdaptyPlugin {
      * import { adapty } from '@adapty/capacitor';
      *
      * try {
-     *   const paywall = await adapty.getPaywall({ placementId: 'YOUR_PLACEMENT_ID' });
-     *   await adapty.openWebPaywall({ paywallOrProduct: paywall });
+     *   const flow = await adapty.getFlow({ placementId: 'YOUR_PLACEMENT_ID' });
+     *   await adapty.openWebPaywall({ paywallOrProduct: flow.paywalls[0] });
      * } catch (error) {
      *   console.error('Failed to open web paywall:', error);
      * }
      * ```
      */
     openWebPaywall(options: {
-        paywallOrProduct: AdaptyPaywall | AdaptyPaywallProduct;
+        paywallOrProduct: AdaptyFlowPaywall | AdaptyPaywallProduct;
         openIn?: WebPresentation;
     }): Promise<void>;
     /**
@@ -384,7 +383,7 @@ export declare class Adapty implements AdaptyPlugin {
      * You can use this URL in a custom web view or a browser.
      *
      * @param options - The options object
-     * @param options.paywallOrProduct - The paywall or product to create a URL for.
+     * @param options.paywallOrProduct - The flow paywall or product to create a URL for.
      * @returns A promise that resolves with the web paywall URL.
      * @throws Error if an error occurs while creating the URL.
      *
@@ -393,8 +392,8 @@ export declare class Adapty implements AdaptyPlugin {
      * import { adapty } from '@adapty/capacitor';
      *
      * try {
-     *   const paywall = await adapty.getPaywall({ placementId: 'YOUR_PLACEMENT_ID' });
-     *   const url = await adapty.createWebPaywallUrl({ paywallOrProduct: paywall });
+     *   const flow = await adapty.getFlow({ placementId: 'YOUR_PLACEMENT_ID' });
+     *   const url = await adapty.createWebPaywallUrl({ paywallOrProduct: flow.paywalls[0] });
      *   console.log('Web paywall URL:', url);
      * } catch (error) {
      *   console.error('Failed to create web paywall URL:', error);
@@ -402,8 +401,62 @@ export declare class Adapty implements AdaptyPlugin {
      * ```
      */
     createWebPaywallUrl(options: {
-        paywallOrProduct: AdaptyPaywall | AdaptyPaywallProduct;
+        paywallOrProduct: AdaptyFlowPaywall | AdaptyPaywallProduct;
     }): Promise<string>;
+    /**
+     * Opens a URL using the native browser.
+     *
+     * @remarks
+     * Backs the default `onUrlPress` flow handler. Call it directly from a custom
+     * `onUrlPress` handler when you want to run your own logic but keep the native
+     * open-URL behavior. `openIn`: `browser_out_app` → external browser,
+     * `browser_in_app` → in-app browser.
+     *
+     * @param options - The options object
+     * @param options.url - The URL to open.
+     * @param options.openIn - Optional. How to present the URL ({@link WebPresentation}). When omitted, the native SDK decides.
+     * @returns A promise that resolves when the URL is opened.
+     * @throws Error if an error occurs while opening the URL.
+     *
+     * @example
+     * ```typescript
+     * import { adapty } from '@adapty/capacitor';
+     *
+     * try {
+     *   await adapty.openWebUrl({ url: 'https://example.com' });
+     * } catch (error) {
+     *   console.error('Failed to open URL:', error);
+     * }
+     * ```
+     */
+    openWebUrl(options: {
+        url: string;
+        openIn?: WebPresentation;
+    }): Promise<void>;
+    /**
+     * Requests the native app-review prompt.
+     *
+     * @remarks
+     * Uses `SKStoreReviewController` on iOS and In-App Review on Android. Backs the
+     * default `onRequestAppReview` flow handler. Call it directly from a custom
+     * `onRequestAppReview` handler when you want to run your own logic but keep the
+     * native prompt.
+     *
+     * @returns A promise that resolves when the native call completes.
+     * @throws Error if an error occurs while requesting the app review.
+     *
+     * @example
+     * ```typescript
+     * import { adapty } from '@adapty/capacitor';
+     *
+     * try {
+     *   await adapty.requestAppReview();
+     * } catch (error) {
+     *   console.error('Failed to request app review:', error);
+     * }
+     * ```
+     */
+    requestAppReview(): Promise<void>;
     /**
      * Logs out the current user.
      *
@@ -491,7 +544,7 @@ export declare class Adapty implements AdaptyPlugin {
      *
      * @param options - The options object
      * @param options.transactionId - The transaction ID of the purchase.
-     * @param options.variationId - Optional. The variation ID from the {@link AdaptyPaywall}.
+     * @param options.variationId - Optional. The variation ID from the {@link AdaptyFlow}.
      * @returns A promise that resolves when the transaction is reported.
      * @throws Error if an error occurs while reporting the transaction.
      *