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

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

"backlog"

[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.

Draft summary

apify actor generate-schema-types --help

Generate TypeScript types from Actor schemas.

USAGE
  $ actor generate-schema-types [path] [--all-optional] [-o <value>] [--strict]

ARGUMENTS
  path  Optional path to the input schema file. If not provided, searches default locations.

FLAGS
      --all-optional    Mark all properties as optional in generated types.
  -o, --output=<value>  Directory where the generated files should be outputted. Defaults to src/.generated/actor/ to stay within the typical tsconfig rootDir.
      --strict          Whether generated interfaces should be strict (no index signature [key: string]: unknown).

DESCRIPTION
  Generate TypeScript types from Actor schemas.

  Generates types from the input schema and, when no custom path is provided,
  also from the dataset schema defined in '.actor/actor.json' under "storages.dataset".

  Reads the input schema from one of these locations (in priority order):
    1. Object in '.actor/actor.json' under "input" key
    2. JSON file path in '.actor/actor.json' "input" key
    3. .actor/INPUT_SCHEMA.json
    4. INPUT_SCHEMA.json

  Optionally specify custom schema path to use.

TO DO:

[slack-feedback] mention in docs that default output path is src due to tsconfig
[slack-feedback] actor generate-schema -> generate-schema-types to keep consistency with actor validate-schema?
[slack-feedback] do not export the individual fields, not useful as you can do Input['field']
- this must be done manually, json-schema-to-typescript does not support this
[slack-feedback] inline primitive types to make it less verbose (the comments above inlined fields still display in editor)
- this must be done manually, json-schema-to-typescript does not support this
output types
key-value-store types
how to resolve unknown[] problem? (As long as the items: { type: string } propagates to string[] type, let's just go that way.)

feedback from @B4nan

Must fix

Verify biome-ignore-all actually works or remove it
Handle Promise.all failure gracefully — partial success should still produce output

Should fix

Extract schema transform functions to src/lib/schema-transforms.ts
Add unit tests for stripTitles
Handle missing JSON Schema keywords in stripTitles

Nice to have

Reduce deep clone overhead
Deduplicate readOutputSchema logic
Clean up import style, unused defaults

src/commands/actor/generate-schema-types.ts

src/commands/actor/generate-types.ts

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()

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

…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

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

l2ysho · 2026-02-17T08:18:48Z

ready for review

input and dataset schemas generated
some feedback from slack addressed
other feedback in summary, If we agree to do It I will create an issues
I will update summary when review done

@vladfrangu @B4nan

vladfrangu · 2026-02-17T14:42:43Z

src/commands/actor/generate-schema-types.ts

+export class ActorGenerateSchemaTypesCommand extends ApifyCommand<typeof ActorGenerateSchemaTypesCommand> {
+	static override name = 'generate-schema-types' as const;
+
+	static override hiddenAliases = ['generate-types'];


Maybe we want this too as an alias? CC @B4nan @patrikbraborec

Suggested change

static override hiddenAliases = ['generate-types'];

static override hiddenAliases = ['generate-types', 'generate'];

vladfrangu · 2026-02-17T14:43:09Z

src/commands/actor/generate-schema-types.ts

+			description:
+				'Directory where the generated files should be outputted. Defaults to src/.generated/actor/ to stay within the typical tsconfig rootDir.',
+			required: false,
+			default: 'src/.generated/actor/',


Suggested change

default: 'src/.generated/actor/',

default: join('src', 'generated', 'actor'),

vladfrangu · 2026-02-17T14:44:37Z

src/commands/actor/generate-schema-types.ts

+		if (datasetSchemaPath) {
+			info({ message: `Generating types from dataset schema at ${datasetSchemaPath}` });
+		} else {
+			info({ message: `Generating types from dataset schema embedded in '${LOCAL_CONFIG_PATH}'` });
+		}


Do check if Dataset also has to be capitalized, like how Actor has to be

according to other places in code it should be capitalized

l2ysho · 2026-02-18T20:31:55Z

some updates

output/kvs schemas added and marked as experimental alongside with dataset
only one type exported from generated files with inline definitions (no ts-morh used now, just striped title before compilation, so far so good, if some problem occurs we can update)

…e-definitions-from-schemas

l2ysho · 2026-02-20T21:24:31Z

src/commands/actor/generate-schema-types.ts

+// biome-ignore-all lint: generated
+// biome-ignore-all format: generated


must be inline, format is available in >2.4.0
biome playground example cc @B4nan

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-schema-types.ts Outdated Show resolved Hide resolved

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

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 6 commits February 11, 2026 14:45

lint fix

e661b5b

update docs and fix options

09a898b

add dataset schema to generator

52e6766

add tests

e508ba7

rename command

ad62972

update docs

b3122a0

l2ysho added 4 commits February 16, 2026 22:19

yarn fix

a17f11f

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

187a811

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

fix docs

1d180f0

fix tests

6ff216c

l2ysho marked this pull request as ready for review February 16, 2026 22:14

l2ysho requested a review from TC-MO as a code owner February 16, 2026 22:14

l2ysho added 5 commits February 17, 2026 00:02

fix ambiguous file name

9a6c93c

Fix banner

6fd1486

Fix(actor): Makes all schema properties optional

0be7af6

Feat(actor): Adds schema optionality

7fb5f9a

Fix(actor): Makes properties with defaults optional

4d5dba9

vladfrangu reviewed Feb 17, 2026

View reviewed changes

l2ysho added 5 commits February 18, 2026 14:55

fix path to file

4306a1e

capitalize Dataset + fix path

0c6c4bc

add experimental schemas

85452dd

strip titles to get inline types

623b3e9

strip title fix + clean up

aa553cb

l2ysho added 2 commits February 18, 2026 21:32

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

dc58016

…e-definitions-from-schemas

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

2ccb29e

…e-definitions-from-schemas

l2ysho requested review from B4nan and vladfrangu February 20, 2026 14:50

Fix biome suppression comments

27ce151

l2ysho commented Feb 20, 2026

View reviewed changes

l2ysho added 2 commits February 20, 2026 22:35

use all settled in schema generator

7d00238

Extract schema transform utilities

75c5bda

	static override hiddenAliases = ['generate-types'];
	static override hiddenAliases = ['generate-types', 'generate'];

	default: 'src/.generated/actor/',
	default: join('src', 'generated', 'actor'),

		// biome-ignore-all lint: generated
		// biome-ignore-all format: generated

Comments

Conversation

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

Uh oh!

Draft summary

Uh oh!

Uh oh!

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!

Uh oh!

l2ysho commented Feb 11, 2026

Uh oh!

l2ysho commented Feb 17, 2026

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 18, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

l2ysho commented Jan 19, 2026 •

edited

Loading