@firestore-repository/firebase-js-sdk 0.4.1 → 0.4.2

package/README.md

@@ -9,7 +9,8 @@ A minimum and universal Firestore ORM (Repository Pattern) for TypeScript
 ## Features
 
 - 🚀 **Minimum**: Only a few straightforward interfaces and classes. You can easily start to use it immediately without learning a lot of things.
-- 🌐 **Unopinionated**: This library does not introduce any additional concepts, and respects an interface of the official Firestore client library.
+- 🌐 **Universal**: You can share most code, including schema and query definitions, between backend and frontend.
+- 🤝 **Unopinionated**: This library does not introduce any additional concepts, and respects vocabulary of the official Firestore client library.
 - ✅ **Type-safe**: This library provides the type-safe interface. It also covers the untyped parts of the official Firestore library.
 - 🗄️ **Repository Pattern**: A simple and consistent way to access Firestore data.
 
@@ -90,28 +91,30 @@ await repository.delete({ userId: 'user2' });
 ### Query
 
 ```ts
-import { condition as $, limit, query, where } from 'firestore-repository/query';
+import { condition as $, limit, query } from 'firestore-repository/query';
 
 // Define a query
-const query1 = query(users, $('profile.age', '>=', 20), limit(10));
+const q = query(
+    users,
+    $('profile.age', '>=', 20),
+    $('profile.gender', '==', 'male'),
+    limit(10),
+);
 
 // List documents
-const docs = await repository.list(query1);
+const docs = await repository.list(q);
 console.log(docs);
 
 // Listen documents
-repository.listOnSnapshot(query1, (docs) => {
+repository.listOnSnapshot(q, (docs) => {
   console.log(docs);
 });
 
 // Aggregate
-const result = await repository.aggregate({
-  query: query1,
-  spec: {
-    avgAge: average('profile.age'),
-    sumAge: sum('profile.age'),
-    count: count(),
-  },
+const result = await repository.aggregate(q, {
+  avgAge: average('profile.age'),
+  sumAge: sum('profile.age'),
+  count: count(),
 });
 console.log(`avg:${result.avgAge} sum:${result.sumAge} count:${result.count}`);
 ```
@@ -188,12 +191,12 @@ await runTransaction(async (tx) => {
     await repository.batchSet([
       { ...doc, userId: 'user2' },
       { ...doc, userId: 'user3' },
-    ]);
+    ], { tx });
   }
 
   // Delete
   await repository.delete({ userId: 'user4' }, { tx });
-  await repository.batchDelete([{ userId: 'user5' }, { userId: 'user6' }]);
+  await repository.batchDelete([{ userId: 'user5' }, { userId: 'user6' }], { tx });
 });
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@firestore-repository/firebase-js-sdk",
-  "version": "0.4.1",
+  "version": "0.4.2",
   "description": "A minimum and universal Firestore ORM (Repository Pattern) for TypeScript",
   "homepage": "https://github.com/ikenox/firestore-repository",
   "repository": {
@@ -10,7 +10,7 @@
   "type": "module",
   "dependencies": {
     "@firebase/firestore": "^4.7.5",
-    "firestore-repository": "0.4.1"
+    "firestore-repository": "0.4.2"
   },
   "devDependencies": {
     "@firebase/app": "^0.10.16"