@capacitor-firebase/performance 0.3.0 → 0.5.0

package/CapacitorFirebasePerformance.podspec

@@ -13,7 +13,7 @@ Pod::Spec.new do |s|
   s.source_files = 'ios/Plugin/**/*.{swift,h,m,c,cc,mm,cpp}'
   s.ios.deployment_target  = '12.0'
   s.dependency 'Capacitor'
-  s.dependency 'Firebase/Performance', '8.13.0'
+  s.dependency 'Firebase/Performance', '9.1.0'
   s.swift_version = '5.1'
   s.static_framework = true
 end

package/README.md

@@ -13,6 +13,8 @@ Add Firebase to your project if you haven't already ([Android](https://firebase.
 
 ### Android
 
+**Attention**: Please make sure that you are using **Java 11**.
+
 See [Add the Performance Monitoring plugin to your app](https://firebase.google.com/docs/perf-mon/get-started-android#add-perfmon-plugin) and follow the instructions to set up your app correctly.
 
 #### Variables
@@ -88,6 +90,8 @@ Starts a trace.
 | ------------- | --------------------------------------------------------------- |
 | **`options`** | <code><a href="#starttraceoptions">StartTraceOptions</a></code> |
 
+**Since:** 0.1.0
+
 --------------------
 
 
@@ -103,6 +107,8 @@ Stops a trace.
 | ------------- | ------------------------------------------------------------- |
 | **`options`** | <code><a href="#stoptraceoptions">StopTraceOptions</a></code> |
 
+**Since:** 0.1.0
+
 --------------------
 
 
@@ -118,6 +124,8 @@ Atomically increments the metric with the given name for the selected trace by t
 | ------------- | ------------------------------------------------------------------------- |
 | **`options`** | <code><a href="#incrementmetricoptions">IncrementMetricOptions</a></code> |
 
+**Since:** 0.1.0
+
 --------------------
 
 
@@ -134,6 +142,8 @@ Will be applied with the next start of the app.
 | ------------- | --------------------------------------------------------------------------------------------------------- |
 | **`options`** | <code><a href="#setperformancecollectionenabledoptions">SetPerformanceCollectionEnabledOptions</a></code> |
 
+**Since:** 0.1.0
+
 --------------------
 
 
@@ -147,6 +157,8 @@ Determines whether performance monitoring is enabled or disabled.
 
 **Returns:** <code>Promise&lt;<a href="#isperformancecollectionenabledresult">IsPerformanceCollectionEnabledResult</a>&gt;</code>
 
+**Since:** 0.1.0
+
 --------------------
 
 
@@ -155,39 +167,39 @@ Determines whether performance monitoring is enabled or disabled.
 
 #### StartTraceOptions
 
-| Prop            | Type                | Description                                                                                                                                                                                     |
-| --------------- | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`traceName`** | <code>string</code> | Custom trace name. Names for custom code traces must meet the following requirements: no leading or trailing whitespace, no leading underscore (_) character, and max length is 100 characters. |
+| Prop            | Type                | Description                                                                                                                                                                                     | Since |
+| --------------- | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
+| **`traceName`** | <code>string</code> | Custom trace name. Names for custom code traces must meet the following requirements: no leading or trailing whitespace, no leading underscore (_) character, and max length is 100 characters. | 0.1.0 |
 
 
 #### StopTraceOptions
 
-| Prop            | Type                | Description                                       |
-| --------------- | ------------------- | ------------------------------------------------- |
-| **`traceName`** | <code>string</code> | Name of the trace that was set with `startTrace`. |
+| Prop            | Type                | Description                                       | Since |
+| --------------- | ------------------- | ------------------------------------------------- | ----- |
+| **`traceName`** | <code>string</code> | Name of the trace that was set with `startTrace`. | 0.1.0 |
 
 
 #### IncrementMetricOptions
 
-| Prop              | Type                | Description                                                    |
-| ----------------- | ------------------- | -------------------------------------------------------------- |
-| **`traceName`**   | <code>string</code> | Name of the trace that was set with `startTrace`.              |
-| **`metricName`**  | <code>string</code> | Name of the metric to be incremented.                          |
-| **`incrementBy`** | <code>number</code> | Amount by which the metric has to be incremented. Default: `1` |
+| Prop              | Type                | Description                                       | Default        | Since |
+| ----------------- | ------------------- | ------------------------------------------------- | -------------- | ----- |
+| **`traceName`**   | <code>string</code> | Name of the trace that was set with `startTrace`. |                | 0.1.0 |
+| **`metricName`**  | <code>string</code> | Name of the metric to be incremented.             |                | 0.1.0 |
+| **`incrementBy`** | <code>number</code> | Amount by which the metric has to be incremented. | <code>1</code> | 0.1.0 |
 
 
 #### SetPerformanceCollectionEnabledOptions
 
-| Prop          | Type                 | Description                               |
-| ------------- | -------------------- | ----------------------------------------- |
-| **`enabled`** | <code>boolean</code> | Should performance monitoring be enabled. |
+| Prop          | Type                 | Description                               | Since |
+| ------------- | -------------------- | ----------------------------------------- | ----- |
+| **`enabled`** | <code>boolean</code> | Should performance monitoring be enabled. | 0.1.0 |
 
 
 #### IsPerformanceCollectionEnabledResult
 
-| Prop          | Type                 | Description                                                     |
-| ------------- | -------------------- | --------------------------------------------------------------- |
-| **`enabled`** | <code>boolean</code> | `true` if performance monitoring is enabled, otherwise `false`. |
+| Prop          | Type                 | Description                                                     | Since |
+| ------------- | -------------------- | --------------------------------------------------------------- | ----- |
+| **`enabled`** | <code>boolean</code> | `true` if performance monitoring is enabled, otherwise `false`. | 0.1.0 |
 
 </docgen-api>
 

package/dist/docs.json

@@ -16,7 +16,12 @@
           }
         ],
         "returns": "Promise<void>",
-        "tags": [],
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
         "docs": "Starts a trace.",
         "complexTypes": [
           "StartTraceOptions"
@@ -34,7 +39,12 @@
           }
         ],
         "returns": "Promise<void>",
-        "tags": [],
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
         "docs": "Stops a trace.",
         "complexTypes": [
           "StopTraceOptions"
@@ -52,7 +62,12 @@
           }
         ],
         "returns": "Promise<void>",
-        "tags": [],
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
         "docs": "Atomically increments the metric with the given name for the selected trace by the `incrementBy` value.",
         "complexTypes": [
           "IncrementMetricOptions"
@@ -70,7 +85,12 @@
           }
         ],
         "returns": "Promise<void>",
-        "tags": [],
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
         "docs": "Enables or disables performance monitoring.\nWill be applied with the next start of the app.",
         "complexTypes": [
           "SetPerformanceCollectionEnabledOptions"
@@ -82,7 +102,12 @@
         "signature": "() => Promise<IsPerformanceCollectionEnabledResult>",
         "parameters": [],
         "returns": "Promise<IsPerformanceCollectionEnabledResult>",
-        "tags": [],
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
         "docs": "Determines whether performance monitoring is enabled or disabled.",
         "complexTypes": [
           "IsPerformanceCollectionEnabledResult"
@@ -97,12 +122,22 @@
       "name": "StartTraceOptions",
       "slug": "starttraceoptions",
       "docs": "",
-      "tags": [],
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
       "methods": [],
       "properties": [
         {
           "name": "traceName",
-          "tags": [],
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
           "docs": "Custom trace name.\n\nNames for custom code traces must meet the following requirements:\nno leading or trailing whitespace, no leading underscore (_) character,\nand max length is 100 characters.",
           "complexTypes": [],
           "type": "string"
@@ -113,12 +148,22 @@
       "name": "StopTraceOptions",
       "slug": "stoptraceoptions",
       "docs": "",
-      "tags": [],
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
       "methods": [],
       "properties": [
         {
           "name": "traceName",
-          "tags": [],
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
           "docs": "Name of the trace that was set with `startTrace`.",
           "complexTypes": [],
           "type": "string"
@@ -129,27 +174,51 @@
       "name": "IncrementMetricOptions",
       "slug": "incrementmetricoptions",
       "docs": "",
-      "tags": [],
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
       "methods": [],
       "properties": [
         {
           "name": "traceName",
-          "tags": [],
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
           "docs": "Name of the trace that was set with `startTrace`.",
           "complexTypes": [],
           "type": "string"
         },
         {
           "name": "metricName",
-          "tags": [],
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
           "docs": "Name of the metric to be incremented.",
           "complexTypes": [],
           "type": "string"
         },
         {
           "name": "incrementBy",
-          "tags": [],
-          "docs": "Amount by which the metric has to be incremented.\n\nDefault: `1`",
+          "tags": [
+            {
+              "text": "1",
+              "name": "default"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Amount by which the metric has to be incremented.",
           "complexTypes": [],
           "type": "number | undefined"
         }
@@ -159,12 +228,22 @@
       "name": "SetPerformanceCollectionEnabledOptions",
       "slug": "setperformancecollectionenabledoptions",
       "docs": "",
-      "tags": [],
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
       "methods": [],
       "properties": [
         {
           "name": "enabled",
-          "tags": [],
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
           "docs": "Should performance monitoring be enabled.",
           "complexTypes": [],
           "type": "boolean"
@@ -180,7 +259,12 @@
       "properties": [
         {
           "name": "enabled",
-          "tags": [],
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
           "docs": "`true` if performance monitoring is enabled, otherwise `false`.",
           "complexTypes": [],
           "type": "boolean"

package/dist/esm/definitions.d.ts

@@ -1,26 +1,39 @@
 export interface FirebasePerformancePlugin {
     /**
      * Starts a trace.
+     *
+     * @since 0.1.0
      */
     startTrace(options: StartTraceOptions): Promise<void>;
     /**
      * Stops a trace.
+     *
+     * @since 0.1.0
      */
     stopTrace(options: StopTraceOptions): Promise<void>;
     /**
      * Atomically increments the metric with the given name for the selected trace by the `incrementBy` value.
+     *
+     * @since 0.1.0
      */
     incrementMetric(options: IncrementMetricOptions): Promise<void>;
     /**
      * Enables or disables performance monitoring.
      * Will be applied with the next start of the app.
+     *
+     * @since 0.1.0
      */
     setPerformanceCollectionEnabled(options: SetPerformanceCollectionEnabledOptions): Promise<void>;
     /**
      * Determines whether performance monitoring is enabled or disabled.
+     *
+     * @since 0.1.0
      */
     isPerformanceCollectionEnabled(): Promise<IsPerformanceCollectionEnabledResult>;
 }
+/**
+ * @since 0.1.0
+ */
 export interface StartTraceOptions {
     /**
      * Custom trace name.
@@ -28,40 +41,62 @@ export interface StartTraceOptions {
      * Names for custom code traces must meet the following requirements:
      * no leading or trailing whitespace, no leading underscore (_) character,
      * and max length is 100 characters.
+     *
+     * @since 0.1.0
      */
     traceName: string;
 }
+/**
+ * @since 0.1.0
+ */
 export interface StopTraceOptions {
     /**
      * Name of the trace that was set with `startTrace`.
+     *
+     * @since 0.1.0
      */
     traceName: string;
 }
+/**
+ * @since 0.1.0
+ */
 export interface IncrementMetricOptions {
     /**
      * Name of the trace that was set with `startTrace`.
+     *
+     * @since 0.1.0
      */
     traceName: string;
     /**
      * Name of the metric to be incremented.
+     *
+     * @since 0.1.0
      */
     metricName: string;
     /**
      * Amount by which the metric has to be incremented.
      *
-     * Default: `1`
+     * @default 1
+     * @since 0.1.0
      */
     incrementBy?: number;
 }
+/**
+ * @since 0.1.0
+ */
 export interface SetPerformanceCollectionEnabledOptions {
     /**
      * Should performance monitoring be enabled.
+     *
+     * @since 0.1.0
      */
     enabled: boolean;
 }
 export interface IsPerformanceCollectionEnabledResult {
     /**
      * `true` if performance monitoring is enabled, otherwise `false`.
+     *
+     * @since 0.1.0
      */
     enabled: boolean;
 }

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["export interface FirebasePerformancePlugin {\n  /**\n   * Starts a trace.\n   */\n  startTrace(options: StartTraceOptions): Promise<void>;\n  /**\n   * Stops a trace.\n   */\n  stopTrace(options: StopTraceOptions): Promise<void>;\n  /**\n   * Atomically increments the metric with the given name for the selected trace by the `incrementBy` value.\n   */\n  incrementMetric(options: IncrementMetricOptions): Promise<void>;\n  /**\n   * Enables or disables performance monitoring.\n   * Will be applied with the next start of the app.\n   */\n  setPerformanceCollectionEnabled(\n    options: SetPerformanceCollectionEnabledOptions,\n  ): Promise<void>;\n  /**\n   * Determines whether performance monitoring is enabled or disabled.\n   */\n  isPerformanceCollectionEnabled(): Promise<IsPerformanceCollectionEnabledResult>;\n}\n\nexport interface StartTraceOptions {\n  /**\n   * Custom trace name.\n   *\n   * Names for custom code traces must meet the following requirements:\n   * no leading or trailing whitespace, no leading underscore (_) character,\n   * and max length is 100 characters.\n   */\n  traceName: string;\n}\n\nexport interface StopTraceOptions {\n  /**\n   * Name of the trace that was set with `startTrace`.\n   */\n  traceName: string;\n}\n\nexport interface IncrementMetricOptions {\n  /**\n   * Name of the trace that was set with `startTrace`.\n   */\n  traceName: string;\n  /**\n   * Name of the metric to be incremented.\n   */\n  metricName: string;\n  /**\n   * Amount by which the metric has to be incremented.\n   *\n   * Default: `1`\n   */\n  incrementBy?: number;\n}\n\nexport interface SetPerformanceCollectionEnabledOptions {\n  /**\n   * Should performance monitoring be enabled.\n   */\n  enabled: boolean;\n}\n\nexport interface IsPerformanceCollectionEnabledResult {\n  /**\n   * `true` if performance monitoring is enabled, otherwise `false`.\n   */\n  enabled: boolean;\n}\n"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["export interface FirebasePerformancePlugin {\n  /**\n   * Starts a trace.\n   *\n   * @since 0.1.0\n   */\n  startTrace(options: StartTraceOptions): Promise<void>;\n  /**\n   * Stops a trace.\n   *\n   * @since 0.1.0\n   */\n  stopTrace(options: StopTraceOptions): Promise<void>;\n  /**\n   * Atomically increments the metric with the given name for the selected trace by the `incrementBy` value.\n   *\n   * @since 0.1.0\n   */\n  incrementMetric(options: IncrementMetricOptions): Promise<void>;\n  /**\n   * Enables or disables performance monitoring.\n   * Will be applied with the next start of the app.\n   *\n   * @since 0.1.0\n   */\n  setPerformanceCollectionEnabled(\n    options: SetPerformanceCollectionEnabledOptions,\n  ): Promise<void>;\n  /**\n   * Determines whether performance monitoring is enabled or disabled.\n   *\n   * @since 0.1.0\n   */\n  isPerformanceCollectionEnabled(): Promise<IsPerformanceCollectionEnabledResult>;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface StartTraceOptions {\n  /**\n   * Custom trace name.\n   *\n   * Names for custom code traces must meet the following requirements:\n   * no leading or trailing whitespace, no leading underscore (_) character,\n   * and max length is 100 characters.\n   *\n   * @since 0.1.0\n   */\n  traceName: string;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface StopTraceOptions {\n  /**\n   * Name of the trace that was set with `startTrace`.\n   *\n   * @since 0.1.0\n   */\n  traceName: string;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface IncrementMetricOptions {\n  /**\n   * Name of the trace that was set with `startTrace`.\n   *\n   * @since 0.1.0\n   */\n  traceName: string;\n  /**\n   * Name of the metric to be incremented.\n   *\n   * @since 0.1.0\n   */\n  metricName: string;\n  /**\n   * Amount by which the metric has to be incremented.\n   *\n   * @default 1\n   * @since 0.1.0\n   */\n  incrementBy?: number;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface SetPerformanceCollectionEnabledOptions {\n  /**\n   * Should performance monitoring be enabled.\n   *\n   * @since 0.1.0\n   */\n  enabled: boolean;\n}\n\nexport interface IsPerformanceCollectionEnabledResult {\n  /**\n   * `true` if performance monitoring is enabled, otherwise `false`.\n   *\n   * @since 0.1.0\n   */\n  enabled: boolean;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capacitor-firebase/performance",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "description": "Capacitor plugin for Firebase Performance Monitoring.",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
@@ -15,13 +15,24 @@
   ],
   "author": "Robin Genz <mail@robingenz.dev>",
   "license": "Apache-2.0",
+  "homepage": "https://capawesome.io/",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/robingenz/capacitor-firebase.git"
+    "url": "git+https://github.com/capawesome-team/capacitor-firebase.git"
   },
   "bugs": {
-    "url": "https://github.com/robingenz/capacitor-firebase/issues"
+    "url": "https://github.com/capawesome-team/capacitor-firebase/issues"
   },
+  "funding": [
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/capawesome-team/"
+    },
+    {
+      "type": "opencollective",
+      "url": "https://opencollective.com/capawesome"
+    }
+  ],
   "keywords": [
     "capacitor",
     "plugin",