@capacitor-firebase/performance 0.2.0 → 0.3.0-dev.6ead72e.1654850957

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/CapacitorFirebasePerformance.podspec +1 -1
  2. package/README.md +29 -19
  3. package/dist/docs.json +101 -17
  4. package/dist/esm/definitions.d.ts +36 -1
  5. package/dist/esm/definitions.js.map +1 -1
  6. package/package.json +1 -1
package/CapacitorFirebasePerformance.podspec CHANGED
@@ -13,7 +13,7 @@ Pod::Spec.new do |s|
13
13
  s.source_files = 'ios/Plugin/**/*.{swift,h,m,c,cc,mm,cpp}'
14
14
  s.ios.deployment_target = '12.0'
15
15
  s.dependency 'Capacitor'
16
- s.dependency 'Firebase/Performance', '8.13.0'
16
+ s.dependency 'Firebase/Performance', '9.1.0'
17
17
  s.swift_version = '5.1'
18
18
  s.static_framework = true
19
19
  end
package/README.md CHANGED
@@ -88,6 +88,8 @@ Starts a trace.
88
88
  | ------------- | --------------------------------------------------------------- |
89
89
  | **`options`** | <code><a href="#starttraceoptions">StartTraceOptions</a></code> |
90
90
 
91
+ **Since:** 0.1.0
92
+
91
93
  --------------------
92
94
 
93
95
 
@@ -103,6 +105,8 @@ Stops a trace.
103
105
  | ------------- | ------------------------------------------------------------- |
104
106
  | **`options`** | <code><a href="#stoptraceoptions">StopTraceOptions</a></code> |
105
107
 
108
+ **Since:** 0.1.0
109
+
106
110
  --------------------
107
111
 
108
112
 
@@ -118,6 +122,8 @@ Atomically increments the metric with the given name for the selected trace by t
118
122
  | ------------- | ------------------------------------------------------------------------- |
119
123
  | **`options`** | <code><a href="#incrementmetricoptions">IncrementMetricOptions</a></code> |
120
124
 
125
+ **Since:** 0.1.0
126
+
121
127
  --------------------
122
128
 
123
129
 
@@ -134,6 +140,8 @@ Will be applied with the next start of the app.
134
140
  | ------------- | --------------------------------------------------------------------------------------------------------- |
135
141
  | **`options`** | <code><a href="#setperformancecollectionenabledoptions">SetPerformanceCollectionEnabledOptions</a></code> |
136
142
 
143
+ **Since:** 0.1.0
144
+
137
145
  --------------------
138
146
 
139
147
 
@@ -147,6 +155,8 @@ Determines whether performance monitoring is enabled or disabled.
147
155
 
148
156
  **Returns:** <code>Promise&lt;<a href="#isperformancecollectionenabledresult">IsPerformanceCollectionEnabledResult</a>&gt;</code>
149
157
 
158
+ **Since:** 0.1.0
159
+
150
160
  --------------------
151
161
 
152
162
 
@@ -155,46 +165,46 @@ Determines whether performance monitoring is enabled or disabled.
155
165
 
156
166
  #### StartTraceOptions
157
167
 
158
- | Prop | Type | Description |
159
- | --------------- | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
160
- | **`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. |
168
+ | Prop | Type | Description | Since |
169
+ | --------------- | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
170
+ | **`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 |
161
171
 
162
172
 
163
173
  #### StopTraceOptions
164
174
 
165
- | Prop | Type | Description |
166
- | --------------- | ------------------- | ------------------------------------------------- |
167
- | **`traceName`** | <code>string</code> | Name of the trace that was set with `startTrace`. |
175
+ | Prop | Type | Description | Since |
176
+ | --------------- | ------------------- | ------------------------------------------------- | ----- |
177
+ | **`traceName`** | <code>string</code> | Name of the trace that was set with `startTrace`. | 0.1.0 |
168
178
 
169
179
 
170
180
  #### IncrementMetricOptions
171
181
 
172
- | Prop | Type | Description |
173
- | ----------------- | ------------------- | -------------------------------------------------------------- |
174
- | **`traceName`** | <code>string</code> | Name of the trace that was set with `startTrace`. |
175
- | **`metricName`** | <code>string</code> | Name of the metric to be incremented. |
176
- | **`incrementBy`** | <code>number</code> | Amount by which the metric has to be incremented. Default: `1` |
182
+ | Prop | Type | Description | Default | Since |
183
+ | ----------------- | ------------------- | ------------------------------------------------- | -------------- | ----- |
184
+ | **`traceName`** | <code>string</code> | Name of the trace that was set with `startTrace`. | | 0.1.0 |
185
+ | **`metricName`** | <code>string</code> | Name of the metric to be incremented. | | 0.1.0 |
186
+ | **`incrementBy`** | <code>number</code> | Amount by which the metric has to be incremented. | <code>1</code> | 0.1.0 |
177
187
 
178
188
 
179
189
  #### SetPerformanceCollectionEnabledOptions
180
190
 
181
- | Prop | Type | Description |
182
- | ------------- | -------------------- | ----------------------------------------- |
183
- | **`enabled`** | <code>boolean</code> | Should performance monitoring be enabled. |
191
+ | Prop | Type | Description | Since |
192
+ | ------------- | -------------------- | ----------------------------------------- | ----- |
193
+ | **`enabled`** | <code>boolean</code> | Should performance monitoring be enabled. | 0.1.0 |
184
194
 
185
195
 
186
196
  #### IsPerformanceCollectionEnabledResult
187
197
 
188
- | Prop | Type | Description |
189
- | ------------- | -------------------- | --------------------------------------------------------------- |
190
- | **`enabled`** | <code>boolean</code> | `true` if performance monitoring is enabled, otherwise `false`. |
198
+ | Prop | Type | Description | Since |
199
+ | ------------- | -------------------- | --------------------------------------------------------------- | ----- |
200
+ | **`enabled`** | <code>boolean</code> | `true` if performance monitoring is enabled, otherwise `false`. | 0.1.0 |
191
201
 
192
202
  </docgen-api>
193
203
 
194
204
  ## Changelog
195
205
 
196
- See [CHANGELOG.md](./CHANGELOG.md).
206
+ See [CHANGELOG.md](/packages/performance/CHANGELOG.md).
197
207
 
198
208
  ## License
199
209
 
200
- See [LICENSE](./LICENSE).
210
+ See [LICENSE](/packages/performance/LICENSE).
package/dist/docs.json CHANGED
@@ -16,7 +16,12 @@
16
16
  }
17
17
  ],
18
18
  "returns": "Promise<void>",
19
- "tags": [],
19
+ "tags": [
20
+ {
21
+ "name": "since",
22
+ "text": "0.1.0"
23
+ }
24
+ ],
20
25
  "docs": "Starts a trace.",
21
26
  "complexTypes": [
22
27
  "StartTraceOptions"
@@ -34,7 +39,12 @@
34
39
  }
35
40
  ],
36
41
  "returns": "Promise<void>",
37
- "tags": [],
42
+ "tags": [
43
+ {
44
+ "name": "since",
45
+ "text": "0.1.0"
46
+ }
47
+ ],
38
48
  "docs": "Stops a trace.",
39
49
  "complexTypes": [
40
50
  "StopTraceOptions"
@@ -52,7 +62,12 @@
52
62
  }
53
63
  ],
54
64
  "returns": "Promise<void>",
55
- "tags": [],
65
+ "tags": [
66
+ {
67
+ "name": "since",
68
+ "text": "0.1.0"
69
+ }
70
+ ],
56
71
  "docs": "Atomically increments the metric with the given name for the selected trace by the `incrementBy` value.",
57
72
  "complexTypes": [
58
73
  "IncrementMetricOptions"
@@ -70,7 +85,12 @@
70
85
  }
71
86
  ],
72
87
  "returns": "Promise<void>",
73
- "tags": [],
88
+ "tags": [
89
+ {
90
+ "name": "since",
91
+ "text": "0.1.0"
92
+ }
93
+ ],
74
94
  "docs": "Enables or disables performance monitoring.\nWill be applied with the next start of the app.",
75
95
  "complexTypes": [
76
96
  "SetPerformanceCollectionEnabledOptions"
@@ -82,7 +102,12 @@
82
102
  "signature": "() => Promise<IsPerformanceCollectionEnabledResult>",
83
103
  "parameters": [],
84
104
  "returns": "Promise<IsPerformanceCollectionEnabledResult>",
85
- "tags": [],
105
+ "tags": [
106
+ {
107
+ "name": "since",
108
+ "text": "0.1.0"
109
+ }
110
+ ],
86
111
  "docs": "Determines whether performance monitoring is enabled or disabled.",
87
112
  "complexTypes": [
88
113
  "IsPerformanceCollectionEnabledResult"
@@ -97,12 +122,22 @@
97
122
  "name": "StartTraceOptions",
98
123
  "slug": "starttraceoptions",
99
124
  "docs": "",
100
- "tags": [],
125
+ "tags": [
126
+ {
127
+ "text": "0.1.0",
128
+ "name": "since"
129
+ }
130
+ ],
101
131
  "methods": [],
102
132
  "properties": [
103
133
  {
104
134
  "name": "traceName",
105
- "tags": [],
135
+ "tags": [
136
+ {
137
+ "text": "0.1.0",
138
+ "name": "since"
139
+ }
140
+ ],
106
141
  "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.",
107
142
  "complexTypes": [],
108
143
  "type": "string"
@@ -113,12 +148,22 @@
113
148
  "name": "StopTraceOptions",
114
149
  "slug": "stoptraceoptions",
115
150
  "docs": "",
116
- "tags": [],
151
+ "tags": [
152
+ {
153
+ "text": "0.1.0",
154
+ "name": "since"
155
+ }
156
+ ],
117
157
  "methods": [],
118
158
  "properties": [
119
159
  {
120
160
  "name": "traceName",
121
- "tags": [],
161
+ "tags": [
162
+ {
163
+ "text": "0.1.0",
164
+ "name": "since"
165
+ }
166
+ ],
122
167
  "docs": "Name of the trace that was set with `startTrace`.",
123
168
  "complexTypes": [],
124
169
  "type": "string"
@@ -129,27 +174,51 @@
129
174
  "name": "IncrementMetricOptions",
130
175
  "slug": "incrementmetricoptions",
131
176
  "docs": "",
132
- "tags": [],
177
+ "tags": [
178
+ {
179
+ "text": "0.1.0",
180
+ "name": "since"
181
+ }
182
+ ],
133
183
  "methods": [],
134
184
  "properties": [
135
185
  {
136
186
  "name": "traceName",
137
- "tags": [],
187
+ "tags": [
188
+ {
189
+ "text": "0.1.0",
190
+ "name": "since"
191
+ }
192
+ ],
138
193
  "docs": "Name of the trace that was set with `startTrace`.",
139
194
  "complexTypes": [],
140
195
  "type": "string"
141
196
  },
142
197
  {
143
198
  "name": "metricName",
144
- "tags": [],
199
+ "tags": [
200
+ {
201
+ "text": "0.1.0",
202
+ "name": "since"
203
+ }
204
+ ],
145
205
  "docs": "Name of the metric to be incremented.",
146
206
  "complexTypes": [],
147
207
  "type": "string"
148
208
  },
149
209
  {
150
210
  "name": "incrementBy",
151
- "tags": [],
152
- "docs": "Amount by which the metric has to be incremented.\n\nDefault: `1`",
211
+ "tags": [
212
+ {
213
+ "text": "1",
214
+ "name": "default"
215
+ },
216
+ {
217
+ "text": "0.1.0",
218
+ "name": "since"
219
+ }
220
+ ],
221
+ "docs": "Amount by which the metric has to be incremented.",
153
222
  "complexTypes": [],
154
223
  "type": "number | undefined"
155
224
  }
@@ -159,12 +228,22 @@
159
228
  "name": "SetPerformanceCollectionEnabledOptions",
160
229
  "slug": "setperformancecollectionenabledoptions",
161
230
  "docs": "",
162
- "tags": [],
231
+ "tags": [
232
+ {
233
+ "text": "0.1.0",
234
+ "name": "since"
235
+ }
236
+ ],
163
237
  "methods": [],
164
238
  "properties": [
165
239
  {
166
240
  "name": "enabled",
167
- "tags": [],
241
+ "tags": [
242
+ {
243
+ "text": "0.1.0",
244
+ "name": "since"
245
+ }
246
+ ],
168
247
  "docs": "Should performance monitoring be enabled.",
169
248
  "complexTypes": [],
170
249
  "type": "boolean"
@@ -180,7 +259,12 @@
180
259
  "properties": [
181
260
  {
182
261
  "name": "enabled",
183
- "tags": [],
262
+ "tags": [
263
+ {
264
+ "text": "0.1.0",
265
+ "name": "since"
266
+ }
267
+ ],
184
268
  "docs": "`true` if performance monitoring is enabled, otherwise `false`.",
185
269
  "complexTypes": [],
186
270
  "type": "boolean"
package/dist/esm/definitions.d.ts CHANGED
@@ -1,26 +1,39 @@
1
1
  export interface FirebasePerformancePlugin {
2
2
  /**
3
3
  * Starts a trace.
4
+ *
5
+ * @since 0.1.0
4
6
  */
5
7
  startTrace(options: StartTraceOptions): Promise<void>;
6
8
  /**
7
9
  * Stops a trace.
10
+ *
11
+ * @since 0.1.0
8
12
  */
9
13
  stopTrace(options: StopTraceOptions): Promise<void>;
10
14
  /**
11
15
  * Atomically increments the metric with the given name for the selected trace by the `incrementBy` value.
16
+ *
17
+ * @since 0.1.0
12
18
  */
13
19
  incrementMetric(options: IncrementMetricOptions): Promise<void>;
14
20
  /**
15
21
  * Enables or disables performance monitoring.
16
22
  * Will be applied with the next start of the app.
23
+ *
24
+ * @since 0.1.0
17
25
  */
18
26
  setPerformanceCollectionEnabled(options: SetPerformanceCollectionEnabledOptions): Promise<void>;
19
27
  /**
20
28
  * Determines whether performance monitoring is enabled or disabled.
29
+ *
30
+ * @since 0.1.0
21
31
  */
22
32
  isPerformanceCollectionEnabled(): Promise<IsPerformanceCollectionEnabledResult>;
23
33
  }
34
+ /**
35
+ * @since 0.1.0
36
+ */
24
37
  export interface StartTraceOptions {
25
38
  /**
26
39
  * Custom trace name.
@@ -28,40 +41,62 @@ export interface StartTraceOptions {
28
41
  * Names for custom code traces must meet the following requirements:
29
42
  * no leading or trailing whitespace, no leading underscore (_) character,
30
43
  * and max length is 100 characters.
44
+ *
45
+ * @since 0.1.0
31
46
  */
32
47
  traceName: string;
33
48
  }
49
+ /**
50
+ * @since 0.1.0
51
+ */
34
52
  export interface StopTraceOptions {
35
53
  /**
36
54
  * Name of the trace that was set with `startTrace`.
55
+ *
56
+ * @since 0.1.0
37
57
  */
38
58
  traceName: string;
39
59
  }
60
+ /**
61
+ * @since 0.1.0
62
+ */
40
63
  export interface IncrementMetricOptions {
41
64
  /**
42
65
  * Name of the trace that was set with `startTrace`.
66
+ *
67
+ * @since 0.1.0
43
68
  */
44
69
  traceName: string;
45
70
  /**
46
71
  * Name of the metric to be incremented.
72
+ *
73
+ * @since 0.1.0
47
74
  */
48
75
  metricName: string;
49
76
  /**
50
77
  * Amount by which the metric has to be incremented.
51
78
  *
52
- * Default: `1`
79
+ * @default 1
80
+ * @since 0.1.0
53
81
  */
54
82
  incrementBy?: number;
55
83
  }
84
+ /**
85
+ * @since 0.1.0
86
+ */
56
87
  export interface SetPerformanceCollectionEnabledOptions {
57
88
  /**
58
89
  * Should performance monitoring be enabled.
90
+ *
91
+ * @since 0.1.0
59
92
  */
60
93
  enabled: boolean;
61
94
  }
62
95
  export interface IsPerformanceCollectionEnabledResult {
63
96
  /**
64
97
  * `true` if performance monitoring is enabled, otherwise `false`.
98
+ *
99
+ * @since 0.1.0
65
100
  */
66
101
  enabled: boolean;
67
102
  }
package/dist/esm/definitions.js.map CHANGED
@@ -1 +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"]}
1
+ {"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 CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@capacitor-firebase/performance",
3
- "version": "0.2.0",
3
+ "version": "0.3.0-dev.6ead72e.1654850957",
4
4
  "description": "Capacitor plugin for Firebase Performance Monitoring.",
5
5
  "main": "dist/plugin.cjs.js",
6
6
  "module": "dist/esm/index.js",