@azure/data-tables 12.1.2-alpha.20211012.1 → 12.2.0-alpha.20211019.1

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Release History
 
+## 12.2.0 (Unreleased)
+
+### Features Added
+- Take `continuationToken` as a `PageSetting` and expose it in the page when listing entities `byPage`. [#18179](https://github.com/Azure/azure-sdk-for-js/pull/18179)
+
+### Breaking Changes
+
+### Bugs Fixed
+- Document usage of SDK with Azurite. [#18211](https://github.com/Azure/azure-sdk-for-js/pull/18211)
+- Issue #17407 - Correctly handle etag in select filter. [#18211](https://github.com/Azure/azure-sdk-for-js/pull/18211)
+- Issue #18079  - Correctly handle creating entities with properties containing empty strings "". Fixes Insert throws "Unknown EDM type object" error with property value { value: "", type: "String" }. [#18211](https://github.com/Azure/azure-sdk-for-js/pull/18211)
+- Issue #18148 - Correctly deserialize Decimal numbers checking for isSafeInteger. Fixes listEntities always returns an Int32 type for a value of "1.23456789012346e+24". [#18211](https://github.com/Azure/azure-sdk-for-js/pull/18211)
+
+### Other Changes
+
 ## 12.1.2 (2021-09-07)
 
 ### Bugs Fixed

package/README.md

@@ -351,6 +351,38 @@ async function main() {
 main();
 ```
 
+## Azurite and Storage Emulator
+
+The Azure Tables Client SDK also works with Azurite, an Azure Storage and Tables API compatible server emulator. Please refer to the ([Azurite repository](https://github.com/Azure/Azurite#azurite-v3)) on how to get started using it.
+
+### Connecting to Azurite with Connection String shortcut
+The easiest way to connect to Azurite from your application is to configure a connection string that references the shortcut `UseDevelopmentStorage=true`. The shortcut is equivalent to the full connection string for the emulator, which specifies the account name, the account key, and the emulator endpoints for each of the Azure Storage services: ([see more](https://github.com/Azure/Azurite#http-connection-strings)). Using this shortcut, the Azure Tables Client SDK would setup the default connection string and `allowInsecureConnection` in the client options.
+
+```typescript
+import { TableClient } from "@azure/data-tables"
+
+const connectionString = "UseDevelopmentStorage=true";
+const client = TableClient.fromConnectionString(connectionString, "myTable");
+```
+
+### Connecting to Azurite without Connection String shortcut
+You can connect to azurite manually without using the connection string shortcut by specifying the service URL and `AzureNamedKeyCredential` or a custom connection string. However, `allowInsecureConnection` will need to be set manually in case Azurite runs in an `http` endpoint.
+
+```typescript
+import { TableClient, AzureNamedKeyCredential } from "@azure/data-tables"
+
+const client = new TableClient(
+  "<Azurite-http-table-endpoint>",
+  "myTable",
+  new AzureNamedKeyCredential(
+    "<Azurite-account-name>",
+    "<Azurite-account-key>"
+  ),
+  { allowInsecureConnection: true }
+);
+```
+
+
 ## Troubleshooting
 
 ### General

package/dist/index.js

@@ -3068,7 +3068,7 @@ class GeneratedClientContext extends coreClient.ServiceClient {
         const defaults = {
             requestContentType: "application/json; charset=utf-8"
         };
-        const packageDetails = `azsdk-js-data-tables/12.1.2`;
+        const packageDetails = `azsdk-js-data-tables/12.2.0`;
         const userAgentPrefix = options.userAgentOptions && options.userAgentOptions.userAgentPrefix
             ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
             : `${packageDetails}`;
@@ -4051,11 +4051,16 @@ function prepateTransactionPipeline(pipeline, bodyParts, changesetId, isCosmos)
 // Licensed under the MIT license.
 /**
  * Encodes a byte array in base64 format.
- * @param value - The Uint8Aray to encode
+ * @param value - The Uint8Aray or string to encode
  */
 function base64Encode(value) {
-    const bufferValue = value instanceof Buffer ? value : Buffer.from(value.buffer);
-    return bufferValue.toString("base64");
+    if (value instanceof Uint8Array) {
+        const bufferValue = value instanceof Buffer ? value : Buffer.from(value.buffer);
+        return bufferValue.toString("base64");
+    }
+    else {
+        return Buffer.from(value).toString("base64");
+    }
 }
 /**
  * Decodes a base64 string into a byte array.
@@ -4129,7 +4134,7 @@ function serializeObject(obj) {
     return serializedValue;
 }
 function getSerializedValue(value) {
-    if (typeof value === "object" && (value === null || value === void 0 ? void 0 : value.value) && (value === null || value === void 0 ? void 0 : value.type)) {
+    if (typeof value === "object" && (value === null || value === void 0 ? void 0 : value.value) !== undefined && (value === null || value === void 0 ? void 0 : value.type) !== undefined) {
         return serializeObject(value);
     }
     else {
@@ -4220,7 +4225,7 @@ function inferTypedObject(propertyName, value) {
  */
 function getTypedNumber(value) {
     const valueStr = String(value);
-    if (Number.isInteger(value)) {
+    if (Number.isSafeInteger(value)) {
         return { value: valueStr, type: "Int32" };
     }
     else {
@@ -4264,6 +4269,19 @@ function deserializeSignedIdentifier(signedIdentifiers) {
         };
     });
 }
+function serializeQueryOptions(query) {
+    const { select } = query, queryOptions = tslib.__rest(query, ["select"]);
+    const mappedQuery = Object.assign({}, queryOptions);
+    // Properties that are always returned by the service but are not allowed in select
+    const excludeFromSelect = ["etag", "odata.etag"];
+    if (select) {
+        mappedQuery.select = select
+            .filter((p) => !excludeFromSelect.includes(p))
+            .map(translatePropertyNameForSerialization)
+            .join(",");
+    }
+    return mappedQuery;
+}
 
 // Copyright (c) Microsoft Corporation.
 // This is used as a workaround to be able to stub generateUuid
@@ -4274,6 +4292,33 @@ class Uuid {
     }
 }
 
+// Copyright (c) Microsoft Corporation.
+/**
+ * Encodes the nextPartitionKey and nextRowKey into a single continuation token
+ */
+function encodeContinuationToken(nextPartitionKey = "", nextRowKey = "") {
+    if (!nextPartitionKey && !nextRowKey) {
+        return undefined;
+    }
+    const continuationToken = JSON.stringify({
+        nextPartitionKey,
+        nextRowKey
+    });
+    return base64Encode(continuationToken);
+}
+/**
+ * Decodes a continuationToken into an object containing a nextPartitionKey and nextRowKey
+ */
+function decodeContinuationToken(encodedToken) {
+    const decodedToken = base64Decode(encodedToken);
+    let tokenStr = "";
+    for (const byte of decodedToken) {
+        tokenStr += String.fromCharCode(byte);
+    }
+    const continuationToken = JSON.parse(tokenStr);
+    return continuationToken;
+}
+
 // Copyright (c) Microsoft Corporation.
 /**
  * A TableClient represents a Client to the Azure Tables service allowing you
@@ -4440,7 +4485,7 @@ class TableClient {
         }
         try {
             const _a = updatedOptions || {}, { disableTypeConversion, queryOptions } = _a, getEntityOptions = tslib.__rest(_a, ["disableTypeConversion", "queryOptions"]);
-            await this.table.queryEntitiesWithPartitionAndRowKey(this.tableName, partitionKey, rowKey, Object.assign(Object.assign({}, getEntityOptions), { queryOptions: this.convertQueryOptions(queryOptions || {}), onResponse }));
+            await this.table.queryEntitiesWithPartitionAndRowKey(this.tableName, partitionKey, rowKey, Object.assign(Object.assign({}, getEntityOptions), { queryOptions: serializeQueryOptions(queryOptions || {}), onResponse }));
             const tableEntity = deserialize(parsedBody, disableTypeConversion !== null && disableTypeConversion !== void 0 ? disableTypeConversion : false);
             return tableEntity;
         }
@@ -4496,6 +4541,9 @@ class TableClient {
             },
             byPage: (settings) => {
                 const pageOptions = Object.assign(Object.assign({}, options), { queryOptions: Object.assign(Object.assign({}, options.queryOptions), { top: settings === null || settings === void 0 ? void 0 : settings.maxPageSize }) });
+                if (settings === null || settings === void 0 ? void 0 : settings.continuationToken) {
+                    pageOptions.continuationToken = settings.continuationToken;
+                }
                 return this.listEntitiesPage(tableName, pageOptions);
             }
         };
@@ -4504,11 +4552,9 @@ class TableClient {
         return tslib.__asyncGenerator(this, arguments, function* listEntitiesAll_1() {
             var e_1, _a;
             const firstPage = yield tslib.__await(this._listEntities(tableName, options));
-            const { nextPartitionKey, nextRowKey } = firstPage;
             yield tslib.__await(yield* tslib.__asyncDelegator(tslib.__asyncValues(firstPage)));
-            if (nextRowKey && nextPartitionKey) {
-                const optionsWithContinuation = Object.assign(Object.assign({}, options), { nextPartitionKey,
-                    nextRowKey });
+            if (firstPage.continuationToken) {
+                const optionsWithContinuation = Object.assign(Object.assign({}, options), { continuationToken: firstPage.continuationToken });
                 try {
                     for (var _b = tslib.__asyncValues(this.listEntitiesPage(tableName, optionsWithContinuation)), _c; _c = yield tslib.__await(_b.next()), !_c.done;) {
                         const page = _c.value;
@@ -4531,8 +4577,8 @@ class TableClient {
             try {
                 let result = yield tslib.__await(this._listEntities(tableName, updatedOptions));
                 yield yield tslib.__await(result);
-                while (result.nextPartitionKey && result.nextRowKey) {
-                    const optionsWithContinuation = Object.assign(Object.assign({}, updatedOptions), { nextPartitionKey: result.nextPartitionKey, nextRowKey: result.nextRowKey });
+                while (result.continuationToken) {
+                    const optionsWithContinuation = Object.assign(Object.assign({}, updatedOptions), { continuationToken: result.continuationToken });
                     result = yield tslib.__await(this._listEntities(tableName, optionsWithContinuation));
                     yield yield tslib.__await(result);
                 }
@@ -4551,13 +4597,23 @@ class TableClient {
     }
     async _listEntities(tableName, options = {}) {
         const { disableTypeConversion = false } = options;
-        const queryOptions = this.convertQueryOptions(options.queryOptions || {});
-        const { xMsContinuationNextPartitionKey: nextPartitionKey, xMsContinuationNextRowKey: nextRowKey, value } = await this.table.queryEntities(tableName, Object.assign(Object.assign({}, options), { queryOptions }));
+        const queryOptions = serializeQueryOptions(options.queryOptions || {});
+        const listEntitiesOptions = Object.assign(Object.assign({}, options), { queryOptions });
+        // If a continuation token is used, decode it and set the next row and partition key
+        if (options.continuationToken) {
+            const continuationToken = decodeContinuationToken(options.continuationToken);
+            listEntitiesOptions.nextRowKey = continuationToken.nextRowKey;
+            listEntitiesOptions.nextPartitionKey = continuationToken.nextPartitionKey;
+        }
+        const { xMsContinuationNextPartitionKey: nextPartitionKey, xMsContinuationNextRowKey: nextRowKey, value } = await this.table.queryEntities(tableName, listEntitiesOptions);
         const tableEntities = deserializeObjectsArray(value !== null && value !== void 0 ? value : [], disableTypeConversion);
-        return Object.assign([...tableEntities], {
-            nextPartitionKey,
-            nextRowKey
+        // Encode nextPartitionKey and nextRowKey as a single continuation token and add it as a
+        // property to the page.
+        const continuationToken = encodeContinuationToken(nextPartitionKey, nextRowKey);
+        const page = Object.assign([...tableEntities], {
+            continuationToken
         });
+        return page;
     }
     /**
      * Insert entity in the table.
@@ -4866,14 +4922,6 @@ class TableClient {
         }
         return this.transactionClient.submitTransaction();
     }
-    convertQueryOptions(query) {
-        const { select } = query, queryOptions = tslib.__rest(query, ["select"]);
-        const mappedQuery = Object.assign({}, queryOptions);
-        if (select) {
-            mappedQuery.select = select.join(",");
-        }
-        return mappedQuery;
-    }
     /**
      *
      * Creates an instance of TableClient from connection string.