vintasend-prisma 0.2.3 → 0.4.0

package/dist/services/notification-backends/base-notification-backend.d.ts

@@ -0,0 +1,89 @@
+import type { InputJsonValue } from '../../types/json-values';
+import type {
+  AnyDatabaseNotification,
+  DatabaseNotification,
+  DatabaseOneOffNotification,
+  Notification,
+  OneOffNotificationInput,
+} from '../../types/notification';
+import type { BaseNotificationTypeConfig } from '../../types/notification-type-config';
+export interface BaseNotificationBackend<Config extends BaseNotificationTypeConfig> {
+  getAllPendingNotifications(): Promise<AnyDatabaseNotification<Config>[]>;
+  getPendingNotifications(
+    page: number,
+    pageSize: number,
+  ): Promise<AnyDatabaseNotification<Config>[]>;
+  getAllFutureNotifications(): Promise<AnyDatabaseNotification<Config>[]>;
+  getFutureNotifications(
+    page: number,
+    pageSize: number,
+  ): Promise<AnyDatabaseNotification<Config>[]>;
+  getAllFutureNotificationsFromUser(
+    userId: Config['UserIdType'],
+  ): Promise<DatabaseNotification<Config>[]>;
+  getFutureNotificationsFromUser(
+    userId: Config['UserIdType'],
+    page: number,
+    pageSize: number,
+  ): Promise<DatabaseNotification<Config>[]>;
+  persistNotification(
+    notification: Omit<Notification<Config>, 'id'>,
+  ): Promise<DatabaseNotification<Config>>;
+  getAllNotifications(): Promise<AnyDatabaseNotification<Config>[]>;
+  getNotifications(page: number, pageSize: number): Promise<AnyDatabaseNotification<Config>[]>;
+  bulkPersistNotifications(
+    notifications: Omit<Notification<Config>, 'id'>[],
+  ): Promise<Config['NotificationIdType'][]>;
+  persistNotificationUpdate(
+    notificationId: Config['NotificationIdType'],
+    notification: Partial<Omit<Notification<Config>, 'id'>>,
+  ): Promise<DatabaseNotification<Config>>;
+  markAsSent(
+    notificationId: Config['NotificationIdType'],
+    checkIsPending: boolean,
+  ): Promise<AnyDatabaseNotification<Config>>;
+  markAsFailed(
+    notificationId: Config['NotificationIdType'],
+    checkIsPending: boolean,
+  ): Promise<AnyDatabaseNotification<Config>>;
+  markAsRead(
+    notificationId: Config['NotificationIdType'],
+    checkIsSent: boolean,
+  ): Promise<DatabaseNotification<Config>>;
+  cancelNotification(notificationId: Config['NotificationIdType']): Promise<void>;
+  getNotification(
+    notificationId: Config['NotificationIdType'],
+    forUpdate: boolean,
+  ): Promise<AnyDatabaseNotification<Config> | null>;
+  filterAllInAppUnreadNotifications(
+    userId: Config['UserIdType'],
+  ): Promise<DatabaseNotification<Config>[]>;
+  filterInAppUnreadNotifications(
+    userId: Config['UserIdType'],
+    page: number,
+    pageSize: number,
+  ): Promise<DatabaseNotification<Config>[]>;
+  getUserEmailFromNotification(
+    notificationId: Config['NotificationIdType'],
+  ): Promise<string | undefined>;
+  storeContextUsed(
+    notificationId: Config['NotificationIdType'],
+    context: InputJsonValue,
+  ): Promise<void>;
+  persistOneOffNotification(
+    notification: Omit<OneOffNotificationInput<Config>, 'id'>,
+  ): Promise<DatabaseOneOffNotification<Config>>;
+  persistOneOffNotificationUpdate(
+    notificationId: Config['NotificationIdType'],
+    notification: Partial<Omit<OneOffNotificationInput<Config>, 'id'>>,
+  ): Promise<DatabaseOneOffNotification<Config>>;
+  getOneOffNotification(
+    notificationId: Config['NotificationIdType'],
+    forUpdate: boolean,
+  ): Promise<DatabaseOneOffNotification<Config> | null>;
+  getAllOneOffNotifications(): Promise<DatabaseOneOffNotification<Config>[]>;
+  getOneOffNotifications(
+    page: number,
+    pageSize: number,
+  ): Promise<DatabaseOneOffNotification<Config>[]>;
+}

package/dist/services/notification-backends/base-notification-backend.js

@@ -0,0 +1 @@
+Object.defineProperty(exports, '__esModule', { value: true });

package/dist/types/identifier.d.ts

@@ -0,0 +1,2 @@
+import type { UUID } from './uuid';
+export type Identifier = string | number | UUID;

package/dist/types/identifier.js

@@ -0,0 +1 @@
+Object.defineProperty(exports, '__esModule', { value: true });

package/dist/types/json-values.d.ts

@@ -0,0 +1,19 @@
+export type JsonPrimitive = string | number | boolean | null;
+export interface JsonArray extends Array<JsonValue> {}
+export type JsonObject = {
+  [Key in string]?: JsonValue;
+};
+export type JsonValue = string | number | boolean | JsonObject | JsonArray | null;
+export type InputJsonObject = {
+  readonly [Key in string]?: InputJsonValue | null;
+};
+export interface InputJsonArray extends ReadonlyArray<InputJsonValue | null> {}
+export type InputJsonValue =
+  | string
+  | number
+  | boolean
+  | InputJsonObject
+  | InputJsonArray
+  | {
+      toJSON(): unknown;
+    };

package/dist/types/json-values.js

@@ -0,0 +1 @@
+Object.defineProperty(exports, '__esModule', { value: true });

package/dist/types/notification-context-generators.d.ts

@@ -0,0 +1,6 @@
+import type { JsonObject, JsonPrimitive } from './json-values';
+export interface ContextGenerator<
+  Params extends Record<string, JsonPrimitive> = Record<string, JsonPrimitive>,
+> {
+  generate(params: Params): JsonObject | Promise<JsonObject>;
+}

package/dist/types/notification-context-generators.js

@@ -0,0 +1 @@
+Object.defineProperty(exports, '__esModule', { value: true });

package/dist/types/notification-status.d.ts

@@ -0,0 +1 @@
+export type NotificationStatus = 'PENDING_SEND' | 'SENT' | 'FAILED' | 'READ' | 'CANCELLED';

package/dist/types/notification-status.js

@@ -0,0 +1 @@
+Object.defineProperty(exports, '__esModule', { value: true });

package/dist/types/notification-type-config.d.ts

@@ -0,0 +1,7 @@
+import type { Identifier } from './identifier';
+import type { ContextGenerator } from './notification-context-generators';
+export type BaseNotificationTypeConfig = {
+  ContextMap: Record<string, ContextGenerator>;
+  NotificationIdType: Identifier;
+  UserIdType: Identifier;
+};

package/dist/types/notification-type-config.js

@@ -0,0 +1 @@
+Object.defineProperty(exports, '__esModule', { value: true });

package/dist/types/notification-type.d.ts

@@ -0,0 +1 @@
+export type NotificationType = 'PUSH' | 'EMAIL' | 'SMS' | 'IN_APP';

package/dist/types/notification-type.js

@@ -0,0 +1 @@
+Object.defineProperty(exports, '__esModule', { value: true });

package/dist/types/notification.d.ts

@@ -0,0 +1,97 @@
+import type { InputJsonValue, JsonValue } from './json-values';
+import type { NotificationStatus } from './notification-status';
+import type { NotificationType } from './notification-type';
+import type { BaseNotificationTypeConfig } from './notification-type-config';
+export type {
+  OneOffNotificationInput,
+  OneOffNotificationResendWithContextInput,
+  DatabaseOneOffNotification,
+  OneOffNotification,
+} from './one-off-notification';
+export type NotificationInput<Config extends BaseNotificationTypeConfig> = {
+  userId: Config['UserIdType'];
+  notificationType: NotificationType;
+  title: string | null;
+  bodyTemplate: string;
+  contextName: string & keyof Config['ContextMap'];
+  contextParameters: Parameters<
+    Config['ContextMap'][NotificationInput<Config>['contextName']]['generate']
+  >[0];
+  sendAfter: Date | null;
+  subjectTemplate: string | null;
+  extraParams: InputJsonValue | null;
+};
+export type NotificationResendWithContextInput<Config extends BaseNotificationTypeConfig> = {
+  userId: Config['UserIdType'];
+  notificationType: NotificationType;
+  title: string | null;
+  bodyTemplate: string;
+  contextName: string & keyof Config['ContextMap'];
+  contextParameters: Parameters<
+    Config['ContextMap'][NotificationResendWithContextInput<Config>['contextName']]['generate']
+  >[0];
+  contextUsed: ReturnType<
+    Config['ContextMap'][NotificationResendWithContextInput<Config>['contextName']]['generate']
+  > extends Promise<infer T>
+    ? T
+    : ReturnType<
+        Config['ContextMap'][NotificationResendWithContextInput<Config>['contextName']]['generate']
+      >;
+  sendAfter: Date | null;
+  subjectTemplate: string | null;
+  extraParams: InputJsonValue | null;
+};
+export type DatabaseNotification<Config extends BaseNotificationTypeConfig> = {
+  id: Config['NotificationIdType'];
+  userId: Config['UserIdType'];
+  notificationType: NotificationType;
+  title: string | null;
+  bodyTemplate: string;
+  contextName: string & keyof Config['ContextMap'];
+  contextParameters: Parameters<
+    Config['ContextMap'][DatabaseNotification<Config>['contextName']]['generate']
+  >[0];
+  sendAfter: Date | null;
+  subjectTemplate: string | null;
+  status: NotificationStatus;
+  contextUsed:
+    | null
+    | (ReturnType<
+        Config['ContextMap'][DatabaseNotification<Config>['contextName']]['generate']
+      > extends Promise<infer T>
+        ? T
+        : ReturnType<
+            Config['ContextMap'][DatabaseNotification<Config>['contextName']]['generate']
+          >);
+  extraParams: JsonValue;
+  adapterUsed: string | null;
+  sentAt: Date | null;
+  readAt: Date | null;
+  createdAt?: Date;
+  updatedAt?: Date;
+};
+export type Notification<Config extends BaseNotificationTypeConfig> =
+  | NotificationInput<Config>
+  | NotificationResendWithContextInput<Config>
+  | DatabaseNotification<Config>;
+/**
+ * Union type representing any notification type (regular or one-off).
+ * This is useful for methods that handle both notification types.
+ */
+export type AnyNotification<Config extends BaseNotificationTypeConfig> =
+  | Notification<Config>
+  | import('./one-off-notification').OneOffNotification<Config>;
+/**
+ * Union type for database notifications only (regular or one-off).
+ * Useful for send methods and database queries.
+ */
+export type AnyDatabaseNotification<Config extends BaseNotificationTypeConfig> =
+  | DatabaseNotification<Config>
+  | import('./one-off-notification').DatabaseOneOffNotification<Config>;
+/**
+ * Union type for notification inputs only (regular or one-off).
+ * Useful for creation methods.
+ */
+export type AnyNotificationInput<Config extends BaseNotificationTypeConfig> =
+  | NotificationInput<Config>
+  | import('./one-off-notification').OneOffNotificationInput<Config>;

package/dist/types/notification.js

@@ -0,0 +1 @@
+Object.defineProperty(exports, '__esModule', { value: true });

package/dist/types/one-off-notification.d.ts

@@ -0,0 +1,91 @@
+import type { InputJsonValue, JsonValue } from './json-values';
+import type { NotificationStatus } from './notification-status';
+import type { NotificationType } from './notification-type';
+import type { BaseNotificationTypeConfig } from './notification-type-config';
+/**
+ * Input type for creating a one-off notification.
+ * One-off notifications are sent directly to an email/phone without requiring a user account.
+ */
+export type OneOffNotificationInput<Config extends BaseNotificationTypeConfig> = {
+  emailOrPhone: string;
+  firstName: string;
+  lastName: string;
+  notificationType: NotificationType;
+  title: string | null;
+  bodyTemplate: string;
+  contextName: string & keyof Config['ContextMap'];
+  contextParameters: Parameters<
+    Config['ContextMap'][OneOffNotificationInput<Config>['contextName']]['generate']
+  >[0];
+  sendAfter: Date | null;
+  subjectTemplate: string | null;
+  extraParams: InputJsonValue | null;
+};
+/**
+ * Input type for resending a one-off notification with stored context.
+ * Similar to OneOffNotificationInput but includes the contextUsed field.
+ */
+export type OneOffNotificationResendWithContextInput<Config extends BaseNotificationTypeConfig> = {
+  emailOrPhone: string;
+  firstName: string;
+  lastName: string;
+  notificationType: NotificationType;
+  title: string | null;
+  bodyTemplate: string;
+  contextName: string & keyof Config['ContextMap'];
+  contextParameters: Parameters<
+    Config['ContextMap'][OneOffNotificationResendWithContextInput<Config>['contextName']]['generate']
+  >[0];
+  contextUsed: ReturnType<
+    Config['ContextMap'][OneOffNotificationResendWithContextInput<Config>['contextName']]['generate']
+  > extends Promise<infer T>
+    ? T
+    : ReturnType<
+        Config['ContextMap'][OneOffNotificationResendWithContextInput<Config>['contextName']]['generate']
+      >;
+  sendAfter: Date | null;
+  subjectTemplate: string | null;
+  extraParams: InputJsonValue | null;
+};
+/**
+ * Database representation of a one-off notification.
+ * Includes all fields from input plus database-managed fields (id, status, timestamps, etc.)
+ */
+export type DatabaseOneOffNotification<Config extends BaseNotificationTypeConfig> = {
+  id: Config['NotificationIdType'];
+  emailOrPhone: string;
+  firstName: string;
+  lastName: string;
+  notificationType: NotificationType;
+  title: string | null;
+  bodyTemplate: string;
+  contextName: string & keyof Config['ContextMap'];
+  contextParameters: Parameters<
+    Config['ContextMap'][DatabaseOneOffNotification<Config>['contextName']]['generate']
+  >[0];
+  sendAfter: Date | null;
+  subjectTemplate: string | null;
+  status: NotificationStatus;
+  contextUsed:
+    | null
+    | (ReturnType<
+        Config['ContextMap'][DatabaseOneOffNotification<Config>['contextName']]['generate']
+      > extends Promise<infer T>
+        ? T
+        : ReturnType<
+            Config['ContextMap'][DatabaseOneOffNotification<Config>['contextName']]['generate']
+          >);
+  extraParams: JsonValue;
+  adapterUsed: string | null;
+  sentAt: Date | null;
+  readAt: Date | null;
+  createdAt?: Date;
+  updatedAt?: Date;
+};
+/**
+ * Union type representing any one-off notification (input, resend, or database).
+ */
+export type OneOffNotification<Config extends BaseNotificationTypeConfig> =
+  | OneOffNotificationInput<Config>
+  | OneOffNotificationResendWithContextInput<Config>
+  | DatabaseOneOffNotification<Config>;

package/dist/types/one-off-notification.js

@@ -0,0 +1 @@
+Object.defineProperty(exports, '__esModule', { value: true });

package/dist/types/uuid.d.ts

@@ -0,0 +1 @@
+export type UUID = `${string}-${string}-${string}-${string}-${string}`;

package/dist/types/uuid.js

@@ -0,0 +1 @@
+Object.defineProperty(exports, '__esModule', { value: true });

package/package.json

@@ -1,29 +1,27 @@
-{
-  "name": "vintasend-prisma",
-  "version": "0.2.3",
-  "description": "VintaSend Backend implementation for Prisma",
-  "main": "dist/index.js",
-  "scripts": {
-    "build": "tsc",
-    "prepublishOnly": "npm run build",
-    "test": "jest",
-    "test:watch": "jest --watch",
-    "test:coverage": "jest --coverage"
-  },
-  "files": [
-    "dist"
-  ],
-  "author": "Hugo Bessa",
-  "license": "MIT",
-  "dependencies": {
-    "@prisma/client": "^6.3.1",
-    "prisma": "^6.3.1",
-    "vintasend": "^0.2.3"
-  },
-  "devDependencies": {
-    "@types/jest": "^29.5.14",
-    "jest": "^29.7.0",
-    "ts-jest": "^29.2.6",
-    "typescript": "^5.8.2"
-  }
-}
+{
+  "name": "vintasend-prisma",
+  "version": "0.4.0",
+  "description": "VintaSend Backend implementation for Prisma",
+  "main": "dist/index.js",
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --coverage"
+  },
+  "files": ["dist"],
+  "author": "Hugo Bessa",
+  "license": "MIT",
+  "dependencies": {
+    "@prisma/client": "^6.3.1",
+    "prisma": "^6.3.1",
+    "vintasend": "^0.4.0"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.14",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.2.6",
+    "typescript": "^5.8.2"
+  }
+}