@deenruv/order-reminder-plugin 1.0.0

package/LICENSE

@@ -0,0 +1,23 @@
+# License 1
+
+The MIT License
+
+Copyright (c) 2025-present Aexol
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# License 2
+
+The MIT License
+
+Copyright (c) 2018-2025 Michael Bromley
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,47 @@
+# @deenruv/order-reminder-plugin
+
+Plugin that sends reminder events for orders that have been in a specific state for a configurable duration. It supports multiple reminder rules, each targeting a specific order state and age threshold, and publishes custom Deenruv events that can trigger email notifications or other actions.
+
+## Installation
+
+```bash
+pnpm add @deenruv/order-reminder-plugin
+```
+
+## Configuration
+
+```typescript
+import { OrderReminderPlugin } from '@deenruv/order-reminder-plugin';
+import { MyPaymentReminderEvent } from './events';
+
+// In your Deenruv server config:
+plugins: [
+  OrderReminderPlugin.init([
+    {
+      uniqueId: 'payment-reminder-24h',
+      orderState: 'ArrangingPayment',
+      orderAgeMs: 24 * 60 * 60 * 1000, // 24 hours
+      eventCtor: MyPaymentReminderEvent,
+      batchSize: 50,
+      orderFrom: new Date('2025-01-01'),
+    },
+  ]),
+]
+```
+
+## Features
+
+- Configurable reminder rules with order state and age thresholds
+- Publishes custom Deenruv events for each qualifying order (integrates with email/notification systems)
+- Per-rule tracking to prevent duplicate reminder sends
+- Batch processing with configurable batch sizes
+- Optional `orderFrom` date to avoid spamming historical orders when enabling the plugin
+- Supports multiple independent reminder rules
+
+## Admin UI
+
+This plugin is server-only and does not add any admin UI extensions.
+
+## API Extensions
+
+This plugin does not add any GraphQL API extensions. It operates via a controller endpoint and internal event publishing.

package/dist/plugin-server/constants.d.ts

@@ -0,0 +1 @@
+export declare const ORDER_REMINDMER_PLUGIN_OPTIONS: unique symbol;

package/dist/plugin-server/constants.js

@@ -0,0 +1 @@
+export const ORDER_REMINDMER_PLUGIN_OPTIONS = Symbol("ORDER_REMINDMER_PLUGIN_OPTIONS");

package/dist/plugin-server/controllers/order-reminder.controller.d.ts

@@ -0,0 +1,8 @@
+import type { Response } from "express";
+import { RequestContext } from "@deenruv/core";
+import { OrderReminderService } from "../services/order-reminder.service.js";
+export declare class OrderReminderController {
+    private service;
+    constructor(service: OrderReminderService);
+    run(ctx: RequestContext, res: Response): Promise<void>;
+}

package/dist/plugin-server/controllers/order-reminder.controller.js

@@ -0,0 +1,39 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+import { Controller, Get, HttpStatus, Res } from "@nestjs/common";
+import { Allow, Ctx, Permission, RequestContext } from "@deenruv/core";
+import { OrderReminderService } from "../services/order-reminder.service.js";
+let OrderReminderController = class OrderReminderController {
+    service;
+    constructor(service) {
+        this.service = service;
+    }
+    async run(ctx, res) {
+        const result = await this.service.run(ctx);
+        res.status(HttpStatus.OK).json({ status: "OK", ...result });
+    }
+};
+__decorate([
+    Allow(Permission.UpdateOrder),
+    Get(""),
+    __param(0, Ctx()),
+    __param(1, Res()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [RequestContext, Object]),
+    __metadata("design:returntype", Promise)
+], OrderReminderController.prototype, "run", null);
+OrderReminderController = __decorate([
+    Controller("order-reminder"),
+    __metadata("design:paramtypes", [OrderReminderService])
+], OrderReminderController);
+export { OrderReminderController };

package/dist/plugin-server/entities/order-reminder.entity.d.ts

@@ -0,0 +1,7 @@
+import { DeepPartial } from "typeorm";
+import { DeenruvEntity, Order } from "@deenruv/core";
+export declare class OrderReminderEntity extends DeenruvEntity {
+    constructor(input?: DeepPartial<OrderReminderEntity>);
+    order: Order;
+    remindmerSend: Record<string, boolean>;
+}

package/dist/plugin-server/entities/order-reminder.entity.js

@@ -0,0 +1,35 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import { Column, Entity, Index, ManyToOne, Unique } from "typeorm";
+import { DeenruvEntity, Order } from "@deenruv/core";
+let OrderReminderEntity = class OrderReminderEntity extends DeenruvEntity {
+    constructor(input) {
+        super(input);
+    }
+    order;
+    remindmerSend;
+};
+__decorate([
+    ManyToOne(() => Order, { eager: true, onDelete: "CASCADE" }),
+    __metadata("design:type", Order)
+], OrderReminderEntity.prototype, "order", void 0);
+__decorate([
+    Column({ type: "jsonb", default: {} }),
+    __metadata("design:type", Object)
+], OrderReminderEntity.prototype, "remindmerSend", void 0);
+OrderReminderEntity = __decorate([
+    Entity(),
+    Unique(["order"]) // one reminder per order
+    ,
+    Index(["order"]) // used in join/filter; JSON key checks are handled in query
+    ,
+    __metadata("design:paramtypes", [Object])
+], OrderReminderEntity);
+export { OrderReminderEntity };

package/dist/plugin-server/index.d.ts

@@ -0,0 +1,6 @@
+import { OrderRemindmerPluginOptions } from "./types.js";
+declare class OrderReminderPlugin {
+    private static options;
+    static init(options: OrderRemindmerPluginOptions): typeof OrderReminderPlugin;
+}
+export { OrderReminderPlugin };

package/dist/plugin-server/index.js

@@ -0,0 +1,34 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import { PluginCommonModule, DeenruvPlugin } from "@deenruv/core";
+import { OrderReminderController } from "./controllers/order-reminder.controller.js";
+import { OrderReminderService } from "./services/order-reminder.service.js";
+import { ORDER_REMINDMER_PLUGIN_OPTIONS } from "./constants.js";
+import { OrderReminderEntity } from "./entities/order-reminder.entity.js";
+let OrderReminderPlugin = class OrderReminderPlugin {
+    static options;
+    static init(options) {
+        this.options = options;
+        return this;
+    }
+};
+OrderReminderPlugin = __decorate([
+    DeenruvPlugin({
+        compatibility: "^0.0.40",
+        imports: [PluginCommonModule],
+        entities: [OrderReminderEntity],
+        controllers: [OrderReminderController],
+        providers: [
+            {
+                provide: ORDER_REMINDMER_PLUGIN_OPTIONS,
+                useFactory: () => OrderReminderPlugin.options,
+            },
+            OrderReminderService,
+        ],
+    })
+], OrderReminderPlugin);
+export { OrderReminderPlugin };

package/dist/plugin-server/services/order-reminder.service.d.ts

@@ -0,0 +1,11 @@
+import { TransactionalConnection, RequestContext, EventBus } from "@deenruv/core";
+import { OrderRemindmerPluginOptions } from "../types.js";
+export declare class OrderReminderService {
+    private connection;
+    private eventBus;
+    private options;
+    constructor(connection: TransactionalConnection, eventBus: EventBus, options: OrderRemindmerPluginOptions);
+    run(ctx: RequestContext): Promise<{
+        processed: number;
+    }>;
+}

package/dist/plugin-server/services/order-reminder.service.js

@@ -0,0 +1,135 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+import { Inject, Injectable } from "@nestjs/common";
+import { TransactionalConnection, EventBus, Order, } from "@deenruv/core";
+import { ORDER_REMINDMER_PLUGIN_OPTIONS } from "../constants.js";
+import { OrderReminderEntity } from "../entities/order-reminder.entity.js";
+import { In } from "typeorm";
+let OrderReminderService = class OrderReminderService {
+    connection;
+    eventBus;
+    options;
+    constructor(connection, eventBus, options) {
+        this.connection = connection;
+        this.eventBus = eventBus;
+        this.options = options;
+    }
+    async run(ctx) {
+        const orderRepo = this.connection.getRepository(ctx, Order);
+        const reminderRepo = this.connection.getRepository(ctx, OrderReminderEntity);
+        let processed = 0;
+        const rules = Array.isArray(this.options)
+            ? this.options
+            : [];
+        for (const rule of rules) {
+            const threshold = new Date(Date.now() - rule.orderAgeMs);
+            const batchSize = rule.batchSize ?? 100;
+            let fetched = 0;
+            let lastUpdatedAt;
+            let lastId;
+            while (true) {
+                // Use NOT EXISTS to exclude orders already reminded for this rule
+                let qb = orderRepo
+                    .createQueryBuilder("o")
+                    .leftJoinAndSelect("o.customer", "c")
+                    .leftJoinAndSelect("o.lines", "lines")
+                    .where("o.updatedAt < :threshold", { threshold })
+                    .andWhere("o.state = :state", { state: rule.orderState })
+                    .andWhere('o."customerId" IS NOT NULL')
+                    .andWhere("lines.id IS NOT NULL")
+                    .andWhere(`NOT EXISTS (
+               SELECT 1 FROM ${orderRepo.metadata.schema
+                    ? '"' + orderRepo.metadata.schema + '".'
+                    : ""}"${reminderRepo.metadata.tableName}" rem
+               WHERE rem."orderId" = o.id
+                 AND coalesce(rem."remindmerSend" ->> :key, 'false') = 'true'
+             )`, { key: rule.uniqueId });
+                if (rule.orderFrom) {
+                    qb = qb.andWhere("o.createdAt >= :orderFrom", {
+                        orderFrom: rule.orderFrom,
+                    });
+                }
+                if (lastUpdatedAt) {
+                    qb = qb.andWhere("(o.updatedAt > :lastUpdatedAt OR (o.updatedAt = :lastUpdatedAt AND o.id > :lastId))", { lastUpdatedAt, lastId });
+                }
+                const oldOrders = await qb
+                    .orderBy("o.updatedAt", "ASC")
+                    .addOrderBy("o.id", "ASC")
+                    .take(batchSize)
+                    .getMany();
+                fetched = oldOrders.length;
+                if (fetched === 0)
+                    break;
+                const ids = oldOrders.map((o) => o.id);
+                const reminders = await reminderRepo.find({
+                    where: { order: { id: In(ids) } },
+                    relations: { order: true },
+                });
+                const remByOrderId = new Map();
+                for (const r of reminders)
+                    remByOrderId.set(r.order.id, r);
+                for (const order of oldOrders) {
+                    let reminder = remByOrderId.get(order.id) ?? null;
+                    if (!reminder) {
+                        try {
+                            reminder = reminderRepo.create({
+                                order,
+                                remindmerSend: { [rule.uniqueId]: false },
+                            });
+                            reminder = await reminderRepo.save(reminder);
+                            remByOrderId.set(order.id, reminder);
+                        }
+                        catch {
+                            // Unique race: fetch existing
+                            reminder = await reminderRepo.findOne({
+                                where: { order: { id: order.id } },
+                                relations: { order: true },
+                            });
+                            if (!reminder)
+                                continue;
+                        }
+                    }
+                    if (reminder.remindmerSend?.[rule.uniqueId]) {
+                        lastUpdatedAt = order.updatedAt;
+                        lastId = order.id;
+                        continue;
+                    }
+                    try {
+                        const EventCtor = rule.eventCtor;
+                        const eventInstance = new EventCtor(ctx, order);
+                        await this.eventBus.publish(eventInstance);
+                        reminder.remindmerSend = {
+                            ...(reminder.remindmerSend ?? {}),
+                            [rule.uniqueId]: true,
+                        };
+                        await reminderRepo.save(reminder);
+                        processed++;
+                    }
+                    catch {
+                        // Swallow individual order errors
+                    }
+                    lastUpdatedAt = order.updatedAt;
+                    lastId = order.id;
+                }
+            }
+        }
+        return { processed };
+    }
+};
+OrderReminderService = __decorate([
+    Injectable(),
+    __param(2, Inject(ORDER_REMINDMER_PLUGIN_OPTIONS)),
+    __metadata("design:paramtypes", [TransactionalConnection,
+        EventBus, Array])
+], OrderReminderService);
+export { OrderReminderService };