azure-mock 2.36.0 → 2.37.2

package/dist/index.d.ts

@@ -1,30 +1,32 @@
 import { PipelineRequest, RestError } from "@azure/core-rest-pipeline";
 import { HttpHeadersLike, WebResourceLike } from "@azure/core-http-compat";
 import { MapValue } from "@esposter/shared";
-import { AnonymousCredential, AppendBlobClient, BlobAbortCopyFromURLResponse, BlobBatchClient, BlobBatchDeleteBlobsResponse, BlobBeginCopyFromURLResponse, BlobClient, BlobCopyFromURLResponse, BlobCreateSnapshotResponse, BlobDeleteIfExistsResponse, BlobDeleteImmutabilityPolicyResponse, BlobDeleteOptions, BlobDeleteResponse, BlobDownloadResponseModel, BlobDownloadResponseParsed, BlobGenerateSasUrlOptions, BlobGetAccountInfoResponse, BlobGetPropertiesResponse, BlobGetTagsResponse, BlobItem, BlobLeaseClient, BlobPrefix, BlobSetHTTPHeadersResponse, BlobSetImmutabilityPolicyResponse, BlobSetLegalHoldResponse, BlobSetMetadataResponse, BlobSetTagsResponse, BlobSetTierResponse, BlobUndeleteResponse, BlobUploadCommonResponse, BlockBlobClient, BlockBlobCommitBlockListResponse, BlockBlobGetBlockListResponse, BlockBlobPutBlobFromUrlResponse, BlockBlobStageBlockFromURLResponse, BlockBlobStageBlockResponse, BlockBlobUploadOptions, BlockBlobUploadResponse, ContainerClient, ContainerCreateIfNotExistsResponse, ContainerCreateResponse, ContainerDeleteIfExistsResponse, ContainerDeleteResponse, ContainerFindBlobsByTagsSegmentResponse, ContainerGenerateSasUrlOptions, ContainerGetAccessPolicyResponse, ContainerGetAccountInfoResponse, ContainerGetPropertiesResponse, ContainerListBlobFlatSegmentResponse, ContainerListBlobHierarchySegmentResponse, ContainerListBlobsOptions, ContainerSetAccessPolicyResponse, ContainerSetMetadataResponse, FilterBlobItem, HttpRequestBody, PageBlobClient, PollOperationState, PollerLikeWithCancellation, StorageSharedKeyCredential } from "@azure/storage-blob";
+import { AnonymousCredential, AppendBlobClient, BlobAbortCopyFromURLResponse, BlobBatchClient, BlobBatchDeleteBlobsResponse, BlobBeginCopyFromURLResponse, BlobClient, BlobCopyFromURLResponse, BlobCreateSnapshotResponse, BlobDeleteIfExistsResponse, BlobDeleteImmutabilityPolicyResponse, BlobDeleteOptions, BlobDeleteResponse, BlobDownloadResponseModel, BlobDownloadResponseParsed, BlobGenerateSasUrlOptions, BlobGetAccountInfoResponse, BlobGetPropertiesResponse, BlobGetTagsResponse, BlobHierarchyListSegment, BlobItem, BlobLeaseClient, BlobPrefix, BlobSetHTTPHeadersResponse, BlobSetImmutabilityPolicyResponse, BlobSetLegalHoldResponse, BlobSetMetadataResponse, BlobSetTagsResponse, BlobSetTierResponse, BlobUndeleteResponse, BlobUploadCommonResponse, BlockBlobClient, BlockBlobCommitBlockListResponse, BlockBlobGetBlockListResponse, BlockBlobPutBlobFromUrlResponse, BlockBlobStageBlockFromURLResponse, BlockBlobStageBlockResponse, BlockBlobUploadOptions, BlockBlobUploadResponse, ContainerClient, ContainerCreateIfNotExistsResponse, ContainerCreateResponse, ContainerDeleteIfExistsResponse, ContainerDeleteResponse, ContainerFindBlobsByTagsSegmentResponse, ContainerGenerateSasUrlOptions, ContainerGetAccessPolicyResponse, ContainerGetAccountInfoResponse, ContainerGetPropertiesResponse, ContainerListBlobFlatSegmentResponse, ContainerListBlobHierarchySegmentResponse, ContainerListBlobsOptions, ContainerSetAccessPolicyResponse, ContainerSetMetadataResponse, FilterBlobItem, HttpRequestBody, PageBlobClient, PollOperationState, PollerLikeWithCancellation, StorageSharedKeyCredential } from "@azure/storage-blob";
 import { BinaryOperator, Clause } from "@esposter/db-schema";
 import { EventGridEvent, EventGridPublisherClient } from "@azure/eventgrid";
 import { ServiceBusMessage, ServiceBusMessageBatch, ServiceBusSender } from "@azure/service-bus";
 import { CreateTableEntityResponse, GetAccessPolicyResponse, GetTableEntityResponse, ListTableEntitiesOptions, TableClient, TableDeleteEntityHeaders, TableEntity, TableEntityResult, TableEntityResultPage, TableMergeEntityHeaders, TableSetAccessPolicyHeaders, TableTransactionResponse, UpdateMode } from "@azure/data-tables";
 import { QueueClearMessagesResponse, QueueClient, QueueCreateIfNotExistsResponse, QueueCreateOptions, QueueCreateResponse, QueueDeleteIfExistsResponse, QueueDeleteMessageResponse, QueueDeleteResponse, QueueGenerateSasUrlOptions, QueueGetAccessPolicyResponse, QueueGetPropertiesResponse, QueueItem, QueuePeekMessagesOptions, QueuePeekMessagesResponse, QueueReceiveMessageOptions, QueueReceiveMessageResponse, QueueSendMessageOptions, QueueSendMessageResponse, QueueServiceProperties, QueueSetAccessPolicyResponse, QueueSetMetadataResponse, QueueUpdateMessageResponse, SignedIdentifier } from "@azure/storage-queue";
 import { AutocompleteResult, CountDocumentsOptions, DeleteDocumentsOptions, GetDocumentOptions, IndexDocumentsBatch, IndexDocumentsOptions, IndexDocumentsResult, MergeDocumentsOptions, MergeOrUploadDocumentsOptions, NarrowedModel, SearchClient, SearchDocumentsResult, SearchOptions, SelectFields, SuggestDocumentsResult, SuggestOptions, UploadDocumentsOptions } from "@azure/search-documents";
-declare const MOCK_BLOB_BASE_URL = "https://mockaccount.blob.core.windows.net";
-declare const MOCK_QUEUE_BASE_URL = "https://mockaccount.queue.core.windows.net";
-declare const MOCK_SEARCH_BASE_URL = "https://mockaccount.search.windows.net";
-declare const MOCK_TABLE_BASE_URL = "https://mockaccount.table.core.windows.net";
-interface MockResponse {
+export declare const BLOB_NOT_FOUND_ERROR_CODE = "BlobNotFound";
+export declare const BLOB_NOT_FOUND_MESSAGE = "The specified blob does not exist.";
+export declare const MOCK_BLOB_BASE_URL = "https://mockaccount.blob.core.windows.net";
+export declare const MOCK_QUEUE_BASE_URL = "https://mockaccount.queue.core.windows.net";
+export declare const MOCK_SEARCH_BASE_URL = "https://mockaccount.search.windows.net";
+export declare const MOCK_TABLE_BASE_URL = "https://mockaccount.table.core.windows.net";
+export interface MockResponse {
   headers: HttpHeadersLike;
   parsedHeaders: Record<string, never>;
   request: WebResourceLike;
   status: number;
 }
-declare class MockRestError extends RestError {
+export declare class MockRestError extends RestError {
   constructor(message: string, statusCode: number);
 }
 /**
  * An interface that tracks the settings for paged iteration
  */
-interface PageSettings {
+export interface PageSettings {
   /**
    * The token that keeps track of where to continue the iterator
    */
@@ -37,7 +39,7 @@ interface PageSettings {
 /**
  * An interface that allows async iterable iteration both to completion and by page.
  */
-interface PagedAsyncIterableIterator<TElement, TPage = TElement[], TPageSettings = PageSettings> {
+export interface PagedAsyncIterableIterator<TElement, TPage = TElement[], TPageSettings = PageSettings> {
   /**
    * The connection to the async iterator, part of the iteration protocol
    */
@@ -51,25 +53,26 @@ interface PagedAsyncIterableIterator<TElement, TPage = TElement[], TPageSettings
    */
   next: () => Promise<IteratorResult<TElement>>;
 }
-declare const createMockResponse: (status: number, url?: string) => MockResponse;
-declare const getMockSasUrl: (url: string, permissions: undefined | {
+export declare const createMockResponse: (status: number, url?: string) => MockResponse;
+export declare const getMockSasUrl: (url: string, permissions: undefined | {
   toString: () => string;
 }, resourceType?: string) => string;
-declare const MockContainerCreatedOnDatabase: Map<string, Date>;
-declare const MOCK_BLOB_SEEDED_CREATED_ON: Date;
-declare const getMockContainerCreatedOnKey: (containerName: string, blobName: string) => string;
-declare const MockContainerDatabase: Map<string, Map<string, Buffer>>;
-declare const MockEventGridDatabase: Map<string, EventGridEvent<unknown>[]>;
-declare const MockQueueDatabase: Map<string, string[]>;
-declare const MockSearchDatabase: Map<string, object[]>;
-declare const MockServiceBusDatabase: Map<string, ServiceBusMessage[]>;
-declare const MockTableDatabase: Map<string, Map<string, TableEntity>>;
-type BlobHierarchyItem = (BlobItem & {
+export declare const MockContainerCreatedOnDatabase: Map<string, Date>;
+export declare const MOCK_BLOB_SEEDED_CREATED_ON: Date;
+export declare const getMockContainerCreatedOnKey: (containerName: string, blobName: string) => string;
+export declare const MockContainerDatabase: Map<string, Map<string, Buffer>>;
+export declare const MockEventGridDatabase: Map<string, EventGridEvent<unknown>[]>;
+export declare const MockQueueDatabase: Map<string, string[]>;
+export declare const MockSearchDatabase: Map<string, object[]>;
+export declare const MockServiceBusDatabase: Map<string, ServiceBusMessage[]>;
+export declare const MockTableDatabase: Map<string, Map<string, TableEntity>>;
+export type BlobHierarchyItem = (BlobItem & {
   kind: "blob";
 }) | (BlobPrefix & {
   kind: "prefix";
 });
-declare class MockBlobBatchClient implements BlobBatchClient {
+export declare class MockBlobBatchClient implements BlobBatchClient {
+  #private;
   url: string;
   constructor(url: string);
   /**
@@ -814,7 +817,7 @@ type PostPayloadFixed = Except<UserData, 'email'>;
 */
 type Except<ObjectType, KeysType extends keyof ObjectType, Options extends ExceptOptions = {}> = _Except<ObjectType, KeysType, ApplyDefaultOptions<ExceptOptions, DefaultExceptOptions, Options>>;
 type _Except<ObjectType, KeysType extends keyof ObjectType, Options extends Required<ExceptOptions>> = { [KeyType in keyof ObjectType as Filter<KeyType, KeysType>]: ObjectType[KeyType]; } & (Options['requireExactProps'] extends true ? Partial<Record<KeysType, never>> : {});
-declare class MockBlobClient implements Except<BlobClient, "accountName"> {
+export declare class MockBlobClient implements Except<BlobClient, "accountName"> {
   connectionString: string;
   containerName: string;
   credential: AnonymousCredential;
@@ -854,7 +857,7 @@ declare class MockBlobClient implements Except<BlobClient, "accountName"> {
   withSnapshot(): BlockBlobClient;
   withVersion(): BlobClient;
 }
-declare class MockBlockBlobClient extends MockBlobClient implements Except<BlockBlobClient, "accountName"> {
+export declare class MockBlockBlobClient extends MockBlobClient implements Except<BlockBlobClient, "accountName"> {
   commitBlockList(): Promise<BlockBlobCommitBlockListResponse>;
   getBlockList(): Promise<BlockBlobGetBlockListResponse>;
   query(): Promise<BlobDownloadResponseModel>;
@@ -877,7 +880,7 @@ declare class MockBlockBlobClient extends MockBlobClient implements Except<Block
  * await blockBlobClient.upload("hello world", 11);
  * const content = await blockBlobClient.downloadToBuffer();
  */
-declare class MockContainerClient implements Except<ContainerClient, "accountName"> {
+export declare class MockContainerClient implements Except<ContainerClient, "accountName"> {
   #private;
   connectionString: string;
   containerName: string;
@@ -919,7 +922,7 @@ declare class MockContainerClient implements Except<ContainerClient, "accountNam
  * It uses a Map to simulate event grid storage and correctly implements the EventGridPublisherClient interface.
  * `client` is excluded because it is a private member of the real class and cannot be satisfied structurally.
  */
-declare class MockEventGridPublisherClient implements Except<EventGridPublisherClient<"EventGrid">, "apiVersion"> {
+export declare class MockEventGridPublisherClient implements Except<EventGridPublisherClient<"EventGrid">, "apiVersion"> {
   readonly endpointUrl: string;
   readonly inputSchema: "EventGrid";
   readonly topicType: "EventGrid";
@@ -936,7 +939,7 @@ declare class MockEventGridPublisherClient implements Except<EventGridPublisherC
  * await mockQueueClient.sendMessage("hello world");
  * const messages = await mockQueueClient.peekMessages();
  */
-declare class MockQueueClient implements Except<QueueClient, "accountName"> {
+export declare class MockQueueClient implements Except<QueueClient, "accountName"> {
   connectionString: string;
   name: string;
   url: string;
@@ -973,7 +976,7 @@ declare class MockQueueClient implements Except<QueueClient, "accountName"> {
  * await mockSearchClient.uploadDocuments([{ ... }]);
  * const { count, results } = await mockSearchClient.search("*", { filter, includeTotalCount: true });
  */
-declare class MockSearchClient<TModel extends object = Record<string, unknown>> implements Except<SearchClient<TModel>, "pipeline"> {
+export declare class MockSearchClient<TModel extends object = Record<string, unknown>> implements Except<SearchClient<TModel>, "pipeline"> {
   readonly apiVersion: string;
   readonly endpoint: string;
   readonly indexName: string;
@@ -1000,7 +1003,7 @@ declare class MockSearchClient<TModel extends object = Record<string, unknown>>
  * const mockServiceBusSender = new MockServiceBusSender("hello world");
  * await mockServiceBusSender.scheduleMessages({ body: "hello world" }, new Date());
  */
-declare class MockServiceBusSender implements ServiceBusSender {
+export declare class MockServiceBusSender implements ServiceBusSender {
   entityPath: string;
   identifier: string;
   isClosed: boolean;
@@ -1021,7 +1024,7 @@ declare class MockServiceBusSender implements ServiceBusSender {
  * await mockTableClient.createEntity({ partitionKey: "partitionKey", rowKey: "rowKey" });
  * const entity = await mockTableClient.getEntity("partitionKey", "rowKey");
  */
-declare class MockTableClient<TEntity extends TableEntity = TableEntity> implements Except<TableClient, "pipeline"> {
+export declare class MockTableClient<TEntity extends TableEntity = TableEntity> implements Except<TableClient, "pipeline"> {
   #private;
   entityType: TEntity;
   tableName: string;
@@ -1046,38 +1049,45 @@ declare class MockTableClient<TEntity extends TableEntity = TableEntity> impleme
  * A minimal mock of the Azure WebPubSubServiceClient for testing purposes.
  * Only implements `group().sendToAll` — the only method used in azure-functions tests.
  */
-declare class MockWebPubSubServiceClient {
+export declare class MockWebPubSubServiceClient {
   group(_groupName: string): {
     sendToAll: () => Promise<void>;
   };
 }
-declare const bodyToBuffer: (body: HttpRequestBody) => Promise<Buffer>;
+export declare const bodyToBuffer: (body: HttpRequestBody) => Promise<Buffer>;
 /**
  * Generates a standard Azure Storage error XML response body.
  * @param errorCode The official Azure error code (e.g., "BlobNotFound").
  * @param errorMessage The user-friendly error message.
  * @returns A formatted XML string.
  */
-declare const getAzureErrorXml: (errorCode: string, errorMessage: string) => string;
-declare const getBlobItemXml: ({ name, properties }: BlobItem) => string;
-declare const getBlobPrefixXml: (name: string) => string;
-declare const getBlobUrl: (containerName: string, blobName: string) => string;
-declare const getBlobUrlParts: (url: string) => undefined | {
+export declare const getAzureErrorXml: (errorCode: string, errorMessage: string) => string;
+export declare const getBlobItemXml: ({ name, properties }: BlobItem) => string;
+export declare const getBlobPrefixXml: (name: string) => string;
+export declare const getBlobUrl: (containerName: string, blobName: string) => string;
+export declare const getBlobUrlParts: (url: string) => undefined | {
   blobName: string;
   containerName: string;
 };
+export declare const getListBlobsSegmentResponse: (containerName: string, prefix: string, segment: BlobHierarchyListSegment, blobsXml: string) => ContainerListBlobHierarchySegmentResponse;
 /**
  * Generates a standard Azure Storage list blobs XML response body.
  * @param containerName The container name.
  * @param blobsXml The blobs xml data.
  * @returns A formatted XML string.
  */
-declare const getListBlobsXml: (containerName: string, blobsXml: string) => string;
-declare const isReadableStream: (value: unknown) => value is NodeJS.ReadableStream;
-declare const toWebResourceLike: (request: PipelineRequest) => WebResourceLike;
-declare const applyFilter: <T extends Record<string, unknown>>(documents: T[], clauses: Clause<T>[]) => T[];
-declare const compare: <T>(operator: BinaryOperator, leftHandSide: T, rightHandSide: null | T) => boolean;
-declare const createFilterPredicate: (filter: string) => ((document: Record<string, unknown>) => boolean);
-declare const isNullClause: (clause: Clause<Record<string, unknown>>) => boolean;
-declare const compareByCompositeKey: (a: TableEntity, b: TableEntity) => number;
-export { BlobHierarchyItem, MOCK_BLOB_BASE_URL, MOCK_BLOB_SEEDED_CREATED_ON, MOCK_QUEUE_BASE_URL, MOCK_SEARCH_BASE_URL, MOCK_TABLE_BASE_URL, MockBlobBatchClient, MockBlobClient, MockBlockBlobClient, MockContainerClient, MockContainerCreatedOnDatabase, MockContainerDatabase, MockEventGridDatabase, MockEventGridPublisherClient, MockQueueClient, MockQueueDatabase, MockResponse, MockRestError, MockSearchClient, MockSearchDatabase, MockServiceBusDatabase, MockServiceBusSender, MockTableClient, MockTableDatabase, MockWebPubSubServiceClient, PageSettings, PagedAsyncIterableIterator, applyFilter, bodyToBuffer, compare, compareByCompositeKey, createFilterPredicate, createMockResponse, getAzureErrorXml, getBlobItemXml, getBlobPrefixXml, getBlobUrl, getBlobUrlParts, getListBlobsXml, getMockContainerCreatedOnKey, getMockSasUrl, isNullClause, isReadableStream, toWebResourceLike };
+export declare const getListBlobsXml: (containerName: string, blobsXml: string) => string;
+export declare const getMockContainer: (containerName: string) => MapValue<typeof MockContainerDatabase>;
+export declare const isReadableStream: (value: unknown) => value is NodeJS.ReadableStream;
+export declare const toWebResourceLike: (request: PipelineRequest) => WebResourceLike;
+export declare const applyFilter: <T extends Record<string, unknown>>(documents: T[], clauses: Clause<T>[]) => T[];
+export declare const compare: <T>(operator: BinaryOperator, leftHandSide: T, rightHandSide: null | T) => boolean;
+export declare const createFilterPredicate: (filter: string) => ((document: Record<string, unknown>) => boolean);
+export declare const isNullClause: (clause: Clause<Record<string, unknown>>) => boolean;
+export declare const getMockQueueMessageItem: (messageText: string) => {
+  expiresOn: Date;
+  insertedOn: Date;
+  messageId: string;
+  messageText: string;
+};
+export declare const compareByCompositeKey: (a: TableEntity, b: TableEntity) => number;