docs: expose serverUrl for local development

[wixysam]

Summary

• Remove the @internal tag from serverUrl in CreateClientConfig so it appears in generated SDK reference docs
• Simplify the JSDoc to be framework-agnostic (no process.env example that breaks in Vite)
• Add description, default value, and link to local development guide

Related: base44-dev/mintlify-docs PR for the local development documentation.

Test plan

• npm run create-docs-local generates docs with serverUrl visible on the createClient reference page
• JSDoc renders correctly in IDE tooltips

Made with Cursor

[claude]

Claude finished @wixysam's task —— View job

---

Code Review for PR #139: docs: expose serverUrl for local development

I've reviewed the changes to expose the serverUrl configuration option in the SDK documentation. Here's my feedback:

✅ Code Quality and Best Practices

The changes follow excellent documentation practices:

• Concise and clear: The updated JSDoc is more straightforward and framework-agnostic
• Good defaults: Properly documents the default value of "https://base44.app"
• Maintains consistency: The documentation style matches other config options in the interface

✅ No Bugs or Issues Detected

The changes are purely documentation-related and don't introduce any functional issues:

• Removing the @internal tag correctly exposes the property in generated docs
• The JSDoc comment structure is valid and will render properly

✅ Performance Considerations

No performance impact - these are documentation-only changes that affect TypeDoc generation but not runtime behavior.

✅ Security Considerations

The changes are security-neutral:

• serverUrl was already a public property in the TypeScript interface
• The @internal tag only affected documentation visibility, not actual access control
• Good security practice to support configurable server URLs for local development

📝 Test Coverage

The test plan is appropriate for documentation changes:

• ✅ Verifying docs generation with npm run create-docs-local
• ✅ Checking IDE tooltip rendering

💡 Minor Suggestions

1. Consider adding a security note: While the current documentation is good, you might want to add a brief security reminder about not hardcoding production URLs:

   * Set this when using a local development server to point SDK requests at your local machine instead of the hosted backend.
   * 
   * **Note:** Always use environment variables for server URLs. Never hardcode production URLs in your source code.

2. Link to local development guide: The PR description mentions a related documentation PR. Once that's merged, consider adding a direct link in the JSDoc:

   * Set this when using a local development server to point SDK requests at your local machine instead of the hosted backend.
   * See the [local development guide](link-here) for detailed setup instructions.

Summary

This is a well-crafted documentation improvement that makes the SDK more developer-friendly by exposing an important configuration option. The framework-agnostic approach is particularly good, as it avoids assumptions about the user's build environment. The changes are minimal, focused, and achieve the stated goal effectively.

Recommendation: Approve ✅

[github-actions]

🚀 Package Preview Available!

---

Install this PR's preview build with npm:

npm i @base44-preview/sdk@0.8.20-pr.139.6d44627

Prefer not to change any import paths? Install using npm alias so your code still imports @base44/sdk:

npm i "@base44/sdk@npm:@base44-preview/sdk@0.8.20-pr.139.6d44627"

Or add it to your package.json dependencies:

{
  "dependencies": {
    "@base44/sdk": "npm:@base44-preview/sdk@0.8.20-pr.139.6d44627"
  }
}

• 📦 Preview Package: @base44-preview/sdk@0.8.20-pr.139.6d44627
• 🔗 View this commit on GitHub

---

_{Preview published to npm registry — try new features instantly!}