@nicefer/types 1.0.13 → 1.0.15

package/dist/index.js

@@ -0,0 +1,31 @@
+"use strict";
+// src/index.ts
+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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/** ID único para un usuario */
+// export type UserId = string & { __brand: 'UserId' };
+__exportStar(require("./types/api"), exports);
+__exportStar(require("./types/bag"), exports);
+__exportStar(require("./types/branch"), exports);
+__exportStar(require("./types/categories"), exports);
+__exportStar(require("./types/countries"), exports);
+__exportStar(require("./types/orders"), exports);
+__exportStar(require("./types/payments"), exports);
+__exportStar(require("./types/product-category"), exports);
+__exportStar(require("./types/products"), exports);
+__exportStar(require("./types/replenishment"), exports);
+__exportStar(require("./types/users"), exports);
+__exportStar(require("./types/warehouses"), exports);

package/dist/types/api.js

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

package/dist/types/bag.js

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

package/dist/types/branch.js

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

package/dist/types/categories.js

@@ -0,0 +1,97 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProductCategories = void 0;
+exports.getSubcategoryByParentId = getSubcategoryByParentId;
+/** @deprecated */
+exports.ProductCategories = [
+    {
+        id: 'tops',
+        title: 'Tops',
+        childs: [
+            { id: 'tops-blouses', title: 'Blusas', parentId: 'tops', },
+            { id: 'tops-knitwear', title: 'Camisas de punto', parentId: 'tops', },
+            { id: 'tops-jackets', title: 'Chaquetas', parentId: 'tops', },
+            { id: 'tops-crop-tops', title: 'Tops cortos', parentId: 'tops', },
+            { id: 'tops-bodysuits', title: 'Body Suits', parentId: 'tops', },
+            { id: 'tops-tank-tops', title: 'Tank tops', parentId: 'tops', }
+        ]
+    },
+    {
+        id: 'dresses',
+        title: 'Vestidos',
+        childs: [
+            { id: 'dresses-casual', title: 'Casual', parentId: 'dresses' },
+            { id: 'dresses-bodycon', title: 'Bodycon', parentId: 'dresses' },
+            { id: 'dresses-maxi', title: 'maxi', parentId: 'dresses' },
+            { id: 'dresses-sun-dresses', title: 'Vestidos de verano', parentId: 'dresses' },
+            { id: 'dresses-long-sleeve', title: 'Long Sleeve', parentId: 'dresses' },
+            { id: 'dresses-knit', title: 'knit', parentId: 'dresses' },
+            { id: 'dresses-midi', title: 'midi', parentId: 'dresses' },
+            { id: 'dresses-mini', title: 'mini', parentId: 'dresses' },
+            { id: 'dresses-off-the-shoulder', title: 'Of the shoulder', parentId: 'dresses' },
+            { id: 'dresses-ruffle', title: 'Ruffle', parentId: 'dresses' },
+            { id: 'dresses-party-dress', title: 'Vestidos de fiesta', parentId: 'dresses' },
+        ]
+    },
+    { id: 't-shirts', title: 'Camisetas' },
+    { id: 'sweatshirts', title: 'Sweatshirts' },
+    { id: 'hoodies', title: 'Hoodies' },
+    {
+        id: 'lingerie',
+        title: 'Lencería',
+        childs: [
+            { id: 'lingerie-bras', title: 'Bras', parentId: 'lingerie' },
+            { id: 'lingerie-bra-sets', title: 'Bra Sets', parentId: 'lingerie' },
+            { id: 'lingerie-panties', title: 'Panties', parentId: 'lingerie' },
+            { id: 'lingerie-shapewear', title: 'shapewear', parentId: 'lingerie' },
+            { id: 'lingerie-plus-size', title: 'Talla grande', parentId: 'lingerie' },
+        ]
+    },
+    {
+        id: 'bottoms',
+        title: 'Bottoms',
+        childs: [
+            { id: 'bottoms-pants', title: 'Pantalones', parentId: 'bottoms' },
+            { id: 'bottoms-skirts', title: 'Faldas', parentId: 'bottoms' },
+            { id: 'bottoms-shorts', title: 'Shorts', parentId: 'bottoms' },
+            { id: 'bottoms-jumpsuits', title: 'jumpsuits', parentId: 'bottoms' },
+            { id: 'bottoms-rompers', title: 'Rompers', parentId: 'bottoms' },
+        ]
+    },
+    {
+        id: 'other',
+        title: 'Otras categorías',
+        childs: [
+            { id: 'other-sports', title: 'Sports', parentId: 'other' },
+            { id: 'other-sets', title: 'Sets', parentId: 'other' },
+            { id: 'other-socks', title: 'Calcetínes', parentId: 'other' },
+            { id: 'other-pajamas', title: 'Pijamas', parentId: 'other' },
+            { id: 'other-denim', title: 'Denim Jackets', parentId: 'other' },
+            { id: 'other-jeans', title: 'Jeans', parentId: 'other' },
+            { id: 'other-hangers', title: 'Hangers', parentId: 'other' },
+            { id: 'other-stockings', title: 'Medias', parentId: 'other' },
+            { id: 'other-leggings', title: 'leggings', parentId: 'other' },
+        ]
+    }
+];
+function getSubcategoryByParentId(categoryId) {
+    /**
+     * Cortar el categoryId
+     * @note La primera posición del split contiene el id de la categoría padre.
+     * @example ```
+     *  const categoryId = '`other`-category';
+     */
+    var splitCategoryId = categoryId.split('-');
+    /**
+     * Id de la categoría padre
+     */
+    var parentCategoryId = splitCategoryId[0];
+    /**
+     * Categoría padre
+     */
+    var parentCategory = exports.ProductCategories.find(function (pc) { return pc.id == parentCategoryId; });
+    if (parentCategory && parentCategory.childs)
+        return parentCategory.childs.find(function (child) { return child.id == categoryId; });
+    else
+        return undefined;
+}

package/dist/types/countries.js

@@ -0,0 +1,175 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.compareRegions = exports.compareCountries = exports.Regions = exports.Countries = void 0;
+exports.getRegionsByCountryId = getRegionsByCountryId;
+exports.Countries = [
+    {
+        id: 'HN',
+        name: 'Honduras',
+        code: 504
+    },
+    {
+        id: 'SV',
+        name: 'El Salvador',
+        code: 503
+    },
+    // {
+    //   id: 'US',
+    //   name: 'Estados Unidos',
+    //   code: '1'
+    // },
+];
+exports.Regions = {
+    HN: [
+        {
+            id: "AT",
+            name: "Atlántida",
+            cities: [
+                { id: "LCB", name: "La Ceiba", regionId: "AT" },
+                { id: "ELP", name: "El Porvenir", regionId: "AT" },
+                { id: "ESP", name: "Esparta", regionId: "AT" },
+                { id: "JUT", name: "Jutiapa", regionId: "AT" },
+                { id: "LAM", name: "La Masica", regionId: "AT" },
+                { id: "SFR", name: "San Francisco", regionId: "AT" },
+                { id: "TEL", name: "Tela", regionId: "AT" },
+                { id: "ARI", name: "Arizona", regionId: "AT" }
+            ]
+        },
+        {
+            id: "CH",
+            name: "Choluteca",
+            cities: []
+        },
+        { id: "CL", name: "Colón" },
+        { id: "CM", name: "Comayagua" },
+        { id: "CP", name: "Copán" },
+        { id: "CR", name: "Cortés" },
+        { id: "EP", name: "El Paraíso" },
+        {
+            id: "FM",
+            name: "Francisco Morazán",
+            cities: [
+                { id: "TGU", name: "Tegucigalpa", regionId: "FM" },
+                { id: "AMA", name: "Amarateca", regionId: "FM" },
+                { id: "AZA", name: "Azacualpa", regionId: "FM" },
+                { id: "CAR", name: "Carpinteron", regionId: "FM" },
+                { id: "CEN", name: "Cerro Grande", regionId: "FM" },
+                { id: "COA", name: "Coa Abajo", regionId: "FM" },
+                { id: "COU", name: "Coa Arriba", regionId: "FM" }, // id corregido
+                { id: "COF", name: "Cofradía", regionId: "FM" },
+                { id: "CON", name: "Concepción de Río Grande", regionId: "FM" },
+                { id: "ELN", name: "El Naranjal", regionId: "FM" },
+                { id: "EPI", name: "El Piliguín", regionId: "FM" },
+                { id: "TIZ", name: "El Tizatillo", regionId: "FM" },
+                { id: "GER", name: "Germania", regionId: "FM" },
+                { id: "GUA", name: "Guangololo", regionId: "FM" },
+                { id: "GUS", name: "Guasculile", regionId: "FM" },
+                { id: "JAC", name: "Jacaleapa", regionId: "FM" },
+                { id: "JUT", name: "Jutiapa", regionId: "FM" },
+                { id: "CAL", name: "La Calera", regionId: "FM" },
+                { id: "CU2", name: "La Cuesta No.2", regionId: "FM" },
+                { id: "MON", name: "La Montañita", regionId: "FM" },
+                { id: "SAB", name: "La Sábana", regionId: "FM" },
+                { id: "VEN", name: "La Venta", regionId: "FM" },
+                { id: "CAS", name: "Las Casitas", regionId: "FM" },
+                { id: "FLO", name: "Las Flores", regionId: "FM" },
+                { id: "TAP", name: "Las Tapias", regionId: "FM" },
+                { id: "JUT2", name: "Los Jutes", regionId: "FM" },
+                { id: "MAT", name: "Mateo", regionId: "FM" },
+                { id: "RED", name: "Monte Redondo", regionId: "FM" },
+                { id: "NAL", name: "Nueva Aldea", regionId: "FM" },
+                { id: "RAB", name: "Río Abajo", regionId: "FM" },
+                { id: "RHO", name: "Río Hondo", regionId: "FM" },
+                { id: "SOR", name: "San Francisco de Soroguara", regionId: "FM" },
+                { id: "SJC", name: "San Juancito", regionId: "FM" },
+                { id: "SJR", name: "San Juan del Rancho", regionId: "FM" },
+                { id: "SRG", name: "San Juan del Río Grande", regionId: "FM" },
+                { id: "SMT", name: "San Matías", regionId: "FM" },
+                { id: "SCA", name: "Santa Cruz Abajo", regionId: "FM" },
+                { id: "SCR", name: "Santa Cruz Arriba", regionId: "FM" },
+                { id: "SAR", name: "Santa Rosa", regionId: "FM" },
+                { id: "SRO", name: "Soroguara", regionId: "FM" },
+                { id: "TAM", name: "Támara", regionId: "FM" },
+                { id: "VNU", name: "Villa Nueva", regionId: "FM" },
+                { id: "YAG", name: "Yaguacire", regionId: "FM" },
+                { id: "ZAM", name: "Zambrano", regionId: "FM" }
+            ]
+        },
+        { id: "GD", name: "Gracias a Dios" },
+        { id: "IN", name: "Intibucá" },
+        { id: "IB", name: "Islas de la Bahía" },
+        { id: "LP", name: "La Paz" },
+        { id: "LE", name: "Lempira" },
+        { id: "OC", name: "Ocotepeque" },
+        { id: "OL", name: "Olancho" },
+        { id: "SB", name: "Santa Bárbara" },
+        { id: "VA", name: "Valle" },
+        { id: "YO", name: "Yoro" }
+    ],
+    US: [
+        { id: "AL", name: "Alabama" },
+        { id: "AK", name: "Alaska" },
+        { id: "AZ", name: "Arizona" },
+        { id: "AR", name: "Arkansas" },
+        { id: "CA", name: "California" },
+        { id: "CO", name: "Colorado" },
+        { id: "CT", name: "Connecticut" },
+        { id: "DE", name: "Delaware" },
+        { id: "FL", name: "Florida" },
+        { id: "GA", name: "Georgia" },
+        { id: "HI", name: "Hawaii" },
+        { id: "ID", name: "Idaho" },
+        { id: "IL", name: "Illinois" },
+        { id: "IN", name: "Indiana" },
+        { id: "IA", name: "Iowa" },
+        { id: "KS", name: "Kansas" },
+        { id: "KY", name: "Kentucky" },
+        { id: "LA", name: "Louisiana" },
+        { id: "ME", name: "Maine" },
+        { id: "MD", name: "Maryland" },
+        { id: "MA", name: "Massachusetts" },
+        { id: "MI", name: "Michigan" },
+        { id: "MN", name: "Minnesota" },
+        { id: "MS", name: "Mississippi" },
+        { id: "MO", name: "Missouri" },
+        { id: "MT", name: "Montana" },
+        { id: "NE", name: "Nebraska" },
+        { id: "NV", name: "Nevada" },
+        { id: "NH", name: "New Hampshire" },
+        { id: "NJ", name: "New Jersey" },
+        { id: "NM", name: "New Mexico" },
+        { id: "NY", name: "New York" },
+        { id: "NC", name: "North Carolina" },
+        { id: "ND", name: "North Dakota" },
+        { id: "OH", name: "Ohio" },
+        { id: "OK", name: "Oklahoma" },
+        { id: "OR", name: "Oregon" },
+        { id: "PA", name: "Pennsylvania" },
+        { id: "RI", name: "Rhode Island" },
+        { id: "SC", name: "South Carolina" },
+        { id: "SD", name: "South Dakota" },
+        { id: "TN", name: "Tennessee" },
+        { id: "TX", name: "Texas" },
+        { id: "UT", name: "Utah" },
+        { id: "VT", name: "Vermont" },
+        { id: "VA", name: "Virginia" },
+        { id: "WA", name: "Washington" },
+        { id: "WV", name: "West Virginia" },
+        { id: "WI", name: "Wisconsin" },
+        { id: "WY", name: "Wyoming" }
+    ]
+};
+function getRegionsByCountryId(id) {
+    return exports.Regions[id];
+}
+/**
+ * Usado en el atributo [compareWith] de los mat-select's
+ * de los formularios que manejan paises y regiones.
+ * @param c1
+ * @param c2
+ * @returns
+ */
+var compareCountries = function (c1, c2) { return c1 && c2 ? c1.id === c2.id : false; };
+exports.compareCountries = compareCountries;
+var compareRegions = function (r1, r2) { return r1 && r2 ? r1.id === r2.id : false; };
+exports.compareRegions = compareRegions;

package/dist/types/index.d.ts

@@ -0,0 +1,13 @@
+/** ID único para un usuario */
+export * from './types/api';
+export * from './types/bag';
+export * from './types/branch';
+export * from './types/categories';
+export * from './types/countries';
+export * from './types/orders';
+export * from './types/payments';
+export * from './types/product-category';
+export * from './types/products';
+export * from './types/replenishment';
+export * from './types/users';
+export * from './types/warehouses';

package/dist/types/orders.js

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

package/dist/types/payments.js

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

package/dist/types/product-category.js

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

package/dist/types/products.js

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

package/dist/types/replenishment.js

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

package/dist/types/types/api.d.ts

@@ -0,0 +1,11 @@
+export interface ApiRequest {
+    route: string;
+    auth?: boolean;
+    params?: any;
+    page?: number;
+}
+export interface ApiResponse<Data, ErrorCodes = string> {
+    ok: boolean;
+    error?: ErrorCodes;
+    data?: Data;
+}

package/dist/types/types/bag.d.ts

@@ -0,0 +1,37 @@
+import { OrderDiscountApplied } from "./orders";
+import { PaymentInDB } from "./payments";
+import { ProductVariantInDB } from "./products";
+export interface Bag {
+    subtotalPrice: number;
+    subtotalWithDiscount: number;
+    totalPrice: number;
+    shippingPrice: number;
+    discounts?: OrderDiscountApplied[];
+    ccy: PaymentInDB['ccy'];
+    products: ProductWithVariantInBag[];
+}
+/**
+ * En la bolsa cada variante será independiente,
+ * @example Si un producto tiene 3 variantes y el usuario
+ * agrega cada variante, entonces se tomará como 3 productos independientes.
+ */
+export interface ProductWithVariantInBag {
+    productId: string;
+    productName: string;
+    imgFullUrl: string | undefined;
+    ccy: PaymentInDB['ccy'];
+    variantId: string;
+    warehouseId: string;
+    selectedOptions: ProductVariantInDB['selectedOptions'];
+    variantQty: number;
+    variantPrice: number;
+    createdAt: string;
+    updatedAt?: string;
+}
+export interface DeliveryMethod {
+    id: 'standard' | 'express' | 'weekend';
+    name: string;
+    desc: string;
+    estimatedDate: string;
+    price: number;
+}

package/dist/types/types/branch.d.ts

@@ -0,0 +1,21 @@
+import { FieldValue } from "firebase/firestore";
+import { Country, Region } from "./countries";
+export interface BranchInDB {
+    id: string;
+    name: string;
+    address: string;
+    secondLineAddress?: string;
+    city: string;
+    region: Region;
+    zipcode: number;
+    country: Country;
+    status: 'active' | 'tmpClosed' | 'closed';
+    createdAt: FieldValue | string;
+}
+/**
+ * Enlace de la sucursal en otro documento
+ */
+export interface BranchFK {
+    id: string;
+    name: string;
+}

package/dist/types/types/categories.d.ts

@@ -0,0 +1,3 @@
+/** @deprecated */
+export declare const ProductCategories: any[];
+export declare function getSubcategoryByParentId(categoryId: string): any;

package/dist/types/types/countries.d.ts

@@ -0,0 +1,30 @@
+export interface Country {
+    id: 'HN' | 'US' | 'SV';
+    name: string;
+    code: number | null | undefined;
+}
+export interface City {
+    id: string;
+    name: string;
+    regionId: string;
+}
+export interface Region {
+    id: string;
+    name: string;
+    cities?: City[];
+}
+export declare const Countries: Country[];
+export declare const Regions: {
+    HN: Region[];
+    US: Region[];
+};
+export declare function getRegionsByCountryId(id: 'HN' | 'US'): Region[] | any[];
+/**
+ * Usado en el atributo [compareWith] de los mat-select's
+ * de los formularios que manejan paises y regiones.
+ * @param c1
+ * @param c2
+ * @returns
+ */
+export declare const compareCountries: (c1: Country, c2: Country) => boolean;
+export declare const compareRegions: (r1: Region, r2: Region) => boolean;

package/dist/types/types/orders.d.ts

@@ -0,0 +1,62 @@
+import { PaymentIntent } from "@stripe/stripe-js";
+import { DeliveryMethod, ProductWithVariantInBag } from "./bag";
+import { FieldValue, Timestamp } from "firebase/firestore";
+import { UserAddressInDB } from "./users";
+export interface OrderDiscount {
+    id: string;
+    name: string;
+    code: string;
+    automatic?: boolean;
+    amount: number;
+    isPercent: boolean;
+    condition: 'first_order' | 'delivery_free' | 'none';
+}
+export interface OrderDiscountApplied extends OrderDiscount {
+    amountInCurrentCcy?: number;
+}
+export interface ProductPrepared {
+    productId: string;
+    variantId: string;
+    qty: number;
+}
+/**
+ * Indicará qué productos de {@link OrderInDB.products} fueron ordenados y cuales fueron preparados
+ */
+export interface ProductCheckedAfterPrepared {
+    productId: string;
+    variantId: string;
+    qtyOrdered: number;
+    qtyPrepared: number;
+}
+export interface OrderInDB {
+    id: string;
+    customerName: string;
+    customerId: string;
+    products: ProductWithVariantInBag[];
+    /**
+     * Indicará qué productos de {@link products} fueron preparados y cuantas unidades.
+     */
+    productsPrepared?: ProductPrepared[];
+    subtotalPrice: number;
+    subtotalWithDiscount: number;
+    totalPrice: number;
+    shippingPrice: number;
+    discounts?: OrderDiscountApplied[];
+    ccy: string;
+    status: 'pending' | 'payment_error' | 'processing' | 'prepared' | 'shipped' | 'delivered' | 'canceled';
+    orderDate: string | FieldValue | Timestamp;
+    /**
+     * Tiempo de entrega estimada
+     */
+    estimatedDeliveryDate?: string;
+    deliveryAddress: UserAddressInDB;
+    paymentStatus?: PaymentIntent.Status;
+    paymentMethod: 'credit_card' | 'paypal' | 'bank_transfer' | 'cash_on_delivery';
+    shippingMethod: DeliveryMethod;
+    gift?: {
+        fullname: string;
+        msg?: string;
+    };
+    notes?: string;
+}
+export type OrderErrorCodes = 'ERR_CREATE_ORDER' | 'ERR_ORDER_INFO' | 'ERR_CHANGE_ORDER_STATUS';

package/dist/types/types/payments.d.ts

@@ -0,0 +1,71 @@
+import { FieldValue, Timestamp } from "firebase/firestore";
+import { Metadata, PaymentIntent } from "@stripe/stripe-js";
+/**
+   * Payment como está registrado en la base de datos
+   */
+export interface PaymentInDB {
+    /**
+     * @property {string} `id`
+     * mismo que `Stripe.PaymentIntent.id`
+     */
+    id: string;
+    /**
+     * @property {@link Issuer} `recipientMap`
+     * Quién pagó
+     */
+    issuerMap: {
+        id: string;
+        displayName: string;
+    };
+    /**
+     * @property {number} `amount`
+     * Monto a pagar, incluyendo impuestos, tarifas y comisiones.
+     */
+    amount: number;
+    /**
+     * @property {number} `tax`
+     * Impuesto de la transacción, basado en EEUU.
+     */
+    tax: 8.25;
+    /**
+     * @property ccy {@link PaymentCCY}
+     * Moneda en la que se ejecutará el pago.
+     */
+    ccy: 'HNL' | 'USD';
+    /**
+     * @property {Timestamp} `createdAt`
+     * Fecha y hora en que se generó la transacción,
+     * igual que `Stripe.PaymentIntent.created`.
+     */
+    createdAt: Timestamp | FieldValue;
+}
+/**
+ * Parámetros que se enviarán al servidor,
+ * y así registrar el PaymentIntent con stripe.
+ */
+export interface StripePaymentIntentParams {
+    cardHolder: string | string | null | undefined;
+    billingAddressLine1: string | string | null | undefined;
+    billingAddressCity: string | string | null | undefined;
+    amount: number;
+    currency: string;
+    metadata: PaymentInStripeMetadata;
+}
+export interface PaymentInStripeMetadata {
+    /** Ej. users/{userId}/orders/{orderId} */
+    refDB: string;
+    issuerId: string;
+    issuerName: string;
+}
+/**
+ * Respuesta de la API Ivife cuándo se busca un PaymentIntent por su {@link StripeMetadata.refId}
+ */
+export interface StripePaymentIntentResponse {
+    metadata: PaymentInStripeMetadata | Metadata;
+    status: PaymentIntent.Status;
+    amount: number;
+    amount_capturable: number;
+    amount_received: number;
+    currency: string;
+}
+export type PaymentErrorCodes = 'ERR_PAYMENT' | 'ERR_REINTENT_PAYMENT' | 'authentication_required' | 'requires_action';

package/dist/types/types/product-category.d.ts

@@ -0,0 +1,21 @@
+export interface SubCategory {
+    id: string;
+    title: string;
+}
+export interface Category {
+    id: string;
+    title: string;
+    icon: string;
+    subcategories?: SubCategory[];
+    hidden?: boolean;
+}
+export interface CategoryType {
+    title: string;
+    type: 'clothes' | 'gifts' | 'perfumes' | 'electric';
+    icon: string;
+    categories: Category[];
+}
+export interface ProductCategoryInDB {
+    id: string;
+    subcategory: string;
+}

package/dist/types/types/products.d.ts

@@ -0,0 +1,116 @@
+import { PaymentInDB } from "./payments";
+import { ProductCategoryInDB } from "./product-category";
+import { RProduct, RSupplier } from "./replenishment";
+export interface ProductFirstOptionTypeValue {
+    value: string;
+    codeColor?: string;
+}
+export interface ProductOptionValue {
+    value: string;
+    code?: string;
+}
+export interface ProductOptionToSelect {
+    option: 'talla' | 'color' | 'onzas';
+    valuesAllowed: ProductOptionValue[];
+}
+/**
+ * Igual que store-product-in-db.ts del proyecto `Zavafa`
+ */
+export interface ProductInDB {
+    id: string;
+    name: string;
+    description: string;
+    category: ProductCategoryInDB;
+    brand: string | null | undefined;
+    coverImg?: ProductVariantImage;
+    type: 'clothes' | 'perfumes';
+    /**
+     * Opciones con las que se identificará cada variante de este producto,
+     * serán establecidas por el usuario.
+     *
+     * Máximo 2.
+     * @example: Talla, Color, Onzas, etc. Y todos sus valores posibles.
+     */
+    optionsToSelect: ProductOptionToSelect[];
+    /** Peso en libras */
+    weightLbs?: number;
+    ccy: PaymentInDB['ccy'];
+    status: 'active' | 'inactive' | 'discontinued';
+    tags: string[];
+    createdAt: any;
+    updatedAt?: string;
+}
+/**
+ * /products/{productId}/variants/{sku}
+ */
+export interface ProductVariantImage {
+    url: string;
+    path: string;
+}
+export interface ProductVariantInDB {
+    /** Este es el SKU */
+    id?: string;
+    supplier: RSupplier;
+    supplierVariantId: RProduct['supplierVariantId'];
+    productId?: string;
+    images?: ProductVariantImage[];
+    barcode?: string;
+    /**
+     * Packages dónde está la variante
+     */
+    inPackages?: {
+        packageId: string;
+        orderId: string;
+    }[];
+    /**
+     * Warehouses dónde está disponible esta variante.
+     * Cada ```key``` del objeto es el id del warehouse y su valor será {@link ProductVariantWarehouseFK}.
+     *
+     * @note Se usa esta nueva manera para poder usar los FieldValue (serverTimestamp, etc) de Firestore,
+     * ya que en los arrays no funcionan.
+     */
+    warehouses: {
+        [key: string]: VariantWarehouseFK;
+    };
+    /**
+     * Opciones de la variante, por ejemplo una prenda tiene color y talla.
+     * Obligatoriamente tiene que tener al menos una opción.
+     *
+     * @note {@link secondOptionType} NO puede ser de tipo 'color'
+     */
+    selectedOptions: {
+        option: ProductOptionToSelect['option'];
+        value: {
+            value: string;
+            code?: string;
+        };
+    }[];
+}
+/**
+ * La forma en que se enlaza información del producto en determinada warehouse,
+ * esta información va adentro de la variante.
+ *
+ * /products/{id}/variants/{id}
+ */
+export interface VariantWarehouseFK {
+    id: string;
+    name: string;
+    stock: number;
+    price: number;
+    lastPrice?: number;
+    supplierPriceUSD: number;
+    supplierPriceHNL: number;
+    profitMarginUSD: number;
+    profitMarginHNL: number;
+    profitMarginPercent: number;
+}
+/**
+ * Para poder mostrar las variantes agrupadas
+ *
+ * Ej. Verde / S, Verde / M, etc
+ */
+export interface ProductGroupVariant {
+    variant: ProductVariantInDB;
+    /** Indica si la información se cargó desde el servidor o se creó automaticamente */
+    dataFromServer: boolean;
+}

package/dist/types/types/replenishment.d.ts

@@ -0,0 +1,100 @@
+import { FieldValue, Timestamp } from "firebase/firestore";
+import { ProductVariantInDB } from "./products";
+import { WarehouseInDB } from "./warehouses";
+export interface RSupplier {
+    id: string;
+    name: string;
+}
+/**
+ * Productos de la orden de reabastecimiento realizada al proveedor
+ */
+export interface RProduct {
+    id?: string;
+    productId: string;
+    variantId: string;
+    packageId: string;
+    selectedOptions: ProductVariantInDB['selectedOptions'];
+    newStock: number;
+    supplier: RSupplier;
+    /** Id que usa el proveedor para manejar este producto en su sistema */
+    supplierVariantId: string;
+    /**
+     * Fecha de registro de el paquete en el sistema
+     */
+    createdAt?: string | FieldValue;
+    /**
+     * Si no tiene rPackageId se considera un
+     * producto de la misma orden pero huérfano
+     */
+    rPackageId?: string;
+}
+export interface ROrder {
+    /**
+     * Id único interno
+     */
+    id?: string;
+    /**
+     * Número de orden del proveedor
+     *
+     * Este es el número de orden con el que
+     * el proveedor da seguimiento a la orden.
+     */
+    supplierOrderId: string;
+    supplier: RSupplier;
+    totalValue: number;
+    packsQty: number;
+    /**
+     * Almacén final que recibirá la orden.
+     * Es donde se pondrán en venta los productos o desde dónde
+     * se distribuirán al resto de almacenes.
+     */
+    warehouseDestination: Pick<WarehouseInDB, 'id' | 'name'>;
+    /**
+     * Moneda siempre será USD
+     */
+    ccy: 'USD';
+    createdAt: Timestamp | FieldValue;
+}
+export interface RPackageHistory {
+    title: string;
+    /**
+     * Si esta en el JSON, entonces ya se llegó al `ROrder['warehouseDestination']` requerido.
+     */
+    warehouseDestination?: ROrder['warehouseDestination'];
+    mode: 'on-the-way' | 'arrived' | 'info';
+    /**
+     * Nombre de la empresa que realiza el envío desde {@link from}
+     * @example UPS, FedEx, SerCargo, etc
+     */
+    shippingCompany?: string | null;
+    trackingURL?: string | null;
+    icon?: string;
+    /**
+     * Fecha en la que se registró el evento
+     */
+    createdAt: string;
+}
+export interface RPackage {
+    id: string;
+    /**
+     * Id de {@link ROrder}
+     */
+    orderId: string;
+    itemsQty: number;
+    historyTracking: RPackageHistory[];
+    /**
+     * Detalles adicionales sobre el paquete
+     */
+    notes?: string;
+    /**
+     * Usuario que registró el paquete
+     */
+    createdBy: {
+        id: string;
+        displayName: string;
+    };
+    /**
+     * Fecha de registro de el paquete en el sistema
+     */
+    createdAt: string | FieldValue;
+}

package/dist/types/types/users.d.ts

@@ -0,0 +1,79 @@
+import { FieldValue, Timestamp } from "firebase/firestore";
+import { Country } from "./countries";
+export interface User {
+    uid: string;
+    displayName: string;
+    email: string;
+    stripeCustomerId?: string;
+    userDevices?: UserDevice[];
+    phoneNumber?: string;
+    photoURL?: string;
+    createdAt: Timestamp | FieldValue;
+    updatedAt?: Timestamp | FieldValue;
+}
+export interface UserDevice {
+    id: string;
+    FCMToken?: string;
+    /**
+     * ios | android | web
+     */
+    platform: string;
+    /**
+     * Iphone 12 | Pixel 5
+     */
+    model: string;
+    /**
+     * ios | android
+     */
+    operatingSystem: string;
+    /**
+     * 13 | 10
+     */
+    osVersion: string;
+    /**
+     * Apple | Google | Microsoft | Samsung
+     */
+    manufacturer: string;
+    /**
+     * ``true`` si es un emulador
+     */
+    isVirtual: boolean;
+    /**
+     * ``es`` | ``en``
+     */
+    language: string;
+    /**
+     * Versión de la app
+     */
+    appVersion: string;
+    appBuild: string;
+    lastLogin: Timestamp | FieldValue;
+    ipSecurity?: {
+        ip: string;
+        type: 'IPv4' | 'IPv6';
+        country: string;
+        country_code: string;
+        region: string;
+        city: string;
+        isp: string;
+    };
+}
+export interface UserAddressInDB {
+    id: string;
+    isDefault?: boolean;
+    fullname: string;
+    phone: string;
+    address: string;
+    references: string;
+    region: string;
+    city: string;
+    country: Country | null | undefined;
+}
+export interface UserSearch {
+    id: string;
+    displayName: string;
+    uid: string;
+    k: string;
+    tags: string[];
+    createdAt: FieldValue | Timestamp;
+}

package/dist/types/types/warehouses.d.ts

@@ -0,0 +1,14 @@
+import { FieldValue } from "firebase/firestore";
+import { Country, Region } from "./countries";
+export interface WarehouseInDB {
+    id?: string;
+    name: string;
+    address: string;
+    secondLineAddress?: string | null;
+    city: string;
+    region: Region;
+    zipcode: number;
+    country: Country;
+    status: 'active' | 'tmpClosed' | 'closed';
+    createdAt: FieldValue | string;
+}

package/dist/types/users.js

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

package/dist/types/warehouses.js

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

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@nicefer/types",
-  "version": "1.0.13",
+  "version": "1.0.15",
   "description": "Tipos compartidos para Nicefer",
+  "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
     "dist"