`wasp-config` userApi renaming #2762

FranjoMindek · 2025-05-16T13:20:46Z

First draft for renaming.
userApi.ts split into publicApi/App.ts and publicApi/tsAppSpec.ts
Anything named ...userSpec... renamed to ...tsAppSpec....
Anything named ...userApp... renamed to ...App... (this referred to publicApi.App.ts)

Might be controversial:
added config suffix to testFixtures.ts config getters (so we have getAppConfig and createApp)

Copilot

Pull Request Overview

This PR resolves the renaming inconsistencies by replacing references to "userApi" with "tsAppSpec" throughout the codebase, including source files and tests, to clarify the API’s public interface. Key changes include:

Renaming imports, functions, and types (e.g. analyzeUserApp → analyzeApp, UserSpec → TsAppSpec) to reflect the new naming scheme.
Updating mapping and re-export files as well as associated tests to use the new names.
Adjusting internal symbols (e.g. GET_USER_SPEC → GET_TS_APP_SPEC) accordingly.

Reviewed Changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
waspc/packages/wasp-config/src/run.ts	Updated function name and import to use analyzeApp.
waspc/packages/wasp-config/src/publicApi/tsAppSpec.ts	Renamed type from UserSpec to TsAppSpec and updated Crud type to CrudConfig.
waspc/packages/wasp-config/src/publicApi/App.ts	Created a new App class that leverages TsAppSpec.
waspc/packages/wasp-config/src/mapTsAppSpecToAppSpecDecls.ts	Adjusted mapping functions to use TsAppSpec types.
waspc/packages/wasp-config/src/index.ts	Updated export paths to reflect the new public API structure.
waspc/packages/wasp-config/src/appAnalyzer.ts	Renamed analyzeUserApp and adjusted instance checks to use the App from publicApi.
waspc/packages/wasp-config/src/_private.ts	Updated symbol from GET_USER_SPEC to GET_TS_APP_SPEC.
Various test files	Revised test references and helper functions to use the new TsAppSpec names.

Comments suppressed due to low confidence (1)

waspc/packages/wasp-config/src/appAnalyzer.ts:10

[nitpick] Consider renaming 'userAppResult' to 'appResult' to align with the new TsAppSpec naming convention and improve clarity.

const userAppResult = await getApp(waspTsSpecPath)

waspc/packages/wasp-config/src/publicApi/tsAppSpec.ts

Martinsos

I will let @sodic take a proper look, but I like the change in the naming, "user" is gone and names make sense! Nice stuff.

waspc/packages/wasp-config/__tests__/mapUserSpecToAppSpecDecls.integration.test.ts

FranjoMindek · 2025-05-27T12:41:10Z

@sodic tag to remind

FranjoMindek · 2025-05-27T12:41:56Z

I will need to explore conflitcts

…naming # Conflicts: # waspc/packages/wasp-config/__tests__/appAnalyzer.unit.test.ts # waspc/packages/wasp-config/__tests__/mapTsAppSpecToAppSpecDecls.integration.test.ts # waspc/packages/wasp-config/__tests__/mapTsAppSpecToAppSpecDecls.unit.test.ts # waspc/packages/wasp-config/__tests__/testFixtures.ts # waspc/packages/wasp-config/src/_private.ts # waspc/packages/wasp-config/src/appAnalyzer.ts # waspc/packages/wasp-config/src/index.ts # waspc/packages/wasp-config/src/mapTsAppSpecToAppSpecDecls.ts # waspc/packages/wasp-config/src/publicApi/tsAppSpec.ts # waspc/packages/wasp-config/src/run.ts

cloudflare-workers-and-pages · 2025-05-29T09:00:03Z

Deploying wasp-docs-on-main with Cloudflare Pages

Latest commit:	`d644e22`
Status:	✅ Deploy successful!
Preview URL:	https://d2d6a7bb.wasp-docs-on-main.pages.dev
Branch Preview URL:	https://franjo-wasp-config-renaming.wasp-docs-on-main.pages.dev

View logs

FranjoMindek · 2025-05-29T09:14:04Z

I recommend opening https://github.com/wasp-lang/wasp/pull/2762/files/0a624611038d5f42df918c3839295bd2780635d7 which shows state before merging Carlos's formatting changes.

@sodic

sodic

Left some comments.

The new code is mostly ready, but we could improve the old stuff if you're up for it :)

waspc/packages/wasp-config/src/publicApi/App.ts

waspc/packages/wasp-config/src/index.ts

waspc/packages/wasp-config/__tests__/testFixtures.ts

waspc/packages/wasp-config/src/appAnalyzer.ts

FranjoMindek · 2025-06-12T17:00:55Z

Didn't add any type tests yet. Do we want that as another issue or here?
Would also love your comment on old TsAppSpec type, what should be its new name? Currently it is AppTsAppSpec.

sodic · 2025-06-12T23:19:57Z

Didn't add any type tests yet. Do we want that as another issue or here?

Good question! I'll continue the discussion in the relevant thread: #2762 (comment)

Would also love your comment on old TsAppSpec type, what should be its new name? Currently it is AppTsAppSpec.

Same thing here

sodic

Nice work with the tests. They make me much more secure in our generics.

I added some comments to them, mostly naming and descriptions.

waspc/packages/wasp-config/src/index.ts

waspc/packages/wasp-config/package.json

waspc/packages/wasp-config/.gitignore

waspc/packages/wasp-config/__tests__/testFixtures.test-d.ts

sodic · 2025-06-24T11:01:40Z

waspc/packages/wasp-config/__tests__/testFixtures.test-d.ts

+type NoPropertiesObject = {};
+
+type OptionalObject = {
+  prop?: string;
+  anotherProp?: number;
+};
+
+type RequiredObject = Required<OptionalObject>;
+
+type OptionalNested<T> = {
+  nested?: T;
+};
+
+type RequiredNested<T> = Required<OptionalNested<T>>;


These names could also be more descriptive. I suggest:

ObjectWithRequiredPrimitiveProperties

ObjectWithOptionalPrimitiveProperties

ObjectWithNestedOptionalProperties

If we're using utility types, I recommend defining required variants and then adding in the optionality, not the other way around.

Finally, I'm not sure about NoPropertiesObject. It does make sense in terms of the test, but looking just at its definition, the name is wrong. Like the comment says, {} does not represent an object without properties. For example, this code would work:

const x: NoPropertiesObject = "something"

Which is problematic. So I suggest inlining {} into the test.

I've changed tests themselves, so the type names no longer make sense.

If we're using utility types, I recommend defining required variants and then adding in the optionality, not the other way around.

For me there is no real difference, between going optional or required first, just that one is defined through the other. But I get the stance of having required object defined first. So I will change it.

For some reason, Partial besides making field optional also allows for fields to be defined but with value of undefined.
This is the LSP information on hover:

type Partial<T> = { [P in keyof T]?: T[P] | undefined; }

While source code in lib.es5.d shows:

type Partial<T> = { [P in keyof T]?: T[P]; };

weird :D.

For some reason, Partial besides making field optional also allows for fields to be defined but with value of undefined.
Yeah, this always confused me too. I don't know why that's the case.

These names could also be more descriptive

I still stand by this suggestion though, ObjectWithRequiredPrimitiveProperties is better than RequiredObject.

sodic

Spotted some mistakes in tests, let's fix those.

waspc/packages/wasp-config/__tests__/testFixtures.test-d.ts

sodic

Nice work! Only three unresolved threads left.

I'm approving, but:

We should definitely remove that export
Please consider the other two threads as well

sodic

I've got nothing else to add. Nice work and thanks for the patience :)

draft

b7da2bd

FranjoMindek self-assigned this May 16, 2025

FranjoMindek added 3 commits May 16, 2025 15:39

fix test names and types

e51e0b0

get config add config suffix

e77bc6d

map types

aed4d3f

FranjoMindek requested review from Martinsos, sodic and Copilot and removed request for Martinsos May 16, 2025 13:46

Copilot AI reviewed May 16, 2025

View reviewed changes

waspc/packages/wasp-config/src/publicApi/tsAppSpec.ts Show resolved Hide resolved

FranjoMindek added 2 commits May 16, 2025 15:51

consistency

6f375e6

comment

0217c6f

Martinsos reviewed May 16, 2025

View reviewed changes

waspc/packages/wasp-config/__tests__/mapUserSpecToAppSpecDecls.integration.test.ts Outdated Show resolved Hide resolved

rename test files

0a62461

FranjoMindek marked this pull request as ready for review May 20, 2025 08:47

FranjoMindek added 2 commits May 29, 2025 10:43

formatting

31a1432

sodic reviewed Jun 6, 2025

View reviewed changes

FranjoMindek added 7 commits June 8, 2025 11:06

rename

07b4162

else

7f54ca6

type out plural functions

3542b1f

types continue

a8548d1

no userApp

334932d

type

61d4d32

refactoring a bit

759806b

FranjoMindek added 4 commits June 12, 2025 17:29

remove config sufixes, move tsappspec type to app.ts

837d90d

reorder

ad4e86e

changes

2943e4d

fixes

2b3f89c

FranjoMindek added 5 commits June 13, 2025 13:14

type tests init

d62f4e3

switch + renames

1a8960c

renames

958c09c

simplify branded

702b239

ts config fixes, vite type check fixes

7a36f51

FranjoMindek requested a review from sodic June 13, 2025 15:43

FranjoMindek added 3 commits June 24, 2025 10:59

comments

9c38031

typo

5fa7a53

format package.json

58e21e6

sodic reviewed Jun 24, 2025

View reviewed changes

FranjoMindek added 3 commits June 24, 2025 13:14

comment

3d3f997

changes

4227c05

no props obj

dd8fbfc

FranjoMindek requested a review from sodic June 24, 2025 18:59

rename T

7c4e793

sodic requested changes Jun 25, 2025

View reviewed changes

fixes

d3e08bf

FranjoMindek requested a review from sodic June 25, 2025 12:19

sodic approved these changes Jun 26, 2025

View reviewed changes

FranjoMindek added 2 commits June 26, 2025 12:18

no exports

2d81a38

fix type

bae7161

sodic approved these changes Jun 26, 2025

View reviewed changes

FranjoMindek merged commit 11909a9 into main Jun 26, 2025
7 checks passed

FranjoMindek deleted the franjo/wasp-config-renaming branch June 26, 2025 11:45

Uh oh!

wasp-config userApi renaming #2762

wasp-config userApi renaming #2762

Uh oh!

Conversation

FranjoMindek commented May 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Martinsos left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

FranjoMindek commented May 27, 2025

Uh oh!

FranjoMindek commented May 27, 2025

Uh oh!

cloudflare-workers-and-pages bot commented May 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Deploying wasp-docs-on-main with Cloudflare Pages

Uh oh!

FranjoMindek commented May 29, 2025

Uh oh!

sodic 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!

FranjoMindek commented Jun 12, 2025

Uh oh!

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

Uh oh!

Uh oh!

sodic left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sodic Jun 24, 2025

Choose a reason for hiding this comment

Uh oh!

FranjoMindek Jun 24, 2025

Choose a reason for hiding this comment

Uh oh!

sodic Jun 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sodic 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!

sodic left a comment

Choose a reason for hiding this comment

Uh oh!

sodic left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

`wasp-config` userApi renaming #2762

`wasp-config` userApi renaming #2762

FranjoMindek commented May 16, 2025 •

edited

Loading

cloudflare-workers-and-pages bot commented May 29, 2025 •

edited

Loading

sodic commented Jun 12, 2025 •

edited

Loading

sodic Jun 26, 2025 •

edited

Loading