feat(actor): adds actor types generation by l2ysho · Pull Request #1000 · apify/apify-cli

l2ysho · 2026-01-19T14:46:54Z

Draft summary

output: path to a directory where the files generated should be outputted, default ./.generated/actor/ (actual path in code is gonna be resolve(cwd(), output), followed by mkdir(), then storing in there). char: o
strict: whether generated interfaces should have an index definition ([key: string]: unknown if this is set to false), default true. char: s
[can optionally be done] language: the language to generate the types for (currently only TypeScript, but ideally structure the code in a way where we can easily add in new languages). char: l
[optional, nice to have, can be for future work] [input/output/dataset/key-value-store]-schema: path to a specific schema to generate types for
[don't implement this until we discuss it] add-to-ignore: whether the cli should add the generated files to files like .prettierignore or the biome config, default: false.
tests

Feedback

mention in docs that default output path is src due to tsconfig
actor generate-schema -> generate-schema-types to keep consistency with actor validate-schema?
do not export the individual fields, not useful as you can do Input['field']
inline primitive types to make it less verbose (the comments above inlined fields still display in editor)

l2ysho · 2026-01-21T13:20:25Z

src/commands/actor/generate-types.ts

+		const { inputSchema, inputSchemaPath } = await readAndValidateInputSchema({
+			forcePath: this.args.path,
+			cwd: process.cwd(),
+			action: 'Generating types from',
+		});


generate-type share a validation logic with validate-schema now

src/commands/actor/generate-types.ts

l2ysho · 2026-01-21T13:28:46Z

src/commands/actor/generate-types.ts

+			char: 'o',
+			description: 'Directory where the generated files should be outputted.',
+			required: false,
+			default: './.generated/actor/',


actor templates have typescript setup with only src as include, so you cannot import it right away and you have to adjust it. Maybe better idea is to generate it directly to src/.generated/actor/ ? cc @vladfrangu

this might be best to discuss with @B4nan and @patrikbraborec too. Or maybe we wanna make it like how prisma handles it? so you'd have @apify/actor in node-modules which gets filled out by the cli?

so you'd have @apify/actor in node-modules which gets filled out by the cli?

I think changed this in v7, because it produced a lot of side effects, e.g. with caching. But we could explore this as well, maybe for our use case it would be fine.

If we won't go that way, I am slightly in favor of putting this into the src folder, the alternative would be dynamically appending the .generated folder to includes in tsconfig. But that would mean you end up with dist/src and dist/.generated if I'm not mistaken, which is a bit ugly (but also rather irrelevant).

fwiw modifying tsconfig can be risky, people may have god knows what setups in their tsconfig files and we shouldn't randomly append our folder.

I think changed this in v7, because it produced a lot of side effects, e.g. with caching. But we could explore this as well, maybe for our use case it would be fine.

Can you help me understand what you mean by this? Did prisma change this or what are you referring to with v7?

Yes, prisma changed that.

https://www.prisma.io/docs/orm/more/upgrade-guides/upgrading-versions/upgrading-to-prisma-7#prisma-schema-changes

I just came back cuz I read that, holy heck I did not know.... But they also use the top level generated dir by def, interesting

lets use 'src/.generated/actor/' for now, we can change in next iteration if needed, now it should work out of the box 3f47502

l2ysho · 2026-01-21T13:29:25Z

test/local/commands/actor/generate-types.test.ts

+import { readFile } from 'node:fs/promises';
+


Really just starting point of tests. No complex scenarios.

vladfrangu · 2026-01-21T13:38:55Z

test/local/commands/actor/generate-types.test.ts

+		});
+
+		expect(lastErrorMessage()).toMatch(/Generated types written to/);
+		expect(lastErrorMessage()).toMatch(/\.generated\/actor\/complex\.ts/);


use path.join and i think you can do .toInclude or just expect(lastErrorMessage().includes()).toBeTruthy()

vladfrangu · 2026-01-21T13:39:35Z

test/local/commands/actor/generate-types.test.ts

+const { lastErrorMessage } = useConsoleSpy();
+
+describe('apify actor generate-types', () => {
+	const { joinPath, beforeAllCalls, afterAllCalls } = useTempPath('generate-types', {


Usually this hook is called from the top level, followed by importing the commands with await import, but if it WORKS even like this... fun

I will keep it this way, If I run on some problems I let you know

…e-definitions-from-schemas

…mand-for-generating-type-definitions-from-schemas

…rating-type-definitions-from-schemas' into 993-implement-a-command-for-generating-type-definitions-from-schemas

…mand-for-generating-type-definitions-from-schemas

l2ysho · 2026-02-11T13:44:30Z

as JuanGalilea mentioned, all properties are optional even if they have default present in definition. There is already opened PR in json-schema-to-typescript to address this, in the meantime, I pushed temporary fix 01d1ccc

l2ysho linked an issue Jan 19, 2026 that may be closed by this pull request

Implement a command for generating type definitions from schemas #993

Open

github-actions bot assigned l2ysho Jan 19, 2026

github-actions bot added this to the 132nd sprint - Tooling team milestone Jan 19, 2026

github-actions bot added the t-tooling Issues with this label are in the ownership of the tooling team. label Jan 19, 2026

l2ysho mentioned this pull request Jan 19, 2026

Implement a command for generating type definitions from schemas #993

Open

l2ysho added 3 commits January 21, 2026 14:17

feat(actor): adds actor types generation

a2780e8

feat(cli): enable generate-types command in generate-cli-docs

e5639ee

refactor(actor): add validation, tests + cleanup

dcc207c

l2ysho force-pushed the 993-implement-a-command-for-generating-type-definitions-from-schemas branch from bbaf98e to dcc207c Compare January 21, 2026 13:18

github-actions bot added the tested Temporary label used only programatically for some analytics. label Jan 21, 2026

l2ysho commented Jan 21, 2026

View reviewed changes

src/commands/actor/generate-types.ts Outdated Show resolved Hide resolved

l2ysho commented Jan 21, 2026

View reviewed changes

vladfrangu reviewed Jan 21, 2026

View reviewed changes

l2ysho added 8 commits January 23, 2026 13:26

test(actor): improve generate-types command tests

08afa3a

feat(actor): changes default output dir

3f47502

Merge branch 'master' into 993-implement-a-command-for-generating-typ…

829ee17

…e-definitions-from-schemas

Merge remote-tracking branch 'origin/master' into 993-implement-a-com…

da27683

…mand-for-generating-type-definitions-from-schemas

Merge remote-tracking branch 'origin/993-implement-a-command-for-gene…

c1052c7

…rating-type-definitions-from-schemas' into 993-implement-a-command-for-generating-type-definitions-from-schemas

Merge remote-tracking branch 'origin/master' into 993-implement-a-com…

5cac9c7

…mand-for-generating-type-definitions-from-schemas

chore: insert empty comment to template

01d1ccc

handle default as required

fc18a16

l2ysho added 2 commits February 11, 2026 14:45

lint fix

e661b5b

update docs and fix options

09a898b

Conversation

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

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

l2ysho commented Feb 11, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

l2ysho commented Jan 19, 2026 •

edited

Loading