@unifiedcommerce/plugin-reviews 0.0.1

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export type { Db } from "./types";
+export { ReviewService } from "./services/review-service";
+export declare function reviewsPlugin(): import("@unifiedcommerce/core").CommercePlugin;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAMA,YAAY,EAAE,EAAE,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAE1D,wBAAgB,aAAa,mDAiB5B"}

package/dist/index.js

@@ -0,0 +1,24 @@
+import { defineCommercePlugin } from "@unifiedcommerce/core";
+import { customerReviews } from "./schema";
+import { ReviewService } from "./services/review-service";
+import { buildReviewRoutes } from "./routes/reviews";
+export { ReviewService } from "./services/review-service";
+export function reviewsPlugin() {
+    return defineCommercePlugin({
+        id: "reviews",
+        version: "1.0.0",
+        permissions: [
+            { scope: "reviews:admin", description: "Approve, reject, and reply to reviews." },
+            { scope: "reviews:write", description: "Submit reviews." },
+            { scope: "reviews:read", description: "View reviews and summaries." },
+        ],
+        schema: () => ({ customerReviews }),
+        hooks: () => [],
+        routes: (ctx) => {
+            const db = ctx.database.db;
+            if (!db)
+                return [];
+            return buildReviewRoutes(new ReviewService(db), ctx);
+        },
+    });
+}

package/dist/routes/reviews.d.ts

@@ -0,0 +1,9 @@
+import type { ReviewService } from "../services/review-service";
+import type { PluginRouteRegistration } from "@unifiedcommerce/core";
+export declare function buildReviewRoutes(service: ReviewService, ctx: {
+    services?: Record<string, unknown>;
+    database?: {
+        db: unknown;
+    };
+}): PluginRouteRegistration[];
+//# sourceMappingURL=reviews.d.ts.map

package/dist/routes/reviews.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reviews.d.ts","sourceRoot":"","sources":["../../src/routes/reviews.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAErE,wBAAgB,iBAAiB,CAC/B,OAAO,EAAE,aAAa,EACtB,GAAG,EAAE;IAAE,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAAC,QAAQ,CAAC,EAAE;QAAE,EAAE,EAAE,OAAO,CAAA;KAAE,CAAA;CAAE,GACtE,uBAAuB,EAAE,CAwE3B"}

package/dist/routes/reviews.js

@@ -0,0 +1,72 @@
+import { router } from "@unifiedcommerce/core";
+import { z } from "@hono/zod-openapi";
+export function buildReviewRoutes(service, ctx) {
+    const r = router("Reviews", "/reviews", ctx);
+    r.post("/").summary("Submit review").permission("reviews:write")
+        .input(z.object({
+        customerId: z.string().uuid().optional(),
+        entityId: z.string().uuid(),
+        orderId: z.string().uuid().optional(),
+        rating: z.number().int().min(1).max(5),
+        title: z.string().optional(),
+        body: z.string().optional(),
+    }))
+        .handler(async ({ input, orgId }) => {
+        const body = input;
+        const result = await service.submit(orgId, body);
+        if (!result.ok)
+            throw new Error(result.error);
+        return result.value;
+    });
+    r.get("/entity/{entityId}").summary("List reviews for entity").permission("reviews:read")
+        .handler(async ({ params, orgId }) => {
+        const result = await service.listForEntity(orgId, params.entityId);
+        if (!result.ok)
+            throw new Error(result.error);
+        return result.value;
+    });
+    r.get("/entity/{entityId}/summary").summary("Review summary for entity").permission("reviews:read")
+        .handler(async ({ params, orgId }) => {
+        const result = await service.getSummary(orgId, params.entityId);
+        if (!result.ok)
+            throw new Error(result.error);
+        return result.value;
+    });
+    r.patch("/{id}/approve").summary("Approve review").permission("reviews:admin")
+        .handler(async ({ params, orgId }) => {
+        const result = await service.approve(orgId, params.id);
+        if (!result.ok)
+            throw new Error(result.error);
+        return result.value;
+    });
+    r.patch("/{id}/reject").summary("Reject review").permission("reviews:admin")
+        .handler(async ({ params, orgId }) => {
+        const result = await service.reject(orgId, params.id);
+        if (!result.ok)
+            throw new Error(result.error);
+        return result.value;
+    });
+    r.post("/{id}/reply").summary("Reply to review").permission("reviews:admin")
+        .input(z.object({
+        response: z.string().min(1),
+        responseBy: z.string().min(1),
+    }))
+        .handler(async ({ params, input, orgId }) => {
+        const body = input;
+        const result = await service.reply(orgId, params.id, body.response, body.responseBy);
+        if (!result.ok)
+            throw new Error(result.error);
+        return result.value;
+    });
+    r.get("/mine").summary("My reviews").permission("reviews:write")
+        .handler(async ({ actor, orgId }) => {
+        // Use the authenticated actor's userId — never accept customerId from query
+        if (!actor?.userId)
+            throw new Error("Authentication required");
+        const result = await service.listByCustomer(orgId, actor.userId);
+        if (!result.ok)
+            throw new Error(result.error);
+        return result.value;
+    });
+    return r.routes();
+}

package/dist/schema.d.ts

@@ -0,0 +1,280 @@
+export declare const customerReviews: import("drizzle-orm/pg-core").PgTableWithColumns<{
+    name: "customer_reviews";
+    schema: undefined;
+    columns: {
+        id: import("drizzle-orm/pg-core").PgColumn<{
+            name: "id";
+            tableName: "customer_reviews";
+            dataType: "string";
+            columnType: "PgUUID";
+            data: string;
+            driverParam: string;
+            notNull: true;
+            hasDefault: true;
+            isPrimaryKey: true;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        organizationId: import("drizzle-orm/pg-core").PgColumn<{
+            name: "organization_id";
+            tableName: "customer_reviews";
+            dataType: "string";
+            columnType: "PgText";
+            data: string;
+            driverParam: string;
+            notNull: true;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        customerId: import("drizzle-orm/pg-core").PgColumn<{
+            name: "customer_id";
+            tableName: "customer_reviews";
+            dataType: "string";
+            columnType: "PgUUID";
+            data: string;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        entityId: import("drizzle-orm/pg-core").PgColumn<{
+            name: "entity_id";
+            tableName: "customer_reviews";
+            dataType: "string";
+            columnType: "PgUUID";
+            data: string;
+            driverParam: string;
+            notNull: true;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        orderId: import("drizzle-orm/pg-core").PgColumn<{
+            name: "order_id";
+            tableName: "customer_reviews";
+            dataType: "string";
+            columnType: "PgUUID";
+            data: string;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        rating: import("drizzle-orm/pg-core").PgColumn<{
+            name: "rating";
+            tableName: "customer_reviews";
+            dataType: "number";
+            columnType: "PgInteger";
+            data: number;
+            driverParam: string | number;
+            notNull: true;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        title: import("drizzle-orm/pg-core").PgColumn<{
+            name: "title";
+            tableName: "customer_reviews";
+            dataType: "string";
+            columnType: "PgText";
+            data: string;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        body: import("drizzle-orm/pg-core").PgColumn<{
+            name: "body";
+            tableName: "customer_reviews";
+            dataType: "string";
+            columnType: "PgText";
+            data: string;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        status: import("drizzle-orm/pg-core").PgColumn<{
+            name: "status";
+            tableName: "customer_reviews";
+            dataType: "string";
+            columnType: "PgText";
+            data: "pending" | "approved" | "rejected";
+            driverParam: string;
+            notNull: true;
+            hasDefault: true;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: ["pending", "approved", "rejected"];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        isVerified: import("drizzle-orm/pg-core").PgColumn<{
+            name: "is_verified";
+            tableName: "customer_reviews";
+            dataType: "boolean";
+            columnType: "PgBoolean";
+            data: boolean;
+            driverParam: boolean;
+            notNull: true;
+            hasDefault: true;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        isPublished: import("drizzle-orm/pg-core").PgColumn<{
+            name: "is_published";
+            tableName: "customer_reviews";
+            dataType: "boolean";
+            columnType: "PgBoolean";
+            data: boolean;
+            driverParam: boolean;
+            notNull: true;
+            hasDefault: true;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        response: import("drizzle-orm/pg-core").PgColumn<{
+            name: "response";
+            tableName: "customer_reviews";
+            dataType: "string";
+            columnType: "PgText";
+            data: string;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        responseBy: import("drizzle-orm/pg-core").PgColumn<{
+            name: "response_by";
+            tableName: "customer_reviews";
+            dataType: "string";
+            columnType: "PgText";
+            data: string;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        responseAt: import("drizzle-orm/pg-core").PgColumn<{
+            name: "response_at";
+            tableName: "customer_reviews";
+            dataType: "date";
+            columnType: "PgTimestamp";
+            data: Date;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        createdAt: import("drizzle-orm/pg-core").PgColumn<{
+            name: "created_at";
+            tableName: "customer_reviews";
+            dataType: "date";
+            columnType: "PgTimestamp";
+            data: Date;
+            driverParam: string;
+            notNull: true;
+            hasDefault: true;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        updatedAt: import("drizzle-orm/pg-core").PgColumn<{
+            name: "updated_at";
+            tableName: "customer_reviews";
+            dataType: "date";
+            columnType: "PgTimestamp";
+            data: Date;
+            driverParam: string;
+            notNull: true;
+            hasDefault: true;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+    };
+    dialect: "pg";
+}>;
+//# sourceMappingURL=schema.d.ts.map

package/dist/schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAuBzB,CAAC"}

package/dist/schema.js

@@ -0,0 +1,25 @@
+import { pgTable, uuid, text, integer, boolean, timestamp, index } from "drizzle-orm/pg-core";
+export const customerReviews = pgTable("customer_reviews", {
+    id: uuid("id").defaultRandom().primaryKey(),
+    organizationId: text("organization_id").notNull(),
+    customerId: uuid("customer_id"),
+    entityId: uuid("entity_id").notNull(),
+    orderId: uuid("order_id"),
+    rating: integer("rating").notNull(),
+    title: text("title"),
+    body: text("body"),
+    status: text("status", { enum: ["pending", "approved", "rejected"] })
+        .notNull()
+        .default("pending"),
+    isVerified: boolean("is_verified").notNull().default(false),
+    isPublished: boolean("is_published").notNull().default(false),
+    response: text("response"),
+    responseBy: text("response_by"),
+    responseAt: timestamp("response_at", { withTimezone: true }),
+    createdAt: timestamp("created_at", { withTimezone: true }).defaultNow().notNull(),
+    updatedAt: timestamp("updated_at", { withTimezone: true }).defaultNow().notNull(),
+}, (table) => ({
+    orgIdx: index("idx_customer_reviews_org").on(table.organizationId),
+    entityIdx: index("idx_customer_reviews_entity").on(table.entityId),
+    statusIdx: index("idx_customer_reviews_status").on(table.status),
+}));

package/dist/services/review-service.d.ts

@@ -0,0 +1,26 @@
+import type { PluginResult } from "@unifiedcommerce/core";
+import type { Db, Review } from "../types";
+export interface ReviewSummary {
+    averageRating: number;
+    totalCount: number;
+    distribution: Record<number, number>;
+}
+export declare class ReviewService {
+    private db;
+    constructor(db: Db);
+    submit(orgId: string, input: {
+        customerId?: string;
+        entityId: string;
+        orderId?: string;
+        rating: number;
+        title?: string;
+        body?: string;
+    }): Promise<PluginResult<Review>>;
+    listForEntity(orgId: string, entityId: string, publishedOnly?: boolean): Promise<PluginResult<Review[]>>;
+    getSummary(orgId: string, entityId: string): Promise<PluginResult<ReviewSummary>>;
+    approve(orgId: string, id: string): Promise<PluginResult<Review>>;
+    reject(orgId: string, id: string): Promise<PluginResult<Review>>;
+    reply(orgId: string, id: string, response: string, responseBy: string): Promise<PluginResult<Review>>;
+    listByCustomer(orgId: string, customerId: string): Promise<PluginResult<Review[]>>;
+}
+//# sourceMappingURL=review-service.d.ts.map

package/dist/services/review-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"review-service.d.ts","sourceRoot":"","sources":["../../src/services/review-service.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAE1D,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAE3C,MAAM,WAAW,aAAa;IAC5B,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACtC;AAED,qBAAa,aAAa;IACZ,OAAO,CAAC,EAAE;gBAAF,EAAE,EAAE,EAAE;IAEpB,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE;QACjC,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,QAAQ,EAAE,MAAM,CAAC;QACjB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,GAAG,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IAkB3B,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;IAYxG,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;IAwBjF,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IASjE,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IAShE,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IASrG,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;CAQzF"}

package/dist/services/review-service.js

@@ -0,0 +1,88 @@
+import { eq, and, sql } from "drizzle-orm";
+import { Ok, Err } from "@unifiedcommerce/core";
+import { customerReviews } from "../schema";
+export class ReviewService {
+    db;
+    constructor(db) {
+        this.db = db;
+    }
+    async submit(orgId, input) {
+        if (input.rating < 1 || input.rating > 5 || !Number.isInteger(input.rating)) {
+            return Err("Rating must be an integer between 1 and 5");
+        }
+        const isVerified = input.orderId != null;
+        const rows = await this.db.insert(customerReviews).values({
+            organizationId: orgId,
+            customerId: input.customerId ?? null,
+            entityId: input.entityId,
+            orderId: input.orderId ?? null,
+            rating: input.rating,
+            title: input.title ?? null,
+            body: input.body ?? null,
+            isVerified,
+        }).returning();
+        return Ok(rows[0]);
+    }
+    async listForEntity(orgId, entityId, publishedOnly) {
+        const conditions = [
+            eq(customerReviews.organizationId, orgId),
+            eq(customerReviews.entityId, entityId),
+        ];
+        if (publishedOnly) {
+            conditions.push(eq(customerReviews.isPublished, true));
+        }
+        const rows = await this.db.select().from(customerReviews).where(and(...conditions));
+        return Ok(rows);
+    }
+    async getSummary(orgId, entityId) {
+        const rows = await this.db.select({
+            rating: customerReviews.rating,
+            count: sql `count(*)::int`,
+        })
+            .from(customerReviews)
+            .where(and(eq(customerReviews.organizationId, orgId), eq(customerReviews.entityId, entityId)))
+            .groupBy(customerReviews.rating);
+        const distribution = { 1: 0, 2: 0, 3: 0, 4: 0, 5: 0 };
+        let totalCount = 0;
+        let totalSum = 0;
+        for (const row of rows) {
+            distribution[row.rating] = row.count;
+            totalCount += row.count;
+            totalSum += row.rating * row.count;
+        }
+        const averageRating = totalCount > 0 ? Math.round((totalSum / totalCount) * 100) / 100 : 0;
+        return Ok({ averageRating, totalCount, distribution });
+    }
+    async approve(orgId, id) {
+        const rows = await this.db.update(customerReviews)
+            .set({ status: "approved", isPublished: true, updatedAt: new Date() })
+            .where(and(eq(customerReviews.organizationId, orgId), eq(customerReviews.id, id)))
+            .returning();
+        if (rows.length === 0)
+            return Err("Review not found");
+        return Ok(rows[0]);
+    }
+    async reject(orgId, id) {
+        const rows = await this.db.update(customerReviews)
+            .set({ status: "rejected", isPublished: false, updatedAt: new Date() })
+            .where(and(eq(customerReviews.organizationId, orgId), eq(customerReviews.id, id)))
+            .returning();
+        if (rows.length === 0)
+            return Err("Review not found");
+        return Ok(rows[0]);
+    }
+    async reply(orgId, id, response, responseBy) {
+        const rows = await this.db.update(customerReviews)
+            .set({ response, responseBy, responseAt: new Date(), updatedAt: new Date() })
+            .where(and(eq(customerReviews.organizationId, orgId), eq(customerReviews.id, id)))
+            .returning();
+        if (rows.length === 0)
+            return Err("Review not found");
+        return Ok(rows[0]);
+    }
+    async listByCustomer(orgId, customerId) {
+        const rows = await this.db.select().from(customerReviews)
+            .where(and(eq(customerReviews.organizationId, orgId), eq(customerReviews.customerId, customerId)));
+        return Ok(rows);
+    }
+}