@azure/cosmos 3.14.2-alpha.20211111.1 → 3.15.0

package/CHANGELOG.md

@@ -1,14 +1,15 @@
 # Release History
 
-## 3.14.2 (Unreleased)
+## 3.15.0 (2021-11-22)
 
 ### Features Added
-
-### Breaking Changes
-
-### Bugs Fixed
+- _GA_ 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
+- _GA_ support for Bulk operation PATCH.
+- _GA_ support for Batch operation PATCH.
+-  Added the `SasTokenProperties` type and a `createAuthorizationSasToken` function to enable scoped access to Cosmos resources with SAS tokens. For an example that demonstrates creating a SAS token and using it to authenticate a `CosmosClient`, see [the `SasTokenAuth` sample](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/cosmosdb/cosmos/samples/v3/typescript/src/SasTokenAuth.ts).
 
 ### Other Changes
+- Made several changes to the sample programs to improve code quality and compatibility with Node 12, and upgraded the sample programs' dependencies.
 
 ## 3.14.1 (2021-09-02)
 

package/dist/index.js

@@ -4,11 +4,10 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; }
 
-var universalUserAgent = require('universal-user-agent');
 var crypto = require('crypto');
 var uuid$3 = require('uuid');
 var tslib = require('tslib');
-var debugLib = _interopDefault(require('debug'));
+var logger$4 = require('@azure/logger');
 var PriorityQueue = _interopDefault(require('priorityqueuejs'));
 var semaphore = _interopDefault(require('semaphore'));
 var stableStringify = _interopDefault(require('fast-json-stable-stringify'));
@@ -16,6 +15,7 @@ var JSBI = _interopDefault(require('jsbi'));
 var coreRestPipeline = require('@azure/core-rest-pipeline');
 var AbortController = _interopDefault(require('node-abort-controller'));
 var url = require('url');
+var universalUserAgent = require('universal-user-agent');
 
 // 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.14.2-alpha.20211111.1",
+    SDKVersion: "3.15.0",
     Quota: {
         CollectionSize: "collectionSize"
     },
@@ -342,10 +342,6 @@ var PermissionScopeValues;
     PermissionScopeValues[PermissionScopeValues["ScopeItemWriteAllAccessValue"] = 458767] = "ScopeItemWriteAllAccessValue";
     PermissionScopeValues[PermissionScopeValues["NoneValue"] = 0] = "NoneValue";
 })(PermissionScopeValues || (PermissionScopeValues = {}));
-/**
- * @hidden
- */
-var SasTokenPermissionKind;
 (function (SasTokenPermissionKind) {
     SasTokenPermissionKind[SasTokenPermissionKind["ContainerCreateItems"] = 1] = "ContainerCreateItems";
     SasTokenPermissionKind[SasTokenPermissionKind["ContainerReplaceItems"] = 2] = "ContainerReplaceItems";
@@ -386,7 +382,7 @@ var SasTokenPermissionKind;
     SasTokenPermissionKind[SasTokenPermissionKind["TriggerRead"] = 512] = "TriggerRead";
     SasTokenPermissionKind[SasTokenPermissionKind["TriggerReplace"] = 33554432] = "TriggerReplace";
     SasTokenPermissionKind[SasTokenPermissionKind["TriggerDelete"] = 67108864] = "TriggerDelete";
-})(SasTokenPermissionKind || (SasTokenPermissionKind = {}));
+})(exports.SasTokenPermissionKind || (exports.SasTokenPermissionKind = {}));
 
 const trimLeftSlashes = new RegExp("^[/]+");
 const trimRightSlashes = new RegExp("[/]+$");
@@ -841,18 +837,6 @@ function createUserDefinedFunctionUri(databaseId, collectionId, udfId) {
         udfId);
 }
 
-// Copyright (c) Microsoft Corporation.
-/**
- * @hidden
- */
-function getUserAgent(suffix) {
-    const ua = `${universalUserAgent.getUserAgent()} ${Constants.SDKName}/${Constants.SDKVersion}`;
-    if (suffix) {
-        return ua + " " + suffix;
-    }
-    return ua;
-}
-
 // Copyright (c) Microsoft Corporation.
 /**
  * @hidden
@@ -2040,36 +2024,7 @@ function mergeHeaders(headers, toBeMergedHeaders) {
 }
 
 // Copyright (c) Microsoft Corporation.
-/** @hidden */
-let cosmosLevelFilter = "warn|error";
-if (typeof process !== "undefined" && process.env && process.env.COSMOS_LOG_LEVEL) {
-    cosmosLevelFilter = process.env.COSMOS_LOG_LEVEL;
-}
-/** @hidden */
-const cosmosDebug = debugLib("cosmos");
-/** @hidden */
-const levelLogger = (namespaceLogger, level) => {
-    return (message) => {
-        if (cosmosLevelFilter.includes(level)) {
-            namespaceLogger("[" + new Date().toISOString() + "][" + level + "]: %o", message);
-        }
-    };
-};
-/** @hidden */
-const logger = (namespace) => {
-    const namespaceLogger = cosmosDebug.extend(namespace);
-    return {
-        silly: levelLogger(namespaceLogger, "silly"),
-        debug: levelLogger(namespaceLogger, "debug"),
-        info: levelLogger(namespaceLogger, "info"),
-        warn: levelLogger(namespaceLogger, "warn"),
-        error: levelLogger(namespaceLogger, "error")
-    };
-};
-
-// Copyright (c) Microsoft Corporation.
-/** @hidden */
-const log = logger("defaultQueryExecutionContext");
+const logger = logger$4.createClientLogger("ClientContext");
 /** @hidden */
 var STATES;
 (function (STATES) {
@@ -2170,12 +2125,12 @@ class DefaultQueryExecutionContext {
         try {
             let p;
             if (this.nextFetchFunction !== undefined) {
-                log.debug("using prefetch");
+                logger.verbose("using prefetch");
                 p = this.nextFetchFunction;
                 this.nextFetchFunction = undefined;
             }
             else {
-                log.debug("using fresh fetch");
+                logger.verbose("using fresh fetch");
                 p = this.fetchFunctions[this.currentPartitionIndex](this.options);
             }
             const response = await p;
@@ -3139,7 +3094,7 @@ class SmartRoutingMapProvider {
 
 // Copyright (c) Microsoft Corporation.
 /** @hidden */
-const log$1 = logger("parallelQueryExecutionContextBase");
+const logger$1 = logger$4.createClientLogger("parallelQueryExecutionContextBase");
 /** @hidden */
 var ParallelQueryExecutionContextBaseStates;
 (function (ParallelQueryExecutionContextBaseStates) {
@@ -3195,7 +3150,7 @@ class ParallelQueryExecutionContextBase {
                 const maxDegreeOfParallelism = options.maxDegreeOfParallelism === undefined || options.maxDegreeOfParallelism < 1
                     ? targetPartitionRanges.length
                     : Math.min(options.maxDegreeOfParallelism, targetPartitionRanges.length);
-                log$1.info("Query starting against " +
+                logger$1.info("Query starting against " +
                     targetPartitionRanges.length +
                     " ranges with parallelism of " +
                     maxDegreeOfParallelism);
@@ -7754,8 +7709,7 @@ function getCachedDefaultHttpClient() {
 }
 
 // Copyright (c) Microsoft Corporation.
-/** @hidden */
-const log$2 = logger("RequestHandler");
+const logger$2 = logger$4.createClientLogger("RequestHandler");
 async function executeRequest(requestContext) {
     return executePlugins(requestContext, httpRequest, exports.PluginOn.request);
 }
@@ -7829,7 +7783,7 @@ async function httpRequest(requestContext) {
         : undefined;
     if (response.status >= 400) {
         const errorResponse = new Error(result.message);
-        log$2.warn(response.status +
+        logger$2.warning(response.status +
             " " +
             requestContext.endpoint +
             " " +
@@ -8149,8 +8103,7 @@ function sanitizeEndpoint(url$1) {
 
 // Copyright (c) Microsoft Corporation.
 const uuid$2 = uuid$3.v4;
-/** @hidden */
-const log$3 = logger("ClientContext");
+const logger$3 = logger$4.createClientLogger("ClientContext");
 const QueryJsonContentType = "application/query+json";
 /**
  * @hidden
@@ -8247,14 +8200,14 @@ class ClientContext {
             }
         }
         this.applySessionToken(request$1);
-        log$3.info("query " +
+        logger$3.info("query " +
             requestId +
             " started" +
             (request$1.partitionKeyRangeId ? " pkrid: " + request$1.partitionKeyRangeId : ""));
-        log$3.silly(request$1);
+        logger$3.verbose(request$1);
         const start = Date.now();
         const response = await request(request$1);
-        log$3.info("query " + requestId + " finished - " + (Date.now() - start) + "ms");
+        logger$3.info("query " + requestId + " finished - " + (Date.now() - start) + "ms");
         this.captureSessionToken(undefined, path, exports.OperationType.Query, response.headers);
         return this.processQueryFeedResponse(response, !!query, resultFn);
     }
@@ -8683,6 +8636,18 @@ class ClientContext {
     }
 }
 
+// Copyright (c) Microsoft Corporation.
+/**
+ * @hidden
+ */
+function getUserAgent(suffix) {
+    const ua = `${universalUserAgent.getUserAgent()} ${Constants.SDKName}/${Constants.SDKVersion}`;
+    if (suffix) {
+        return ua + " " + suffix;
+    }
+    return ua;
+}
+
 // Copyright (c) Microsoft Corporation.
 /**
  * @hidden
@@ -9023,6 +8988,141 @@ class CosmosClient {
     }
 }
 
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+class SasTokenProperties {
+}
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+/// <reference lib="dom"/>
+function encodeUTF8(str) {
+    const bytes = new Uint8Array(str.length);
+    for (let i = 0; i < str.length; i++) {
+        bytes[i] = str.charCodeAt(i);
+    }
+    return bytes;
+}
+
+// Copyright (c) Microsoft Corporation.
+/**
+ * Experimental internal only
+ * Generates the payload representing the permission configuration for the sas token.
+ */
+async function createAuthorizationSasToken(masterKey, sasTokenProperties) {
+    let resourcePrefixPath = "";
+    if (typeof sasTokenProperties.databaseName === "string" &&
+        sasTokenProperties.databaseName !== "") {
+        resourcePrefixPath += `/${Constants.Path.DatabasesPathSegment}/${sasTokenProperties.databaseName}`;
+    }
+    if (typeof sasTokenProperties.containerName === "string" &&
+        sasTokenProperties.containerName !== "") {
+        if (sasTokenProperties.databaseName === "") {
+            throw new Error(`illegalArgumentException : ${sasTokenProperties.databaseName} \
+                          is an invalid database name`);
+        }
+        resourcePrefixPath += `/${Constants.Path.CollectionsPathSegment}/${sasTokenProperties.containerName}`;
+    }
+    if (typeof sasTokenProperties.resourceName === "string" &&
+        sasTokenProperties.resourceName !== "") {
+        if (sasTokenProperties.containerName === "") {
+            throw new Error(`illegalArgumentException : ${sasTokenProperties.containerName} \
+                          is an invalid container name`);
+        }
+        switch (sasTokenProperties.resourceKind) {
+            case "ITEM":
+                resourcePrefixPath += `${Constants.Path.Root}${Constants.Path.DocumentsPathSegment}`;
+                break;
+            case "STORED_PROCEDURE":
+                resourcePrefixPath += `${Constants.Path.Root}${Constants.Path.StoredProceduresPathSegment}`;
+                break;
+            case "USER_DEFINED_FUNCTION":
+                resourcePrefixPath += `${Constants.Path.Root}${Constants.Path.UserDefinedFunctionsPathSegment}`;
+                break;
+            case "TRIGGER":
+                resourcePrefixPath += `${Constants.Path.Root}${Constants.Path.TriggersPathSegment}`;
+                break;
+            default:
+                throw new Error(`illegalArgumentException : ${sasTokenProperties.resourceKind} \
+                          is an invalid resource kind`);
+        }
+        resourcePrefixPath += `${Constants.Path.Root}${sasTokenProperties.resourceName}${Constants.Path.Root}`;
+    }
+    sasTokenProperties.resourcePath = resourcePrefixPath.toString();
+    let partitionRanges = "";
+    if (sasTokenProperties.partitionKeyValueRanges !== undefined &&
+        sasTokenProperties.partitionKeyValueRanges.length > 0) {
+        if (typeof sasTokenProperties.resourceKind !== "string" &&
+            sasTokenProperties.resourceKind !== "ITEM") {
+            throw new Error(`illegalArgumentException : ${sasTokenProperties.resourceKind} \
+                          is an invalid partition key value range`);
+        }
+        sasTokenProperties.partitionKeyValueRanges.forEach((range) => {
+            partitionRanges += `${encodeUTF8(range)},`;
+        });
+    }
+    if (sasTokenProperties.controlPlaneReaderScope === 0) {
+        sasTokenProperties.controlPlaneReaderScope += exports.SasTokenPermissionKind.ContainerReadAny;
+        sasTokenProperties.controlPlaneWriterScope += exports.SasTokenPermissionKind.ContainerReadAny;
+    }
+    if (sasTokenProperties.dataPlaneReaderScope === 0 &&
+        sasTokenProperties.dataPlaneWriterScope === 0) {
+        sasTokenProperties.dataPlaneReaderScope = exports.SasTokenPermissionKind.ContainerFullAccess;
+        sasTokenProperties.dataPlaneWriterScope = exports.SasTokenPermissionKind.ContainerFullAccess;
+    }
+    if (typeof sasTokenProperties.keyType !== "number" ||
+        typeof sasTokenProperties.keyType === undefined) {
+        switch (sasTokenProperties.keyType) {
+            case CosmosKeyType.PrimaryMaster:
+                sasTokenProperties.keyType = 1;
+                break;
+            case CosmosKeyType.SecondaryMaster:
+                sasTokenProperties.keyType = 2;
+                break;
+            case CosmosKeyType.PrimaryReadOnly:
+                sasTokenProperties.keyType = 3;
+                break;
+            case CosmosKeyType.SecondaryReadOnly:
+                sasTokenProperties.keyType = 4;
+                break;
+            default:
+                throw new Error(`illegalArgumentException : ${sasTokenProperties.keyType} \
+                          is an invalid key type`);
+        }
+    }
+    const payload = sasTokenProperties.user +
+        "\n" +
+        sasTokenProperties.userTag +
+        "\n" +
+        sasTokenProperties.resourcePath +
+        "\n" +
+        partitionRanges +
+        "\n" +
+        utcsecondsSinceEpoch(sasTokenProperties.startTime).toString(16) +
+        "\n" +
+        utcsecondsSinceEpoch(sasTokenProperties.expiryTime).toString(16) +
+        "\n" +
+        sasTokenProperties.keyType +
+        "\n" +
+        sasTokenProperties.controlPlaneReaderScope.toString(16) +
+        "\n" +
+        sasTokenProperties.controlPlaneWriterScope.toString(16) +
+        "\n" +
+        sasTokenProperties.dataPlaneReaderScope.toString(16) +
+        "\n" +
+        sasTokenProperties.dataPlaneWriterScope.toString(16) +
+        "\n";
+    const signedPayload = await hmac(masterKey, Buffer.from(payload).toString("base64"));
+    return "type=sas&ver=1.0&sig=" + signedPayload + ";" + Buffer.from(payload).toString("base64");
+}
+/**
+ * @hidden
+ */
+// TODO: utcMilllisecondsSinceEpoch
+function utcsecondsSinceEpoch(date) {
+    return Math.round(date.getTime() / 1000);
+}
+
 exports.BulkOperationType = BulkOperationType;
 exports.ChangeFeedIterator = ChangeFeedIterator;
 exports.ChangeFeedResponse = ChangeFeedResponse;
@@ -9059,6 +9159,7 @@ exports.QueryMetricsConstants = QueryMetricsConstants;
 exports.QueryPreparationTimes = QueryPreparationTimes;
 exports.ResourceResponse = ResourceResponse;
 exports.RuntimeExecutionTimes = RuntimeExecutionTimes;
+exports.SasTokenProperties = SasTokenProperties;
 exports.Scripts = Scripts;
 exports.StatusCodes = StatusCodes;
 exports.StoredProcedure = StoredProcedure;
@@ -9074,6 +9175,7 @@ exports.UserDefinedFunctionResponse = UserDefinedFunctionResponse;
 exports.UserDefinedFunctions = UserDefinedFunctions;
 exports.UserResponse = UserResponse;
 exports.Users = Users;
+exports.createAuthorizationSasToken = createAuthorizationSasToken;
 exports.extractPartitionKey = extractPartitionKey;
 exports.setAuthorizationTokenHeaderUsingMasterKey = setAuthorizationTokenHeaderUsingMasterKey;
 //# sourceMappingURL=index.js.map