@azure/data-tables 13.0.1-alpha.20211214.2 → 13.0.1-alpha.20220103.2

package/README.md

@@ -123,6 +123,24 @@ const { TableServiceClient, AzureNamedKeyCredential } = require("@azure/data-tab
 
 The `TableServiceClient` requires a URL to the table service and an access credential. It also optionally accepts some settings in the `options` parameter.
 
+#### `TableServiceClient` with AzureNamedKeyCredential
+
+You can instantiate a `TableServiceClient` with a `AzureNamedKeyCredential` by passing account-name and account-key as arguments. (The account-name and account-key can be obtained from the azure portal.)
+[ONLY AVAILABLE IN NODE.JS RUNTIME]
+
+```javascript
+const { TableServiceClient, AzureNamedKeyCredential } = require("@azure/data-tables");
+
+const account = "<account>";
+const accountKey = "<accountkey>";
+
+const credential = new AzureNamedKeyCredential(account, accountKey);
+const serviceClient = new TableServiceClient(
+  `https://${account}.table.core.windows.net`,
+  credential
+);
+```
+
 #### `TableServiceClient` with TokenCredential (AAD)
 
 Azure Tables provides integration with Azure Active Directory (Azure AD) for identity-based authentication of requests
@@ -220,7 +238,7 @@ const serviceClient = new TableServiceClient(
 
 async function main() {
   const tableName = `newtable`;
-  // If the table 'newTable' already exists, createTable doesn' throw
+  // If the table 'newTable' already exists, createTable doesn't throw
   await serviceClient.createTable(tableName);
 }
 
@@ -326,6 +344,36 @@ const clientWithSAS = new TableClient(
 );
 ```
 
+#### `TableClient` with TokenCredential (AAD)
+
+Azure Tables provides integration with Azure Active Directory (Azure AD) for identity-based authentication of requests
+to the Table service when targeting a Storage endpoint. With Azure AD, you can use role-based access control (RBAC) to
+grant access to your Azure Table resources to users, groups, or applications.
+
+To access a table resource with a `TokenCredential`, the authenticated identity should have either the "Storage Table Data Contributor" or "Storage Table Data Reader" role.
+
+With the `@azure/identity` package, you can seamlessly authorize requests in both development and production environments.
+To learn more about Azure AD integration in Azure Storage, see the [Azure.Identity README](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/README.md)
+
+```javascript
+const { TableClient } = require("@azure/data-tables");
+const { DefaultAzureCredential } = require("@azure/identity");
+
+// DefaultAzureCredential expects the following three environment variables:
+// - AZURE_TENANT_ID: The tenant ID in Azure Active Directory
+// - AZURE_CLIENT_ID: The application (client) ID registered in the AAD tenant
+// - AZURE_CLIENT_SECRET: The client secret for the registered application
+const credential = new DefaultAzureCredential();
+const account = "<account name>";
+const tableName = "<tableName>";
+
+const clientWithAAD = new TableClient(
+  `https://${account}.table.core.windows.net`,
+  tableName,
+  credential
+);
+```
+
 #### List Entities in a table
 
 You can list entities within a table by through a `TableClient` instance calling the `listEntities` function. This function returns a `PageableAsyncIterator` that you can consume using `for-await-of`

package/dist/index.js

@@ -246,7 +246,7 @@ class SasQueryParameters {
         if (this.ipRangeInner) {
             return {
                 end: this.ipRangeInner.end,
-                start: this.ipRangeInner.start
+                start: this.ipRangeInner.start,
             };
         }
         return undefined;
@@ -281,7 +281,7 @@ class SasQueryParameters {
             "rsct",
             "saoid",
             "scid",
-            "tn" // TableName
+            "tn", // TableName
         ];
         const queries = [];
         for (const param of params) {
@@ -427,7 +427,7 @@ const HeaderConstants = {
     CONTENT_TRANSFER_ENCODING: "content-transfer-encoding",
     DATE: "date",
     X_MS_DATE: "x-ms-date",
-    X_MS_VERSION: "x-ms-version"
+    X_MS_VERSION: "x-ms-version",
 };
 const TablesLoggingAllowedHeaderNames = [
     "Access-Control-Allow-Origin",
@@ -510,15 +510,13 @@ const TablesLoggingAllowedHeaderNames = [
     "x-ms-source-if-none-match",
     "x-ms-source-if-unmodified-since",
     "x-ms-tag-count",
-    "x-ms-encryption-key-sha256"
+    "x-ms-encryption-key-sha256",
 ];
 
 // Copyright (c) Microsoft Corporation.
 function computeHMACSHA256(stringToSign, accountKey) {
     const key = Buffer.from(accountKey, "base64");
-    return crypto.createHmac("sha256", key)
-        .update(stringToSign, "utf8")
-        .digest("base64");
+    return crypto.createHmac("sha256", key).update(stringToSign, "utf8").digest("base64");
 }
 
 // Copyright (c) Microsoft Corporation.
@@ -553,7 +551,7 @@ function generateAccountSasQueryParameters(accountSasSignatureValues, credential
         accountSasSignatureValues.ipRange ? ipRangeToString(accountSasSignatureValues.ipRange) : "",
         accountSasSignatureValues.protocol ? accountSasSignatureValues.protocol : "",
         version,
-        "" // Account SAS requires an additional newline character
+        "", // Account SAS requires an additional newline character
     ].join("\n");
     const signature = computeHMACSHA256(stringToSign, credential.key);
     return new SasQueryParameters(version, signature, {
@@ -563,7 +561,7 @@ function generateAccountSasQueryParameters(accountSasSignatureValues, credential
         protocol: accountSasSignatureValues.protocol,
         startsOn: accountSasSignatureValues.startsOn,
         expiresOn: accountSasSignatureValues.expiresOn,
-        ipRange: accountSasSignatureValues.ipRange
+        ipRange: accountSasSignatureValues.ipRange,
     });
 }
 
@@ -691,7 +689,7 @@ function generateTableSasQueryParameters(tableName, credential, tableSasSignatur
         startingPartitionKey,
         startingRowKey,
         endingPartitionKey,
-        endingRowKey
+        endingRowKey,
     ].join("\n");
     const signature = computeHMACSHA256(stringToSign, credential.key);
     return new SasQueryParameters(version, signature, {
@@ -701,7 +699,7 @@ function generateTableSasQueryParameters(tableName, credential, tableSasSignatur
         expiresOn: tableSasSignatureValues.expiresOn,
         ipRange: tableSasSignatureValues.ipRange,
         identifier: tableSasSignatureValues.identifier,
-        tableName
+        tableName,
     });
 }
 function getCanonicalName(accountName, tableName) {
@@ -3113,7 +3111,7 @@ class GeneratedClient extends GeneratedClientContext {
  */
 const createSpan = coreTracing.createSpanFunction({
     packagePrefix: "Azure.Data.Tables",
-    namespace: "Microsoft.Data.Tables"
+    namespace: "Microsoft.Data.Tables",
 });
 
 // Copyright (c) Microsoft Corporation.
@@ -3128,7 +3126,7 @@ function fromAccountConnectionString(extractedCreds, options = {}) {
     return {
         url: extractedCreds.url,
         options,
-        credential: sharedKeyCredential
+        credential: sharedKeyCredential,
     };
 }
 function getAccountConnectionString(accountName, accountKey, defaultEndpointsProtocol, endpointSuffix, tableEndpoint) {
@@ -3154,7 +3152,7 @@ function getAccountConnectionString(accountName, accountKey, defaultEndpointsPro
         kind: "AccountConnString",
         url: tableEndpoint,
         accountName,
-        accountKey
+        accountKey,
     };
 }
 
@@ -3182,7 +3180,7 @@ function getClientParamsFromConnectionString(connectionString, options = {}) {
     else if (extractedCreds.kind === "SASConnString") {
         return {
             url: `${extractedCreds.url}?${extractedCreds.accountSas}`,
-            options
+            options,
         };
     }
     else {
@@ -3350,7 +3348,7 @@ function tablesNamedKeyCredentialPolicy(credential) {
         async sendRequest(request, next) {
             signRequest(request);
             return next(request);
-        }
+        },
     };
 }
 function getAuthorizationHeader(request, credential) {
@@ -3367,7 +3365,7 @@ function getAuthorizationHeader(request, credential) {
     }
     const stringToSign = [
         dateHeader,
-        getCanonicalizedResourceString(request, credential)
+        getCanonicalizedResourceString(request, credential),
     ].join("\n");
     const signature = computeHMACSHA256(stringToSign, credential.key);
     return `SharedKeyLite ${credential.name}:${signature}`;
@@ -3406,7 +3404,7 @@ function tablesSASTokenPolicy(credential) {
         async sendRequest(request, next) {
             signURLWithSAS(request, credential);
             return next(request);
-        }
+        },
     };
 }
 function signURLWithSAS(request, credential) {
@@ -3432,14 +3430,14 @@ class TableServiceClient {
         const internalPipelineOptions = Object.assign(Object.assign(Object.assign({}, clientOptions), {
             loggingOptions: {
                 logger: logger.info,
-                additionalAllowedHeaderNames: [...TablesLoggingAllowedHeaderNames]
+                additionalAllowedHeaderNames: [...TablesLoggingAllowedHeaderNames],
             },
             deserializationOptions: {
-                parseXML: coreXml.parseXML
+                parseXML: coreXml.parseXML,
             },
             serializationOptions: {
-                stringifyXML: coreXml.stringifyXML
-            }
+                stringifyXML: coreXml.stringifyXML,
+            },
         }), (coreAuth.isTokenCredential(credential) && { credential, credentialScopes: STORAGE_SCOPE }));
         const client = new GeneratedClient(this.url, internalPipelineOptions);
         if (coreAuth.isNamedKeyCredential(credential)) {
@@ -3568,7 +3566,7 @@ class TableServiceClient {
                     pageOptions.continuationToken = settings.continuationToken;
                 }
                 return this.listTablesPage(pageOptions);
-            }
+            },
         };
     }
     listTablesAll(options) {
@@ -3637,7 +3635,7 @@ class TableServiceClient {
     static fromConnectionString(connectionString, 
     // eslint-disable-next-line @azure/azure-sdk/ts-naming-options
     options) {
-        const { url, options: clientOptions, credential } = getClientParamsFromConnectionString(connectionString, options);
+        const { url, options: clientOptions, credential, } = getClientParamsFromConnectionString(connectionString, options);
         if (credential) {
             return new TableServiceClient(url, credential, clientOptions);
         }
@@ -3670,7 +3668,7 @@ function getTransactionBoundary(transactionId) {
 function getInitialTransactionBody(transactionId, changesetId) {
     const transactionBoundary = `batch_${transactionId}`;
     return [
-        `--${transactionBoundary}${TRANSACTION_HTTP_LINE_ENDING}${HeaderConstants.CONTENT_TYPE}: multipart/mixed; boundary=changeset_${changesetId}${TRANSACTION_HTTP_LINE_ENDING}${TRANSACTION_HTTP_LINE_ENDING}`
+        `--${transactionBoundary}${TRANSACTION_HTTP_LINE_ENDING}${HeaderConstants.CONTENT_TYPE}: multipart/mixed; boundary=changeset_${changesetId}${TRANSACTION_HTTP_LINE_ENDING}${TRANSACTION_HTTP_LINE_ENDING}`,
     ];
 }
 /**
@@ -3693,7 +3691,7 @@ const transactionRequestAssemblePolicyName = "transactionRequestAssemblePolicy";
 const dummyResponse = {
     request: coreRestPipeline.createPipelineRequest({ url: "FAKE" }),
     status: 200,
-    headers: coreRestPipeline.createHttpHeaders()
+    headers: coreRestPipeline.createHttpHeaders(),
 };
 function transactionRequestAssemblePolicy(bodyParts, changesetId) {
     return {
@@ -3703,7 +3701,7 @@ function transactionRequestAssemblePolicy(bodyParts, changesetId) {
             bodyParts.push(subRequest);
             // Intercept request from going to wire
             return dummyResponse;
-        }
+        },
     };
 }
 const transactionHeaderFilterPolicyName = "transactionHeaderFilterPolicy";
@@ -3714,7 +3712,7 @@ function transactionHeaderFilterPolicy() {
             // The subrequests should not have the x-ms-version header.
             request.headers.delete(HeaderConstants.X_MS_VERSION);
             return next(request);
-        }
+        },
     };
 }
 function getSubRequestUrl(url) {
@@ -3731,7 +3729,7 @@ function getNextSubrequestBodyPart(request, changesetId) {
     const subRequest = [
         subRequestPrefix,
         "",
-        `${request.method.toString()} ${subRequestUrl} ${TRANSACTION_HTTP_VERSION_1_1}` // sub request start line with method,
+        `${request.method.toString()} ${subRequestUrl} ${TRANSACTION_HTTP_VERSION_1_1}`, // sub request start line with method,
     ];
     // Add required headers
     for (const [name, value] of request.headers) {
@@ -3758,7 +3756,7 @@ function cosmosPatchPolicy() {
                 request.headers.set("X-HTTP-Method", "MERGE");
             }
             return next(request);
-        }
+        },
     };
 }
 
@@ -3774,7 +3772,7 @@ function getBaseTransactionHeaders(transactionGuid) {
         "x-ms-version": "2019-02-02",
         DataServiceVersion: "3.0;",
         MaxDataServiceVersion: "3.0;NetFx",
-        "Content-Type": `multipart/mixed; boundary=batch_${transactionGuid}`
+        "Content-Type": `multipart/mixed; boundary=batch_${transactionGuid}`,
     };
 }
 
@@ -3854,7 +3852,8 @@ class InternalTableTransaction {
      * @param partitionKey - partition key
      * @param credential - credential to authenticate the transaction request
      */
-    constructor(url, partitionKey, transactionId, changesetId, interceptClient, credential, allowInsecureConnection = false) {
+    constructor(url, partitionKey, transactionId, changesetId, clientOptions, interceptClient, credential, allowInsecureConnection = false) {
+        this.clientOptions = clientOptions;
         this.credential = credential;
         this.url = url;
         this.interceptClient = interceptClient;
@@ -3890,7 +3889,7 @@ class InternalTableTransaction {
             changesetId,
             partitionKey,
             pendingOperations,
-            bodyParts
+            bodyParts,
         };
     }
     /**
@@ -3949,7 +3948,7 @@ class InternalTableTransaction {
     async submitTransaction() {
         await Promise.all(this.resetableState.pendingOperations);
         const body = getTransactionHttpRequestBody(this.resetableState.bodyParts, this.resetableState.transactionId, this.resetableState.changesetId);
-        const options = {};
+        const options = this.clientOptions;
         if (coreAuth.isTokenCredential(this.credential)) {
             options.credentialScopes = STORAGE_SCOPE;
             options.credential = this.credential;
@@ -3963,7 +3962,7 @@ class InternalTableTransaction {
             body,
             headers: coreRestPipeline.createHttpHeaders(headers),
             tracingOptions: updatedOptions.tracingOptions,
-            allowInsecureConnection: this.allowInsecureConnection
+            allowInsecureConnection: this.allowInsecureConnection,
         });
         if (coreAuth.isNamedKeyCredential(this.credential)) {
             const authHeader = getAuthorizationHeader(request, this.credential);
@@ -3979,7 +3978,7 @@ class InternalTableTransaction {
         catch (error) {
             span.setStatus({
                 code: coreTracing.SpanStatusCode.ERROR,
-                message: error.message
+                message: error.message,
             });
             throw error;
         }
@@ -4028,7 +4027,7 @@ function parseTransactionResponse(transactionResponse) {
     return {
         status,
         subResponses: responses,
-        getResponseForEntity: (rowKey) => responses.find((r) => r.rowKey === rowKey)
+        getResponseForEntity: (rowKey) => responses.find((r) => r.rowKey === rowKey),
     };
 }
 function handleBodyError(bodyAsText, statusCode, request, response) {
@@ -4052,7 +4051,7 @@ function handleBodyError(bodyAsText, statusCode, request, response) {
         code,
         statusCode,
         request,
-        response
+        response,
     });
 }
 /**
@@ -4065,7 +4064,7 @@ function prepateTransactionPipeline(pipeline, bodyParts, changesetId, isCosmos)
     const policies = pipeline.getOrderedPolicies();
     for (const policy of policies) {
         pipeline.removePolicy({
-            name: policy.name
+            name: policy.name,
         });
     }
     // With the clear state we now initialize the pipelines required for intercepting the requests.
@@ -4076,7 +4075,7 @@ function prepateTransactionPipeline(pipeline, bodyParts, changesetId, isCosmos)
     if (isCosmos) {
         pipeline.addPolicy(cosmosPatchPolicy(), {
             afterPolicies: [transactionHeaderFilterPolicyName],
-            beforePolicies: [coreClient.serializationPolicyName, transactionRequestAssemblePolicyName]
+            beforePolicies: [coreClient.serializationPolicyName, transactionRequestAssemblePolicyName],
         });
     }
 }
@@ -4114,7 +4113,7 @@ function encodeContinuationToken(nextPartitionKey = "", nextRowKey = "") {
     }
     const continuationToken = JSON.stringify({
         nextPartitionKey,
-        nextRowKey
+        nextRowKey,
     });
     return base64Encode(continuationToken);
 }
@@ -4136,7 +4135,7 @@ const propertyCaseMap = new Map([
     ["PartitionKey", "partitionKey"],
     ["RowKey", "rowKey"],
     ["odata.etag", "etag"],
-    ["Timestamp", "timestamp"]
+    ["Timestamp", "timestamp"],
 ]);
 const Edm = {
     Binary: "Edm.Binary",
@@ -4146,7 +4145,7 @@ const Edm = {
     Guid: "Edm.Guid",
     Int32: "Edm.Int32",
     Int64: "Edm.Int64",
-    String: "Edm.String"
+    String: "Edm.String",
 };
 function serializePrimitive(value) {
     const serializedValue = { value };
@@ -4312,7 +4311,7 @@ function serializeSignedIdentifiers(signedIdentifiers) {
             : undefined;
         return {
             id,
-            accessPolicy: Object.assign(Object.assign(Object.assign({}, (serializedExpiry && { expiry: serializedExpiry })), (serializedStart && { start: serializedStart })), rest)
+            accessPolicy: Object.assign(Object.assign(Object.assign({}, (serializedExpiry && { expiry: serializedExpiry })), (serializedStart && { start: serializedStart })), rest),
         };
     });
 }
@@ -4324,7 +4323,7 @@ function deserializeSignedIdentifier(signedIdentifiers) {
         const deserializedExpiry = expiry ? new Date(expiry) : undefined;
         return {
             id,
-            accessPolicy: Object.assign(Object.assign(Object.assign({}, (deserializedExpiry && { expiry: deserializedExpiry })), (deserializedStart && { start: deserializedStart })), restAcl)
+            accessPolicy: Object.assign(Object.assign(Object.assign({}, (deserializedExpiry && { expiry: deserializedExpiry })), (deserializedStart && { start: deserializedStart })), restAcl),
         };
     });
 }
@@ -4393,19 +4392,19 @@ class TableClient {
         this.tableName = tableName;
         const credential = isCredential(credentialOrOptions) ? credentialOrOptions : undefined;
         this.credential = credential;
-        const clientOptions = (!isCredential(credentialOrOptions) ? credentialOrOptions : options) || {};
-        this.allowInsecureConnection = (_a = clientOptions.allowInsecureConnection) !== null && _a !== void 0 ? _a : false;
-        clientOptions.endpoint = clientOptions.endpoint || this.url;
-        const internalPipelineOptions = Object.assign(Object.assign(Object.assign({}, clientOptions), { loggingOptions: {
+        this.clientOptions = (!isCredential(credentialOrOptions) ? credentialOrOptions : options) || {};
+        this.allowInsecureConnection = (_a = this.clientOptions.allowInsecureConnection) !== null && _a !== void 0 ? _a : false;
+        this.clientOptions.endpoint = this.clientOptions.endpoint || this.url;
+        const internalPipelineOptions = Object.assign(Object.assign(Object.assign({}, this.clientOptions), { loggingOptions: {
                 logger: logger.info,
-                additionalAllowedHeaderNames: [...TablesLoggingAllowedHeaderNames]
+                additionalAllowedHeaderNames: [...TablesLoggingAllowedHeaderNames],
             }, deserializationOptions: {
-                parseXML: coreXml.parseXML
+                parseXML: coreXml.parseXML,
             }, serializationOptions: {
-                stringifyXML: coreXml.stringifyXML
+                stringifyXML: coreXml.stringifyXML,
             } }), (coreAuth.isTokenCredential(this.credential) && {
             credential: this.credential,
-            credentialScopes: STORAGE_SCOPE
+            credentialScopes: STORAGE_SCOPE,
         }));
         const generatedClient = new GeneratedClient(this.url, internalPipelineOptions);
         if (coreAuth.isNamedKeyCredential(credential)) {
@@ -4601,7 +4600,7 @@ class TableClient {
                     pageOptions.continuationToken = settings.continuationToken;
                 }
                 return this.listEntitiesPage(tableName, pageOptions);
-            }
+            },
         };
     }
     listEntitiesAll(tableName, options) {
@@ -4642,7 +4641,7 @@ class TableClient {
             catch (e) {
                 span.setStatus({
                     code: coreTracing.SpanStatusCode.ERROR,
-                    message: e.message
+                    message: e.message,
                 });
                 throw e;
             }
@@ -4661,13 +4660,13 @@ class TableClient {
             listEntitiesOptions.nextRowKey = continuationToken.nextRowKey;
             listEntitiesOptions.nextPartitionKey = continuationToken.nextPartitionKey;
         }
-        const { xMsContinuationNextPartitionKey: nextPartitionKey, xMsContinuationNextRowKey: nextRowKey, value } = await this.table.queryEntities(tableName, listEntitiesOptions);
+        const { xMsContinuationNextPartitionKey: nextPartitionKey, xMsContinuationNextRowKey: nextRowKey, value, } = await this.table.queryEntities(tableName, listEntitiesOptions);
         const tableEntities = deserializeObjectsArray(value !== null && value !== void 0 ? value : [], disableTypeConversion);
         // 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
+            continuationToken,
         });
         return page;
     }
@@ -4953,7 +4952,7 @@ class TableClient {
         const changesetId = Uuid.generateUuid();
         if (!this.transactionClient) {
             // Add pipeline
-            this.transactionClient = new InternalTableTransaction(this.url, partitionKey, transactionId, changesetId, new TableClient(this.url, this.tableName), this.credential, this.allowInsecureConnection);
+            this.transactionClient = new InternalTableTransaction(this.url, partitionKey, transactionId, changesetId, this.clientOptions, new TableClient(this.url, this.tableName), this.credential, this.allowInsecureConnection);
         }
         else {
             this.transactionClient.reset(transactionId, changesetId, partitionKey);
@@ -4992,7 +4991,7 @@ class TableClient {
     static fromConnectionString(connectionString, tableName, 
     // eslint-disable-next-line @azure/azure-sdk/ts-naming-options
     options) {
-        const { url, options: clientOptions, credential } = getClientParamsFromConnectionString(connectionString, options);
+        const { url, options: clientOptions, credential, } = getClientParamsFromConnectionString(connectionString, options);
         if (credential) {
             return new TableClient(url, tableName, credential, clientOptions);
         }