@or-sdk/notifications 1.1.20 → 1.2.0

package/src/index.ts

@@ -1,2 +1,3 @@
-export { Notifications } from './Notifications';
+export * from './Notifications';
 export * from './types';
+export * from './schemas';

package/src/schemas/config.schema.ts

@@ -0,0 +1,37 @@
+import { Token } from '@or-sdk/base';
+import { z } from 'zod';
+
+const baseNotificationsConfig = z.object({
+  /** Authorization token or factory function. */
+  token: z.union([
+    z.string().min(1),
+    z.function().args().returns(z.string()),
+  ]).describe('Authorization token or factory function') satisfies z.ZodType<Token>,
+  /** Account id for cross-account requests. Requires SUPER_ADMIN role. */
+  accountId: z.string().uuid().optional().describe('Account ID for cross-account requests'),
+
+  /** If true validate method params. Default: true */
+  validateInputs: z.boolean().optional().describe('If true validate inputs'),
+  /** If true validate method results. Default: true */
+  validateOutputs: z.boolean().optional().describe('If true validate outputs'),
+});
+
+export const notificationsConfigSchema = z.union([
+  baseNotificationsConfig.extend({
+    /** URL of ServiceDiscovery API service */
+    discoveryUrl: z.undefined(),
+    /** URL of Notifications API service */
+    notificationsUrl: z.string().url().describe('URL of notifications API service'),
+  }),
+  baseNotificationsConfig.extend({
+    /** URL of ServiceDiscovery API service */
+    discoveryUrl: z.string().url().describe('URL of service discovery API'),
+    /** URL of Notifications API service */
+    notificationsUrl: z.undefined(),
+  }),
+]);
+
+/**
+ * @typedef {z.infer<typeof notificationsConfigSchema>} NotificationsConfig
+ */
+export type NotificationsConfig = z.infer<typeof notificationsConfigSchema>;

package/src/schemas/createTrailEvent.schema.ts

@@ -0,0 +1,12 @@
+import { z } from 'zod';
+
+import { trailEventSchema } from './trailEvent.schema';
+
+export const createTrailEventSchema = z.object({
+  /** The service that triggered the event */
+  service: trailEventSchema.shape.name,
+  /** Trail event details */
+  data: trailEventSchema.shape.attributes,
+});
+
+export type CreateTrailEvent = Omit<z.infer<typeof createTrailEventSchema>, never>;

package/src/schemas/index.ts

@@ -0,0 +1,4 @@
+export * from './config.schema';
+export * from './createTrailEvent.schema';
+export * from './listTrailEvents.schema';
+export * from './trailEvent.schema';

package/src/schemas/listTrailEvents.schema.ts

@@ -0,0 +1,39 @@
+import { z } from 'zod';
+
+import { trailEventSchema } from './trailEvent.schema';
+
+export const listTrailEventsParamsSchema = z.object({
+  /** The message to be displayed in the notification */
+  service: trailEventSchema.shape.name,
+
+  /** The starting point for the list of events */
+  from: z.number().int().min(0).optional().describe('The starting point for the list of events'),
+  /** The number of events to retrieve */
+  size: z.number().min(1).optional().describe('The number of events to retrieve'),
+
+  /** The start date for filtering events */
+  dateFrom: z.coerce.date().optional().describe('The start date for filtering events'),
+  /** The end date for filtering events */
+  dateTo: z.coerce.date().optional().describe('The end date for filtering events'),
+
+  /** Unique identifier of the trail event */
+  id: trailEventSchema.shape.id.optional(),
+  /** User ID related to the trail event */
+  userId: trailEventSchema.shape.userId.optional(),
+
+  /** The flow ID associated with the event */
+  flowId: trailEventSchema.shape.attributes.shape.flowId,
+  /** The bot ID associated with the event */
+  botId: trailEventSchema.shape.attributes.shape.botId,
+
+  /** The name of the creator of the event */
+  creatorName: trailEventSchema.shape.attributes.shape['creator.name'],
+  /** The user ID of the creator of the event */
+  creatorUserId: trailEventSchema.shape.attributes.shape['creator.userId'],
+  /** The multi-user ID of the creator of the event */
+  creatorMultiUserId: trailEventSchema.shape.attributes.shape['creator.multiUserId'],
+  /** The flow ID of the creator of the event */
+  creatorFlowId: trailEventSchema.shape.attributes.shape['creator.flowId'],
+});
+
+export type ListTrailEventsParams = Omit<z.infer<typeof listTrailEventsParamsSchema>, never>;

package/src/schemas/trailEvent.schema.ts

@@ -0,0 +1,46 @@
+import { z } from 'zod';
+
+const trailEventAttributesSchema = z.object({
+  /** The message to be displayed in the notification */
+  message: z.string().min(1).describe('The message to be displayed in the notification'),
+  /** The icon to be displayed in the notification */
+  icon: z.string().min(1).describe('The icon to be displayed in the notification'),
+
+  /** The URL to be opened when the notification is clicked */
+  url: z.string().url().optional().describe('The URL to be opened when the notification is clicked'),
+  /** The name of the URL to be displayed in the notification */
+  urlName: z.string().min(1).optional().describe('The name of the URL to be displayed in the notification'),
+
+  /** The flow ID associated with the event */
+  flowId: z.string().uuid().optional().describe('The flow ID associated with the event'),
+  /** The bot ID associated with the event */
+  botId: z.string().uuid().optional().describe('The bot ID associated with the event'),
+
+  /** The name of the creator of the event */
+  'creator.name': z.string().min(1).describe('The name of the creator of the event'),
+  /** The user ID of the creator of the event */
+  'creator.userId': z.string().uuid().optional().describe('The user ID of the creator of the event'),
+  /** The multi-user ID of the creator of the event */
+  'creator.multiUserId': z.string().uuid().optional().describe('The multi-user ID of the creator of the event'),
+  /** The flow ID of the creator of the event */
+  'creator.flowId': z.string().uuid().optional().describe('The flow ID of the creator of the event'),
+}).passthrough(); // allow unknown fields
+
+export type TrailEventAttributes = z.infer<typeof trailEventAttributesSchema>;
+
+export const trailEventSchema = z.object({
+  /** Unique identifier of the trail event */
+  id: z.string().uuid().readonly().describe('Unique identifier of the trail event'),
+  /** The service that triggered the event */
+  name: z.string().min(1).describe('The service that triggered the event'),
+  /** Account ID related to the trail event */
+  accountId: z.string().uuid().describe('Account ID related to the trail event'),
+  /** User ID related to the trail event */
+  userId: z.string().uuid().optional().describe('User ID related to the trail event'),
+  /** Date-time of the trail event as ISO date-time string */
+  timestamp: z.date().readonly().describe('Date-time of the trail event as ISO date-time string'),
+  /** Trail event details */
+  attributes: trailEventAttributesSchema,
+});
+
+export type TrailEvent = Omit<z.infer<typeof trailEventSchema>, never>;

package/src/types.ts

@@ -1,27 +1,3 @@
-import { Token } from '@or-sdk/base';
-
-export type NotificationsConfig = {
-  /**
-   * token
-   */
-  token: Token;
-  /**
-   * service discrovery url
-   */
-  discoveryUrl?: string;
-
-  /**
-   * url of notifications service
-   */
-  notificationsUrl?: string;
-
-  /**
-   * Account id for cross account re
-   */
-  accountId?: string;
-};
-
-
 export type ListNotificationsParams = {
   from?: number;
   size?: number;
@@ -87,27 +63,3 @@ export type SAListNotifications = {
   };
 };
 
-export type NewTrailEvent = {
-  service: string;
-  data: {
-    message: string;
-    icon?: string;
-    urlName?: string;
-    url?: string;
-    [key: string]: unknown;
-  };
-};
-
-export type ListTrailParams = {
-  from?: number;
-  size?: number;
-  service?: string;
-};
-
-export type TrailEvent = {
-  id: string;
-  data: {
-    message: string;
-  };
-  dateCreated: Date;
-};