Skip to content

v1.0.0 — SDK v1 release - #7

Merged
razorback16 merged 15 commits into
mainfrom
feat/v1
Feb 20, 2026
Merged

razorback16 merged 15 commits into
mainfrom
feat/v1

Conversation

@razorback16

@razorback16 razorback16 commented Feb 19, 2026 •

Copy link
Copy Markdown
Collaborator

v1.0.0 — SDK v1 Release

Full rewrite targeting the v1 API at api.svgmaker.io. Expands from 3 clients (generate, edit, convert) to 12 with complete API coverage.

Breaking Changes

  • Base URL: svgmaker.io/api → api.svgmaker.io (automatic if using defaults)
  • Convert client restructured: client.convert.configure(...) → client.convert.aiVectorize.configure(...). Convert is now a namespace with sub-clients: aiVectorize, trace, svgToVector, rasterToRaster, batch
  • styleParams redesigned: New style values (flat, line_art, engraving, linocut, silhouette, ghibli, ...), advanced block removed, new text field added
  • Aspect ratios wide/tall removed: Only auto, portrait, landscape, square remain
  • model parameter: New option on generate and edit — mutually exclusive with quality
  • Cloud storage no longer default — generate, edit, and AI vectorize no longer store results to cloud by default; pass storage: true to persist

See the full Migration Guide for upgrade instructions and code examples.

New Clients

Client Description
convert.aiVectorize AI-powered raster → SVG (was convert)
convert.trace Algorithmic raster → SVG tracing
convert.svgToVector SVG → PDF, EPS, DXF, AI, PS
convert.rasterToRaster Raster format conversion
convert.batch Batch convert up to 10 files
enhancePrompt AI prompt improvement
optimizeSvg SVGO-based SVG optimization
generations List, download, share, delete generations
gallery Browse and download public gallery
account Account info and credit usage

Other Changes

  • New error types: ContentSafetyError, FileSizeError, FileFormatError, EndpointDisabledError
  • Response metadata with requestId for support inquiries
  • storage parameter on generate to control persistence
  • 284 unit tests, integration test suite with streaming coverage
  • Comprehensive v1 API documentation

Test Plan

  • All 284 unit tests pass
  • Lint, format, typecheck pass
  • Build succeeds (CJS + ESM + types)
  • Security audit clean (0 vulnerabilities)
  • Merge to main triggers automated release pipeline
  • npm publish with provenance
  • GitHub Release created with changelog

…cumulation

  - Migrate all endpoints to v1 paths (/v1/generate, /v1/edit, /v1/convert/ai-vectorize)
  - Add response envelope unwrapping (success/data/metadata) and v1 error mapping
  - Add model parameter support for Generate and Edit (mutually exclusive with quality)
  - Add storage parameter for persistent SVG URLs across all endpoints
  - Restructure convert namespace (client.convert.aiVectorize) for future extensibility
  - Update style params, aspect ratios, and types to match v1 API spec
  - Fix streaming to accumulate fields across events (svgUrl from generated event
    now carries through to complete event)
  - Add manual test script and SDK test commands for all 17 test scenarios
  - Add hashTags and categories to GenerationResponse/GalleryItemResponse
  - Add quality field to EditResponse
  - Add reduceNoise param to BatchConvertParams
  - Update tests and mock factories
@razorback16 razorback16 changed the title Feat/v1 v1.0.0-rc.1 — SDK v1 + automated release flow Feb 20, 2026
- Rewrite release workflow: trigger on version bump in main (not tag push)
- Auto-detect version changes by comparing package.json between commits
- Generate release notes via GitHub API + enhance with AI (GitHub Models)
- Add .github/release.yml for PR categorization
- Remove manual release scripts, keep version bump helpers
- Update CONTRIBUTING.md and CHANGELOG.md for automated flow
- Consolidate and update SDK documentation for v1 API
- Fix lint errors: replace require() with imports, remove unused imports
- Format all source and test files with prettier
- Fix security audit to only check production dependencies
…ng test suite

- Rewrite integration tests as Node.js (run-integration-tests.js) with
  dynamic generation ID capture, removing need for manual ID configuration
- Add streaming test suite (run-streaming-tests.js) covering generate,
  edit, and AI vectorize with real-time event logging and asset downloads
- Extract shared config (API keys, IDs) into tests/test-config.js with
  example template (test-config.example.js)
- Add tests/test-config.js and tests/assets/ to .gitignore
- Remove old bash test runner and unused test.svg
@razorback16 razorback16 changed the title v1.0.0-rc.1 — SDK v1 + automated release flow v1.0.0 — SDK v1 release Feb 20, 2026
@razorback16
razorback16 merged commit e641706 into main Feb 20, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants