docs(shared): fix touchSession Frontend API link by SarahSoutoul · Pull Request #9097 · clerk/javascript

SarahSoutoul · 2026-07-07T03:51:08Z

Description

Update the touchSession option JSDoc to link directly to the canonical Scalar Frontend API touch endpoint.
Add a changeset for @clerk/shared.
This lets regenerated Typedoc output point users to the exact operation instead of relying on the broken legacy Redocly redirect.

Checklist

pnpm test runs as expected.
pnpm build runs as expected.
(If applicable) JSDoc comments have been added or updated for any package exports
(If applicable) Documentation has been updated

Type of change

Summary by CodeRabbit

Documentation
- Fixed the link for the touchSession option so it now points directly to the correct Frontend API session endpoint.
- Improved the accuracy of the related API reference without changing any runtime behavior.

vercel · 2026-07-07T03:51:12Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
clerk-js-sandbox	Ready	Preview, Comment	Jul 7, 2026 3:51am
swingset	Ready	Preview, Comment	Jul 7, 2026 3:51am

changeset-bot · 2026-07-07T03:51:12Z

🦋 Changeset detected

Latest commit: a6cf420

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 23 packages

Name	Type
@clerk/shared	Patch
@clerk/astro	Patch
@clerk/backend	Patch
@clerk/chrome-extension	Patch
@clerk/clerk-js	Patch
@clerk/electron	Patch
@clerk/expo-passkeys	Patch
@clerk/expo	Patch
@clerk/express	Patch
@clerk/fastify	Patch
@clerk/headless	Patch
@clerk/hono	Patch
@clerk/localizations	Patch
@clerk/msw	Patch
@clerk/nextjs	Patch
@clerk/nuxt	Patch
@clerk/react-router	Patch
@clerk/react	Patch
@clerk/tanstack-react-start	Patch
@clerk/testing	Patch
@clerk/ui	Patch
@clerk/vue	Patch
@clerk/swingset	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

coderabbitai · 2026-07-07T03:51:26Z

📝 Walkthrough

Walkthrough

This PR updates the JSDoc documentation link for the touchSession option in the Clerk types file, pointing it to a specific Frontend API sessions touch endpoint instead of a generic anchor, and adds a corresponding changeset entry.

Changes

Documentation link fix

Layer / File(s)	Summary
Update touchSession doc link `packages/shared/src/types/clerk.ts`, `.changeset/fix-touch-session-doc-link.md`	The JSDoc link for `touchSession` was changed to reference the specific `v1/client/sessions/{session_id}/touch` endpoint, and a changeset patch entry documents the fix.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Poem

A tiny hop, a link made right,
Pointing straight to touch's true site.
No code was changed, no logic bent,
Just docs made clear with sweet intent.
🐇✨ Thump-thump, ship it tonight!

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely describes the main change: fixing the touchSession Frontend API documentation link in shared code.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

📝 Generate docstrings

Create stacked PR
Commit on current branch

_{Comment @coderabbitai help to get the list of available commands.}

coderabbitai

🧹 Nitpick comments (1)

packages/shared/src/types/clerk.ts (1)
1404-1404: 🧹 Nitpick | 🔵 Trivial

Docs team should sanity-check the generated reference output.

This is public-facing JSDoc under packages/**, so the link change will flow into Clerk Docs. As per path instructions, “JSDoc on public/reference-facing APIs is customer-facing documentation, not ordinary internal comments.”
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@packages/shared/src/types/clerk.ts` at line 1404, The JSDoc on the public API
in clerk.ts is customer-facing and feeds Clerk Docs, so the generated reference
output should be sanity-checked after this link change. Review the affected
documentation comment and confirm the rendered docs text and link target are
correct in the generated reference for the relevant public symbol(s), especially
the session touch behavior description, before merging.
Source: Path instructions

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@packages/shared/src/types/clerk.ts`:
- Line 1404: The JSDoc on the public API in clerk.ts is customer-facing and
feeds Clerk Docs, so the generated reference output should be sanity-checked
after this link change. Review the affected documentation comment and confirm
the rendered docs text and link target are correct in the generated reference
for the relevant public symbol(s), especially the session touch behavior
description, before merging.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Repository YAML (base), Repository UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: 16430c28-8725-4086-984f-db13e3352a67

📥 Commits

Reviewing files that changed from the base of the PR and between 4aebb88 and a6cf420.

📒 Files selected for processing (2)

.changeset/fix-touch-session-doc-link.md
packages/shared/src/types/clerk.ts

pkg-pr-new · 2026-07-07T03:53:52Z

Open in StackBlitz

@clerk/astro

npm i https://pkg.pr.new/@clerk/astro@9097

@clerk/backend

npm i https://pkg.pr.new/@clerk/backend@9097

@clerk/chrome-extension

npm i https://pkg.pr.new/@clerk/chrome-extension@9097

@clerk/clerk-js

npm i https://pkg.pr.new/@clerk/clerk-js@9097

@clerk/electron

npm i https://pkg.pr.new/@clerk/electron@9097

@clerk/electron-passkeys

npm i https://pkg.pr.new/@clerk/electron-passkeys@9097

@clerk/eslint-plugin

npm i https://pkg.pr.new/@clerk/eslint-plugin@9097

@clerk/expo

npm i https://pkg.pr.new/@clerk/expo@9097

@clerk/expo-passkeys

npm i https://pkg.pr.new/@clerk/expo-passkeys@9097

@clerk/express

npm i https://pkg.pr.new/@clerk/express@9097

@clerk/fastify

npm i https://pkg.pr.new/@clerk/fastify@9097

@clerk/hono

npm i https://pkg.pr.new/@clerk/hono@9097

@clerk/localizations

npm i https://pkg.pr.new/@clerk/localizations@9097

@clerk/nextjs

npm i https://pkg.pr.new/@clerk/nextjs@9097

@clerk/nuxt

npm i https://pkg.pr.new/@clerk/nuxt@9097

@clerk/react

npm i https://pkg.pr.new/@clerk/react@9097

@clerk/react-router

npm i https://pkg.pr.new/@clerk/react-router@9097

@clerk/shared

npm i https://pkg.pr.new/@clerk/shared@9097

@clerk/tanstack-react-start

npm i https://pkg.pr.new/@clerk/tanstack-react-start@9097

@clerk/testing

npm i https://pkg.pr.new/@clerk/testing@9097

@clerk/ui

npm i https://pkg.pr.new/@clerk/ui@9097

@clerk/upgrade

npm i https://pkg.pr.new/@clerk/upgrade@9097

@clerk/vue

npm i https://pkg.pr.new/@clerk/vue@9097

commit: a6cf420

github-actions · 2026-07-07T03:54:26Z

API Changes Report

Generated by Break Check on 2026-07-07T03:54:24.089Z

Summary

Metric	Count
Packages analyzed	19
Packages with changes	0
🔴 Breaking changes	0
🟡 Non-breaking changes	0
🟢 Additions	0

No API Changes Detected

All packages have stable APIs with no detected changes.

Report generated by Break Check

_{Last ran on a6cf420.}

Fix touchSession FAPI link

a6cf420

SarahSoutoul self-assigned this Jul 7, 2026

vercel Bot deployed to Preview – swingset July 7, 2026 03:51 View deployment

coderabbitai Bot reviewed Jul 7, 2026

View reviewed changes

SarahSoutoul requested a review from manovotny July 7, 2026 03:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs(shared): fix touchSession Frontend API link#9097

docs(shared): fix touchSession Frontend API link#9097
SarahSoutoul wants to merge 1 commit into
mainfrom
ss/DOCS-11909

SarahSoutoul commented Jul 7, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

vercel Bot commented Jul 7, 2026 •

edited

Loading

Uh oh!

changeset-bot Bot commented Jul 7, 2026

Uh oh!

coderabbitai Bot commented Jul 7, 2026 •

edited

Loading

Walkthrough

Changes

Uh oh!

coderabbitai Bot left a comment

Uh oh!

pkg-pr-new Bot commented Jul 7, 2026

Uh oh!

github-actions Bot commented Jul 7, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Conversation

SarahSoutoul commented Jul 7, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Type of change

Summary by CodeRabbit

Uh oh!

vercel Bot commented Jul 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot Bot commented Jul 7, 2026

🦋 Changeset detected

Uh oh!

coderabbitai Bot commented Jul 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

pkg-pr-new Bot commented Jul 7, 2026

Uh oh!

github-actions Bot commented Jul 7, 2026

API Changes Report

Summary

No API Changes Detected

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

SarahSoutoul commented Jul 7, 2026 •

edited by coderabbitai Bot

Loading

vercel Bot commented Jul 7, 2026 •

edited

Loading

coderabbitai Bot commented Jul 7, 2026 •

edited

Loading