@sap/audit-logging - npm Package Compare versions

Comparing version 5.3.0 to 5.4.0

CHANGELOG.md

@@ -8,2 +8,10 @@ # Change Log
 
+## 5.4.0 - 2022-01-03
+
+### Updated
+- Documentation with new usage for tenant() when providing subdomain.
+
+### Fixed
+- $SUBSCRIBER option can now be properly used by providing a subdomain in tenant().
+
 ## 5.3.0 - 2021-11-22
@@ -10,0 +18,0 @@

lib/base-messages/MessageBase.js

@@ -18,5 +18,6 @@ 'use strict';
 
-MessageBase.prototype.tenant = function (tenant) {
+MessageBase.prototype.tenant = function (tenant, subdomain) {
   utils.validate.notEmptyString(tenant, 'tenant');
   this._content.tenant = tenant;
+  this._transport.subdomain = subdomain;
   return this;
@@ -23,0 +24,0 @@ };

lib/transports/ServiceTransport.js

@@ -15,2 +15,3 @@ 'use strict';
   checkCredentials(credentials);
+  this.subdomain = null;
   this.credentials = credentials;
@@ -133,3 +134,3 @@ this.serviceURL = credentials.url + options.url;
     debug('User token exchange: %s, %s', this.securityContext.getGrantType(), userToken);
-    requests.requestUserToken(userToken, this.credentials.uaa, null, null, null, null, (err, token) => {
+    requests.requestUserToken(userToken, this.credentials.uaa, null, null, this.subdomain, null, (err, token) => {
       if (err) {
@@ -144,3 +145,3 @@ return callback(err);
   && this.credentials.uaa.url) {
-    requests.requestClientCredentialsToken(null, this.credentials.uaa, null, null, (err, token) => {
+    requests.requestClientCredentialsToken(this.subdomain, this.credentials.uaa, null, null, (err, token) => {
       if (err) {
@@ -147,0 +148,0 @@ return callback(err);

npm-shrinkwrap.json

 {
   "name": "@sap/audit-logging",
-  "version": "5.3.0",
+  "version": "5.4.0",
   "lockfileVersion": 1,
@@ -8,3 +8,3 @@ "requires": true,
     "@sap/xssec": {
-      "version": "3.2.10",
+      "version": "3.2.11",
       "requires": {
@@ -61,3 +61,3 @@ "axios": "^0.21.4",
     "follow-redirects": {
-      "version": "1.14.5"
+      "version": "1.14.7"
     },
@@ -64,0 +64,0 @@ "jsonwebtoken": {

package.json

 {
   "name": "@sap/audit-logging",
   "description": "Provides audit logging functionalities for Node.js applications",
-  "version": "5.3.0",
+  "version": "5.4.0",
   "license": "SEE LICENSE IN LICENSE file",
@@ -6,0 +6,0 @@ "main": "index.js",

README.md

@@ -250,3 +250,3 @@ # @sap/audit-logging
   .accessChannel('UI')
-  .tenant('$PROVIDER') // or .tenant('$SUBSCRIBER')
+  .tenant('$PROVIDER') // or .tenant('$SUBSCRIBER', subdomain)
   .by('$USER')
@@ -266,3 +266,3 @@ .at(42 || new Date() || '1970-01-01T00:00:00.042Z')
   * `name` - attachment name
-* `tenant` - takes a specific string placeholder ('$PROVIDER' or '$SUBSCRIBER') that is replaced by the service. This is **mandatory**.
+* `tenant` - takes a specific string placeholder ('$PROVIDER' or '$SUBSCRIBER') that is replaced by the service. This is **mandatory**. `subdomain` is an optional value used only with '$SUBSCRIBER'.
 * `at(time)` - sets a custom timestamp for event time.
@@ -320,3 +320,3 @@ * `log` - See [here](#logging-a-message)
   .attribute('first name', 'john', 'John')
-  .tenant('$PROVIDER') // or .tenant('$SUBSCRIBER')
+  .tenant('$PROVIDER') // or .tenant('$SUBSCRIBER', subdomain)
   .by('$USER')
@@ -331,3 +331,3 @@ .log(...);
   .attribute('password', false)
-  .tenant('$PROVIDER') // or .tenant('$SUBSCRIBER')
+  .tenant('$PROVIDER') // or .tenant('$SUBSCRIBER', subdomain)
   .by('$USER')
@@ -353,3 +353,3 @@ .at(42 || new Date() || '1970-01-01T00:00:00.042Z')
 * `by` - takes a fixed string '$USER' that is a placeholder replaced by the service. This is **mandatory**.
-* `tenant` - takes a specific string placeholder ('$PROVIDER' or '$SUBSCRIBER') that is replaced by the service. This is **mandatory**. The provided value is ignored by older versions of the Audit log service that do not support setting a tenant.
+* `tenant` - takes a specific string placeholder ('$PROVIDER' or '$SUBSCRIBER') that is replaced by the service. This is **mandatory**. The provided value is ignored by older versions of the Audit log service that do not support setting a tenant. `subdomain` is an optional value used only with '$SUBSCRIBER'.
 * `at(time)` - sets a custom timestamp for event time.
@@ -406,3 +406,3 @@ * `log` - See [here](#logging-a-message)
   .attribute('session timeout', '5', '25')
-  .tenant('$PROVIDER') // or .tenant('$SUBSCRIBER')
+  .tenant('$PROVIDER') // or .tenant('$SUBSCRIBER', subdomain)
   .by('$USER')
@@ -423,3 +423,3 @@ .successful(true)
 * `by` - takes a fixed string '$USER' that is a placeholder replaced by the service. This is **mandatory**.
-* `tenant` - takes a specific string placeholder ('$PROVIDER' or '$SUBSCRIBER') that is replaced by the service. This is **mandatory**. The provided value is ignored by older versions of the Audit log service that do not support setting a tenant.
+* `tenant` - takes a specific string placeholder ('$PROVIDER' or '$SUBSCRIBER') that is replaced by the service. This is **mandatory**. The provided value is ignored by older versions of the Audit log service that do not support setting a tenant. `subdomain` is an optional value used only with '$SUBSCRIBER'.
 * `at(time)` - sets a custom timestamp for event time.
@@ -466,3 +466,3 @@ * `log` - See [here](#logging-a-message)
 auditLog.securityMessage('%d unsuccessful login attempts', 3)
-  .tenant('$PROVIDER') // or .tenant('$SUBSCRIBER')
+  .tenant('$PROVIDER') // or .tenant('$SUBSCRIBER', subdomain)
   .by('$USER')
@@ -477,3 +477,3 @@ .externalIP('127.0.0.1')
 * `by` - takes a fixed string '$USER' that is a placeholder replaced by the service. This is **mandatory**.
-* `tenant` - takes a specific string placeholder ('$PROVIDER' or '$SUBSCRIBER') that is replaced by the service. This is **mandatory**. The provided value is ignored by older versions of the Audit log service that do not support setting a tenant.
+* `tenant` - takes a specific string placeholder ('$PROVIDER' or '$SUBSCRIBER') that is replaced by the service. This is **mandatory**. The provided value is ignored by older versions of the Audit log service that do not support setting a tenant. `subdomain` is an optional value used only with '$SUBSCRIBER'.
 * `at(time)` - sets a custom timestamp for event time.
@@ -607,3 +607,3 @@ * `log` - See [here](#logging-a-message)
   .accessChannel('UI')
-  .tenant('$PROVIDER') // or .tenant('$SUBSCRIBER')
+  .tenant('$PROVIDER') // or .tenant('$SUBSCRIBER', subdomain)
   .by('$USER')
@@ -623,3 +623,3 @@ .at(42 || new Date() || '1970-01-01T00:00:00.042Z')
 * `by` - takes a fixed string '$USER' that is a placeholder replaced by the service. This is **mandatory**.
-* `tenant` - takes a specific string placeholder ('$PROVIDER' or '$SUBSCRIBER') that is replaced by the service. This is **mandatory**.
+* `tenant` - takes a specific string placeholder ('$PROVIDER' or '$SUBSCRIBER') that is replaced by the service. This is **mandatory**. `subdomain` is an optional value used only with '$SUBSCRIBER'.
 * `at(time)` - sets a custom timestamp for event time.
@@ -665,3 +665,3 @@ * `log` - logs the message.
   .dataSubject({ type: 'student', id: { student_id: 'st_123' }, role: 'foreign student' })
-  .tenant('$PROVIDER') // or .tenant('$SUBSCRIBER')
+  .tenant('$PROVIDER') // or .tenant('$SUBSCRIBER', subdomain)
   .by('$USER')
@@ -681,3 +681,3 @@ .at(42 || new Date() || '1970-01-01T00:00:00.042Z');
 * `by` - takes a fixed string '$USER' that is a placeholder replaced by the service. This is **mandatory**.
-* `tenant` - takes a specific string placeholder ('$PROVIDER' or '$SUBSCRIBER') that is replaced by the service. This is **mandatory**.
+* `tenant` - takes a specific string placeholder ('$PROVIDER' or '$SUBSCRIBER') that is replaced by the service. This is **mandatory**. `subdomain` is an optional value used only with '$SUBSCRIBER'.
 * `at(time)` - sets a custom timestamp for event time.
@@ -720,3 +720,3 @@ * `logPrepare` - Used to log that a user has started an operation over the data.
   .attribute({ name: 'session timeout', old: '5', new: '25' })
-  .tenant('$PROVIDER') // or .tenant('$SUBSCRIBER')
+  .tenant('$PROVIDER') // or .tenant('$SUBSCRIBER', subdomain)
   .by('$USER')
@@ -735,3 +735,3 @@ .at(42 || new Date() || '1970-01-01T00:00:00.042Z');
 * `by` - takes a fixed string '$USER' that is a placeholder replaced by the service. This is **mandatory**.
-* `tenant` - takes a specific string placeholder ('$PROVIDER' or '$SUBSCRIBER') that is replaced by the service. This is **mandatory**.
+* `tenant` - takes a specific string placeholder ('$PROVIDER' or '$SUBSCRIBER') that is replaced by the service. This is **mandatory**. `subdomain` is an optional value used only with '$SUBSCRIBER'.
 * `at(time)` - sets a custom timestamp for event time.
@@ -769,3 +769,3 @@ * `logPrepare` - Used to log that a user has started a configuration change operation.
   .externalIP('127.0.0.1')
-  .tenant('$PROVIDER') // or .tenant('$SUBSCRIBER')
+  .tenant('$PROVIDER') // or .tenant('$SUBSCRIBER', subdomain)
   .by('$USER')
@@ -780,3 +780,3 @@ .at(42 || new Date() || '1970-01-01T00:00:00.042Z')
 * `externalIP` - states the IP of the machine that contacts the system. Specifying it is optional, but if provided, should be either IPv4 or IPv6.
-* `by` -  takes a fixed string '$USER' that is a placeholder replaced by the service. This is **mandatory**.
+* `by` -  takes a fixed string '$USER' that is a placeholder replaced by the service. This is **mandatory**. `subdomain` is an optional value used only with '$SUBSCRIBER'.
 * `tenant` -  takes a specific string placeholder ('$PROVIDER' or '$SUBSCRIBER') that is replaced by the service. This is **mandatory**.
@@ -783,0 +783,0 @@ * `at(time)` - sets a custom timestamp for event time.f

No alert changes

Improved metrics

Total package byte prevSize

88378

increased by1.03%

Lines of code

882

increased by0.23%

No dependency changes