cordova-plugin-firebase-analytics - npm Package Compare versions

Comparing version 7.0.2 to 7.0.3

package.json

 {
   "name": "cordova-plugin-firebase-analytics",
-  "version": "7.0.2",
+  "version": "7.0.3",
   "description": "Cordova plugin for Firebase Analytics",
@@ -33,8 +33,8 @@ "types": "./types/index.d.ts",
   "scripts": {
-    "prepare": "husky install",
-    "version": "perl -i -pe 's/(version=)\"\\d+\\.\\d+\\.\\d+\"/$1\"'$npm_package_version'\"$2/' plugin.xml && git add plugin.xml README.md",
+    "preversion": "npm run docs && rm -rf docs",
+    "version": "perl -i -pe 's/(version=)\"\\d+\\.\\d+\\.\\d+\"/$1\"'$npm_package_version'\"$2/' plugin.xml && git add .",
     "postversion": "git push && git push --tags",
     "predocs": "tsc www/* --declaration --allowJs --checkJs --lib es2015,dom --emitDeclarationOnly --outDir types",
-    "docs": "typedoc ./types",
-    "postdocs": "cat ./docs/modules/FirebaseAnalytics.md >> README.md && perl -i -0pe 's/(## Methods).*(## Functions)/$1/gms' README.md"
+    "docs": "typedoc && perl -i -pe 's/README.md#/#/g' ./docs/README.md",
+    "postdocs": "perl -i -0pe 's/(<!-- TypedocGenerated -->).*/$1\n\n/gms' README.md && cat ./docs/README.md >> README.md"
   },
@@ -47,7 +47,5 @@ "lint-staged": {
   "devDependencies": {
-    "@colony/typedoc-plugin-markdown": "3.16.0",
-    "husky": "^8.0.1",
-    "lint-staged": "^13.0.3",
-    "typedoc": "^0.23.9"
+    "typedoc": "^0.23.9",
+    "typedoc-plugin-markdown": "^3.13.4"
   }
 }

README.md

@@ -18,7 +18,17 @@ # Cordova plugin for [Firebase Analytics](https://firebase.google.com/docs/analytics/)
 
-<!-- MarkdownTOC levels="2" autolink="true" -->
+<!-- MarkdownTOC levels="2,3" autolink="true" -->
 
 - [Supported platforms](#supported-platforms)
 - [Installation](#installation)
-- [Methods](#methods)
+    - [Disabling analytics data collection](#disabling-analytics-data-collection)
+    - [Disabling automatic screen collection](#disabling-automatic-screen-collection)
+    - [Adding required configuration files](#adding-required-configuration-files)
+- [Functions](#functions)
+    - [logEvent](#logevent)
+    - [resetAnalyticsData](#resetanalyticsdata)
+    - [setCurrentScreen](#setcurrentscreen)
+    - [setDefaultEventParameters](#setdefaulteventparameters)
+    - [setEnabled](#setenabled)
+    - [setUserId](#setuserid)
+    - [setUserProperty](#setuserproperty)
 
@@ -83,6 +93,10 @@ <!-- /MarkdownTOC -->
 
-## Methods
+<!-- TypedocGenerated -->
 
-### ▸ **logEvent**(`name`, `params`): `Promise`<`void`\>
+## Functions
 
+### logEvent
+
+**logEvent**(`name`, `params`): `Promise`<`void`\>
+
 Logs an app event.
@@ -109,4 +123,8 @@
 
-### ▸ **resetAnalyticsData**(): `Promise`<`void`\>
+___
 
+### resetAnalyticsData
+
+**resetAnalyticsData**(): `Promise`<`void`\>
+
 Clears all analytics data for this instance from the device and resets the app instance ID.
@@ -126,4 +144,8 @@
 
-### ▸ **setCurrentScreen**(`screenName`): `Promise`<`void`\>
+___
 
+### setCurrentScreen
+
+**setCurrentScreen**(`screenName`): `Promise`<`void`\>
+
 Sets the current screen name, which specifies the current visual context in your app. This helps identify the areas in your app where users spend their time and how they interact with your app.
@@ -149,4 +171,8 @@
 
-### ▸ **setDefaultEventParameters**(`defaults`): `Promise`<`void`\>
+___
 
+### setDefaultEventParameters
+
+**setDefaultEventParameters**(`defaults`): `Promise`<`void`\>
+
 Adds parameters that will be set on every event logged from the SDK, including automatic ones.
@@ -172,4 +198,8 @@
 
-### ▸ **setEnabled**(`enabled`): `Promise`<`void`\>
+___
 
+### setEnabled
+
+**setEnabled**(`enabled`): `Promise`<`void`\>
+
 Sets whether analytics collection is enabled for this app on this device.
@@ -195,4 +225,8 @@
 
-### ▸ **setUserId**(`userId`): `Promise`<`void`\>
+___
 
+### setUserId
+
+**setUserId**(`userId`): `Promise`<`void`\>
+
 Sets the user ID property. This feature must be used in accordance with Google's Privacy Policy.
@@ -222,4 +256,8 @@
 
-### ▸ **setUserProperty**(`name`, `value`): `Promise`<`void`\>
+___
 
+### setUserProperty
+
+**setUserProperty**(`name`, `value`): `Promise`<`void`\>
+
 Sets a user property to a given value. Be aware of automatically collected user properties.
@@ -226,0 +264,0 @@

tsconfig.json

 {
   "typedocOptions": {
     "out": "docs",
+    "readme": "none",
+    "entryPoints": "./types",
+    "exclude": "./types/index.d.ts",
     "entryPointStrategy": "expand",
@@ -8,4 +11,6 @@ "hideBreadcrumbs": true,
     "hidePageTitle": true,
-    "hideMembersSymbol": true
+    "hideMembersSymbol": true,
+    "disableSources": true,
+    "githubPages": false
   }
 }

No alert changes

Improved metrics

Total package byte prevSize

29736

2.51%

Dev dependency count

2

-50%

Lines of code

319

1.59%

Number of lines in readme file

279

15.77%

Worsened metrics

Number of package files

12

-7.69%

No dependency changes