leap-capacitor 2.2.5 → 2.3.0

package/LICENSE.md

@@ -0,0 +1,105 @@
+# WHATFIX MOBILE SDK LICENSE AGREEMENT
+
+**IMPORTANT — READ CAREFULLY:** BY DOWNLOADING, INSTALLING OR USING THE WHATFIX MOBILE SOFTWARE DEVELOPMENT KIT (THE "SDK"), YOU AGREE TO THIS AGREEMENT. IF YOU DO NOT AGREE, YOU MUST NOT DOWNLOAD, INSTALL OR USE THE SDK.
+
+This Agreement is between you ("Licensee" or "you") and the Whatfix entity identified in your master services agreement (MSA) ("Whatfix"). If you act on behalf of a legal entity, you represent that you have authority to bind that entity, and "Licensee" means that entity.
+
+## 1. Definitions
+
+**1.1 "Authorized Application"** means a mobile application owned or operated by Licensee and authorized for use with the Whatfix Platform under the MSA.
+
+**1.2 "MSA"** means the applicable master services agreement (MSA) between Licensee and Whatfix governing the Whatfix Platform, whether accepted electronically or signed, including applicable Order Forms and the data processing addendum ("DPA").
+
+**1.3 "Documentation"** means Whatfix's published integration guides, API references and README files for the SDK.
+
+**1.4 "SDK"** means the Whatfix mobile software development kits, including iOS and Android components, made available to Licensee in object-code (binary) form, together with any updates supplied by Whatfix and the Documentation.
+
+**1.5 "Whatfix Platform"** means Whatfix's hosted services with which the SDK communicates, including configuration, content-delivery and analytics endpoints.
+
+## 2. License Grant
+
+**2.1** Subject to compliance with this Agreement and the MSA, Whatfix grants Licensee a non-exclusive, non-transferable (except as permitted under the MSA), non-sublicensable license, for the applicable subscription term and within the purchased usage limits, to:
+
+(a) install and make reasonable copies of the SDK for development, integration and testing of Authorized Applications;
+
+(b) integrate and link the SDK into Authorized Applications solely to enable their use with the Whatfix Platform;
+
+(c) reproduce and distribute the SDK solely in binary form as embedded in Authorized Applications through public app stores or internal enterprise distribution, and permit end users to execute the embedded SDK solely as part of those applications; and
+
+(d) use and reasonably copy the Documentation internally to support those activities.
+
+**2.2** Licensee may permit its employees and contractors acting on its behalf to exercise these rights solely for Licensee's benefit, subject to confidentiality and use restrictions no less protective than those applicable under this Agreement. Licensee remains responsible for their compliance. End users receive no right to extract, modify or separately use the SDK.
+
+**2.3** This Agreement does not independently grant access to the Whatfix Platform or expand any subscription entitlement.
+
+## 3. License Restrictions
+
+Licensee shall not, and shall not permit any third party to:
+
+(a) except as expressly permitted under this Agreement, copy, modify, translate or create derivative works of the SDK;
+
+(b) reverse engineer, decompile or disassemble the SDK, or attempt to derive its source code, except to the extent applicable law prohibits this restriction;
+
+(c) distribute, sell, rent, lease or sublicense the SDK as a standalone product, library or wrapper;
+
+(d) remove or alter proprietary, copyright or open-source notices;
+
+(e) use the SDK to build a competing digital adoption or in-app guidance product;
+
+(f) include Creator components or debug variants in production releases distributed to end users; such components are solely for authorized pre-production authoring and preview use; or
+
+(g) circumvent license restrictions, usage limits, authentication or security controls applicable to the SDK or Whatfix Platform.
+
+These restrictions are subject to Section 6 for Third-Party Components.
+
+## 4. Ownership and Confidentiality
+
+**4.1** Whatfix and its licensors retain all right, title and interest in the SDK, Documentation and Whatfix Platform, including all intellectual property rights. Licensee retains all right, title and interest in its Authorized Applications, excluding the SDK. No rights are granted except as expressly stated. Whatfix may use feedback or suggestions voluntarily provided by Licensee perpetually and without obligation, but this does not authorize disclosure of Licensee's confidential information or use of its personal data contrary to the MSA or DPA.
+
+**4.2** Non-public SDK materials, Documentation and access credentials are Whatfix confidential information subject to the MSA's confidentiality provisions.
+
+## 5. Integration and Data Practices
+
+**5.1 Integration:** Licensee shall use the SDK through its documented public APIs and in accordance with the Documentation. Licensee is responsible for its application code, integration and testing, and applicable app-store submissions and disclosures. These responsibilities do not limit Whatfix's express obligations under the MSA.
+
+**5.2 User Data:** Licensee is responsible for determining the user identifiers and properties it supplies or configures for transmission through the SDK. The SDK may also generate or collect usage, interaction and device information as described in the applicable Documentation. Licensee shall not intentionally supply special-category personal data, government identifiers or payment card data through the SDK and shall configure the integration to prevent their collection or transmission, except to the extent expressly permitted under the MSA and DPA.
+
+**5.3 Notices and Consents:** Licensee is responsible for providing legally required privacy notices, establishing an appropriate lawful basis, and obtaining any required consents before relevant collection or processing begins, including applicable app-store privacy disclosures. Where consent is required and is withheld or withdrawn, Licensee shall prevent or stop the relevant collection and processing through its integration and the appropriate controls described in the Documentation for the applicable SDK version.
+
+**5.4 Processing by Whatfix:** Whatfix's processing of personal data through the SDK is governed by the MSA and applicable DPA. This Agreement does not expand Whatfix's rights to use such data.
+
+## 6. Third-Party Components
+
+The SDK may include third-party components subject to separate license terms ("Third-Party Components"), identified in the accompanying third-party notices or Documentation. Those terms govern the relevant components and prevail over this Agreement to the extent of a conflict. Licensee shall preserve and reproduce attribution and license notices as required by those terms. Nothing in this Agreement restricts rights granted under the applicable third-party licenses.
+
+## 7. Support, Warranties and Disclaimers
+
+**7.1** Any support, maintenance, updates, warranties and indemnities for the SDK are governed exclusively by the MSA. Supported SDK versions and technical compatibility requirements are described in the applicable Documentation or support policy, subject to the MSA. This Agreement creates no additional obligation to provide support, updates or compatibility with every application, device or operating-system version.
+
+**7.2** EXCEPT AS EXPRESSLY PROVIDED IN THE MSA AND TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SDK IS PROVIDED "AS IS" AND "AS AVAILABLE." WHATFIX DISCLAIMS ALL OTHER WARRANTIES, EXPRESS OR IMPLIED, INCLUDING MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. WHATFIX DOES NOT WARRANT UNINTERRUPTED OR ERROR-FREE OPERATION. THE SDK IS NOT DESIGNED FOR USE IN HIGH-RISK ACTIVITIES WHERE FAILURE COULD REASONABLY RESULT IN DEATH, PERSONAL INJURY OR SERIOUS ENVIRONMENTAL DAMAGE.
+
+## 8. Limitation of Liability
+
+All liability arising out of or relating to the SDK or this Agreement is subject to that MSA's limitations and exclusions of liability, including its applicable exceptions. Such liability forms part of, and does not create a separate or additional limit from, the applicable aggregate liability limits under the MSA.
+
+## 9. Term and Termination
+
+**9.1** This Agreement takes effect upon Licensee's first download, installation or use of the SDK and continues for the applicable subscription term, unless terminated earlier in accordance with this Section.
+
+**9.2** Suspension and termination rights, notices and cure periods are governed by that agreement. The SDK license ends upon expiry or termination of the subscription for which the SDK is provided, unless otherwise agreed in writing.
+
+**9.3** Upon expiry or termination, Licensee shall cease development and new distribution using the SDK, cease access to the Whatfix Platform, and remove the SDK from development environments and production releases distributed after thirty (30) days from expiry or termination. Licensee shall take commercially reasonable steps, as soon as reasonably practicable, to disable SDK functionality in previously distributed applications and remove the SDK through application updates. Licensee need not recall or remotely delete applications from end-user devices where it lacks the technical ability to do so. Any SDK copies remaining on such devices may not be used to access the Whatfix Platform. Licensee shall destroy other SDK copies in its possession or control, except a copy required by law or retained in routine backups, which must remain protected and unused until deleted in the ordinary course. Any temporary retention permitted by this Section grants no continued production-use rights.
+
+**9.4** Sections 3, 4, 6, 7.2, 8, 9.3, 9.4 and 10 survive expiry or termination. Section 5.4 continues to apply to any retained personal data. The MSA's survival provisions also apply.
+
+## 10. General
+
+**10.1 Relationship with MSA:** The SDK forms part of the services provided under that agreement. Its provisions concerning confidentiality, data protection, warranties, indemnification, support, suspension, termination and liability apply to the SDK. This Agreement supplements that agreement solely with respect to SDK licensing and use. In the event of conflict, the MSA controls, subject to its own order-of-precedence provisions.
+
+**10.2 Governing Law and Disputes:** The governing law and dispute-resolution provisions of the MSA apply to this Agreement.
+
+**10.3 Notices:** Notices shall follow the MSA.
+
+**10.4 Assignment:** Assignment is governed by the MSA.
+
+**10.5 Entire Agreement; Other Terms:** This Agreement and the MSA constitute the entire agreement concerning the SDK. Amendments must be agreed in writing by authorized representatives, including electronically. If a provision is unenforceable, the remainder remains effective. Failure to enforce a provision is not a waiver. Neither party is the other's agent or partner.

package/LeapCapacitor.podspec

@@ -1,19 +1,22 @@
-require 'json'
+require "json"
 
-package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+# The package version and the Leap SDK versions come from package.json (see scripts/bump.js).
+# Capacitor apps that use Swift Package Manager get Package.swift instead.
+package = JSON.parse(File.read(File.join(__dir__, "package.json")))
 
 Pod::Spec.new do |s|
-  s.name = 'LeapCapacitor'
-  s.version = package['version']
-  s.summary = package['description']
-  s.license = package['license']
-  s.homepage = package['repository']['url']
-  s.author = package['author']
-  s.source = { :git => package['repository']['url'], :tag => s.version.to_s }
-  s.source_files = 'ios/Plugin/**/*.{swift,h,m,c,cc,mm,cpp}'
-  s.ios.deployment_target  = '15.0'
-  s.dependency 'Capacitor'
-  s.swift_version = '5.1'
+  s.name = "LeapCapacitor"
+  s.version = package["version"]
+  s.summary = package["description"]
+  s.license = { :type => "Commercial", :file => "LICENSE.md" }
+  s.homepage = "https://leap.whatfix.com/"
+  s.author = package["author"]
+  # Installed from the npm package (Capacitor's Podfile uses :path), never from this source.
+  s.source = { :git => "https://github.com/whatfix/capacitor-plugin.git", :tag => s.version.to_s }
+  s.source_files = "ios/Sources/**/*.swift"
+  s.ios.deployment_target = "15.0"
+  s.dependency "Capacitor"
+  s.swift_version = "5.1"
 
-  s.dependency "LeapSDK", "2.2.9"
+  s.dependency "LeapSDK", package["leapSdk"]["ios"]
 end

package/Package.swift

@@ -0,0 +1,30 @@
+// swift-tools-version: 5.9
+// leap-capacitor for Capacitor apps that use Swift Package Manager (Capacitor 6+); CocoaPods apps use
+// LeapCapacitor.podspec. The Capacitor CLI names the package after the npm package (LeapCapacitor).
+//
+// The Leap iOS SDK version is set by scripts/bump.js from package.json (leapSdk.ios), and npm only
+// ships this file from Leap iOS 2.2.12, the first release whose Swift package resolves.
+import PackageDescription
+
+let package = Package(
+    name: "LeapCapacitor",
+    platforms: [.iOS(.v15)],
+    products: [
+        .library(name: "LeapCapacitor", targets: ["LeapPlugin"])
+    ],
+    dependencies: [
+        .package(url: "https://github.com/ionic-team/capacitor-swift-pm.git", "6.0.0"..<"9.0.0"),
+        .package(url: "https://github.com/Leap-Platform/leap-ios.git", exact: "2.3.0")
+    ],
+    targets: [
+        .target(
+            name: "LeapPlugin",
+            dependencies: [
+                .product(name: "Capacitor", package: "capacitor-swift-pm"),
+                .product(name: "Cordova", package: "capacitor-swift-pm"),
+                .product(name: "LeapSDK", package: "leap-ios")
+            ],
+            path: "ios/Sources/LeapPlugin"
+        )
+    ]
+)

package/android/build.gradle

@@ -17,6 +17,9 @@ buildscript {
 
 apply plugin: 'com.android.library'
 
+// The Leap Android SDK version comes from the package's package.json (leapSdk.android).
+def leapSdkVersions = new groovy.json.JsonSlurper().parse(file("$projectDir/../package.json")).leapSdk
+
 android {
     namespace "is.leap.capacitor"
     compileSdkVersion project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 36
@@ -51,7 +54,7 @@ repositories {
 dependencies {
     implementation fileTree(dir: 'libs', include: ['*.jar'])
     implementation project(':capacitor-android')
-    implementation 'is.leap.android:sdk:2.2.13'
+    implementation "is.leap.android:sdk:${leapSdkVersions.android}"
     implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
     testImplementation "junit:junit:$junitVersion"
     androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"

package/ios/{Plugin → Sources/LeapPlugin}/LeapPlugin.swift

@@ -22,9 +22,25 @@ let LEAP_EXCEPTION_CALLBACKS = "leapExceptionCallbacks"
  * here: https://capacitorjs.com/docs/plugins/ios
  */
 @objc(LeapPlugin)
+public class LeapPlugin: CAPPlugin, CAPBridgedPlugin {
+    // Registers the plugin with Capacitor (6+), replacing the CAP_PLUGIN macro in LeapPlugin.m, which
+    // Swift Package Manager can't build. Keep in sync with LeapPluginInterface in src/definitions.ts.
+    public let identifier = "LeapPlugin"
+    public let jsName = "LeapPlugin"
+    public let pluginMethods: [CAPPluginMethod] = [
+        CAPPluginMethod(name: "start", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "startWithSelfHostingEnabled", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "flushProperties", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "startProject", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "embedProject", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "setUniqueUserId", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "setAppLocale", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "offlineSync", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "disable", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "logout", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "registerExceptionCallback", returnType: CAPPluginReturnPromise)
+    ]
 
-public class LeapPlugin: CAPPlugin {
-    
     var exceptionCall:CAPPluginCall?
     
     @objc public func start(_ call: CAPPluginCall) {

package/package.json

@@ -1,27 +1,26 @@
 {
   "name": "leap-capacitor",
-  "version": "2.2.5",
+  "version": "2.3.0",
+  "leapSdk": {
+    "ios": "2.3.0",
+    "android": "2.3.0"
+  },
   "description": "Plugin for Leap",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
   "types": "dist/esm/index.d.ts",
   "unpkg": "dist/plugin.js",
   "files": [
+    "LICENSE.md",
     "android/src/main/",
     "android/build.gradle",
     "dist/",
-    "ios/Plugin/",
-    "LeapCapacitor.podspec"
+    "ios/Sources/",
+    "LeapCapacitor.podspec",
+    "Package.swift"
   ],
   "author": "Leap",
-  "license": "Apache-2.0",
-  "repository": {
-    "type": "git",
-    "url": "https://www.npmjs.com/package/leap-capacitor.git"
-  },
-  "bugs": {
-    "url": "https://www.npmjs.com/package/leap-capacitor/issues"
-  },
+  "license": "SEE LICENSE IN LICENSE.md",
   "keywords": [
     "capacitor",
     "plugin",
@@ -29,7 +28,7 @@
   ],
   "scripts": {
     "verify": "npm run verify:ios && npm run verify:android && npm run verify:web",
-    "verify:ios": "cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin && cd ..",
+    "verify:ios": "xcodebuild build -scheme LeapCapacitor -destination generic/platform=iOS",
     "verify:android": "cd android && ./gradlew clean build test && cd ..",
     "verify:web": "npm run build",
     "lint": "npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint",
@@ -62,10 +61,10 @@
     "typescript": "^5.9.3"
   },
   "peerDependencies": {
-    "@capacitor/core": ">=3.0.0"
+    "@capacitor/core": ">=6.0.0"
   },
   "prettier": "@ionic/prettier-config",
-  "swiftlint": "@ionic/swiftlint-config",  
+  "swiftlint": "@ionic/swiftlint-config",
   "capacitor": {
     "ios": {
       "src": "ios"
@@ -80,4 +79,4 @@
     "glob": "^10.0.0",
     "rimraf": "^5.0.0"
   }
-}
+}

package/ios/Plugin/Info.plist

@@ -1,24 +0,0 @@
-<?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>CFBundleDevelopmentRegion</key>
-	<string>$(DEVELOPMENT_LANGUAGE)</string>
-	<key>CFBundleExecutable</key>
-	<string>$(EXECUTABLE_NAME)</string>
-	<key>CFBundleIdentifier</key>
-	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
-	<key>CFBundleInfoDictionaryVersion</key>
-	<string>6.0</string>
-	<key>CFBundleName</key>
-	<string>$(PRODUCT_NAME)</string>
-	<key>CFBundlePackageType</key>
-	<string>FMWK</string>
-	<key>CFBundleShortVersionString</key>
-	<string>1.0</string>
-	<key>CFBundleVersion</key>
-	<string>$(CURRENT_PROJECT_VERSION)</string>
-	<key>NSPrincipalClass</key>
-	<string></string>
-</dict>
-</plist>

package/ios/Plugin/LeapPlugin.h

@@ -1,10 +0,0 @@
-#import <UIKit/UIKit.h>
-
-//! Project version number for Plugin.
-FOUNDATION_EXPORT double PluginVersionNumber;
-
-//! Project version string for Plugin.
-FOUNDATION_EXPORT const unsigned char PluginVersionString[];
-
-// In this header, you should import all the public headers of your framework using statements like #import <Plugin/PublicHeader.h>
-

package/ios/Plugin/LeapPlugin.m

@@ -1,18 +0,0 @@
-#import <Foundation/Foundation.h>
-#import <Capacitor/Capacitor.h>
-
-// Define the plugin using the CAP_PLUGIN Macro, and
-// each method the plugin supports using the CAP_PLUGIN_METHOD macro.
-CAP_PLUGIN(LeapPlugin, "LeapPlugin",
-           CAP_PLUGIN_METHOD(start, CAPPluginReturnPromise);
-           CAP_PLUGIN_METHOD(startWithSelfHostingEnabled, CAPPluginReturnPromise);
-           CAP_PLUGIN_METHOD(flushProperties, CAPPluginReturnPromise);
-           CAP_PLUGIN_METHOD(startProject, CAPPluginReturnPromise);
-           CAP_PLUGIN_METHOD(embedProject, CAPPluginReturnPromise);
-           CAP_PLUGIN_METHOD(setUniqueUserId, CAPPluginReturnPromise);
-           CAP_PLUGIN_METHOD(setAppLocale, CAPPluginReturnPromise);
-           CAP_PLUGIN_METHOD(offlineSync, CAPPluginReturnPromise);
-           CAP_PLUGIN_METHOD(disable, CAPPluginReturnPromise);
-           CAP_PLUGIN_METHOD(logout, CAPPluginReturnPromise);
-           CAP_PLUGIN_METHOD(registerExceptionCallback, CAPPluginReturnPromise);
-)