@azure/cosmos 3.16.3-alpha.20220628.2 → 3.16.3

package/CHANGELOG.md

@@ -1,19 +1,14 @@
 # Release History
 
-## 3.16.3 (Unreleased)
-
-### Features Added
-
-### Breaking Changes
+## 3.16.3 (2022-07-13)
 
 ### Bugs Fixed
-
-### Other Changes
+- 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
-- Added 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)
 

package/dist/index.js

@@ -174,7 +174,10 @@ const Constants = {
     // Client generated retry count response header
     ThrottleRetryCount: "x-ms-throttle-retry-count",
     ThrottleRetryWaitTimeInMs: "x-ms-throttle-retry-wait-time-ms",
+    // Platform
     CurrentVersion: "2020-07-15",
+    AzureNamespace: "Azure.Cosmos",
+    AzurePackageName: "@azure/cosmos",
     SDKName: "azure-cosmos-js",
     SDKVersion: "3.16.3",
     Quota: {
@@ -561,17 +564,10 @@ function isResourceValid(resource, err) {
             err.message = "Id must be a string.";
             return false;
         }
-        if (resource.id.indexOf("/") !== -1 ||
-            resource.id.indexOf("\\") !== -1 ||
-            resource.id.indexOf("?") !== -1 ||
-            resource.id.indexOf("#") !== -1) {
+        if (resource.id.indexOf("/") !== -1 || resource.id.indexOf("\\") !== -1) {
             err.message = "Id contains illegal chars.";
             return false;
         }
-        if (resource.id[resource.id.length - 1] === " ") {
-            err.message = "Id ends with a space.";
-            return false;
-        }
     }
     return true;
 }
@@ -614,13 +610,9 @@ function validateResourceId(resourceId) {
     if (typeof resourceId !== "string" || isStringNullOrEmpty(resourceId)) {
         throw new Error("Resource Id must be a string and cannot be undefined, null or empty");
     }
-    // if resourceId starts or ends with space throw an error
-    if (resourceId[resourceId.length - 1] === " ") {
-        throw new Error("Resource Id cannot end with space");
-    }
     // if resource id contains illegal characters throw an error
     if (illegalResourceIdCharacters.test(resourceId)) {
-        throw new Error("Illegal characters ['/', '\\', '?', '#'] cannot be used in resourceId");
+        throw new Error("Illegal characters ['/', '\\'] cannot be used in resourceId");
     }
     return true;
 }
@@ -916,6 +908,17 @@ async function generateHeaders(masterKey, method, resourceType = exports.Resourc
         [Constants.HttpHeaders.XDate]: date.toUTCString(),
     };
 }
+function getEffectiveResourceIdForSignature(resourceId) {
+    const lastSlashPosition = resourceId.lastIndexOf("/");
+    if (lastSlashPosition <= 0) {
+        return resourceId;
+    }
+    const prefix = resourceId.substring(0, lastSlashPosition);
+    if (!prefix.endsWith("/docs")) {
+        return resourceId;
+    }
+    return prefix + "/" + decodeURIComponent(resourceId.substring(lastSlashPosition + 1));
+}
 async function signature(masterKey, method, resourceType, resourceId = "", date = new Date()) {
     const type = "master";
     const version = "1.0";
@@ -923,7 +926,7 @@ async function signature(masterKey, method, resourceType, resourceId = "", date
         "\n" +
         resourceType.toLowerCase() +
         "\n" +
-        resourceId +
+        getEffectiveResourceIdForSignature(resourceId) +
         "\n" +
         date.toUTCString().toLowerCase() +
         "\n" +
@@ -4369,7 +4372,7 @@ class Item {
      * Returns a reference URL to the resource. Used for linking in Permissions.
      */
     get url() {
-        return createDocumentUri(this.container.database.id, this.container.id, this.id);
+        return createDocumentUri(this.container.database.id, this.container.id, encodeURIComponent(this.id));
     }
     /**
      * Read the item's definition.
@@ -4400,8 +4403,9 @@ class Item {
             const { resource: partitionKeyDefinition } = await this.container.readPartitionKeyDefinition();
             this.partitionKey = undefinedPartitionKey(partitionKeyDefinition);
         }
-        const path = getPathFromLink(this.url);
-        const id = getIdFromLink(this.url);
+        const resourceUri = this.url;
+        const path = getPathFromLink(resourceUri);
+        const id = getIdFromLink(resourceUri);
         let response;
         try {
             response = await this.clientContext.read({
@@ -4429,8 +4433,9 @@ class Item {
         if (!isResourceValid(body, err)) {
             throw err;
         }
-        const path = getPathFromLink(this.url);
-        const id = getIdFromLink(this.url);
+        const resourceUri = this.url;
+        const path = getPathFromLink(resourceUri);
+        const id = getIdFromLink(resourceUri);
         const response = await this.clientContext.replace({
             body,
             path,
@@ -4454,8 +4459,9 @@ class Item {
             const { resource: partitionKeyDefinition } = await this.container.readPartitionKeyDefinition();
             this.partitionKey = undefinedPartitionKey(partitionKeyDefinition);
         }
-        const path = getPathFromLink(this.url);
-        const id = getIdFromLink(this.url);
+        const resourceUri = this.url;
+        const path = getPathFromLink(resourceUri);
+        const id = getIdFromLink(resourceUri);
         const response = await this.clientContext.delete({
             path,
             resourceType: exports.ResourceType.item,
@@ -4478,8 +4484,9 @@ class Item {
             const { resource: partitionKeyDefinition } = await this.container.readPartitionKeyDefinition();
             this.partitionKey = extractPartitionKey(body, partitionKeyDefinition);
         }
-        const path = getPathFromLink(this.url);
-        const id = getIdFromLink(this.url);
+        const resourceUri = this.url;
+        const path = getPathFromLink(resourceUri);
+        const id = getIdFromLink(resourceUri);
         const response = await this.clientContext.patch({
             body,
             path,