Document geo location (#705)

Co-authored-by: Abhijeet Prasad <[email protected]>

Author: marandaneto

package.json

@@ -11,7 +11,7 @@
     "@sentry/tracing": "^7.15.0",
     "@sentry/webpack-plugin": "^1.18.3",
     "@types/dompurify": "^2.0.3",
-    "@types/node": "^12",
+    "@types/node": "^14",
     "@types/react": "^16.9.46",
     "@types/react-dom": "^16.9.8",
     "@types/react-helmet": "^6.1.0",

src/docs/sdk/event-payloads/user.mdx

@@ -35,6 +35,28 @@ of these attributes and only custom attributes is valid, but not as useful.
 All other keys are stored as extra information but not specifically processed by
 Sentry.
 
+`geo`
+
+: An optional object describing the [geographical location](#geographical-location) of the end user or device, this object is automatically inferred by Relay if `ip_address` is provided.
+
+## Geographical location
+
+Approximate geographical location of the end user or device.
+
+### Attributes
+
+`city`
+
+: Human readable city name.
+
+`country_code`
+
+: Two-letter country code (ISO 3166-1 alpha-2).
+
+`region`
+
+: Human readable region name or code.
+
 ## Automatic IP addresses
 
 SDKs running on client platforms, such as browsers and mobile applications,

yarn.lock

@@ -2778,10 +2778,10 @@
   resolved "https://registry.yarnpkg.com/@types/node/-/node-16.9.1.tgz#0611b37db4246c937feef529ddcc018cf8e35708"
   integrity sha512-QpLcX9ZSsq3YYUUnD3nFDY8H7wctAhQj/TFKL8Ya8v5fMm3CFXxo8zStsLAl780ltoYoo1WvKUVGBQK+1ifr7g==
 
-"@types/node@^12":
-  version "12.20.52"
-  resolved "https://registry.yarnpkg.com/@types/node/-/node-12.20.52.tgz#2fd2dc6bfa185601b15457398d4ba1ef27f81251"
-  integrity sha512-cfkwWw72849SNYp3Zx0IcIs25vABmFh73xicxhCkTcvtZQeIez15PpwQN8fY3RD7gv1Wrxlc9MEtfMORZDEsGw==
+"@types/node@^14":
+  version "14.18.32"
+  resolved "https://registry.yarnpkg.com/@types/node/-/node-14.18.32.tgz#8074f7106731f1a12ba993fe8bad86ee73905014"
+  integrity sha512-Y6S38pFr04yb13qqHf8uk1nHE3lXgQ30WZbv1mLliV9pt0NjvqdWttLcrOYLnXbOafknVYRHZGoMSpR9UwfYow==
 
 "@types/node@^14.14.10":
   version "14.18.18"