@or-sdk/notifications 1.1.20 → 1.2.0

package/dist/esm/schemas/trailEvent.schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"trailEvent.schema.js","sourceRoot":"","sources":["../../../src/schemas/trailEvent.schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,0BAA0B,GAAG,CAAC,CAAC,MAAM,CAAC;IAE1C,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,iDAAiD,CAAC;IAEtF,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,8CAA8C,CAAC;IAGhF,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,uDAAuD,CAAC;IAElG,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,yDAAyD,CAAC;IAGzG,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,uCAAuC,CAAC;IAEtF,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,sCAAsC,CAAC;IAGpF,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,sCAAsC,CAAC;IAElF,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,yCAAyC,CAAC;IAElG,qBAAqB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,+CAA+C,CAAC;IAE7G,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,yCAAyC,CAAC;CACnG,CAAC,CAAC,WAAW,EAAE,CAAC;AAIjB,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IAEvC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,sCAAsC,CAAC;IAEjF,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,sCAAsC,CAAC;IAExE,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,uCAAuC,CAAC;IAE9E,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,oCAAoC,CAAC;IAEnF,SAAS,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,sDAAsD,CAAC;IAE/F,UAAU,EAAE,0BAA0B;CACvC,CAAC,CAAC"}

package/dist/types/Notifications.d.ts

@@ -1,15 +1,18 @@
 import { Base } from '@or-sdk/base';
-import { FullNotificationItem, ListNotificationsParams, ListTrailParams, NewTrailEvent, NewUserNotification, NotificationItem, NotificationsConfig, SACreateNotificationParams, SAListNotifications, TrailEvent } from './types';
+import type { CreateTrailEvent, ListTrailEventsParams, NotificationsConfig, TrailEvent } from './schemas';
+import type { FullNotificationItem, ListNotificationsParams, NewUserNotification, NotificationItem, SACreateNotificationParams, SAListNotifications } from './types';
 export declare class Notifications extends Base {
+    private readonly validateInputs;
+    private readonly validateOutputs;
     constructor(params: NotificationsConfig);
     listNotifications(params?: ListNotificationsParams): Promise<NotificationItem[]>;
-    markSeen(): Promise<null>;
-    createUserNotification(data: NewUserNotification): Promise<null>;
-    SACreateNotification(params: SACreateNotificationParams): Promise<null>;
+    markSeen(): Promise<void>;
+    createUserNotification(data: NewUserNotification): Promise<void>;
+    SACreateNotification(params: SACreateNotificationParams): Promise<void>;
     SAListNotifications(params?: SAListNotifications): Promise<FullNotificationItem[]>;
-    SAUpdateNotification(id: string, data: FullNotificationItem): Promise<null>;
-    SADeleteNotification(id: string): Promise<null>;
-    createTrailEvent(data: NewTrailEvent): Promise<null>;
-    listTrailEvents(params?: ListTrailParams): Promise<TrailEvent[]>;
+    SAUpdateNotification(id: string, data: FullNotificationItem): Promise<void>;
+    SADeleteNotification(id: string): Promise<void>;
+    createTrailEvent(data: CreateTrailEvent): Promise<void>;
+    listTrailEvents(params: ListTrailEventsParams): Promise<TrailEvent[]>;
 }
 //# sourceMappingURL=Notifications.d.ts.map

package/dist/types/Notifications.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Notifications.d.ts","sourceRoot":"","sources":["../../src/Notifications.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAEpC,OAAO,EACL,oBAAoB,EACpB,uBAAuB,EACvB,eAAe,EACf,aAAa,EACb,mBAAmB,EACnB,gBAAgB,EAChB,mBAAmB,EACnB,0BAA0B,EAC1B,mBAAmB,EACnB,UAAU,EACX,MAAM,SAAS,CAAC;AASjB,qBAAa,aAAc,SAAQ,IAAI;gBAOzB,MAAM,EAAE,mBAAmB;IAkB1B,iBAAiB,CAAC,MAAM,GAAS,uBAAuB,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IActF,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAazB,sBAAsB,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAchE,oBAAoB,CAAC,MAAM,EAAE,0BAA0B,GAAG,OAAO,CAAC,IAAI,CAAC;IAcvE,mBAAmB,CAAC,MAAM,GAAS,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,EAAE,CAAC;IAcxF,oBAAoB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;IAc3E,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAa/C,gBAAgB,CAAC,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAepD,eAAe,CAAC,MAAM,GAAS,eAAe,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;CAOpF"}
+{"version":3,"file":"Notifications.d.ts","sourceRoot":"","sources":["../../src/Notifications.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AASpC,OAAO,KAAK,EACV,gBAAgB,EAChB,qBAAqB,EACrB,mBAAmB,EACnB,UAAU,EACX,MAAM,WAAW,CAAC;AACnB,OAAO,KAAK,EACV,oBAAoB,EACpB,uBAAuB,EACvB,mBAAmB,EACnB,gBAAgB,EAChB,0BAA0B,EAC1B,mBAAmB,EACpB,MAAM,SAAS,CAAC;AAWjB,qBAAa,aAAc,SAAQ,IAAI;IACrC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAU;IACzC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAU;gBAqC9B,MAAM,EAAE,mBAAmB;IAsB1B,iBAAiB,CAAC,MAAM,GAAS,uBAAuB,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IActF,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAazB,sBAAsB,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAchE,oBAAoB,CAAC,MAAM,EAAE,0BAA0B,GAAG,OAAO,CAAC,IAAI,CAAC;IAcvE,mBAAmB,CAAC,MAAM,GAAS,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,EAAE,CAAC;IAcxF,oBAAoB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;IAc3E,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAc/C,gBAAgB,CAAC,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAgBvD,eAAe,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;CASnF"}

package/dist/types/index.d.ts

@@ -1,3 +1,4 @@
-export { Notifications } from './Notifications';
+export * from './Notifications';
 export * from './types';
+export * from './schemas';
 //# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,SAAS,CAAC;AACxB,cAAc,WAAW,CAAC"}

package/dist/types/schemas/config.schema.d.ts

@@ -0,0 +1,48 @@
+import { z } from 'zod';
+export declare const notificationsConfigSchema: z.ZodUnion<[z.ZodObject<z.objectUtil.extendShape<{
+    token: z.ZodUnion<[z.ZodString, z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodString>]>;
+    accountId: z.ZodOptional<z.ZodString>;
+    validateInputs: z.ZodOptional<z.ZodBoolean>;
+    validateOutputs: z.ZodOptional<z.ZodBoolean>;
+}, {
+    discoveryUrl: z.ZodUndefined;
+    notificationsUrl: z.ZodString;
+}>, "strip", z.ZodTypeAny, {
+    token: string | ((...args: unknown[]) => string);
+    notificationsUrl: string;
+    accountId?: string | undefined;
+    validateInputs?: boolean | undefined;
+    validateOutputs?: boolean | undefined;
+    discoveryUrl?: undefined;
+}, {
+    token: string | ((...args: unknown[]) => string);
+    notificationsUrl: string;
+    accountId?: string | undefined;
+    validateInputs?: boolean | undefined;
+    validateOutputs?: boolean | undefined;
+    discoveryUrl?: undefined;
+}>, z.ZodObject<z.objectUtil.extendShape<{
+    token: z.ZodUnion<[z.ZodString, z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodString>]>;
+    accountId: z.ZodOptional<z.ZodString>;
+    validateInputs: z.ZodOptional<z.ZodBoolean>;
+    validateOutputs: z.ZodOptional<z.ZodBoolean>;
+}, {
+    discoveryUrl: z.ZodString;
+    notificationsUrl: z.ZodUndefined;
+}>, "strip", z.ZodTypeAny, {
+    token: string | ((...args: unknown[]) => string);
+    discoveryUrl: string;
+    accountId?: string | undefined;
+    validateInputs?: boolean | undefined;
+    validateOutputs?: boolean | undefined;
+    notificationsUrl?: undefined;
+}, {
+    token: string | ((...args: unknown[]) => string);
+    discoveryUrl: string;
+    accountId?: string | undefined;
+    validateInputs?: boolean | undefined;
+    validateOutputs?: boolean | undefined;
+    notificationsUrl?: undefined;
+}>]>;
+export type NotificationsConfig = z.infer<typeof notificationsConfigSchema>;
+//# sourceMappingURL=config.schema.d.ts.map

package/dist/types/schemas/config.schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.schema.d.ts","sourceRoot":"","sources":["../../../src/schemas/config.schema.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAiBxB,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAapC,CAAC;AAKH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC"}

package/dist/types/schemas/createTrailEvent.schema.d.ts

@@ -0,0 +1,72 @@
+import { z } from 'zod';
+export declare const createTrailEventSchema: z.ZodObject<{
+    service: z.ZodString;
+    data: z.ZodObject<{
+        message: z.ZodString;
+        icon: z.ZodString;
+        url: z.ZodOptional<z.ZodString>;
+        urlName: z.ZodOptional<z.ZodString>;
+        flowId: z.ZodOptional<z.ZodString>;
+        botId: z.ZodOptional<z.ZodString>;
+        'creator.name': z.ZodString;
+        'creator.userId': z.ZodOptional<z.ZodString>;
+        'creator.multiUserId': z.ZodOptional<z.ZodString>;
+        'creator.flowId': z.ZodOptional<z.ZodString>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        message: z.ZodString;
+        icon: z.ZodString;
+        url: z.ZodOptional<z.ZodString>;
+        urlName: z.ZodOptional<z.ZodString>;
+        flowId: z.ZodOptional<z.ZodString>;
+        botId: z.ZodOptional<z.ZodString>;
+        'creator.name': z.ZodString;
+        'creator.userId': z.ZodOptional<z.ZodString>;
+        'creator.multiUserId': z.ZodOptional<z.ZodString>;
+        'creator.flowId': z.ZodOptional<z.ZodString>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        message: z.ZodString;
+        icon: z.ZodString;
+        url: z.ZodOptional<z.ZodString>;
+        urlName: z.ZodOptional<z.ZodString>;
+        flowId: z.ZodOptional<z.ZodString>;
+        botId: z.ZodOptional<z.ZodString>;
+        'creator.name': z.ZodString;
+        'creator.userId': z.ZodOptional<z.ZodString>;
+        'creator.multiUserId': z.ZodOptional<z.ZodString>;
+        'creator.flowId': z.ZodOptional<z.ZodString>;
+    }, z.ZodTypeAny, "passthrough">>;
+}, "strip", z.ZodTypeAny, {
+    service: string;
+    data: {
+        message: string;
+        icon: string;
+        'creator.name': string;
+        url?: string | undefined;
+        urlName?: string | undefined;
+        flowId?: string | undefined;
+        botId?: string | undefined;
+        'creator.userId'?: string | undefined;
+        'creator.multiUserId'?: string | undefined;
+        'creator.flowId'?: string | undefined;
+    } & {
+        [k: string]: unknown;
+    };
+}, {
+    service: string;
+    data: {
+        message: string;
+        icon: string;
+        'creator.name': string;
+        url?: string | undefined;
+        urlName?: string | undefined;
+        flowId?: string | undefined;
+        botId?: string | undefined;
+        'creator.userId'?: string | undefined;
+        'creator.multiUserId'?: string | undefined;
+        'creator.flowId'?: string | undefined;
+    } & {
+        [k: string]: unknown;
+    };
+}>;
+export type CreateTrailEvent = Omit<z.infer<typeof createTrailEventSchema>, never>;
+//# sourceMappingURL=createTrailEvent.schema.d.ts.map

package/dist/types/schemas/createTrailEvent.schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createTrailEvent.schema.d.ts","sourceRoot":"","sources":["../../../src/schemas/createTrailEvent.schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAKjC,CAAC;AAEH,MAAM,MAAM,gBAAgB,GAAG,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,EAAE,KAAK,CAAC,CAAC"}

package/dist/types/schemas/index.d.ts

@@ -0,0 +1,5 @@
+export * from './config.schema';
+export * from './createTrailEvent.schema';
+export * from './listTrailEvents.schema';
+export * from './trailEvent.schema';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/schemas/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/schemas/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,0BAA0B,CAAC;AACzC,cAAc,qBAAqB,CAAC"}

package/dist/types/schemas/listTrailEvents.schema.d.ts

@@ -0,0 +1,46 @@
+import { z } from 'zod';
+export declare const listTrailEventsParamsSchema: z.ZodObject<{
+    service: z.ZodString;
+    from: z.ZodOptional<z.ZodNumber>;
+    size: z.ZodOptional<z.ZodNumber>;
+    dateFrom: z.ZodOptional<z.ZodDate>;
+    dateTo: z.ZodOptional<z.ZodDate>;
+    id: z.ZodOptional<z.ZodReadonly<z.ZodString>>;
+    userId: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+    flowId: z.ZodOptional<z.ZodString>;
+    botId: z.ZodOptional<z.ZodString>;
+    creatorName: z.ZodString;
+    creatorUserId: z.ZodOptional<z.ZodString>;
+    creatorMultiUserId: z.ZodOptional<z.ZodString>;
+    creatorFlowId: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    service: string;
+    creatorName: string;
+    flowId?: string | undefined;
+    botId?: string | undefined;
+    id?: string | undefined;
+    userId?: string | undefined;
+    from?: number | undefined;
+    size?: number | undefined;
+    dateFrom?: Date | undefined;
+    dateTo?: Date | undefined;
+    creatorUserId?: string | undefined;
+    creatorMultiUserId?: string | undefined;
+    creatorFlowId?: string | undefined;
+}, {
+    service: string;
+    creatorName: string;
+    flowId?: string | undefined;
+    botId?: string | undefined;
+    id?: string | undefined;
+    userId?: string | undefined;
+    from?: number | undefined;
+    size?: number | undefined;
+    dateFrom?: Date | undefined;
+    dateTo?: Date | undefined;
+    creatorUserId?: string | undefined;
+    creatorMultiUserId?: string | undefined;
+    creatorFlowId?: string | undefined;
+}>;
+export type ListTrailEventsParams = Omit<z.infer<typeof listTrailEventsParamsSchema>, never>;
+//# sourceMappingURL=listTrailEvents.schema.d.ts.map

package/dist/types/schemas/listTrailEvents.schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"listTrailEvents.schema.d.ts","sourceRoot":"","sources":["../../../src/schemas/listTrailEvents.schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAgCtC,CAAC;AAEH,MAAM,MAAM,qBAAqB,GAAG,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,EAAE,KAAK,CAAC,CAAC"}

package/dist/types/schemas/trailEvent.schema.d.ts

@@ -0,0 +1,120 @@
+import { z } from 'zod';
+declare const trailEventAttributesSchema: z.ZodObject<{
+    message: z.ZodString;
+    icon: z.ZodString;
+    url: z.ZodOptional<z.ZodString>;
+    urlName: z.ZodOptional<z.ZodString>;
+    flowId: z.ZodOptional<z.ZodString>;
+    botId: z.ZodOptional<z.ZodString>;
+    'creator.name': z.ZodString;
+    'creator.userId': z.ZodOptional<z.ZodString>;
+    'creator.multiUserId': z.ZodOptional<z.ZodString>;
+    'creator.flowId': z.ZodOptional<z.ZodString>;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    message: z.ZodString;
+    icon: z.ZodString;
+    url: z.ZodOptional<z.ZodString>;
+    urlName: z.ZodOptional<z.ZodString>;
+    flowId: z.ZodOptional<z.ZodString>;
+    botId: z.ZodOptional<z.ZodString>;
+    'creator.name': z.ZodString;
+    'creator.userId': z.ZodOptional<z.ZodString>;
+    'creator.multiUserId': z.ZodOptional<z.ZodString>;
+    'creator.flowId': z.ZodOptional<z.ZodString>;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    message: z.ZodString;
+    icon: z.ZodString;
+    url: z.ZodOptional<z.ZodString>;
+    urlName: z.ZodOptional<z.ZodString>;
+    flowId: z.ZodOptional<z.ZodString>;
+    botId: z.ZodOptional<z.ZodString>;
+    'creator.name': z.ZodString;
+    'creator.userId': z.ZodOptional<z.ZodString>;
+    'creator.multiUserId': z.ZodOptional<z.ZodString>;
+    'creator.flowId': z.ZodOptional<z.ZodString>;
+}, z.ZodTypeAny, "passthrough">>;
+export type TrailEventAttributes = z.infer<typeof trailEventAttributesSchema>;
+export declare const trailEventSchema: z.ZodObject<{
+    id: z.ZodReadonly<z.ZodString>;
+    name: z.ZodString;
+    accountId: z.ZodString;
+    userId: z.ZodOptional<z.ZodString>;
+    timestamp: z.ZodReadonly<z.ZodDate>;
+    attributes: z.ZodObject<{
+        message: z.ZodString;
+        icon: z.ZodString;
+        url: z.ZodOptional<z.ZodString>;
+        urlName: z.ZodOptional<z.ZodString>;
+        flowId: z.ZodOptional<z.ZodString>;
+        botId: z.ZodOptional<z.ZodString>;
+        'creator.name': z.ZodString;
+        'creator.userId': z.ZodOptional<z.ZodString>;
+        'creator.multiUserId': z.ZodOptional<z.ZodString>;
+        'creator.flowId': z.ZodOptional<z.ZodString>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        message: z.ZodString;
+        icon: z.ZodString;
+        url: z.ZodOptional<z.ZodString>;
+        urlName: z.ZodOptional<z.ZodString>;
+        flowId: z.ZodOptional<z.ZodString>;
+        botId: z.ZodOptional<z.ZodString>;
+        'creator.name': z.ZodString;
+        'creator.userId': z.ZodOptional<z.ZodString>;
+        'creator.multiUserId': z.ZodOptional<z.ZodString>;
+        'creator.flowId': z.ZodOptional<z.ZodString>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        message: z.ZodString;
+        icon: z.ZodString;
+        url: z.ZodOptional<z.ZodString>;
+        urlName: z.ZodOptional<z.ZodString>;
+        flowId: z.ZodOptional<z.ZodString>;
+        botId: z.ZodOptional<z.ZodString>;
+        'creator.name': z.ZodString;
+        'creator.userId': z.ZodOptional<z.ZodString>;
+        'creator.multiUserId': z.ZodOptional<z.ZodString>;
+        'creator.flowId': z.ZodOptional<z.ZodString>;
+    }, z.ZodTypeAny, "passthrough">>;
+}, "strip", z.ZodTypeAny, {
+    accountId: string;
+    id: string;
+    name: string;
+    timestamp: Date;
+    attributes: {
+        message: string;
+        icon: string;
+        'creator.name': string;
+        url?: string | undefined;
+        urlName?: string | undefined;
+        flowId?: string | undefined;
+        botId?: string | undefined;
+        'creator.userId'?: string | undefined;
+        'creator.multiUserId'?: string | undefined;
+        'creator.flowId'?: string | undefined;
+    } & {
+        [k: string]: unknown;
+    };
+    userId?: string | undefined;
+}, {
+    accountId: string;
+    id: string;
+    name: string;
+    timestamp: Date;
+    attributes: {
+        message: string;
+        icon: string;
+        'creator.name': string;
+        url?: string | undefined;
+        urlName?: string | undefined;
+        flowId?: string | undefined;
+        botId?: string | undefined;
+        'creator.userId'?: string | undefined;
+        'creator.multiUserId'?: string | undefined;
+        'creator.flowId'?: string | undefined;
+    } & {
+        [k: string]: unknown;
+    };
+    userId?: string | undefined;
+}>;
+export type TrailEvent = Omit<z.infer<typeof trailEventSchema>, never>;
+export {};
+//# sourceMappingURL=trailEvent.schema.d.ts.map

package/dist/types/schemas/trailEvent.schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"trailEvent.schema.d.ts","sourceRoot":"","sources":["../../../src/schemas/trailEvent.schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,QAAA,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gCAwBhB,CAAC;AAEjB,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAE9E,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAa3B,CAAC;AAEH,MAAM,MAAM,UAAU,GAAG,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,EAAE,KAAK,CAAC,CAAC"}

package/dist/types/types.d.ts

@@ -1,10 +1,3 @@
-import { Token } from '@or-sdk/base';
-export type NotificationsConfig = {
-    token: Token;
-    discoveryUrl?: string;
-    notificationsUrl?: string;
-    accountId?: string;
-};
 export type ListNotificationsParams = {
     from?: number;
     size?: number;
@@ -61,26 +54,4 @@ export type SAListNotifications = {
         tags?: string[];
     };
 };
-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;
-};
 //# sourceMappingURL=types.d.ts.map

package/dist/types/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAErC,MAAM,MAAM,mBAAmB,GAAG;IAIhC,KAAK,EAAE,KAAK,CAAC;IAIb,YAAY,CAAC,EAAE,MAAM,CAAC;IAKtB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAK1B,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAGF,MAAM,MAAM,uBAAuB,GAAG;IACpC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,gBAAgB,CAAC;IACvB,WAAW,EAAE,IAAI,CAAC;IAClB,IAAI,EAAE,OAAO,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAAC;AAE9D,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,gBAAgB,CAAC;IACvB,IAAI,EAAE,gBAAgB,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,gBAAgB,GAAG;IACpD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,gBAAgB,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,IAAI,EAAE,gBAAgB,CAAC;IACvB,IAAI,EAAE,gBAAgB,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,WAAW,CAAC,EAAE,IAAI,CAAC;IACnB,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB,CAAC;AAGF,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,gBAAgB,CAAC;IACxB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,WAAW,CAAC,EAAE,IAAI,CAAC;IACnB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,IAAI,CAAC,EAAE;QACL,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;KACjB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE;QACJ,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE;QACJ,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,WAAW,EAAE,IAAI,CAAC;CACnB,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,uBAAuB,GAAG;IACpC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,gBAAgB,CAAC;IACvB,WAAW,EAAE,IAAI,CAAC;IAClB,IAAI,EAAE,OAAO,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAAC;AAE9D,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,gBAAgB,CAAC;IACvB,IAAI,EAAE,gBAAgB,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,gBAAgB,GAAG;IACpD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,gBAAgB,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,IAAI,EAAE,gBAAgB,CAAC;IACvB,IAAI,EAAE,gBAAgB,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,WAAW,CAAC,EAAE,IAAI,CAAC;IACnB,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB,CAAC;AAGF,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,gBAAgB,CAAC;IACxB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,WAAW,CAAC,EAAE,IAAI,CAAC;IACnB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,IAAI,CAAC,EAAE;QACL,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;KACjB,CAAC;CACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@or-sdk/notifications",
-  "version": "1.1.20",
+  "version": "1.2.0",
   "license": "Apache-2.0",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -18,7 +18,8 @@
     "dev": "pnpm build:watch:esm"
   },
   "dependencies": {
-    "@or-sdk/base": "^0.39.2"
+    "@or-sdk/base": "^0.39.2",
+    "zod": "^3.22.4"
   },
   "devDependencies": {
     "concurrently": "9.0.1",
@@ -27,5 +28,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "6999b19155b0149a043762916aa6ab17c74796aa"
+  "gitHead": "def6c1982fcefc97f2f7fdad5892ec95d1535c3a"
 }

package/src/Notifications.ts

@@ -1,42 +1,89 @@
 import { Base } from '@or-sdk/base';
+
 import { SERVICE_KEY } from './constants';
 import {
+  notificationsConfigSchema,
+  createTrailEventSchema,
+  listTrailEventsParamsSchema,
+  trailEventSchema,
+} from './schemas';
+import type {
+  CreateTrailEvent,
+  ListTrailEventsParams,
+  NotificationsConfig,
+  TrailEvent,
+} from './schemas';
+import type {
   FullNotificationItem,
   ListNotificationsParams,
-  ListTrailParams,
-  NewTrailEvent,
   NewUserNotification,
   NotificationItem,
-  NotificationsConfig,
   SACreateNotificationParams,
   SAListNotifications,
-  TrailEvent,
 } from './types';
 
 /**
  * OneReach Notifications service client
- *  ## Installation:
- * ```
- * $ npm i @or-sdk/notifications
+ *
+ * ## Installation:
+ *
+ * ```sh
+ * npm i '@or-sdk/notifications'
  * ```
  */
 export class Notifications extends Base {
+  private readonly validateInputs: boolean;
+  private readonly validateOutputs: boolean;
+
   /**
+   * To create Notifications client do:
+   *
    * ```typescript
-   * import { Notifications } from '@or-sdk/notifications'
-   * const notifications = new Notifications({token: () => token', notificationsUrl: 'https://example'});
+   * import { Notifications } from '@or-sdk/notifications';
+   *
+   * const notifications = new Notifications({
+   *   token: () => token,
+   *   notificationsUrl: 'https://notifications.api.example.com',
+   * });
+   * ```
+   *
+   * or with service discovery URL:
+   *
+   * ```typescript
+   * const notifications = new Notifications({
+   *   token: () => token,
+   *   discoveryUrl: 'https://discovery.api.example.com',
+   * });
+   * ```
+   *
+   * ## Validation
+   *
+   * To disable validation of input params and/or output results do:
+   *
+   * ```typescript
+   * import { Notifications } from '@or-sdk/notifications';
+   *
+   * const notifications = new Notifications({
+   *   // ...
+   *   validateInputs: false,  // to disable validation of client methods' arguments
+   *   validateOutputs: false, // to disable validation of client methods' results
+   * });
    * ```
    */
   constructor(params: NotificationsConfig) {
-    const { token, discoveryUrl, accountId, notificationsUrl } = params;
+    const parsedParams = params.validateInputs ? notificationsConfigSchema.parse(params) : params;
+    const { token, discoveryUrl, accountId, notificationsUrl, validateInputs, validateOutputs } = parsedParams;
 
     super({
       token,
-      discoveryUrl,
+      serviceUrl: notificationsUrl,
+      discoveryUrl: discoveryUrl,
       serviceKey: SERVICE_KEY,
       accountId,
-      serviceUrl: notificationsUrl,
     });
+
+    this.validateInputs = validateInputs ?? true;
+    this.validateOutputs = validateOutputs ?? true;
   }
 
   /**
@@ -46,7 +93,7 @@ export class Notifications extends Base {
    * ```
    */
   public async listNotifications(params = {} as ListNotificationsParams): Promise<NotificationItem[]> {
-    return this.callApiV2({
+    return await this.callApiV2({
       route: '/user',
       method: 'GET',
       params,
@@ -59,8 +106,8 @@ export class Notifications extends Base {
    * await notifications.markSeen();
    * ```
    */
-  public async markSeen(): Promise<null> {
-    return this.callApiV2({
+  public async markSeen(): Promise<void> {
+    await this.callApiV2({
       route: '/user',
       method: 'POST',
     });
@@ -72,8 +119,8 @@ export class Notifications extends Base {
    * await notifications.createUserNotification({type, data});
    * ```
    */
-  public async createUserNotification(data: NewUserNotification): Promise<null> {
-    return this.callApiV2({
+  public async createUserNotification(data: NewUserNotification): Promise<void> {
+    await this.callApiV2({
       route: '/user',
       method: 'PUT',
       data,
@@ -86,8 +133,8 @@ export class Notifications extends Base {
    * await notifications.SACreateNotification({type, data, accountId, userId, dateCreated, parentId});
    * ```
    */
-  public async SACreateNotification(params: SACreateNotificationParams): Promise<null> {
-    return this.callApiV2({
+  public async SACreateNotification(params: SACreateNotificationParams): Promise<void> {
+    await this.callApiV2({
       route: '/service',
       method: 'PUT',
       data: params,
@@ -114,9 +161,9 @@ export class Notifications extends Base {
    * await notifications.SAUpdateNotification(id, {type, data, accountId, userId, dateCreated, parentId});
    * ```
    */
-  public async SAUpdateNotification(id: string, data: FullNotificationItem): Promise<null> {
-    return this.callApiV2({
-      route: `/service/${id}`,
+  public async SAUpdateNotification(id: string, data: FullNotificationItem): Promise<void> {
+    await this.callApiV2({
+      route: `/service/${encodeURIComponent(id)}`,
       method: 'POST',
       data,
     });
@@ -128,41 +175,43 @@ export class Notifications extends Base {
    * await notifications.SADeleteNotification(id);
    * ```
    */
-  public async SADeleteNotification(id: string): Promise<null> {
-    return this.callApiV2({
-      route: `/service/${id}`,
+  public async SADeleteNotification(id: string): Promise<void> {
+    await this.callApiV2({
+      route: `/service/${encodeURIComponent(id)}`,
       method: 'DELETE',
     });
   }
 
   /**
-   * Create trail event
+   * Create new trail event
+   *
    * ```typescript
-   * await notifications.createTrailEvent({service, data});
+   * await notifications.createTrailEvent({service: 'pgsql', data});
    * ```
    */
-  public async createTrailEvent(data: NewTrailEvent): Promise<null> {
-    return this.callApiV2({
-      route: `/trail/${data.service}`,
+  public async createTrailEvent(data: CreateTrailEvent): Promise<void> {
+    const parsedData = this.validateInputs ? createTrailEventSchema.parse(data) : data;
+    await this.callApiV2({
+      route: `/trail/${encodeURIComponent(parsedData.service)}`,
       method: 'PUT',
-      data: data.data,
+      data: parsedData.data,
     });
   }
 
-
   /**
-   * List trail event
+   * List trail events
+   *
    * ```typescript
-   * await notifications.listTrailEvents({size, from, service});
+   * await notifications.listTrailEvents({ service: 'pgsql' });
    * ```
    */
-  public async listTrailEvents(params = {} as ListTrailParams): Promise<TrailEvent[]> {
-    return this.callApiV2({
+  public async listTrailEvents(params: ListTrailEventsParams): Promise<TrailEvent[]> {
+    const parsedParams = this.validateInputs ? listTrailEventsParamsSchema.parse(params) : params;
+    const response = await this.callApiV2<TrailEvent[]>({
       route: '/trail',
       method: 'GET',
-      params,
+      params: parsedParams,
     });
+    return this.validateOutputs ? trailEventSchema.array().parse(response) : response;
   }
 }
-
-