@azure/storage-blob-changefeed 12.0.0-preview.4 → 12.0.0-preview.5

package/LICENSE

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+Copyright (c) Microsoft Corporation.
 
-Copyright (c) 2020 Microsoft
+MIT License
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -12,7 +12,7 @@ furnished to do so, subject to the following conditions:
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

package/README.md

@@ -15,15 +15,15 @@ Key links:
 
 - [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/storage/storage-blob-changefeed)
 - [Package (npm)](https://www.npmjs.com/package/@azure/storage-blob-changefeed/)
-- [API Reference Documentation](https://docs.microsoft.com/javascript/api/@azure/storage-blob-changefeed)
-- [Product documentation](https://docs.microsoft.com/azure/storage/blobs/storage-blob-change-feed)
+- [API Reference Documentation](https://learn.microsoft.com/javascript/api/@azure/storage-blob-changefeed)
+- [Product documentation](https://learn.microsoft.com/azure/storage/blobs/storage-blob-change-feed)
 - [Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/storage/storage-blob-changefeed/samples)
 
 ## Getting started
 
 ### Currently supported environments
 
-- [LTS versions of Node.js](https://nodejs.org/about/releases/)
+- [LTS versions of Node.js](https://github.com/nodejs/release#release-schedule)
 - Latest versions of Safari, Chrome, Edge, and Firefox.
 
 See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details.
@@ -31,7 +31,7 @@ See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUP
 ### Prerequisites
 
 - An [Azure subscription](https://azure.microsoft.com/free/)
-- A [Storage Account](https://docs.microsoft.com/azure/storage/blobs/storage-quickstart-blobs-portal)
+- A [Storage Account](https://learn.microsoft.com/azure/storage/blobs/storage-quickstart-blobs-portal)
 
 ### Install the package
 
@@ -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>";
@@ -80,7 +80,7 @@ const sharedKeyCredential = new StorageSharedKeyCredential(account, accountKey);
 const changeFeedClient = new BlobChangeFeedClient(
   // When using AnonymousCredential, following url should include a valid SAS or support public access
   `https://${account}.blob.core.windows.net`,
-  sharedKeyCredential
+  sharedKeyCredential,
 );
 ```
 
@@ -88,48 +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)}`);
   }
 }
 ```
@@ -140,16 +163,35 @@ 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)}`);
+  }
 }
 ```
 
@@ -157,7 +199,7 @@ for await (const event of changeFeedClient.listChanges({ start, end })) {
 
 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");
@@ -176,5 +218,3 @@ More code samples:
 If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
 
 Also refer to [Storage specific guide](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/storage/CONTRIBUTING.md) for additional information on setting up the test environment for storage libraries.
-
-![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fstorage%2Fstorage-blob-changefeed%2FREADME.png)

package/{types/3.1/storage-blob-changefeed/src → dist/browser}/AvroReaderFactory.d.ts

@@ -1,9 +1,10 @@
-import { AvroReadable, AvroReader } from "../../storage-internal-avro/src";
-/**
- * Creates AvroReaders.  Allows us to inject mock AvroReaders in the Chunk unit tests.
- */
-export declare class AvroReaderFactory {
-    create(headerAndDataStream: AvroReadable): AvroReader;
-    create(dataStream: AvroReadable, headerStream: AvroReadable, blockOffset: number, eventIndex: number): AvroReader;
-}
-//# sourceMappingURL=AvroReaderFactory.d.ts.map
+import type { AvroReadable } from "@azure/storage-internal-avro";
+import { AvroReader } from "@azure/storage-internal-avro";
+/**
+ * Creates AvroReaders.  Allows us to inject mock AvroReaders in the Chunk unit tests.
+ */
+export declare class AvroReaderFactory {
+    create(headerAndDataStream: AvroReadable): AvroReader;
+    create(dataStream: AvroReadable, headerStream: AvroReadable, blockOffset: number, eventIndex: number): AvroReader;
+}
+//# sourceMappingURL=AvroReaderFactory.d.ts.map

package/dist/browser/AvroReaderFactory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AvroReaderFactory.d.ts","sourceRoot":"","sources":["../../src/AvroReaderFactory.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAE1D;;GAEG;AACH,qBAAa,iBAAiB;IACrB,MAAM,CAAC,mBAAmB,EAAE,YAAY,GAAG,UAAU;IAErD,MAAM,CACX,UAAU,EAAE,YAAY,EACxB,YAAY,EAAE,YAAY,EAC1B,WAAW,EAAE,MAAM,EACnB,UAAU,EAAE,MAAM,GACjB,UAAU;CAcd"}

package/{dist-esm/storage-blob-changefeed/src → dist/browser}/AvroReaderFactory.js

@@ -1,6 +1,6 @@
 // Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-import { AvroReader } from "../../storage-internal-avro/src";
+// Licensed under the MIT License.
+import { AvroReader } from "@azure/storage-internal-avro";
 /**
  * Creates AvroReaders.  Allows us to inject mock AvroReaders in the Chunk unit tests.
  */

package/dist/browser/AvroReaderFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AvroReaderFactory.js","sourceRoot":"","sources":["../../src/AvroReaderFactory.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAE1D;;GAEG;AACH,MAAM,OAAO,iBAAiB;IAUrB,MAAM,CACX,UAAwB,EACxB,YAA2B,EAC3B,WAAoB,EACpB,UAAmB;QAEnB,IAAI,YAAY,EAAE,CAAC;YACjB,OAAO,IAAI,UAAU,CAAC,UAAU,EAAE,YAAY,EAAE,WAAY,EAAE,UAAW,CAAC,CAAC;QAC7E,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,UAAU,CAAC,UAAU,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { AvroReadable } from \"@azure/storage-internal-avro\";\nimport { AvroReader } from \"@azure/storage-internal-avro\";\n\n/**\n * Creates AvroReaders.  Allows us to inject mock AvroReaders in the Chunk unit tests.\n */\nexport class AvroReaderFactory {\n  public create(headerAndDataStream: AvroReadable): AvroReader;\n\n  public create(\n    dataStream: AvroReadable,\n    headerStream: AvroReadable,\n    blockOffset: number,\n    eventIndex: number,\n  ): AvroReader;\n\n  public create(\n    dataStream: AvroReadable,\n    headerStream?: AvroReadable,\n    blockOffset?: number,\n    eventIndex?: number,\n  ): AvroReader {\n    if (headerStream) {\n      return new AvroReader(dataStream, headerStream, blockOffset!, eventIndex!);\n    } else {\n      return new AvroReader(dataStream);\n    }\n  }\n}\n"]}