update: release v2.3.2

dist/cjs/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@skeet-framework/firestore",
-    "version": "2.3.1",
+    "version": "2.3.2",
     "description": "Skeet Framework Plugin - Firestore",
     "main": "./dist/cjs/index.js",
     "module": "./dist/esm/index.js",
@@ -27,7 +27,7 @@
         "test": "FIRESTORE_EMULATOR_HOST=127.0.0.1:8080 jest --coverage=false --maxWorkers=1 --forceExit",
         "test:ci": "npx firebase emulators:exec --only firestore 'yarn run test'",
         "dev:emulator": "firebase emulators:start --only firestore --project fakeproject",
-        "build": "yarn build-doc && yarn version:update && yarn build:cjs && yarn build:esm",
+        "build": "yarn version:update && yarn build:cjs && yarn build:esm",
         "version:update": "ts-node -r tsconfig-paths/register --transpile-only release.ts",
         "build:cjs": "tsc -b tsconfig.cjs.json",
         "build:esm": "tsc -b tsconfig.esm.json",

dist/cjs/src/index.d.ts

@@ -8,7 +8,7 @@ export {
   addMultipleCollectionItems as adds,
   queryCollectionItems as query,
   updateCollectionItem as update,
-  deleteCollectionItem as delete,
+  deleteCollectionItem as remove,
 } from './lib'
 export type { QueryCondition } from './lib'
 export { Timestamp, FieldValue } from 'firebase/firestore'

dist/cjs/src/lib/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = '2.3.1'
+export declare const VERSION = '2.3.2'

dist/esm/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@skeet-framework/firestore",
-    "version": "2.3.1",
+    "version": "2.3.2",
     "description": "Skeet Framework Plugin - Firestore",
     "main": "./dist/cjs/index.js",
     "module": "./dist/esm/index.js",
@@ -27,7 +27,7 @@
         "test": "FIRESTORE_EMULATOR_HOST=127.0.0.1:8080 jest --coverage=false --maxWorkers=1 --forceExit",
         "test:ci": "npx firebase emulators:exec --only firestore 'yarn run test'",
         "dev:emulator": "firebase emulators:start --only firestore --project fakeproject",
-        "build": "yarn build-doc && yarn version:update && yarn build:cjs && yarn build:esm",
+        "build": "yarn version:update && yarn build:cjs && yarn build:esm",
         "version:update": "ts-node -r tsconfig-paths/register --transpile-only release.ts",
         "build:cjs": "tsc -b tsconfig.cjs.json",
         "build:esm": "tsc -b tsconfig.esm.json",

dist/esm/src/index.d.ts

@@ -8,7 +8,7 @@ export {
   addMultipleCollectionItems as adds,
   queryCollectionItems as query,
   updateCollectionItem as update,
-  deleteCollectionItem as delete,
+  deleteCollectionItem as remove,
 } from './lib'
 export type { QueryCondition } from './lib'
 export { Timestamp, FieldValue } from 'firebase/firestore'

dist/esm/src/lib/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = '2.3.1'
+export declare const VERSION = '2.3.2'

docs/functions/add.html

@@ -53,7 +53,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">DocumentReference</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A reference to the added or set document.</p>
 <aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/elsoul/skeet-firestore/blob/e3f4d3d/src/lib/addCollectionItem.ts#L48">src/lib/addCollectionItem.ts:48</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/elsoul/skeet-firestore/blob/3023136/src/lib/addCollectionItem.ts#L48">src/lib/addCollectionItem.ts:48</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/functions/adds.html

@@ -51,7 +51,7 @@ <h5><span class="tsd-kind-parameter">items</span>: <span class="tsd-signature-ty
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">WriteResult</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4><p>An array of WriteResult arrays corresponding to each batch.</p>
 <aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/elsoul/skeet-firestore/blob/e3f4d3d/src/lib/addMultipleCollectionItems.ts#L43">src/lib/addMultipleCollectionItems.ts:43</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/elsoul/skeet-firestore/blob/3023136/src/lib/addMultipleCollectionItems.ts#L43">src/lib/addMultipleCollectionItems.ts:43</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/functions/createCollectionRef.html

@@ -33,7 +33,7 @@ <h5><span class="tsd-kind-parameter">db</span>: <span class="tsd-signature-type
 <h5><span class="tsd-kind-parameter">collectionPath</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">CollectionReference</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/elsoul/skeet-firestore/blob/e3f4d3d/src/lib/createCollectionRef.ts#L5">src/lib/createCollectionRef.ts:5</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/elsoul/skeet-firestore/blob/3023136/src/lib/createCollectionRef.ts#L5">src/lib/createCollectionRef.ts:5</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/functions/createDataRef.html

@@ -33,7 +33,7 @@ <h5><span class="tsd-kind-parameter">db</span>: <span class="tsd-signature-type
 <h5><span class="tsd-kind-parameter">collectionPath</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">DocumentReference</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/elsoul/skeet-firestore/blob/e3f4d3d/src/lib/createDataRef.ts#L4">src/lib/createDataRef.ts:4</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/elsoul/skeet-firestore/blob/3023136/src/lib/createDataRef.ts#L4">src/lib/createDataRef.ts:4</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/functions/createFirestoreDataConverter.html

@@ -26,7 +26,7 @@ <h4>Type Parameters</h4>
 <h4><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type ">DocumentData</span></h4></li></ul></section>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">FirestoreDataConverter</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/elsoul/skeet-firestore/blob/e3f4d3d/src/lib/createFirestoreDataConverter.ts#L3">src/lib/createFirestoreDataConverter.ts:3</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/elsoul/skeet-firestore/blob/3023136/src/lib/createFirestoreDataConverter.ts#L3">src/lib/createFirestoreDataConverter.ts:3</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/functions/delete.html

@@ -44,7 +44,7 @@ <h5><span class="tsd-kind-parameter">docId</span>: <span class="tsd-signature-ty
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A boolean indicating the success of the delete operation.</p>
 <aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/elsoul/skeet-firestore/blob/e3f4d3d/src/lib/deleteCollectionItem.ts#L38">src/lib/deleteCollectionItem.ts:38</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/elsoul/skeet-firestore/blob/3023136/src/lib/deleteCollectionItem.ts#L38">src/lib/deleteCollectionItem.ts:38</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/functions/get.html

@@ -43,7 +43,7 @@ <h5><span class="tsd-kind-parameter">docId</span>: <span class="tsd-signature-ty
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span></h4><p>The data of the document as an object of type T.</p>
 <aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/elsoul/skeet-firestore/blob/e3f4d3d/src/lib/getCollectionItem.ts#L34">src/lib/getCollectionItem.ts:34</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/elsoul/skeet-firestore/blob/3023136/src/lib/getCollectionItem.ts#L34">src/lib/getCollectionItem.ts:34</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/functions/query.html

@@ -50,7 +50,7 @@ <h5><span class="tsd-kind-parameter">conditions</span>: <a href="../types/QueryC
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4><p>An array of documents from the collection that match the conditions.</p>
 <aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/elsoul/skeet-firestore/blob/e3f4d3d/src/lib/queryCollectionItems.ts#L77">src/lib/queryCollectionItems.ts:77</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/elsoul/skeet-firestore/blob/3023136/src/lib/queryCollectionItems.ts#L77">src/lib/queryCollectionItems.ts:77</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/functions/serverTimestamp.html

@@ -21,7 +21,7 @@ <h1>Function serverTimestamp</h1></div>
 <li class="tsd-description">
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">FieldValue</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/elsoul/skeet-firestore/blob/e3f4d3d/src/lib/serverTimestamp.ts#L3">src/lib/serverTimestamp.ts:3</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/elsoul/skeet-firestore/blob/3023136/src/lib/serverTimestamp.ts#L3">src/lib/serverTimestamp.ts:3</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/functions/update.html

@@ -53,7 +53,7 @@ <h5><span class="tsd-kind-parameter">params</span>: <span class="tsd-signature-t
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A boolean indicating the success of the update operation.</p>
 <aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/elsoul/skeet-firestore/blob/e3f4d3d/src/lib/updateCollectionItem.ts#L43">src/lib/updateCollectionItem.ts:43</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/elsoul/skeet-firestore/blob/3023136/src/lib/updateCollectionItem.ts#L43">src/lib/updateCollectionItem.ts:43</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/types/QueryCondition.html

@@ -32,7 +32,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-
 <li class="tsd-parameter">
 <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">value</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span></h5></li></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/elsoul/skeet-firestore/blob/e3f4d3d/src/lib/queryCollectionItems.ts#L7">src/lib/queryCollectionItems.ts:7</a></li></ul></aside></div>
+<li>Defined in <a href="https://github.com/elsoul/skeet-firestore/blob/3023136/src/lib/queryCollectionItems.ts#L7">src/lib/queryCollectionItems.ts:7</a></li></ul></aside></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skeet-framework/firestore",
-  "version": "2.3.1",
+  "version": "2.3.2",
   "description": "Skeet Framework Plugin - Firestore",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",
@@ -27,7 +27,7 @@
     "test": "FIRESTORE_EMULATOR_HOST=127.0.0.1:8080 jest --coverage=false --maxWorkers=1 --forceExit",
     "test:ci": "npx firebase emulators:exec --only firestore 'yarn run test'",
     "dev:emulator": "firebase emulators:start --only firestore --project fakeproject",
-    "build": "yarn build-doc && yarn version:update && yarn build:cjs && yarn build:esm",
+    "build": "yarn version:update && yarn build:cjs && yarn build:esm",
     "version:update": "ts-node -r tsconfig-paths/register --transpile-only release.ts",
     "build:cjs": "tsc -b tsconfig.cjs.json",
     "build:esm": "tsc -b tsconfig.esm.json",
@@ -71,4 +71,4 @@
     "*.{ts,css,md}": "prettier --write",
     "{src,tests}/**/*.ts": "eslint --fix"
   }
-}
+}

src/index.ts

@@ -8,7 +8,7 @@ export {
   addMultipleCollectionItems as adds,
   queryCollectionItems as query,
   updateCollectionItem as update,
-  deleteCollectionItem as delete,
+  deleteCollectionItem as remove,
 } from './lib'
 export type { QueryCondition } from './lib'
 export { Timestamp, FieldValue } from 'firebase/firestore'

src/lib/version.ts

@@ -1 +1 @@
-export const VERSION = '2.3.1'
+export const VERSION = '2.3.2'