@icanbwell/types 4.0.1 → 4.1.0
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.
- package/package.json +3 -3
- package/src/index.d.ts +34 -0
- package/src/native-components.d.ts +2 -1
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@icanbwell/types",
|
|
3
|
-
"version": "4.0
|
|
3
|
+
"version": "4.1.0",
|
|
4
4
|
"typedoc": {
|
|
5
5
|
"entryPoint": "./src/index.ts",
|
|
6
6
|
"tsconfig": "./tsconfig.lib.json"
|
|
@@ -36,8 +36,8 @@
|
|
|
36
36
|
"import": "./index.js"
|
|
37
37
|
}
|
|
38
38
|
},
|
|
39
|
-
"repoVersion": "8.
|
|
40
|
-
"description": "@icanbwell/types. repo version: 8.
|
|
39
|
+
"repoVersion": "8.11.0",
|
|
40
|
+
"description": "@icanbwell/types. repo version: 8.11.0",
|
|
41
41
|
"peerDependencies": {
|
|
42
42
|
"react-native": "0.x",
|
|
43
43
|
"react-native-biometrics": "3.x",
|
package/src/index.d.ts
CHANGED
|
@@ -9,3 +9,37 @@ export type PageTransitionEventPayload = {
|
|
|
9
9
|
path: string;
|
|
10
10
|
pageTitle?: string;
|
|
11
11
|
};
|
|
12
|
+
/**
|
|
13
|
+
* The `Telemetry` type represents the configuration for telemetry settings.
|
|
14
|
+
* It can be either a boolean value or an object containing boolean flags for individual telemetry features.
|
|
15
|
+
*
|
|
16
|
+
* If the `Telemetry` variable is a boolean, all three telemetry features will be set to that boolean value.
|
|
17
|
+
*
|
|
18
|
+
* If the `Telemetry` variable is an object, you can individually enable/disable specific telemetry features
|
|
19
|
+
* using boolean flags:
|
|
20
|
+
*
|
|
21
|
+
* - `logging`: Set to `true` to enable logging, `false` to disable. When logging is disabled, logs (such as logs, errors, infos, debugs) will be output to the development console instead of Sentry.
|
|
22
|
+
*
|
|
23
|
+
* - `tracing`: Set to `true` to enable tracing, `false` to disable. When tracing is disabled, Otel traces will be logged to the development console.
|
|
24
|
+
*
|
|
25
|
+
* - `rum`: Set to `true` to enable Real User Monitoring (RUM), `false` to disable. The behavior of disabling RUM is to be determined (TBD).
|
|
26
|
+
*
|
|
27
|
+
* Examples:
|
|
28
|
+
*
|
|
29
|
+
* ```typescript
|
|
30
|
+
* // Example 1: Set all telemetry features to true
|
|
31
|
+
* const telemetry1: Telemetry = true;
|
|
32
|
+
*
|
|
33
|
+
* // Example 2: Set individual telemetry features using an object
|
|
34
|
+
* const telemetry2: Telemetry = {
|
|
35
|
+
* logging: true, // Enable logging
|
|
36
|
+
* tracing: false, // Disable tracing
|
|
37
|
+
* rum: true // Enable RUM
|
|
38
|
+
* };
|
|
39
|
+
* ```
|
|
40
|
+
*/
|
|
41
|
+
export type Telemetry = boolean | {
|
|
42
|
+
logging?: boolean;
|
|
43
|
+
tracing?: boolean;
|
|
44
|
+
rum?: boolean;
|
|
45
|
+
};
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { NativeModuleMap } from './native-plugins';
|
|
2
|
-
import { PageTransitionEventKey, PageTransitionEventPayload } from '.';
|
|
2
|
+
import { PageTransitionEventKey, PageTransitionEventPayload, Telemetry } from '.';
|
|
3
3
|
export type OnAuthSuccessEventData = {
|
|
4
4
|
user: {
|
|
5
5
|
id: string;
|
|
@@ -32,6 +32,7 @@ export type ComponentViewBaseProps = {
|
|
|
32
32
|
onEvent?: <T extends keyof EventKeyToDataMap>(data: OnEventData<T>) => void;
|
|
33
33
|
debug?: boolean;
|
|
34
34
|
nativeModules?: NativeModuleMap;
|
|
35
|
+
telemetry?: Telemetry;
|
|
35
36
|
} & ({
|
|
36
37
|
/** Supply the auth strategy. Defaults to `jwe` which will require a `userToken` prop.
|
|
37
38
|
*
|