ixc-orm

library2.3.5jsnpmunverified

IXC-ORM v2.3.5 is a TypeScript ORM for consuming data from the IXC Provedor API (IXCsoft). It simplifies CRUD operations with a model-based approach, query builder, and built-in resource endpoints for common actions like contract activation, temporary unblocking, and fetching boletos. The library is community-maintained, supports ESM only, and requires environment variables for authentication. It ships with TypeScript types and has a stable release cadence.

database

npm install ixc-orm

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · IXC-ORM

ixc-orm

databasejavascriptv2.3.5

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

IxcOrm

✓ import { IxcOrm } from 'ixc-orm'

✗ const IxcOrm = require('ixc-orm')

ESM-only package; CommonJS require will fail. Use import syntax.

Recurso

✓ import { Recurso } from 'ixc-orm'

✗ import Recurso from 'ixc-orm'

Named export, not default. Must use destructured import.

IxcResponse

✓ import { IxcResponse } from 'ixc-orm'

Type export for response handling. Common in query builder usage.

Sort

✓ import { Sort } from 'ixc-orm'

Enum for sort direction (ASC/DESC).

Defines a model class extending IxcOrm, performs a filtered query with sorting, and uses a built-in resource endpoint for temporary unblock.

import { IxcOrm, IxcResponse, Sort, Recurso } from 'ixc-orm'; // Define a model for 'cliente_contrato' class Contrato extends IxcOrm { constructor() { super('cliente_contrato'); } } async function main() { // Query example const contrato = new Contrato(); const response: IxcResponse = await contrato .where('data_ativacao') .greaterThanEquals('2024-09-24') .orderBy('data_ativacao', Sort.DESC) .GET(); console.log(response.registros()); // Resource example: temporary unblock const recursoResponse = await Recurso.liberacaoTemporaria({ id_contrato: 12345 }); console.log(recursoResponse); } main().catch(console.error);

Debug

Known issues

breakingEnvironment variables IXC_ACCESS_TOKEN and IXC_SERVER_DOMAIN must be set. If missing, the library throws a runtime error.

fix

Create a .env file with IXC_ACCESS_TOKEN=<your-token> and IXC_SERVER_DOMAIN=<your-domain> before using the library.

affects: >=0.0.0

gotchaThe library is ESM-only. Using require() results in a runtime error.

fix

Use import syntax and ensure your project is configured for ES modules (type: 'module' in package.json).

affects: >=2.0.0

gotchaThe model table name passed to the super() call must exactly match an API endpoint name (e.g., 'cliente_contrato'). Incorrect names result in 404 errors.

fix

Verify the correct endpoint name in IXC Provedor API documentation.

affects: >=0.0.0

deprecatedNo deprecated features reported in the current version.

fix

N/A

affects: >=2.3.5

Errors

Common errors & fixes

Error: Module not found: Can't resolve 'ixc-orm'

Missing npm install.

fix

Run: npm install ixc-orm

TypeError: IxcOrm is not a constructor

Using CommonJS require instead of ESM import.

fix

Use: import { IxcOrm } from 'ixc-orm'

Error: IXC_ACCESS_TOKEN not defined in environment variables

Missing environment variables in .env file.

fix

Create .env file with IXC_ACCESS_TOKEN=your_token and IXC_SERVER_DOMAIN=your_domain

Error: Invalid or missing 'tabela' parameter

Incorrect table name in super() call.

fix

Double-check the exact endpoint name (e.g., 'cliente_contrato').

Upgrade

Version history

2.3.5latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/fscarmo/ixc-orm ↗

packageixc-orm ↗

homepagehttps://github.com/fscarmo/ixc-orm#readme ↗