feat(types): add Media Library asset aspect types #9146

juice49 · 2025-04-05T20:53:27Z

Description

This branch adds types for Media Library aspects and a defineAssetAspect function for defining aspects. This is based on prior work by @sgulseth and @sjelfull.

These additions can be imported from either sanity or @sanity/types.

What to review

The new defineAssetAspect and types. Does all the naming make sense?

Testing

Added some basic unit tests.

vercel · 2025-04-05T20:53:32Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
page-building-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 15, 2025 9:18am
performance-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 15, 2025 9:18am
test-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 15, 2025 9:18am

3 Skipped Deployments

Name	Status	Preview	Updated (UTC)
e2e-studio	⬜️ Ignored (Inspect)		Apr 15, 2025 9:18am
studio-workshop	⬜️ Ignored (Inspect)	Visit Preview	Apr 15, 2025 9:18am
test-next-studio	⬜️ Ignored (Inspect)		Apr 15, 2025 9:18am

github-actions · 2025-04-05T20:57:28Z

No changes to documentation

github-actions · 2025-04-05T20:58:48Z

Coverage Report

Status	Category	Percentage	Covered / Total
🔵	Lines	43.38%	57071 / 131549
🔵	Statements	43.38%	57071 / 131549
🔵	Functions	47.9%	2854 / 5958
🔵	Branches	79.85%	10654 / 13341

File Coverage

File	Stmts	Branches	Functions	Lines	Uncovered Lines
Changed Files
packages/@sanity/types/src/index.ts	100%	100%	100%	100%
packages/@sanity/types/src/mediaLibrary/asserters.ts	100%	100%	100%	100%
packages/@sanity/types/src/mediaLibrary/defineAssetAspect.ts	85.71%	50%	100%	85.71%	25-26
packages/@sanity/types/src/mediaLibrary/index.ts	100%	100%	100%	100%
packages/@sanity/types/src/mediaLibrary/types.ts	100%	100%	100%	100%

Generated in workflow #33685 for commit 5966f1a by the Vitest Coverage Report Action

github-actions · 2025-04-05T21:04:55Z

⚡️ Editor Performance Report

Updated Tue, 15 Apr 2025 09:28:59 GMT

Benchmark	reference ^{latency of sanity@latest}	experiment ^{latency of this branch}	Δ (%) ^{latency difference}
article (title)	23.8 efps (42ms)	23.5 efps (43ms)	+1ms (+1.2%)	✅
article (body)	46.9 efps (21ms)	64.3 efps (16ms)	-6ms (-27.0%)	✅
article (string inside object)	26.3 efps (38ms)	26.7 efps (38ms)	-1ms (-1.3%)	✅
article (string inside array)	22.2 efps (45ms)	23.8 efps (42ms)	-3ms (-6.7%)	✅
recipe (name)	45.5 efps (22ms)	45.5 efps (22ms)	+0ms (-/-%)	✅
recipe (description)	52.6 efps (19ms)	52.6 efps (19ms)	+0ms (-/-%)	✅
recipe (instructions)	99.9+ efps (6ms)	99.9+ efps (5ms)	-1ms (-/-%)	✅
synthetic (title)	18.2 efps (55ms)	19.2 efps (52ms)	-3ms (-5.5%)	✅
synthetic (string inside object)	18.2 efps (55ms)	18.5 efps (54ms)	-1ms (-1.8%)	✅

efps — editor "frames per second". The number of updates assumed to be possible within a second.

Derived from input latency. efps = 1000 / input_latency

Detailed information

🏠 Reference result

The performance result of sanity@latest

Benchmark	latency	p75	p90	p99	blocking time	test duration
article (title)	42ms	44ms	46ms	76ms	87ms	11.4s
article (body)	21ms	25ms	43ms	439ms	1058ms	8.1s
article (string inside object)	38ms	40ms	43ms	49ms	17ms	7.2s
article (string inside array)	45ms	47ms	50ms	59ms	155ms	7.0s
recipe (name)	22ms	24ms	26ms	66ms	0ms	7.7s
recipe (description)	19ms	20ms	21ms	24ms	0ms	4.7s
recipe (instructions)	6ms	7ms	8ms	18ms	0ms	3.1s
synthetic (title)	55ms	56ms	59ms	227ms	987ms	12.9s
synthetic (string inside object)	55ms	57ms	65ms	230ms	832ms	8.2s

🧪 Experiment result

The performance result of this branch

Benchmark	latency	p75	p90	p99	blocking time	test duration
article (title)	43ms	47ms	53ms	74ms	209ms	11.4s
article (body)	16ms	17ms	18ms	36ms	49ms	5.3s
article (string inside object)	38ms	40ms	44ms	64ms	119ms	7.1s
article (string inside array)	42ms	44ms	47ms	49ms	56ms	6.7s
recipe (name)	22ms	23ms	27ms	38ms	0ms	7.9s
recipe (description)	19ms	20ms	20ms	35ms	0ms	4.7s
recipe (instructions)	5ms	7ms	7ms	8ms	0ms	3.1s
synthetic (title)	52ms	56ms	61ms	182ms	821ms	14.3s
synthetic (string inside object)	54ms	56ms	58ms	201ms	851ms	8.4s

📚 Glossary

column definitions

benchmark — the name of the test, e.g. "article", followed by the label of the field being measured, e.g. "(title)".

latency — the time between when a key was pressed and when it was rendered. derived from a set of samples. the median (p50) is shown to show the most common latency.

p75 — the 75th percentile of the input latency in the test run. 75% of the sampled inputs in this benchmark were processed faster than this value. this provides insight into the upper range of typical performance.

p90 — the 90th percentile of the input latency in the test run. 90% of the sampled inputs were faster than this. this metric helps identify slower interactions that occurred less frequently during the benchmark.

p99 — the 99th percentile of the input latency in the test run. only 1% of sampled inputs were slower than this. this represents the worst-case scenarios encountered during the benchmark, useful for identifying potential performance outliers.

blocking time — the total time during which the main thread was blocked, preventing user input and UI updates. this metric helps identify performance bottlenecks that may cause the interface to feel unresponsive.

test duration — how long the test run took to complete.

github-actions · 2025-04-05T21:07:09Z

📊 Playwright Test Report

Download Full E2E Report

This report contains test results, including videos of failing tests.

juice49 · 2025-04-05T21:38:19Z

This stack of pull requests is managed by Graphite. Learn more about stacking.

sgulseth

nice!

packages/@sanity/types/src/mediaLibrary/types.ts

sgulseth · 2025-04-14T09:00:23Z

packages/@sanity/types/src/mediaLibrary/defineAssetAspect.ts

+
+  return {
+    _type: MEDIA_LIBRARY_ASSET_ASPECT_TYPE_NAME,
+    _id: `${name}`,


Makes sense to me!

This has been fixed.

github-actions · 2025-04-15T09:20:03Z

🧪 E2E Preview environment

🔑 Environment Variables for Local Testing

This is the preview URL for the E2E tests: https://e2e-studio-cs2vpvdxf.sanity.dev

To run the E2E tests locally, you can use the following environment variables, then run pnpm test:e2e --ui to open the Playwright test runner.

💬 Remember to build the project first with pnpm build:e2e.

  SANITY_E2E_PROJECT_ID=kin4wkua
  SANITY_E2E_BASE_URL=https://e2e-studio-cs2vpvdxf.sanity.dev
  SANITY_E2E_DATASET="update depending the project you want to test (pr-chromium-9146 || pr-firefox-9146 )"
  SANITY_E2E_DATASET_CHROMIUM=pr-chromium-9146
  SANITY_E2E_DATASET_FIREFOX=pr-firefox-9146

vercel bot deployed to Preview – performance-studio April 5, 2025 20:59 View deployment

vercel bot deployed to Preview – page-building-studio April 5, 2025 20:59 View deployment

vercel bot deployed to Preview – test-studio April 5, 2025 21:00 View deployment

juice49 mentioned this pull request Apr 5, 2025

feat(cli): add Media Library CLI #9147

Merged

vercel bot had a problem deploying to Preview – page-building-studio April 5, 2025 21:52 Failure

vercel bot had a problem deploying to Preview – test-studio April 5, 2025 21:52 Failure

vercel bot had a problem deploying to Preview – performance-studio April 5, 2025 21:52 Failure

juice49 force-pushed the feat/dam-410/media-library-types branch from 2e1be79 to 93fad0d Compare April 5, 2025 22:46

vercel bot had a problem deploying to Preview – page-building-studio April 5, 2025 22:47 Failure

vercel bot had a problem deploying to Preview – test-studio April 5, 2025 22:47 Failure

vercel bot had a problem deploying to Preview – performance-studio April 5, 2025 22:47 Failure

juice49 force-pushed the feat/dam-410/media-library-types branch from 93fad0d to 17abd4c Compare April 5, 2025 23:10

vercel bot deployed to Preview – page-building-studio April 5, 2025 23:16 View deployment

vercel bot deployed to Preview – performance-studio April 5, 2025 23:16 View deployment

vercel bot deployed to Preview – test-studio April 5, 2025 23:17 View deployment

juice49 mentioned this pull request Apr 5, 2025

feat(sanity): add Media Library import and export CLI commands #9148

Draft

vercel bot deployed to Preview – page-building-studio April 6, 2025 14:14 View deployment

vercel bot deployed to Preview – performance-studio April 6, 2025 14:14 View deployment

vercel bot deployed to Preview – test-studio April 6, 2025 14:15 View deployment

juice49 force-pushed the feat/dam-410/media-library-types branch from 38560b1 to 8f78b2d Compare April 6, 2025 14:25

vercel bot deployed to Preview – page-building-studio April 6, 2025 14:25 View deployment

vercel bot deployed to Preview – performance-studio April 6, 2025 14:25 View deployment

vercel bot deployed to Preview – test-studio April 6, 2025 14:25 View deployment

juice49 force-pushed the feat/dam-410/media-library-types branch from 8f78b2d to 6d10258 Compare April 9, 2025 07:27

vercel bot deployed to Preview – performance-studio April 13, 2025 18:07 View deployment

vercel bot deployed to Preview – page-building-studio April 13, 2025 18:07 View deployment

vercel bot deployed to Preview – test-studio April 13, 2025 18:07 View deployment

juice49 added a commit that referenced this pull request Apr 13, 2025

feat(types): add Media Library asset aspect types (#9146)

ca0e762

juice49 force-pushed the feat/dam-410/media-library-types branch from 4e52dcb to ca0e762 Compare April 13, 2025 18:22

vercel bot deployed to Preview – performance-studio April 13, 2025 18:28 View deployment

vercel bot deployed to Preview – page-building-studio April 13, 2025 18:28 View deployment

vercel bot deployed to Preview – test-studio April 13, 2025 18:29 View deployment

juice49 requested review from sjelfull and sgulseth April 14, 2025 08:46

sgulseth previously approved these changes Apr 14, 2025

View reviewed changes

juice49 added a commit that referenced this pull request Apr 14, 2025

feat(types): add Media Library asset aspect types (#9146)

7f4b7f4

juice49 dismissed sgulseth’s stale review via 7f4b7f4 April 14, 2025 09:02

juice49 force-pushed the feat/dam-410/media-library-types branch from ca0e762 to 7f4b7f4 Compare April 14, 2025 09:02

juice49 requested a review from sgulseth April 14, 2025 09:02

sgulseth approved these changes Apr 14, 2025

View reviewed changes

vercel bot deployed to Preview – performance-studio April 14, 2025 09:07 View deployment

vercel bot deployed to Preview – page-building-studio April 14, 2025 09:08 View deployment

vercel bot deployed to Preview – test-studio April 14, 2025 09:09 View deployment

juice49 requested a review from jordanl17 April 15, 2025 08:12

feat(types): add Media Library asset aspect types (#9146)

5966f1a

juice49 force-pushed the feat/dam-410/media-library-types branch from 7f4b7f4 to 5966f1a Compare April 15, 2025 09:11

vercel bot deployed to Preview – page-building-studio April 15, 2025 09:17 View deployment

vercel bot deployed to Preview – performance-studio April 15, 2025 09:18 View deployment

vercel bot deployed to Preview – test-studio April 15, 2025 09:18 View deployment

juice49 merged commit 1e99f49 into main Apr 15, 2025
64 checks passed

juice49 deleted the feat/dam-410/media-library-types branch April 15, 2025 09:35

jordanl17 pushed a commit that referenced this pull request Apr 15, 2025

feat(types): add Media Library asset aspect types (#9146)

09e43c2

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(types): add Media Library asset aspect types #9146

feat(types): add Media Library asset aspect types #9146

juice49 commented Apr 5, 2025 •

edited

Loading

vercel bot commented Apr 5, 2025 •

edited

Loading

github-actions bot commented Apr 5, 2025

github-actions bot commented Apr 5, 2025 •

edited

Loading

github-actions bot commented Apr 5, 2025 •

edited

Loading

🏠 Reference result

🧪 Experiment result

📚 Glossary

column definitions

github-actions bot commented Apr 5, 2025 •

edited

Loading

juice49 commented Apr 5, 2025 •

edited

Loading

sgulseth left a comment

sgulseth Apr 14, 2025

github-actions bot commented Apr 15, 2025

feat(types): add Media Library asset aspect types #9146

feat(types): add Media Library asset aspect types #9146

Conversation

juice49 commented Apr 5, 2025 • edited Loading

Description

What to review

Testing

vercel bot commented Apr 5, 2025 • edited Loading

github-actions bot commented Apr 5, 2025

github-actions bot commented Apr 5, 2025 • edited Loading

Coverage Report

github-actions bot commented Apr 5, 2025 • edited Loading

⚡️ Editor Performance Report

🏠 Reference result

🧪 Experiment result

📚 Glossary

column definitions

github-actions bot commented Apr 5, 2025 • edited Loading

📊 Playwright Test Report

juice49 commented Apr 5, 2025 • edited Loading

sgulseth left a comment

Choose a reason for hiding this comment

sgulseth Apr 14, 2025

Choose a reason for hiding this comment

github-actions bot commented Apr 15, 2025

🧪 E2E Preview environment

juice49 commented Apr 5, 2025 •

edited

Loading

vercel bot commented Apr 5, 2025 •

edited

Loading

github-actions bot commented Apr 5, 2025 •

edited

Loading

github-actions bot commented Apr 5, 2025 •

edited

Loading

github-actions bot commented Apr 5, 2025 •

edited

Loading

juice49 commented Apr 5, 2025 •

edited

Loading