OpenSpec Change: enterprise-api-plugin-warehouse-ops

Change ID: enterprise-api-plugin-warehouse-ops
Package: @suaveplan/api-plugin-warehouse-ops
Category: api/logistics
Target path: api/logistics/api-plugin-warehouse-ops
Status: PROPOSED
Date: 2026-04-24
Reference spec: /mnt/s/web/suaveplan/enterprise/api-plugin-warehouse-ops.md

Summary

Deliver @suaveplan/api-plugin-warehouse-ops on the genesis branch from scratch at enterprise quality. Warehouse operations plugin: zone/aisle/location bin management, inbound (receive/putaway), outbound (pick/pack/dispatch), pick-list generation, wave planning, bin slotting optimisation, and cycle-count workflows. Emits warehouse:pickpack:ready to trigger @suaveplan/api-plugin-logistics auto-shipment creation. Routes under /warehouse. Per-table SurrealQL. Events: warehouse:goods:received, warehouse:pickpack:ready, warehouse:cycle-count:completed.

Available workspace deps on genesis

Package	Role
`@suaveplan/api` (`workspace:^`)	`definePlugin`
`@suaveplan/api-shared` (`workspace:^`)	Helpers
`@suaveplan/api-plugin-auth` (`workspace:^`)	`requireAuth`
`@suaveplan/api-plugin-database` (`workspace:^`)	SurrealDB
`@suaveplan/api-plugin-inventory` (`workspace:^`)	Stock level queries
`@suaveplan/events` (`workspace:^`)	Event bus
`@suaveplan/error` (`workspace:^`)	`WarehouseError` hierarchy
`@suaveplan/idempotency` (`workspace:^`)	Mutation guard
`@suaveplan/audit-logging` (`workspace:^`)	Audit
`@suaveplan/barcode` (`workspace:^`)	Bin/pallet label printing
`hono` + `@hono/zod-openapi` + `zod`	Routes
`@opentelemetry/api`	OTel

Public API surface

function createWarehouseOpsPlugin(config?: WarehouseOpsConfig): PluginDescriptor
// Services: ZoneService, BinService, InboundService, OutboundService,
//           PickListService, CycleCountService
// Routes: /warehouse/zones, /warehouse/bins, /warehouse/inbound,
//         /warehouse/outbound, /warehouse/pick-lists, /warehouse/cycle-counts

Error codes

type WarehouseErrorCode =
  | "WAREHOUSE_ZONE_NOT_FOUND"
  | "WAREHOUSE_BIN_NOT_FOUND"
  | "WAREHOUSE_BIN_OCCUPIED"
  | "WAREHOUSE_PICK_NOT_FOUND"
  | "WAREHOUSE_INSUFFICIENT_STOCK"
  | "WAREHOUSE_CYCLE_COUNT_OPEN"

File layout

api/logistics/api-plugin-warehouse-ops/
  package.json  tsconfig.json  vitest.config.ts
  surql/ (zone, aisle, bin, inbound_receipt, pick_list, pick_line, cycle_count tables)
  src/
    index.ts  events.ts  types/  errors/
    services/zone/  services/bin/  services/inbound/  services/outbound/
    services/pick-list/  services/cycle-count/
    routes/warehouse/
  tests/integration.test.ts

Impact

Prerequisites: @suaveplan/api, @suaveplan/api-plugin-auth, @suaveplan/api-plugin-database, @suaveplan/api-plugin-inventory, @suaveplan/events, @suaveplan/idempotency, @suaveplan/barcode.

2.9 KiB Raw Blame History