azure-mock 2.10.0 → 2.11.0

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { AnonymousCredential, AppendBlobClient, BlobAbortCopyFromURLResponse, BlobBatchClient, BlobBatchDeleteBlobsResponse, BlobBeginCopyFromURLResponse, BlobClient, BlobCopyFromURLResponse, BlobCreateSnapshotResponse, BlobDeleteIfExistsResponse, BlobDeleteImmutabilityPolicyResponse, BlobDeleteOptions, BlobDeleteResponse, BlobDownloadResponseModel, BlobDownloadResponseParsed, BlobGetAccountInfoResponse, BlobGetPropertiesResponse, BlobGetTagsResponse, BlobItem, BlobLeaseClient, BlobPrefix, BlobSetHTTPHeadersResponse, BlobSetImmutabilityPolicyResponse, BlobSetLegalHoldResponse, BlobSetMetadataResponse, BlobSetTagsResponse, BlobSetTierResponse, BlobUndeleteResponse, BlobUploadCommonResponse, BlockBlobClient, BlockBlobCommitBlockListResponse, BlockBlobGetBlockListResponse, BlockBlobPutBlobFromUrlResponse, BlockBlobStageBlockFromURLResponse, BlockBlobStageBlockResponse, BlockBlobUploadResponse, ContainerClient, ContainerCreateIfNotExistsResponse, ContainerCreateResponse, ContainerDeleteIfExistsResponse, ContainerDeleteResponse, ContainerFindBlobsByTagsSegmentResponse, ContainerGetAccessPolicyResponse, ContainerGetAccountInfoResponse, ContainerGetPropertiesResponse, ContainerListBlobFlatSegmentResponse, ContainerListBlobHierarchySegmentResponse, ContainerListBlobsOptions, ContainerSetAccessPolicyResponse, ContainerSetMetadataResponse, FilterBlobItem, HttpRequestBody, PageBlobClient, PollOperationState, PollerLikeWithCancellation, StorageSharedKeyCredential } from "@azure/storage-blob";
 import { MapValue } from "type-fest/source/entry";
-import { CreateTableEntityResponse, GetAccessPolicyResponse, GetTableEntityResponse, TableClient, TableDeleteEntityHeaders, TableEntity, TableEntityResult, TableEntityResultPage, TableMergeEntityHeaders, TableSetAccessPolicyHeaders, TableTransactionResponse, UpdateMode } from "@azure/data-tables";
+import { CreateTableEntityResponse, GetAccessPolicyResponse, GetTableEntityResponse, ListTableEntitiesOptions, TableClient, TableDeleteEntityHeaders, TableEntity, TableEntityResult, TableEntityResultPage, TableMergeEntityHeaders, TableSetAccessPolicyHeaders, TableTransactionResponse, UpdateMode } from "@azure/data-tables";
 
 //#region src/models/BlobHierarchyItem.d.ts
 type BlobHierarchyItem = (BlobItem & {
@@ -830,7 +830,7 @@ declare class MockTableClient implements Except<TableClient, "pipeline"> {
   deleteTable(): Promise<void>;
   getAccessPolicy(): Promise<GetAccessPolicyResponse>;
   getEntity<T extends object = Record<string, unknown>>(partitionKey: string, rowKey: string): Promise<GetTableEntityResponse<TableEntityResult<T>>>;
-  listEntities<T extends object>(): PagedAsyncIterableIterator<TableEntityResult<T>, TableEntityResultPage<T>>;
+  listEntities<T extends object>(options?: ListTableEntitiesOptions): PagedAsyncIterableIterator<TableEntityResult<T>, TableEntityResultPage<T>>;
   setAccessPolicy(): Promise<TableSetAccessPolicyHeaders>;
   submitTransaction(): Promise<TableTransactionResponse>;
   updateEntity<T extends object>(entity: TableEntity<T>, mode?: UpdateMode): Promise<TableMergeEntityHeaders>;
@@ -1522,4 +1522,94 @@ type TransferProgressEvent = {
 //#region src/util/toWebResourceLike.d.ts
 declare const toWebResourceLike: (request: PipelineRequest) => WebResourceLike;
 //#endregion
-export { BlobHierarchyItem, MockBlobBatchClient, MockBlobClient, MockBlockBlobClient, MockContainerClient, MockContainerDatabase, MockRestError, MockTableClient, MockTableDatabase, PageSettings, PagedAsyncIterableIterator, bodyToBuffer, getAzureErrorXml, getBlobItemXml, getBlobPrefixXml, getListBlobsXml, isReadableStream, toWebResourceLike };
+//#region ../shared/dist/index.d.ts
+//#region src/models/azure/BinaryOperator.d.ts
+declare enum BinaryOperator {
+  eq = "eq",
+  ge = "ge",
+  gt = "gt",
+  le = "le",
+  lt = "lt",
+}
+//#endregion
+//#region src/models/shared/Operation.d.ts
+
+//#endregion
+//#region ../../node_modules/.pnpm/type-fest@4.41.0/node_modules/type-fest/source/observable-like.d.ts
+declare global {
+  // eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
+  interface SymbolConstructor {
+    readonly observable: symbol;
+  }
+}
+
+/**
+@remarks
+The TC39 observable proposal defines a `closed` property, but some implementations (such as xstream) do not as of 10/08/2021.
+As well, some guidance on making an `Observable` to not include `closed` property.
+@see https://github.com/tc39/proposal-observable/blob/master/src/Observable.js#L129-L130
+@see https://github.com/staltz/xstream/blob/6c22580c1d84d69773ee4b0905df44ad464955b3/src/index.ts#L79-L85
+@see https://github.com/benlesh/symbol-observable#making-an-object-observable
+
+@category Observable
+*/
+
+//#endregion
+//#region ../../node_modules/.pnpm/type-fest@4.41.0/node_modules/type-fest/source/optional-keys-of.d.ts
+/**
+Extract all optional keys from the given type.
+
+This is useful when you want to create a new type that contains different type values for the optional keys only.
+
+@example
+```
+import type {OptionalKeysOf, Except} from 'type-fest';
+
+interface User {
+	name: string;
+	surname: string;
+
+	luckyNumber?: number;
+}
+
+const REMOVE_FIELD = Symbol('remove field symbol');
+type UpdateOperation<Entity extends object> = Except<Partial<Entity>, OptionalKeysOf<Entity>> & {
+	[Key in OptionalKeysOf<Entity>]?: Entity[Key] | typeof REMOVE_FIELD;
+};
+
+const update1: UpdateOperation<User> = {
+	name: 'Alice'
+};
+
+const update2: UpdateOperation<User> = {
+	name: 'Bob',
+	luckyNumber: REMOVE_FIELD
+};
+```
+
+@category Utilities
+*/
+//#endregion
+//#region src/models/tableFilter/Clause.d.ts
+interface Clause {
+  key: string;
+  operator: BinaryOperator;
+  value: string;
+}
+//#endregion
+//#region src/util/tableFilter/applyTableFilter.d.ts
+declare const applyTableFilter: <T extends object>(entities: TableEntity<T>[], filter: string) => TableEntity<T>[];
+//#endregion
+//#region src/util/tableFilter/compare.d.ts
+declare const compare: (operator: BinaryOperator, leftHandSide: string, rightHandSide: string) => boolean;
+//#endregion
+//#region src/util/tableFilter/constants.d.ts
+declare const CLAUSE_REGEX: RegExp;
+//#endregion
+//#region src/util/tableFilter/createTableFilterPredicate.d.ts
+declare const createTableFilterPredicate: <T extends object>(filter: string) => ((entity: TableEntity<T>) => boolean);
+//#endregion
+//#region src/util/tableFilter/parseClause.d.ts
+declare const parseClause: (rawClause: string) => Clause;
+//#endregion
+export { BlobHierarchyItem, CLAUSE_REGEX, Clause, MockBlobBatchClient, MockBlobClient, MockBlockBlobClient, MockContainerClient, MockContainerDatabase, MockRestError, MockTableClient, MockTableDatabase, PageSettings, PagedAsyncIterableIterator, applyTableFilter, bodyToBuffer, compare, createTableFilterPredicate, getAzureErrorXml, getBlobItemXml, getBlobPrefixXml, getListBlobsXml, isReadableStream, parseClause, toWebResourceLike };

package/dist/index.js

@@ -5,12 +5,26 @@ const MockContainerDatabase = /* @__PURE__ */ new Map();
 
 //#endregion
 //#region ../shared/dist/index.js
+let BinaryOperator = /* @__PURE__ */ function(BinaryOperator$1) {
+	BinaryOperator$1["eq"] = "eq";
+	BinaryOperator$1["ge"] = "ge";
+	BinaryOperator$1["gt"] = "gt";
+	BinaryOperator$1["le"] = "le";
+	BinaryOperator$1["lt"] = "lt";
+	return BinaryOperator$1;
+}({});
 var InvalidOperationError = class extends Error {
 	constructor(operation, name, message) {
 		super(`Invalid operation: ${operation}, name: ${name}, ${message}`);
 		this.name = "InvalidOperationError";
 	}
 };
+var NotFoundError = class extends Error {
+	constructor(name, id) {
+		super(`${name} is not found for id: ${id}`);
+		this.name = "NotFoundError";
+	}
+};
 let Operation = /* @__PURE__ */ function(Operation$1) {
 	Operation$1["Create"] = "Create";
 	Operation$1["Delete"] = "Delete";
@@ -29,6 +43,7 @@ const streamToText = async (readable) => {
 	for await (const chunk of readable) data += chunk.toString();
 	return data;
 };
+const uncapitalize = (string) => `${string.charAt(0).toLowerCase()}${string.slice(1)}`;
 const exhaustiveGuard = (value) => {
 	throw new InvalidOperationError(Operation.Read, exhaustiveGuard.name, JSON.stringify(value));
 };
@@ -1111,6 +1126,72 @@ var MockContainerClient = class {
 //#region src/store/MockTableDatabase.ts
 const MockTableDatabase = /* @__PURE__ */ new Map();
 
+//#endregion
+//#region src/util/tableFilter/compare.ts
+const compare = (operator, leftHandSide, rightHandSide) => {
+	switch (operator) {
+		case BinaryOperator.eq: return leftHandSide === rightHandSide;
+		case BinaryOperator.ge: return leftHandSide >= rightHandSide;
+		case BinaryOperator.gt: return leftHandSide > rightHandSide;
+		case BinaryOperator.le: return leftHandSide <= rightHandSide;
+		case BinaryOperator.lt: return leftHandSide < rightHandSide;
+	}
+};
+
+//#endregion
+//#region src/util/tableFilter/constants.ts
+const CLAUSE_REGEX = /^(?<key>[A-Za-z0-9_]+)\s+(?<operator>eq|gt|ge|lt|le)\s+'(?<value>[^']+)'$/i;
+
+//#endregion
+//#region src/util/tableFilter/parseClause.ts
+const parseClause = (rawClause) => {
+	const match = CLAUSE_REGEX.exec(rawClause.trim());
+	if (!match) throw new NotFoundError(parseClause.name, rawClause);
+	const groups = match.groups;
+	if (!groups) throw new NotFoundError(parseClause.name, rawClause);
+	const { key, operator, value } = groups;
+	return {
+		key,
+		operator,
+		value
+	};
+};
+
+//#endregion
+//#region src/util/tableFilter/createTableFilterPredicate.ts
+const createTableFilterPredicate = (filter) => {
+	const normalizedFilter = filter.replaceAll(String.raw`(`, "").replaceAll(String.raw`)`, "");
+	const andGroups = normalizedFilter.split(/\s+and\s+/i).filter(Boolean);
+	const orGroups = andGroups.map((group) => group.split(/\s+or\s+/i).filter(Boolean));
+	return (entity) => {
+		for (const group of orGroups) {
+			let isGroupMatched = false;
+			for (const rawClause of group) {
+				const clause = parseClause(rawClause);
+				const normalizedClauseKey = uncapitalize(clause.key);
+				if (!(normalizedClauseKey in entity)) throw new NotFoundError(createTableFilterPredicate.name, JSON.stringify({
+					entity,
+					filter,
+					key: normalizedClauseKey
+				}));
+				if (compare(clause.operator, String(entity[normalizedClauseKey]), clause.value)) {
+					isGroupMatched = true;
+					break;
+				}
+			}
+			if (!isGroupMatched) return false;
+		}
+		return true;
+	};
+};
+
+//#endregion
+//#region src/util/tableFilter/applyTableFilter.ts
+const applyTableFilter = (entities, filter) => {
+	const predicate = createTableFilterPredicate(filter);
+	return entities.filter(predicate);
+};
+
 //#endregion
 //#region src/models/MockTableClient.ts
 /**
@@ -1170,16 +1251,19 @@ var MockTableClient = class {
 			etag: this.getEtag()
 		});
 	}
-	listEntities() {
+	listEntities(options) {
 		const withMetadata = this.withMetadata.bind(this);
+		const filter = options?.queryOptions?.filter;
+		const tableEntities = [...this.table.values()];
+		const resultTableEntities = filter ? applyTableFilter(tableEntities, filter) : tableEntities;
 		return {
 			byPage: () => (async function* (entities) {
-				const allEntitiesWithMetadata = [...entities.values()].map(withMetadata);
+				const allEntitiesWithMetadata = entities.map(withMetadata);
 				if (allEntitiesWithMetadata.length > 0) yield await Promise.resolve(allEntitiesWithMetadata);
-			})(this.table),
+			})(resultTableEntities),
 			next: () => (async function* (entities) {
-				for (const entity of entities.values()) yield await Promise.resolve(withMetadata(entity));
-			})(this.table).next(),
+				for (const entity of entities) yield await Promise.resolve(withMetadata(entity));
+			})(resultTableEntities).next(),
 			[Symbol.asyncIterator]() {
 				return this;
 			}
@@ -1237,4 +1321,4 @@ var MockTableClient = class {
 };
 
 //#endregion
-export { MockBlobBatchClient, MockBlobClient, MockBlockBlobClient, MockContainerClient, MockContainerDatabase, MockRestError, MockTableClient, MockTableDatabase, bodyToBuffer, getAzureErrorXml, getBlobItemXml, getBlobPrefixXml, getListBlobsXml, isReadableStream, toWebResourceLike };
+export { CLAUSE_REGEX, MockBlobBatchClient, MockBlobClient, MockBlockBlobClient, MockContainerClient, MockContainerDatabase, MockRestError, MockTableClient, MockTableDatabase, applyTableFilter, bodyToBuffer, compare, createTableFilterPredicate, getAzureErrorXml, getBlobItemXml, getBlobPrefixXml, getListBlobsXml, isReadableStream, parseClause, toWebResourceLike };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "azure-mock",
-  "version": "2.10.0",
+  "version": "2.11.0",
   "description": "A library that contains azure mock classes.",
   "type": "module",
   "homepage": "https://github.com/Esposter/Esposter#readme",
@@ -23,6 +23,8 @@
   },
   "scripts": {
     "build": "pnpm export:gen && rolldown --config rolldown.config.ts",
+    "test": "NODE_OPTIONS=--max-old-space-size=8192 vitest",
+    "coverage": "vitest run --coverage",
     "lint": "oxlint && eslint .",
     "lint:fix": "oxlint --fix && eslint --fix .",
     "typecheck": "tsc",
@@ -34,5 +36,5 @@
     "@azure/data-tables": "^13.3.1",
     "@azure/storage-blob": "^12.28.0"
   },
-  "gitHead": "ccf4ffe4c50cf43881b91045207eb5814ecf1cd3"
+  "gitHead": "e3d27b0dd40f23eebc5236a975406d0ada8e66c4"
 }