Why use Ultan?

Ultan is a utility library that bridges traditional JavaScript development with modern AI, healthcare (FHIR/HL7), and cloud-native architectures. Built for Fortune 500 environments, it provides enterprise-grade functions for string manipulation, array operations, object handling, healthcare data processing, AI prompt management, PHI masking, and reactive state management. Whether you're building HIPAA-compliant healthcare applications, AI-powered workflows, or mission-critical enterprise systems, Ultan delivers production-ready utilities that eliminate boilerplate and accelerate development cycles.

Table of Contents

• Installation
• Quick Start
• Healthcare (FHIR/HL7)
  • isValidFhir
  • getFhirName
  • getAcuityScore
  • maskPHI
  • isZombie
• AI Integration
  • fillPrompt
  • parseAiJson
  • createSignal
• String Manipulation
  • stringFormat
  • toTitleCase
  • sanitizeString
  • fromBase64 / toBase64
  • countOccurrences
• Object Utilities
  • isEmpty
  • deepClone
  • setNestedProperty
  • getNestedProperty
  • objectToArray / arrayToObject
• Array Utilities
  • mergeArrays
  • sumArray / averageArray
  • arrayDifference
  • removeFalsyValues
  • groupBy
• Function Utilities
  • debounce
  • throttle
• HTTP/Network
  • reqFlow
• Miscellaneous
  • greet
  • getType
  • getRandomInRange
  • round
  • generateUUID
  • formatDate
• Regular Expressions
• Constants
  • DaysOfWeek
  • HttpStatus
• License

Installation

npm install ultan

Quick Start

const {
  stringFormat,
  isValidFhir,
  getFhirName,
  getAcuityScore,
  fillPrompt,
  parseAiJson,
  maskPHI,
  debounce,
  generateUUID
} = require('ultan');

const patient = {
  resourceType: 'Patient',
  id: '12345',
  name: [{ use: 'official', given: ['John'], family: 'Doe' }]
};

console.log(isValidFhir(patient));
console.log(getFhirName(patient));

Healthcare (FHIR/HL7)

isValidFhir(resource)

Validates if an object is a valid FHIR resource by checking for resourceType and id properties.

isValidFhir({ resourceType: 'Patient', id: '123' });

getFhirName(patient)

Extracts the official name from a FHIR Patient resource, falling back to the first name available.

const name = getFhirName(patientResource);

getAcuityScore({ hr, rr, temp, sbp })

Calculates clinical acuity score based on vital signs (heart rate, respiratory rate, temperature, systolic blood pressure).

const score = getAcuityScore({ hr: 120, rr: 26, temp: 98.6, sbp: 85 });

maskPHI(string)

Masks Protected Health Information including SSN, phone numbers, and email addresses.

const masked = maskPHI('Contact: [email protected] or 555-123-4567');

isZombie(lastHeartbeat, limit = 300000)

Detects stagnant sessions or zombie connections based on heartbeat timestamp.

const stale = isZombie('2024-01-01T10:00:00Z', 300000);

AI Integration

fillPrompt(template, variables)

Replaces {{variable}} placeholders in prompt templates with actual values.

const prompt = fillPrompt('Analyze {{dataType}} for patient {{id}}', {
  dataType: 'vitals',
  id: '12345'
});

parseAiJson(string)

Parses JSON from AI responses, handling markdown code fences and malformed output.

const data = parseAiJson('```json\n{"key": "value"}\n```');

createSignal(initialValue)

Creates a reactive signal with pub/sub pattern for state management.

const counter = createSignal(0);
counter.subscribe(val => console.log('New value:', val));
counter.set(5);
const current = counter.get();

String Manipulation

stringFormat(format, ...args)

Replaces {0}, {1}, etc. placeholders with arguments.

stringFormat('Hello, {0}! Welcome to {1}.', 'Alice', 'Ultan');

toTitleCase(string)

Converts string to title case.

toTitleCase('hello world');

sanitizeString(string)

Escapes HTML special characters.

sanitizeString('<script>alert("xss")</script>');

fromBase64(base64) / toBase64(string)

Base64 encoding and decoding with UTF-8 support.

const encoded = toBase64('Hello World');
const decoded = fromBase64(encoded);

countOccurrences(string, substring)

Counts substring occurrences.

countOccurrences('hello world hello', 'hello');

Object Utilities

isEmpty(value)

Checks if object, array, or string is empty.

isEmpty({});
isEmpty([]);
isEmpty('');
isEmpty(null);

deepClone(object)

Creates deep copy using structuredClone or JSON fallback.

const clone = deepClone({ nested: { data: [1, 2, 3] } });

setNestedProperty(object, path, value)

Sets nested property using dot notation.

const obj = {};
setNestedProperty(obj, 'user.profile.name', 'John');

getNestedProperty(object, path)

Retrieves nested property using dot notation.

const name = getNestedProperty(obj, 'user.profile.name');

objectToArray(object) / arrayToObject(array)

Converts between objects and key-value pair arrays.

objectToArray({ a: 1, b: 2 });
arrayToObject([['a', 1], ['b', 2]]);

Array Utilities

mergeArrays(array1, array2)

Merges arrays removing duplicates.

mergeArrays([1, 2, 3], [3, 4, 5]);

sumArray(array) / averageArray(array)

Calculates sum or average of numeric array.

sumArray([1, 2, 3, 4]);
averageArray([10, 20, 30]);

arrayDifference(array1, array2)

Returns elements in array1 not in array2.

arrayDifference([1, 2, 3], [2, 3, 4]);

removeFalsyValues(array)

Filters out falsy values.

removeFalsyValues([0, 1, false, 2, '', 3, null, undefined]);

groupBy(array, key)

Groups array of objects by property.

groupBy([{ type: 'A', val: 1 }, { type: 'B', val: 2 }], 'type');

Function Utilities

debounce(function, delay = 300)

Delays function execution until after delay milliseconds.

const debouncedSearch = debounce(searchFunction, 500);

throttle(function, limit)

Ensures function executes at most once per limit milliseconds.

const throttledScroll = throttle(handleScroll, 100);

HTTP/Network

reqFlow(url, options = {})

Simplified fetch wrapper that throws on non-OK responses and parses JSON.

const data = await reqFlow('https://api.example.com/data', {
  method: 'POST',
  body: JSON.stringify({ key: 'value' })
});

Miscellaneous

greet({ name, age })

Console logs greeting with optional destructured parameters.

greet({ name: 'Alice', age: 30 });
greet();

getType(value)

Returns lowercase type string.

getType([]);
getType({});
getType(null);

getRandomInRange(min, max)

Returns random float in range.

getRandomInRange(1, 10);

round(number, decimals = 2)

Rounds to specified decimal places.

round(3.14159, 2);

generateUUID()

Generates RFC4122 compliant UUID v4.

const id = generateUUID();

formatDate(date)

Formats date as MM/DD/YYYY.

formatDate(new Date());

Regular Expressions

Pre-compiled regex patterns accessible via regexes object:

• regexes.email - Email validation
• regexes.phone - International phone numbers
• regexes.url - HTTP/HTTPS URLs

const { regexes } = require('ultan');
regexes.email.test('[email protected]');

Constants

DaysOfWeek

Frozen object with weekday names.

const { DaysOfWeek } = require('ultan');
console.log(DaysOfWeek.MONDAY);

HttpStatus

Common HTTP status codes.

const { HttpStatus } = require('ultan');
if (response.status === HttpStatus.NOT_FOUND) { }

License

MIT