@azure/cosmos 3.13.1-alpha.20210830.2 → 3.14.1

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Release History
 
+## 3.14.1 (2021-09-02)
+
+### Bugs Fixed
+
+- Fix @azure/core-rest-pipeline version for AAD auth.
+
+## 3.14.0 (2021-09-01)
+
+### Features Added
+
+- _PREVIEW_ Adds `container.item(itemId).patch()`. `patch()` is an alternative to `replace()` for item updates. https://github.com/Azure/azure-sdk-for-js/pull/16264/files#diff-7caca690c469e2025576523c0377ac71815f001024fde7c48b20cd24adaa6977R561
+- _PREVIEW_ Adds support for Bulk operation PATCH.
+- _PREVIEW_ Adds support for Batch operation PATCH.
+
+### Bugs Fixed
+
+- Fixes bug where Batch was passing the wrong header for batch requests with partition keys
+- Fixes 401s when using AAD auth. AAD credentials should now work and no longer cause 429s from @azure/identity at high throughput.
+
 ## 3.13.1 (2021-08-23)
 
 ### Bugs Fixed

package/dist/index.js

@@ -6,7 +6,6 @@ function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'defau
 
 var universalUserAgent = require('universal-user-agent');
 var crypto = require('crypto');
-var url = require('url');
 var uuid$3 = require('uuid');
 var tslib = require('tslib');
 var debugLib = _interopDefault(require('debug'));
@@ -16,6 +15,7 @@ var stableStringify = _interopDefault(require('fast-json-stable-stringify'));
 var JSBI = _interopDefault(require('jsbi'));
 var coreRestPipeline = require('@azure/core-rest-pipeline');
 var AbortController = _interopDefault(require('node-abort-controller'));
+var url = require('url');
 
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
@@ -170,7 +170,7 @@ const Constants = {
     ThrottleRetryWaitTimeInMs: "x-ms-throttle-retry-wait-time-ms",
     CurrentVersion: "2018-12-31",
     SDKName: "azure-cosmos-js",
-    SDKVersion: "3.13.1-alpha.20210830.2",
+    SDKVersion: "3.14.1",
     Quota: {
         CollectionSize: "collectionSize"
     },
@@ -232,6 +232,7 @@ const Constants = {
 })(exports.ResourceType || (exports.ResourceType = {}));
 (function (HTTPMethod) {
     HTTPMethod["get"] = "GET";
+    HTTPMethod["patch"] = "PATCH";
     HTTPMethod["post"] = "POST";
     HTTPMethod["put"] = "PUT";
     HTTPMethod["delete"] = "DELETE";
@@ -245,6 +246,7 @@ const Constants = {
     OperationType["Query"] = "query";
     OperationType["Execute"] = "execute";
     OperationType["Batch"] = "batch";
+    OperationType["Patch"] = "patch";
 })(exports.OperationType || (exports.OperationType = {}));
 /**
  * @hidden
@@ -930,20 +932,11 @@ async function signature(masterKey, method, resourceType, resourceId = "", date
     return encodeURIComponent("type=" + type + "&ver=" + version + "&sig=" + signed);
 }
 
-// Copyright (c) Microsoft Corporation.
-function checkURL(testString) {
-    return new url.URL(testString);
-}
-function sanitizeEndpoint(url$1) {
-    return new url.URL(url$1).href.replace(/\/$/, "");
-}
-
 // Copyright (c) Microsoft Corporation.
 /**
  * @hidden
  */
 async function setAuthorizationHeader(clientOptions, verb, path, resourceId, resourceType, headers) {
-    var _a;
     if (clientOptions.permissionFeed) {
         clientOptions.resourceTokens = {};
         for (const permission of clientOptions.permissionFeed) {
@@ -964,16 +957,6 @@ async function setAuthorizationHeader(clientOptions, verb, path, resourceId, res
     else if (clientOptions.tokenProvider) {
         headers[Constants.HttpHeaders.Authorization] = encodeURIComponent(await clientOptions.tokenProvider({ verb, path, resourceId, resourceType, headers }));
     }
-    else if (clientOptions.aadCredentials) {
-        if (typeof ((_a = clientOptions.aadCredentials) === null || _a === void 0 ? void 0 : _a.getToken) !== "function") {
-            throw new Error("Cannot use AAD Credentials without `getToken`. See @azure/identity docs");
-        }
-        const hrefEndpoint = sanitizeEndpoint(clientOptions.endpoint);
-        const token = await clientOptions.aadCredentials.getToken(`${hrefEndpoint}/.default`);
-        const AUTH_PREFIX = `type=aad&ver=1.0&sig=`;
-        const authorizationToken = `${AUTH_PREFIX}${token.token}`;
-        headers[Constants.HttpHeaders.Authorization] = encodeURIComponent(authorizationToken);
-    }
 }
 /**
  * The default function for setting header token using the masterKey
@@ -1048,10 +1031,12 @@ const BulkOperationType = {
     Upsert: "Upsert",
     Read: "Read",
     Delete: "Delete",
-    Replace: "Replace"
+    Replace: "Replace",
+    Patch: "Patch"
 };
 function hasResource(operation) {
-    return operation.resourceBody !== undefined;
+    return (operation.operationType !== "Patch" &&
+        operation.resourceBody !== undefined);
 }
 function getPartitionKeyToHash(operation, partitionProperty) {
     const toHashKey = hasResource(operation)
@@ -1123,9 +1108,19 @@ function deepFind(document, path) {
     return h;
 }
 
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+const PatchOperationType = {
+    add: "add",
+    replace: "replace",
+    remove: "remove",
+    set: "set",
+    incr: "incr"
+};
+
 // Copyright (c) Microsoft Corporation.
 (function (ConnectionMode) {
-    /** Gateway mode talks to a intermediate gateway which handles the direct communicationi with your individual partitions. */
+    /** Gateway mode talks to an intermediate gateway which handles the direct communication with your individual partitions. */
     ConnectionMode[ConnectionMode["Gateway"] = 0] = "Gateway";
 })(exports.ConnectionMode || (exports.ConnectionMode = {}));
 
@@ -4440,6 +4435,31 @@ class Item {
         });
         return new ItemResponse(response.result, response.headers, response.code, response.substatus, this);
     }
+    /**
+     * Perform a JSONPatch on the item.
+     *
+     * Any provided type, T, is not necessarily enforced by the SDK.
+     * You may get more or less properties and it's up to your logic to enforce it.
+     *
+     * @param options - Additional options for the request
+     */
+    async patch(body, options = {}) {
+        if (this.partitionKey === undefined) {
+            const { resource: partitionKeyDefinition } = await this.container.readPartitionKeyDefinition();
+            this.partitionKey = extractPartitionKey(body, partitionKeyDefinition);
+        }
+        const path = getPathFromLink(this.url);
+        const id = getIdFromLink(this.url);
+        const response = await this.clientContext.patch({
+            body,
+            path,
+            resourceType: exports.ResourceType.item,
+            resourceId: id,
+            options,
+            partitionKey: this.partitionKey
+        });
+        return new ItemResponse(response.result, response.headers, response.code, response.substatus, this);
+    }
 }
 
 // Copyright (c) Microsoft Corporation.
@@ -8119,6 +8139,14 @@ SessionContainer.EMPTY_SESSION_TOKEN = "";
 SessionContainer.SESSION_TOKEN_SEPARATOR = ",";
 SessionContainer.SESSION_TOKEN_PARTITION_SPLITTER = ":";
 
+// Copyright (c) Microsoft Corporation.
+function checkURL(testString) {
+    return new url.URL(testString);
+}
+function sanitizeEndpoint(url$1) {
+    return new url.URL(url$1).href.replace(/\/$/, "");
+}
+
 // Copyright (c) Microsoft Corporation.
 const uuid$2 = uuid$3.v4;
 /** @hidden */
@@ -8142,7 +8170,15 @@ class ClientContext {
             const scope = `${hrefEndpoint}/.default`;
             this.pipeline.addPolicy(coreRestPipeline.bearerTokenAuthenticationPolicy({
                 credential: cosmosClientOptions.aadCredentials,
-                scopes: scope
+                scopes: scope,
+                challengeCallbacks: {
+                    async authorizeRequest({ request, getAccessToken }) {
+                        const tokenResponse = await getAccessToken([scope], {});
+                        const AUTH_PREFIX = `type=aad&ver=1.0&sig=`;
+                        const authorizationToken = `${AUTH_PREFIX}${tokenResponse.token}`;
+                        request.headers.set("Authorization", authorizationToken);
+                    }
+                }
             }));
         }
     }
@@ -8303,6 +8339,36 @@ class ClientContext {
             throw err;
         }
     }
+    async patch({ body, path, resourceType, resourceId, options = {}, partitionKey }) {
+        try {
+            const request$1 = {
+                globalEndpointManager: this.globalEndpointManager,
+                requestAgent: this.cosmosClientOptions.agent,
+                connectionPolicy: this.connectionPolicy,
+                method: exports.HTTPMethod.patch,
+                client: this,
+                operationType: exports.OperationType.Patch,
+                path,
+                resourceType,
+                body,
+                resourceId,
+                options,
+                plugins: this.cosmosClientOptions.plugins,
+                partitionKey
+            };
+            request$1.headers = await this.buildHeaders(request$1);
+            this.applySessionToken(request$1);
+            // patch will use WriteEndpoint
+            request$1.endpoint = await this.globalEndpointManager.resolveServiceEndpoint(request$1.resourceType, request$1.operationType);
+            const response = await executePlugins(request$1, request, exports.PluginOn.operation);
+            this.captureSessionToken(undefined, path, exports.OperationType.Patch, response.headers);
+            return response;
+        }
+        catch (err) {
+            this.captureSessionToken(err, path, exports.OperationType.Upsert, err.headers);
+            throw err;
+        }
+    }
     async create({ body, path, resourceType, resourceId, options = {}, partitionKey }) {
         try {
             const request$1 = {
@@ -8508,11 +8574,11 @@ class ClientContext {
                 resourceId,
                 plugins: this.cosmosClientOptions.plugins,
                 options,
-                pipeline: this.pipeline
+                pipeline: this.pipeline,
+                partitionKey
             };
             request$1.headers = await this.buildHeaders(request$1);
             request$1.headers[Constants.HttpHeaders.IsBatchRequest] = true;
-            request$1.headers[Constants.HttpHeaders.PartitionKey] = partitionKey;
             request$1.headers[Constants.HttpHeaders.IsBatchAtomic] = true;
             this.applySessionToken(request$1);
             request$1.endpoint = await this.globalEndpointManager.resolveServiceEndpoint(request$1.resourceType, request$1.operationType);
@@ -8983,6 +9049,7 @@ exports.Items = Items;
 exports.Offer = Offer;
 exports.OfferResponse = OfferResponse;
 exports.Offers = Offers;
+exports.PatchOperationType = PatchOperationType;
 exports.Permission = Permission;
 exports.PermissionResponse = PermissionResponse;
 exports.Permissions = Permissions;