@tewtawanc/loops-utils 1.0.0

package/dist/index.d.mts

@@ -0,0 +1,140 @@
+/**
+ * @tewtawanc/loops-utils
+ *
+ * Shared utilities for Loops warehouse management system.
+ *
+ * SKU Generation:
+ * - Inventory SKU: Product specifications (grade, lot, material, weight, package)
+ * - Stock SKU: Physical units with location tracking
+ *
+ * @example
+ * import { generateInventorySku, generateStockSku } from '@tewtawanc/loops-utils';
+ *
+ * const sku = generateInventorySku({
+ *   grade: 'HD6600B',
+ *   lotNumber: 'H5490205B',
+ *   materialCode: 'C/P',
+ *   netWeight: 25,
+ *   packageType: 'PALLET'
+ * });
+ * // Returns: "HD6600B-H5490205B-C/P-25KG-PALLET"
+ */
+interface InventorySkuParams {
+    materialCode: string;
+    grade: string;
+    lotNumber: string;
+    netWeight: number;
+    packageType: string;
+}
+interface StockSkuParams extends InventorySkuParams {
+    stockNumber: string;
+}
+/**
+ * Normalize SKU component to ensure valid SKU string:
+ * - Trims whitespace from both ends
+ * - Converts to uppercase for consistency
+ * - Replaces spaces with underscores
+ * - Removes special characters except / (for codes like C/P) and _ (word separator)
+ * - Removes consecutive underscores
+ * - Removes leading/trailing underscores
+ */
+declare function normalizeSkuComponent(component: string): string;
+/**
+ * Format weight with appropriate precision
+ * - Integer weights: "25"
+ * - Decimal weights: "25.5"
+ */
+declare function formatWeight(weight: number): string;
+/**
+ * Generate SKU for logical Inventory
+ * Format: {grade}-{lotNumber}-{materialCode}-{netWeight}KG-{packageType}
+ *
+ * @example
+ * generateInventorySku({
+ *   materialCode: 'C/P',
+ *   grade: 'HD6600B',
+ *   lotNumber: 'H5490205B',
+ *   netWeight: 25.0,
+ *   packageType: 'PALLET'
+ * })
+ * // Returns: "HD6600B-H5490205B-C/P-25KG-PALLET"
+ */
+declare function generateInventorySku(params: InventorySkuParams): string;
+/**
+ * Generate SKU for physical Stock
+ * Format: {inventorySKU}-{stockNumber}
+ *
+ * @example
+ * generateStockSku({
+ *   materialCode: 'C/P',
+ *   grade: 'HD6600B',
+ *   lotNumber: 'H5490205B',
+ *   netWeight: 25.0,
+ *   packageType: 'PALLET',
+ *   stockNumber: 'P001234'
+ * })
+ * // Returns: "HD6600B-H5490205B-C/P-25KG-PALLET-P001234"
+ */
+declare function generateStockSku(params: StockSkuParams): string;
+/**
+ * Parse an Inventory SKU into its components
+ *
+ * @example
+ * parseInventorySku('HD6600B-H5490205B-C/P-25KG-PALLET')
+ * // Returns: {
+ * //   materialCode: 'C/P',
+ * //   grade: 'HD6600B',
+ * //   lotNumber: 'H5490205B',
+ * //   netWeight: 25.0,
+ * //   packageType: 'PALLET'
+ * // }
+ */
+declare function parseInventorySku(sku: string): InventorySkuParams | null;
+/**
+ * Parse a Stock SKU into its components
+ *
+ * @example
+ * parseStockSku('HD6600B-H5490205B-C/P-25KG-PALLET-P001234')
+ * // Returns: {
+ * //   materialCode: 'C/P',
+ * //   grade: 'HD6600B',
+ * //   lotNumber: 'H5490205B',
+ * //   netWeight: 25.0,
+ * //   packageType: 'PALLET',
+ * //   stockNumber: 'P001234'
+ * // }
+ */
+declare function parseStockSku(sku: string): StockSkuParams | null;
+/**
+ * Extract inventory SKU from stock SKU
+ *
+ * @example
+ * extractInventorySku('HD6600B-H5490205B-C/P-25KG-PALLET-P001234')
+ * // Returns: "HD6600B-H5490205B-C/P-25KG-PALLET"
+ */
+declare function extractInventorySku(stockSku: string): string | null;
+/**
+ * Validate if a string is a valid Inventory SKU format
+ */
+declare function isValidInventorySku(sku: string): boolean;
+/**
+ * Validate if a string is a valid Stock SKU format
+ */
+declare function isValidStockSku(sku: string): boolean;
+/**
+ * Generate a human-readable name from SKU components
+ * Format: {grade} {lotNumber} {materialCode} {netWeight}kg {packageType}
+ *
+ * @example
+ * generateInventoryName({
+ *   materialCode: 'C/P',
+ *   grade: 'HD6600B',
+ *   lotNumber: 'H5490205B',
+ *   netWeight: 25.0,
+ *   packageType: 'PALLET'
+ * })
+ * // Returns: "HD6600B H5490205B C/P 25kg Pallet"
+ */
+declare function generateInventoryName(params: InventorySkuParams): string;
+
+export { type InventorySkuParams, type StockSkuParams, extractInventorySku, formatWeight, generateInventoryName, generateInventorySku, generateStockSku, isValidInventorySku, isValidStockSku, normalizeSkuComponent, parseInventorySku, parseStockSku };

package/dist/index.d.ts

@@ -0,0 +1,140 @@
+/**
+ * @tewtawanc/loops-utils
+ *
+ * Shared utilities for Loops warehouse management system.
+ *
+ * SKU Generation:
+ * - Inventory SKU: Product specifications (grade, lot, material, weight, package)
+ * - Stock SKU: Physical units with location tracking
+ *
+ * @example
+ * import { generateInventorySku, generateStockSku } from '@tewtawanc/loops-utils';
+ *
+ * const sku = generateInventorySku({
+ *   grade: 'HD6600B',
+ *   lotNumber: 'H5490205B',
+ *   materialCode: 'C/P',
+ *   netWeight: 25,
+ *   packageType: 'PALLET'
+ * });
+ * // Returns: "HD6600B-H5490205B-C/P-25KG-PALLET"
+ */
+interface InventorySkuParams {
+    materialCode: string;
+    grade: string;
+    lotNumber: string;
+    netWeight: number;
+    packageType: string;
+}
+interface StockSkuParams extends InventorySkuParams {
+    stockNumber: string;
+}
+/**
+ * Normalize SKU component to ensure valid SKU string:
+ * - Trims whitespace from both ends
+ * - Converts to uppercase for consistency
+ * - Replaces spaces with underscores
+ * - Removes special characters except / (for codes like C/P) and _ (word separator)
+ * - Removes consecutive underscores
+ * - Removes leading/trailing underscores
+ */
+declare function normalizeSkuComponent(component: string): string;
+/**
+ * Format weight with appropriate precision
+ * - Integer weights: "25"
+ * - Decimal weights: "25.5"
+ */
+declare function formatWeight(weight: number): string;
+/**
+ * Generate SKU for logical Inventory
+ * Format: {grade}-{lotNumber}-{materialCode}-{netWeight}KG-{packageType}
+ *
+ * @example
+ * generateInventorySku({
+ *   materialCode: 'C/P',
+ *   grade: 'HD6600B',
+ *   lotNumber: 'H5490205B',
+ *   netWeight: 25.0,
+ *   packageType: 'PALLET'
+ * })
+ * // Returns: "HD6600B-H5490205B-C/P-25KG-PALLET"
+ */
+declare function generateInventorySku(params: InventorySkuParams): string;
+/**
+ * Generate SKU for physical Stock
+ * Format: {inventorySKU}-{stockNumber}
+ *
+ * @example
+ * generateStockSku({
+ *   materialCode: 'C/P',
+ *   grade: 'HD6600B',
+ *   lotNumber: 'H5490205B',
+ *   netWeight: 25.0,
+ *   packageType: 'PALLET',
+ *   stockNumber: 'P001234'
+ * })
+ * // Returns: "HD6600B-H5490205B-C/P-25KG-PALLET-P001234"
+ */
+declare function generateStockSku(params: StockSkuParams): string;
+/**
+ * Parse an Inventory SKU into its components
+ *
+ * @example
+ * parseInventorySku('HD6600B-H5490205B-C/P-25KG-PALLET')
+ * // Returns: {
+ * //   materialCode: 'C/P',
+ * //   grade: 'HD6600B',
+ * //   lotNumber: 'H5490205B',
+ * //   netWeight: 25.0,
+ * //   packageType: 'PALLET'
+ * // }
+ */
+declare function parseInventorySku(sku: string): InventorySkuParams | null;
+/**
+ * Parse a Stock SKU into its components
+ *
+ * @example
+ * parseStockSku('HD6600B-H5490205B-C/P-25KG-PALLET-P001234')
+ * // Returns: {
+ * //   materialCode: 'C/P',
+ * //   grade: 'HD6600B',
+ * //   lotNumber: 'H5490205B',
+ * //   netWeight: 25.0,
+ * //   packageType: 'PALLET',
+ * //   stockNumber: 'P001234'
+ * // }
+ */
+declare function parseStockSku(sku: string): StockSkuParams | null;
+/**
+ * Extract inventory SKU from stock SKU
+ *
+ * @example
+ * extractInventorySku('HD6600B-H5490205B-C/P-25KG-PALLET-P001234')
+ * // Returns: "HD6600B-H5490205B-C/P-25KG-PALLET"
+ */
+declare function extractInventorySku(stockSku: string): string | null;
+/**
+ * Validate if a string is a valid Inventory SKU format
+ */
+declare function isValidInventorySku(sku: string): boolean;
+/**
+ * Validate if a string is a valid Stock SKU format
+ */
+declare function isValidStockSku(sku: string): boolean;
+/**
+ * Generate a human-readable name from SKU components
+ * Format: {grade} {lotNumber} {materialCode} {netWeight}kg {packageType}
+ *
+ * @example
+ * generateInventoryName({
+ *   materialCode: 'C/P',
+ *   grade: 'HD6600B',
+ *   lotNumber: 'H5490205B',
+ *   netWeight: 25.0,
+ *   packageType: 'PALLET'
+ * })
+ * // Returns: "HD6600B H5490205B C/P 25kg Pallet"
+ */
+declare function generateInventoryName(params: InventorySkuParams): string;
+
+export { type InventorySkuParams, type StockSkuParams, extractInventorySku, formatWeight, generateInventoryName, generateInventorySku, generateStockSku, isValidInventorySku, isValidStockSku, normalizeSkuComponent, parseInventorySku, parseStockSku };

package/dist/index.js

@@ -0,0 +1,124 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  extractInventorySku: () => extractInventorySku,
+  formatWeight: () => formatWeight,
+  generateInventoryName: () => generateInventoryName,
+  generateInventorySku: () => generateInventorySku,
+  generateStockSku: () => generateStockSku,
+  isValidInventorySku: () => isValidInventorySku,
+  isValidStockSku: () => isValidStockSku,
+  normalizeSkuComponent: () => normalizeSkuComponent,
+  parseInventorySku: () => parseInventorySku,
+  parseStockSku: () => parseStockSku
+});
+module.exports = __toCommonJS(index_exports);
+function normalizeSkuComponent(component) {
+  return component.trim().toUpperCase().replace(/\s+/g, "_").replace(/[^A-Z0-9/_]/g, "").replace(/_+/g, "_").replace(/^_+|_+$/g, "");
+}
+function formatWeight(weight) {
+  if (Number.isInteger(weight)) {
+    return weight.toString();
+  }
+  return weight.toFixed(2).replace(/\.?0+$/, "");
+}
+function generateInventorySku(params) {
+  const { materialCode, grade, lotNumber, netWeight, packageType } = params;
+  const normalizedMaterialCode = normalizeSkuComponent(materialCode);
+  const normalizedGrade = normalizeSkuComponent(grade);
+  const normalizedLotNumber = normalizeSkuComponent(lotNumber);
+  const normalizedPackageType = normalizeSkuComponent(packageType);
+  const weightStr = formatWeight(netWeight);
+  return `${normalizedGrade}-${normalizedLotNumber}-${normalizedMaterialCode}-${weightStr}KG-${normalizedPackageType}`;
+}
+function generateStockSku(params) {
+  const inventorySku = generateInventorySku(params);
+  const normalizedStockNumber = normalizeSkuComponent(params.stockNumber);
+  return `${inventorySku}-${normalizedStockNumber}`;
+}
+function parseInventorySku(sku) {
+  const parts = sku.split("-");
+  if (parts.length < 5) {
+    return null;
+  }
+  const grade = parts[0];
+  const lotNumber = parts[1];
+  const materialCode = parts[2];
+  const weightPart = parts[3];
+  if (!weightPart.endsWith("KG")) {
+    return null;
+  }
+  const netWeight = parseFloat(weightPart.replace("KG", ""));
+  const packageType = parts[4];
+  return {
+    materialCode,
+    grade,
+    lotNumber,
+    netWeight,
+    packageType
+  };
+}
+function parseStockSku(sku) {
+  const parts = sku.split("-");
+  if (parts.length < 6) {
+    return null;
+  }
+  const inventoryParams = parseInventorySku(parts.slice(0, 5).join("-"));
+  if (!inventoryParams) {
+    return null;
+  }
+  return {
+    ...inventoryParams,
+    stockNumber: parts[5]
+  };
+}
+function extractInventorySku(stockSku) {
+  const parsed = parseStockSku(stockSku);
+  if (!parsed) {
+    return null;
+  }
+  return generateInventorySku(parsed);
+}
+function isValidInventorySku(sku) {
+  return parseInventorySku(sku) !== null;
+}
+function isValidStockSku(sku) {
+  return parseStockSku(sku) !== null;
+}
+function generateInventoryName(params) {
+  const { materialCode, grade, lotNumber, netWeight, packageType } = params;
+  const capitalizedPackageType = packageType.toLowerCase().split("_").map((word) => word.charAt(0).toUpperCase() + word.slice(1)).join(" ");
+  return `${grade} ${lotNumber} ${materialCode} ${netWeight}kg ${capitalizedPackageType}`;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  extractInventorySku,
+  formatWeight,
+  generateInventoryName,
+  generateInventorySku,
+  generateStockSku,
+  isValidInventorySku,
+  isValidStockSku,
+  normalizeSkuComponent,
+  parseInventorySku,
+  parseStockSku
+});

package/dist/index.mjs

@@ -0,0 +1,90 @@
+// src/index.ts
+function normalizeSkuComponent(component) {
+  return component.trim().toUpperCase().replace(/\s+/g, "_").replace(/[^A-Z0-9/_]/g, "").replace(/_+/g, "_").replace(/^_+|_+$/g, "");
+}
+function formatWeight(weight) {
+  if (Number.isInteger(weight)) {
+    return weight.toString();
+  }
+  return weight.toFixed(2).replace(/\.?0+$/, "");
+}
+function generateInventorySku(params) {
+  const { materialCode, grade, lotNumber, netWeight, packageType } = params;
+  const normalizedMaterialCode = normalizeSkuComponent(materialCode);
+  const normalizedGrade = normalizeSkuComponent(grade);
+  const normalizedLotNumber = normalizeSkuComponent(lotNumber);
+  const normalizedPackageType = normalizeSkuComponent(packageType);
+  const weightStr = formatWeight(netWeight);
+  return `${normalizedGrade}-${normalizedLotNumber}-${normalizedMaterialCode}-${weightStr}KG-${normalizedPackageType}`;
+}
+function generateStockSku(params) {
+  const inventorySku = generateInventorySku(params);
+  const normalizedStockNumber = normalizeSkuComponent(params.stockNumber);
+  return `${inventorySku}-${normalizedStockNumber}`;
+}
+function parseInventorySku(sku) {
+  const parts = sku.split("-");
+  if (parts.length < 5) {
+    return null;
+  }
+  const grade = parts[0];
+  const lotNumber = parts[1];
+  const materialCode = parts[2];
+  const weightPart = parts[3];
+  if (!weightPart.endsWith("KG")) {
+    return null;
+  }
+  const netWeight = parseFloat(weightPart.replace("KG", ""));
+  const packageType = parts[4];
+  return {
+    materialCode,
+    grade,
+    lotNumber,
+    netWeight,
+    packageType
+  };
+}
+function parseStockSku(sku) {
+  const parts = sku.split("-");
+  if (parts.length < 6) {
+    return null;
+  }
+  const inventoryParams = parseInventorySku(parts.slice(0, 5).join("-"));
+  if (!inventoryParams) {
+    return null;
+  }
+  return {
+    ...inventoryParams,
+    stockNumber: parts[5]
+  };
+}
+function extractInventorySku(stockSku) {
+  const parsed = parseStockSku(stockSku);
+  if (!parsed) {
+    return null;
+  }
+  return generateInventorySku(parsed);
+}
+function isValidInventorySku(sku) {
+  return parseInventorySku(sku) !== null;
+}
+function isValidStockSku(sku) {
+  return parseStockSku(sku) !== null;
+}
+function generateInventoryName(params) {
+  const { materialCode, grade, lotNumber, netWeight, packageType } = params;
+  const capitalizedPackageType = packageType.toLowerCase().split("_").map((word) => word.charAt(0).toUpperCase() + word.slice(1)).join(" ");
+  return `${grade} ${lotNumber} ${materialCode} ${netWeight}kg ${capitalizedPackageType}`;
+}
+export {
+  extractInventorySku,
+  formatWeight,
+  generateInventoryName,
+  generateInventorySku,
+  generateStockSku,
+  isValidInventorySku,
+  isValidStockSku,
+  normalizeSkuComponent,
+  parseInventorySku,
+  parseStockSku
+};

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@tewtawanc/loops-utils",
+  "version": "1.0.0",
+  "description": "Shared utilities for Loops warehouse management system",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "sku",
+    "inventory",
+    "warehouse"
+  ],
+  "author": "tewtawanc",
+  "license": "MIT",
+  "devDependencies": {
+    "tsup": "^8.0.0",
+    "typescript": "^5.0.0"
+  }
+}