@unifiedcommerce/plugin-uom 0.2.0 → 0.2.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unifiedcommerce/plugin-uom",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "type": "module",
   "exports": {
     ".": {
@@ -37,6 +37,7 @@
     "access": "public"
   },
   "files": [
+    "src",
     "dist",
     "README.md"
   ]

package/src/index.ts

@@ -0,0 +1,26 @@
+import { defineCommercePlugin } from "@unifiedcommerce/core";
+import { unitsOfMeasure, uomConversions, entityUom } from "./schema.js";
+import { UOMService } from "./services/uom-service.js";
+import { buildUOMRoutes } from "./routes/uom.js";
+import type { Db } from "./types.js";
+
+export type { Db } from "./types.js";
+export { UOMService } from "./services/uom-service.js";
+
+export function uomPlugin() {
+  return defineCommercePlugin({
+    id: "uom",
+    version: "1.0.0",
+    permissions: [
+      { scope: "uom:admin", description: "Create/edit units, conversions, entity UOM assignments." },
+      { scope: "uom:read", description: "View units, conversions, convert quantities." },
+    ],
+    schema: () => ({ unitsOfMeasure, uomConversions, entityUom }),
+    hooks: () => [],
+    routes: (ctx) => {
+      const db = ctx.database.db;
+      if (!db) return [];
+      return buildUOMRoutes(new UOMService(db), ctx);
+    },
+  });
+}

package/src/routes/uom.ts

@@ -0,0 +1,72 @@
+import { router } from "@unifiedcommerce/core";
+import { z } from "@hono/zod-openapi";
+import type { UOMService } from "../services/uom-service.js";
+import type { PluginRouteRegistration } from "@unifiedcommerce/core";
+
+export function buildUOMRoutes(
+  service: UOMService,
+  ctx: { services?: Record<string, unknown>; database?: { db: unknown } },
+): PluginRouteRegistration[] {
+  const r = router("Units of Measure", "/uom", ctx);
+
+  r.post("/units").summary("Create unit").permission("uom:admin")
+    .input(z.object({ code: z.string().min(1).max(20), name: z.string().min(1), category: z.enum(["weight", "volume", "length", "count", "area", "time"]), isBaseUnit: z.boolean().optional() }))
+    .handler(async ({ input, orgId }) => {
+      const body = input as { code: string; name: string; category: "weight" | "volume" | "length" | "count" | "area" | "time"; isBaseUnit?: boolean };
+      const result = await service.createUnit(orgId, body);
+      if (!result.ok) throw new Error(result.error);
+      return result.value;
+    });
+
+  r.get("/units").summary("List units").permission("uom:read")
+    .query(z.object({ category: z.enum(["weight", "volume", "length", "count", "area", "time"]).optional() }))
+    .handler(async ({ query, orgId }) => {
+      const q = query as { category?: "weight" | "volume" | "length" | "count" | "area" | "time" };
+      const result = await service.listUnits(orgId, q.category);
+      if (!result.ok) throw new Error(result.error);
+      return result.value;
+    });
+
+  r.post("/conversions").summary("Create conversion").permission("uom:admin")
+    .input(z.object({ fromUnitId: z.string().uuid(), toUnitId: z.string().uuid(), factor: z.number().int().positive() }))
+    .handler(async ({ input, orgId }) => {
+      const body = input as { fromUnitId: string; toUnitId: string; factor: number };
+      const result = await service.createConversion(orgId, body);
+      if (!result.ok) throw new Error(result.error);
+      return result.value;
+    });
+
+  r.get("/conversions").summary("List conversions").permission("uom:read")
+    .handler(async ({ orgId }) => {
+      const result = await service.listConversions(orgId);
+      if (!result.ok) throw new Error(result.error);
+      return result.value;
+    });
+
+  r.post("/convert").summary("Convert quantity").permission("uom:read")
+    .input(z.object({ fromUnitId: z.string().uuid(), toUnitId: z.string().uuid(), quantity: z.number().positive() }))
+    .handler(async ({ input, orgId }) => {
+      const body = input as { fromUnitId: string; toUnitId: string; quantity: number };
+      const result = await service.convert(orgId, body);
+      if (!result.ok) throw new Error(result.error);
+      return result.value;
+    });
+
+  r.post("/entities/{id}/uom").summary("Set entity UOM").permission("uom:admin")
+    .input(z.object({ purchaseUomId: z.string().uuid(), stockUomId: z.string().uuid(), saleUomId: z.string().uuid(), yieldPercentage: z.number().int().min(1).max(100).optional() }))
+    .handler(async ({ params, input, orgId }) => {
+      const body = input as { purchaseUomId: string; stockUomId: string; saleUomId: string; yieldPercentage?: number };
+      const result = await service.setEntityUom(orgId, { entityId: params.id!, ...body });
+      if (!result.ok) throw new Error(result.error);
+      return result.value;
+    });
+
+  r.get("/entities/{id}/uom").summary("Get entity UOM").permission("uom:read")
+    .handler(async ({ params, orgId }) => {
+      const result = await service.getEntityUom(orgId, params.id!);
+      if (!result.ok) throw new Error(result.error);
+      return result.value;
+    });
+
+  return r.routes();
+}

package/src/schema.ts

@@ -0,0 +1,40 @@
+import { pgTable, uuid, text, integer, boolean, timestamp, index, uniqueIndex } from "drizzle-orm/pg-core";
+
+export const unitsOfMeasure = pgTable("units_of_measure", {
+  id: uuid("id").defaultRandom().primaryKey(),
+  organizationId: text("organization_id").notNull(),
+  code: text("code").notNull(),
+  name: text("name").notNull(),
+  category: text("category", { enum: ["weight", "volume", "length", "count", "area", "time"] }).notNull(),
+  isBaseUnit: boolean("is_base_unit").notNull().default(false),
+  createdAt: timestamp("created_at", { withTimezone: true }).defaultNow().notNull(),
+  updatedAt: timestamp("updated_at", { withTimezone: true }).defaultNow().notNull(),
+}, (table) => ({
+  orgIdx: index("idx_uom_org").on(table.organizationId),
+  codeUnique: uniqueIndex("uom_org_code_unique").on(table.organizationId, table.code),
+}));
+
+export const uomConversions = pgTable("uom_conversions", {
+  id: uuid("id").defaultRandom().primaryKey(),
+  organizationId: text("organization_id").notNull(),
+  fromUnitId: uuid("from_unit_id").references(() => unitsOfMeasure.id, { onDelete: "cascade" }).notNull(),
+  toUnitId: uuid("to_unit_id").references(() => unitsOfMeasure.id, { onDelete: "cascade" }).notNull(),
+  factor: integer("factor").notNull(),
+  createdAt: timestamp("created_at", { withTimezone: true }).defaultNow().notNull(),
+}, (table) => ({
+  orgIdx: index("idx_uom_conversions_org").on(table.organizationId),
+}));
+
+export const entityUom = pgTable("entity_uom", {
+  id: uuid("id").defaultRandom().primaryKey(),
+  organizationId: text("organization_id").notNull(),
+  entityId: uuid("entity_id").notNull(),
+  purchaseUomId: uuid("purchase_uom_id").references(() => unitsOfMeasure.id).notNull(),
+  stockUomId: uuid("stock_uom_id").references(() => unitsOfMeasure.id).notNull(),
+  saleUomId: uuid("sale_uom_id").references(() => unitsOfMeasure.id).notNull(),
+  yieldPercentage: integer("yield_percentage").notNull().default(100),
+  createdAt: timestamp("created_at", { withTimezone: true }).defaultNow().notNull(),
+  updatedAt: timestamp("updated_at", { withTimezone: true }).defaultNow().notNull(),
+}, (table) => ({
+  entityUnique: uniqueIndex("entity_uom_org_entity_unique").on(table.organizationId, table.entityId),
+}));

package/src/services/uom-service.ts

@@ -0,0 +1,111 @@
+import { eq, and } from "drizzle-orm";
+import { Ok, Err } from "@unifiedcommerce/core";
+import type { PluginResult } from "@unifiedcommerce/core";
+import { unitsOfMeasure, uomConversions, entityUom } from "../schema.js";
+import type { Db, UnitOfMeasure, UOMConversion, EntityUOM, UOMCategory } from "../types.js";
+
+export class UOMService {
+  constructor(private db: Db) {}
+
+  async createUnit(orgId: string, input: {
+    code: string; name: string; category: UOMCategory; isBaseUnit?: boolean;
+  }): Promise<PluginResult<UnitOfMeasure>> {
+    const existing = await this.db.select().from(unitsOfMeasure)
+      .where(and(eq(unitsOfMeasure.organizationId, orgId), eq(unitsOfMeasure.code, input.code)));
+    if (existing.length > 0) return Err(`Unit '${input.code}' already exists`);
+    const rows = await this.db.insert(unitsOfMeasure).values({
+      organizationId: orgId, code: input.code, name: input.name,
+      category: input.category, isBaseUnit: input.isBaseUnit ?? false,
+    }).returning();
+    return Ok(rows[0]!);
+  }
+
+  async listUnits(orgId: string, category?: UOMCategory): Promise<PluginResult<UnitOfMeasure[]>> {
+    const conditions = [eq(unitsOfMeasure.organizationId, orgId)];
+    if (category) conditions.push(eq(unitsOfMeasure.category, category));
+    const rows = await this.db.select().from(unitsOfMeasure).where(and(...conditions));
+    return Ok(rows);
+  }
+
+  async createConversion(orgId: string, input: {
+    fromUnitId: string; toUnitId: string; factor: number;
+  }): Promise<PluginResult<UOMConversion>> {
+    if (input.factor <= 0) return Err("Factor must be positive");
+    const rows = await this.db.insert(uomConversions).values({
+      organizationId: orgId, fromUnitId: input.fromUnitId,
+      toUnitId: input.toUnitId, factor: input.factor,
+    }).returning();
+    return Ok(rows[0]!);
+  }
+
+  async listConversions(orgId: string): Promise<PluginResult<UOMConversion[]>> {
+    const rows = await this.db.select().from(uomConversions)
+      .where(eq(uomConversions.organizationId, orgId));
+    return Ok(rows);
+  }
+
+  async convert(orgId: string, input: {
+    fromUnitId: string; toUnitId: string; quantity: number;
+  }): Promise<PluginResult<{ result: number; fromCode: string; toCode: string }>> {
+    if (input.fromUnitId === input.toUnitId) {
+      const unit = await this.db.select().from(unitsOfMeasure).where(eq(unitsOfMeasure.id, input.fromUnitId));
+      return Ok({ result: input.quantity, fromCode: unit[0]?.code ?? "", toCode: unit[0]?.code ?? "" });
+    }
+    // Try forward conversion
+    const forward = await this.db.select().from(uomConversions).where(and(
+      eq(uomConversions.organizationId, orgId),
+      eq(uomConversions.fromUnitId, input.fromUnitId),
+      eq(uomConversions.toUnitId, input.toUnitId),
+    ));
+    const fromUnit = await this.db.select().from(unitsOfMeasure).where(eq(unitsOfMeasure.id, input.fromUnitId));
+    const toUnit = await this.db.select().from(unitsOfMeasure).where(eq(unitsOfMeasure.id, input.toUnitId));
+    const fromCode = fromUnit[0]?.code ?? "";
+    const toCode = toUnit[0]?.code ?? "";
+
+    if (forward.length > 0) {
+      return Ok({ result: Math.round(input.quantity * forward[0]!.factor / 10000), fromCode, toCode });
+    }
+    // Try reverse
+    const reverse = await this.db.select().from(uomConversions).where(and(
+      eq(uomConversions.organizationId, orgId),
+      eq(uomConversions.fromUnitId, input.toUnitId),
+      eq(uomConversions.toUnitId, input.fromUnitId),
+    ));
+    if (reverse.length > 0) {
+      return Ok({ result: Math.round(input.quantity * 10000 / reverse[0]!.factor), fromCode, toCode });
+    }
+    return Err(`No conversion found between '${fromCode}' and '${toCode}'`);
+  }
+
+  async setEntityUom(orgId: string, input: {
+    entityId: string; purchaseUomId: string; stockUomId: string; saleUomId: string; yieldPercentage?: number;
+  }): Promise<PluginResult<EntityUOM>> {
+    const existing = await this.db.select().from(entityUom)
+      .where(and(eq(entityUom.organizationId, orgId), eq(entityUom.entityId, input.entityId)));
+    if (existing.length > 0) {
+      const rows = await this.db.update(entityUom).set({
+        purchaseUomId: input.purchaseUomId, stockUomId: input.stockUomId,
+        saleUomId: input.saleUomId, yieldPercentage: input.yieldPercentage ?? 100, updatedAt: new Date(),
+      }).where(eq(entityUom.id, existing[0]!.id)).returning();
+      return Ok(rows[0]!);
+    }
+    const rows = await this.db.insert(entityUom).values({
+      organizationId: orgId, entityId: input.entityId,
+      purchaseUomId: input.purchaseUomId, stockUomId: input.stockUomId,
+      saleUomId: input.saleUomId, yieldPercentage: input.yieldPercentage ?? 100,
+    }).returning();
+    return Ok(rows[0]!);
+  }
+
+  async getEntityUom(orgId: string, entityId: string): Promise<PluginResult<EntityUOM>> {
+    const rows = await this.db.select().from(entityUom)
+      .where(and(eq(entityUom.organizationId, orgId), eq(entityUom.entityId, entityId)));
+    if (rows.length === 0) return Err("No UOM assignment for this entity");
+    return Ok(rows[0]!);
+  }
+
+  async calculateYield(yieldPercentage: number, requiredQuantity: number): Promise<PluginResult<{ purchaseQuantity: number }>> {
+    if (yieldPercentage <= 0 || yieldPercentage > 100) return Ok({ purchaseQuantity: requiredQuantity });
+    return Ok({ purchaseQuantity: Math.ceil(requiredQuantity * 100 / yieldPercentage) });
+  }
+}

package/src/types.ts

@@ -0,0 +1,6 @@
+export type { PluginDb as Db } from "@unifiedcommerce/core";
+import type { unitsOfMeasure, uomConversions, entityUom } from "./schema.js";
+export type UnitOfMeasure = typeof unitsOfMeasure.$inferSelect;
+export type UOMConversion = typeof uomConversions.$inferSelect;
+export type EntityUOM = typeof entityUom.$inferSelect;
+export type UOMCategory = "weight" | "volume" | "length" | "count" | "area" | "time";