@nicefer/types 1.0.216 → 1.0.218

package/src/countries.ts

@@ -0,0 +1,227 @@
+import { PaymentInDB } from "./payments";
+
+export interface Country {
+  id: 'HN' | 'US' | 'SV' | 'CN';
+  name: string;
+  ccy: PaymentInDB['ccy'];
+  code: number | null | undefined;
+}
+
+export interface City {
+  id: string;
+  name: string;
+  regionId: string;
+}
+
+export interface Region {
+  id: string;
+  name: string;
+  cities?: City[];
+}
+
+export const Countries: Country[] = [
+  {
+    id: 'HN',
+    name: 'Honduras',
+    code: 504,
+    ccy: 'HNL'
+  },
+
+  {
+    id: 'SV',
+    name: 'El Salvador',
+    code: 503,
+    ccy: 'USD'
+  },
+
+  {
+    id: 'US',
+    name: 'Estados Unidos',
+    code: 1,
+    ccy: 'USD',
+  },
+
+  {
+    id: 'CN',
+    name: 'China',
+    code: 56,
+    ccy: 'USD'
+  },
+];
+
+export const Regions: {[countryId in Country['id']]: Region[]} = {
+  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" }
+  ],
+
+  SV: [
+    { id: "AH", name: "Ahuachapán" },
+    { id: "CA", name: "Cabañas" },
+    { id: "CH", name: "Chalatenango" },
+    { id: "CU", name: "Cuscatlán" },
+    { id: "LI", name: "La Libertad" },
+    { id: "PA", name: "La Paz" },
+    { id: "ONU", name: "La Unión" },
+    { id: "MO", name: "Morazán" },
+    { id: "SM", name: "San Miguel" },
+    { id: "SS", name: "San Salvador" },
+    { id: "SV", name: "San Vicente" },
+    { id: "SA", name: "Santa Ana" },
+    { id: "SO", name: "Sonsonate" },
+    { id: "US", name: "Usulutan" }
+  ],
+
+  CN: []
+}
+
+export function getRegionsByCountryId(id: 'HN' | 'US' | 'SV'): Region[] | any[] {
+  return 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 
+ */
+export const compareCountries = (c1: Country, c2: Country) => c1 && c2 ? c1.id === c2.id : false;
+export const compareRegions = (r1: Region, r2: Region) => r1 && r2 ? r1.id === r2.id : false;

package/src/index.ts

@@ -0,0 +1,19 @@
+// src/index.ts
+
+/** ID único para un usuario */
+// export type UserId = string & { __brand: 'UserId' };
+export * from './api';
+export * from './bag';
+export * from './branch';
+export * from './countries';
+export * from './orders';
+export * from './stats';
+export * from './payments';
+export * from './product-category';
+export * from './products';
+export * from './replenishment';
+export * from './users';
+export * from './warehouses';
+export * from './translations';
+export * from './company';
+

package/src/orders.ts

@@ -0,0 +1,112 @@
+import { PaymentIntent } from "@stripe/stripe-js";
+import { ProductWithVariantInBag } from "./bag";
+import { UserAddressInDB } from "./users";
+import { Country } from "./countries";
+import { CategoryType } from "./product-category";
+import { DeliveryMethod } from "./warehouses";
+
+export interface Gift { fullname: string; msg?: string | null | undefined; };
+
+export interface OrderDiscount {
+  id: string;
+  name: string;
+  subtitle: string;
+  code: string;
+  automatic?: boolean;
+  amount: number;
+  isPercent: boolean;
+  condition: 'first_order' | 'delivery_free' | 'none' | 'student' | 'share_5_friends';
+  conditionDescription: string;
+  categoriesTypes?: CategoryType['type'][];
+  minOrderAmount?: number;
+  dueDate: string;
+  public?: boolean;
+};
+
+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;
+  customerCountry: Country;
+
+  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[];
+  
+  status: 'pending' | 'payment_error' | 'processing' | 'prepared' | 'shipped' | 'delivered' | 'canceled';
+  orderDate: string;
+  deliveryAddress: UserAddressInDB;
+  paymentStatus?: PaymentIntent.Status,
+  paymentMethod: 'credit_card' | 'paypal' | 'bank_transfer' | 'cash_on_delivery';
+  shippingMethod: DeliveryMethod;
+  gift?: Gift,
+  notes?: string;
+}
+
+export type OrderErrorCodes = 'ERR_CREATE_ORDER' | 'ERR_ORDER_INFO' | 'ERR_CHANGE_ORDER_STATUS';
+
+
+/**
+ * Interfaz para comunicación con la API
+ */
+export interface ConfirmOrderPayload {
+  orderReadyToPay: OrderReady;
+  customerCountry: Country;
+  paymentMethod: OrderInDB['paymentMethod'];
+  shippingMethod: OrderInDB['shippingMethod'];
+  deliveryAddress: OrderInDB['deliveryAddress'];
+  gift?: Gift;
+};
+
+/**
+ * Orden lista para que el usuario decida pagar
+ */
+export interface OrderReady {
+  warehouseId: string;
+  warehouseCountryId: Country['id'];
+  products: ProductWithVariantInBag[];
+  paymentMethod?: OrderInDB['paymentMethod'];
+  shippingMethod?: DeliveryMethod;
+  deliveryAddress?: UserAddressInDB;
+  gift?: { fullname: string; msg?: string | null | undefined; };
+  subtotalPrice: number;
+  shippingPrice: number;
+  subtotalWithDiscount: number;
+  totalPrice: number;
+};
+
+
+/**
+ * Ordenes listas para que el usuario decida pagar
+ */
+export interface OrdersReady {
+  [warehouseId: string]: OrderReady;
+};

package/src/org/event.ts

@@ -0,0 +1,17 @@
+export interface NiceEvent {
+    id: string;
+    title: string;
+    description: string;
+    inPerson: boolean;
+    organizerName: string;
+    createdBy: {
+      id: string;
+      name: string;
+    };
+    location: string;
+    coverUrl?: string;
+    startDate: Date;
+    endDate: Date;
+    createdAt: string;
+    updatedAt?: string;
+  }

package/src/org/index.ts

@@ -0,0 +1,2 @@
+export * from './event';
+export {Donation} from './radar';

package/src/org/radar.ts

@@ -0,0 +1,86 @@
+import { PaymentIntent } from "@stripe/stripe-js";
+
+export type Currency       = 'HNL' | 'EUR' | 'USD';
+  export type DonationStatus = 'pending_pay' | 'pending' | 'payment_error' | 'processing' | 'resolve' | 'rejected' | 'expired' | 'used';
+  
+  /**
+   * Tipos de donaciones usadas en el radar
+   * 
+   * Valores posibles:
+   * - `direct_donation`: Donación directa a una persona
+   * - `event`: Evento
+   * - `operating_expenses`: Gastos operativos
+   */
+  export type UsedIn = 'direct_donation' | 'event' | 'operating_expenses';
+  
+  /**
+   * Tipos de movimientos del radar
+   *
+   * Valores posibles:
+   * - `info`: Movimiento informativo
+   * - `cash_converted_to_hnl`: Convertido a lempiras
+   * - `cash_income`: Ingreso
+   * - `cash_expense`: Gasto
+   * - `cash_refund`: Reembolso
+   * - `cash_reversion`: Reversión
+   *
+   * @remarks
+   * El reembolso es para el cliente, mientras que la reversión
+   * es para devolver el dinero a la donación original.
+   */
+  export type FlowType = 'info' | 'cash_converted_to_hnl' | 'cash_income' | 'cash_expense' | 'cash_refund' | 'cash_reversion';
+  
+  export interface Movement {
+    id: string;
+    title: string;
+    desc?: string;
+    /**
+     * Tipos de donaciones usadas en el radar
+     * 
+     * Valores posibles:
+     * - `direct_donation`: Donación directa a una persona
+     * - `event`: Evento
+     * - `operating_expenses`: Gastos operativos
+     */
+    usedIn: UsedIn;
+    icon: 'ok' | 'error' | 'info' | 'waiting';
+    type: FlowType;
+  
+    /**
+     * Monto involucrado en el movimiento,
+     * se debe proporcionar `0` cuándo {@link FlowType} sea `none`.
+     * Ej. `amount: 0`
+     */
+    amount: number;
+    createdAt: string;
+  };
+  
+  export interface DonationCharges {
+    subtotal: number;
+    fees: number;
+    total: number;
+  }
+  
+  /**
+   * La donación se puede recibir en HNL, USD o EUR,
+   * pero se deberá convertir a lempiras antes de ser usada.
+   */
+  export interface Donation {
+    id: string;
+    donorId: string;
+    fullname: string,
+    anonymous: boolean;
+    charges: DonationCharges;
+  
+    /**
+     * Cuándo se reciba en una moneda distinta de HNL, se convertirá a HNL.
+     * De lo contrario será `undefined`
+     */
+    chargesInHNL?: DonationCharges;
+    status: DonationStatus;
+    mainCcy: Currency;
+    paymentStatus?: PaymentIntent.Status;
+    
+    radar?: { [movementId: string]: Movement };
+    createdAt?: string;
+  };

package/src/payments.ts

@@ -0,0 +1,79 @@
+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' | 'EUR';
+
+  /**
+   * @property {Timestamp} `createdAt`
+   * Fecha y hora en que se generó la transacción,
+   * igual que `Stripe.PaymentIntent.created`.
+   */
+  createdAt: string;
+}
+
+
+/**
+ * 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/src/product-category.ts

@@ -0,0 +1,34 @@
+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
+};