@azure/cosmos 3.16.4 → 3.17.0

package/CHANGELOG.md

@@ -1,28 +1,42 @@
 # Release History
 
-## 3.16.4 (2022-08-05)
+## 3.17.0 (2022-08-19)
+
+### Features Added
+
+#### GA: Azure Cosmos DB Integrated Cache
+
+- Support DedicatedGatewayRequestOptions and MaxIntegratedCacheStaleness [#21240](https://github.com/Azure/azure-sdk-for-js/pull/21240)
+- Upgrade cosmos with azure core tracing [#22284](https://github.com/Azure/azure-sdk-for-js/pull/22284)
+- Removed old logging and implement Azure core logging coverage [#18723](https://github.com/Azure/azure-sdk-for-js/pull/18723?)
 
 ### Bugs Fixed
-- Reverts changes of [PR 22548](https://github.com/Azure/azure-sdk-for-js/pull/22548) to avoid possible regression when customers use id with special characters and their account is on ComputeGateway already. - See [PR 22818](https://github.com/Azure/azure-sdk-for-js/pull/22818)
+
+- ParallelQueryExecutionContextBase breaks use of abortSignal [#18544](https://github.com/Azure/azure-sdk-for-js/pull/18544)
+- Fixes id encoding issues when using special characters fo RoutingGateway
 
 ## 3.16.3 (2022-07-13)
 
 ### Bugs Fixed
-- Fixes issues with "id" encoding when using special characters that should be allowed in the "id" property of a document.  [#22548](https://github.com/Azure/azure-sdk-for-js/pull/22548)
+
+- Fixes issues with "id" encoding when using special characters that should be allowed in the "id" property of a document. [#22548](https://github.com/Azure/azure-sdk-for-js/pull/22548)
 
 ## 3.16.2 (2022-06-24)
 
 ### Bugs Fixed
-- Adds support to run queries with group by over a column with null values.  [#22345](https://github.com/Azure/azure-sdk-for-js/pull/22345)
+
+- Adds support to run queries with group by over a column with null values. [#22345](https://github.com/Azure/azure-sdk-for-js/pull/22345)
 
 ## 3.16.1 (2022-05-31)
 
 ### Bugs Fixed
+
 - Fix [#22003](https://github.com/Azure/azure-sdk-for-js/issues/22003) missing interface error. [#22015](https://github.com/Azure/azure-sdk-for-js/pull/22015)
 
 ## 3.16.0 (2022-05-23)
 
 ### Features Added
+
 - Allow users like cosmos-explorer to specify hierarchical partition keys. https://github.com/Azure/azure-sdk-for-js/pull/21934
 - Support Dedicated Gateway RequestOptions and Max Integrated Cache Staleness. https://github.com/Azure/azure-sdk-for-js/pull/21240
 
@@ -112,8 +126,8 @@ const client = new CosmosClient({
   connectionPolicy: {
     ...defaultConnectionPolicy,
     endpointRefreshRateInMs: 700,
-    enableBackgroundEndpointRefreshing: true
-  }
+    enableBackgroundEndpointRefreshing: true,
+  },
 });
 ```
 
@@ -258,17 +272,17 @@ database.container.create(containerDefinition)
 const operations: OperationInput[] = [
   {
     operationType: "Create",
-    resourceBody: { id: "doc1", name: "sample", key: "A" }
+    resourceBody: { id: "doc1", name: "sample", key: "A" },
   },
   {
     operationType: "Upsert",
-    resourceBody: { id: "doc2", name: "other", key: "A" }
+    resourceBody: { id: "doc2", name: "other", key: "A" },
   },
   {
     operationType: "Read",
     id: "readItemId",
-    partitionKey: "key"
-  }
+    partitionKey: "key",
+  },
 ];
 
 await database.container.items.bulk(operations);
@@ -485,14 +499,14 @@ Constructor options have been simplified:
 const client = new CosmosClient({
   endpoint: "https://your-database.cosmos.azure.com",
   auth: {
-    masterKey: "your-primary-key"
-  }
+    masterKey: "your-primary-key",
+  },
 });
 
 // v3
 const client = new CosmosClient({
   endpoint: "https://your-database.cosmos.azure.com",
-  key: "your-primary-key"
+  key: "your-primary-key",
 });
 ```
 

package/dist/index.js

@@ -10,6 +10,7 @@ var stableStringify = require('fast-json-stable-stringify');
 var PriorityQueue = require('priorityqueuejs');
 var semaphore = require('semaphore');
 var coreRestPipeline = require('@azure/core-rest-pipeline');
+var identity = require('@azure/identity');
 var nodeAbortController = require('node-abort-controller');
 var universalUserAgent = require('universal-user-agent');
 var JSBI = require('jsbi');
@@ -179,7 +180,7 @@ const Constants = {
     AzureNamespace: "Azure.Cosmos",
     AzurePackageName: "@azure/cosmos",
     SDKName: "azure-cosmos-js",
-    SDKVersion: "3.16.4",
+    SDKVersion: "3.17.0",
     Quota: {
         CollectionSize: "collectionSize",
     },
@@ -7334,8 +7335,14 @@ async function getHeaders({ clientOptions, defaultHeaders, verb, path, resourceI
         headers[Constants.HttpHeaders.ConsistencyLevel] = options.consistencyLevel;
     }
     if (options.maxIntegratedCacheStalenessInMs && resourceType === exports.ResourceType.item) {
-        headers[Constants.HttpHeaders.DedicatedGatewayPerRequestCacheStaleness] =
-            options.maxIntegratedCacheStalenessInMs;
+        if (typeof options.maxIntegratedCacheStalenessInMs === "number") {
+            headers[Constants.HttpHeaders.DedicatedGatewayPerRequestCacheStaleness] =
+                options.maxIntegratedCacheStalenessInMs.toString();
+        }
+        else {
+            identity.logger.error(`RangeError: maxIntegratedCacheStalenessInMs "${options.maxIntegratedCacheStalenessInMs}" is not a valid parameter.`);
+            headers[Constants.HttpHeaders.DedicatedGatewayPerRequestCacheStaleness] = "null";
+        }
     }
     if (options.resourceTokenExpirySeconds) {
         headers[Constants.HttpHeaders.ResourceTokenExpiry] = options.resourceTokenExpirySeconds;