feat: add Artifacts binding TypeScript definitions#6508
Merged
dario-piotrowicz merged 16 commits intoApr 17, 2026
Conversation
|
All contributors have signed the CLA ✍️ ✅ |
Contributor
Author
|
I have read the CLA Document and I hereby sign the CLA |
7071b12 to
23898be
Compare
23898be to
00d8b17
Compare
Merging this PR will not alter performance
Comparing 
Footnotes
|
b763d83 to
daeaa28
Compare
5eb297f to
56e4a11
Compare
mattzcarey
commented
Apr 15, 2026
Codecov Report✅ All modified and coverable lines are covered by tests. 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. 🚀 New features to boost your workflow:
|
d0d1645 to
2b42cb6
Compare
2 tasks
Collaborator
|
/bonk review this pr |
Contributor
There was a problem hiding this comment.
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 byjust generate-types. The hand-edited snapshots will diverge from the pipeline output and CI will likely reject them.ArtifactsRepoduplicates all fields fromArtifactsRepoInfoinstead of extending it — this creates a maintenance burden.scopefield inArtifactsCreateTokenResultshould use a string literal union to matchArtifactsTokenInfo.scopeandcreateToken()'s parameter type.get()return type should bePromise<ArtifactsRepo | null>since the JSDoc says it returns null when not found.import()target.optsnesting 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.
- 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>
Co-authored-by: ask-bonk[bot] <249159057+ask-bonk[bot]@users.noreply.github.com>
6ae35d7 to
fca1d4c
Compare
fca1d4c to
0996d4f
Compare
dario-piotrowicz
approved these changes
Apr 17, 2026
danlapid
approved these changes
Apr 17, 2026
mattzcarey
added a commit
to cloudflare/cloudflare-docs
that referenced
this pull request
Apr 17, 2026
- 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
mattzcarey
added a commit
to cloudflare/cloudflare-docs
that referenced
this pull request
Apr 17, 2026
- 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
mattzcarey
added a commit
to cloudflare/cloudflare-docs
that referenced
this pull request
Apr 17, 2026
- 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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add TypeScript type definitions for the Artifacts binding
Changes
New file:
types/defines/artifacts.d.ts