feat(client): add feed support for date range filters (#457)

Author: meryldakin

.changeset/better-bugs-sneeze.md

@@ -0,0 +1,6 @@
+---
+"@knocklabs/client": minor
+"client-example": patch
+---
+
+add support for filtering by date in the feed client

examples/client-example/vite.config.js

@@ -11,9 +11,6 @@ export default defineConfig({
       include: [/node_modules/],
     },
   },
-  optimizeDeps: {
-    include: ['@knocklabs/client'],
-  },
   resolve: {
     extensions: ['.js', '.jsx', '.json'],
   },

examples/nextjs-example/next-env.d.ts

@@ -2,4 +2,4 @@
 /// <reference types="next/image-types/global" />
 
 // NOTE: This file should not be edited
-// see https://nextjs.org/docs/pages/building-your-application/configuring/typescript for more information.
+// see https://nextjs.org/docs/pages/api-reference/config/typescript for more information.

examples/slack-connect-example/next-env.d.ts

@@ -2,4 +2,4 @@
 /// <reference types="next/image-types/global" />
 
 // NOTE: This file should not be edited
-// see https://nextjs.org/docs/pages/building-your-application/configuring/typescript for more information.
+// see https://nextjs.org/docs/pages/api-reference/config/typescript for more information.

packages/client/src/clients/feed/feed.ts

@@ -497,12 +497,42 @@ class Feed {
       __experimentalCrossBrowserUpdates: undefined,
       auto_manage_socket_connection: undefined,
       auto_manage_socket_connection_delay: undefined,
+      inserted_at_date_range: undefined,
     };
 
+    // If the user has set a date range, transform it to the backend's expected format
+    const dateRange = options.inserted_at_date_range;
+    let finalQueryParams = { ...queryParams };
+
+    if (dateRange) {
+      // Create a properly typed object for our date filter parameters
+      const dateRangeParams: Record<string, string> = {};
+
+      // Determine which operators to use based on the inclusive flag
+      const isInclusive = dateRange.inclusive ?? false;
+
+      // For start date: use gte if inclusive, gt if not
+      if (dateRange.start) {
+        const startOperator = isInclusive
+          ? "inserted_at.gte"
+          : "inserted_at.gt";
+        dateRangeParams[startOperator] = dateRange.start;
+      }
+
+      // For end date: use lte if inclusive, lt if not
+      if (dateRange.end) {
+        const endOperator = isInclusive ? "inserted_at.lte" : "inserted_at.lt";
+        dateRangeParams[endOperator] = dateRange.end;
+      }
+
+      // Create a new object combining queryParams and dateRangeParams
+      finalQueryParams = { ...queryParams, ...dateRangeParams };
+    }
+
     const result = await this.knock.client().makeRequest({
       method: "GET",
       url: `/v1/users/${this.knock.userId}/feeds/${this.feedId}`,
-      params: queryParams,
+      params: finalQueryParams,
     });
 
     if (result.statusCode === "error" || !result.body) {
@@ -623,7 +653,7 @@ class Feed {
         }
       });
 
-      // Tnis is a hack to determine the direction of whether we're
+      // This is a hack to determine the direction of whether we're
       // adding or removing from the badge count
       const direction = type.startsWith("un")
         ? itemsToUpdate.length

packages/client/src/clients/feed/interfaces.ts

@@ -30,6 +30,15 @@ export interface FeedClientOptions {
   // Optionally set the delay amount in milliseconds when automatically disconnecting sockets from inactive tabs (defaults to `2000`)
   // Requires `auto_manage_socket_connection` to be `true`
   auto_manage_socket_connection_delay?: number;
+  // Optionally scope notifications to a given date range
+  inserted_at_date_range?: {
+    // Optionally set the start date with a string in ISO 8601 format
+    start?: string;
+    // Optionally set the end date with a string in ISO 8601 format
+    end?: string;
+    // Optionally set whether to be inclusive of the start and end dates
+    inclusive?: boolean;
+  };
 }
 
 export type FetchFeedOptions = {