@forge/util 1.3.0 → 1.3.1-next.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @forge/util
 
+## 1.3.1-next.1
+
+### Patch Changes
+
+- 801ea11: Renovate
+
+## 1.3.1-next.0
+
+### Patch Changes
+
+- 94b724a: Renovate
+
 ## 1.3.0
 
 ### Minor Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/util",
-  "version": "1.3.0",
+  "version": "1.3.1-next.1",
   "description": "",
   "scripts": {
     "build": "./scripts/build.sh",
@@ -9,7 +9,7 @@
   "author": "Daniel Winter-Wijntjes",
   "license": "UNLICENSED",
   "exports": {
-    "./packages/cs-ari": "./packages/cs-ari/dist/Index.js",
+    "./packages/cs-ari": "./packages/cs-ari/dist/index.js",
     "./packages/metrics-interface": "./packages/metrics-interface/dist/index.js",
     "./packages/logger-interface": "./packages/logger-interface/dist/index.js",
     "./packages/analytics-node-client": "./packages/analytics-node-client/src/index.js"

package/packages/analytics-node-client/CHANGELOG.md

@@ -1,5 +1,35 @@
 # Change log
 
+## 3.3.0
+
+### Minor Changes
+
+- fa5c710: Added customerAccount as a valid userIdType
+
+## 3.2.2
+
+### Patch Changes
+
+- 9d7ba15: add changesets as devDependencies
+
+## 3.2.0
+
+Added workspaceId and orgId as additional fields to ui, track, operational and screen events
+
+## 3.1.0
+
+Updated analytics-node from v6.0.0 to v6.2.0. This incorporates a
+[fix](https://github.com/segmentio/analytics-node/pull/347) for a
+bug that could result in the callback for a message not being called during
+flush if the `errorHandler` property is used. The `errorHandler` property
+_should_ now be safe and usable.
+
+## 3.0.0
+
+Updated analytics-node from [5.1.0 to 6.0.0](https://github.com/segmentio/analytics-node/releases/tag/v6.0.0).
+Add support for `errorHandler` argument to allow library users
+to prevent uncaught exception errors.
+
 ## 2.2.1
 
 Removed SourceClear build step

package/packages/analytics-node-client/README.md

@@ -32,6 +32,7 @@ We support the following `userIdType`s:
 * `HASHED_EMAIL`
 * `OPSGENIE`
 * `HALP`
+* `CUSTOMER_ACCOUNT` - This type is the JSM customer account
 
 #### Tenant information
 
@@ -43,6 +44,14 @@ We support the following `tenantIdType`s:
 * `HALP_TEAM_ID` - Halp
 * `NONE` - Products without a tenant concept
 
+#### Org information
+
+You can provide org information by specifying an `orgId`.
+
+#### Workspace information
+
+If you specify a `workspaceId`, you can use it to provide information about the workspace
+
 #### Containers
 
 The `containers` field is meant to be the new representation of the container hierarchy where the event takes place. Think something like issue -> board -> project.
@@ -130,6 +139,8 @@ client.sendTrackEvent({
     userIdType: 'atlassianAccount',
     tenantIdType: 'cloudId',
     tenantId: 'some-tenant-id',
+    orgId: 'some-org-id',
+    workspaceId: 'some-workspace-id',
     trackEvent: {
         source: 'api', // required
         action: 'testAction', // required
@@ -161,6 +172,8 @@ client.sendTrackEvent({
     userIdType: 'atlassianAccount',
     tenantIdType: 'cloudId',
     tenantId: 'some-tenant-id',
+    orgId: 'some-org-id',
+    workspaceId: 'some-workspace-id',
     trackEvent: {
         source: 'api', // required
         action: 'testAction', // required
@@ -196,6 +209,8 @@ client.sendUIEvent({
     userIdType: 'atlassianAccount',
     tenantIdType: 'cloudId',
     tenantType: 'my-tenant-type',
+    orgId: 'some-org-id',
+    workspaceId: 'some-workspace-id',
     uiEvent: {
         source: 'api',
         action: 'testAction', // required
@@ -227,6 +242,8 @@ client.sendScreenEvent({
     userIdType: 'atlassianAccount',
     tenantIdType: 'cloudId',
     tenantType: 'my-tenant-type',
+    orgId: 'some-org-id',
+    workspaceId: 'some-workspace-id',
     name: 'some-screen-name', // required
     screenEvent: {
         origin: 'some-origin', // required
@@ -257,6 +274,8 @@ client.sendOperationalEvent({
     userIdType: 'atlassianAccount',
     tenantIdType: 'cloudId',
     tenantId: 'some-tenant-id',
+    orgId: 'some-org-id',
+    workspaceId: 'some-workspace-id',
     operationalEvent: {
         source: 'api', // required
         action: 'testAction', // required
@@ -291,6 +310,21 @@ client.sendTraitEvent({
 });
 ```
 
+## Error Handling
+
+If an error is encountered while flushing messages, some versions of this
+library will throw an uncaught exception which can only be handled in
+`process.on('unhandledRejection', ...)`, and will, otherwise, crash your
+process.
+
+As of v3.1.0 of this library, you can pass an `errorHandler` function to
+the constructor and that function will be called instead of crashing your
+process. You can use this function to log the error.
+
+Likely, you don't want your process to crash when you get a 429 from GAS
+(essentially creating a hard coupling from your service to GAS), so we
+recommend passing this property.
+
 ## Developing Locally
 
 Setup: `npm install`
@@ -300,3 +334,11 @@ Cleaning up Typescript Types: `npm run cleanTypes`
 ### Tests:
 
 `npm test`
+
+### Writing changesets:
+
+Changesets are an important part of the development process. Version bumping is automatic and controlled via changeset files.
+
+Please adhere to the [this](https://developer.atlassian.com/cloud/framework/atlassian-frontend/development/versioning/#versioning-guidelines) guideline when selecting the bump type for your package.
+
+Run the command line script `npx changeset`, write changesets that users understand and can take action on and commit changes.

package/packages/analytics-node-client/package.json

@@ -1,6 +1,6 @@
 {
   "name": "analytics-node-client",
-  "version": "2.2.2",
+  "version": "3.3.0",
   "description": "Analytics Serverside client for Node JS",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -21,6 +21,7 @@
   "author": "Atlassian",
   "license": "Private",
   "devDependencies": {
+    "@changesets/cli": "^2.26.1",
     "eslint": "^4.18.1",
     "eslint-config-jbunton": "0.0.3",
     "jasmine": "^3.0.0",
@@ -34,7 +35,7 @@
     "watch": "https://github.com/jbunton-atlassian/watch#5de0fc9c13df5ebc3320c1cbe275916cc954142d"
   },
   "dependencies": {
-    "analytics-node": "^5.1.0",
+    "analytics-node": "^6.2.0",
     "lodash": "^4.17.21"
   },
   "files": [