@sales-planner/shared 0.16.0 → 0.17.0

package/README.md

@@ -140,6 +140,17 @@ The API uses **numeric IDs** internally for referential integrity:
 | `UserRole` | User-role assignment |
 | `ApiKey` | API authentication key |
 | `Marketplace` | E-commerce platform (numeric ID, shop-scoped) |
+| `SkuMetrics` | Computed SKU metrics (read-only, from materialized view) |
+
+### Computed Entities (Read-Only)
+
+| Type | Description |
+|------|-------------|
+| `SkuMetrics` | Aggregated SKU metrics from materialized view |
+| `SkuMetrics.abc_class` | ABC classification: 'A' (top 20%), 'B' (next 30%), 'C' (bottom 50%) |
+| `SkuMetrics.sales_rank` | Sales rank within shop (1 = highest) |
+| `SkuMetrics.days_of_stock` | Estimated days of stock based on sales velocity |
+| `SkuMetrics.last_period_sales` | Total sales quantity for the last period |
 
 ### Query Types
 

package/dist/entities/index.d.ts

@@ -21,4 +21,5 @@ export * from './sku-competitor-mappings';
 export * from './competitor-sales';
 export * from './roles';
 export * from './api-keys';
+export * from './sku-metrics';
 //# sourceMappingURL=index.d.ts.map

package/dist/entities/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/entities/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC;AACxB,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,yBAAyB,CAAC;AACxC,cAAc,uBAAuB,CAAC;AACtC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,oBAAoB,CAAC;AACnC,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/entities/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC;AACxB,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,yBAAyB,CAAC;AACxC,cAAc,uBAAuB,CAAC;AACtC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,oBAAoB,CAAC;AACnC,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAG3B,cAAc,eAAe,CAAC"}

package/dist/entities/index.js

@@ -37,3 +37,5 @@ __exportStar(require("./sku-competitor-mappings"), exports);
 __exportStar(require("./competitor-sales"), exports);
 __exportStar(require("./roles"), exports);
 __exportStar(require("./api-keys"), exports);
+// Computed entities (materialized views)
+__exportStar(require("./sku-metrics"), exports);

package/dist/entities/sku-metrics.d.ts

@@ -0,0 +1,34 @@
+/**
+ * SKU Metrics - Computed entity from materialized view
+ *
+ * This is a read-only computed entity providing aggregated metrics for SKUs
+ * including sales, stock levels, and ABC classification.
+ */
+export interface SkuMetrics {
+    id: number;
+    sku_id: number;
+    shop_id: number;
+    tenant_id: number;
+    sku_code: string;
+    sku_title: string;
+    group_code: string | null;
+    category_code: string | null;
+    brand_code: string | null;
+    status_code: string | null;
+    supplier_code: string | null;
+    /** Period in YYYY-MM format */
+    last_period: string;
+    /** Total sales quantity for the last period */
+    last_period_sales: number;
+    /** Current stock across all warehouses */
+    current_stock: number;
+    /** Estimated days of stock based on sales velocity */
+    days_of_stock: number | null;
+    /** ABC classification: A (top 20%), B (next 30%), C (bottom 50%) */
+    abc_class: 'A' | 'B' | 'C';
+    /** Sales rank within the shop (1 = highest sales) */
+    sales_rank: number;
+    /** When this metric was last computed */
+    computed_at: Date;
+}
+//# sourceMappingURL=sku-metrics.d.ts.map

package/dist/entities/sku-metrics.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sku-metrics.d.ts","sourceRoot":"","sources":["../../src/entities/sku-metrics.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,+BAA+B;IAC/B,WAAW,EAAE,MAAM,CAAC;IACpB,+CAA+C;IAC/C,iBAAiB,EAAE,MAAM,CAAC;IAC1B,0CAA0C;IAC1C,aAAa,EAAE,MAAM,CAAC;IACtB,sDAAsD;IACtD,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,oEAAoE;IACpE,SAAS,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;IAC3B,qDAAqD;IACrD,UAAU,EAAE,MAAM,CAAC;IACnB,yCAAyC;IACzC,WAAW,EAAE,IAAI,CAAC;CACnB"}

package/dist/entities/sku-metrics.js

@@ -0,0 +1,8 @@
+"use strict";
+/**
+ * SKU Metrics - Computed entity from materialized view
+ *
+ * This is a read-only computed entity providing aggregated metrics for SKUs
+ * including sales, stock levels, and ABC classification.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sales-planner/shared",
-  "version": "0.16.0",
+  "version": "0.17.0",
   "description": "Shared types and DTOs for Sales Planner API",
   "author": "Damir Manapov",
   "license": "MIT",