Skip to content

docs: clarify Node SDK installation and import options - #304

Draft
javorosas wants to merge 1 commit into
mainfrom
docs/node-sdk-v6-guides
Draft

javorosas wants to merge 1 commit into
mainfrom
docs/node-sdk-v6-guides

Conversation

@javorosas

@javorosas javorosas commented Oct 2, 2026 •

Copy link
Copy Markdown
Member

Summary

Clarify the Spanish and English Node SDK installation guide:

  • Show ESM/TypeScript and CommonJS imports.
  • Explain bundled TypeScript types, public package imports, and supported Node.js runtime.
  • Simplify the npm install command.

Publication order

Keep this PR in draft until SDK 6 is published on npm: the CommonJS example uses the direct constructor export introduced in SDK 6. SDK 5 requires require('facturapi').default. Node.js 18 and bundled TypeScript types are already supported in SDK 5. The branch is based on main and contains only installation guide changes and the related writing convention. Merge #308 first.

Verification

Diff checks passed. The production build on current main fails because of unresolved ErrorMessage references in the OpenAPI spec; #308 corrects those references. Re-run the production build after #308 merges.

@javorosas javorosas changed the title docs: prepare Node SDK v6 usage and migration guides docs: clarify Node SDK installation and import options Oct 2, 2026
Base automatically changed from docs/sdk-generation-contract-audit to main October 5, 2026 20:30

This branch has not been deployed

No deployments
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.

1 participant