Repository navigation
docs(payments): review the payments reference and merge the service role methods into it - #364
Merged
Merged
Conversation
…ole methods into it Payments JSDoc: house-style fixes, a fuller overview, provider and authentication sections, method order that follows the checkout flow, cross-links between the user and service role methods, error code links, and new examples for the Stripe success page and confirming a purchase in a backend function. "Wix Payments" is now "Base44 Payments", the product name. Docs pipeline: - Append ServiceRolePaymentsModule onto the payments page as "Service role methods", and group PaymentsErrorCode under an Errors heading. - An appended module's section is headed with its interface name, so typesWithOwnMethods can rename it. The connectors and integrations special cases match the new headings. - Links back to the host module, or to an appended module by its slug, become same-page anchors. - A Returns section shows the method's @returns text and only falls back to the return type's description when there is none. - AiGatewayConnectionOptions, ConnectorApiRequest, and ConnectorApiResponse render inline and no longer get their own pages. Also brings in the AI Gateway video JSDoc from #305 and the prose fixes already published for that page, moves two return-type details into @returns so they still show, and adds skill rules for links, framework- neutral examples, and "the current user". Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
🚀 Package Preview Available! (
|
Contributor
🚀 Package Preview Available!Install this PR's preview build with npm: npm i @base44-preview/sdk@0.8.58-beta.0-pr.364.6994ab8Prefer not to change any import paths? Install using npm alias so your code still imports npm i "@base44/sdk@npm:@base44-preview/sdk@0.8.58-beta.0-pr.364.6994ab8"Or add it to your {
"dependencies": {
"@base44/sdk": "npm:@base44-preview/sdk@0.8.58-beta.0-pr.364.6994ab8"
}
}
Preview published to npm registry — try new features instantly! |
House-style fixes: no em dashes, prose semicolons or colon breaks, no status
code in prose, contractions, and plain code names instead of {@link} on
properties, where the pipeline drops the link. Says "credits" now that
metered calls bill unified credits, counts the three tips correctly, and
stops pointing callApi()'s integration type at the Available connectors
table, which lists getConnection() connectors only.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
adamfri
approved these changes
Nov 3, 2026
1 task
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reviews the payments reference and changes the docs pipeline so the user and service role methods share one page. The regenerated docs go in a separate docs PR.
Payments page
PaymentsErrorCodeintro.ServiceRolePaymentsModuleis appended as "Service role methods", andPaymentsErrorCodesits under an "Errors" heading.preloadCheckout(),mountCheckout(),completeCheckout(),listPurchases(), and on the service role,createCheckout(),completeCheckout(),listPurchases(), and then refunds and subscriptions.createCheckout()explains redirect and embedded checkouts.listPurchases()says why PayPal needs acheckout_idorsubscription_id.completeCheckout()stands on its own.preloadCheckout()call, a Stripe success page example, and a backend example that confirms a purchase before granting access.Pipeline
typesWithOwnMethodsinpage-sections.jsoncan rename it. The connectors and integrations special cases now match## UserConnectorsModuleand## CustomIntegrationsModule, and their output doesn't change.@returnstext, and falls back to the return type's description only when there's none. Before, both showed, as in "A mounted embedded checkout." followed by "Promise resolving to the mounted checkout once it renders." This removes about 90 generic lines across the App SDK reference and 5 in the Platform SDK. Two descriptions with details that appear nowhere else moved into@returns:createCheckout()openLiveSession()onuseChat()AiGatewayConnectionOptions,ConnectorApiRequest, andConnectorApiResponsealready render inline, so they're on the delete-after-processing list and no longer show up as modules in the nav.Also in this PR
mainwould remove the published Video section. docs(ai-gateway): document video generation #305's other two commits are already covered onmain, so it can be closed after this merges.callApi(), and its request and response types:callApi()'s integration type no longer points at the Available connectors table, which listsgetConnection()connectors only{@link}can't be used: methods on another page, and methods mentioned in type or property commentsChecks
npm test, 430 passingtest:types, plustest:unitwith 160 passingnpm run lintis cleancreate-docsfor both packages. Reviewed the output page by page.🤖 Generated with Claude Code