feat: Add datastore count API

slackapi · Feb 27, 2024 · 3162134 · 3162134
1 parent fcb40ae
commit 3162134
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 0 deletions.
diff --git a/src/typed-method-types/apps.ts b/src/typed-method-types/apps.ts
@@ -208,6 +208,35 @@ export type DatastoreQueryResponse<
     items: DatastoreItem<Schema>[];
   };
 
+export type DatastoreCountArgs<
+  Schema extends DatastoreSchema,
+> =
+  & BaseMethodArgs
+  & {
+    /**
+     * @description The name of the datastore
+     */
+    datastore: Schema["name"];
+    expression?: string;
+    "expression_attributes"?: Record<string, string>;
+    "expression_values"?: Record<string, string | boolean | number>;
+  };
+
+export type DatastoreCountResponse<
+  Schema extends DatastoreSchema,
+> =
+  & BaseResponse
+  & {
+    /**
+     * @description The name of the datastore
+     */
+    datastore: Schema["name"];
+    /**
+     * @description The number of items matching your query
+     */
+    count: number;
+  };
+
 export type DatastoreDeleteArgs<
   Schema extends DatastoreSchema,
 > =
@@ -293,6 +322,11 @@ export type AppsDatastoreQuery = {
     args: DatastoreQueryArgs<Schema>,
   ): Promise<DatastoreQueryResponse<Schema>>;
 };
+export type AppsDatastoreCount = {
+  <Schema extends DatastoreSchema>(
+    args: DatastoreCountArgs<Schema>,
+  ): Promise<DatastoreCountResponse<Schema>>;
+};
 export type AppsDatastoreDelete = {
   <Schema extends DatastoreSchema>(
     args: DatastoreDeleteArgs<Schema>,
@@ -368,6 +402,7 @@ export type TypedAppsMethodTypes = {
       bulkPut: AppsDatastoreBulkPut;
       update: AppsDatastoreUpdate;
       query: AppsDatastoreQuery;
+      count: AppsDatastoreCount;
       delete: AppsDatastoreDelete;
       bulkDelete: AppsDatastoreBulkDelete;
     };

diff --git a/src/typed-method-types/mod.ts b/src/typed-method-types/mod.ts
@@ -20,6 +20,7 @@ export const methodsWithCustomTypes = [
   "apps.datastore.bulkPut",
   "apps.datastore.update",
   "apps.datastore.query",
+  "apps.datastore.count",
   "apps.auth.external.get",
   "apps.auth.external.delete",
   "chat.postMessage",

diff --git a/src/typed-method-types/typed-method-tests.ts b/src/typed-method-types/typed-method-tests.ts
@@ -12,6 +12,7 @@ Deno.test("Custom Type Methods are valid functions", () => {
   assertEquals(typeof client.apps.datastore.bulkPut, "function");
   assertEquals(typeof client.apps.datastore.update, "function");
   assertEquals(typeof client.apps.datastore.query, "function");
+  assertEquals(typeof client.apps.datastore.count, "function");
   assertEquals(typeof client.apps.auth.external.get, "function");
   assertEquals(typeof client.apps.auth.external.delete, "function");
   assertEquals(typeof client.workflows.triggers.create, "function");