fix(structure): add opt out option from releases in DocumentPaneProvider

[pedrobonamin]

Description

Adds an option for the DocumentPaneProvider to opt out from checking the global release or version when determining the document id.
This is useful in cases where plugins need to use the DocumentPaneProvider but not have it checking for the global version, like in the case of sanity-assist which has a PaneProvider inside a inspector which allows you to edit a document that will give the actions to the assist ai

Updates the return type of the DocumentPaneValue and verifies that the value is correctly returned by the provider with the satisfies validation.

What to review

Is the new prop naming correct?

Testing

Notes for release

[vercel]

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	Jan 3, 2025 1:44pm
performance-studio	✅ Ready (Inspect)	Visit Preview		Jan 3, 2025 1:44pm
test-next-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 3, 2025 1:44pm
test-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 3, 2025 1:44pm

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
studio-workshop	⬜️ Ignored (Inspect)	Visit Preview		Jan 3, 2025 1:44pm

[github-actions]

No changes to documentation

[github-actions]

Component Testing Report Updated Jan 3, 2025 1:40 PM (UTC)

❌ Failed Tests (2) -- expand for details

File	Status	Duration	Passed	Skipped	Failed
comments/CommentInput.spec.tsx	✅ Passed (Inspect)	1m 5s	15	0	0
formBuilder/ArrayInput.spec.tsx	✅ Passed (Inspect)	12s	3	0	0
formBuilder/inputs/PortableText/Annotations.spec.tsx	✅ Passed (Inspect)	39s	6	0	0
formBuilder/inputs/PortableText/copyPaste/CopyPaste.spec.tsx	✅ Passed (Inspect)	51s	11	7	0
formBuilder/inputs/PortableText/copyPaste/CopyPasteFields.spec.tsx	✅ Passed (Inspect)	0s	0	12	0
formBuilder/inputs/PortableText/Decorators.spec.tsx	✅ Passed (Inspect)	26s	6	0	0
formBuilder/inputs/PortableText/DisableFocusAndUnset.spec.tsx	✅ Passed (Inspect)	14s	3	0	0
formBuilder/inputs/PortableText/DragAndDrop.spec.tsx	✅ Passed (Inspect)	27s	6	0	0
formBuilder/inputs/PortableText/FocusTracking.spec.tsx	✅ Passed (Inspect)	1m 8s	15	0	0
formBuilder/inputs/PortableText/Input.spec.tsx	✅ Passed (Inspect)	1m 29s	21	0	0
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx	❌ Failed (Inspect)	2m 19s	17	0	1
formBuilder/inputs/PortableText/PresenceCursors.spec.tsx	✅ Passed (Inspect)	13s	3	9	0
formBuilder/inputs/PortableText/Styles.spec.tsx	✅ Passed (Inspect)	26s	6	0	0
formBuilder/inputs/PortableText/Toolbar.spec.tsx	❌ Failed (Inspect)	2m 23s	20	0	1
formBuilder/tree-editing/TreeEditing.spec.tsx	✅ Passed (Inspect)	0s	0	3	0
formBuilder/tree-editing/TreeEditingNestedObjects.spec.tsx	✅ Passed (Inspect)	0s	0	3	0

[github-actions]

⚡️ Editor Performance Report

Updated Fri, 03 Jan 2025 13:42:04 GMT

Benchmark	reference latency of sanity@latest	experiment latency of this branch	Δ (%) latency difference
article (title)	25.0 efps (40ms)	16.9 efps (59ms)	+19ms (+47.5%)	🔴
article (body)	53.3 efps (19ms)	67.6 efps (15ms)	-4ms (-21.1%)	✅
article (string inside object)	27.4 efps (37ms)	20.0 efps (50ms)	+14ms (+37.0%)	🔴
article (string inside array)	23.3 efps (43ms)	17.4 efps (58ms)	+15ms (+33.7%)	🔴
recipe (name)	52.6 efps (19ms)	31.3 efps (32ms)	+13ms (+68.4%)	🔴
recipe (description)	55.6 efps (18ms)	34.5 efps (29ms)	+11ms (+61.1%)	🔴
recipe (instructions)	99.9+ efps (6ms)	99.9+ efps (5ms)	-1ms (-/-%)	✅

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)	40ms	50ms	72ms	447ms	827ms	10.8s
article (body)	19ms	20ms	28ms	137ms	81ms	5.4s
article (string inside object)	37ms	39ms	45ms	118ms	145ms	6.7s
article (string inside array)	43ms	46ms	54ms	244ms	270ms	7.3s
recipe (name)	19ms	21ms	22ms	39ms	0ms	8.1s
recipe (description)	18ms	21ms	24ms	50ms	0ms	4.6s
recipe (instructions)	6ms	8ms	10ms	16ms	0ms	3.3s

🧪 Experiment result

The performance result of this branch

Benchmark	latency	p75	p90	p99	blocking time	test duration
article (title)	59ms	73ms	83ms	497ms	1448ms	31.0s
article (body)	15ms	18ms	20ms	77ms	96ms	4.9s
article (string inside object)	50ms	53ms	58ms	168ms	498ms	8.3s
article (string inside array)	58ms	63ms	72ms	129ms	928ms	8.6s
recipe (name)	32ms	35ms	41ms	62ms	0ms	8.4s
recipe (description)	29ms	30ms	35ms	55ms	22ms	5.7s
recipe (instructions)	5ms	7ms	8ms	31ms	0ms	3.0s

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