Refactor paramsSchema to function-based pattern with z in context #4858

Copilot · 2026-01-09T13:01:32Z

Refactor paramsSchema to Use Function-Based Approach with z in Context

Pattern Examples

Simple (only z needed):

paramsSchema: ({ z }) => ({
    setupName: z.enum(["ddb", "ddb+es", "ddb+os"]).describe(...)
})

With project context (no z usage):

paramsSchema: ({ project }) => ({
    src: zodPathToAbstraction(SomeAbstraction, project)
})

With project context (using z):

paramsSchema: ({ project, z }) => ({
    src: zodPathToFile(project),
    singleton: z.boolean().optional().default(true)
})

Key points:

Only destructure the parameters you actually use
Always return a plain object {...}, NOT z.object({...})
The z.object() wrapping happens automatically in ExtensionInstanceModel.validateParams()

Files Updated (24 files)

packages/project:

Removed unused z from 20 hook files that only use project
Removed unused z from 3 pulumi files (AdminPulumi, ApiPulumi, CorePulumi)
Removed unused z from ProjectDecorator.ts
Kept z in ProjectImplementation.ts and defineApiExtension.ts (they use it)

Original prompt

let's adjust the paramsSchema.. instead of

paramsSchema: z.object({
setupName: z
.enum(["ddb", "ddb+es", "ddb+os"])
.describe(
"The database setup type: ddb (DynamoDB only), ddb+es (DynamoDB + ElasticSearch), or ddb+os (DynamoDB + OpenSearch)"
)
})

let's have the same appraoch as in

packages/cognito/src/admin/routes.ts:9

So basically

paramsSchema: z => {
return {
setupName: z.enum(["ddb", "ddb+es", "ddb+os"]).describe(
"The database setup type: ddb (DynamoDB only), ddb+es (DynamoDB + ElasticSearch), or ddb+os (DynamoDB + OpenSearch)"
)
})

this needs to be done for ALL defineExtension calls but for starters, let's do just packages/project. So we see first how it went there.

The user has attached the following files from their workspace:

packages/project/src/extensions/DatabaseSetup.ts

TITLE: Refactoring paramsSchema Definition in packages/project to Use Function-Based Approach

USER INTENT:
The user wants to refactor the paramsSchema definition in the packages/project codebase to use a function-based approach (accepting z as an argument), similar to the pattern used in packages/cognito/src/admin/routes.ts. This change should be applied to all defineExtension calls, but the user wants to start with packages/project to validate the approach.

TASK DESCRIPTION:

Update the paramsSchema definition in packages/project so that it is a function accepting z as an argument, returning the schema object.

The new approach should mirror the implementation found in packages/cognito/src/admin/routes.ts:9.

The schema should still validate setupName as one of "ddb", "ddb+es", or "ddb+os", with the same descriptive text.

This is a preliminary step before applying the change to all defineExtension calls.

EXISTING:
The current paramsSchema in packages/project is defined as:
paramsSchema: z.object({
    setupName: z
        .enum(["ddb", "ddb+es", "ddb+os"])
        .describe(
            "The database setup type: ddb (DynamoDB only), ddb+es (DynamoDB + ElasticSearch), or ddb+os (DynamoDB + OpenSearch)"
        )
})
The desired pattern is already implemented in packages/cognito/src/admin/routes.ts at line 9.
PENDING:
Refactor the paramsSchema in packages/project to use the function-based approach:
paramsSchema: z => ({
    setupName: z.enum(["ddb", "ddb+es", "ddb+os"]).describe(
        "The database setup type: ddb (DynamoDB only), ddb+es (DynamoDB + ElasticSearch), or ddb+os (DynamoDB + OpenSearch)"
    )
})
Test and validate the change in packages/project before rolling out to other defineExtension calls.
CODE STATE:

packages/project (file(s) containing defineExtension calls with paramsSchema)

packages/cognito/src/admin/routes.ts (reference implementation at line 9)

RELEVANT CODE/DOCUMENTATION SNIPPETS:
Reference implementation from packages/cognito/src/admin/routes.ts:
paramsSchema: z => ({
    // ...schema fields
})
Target schema for setupName:
setupName: z.enum(["ddb", "ddb+es", "ddb+os"]).describe(
    "The database setup type: ddb (DynamoDB only), ddb+es (DynamoDB + ElasticSearch), or ddb+os (DynamoDB + OpenSearch)"
)
OTHER NOTES:

The user wants to see how the change works in packages/project before applying it more broadly.

The main motivation is to standardize the schema definition pattern across the codebase.

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: adrians5j <[email protected]>

…iBackendService Co-authored-by: adrians5j <[email protected]>

Co-authored-by: adrians5j <[email protected]>

…ate-files-option

Co-authored-by: adrians5j <[email protected]>

adrians5j · 2026-01-09T14:36:52Z

packages/project/src/extensions/ProjectImplementation.ts

    multiple: true,
    description: "Define a custom implementation or replace an existing one.",
-    paramsSchema: ({ project }) => {
+    paramsSchema: ({ project }: ExtensionInstanceModelContext) => {


maybe you misunderstood me but..

paramsSchema: ({ project }: ExtensionInstanceModelContext) => { return z.object({ src: zodPathToFile(project), singleton: z.boolean().optional().default(true)

the above should become

paramsSchema: ({ project, z }) => { return z.object({ src: zodPathToFile(project), singleton: z.boolean().optional().default(true)

So, include z in callback. Also, I should not be required to pass any typings here. It should happen automatically, like in packages/cognito/src/admin/routes.ts. Check this example again.

This is the file where its impl resides: packages/app/src/features/router/Route.ts:11

@copilot

Updated all extensions to use ({ project, z }) pattern. Type annotations are now automatic through TypeScript inference, matching the Route pattern. Changes in commit d4a869b.

Co-authored-by: adrians5j <[email protected]>

adrians5j

@copilot

adrians5j · 2026-01-09T16:04:25Z

packages/project/src/extensions/hooks/ApiAfterDeploy.ts

 import { defineExtension } from "~/defineExtension/index.js";
 import { zodPathToAbstraction } from "~/defineExtension/zodTypes/zodPathToAbstraction.js";
 import { ApiAfterDeploy as ApiAfterDeployAbstraction } from "~/abstractions/index.js";
 import { z } from "zod";


Why leave this import here? Please remove.

Removed the unused z import from ApiAfterDeploy.ts and all other hook/pulumi files that use ({ z }) or ({ project, z }) pattern. Changes in commit b7a5b33.

adrians5j · 2026-01-09T16:04:58Z

packages/project/src/extensions/hooks/AdminBeforeDeploy.ts

    description: "Add custom logic to be executed before the ADMIN deployment process.",
    multiple: true,
-    paramsSchema: ({ project }) => {
+    paramsSchema: ({ project, z }) => {


I love what you did here, so now do the same in packages/project-aws please.

P.S. Ofc, you did not remove the import of zod at the top of the file. Make sure to not forget removing this.

Applied the same refactoring to packages/project-aws. Updated 7 extension files to use the new ({ z }) => ({...}) pattern and removed all z imports. Changes in commit b7a5b33.

…-aws Co-authored-by: adrians5j <[email protected]>

Co-authored-by: adrians5j <[email protected]>

…ms-schema-definition

adrians5j · 2026-01-13T05:26:12Z

/e2e

adrians5j · 2026-01-13T05:26:32Z

/cypress

github-actions · 2026-01-13T05:26:43Z

Cypress E2E tests have been initiated (for more information, click here). ✨

adrians5j · 2026-01-13T10:16:53Z

/vitest

github-actions · 2026-01-13T10:17:02Z

Vitest tests have been initiated (for more information, click here). ✨

…ms-schema-definition

adrians5j · 2026-01-13T17:40:26Z

/e2e

adrians5j · 2026-01-13T17:40:33Z

/vitest

github-actions · 2026-01-13T17:40:38Z

Cypress E2E tests have been initiated (for more information, click here). ✨

github-actions · 2026-01-13T17:40:44Z

Vitest tests have been initiated (for more information, click here). ✨

adrians5j · 2026-01-13T18:00:24Z

/vitest

github-actions · 2026-01-13T18:00:36Z

Vitest tests have been initiated (for more information, click here). ✨

adrians5j · 2026-01-13T18:26:34Z

/vitest

github-actions · 2026-01-13T18:26:45Z

Vitest tests have been initiated (for more information, click here). ✨

adrians5j and others added 13 commits January 8, 2026 12:41

wip:1 (xp9ml)

9325dc4

Initial plan

389ab2f

feat: add Pulumi production state file validation to DeployCommand

a10c374

Co-authored-by: adrians5j <[email protected]>

feat: export isRemotePulumiBackend from project package

a9a82d3

Co-authored-by: adrians5j <[email protected]>

refactor: move validation to CoreBeforeDeploy hook with IsRemotePulum…

bec2fd1

…iBackendService Co-authored-by: adrians5j <[email protected]>

fix: add params parameter to CoreBeforeDeploy hook execute method

6ae01ca

Co-authored-by: adrians5j <[email protected]>

fix: move allowLocalStateFiles from sdkParams to execute params

154cbd9

Co-authored-by: adrians5j <[email protected]>

wip:2 (cxfu3)

5135f83

wip:3 (ekinh)

7d8f06c

ci:run workflows

0a20a59

Merge remote-tracking branch 'origin/next' into copilot/port-local-st…

2c1fd39

…ate-files-option

wip:7 (kc99e)

d48e7cb

Initial plan

b212b04

Copilot AI assigned Copilot and adrians5j Jan 9, 2026

Copilot started work on behalf of adrians5j January 9, 2026 13:01 View session

Copilot AI and others added 2 commits January 9, 2026 13:21

Refactor paramsSchema in packages/project to use function-based approach

68b0c9e

Co-authored-by: adrians5j <[email protected]>

Improve pattern detection in ExtensionInstanceModel using runtime checks

10a5e1c

Co-authored-by: adrians5j <[email protected]>

Copilot AI changed the title ~~[WIP] Refactor paramsSchema definition in packages/project to use function-based approach~~ Refactor paramsSchema to function-based pattern in packages/project Jan 9, 2026

Copilot AI requested a review from adrians5j January 9, 2026 13:29

Copilot finished work on behalf of adrians5j January 9, 2026 13:29

adrians5j reviewed Jan 9, 2026

View reviewed changes

Copilot started work on behalf of adrians5j January 9, 2026 14:37 View session

Update paramsSchema to include z in context object ({ project, z })

d4a869b

Co-authored-by: adrians5j <[email protected]>

Copilot AI changed the title ~~Refactor paramsSchema to function-based pattern in packages/project~~ Refactor paramsSchema to function-based pattern with z in context Jan 9, 2026

Copilot AI requested a review from adrians5j January 9, 2026 14:43

Copilot finished work on behalf of adrians5j January 9, 2026 14:43

adrians5j reviewed Jan 9, 2026

View reviewed changes

Copilot started work on behalf of adrians5j January 9, 2026 16:07 View session

Remove unused z imports and apply paramsSchema refactoring to project…

b7a5b33

…-aws Co-authored-by: adrians5j <[email protected]>

Remove unused z parameter from paramsSchema destructuring

3cb5368

Co-authored-by: adrians5j <[email protected]>

Copilot AI requested a review from adrians5j January 9, 2026 17:04

Copilot finished work on behalf of adrians5j January 9, 2026 17:04

adrians5j changed the base branch from copilot/port-local-state-files-option to next January 12, 2026 13:31

Merge remote-tracking branch 'origin/next' into copilot/refactor-para…

755cbac

…ms-schema-definition

Pavel910 added this to the 6.0.0 milestone Jan 12, 2026

adrians5j and others added 4 commits January 13, 2026 06:01

wip:8 (n6t8o)

775ff52

wip

330ab4c

wip

f5005f4

Merge branch 'next' into copilot/refactor-params-schema-definition

221094c

adrians5j marked this pull request as ready for review January 13, 2026 05:26

adrians5j and others added 3 commits January 13, 2026 07:14

wip:11 (i1hpu)

9c7b02e

Merge branch 'next' into copilot/refactor-params-schema-definition

ea40465

Merge branch 'next' into copilot/refactor-params-schema-definition

30a5c28

Merge remote-tracking branch 'origin/next' into copilot/refactor-para…

3a9472f

…ms-schema-definition

Merge branch 'next' into copilot/refactor-params-schema-definition

0137413

Merge branch 'next' into copilot/refactor-params-schema-definition

2938c9c

Refactor paramsSchema to function-based pattern with z in context #4858

Are you sure you want to change the base?

Refactor paramsSchema to function-based pattern with z in context #4858

Conversation

Copilot AI commented Jan 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Refactor paramsSchema to Use Function-Based Approach with z in Context

Pattern Examples

Files Updated (24 files)

Uh oh!

adrians5j Jan 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 9, 2026

Choose a reason for hiding this comment

Uh oh!

adrians5j left a comment

Choose a reason for hiding this comment

Uh oh!

adrians5j Jan 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 9, 2026

Choose a reason for hiding this comment

Uh oh!

adrians5j Jan 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 9, 2026

Choose a reason for hiding this comment

Uh oh!

adrians5j commented Jan 13, 2026

Uh oh!

adrians5j commented Jan 13, 2026

Uh oh!

github-actions bot commented Jan 13, 2026

Uh oh!

adrians5j commented Jan 13, 2026

Uh oh!

github-actions bot commented Jan 13, 2026

Uh oh!

adrians5j commented Jan 13, 2026

Uh oh!

adrians5j commented Jan 13, 2026

Uh oh!

github-actions bot commented Jan 13, 2026

Uh oh!

github-actions bot commented Jan 13, 2026

Uh oh!

adrians5j commented Jan 13, 2026

Uh oh!

github-actions bot commented Jan 13, 2026

Uh oh!

adrians5j commented Jan 13, 2026

Uh oh!

github-actions bot commented Jan 13, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Jan 9, 2026 •

edited

Loading