Add ESLint configuration and fix TypeScript definition issues

al-af · al-af · commit c03c688064b9 · 2025-11-25T13:49:54.000+02:00
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -0,0 +1,72 @@
+/**
+ * ESLint configuration for react-native-appsflyer plugin
+ * Optimized for TypeScript + React Native library development
+ */
+
+module.exports = {
+  root: true,
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 2020,
+    sourceType: 'module',
+    ecmaFeatures: { jsx: true },
+  },
+
+  env: {
+    node: true,
+    es6: true,
+  },
+
+  plugins: [
+    '@typescript-eslint',
+  ],
+
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+  ],
+
+  rules: {
+    // JS/TS hygiene
+    'no-console': 'off',
+    '@typescript-eslint/no-unused-vars': ['warn', { argsIgnorePattern: '^_' }],
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/no-var-requires': 'off', // Allow require() in CommonJS files
+    
+    // Import/export rules - disabled because TypeScript handles this
+    // and our index.d.ts properly declares all exports for ESLint compatibility
+    'import/default': 'off',
+    'import/named': 'off',
+    'import/no-unresolved': 'off',
+  },
+  overrides: [
+    {
+      files: ['expo/**/*.js'],
+      rules: {
+        '@typescript-eslint/no-var-requires': 'off', // Expo config plugins use require()
+      },
+    },
+    {
+      files: ['**/*.ts', '**/*.tsx'],
+      rules: {
+        // TypeScript-specific rules
+        'no-undef': 'off', // TypeScript handles this
+      },
+    },
+  ],
+
+  ignorePatterns: [
+    'node_modules/**',
+    'demos/**',
+    'android/**',
+    'ios/**',
+    'build/**',
+    'dist/**',
+    '__tests__/**',
+    '*.config.js',
+    'babel.config.js',
+    'metro.config.js',
+    'jest.config.js',
+    'react-native.config.js',
+  ],
+};
diff --git a/PurchaseConnector/models/canceled_state_context.ts b/PurchaseConnector/models/canceled_state_context.ts
@@ -52,7 +52,7 @@ export class CanceledStateContext {
 class DeveloperInitiatedCancellation {
   constructor() {}
 
-  static fromJson(json: any): DeveloperInitiatedCancellation {
+  static fromJson(_json: any): DeveloperInitiatedCancellation {
     // Here you would implement the conversion from JSON to DeveloperInitiatedCancellation instance
     return new DeveloperInitiatedCancellation();
   }
@@ -66,7 +66,7 @@ class DeveloperInitiatedCancellation {
 class ReplacementCancellation {
   constructor() {}
 
-  static fromJson(json: any): ReplacementCancellation {
+  static fromJson(_json: any): ReplacementCancellation {
     // Here you would implement the conversion from JSON to ReplacementCancellation instance
     return new ReplacementCancellation();
   }
@@ -79,7 +79,7 @@ class ReplacementCancellation {
 class SystemInitiatedCancellation {
   constructor() {}
 
-  static fromJson(json: any): SystemInitiatedCancellation {
+  static fromJson(_json: any): SystemInitiatedCancellation {
     // Here you would implement the conversion from JSON to SystemInitiatedCancellation instance
     return new SystemInitiatedCancellation();
   }
diff --git a/PurchaseConnector/models/test_purchase.ts b/PurchaseConnector/models/test_purchase.ts
@@ -3,7 +3,7 @@ interface TestPurchaseJson {}
 export class TestPurchase {
   constructor() {}
 
-  static fromJson(json: TestPurchaseJson): TestPurchase {
+  static fromJson(_json: TestPurchaseJson): TestPurchase {
     return new TestPurchase();
   }
 
diff --git a/PurchaseConnector/utils/connector_callbacks.ts b/PurchaseConnector/utils/connector_callbacks.ts
@@ -1,4 +1,5 @@
-import { IosError, JVMThrowable } from "../models";
+import { IosError } from "../models/ios_errors";
+import { JVMThrowable } from "../models/jvm_throwable";
 
 // Type definition for a general-purpose listener.
 export type PurchaseConnectorListener = (data: any) => void;
diff --git a/expo/withAppsFlyerAndroid.js b/expo/withAppsFlyerAndroid.js
@@ -51,10 +51,7 @@ function withCustomAndroidManifest(config) {
 module.exports = function withAppsFlyerAndroid(config, { shouldUsePurchaseConnector = false } = {}) {
   if (shouldUsePurchaseConnector) {
     config = addPurchaseConnectorFlag(config);
-  } else {
-    console.log('[AppsFlyerPlugin] Purchase Connector disabled, skipping gradle property injection');
-  }
-  
+  } 
   // Always apply Android manifest modifications for secure data handling
   config = withCustomAndroidManifest(config);
   
diff --git a/index.d.ts b/index.d.ts
@@ -1,13 +1,13 @@
 /**
  * Typescript Definition Sync with v5.1.1
  **/
-import { InAppPurchaseValidationResult } from "../models/in_app_purchase_validation_result";
-import SubscriptionValidationResult from "../models/subscription_validation_result";
+import InAppPurchaseValidationResult from "./PurchaseConnector/models/in_app_purchase_validation_result";
+import SubscriptionValidationResult from "./PurchaseConnector/models/subscription_validation_result";
 import {
   OnResponse,
   OnFailure,
   OnReceivePurchaseRevenueValidationInfo,
-} from "../utils/connector_callbacks";
+} from "./PurchaseConnector/utils/connector_callbacks";
 
 declare module "react-native-appsflyer" {
   type Response<T> = void | Promise<T>;
@@ -151,21 +151,17 @@ declare module "react-native-appsflyer" {
             hasConsentForDataUsage?: boolean,
             hasConsentForAdsPersonalization?: boolean,
             hasConsentForAdStorage?: boolean
-        ) {}
+        );
 
         /**
          * @deprecated since version 6.16.2. Use the AppsFlyerConsent constructor instead for more flexibility with optional booleans.
          */
-        static forGDPRUser(hasConsentForDataUsage: boolean, hasConsentForAdsPersonalization: boolean): AppsFlyerConsent {
-            return new AppsFlyerConsent(true, hasConsentForDataUsage, hasConsentForAdsPersonalization);
-        }
+        static forGDPRUser(hasConsentForDataUsage: boolean, hasConsentForAdsPersonalization: boolean): AppsFlyerConsent;
 
         /**
          * @deprecated since version 6.16.2. Use the AppsFlyerConsent constructor instead for more flexibility with optional booleans.
          */
-        static forNonGDPRUser(): AppsFlyerConsent {
-            return new AppsFlyerConsent(false);
-        }
+        static forNonGDPRUser(): AppsFlyerConsent;
     }
 
     /**
@@ -201,15 +197,15 @@ declare module "react-native-appsflyer" {
     mediationNetwork: MEDIATION_NETWORK;
     currencyIso4217Code: string;
     revenue: number;
-    additionalParameters?: StringMap;
+    additionalParameters?: { [key: string]: any };
   }
 
   /**
    * PurchaseConnector
    */
-  export const StoreKitVersion = {
-    SK1: "SK1",
-    SK2: "SK2",
+  export const StoreKitVersion: {
+    readonly SK1: "SK1";
+    readonly SK2: "SK2";
   };
 
   export interface PurchaseConnectorConfig {
@@ -264,13 +260,13 @@ declare module "react-native-appsflyer" {
       callback: (data:OnResponse<SubscriptionValidationResult>) => any
     ): () => void;
     onSubscriptionValidationResultFailure(
-      callback: (data:onFailure) => any
+      callback: (data:OnFailure) => any
     ): () => void;
     onInAppValidationResultSuccess(
       callback: (data:OnResponse<InAppPurchaseValidationResult>) => any
     ): () => void;
     onInAppValidationResultFailure(
-      callback: (data:onFailure) => any
+      callback: (data:OnFailure) => any
     ): () => void;
 
     setSubscriptionPurchaseEventDataSource: (dataSource: SubscriptionPurchaseEventDataSource) => void;
@@ -397,7 +393,7 @@ declare module "react-native-appsflyer" {
     ): void;
     startSdk(): void;
     enableTCFDataCollection(enabled: boolean): void;
-    setConsentData(consentData: AppsFlyerConsentType): void;
+    setConsentData(consentData: AppsFlyerConsent): void;
     logAdRevenue(adRevenueData: AFAdRevenueData): void;
     /**
      * For iOS Only
@@ -420,3 +416,14 @@ declare module "react-native-appsflyer" {
 
   export default appsFlyer;
 }
+
+// Explicit ambient declarations for ESLint compatibility
+// ESLint's import resolver doesn't recognize exports inside 'declare module' blocks.
+// These top-level declarations allow ESLint to detect the exports.
+declare const StoreKitVersion: { readonly SK1: "SK1"; readonly SK2: "SK2" };
+declare const AppsFlyerPurchaseConnector: any; // Type is defined in declare module above
+declare const AppsFlyerPurchaseConnectorConfig: any; // Type is defined in declare module above  
+declare const appsFlyer: any; // Type is defined in declare module above
+
+export { StoreKitVersion, AppsFlyerPurchaseConnector, AppsFlyerPurchaseConnectorConfig };
+export { appsFlyer as default };
diff --git a/index.js b/index.js
@@ -3,6 +3,7 @@ import AppsFlyerConstants from "./PurchaseConnector/constants/constants";
 import InAppPurchaseValidationResult from "./PurchaseConnector/models/in_app_purchase_validation_result";
 import ValidationFailureData from "./PurchaseConnector/models/validation_failure_data";
 import SubscriptionValidationResult from "./PurchaseConnector/models/subscription_validation_result";
+import { MissingConfigurationException } from "./PurchaseConnector/models/missing_configuration_exception";
 
 const { RNAppsFlyer } = NativeModules;
 const appsFlyer = {};
@@ -186,7 +187,7 @@ AppsFlyerPurchaseConnector.setInAppPurchaseEventDataSource = (dataSource) => {
 // Purchase Connector iOS methods
 function logConsumableTransaction(transactionId){
 	PCAppsFlyer.logConsumableTransaction(transactionId);
-};
+}
   
 AppsFlyerPurchaseConnector.logConsumableTransaction = logConsumableTransaction;
 
@@ -233,7 +234,7 @@ AppsFlyerPurchaseConnector.setPurchaseRevenueDataSource = (dataSource) => {
   
 AppsFlyerPurchaseConnector.setPurchaseRevenueDataSourceStoreKit2 = (dataSource) => {
 	if (!dataSource || typeof dataSource !== 'object') {
-	  throw new Error('dataSource must be an object');
+		throw new Error('dataSource must be an object');
 	}
 	PCAppsFlyer.setPurchaseRevenueDataSourceStoreKit2(dataSource);
 };
@@ -847,7 +848,7 @@ appsFlyer.setSharingFilterForAllPartners = () => {
  * @param errorC Error callback
  */
 
-appsFlyer.setSharingFilter = (partners, successC, errorC) => {
+appsFlyer.setSharingFilter = (partners, _successC, _errorC) => {
   return appsFlyer.setSharingFilterForPartners(partners);
 };
 
diff --git a/package.json b/package.json
@@ -6,6 +6,8 @@
   "types": "index.d.ts",
   "scripts": {
     "test": "jest --coverage",
+    "lint": "eslint . --ext .js,.jsx,.ts,.tsx",
+    "lint:fix": "eslint . --ext .js,.jsx,.ts,.tsx --fix",
     "demo.ios": "npm run ios-pod; cd SampleApps/AppsFlyerExample; npm run ios",
     "demo.android": "cd SampleApps/AppsFlyerExample; npm run android",
     "ios-pod": "cd SampleApps/AppsFlyerExample/ios; pod install; cd ../"
@@ -32,7 +34,10 @@
   "devDependencies": {
     "@babel/preset-env": "^7.26.9",
     "@types/jest": "^29.5.14",
+    "@typescript-eslint/eslint-plugin": "^6.21.0",
+    "@typescript-eslint/parser": "^6.21.0",
     "babel-jest": "^29.7.0",
+    "eslint": "^8.57.1",
     "jest": "^29.7.0",
     "react": "16.11.0",
     "react-native": "0.62.3",

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ interface TestPurchaseJson {}`
`3`	`3`	`export class TestPurchase {`
`4`	`4`	`constructor() {}`
`5`	`5`
`6`		`- static fromJson(json: TestPurchaseJson): TestPurchase {`
	`6`	`+ static fromJson(_json: TestPurchaseJson): TestPurchase {`
`7`	`7`	`return new TestPurchase();`
`8`	`8`	`}`
`9`	`9`