feat: add Artifacts binding TypeScript definitions by mattzcarey · Pull Request #6508 · cloudflare/workerd

mattzcarey · 2026-04-07T11:01:39Z

Summary

Add TypeScript type definitions for the Artifacts binding

Changes

New file: types/defines/artifacts.d.ts

github-actions · 2026-04-07T11:01:50Z

All contributors have signed the CLA ✍️ ✅
_{Posted by the CLA Assistant Lite bot.}

mattzcarey · 2026-04-07T11:02:58Z

I have read the CLA Document and I hereby sign the CLA

codspeed-hq · 2026-04-08T17:24:54Z

Merging this PR will not alter performance

✅ 72 untouched benchmarks
⏩ 129 skipped benchmarks¹

_{Comparing mattzcarey:feat/artifacts-binding-types (139ff03) with main (16ead14)}

129 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩

codecov-commenter · 2026-04-15T16:53:15Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 70.86%. Comparing base (16ead14) to head (139ff03).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #6508   +/-   ##
=======================================
  Coverage   70.86%   70.86%           
=======================================
  Files         438      438           
  Lines      123696   123696           
  Branches    19467    19467           
=======================================
  Hits        87660    87660           
  Misses      24510    24510           
  Partials    11526    11526

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

danlapid · 2026-04-16T00:27:49Z

/bonk review this pr

ask-bonk

Review Summary

The type definitions are well-documented with solid JSDoc comments, and the naming conventions (Artifacts* prefix) follow the codebase standard. There are several issues to address before this can merge:

generated-snapshot/ files should not be manually edited — they must be produced by just generate-types. The hand-edited snapshots will diverge from the pipeline output and CI will likely reject them.
ArtifactsRepo duplicates all fields from ArtifactsRepoInfo instead of extending it — this creates a maintenance burden.
scope field in ArtifactsCreateTokenResult should use a string literal union to match ArtifactsTokenInfo.scope and createToken()'s parameter type.
get() return type should be Promise<ArtifactsRepo | null> since the JSDoc says it returns null when not found.
import() target.opts nesting is unnecessarily deep — consider flattening.
Missing type tests — other bindings (D1, AI, RPC, etc.) have type tests in types/test/types/.

This review was generated by an AI assistant and may contain inaccuracies. Please verify all suggestions before applying.

Add Artifacts binding types to the generated snapshot files (index.d.ts and index.ts) to match bazel-generated output.

- fork(): flatten to (name, opts?) with description, readOnly, defaultBranchOnly - create(): add description and setDefaultBranch to opts - import(): restructure to params object with source and target - Flatten return types: remove '& { repo: ArtifactsRepo }' intersections - get(): add JSDoc note about transient states (import/fork in progress) - Update all 4 generated snapshot files to match

- Remove Artifacts.import() method entirely - Add ArtifactsGetRepoResult type with repo handle and status field - get() now returns { repo, status } where status is 'ready' | 'importing' | 'forking' - Update all generated snapshots

ArtifactsGetRepoResult is now: | { status: 'ready'; repo: ArtifactsRepo } | { status: 'not_found' } | { status: 'importing'; retryAfter: number } | { status: 'forking'; retryAfter: number }

- Rename expiresAt → tokenExpiresAt on ArtifactsCreateRepoResult - Remove ArtifactsTokenValidation and validateToken() - Remove ArtifactsGetRepoResult union, get() returns ArtifactsRepo directly - Inline repo fields directly on ArtifactsRepo (no more info() method) - Restore import() with source/target params structure - Update all generated snapshots

Co-authored-by: ask-bonk[bot] <249159057+ask-bonk[bot]@users.noreply.github.com>

- create() returns ArtifactsCreateRepoResult (not & { repo }) - get() returns ArtifactsRepo (throws on not found, no null) - Remove info() — repo metadata is on the handle directly (ArtifactsRepo extends ArtifactsRepoInfo) - Remove validateToken() — not in workerd types or binding - Add import() — was missing from docs entirely - Fix expiresAt → tokenExpiresAt in get-started example - Add namespace note (any name works, not just 'default') - Remove null checks on get() — it throws, not returns null Aligned with: cloudflare/workerd#6508

github-actions bot added a commit that referenced this pull request Apr 7, 2026

@mattzcarey has signed the CLA in #6508

35d139a

mattzcarey force-pushed the feat/artifacts-binding-types branch 8 times, most recently from 7071b12 to 23898be Compare April 8, 2026 16:49

penalosa force-pushed the feat/artifacts-binding-types branch from 23898be to 00d8b17 Compare April 8, 2026 16:57

mattzcarey force-pushed the feat/artifacts-binding-types branch 4 times, most recently from b763d83 to daeaa28 Compare April 15, 2026 10:56

mattzcarey marked this pull request as ready for review April 15, 2026 11:22

mattzcarey requested a review from a team as a code owner April 15, 2026 11:22

mattzcarey requested a review from emily-shen April 15, 2026 11:22

mattzcarey force-pushed the feat/artifacts-binding-types branch from 5eb297f to 56e4a11 Compare April 15, 2026 11:56

mattzcarey requested review from a team as code owners April 15, 2026 11:56

mattzcarey commented Apr 15, 2026

View reviewed changes

mattzcarey force-pushed the feat/artifacts-binding-types branch 2 times, most recently from d0d1645 to 2b42cb6 Compare April 15, 2026 17:47

dario-piotrowicz mentioned this pull request Apr 15, 2026

[wrangler] add artifacts binding support cloudflare/workers-sdk#13326

Merged

2 tasks

ask-bonk bot reviewed Apr 16, 2026

View reviewed changes

mattzcarey and others added 10 commits April 16, 2026 15:12

chore: update generated type snapshots with Artifacts types

f0ba2b1

Add Artifacts binding types to the generated snapshot files (index.d.ts and index.ts) to match bazel-generated output.

fix: remove import(), return typed status from get()

35e8d87

- Remove Artifacts.import() method entirely - Add ArtifactsGetRepoResult type with repo handle and status field - get() now returns { repo, status } where status is 'ready' | 'importing' | 'forking' - Update all generated snapshots

fix: use discriminated union for get() result with retryAfter

b7f2572

ArtifactsGetRepoResult is now: | { status: 'ready'; repo: ArtifactsRepo } | { status: 'not_found' } | { status: 'importing'; retryAfter: number } | { status: 'forking'; retryAfter: number }

Update types/defines/artifacts.d.ts

3507b00

Co-authored-by: ask-bonk[bot] <249159057+ask-bonk[bot]@users.noreply.github.com>

update ArtifactsRepo to extend ArtifactsRepoInfo

501c7f1

Update incorrect jsdoc comment

603862b

Update types/defines/artifacts.d.ts

3798d21

Co-authored-by: ask-bonk[bot] <249159057+ask-bonk[bot]@users.noreply.github.com>

Update token scope to use strings union

ddbc54a

dario-piotrowicz force-pushed the feat/artifacts-binding-types branch from 6ae35d7 to fca1d4c Compare April 16, 2026 14:14

update generated types

0996d4f

dario-piotrowicz force-pushed the feat/artifacts-binding-types branch from fca1d4c to 0996d4f Compare April 16, 2026 14:25

dario-piotrowicz mentioned this pull request Apr 16, 2026

feat: add Artifacts binding TypeScript definitions #6593

Merged

Merge branch 'main' into feat/artifacts-binding-types

77824cf

dario-piotrowicz approved these changes Apr 17, 2026

View reviewed changes

danlapid approved these changes Apr 17, 2026

View reviewed changes

Merge branch 'main' into feat/artifacts-binding-types

139ff03

dario-piotrowicz merged commit ce15db6 into cloudflare:main Apr 17, 2026
38 of 39 checks passed

Conversation

mattzcarey commented Apr 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

Uh oh!

github-actions bot commented Apr 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mattzcarey commented Apr 7, 2026

Uh oh!

codspeed-hq bot commented Apr 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merging this PR will not alter performance

Footnotes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov-commenter commented Apr 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

danlapid commented Apr 16, 2026

Uh oh!

ask-bonk bot left a comment

Choose a reason for hiding this comment

Review Summary

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!

5 participants

mattzcarey commented Apr 7, 2026 •

edited

Loading

github-actions bot commented Apr 7, 2026 •

edited

Loading

codspeed-hq bot commented Apr 8, 2026 •

edited

Loading

codecov-commenter commented Apr 15, 2026 •

edited

Loading