@erxes/api-shared 0.0.0-stage → 3.2.19-1

package/src/core-modules/logs/definitions/activityLog.ts

@@ -0,0 +1,71 @@
+import { Document, Schema } from 'mongoose';
+
+export interface TActivityEntity<TData = any> {
+  moduleName: string;
+  collectionName: string;
+  text?: string;
+  data?: TData;
+}
+
+export type TActivityLog<
+  TTarget = any,
+  TContext = TActivityEntity,
+  TActor = any,
+> = {
+  createdAt: Date;
+  activityType: string;
+  sourcePlugin?: string;
+  actorType: string;
+  actor: TActor;
+  targetType: string;
+  target: TTarget;
+  contextType: string;
+  context: TContext;
+  action: {
+    type: string;
+    description: string;
+  };
+  changes: any;
+  metadata?: any;
+};
+
+export type IActivityLogDocument = TActivityLog & {
+  _id: string;
+} & Document;
+
+const entitySchema = new Schema(
+  {
+    moduleName: { type: String },
+    collectionName: { type: String },
+    text: { type: String },
+    data: { type: Schema.Types.Mixed },
+  },
+  { _id: false },
+);
+
+const activityActionSchema = new Schema(
+  {
+    type: { type: String, required: true },
+    description: { type: String, required: true },
+  },
+  { _id: false },
+);
+
+export const activityLogsSchema = new Schema({
+  createdAt: { type: Date, required: true, default: Date.now },
+  activityType: { type: String, required: true },
+  sourcePlugin: { type: String },
+  actorType: { type: String, required: true },
+  actor: { type: Object, required: true },
+  targetId: { type: String, required: true, index: true },
+  targetType: { type: String, required: true },
+  target: { type: Schema.Types.Mixed, required: true },
+  contextType: { type: String, optional: true },
+  context: { type: Schema.Types.Mixed, optional: true },
+  action: {
+    type: activityActionSchema,
+    required: true,
+  },
+  changes: { type: Schema.Types.Mixed, required: true },
+  metadata: { type: Schema.Types.Mixed },
+});

package/src/core-modules/logs/definitions/logs.ts

@@ -0,0 +1,49 @@
+import { Schema } from 'mongoose';
+const LOG_RETENTION_SECONDS =
+  Number(process.env.LOG_RETENTION_DAYS || '365') * 24 * 60 * 60;
+
+export const logsSchema = new Schema(
+  {
+    source: { type: String, label: 'Source' },
+    status: { type: String, enum: ['success', 'failed'], required: true },
+    createdAt: {
+      type: Date,
+      label: 'Created At',
+      default: Date.now,
+      required: true,
+    },
+    userId: { type: String, label: 'User Id' },
+    docId: { type: String },
+    payload: { type: Schema.Types.Mixed },
+    action: { type: String, label: 'action' },
+    processId: { type: String, label: 'Process' },
+    contentType: { type: String, label: 'Content Type' },
+  },
+  {
+    minimize: true,
+  },
+);
+
+logsSchema.index(
+  { createdAt: 1 },
+  { expireAfterSeconds: LOG_RETENTION_SECONDS },
+);
+
+// Match the default logsMainList cursor order for index-only pagination.
+logsSchema.index({ createdAt: -1, _id: 1 });
+
+logsSchema.index(
+  { docId: 1, createdAt: -1 },
+  { partialFilterExpression: { docId: { $exists: true } } },
+);
+
+logsSchema.index(
+  { contentType: 1, createdAt: -1 },
+  { partialFilterExpression: { contentType: { $exists: true } } },
+);
+
+// One request's cascade of changes shares a processId.
+logsSchema.index(
+  { processId: 1, createdAt: -1 },
+  { partialFilterExpression: { processId: { $exists: true } } },
+);

package/src/core-modules/logs/index.ts

@@ -0,0 +1,5 @@
+export * from './definitions/logs';
+export * from './definitions/activityLog';
+export * from './types';
+export * from './activityLogUtils';
+export * from './activityLog';

package/src/core-modules/logs/types.ts

@@ -0,0 +1,16 @@
+export enum TAfterProcessProducers {
+  AFTER_MUTATION = 'afterMutation',
+  AFTER_AUTH = 'afterAuth',
+  AFTER_API_REQUEST = 'afterApiRequest',
+  AFTER_DOCUMENT_UPDATED = 'afterDocumentUpdated',
+  AFTER_DOCUMENT_CREATED = 'afterDocumentCreated',
+}
+
+export interface ILogContentTypeConfig {
+  moduleName: string;
+  collectionName: string;
+}
+
+export interface LogsConfigs {
+  contentTypes: ILogContentTypeConfig[];
+}

package/src/core-modules/notifications/definitions/emailAddresses.ts

@@ -0,0 +1,105 @@
+import { Document, Schema } from 'mongoose';
+
+export type TEmailSuppressionReason =
+  | 'hard_bounce'
+  | 'complaint'
+  | 'unsubscribe'
+  | 'screened'
+  | 'manual';
+
+export type TEmailLane = 'proven' | 'unknown' | 'suppressed';
+
+export const EMAIL_LANES: TEmailLane[] = ['proven', 'unknown', 'suppressed'];
+
+export type TMailKind = 'marketing' | 'transactional';
+
+export interface IEmailAddressDocument extends Document {
+  _id: string;
+  email: string;
+
+  lastSentAt?: Date;
+  lastDeliveredAt?: Date;
+  deliveredCount: number;
+
+  softBounceCount: number;
+  lastSoftBounceAt?: Date;
+
+  suppressedAt?: Date;
+  suppressionReason?: TEmailSuppressionReason;
+  suppressedBy?: string;
+
+  releasedAt?: Date;
+  releasedBy?: string;
+  releaseNote?: string;
+
+  createdAt: Date;
+  updatedAt: Date;
+}
+
+export const emailAddressSchema = new Schema({
+  email: {
+    type: String,
+    required: true,
+    unique: true,
+  },
+
+  lastSentAt: {
+    type: Date,
+  },
+
+  lastDeliveredAt: {
+    type: Date,
+  },
+
+  deliveredCount: {
+    type: Number,
+    default: 0,
+  },
+
+  softBounceCount: {
+    type: Number,
+    default: 0,
+  },
+
+  lastSoftBounceAt: {
+    type: Date,
+  },
+
+  suppressedAt: {
+    type: Date,
+  },
+
+  suppressionReason: {
+    type: String,
+    enum: ['hard_bounce', 'complaint', 'unsubscribe', 'screened', 'manual'],
+  },
+
+  suppressedBy: {
+    type: String,
+  },
+
+  releasedAt: {
+    type: Date,
+  },
+
+  releasedBy: {
+    type: String,
+  },
+
+  releaseNote: {
+    type: String,
+  },
+
+  createdAt: {
+    type: Date,
+    default: Date.now,
+  },
+
+  updatedAt: {
+    type: Date,
+    default: Date.now,
+  },
+});
+
+emailAddressSchema.index({ suppressedAt: 1 });
+emailAddressSchema.index({ lastDeliveredAt: -1 });

package/src/core-modules/notifications/definitions/emailDeliveries.ts

@@ -0,0 +1,188 @@
+import { Document, Schema } from 'mongoose';
+
+export type TEmailHandoffStatus = 'queued' | 'sent' | 'failed';
+
+export type TEmailDeliveryStatus =
+  | 'delivered'
+  | 'opened'
+  | 'clicked'
+  | 'bounced'
+  | 'complained'
+  | 'dropped';
+
+export interface IEmailDeliveryDocument extends Document {
+  _id: string;
+
+  notificationId?: string;
+  userId?: string;
+
+  source?: string;
+  sourceId?: string;
+
+  lane?: 'proven' | 'unknown';
+
+  toEmails: string[];
+  ccEmails?: string[];
+  from?: string;
+  subject: string;
+  content?: string;
+
+  provider: 'sendgrid' | 'smtp' | 'ses';
+  messageId?: string;
+  providerResponse?: string;
+
+  status: TEmailHandoffStatus;
+  sentAt?: Date;
+  error?: string;
+
+  rejected: string[];
+
+  deliveryStatus?: TEmailDeliveryStatus;
+  deliveryStatusAt?: Date;
+  bounced: string[];
+  complained: string[];
+  opened: string[];
+  clicked: string[];
+
+  createdAt: Date;
+  updatedAt: Date;
+}
+
+const RETENTION_SECONDS = 60 * 60 * 24 * 90;
+
+export const emailDeliverySchema = new Schema({
+  notificationId: {
+    type: String,
+    index: true,
+  },
+
+  userId: {
+    type: String,
+  },
+
+  source: {
+    type: String,
+  },
+
+  sourceId: {
+    type: String,
+  },
+
+  lane: {
+    type: String,
+    enum: ['proven', 'unknown'],
+  },
+
+  toEmails: {
+    type: [String],
+    default: [],
+    index: true,
+  },
+
+  ccEmails: {
+    type: [String],
+    default: [],
+  },
+
+  from: {
+    type: String,
+  },
+
+  subject: {
+    type: String,
+    default: '',
+  },
+
+  content: {
+    type: String,
+  },
+
+  provider: {
+    type: String,
+    enum: ['sendgrid', 'smtp', 'ses'],
+    required: true,
+  },
+
+  messageId: {
+    type: String,
+    index: true,
+  },
+
+  providerResponse: {
+    type: String,
+  },
+
+  status: {
+    type: String,
+    enum: ['queued', 'sent', 'failed'],
+    default: 'queued',
+    index: true,
+  },
+
+  sentAt: {
+    type: Date,
+  },
+
+  error: {
+    type: String,
+  },
+
+  rejected: {
+    type: [String],
+    default: [],
+  },
+
+  deliveryStatus: {
+    type: String,
+    enum: [
+      'delivered',
+      'opened',
+      'clicked',
+      'bounced',
+      'complained',
+      'dropped',
+    ],
+  },
+
+  deliveryStatusAt: {
+    type: Date,
+  },
+
+  bounced: {
+    type: [String],
+    default: [],
+  },
+
+  complained: {
+    type: [String],
+    default: [],
+  },
+
+  opened: {
+    type: [String],
+    default: [],
+  },
+
+  clicked: {
+    type: [String],
+    default: [],
+  },
+
+  createdAt: {
+    type: Date,
+    default: Date.now,
+    expires: RETENTION_SECONDS,
+  },
+
+  updatedAt: {
+    type: Date,
+    default: Date.now,
+  },
+});
+
+// Compound indexes for analytics
+emailDeliverySchema.index({ userId: 1, createdAt: -1 });
+emailDeliverySchema.index({ status: 1, createdAt: -1 });
+emailDeliverySchema.index({ provider: 1, status: 1 });
+emailDeliverySchema.index({ source: 1, sourceId: 1 });
+emailDeliverySchema.index({ createdAt: -1, lane: 1 });

package/src/core-modules/notifications/definitions/emailRamp.ts

@@ -0,0 +1,83 @@
+import { Document, Schema } from 'mongoose';
+
+export interface IEmailRampDocument extends Document {
+  _id: string;
+
+  tier: number;
+  day: string;
+  usedToday: number;
+
+  haltedAt?: Date;
+  haltReason?: string;
+  releasedAt?: Date;
+  releasedBy?: string;
+  releaseNote?: string;
+
+  lastEvaluatedAt?: Date;
+  lastRate?: number;
+
+  createdAt: Date;
+  updatedAt: Date;
+}
+
+export const EMAIL_RAMP_ID = 'ramp';
+
+export const emailRampSchema = new Schema({
+  _id: {
+    type: String,
+    default: EMAIL_RAMP_ID,
+  },
+
+  tier: {
+    type: Number,
+    default: 0,
+  },
+
+  day: {
+    type: String,
+    default: '',
+  },
+
+  usedToday: {
+    type: Number,
+    default: 0,
+  },
+
+  haltedAt: {
+    type: Date,
+  },
+
+  haltReason: {
+    type: String,
+  },
+
+  releasedAt: {
+    type: Date,
+  },
+
+  releasedBy: {
+    type: String,
+  },
+
+  releaseNote: {
+    type: String,
+  },
+
+  lastEvaluatedAt: {
+    type: Date,
+  },
+
+  lastRate: {
+    type: Number,
+  },
+
+  createdAt: {
+    type: Date,
+    default: Date.now,
+  },
+
+  updatedAt: {
+    type: Date,
+    default: Date.now,
+  },
+});

package/src/core-modules/notifications/definitions/emailSenders.ts

@@ -0,0 +1,84 @@
+import { Document, Schema } from 'mongoose';
+
+export type TEmailSenderState = 'pending' | 'active' | 'revoked' | 'suspended';
+
+export interface IEmailSenderDocument extends Document {
+  _id: string;
+
+  email: string;
+  name?: string;
+  type: 'single' | 'domain';
+  scope: string;
+
+  state: TEmailSenderState;
+  providerId?: string;
+
+  verifiedAt?: Date;
+  verificationToken?: string;
+  verificationSentAt?: Date;
+
+  createdAt: Date;
+  updatedAt: Date;
+}
+
+export const emailSenderSchema = new Schema({
+  email: {
+    type: String,
+    required: true,
+    lowercase: true,
+    trim: true,
+    index: true,
+  },
+
+  name: {
+    type: String,
+  },
+
+  type: {
+    type: String,
+    enum: ['single', 'domain'],
+    default: 'single',
+  },
+
+  scope: {
+    type: String,
+    default: 'transactional',
+    index: true,
+  },
+
+  state: {
+    type: String,
+    enum: ['pending', 'active', 'revoked', 'suspended'],
+    default: 'pending',
+    index: true,
+  },
+
+  providerId: {
+    type: String,
+  },
+
+  verifiedAt: {
+    type: Date,
+  },
+
+  verificationToken: {
+    type: String,
+    index: true,
+  },
+
+  verificationSentAt: {
+    type: Date,
+  },
+
+  createdAt: {
+    type: Date,
+    default: Date.now,
+  },
+
+  updatedAt: {
+    type: Date,
+    default: Date.now,
+  },
+});
+
+emailSenderSchema.index({ scope: 1, email: 1 }, { unique: true });

package/src/core-modules/notifications/definitions/notificationConfigs.ts

@@ -0,0 +1,110 @@
+import { Document, Schema } from 'mongoose';
+
+// Default notification configuration (set by owner/admin)
+export interface INotificationConfigDocument extends Document {
+  _id: string;
+
+  // Notification settings
+  inAppNotificationsDisabled: boolean;
+  emailNotificationsDisabled: boolean;
+
+  // Email template (if email enabled)
+  emailTemplateId?: string;
+  emailSubject?: string;
+
+  plugins: {
+    [pluginName: string]: {
+      inAppDisabled: boolean;
+      emailDisabled: boolean;
+      types: {
+        [notifTypeAction: string]: {
+          inAppDisabled: boolean;
+          emailDisabled: boolean;
+        };
+      };
+    };
+  };
+  // Metadata
+  createdAt: Date;
+  updatedAt: Date;
+  createdBy: string; // user ID
+}
+
+const orgNotifTypeSettingsScheam = new Schema(
+  {
+    inAppDisabled: { type: Boolean },
+    emailDisabled: { type: Boolean },
+    emailTemplateId: {
+      type: String,
+    },
+
+    emailSubject: {
+      type: String,
+      maxlength: 200,
+    },
+  },
+  { _id: false },
+);
+
+const pluginSettingsSchema = new Schema(
+  {
+    inAppDisabled: { type: Boolean },
+    emailDisabled: { type: Boolean },
+    types: {
+      type: Map,
+      of: orgNotifTypeSettingsScheam,
+      default: {},
+    },
+  },
+  { _id: false },
+);
+
+export const notificationConfigSchema = new Schema({
+  plugins: {
+    type: Map,
+    of: pluginSettingsSchema,
+    default: {},
+  },
+
+  inAppNotificationsDisabled: {
+    type: Boolean,
+    default: false,
+  },
+
+  emailNotificationsDisabled: {
+    type: Boolean,
+    default: false,
+  },
+
+  emailTemplateId: {
+    type: String,
+  },
+
+  emailSubject: {
+    type: String,
+    maxlength: 200,
+  },
+
+  createdAt: {
+    type: Date,
+    default: Date.now,
+  },
+  createdBy: {
+    type: String,
+    required: true,
+  },
+
+  updatedAt: {
+    type: Date,
+    default: Date.now,
+  },
+
+  expiresAfterDays: {
+    type: Number,
+    default: 30,
+  },
+});
+
+// Unique constraint on contentType + action
+notificationConfigSchema.index({ contentType: 1, action: 1 }, { unique: true });
+notificationConfigSchema.index({ enabled: 1 });