fiscalapi 1.0.0

package/dist/types/services/fiscalapi-client.d.ts

@@ -0,0 +1,49 @@
+import { IFiscalapiClient, IInvoiceService, IProductService, IPersonService, IApiKeyService, ICatalogService, ITaxFileService } from '..';
+import { FiscalapiSettings } from '../common/fiscalapi-settings';
+/**
+ * Cliente principal para FiscalAPI
+ */
+export declare class FiscalapiClient implements IFiscalapiClient {
+    /**
+     * Servicio de facturas
+     */
+    readonly invoices: IInvoiceService;
+    /**
+     * Servicio de productos
+     */
+    readonly products: IProductService;
+    /**
+     * Servicio de personas
+     */
+    readonly persons: IPersonService;
+    /**
+     * Servicio de claves de API
+     */
+    readonly apiKeys: IApiKeyService;
+    /**
+     * Servicio de catálogos
+     */
+    readonly catalogs: ICatalogService;
+    /**
+     * Servicio de archivos fiscales
+     */
+    readonly taxFiles: ITaxFileService;
+    /**
+     * Crea una nueva instancia del cliente de FiscalAPI
+     * @param {FiscalapiSettings} settings - Configuración
+     * @private
+     */
+    private constructor();
+    /**
+     * Crea una nueva instancia del cliente de FiscalAPI
+     * @param {FiscalapiSettings} settings - Configuración
+     * @returns {IFiscalapiClient} Instancia del cliente de FiscalAPI
+     */
+    static create(settings: FiscalapiSettings): IFiscalapiClient;
+    /**
+     * Valida la configuración
+     * @param {FiscalapiSettings} settings - Configuración
+     * @private
+     */
+    private static validateSettings;
+}

package/dist/types/services/invoice-service.d.ts

@@ -0,0 +1,54 @@
+import { IFiscalapiHttpClient } from '../http/fiscalapi-http-client.interface';
+import { ApiResponse } from '../common/api-response';
+import { FileResponse } from '../common/file-response';
+import { BaseFiscalapiService } from './base-fiscalapi-service';
+import { IInvoiceService } from '../abstractions/invoice-service.interface';
+import { Invoice, CancelInvoiceRequest, CancelInvoiceResponse, CreatePdfRequest, SendInvoiceRequest, InvoiceStatusRequest, InvoiceStatusResponse } from '../models/invoice';
+/**
+ * Implementación del servicio de facturas
+ */
+export declare class InvoiceService extends BaseFiscalapiService<Invoice> implements IInvoiceService {
+    private readonly INCOME_ENDPOINT;
+    private readonly CREDIT_NOTE_ENDPOINT;
+    private readonly PAYMENT_ENDPOINT;
+    /**
+     * Crea una nueva instancia del servicio de facturas
+     * @param {IFiscalapiHttpClient} httpClient - Cliente HTTP
+     * @param {string} apiVersion - Versión de la API
+     */
+    constructor(httpClient: IFiscalapiHttpClient, apiVersion: string);
+    /**
+     * @inheritdoc
+     */
+    create(requestModel: Invoice): Promise<ApiResponse<Invoice>>;
+    /**
+     * Cancela una factura
+     * @param {CancelInvoiceRequest} request - Solicitud para cancelar factura
+     * @returns {Promise<ApiResponse<CancelInvoiceResponse>>} Respuesta de la cancelación
+     */
+    cancel(request: CancelInvoiceRequest): Promise<ApiResponse<CancelInvoiceResponse>>;
+    /**
+     * Obtiene el PDF de una factura
+     * @param {CreatePdfRequest} request - Solicitud para crear PDF
+     * @returns {Promise<ApiResponse<FileResponse>>} Respuesta con el archivo PDF
+     */
+    getPdf(request: CreatePdfRequest): Promise<ApiResponse<FileResponse>>;
+    /**
+     * Obtiene el XML de una factura
+     * @param {string} id - ID de la factura
+     * @returns {Promise<ApiResponse<FileResponse>>} Respuesta con el archivo XML
+     */
+    getXml(id: string): Promise<ApiResponse<FileResponse>>;
+    /**
+     * Envía una factura por correo electrónico
+     * @param {SendInvoiceRequest} request - Solicitud para enviar factura
+     * @returns {Promise<ApiResponse<boolean>>} Resultado de la operación
+     */
+    send(request: SendInvoiceRequest): Promise<ApiResponse<boolean>>;
+    /**
+     * Obtiene el estado de una factura
+     * @param {InvoiceStatusRequest} request - Solicitud para consultar estado
+     * @returns {Promise<ApiResponse<InvoiceStatusResponse>>} Respuesta con el estado de la factura
+     */
+    getStatus(request: InvoiceStatusRequest): Promise<ApiResponse<InvoiceStatusResponse>>;
+}

package/dist/types/services/person-service.d.ts

@@ -0,0 +1,15 @@
+import { Person } from '../models/person';
+import { IFiscalapiHttpClient } from '../http/fiscalapi-http-client.interface';
+import { BaseFiscalapiService } from './base-fiscalapi-service';
+import { IPersonService } from '..';
+/**
+ * Implementación del servicio de personas
+ */
+export declare class PersonService extends BaseFiscalapiService<Person> implements IPersonService {
+    /**
+     * Crea una nueva instancia del servicio de personas
+     * @param {IFiscalapiHttpClient} httpClient - Cliente HTTP
+     * @param {string} apiVersion - Versión de la API
+     */
+    constructor(httpClient: IFiscalapiHttpClient, apiVersion: string);
+}

package/dist/types/services/product-service.d.ts

@@ -0,0 +1,15 @@
+import { Product } from '../models/product';
+import { IFiscalapiHttpClient } from '../http/fiscalapi-http-client.interface';
+import { BaseFiscalapiService } from './base-fiscalapi-service';
+import { IProductService } from '..';
+/**
+ * Implementación del servicio de productos
+ */
+export declare class ProductService extends BaseFiscalapiService<Product> implements IProductService {
+    /**
+     * Crea una nueva instancia del servicio de productos
+     * @param {IFiscalapiHttpClient} httpClient - Cliente HTTP
+     * @param {string} apiVersion - Versión de la API
+     */
+    constructor(httpClient: IFiscalapiHttpClient, apiVersion: string);
+}

package/dist/types/services/tax-file-service.d.ts

@@ -0,0 +1,30 @@
+import { TaxFile } from '../models/tax-file';
+import { IFiscalapiHttpClient } from '../http/fiscalapi-http-client.interface';
+import { ApiResponse } from '../common/api-response';
+import { BaseFiscalapiService } from './base-fiscalapi-service';
+import { ITaxFileService } from '..';
+/**
+ * Implementación del servicio de archivos fiscales
+ */
+export declare class TaxFileService extends BaseFiscalapiService<TaxFile> implements ITaxFileService {
+    /**
+     * Crea una nueva instancia del servicio de archivos fiscales
+     * @param {IFiscalapiHttpClient} httpClient - Cliente HTTP
+     * @param {string} apiVersion - Versión de la API
+     */
+    constructor(httpClient: IFiscalapiHttpClient, apiVersion: string);
+    /**
+     * Obtiene el último par de ids de certificados válidos y vigente de una persona. Es decir sus certificados por defecto (ids)
+     *
+     * @param personId - Id de la persona propietaria de los certificados
+     * @returns Promise que resuelve en una respuesta API con una lista de un par de certificados, pero sin contenido, solo sus Ids
+     */
+    getDefaultReferences(personId: string): Promise<ApiResponse<TaxFile[]>>;
+    /**
+    * Obtiene el último par de certificados válidos y vigente de una persona. Es decir sus certificados por defecto
+    *
+    * @param personId - Id de la persona dueña de los certificados
+    * @returns Promise que resuelve en una respuesta API con una lista de un par de certificados
+    */
+    getDefaultValues(personId: string): Promise<ApiResponse<TaxFile[]>>;
+}

package/dist/types/utils/date-utils.d.ts

@@ -0,0 +1,17 @@
+import { DateTime } from 'luxon';
+/**
+ * Formato de fecha SAT (para facturas mexicanas)
+ */
+export declare const SAT_DATE_FORMAT = "yyyy-MM-dd'T'HH:mm:ss";
+/**
+ * Formatea una fecha de acuerdo al formato de fecha SAT
+ * @param {Date|string|DateTime} date - Fecha a formatear
+ * @returns {string} Cadena de fecha formateada
+ */
+export declare function formatSatDate(date: Date | string | DateTime): string;
+/**
+ * Analiza una cadena de formato de fecha SAT en un objeto DateTime
+ * @param {string} dateStr - Cadena de fecha en formato SAT
+ * @returns {DateTime} Objeto DateTime
+ */
+export declare function parseSatDate(dateStr: string): DateTime;

package/dist/types/utils/encoding-utils.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Codifica una cadena a base64
+ * @param {string} text - Texto a codificar
+ * @returns {string} Cadena codificada en base64
+ */
+export declare function encodeToBase64(text: string): string;
+/**
+ * Decodifica una cadena base64
+ * @param {string} base64Text - Cadena codificada en base64
+ * @returns {string} Cadena decodificada
+ */
+export declare function decodeFromBase64(base64Text: string): string;

package/dist/types/utils/validation-utils.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Comprueba si un valor es nulo o indefinido
+ * @param {any} value - Valor a comprobar
+ * @returns {boolean} Verdadero si el valor es nulo o indefinido, falso en caso contrario
+ */
+export declare function isNullOrUndefined(value: any): boolean;
+/**
+ * Comprueba si una cadena es nula, indefinida o vacía
+ * @param {string|null|undefined} value - Cadena a comprobar
+ * @returns {boolean} Verdadero si la cadena es nula, indefinida o vacía, falso en caso contrario
+ */
+export declare function isNullOrEmpty(value: string | null | undefined): boolean;
+/**
+ * Comprueba si un array es nulo, indefinido o vacío
+ * @param {T[]|null|undefined} value - Array a comprobar
+ * @returns {boolean} Verdadero si el array es nulo, indefinido o vacío, falso en caso contrario
+ * @template T
+ */
+export declare function isArrayNullOrEmpty<T>(value: T[] | null | undefined): boolean;
+/**
+ * Comprueba si un objeto es nulo, indefinido o no tiene propiedades
+ * @param {object|null|undefined} value - Objeto a comprobar
+ * @returns {boolean} Verdadero si el objeto es nulo, indefinido o no tiene propiedades, falso en caso contrario
+ */
+export declare function isObjectEmpty(value: object | null | undefined): boolean;

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "fiscalapi",
+  "version": "1.0.0",
+  "description": "SDK de Node.js para FiscalAPI",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/types/index.d.ts",
+  "files": [
+    "dist/",
+    "fiscalapi.ico",
+    "fiscalapi.png",
+    "LICENSE.txt"
+  ],
+  "scripts": {
+    "clean": "rimraf dist",
+    "build": "npm run clean && npm run build:esm && npm run build:cjs && npm run build:types",
+    "build:esm": "tsc -p tsconfig.esm.json",
+    "build:cjs": "tsc -p tsconfig.cjs.json",
+    "build:types": "tsc -p tsconfig.types.json",
+    "test": "jest",
+    "lint": "eslint 'src/**/*.ts'",
+    "prepare": "npm run build",
+    "main": "ts-node examples/main.ts"
+  },
+  "keywords": [
+    "fiscalapi",
+    "cfdi",
+    "factura",
+    "facturación",
+    "sat",
+    "mexico"
+  ],
+  "author": "FISCAL API S DE R.L DE C.V",
+  "license": "MPL-2.0",
+  "engines": {
+    "node": ">=12.0.0"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js",
+      "types": "./dist/types/index.d.ts"
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/FiscalAPI/fiscalapi-node"
+  },
+  "homepage": "https://www.fiscalapi.com",
+  "bugs": {
+    "url": "https://github.com/FiscalAPI/fiscalapi-node/issues"
+  },
+  "dependencies": {
+    "axios": "^1.8.4",
+    "luxon": "^3.6.0"
+  },
+  "devDependencies": {
+    "@types/luxon": "^3.4.2",
+    "@types/node": "^22.13.14",
+    "rimraf": "^6.0.1",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.8.2"
+  }
+}