vintasend-prisma 0.3.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,5 +1,7 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
1
+ Object.defineProperty(exports, '__esModule', { value: true });
3
2
  exports.PrismaNotificationBackendFactory = void 0;
4
- var prisma_notification_backend_1 = require("./prisma-notification-backend");
5
- Object.defineProperty(exports, "PrismaNotificationBackendFactory", { enumerable: true, get: function () { return prisma_notification_backend_1.PrismaNotificationBackendFactory; } });
3
+ var prisma_notification_backend_1 = require('./prisma-notification-backend');
4
+ Object.defineProperty(exports, 'PrismaNotificationBackendFactory', {
5
+ enumerable: true,
6
+ get: () => prisma_notification_backend_1.PrismaNotificationBackendFactory,
7
+ });
@@ -1,190 +1,318 @@
1
- import type { BaseNotificationBackend } from '../../../services/notification-backends/base-notification-backend';
2
1
  import type { InputJsonValue, JsonValue } from 'vintasend/dist/types/json-values';
3
- import type { DatabaseNotification, Notification, NotificationInput } from 'vintasend/dist/types/notification';
4
- import type { DatabaseOneOffNotification, OneOffNotificationInput, AnyDatabaseNotification } from '../../../types/notification';
2
+ import type {
3
+ DatabaseNotification,
4
+ Notification,
5
+ NotificationInput,
6
+ } from 'vintasend/dist/types/notification';
5
7
  import type { NotificationStatus } from 'vintasend/dist/types/notification-status';
6
8
  import type { NotificationType } from 'vintasend/dist/types/notification-type';
7
9
  import type { BaseNotificationTypeConfig } from 'vintasend/dist/types/notification-type-config';
10
+ import type { BaseNotificationBackend } from '../../../services/notification-backends/base-notification-backend';
11
+ import type {
12
+ AnyDatabaseNotification,
13
+ DatabaseOneOffNotification,
14
+ OneOffNotificationInput,
15
+ } from '../../../types/notification';
8
16
  export declare const NotificationStatusEnum: {
9
- readonly PENDING_SEND: "PENDING_SEND";
10
- readonly SENT: "SENT";
11
- readonly FAILED: "FAILED";
12
- readonly READ: "READ";
13
- readonly CANCELLED: "CANCELLED";
17
+ readonly PENDING_SEND: 'PENDING_SEND';
18
+ readonly SENT: 'SENT';
19
+ readonly FAILED: 'FAILED';
20
+ readonly READ: 'READ';
21
+ readonly CANCELLED: 'CANCELLED';
14
22
  };
15
23
  export declare const NotificationTypeEnum: {
16
- readonly EMAIL: "EMAIL";
17
- readonly PUSH: "PUSH";
18
- readonly SMS: "SMS";
19
- readonly IN_APP: "IN_APP";
24
+ readonly EMAIL: 'EMAIL';
25
+ readonly PUSH: 'PUSH';
26
+ readonly SMS: 'SMS';
27
+ readonly IN_APP: 'IN_APP';
20
28
  };
21
29
  export interface PrismaNotificationModel<IdType, UserId> {
22
- id: IdType;
23
- userId: UserId | null;
24
- emailOrPhone: string | null;
25
- firstName: string | null;
26
- lastName: string | null;
27
- notificationType: NotificationType;
28
- title: string | null;
29
- bodyTemplate: string;
30
- contextName: string;
31
- contextParameters: JsonValue;
32
- sendAfter: Date | null;
33
- subjectTemplate: string | null;
34
- status: NotificationStatus;
35
- contextUsed: JsonValue | null;
36
- extraParams: JsonValue | null;
37
- adapterUsed: string | null;
38
- sentAt: Date | null;
39
- readAt: Date | null;
40
- createdAt: Date;
41
- updatedAt: Date;
42
- user?: {
43
- email: string;
44
- };
30
+ id: IdType;
31
+ userId: UserId | null;
32
+ emailOrPhone: string | null;
33
+ firstName: string | null;
34
+ lastName: string | null;
35
+ notificationType: NotificationType;
36
+ title: string | null;
37
+ bodyTemplate: string;
38
+ contextName: string;
39
+ contextParameters: JsonValue;
40
+ sendAfter: Date | null;
41
+ subjectTemplate: string | null;
42
+ status: NotificationStatus;
43
+ contextUsed: JsonValue | null;
44
+ extraParams: JsonValue | null;
45
+ adapterUsed: string | null;
46
+ sentAt: Date | null;
47
+ readAt: Date | null;
48
+ createdAt: Date;
49
+ updatedAt: Date;
50
+ user?: {
51
+ email: string;
52
+ };
45
53
  }
46
54
  export interface NotificationPrismaClientInterface<NotificationIdType, UserIdType> {
47
- notification: {
48
- findMany(args: {
49
- where?: {
50
- status?: NotificationStatus | {
51
- not: NotificationStatus;
52
- };
53
- sendAfter?: {
54
- lte: Date;
55
- } | null;
56
- userId?: UserIdType | null;
57
- readAt?: null;
58
- emailOrPhone?: string | {
59
- not: null;
60
- };
61
- };
62
- skip?: number;
63
- take?: number;
64
- include?: {
65
- user?: boolean;
66
- };
67
- }): Promise<PrismaNotificationModel<NotificationIdType, UserIdType>[]>;
68
- create(args: {
69
- data: BaseNotificationCreateInput<UserIdType>;
70
- include?: {
71
- user?: boolean;
72
- };
73
- }): Promise<PrismaNotificationModel<NotificationIdType, UserIdType>>;
74
- createMany(args: {
75
- data: BaseNotificationCreateInput<UserIdType>[];
76
- }): Promise<NotificationIdType[]>;
77
- update(args: {
78
- where: {
79
- id: NotificationIdType;
80
- };
81
- data: Partial<BaseNotificationUpdateInput<UserIdType>>;
82
- include?: {
83
- user?: boolean;
84
- };
85
- }): Promise<PrismaNotificationModel<NotificationIdType, UserIdType>>;
86
- findUnique(args: {
87
- where: {
88
- id: NotificationIdType;
55
+ notification: {
56
+ findMany(args: {
57
+ where?: {
58
+ status?:
59
+ | NotificationStatus
60
+ | {
61
+ not: NotificationStatus;
89
62
  };
90
- include?: {
91
- user?: boolean;
63
+ sendAfter?: {
64
+ lte: Date;
65
+ } | null;
66
+ userId?: UserIdType | null;
67
+ readAt?: null;
68
+ emailOrPhone?:
69
+ | string
70
+ | {
71
+ not: null;
92
72
  };
93
- }): Promise<PrismaNotificationModel<NotificationIdType, UserIdType> | null>;
94
- };
73
+ };
74
+ skip?: number;
75
+ take?: number;
76
+ include?: {
77
+ user?: boolean;
78
+ };
79
+ }): Promise<PrismaNotificationModel<NotificationIdType, UserIdType>[]>;
80
+ create(args: {
81
+ data: BaseNotificationCreateInput<UserIdType>;
82
+ include?: {
83
+ user?: boolean;
84
+ };
85
+ }): Promise<PrismaNotificationModel<NotificationIdType, UserIdType>>;
86
+ createMany(args: {
87
+ data: BaseNotificationCreateInput<UserIdType>[];
88
+ }): Promise<NotificationIdType[]>;
89
+ update(args: {
90
+ where: {
91
+ id: NotificationIdType;
92
+ };
93
+ data: Partial<BaseNotificationUpdateInput<UserIdType>>;
94
+ include?: {
95
+ user?: boolean;
96
+ };
97
+ }): Promise<PrismaNotificationModel<NotificationIdType, UserIdType>>;
98
+ findUnique(args: {
99
+ where: {
100
+ id: NotificationIdType;
101
+ };
102
+ include?: {
103
+ user?: boolean;
104
+ };
105
+ }): Promise<PrismaNotificationModel<NotificationIdType, UserIdType> | null>;
106
+ };
95
107
  }
96
108
  type NoExpand<T> = T extends unknown ? T : never;
97
- type AtLeast<O extends object, K extends string> = NoExpand<O extends unknown ? (K extends keyof O ? {
98
- [P in K]: O[P];
99
- } & O : O) | ({
100
- [P in keyof O as P extends K ? K : never]-?: O[P];
101
- } & O) : never>;
109
+ type AtLeast<O extends object, K extends string> = NoExpand<
110
+ O extends unknown
111
+ ?
112
+ | (K extends keyof O
113
+ ? {
114
+ [P in K]: O[P];
115
+ } & O
116
+ : O)
117
+ | ({
118
+ [P in keyof O as P extends K ? K : never]-?: O[P];
119
+ } & O)
120
+ : never
121
+ >;
102
122
  export interface BaseNotificationCreateInput<UserIdType> {
103
- user?: {
104
- connect?: AtLeast<{
105
- id?: UserIdType;
106
- email?: string;
107
- }, 'id' | 'email'>;
108
- };
109
- userId?: UserIdType | null;
110
- emailOrPhone?: string | null;
111
- firstName?: string | null;
112
- lastName?: string | null;
113
- notificationType: NotificationType;
114
- title?: string | null;
115
- bodyTemplate: string;
116
- contextName: string;
117
- contextParameters: InputJsonValue;
118
- sendAfter?: Date | null;
119
- subjectTemplate?: string | null;
120
- status?: NotificationStatus;
121
- contextUsed?: InputJsonValue;
122
- extraParams?: InputJsonValue;
123
- adapterUsed?: string | null;
124
- sentAt?: Date | null;
125
- readAt?: Date | null;
123
+ user?: {
124
+ connect?: AtLeast<
125
+ {
126
+ id?: UserIdType;
127
+ email?: string;
128
+ },
129
+ 'id' | 'email'
130
+ >;
131
+ };
132
+ userId?: UserIdType | null;
133
+ emailOrPhone?: string | null;
134
+ firstName?: string | null;
135
+ lastName?: string | null;
136
+ notificationType: NotificationType;
137
+ title?: string | null;
138
+ bodyTemplate: string;
139
+ contextName: string;
140
+ contextParameters: InputJsonValue;
141
+ sendAfter?: Date | null;
142
+ subjectTemplate?: string | null;
143
+ status?: NotificationStatus;
144
+ contextUsed?: InputJsonValue;
145
+ extraParams?: InputJsonValue;
146
+ adapterUsed?: string | null;
147
+ sentAt?: Date | null;
148
+ readAt?: Date | null;
126
149
  }
127
150
  export interface BaseNotificationUpdateInput<UserIdType> {
128
- user?: {
129
- connect?: AtLeast<{
130
- id?: UserIdType;
131
- email?: string;
132
- }, 'id' | 'email'>;
133
- };
134
- emailOrPhone?: string | null;
135
- firstName?: string | null;
136
- lastName?: string | null;
137
- notificationType?: NotificationType;
138
- title?: string | null;
139
- bodyTemplate?: string;
140
- contextName?: string;
141
- contextParameters?: InputJsonValue;
142
- sendAfter?: Date | null;
143
- subjectTemplate?: string | null;
144
- status?: NotificationStatus;
145
- contextUsed?: InputJsonValue;
146
- extraParams?: InputJsonValue;
147
- adapterUsed?: string | null;
148
- sentAt?: Date | null;
149
- readAt?: Date | null;
151
+ user?: {
152
+ connect?: AtLeast<
153
+ {
154
+ id?: UserIdType;
155
+ email?: string;
156
+ },
157
+ 'id' | 'email'
158
+ >;
159
+ };
160
+ emailOrPhone?: string | null;
161
+ firstName?: string | null;
162
+ lastName?: string | null;
163
+ notificationType?: NotificationType;
164
+ title?: string | null;
165
+ bodyTemplate?: string;
166
+ contextName?: string;
167
+ contextParameters?: InputJsonValue;
168
+ sendAfter?: Date | null;
169
+ subjectTemplate?: string | null;
170
+ status?: NotificationStatus;
171
+ contextUsed?: InputJsonValue;
172
+ extraParams?: InputJsonValue;
173
+ adapterUsed?: string | null;
174
+ sentAt?: Date | null;
175
+ readAt?: Date | null;
150
176
  }
151
- export declare class PrismaNotificationBackend<Client extends NotificationPrismaClientInterface<Config['NotificationIdType'], Config['UserIdType']>, Config extends BaseNotificationTypeConfig> implements BaseNotificationBackend<Config> {
152
- private prismaClient;
153
- constructor(prismaClient: Client);
154
- /**
155
- * Serialize a Prisma notification model to either DatabaseNotification or DatabaseOneOffNotification
156
- * based on whether it has a userId or not
157
- */
158
- serializeNotification(notification: NonNullable<Awaited<ReturnType<typeof this.prismaClient.notification.findUnique>>>): AnyDatabaseNotification<Config>;
159
- deserializeNotification(notification: NotificationInput<Config>): BaseNotificationCreateInput<Config['UserIdType']>;
160
- deserializeNotificationForUpdate(notification: Partial<Notification<Config>>): Partial<Parameters<typeof this.prismaClient.notification.update>[0]['data']>;
161
- getAllPendingNotifications(): Promise<AnyDatabaseNotification<Config>[]>;
162
- getPendingNotifications(page?: number, pageSize?: number): Promise<AnyDatabaseNotification<Config>[]>;
163
- getAllFutureNotifications(): Promise<AnyDatabaseNotification<Config>[]>;
164
- getFutureNotifications(page?: number, pageSize?: number): Promise<AnyDatabaseNotification<Config>[]>;
165
- getAllFutureNotificationsFromUser(userId: NonNullable<Awaited<ReturnType<typeof this.prismaClient.notification.findUnique>>>['userId']): Promise<DatabaseNotification<Config>[]>;
166
- getFutureNotificationsFromUser(userId: NonNullable<Awaited<ReturnType<typeof this.prismaClient.notification.findUnique>>>['userId'], page: number, pageSize: number): Promise<DatabaseNotification<Config>[]>;
167
- getAllNotifications(): Promise<AnyDatabaseNotification<Config>[]>;
168
- getNotifications(page: number, pageSize: number): Promise<AnyDatabaseNotification<Config>[]>;
169
- persistNotification(notification: NotificationInput<Config>): Promise<DatabaseNotification<Config>>;
170
- persistNotificationUpdate(notificationId: NonNullable<Awaited<ReturnType<typeof this.prismaClient.notification.findUnique>>>['id'], notification: Partial<Omit<DatabaseNotification<Config>, 'id'>>): Promise<DatabaseNotification<Config>>;
171
- persistOneOffNotification(notification: OneOffNotificationInput<Config>): Promise<DatabaseOneOffNotification<Config>>;
172
- persistOneOffNotificationUpdate(notificationId: NonNullable<Awaited<ReturnType<typeof this.prismaClient.notification.findUnique>>>['id'], notification: Partial<Omit<DatabaseOneOffNotification<Config>, 'id'>>): Promise<DatabaseOneOffNotification<Config>>;
173
- getOneOffNotification(notificationId: NonNullable<Awaited<ReturnType<typeof this.prismaClient.notification.findUnique>>>['id'], _forUpdate: boolean): Promise<DatabaseOneOffNotification<Config> | null>;
174
- getAllOneOffNotifications(): Promise<DatabaseOneOffNotification<Config>[]>;
175
- getOneOffNotifications(page: number, pageSize: number): Promise<DatabaseOneOffNotification<Config>[]>;
176
- markAsSent(notificationId: NonNullable<Awaited<ReturnType<typeof this.prismaClient.notification.findUnique>>>['id'], checkIsPending?: boolean): Promise<AnyDatabaseNotification<Config>>;
177
- markAsFailed(notificationId: NonNullable<Awaited<ReturnType<typeof this.prismaClient.notification.findUnique>>>['id'], checkIsPending?: boolean): Promise<AnyDatabaseNotification<Config>>;
178
- markAsRead(notificationId: NonNullable<Awaited<ReturnType<typeof this.prismaClient.notification.findUnique>>>['id'], checkIsSent?: boolean): Promise<DatabaseNotification<Config>>;
179
- cancelNotification(notificationId: NonNullable<Awaited<ReturnType<typeof this.prismaClient.notification.findUnique>>>['id']): Promise<void>;
180
- getNotification(notificationId: NonNullable<Awaited<ReturnType<typeof this.prismaClient.notification.findUnique>>>['id'], _forUpdate: boolean): Promise<AnyDatabaseNotification<Config> | null>;
181
- filterAllInAppUnreadNotifications(userId: NonNullable<Awaited<ReturnType<typeof this.prismaClient.notification.findUnique>>>['userId']): Promise<DatabaseNotification<Config>[]>;
182
- filterInAppUnreadNotifications(userId: NonNullable<Awaited<ReturnType<typeof this.prismaClient.notification.findUnique>>>['userId'], page: number, pageSize: number): Promise<DatabaseNotification<Config>[]>;
183
- getUserEmailFromNotification(notificationId: NonNullable<Awaited<ReturnType<typeof this.prismaClient.notification.findUnique>>>['id']): Promise<string | undefined>;
184
- storeContextUsed(notificationId: NonNullable<Awaited<ReturnType<typeof this.prismaClient.notification.findUnique>>>['id'], context: InputJsonValue): Promise<void>;
185
- bulkPersistNotifications(notifications: Omit<Notification<Config>, 'id'>[]): Promise<Config['NotificationIdType'][]>;
177
+ export declare class PrismaNotificationBackend<
178
+ Client extends NotificationPrismaClientInterface<
179
+ Config['NotificationIdType'],
180
+ Config['UserIdType']
181
+ >,
182
+ Config extends BaseNotificationTypeConfig,
183
+ > implements BaseNotificationBackend<Config>
184
+ {
185
+ private prismaClient;
186
+ constructor(prismaClient: Client);
187
+ /**
188
+ * Serialize a Prisma notification model to either DatabaseNotification or DatabaseOneOffNotification
189
+ * based on whether it has a userId or not
190
+ */
191
+ serializeNotification(
192
+ notification: NonNullable<
193
+ Awaited<ReturnType<typeof this.prismaClient.notification.findUnique>>
194
+ >,
195
+ ): AnyDatabaseNotification<Config>;
196
+ deserializeNotification(
197
+ notification: NotificationInput<Config>,
198
+ ): BaseNotificationCreateInput<Config['UserIdType']>;
199
+ deserializeNotificationForUpdate(
200
+ notification: Partial<Notification<Config>>,
201
+ ): Partial<Parameters<typeof this.prismaClient.notification.update>[0]['data']>;
202
+ getAllPendingNotifications(): Promise<AnyDatabaseNotification<Config>[]>;
203
+ getPendingNotifications(
204
+ page?: number,
205
+ pageSize?: number,
206
+ ): Promise<AnyDatabaseNotification<Config>[]>;
207
+ getAllFutureNotifications(): Promise<AnyDatabaseNotification<Config>[]>;
208
+ getFutureNotifications(
209
+ page?: number,
210
+ pageSize?: number,
211
+ ): Promise<AnyDatabaseNotification<Config>[]>;
212
+ getAllFutureNotificationsFromUser(
213
+ userId: NonNullable<
214
+ Awaited<ReturnType<typeof this.prismaClient.notification.findUnique>>
215
+ >['userId'],
216
+ ): Promise<DatabaseNotification<Config>[]>;
217
+ getFutureNotificationsFromUser(
218
+ userId: NonNullable<
219
+ Awaited<ReturnType<typeof this.prismaClient.notification.findUnique>>
220
+ >['userId'],
221
+ page: number,
222
+ pageSize: number,
223
+ ): Promise<DatabaseNotification<Config>[]>;
224
+ getAllNotifications(): Promise<AnyDatabaseNotification<Config>[]>;
225
+ getNotifications(page: number, pageSize: number): Promise<AnyDatabaseNotification<Config>[]>;
226
+ persistNotification(
227
+ notification: NotificationInput<Config>,
228
+ ): Promise<DatabaseNotification<Config>>;
229
+ persistNotificationUpdate(
230
+ notificationId: NonNullable<
231
+ Awaited<ReturnType<typeof this.prismaClient.notification.findUnique>>
232
+ >['id'],
233
+ notification: Partial<Omit<DatabaseNotification<Config>, 'id'>>,
234
+ ): Promise<DatabaseNotification<Config>>;
235
+ persistOneOffNotification(
236
+ notification: OneOffNotificationInput<Config>,
237
+ ): Promise<DatabaseOneOffNotification<Config>>;
238
+ persistOneOffNotificationUpdate(
239
+ notificationId: NonNullable<
240
+ Awaited<ReturnType<typeof this.prismaClient.notification.findUnique>>
241
+ >['id'],
242
+ notification: Partial<Omit<DatabaseOneOffNotification<Config>, 'id'>>,
243
+ ): Promise<DatabaseOneOffNotification<Config>>;
244
+ getOneOffNotification(
245
+ notificationId: NonNullable<
246
+ Awaited<ReturnType<typeof this.prismaClient.notification.findUnique>>
247
+ >['id'],
248
+ _forUpdate: boolean,
249
+ ): Promise<DatabaseOneOffNotification<Config> | null>;
250
+ getAllOneOffNotifications(): Promise<DatabaseOneOffNotification<Config>[]>;
251
+ getOneOffNotifications(
252
+ page: number,
253
+ pageSize: number,
254
+ ): Promise<DatabaseOneOffNotification<Config>[]>;
255
+ markAsSent(
256
+ notificationId: NonNullable<
257
+ Awaited<ReturnType<typeof this.prismaClient.notification.findUnique>>
258
+ >['id'],
259
+ checkIsPending?: boolean,
260
+ ): Promise<AnyDatabaseNotification<Config>>;
261
+ markAsFailed(
262
+ notificationId: NonNullable<
263
+ Awaited<ReturnType<typeof this.prismaClient.notification.findUnique>>
264
+ >['id'],
265
+ checkIsPending?: boolean,
266
+ ): Promise<AnyDatabaseNotification<Config>>;
267
+ markAsRead(
268
+ notificationId: NonNullable<
269
+ Awaited<ReturnType<typeof this.prismaClient.notification.findUnique>>
270
+ >['id'],
271
+ checkIsSent?: boolean,
272
+ ): Promise<DatabaseNotification<Config>>;
273
+ cancelNotification(
274
+ notificationId: NonNullable<
275
+ Awaited<ReturnType<typeof this.prismaClient.notification.findUnique>>
276
+ >['id'],
277
+ ): Promise<void>;
278
+ getNotification(
279
+ notificationId: NonNullable<
280
+ Awaited<ReturnType<typeof this.prismaClient.notification.findUnique>>
281
+ >['id'],
282
+ _forUpdate: boolean,
283
+ ): Promise<AnyDatabaseNotification<Config> | null>;
284
+ filterAllInAppUnreadNotifications(
285
+ userId: NonNullable<
286
+ Awaited<ReturnType<typeof this.prismaClient.notification.findUnique>>
287
+ >['userId'],
288
+ ): Promise<DatabaseNotification<Config>[]>;
289
+ filterInAppUnreadNotifications(
290
+ userId: NonNullable<
291
+ Awaited<ReturnType<typeof this.prismaClient.notification.findUnique>>
292
+ >['userId'],
293
+ page: number,
294
+ pageSize: number,
295
+ ): Promise<DatabaseNotification<Config>[]>;
296
+ getUserEmailFromNotification(
297
+ notificationId: NonNullable<
298
+ Awaited<ReturnType<typeof this.prismaClient.notification.findUnique>>
299
+ >['id'],
300
+ ): Promise<string | undefined>;
301
+ storeContextUsed(
302
+ notificationId: NonNullable<
303
+ Awaited<ReturnType<typeof this.prismaClient.notification.findUnique>>
304
+ >['id'],
305
+ context: InputJsonValue,
306
+ ): Promise<void>;
307
+ bulkPersistNotifications(
308
+ notifications: Omit<Notification<Config>, 'id'>[],
309
+ ): Promise<Config['NotificationIdType'][]>;
186
310
  }
187
311
  export declare class PrismaNotificationBackendFactory<Config extends BaseNotificationTypeConfig> {
188
- create<Client extends NotificationPrismaClientInterface<Config['NotificationIdType'], Config['UserIdType']>>(prismaClient: Client): PrismaNotificationBackend<Client, Config>;
312
+ create<
313
+ Client extends NotificationPrismaClientInterface<
314
+ Config['NotificationIdType'],
315
+ Config['UserIdType']
316
+ >,
317
+ >(prismaClient: Client): PrismaNotificationBackend<Client, Config>;
189
318
  }
190
- export {};