sinfactura-types 1.6.0 → 1.6.1

package/README.md

@@ -23,8 +23,26 @@ The package contains only TypeScript type declarations — no runtime code. Zod
 
 ## Installation
 
+Two distribution channels:
+
+### Git (preferred — no NPM publish step)
+
+Consumers reference the auto-built `dist` branch directly:
+
+```jsonc
+// app/package.json (and api, web, landing)
+{
+  "devDependencies": {
+    "sinfactura-types": "github:sinfactura/types#dist"
+  }
+}
+```
+
+The [`build-dist`](.github/workflows/build-dist.yml) GitHub Actions workflow runs on every push to `main`, builds `dist/`, and force-pushes a clean orphan commit to the `dist` branch. Consumers fetch a ready-to-use package — no build step required at install time.
+
+### npm (legacy — being phased out)
+
 ```bash
-# In a SINFACTURA consumer repo (app, web, etc.)
 yarn add --dev sinfactura-types
 ```
 
@@ -34,16 +52,34 @@ yarn add --dev sinfactura-types
 import type { IUser, IOrder, IInvoice, IProduct } from "sinfactura-types";
 ```
 
-## Publishing a New Version
+## Updating Types
 
-1. Bump the `version` field in `package.json` (follow semver)
-2. Publish to npm:
+### Authoring side (this repo)
+
+1. Edit types in `src/`.
+2. Commit + push to `main`.
+3. The `build-dist` workflow runs automatically, force-pushes the new build to `dist`.
+
+No manual version bump, no NPM publish. (The `version` field in `package.json` still gets bumped for npm publishing if/when needed; consumers using the git URL ignore it — they pin commit hashes via their lockfiles.)
+
+### Consumer side (app, api, web, landing)
+
+After a new types build lands, consumers explicitly pull it:
 
 ```bash
-yarn publish
+yarn up "sinfactura-types@github:sinfactura/types#dist"
 ```
 
-3. In each consumer repo, bump the `sinfactura-types` dependency (e.g. `app` currently uses `^1.0.90`)
+This re-resolves the git ref to the latest commit on `dist` and pins it in the lockfile. Commit the lockfile change.
+
+> **Why explicit?** `yarn install` does NOT re-resolve git branch refs to their current HEAD — it reuses the cached resolution for reproducibility. Consumers that want auto-bump-on-pull can add a `post-merge` Husky hook that runs `yarn up sinfactura-types@github:sinfactura/types#dist` whenever `package.json`/`yarn.lock` changed in the merge.
+
+## Legacy: Publishing a New NPM Version
+
+Kept for reference / external consumers. New SINFACTURA repos should use the git URL instead.
+
+1. Bump the `version` field in `package.json` (follow semver)
+2. Publish to npm: `yarn publish`
 
 ## License
 

package/dist/account.d.ts

@@ -12,7 +12,9 @@ declare global {
         debit?: number;
         credit?: number;
         amount?: number;
+        currency?: string;
         currencyValue?: number;
+        currencyValueAt?: number;
         balance?: number;
         userId: string;
         deleted?: boolean;

package/dist/basket.d.ts

@@ -7,6 +7,8 @@ declare global {
         updatedAt: number;
         quantity: number;
         currency: string;
+        currencyValue?: number;
+        currencyValueAt?: number;
         cost: number;
         total: number;
         items: BasketItem[];

package/dist/invoice.d.ts

@@ -17,6 +17,7 @@ declare global {
         cuit: string;
         currency?: string;
         currencyValue?: number;
+        currencyValueAt?: number;
         fiscalCondition: string;
         paymentCondition: string;
         deliveryCondition: string;

package/dist/order.d.ts

@@ -11,6 +11,8 @@ declare global {
         deliveredDate?: number;
         comments?: string;
         currency: string;
+        currencyValue?: number;
+        currencyValueAt?: number;
         paymentMethod: number;
         deliveryMethod: number;
         invoiceMethod?: {

package/dist/payment.d.ts

@@ -33,6 +33,8 @@ export interface PaymentReceived {
     source: PaymentReceivedSource;
     total: number;
     currency: string;
+    currencyValue?: number;
+    currencyValueAt?: number;
     payerName?: string;
     payerEmail?: string;
     payerCuit?: string;

package/dist/product.d.ts

@@ -34,6 +34,8 @@ declare global {
         totalSales?: number;
         zone?: string;
         currency: string;
+        currencyValue?: number;
+        currencyValueAt?: number;
         ivaType: number;
         categoryId: string;
         brandId: string;

package/dist/supplier.d.ts

@@ -34,7 +34,9 @@ declare global {
         per_iibb: number;
         per_iva: number;
         file: string;
+        currency?: string;
         currencyValue: number;
+        currencyValueAt?: number;
     }
     interface SupplierAccount {
         storeId: string;
@@ -49,7 +51,9 @@ declare global {
         debit: number;
         credit: number;
         amount: number;
+        currency?: string;
         currencyValue: number;
+        currencyValueAt?: number;
         balance: number;
         deleted: boolean;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sinfactura-types",
-  "version": "1.6.0",
+  "version": "1.6.1",
   "main": "dist/index.js",
   "type": "module",
   "types": "./dist/index.d.ts",

package/dist/src/account.d.ts

@@ -1,21 +0,0 @@
-declare global {
-    interface Account {
-        storeId: string;
-        accountId: string;
-        orderId?: string;
-        createdAt: number;
-        dated: number;
-        customerId?: string;
-        fullName?: string;
-        subject?: string;
-        details: string;
-        debit?: number;
-        credit?: number;
-        amount?: number;
-        currencyValue?: number;
-        balance?: number;
-        userId: string;
-        deleted?: boolean;
-    }
-}
-export {};

package/dist/src/account.js

@@ -1 +0,0 @@
-export {};

package/dist/src/afip.d.ts

@@ -1,82 +0,0 @@
-declare global {
-    interface AfipImpuesto {
-        descripcionImpuesto: string;
-        idImpuesto: number;
-        periodo: number;
-    }
-    interface AfipActividad {
-        descripcionActividad: string;
-        idActividad: number;
-        nomenclador: number;
-        orden: number;
-        periodo: number;
-    }
-    interface AfipErrorConstancia {
-        apellido?: string;
-        error: string[];
-        idPersona: number;
-        nombre?: string;
-        razonSocial?: string;
-    }
-    interface AfipDomicilioFiscal {
-        codPostal: string;
-        datoAdicional?: string;
-        descripcionProvincia: string;
-        direccion: string;
-        idProvincia: number;
-        localidad?: string;
-        tipoDatoAdicional?: string;
-        tipoDomicilio: string;
-    }
-    interface AfipDatosGenerales {
-        apellido?: string;
-        domicilioFiscal: AfipDomicilioFiscal;
-        esSucesion: string;
-        estadoClave: string;
-        fechaContratoSocial?: string;
-        idPersona: number;
-        mesCierre: number;
-        razonSocial?: string;
-        nombre?: string;
-        tipoClave: string;
-        tipoPersona: "FISICA" | "JURIDICA";
-    }
-    interface AfipCategoria {
-        descripcionCategoria: string;
-        idCategoria: number;
-        idImpuesto: number;
-        perdiodo: number;
-    }
-    interface AfipRegimen {
-        descripcionRegimen: string;
-        idImpuesto: number;
-        idRegimen: number;
-        periodo: number;
-        tipoRegimen?: string;
-    }
-    interface AfipDatosMonotributo {
-        actividad?: AfipActividad[];
-        actividadMonotributista: AfipActividad;
-        categoriaMonotributo: AfipCategoria;
-        impuestos?: AfipImpuesto[];
-        impuesto: AfipImpuesto[];
-    }
-    interface AfipDatosRegimenGeneral {
-        actividad: AfipActividad[];
-        categoriaAutonomo?: AfipCategoria;
-        impuesto: AfipImpuesto[];
-        regimen?: AfipRegimen[];
-    }
-    interface AfipErrorRegimenGeneral {
-        error: string[];
-        mensaje: string;
-    }
-    interface CuitAfip {
-        datosGenerales?: AfipDatosGenerales;
-        datosMonotributo?: AfipDatosMonotributo;
-        datosRegimenGeneral?: AfipDatosRegimenGeneral;
-        errorConstancia?: AfipErrorConstancia;
-        errorRegimenGeneral?: AfipErrorRegimenGeneral;
-    }
-}
-export {};

package/dist/src/afip.js

@@ -1 +0,0 @@
-export {};

package/dist/src/api.d.ts

@@ -1,11 +0,0 @@
-declare global {
-    interface ResponseApi<T = Record<string, string>> {
-        status: boolean;
-        error: string | null;
-        message: string | null;
-        data: T;
-        ConsumedCapacity?: Record<string, string | number>;
-        LastEvaluatedKey?: Record<string, string>;
-    }
-}
-export {};

package/dist/src/api.js

@@ -1 +0,0 @@
-export {};

package/dist/src/audit.d.ts

@@ -1,35 +0,0 @@
-declare global {
-    interface OrderAudit {
-        storeId: string;
-        auditId: string;
-        orderId: string;
-        userId: string;
-        fullName?: string;
-        action: OrderAuditAction;
-        createdAt: number;
-        dated: number;
-        changes?: OrderAuditChange[];
-        itemChanges?: {
-            added: Partial<BasketItem>[];
-            removed: Partial<BasketItem>[];
-            modified: Array<{
-                productId: string;
-                name?: string;
-                oldQuantity: number;
-                newQuantity: number;
-                oldPrice: number;
-                newPrice: number;
-            }>;
-        };
-        oldTotal?: number;
-        newTotal?: number;
-        returnId?: string;
-    }
-    interface OrderAuditChange {
-        field: string;
-        oldValue: unknown;
-        newValue: unknown;
-    }
-    type OrderAuditAction = 'order_created' | 'order_edited' | 'order_ready' | 'order_delivered' | 'order_delivery_cancelled' | 'order_disabled' | 'order_enabled' | 'order_returned' | 'discount_changed' | 'payment_method_changed' | 'delivery_method_changed' | 'delivery_address_changed' | 'invoice_created' | 'credit_note_created';
-}
-export {};

package/dist/src/audit.js

@@ -1 +0,0 @@
-export {};

package/dist/src/auth.d.ts

@@ -1,20 +0,0 @@
-declare global {
-    interface Login {
-        email: string;
-        password: string;
-    }
-    interface Social {
-        accessToken?: string;
-    }
-    interface Register {
-        email: string;
-        password: string;
-        cuit: string;
-        fullName: string;
-        phone?: number;
-    }
-    interface Recover {
-        email: string;
-    }
-}
-export {};

package/dist/src/auth.js

@@ -1 +0,0 @@
-export {};

package/dist/src/basket.d.ts

@@ -1,27 +0,0 @@
-declare global {
-    interface Basket {
-        storeId: string;
-        customerId: string;
-        customer: Partial<Customer>;
-        createdAt: number;
-        updatedAt: number;
-        quantity: number;
-        currency: string;
-        cost: number;
-        total: number;
-        items: BasketItem[];
-    }
-    interface BasketItem {
-        dated: number;
-        productId: string;
-        sku: string;
-        pictures: Product['pictures'];
-        name: string;
-        zone?: string;
-        quantity: number;
-        ivaType: number;
-        cost: number;
-        price: number;
-    }
-}
-export {};

package/dist/src/basket.js

@@ -1 +0,0 @@
-export {};

package/dist/src/brands.d.ts

@@ -1,14 +0,0 @@
-declare global {
-    interface Brand {
-        storeId: string;
-        brandId: string;
-        name: string;
-        photoURL?: string;
-        photoData?: string;
-        removePhotoURL?: string;
-        isFather: boolean;
-        father?: string;
-        disabled: boolean;
-    }
-}
-export {};

package/dist/src/brands.js

@@ -1 +0,0 @@
-export {};

package/dist/src/cash.d.ts

@@ -1,14 +0,0 @@
-declare global {
-    interface Cash {
-        storeId: string;
-        cashId: string;
-        createdAt: number;
-        dated: number;
-        description: string;
-        income?: number;
-        outcome?: number;
-        balance?: number;
-        subject?: string;
-    }
-}
-export {};

package/dist/src/cash.js

@@ -1 +0,0 @@
-export {};

package/dist/src/categories.d.ts

@@ -1,14 +0,0 @@
-declare global {
-    interface Category {
-        storeId: string;
-        categoryId: string;
-        name: string;
-        photoURL?: string;
-        photoData?: string;
-        removePhotoURL?: string;
-        isFather: boolean;
-        father?: string;
-        disabled: boolean;
-    }
-}
-export {};

package/dist/src/categories.js

@@ -1 +0,0 @@
-export {};

package/dist/src/currency.d.ts

@@ -1,39 +0,0 @@
-declare global {
-    type CurrencyVariant = "oficial" | "blue" | "mep" | "ccl" | "turista" | "informal" | "cripto" | "oficial-bcra";
-    interface PlatformCurrency {
-        catalogId: string;
-        isoCode: string;
-        variant: CurrencyVariant;
-        displayName: string;
-        afipCode: "PES" | "DOL" | null;
-        decimals: number;
-        enabled: boolean;
-        createdAt: number;
-        updatedAt?: number;
-    }
-    interface StoreCurrencySubscription {
-        catalogId: string;
-        value: number;
-        order?: number;
-        autoUpdate?: {
-            sourceId: string;
-            strategy: "overwrite" | "overwrite-if-stale" | "notify-only";
-            lastUpdatedAt?: number;
-            lastValue?: number;
-        };
-    }
-    interface StoreCurrencySubscriptionView extends StoreCurrencySubscription {
-        isoCode: string;
-        variant: CurrencyVariant;
-        displayName: string;
-        afipCode?: "PES" | "DOL" | null;
-        decimals?: number;
-    }
-    interface Currency {
-        catalogId: string;
-        dated: string;
-        value: number;
-        source?: string;
-    }
-}
-export {};

package/dist/src/currency.js

@@ -1 +0,0 @@
-export {};

package/dist/src/customer.d.ts

@@ -1,63 +0,0 @@
-declare global {
-    interface CustomerAfip {
-        cuit: string;
-        razonSocial: string;
-        condFiscal: number;
-        condFiscalName: string;
-        address: string;
-        postalCode: string;
-        city: string;
-        province: string;
-    }
-    interface CustomerMarketing {
-        adds?: boolean;
-        email?: boolean;
-        phone?: boolean;
-        sms?: boolean;
-        whatsapp?: boolean;
-    }
-    interface Customer {
-        storeId: string;
-        customerId: string;
-        address: string;
-        afip: CustomerAfip[];
-        balance?: number;
-        city: string;
-        createdAt: number;
-        cuit: string;
-        deliveryMethod: number;
-        disabled: boolean;
-        discount: number;
-        email: string;
-        favorites?: Partial<Product>[];
-        fullName: string;
-        hash?: string;
-        lastBuy?: number;
-        lastLog?: number;
-        marketing?: CustomerMarketing;
-        minBuy?: number;
-        paymentMethod: number;
-        phone: string;
-        photoURL: string;
-        postalCode: string;
-        priceList: number;
-        province: string;
-        salt?: string;
-        search: string;
-        updatedAt?: number;
-        currencyId?: string;
-        deliveryAddress?: {
-            fullName: string;
-            address: string;
-            phone: string;
-            city: string;
-            province: string;
-            postalCode: string;
-        };
-    }
-    interface AuthCustomer extends Customer {
-        accessToken: string;
-        refreshToken: string;
-    }
-}
-export {};

package/dist/src/customer.js

@@ -1 +0,0 @@
-export {};

package/dist/src/imports.d.ts

@@ -1,21 +0,0 @@
-declare global {
-    interface ProductSale {
-        pk: string;
-        sk: string;
-        orderId: string;
-        customerId: string;
-        fullName: string;
-        quantity: number;
-        price: number;
-    }
-    interface ProductIncome {
-        pk: string;
-        sk: string;
-        orderId?: string;
-        supplierId: string;
-        supplierName?: string;
-        quantity: number;
-        cost: number;
-    }
-}
-export {};

package/dist/src/imports.js

@@ -1 +0,0 @@
-export {};

package/dist/src/index.d.ts

@@ -1,28 +0,0 @@
-export * from "./account";
-export * from "./afip";
-export * from "./api";
-export * from "./audit";
-export * from "./auth";
-export * from "./basket";
-export * from "./brands";
-export * from "./cash";
-export * from "./categories";
-export * from "./currency";
-export * from "./customer";
-export * from "./imports";
-export * from "./invoice";
-export * from "./log";
-export * from "./maintenance";
-export * from "./mercadopago";
-export * from "./notification";
-export * from "./order";
-export * from "./payment";
-export * from "./product";
-export * from "./return";
-export * from "./stock";
-export * from "./store";
-export * from "./subscription";
-export * from "./supplier";
-export * from "./user";
-export * from "./whatsapp";
-export * from "./provinces";

package/dist/src/index.js

@@ -1,28 +0,0 @@
-export * from "./account";
-export * from "./afip";
-export * from "./api";
-export * from "./audit";
-export * from "./auth";
-export * from "./basket";
-export * from "./brands";
-export * from "./cash";
-export * from "./categories";
-export * from "./currency";
-export * from "./customer";
-export * from "./imports";
-export * from "./invoice";
-export * from "./log";
-export * from "./maintenance";
-export * from "./mercadopago";
-export * from "./notification";
-export * from "./order";
-export * from "./payment";
-export * from "./product";
-export * from "./return";
-export * from "./stock";
-export * from "./store";
-export * from "./subscription";
-export * from "./supplier";
-export * from "./user";
-export * from "./whatsapp";
-export * from "./provinces";