Skip to content

Use PK data API script in webviewer guidance#297

Open
eluce2 wants to merge 1 commit into
fm26from
fix/pk-data-api-script-guidance
Open

Use PK data API script in webviewer guidance#297
eluce2 wants to merge 1 commit into
fm26from
fix/pk-data-api-script-guidance

Conversation

@eluce2

@eluce2 eluce2 commented Jun 26, 2026

Copy link
Copy Markdown
Collaborator

Summary\n- update WebViewerAdapter guidance from the old ExecuteDataApi name to PK_execute_data_api\n- update FM MCP/typegen defaults, schema descriptions, UI placeholder, and fixture output to use PK_execute_data_api\n- update FmMcpAdapter default script name to match the renamed ProofKit FileMaker script\n\n## Tests\n- pnpm --filter @proofkit/typegen test -- --runInBand\n- pnpm --filter @proofkit/fmdapi test -- --runInBand

Summary by CodeRabbit

  • Bug Fixes
    • Updated the default FileMaker script name used across Data API and WebViewer flows, so generated clients and adapters now point to the renamed script.
  • Documentation
    • Refreshed setup guidance and examples (including configuration placeholders and SKILL guidance) to match the new default script naming.
  • Tests
    • Updated adapter tests to verify the revised default script name is used when no custom value is provided.

@changeset-bot

changeset-bot Bot commented Jun 26, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 9ff0722

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

This PR includes changesets to release 5 packages
Name Type
@proofkit/typegen Patch
@proofkit/webviewer Patch
@proofkit/fmdapi Patch
@proofkit/better-auth Patch
@proofkit/fmodata 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

@vercel

vercel Bot commented Jun 26, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
proofkit-docs Ready Ready Preview, Comment Jun 26, 2026 8:00pm

Request Review

@pkg-pr-new

pkg-pr-new Bot commented Jun 26, 2026

Copy link
Copy Markdown

Open in StackBlitz

@proofkit/better-auth

pnpm add https://pkg.pr.new/proofsh/proofkit/@proofkit/better-auth@297

@proofkit/fmdapi

pnpm add https://pkg.pr.new/proofsh/proofkit/@proofkit/fmdapi@297

@proofkit/fmodata

pnpm add https://pkg.pr.new/proofsh/proofkit/@proofkit/fmodata@297

@proofkit/typegen

pnpm add https://pkg.pr.new/proofsh/proofkit/@proofkit/typegen@297

@proofkit/webviewer

pnpm add https://pkg.pr.new/proofsh/proofkit/@proofkit/webviewer@297

commit: 9ff0722

@coderabbitai

coderabbitai Bot commented Jun 26, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 81276a61-081d-499b-b4c5-84ddaeb9de1b

📥 Commits

Reviewing files that changed from the base of the PR and between b52c74d and 9753135.

📒 Files selected for processing (11)
  • .changeset/pk-data-api-script-guidance.md
  • packages/fmdapi/skills/typegen-fmdapi/SKILL.md
  • packages/fmdapi/src/adapters/fm-mcp.ts
  • packages/fmdapi/tests/fm-mcp-adapter.test.ts
  • packages/typegen/live-fm-mcp-output/client/contacts.ts
  • packages/typegen/src/buildLayoutClient.ts
  • packages/typegen/src/typegen.ts
  • packages/typegen/src/types.ts
  • packages/typegen/typegen.schema.json
  • packages/typegen/web/src/components/ConfigEditor.tsx
  • packages/webviewer/skills/webviewer-integration/SKILL.md
✅ Files skipped from review due to trivial changes (9)
  • .changeset/pk-data-api-script-guidance.md
  • packages/typegen/web/src/components/ConfigEditor.tsx
  • packages/typegen/src/typegen.ts
  • packages/typegen/live-fm-mcp-output/client/contacts.ts
  • packages/typegen/src/types.ts
  • packages/fmdapi/tests/fm-mcp-adapter.test.ts
  • packages/typegen/typegen.schema.json
  • packages/typegen/src/buildLayoutClient.ts
  • packages/webviewer/skills/webviewer-integration/SKILL.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/fmdapi/src/adapters/fm-mcp.ts

📝 Walkthrough

Walkthrough

This PR updates the default FileMaker Data API script name from execute_data_api to PK_execute_data_api across the FM MCP adapter, typegen defaults, generated client output, UI placeholder text, documentation, and the related changeset.

Changes

FileMaker script default update

Layer / File(s) Summary
Adapter fallback and test
packages/fmdapi/src/adapters/fm-mcp.ts, packages/fmdapi/tests/fm-mcp-adapter.test.ts
The FM MCP adapter falls back to PK_execute_data_api when no script name is set, and the request payload test matches that value.
Typegen defaults and config surface
packages/typegen/src/types.ts, packages/typegen/typegen.schema.json, packages/typegen/src/buildLayoutClient.ts, packages/typegen/src/typegen.ts, packages/typegen/web/src/components/ConfigEditor.tsx, packages/typegen/live-fm-mcp-output/client/contacts.ts
The typegen schema descriptions, generated-client defaults, log message, config editor placeholder, and generated client output use PK_execute_data_api.
Documentation and changeset guidance
packages/fmdapi/skills/typegen-fmdapi/SKILL.md, packages/webviewer/skills/webviewer-integration/SKILL.md, .changeset/pk-data-api-script-guidance.md
The FM MCP and WebViewer skill docs, plus the changeset note, now reference PK_execute_data_api in examples and guidance.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title is concise and accurately reflects one major part of the change, though it omits the broader FM MCP/typegen updates.
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
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/pk-data-api-script-guidance

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

@eluce2 eluce2 changed the base branch from main to graphite-base/297 June 26, 2026 19:41
@eluce2 eluce2 force-pushed the fix/pk-data-api-script-guidance branch from b52c74d to 9753135 Compare June 26, 2026 19:41
@eluce2 eluce2 changed the base branch from graphite-base/297 to fm26 June 26, 2026 19:41

eluce2 commented Jun 26, 2026

Copy link
Copy Markdown
Collaborator Author

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

This stack of pull requests is managed by Graphite. Learn more about stacking.

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