@nicefer/types 1.0.218 → 2.0.0

package/src/product-category.ts

@@ -1,34 +0,0 @@
-import { Country } from "./countries";
-import { Translations } from "./translations";
-
-export interface Category {
-  id: string;
-  title: string;
-  translations?: Translations<string>;
-  icon?: string;
-  subcategories?: SubCategory[];
-  hidden?: boolean;
-  adultsOnly?: boolean;
-}
-
-export interface SubCategory {
-  id: string;
-  title: string;
-  translations?: Translations<string>;
-}
-
-export interface CategoryType {
-  title: string;
-  type: 'clothes' |'gifts' | 'perfumes' | 'electric' | 'electronics' | 'handmade-jewelry' | 'jewelry' | 'home' | 'beauty' | 'health' | 'books' | 'shoes' | 'bags';
-  translations?: Translations<string>;
-  icon?: string;
-  categories: Category[];
-  countries: Country['id'][];
-  hidden?: boolean;
-}
-
-
-export interface ProductCategoryInDB {
-  id: string;
-  subcategory: string
-};

package/src/products.ts

@@ -1,129 +0,0 @@
-import { CompanyFK } from "./company";
-import { Country } from "./countries";
-import { CategoryType, ProductCategoryInDB } from "./product-category";
-import { RProduct, RSupplier } from "./replenishment";
-import { Translations } from "./translations";
-
-export interface ProductFirstOptionTypeValue { value: string; codeColor?: string; };
-export interface ProductOptionValue { value: string, code?: string };
-
-type clothesOptions = 'talla' | 'color';
-type giftsOptions = 'color' | 'tipo de flor';
-
-export interface ProductOptionToSelect {
-  option: clothesOptions | giftsOptions;
-  valuesAllowed: ProductOptionValue[];
-};
-
-/**
- * Igual que store-product-in-db.ts del proyecto `Zavafa`
- */
-export interface ProductInDB {
-  id: string; // ID único del producto principal
-  name: string; // Nombre del producto
-  nameTranslations?: Translations<string>;
-  description: string; // Descripcion del producto
-  descriptionTranslations?: Translations<string>;
-  category: ProductCategoryInDB; // Categoría del producto (ej. "Electrónica", "Ropa")
-  brand: string | null | undefined; // Marca del producto (opcional)
-  coverImg?: ProductVariantImage;
-  type: CategoryType['type'];
-  soldBy: CompanyFK;
-  adultsOnly?: boolean; // Indica si el producto es para adultos
-  shipmentsTo?: { [countryId in Country['id']]: boolean }; // Países(s) a donde se envia el producto
-
-  countries?: { [key: string]: boolean }; // Países(s) donde se almacena el producto
-  warrantyInDays?: number;
-
-  /**
-   * 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[]; // Máximo 2 opciones
-  /** Peso en libras */
-  weightLbs?: number;
-  status: 'active' | 'inactive' | 'discontinued'; // Estado del producto
-  tags: string[]; // Etiquetas por las cuáles los usuarios pueden buscar este producto
-  createdAt: any; // Fecha de creación en formato ISO 8601
-  updatedAt?: string; // Última actualización en formato ISO 8601
-  
-  createdBy: { id: string; displayName: string; }; // Usuario que creó el producto
-  updatedBy?: { id: string; displayName: string; }; // Usuario que actualizó el producto
-}
-
-
-/**
- * /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 VariantWarehouseFK}.
-   * 
-   * @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; // Cantidad disponible en inventario
-  price: number; // Precio de esta variante (puede ser diferente del basePrice)
-  priceUSD: number; // Precio de esta variante (puede ser diferente del basePrice)
-  lastPrice?: number; // Último precio de esta variante usado para descuentos o reducciones de precio
-  lastPriceUSD?: number; // Último precio de esta variante usado para descuentos o reducciones de precio
-  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/src/replenishment.ts

@@ -1,114 +0,0 @@
-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;
-  /**
-   * 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: string;
-};
-
-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;
-}

package/src/stats.ts

@@ -1,18 +0,0 @@
-export interface OrdersStats {
-  total?: number;
-  canceled?: number;
-  delivered?: number;
-}
-
-// export interface Stats {
-//   orders?: OrdersStats;
-// }
-
-export interface UserStats {
-  orders?: {
-    total?: number;
-    canceled?: number;
-    delivered?: number;
-  };
-  qtyReferrals?: number;
-}

package/src/translations.ts

@@ -1,3 +0,0 @@
-export interface Translations<T = any> {
-  [key: string]: T;
-}

package/src/users.ts

@@ -1,85 +0,0 @@
-import { Country } from "./countries";
-
-export interface User {
-  uid: string;
-  displayName: string;
-  email: string;
-  stripeCustomerId?: string;
-  userDevices?: UserDevice[];
-  phoneNumber?: string;
-  photoURL?: string;
-  referralBy?: {uid: string, displayName: string, referredAt: string};
-  tags: string[];
-  createdAt: string;
-  updatedAt?: string;
-};
-
-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: string;
-  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: string;
-}

package/src/warehouses.ts

@@ -1,53 +0,0 @@
-import { Country, Region } from "./countries";
-
-export interface WarehouseInDB {
-  id?: string;                      // maxLength: 36 (UUID estándar)
-  name: string;                    // maxLength: 100 (nombre comercial)
-  address: string;                 // maxLength: 150 (calle y número)
-  secondLineAddress?: string | null;      // maxLength: 100 (complemento opcional)
-  city: string;                    // maxLength: 80 (ciudades grandes pueden ser largas)
-  region?: Region | null;                  
-  zipcode: number;                 // maxLength: 10 (ZIP/Postal code)
-  country: Country;                
-  status: 'active' | 'tmpClosed' | 'closed';  // No necesita maxLength (valores fijos)
-  /**
-   * `key` es el id del país al que se entrega. Ej. `US`
-   */
-  shipmentsTo: {[countryId in Country['id']]: WarehouseDeliveryTime};
-  createdAt: string;  // ISO 8601 (maxLength: 24, e.g., "2025-03-15T12:00:00Z")
-}
-
-/**
- * Tiempo de entrega en días hábiles de un país a otro
- */
-export interface WarehouseDeliveryTime {
-  countryId: Country['id'];
-  countryName: string;
-  deliveryMethods: {
-    [deliveryMethodId in DeliveryMethod['id']]: DeliveryMethod
-  };
-};
-
-export interface DeliveryMethod {
-  id: 'standard' | 'express' | 'weekend';
-  name: string;
-  /**
-   * Número de días hábiles que tarda la entrega,
-   * se calcula y llena en `client`.
-   */
-  deliveryRange?: string;
-  inBusinessDays: `${number}-${number}`; // Ej. "3-5"
-  deliveryFeeInUSD: number;
-  deliveryFeeInHNL: number;
-  /**
-   * El cargo en {@link deliveryFeeInUSD} y {@link deliveryFeeInHNL}
-   * permitirá un máximo de lo indicado aquí. Si se supera el máximo,
-   * se cobrará 
-   */
-  maxLbPerFee: number;
-}
-
-
-
-
-

package/tsconfig.json

@@ -1,40 +0,0 @@
-{
-  "compilerOptions": {
-    "baseUrl": "./",
-    "outDir": "./dist",
-    "module": "es2015",
-    "moduleResolution": "bundler",
-    "declaration": true,
-    "sourceMap": true,
-    "inlineSources": true,
-    "emitDecoratorMetadata": true,
-    "experimentalDecorators": true,
-    "importHelpers": true,
-    "types": [],
-    "lib": [
-      "dom",
-      "es2018"
-    ],
-    "paths": {
-      "nicefer": [
-        "src/index"
-      ],
-      "org": [
-        "src/org"
-      ]
-    },
-  },
-  "angularCompilerOptions": {
-    "annotateForClosureCompiler": true,
-    "skipTemplateCodegen": true,
-    "strictMetadataEmit": true,
-    "fullTemplateTypeCheck": true,
-    "strictInjectionParameters": true,
-    "enableResourceInlining": true
-  },
-  "exclude": [
-    "src/test.ts",
-    "**/*.spec.ts",
-    "dist"
-  ]
-}

package/tsconfig.json.old

@@ -1,16 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ESNext",
-    "module": "ESNext",
-    "moduleResolution": "node",
-    "esModuleInterop": true,
-    "emitDeclarationOnly": false,
-    "outDir": "./dist",
-    "rootDir": "./src",
-    "strict": true,
-    "declaration": true,
-    "skipLibCheck": true
-  },
-  "include": ["src/**/*"],
-  "exclude": ["node_modules", "dist"]
-}