@microsoft/applicationinsights-react-native 3.0.3 → 4.0.0

package/dist/applicationinsights-react-native.api.json

@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "7.35.1",
+    "toolVersion": "7.36.3",
     "schemaVersion": 1011,
     "oldestForwardsCompatibleVersion": 1001,
     "tsdocConfig": {
@@ -509,12 +509,12 @@
         },
         {
           "kind": "Class",
-          "canonicalReference": "@microsoft/applicationinsights-react-native!ReactNativePlugin:class",
+          "canonicalReference": "@microsoft/applicationinsights-react-native!ReactNativeManualDevicePlugin:class",
           "docComment": "",
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export declare class ReactNativePlugin extends "
+              "text": "export declare class ReactNativeManualDevicePlugin extends "
             },
             {
               "kind": "Reference",
@@ -526,15 +526,15 @@
               "text": " "
             }
           ],
-          "fileUrlPath": "types/ReactNativePlugin.d.ts",
+          "fileUrlPath": "types/ReactNativeManualDevicePlugin.d.ts",
           "releaseTag": "Public",
           "isAbstract": false,
-          "name": "ReactNativePlugin",
+          "name": "ReactNativeManualDevicePlugin",
           "preserveMemberOrder": false,
           "members": [
             {
               "kind": "Property",
-              "canonicalReference": "@microsoft/applicationinsights-react-native!ReactNativePlugin#_nextPlugin:member",
+              "canonicalReference": "@microsoft/applicationinsights-react-native!ReactNativeManualDevicePlugin#_nextPlugin:member",
               "docComment": "",
               "excerptTokens": [
                 {
@@ -565,8 +565,8 @@
             },
             {
               "kind": "Constructor",
-              "canonicalReference": "@microsoft/applicationinsights-react-native!ReactNativePlugin:constructor(1)",
-              "docComment": "/**\n * Constructs a new instance of the `ReactNativePlugin` class\n */\n",
+              "canonicalReference": "@microsoft/applicationinsights-react-native!ReactNativeManualDevicePlugin:constructor(1)",
+              "docComment": "/**\n * Constructs a new instance of the `ReactNativeManualDevicePlugin` class\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -596,9 +596,58 @@
                 }
               ]
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@microsoft/applicationinsights-react-native!ReactNativeManualDevicePlugin#getDeviceInfoModule:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "protected getDeviceInfoModule(_deviceInfoModule: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "any"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "IDeviceInfoModule",
+                  "canonicalReference": "@microsoft/applicationinsights-react-native!IDeviceInfoModule:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "releaseTag": "Public",
+              "isProtected": true,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "_deviceInfoModule",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "getDeviceInfoModule"
+            },
             {
               "kind": "Property",
-              "canonicalReference": "@microsoft/applicationinsights-react-native!ReactNativePlugin#identifier:member",
+              "canonicalReference": "@microsoft/applicationinsights-react-native!ReactNativeManualDevicePlugin#identifier:member",
               "docComment": "",
               "excerptTokens": [
                 {
@@ -628,7 +677,7 @@
             },
             {
               "kind": "Method",
-              "canonicalReference": "@microsoft/applicationinsights-react-native!ReactNativePlugin#initialize:member(1)",
+              "canonicalReference": "@microsoft/applicationinsights-react-native!ReactNativeManualDevicePlugin#initialize:member(1)",
               "docComment": "",
               "excerptTokens": [
                 {
@@ -719,7 +768,7 @@
             },
             {
               "kind": "Property",
-              "canonicalReference": "@microsoft/applicationinsights-react-native!ReactNativePlugin#priority:member",
+              "canonicalReference": "@microsoft/applicationinsights-react-native!ReactNativeManualDevicePlugin#priority:member",
               "docComment": "",
               "excerptTokens": [
                 {
@@ -749,7 +798,7 @@
             },
             {
               "kind": "Method",
-              "canonicalReference": "@microsoft/applicationinsights-react-native!ReactNativePlugin#processTelemetry:member(1)",
+              "canonicalReference": "@microsoft/applicationinsights-react-native!ReactNativeManualDevicePlugin#processTelemetry:member(1)",
               "docComment": "",
               "excerptTokens": [
                 {
@@ -815,7 +864,7 @@
             },
             {
               "kind": "Method",
-              "canonicalReference": "@microsoft/applicationinsights-react-native!ReactNativePlugin#setDeviceId:member(1)",
+              "canonicalReference": "@microsoft/applicationinsights-react-native!ReactNativeManualDevicePlugin#setDeviceId:member(1)",
               "docComment": "/**\n * Manually set the deviceId, if set before initialization and automatic device info collection is enabled this value may get overwritten. If you want to keep this value disable auto collection by setting the `disableDeviceCollection` config to true.\n *\n * @param newId - The value to use as the device Id.\n */\n",
               "excerptTokens": [
                 {
@@ -863,8 +912,8 @@
             },
             {
               "kind": "Method",
-              "canonicalReference": "@microsoft/applicationinsights-react-native!ReactNativePlugin#setDeviceInfoModule:member(1)",
-              "docComment": "/**\n * Set the module that will be used during initialization when collecting device is enabled (the default), automatic collection can be disabled via the `disableDeviceCollection` config. The `react-native-device-info` module will be used by default if no `deviceInfoModule` is set and collection is enabled.\n *\n * @param deviceInfoModule - \n */\n",
+              "canonicalReference": "@microsoft/applicationinsights-react-native!ReactNativeManualDevicePlugin#setDeviceInfoModule:member(1)",
+              "docComment": "/**\n * Set the module that will be used during initialization when collecting device is enabled (the default), automatic collection can be disabled via the `disableDeviceCollection` config. If no `deviceInfoModule` is set and collection is enabled, an error will be thrown.\n *\n * @param deviceInfoModule - \n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -912,7 +961,7 @@
             },
             {
               "kind": "Method",
-              "canonicalReference": "@microsoft/applicationinsights-react-native!ReactNativePlugin#setDeviceModel:member(1)",
+              "canonicalReference": "@microsoft/applicationinsights-react-native!ReactNativeManualDevicePlugin#setDeviceModel:member(1)",
               "docComment": "/**\n * Manually set the device model, if set before initialization and automatic device info collection is enabled this value may get overwritten. If you want to keep this value disable auto collection by setting the `disableDeviceCollection` config to true.\n *\n * @param newModel - The value to use as the device model.\n */\n",
               "excerptTokens": [
                 {
@@ -960,7 +1009,7 @@
             },
             {
               "kind": "Method",
-              "canonicalReference": "@microsoft/applicationinsights-react-native!ReactNativePlugin#setDeviceType:member(1)",
+              "canonicalReference": "@microsoft/applicationinsights-react-native!ReactNativeManualDevicePlugin#setDeviceType:member(1)",
               "docComment": "/**\n * Manually set the device type (class), if set before initialization and automatic device info collection is enabled this value may get overwritten. If you want to keep this value disable auto collection by setting the `disableDeviceCollection` config to true.\n *\n * @param newType - The value to use as the device type\n */\n",
               "excerptTokens": [
                 {
@@ -1012,6 +1061,87 @@
             "endIndex": 2
           },
           "implementsTokenRanges": []
+        },
+        {
+          "kind": "Class",
+          "canonicalReference": "@microsoft/applicationinsights-react-native!ReactNativePlugin:class",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare class ReactNativePlugin extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "ReactNativeManualDevicePlugin",
+              "canonicalReference": "@microsoft/applicationinsights-react-native!ReactNativeManualDevicePlugin:class"
+            },
+            {
+              "kind": "Content",
+              "text": " "
+            }
+          ],
+          "fileUrlPath": "types/ReactNativePlugin.d.ts",
+          "releaseTag": "Public",
+          "isAbstract": false,
+          "name": "ReactNativePlugin",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "Method",
+              "canonicalReference": "@microsoft/applicationinsights-react-native!ReactNativePlugin#getDeviceInfoModule:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "protected getDeviceInfoModule(_deviceInfoModule: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "any"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "IDeviceInfoModule",
+                  "canonicalReference": "@microsoft/applicationinsights-react-native!IDeviceInfoModule:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "releaseTag": "Public",
+              "isProtected": true,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "_deviceInfoModule",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "getDeviceInfoModule"
+            }
+          ],
+          "extendsTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          },
+          "implementsTokenRanges": []
         }
       ]
     }

package/dist/applicationinsights-react-native.api.md

@@ -36,9 +36,11 @@ export interface IReactNativePluginConfig {
 }
 
 // @public (undocumented)
-export class ReactNativePlugin extends BaseTelemetryPlugin {
+export class ReactNativeManualDevicePlugin extends BaseTelemetryPlugin {
     constructor(config?: IReactNativePluginConfig);
     // (undocumented)
+    protected getDeviceInfoModule(_deviceInfoModule: any): IDeviceInfoModule;
+    // (undocumented)
     identifier: string;
     // (undocumented)
     initialize(config?: IReactNativePluginConfig | object, // need `| object` to coerce to interface
@@ -55,6 +57,12 @@ export class ReactNativePlugin extends BaseTelemetryPlugin {
     setDeviceType(newType: string): void;
 }
 
+// @public (undocumented)
+export class ReactNativePlugin extends ReactNativeManualDevicePlugin {
+    // (undocumented)
+    protected getDeviceInfoModule(_deviceInfoModule: any): IDeviceInfoModule;
+}
+
 // (No @packageDocumentation comment for this package)
 
 ```

package/dist/applicationinsights-react-native.d.ts

@@ -1,5 +1,5 @@
 /*
- * Microsoft Application Insights react native plugin, 3.0.3
+ * Microsoft Application Insights react native plugin, 4.0.0
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -77,21 +77,21 @@ declare namespace ApplicationInsights {
         uniqueIdPromiseTimeout?: number;
     }
 
-    class ReactNativePlugin extends BaseTelemetryPlugin {
+    class ReactNativeManualDevicePlugin extends BaseTelemetryPlugin {
         identifier: string;
         priority: number;
         _nextPlugin?: ITelemetryPlugin;
         private _setExceptionHandler;
         private _collectDeviceInfo;
         constructor(config?: IReactNativePluginConfig);
+        protected getDeviceInfoModule(_deviceInfoModule: any): IDeviceInfoModule;
         initialize(config?: IReactNativePluginConfig | object, // need `| object` to coerce to interface
         core?: IAppInsightsCore, extensions?: IPlugin[]): void;
         processTelemetry(env: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
         /**
          * Set the module that will be used during initialization when collecting device is enabled
          * (the default), automatic collection can be disabled via the `disableDeviceCollection`
-         * config. The `react-native-device-info` module will be used by default if no
-         * `deviceInfoModule` is set and collection is enabled.
+         * config. If no `deviceInfoModule` is set and collection is enabled, an error will be thrown.
          * @param deviceInfoModule
          */
         setDeviceInfoModule(deviceInfoModule: IDeviceInfoModule): void;
@@ -118,5 +118,9 @@ declare namespace ApplicationInsights {
         setDeviceType(newType: string): void;
     }
 
+    class ReactNativePlugin extends ReactNativeManualDevicePlugin {
+        protected getDeviceInfoModule(_deviceInfoModule: any): IDeviceInfoModule;
+    }
+
     
 }