Releases: syniol/xyo-sdk-node
Releases · syniol/xyo-sdk-node
Release list
v1.2.2
🚀 XYO Node.js SDK v1.2.2 Release Notes
Tag:
v1.2.2
Previous Tag:v1.2.1
Release Date: 20th July 2026
⚖️ Licensing Update
- Adopted BSD 3-Clause License: Changed package licensing from Apache-2.0 / legacy references to the standard BSD 3-Clause License.
- License File Synchronization: Replaced content in LICENSE with official BSD 3-Clause License text.
- Package Metadata: Updated the
"license"field in package.json to"BSD-3-Clause". - Documentation Alignment: Updated the License section and copyright headers in README.md to reflect the BSD 3-Clause License and Copyright © 2026 Syniol Limited.
📦 Version Bump
- SDK Version: Incremented from
1.2.1to1.2.2across package.json, package-lock.json, and example/package-lock.json. - Runtime Version Consistency: Automatically updated
SDK_VERSIONexport in src/client/version.ts.
📊 Summary of Modified Files
| File | Changes |
|---|---|
| LICENSE | Updated to BSD 3-Clause License text |
| README.md | Updated license section to BSD 3-Clause and copyright to 2026 |
| package.json | Incremented version to 1.2.2 & set "license": "BSD-3-Clause" |
| package-lock.json | Synchronised lockfile with package version and license |
| example/package-lock.json | Synchronised example application dependency lockfile |
Diff Stats: 5 files changed, 38 additions(+), 26 deletions(-)
v1.2.1
Release v1.2.1
📖 Documentation Overhaul (Enterprise Grade)
- Elite
README.mdRewrite: Completely overhauled the primary documentation to target Principal Engineers and Lead Architects at Tier-1 financial institutions.- Introduced Enterprise Architectural Principles (Type-Safety, Resiliency, Statelessness).
- Added detailed integration patterns differentiating between Real-Time Enrichment (Synchronous) and Batch Processing (Asynchronous Bulk).
- Added a Robust Error Handling matrix detailing enterprise mitigation strategies (e.g., DLQ routing, Circuit Breakers, Exponential Backoff).
- Added Security & Compliance assertions highlighting zero third-party runtime dependencies and TLS enforcement.
- British English Standardisation: Audited and converted all documentation (
README.md,CONTRIBUTING.md,mascot_generation_instructions.md) to adhere strictly to British English spelling (e.g., Initialise, Unauthorised, maximise, colours).
🎨 Branding & Assets
- New SDK Mascot: Updated
docs/mascot.pngfrom the legacy turtle concept to a sleek, neon cybernetic hexagon to match the unified Syniol SDK aesthetics. - Mascot Instructions: Added
docs/mascot_generation_instructions.mdoutlining the prompt and reference images used to generate the new mascot.
⚖️ Licensing & Maintenance
- License Audit: Streamlined and cleaned up the
LICENSEfile. - Readme Badges: Updated CI/CD workflow and compatibility badges in the README.
- Version Increment: Incremented the minor version in
package.jsonand synchronisedpackage-lock.json.
Full Changelog: v1.2.0...v1.2.1
v1.2.0
Release v1.2.0
🚀 Features & Enhancements
- AI-Guided Refactoring: Addressed comprehensive code reviews by multiple AI models (Gemini 3.5 Flash, Claude Sonnet 4.6, and Opus 4.7) resulting in a significantly more robust codebase.
- Client Hardening: Major enhancements to
src/client/client.ts, including improved type guards, payload validations, and enhanced network error handling. - Enrichment Module Restructure: Streamlined the enrichment implementation by consolidating
service.tsandservice.test.tsdirectly intoenrichment.ts. - Enhanced Error Handling: Overhauled
src/client/error.tsto provide more granular, typed error classes for better SDK debugging and integration. - Testing Expansion: Added massive coverage improvements to the test suite (
client.test.tswith over 800 insertions).
🛠 Fixes & CI/CD
- NPM Publish Pipeline: Completely revamped and unified the release pipeline in
.github/workflows/release.yml. Deprecated the separatenpm_publish.ymlworkflow and fixed authentication/provenance issues with the npm registry. - Security Hardening: Integrated
npm audit --audit-level=lowdirectly into the CI/CD and Docker builds (deploy/Dockerfile) to ensure zero-tolerance for vulnerabilities. - Publish Packaging: Removed the deprecated
.npmignorefile, opting for a deterministicfilesarray pattern insidepackage.jsonfor cleaner published tarballs.
📝 Documentation & Examples
- Documentation: Updated
CONTRIBUTING.md(Syniol-only policies and release processes) andREADME.mdto reflect the latest changes. - Example Implementation: Refactored
example/index.jsandexample/package.jsonto seamlessly link and demonstrate the locally built SDK without module resolution errors.
📊 Diff Stats
- Commits: 4
- Files Changed: 23
- Additions: 1,838
- Deletions: 728