@dynatrace/react-native-plugin 2.275.1 → 2.279.1

package/lib/react/Component.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DynatraceClassWrapper = exports.DynatraceFnWrapper = void 0;
-const React = require("react");
-const Configuration_1 = require("../instrumentor/base/configuration/Configuration");
+const react_1 = require("react");
+const ConfigurationHandler_1 = require("../instrumentor/base/configuration/ConfigurationHandler");
 const Logger_1 = require("../instrumentor/base/Logger");
 const NullAction_1 = require("../instrumentor/base/NullAction");
 const Dynatrace_1 = require("../instrumentor/base/Dynatrace");
@@ -12,24 +12,24 @@ const DynatraceFnWrapper = (props) => {
     if (action instanceof NullAction_1.NullAction) {
         Logger_1.Logger.logInfo(`Component ${componentName}: React Native plugin has not been started yet! Component will not be reported!`);
     }
-    React.useEffect(() => {
+    (0, react_1.useEffect)(() => {
         action.leaveAction();
     });
     return props.children;
 };
 exports.DynatraceFnWrapper = DynatraceFnWrapper;
-class DynatraceClassWrapper extends React.Component {
+class DynatraceClassWrapper extends react_1.Component {
     constructor(props) {
         super(props);
         this.wrappingName = getNameFromComponent(props);
         this.componentMounted = false;
     }
     render() {
-        if (!Configuration_1.Configuration.isConfigurationAvailable()) {
+        if (!ConfigurationHandler_1.ConfigurationHandler.isConfigurationAvailable()) {
             Logger_1.Logger.logInfo(`Component ${this.wrappingName}: React Native plugin has not been started yet! Component will not be reported!`);
         }
         else {
-            if ((this.componentMounted && Configuration_1.Configuration.isLifecycleUpdateEnabled()) ||
+            if ((this.componentMounted && ConfigurationHandler_1.ConfigurationHandler.isLifecycleUpdateEnabled()) ||
                 !this.componentMounted) {
                 const actionPrefix = !this.componentMounted ? 'Render ' : 'Update ';
                 this.internalAction = Dynatrace_1.Dynatrace.enterAutoAction(actionPrefix + this.wrappingName);

package/lib/react-navigation/ReactNavigation.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerListener = void 0;
+const React = require("react");
+const Logger_1 = require("../instrumentor/base/Logger");
+let isRegistered = false;
+const registerListener = (navContainer) => {
+    React.useEffect(() => {
+        if (isRegistered && navContainer.current != null && navContainer.current.addListener != null) {
+            isRegistered = true;
+            navContainer.current.addListener('__unsafe_action__', (data) => {
+                if (data != null && data.data != null && data.data.action != null) {
+                    Logger_1.Logger.logDebug(`ReactNavigation Listener Dispatch: ${JSON.stringify(data.data.action)}`);
+                }
+            });
+            navContainer.current.addListener('state', (state) => {
+                Logger_1.Logger.logDebug(`ReactNavigation Listener State: ${JSON.stringify(state)}`);
+            });
+        }
+    });
+};
+exports.registerListener = registerListener;

package/package.json

@@ -1 +1 @@
-{"name":"@dynatrace/react-native-plugin","version":"2.275.1","description":"This plugin gives you the ability to use the Dynatrace Mobile agent in your react native application.","main":"index.js","types":"typings/react-native-dynatrace.d.ts","bin":{"instrumentDynatrace":"scripts/Instrument.js","configDynatrace":"scripts/CheckConfig.js"},"keywords":["react-native","dynatrace","mobile","android","ios","performance","monitoring"],"rnpm":{"plugin":"./command/command.js"},"scripts":{"uninstall":"node ./scripts/Uninstall.js","test":"jest --runInBand","test:debug":"node --inspect-brk ./node_modules/jest/bin/jest.js --runInBand","tsc":"tsc","tsc:prod":"tsc -p tsconfig.release.json","lint":"eslint --cache src/**/*.ts --ignore-pattern .gitignore","lint:spec":"eslint --cache tests/**/*.ts --cache-file tests/.eslintcache --ignore-pattern .gitignore --fix"},"jest":{"preset":"react-native","moduleDirectories":["node_modules"],"unmockedModulePathPatterns":["node_modules"],"modulePathIgnorePatterns":["<rootDir>/src","<rootDir>/tests/commandTestTmp","node_modules/react-native/local-cli"],"transform":{"^.+\\.(ts|tsx)$":"ts-jest"},"testPathIgnorePatterns":["<rootDir>/src","<rootDir>/tests/commandTestTmp"],"transformIgnorePatterns":["node_modules/(?!(@react-native|react-native)/)"],"setupFiles":["<rootDir>/tests/setup/setup.js"],"testResultsProcessor":"jest-junit","testRegex":["(/__tests__/.*|(\\.|/)(Test|spec))\\.[jt]sx?$"]},"jest-junit":{"suiteName":"jest tests","outputDirectory":".","outputName":"junit.xml","uniqueOutputName":"true","ancestorSeparator":" › ","usePathForSuiteName":"true"},"author":"Dynatrace","license":"SEE LICENSE IN LICENSE.md","dependencies":{"@babel/runtime":"^7.22.15","jscodeshift":"^0.15.0","plist":"^3.1.0","proxy-polyfill":"^0.3.2","semver":"^7.5.4"},"homepage":"https://www.dynatrace.com/","peerDependencies":{"@babel/parser":">=7.4.4","@react-native-picker/picker":">=1.0.0","react":">=16.8.0","react-native":">=0.59.0"},"devDependencies":{"@babel/cli":"^7.22.9","@babel/plugin-proposal-class-properties":"^7.8.3","@babel/plugin-proposal-nullish-coalescing-operator":"^7.8.3","@babel/plugin-proposal-optional-chaining":"^7.8.3","@babel/plugin-transform-flow-strip-types":"^7.8.3","@babel/plugin-transform-runtime":"^7.12.1","@babel/preset-env":"^7.4.4","@babel/preset-react":"^7.8.3","@testing-library/react-native":"^7.0.2","@types/jest":"^26.0.19","@types/jscodeshift":"^0.11.6","@types/libxmljs":"^0.18.3","@types/node":"^18.17.12","@types/plist":"^3.0.2","@types/react-native":"^0.63.32","@types/semver":"^7.5.0","@types/shelljs":"^0.8.8","@types/uglify-js":"^3.17.1","@typescript-eslint/eslint-plugin":"^5.16.0","@typescript-eslint/parser":"^5.16.0","compressing":"^1.5.1","eslint":"^8.45.0","eslint-config-prettier":"^8.5.0","eslint-plugin-import":"^2.26.0","eslint-plugin-jsdoc":"^39.1.0","eslint-plugin-prefer-arrow":"^1.2.3","eslint-plugin-unicorn":"^42.0.0","jest":"24.9.0","jest-each":"^28.1.3","jest-junit":"^14.0.0","jest-mock":"^28.1.3","npm-check-updates":"^16.10.12","prettier":"^2.6.1","shelljs":"^0.8.5","ts-jest":"24.3.0","ts-mockito":"^2.6.1","typescript":"^4.7.4","uglify-js":"^3.17.4","react-native":"0.71.3","react":"18.2.0","react-test-renderer":"18.2.0"},"files":["command/command.js","command/util/*","command/interface/*","android/build.gradle","android/src/main/**/*","ios/**/*","files/*","lib/instrumentor/base/*.js","lib/instrumentor/base/model/*.js","lib/instrumentor/base/configuration/*.js","lib/instrumentor/base/configuration/interface/*.js","lib/instrumentor/base/interface/*.js","lib/instrumentor/base/util/*.js","lib/instrumentor/model/*.js","lib/instrumentor/parser/*.js","lib/instrumentor/DynatraceInstrumentation.js","lib/*.js","lib/community/*.js","lib/community/gesture-handler/*.js","lib/react-native/*.js","lib/react/*.js","lib/metro/*.js","lib/util/*.js","react-native.config.js","react-native-dynatrace.js","react-native-dynatrace.podspec","README.md","LICENSE.md","scripts/*","scripts/api/*","scripts/core/*","scripts/api/model/*","scripts/util/*","typings/*","package.json","jsx-runtime.js"]}
+{"name":"@dynatrace/react-native-plugin","version":"2.279.1","description":"This plugin gives you the ability to use the Dynatrace Mobile agent in your react native application.","main":"index.js","types":"typings/react-native-dynatrace.d.ts","bin":{"instrumentDynatrace":"scripts/Instrument.js","configDynatrace":"scripts/CheckConfig.js"},"keywords":["react-native","dynatrace","mobile","android","ios","performance","monitoring"],"rnpm":{"plugin":"./command/command.js"},"scripts":{"uninstall":"node ./scripts/Uninstall.js","test":"jest --runInBand","test:debug":"node --inspect-brk ./node_modules/jest/bin/jest.js --runInBand","tsc":"tsc","tsc:prod":"tsc -p tsconfig.release.json","lint":"eslint --cache src/**/*.ts --ignore-pattern .gitignore","lint:spec":"eslint --cache tests/**/*.ts --cache-file tests/.eslintcache --ignore-pattern .gitignore --fix"},"jest":{"preset":"react-native","moduleDirectories":["node_modules"],"unmockedModulePathPatterns":["node_modules"],"modulePathIgnorePatterns":["<rootDir>/src","<rootDir>/tests/commandTestTmp","node_modules/react-native/local-cli"],"transform":{"^.+\\.(ts|tsx)$":"ts-jest"},"testPathIgnorePatterns":["<rootDir>/src","<rootDir>/tests/commandTestTmp"],"transformIgnorePatterns":["node_modules/(?!(@react-native|react-native)/)"],"setupFiles":["<rootDir>/tests/setup/setup.js"],"testResultsProcessor":"jest-junit","testRegex":["(/__tests__/.*|(\\.|/)(Test|spec))\\.[jt]sx?$"]},"jest-junit":{"suiteName":"jest tests","outputDirectory":".","outputName":"junit.xml","uniqueOutputName":"true","ancestorSeparator":" › ","usePathForSuiteName":"true"},"author":"Dynatrace","license":"SEE LICENSE IN LICENSE.md","dependencies":{"@babel/runtime":"^7.23.2","jscodeshift":"^0.15.1","plist":"^3.1.0","proxy-polyfill":"^0.3.2","semver":"^7.5.4"},"homepage":"https://www.dynatrace.com/","peerDependencies":{"@babel/parser":">=7.4.4","@react-native-picker/picker":">=1.0.0","react":">=16.8.0","react-native":">=0.59.0"},"devDependencies":{"@babel/cli":"^7.22.9","@babel/plugin-proposal-class-properties":"^7.8.3","@babel/plugin-proposal-nullish-coalescing-operator":"^7.8.3","@babel/plugin-proposal-optional-chaining":"^7.8.3","@babel/plugin-transform-flow-strip-types":"^7.8.3","@babel/plugin-transform-runtime":"^7.12.1","@babel/preset-env":"^7.4.4","@babel/preset-react":"^7.8.3","@testing-library/react-native":"^7.0.2","@types/jest":"^26.0.19","@types/jscodeshift":"^0.11.6","@types/libxmljs":"^0.18.3","@types/node":"^18.17.12","@types/plist":"^3.0.2","@types/react-native":"^0.63.32","@types/semver":"^7.5.0","@types/shelljs":"^0.8.8","@types/uglify-js":"^3.17.1","@typescript-eslint/eslint-plugin":"^5.16.0","@typescript-eslint/parser":"^5.16.0","compressing":"^1.5.1","eslint":"^8.45.0","eslint-config-prettier":"^8.5.0","eslint-plugin-import":"^2.26.0","eslint-plugin-jsdoc":"^39.1.0","eslint-plugin-prefer-arrow":"^1.2.3","eslint-plugin-unicorn":"^42.0.0","jest":"24.9.0","jest-each":"^28.1.3","jest-junit":"^14.0.0","jest-mock":"^28.1.3","npm-check-updates":"^16.10.12","prettier":"^2.6.1","shelljs":"^0.8.5","ts-jest":"24.3.0","ts-mockito":"^2.6.1","typescript":"^4.7.4","uglify-js":"^3.17.4","react-native":"0.71.3","react":"18.2.0","react-test-renderer":"18.2.0"},"files":["command/command.js","command/util/*","command/interface/*","android/build.gradle","android/src/main/**/*","ios/**/*","files/*","lib/instrumentor/base/*.js","lib/instrumentor/base/model/*.js","lib/instrumentor/base/configuration/*.js","lib/instrumentor/base/configuration/interface/*.js","lib/instrumentor/base/interface/*.js","lib/instrumentor/base/util/*.js","lib/instrumentor/model/*.js","lib/instrumentor/parser/*.js","lib/instrumentor/DynatraceInstrumentation.js","lib/*.js","lib/community/*.js","lib/community/gesture-handler/*.js","lib/react-navigation/*.js","lib/react-native/*.js","lib/react/*.js","lib/metro/*.js","lib/util/*.js","react-native.config.js","react-native-dynatrace.js","react-native-dynatrace.podspec","README.md","LICENSE.md","scripts/*","scripts/api/*","scripts/core/*","scripts/api/model/*","scripts/util/*","typings/*","package.json","jsx-runtime.js"]}

package/scripts/Config.js

@@ -27,6 +27,9 @@ exports.defaultConfig = {
             instrument: (filename) => true,
             actionNamePrivacy: false,
         },
+        custom: {
+            reactnavigation: false,
+        },
     },
 };
 const readConfig = (pathToConfig) => {

package/typings/react-native-dynatrace.d.ts

@@ -81,9 +81,9 @@ export declare const Dynatrace: {
 	 * in case of manual startup and will be ignored in auto startup scenarios. The start method will
 	 * set the error handler for reporting crashes and will apply the provided configuration globally.
 	 *
-	 * @param {ManualStartupConfiguration} configuration Configuration for a manual startup of the plugin
+	 * @param {IConfiguration} configuration Configuration for a manual startup of the plugin
 	 */
-	start(configuration: ManualStartupConfiguration): Promise<void>;
+	start(configuration: IConfiguration): Promise<void>;
 
 	/**
 	 * This call allows to monitor the passed in component. Depending on the type of the component
@@ -545,10 +545,75 @@ export declare class UserPrivacyOptions {
 	set crashReportingOptedIn(crashReportingOptedIn: boolean);
 }
 
+/**
+ * Configuration interface which should be used during a manual startup
+ */
+export declare interface IConfiguration {
+
+    /**
+     * Beacon url which is used for communicate with the beacon endpoint. This value is mandatory.
+     *
+     * Be aware this value is only important for manual startup. In case of auto startup this needs to be handled via
+     * native agent configuration.
+     */
+    readonly beaconUrl: string;
+
+    /**
+     * Needed to identify and report data for this application. This value is mandatory.
+     *
+     * Be aware this value is only important for manual startup. In case of auto startup this needs to be handled via
+     * native agent configuration.
+     */
+	readonly applicationId: string;
+
+    /**
+     * Enables reporting of crashes. By default this value is true if nothing is passed.
+     *
+     * Be aware this value is only important for manual startup. In case of auto startup this needs to be handled via
+     * native agent configuration.
+     */
+	readonly reportCrash: boolean;
+
+    /**
+     * Log level of our plugin during application runtime. By default this values is LogLevel.Info, if nothing is passed.
+     */
+	readonly logLevel: LogLevel;
+
+    /**
+     * Decide if you want to see update cycles on lifecycle actions as well.
+     * By default this value is false, if nothing is passed. Be aware as this creates a lot more data.
+     */
+	readonly lifecycleUpdate: boolean;
+
+    /**
+     * Activates the privacy mode when set to true. User consent must be queried and set.
+     * The privacy settings for data collection and crash reporting can be changed via OneAgent SDK
+     * for Mobile as described under Data privacy. By default this value is false, if nothing is passed.
+     *
+     * Be aware this value is only important for manual startup. In case of auto startup this needs to be handled via
+     * native agent configuration.
+     */
+	readonly userOptIn: boolean;
+
+    /**
+     * Activates a privacy mode especially for Touchables and Buttons. Setting this option to true
+     * means that a name for the control will no longer be shown, e.g. "Touch on Button".
+     * When setting a dtActionName onto the component this setting will be ignored. By default this value is false,
+     * if nothing is passed.
+     */
+	readonly actionNamePrivacy: boolean;
+
+    /**
+     * Will define the bundle name which will prefix internal action ids.
+     */
+    readonly bundleName?: string;
+}
+
 /**
  * Manual startup configuration which is used for Dynatrace.start()
+ * @deprecated Use ConfigurationBuilder and IConfiguration instead
  */
-export declare class ManualStartupConfiguration {
+export declare class ManualStartupConfiguration implements IConfiguration {
 	/**
 	 * Creates a Manual Startup configuration instance
 	 *
@@ -560,8 +625,129 @@ export declare class ManualStartupConfiguration {
 	 * @param {boolean} userOptIn Activates the privacy mode when set to `true`. User consent must be queried and set.
 	 * @param {boolean} actionNamePrivacy Activates a privacy mode especially for Touchables and Buttons. Setting this option to true means that a name for the control will no longer be shown, e.g. "Touch on Button". When setting a dtActionName onto the component this setting will be ignored.
 	 * @param {string} bundleName Will define the bundle name which will prefix internal action ids.
+	 * 
+	 * @deprecated Use ConfigurationBuilder and IConfiguration instead
 	 */
 	constructor(beaconUrl: string, applicationId: string, reportCrash?: boolean,
 		logLevel?: LogLevel, lifecycleUpdate?: boolean, userOptIn?: boolean, 
 		actionNamePrivacy?: boolean, bundleName?: string);
+
+	/**
+     * Beacon url which is used for communicate with the beacon endpoint. This value is mandatory.
+     *
+     * Be aware this value is only important for manual startup. In case of auto startup this needs to be handled via
+     * native agent configuration.
+     */
+    readonly beaconUrl: string;
+
+    /**
+     * Needed to identify and report data for this application. This value is mandatory.
+     *
+     * Be aware this value is only important for manual startup. In case of auto startup this needs to be handled via
+     * native agent configuration.
+     */
+	readonly applicationId: string;
+
+	/**
+     * Enables reporting of crashes. By default this value is true if nothing is passed.
+     *
+     * Be aware this value is only important for manual startup. In case of auto startup this needs to be handled via
+     * native agent configuration.
+     */
+	readonly reportCrash: boolean;
+
+    /**
+     * Log level of our plugin during application runtime. By default this values is LogLevel.Info, if nothing is passed.
+     */
+	readonly logLevel: LogLevel;
+
+    /**
+     * Decide if you want to see update cycles on lifecycle actions as well.
+     * By default this value is false, if nothing is passed. Be aware as this creates a lot more data.
+     */
+	readonly lifecycleUpdate: boolean;
+
+    /**
+     * Activates the privacy mode when set to true. User consent must be queried and set.
+     * The privacy settings for data collection and crash reporting can be changed via OneAgent SDK
+     * for Mobile as described under Data privacy. By default this value is false, if nothing is passed.
+     *
+     * Be aware this value is only important for manual startup. In case of auto startup this needs to be handled via
+     * native agent configuration.
+     */
+	readonly userOptIn: boolean;
+
+    /**
+     * Activates a privacy mode especially for Touchables and Buttons. Setting this option to true
+     * means that a name for the control will no longer be shown, e.g. "Touch on Button".
+     * When setting a dtActionName onto the component this setting will be ignored. By default this value is false,
+     * if nothing is passed.
+     */
+	readonly actionNamePrivacy: boolean;
+
+    /**
+     * Will define the bundle name which will prefix internal action ids.
+     */
+    readonly bundleName?: string;
+}
+
+/**
+ * Builder for Manual startup configuration which is used for Dynatrace.start()
+ */
+export declare class ConfigurationBuilder {
+
+	/**
+	 * Creates a builder for Manual Startup configuration
+	 * 
+	 * @param {string} beaconUrl Identifies your environment within Dynatrace. This property is mandatory for manual startup
+	 * @param {string} applicationId Identifies your mobile app. This property is mandatory for manual startup
+	 */
+	constructor(beaconUrl: string, applicationId: string);
+
+	/**
+	 * Builder function to handle crash reporting property
+	 *
+	 * @param {boolean} reportCrash Allows reporting React Native crashes.     
+	 */
+	public withCrashReporting(reportCrash: boolean): ConfigurationBuilder;
+
+	/**
+	 * Builder function to handle loglevel property
+	 *
+	 * @param {LogLevel} logLevel Allows you to choose between `LogLevel.Info` and `LogLevel.Debug`. Debug returns more logs. This is especially important when something is not functioning correctly.
+	 */
+	public withLogLevel(logLevel: LogLevel): ConfigurationBuilder;
+
+	/**
+	 * Builder function to handle lifecycle update property
+	 *
+	 * @param {boolean} lifecycleUpdate Decide if you want to see update cycles on lifecycle actions as well. This is per default false as it creates a lot more actions.
+	 */
+	public withLifecycleUpdate(lifecycleUpdate: boolean): ConfigurationBuilder
+
+	/**
+	 * Builder function to handle user opt in property
+	 *
+	 * @param {boolean} userOptIn Activates the privacy mode when set to `true`. User consent must be queried and set.
+	 */
+	public withUserOptIn(userOptIn: boolean): ConfigurationBuilder;
+
+	/**
+	 * Builder function to handle action name privacy property
+	 * 
+	 * @param {boolean} actionNamePrivacy Activates a privacy mode especially for Touchables and Buttons. Setting this option to true means that a name for the control will no longer be shown, e.g. "Touch on Button". When setting a dtActionName onto the component this setting will be ignored.
+	 */
+	public withActionNamePrivacy(actionNamePrivacy: boolean): ConfigurationBuilder;
+
+	/**
+	 * Builder function to handle bundle name property
+	 *
+	 * @param {string} bundleName Will define the bundle name which will prefix internal action ids.
+	 */
+	public withBundleName(bundleName: string): ConfigurationBuilder;
+
+	/**
+	 * Build configuration which is used for startup
+	 */
+	public buildConfiguration(): IConfiguration;
 }

package/lib/instrumentor/base/configuration/AutoStartupConfiguration.js

@@ -1,28 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AutoStartupConfiguration = void 0;
-const ConfigurationDefaults_1 = require("./ConfigurationDefaults");
-class AutoStartupConfiguration {
-    constructor(optionalAutoStartParameters) {
-        this.lifecycleUpdate = ConfigurationDefaults_1.DEFAULT_LIFECYCLE_UPDATE_AUTO;
-        this.logLevel = ConfigurationDefaults_1.DEFAULT_LOGLEVEL_AUTO;
-        this.actionNamePrivacy = ConfigurationDefaults_1.DEFAULT_ACTION_NAME_PRIVACY;
-        this.bundleName = ConfigurationDefaults_1.DEFAULT_BUNDLE_NAME_AUTO;
-        if (optionalAutoStartParameters === undefined) {
-            return;
-        }
-        if (optionalAutoStartParameters.lifecycleUpdate !== undefined) {
-            this.lifecycleUpdate = optionalAutoStartParameters.lifecycleUpdate;
-        }
-        if (optionalAutoStartParameters.logLevel !== undefined) {
-            this.logLevel = optionalAutoStartParameters.logLevel;
-        }
-        if (optionalAutoStartParameters.actionNamePrivacy !== undefined) {
-            this.actionNamePrivacy = optionalAutoStartParameters.actionNamePrivacy;
-        }
-        if (optionalAutoStartParameters.bundleName !== undefined) {
-            this.bundleName = optionalAutoStartParameters.bundleName;
-        }
-    }
-}
-exports.AutoStartupConfiguration = AutoStartupConfiguration;

package/lib/instrumentor/base/configuration/interface/IAutoConfiguration.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });