grexx-api

library13.6.2jsnpmunverified

The `grexx-api` package provides a strongly-typed TypeScript client for interacting with the Grexx Platform API, which is generated from an OpenAPI 3.0.2 specification. It enables developers to manage various Grexx platform entities such as cases, datasets, forms, and tasks programmatically. This client abstracts the HTTP request details, offering a more intuitive and type-safe interface for API operations. As of version 13.6.2, it is actively maintained, with new releases typically aligning with updates to the underlying Grexx Platform API or improvements in the OpenAPI generator itself. Its primary differentiator is the full TypeScript support, ensuring compile-time safety and a better development experience compared to direct HTTP requests.

http-networking serialization

npm install grexx-api

package ↗homepage ↗

INSTALL

IMPORT

SIG · GREXX-API

grexx-api

http-networkingjavascriptv13.6.2

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

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

OpenAPI

✓ import { OpenAPI } from 'grexx-api';

✗ const OpenAPI = require('grexx-api').OpenAPI;

Used for global client configuration like base URL and authentication tokens. Primarily designed for ESM imports.

CaseService

✓ import { CaseService } from 'grexx-api';

✗ const CaseService = require('grexx-api').CaseService;

Imports the service client for Case-related API endpoints. Each major API entity typically has its own service export.

CaseInfo

✓ import type { CaseInfo } from 'grexx-api';

✗ import { CaseInfo } from 'grexx-api';

For importing TypeScript types/interfaces like `CaseInfo` which represent API response structures. Use `import type` for clarity and bundler optimization.

Demonstrates initializing the Grexx API client and retrieving information for a specific case using the `CaseService`.

import { OpenAPI, CaseService } from 'grexx-api'; // Configure the API client with your base URL and API key OpenAPI.BASE = process.env.GREXX_API_BASE_URL ?? 'https://name.grexx.today/api/v1'; OpenAPI.TOKEN = process.env.GREXX_API_KEY ?? 'your-api-key'; // Replace with a secure way to load your API key const casePath = 'example-case-id'; // Replace with a valid case ID from your Grexx platform CaseService.caseInfo(casePath, { css: true, rootline: false }) .then(response => { console.log('Successfully fetched Case Info:'); console.log(`Case ID: ${response.id}`); console.log(`Case Title: ${response.title}`); }) .catch(error => { console.error('Error fetching case info:', error.message || error); if (error.status) { console.error(`Status: ${error.status}, Body: ${JSON.stringify(error.body)}`); } });

Debug

Known issues

breakingMajor version updates (e.g., v12 to v13) typically introduce breaking changes, which directly correspond to significant updates or refactorings in the underlying Grexx Platform API's OpenAPI specification. These changes may include altered endpoint paths, renamed parameters, different response body structures, or changes in required authentication schemes.

fix

Always review the release notes or changelog for specific breaking changes when upgrading major versions. Regenerate or update client code if you are using a custom OpenAPI generator, and adapt your application code to the new API contract.

affects: >=12.0

gotchaThe `OpenAPI.TOKEN` and `OpenAPI.BASE` configurations are global. If you are developing a server-side application that needs to interact with multiple Grexx instances or different user contexts, direct modification of these global properties can lead to race conditions or incorrect API calls. Ensure these are set appropriately for the current request context.

fix

For multi-tenant or multi-user applications, consider wrapping API calls within a function or class that accepts configuration parameters specific to each request or user, or ensure that global settings are managed carefully with proper isolation mechanisms (e.g., using a fresh instance of the client configuration for each request if the library supports it, or dynamically setting it with care).

affects: >=1.0

gotchaAPI keys (OpenAPI.TOKEN) and base URLs (OpenAPI.BASE) should never be hardcoded directly into production application code or committed to version control. This is a significant security risk.

fix

Store API keys and sensitive configurations in environment variables, a secure vault service (e.g., AWS Secrets Manager, HashiCorp Vault), or a `.env` file for local development. Access them at runtime using `process.env.YOUR_API_KEY`.

affects: >=1.0

Errors

Common errors & fixes

TypeError: Cannot read properties of undefined (reading 'caseInfo')

The `CaseService` or other service client was not correctly imported or `grexx-api` itself failed to load.

fix

Ensure `import { CaseService } from 'grexx-api';` is at the top of your file and that `grexx-api` is correctly installed via `npm install grexx-api`.

Error: Request failed with status code 401 (Unauthorized)

The provided `OpenAPI.TOKEN` is either missing, invalid, or has expired, preventing authentication with the Grexx Platform API.

fix

Verify that `OpenAPI.TOKEN` is set correctly with a valid, unexpired API key for your Grexx instance. Check the API key's permissions on the Grexx platform.

Error: Request failed with status code 404 (Not Found)

The `OpenAPI.BASE` URL is incorrect, the specific API endpoint does not exist at the provided path, or the resource (e.g., `casePath`) does not exist on the Grexx platform.

fix

Double-check `OpenAPI.BASE` against your Grexx platform's API documentation. Confirm that the `casePath` or other resource identifiers are correct and exist on your Grexx instance.

Upgrade

Version history

13.6.2latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

8 hits · last 30 days

node

Resources

packagehttps://www.npmjs.com/package/grexx-api ↗

homepagehttps://grexx.com ↗