[storage] Migrate Storage to ESM/vitest

rush.json

@@ -1,7 +1,7 @@
 /**
  * This is the main configuration file for Rush.
  * For full documentation, please see https://rushjs.io
- */{
+ */ {
   "$schema": "https://developer.microsoft.com/json-schemas/rush/v5/rush.schema.json",
   /**
    * (Required) This specifies the version of the Rush engine to be used in this repo.
@@ -560,9 +560,7 @@
       "projectFolder": "common/tools/dev-tool",
       "versionPolicyName": "utility",
       // Add Identity to decoupledLocalDependencies so that dev-tool uses the package from npm, avoiding a cyclic dependency.
-      "decoupledLocalDependencies": [
-        "@azure/identity"
-      ]
+      "decoupledLocalDependencies": ["@azure/identity"]
     },
     {
       "packageName": "@azure/eventgrid",
@@ -602,9 +600,7 @@
     {
       "packageName": "@azure/identity",
       "projectFolder": "sdk/identity/identity",
-      "decoupledLocalDependencies": [
-        "@azure/keyvault-keys"
-      ],
+      "decoupledLocalDependencies": ["@azure/keyvault-keys"],
       "versionPolicyName": "client"
     },
     {
@@ -717,6 +713,11 @@
       "projectFolder": "sdk/storage/storage-internal-avro",
       "versionPolicyName": "utility"
     },
+    {
+      "packageName": "@azure/storage-common",
+      "projectFolder": "sdk/storage/storage-common",
+      "versionPolicyName": "utility"
+    },
     {
       "packageName": "@azure/storage-blob",
       "projectFolder": "sdk/storage/storage-blob",
@@ -2333,4 +2334,4 @@
       "versionPolicyName": "management"
     }
   ]
-}
+}

sdk/storage/storage-blob-changefeed/README.md

@@ -67,9 +67,9 @@ This library offers a client you can use to fetch the change events.
 
 The `BlobChangeFeedClient` requires almost the same parameters as `BlobServiceClient` to initialize. Refer to [storage-blob](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/storage/storage-blob#create-the-blob-service-client) for how to create the blob service client. Here is an example using `StorageSharedKeyCredential`.
 
-```javascript
-const { StorageSharedKeyCredential } = require("@azure/storage-blob");
-const { BlobChangeFeedClient } = require("@azure/storage-blob-changefeed");
+```ts snippet:ReadmeSampleCreateClient
+import { StorageSharedKeyCredential } from "@azure/storage-blob";
+import { BlobChangeFeedClient } from "@azure/storage-blob-changefeed";
 
 // Enter your storage account name and shared key
 const account = "<account>";
@@ -88,45 +88,71 @@ const changeFeedClient = new BlobChangeFeedClient(
 
 Use `BlobChangeFeedClient.listChanges()` to get iterators to iterate through the change events.
 
-```javascript
-const { BlobChangeFeedEvent } = require("@azure/storage-blob-changefeed");
+```ts snippet:ReadmeSampleListChanges
+import { StorageSharedKeyCredential } from "@azure/storage-blob";
+import { BlobChangeFeedClient } from "@azure/storage-blob-changefeed";
 
-let changeFeedEvents = [];
+const account = "<account>";
+const accountKey = "<accountkey>";
+const sharedKeyCredential = new StorageSharedKeyCredential(account, accountKey);
+const changeFeedClient = new BlobChangeFeedClient(
+  `https://${account}.blob.core.windows.net`,
+  sharedKeyCredential,
+);
+
+// Use for await to iterate through the change feed
 for await (const event of changeFeedClient.listChanges()) {
-  changeFeedEvents.push(event);
+  console.log(`Event: ${event.eventType}`);
+  console.log(`Event time: ${event.eventTime}`);
+  console.log(`Event data: ${JSON.stringify(event.data)}`);
 }
-```
 
-By page.
-
-```javascript
-const { BlobChangeFeedEvent } = require("@azure/storage-blob-changefeed");
-
-let changeFeedEvents = [];
-for await (const eventPage of changeFeedClient.listChanges().byPage()) {
-  for (const event of eventPage.events) {
-    changeFeedEvents.push(event);
+// Use `byPage` to iterate through the change feed
+for await (const page of changeFeedClient.listChanges().byPage()) {
+  console.log(`Page: ${JSON.stringify(page)}`);
+  for (const event of page.events) {
+    console.log(`Event: ${event.eventType}`);
+    console.log(`Event time: ${event.eventTime}`);
+    console.log(`Event data: ${JSON.stringify(event.data)}`);
   }
 }
 ```
 
 ### Resuming reading events with a continuationToken
 
-```javascript
-const { BlobChangeFeedEvent } = require("@azure/storage-blob-changefeed");
+```ts snippet:ReadmeSampleListChanges_Continuation
+import { StorageSharedKeyCredential } from "@azure/storage-blob";
+import { BlobChangeFeedClient } from "@azure/storage-blob-changefeed";
 
-let changeFeedEvents = [];
-const firstPage = await changeFeedClient.listChanges().byPage({ maxPageSize: 10 }).next();
-for (const event of firstPage.value.events) {
-  changeFeedEvents.push(event);
-}
+const account = "<account>";
+const accountKey = "<accountkey>";
+const sharedKeyCredential = new StorageSharedKeyCredential(account, accountKey);
+const changeFeedClient = new BlobChangeFeedClient(
+  `https://${account}.blob.core.windows.net`,
+  sharedKeyCredential,
+);
 
-// Resume iterating from the previous position with the continuationToken.
-for await (const eventPage of changeFeedClient
-  .listChanges()
-  .byPage({ continuationToken: firstPage.value.continuationToken })) {
-  for (const event of eventPage.events) {
-    changeFeedEvents.push(event);
+let iterator = changeFeedClient.listChanges().byPage({ maxPageSize: 2 });
+let response = (await iterator.next()).value;
+// Prints 2 page ranges
+if (response.pageRange) {
+  for (const pageRange of response.pageRange) {
+    console.log(`Event: ${pageRange.eventType}`);
+    console.log(`Event time: ${pageRange.eventTime}`);
+    console.log(`Event data: ${JSON.stringify(pageRange.data)}`);
+  }
+}
+// Gets next marker
+let marker = response.continuationToken;
+// Passing next marker as continuationToken
+iterator = changeFeedClient.listChanges().byPage({ continuationToken: marker, maxPageSize: 10 });
+response = (await iterator.next()).value;
+// Prints 10 page ranges
+if (response.pageRange) {
+  for (const pageRange of response.pageRange) {
+    console.log(`Event: ${pageRange.eventType}`);
+    console.log(`Event time: ${pageRange.eventTime}`);
+    console.log(`Event data: ${JSON.stringify(pageRange.data)}`);
   }
 }
 ```
@@ -137,24 +163,43 @@ Pass start time and end time to `BlobChangeFeedClient.listChanges()` to fetch ev
 
 Note that for now, the change feed client will round start time down to the nearest hour, and round end time up to the next hour.
 
-```javascript
-const { BlobChangeFeedEvent } = require("@azure/storage-blob-changefeed");
+```ts snippet:ReadmeSampleListChangesTimeRange
+import { StorageSharedKeyCredential } from "@azure/storage-blob";
+import { BlobChangeFeedClient } from "@azure/storage-blob-changefeed";
+
+const account = "<account>";
+const accountKey = "<accountkey>";
+const sharedKeyCredential = new StorageSharedKeyCredential(account, accountKey);
+const changeFeedClient = new BlobChangeFeedClient(
+  `https://${account}.blob.core.windows.net`,
+  sharedKeyCredential,
+);
 
 const start = new Date(Date.UTC(2020, 1, 21, 22, 30, 0)); // will be rounded down to 22:00
 const end = new Date(Date.UTC(2020, 4, 8, 21, 10, 0)); // will be rounded up to 22:00
-
-let changeFeedEvents = [];
-// You can also provide just a start or end time.
+// Use for await to iterate through the change feed
 for await (const event of changeFeedClient.listChanges({ start, end })) {
-  changeFeedEvents.push(event);
+  console.log(`Event: ${event.eventType}`);
+  console.log(`Event time: ${event.eventTime}`);
+  console.log(`Event data: ${JSON.stringify(event.data)}`);
+}
+
+// Use `byPage` to iterate through the change feed
+for await (const page of changeFeedClient.listChanges({ start, end }).byPage()) {
+  console.log(`Page: ${JSON.stringify(page)}`);
+  for (const event of page.events) {
+    console.log(`Event: ${event.eventType}`);
+    console.log(`Event time: ${event.eventTime}`);
+    console.log(`Event data: ${JSON.stringify(event.data)}`);
+  }
 }
 ```
 
 ## Troubleshooting
 
 Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`:
 
-```javascript
+```ts snippet:SetLogLevel
 import { setLogLevel } from "@azure/logger";
 
 setLogLevel("info");

sdk/storage/storage-blob-changefeed/api-extractor.json

@@ -1,6 +1,6 @@
 {
   "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-  "mainEntryPointFilePath": "types/latest/storage-blob-changefeed/src/index.d.ts",
+  "mainEntryPointFilePath": "dist/esm/index.d.ts",
   "docModel": {
     "enabled": true
   },
@@ -11,7 +11,7 @@
   "dtsRollup": {
     "enabled": true,
     "untrimmedFilePath": "",
-    "publicTrimmedFilePath": "./types/latest/storage-blob-changefeed.d.ts"
+    "publicTrimmedFilePath": "dist/storage-blob-changefeed.d.ts"
   },
   "messages": {
     "tsdocMessageReporting": {