azure-mock 4.3.1 → 4.4.0

package/README.md

@@ -5,12 +5,14 @@
 [![NPM downloads][badge-npm-downloads]][url-npm]
 [![NPM Unpacked Size (with version)][badge-npm-unpacked-size]][url-npm]
 
-Mock Azure service classes for local development and testing. Provides in-memory implementations of Azure Table Storage, Blob Storage, Service Bus, and EventGrid clients that mirror the real Azure SDK interfaces.
+Mock Azure service classes for local development and testing, providing in-memory implementations of Azure Table Storage, Blob Storage, Service Bus, and EventGrid clients that mirror the real Azure SDK interfaces.
+
+Design notes live in [the specs](https://github.com/Esposter/Esposter/tree/main/openspec/specs).
 
 ## Table of Contents
 
 - 🚀 [Getting Started](#getting-started)
-- 📖 [Documentation](#documentation)
+- 🧩 [Key Exports](#key-exports)
 - ⚖️ [License](#license)
 
 ---
@@ -18,30 +20,9 @@ Mock Azure service classes for local development and testing. Provides in-memory
 ## <a name="getting-started">🚀 Getting Started</a>
 
 ```bash
-pnpm i -D azure-mock @azure/core-http-compat @azure/core-rest-pipeline @azure/data-tables @azure/eventgrid @azure/service-bus @azure/storage-blob
+pnpm i -D azure-mock @azure/core-http-compat @azure/core-rest-pipeline @azure/data-tables @azure/eventgrid @azure/search-documents @azure/service-bus @azure/storage-blob @azure/storage-queue
 ```
 
-## <a name="documentation">📖 Documentation</a>
-
-We highly recommend you take a look at the [documentation](https://github.com/Esposter/Esposter/tree/main/openspec/specs) to level up.
-
-### Available Mocks
-
-| Class                          | Azure Equivalent           | Description                                  |
-| ------------------------------ | -------------------------- | -------------------------------------------- |
-| `MockTableClient`              | `TableClient`              | In-memory Azure Table Storage                |
-| `MockContainerClient`          | `ContainerClient`          | In-memory blob container, listing and paging |
-| `MockBlobClient`               | `BlobClient`               | In-memory blob read, copy and delete         |
-| `MockBlockBlobClient`          | `BlockBlobClient`          | In-memory block blob upload and download     |
-| `MockBlobBatchClient`          | `BlobBatchClient`          | In-memory batched blob deletion              |
-| `MockSearchClient`             | `SearchClient`             | In-memory Azure AI Search index              |
-| `MockQueueClient`              | `QueueClient`              | In-memory Azure Storage Queue                |
-| `MockServiceBusSender`         | `ServiceBusSender`         | In-memory Azure Service Bus                  |
-| `MockWebPubSubServiceClient`   | `WebPubSubServiceClient`   | In-memory Azure Web PubSub                   |
-| `MockEventGridPublisherClient` | `EventGridPublisherClient` | In-memory EventGrid publisher                |
-
-Each client's state lives in an exported `Mock*Database` map (`MockTableDatabase`, `MockContainerDatabase`, …), so a test resets by clearing the one it seeded.
-
 ### Usage
 
 ```ts
@@ -55,16 +36,22 @@ const entity = await mockTableClient.getEntity("pk", "rk");
 
 Replace real Azure clients with their mock equivalents by swapping them in your test setup or local `.env` configuration.
 
-### Commands
+## <a name="key-exports">🧩 Key Exports</a>
 
-Run from `packages/azure-mock/`:
+| Class                          | Azure Equivalent           | Description                                  |
+| ------------------------------ | -------------------------- | -------------------------------------------- |
+| `MockBlobBatchClient`          | `BlobBatchClient`          | In-memory batched blob deletion              |
+| `MockBlobClient`               | `BlobClient`               | In-memory blob read, copy and delete         |
+| `MockBlockBlobClient`          | `BlockBlobClient`          | In-memory block blob upload and download     |
+| `MockContainerClient`          | `ContainerClient`          | In-memory blob container, listing and paging |
+| `MockEventGridPublisherClient` | `EventGridPublisherClient` | In-memory EventGrid publisher                |
+| `MockQueueClient`              | `QueueClient`              | In-memory Azure Storage Queue                |
+| `MockSearchClient`             | `SearchClient`             | In-memory Azure AI Search index              |
+| `MockServiceBusSender`         | `ServiceBusSender`         | In-memory Azure Service Bus                  |
+| `MockTableClient`              | `TableClient`              | In-memory Azure Table Storage                |
+| `MockWebPubSubServiceClient`   | `WebPubSubServiceClient`   | Stub: `group().sendToAll` and nothing else   |
 
-```bash
-pnpm build        # compile to dist/
-pnpm test         # vitest watch mode (coverage is run from the repo root)
-pnpm lint:fix     # auto-fix lint
-pnpm typecheck    # type check
-```
+Each client's state lives in an exported `Mock*Database` map (`MockTableDatabase`, `MockContainerDatabase`, …), so a test resets by clearing the one it seeded.
 
 ## <a name="license">⚖️ License</a>
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "azure-mock",
-  "version": "4.3.1",
+  "version": "4.4.0",
   "description": "A library that contains azure mock classes.",
   "keywords": [
     "azure",
@@ -48,15 +48,15 @@
     "lint": "eslint .",
     "lint:fix": "eslint --fix .",
     "test": "vitest",
-    "typecheck": "tsc"
+    "typecheck": "tsrs --fast"
   },
   "dependencies": {
-    "@esposter/azure": "4.3.1",
-    "@esposter/shared": "4.3.1"
+    "@esposter/azure": "4.4.0",
+    "@esposter/shared": "4.4.0"
   },
   "devDependencies": {
-    "@esposter/configuration": "4.3.1",
-    "tsdown": "^0.23.1",
+    "@esposter/configuration": "4.4.0",
+    "tsdown": "0.23.2",
     "type-fest": "^5.10.0"
   },
   "peerDependencies": {
@@ -72,5 +72,5 @@
   "inlinedDependencies": {
     "type-fest": "5.10.0"
   },
-  "gitHead": "777a39636b789c13af33ed13370246ccf6dbaf31"
+  "gitHead": "e1a416c4b91da69cc2aa259b50a4d656f204d272"
 }