@forge/util 1.4.1-next.0 → 1.4.1

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @forge/util
 
+## 1.4.1
+
+### Patch Changes
+
+- 5b82e7f: Bumping dependencies via Renovate:
+
+  - webpack
+
 ## 1.4.1-next.0
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/util",
-  "version": "1.4.1-next.0",
+  "version": "1.4.1",
   "description": "",
   "scripts": {
     "build": "./scripts/build.sh",

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

@@ -4,7 +4,7 @@ Analytics Client NodeJS services. Uses the GASv3 platform.
 
 * [Event Guidelines](http://go.atlassian.com/analytics)
 * [Trait Guidelines](https://developer.atlassian.com/platform/targeting/overview/concepts/traits/)
-* Questions / Other support: visit us in Slack: #product-analytics-dev "Product Analytics Dev"
+* Questions / Other support: visit us in Slack: [#help-analytics-pipeline](https://atlassian.enterprise.slack.com/archives/CFG85MPMX).
 
 ## Usage
 
@@ -301,6 +301,29 @@ client.sendOperationalEvent({
 });
 ```
 
+### Set alias or group (optional):
+
+The `aliases` container allows you to assign an extra customer identity to GASv3 analytics Track, UI, Screen and Operational events.
+
+```javascript
+analyticsClient.setAlias(
+    aliasTypes.A_FUTURE_MEMBER_ID,
+    'dummy-1234',
+);
+```
+The `groups` container aids in identifying the account or organization associated with your users.
+```javascript
+analyticsClient.setGroup(
+    groupTypes.TRANSACTION_ACCOUNT_ID,
+    'dummy-1234',
+);
+```
+**Note** The `setAlias` and `setGroup` methods will only accept values that are in the enums `aliasTypes` and `groupTypes`. If you have a specific use case and wish to include a new enum, please get in touch with us at [#help-analytics-pipeline](https://atlassian.enterprise.slack.com/archives/CFG85MPMX).
+
+Currently, [we support the following `groupTypes` values](https://bitbucket.org/atlassian/analytics-node-client/src/master/src/constants/group-type.js):
+- `TRANSACTION_ACCOUNT_ID`
+
+
 ## Sending a TraitEvent
 
 ```javascript
@@ -345,3 +368,44 @@ Changesets are an important part of the development process. Version bumping is
 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.
+
+## Migration from v3 to v4 Guide
+
+1. System requirements
+
+- Node >= 14
+
+2. Changes to `flush()`
+
+The `flush()` function has been deprecated. 
+
+If you don’t want to batch messages, you can turn batching off by setting the`maxEventsInBatch` setting to 1, like so:
+
+```
+const client = analyticsClient({
+  ...
+  maxEventsInBatch: 1
+});
+```
+
+If you want to avoid losing events after shutting down your console. Call `.gracefulShutdown()` to stop collecting new events and flush all existing events.
+
+```
+await client .gracefulShutdown()
+```
+
+***Note*** Calling `.gracefulShutdown()` will stop collecting new events.
+
+If you need to call gracefulShudown() function and subsequently trigger new events, you should instantiate a new instance of the analytics client.
+
+3. Changes to `flushAt`
+
+The `flushAt` configuration option has been renamed to `maxEventsInBatch`.
+
+4. Changes to `retryDelayFn`
+
+The `retryDelayFn` has been removed from `@segment/analytics-node`. Use `maxRetries` to configure the number of times to retry flushing a batch.
+
+5. Changes to `timeout`
+
+The `timeout` option has been removed from `@segment/analytics-node`. Use `httpRequestTimeout` to configure the maximum number of milliseconds to wait for an http request.

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

@@ -1,6 +1,6 @@
 {
   "name": "analytics-node-client",
-  "version": "3.6.0",
+  "version": "4.1.1",
   "description": "Analytics Serverside client for Node JS",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -23,23 +23,28 @@
   "license": "Private",
   "devDependencies": {
     "@changesets/cli": "^2.26.1",
-    "eslint": "^4.18.1",
+    "eslint": "^8.56.0",
     "eslint-config-jbunton": "0.0.3",
     "jasmine": "^3.0.0",
     "jasmine-console-reporter": "^1.2.6",
-    "jasmine-http-server-spy": "^0.4.0",
+    "jasmine-http-server-spy": "^0.5.0",
     "jasmine-promise-tools": "^1.1.0",
     "jasmine-reporters": "^2.2.0",
-    "jest": "^24.9.0",
+    "jest": "^29.7.0",
     "npm-run-all": "^3.1.0",
     "proxyquire": "^1.7.2",
     "typescript": "^5.2.2",
     "watch": "https://github.com/jbunton-atlassian/watch#5de0fc9c13df5ebc3320c1cbe275916cc954142d"
   },
   "dependencies": {
-    "analytics-node": "^6.2.0",
+    "@segment/analytics-node": "^1.1.3",
     "lodash": "^4.17.21"
   },
+  "overrides": {
+    "watch": {
+      "exec-sh": "^0.4.0"
+    }
+  },
   "files": [
     "src"
   ]