@goscribe/server 1.3.3 → 1.5.0

package/dist/services/notifications/notification.service.d.ts

@@ -0,0 +1,214 @@
+import type { PrismaClient } from '@prisma/client';
+import { BaseService } from '../base.service.js';
+type NotificationPriority = 'LOW' | 'NORMAL' | 'HIGH';
+export declare const NotificationType: {
+    readonly GENERAL: "GENERAL";
+    readonly USER_SIGNED_UP: "USER_SIGNED_UP";
+    readonly ACCOUNT_DELETION_SCHEDULED: "ACCOUNT_DELETION_SCHEDULED";
+    readonly ACCOUNT_PERMANENTLY_DELETED: "ACCOUNT_PERMANENTLY_DELETED";
+    readonly WORKSPACE_INVITE_RECEIVED: "WORKSPACE_INVITE_RECEIVED";
+    readonly WORKSPACE_INVITE_ACCEPTED: "WORKSPACE_INVITE_ACCEPTED";
+    readonly WORKSPACE_DELETED: "WORKSPACE_DELETED";
+    readonly PAYMENT_SUCCEEDED: "PAYMENT_SUCCEEDED";
+    readonly SUBSCRIPTION_ACTIVATED: "SUBSCRIPTION_ACTIVATED";
+    readonly SUBSCRIPTION_PAYMENT_SUCCEEDED: "SUBSCRIPTION_PAYMENT_SUCCEEDED";
+    readonly SUBSCRIPTION_CANCELED: "SUBSCRIPTION_CANCELED";
+    readonly PAYMENT_FAILED: "PAYMENT_FAILED";
+    readonly WORKSPACE_ROLE_CHANGED: "WORKSPACE_ROLE_CHANGED";
+    readonly WORKSPACE_MEMBERSHIP_REMOVED: "WORKSPACE_MEMBERSHIP_REMOVED";
+    readonly STUDY_GUIDE_COMMENT_ADDED: "STUDY_GUIDE_COMMENT_ADDED";
+    readonly ARTIFACT_READY: "ARTIFACT_READY";
+    readonly ARTIFACT_FAILED: "ARTIFACT_FAILED";
+};
+export declare function artifactTypeLabel(artifactType: string): string;
+export declare function buildArtifactActionUrl(workspaceId: string, artifactId: string | undefined, artifactType: string): string;
+type CreateNotificationInput = {
+    userId: string;
+    type: string;
+    title: string;
+    body: string;
+    actorUserId?: string;
+    workspaceId?: string;
+    actionUrl?: string;
+    metadata?: Record<string, unknown>;
+    priority?: NotificationPriority;
+    sourceId?: string;
+};
+export declare function createNotification(db: any, input: CreateNotificationInput): Promise<any>;
+export declare function createManyNotifications(db: any, inputs: CreateNotificationInput[]): Promise<any[]>;
+export declare function getSystemAdminIds(db: any): Promise<any>;
+export declare function notifyAdminsOnSignup(db: any, user: {
+    id: string;
+    name?: string | null;
+    email?: string | null;
+}): Promise<void>;
+export declare function notifyAdminsAccountDeletionScheduled(db: any, user: {
+    id: string;
+    name?: string | null;
+    email?: string | null;
+}): Promise<void>;
+export declare function notifyAdminsAccountPermanentlyDeleted(db: any, user: {
+    id: string;
+    name?: string | null;
+    email?: string | null;
+}): Promise<void>;
+export declare function notifyInviteRecipient(db: any, input: {
+    invitedUserId: string;
+    inviterUserId: string;
+    workspaceId: string;
+    workspaceTitle: string;
+    invitationId: string;
+    invitationToken: string;
+    inviterName?: string | null;
+}): Promise<void>;
+export declare function notifyInviteAccepted(db: any, input: {
+    recipientUserIds: string[];
+    actorUserId: string;
+    workspaceId: string;
+    workspaceTitle: string;
+    memberName?: string | null;
+    invitationId: string;
+}): Promise<void>;
+export declare function notifyWorkspaceDeleted(db: any, input: {
+    recipientUserIds: string[];
+    actorUserId: string;
+    actorName: string;
+    workspaceId: string;
+    workspaceTitle: string;
+}): Promise<void>;
+export declare function notifyPaymentSucceeded(db: any, input: {
+    userId: string;
+    planId?: string;
+    planName?: string;
+    stripeSessionId?: string;
+    amountPaid?: number;
+}): Promise<void>;
+export declare function notifySubscriptionActivated(db: any, input: {
+    userId: string;
+    planId?: string;
+    planName?: string;
+    stripeSubscriptionId: string;
+}): Promise<void>;
+export declare function notifySubscriptionPaymentSucceeded(db: any, input: {
+    userId: string;
+    planId?: string;
+    planName?: string;
+    stripeInvoiceId: string;
+    amountPaid?: number;
+}): Promise<void>;
+export declare function notifySubscriptionCanceled(db: any, input: {
+    userId: string;
+    planId?: string;
+    planName?: string;
+    stripeSubscriptionId: string;
+}): Promise<void>;
+export declare function notifyPaymentFailed(db: any, input: {
+    userId: string;
+    planId?: string;
+    planName?: string;
+    stripeInvoiceId?: string;
+    stripePaymentIntentId?: string;
+}): Promise<void>;
+export declare function notifyWorkspaceRoleChanged(db: any, input: {
+    memberUserId: string;
+    workspaceId: string;
+    workspaceTitle: string;
+    newRole: string;
+    oldRole: string;
+    actorUserId: string;
+    actorName: string;
+}): Promise<void>;
+export declare function notifyWorkspaceMembershipRemoved(db: any, input: {
+    memberUserId: string;
+    workspaceId: string;
+    workspaceTitle: string;
+    actorUserId: string;
+    actorName: string;
+}): Promise<void>;
+export declare function notifyStudyGuideCommentAdded(db: any, input: {
+    authorUserId: string;
+    authorName: string;
+    content: string;
+    highlightId: string;
+    commentId: string;
+    workspaceId: string;
+    artifactId: string;
+    artifactTitle: string;
+    recipientUserIds: string[];
+}): Promise<void>;
+export declare function notifyArtifactReady(db: any, input: {
+    userId: string;
+    workspaceId: string;
+    artifactId: string;
+    artifactType: string;
+    title: string;
+}): Promise<void>;
+export declare function notifyArtifactFailed(db: any, input: {
+    userId: string;
+    workspaceId: string;
+    artifactType: string;
+    title?: string;
+    artifactId?: string;
+    message: string;
+}): Promise<void>;
+/**
+ * Inbox-side operations (list, mark read, delete) used by the notifications
+ * router. Creation flows live in the standalone exported functions above and
+ * are called directly by other services.
+ */
+export declare class NotificationService extends BaseService {
+    constructor(db: PrismaClient);
+    list(userId: string, input: {
+        cursor?: string;
+        limit: number;
+        unreadOnly?: boolean;
+        types?: string[];
+    }): Promise<{
+        items: ({
+            workspace: {
+                id: string;
+                title: string;
+            } | null;
+            actor: {
+                name: string | null;
+                id: string;
+                email: string | null;
+            } | null;
+        } & {
+            id: string;
+            createdAt: Date;
+            updatedAt: Date;
+            workspaceId: string | null;
+            type: string;
+            title: string;
+            content: string | null;
+            userId: string;
+            actorUserId: string | null;
+            body: string;
+            actionUrl: string | null;
+            metadata: import("@prisma/client/runtime/library").JsonValue | null;
+            priority: import("@prisma/client").$Enums.NotificationPriority;
+            sourceId: string | null;
+            read: boolean;
+            readAt: Date | null;
+            deliveredAt: Date | null;
+        })[];
+        nextCursor: string | undefined;
+    }>;
+    unreadCount(userId: string): Promise<{
+        count: number;
+    }>;
+    markRead(userId: string, id: string): Promise<{
+        success: boolean;
+    }>;
+    markManyRead(userId: string, ids: string[]): Promise<{
+        success: boolean;
+    }>;
+    markAllRead(userId: string): Promise<{
+        success: boolean;
+    }>;
+    delete(userId: string, id: string): Promise<{
+        success: boolean;
+    }>;
+}
+export {};