Merge pull request #535 from jiacfan/dev

Code change for release 2.10.2.

BreakingChanges.md

@@ -4,7 +4,7 @@ ALL
 * Fixed the issue that retry filter will continuously retry for client error like `ETIMEDOUT`.
 
 BLOB
-* When specifiying access condition `If-None-Match: *` for read, it will always fail.
+* When specifying access condition `If-None-Match: *` for read, it will always fail.
 
 QUEUE
 * `createMessage` callback has been changed from `errorOrResponse` to `errorOrResult<QueueMessageResult>` which contains `messageId`, `popReceipt`, `timeNextVisible`, `insertionTime` and `expirationTime`. It can be passed to `updateMessage` and `deleteMessage` APIs.

CONTRIBUTING.md

@@ -2,9 +2,9 @@
 
 If you would like to become an active contributor to this project please follow the instructions provided in [Microsoft Azure Projects Contribution Guidelines](https://azure.github.io/guidelines/).
 
-Look at issues in the repository labeled 'good first issue' to choose what'd you liked to jump into!
+Look at issues in the repository labeled 'good first issue' to choose what you would like to jump into!
 
-## Project Steup
+## Project Setup
 The Azure Storage development team uses Visual Studio Code so instructions will be tailored to that preference. However, any preferred IDE or other toolset should be usable.
 
 ### Install
@@ -80,4 +80,4 @@ We strive to release each new feature for each of our environments at the same t
 ### Review Process
 We expect all guidelines to be met before accepting a pull request. As such, we will work with you to address issues we find by leaving comments in your code. Please understand that it may take a few iterations before the code is accepted as we maintain high standards on code quality. Once we feel comfortable with a contribution, we will validate the change and accept the pull request.
 
-Thank you for any contributions! Please let the team know if you have any questions or concerns about our contribution policy.
+Thank you for any contributions! Please let the team know if you have any questions or concerns about our contribution policy.

ChangeLog.md

@@ -1,6 +1,23 @@
 Note: This is an Azure Storage only package. The all up Azure node sdk still has the old storage bits in there. In a future release, those storage bits will be removed and an npm dependency to this storage node sdk will 
 be taken. This is a GA release and the changes described below indicate the changes from the Azure node SDK 0.9.8 available here - https://github.com/Azure/azure-sdk-for-node.
 
+2018.10 Version 2.10.2
+
+ALL
+* Upgrade `xmlbuilder` to 9.0.7 and `extend` to 3.0.2 to avoid vulnerabilities.
+* Removed deprecated Buffer constructor calls in favor of static methods `Buffer.from` and `Buffer.alloc`.
+* Added JSv10 link and docs.microsoft.com link.
+* Improved documents.
+
+BLOB
+* Added typescript declarations to `listBlobDirectoriesSegmented` and `listBlobDirectoriesSegmentedWithPrefix`.
+
+FILE
+* Fixed an issue that empty text isn’t supported in `createFileFromText`.
+
+TABLE
+* Fixed an issue that uncaught TypeError could be thrown from `createTable` when request is not sent properly.
+
 2018.08 Version 2.10.1
 
 ALL

README.md

@@ -1,13 +1,19 @@
 # Microsoft Azure Storage SDK for Node.js and JavaScript for Browsers
 
-[![NPM version](https://badge.fury.io/js/azure-storage.svg)](http://badge.fury.io/js/azure-storage) [![Slack](https://azurestorageslack.azurewebsites.net/badge.svg)]( https://azurestorageslack.azurewebsites.net)
+[![NPM version](https://badge.fury.io/js/azure-storage.svg)](http://badge.fury.io/js/azure-storage)
 
 * Master [![Build Status](https://travis-ci.org/Azure/azure-storage-node.svg?branch=master)](https://travis-ci.org/Azure/azure-storage-node/branches) [![Coverage Status](https://coveralls.io/repos/Azure/azure-storage-node/badge.svg?branch=master&service=github)](https://coveralls.io/github/Azure/azure-storage-node?branch=master)
 * Dev [![Build Status](https://travis-ci.org/Azure/azure-storage-node.svg?branch=dev)](https://travis-ci.org/Azure/azure-storage-node/branches) [![Coverage Status](https://coveralls.io/repos/Azure/azure-storage-node/badge.svg?branch=dev&service=github)](https://coveralls.io/github/Azure/azure-storage-node?branch=dev)
 
 This project provides a Node.js package and a browser compatible [JavaScript Client Library](https://github.com/Azure/azure-storage-node#azure-storage-javascript-client-library-for-browsers) that makes it easy to consume and manage Microsoft Azure Storage Services.
 
-> If you are looking for the Node.js SDK for other Azure services, visit [https://github.com/Azure/azure-sdk-for-node](https://github.com/Azure/azure-sdk-for-node).
+> This README page is a reference to the SDK v2. For the new SDK v10, go to [Storage SDK v10 for JavaScript (Preview)](https://github.com/Azure/azure-storage-js).
+
+| SDK Name                                                                                 | Version     | Description                                                                              | NPM/API Reference Links                                                                                                                                 |
+|------------------------------------------------------------------------------------------|-------------|------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
+| [Storage SDK v10 for JavaScript](https://github.com/Azure/azure-storage-js)              | v10-Preview | The next generation async Storage SDK (Blob only, async and promise support)             | [NPM](https://www.npmjs.com/package/@azure/storage-blob) - [Reference](https://docs.microsoft.com/en-us/javascript/api/%40azure/storage-blob/index?view=azure-node-preview) |
+| [Storage SDK v2 for JavaScript](https://github.com/Azure/azure-storage-node)             | v2          | Legacy Storage SDK in this repository (Blob/Queue/File/Table, callback style)            | [NPM](https://www.npmjs.com/package/azure-storage) - [Reference](https://docs.microsoft.com/en-us/javascript/api/azure-storage/?view=azure-node-latest) |
+| [Azure Management SDKs for JavaScript](https://github.com/Azure/azure-sdk-for-node)      | v2          | Management SDKs including Storage Resource Provider APIs                                 | [NPM](https://www.npmjs.com/package/azure) - [Reference](https://github.com/Azure/azure-sdk-for-node#documentation)                                     |
 
 # Features
 
@@ -29,7 +35,10 @@ This project provides a Node.js package and a browser compatible [JavaScript Cli
   - Get Service Properties
   - Set Service Properties
 
-Please check details on [API reference documents](http://azure.github.io/azure-storage-node).
+Please check details on API reference documents:
+
+* [Microsoft official API document on docs.microsoft.com](https://docs.microsoft.com/en-us/javascript/api/azure-storage/?view=azure-node-latest)
+* [Generated API references on GitHub pages](http://azure.github.io/azure-storage-node)
 
 # Getting Started
 
@@ -181,7 +190,7 @@ tableService.retrieveEntity('mytable', 'part2', 'row1', function(error, result,
 });
 ```
 
-The method **replaceEntity** or **insertOrReplaceEntity** can be called to update/edit an existing entry. In the following example we asssume that an entity `'part2', 'row1'` with a field `'taskDone'` set to `false` already exists.
+The method **replaceEntity** or **insertOrReplaceEntity** can be called to update/edit an existing entry. In the following example we assume that an entity `'part2', 'row1'` with a field `'taskDone'` set to `false` already exists.
 
 ```Javascript
 var azure = require('azure-storage');
@@ -456,7 +465,7 @@ By default, no retry will be performed with service instances newly created by A
 Two pre-written retry polices [ExponentialRetryPolicyFilter](http://azure.github.io/azure-storage-node/ExponentialRetryPolicyFilter.html) and [LinearRetryPolicyFilter](http://azure.github.io/azure-storage-node/LinearRetryPolicyFilter.html) are available with modifiable settings, and can be used through associating filter.
 Any custom retry logic may be used by customizing RetryPolicyFilter instance.
 
-For how to use pre-writtern retry policies and how to define customized retry policy, please refer to **retrypolicysample** in samples directory. 
+For how to use pre-written retry policies and how to define customized retry policy, please refer to **retrypolicysample** in samples directory.
 
 ## Code Samples
 
@@ -511,8 +520,6 @@ On Linux, please use `export` other than `set` to set the variables.
 
 # Azure Storage JavaScript Client Library for Browsers
 
-* Questions and feedback are welcome in our [Slack channel](https://azurestorageslack.azurewebsites.net).
-
 Azure Storage Node.js Client Library is compatible with [Browserify](http://browserify.org/). This means you can bundle your Node.js application which depends on the Node.js Client Library using Browserify.
 
 You can also choose to download the JavaScript Client Library provided by us, or generate the library by yourself. Please refer to the [README.md](https://github.com/Azure/azure-storage-node/blob/master/browser/README.md) under `browser` folder for detailed usage guidelines.

browser/ChangeLog.md

@@ -1,5 +1,15 @@
 Note: This is the change log file for Azure Storage JavaScript Client Library.
 
+2018.10 Version 2.10.102
+
+ALL
+* Generated browser compatible JavaScript files based on Microsoft Azure Storage SDK for Node.js 2.10.2.
+* Optimized browser samples and other documents.
+* Added JSv10 link and docs.microsoft.com link.
+
+FILE
+* Fixed an issue that empty text isn’t supported in `createFileFromText`.
+
 2018.08 Version 2.10.101
 
 ALL

browser/README.md

@@ -1,7 +1,5 @@
 # Azure Storage JavaScript Client Library for Browsers
 
-* Join the community discussion on Slack! [![Slack](https://azurestorageslack.azurewebsites.net/badge.svg)]( https://azurestorageslack.azurewebsites.net) 
-
 ## Downloading
 
 It's recommended to use the Azure Storage JavaScript Client Library provided by us. Please [download the latest library](https://aka.ms/downloadazurestoragejs).