feat: Add `ActionInputSchema` utility type by mauriciabad · Pull Request #14698 · withastro/astro

mauriciabad · 2025-10-31T03:24:10Z

Changes

Adds the utility type ActionInputSchema that returns the type of the zod schema used in defineAction({ input: z.object(...) }).

This is incredibly useful for creating abstractions that use actions.

The main use will be getting the action input type when the action has accept: 'form'.

Example usage:

import { type ActionInputSchema, defineAction } from 'astro:actions';
import { z } from 'astro/zod';

const action = defineAction({
  accept: 'form',
  input: z.object({ name: z.string() }),
  handler: ({ name }) => ({ message: `Welcome, ${name}!` }),
});

type Schema = ActionInputSchema<typeof action>; 
// typeof z.object({ name: z.string() })

type Input = z.input<Schema>;
// { name: string }

Since it's quite hard to pull off by a non-typescript fluent dev, I suggest including it along the other action utility types.

Decisions to be made

If the input validator is omitted, it returns never. Do you think it's fine? Or it should return something else, like undefined?
Initially, I was going to create the type ActionInput directly, to avoid having to do z.input<ActionInputSchema<typeof action>>. But I thought the name would be confusing because when the action accepts a form, the input is actually a FormData, not a JS object. And returning the schema seems more versatile. Let me know if you think it would be valuable to also add a utility type ActionInputObject or something like that.

Testing

No tests needed because it's a type.

Docs

The astro-actions page should be updated. I opened a PR with the documentation: withastro/docs#12647

/cc @withastro/maintainers-docs

changeset-bot · 2025-10-31T03:24:15Z

🦋 Changeset detected

Latest commit: 67c9bb5

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

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

github-actions · 2025-10-31T03:25:13Z

📝 Changeset Validation Results

❌ Changeset validation failed

Issues Found:

`.changeset/poor-loops-boil.md`

Issue with: 'Adds the ActionInputSchema utility type to infer an action's input zod schema.'

❌ The description specifies addition or introduction of a feature, which aligns better with the 'minor' change type rather than 'patch'.

💡 Suggestions:
• Use the 'minor' change type for introducing new features and APIs, aligning with the described addition.
• Revise the YAML frontmatter to reflect: ```yaml

'astro': minor


**General Suggestions:**
- Consider revising the change type to better reflect the user's perspective in alignment with the described change (minor instead of patch).

---
*📖 See [Astro's changeset guide](https://contribute.docs.astro.build/docs-for-code-changes/changesets/) for details.*

codspeed-hq · 2025-10-31T03:37:01Z

CodSpeed Performance Report

Merging #14698 will not alter performance

_{Comparing mauriciabad:patch-1 (67c9bb5) with main (c29a785)}

Summary

✅ 6 untouched

florian-lefebvre

Hi, thanks for opening a PR! I think it's a nice addition, a few comments:

I wonder if it should be named something else, eg. InferActionInputSchema<T>? Would be nice to check if we have other cases like this in Astro (I don't think we do) and otherwise what other tools use. I'm suggesting "infer" because of zod but really it could be anything
Can you add type tests for this? In packages/astro/test/types/

sarah11918 · 2025-11-12T16:23:09Z

Just noting that I will wait to review the docs until @florian-lefebvre 's naming issue has been addressed!

mauriciabad · 2025-11-12T22:41:46Z

@florian-lefebvre Thanks for taking a look.

I wouldn't use infer in the name because it would confuse devs. z.infer<T> transformations a ZodType to its TypeScript type, on the other side ActionInputSchema<T> returns the ZodType. Maybe we could also add InferActionInput<T>, that does z.infer<ActionInputSchema<T>>.
Yes I'll add the tests

florian-lefebvre · 2025-11-13T07:59:26Z

Okay makes sense! Then let's keep the currrent naming 👍 (and a single new type helper). FYI we plan to include these changes in 5.16, to be released next week

mauriciabad · 2025-11-17T00:16:22Z

I added JSDoc; if you don't like it, remove it.

I also added the tests.

packages/astro/src/actions/runtime/server.ts

florian-lefebvre

Approving in terms of code! @sarah11918 this is ready for your review

sarah11918

Just a quick note from me re: introducing the code sample!

.changeset/poor-loops-boil.md

Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>

packages/astro/src/actions/runtime/server.ts

.changeset/poor-loops-boil.md

packages/astro/src/actions/runtime/server.ts

.changeset/poor-loops-boil.md

Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>

packages/astro/src/actions/runtime/server.ts

mauriciabad added 2 commits October 31, 2025 04:10

feat: Add ActionInputSchema utility type

7a6f7de

Update changeset

1b69b4d

github-actions bot added the pkg: astro Related to the core `astro` package (scope) label Oct 31, 2025

mauriciabad changed the title ~~feat: Add ActionInputSchema utility type~~ feat: Add ActionInputSchema utility type Oct 31, 2025

mauriciabad mentioned this pull request Oct 31, 2025

Document new ActionInputSchema utility type withastro/docs#12647

Merged

Merge branch 'main' into patch-1

398c61c

florian-lefebvre reviewed Nov 10, 2025

View reviewed changes

Merge branch 'main' into patch-1

7c9dce5

florian-lefebvre added this to the v5.16.0 milestone Nov 10, 2025

florian-lefebvre and others added 4 commits November 13, 2025 08:59

Merge branch 'main' into patch-1

dcf7aaa

Add tests

4aa9846

Merge branch 'main' into patch-1

f3703f0

Add JS Doc

60d37df

fix

24ac968

florian-lefebvre reviewed Nov 17, 2025

View reviewed changes

packages/astro/src/actions/runtime/server.ts Show resolved Hide resolved

florian-lefebvre approved these changes Nov 17, 2025

View reviewed changes

Merge branch 'main' into patch-1

8d2c050

sarah11918 reviewed Nov 18, 2025

View reviewed changes

.changeset/poor-loops-boil.md Outdated Show resolved Hide resolved

.changeset/poor-loops-boil.md Outdated Show resolved Hide resolved

Update .changeset/poor-loops-boil.md

1a962d7

Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>

florian-lefebvre reviewed Nov 18, 2025

View reviewed changes

packages/astro/src/actions/runtime/server.ts Show resolved Hide resolved

florian-lefebvre reviewed Nov 18, 2025

View reviewed changes

.changeset/poor-loops-boil.md Outdated Show resolved Hide resolved

florian-lefebvre added 2 commits November 18, 2025 17:46

Update .changeset/poor-loops-boil.md

7a7a8bd

Apply suggestion from @florian-lefebvre

4ddb707

florian-lefebvre reviewed Nov 18, 2025

View reviewed changes

packages/astro/src/actions/runtime/server.ts Outdated Show resolved Hide resolved

sarah11918 reviewed Nov 18, 2025

View reviewed changes

.changeset/poor-loops-boil.md Outdated Show resolved Hide resolved

Update .changeset/poor-loops-boil.md

81e0caa

Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>

florian-lefebvre reviewed Nov 19, 2025

View reviewed changes

packages/astro/src/actions/runtime/server.ts Outdated Show resolved Hide resolved

Apply suggestion from @florian-lefebvre

e7cc58a

florian-lefebvre reviewed Nov 19, 2025

View reviewed changes

packages/astro/src/actions/runtime/server.ts Outdated Show resolved Hide resolved

Apply suggestion from @florian-lefebvre

67c9bb5

florian-lefebvre merged commit f42ff9b into withastro:main Nov 19, 2025
4 checks passed

astrobot-houston mentioned this pull request Nov 19, 2025

[ci] release #14808

Merged

ArmandPhilippot mentioned this pull request Nov 21, 2025

Exported variable has or is using name 'inferSymbol' from external module but cannot be named. #14864

Closed

1 task

mauriciabad deleted the patch-1 branch November 26, 2025 10:32

Uh oh!

Conversation

mauriciabad commented Oct 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Decisions to be made

Testing

Docs

Uh oh!

changeset-bot bot commented Oct 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

github-actions bot commented Oct 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📝 Changeset Validation Results

Issues Found:

.changeset/poor-loops-boil.md

💡 Suggestions: • Use the 'minor' change type for introducing new features and APIs, aligning with the described addition. • Revise the YAML frontmatter to reflect: ```yaml

'astro': minor

Uh oh!

codspeed-hq bot commented Oct 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CodSpeed Performance Report

Merging #14698 will not alter performance

Summary

Uh oh!

florian-lefebvre left a comment

Choose a reason for hiding this comment

Uh oh!

sarah11918 commented Nov 12, 2025

Uh oh!

mauriciabad commented Nov 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

florian-lefebvre commented Nov 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mauriciabad commented Nov 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

florian-lefebvre left a comment

Choose a reason for hiding this comment

Uh oh!

sarah11918 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mauriciabad commented Oct 31, 2025 •

edited

Loading

changeset-bot bot commented Oct 31, 2025 •

edited

Loading

github-actions bot commented Oct 31, 2025 •

edited

Loading

`.changeset/poor-loops-boil.md`

💡 Suggestions:
• Use the 'minor' change type for introducing new features and APIs, aligning with the described addition.
• Revise the YAML frontmatter to reflect: ```yaml

codspeed-hq bot commented Oct 31, 2025 •

edited

Loading

mauriciabad commented Nov 12, 2025 •

edited

Loading

florian-lefebvre commented Nov 13, 2025 •

edited

Loading

mauriciabad commented Nov 17, 2025 •

edited

Loading