@tyrads.com/tyrads-sdk 2.0.0-beta.2 → 2.0.0

package/package.json

@@ -1,197 +1,197 @@
-{
-  "name": "@tyrads.com/tyrads-sdk",
-  "version": "2.0.0-beta.2",
-  "description": "Tyrads SDK for React Native ",
-  "source": "./src/index.tsx",
-  "main": "./lib/commonjs/index.js",
-  "module": "./lib/module/index.js",
-  "exports": {
-    ".": {
-      "import": {
-        "types": "./lib/typescript/module/src/index.d.ts",
-        "default": "./lib/module/index.js"
-      },
-      "require": {
-        "types": "./lib/typescript/commonjs/src/index.d.ts",
-        "default": "./lib/commonjs/index.js"
-      }
-    }
-  },
-  "files": [
-    "src",
-    "lib",
-    "android",
-    "ios",
-    "cpp",
-    "*.podspec",
-    "!ios/build",
-    "!android/build",
-    "!android/app/build",
-    "!android/gradle",
-    "!android/gradlew",
-    "!android/gradlew.bat",
-    "!android/local.properties",
-    "!**/__tests__",
-    "!**/__fixtures__",
-    "!**/__mocks__",
-    "!**/.*"
-  ],
-  "scripts": {
-    "example": "yarn workspace tyrads-sdk-example",
-    "test": "jest",
-    "typecheck": "tsc",
-    "lint": "eslint \"**/*.{js,ts,tsx}\"",
-    "clean": "del-cli android/build example/android/build example/android/app/build example/ios/build lib",
-    "prepare": "bob build",
-    "release": "release-it"
-  },
-  "keywords": [
-    "react-native",
-    "ios",
-    "android"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/tyrads-com/tyrads-sdk-reactnative.git"
-  },
-  "author": "dev@acmo.in <dev@acmo.in> (https://tyrads.com)",
-  "license": " BSD-3-Clause",
-  "bugs": {
-    "url": "https://github.com/tyrads-com/tyrads-sdk-reactnative/issues"
-  },
-  "homepage": "https://github.com/tyrads-com/tyrads-sdk-reactnative#readme",
-  "publishConfig": {
-    "registry": "https://registry.npmjs.org/"
-  },
-  "devDependencies": {
-    "@commitlint/config-conventional": "^17.0.2",
-    "@evilmartians/lefthook": "^1.5.0",
-    "@react-native/eslint-config": "^0.73.1",
-    "@release-it/conventional-changelog": "^5.0.0",
-    "@types/jest": "^29.5.5",
-    "@types/numeral": "^2.0.5",
-    "@types/react": "^18.2.44",
-    "commitlint": "^17.0.2",
-    "del-cli": "^5.1.0",
-    "eslint": "^8.51.0",
-    "eslint-config-prettier": "^9.0.0",
-    "eslint-plugin-prettier": "^5.0.1",
-    "jest": "^29.7.0",
-    "prettier": "^3.0.3",
-    "react": "18.2.0",
-    "react-native": "0.74.5",
-    "react-native-builder-bob": "^0.29.0",
-    "release-it": "^15.0.0",
-    "turbo": "^1.10.7",
-    "typescript": "^5.2.2"
-  },
-  "resolutions": {
-    "@types/react": "^18.2.44"
-  },
-  "peerDependencies": {
-    "react": "*",
-    "react-native": "*"
-  },
-  "workspaces": [
-    "example"
-  ],
-  "packageManager": "yarn@3.6.1",
-  "jest": {
-    "preset": "react-native",
-    "modulePathIgnorePatterns": [
-      "<rootDir>/example/node_modules",
-      "<rootDir>/lib/"
-    ]
-  },
-  "commitlint": {
-    "extends": [
-      "@commitlint/config-conventional"
-    ]
-  },
-  "release-it": {
-    "git": {
-      "commitMessage": "chore: release ${version}",
-      "tagName": "v${version}"
-    },
-    "npm": {
-      "publish": true
-    },
-    "github": {
-      "release": true
-    },
-    "plugins": {
-      "@release-it/conventional-changelog": {
-        "preset": "angular"
-      }
-    }
-  },
-  "eslintConfig": {
-    "root": true,
-    "extends": [
-      "@react-native",
-      "prettier"
-    ],
-    "rules": {
-      "react/react-in-jsx-scope": "off",
-      "prettier/prettier": [
-        "error",
-        {
-          "quoteProps": "consistent",
-          "singleQuote": true,
-          "tabWidth": 2,
-          "trailingComma": "es5",
-          "useTabs": false
-        }
-      ]
-    }
-  },
-  "eslintIgnore": [
-    "node_modules/",
-    "lib/"
-  ],
-  "prettier": {
-    "quoteProps": "consistent",
-    "singleQuote": true,
-    "tabWidth": 2,
-    "trailingComma": "es5",
-    "useTabs": false
-  },
-  "react-native-builder-bob": {
-    "source": "src",
-    "output": "lib",
-    "targets": [
-      [
-        "commonjs",
-        {
-          "esm": true
-        }
-      ],
-      [
-        "module",
-        {
-          "esm": true
-        }
-      ],
-      [
-        "typescript",
-        {
-          "project": "tsconfig.build.json",
-          "esm": true
-        }
-      ]
-    ]
-  },
-  "create-react-native-library": {
-    "type": "module-legacy",
-    "languages": "kotlin-swift",
-    "version": "0.40.0"
-  },
-  "dependencies": {
-    "@react-native-async-storage/async-storage": "^2.1.2",
-    "axios": "^1.8.1",
-    "i18next": "^24.2.2",
-    "numeral": "^2.0.6",
-    "react-i18next": "^15.4.1",
-    "react-native-text-ticker": "^1.14.0"
-  }
-}
+{
+  "name": "@tyrads.com/tyrads-sdk",
+  "version": "2.0.0",
+  "description": "Tyrads SDK for React Native ",
+  "source": "./src/index.tsx",
+  "main": "./lib/commonjs/index.js",
+  "module": "./lib/module/index.js",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./lib/typescript/module/src/index.d.ts",
+        "default": "./lib/module/index.js"
+      },
+      "require": {
+        "types": "./lib/typescript/commonjs/src/index.d.ts",
+        "default": "./lib/commonjs/index.js"
+      }
+    }
+  },
+  "files": [
+    "src",
+    "lib",
+    "android",
+    "ios",
+    "cpp",
+    "*.podspec",
+    "!ios/build",
+    "!android/build",
+    "!android/app/build",
+    "!android/gradle",
+    "!android/gradlew",
+    "!android/gradlew.bat",
+    "!android/local.properties",
+    "!**/__tests__",
+    "!**/__fixtures__",
+    "!**/__mocks__",
+    "!**/.*"
+  ],
+  "scripts": {
+    "example": "yarn workspace tyrads-sdk-example",
+    "test": "jest",
+    "typecheck": "tsc",
+    "lint": "eslint \"**/*.{js,ts,tsx}\"",
+    "clean": "del-cli android/build example/android/build example/android/app/build example/ios/build lib",
+    "prepare": "bob build",
+    "release": "release-it"
+  },
+  "keywords": [
+    "react-native",
+    "ios",
+    "android"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tyrads-com/tyrads-sdk-reactnative.git"
+  },
+  "author": "dev@acmo.in <dev@acmo.in> (https://tyrads.com)",
+  "license": " BSD-3-Clause",
+  "bugs": {
+    "url": "https://github.com/tyrads-com/tyrads-sdk-reactnative/issues"
+  },
+  "homepage": "https://github.com/tyrads-com/tyrads-sdk-reactnative#readme",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "devDependencies": {
+    "@commitlint/config-conventional": "^17.0.2",
+    "@evilmartians/lefthook": "^1.5.0",
+    "@react-native/eslint-config": "^0.73.1",
+    "@release-it/conventional-changelog": "^5.0.0",
+    "@types/jest": "^29.5.5",
+    "@types/numeral": "^2.0.5",
+    "@types/react": "^18.2.44",
+    "commitlint": "^17.0.2",
+    "del-cli": "^5.1.0",
+    "eslint": "^8.51.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-prettier": "^5.0.1",
+    "jest": "^29.7.0",
+    "prettier": "^3.0.3",
+    "react": "18.2.0",
+    "react-native": "0.74.5",
+    "react-native-builder-bob": "^0.29.0",
+    "release-it": "^15.0.0",
+    "turbo": "^1.10.7",
+    "typescript": "^5.2.2"
+  },
+  "resolutions": {
+    "@types/react": "^18.2.44"
+  },
+  "peerDependencies": {
+    "react": "*",
+    "react-native": "*"
+  },
+  "workspaces": [
+    "example"
+  ],
+  "packageManager": "yarn@3.6.1",
+  "jest": {
+    "preset": "react-native",
+    "modulePathIgnorePatterns": [
+      "<rootDir>/example/node_modules",
+      "<rootDir>/lib/"
+    ]
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "release-it": {
+    "git": {
+      "commitMessage": "chore: release ${version}",
+      "tagName": "v${version}"
+    },
+    "npm": {
+      "publish": true
+    },
+    "github": {
+      "release": true
+    },
+    "plugins": {
+      "@release-it/conventional-changelog": {
+        "preset": "angular"
+      }
+    }
+  },
+  "eslintConfig": {
+    "root": true,
+    "extends": [
+      "@react-native",
+      "prettier"
+    ],
+    "rules": {
+      "react/react-in-jsx-scope": "off",
+      "prettier/prettier": [
+        "error",
+        {
+          "quoteProps": "consistent",
+          "singleQuote": true,
+          "tabWidth": 2,
+          "trailingComma": "es5",
+          "useTabs": false
+        }
+      ]
+    }
+  },
+  "eslintIgnore": [
+    "node_modules/",
+    "lib/"
+  ],
+  "prettier": {
+    "quoteProps": "consistent",
+    "singleQuote": true,
+    "tabWidth": 2,
+    "trailingComma": "es5",
+    "useTabs": false
+  },
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      [
+        "commonjs",
+        {
+          "esm": true
+        }
+      ],
+      [
+        "module",
+        {
+          "esm": true
+        }
+      ],
+      [
+        "typescript",
+        {
+          "project": "tsconfig.build.json",
+          "esm": true
+        }
+      ]
+    ]
+  },
+  "create-react-native-library": {
+    "type": "module-legacy",
+    "languages": "kotlin-swift",
+    "version": "0.40.0"
+  },
+  "dependencies": {
+    "@react-native-async-storage/async-storage": "^2.1.2",
+    "axios": "^1.8.1",
+    "i18next": "^24.2.2",
+    "numeral": "^2.0.6",
+    "react-i18next": "^15.4.1",
+    "react-native-text-ticker": "^1.14.0"
+  }
+}

package/readme.md

@@ -1,97 +1,95 @@
-# tyrads-sdk
-
-Tyrads SDK for React Native 
-
-## Installation
-
-```sh
-npm install @tyrads.com/tyrads-sdk
-# or
-yarn add @tyrads.com/tyrads-sdk
-```
-
-## Usage
-
-
-```js
-import Tyrads from '@tyrads.com/tyrads-sdk';
-
-// ...
-
-
-    Tyrads.init('', '');
-    Tyrads.loginUser('');
-    Tyrads.showOffers();
-```
-
-
-</br>
-<details>
-<summary><strong>Launch Mode</strong></summary>
-
-
-</br>
-
-##### Min SDK version required: v1.1.6
-##### Works only for iOS 
-
-</br>
-
-Tyrads SDK provides the ability to open the Offerwall in a webkit view that is embedded in the app to provide a seamless user experience. Also, it provides the ability to open the Offerwall in an external browser (Safari) if Apple's app store policy does not approve the in-app rewards system for the app.
-
-Available launch modes:
-- `launchMode: 3` - opens the Offerwall in an external browser (Safari)
-- `launchMode: 2` - opens the Offerwall in a webkit view that is embedded in the app
-
-```js
-
-// Note: The launchMode parameter is optional, if not specified the default would be opening the Offerwall in an external browser (Safari)
-
-Tyrads.showOffers({ launchMode: 3 });// provide launchMode: 2 to open the Offerwall in a webkit view that is embedded in the app
-
-```
-</details>
-
-
-
-</br>
-<details>
-<summary><strong>Deeplinking Routes</strong></summary>
-
-
-</br>
-
-##### Min SDK version required: v1.1.6
-
-</br>
-
-The Tyrads SDK supports deeplinking to specific sections of the offerwall. When initializing or interacting with the SDK, you can specify a route to open a particular page. For campaign-specific routes, you'll need to provide the campaignID as well.
-
-Available routes and their usage:
-- `campaigns` - opens the Campaigns Page
-- `campaigns-activated` - opens the Activated Campaigns Page
-- `campaign-details` - opens the Campaign Details Page (requires campaignID)
-- `campaign-tickets` - opens the Campaign Tickets Page (requires campaignID)
-
-```js
-
-// Default route (Campaigns Page)
-Tyrads.showOffers();
-
-// Explicitly specifying the Campaigns Page
-Tyrads.showOffers({ route: "campaigns" });
-
-// Activated Campaigns Page
-Tyrads.showOffers({ route: "campaigns-activated" });
-
-// Campaign Details Page (requires campaignID)
-Tyrads.showOffers({ route: "campaign-details", campaignID: "your_campaign_id_here" });
-
-// Campaign Tickets Page (requires campaignID)
-Tyrads.showOffers({ route: "campaign-tickets", campaignID: "your_campaign_id_here" });
-
-```
-</details>
-
-</br></br>
-
+# tyrads-sdk
+
+Tyrads SDK for React Native 
+
+## Installation
+
+```sh
+npm install @tyrads.com/tyrads-sdk
+```
+
+## Usage
+
+
+```js
+import Tyrads from '@tyrads.com/tyrads-sdk';
+
+// ...
+
+
+    Tyrads.init('', '');
+    Tyrads.loginUser('');
+    Tyrads.showOffers();
+```
+
+
+</br>
+<details>
+<summary><strong>Launch Mode</strong></summary>
+
+
+</br>
+
+##### Min SDK version required: v1.1.6
+##### Works only for iOS 
+
+</br>
+
+Tyrads SDK provides the ability to open the Offerwall in a webkit view that is embedded in the app to provide a seamless user experience. Also, it provides the ability to open the Offerwall in an external browser (Safari) if Apple's app store policy does not approve the in-app rewards system for the app.
+
+Available launch modes:
+- `launchMode: 3` - opens the Offerwall in an external browser (Safari)
+- `launchMode: 2` - opens the Offerwall in a webkit view that is embedded in the app
+
+```js
+
+// Note: The launchMode parameter is optional, if not specified the default would be opening the Offerwall in an external browser (Safari)
+
+Tyrads.showOffers({ launchMode: 3 });// provide launchMode: 2 to open the Offerwall in a webkit view that is embedded in the app
+
+```
+</details>
+
+
+
+</br>
+<details>
+<summary><strong>Deeplinking Routes</strong></summary>
+
+
+</br>
+
+##### Min SDK version required: v1.1.6
+
+</br>
+
+The Tyrads SDK supports deeplinking to specific sections of the offerwall. When initializing or interacting with the SDK, you can specify a route to open a particular page. For campaign-specific routes, you'll need to provide the campaignID as well.
+
+Available routes and their usage:
+- `campaigns` - opens the Campaigns Page
+- `campaigns-activated` - opens the Activated Campaigns Page
+- `campaign-details` - opens the Campaign Details Page (requires campaignID)
+- `campaign-tickets` - opens the Campaign Tickets Page (requires campaignID)
+
+```js
+
+// Default route (Campaigns Page)
+Tyrads.showOffers();
+
+// Explicitly specifying the Campaigns Page
+Tyrads.showOffers({ route: "campaigns" });
+
+// Activated Campaigns Page
+Tyrads.showOffers({ route: "campaigns-activated" });
+
+// Campaign Details Page (requires campaignID)
+Tyrads.showOffers({ route: "campaign-details", campaignID: "your_campaign_id_here" });
+
+// Campaign Tickets Page (requires campaignID)
+Tyrads.showOffers({ route: "campaign-tickets", campaignID: "your_campaign_id_here" });
+
+```
+</details>
+
+</br></br>
+