surveysparrow-ionic-plugin 0.1.0 → 1.0.1

package/README.md

@@ -1,6 +1,6 @@
 # surveysparrow-ionic-plugin
 
-SurveySparrow SDK enables you to collect feedback from your mobile app. Embed the Classic, Chat & NPS surveys in your ionic application seamlessly with few lines of code.
+SurveySparrow SDK enables you to collect feedback from your mobile app. Embed the Classic, Chat & NPS surveys in your Ionic application seamlessly with few lines of code.
 
 ## Install
 
@@ -9,19 +9,40 @@ npm install surveysparrow-ionic-plugin
 npx cap sync
 ```
 
-## API
+## Permissions Required
+
+To use this plugin, ensure the following permissions are added to your app:
+
+### Android
+
+Add these permissions to your `AndroidManifest.xml`:
+
+```xml
+<uses-permission android:name="android.permission.INTERNET" />
+<uses-permission android:name="android.permission.CAMERA" />
+<uses-permission android:name="android.permission.RECORD_AUDIO" />
+```
 
-<docgen-index>
+### iOS
 
-* [`loadFullScreenSurvey(...)`](#loadfullscreensurvey)
-* [`loadFullScreenSurveyWithValidation(...)`](#loadfullscreensurveywithvalidation)
-* [Interfaces](#interfaces)
-* [Type Aliases](#type-aliases)
+Add the necessary permissions to your `Info.plist`:
 
-</docgen-index>
+```xml
+<key>NSCameraUsageDescription</key>
+<string>We need camera access to capture photos and videos.</string>
+<key>NSMicrophoneUsageDescription</key>
+<string>We need microphone access to record audio.</string>
+```
+
+### General Note
+
+Based on the survey type being used, ensure the necessary permissions (e.g., for photos, videos, audio, or storage) are added to your app's configuration.
 
-<docgen-api>
-<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+## API
+
+  [loadFullScreenSurvey(...)](#loadfullscreensurvey)
+  
+  [loadFullScreenSurveyWithValidation(...)](#loadfullscreensurveywithvalidation)
 
 ### loadFullScreenSurvey(...)
 
@@ -35,7 +56,6 @@ loadFullScreenSurvey(options: { domain: String; token: String; params: Object; p
 
 --------------------
 
-
 ### loadFullScreenSurveyWithValidation(...)
 
 ```typescript
@@ -45,5 +65,31 @@ loadFullScreenSurveyWithValidation(options: { domain: String; token: String; par
 | Param         | Type                                                                                                                                                                        |
 | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | **`options`** | <code>{ domain: <a href="#string">String</a>; token: <a href="#string">String</a>; params: <a href="#object">Object</a>; properties: <a href="#object">Object</a>; }</code> |
-
 --------------------
+
+## Validations  
+
+Validations include **Limit Submission Per User** and **Survey Throttling**.  
+
+To achieve this, the **`emailaddress`** of the user must be passed in the `params` object.  
+
+## Params  
+
+The `params` object allows passing **survey variables**, which can be accessed in the survey's end-user interface. Ensure that the spelling of survey variables matches the configured values. Additionally, make sure to include the **`emailaddress`** field.  
+
+## Properties  
+
+The `properties` object includes the following parameters:  
+
+1. **`isCloseButtonEnabled`** (default: `true`)  
+   - If set to `false`, the close button will be removed.  
+   - **Note:** Disabling this option will also disable the close button inside the survey.  
+
+2. **`langcode`** (default: `en`)  
+   - To load the survey in a specific language, pass the corresponding language code.  
+   - Ensure that the language is configured in the SurveySparrow app.  
+   - A list of supported language codes can be found [here](https://docs.google.com/document/d/1cmmWJQba8B3UkV6g5m93DgpenVojclzeOB0mdn-rlrg/edit?usp=sharing).  
+
+
+## Support
+For questions or issues, contact us at [support@surveysparrow.com](mailto:support@surveysparrow.com).

package/ios/Sources/SurveySparrowIonicPluginPlugin/SsSurveyView.swift

@@ -209,6 +209,7 @@ import WebKit
         let ssSurveyViewController = SsSurveyViewController()
         ssSurveyViewController.domain = domain
         ssSurveyViewController.token = token
+        ssSurveyViewController.modalPresentationStyle = .fullScreen
         ssSurveyViewController.properties = self.properties ?? [:]
         if(params != nil){
             ssSurveyViewController.params = params ?? [:]

package/ios/Sources/SurveySparrowIonicPluginPlugin/SurveySparrowIonicPlugin.swift

@@ -10,6 +10,7 @@ import SwiftUI
             ssSurveyViewController.domain = domain
             ssSurveyViewController.token = token
             ssSurveyViewController.params = params
+            ssSurveyViewController.modalPresentationStyle = .fullScreen
             ssSurveyViewController.properties = properties
             ssSurveyViewController.getSurveyLoadedResponse = true
             ssSurveyViewController.surveyDelegate = SsDelegate()

package/ios/Sources/SurveySparrowIonicPluginPlugin/SurveySparrowIonicPluginPlugin.swift

@@ -14,37 +14,37 @@ public class SurveySparrowIonicPluginPlugin: CAPPlugin, CAPBridgedPlugin {
     private let implementation = SurveySparrowIonicPlugin()
     
     @objc public func loadFullScreenSurvey(_ call: CAPPluginCall) {
-        
-        let domain = call.getString("domain")
-        let token = call.getString("token")
-        let params = call.getObject("params") as? [String : String]
-        let properties = call.getObject("properties")
-
-        guard let domain = domain, let token = token, let params = params, let properties = properties else {
-            call.reject("Invalid or missing parameters")
-            return
-        }
-
-        DispatchQueue.main.async {
-            self.implementation.loadFullScreenSurvey(domain: domain, token: token, params: params, properties: properties)
-        }
-    
+        handleFullScreenSurvey(call, withValidation: false)
     }
     
     @objc public func loadFullScreenSurveyWithValidation(_ call: CAPPluginCall) {
-
-        let domain = call.getString("domain")
-        let token = call.getString("token")
-        let params = call.getObject("params") as? [String : String]
-        let properties = call.getObject("properties")
-        
-        guard let domain = domain, let token = token, let params = params, let properties = properties else {
+        handleFullScreenSurvey(call, withValidation: true)
+    }
+    
+    private func handleFullScreenSurvey(_ call: CAPPluginCall, withValidation: Bool) {
+        guard
+            let domain = call.getString("domain"),
+            let token = call.getString("token"),
+            let params = call.getObject("params") as? [String: String],
+            var properties = call.getObject("properties")
+        else {
             call.reject("Invalid or missing parameters")
             return
         }
-
+        
+        if let langCode = properties["langCode"] {
+            properties["sparrowLang"] = langCode
+            properties.removeValue(forKey: "langCode")
+        } else {
+            properties["sparrowLang"] = "en"
+        }
+        
         DispatchQueue.main.async {
-            self.implementation.loadFullScreenSurveyWithValidation(domain: domain, token: token, params: params, properties: properties)
+            if withValidation {
+                self.implementation.loadFullScreenSurveyWithValidation(domain: domain, token: token, params: params, properties: properties)
+            } else {
+                self.implementation.loadFullScreenSurvey(domain: domain, token: token, params: params, properties: properties)
+            }
         }
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "surveysparrow-ionic-plugin",
-  "version": "0.1.0",
+  "version": "1.0.1",
   "description": "SurveySparrow SDK enables you to collect feedback from your mobile app. Embed the Classic, Chat & NPS surveys in your ionic application seamlessly with few lines of code.",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",