cecon-interfaces 1.1.79 → 1.1.80

package/dist/product-global/interfaces/i-product.d.ts

@@ -0,0 +1,211 @@
+import { GTINTypeEnum } from '../enums';
+import { IProductBrand } from './i-brand';
+import { IProductNcm } from './i-ncm';
+export interface IProductBase {
+    /**
+     * Indicates whether the product is active.
+     * @default true
+     * @example true
+     */
+    active: boolean;
+    /**
+     * Average price of the product.
+     * @example 1.5
+     * @default 0
+     * @minimum 0
+     * @maximum 9999999999999.99
+     */
+    avgPrice: number;
+    /**
+     * Barcode of the product.
+     * @example "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAYAAACtWK6eAAAgAElEQ…"
+     * @default ""
+     */
+    barcodeImage: string | null;
+    /**
+     * Contains brand information of the product.
+     * @example { "id": "5e4f1b1b1b1b1b1b1b1b1b1b", "name": "Brand name" }
+     *
+     */
+    brand: IProductBrand;
+    /**
+     * CEST Code.
+     * @minlength 7
+     * @maxlength 7
+     */
+    cest: string | null;
+    /**
+     * Date of product creation.
+     * @format date-time
+     * @example "2019-01-01T00:00:00.000Z"
+     * @default Date.now()
+     * @readonly
+     */
+    createdAt: Date;
+    /**
+     * Description of the product or service.
+     * @minlength 1
+     * @maxlength 120
+     * @example "Product description"
+     */
+    description: string;
+    /**
+     * Gross weight of the product.
+     * @example 1.5
+     * @default 0
+     */
+    grossWeight: number | null;
+    /**
+     * Unit of measurement of gross weight.
+     * @minlength 1
+     * @maxlength 6
+     */
+    grossWeightUnit: string | null;
+    /**
+     * To be filled with the GTIN-8, GTIN-12, GTIN-13 or GTIN-14 code
+     * (old EAN, UPC and DUN-14 codes).
+     * For products that do not have a bar code with GTIN,
+     * the literal "WITHOUT GTIN" must be informed.
+     * @minlength 1
+     * @maxlength 14
+     * @example "123456789"
+     */
+    gtin: string;
+    /**
+     * Type of GTIN.
+     * @default GTINTypeEnum.GTIN_13
+     * @minlength 1
+     * @maxlength 8
+     */
+    gtinType: GTINTypeEnum;
+    /**
+     * Height of the product.
+     * @example 15
+     * @default 0
+     */
+    height: number | null;
+    /**
+     * Identifier of the product.
+     * @minlength 24
+     * @maxlength 24
+     * @example "5e4f1b1b1b1b1b1b1b1b1b1b"
+     */
+    id: string;
+    /**
+     * Length of the product.
+     * @example 15
+     * @default 0
+     */
+    length: number | null;
+    /**
+     * Max cost of the product.
+     * @example 1.5
+     * @default 0
+     * @minimum 0
+     * @maximum 9999999999999.99
+     */
+    maxPrice: number;
+    /**
+     * Quantity of the product.
+     * @example 1.5
+     * @default 0
+     */
+    measureQuantity: number;
+    /**
+     * Height of the product.
+     * @example "UN"
+     * @default "UN"
+     */
+    measureUnit: string;
+    /**
+     * Min cost of the product.
+     * @example 1.5
+     * @default 0
+     * @minimum 0
+     * @maximum 9999999999999.99
+     */
+    minPrice: number;
+    /**
+     * Name of the product.
+     * @minlength 1
+     * @maxlength 120
+     * @example "Product name"
+     */
+    name: string;
+    /**
+     * Fill in with the full NCM Code (position and sub-item) or, if you do not have it,
+     * with the NCM code "00" (two zeros). Format: "99999999" or "00"
+     * @minlength 2
+     * @maxlength 8
+     */
+    ncm: IProductNcm;
+    /**
+     * Net weight of the product.
+     * @example 1.5
+     * @default 0
+     * @minimum 0
+     * @maximum 9999999999999.999
+     * @multipleOf 0.001
+     */
+    netWeight: number | null;
+    /**
+     * Unit of measurement of net weight.
+     * @minlength 1
+     * @maxlength 6
+     * @example "KG"
+     * @default "UN"
+     * @pattern ^[A-Z]+$
+     */
+    netWeightUnit: string | null;
+    /**
+     * Price of the product.
+     * @example 1.5
+     * @default 0
+     * @minimum 0
+     * @maximum 9999999999999.99
+     * @multipleOf 0.01
+     */
+    price: number;
+    /**
+     * Code of the product.
+     * @minlength 1
+     * @maxlength 60
+     * @pattern ^[a-zA-Z0-9]+$
+     * @example "123456789"
+     */
+    sku: string;
+    /**
+     * Tags associated with the product.
+     * @example ["tag1", "tag2"]
+     * @default []
+     * @uniqueItems true
+     * @minItems 0
+     * @maxItems 50
+     * @items
+     * @minlength 1
+     * @maxlength 60
+     */
+    tags: string[];
+    /**
+     * URL of the product image.
+     * @minlength 1
+     * @maxlength 120
+     * @example "https://www.example.com/image.jpg"
+     * @default ""
+     */
+    thumbnail: string | null;
+    /**
+     * Date when the product was last updated.
+     * @format date-time
+     * @example "2019-01-01T00:00:00.000Z"
+     * @default Date.now()
+     */
+    updatedAt: Date;
+    /**
+     * Width of the product.
+     * @example 15
+     * @default 0
+     *
+     */
+    width: number | null;
+}

package/dist/product-global/interfaces/i-product.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/product-global/interfaces/index.d.ts

@@ -0,0 +1,3 @@
+export { IProductBrand } from './i-brand';
+export { IProductNcm } from './i-ncm';
+export { IProductBase } from './i-product';

package/dist/product-global/interfaces/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "cecon-interfaces",
-    "version": "1.1.79",
+    "version": "1.1.80",
     "description": "Interfaces de Projetos Cecon",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",