keez-invoicing 1.1.5

package/dist/types/src/api/items/update.d.ts

@@ -0,0 +1,11 @@
+import { UpdateItemRequest } from '../../../../src/dto/items';
+interface UpdateItemParams {
+    readonly baseDomain: string;
+    readonly appId: string;
+    readonly appClientId: string;
+    readonly bearerToken: string;
+    readonly itemId: string;
+    readonly item: UpdateItemRequest;
+}
+export declare function apiUpdateItem(params: UpdateItemParams): Promise<void>;
+export {};

package/dist/types/src/config/constants.d.ts

@@ -0,0 +1,13 @@
+export declare const SECONDS_IN_MINUTE = 60;
+export declare const MINUTES_IN_HOUR = 60;
+export declare const MILLISECONDS_IN_SECOND = 1000;
+export declare const SECONDS_IN_HOUR: number;
+export declare const MILLISECONDS_IN_MINUTE: number;
+export declare const HTTP_REQUEST_TIMEOUT_MS: number;
+export declare const DOWNLOAD_REQUEST_TIMEOUT_MS: number;
+export declare const TOKEN_EXPIRY_BUFFER_MS: number;
+export declare const DATE_PAD_LENGTH = 2;
+export declare const MONTH_INDEX_OFFSET = 1;
+export declare const DECIMAL_RADIX = 10;
+export declare const DEFAULT_VAT_AMOUNT = 0;
+export declare const DEFAULT_INVOICE_QUANTITY = 1;

package/dist/types/src/config/constructorParam.d.ts

@@ -0,0 +1,6 @@
+export interface KeezConstructor {
+    readonly application_id: string;
+    readonly client_eid: string;
+    readonly secret: string;
+    readonly live: boolean;
+}

package/dist/types/src/config/measureUnit.d.ts

@@ -0,0 +1,17 @@
+export declare enum MeasureUnit {
+    PIECE = 1,// Bucata
+    KILOGRAM = 2,// Kilogram
+    GRAM = 3,// Gram
+    LITER = 4,// Litru
+    METER = 5,// Metru
+    SQUARE_METER = 6,// Metru patrat
+    CUBIC_METER = 7,// Metru cub
+    HOUR = 8,// Ora
+    DAY = 9,// Zi
+    MONTH = 10,// Luna
+    YEAR = 11,// An
+    SET = 12,// Set
+    PACK = 13,// Pachet
+    BOX = 14,// Cutie
+    SERVICE = 15
+}

package/dist/types/src/config/paymentType.d.ts

@@ -0,0 +1,12 @@
+export declare enum PaymentType {
+    CASH = 1,// Bon fiscal platit cu numerar
+    CARD = 2,// Bon fiscal platit cu cardul
+    BANK_TRANSFER = 3,// Factura platita prin transfer bancar
+    CASH_RECEIPT = 4,// Plata numerar cu chitanta
+    CASH_ON_DELIVERY = 5,// Ramburs
+    CARD_ONLINE = 6,// Plata cu cardul online
+    CARD_PLATFORMS = 7,// Plata cu platforme distributie si plata (Emag)
+    HOLIDAY_VOUCHER_CARD = 8,// Plata cu voucher de vacanta (card)
+    HOLIDAY_VOUCHER_TICKET = 9,// Plata cu voucher de vacanta (ticket)
+    MEAL_VOUCHER = 10
+}

package/dist/types/src/config/paymentType.js.d.ts

@@ -0,0 +1,11 @@
+export declare enum PaymentType {
+    CASH = 1,
+    CARD = 2,
+    BANK_TRANSFER = 3,
+    CASH_RECEIPT = 4,
+    CASH_ON_DELIVERY = 5,
+    CARD_ONLINE = 6,
+    CARD_PLATFORMS = 7,
+    HOLIDAY_VOUCHER_CARD = 8,
+    HOLIDAY_VOUCHER_TICKET = 9
+}

package/dist/types/src/dto/allInvoicesResponse.d.ts

@@ -0,0 +1,21 @@
+export interface ShortInvoiceResponse {
+    readonly externalId: string;
+    readonly series: string;
+    readonly number: number;
+    readonly documentDate: number;
+    readonly dueDate: number;
+    readonly status: string;
+    readonly clientName: string;
+    readonly partnerName: string;
+    readonly currencyCode: string;
+    readonly referenceCurrencyCode: string;
+    readonly netAmount: number;
+    readonly vatAmount: number;
+    readonly grossAmount: number;
+}
+export interface AllInvoicesResponse {
+    readonly first: number;
+    readonly last: number;
+    readonly recordsCount: number;
+    readonly data: ShortInvoiceResponse[];
+}

package/dist/types/src/dto/authResponse.d.ts

@@ -0,0 +1,7 @@
+export interface AuthResponse {
+    readonly access_token: string;
+    readonly expires_in: number;
+    readonly expires_at: number;
+    readonly token_type: string;
+    readonly scope: string;
+}

package/dist/types/src/dto/common/index.d.ts

@@ -0,0 +1 @@
+export { PaginationParams } from './paginationParams';

package/dist/types/src/dto/common/paginationParams.d.ts

@@ -0,0 +1,4 @@
+export interface PaginationParams {
+    readonly offset?: number;
+    readonly count?: number;
+}

package/dist/types/src/dto/createInvoiceRequest.d.ts

@@ -0,0 +1,34 @@
+import { PaymentType } from '../../../src/config/paymentType';
+export interface Partner {
+    addressDetails: string;
+    cityName: string;
+    countryCode: string;
+    countryName: string;
+    countyCode: string;
+    countyName: string;
+    identificationNumber: string;
+    isLegalPerson: boolean;
+    partnerName: string;
+}
+export interface InvoiceDetail {
+    itemExternalId: string;
+    measureUnitId: number;
+    quantity: number;
+    unitPrice: number;
+    netAmount: number;
+    vatAmount: number;
+    grossAmount: number;
+}
+export interface InvoiceRequest {
+    series: string;
+    currencyCode: string;
+    amount: number;
+    paymentType: PaymentType;
+    partner: Partner;
+    itemId: string;
+    documentDate?: number;
+    dueDate?: number;
+    measureUnitId?: number;
+    quantity?: number;
+    vatOnCollection?: boolean;
+}

package/dist/types/src/dto/invoiceResponse.d.ts

@@ -0,0 +1,48 @@
+import { Partner } from './createInvoiceRequest';
+export interface Item {
+    discountGrossValue: number;
+    discountNetValue: number;
+    discountValueOnNet: boolean;
+    discountVatValue: number;
+    exciseAmount: number;
+    grossAmount: number;
+    itemCode: string;
+    itemDescription: string;
+    itemExternalId: string;
+    itemName: string;
+    measureUnitId: number;
+    netAmount: number;
+    originalNetAmount: number;
+    originalVatAmount: number;
+    quantity: number;
+    unMeasureUnit: string;
+    unVatCategory: string;
+    unVatExemptionReason: string;
+    unitPrice: number;
+    vatAmount: number;
+    vatPercent: number;
+}
+export interface InvoiceResponse {
+    currencyCode: string;
+    discountGrossValue: number;
+    discountNetValue: number;
+    discountValueOnNet: boolean;
+    discountVatValue: number;
+    documentDate: number;
+    dueDate: number;
+    exchangeRate: number;
+    exciseAmount: number;
+    grossAmount: number;
+    items: Item[];
+    netAmount: number;
+    number: number;
+    originalNetAmount: number;
+    originalVatAmount: number;
+    partner: Partner;
+    paymentTypeId: number;
+    referenceCurrencyCode: string;
+    series: string;
+    status: string;
+    vatAmount: number;
+    vatOnCollection: boolean;
+}

package/dist/types/src/dto/invoices/index.d.ts

@@ -0,0 +1,3 @@
+export { InvoiceFilterParams } from './invoiceFilterParams';
+export { SendInvoiceEmailParams } from './sendInvoiceParams';
+export { InvoiceRequestV2, InvoiceLineItem } from './invoiceRequestV2';

package/dist/types/src/dto/invoices/invoiceFilterParams.d.ts

@@ -0,0 +1,8 @@
+import { PaginationParams } from '../../../../src/dto/common/paginationParams';
+export interface InvoiceFilterParams extends PaginationParams {
+    readonly status?: string;
+    readonly fromDate?: number;
+    readonly toDate?: number;
+    readonly series?: string;
+    readonly partnerName?: string;
+}

package/dist/types/src/dto/invoices/invoiceRequestV2.d.ts

@@ -0,0 +1,23 @@
+import { PaymentType } from '../../../../src/config/paymentType';
+import { Partner } from '../../../../src/dto/createInvoiceRequest';
+export interface InvoiceLineItem {
+    readonly itemExternalId: string;
+    readonly measureUnitId: number;
+    readonly quantity: number;
+    readonly unitPrice: number;
+    readonly vatPercent?: number;
+    readonly discountPercent?: number;
+    readonly description?: string;
+}
+export interface InvoiceRequestV2 {
+    readonly series: string;
+    readonly documentDate: number;
+    readonly dueDate: number;
+    readonly currencyCode: string;
+    readonly paymentType: PaymentType;
+    readonly partner: Partner;
+    readonly items: InvoiceLineItem[];
+    readonly vatOnCollection?: boolean;
+    readonly exchangeRate?: number;
+    readonly notes?: string;
+}

package/dist/types/src/dto/invoices/sendInvoiceParams.d.ts

@@ -0,0 +1,5 @@
+export interface SendInvoiceEmailParams {
+    readonly to: string;
+    readonly cc?: string[];
+    readonly bcc?: string[];
+}

package/dist/types/src/dto/items/allItemsResponse.d.ts

@@ -0,0 +1,13 @@
+import { PaginationParams } from '../../../../src/dto/common/paginationParams';
+import { ItemResponse } from './itemResponse';
+export interface ItemFilterParams extends PaginationParams {
+    readonly itemName?: string;
+    readonly itemCode?: string;
+    readonly isActive?: boolean;
+}
+export interface AllItemsResponse {
+    readonly first: number;
+    readonly last: number;
+    readonly recordsCount: number;
+    readonly data: ItemResponse[];
+}

package/dist/types/src/dto/items/index.d.ts

@@ -0,0 +1,3 @@
+export { CreateItemRequest, UpdateItemRequest, PatchItemRequest } from './itemRequest';
+export { ItemResponse } from './itemResponse';
+export { ItemFilterParams, AllItemsResponse } from './allItemsResponse';

package/dist/types/src/dto/items/itemRequest.d.ts

@@ -0,0 +1,34 @@
+import { MeasureUnit } from '../../../../src/config/measureUnit';
+export interface CreateItemRequest {
+    readonly itemName: string;
+    readonly itemCode?: string;
+    readonly itemDescription?: string;
+    readonly measureUnitId: MeasureUnit;
+    readonly unitPrice: number;
+    readonly vatPercent: number;
+    readonly vatCategoryCode?: string;
+    readonly vatExemptionReason?: string;
+    readonly isActive?: boolean;
+}
+export interface UpdateItemRequest {
+    readonly itemName: string;
+    readonly itemCode?: string;
+    readonly itemDescription?: string;
+    readonly measureUnitId: MeasureUnit;
+    readonly unitPrice: number;
+    readonly vatPercent: number;
+    readonly vatCategoryCode?: string;
+    readonly vatExemptionReason?: string;
+    readonly isActive?: boolean;
+}
+export interface PatchItemRequest {
+    readonly itemName?: string;
+    readonly itemCode?: string;
+    readonly itemDescription?: string;
+    readonly measureUnitId?: MeasureUnit;
+    readonly unitPrice?: number;
+    readonly vatPercent?: number;
+    readonly vatCategoryCode?: string;
+    readonly vatExemptionReason?: string;
+    readonly isActive?: boolean;
+}

package/dist/types/src/dto/items/itemResponse.d.ts

@@ -0,0 +1,15 @@
+export interface ItemResponse {
+    readonly externalId: string;
+    readonly itemName: string;
+    readonly itemCode: string;
+    readonly itemDescription: string;
+    readonly measureUnitId: number;
+    readonly measureUnitName: string;
+    readonly unitPrice: number;
+    readonly vatPercent: number;
+    readonly vatCategoryCode: string;
+    readonly vatExemptionReason: string;
+    readonly isActive: boolean;
+    readonly createdAt: number;
+    readonly updatedAt: number;
+}

package/dist/types/src/errors/KeezError.d.ts

@@ -0,0 +1,11 @@
+export declare class KeezError extends Error {
+    readonly statusCode?: number | undefined;
+    readonly originalError?: unknown | undefined;
+    constructor(message: string, statusCode?: number | undefined, originalError?: unknown | undefined);
+}
+export declare class KeezAuthError extends KeezError {
+    constructor(message: string, statusCode?: number, originalError?: unknown);
+}
+export declare class KeezApiError extends KeezError {
+    constructor(message: string, statusCode?: number, originalError?: unknown);
+}

package/dist/types/src/helpers/logger.d.ts

@@ -0,0 +1,2 @@
+import winston from 'winston';
+export declare const logger: winston.Logger;

package/dist/types/src/index.d.ts

@@ -0,0 +1,11 @@
+export { KeezApi } from './keezApi';
+export { KeezError, KeezAuthError, KeezApiError } from './errors/KeezError';
+export { PaymentType } from './config/paymentType';
+export { MeasureUnit } from './config/measureUnit';
+export { PaginationParams } from './dto/common';
+export { InvoiceRequest, Partner } from './dto/createInvoiceRequest';
+export { InvoiceResponse, Item } from './dto/invoiceResponse';
+export { AllInvoicesResponse, ShortInvoiceResponse } from './dto/allInvoicesResponse';
+export { InvoiceFilterParams, SendInvoiceEmailParams, InvoiceRequestV2, InvoiceLineItem } from './dto/invoices';
+export { CreateItemRequest, UpdateItemRequest, PatchItemRequest, ItemResponse, ItemFilterParams, AllItemsResponse, } from './dto/items';
+export { AuthResponse } from './dto/authResponse';

package/dist/types/src/keezApi.d.ts

@@ -0,0 +1,114 @@
+import { KeezConstructor } from './config/constructorParam';
+import { InvoiceRequest } from './dto/createInvoiceRequest';
+import { InvoiceFilterParams, InvoiceRequestV2, SendInvoiceEmailParams } from './dto/invoices';
+import { AllItemsResponse, CreateItemRequest, ItemFilterParams, ItemResponse, PatchItemRequest, UpdateItemRequest } from './dto/items';
+export declare class KeezApi {
+    private readonly appId;
+    private readonly apiSecret;
+    private readonly apiClientId;
+    private authResponse;
+    private authToken;
+    private isLive;
+    constructor(params: KeezConstructor);
+    /**
+     * Get the base domain for the API
+     * @returns {string} - The base domain
+     */
+    getBaseDomain(): string;
+    private checkIfTokenIsValid;
+    private generateToken;
+    /**
+     * Set live mode
+     *
+     * @param {boolean} mode - `False` will use the staging mode and `True` will use the production mode
+     */
+    setLive(mode: boolean): void;
+    /**
+     * Get all invoices with optional filtering and pagination
+     * @param params - Optional filter parameters
+     */
+    getAllInvoices(params?: InvoiceFilterParams): Promise<import(".").AllInvoicesResponse>;
+    /**
+     * Get an invoice by its external ID
+     * @param invoiceExternalId - The external ID of the invoice
+     */
+    getInvoiceByExternalId(invoiceExternalId: string): Promise<import(".").InvoiceResponse>;
+    /**
+     * Send an invoice via email
+     * @param email - The recipient email address
+     * @param invoiceExternalId - The external ID of the invoice
+     */
+    sendInvoice(email: string, invoiceExternalId: string): Promise<string>;
+    /**
+     * Send an invoice via email with CC/BCC support
+     * @param emailParams - Email parameters including to, cc, and bcc
+     * @param invoiceExternalId - The external ID of the invoice
+     */
+    sendInvoice(emailParams: SendInvoiceEmailParams, invoiceExternalId: string): Promise<string>;
+    /**
+     * Create a new invoice
+     * @param invoiceParams - The invoice parameters
+     */
+    createInvoice(invoiceParams: InvoiceRequest): Promise<string>;
+    /**
+     * Validate an invoice
+     * @param invoiceExternalId - The external ID of the invoice
+     */
+    validateInvoice(invoiceExternalId: string): Promise<string>;
+    /**
+     * Update an existing invoice
+     * @param invoiceId - The external ID of the invoice to update
+     * @param invoice - The updated invoice data
+     */
+    updateInvoice(invoiceId: string, invoice: InvoiceRequestV2): Promise<void>;
+    /**
+     * Delete an invoice
+     * @param invoiceId - The external ID of the invoice to delete
+     */
+    deleteInvoice(invoiceId: string): Promise<void>;
+    /**
+     * Submit an invoice to eFactura (Romanian electronic invoicing system)
+     * @param invoiceId - The external ID of the invoice to submit
+     * @returns The upload index or confirmation from eFactura
+     */
+    submitInvoiceToEfactura(invoiceId: string): Promise<string>;
+    /**
+     * Cancel an invoice
+     * @param invoiceId - The external ID of the invoice to cancel
+     */
+    cancelInvoice(invoiceId: string): Promise<void>;
+    /**
+     * Download an invoice as PDF
+     * @param invoiceId - The external ID of the invoice
+     * @returns Buffer containing the PDF data
+     */
+    downloadInvoicePdf(invoiceId: string): Promise<Buffer>;
+    /**
+     * Get all items with optional filtering and pagination
+     * @param params - Optional filter parameters
+     */
+    getAllItems(params?: ItemFilterParams): Promise<AllItemsResponse>;
+    /**
+     * Get an item by its external ID
+     * @param itemId - The external ID of the item
+     */
+    getItemByExternalId(itemId: string): Promise<ItemResponse>;
+    /**
+     * Create a new item
+     * @param item - The item data to create
+     * @returns The external ID of the created item
+     */
+    createItem(item: CreateItemRequest): Promise<string>;
+    /**
+     * Update an existing item (full replacement)
+     * @param itemId - The external ID of the item to update
+     * @param item - The updated item data
+     */
+    updateItem(itemId: string, item: UpdateItemRequest): Promise<void>;
+    /**
+     * Partially update an existing item
+     * @param itemId - The external ID of the item to patch
+     * @param item - The fields to update
+     */
+    patchItem(itemId: string, item: PatchItemRequest): Promise<void>;
+}

package/dist/types/tests/additional-coverage.test.d.ts

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

package/dist/types/tests/edge-cases.test.d.ts

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

package/dist/types/tests/error-handling.test.d.ts

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

package/dist/types/tests/filter-params.test.d.ts

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

package/dist/types/tests/index.test.d.ts

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

package/dist/types/tests/invoices-extended.test.d.ts

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

package/dist/types/tests/items.test.d.ts

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

package/package.json

@@ -0,0 +1,66 @@
+{
+    "name": "keez-invoicing",
+    "version": "1.1.5",
+    "description": "Keez API wrapper using Node",
+    "type": "module",
+    "main": "dist/src/index.js",
+    "types": "dist/src/index.d.ts",
+    "scripts": {
+        "build": "tsc && tsc-alias",
+        "format": "prettier --write \"src/**/*.(js|ts)\"",
+        "lint": "eslint src",
+        "lint:fix": "eslint src --fix",
+        "postversion": "git push && git push --tags",
+        "prepare": "npm run build",
+        "prepublishOnly": "npm test && npm run lint",
+        "preversion": "npm run lint",
+        "test": "jest --config jest.config.cjs",
+        "test:ci": "jest --coverage --ci --maxWorkers=2",
+        "test:coverage": "jest --coverage",
+        "test:e2e": "jest --testPathPatterns=e2e",
+        "test:integration": "jest --testPathPatterns=integration",
+        "test:unit": "jest --testPathPatterns=unit",
+        "test:watch": "jest --watch",
+        "version": "npm run format && git add -A src"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/TPN-Labs/keez-node.git"
+    },
+    "keywords": [
+        "keez",
+        "node",
+        "romania",
+        "efactura",
+        "typescript"
+    ],
+    "author": "TPN LABS",
+    "license": "MIT",
+    "bugs": {
+        "url": "https://github.com/TPN-Labs/keez-node/issues"
+    },
+    "homepage": "https://github.com/TPN-Labs/keez-node#readme",
+    "devDependencies": {
+        "@eslint/js": "^9.18.0",
+        "@types/jest": "^30.0.0",
+        "@typescript-eslint/eslint-plugin": "^8.20.0",
+        "@typescript-eslint/parser": "^8.20.0",
+        "eslint": "^9.39.2",
+        "eslint-plugin-jest": "^29.12.1",
+        "globals": "^17.0.0",
+        "typescript-eslint": "^8.20.0",
+        "jest": "^30.2.0",
+        "nock": "^14.0.10",
+        "prettier": "^3.4.2",
+        "ts-jest": "^29.2.5",
+        "tsc-alias": "^1.8.16",
+        "typescript": "^5.7.3"
+    },
+    "files": [
+        "dist/**/*"
+    ],
+    "dependencies": {
+        "axios": "^1.7.9",
+        "winston": "^3.17.0"
+    }
+}