vintasend 0.2.3 → 0.4.0

package/dist/services/notification-template-renderers/base-notification-template-renderer.d.ts

@@ -1,6 +1,6 @@
 import type { JsonObject } from '../../types/json-values';
-import type { Notification } from '../../types/notification';
+import type { AnyNotification } from '../../types/notification';
 import type { BaseNotificationTypeConfig } from '../../types/notification-type-config';
 export interface BaseNotificationTemplateRenderer<Config extends BaseNotificationTypeConfig, T = unknown> {
-    render(notification: Notification<Config>, context: JsonObject): Promise<T>;
+    render(notification: AnyNotification<Config>, context: JsonObject): Promise<T>;
 }

package/dist/types/attachment.d.ts

@@ -0,0 +1,42 @@
+import type { Readable } from 'node:stream';
+export type FileAttachment = Buffer | ReadableStream | Readable | string;
+export interface NotificationAttachmentUpload {
+    file: FileAttachment;
+    filename: string;
+    contentType?: string;
+    description?: string;
+}
+export interface NotificationAttachmentReference {
+    fileId: string;
+    description?: string;
+}
+export type NotificationAttachment = NotificationAttachmentUpload | NotificationAttachmentReference;
+export declare function isAttachmentReference(attachment: NotificationAttachment): attachment is NotificationAttachmentReference;
+export interface AttachmentFile {
+    read(): Promise<Buffer>;
+    stream(): Promise<ReadableStream>;
+    url(expiresIn?: number): Promise<string>;
+    delete(): Promise<void>;
+}
+export interface AttachmentFileRecord {
+    id: string;
+    filename: string;
+    contentType: string;
+    size: number;
+    checksum: string;
+    storageMetadata: Record<string, unknown>;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export interface StoredAttachment {
+    id: string;
+    fileId: string;
+    filename: string;
+    contentType: string;
+    size: number;
+    checksum: string;
+    createdAt: Date;
+    file: AttachmentFile;
+    description?: string;
+    storageMetadata: Record<string, unknown>;
+}

package/dist/types/attachment.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isAttachmentReference = isAttachmentReference;
+// Type guard to check if attachment is a reference
+function isAttachmentReference(attachment) {
+    return 'fileId' in attachment;
+}

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

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

package/dist/types/notification.d.ts

@@ -1,7 +1,10 @@
+import type { NotificationAttachment, StoredAttachment } from './attachment';
 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';
+import type { DatabaseOneOffNotification, OneOffNotification, OneOffNotificationInput } from './one-off-notification';
+export type { DatabaseOneOffNotification, OneOffNotification, OneOffNotificationInput, OneOffNotificationResendWithContextInput, } from './one-off-notification';
 export type NotificationInput<Config extends BaseNotificationTypeConfig> = {
     userId: Config['UserIdType'];
     notificationType: NotificationType;
@@ -12,6 +15,7 @@ export type NotificationInput<Config extends BaseNotificationTypeConfig> = {
     sendAfter: Date | null;
     subjectTemplate: string | null;
     extraParams: InputJsonValue | null;
+    attachments?: NotificationAttachment[];
 };
 export type NotificationResendWithContextInput<Config extends BaseNotificationTypeConfig> = {
     userId: Config['UserIdType'];
@@ -24,6 +28,7 @@ export type NotificationResendWithContextInput<Config extends BaseNotificationTy
     sendAfter: Date | null;
     subjectTemplate: string | null;
     extraParams: InputJsonValue | null;
+    attachments?: NotificationAttachment[];
 };
 export type DatabaseNotification<Config extends BaseNotificationTypeConfig> = {
     id: Config['NotificationIdType'];
@@ -43,5 +48,21 @@ export type DatabaseNotification<Config extends BaseNotificationTypeConfig> = {
     readAt: Date | null;
     createdAt?: Date;
     updatedAt?: Date;
+    attachments?: StoredAttachment[];
 };
 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> | 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> | DatabaseOneOffNotification<Config>;
+/**
+ * Union type for notification inputs only (regular or one-off).
+ * Useful for creation methods.
+ */
+export type AnyNotificationInput<Config extends BaseNotificationTypeConfig> = NotificationInput<Config> | OneOffNotificationInput<Config>;

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

@@ -0,0 +1,72 @@
+import type { NotificationAttachment, StoredAttachment } from './attachment';
+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;
+    attachments?: NotificationAttachment[];
+};
+/**
+ * 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;
+    attachments?: NotificationAttachment[];
+};
+/**
+ * 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;
+    attachments?: StoredAttachment[];
+};
+/**
+ * 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,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,16 +1,14 @@
 {
   "name": "vintasend",
-  "version": "0.2.3",
+  "version": "0.4.0",
   "main": "dist/index.js",
-  "files": [
-    "dist"
-  ],
+  "files": ["dist"],
   "author": "Hugo Bessa",
   "license": "MIT",
   "scripts": {
     "lint": "biome check .",
     "format": "biome format .",
-    "check": "biome check --apply .",
+    "check": "biome check --write .",
     "build": "tsc",
     "prepublishOnly": "npm run build",
     "test": "jest",
@@ -18,11 +16,15 @@
     "test:coverage": "jest --coverage"
   },
   "devDependencies": {
-    "@biomejs/biome": "1.9.4",
-    "@types/jest": "^29.5.14",
-    "@types/node": "^22.13.1",
-    "jest": "^29.7.0",
-    "ts-jest": "^29.2.6",
-    "typescript": "^5.8.2"
+    "@biomejs/biome": "^2.3.11",
+    "@types/jest": "^30.0.0",
+    "@types/mime-types": "^3.0.1",
+    "@types/node": "^25.0.8",
+    "jest": "^30.2.0",
+    "ts-jest": "^29.4.6",
+    "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "mime-types": "^3.0.2"
   }
 }