Merge pull request #1047 from OneSignal/fg/cordova-types

Add cordova types package

Author: fadi-george

.gitignore

@@ -1,2 +1,4 @@
 node_modules
 dist
+
+.vscode

.prettierrc

@@ -0,0 +1,4 @@
+{
+  "singleQuote": false,
+  "trailingComma": "all"
+}

example/IonicCapOneSignal/src/OSDemo.tsx

@@ -62,7 +62,7 @@ class OSDemo extends React.Component<Props, State> {
           // Call to display the notification after 5 second delay
           notif.display();
         }, 10000);
-      }
+      },
     );
 
     OneSignal.Notifications.addEventListener("click", (event) => {
@@ -93,7 +93,7 @@ class OSDemo extends React.Component<Props, State> {
       "change",
       (subscription) => {
         this.OSLog("OneSignal: subscription changed:", subscription);
-      }
+      },
     );
 
     OneSignal.Notifications.addEventListener("permissionChange", (granted) => {
@@ -105,7 +105,7 @@ class OSDemo extends React.Component<Props, State> {
     });
   }
 
-  OSLog = (message: string, optionalArg: any = null) => {
+  OSLog = (message: string, optionalArg: unknown = null) => {
     if (optionalArg !== null) {
       message = message + JSON.stringify(optionalArg);
     }

package-lock.json

@@ -67,5 +67,8 @@
   "bugs": {
     "url": "https://github.com/onesignal/OneSignal-Cordova-SDK/issues"
   },
-  "homepage": "https://github.com/onesignal/OneSignal-Cordova-SDK#readme"
+  "homepage": "https://github.com/onesignal/OneSignal-Cordova-SDK#readme",
+  "devDependencies": {
+    "@types/cordova": "^11.0.3"
+  }
 }

package.json

@@ -1,20 +1,15 @@
 {
-    "compilerOptions": {
-        "outDir": "dist",
-        "target": "es5",
-        "moduleResolution": "node",
-        "noImplicitAny": true,
-        "lib": [
-            "es6",
-            "dom",
-        ],
-        "declaration": true,
-        "allowSyntheticDefaultImports": true,
-        "esModuleInterop": true,
-        "strict": true,
-        "noUnusedLocals": true,
-    },
-    "include": [
-        "www"
-    ]
+  "compilerOptions": {
+    "outDir": "dist",
+    "target": "es5",
+    "moduleResolution": "node",
+    "noImplicitAny": true,
+    "lib": ["es6", "dom"],
+    "declaration": true,
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "strict": true,
+    "noUnusedLocals": true
+  },
+  "include": ["www"]
 }

tsconfig.json

@@ -1,33 +1,42 @@
-// Suppress TS warnings about window.cordova
-declare let window: any; // turn off type checking
-
 // An enum that declares different types of log levels you can use with the OneSignal SDK, going from the least verbose (none) to verbose (print all comments).
 export enum LogLevel {
-    None = 0,
-    Fatal,
-    Error,
-    Warn,
-    Info,
-    Debug,
-    Verbose,
+  None = 0,
+  Fatal,
+  Error,
+  Warn,
+  Info,
+  Debug,
+  Verbose,
 }
 
 export default class Debug {
-    /**
-     * Enable logging to help debug if you run into an issue setting up OneSignal.
-     * @param  {LogLevel} logLevel - Sets the logging level to print to the Android LogCat log or Xcode log.
-     * @returns void
-     */
-    setLogLevel(logLevel: LogLevel): void {
-        window.cordova.exec(function(){}, function(){}, "OneSignalPush", "setLogLevel", [logLevel]);
-    };
+  /**
+   * Enable logging to help debug if you run into an issue setting up OneSignal.
+   * @param  {LogLevel} logLevel - Sets the logging level to print to the Android LogCat log or Xcode log.
+   * @returns void
+   */
+  setLogLevel(logLevel: LogLevel): void {
+    window.cordova.exec(
+      function () {},
+      function () {},
+      "OneSignalPush",
+      "setLogLevel",
+      [logLevel],
+    );
+  }
 
-    /**
-     * Enable logging to help debug if you run into an issue setting up OneSignal.
-     * @param  {LogLevel} visualLogLevel - Sets the logging level to show as alert dialogs.
-     * @returns void
-     */
-    setAlertLevel(visualLogLevel: LogLevel): void {
-        window.cordova.exec(function(){}, function(){}, "OneSignalPush", "setAlertLevel", [visualLogLevel]);
-    }
+  /**
+   * Enable logging to help debug if you run into an issue setting up OneSignal.
+   * @param  {LogLevel} visualLogLevel - Sets the logging level to show as alert dialogs.
+   * @returns void
+   */
+  setAlertLevel(visualLogLevel: LogLevel): void {
+    window.cordova.exec(
+      function () {},
+      function () {},
+      "OneSignalPush",
+      "setAlertLevel",
+      [visualLogLevel],
+    );
+  }
 }