fux: internal sdk

Author: scopsy

apps/api/src/app/topics-v2/dtos/topic-subscription-response.dto.ts

@@ -50,6 +50,12 @@ export class TopicSubscriptionResponseDto {
   })
   _id: string;
 
+  @ApiProperty({
+    description: 'The date and time the subscription was created',
+    example: '2021-01-01T00:00:00.000Z',
+  })
+  createdAt: string;
+
   @ApiProperty({
     description: 'Topic information',
     type: TopicResponseDto,

apps/api/src/app/topics-v2/usecases/list-topic-subscriptions/list-topic-subscriptions.usecase.ts

@@ -33,7 +33,6 @@ export class ListTopicSubscriptionsUseCase {
       throw new NotFoundException(`Topic with key ${command.topicKey} not found`);
     }
 
-    // Use the repository method for pagination
     const subscriptionsPagination = await this.topicSubscribersRepository.findTopicSubscriptionsWithPagination({
       environmentId: command.environmentId,
       organizationId: command.organizationId,

apps/api/src/app/topics-v2/usecases/list-topics/map-topic-entity-to.dto.ts

@@ -20,6 +20,7 @@ export function mapTopicSubscriptionsToDto(
   return {
     _id: String(subscription._id),
     topic: mapTopicEntityToDto(topic),
+    createdAt: subscription.createdAt!,
     subscriber: {
       _id: String(subscriber._id),
       subscriberId: subscriber.subscriberId,

apps/dashboard/src/api/topics.ts

@@ -139,6 +139,7 @@ export const removeSubscribersFromTopic = async ({
 
 export type TopicSubscription = {
   _id: string;
+  createdAt: string;
   topic: {
     _id: string;
     key: string;

apps/dashboard/src/components/subscribers/subscriptions/subscription-item.tsx

@@ -3,6 +3,8 @@ import { TopicDrawerButton } from '@/components/topics/topic-drawer';
 import TruncatedText from '@/components/truncated-text';
 import { cn } from '@/utils/ui';
 import { motion } from 'motion/react';
+import { TimeDisplayHoverCard } from '@/components/time-display-hover-card';
+import { format } from 'date-fns';
 
 type SubscriptionItemProps = {
   subscription: TopicSubscription;
@@ -34,6 +36,11 @@ export function SubscriptionItem({ subscription }: SubscriptionItemProps) {
             </div>
           </div>
         </div>
+        {subscription.createdAt && (
+          <TimeDisplayHoverCard date={subscription.createdAt} className="text-label-xs text-foreground-600">
+            {format(new Date(subscription.createdAt), 'MMM d, yyyy')}
+          </TimeDisplayHoverCard>
+        )}
       </motion.div>
     </TopicDrawerButton>
   );

apps/dashboard/src/components/topics/topic-drawer.tsx

@@ -128,8 +128,10 @@ const TopicSubscribers = (props: TopicSubscribersProps) => {
           <TopicSubscriberItem
             key={subscription._id}
             subscriber={subscription.subscriber as ISubscriber}
+            subscription={subscription}
             topicKey={topicKey}
             readOnly={readOnly}
+            subscriptionDate={subscription.createdAt}
           />
         ))
       )}

apps/dashboard/src/components/topics/topic-subscriber-item.tsx

@@ -16,14 +16,17 @@ import { useState } from 'react';
 import { RiDeleteBinLine, RiMailLine } from 'react-icons/ri';
 import { SubscriberDrawerButton } from '../subscribers/subscriber-drawer';
 import { useRemoveTopicSubscriber } from './hooks/use-topic-subscribers';
+import { TimeDisplayHoverCard } from '../time-display-hover-card';
+import { format } from 'date-fns';
+import { TopicSubscription } from '@/api/topics';
 
 interface TopicSubscriberItemProps {
-  subscriber: ISubscriber;
   topicKey: string;
   readOnly?: boolean;
+  subscription: TopicSubscription;
 }
 
-export function TopicSubscriberItem({ subscriber, topicKey, readOnly = false }: TopicSubscriberItemProps) {
+export function TopicSubscriberItem({ topicKey, subscription, readOnly = false }: TopicSubscriberItemProps) {
   const [confirmDialogOpen, setConfirmDialogOpen] = useState(false);
   const { mutate: removeSubscriber, isPending } = useRemoveTopicSubscriber();
 
@@ -38,55 +41,63 @@ export function TopicSubscriberItem({ subscriber, topicKey, readOnly = false }:
 
     removeSubscriber({
       topicKey,
-      subscriberId: subscriber.subscriberId,
+      subscriberId: subscription.subscriber.subscriberId,
     });
 
     setConfirmDialogOpen(false);
   };
 
   const getDisplayName = () => {
-    if (subscriber.firstName || subscriber.lastName) {
-      return `${subscriber.firstName || ''} ${subscriber.lastName || ''}`.trim();
+    if (subscription.subscriber.firstName || subscription.subscriber.lastName) {
+      return `${subscription.subscriber.firstName || ''} ${subscription.subscriber.lastName || ''}`.trim();
     }
 
     return null;
   };
 
   const displayName = getDisplayName();
-  const subscriberTitle = displayName || subscriber.subscriberId;
+  const subscriberTitle = displayName || subscription.subscriber.subscriberId;
 
   return (
     <>
-      <SubscriberDrawerButton subscriberId={subscriber.subscriberId} readOnly>
+      <SubscriberDrawerButton subscriberId={subscription.subscriber.subscriberId} readOnly>
         <motion.div
           variants={itemVariants}
           className="border-b-stroke-soft group flex w-full cursor-pointer border-b last:border-b-0 hover:bg-neutral-50"
         >
-          <div className="grid w-full grid-cols-[150px_1fr_auto] items-center px-3 py-2">
+          <div className="grid w-full grid-cols-[150px_1fr_120px_auto] items-center px-3 py-2">
             <div className="flex max-w-[150px] items-center gap-3 overflow-hidden">
               <Avatar className="size-8">
-                <AvatarImage src={subscriber.avatar || undefined} />
+                <AvatarImage src={subscription.subscriber.avatar || undefined} />
                 <AvatarFallback>{subscriberTitle[0]}</AvatarFallback>
               </Avatar>
               <div className="flex flex-col overflow-hidden">
                 <span className="text-label-xs text-foreground-950 truncate font-medium">
-                  {displayName || subscriber.subscriberId}
+                  {displayName || subscription.subscriber.subscriberId}
                 </span>
-                {subscriber.email && (
+                {subscription.subscriber.email && (
                   <div className="flex items-center">
                     <RiMailLine className="mr-1.5 size-3 min-w-3 text-neutral-400" />
-                    <span className="text-label-xs truncate text-neutral-500">{subscriber.email}</span>
+                    <span className="text-label-xs truncate text-neutral-500">{subscription.subscriber.email}</span>
                   </div>
                 )}
               </div>
             </div>
 
             <div className="overflow-hidden px-4 text-left">
-              <span className="text-label-xs truncate text-neutral-500">{subscriber.subscriberId}</span>
+              <span className="text-label-xs truncate text-neutral-500">{subscription.subscriber.subscriberId}</span>
+            </div>
+
+            <div className="text-label-xs text-foreground-600 justify-self-end px-2">
+              {subscription.createdAt && (
+                <TimeDisplayHoverCard date={subscription.createdAt}>
+                  {format(new Date(subscription.createdAt), 'MMM d, yyyy')}
+                </TimeDisplayHoverCard>
+              )}
             </div>
 
             {!readOnly && (
-              <div className="opacity-0 transition-opacity duration-200 group-hover:opacity-100">
+              <div className="justify-self-end opacity-0 transition-opacity duration-200 group-hover:opacity-100">
                 <Tooltip>
                   <TooltipTrigger asChild>
                     <Button
@@ -114,8 +125,8 @@ export function TopicSubscriberItem({ subscriber, topicKey, readOnly = false }:
             <DialogTitle>Remove Subscriber</DialogTitle>
             <DialogDescription>
               Are you sure you want to remove{' '}
-              <span className="font-medium">{displayName || subscriber.subscriberId}</span> from this topic? This action
-              cannot be undone.
+              <span className="font-medium">{displayName || subscription.subscriber.subscriberId}</span> from this
+              topic? This action cannot be undone.
             </DialogDescription>
           </DialogHeader>
           <DialogFooter>

libs/internal-sdk/.gitignore

@@ -1,3 +1,5 @@
+**/.speakeasy/temp/
+**/.speakeasy/logs/
 .speakeasy/temp/
 .DS_Store
 /mcp-server

libs/internal-sdk/eslint.config.mjs

@@ -11,6 +11,7 @@ export default [
   {
     rules: {
       "no-constant-condition": "off",
+      "no-useless-escape": "off",
       // Handled by typescript compiler
       "@typescript-eslint/no-unused-vars": "off",
       "@typescript-eslint/no-explicit-any": "off",

libs/internal-sdk/src/funcs/subscribersTopicsList.ts

@@ -25,7 +25,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * List topic subscriptions for a subscriber
+ * List topics a subscriber is subscribed to
  *
  * @remarks
  * List topic subscriptions for a subscriber with pagination and filtering

libs/internal-sdk/src/lib/config.ts

@@ -63,6 +63,6 @@ export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0",
   sdkVersion: "0.1.21",
-  genVersion: "2.593.4",
-  userAgent: "speakeasy-sdk/typescript 0.1.21 2.593.4 1.0 @novu/api",
+  genVersion: "2.596.2",
+  userAgent: "speakeasy-sdk/typescript 0.1.21 2.596.2 1.0 @novu/api",
 } as const;

libs/internal-sdk/src/lib/sdks.ts

@@ -46,12 +46,14 @@ export type RequestOptions = {
    */
   serverURL?: string | URL;
   /**
+   * @deprecated `fetchOptions` has been flattened into `RequestOptions`.
+   *
    * Sets various request options on the `fetch` call made by an SDK method.
    *
    * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options|Request}
    */
   fetchOptions?: Omit<RequestInit, "method" | "body">;
-};
+} & Omit<RequestInit, "method" | "body">;
 
 type RequestConfig = {
   method: string;
@@ -168,7 +170,9 @@ export class ClientSDK {
     cookie = cookie.startsWith("; ") ? cookie.slice(2) : cookie;
     headers.set("cookie", cookie);
 
-    const userHeaders = new Headers(options?.fetchOptions?.headers);
+    const userHeaders = new Headers(
+      options?.headers ?? options?.fetchOptions?.headers,
+    );
     for (const [k, v] of userHeaders) {
       headers.set(k, v);
     }
@@ -179,20 +183,16 @@ export class ClientSDK {
       headers.set(conf.uaHeader ?? "user-agent", SDK_METADATA.userAgent);
     }
 
-    let fetchOptions = options?.fetchOptions;
+    const fetchOptions: Omit<RequestInit, "method" | "body"> = {
+      ...options?.fetchOptions,
+      ...options,
+    };
     if (!fetchOptions?.signal && conf.timeoutMs && conf.timeoutMs > 0) {
       const timeoutSignal = AbortSignal.timeout(conf.timeoutMs);
-      if (!fetchOptions) {
-        fetchOptions = { signal: timeoutSignal };
-      } else {
-        fetchOptions.signal = timeoutSignal;
-      }
+      fetchOptions.signal = timeoutSignal;
     }
 
     if (conf.body instanceof ReadableStream) {
-      if (!fetchOptions) {
-        fetchOptions = {};
-      }
       Object.assign(fetchOptions, { duplex: "half" });
     }
 

libs/internal-sdk/src/models/components/topicdto.ts

@@ -10,11 +10,11 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type TopicDto = {
   /**
-   * The unique identifier of the topic
+   * The internal unique identifier of the topic
    */
   id: string;
   /**
-   * The key identifier of the topic
+   * The key identifier of the topic used in your application. Should be unique on the environment level.
    */
   key: string;
   /**

libs/internal-sdk/src/models/components/topicsubscriptionresponsedto.ts

@@ -25,6 +25,10 @@ export type TopicSubscriptionResponseDto = {
    * The identifier of the subscription
    */
   id: string;
+  /**
+   * The date and time the subscription was created
+   */
+  createdAt: string;
   /**
    * Topic information
    */
@@ -42,6 +46,7 @@ export const TopicSubscriptionResponseDto$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   _id: z.string(),
+  createdAt: z.string(),
   topic: TopicResponseDto$inboundSchema,
   subscriber: SubscriberDto$inboundSchema,
 }).transform((v) => {
@@ -53,6 +58,7 @@ export const TopicSubscriptionResponseDto$inboundSchema: z.ZodType<
 /** @internal */
 export type TopicSubscriptionResponseDto$Outbound = {
   _id: string;
+  createdAt: string;
   topic: TopicResponseDto$Outbound;
   subscriber: SubscriberDto$Outbound;
 };
@@ -64,6 +70,7 @@ export const TopicSubscriptionResponseDto$outboundSchema: z.ZodType<
   TopicSubscriptionResponseDto
 > = z.object({
   id: z.string(),
+  createdAt: z.string(),
   topic: TopicResponseDto$outboundSchema,
   subscriber: SubscriberDto$outboundSchema,
 }).transform((v) => {

libs/internal-sdk/src/react-query/subscribersTopicsList.ts

@@ -29,7 +29,7 @@ export type SubscribersTopicsListQueryData =
   operations.SubscribersControllerListSubscriberTopicsResponse;
 
 /**
- * List topic subscriptions for a subscriber
+ * List topics a subscriber is subscribed to
  *
  * @remarks
  * List topic subscriptions for a subscriber with pagination and filtering
@@ -50,7 +50,7 @@ export function useSubscribersTopicsList(
 }
 
 /**
- * List topic subscriptions for a subscriber
+ * List topics a subscriber is subscribed to
  *
  * @remarks
  * List topic subscriptions for a subscriber with pagination and filtering

libs/internal-sdk/src/sdk/novutopics.ts

@@ -9,7 +9,7 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class NovuTopics extends ClientSDK {
   /**
-   * List topic subscriptions for a subscriber
+   * List topics a subscriber is subscribed to
    *
    * @remarks
    * List topic subscriptions for a subscriber with pagination and filtering