@softwear/latestcollectioncore 1.0.4 → 1.0.6

package/dist/index.d.ts

@@ -1,2 +1,3 @@
 export { default as ean13 } from "./ean13";
 export { default as hashBrand } from "./hashBrand";
+export * from "./types";

package/dist/index.js

@@ -1,4 +1,18 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -8,3 +22,4 @@ var ean13_1 = require("./ean13");
 Object.defineProperty(exports, "ean13", { enumerable: true, get: function () { return __importDefault(ean13_1).default; } });
 var hashBrand_1 = require("./hashBrand");
 Object.defineProperty(exports, "hashBrand", { enumerable: true, get: function () { return __importDefault(hashBrand_1).default; } });
+__exportStar(require("./types"), exports);

package/dist/types.d.ts

@@ -0,0 +1,179 @@
+declare enum vatCategoryE {
+    LOW = "low",
+    HIGH = "high",
+    ZERO = "zero"
+}
+declare enum tagTypeE {
+    STICKER = "stikker",
+    LABEL = "label"
+}
+interface ImageI {
+    name: string;
+    url: string;
+}
+interface GroupI {
+    name: string;
+    value: string;
+}
+interface CareI {
+    temperature: number;
+    bleach: number;
+    iron: number;
+    chemical: number;
+    dryer: number;
+}
+interface AttributeI {
+    key: string;
+    value: string;
+}
+type barcode = string;
+interface RowI {
+    cells: {
+        key?: barcode | undefined;
+        value: number;
+        state?: string;
+    }[];
+    group: string;
+    initialIndex?: number;
+    filteredOut?: boolean;
+    warehouse?: string;
+    selected?: boolean;
+}
+interface MatrixI {
+    matrixMetadata: string | string[];
+    headers: string[];
+    rows: RowI[];
+}
+interface StockAdviceMatrixI {
+    rows: RowI[];
+    selection: StockAdviceSelectionI;
+}
+interface StockAdviceDataI extends StockAdviceMatrixI {
+    rowIndex: number;
+    cellIndex: number | undefined;
+    value: number | undefined;
+}
+interface StockAdviceSelectionI {
+    cells: {
+        cellIndex: number;
+        value: number;
+    }[];
+    rowIndex: number | null;
+}
+/**
+ * A SKU is the main building block of our product data model.
+ * It is the most granualar piece of information. We store all possible properties at this object. That is very redundant but we do it for a reason.
+ * Most product data nowadays is coming from external sources and the SKU is most often used as the communication unit bringing along all those redundant properties.
+ * There is no consensus in the market about how to structure that data any further so imposing any structure upon it ultimately will result in conflicts.
+ * Therefore, we keep the redundancy to accomodate all possible data and regard that as our single source of truth.
+ *
+ * UPPERCASE propertynames are used for properties that are added for UI purposes only.
+ * They are not part of the persistent data model
+ */
+interface SkuI {
+    barcode?: barcode;
+    id?: barcode;
+    primary: boolean;
+    articleCode: string;
+    articleDescription: string;
+    pricetagLayouts: string;
+    brand: string;
+    articleGroup: string;
+    articleGroupSupplier?: string;
+    ATTRIBUTES?: object;
+    IMAGES?: Array<ImageI>;
+    images?: string;
+    SIZES?: unknown;
+    groups: Array<GroupI>;
+    vat: number;
+    vatCategory: vatCategoryE;
+    supplierName?: string;
+    size: string;
+    sizeSupplier?: string;
+    mainSize?: string;
+    subSize?: string;
+    subSizeSupplier?: string;
+    sizeIndex: number;
+    sizes?: Array<string>;
+    sizeRange?: string;
+    colorCode?: string;
+    colorDescription?: string;
+    colorSupplier?: string;
+    colorCodeSupplier?: string;
+    colorFamily: string;
+    mainColorCode: string;
+    mainColorDescription?: string;
+    subColorCode?: string;
+    subColorDescription?: string;
+    articleCodeSupplier?: string;
+    price: number;
+    buyPrice: number;
+    suggestedRetailPrice: number;
+    valuePrice: number;
+    salePrice: number;
+    prices?: unknown;
+    year?: string;
+    season?: string;
+    collection: string;
+    collectionSupplier?: string;
+    active: boolean;
+    skuActive: boolean;
+    warehouseLocation: string;
+    tagType?: tagTypeE;
+    directDelivery?: boolean;
+    care?: CareI;
+}
+interface MarkedSkuI extends SkuI {
+    source?: string;
+    usedByTenant?: boolean;
+    warehouse?: string;
+    qty?: number;
+}
+interface ColorI {
+    color: string;
+    subColors: Array<string>;
+    IMAGES: Array<ImageI>;
+    colorCodeSupplier: string;
+    colorSupplier: string;
+    newColor?: boolean;
+}
+/**
+ * A product is our abstraction of a set of SKU's that share the same brand and articleCode (productId)
+ * Softwear versions before 7.0 regarded the product as the main unit of information having multiple colors and sizes assoiated with it.
+ * From version 7.0 and up we regard the SKU as the main unit of information. A product serves merely as an representational abstraction of a series of SKUs.
+ *
+ */
+interface ProductI {
+    ATTRIBUTES: object;
+    COLORS: Array<ColorI>;
+    IMAGES?: unknown;
+    INDEX: object;
+    MATRIX?: MatrixI;
+    SIZES: Array<string>;
+    SKUS: Array<MarkedSkuI>;
+    active: boolean;
+    articleCode: string;
+    articleCodeSupplier?: string;
+    articleDescription: string;
+    articleGroup: string;
+    articleGroupSupplier: string;
+    brand: string;
+    buyPrice: number;
+    care?: CareI;
+    collection: string;
+    collectionSupplier: string;
+    groups: Array<GroupI>;
+    price: number;
+    prices?: unknown;
+    pricetagLayouts: Array<string>;
+    season?: string;
+    suggestedRetailPrice: number;
+    supplierName?: string;
+    tagType?: tagTypeE;
+    valuePrice: number;
+    vat: number;
+    vatCategory: vatCategoryE;
+    warehouseLocation: string;
+    year?: string;
+}
+export { RowI, StockAdviceSelectionI, MarkedSkuI, vatCategoryE, tagTypeE, SkuI, GroupI, ProductI, ImageI, AttributeI, ColorI, MatrixI, StockAdviceDataI, StockAdviceMatrixI };

package/dist/types.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tagTypeE = exports.vatCategoryE = void 0;
+var vatCategoryE;
+(function (vatCategoryE) {
+    vatCategoryE["LOW"] = "low";
+    vatCategoryE["HIGH"] = "high";
+    vatCategoryE["ZERO"] = "zero";
+})(vatCategoryE || (vatCategoryE = {}));
+exports.vatCategoryE = vatCategoryE;
+var tagTypeE;
+(function (tagTypeE) {
+    tagTypeE["STICKER"] = "stikker";
+    tagTypeE["LABEL"] = "label";
+})(tagTypeE || (tagTypeE = {}));
+exports.tagTypeE = tagTypeE;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@softwear/latestcollectioncore",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "Core functions for LatestCollections applications",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/index.ts

@@ -1,2 +1,3 @@
 export { default as ean13 } from "./ean13"
 export { default as hashBrand } from "./hashBrand"
+export * from "./types"

package/src/types.ts

@@ -0,0 +1,191 @@
+enum vatCategoryE {
+  LOW = "low",
+  HIGH = "high",
+  ZERO = "zero",
+}
+
+enum tagTypeE {
+  STICKER = "stikker",
+  LABEL = "label",
+}
+
+interface ImageI {
+  name: string
+  url: string
+}
+
+interface GroupI {
+  name: string
+  value: string
+}
+
+interface CareI {
+  temperature: number
+  bleach: number
+  iron: number
+  chemical: number
+  dryer: number
+}
+
+interface AttributeI {
+  key: string
+  value: string
+}
+// better represents what the key is in MatrixI
+type barcode = string
+
+interface RowI {
+  cells: { key?: barcode | undefined; value: number; state?: string }[] // uses the barcode for backtracking of each cell
+  group: string // first column of a row, could be a grouper or a color
+  initialIndex?: number // used for filtered data
+  filteredOut?: boolean // used for filtered data
+  warehouse?: string // used for stock management, the actual string might be in the group key as well
+  selected?: boolean // used for UI
+}
+
+interface MatrixI {
+  matrixMetadata: string | string[]
+  headers: string[]
+  rows: RowI[]
+}
+
+interface StockAdviceMatrixI {
+  rows: RowI[]
+  selection: StockAdviceSelectionI
+}
+
+interface StockAdviceDataI extends StockAdviceMatrixI {
+  rowIndex: number
+  cellIndex: number | undefined
+  value: number | undefined
+}
+
+interface StockAdviceSelectionI {
+  cells: {
+    cellIndex: number
+    value: number
+  }[]
+  rowIndex: number | null
+}
+
+/**
+ * A SKU is the main building block of our product data model.
+ * It is the most granualar piece of information. We store all possible properties at this object. That is very redundant but we do it for a reason.
+ * Most product data nowadays is coming from external sources and the SKU is most often used as the communication unit bringing along all those redundant properties.
+ * There is no consensus in the market about how to structure that data any further so imposing any structure upon it ultimately will result in conflicts.
+ * Therefore, we keep the redundancy to accomodate all possible data and regard that as our single source of truth.
+ *
+ * UPPERCASE propertynames are used for properties that are added for UI purposes only.
+ * They are not part of the persistent data model
+ */
+interface SkuI {
+  barcode?: barcode
+  id?: barcode
+  primary: boolean
+  articleCode: string
+  articleDescription: string
+  pricetagLayouts: string
+  brand: string
+  articleGroup: string
+  articleGroupSupplier?: string
+  ATTRIBUTES?: object
+  IMAGES?: Array<ImageI>
+  images?: string
+  SIZES?: unknown
+  groups: Array<GroupI>
+  vat: number
+  vatCategory: vatCategoryE
+  supplierName?: string
+  size: string
+  sizeSupplier?: string
+  mainSize?: string
+  subSize?: string
+  subSizeSupplier?: string
+  sizeIndex: number
+  sizes?: Array<string>
+  sizeRange?: string
+  colorCode?: string
+  colorDescription?: string
+  colorSupplier?: string
+  colorCodeSupplier?: string
+  colorFamily: string
+  mainColorCode: string
+  mainColorDescription?: string
+  subColorCode?: string
+  subColorDescription?: string
+  articleCodeSupplier?: string
+  price: number
+  buyPrice: number
+  suggestedRetailPrice: number
+  valuePrice: number
+  salePrice: number
+  prices?: unknown
+  year?: string
+  season?: string
+  collection: string
+  collectionSupplier?: string
+  active: boolean
+  skuActive: boolean
+  warehouseLocation: string
+  tagType?: tagTypeE
+  directDelivery?: boolean
+  care?: CareI
+}
+
+interface MarkedSkuI extends SkuI {
+  source?: string
+  usedByTenant?: boolean
+  warehouse?: string
+  qty?: number
+}
+
+interface ColorI {
+  color: string
+  subColors: Array<string>
+  IMAGES: Array<ImageI>
+  colorCodeSupplier: string
+  colorSupplier: string
+  newColor?: boolean
+}
+
+/**
+ * A product is our abstraction of a set of SKU's that share the same brand and articleCode (productId)
+ * Softwear versions before 7.0 regarded the product as the main unit of information having multiple colors and sizes assoiated with it.
+ * From version 7.0 and up we regard the SKU as the main unit of information. A product serves merely as an representational abstraction of a series of SKUs.
+ *
+ */
+interface ProductI {
+  ATTRIBUTES: object
+  COLORS: Array<ColorI>
+  IMAGES?: unknown
+  INDEX: object
+  MATRIX?: MatrixI
+  SIZES: Array<string>
+  SKUS: Array<MarkedSkuI>
+  active: boolean
+  articleCode: string
+  articleCodeSupplier?: string
+  articleDescription: string
+  articleGroup: string
+  articleGroupSupplier: string
+  brand: string
+  buyPrice: number
+  care?: CareI
+  collection: string
+  collectionSupplier: string
+  groups: Array<GroupI>
+  price: number
+  prices?: unknown
+  pricetagLayouts: Array<string>
+  season?: string
+  suggestedRetailPrice: number
+  supplierName?: string
+  tagType?: tagTypeE
+  valuePrice: number
+  vat: number
+  vatCategory: vatCategoryE
+  warehouseLocation: string
+  year?: string
+}
+
+export { RowI, StockAdviceSelectionI, MarkedSkuI, vatCategoryE, tagTypeE, SkuI, GroupI, ProductI, ImageI, AttributeI, ColorI, MatrixI, StockAdviceDataI, StockAdviceMatrixI }