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

github ↗package ↗homepage ↗

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.

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

import { IxcOrm } from 'ixc-orm'

Named export, not default. Must use destructured import.

import { Recurso } from 'ixc-orm'

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

import { IxcResponse } from 'ixc-orm'

Enum for sort direction (ASC/DESC).

import { Sort } from 'ixc-orm'

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 footguns

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

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

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.

deprecatedNo deprecated features reported in the current version.

Upgrade

Version history

Breaking-change detection hasn't run for this library yet.

Audit

Security & dependencies

CVE tracking and dependency tree are planned for a later release.

Agent activity

8 hits · last 30 days

gptbot

ahrefsbot

Resources

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

packageixc-orm ↗

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