Merge pull request #333 from tigrisdata/main

beta release

.github/workflows/pre-release.yaml

@@ -1,6 +1,6 @@
 name: release-test
 on:
-  pull_request_target:
+  pull_request:
     types:
       - "opened"
       - "reopened"

.github/workflows/ts-ci.yml

@@ -1,6 +1,13 @@
 name: ts-ci
 
-on: [push]
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+    branches:
+      - main
+  push:
+    branches:
+      - main
 
 jobs:
   build:

README.md

@@ -63,3 +63,11 @@ On every `git commit` we check the code quality using prettier and eslint.
 # License
 
 This software is licensed under the [Apache 2.0](LICENSE).
+
+# Contributors
+
+Thanks to all the people who contributed!
+
+<a href="https://github.com/tigrisdata/tigris-client-ts/graphs/contributors">
+	<img src="https://contrib.rocks/image?repo=tigrisdata/tigris-client-ts" />
+</a>

src/__tests__/test-service.ts

@@ -1,6 +1,6 @@
 import { TigrisService } from "../proto/server/v1/api_grpc_pb";
 import * as grpc from "@grpc/grpc-js";
-import { sendUnaryData, ServerUnaryCall, ServerWritableStream } from "@grpc/grpc-js";
+import { sendUnaryData, Server, ServerUnaryCall, ServerWritableStream } from "@grpc/grpc-js";
 import { v4 as uuidv4 } from "uuid";
 import {
 	BeginTransactionRequest,
@@ -11,6 +11,8 @@ import {
 	CollectionMetadata,
 	CommitTransactionRequest,
 	CommitTransactionResponse,
+	CountRequest,
+	CountResponse,
 	CreateBranchRequest,
 	CreateBranchResponse,
 	CreateOrUpdateCollectionRequest,
@@ -62,6 +64,8 @@ import * as google_protobuf_timestamp_pb from "google-protobuf/google/protobuf/t
 import { Utility } from "../utility";
 import { Status } from "@grpc/grpc-js/build/src/constants";
 import assert from "assert";
+import { Tigris } from "../tigris";
+import { Collection } from "../collection";
 
 export class TestTigrisService {
 	public static readonly ExpectedBranch = "unit-tests";
@@ -93,6 +97,8 @@ export class TestTigrisService {
 		],
 	]);
 
+	private myDatabase: any;
+
 	public static readonly ALERTS_B64_BY_ID: ReadonlyMap<number, string> = new Map([
 		// base64 of {"id":1,"text":"test"}
 		[1, "eyJpZCI6MSwidGV4dCI6InRlc3QifQ=="],
@@ -190,6 +196,10 @@ export class TestTigrisService {
 			call: ServerUnaryCall<ReadRequest, ExplainResponse>,
 			callback: sendUnaryData<ExplainResponse>
 		): void;
+		count(
+			call: ServerUnaryCall<CountRequest, CountResponse>,
+			callback: sendUnaryData<CountResponse>
+		): void;
 	} = {
 		createBranch(
 			call: ServerUnaryCall<CreateBranchRequest, CreateBranchResponse>,
@@ -317,6 +327,7 @@ export class TestTigrisService {
 			);
 			callback(undefined, reply);
 		},
+
 		/* eslint-disable @typescript-eslint/no-empty-function */
 		describeCollection(
 			call: ServerUnaryCall<DescribeCollectionRequest, DescribeCollectionResponse>,
@@ -337,6 +348,7 @@ export class TestTigrisService {
 
 			callback(undefined, reply);
 		},
+
 		describeDatabase(
 			call: ServerUnaryCall<DescribeDatabaseRequest, DescribeDatabaseResponse>,
 			callback: sendUnaryData<DescribeDatabaseResponse>
@@ -718,6 +730,17 @@ export class TestTigrisService {
 			reply.setReadType("secondary index");
 			callback(undefined, reply);
 		},
+
+		count(
+			call: ServerUnaryCall<CountRequest, CountResponse>,
+			callback: sendUnaryData<CountResponse>
+		): void {
+			assert(call.request.getBranch() === TestTigrisService.ExpectedBranch);
+
+			const reply: CountResponse = new CountResponse();
+			reply.setCount(3);
+			callback(undefined, reply);
+		},
 	};
 }
 

src/__tests__/tigris.filters.spec.ts

@@ -154,6 +154,33 @@ describe("filters tests", () => {
 		expect(Utility.filterToString(tigrisFilter)).toBe('{"balance":{"$gte":10}}');
 	});
 
+	it("not Filter", () => {
+		const tigrisFilter: Filter<Student> = {
+			name: {
+				$not: "Jack",
+			},
+		};
+		expect(Utility.filterToString(tigrisFilter)).toBe('{"name":{"$not":"Jack"}}');
+	});
+
+	it("contains Filter(string)", () => {
+		const tigrisFilter: Filter<Student> = {
+			name: {
+				$contains: "Adam",
+			},
+		};
+		expect(Utility.filterToString(tigrisFilter)).toBe('{"name":{"$contains":"Adam"}}');
+	});
+
+	it("regex Filter", () => {
+		const tigrisFilter: Filter<Student> = {
+			name: {
+				$regex: "/andy/i",
+			},
+		};
+		expect(Utility.filterToString(tigrisFilter)).toBe('{"name":{"$regex":"/andy/i"}}');
+	});
+
 	it("logicalFilterTest1", () => {
 		const logicalFilter: Filter<IUser> = {
 			$or: [

src/__tests__/tigris.rpc.spec.ts

@@ -469,6 +469,15 @@ describe("rpc tests", () => {
 		expect(explainResp.filter).toEqual(JSON.stringify({ author: "Marcel Proust" }));
 	});
 
+	it("count", async () => {
+		const tigris = new Tigris({ ...testConfig, projectName: "db3" });
+		const db = tigris.getDatabase();
+		const countResponse = await db.getCollection<IBook>("books").count({
+			author: "Marcel Proust",
+		});
+		expect(countResponse).toEqual(3);
+	});
+
 	it("describe collection", async () => {
 		const tigris = new Tigris({ ...testConfig, projectName: "db3" });
 

src/collection.ts

@@ -9,6 +9,7 @@ import {
 	SearchResponse as ProtoSearchResponse,
 	UpdateRequest as ProtoUpdateRequest,
 	SearchRequest as ProtoSearchRequest,
+	CountRequest as ProtoCountRequest,
 	DescribeCollectionRequest as ProtoDescribeCollectionRequest,
 } from "./proto/server/v1/api_pb";
 import { Session } from "./session";
@@ -618,6 +619,40 @@ export class Collection<T extends TigrisCollectionType> implements ICollection {
 		});
 	}
 
+	/**
+	 * Count the number of documents in a collection
+	 * @returns - the number of documents in a collection
+	 *
+	 * @example
+	 * ```
+	 * const countPromise = db.getCollection<Book>(Book).count();
+	 *
+	 * countPromise
+	 * 		.then(count: number) => console.log(count);
+	 * 		.catch( // catch the error)
+	 * 		.finally( // finally do something)
+	 * ```
+	 */
+	count(filter?: Filter<T>): Promise<number> {
+		if (!filter) {
+			filter = {};
+		}
+		const countRequest = new ProtoCountRequest()
+			.setProject(this.db)
+			.setCollection(this.collectionName)
+			.setBranch(this.branch)
+			.setFilter(Utility.stringToUint8Array(Utility.filterToString(filter)));
+
+		return new Promise((resolve, reject) => {
+			this.grpcClient.count(countRequest, (err, response) => {
+				if (err) {
+					return reject(err);
+				}
+				resolve(response.getCount());
+			});
+		});
+	}
+
 	/**
 	 * Read a single document from collection.
 	 *

src/types.ts

@@ -762,7 +762,16 @@ type PathsForFilter<T, P extends string = ""> = {
 		: `${P}${K & string}`;
 }[keyof T];
 
-export type SelectorOperator = "$eq" | "$gt" | "$gte" | "$lt" | "$lte" | "$none";
+export type SelectorOperator =
+	| "$eq"
+	| "$gt"
+	| "$gte"
+	| "$lt"
+	| "$lte"
+	| "$not"
+	| "$regex"
+	| "$contains"
+	| "$none";
 export type LogicalOperator = "$or" | "$and";
 
 export type SelectorFilter<T> = {