Repository navigation
feat(turbosign): createSigningUrl accepts optional pageNavigation (auto | collapsed | hidden) - #132
Draft
nicolasiscoding wants to merge 8 commits into
Draft
nicolasiscoding wants to merge 8 commits into
nicolasiscoding wants to merge 8 commits into
Conversation
added 8 commits
October 20, 2026 11:59
pageNavigation ('auto' | 'collapsed' | 'hidden') controls how the embedded
signing page shows its page navigation. createEmbeddedSignature forwards it
to each signing-url call, like returnUrl.
…gation
page_navigation ("auto" | "collapsed" | "hidden", typed as the exported
PageNavigationMode Literal) is sent as pageNavigation. create_embedded_signature
forwards it to each signing-url call, like return_url.
New PageNavigationMode type with PageNavigationAuto / Collapsed / Hidden, sent as pageNavigation (omitempty). CreateEmbeddedSignature forwards it to each signing-url call, like ReturnURL.
…tion New PageNavigation backed enum (AUTO, COLLAPSED, HIDDEN) on CreateSigningUrlRequest and CreateEmbeddedSignatureRequest, sent as pageNavigation only when set. fromArray() accepts the string value.
…ation New PageNavigation enum (AUTO, COLLAPSED, HIDDEN) with a pageNavigation builder method on CreateSigningUrlRequest and CreateEmbeddedSignatureRequest, sent as pageNavigation only when set. The empty-returnUrl rebuild keeps it.
…vigation
page_navigation ("auto" | "collapsed" | "hidden") is sent as pageNavigation.
create_embedded_signature forwards :pageNavigation to each signing-url call,
like :returnUrl.
openapi.yaml, the root and embed READMEs, the Java and PHP createSigningUrl references, the parity rule, and a commented option in each embedded identity example.
nicolasiscoding
force-pushed
the
feature/signing-url-page-navigation
branch
from
October 20, 2026 16:00
69c42da to
d47d391
Compare
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.
Closes #131
createSigningUrl: optional
pageNavigationcontrols the embedded signing page's page navigation (auto|collapsed|hidden).auto(default): sized to the iframe width. The thumbnail rail is open at 1200px and wider, collapsed from 900px to 1199px, and a "Pages" button in the bottom bar under 900px.collapsed: the rail starts collapsed at any width. The signer can still expand it.hidden: no rail and no "Pages" button.It works like
returnUrl: it applies to that signing URL only, is left out of the body when not set, and does not change the response.All six SDKs
pageNavigation?: PageNavigationMode(exported'auto' | 'collapsed' | 'hidden'union) onCreateSigningUrlRequestandCreateEmbeddedSignatureRequest.page_navigationkwarg typed as the exportedPageNavigationModeLiteral, sent aspageNavigation.PageNavigation PageNavigationModewithjson:"pageNavigation,omitempty", plusPageNavigationAuto/PageNavigationCollapsed/PageNavigationHidden.PageNavigationbacked enum,pageNavigation:named arg (last).fromArray()accepts the string value.PageNavigationenum,.pageNavigation(...)builder method. The empty-returnUrlrebuild path copies it too.page_navigation:kwarg (plain string, like the other TurboSign options),:pageNavigationoncreate_embedded_signature.createEmbeddedSignatureforwards it to each signing-url call in all six, likereturnUrl.@turbodocx/embed: no code change. It only consumes the URL; the option is set when the URL is minted.Tests (written first, watched fail, then implemented): body includes
pageNavigationwhen given, omits it when not,createEmbeddedSignatureforwards it, and the enum/union holds exactly the three values.JS 410 passed (
tsc --noEmitclean), Python 424 passed, Gogo test ./...ok, Java 376 passed, PHP 454 passed (phpstan level 8 clean), Ruby 402 examples, 0 failures.Notes for release
pageNavigationagainst an API version without it returns a 400. Callers who don't set it are unaffected. Publish after the matching API release.CreateSigningUrlRequest::fromArray()throwsValidationException(InvalidPageNavigation) for a string outside the three values, since the property is enum-typed. The other SDKs leave validation to the API's 400.🤖 Generated with Claude Code