added collections.truncate method

pocketbase · Sep 28, 2024 · 5793c99 · 5793c99
1 parent 375d6ba
commit 5793c99
Show file tree

Hide file tree

Showing 19 changed files with 88 additions and 16 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -61,6 +61,8 @@
 
 - Added new `pb.collections.getScaffolds()` method to retrieve a type indexed map with the collection models (base, auth, view) loaded with their defaults.
 
+- Added new `pb.collections.truncate(idOrName)` to delete all records associated with the specified collection.
+
 - Added the submitted fetch options as 3rd last argument in the `pb.afterSend` hook.
 
 - ⚠️ Admins are converted to `_superusers` auth collection and there is no longer `AdminService` and `AdminModel` types.

diff --git a/README.md b/README.md
@@ -936,17 +936,20 @@ const result = await batch.send()
 // Returns the first found collection matching the specified filter.
 🔐 pb.collections.getFirstListItem(filter, options = {});
 
-// Returns a single collection by its id.
-🔐 pb.collections.getOne(id, options = {});
+// Returns a single collection by its id or name.
+🔐 pb.collections.getOne(idOrName, options = {});
 
 // Creates (aka. register) a new collection.
 🔐 pb.collections.create(bodyParams = {}, options = {});
 
-// Updates an existing collection by its id.
-🔐 pb.collections.update(id, bodyParams = {}, options = {});
+// Updates an existing collection by its id or name.
+🔐 pb.collections.update(idOrName, bodyParams = {}, options = {});
 
-// Deletes a single collection by its id.
-🔐 pb.collections.delete(id, options = {});
+// Deletes a single collection by its id or name.
+🔐 pb.collections.delete(idOrName, options = {});
+
+// Deletes all records associated with the specified collection.
+🔐 pb.collections.truncate(idOrName, options = {});
 
 // Imports the provided collections.
 🔐 pb.collections.import(collections, deleteMissing = false, options = {});

diff --git a/dist/pocketbase.cjs.d.ts b/dist/pocketbase.cjs.d.ts
@@ -938,6 +938,12 @@ declare class CollectionService extends CrudService<CollectionModel> {
     getScaffolds(options?: CommonOptions): Promise<{
         [key: string]: CollectionModel;
     }>;
+    /**
+     * Deletes all records associated with the specified collection.
+     *
+     * @throws {ClientResponseError}
+     */
+    truncate(collectionIdOrName: string, options?: CommonOptions): Promise<true>;
 }
 interface HourlyStats {
     total: number;

diff --git a/dist/pocketbase.cjs.js b/dist/pocketbase.cjs.js
diff --git a/dist/pocketbase.cjs.js.map b/dist/pocketbase.cjs.js.map
diff --git a/dist/pocketbase.es.d.mts b/dist/pocketbase.es.d.mts
@@ -981,6 +981,12 @@ declare class CollectionService extends CrudService<CollectionModel> {
     getScaffolds(options?: CommonOptions): Promise<{
         [key: string]: CollectionModel;
     }>;
+    /**
+     * Deletes all records associated with the specified collection.
+     *
+     * @throws {ClientResponseError}
+     */
+    truncate(collectionIdOrName: string, options?: CommonOptions): Promise<true>;
 }
 interface HourlyStats {
     total: number;

diff --git a/dist/pocketbase.es.d.ts b/dist/pocketbase.es.d.ts
@@ -981,6 +981,12 @@ declare class CollectionService extends CrudService<CollectionModel> {
     getScaffolds(options?: CommonOptions): Promise<{
         [key: string]: CollectionModel;
     }>;
+    /**
+     * Deletes all records associated with the specified collection.
+     *
+     * @throws {ClientResponseError}
+     */
+    truncate(collectionIdOrName: string, options?: CommonOptions): Promise<true>;
 }
 interface HourlyStats {
     total: number;

diff --git a/dist/pocketbase.es.js b/dist/pocketbase.es.js
diff --git a/dist/pocketbase.es.js.map b/dist/pocketbase.es.js.map
diff --git a/dist/pocketbase.es.mjs b/dist/pocketbase.es.mjs
diff --git a/dist/pocketbase.es.mjs.map b/dist/pocketbase.es.mjs.map
diff --git a/dist/pocketbase.iife.d.ts b/dist/pocketbase.iife.d.ts
@@ -938,6 +938,12 @@ declare class CollectionService extends CrudService<CollectionModel> {
     getScaffolds(options?: CommonOptions): Promise<{
         [key: string]: CollectionModel;
     }>;
+    /**
+     * Deletes all records associated with the specified collection.
+     *
+     * @throws {ClientResponseError}
+     */
+    truncate(collectionIdOrName: string, options?: CommonOptions): Promise<true>;
 }
 interface HourlyStats {
     total: number;

diff --git a/dist/pocketbase.iife.js b/dist/pocketbase.iife.js
diff --git a/dist/pocketbase.iife.js.map b/dist/pocketbase.iife.js.map
diff --git a/dist/pocketbase.umd.d.ts b/dist/pocketbase.umd.d.ts
@@ -938,6 +938,12 @@ declare class CollectionService extends CrudService<CollectionModel> {
     getScaffolds(options?: CommonOptions): Promise<{
         [key: string]: CollectionModel;
     }>;
+    /**
+     * Deletes all records associated with the specified collection.
+     *
+     * @throws {ClientResponseError}
+     */
+    truncate(collectionIdOrName: string, options?: CommonOptions): Promise<true>;
 }
 interface HourlyStats {
     total: number;

diff --git a/dist/pocketbase.umd.js b/dist/pocketbase.umd.js
diff --git a/dist/pocketbase.umd.js.map b/dist/pocketbase.umd.js.map
diff --git a/src/services/CollectionService.ts b/src/services/CollectionService.ts
@@ -56,4 +56,20 @@ export class CollectionService extends CrudService<CollectionModel> {
 
         return this.client.send(this.baseCrudPath + "/meta/scaffolds", options);
     }
+
+    /**
+     * Deletes all records associated with the specified collection.
+     *
+     * @throws {ClientResponseError}
+     */
+    async truncate(collectionIdOrName: string, options?: CommonOptions): Promise<true> {
+        options = Object.assign(
+            {
+                method: "DELETE",
+            },
+            options,
+        );
+
+        return this.client.send(this.baseCrudPath + "/" + encodeURIComponent(collectionIdOrName) +"/truncate", options).then(() => true);
+    }
 }
diff --git a/tests/services/CollectionService.spec.ts b/tests/services/CollectionService.spec.ts
@@ -74,4 +74,25 @@ describe("CollectionService", function () {
             assert.deepEqual(result as any, true);
         });
     });
+
+    describe("truncate()", function () {
+        test("Should send truncate collection request", async function () {
+            fetchMock.on({
+                method: "DELETE",
+                url: service.client.buildURL("/api/collections/test%3D/truncate?q1=456"),
+                additionalMatcher: (_, config) => {
+                    return config?.headers?.["x-test"] === "123";
+                },
+                replyCode: 204,
+                replyBody: true,
+            });
+
+            const result = await service.truncate("test=", {
+                q1: 456,
+                headers: { "x-test": "123" },
+            });
+
+            assert.deepEqual(result, true);
+        });
+    });
 });