Introducing the xyOps SDK for Node.js

[jhuckaby]

Hello everyone!

I’m happy to share the new xyOps SDK for Node.js, now available on npm.

The SDK gives your Node.js code a friendly, native JavaScript interface to xyOps. It is designed for two main use cases: connecting external applications and integrations to the xyOps REST API, and building custom code that runs inside xyOps jobs.

const { api, job } = require('@pixlcore/xyops-sdk');

A rich toolkit for running jobs

The job interface makes it much easier to write custom Node.js Event Plugins and scripts for the built-in Shell Plugin. It handles the xyOps job protocol for you, so your code can focus on the work it needs to do.

You can use simple helpers to:

• Read job parameters, input data, files, workflow data, server data, and Secret Vault variables
• Send output data to downstream workflow nodes
• Attach files to completed jobs
• Add tags and follow-up actions
• Display tables, text, HTML, or GitHub Flavored Markdown on the Job Details page
• Send live progress, status, and label updates
• Write structured job logs with automatic xyOps context
• Record performance timings and counters
• Complete jobs cleanly with a success or error result

const { job } = require('@pixlcore/xyops-sdk');

(async function() {
	await job.read();
	
	let filename = job.getParam('filename');
	job.setStatus('Processing ' + filename + '...');
	job.setProgress(50);
	
	job.addData({ processed_file: filename });
	job.setProgress(100);
	job.finalSuccess('Processing complete');
})();

A friendly API client

The api interface wraps the xyOps REST API and takes care of request formatting, authentication, and response parsing. You can use it from applications, services, command-line tools, integrations, or directly inside an xyOps job.

It includes support for:

• The complete standard xyOps API catalog, including events, jobs, servers, monitors, alerts, tickets, secrets, buckets, Marketplace data, and more
• File uploads and downloads
• Streaming live job updates
• Configurable timeouts and automatic retries
• Optional exception-based error handling
• Raw response access and request performance metrics when you need them

Here is a small example:

const { api } = require('@pixlcore/xyops-sdk');

(async function() {
	let { err, data } = await api.getEvents();
	if (err) return console.error(err);
	
	console.log(data.rows);
})();

Note: For using the API client inside of xyOps jobs, you'll need to create an API Key, add it to a Secret Vault as XYOPS_API_KEY, and assign that Secret Vault to the Event or Plugin running your code. The SDK will automatically use this variable to authenticate API requests.

Ready to use in xyOps jobs

Starting with xySat (xyOps Satellite) v1.0.34, the SDK is already included with the Satellite. Your custom xyOps Event Plugins and scripts running through the built-in Shell Plugin can simply require the package and start using it, without a separate installation step.

For external Node.js applications, install it from npm as usual:

npm install @pixlcore/xyops-sdk

Both CommonJS and ESM imports are supported, and the library is fully typed with bundled TypeScript type definitions.

The project README includes a complete guide to the job runtime helpers, API client configuration, working examples, and the full API catalog.

I hope this makes it easier and more enjoyable to extend xyOps, build integrations, and create powerful custom job experiences. If you try it, I’d love to hear what you build and any feedback you have!

What SDK language should we build next? PHP? Python? Go? Perl?