@vcp-dev/contracts 0.4.9 → 0.6.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (14) hide show
  1. package/dist/index.d.ts +39 -32
  2. package/dist/index.js +1 -1
  3. package/dist/site-edit-class-name-source.d.ts +3 -98
  4. package/dist/site-edit-event.d.ts +20 -2
  5. package/dist/site-edit-history-status.d.ts +120 -0
  6. package/dist/site-edit-materialization.d.ts +49 -0
  7. package/dist/site-edit-mutation-context.d.ts +24 -0
  8. package/dist/site-edit-operation.d.ts +465 -52
  9. package/dist/site-edit-page-composition.d.ts +971 -0
  10. package/dist/site-edit-render-document.d.ts +73 -138
  11. package/dist/site-edit-render-page-composition.d.ts +84 -0
  12. package/dist/site-edit-session.d.ts +15 -0
  13. package/dist/site-edit-version.d.ts +1 -1
  14. package/package.json +1 -1
package/dist/index.d.ts CHANGED
@@ -6,12 +6,18 @@ export * from "./site-edit-class-name-source.js";
6
6
  export * from "./site-edit-command-result.js";
7
7
  export * from "./site-edit-element-property.js";
8
8
  export * from "./site-edit-event.js";
9
+ export * from "./site-edit-history-status.js";
9
10
  export * from "./site-edit-identity.js";
11
+ export * from "./site-edit-materialization.js";
12
+ export * from "./site-edit-mutation-context.js";
10
13
  export * from "./site-edit-operation.js";
14
+ export * from "./site-edit-page-composition.js";
11
15
  export * from "./site-edit-patch-plan.js";
12
16
  export * from "./site-edit-repeat-instance-key.js";
13
17
  export * from "./site-edit-render-document.js";
18
+ export * from "./site-edit-render-page-composition.js";
14
19
  export * from "./site-edit-runtime-capability.js";
20
+ export * from "./site-edit-session.js";
15
21
  export * from "./site-edit-source.js";
16
22
  export * from "./user-facing-copy.js";
17
23
  export * from "./site-edit-version.js";
@@ -50,11 +56,11 @@ export declare const VisualHintsSchema: z.ZodObject<{
50
56
  dark: "dark";
51
57
  }>>;
52
58
  radius: z.ZodOptional<z.ZodEnum<{
59
+ none: "none";
53
60
  sm: "sm";
54
61
  md: "md";
55
62
  lg: "lg";
56
63
  xl: "xl";
57
- none: "none";
58
64
  }>>;
59
65
  density: z.ZodOptional<z.ZodEnum<{
60
66
  compact: "compact";
@@ -228,11 +234,11 @@ export declare const ClarifyQuestionOptionSchema: z.ZodObject<{
228
234
  dark: "dark";
229
235
  }>>;
230
236
  radius: z.ZodOptional<z.ZodEnum<{
237
+ none: "none";
231
238
  sm: "sm";
232
239
  md: "md";
233
240
  lg: "lg";
234
241
  xl: "xl";
235
- none: "none";
236
242
  }>>;
237
243
  density: z.ZodOptional<z.ZodEnum<{
238
244
  compact: "compact";
@@ -293,11 +299,11 @@ export declare const ClarifyQuestionSchema: z.ZodObject<{
293
299
  dark: "dark";
294
300
  }>>;
295
301
  radius: z.ZodOptional<z.ZodEnum<{
302
+ none: "none";
296
303
  sm: "sm";
297
304
  md: "md";
298
305
  lg: "lg";
299
306
  xl: "xl";
300
- none: "none";
301
307
  }>>;
302
308
  density: z.ZodOptional<z.ZodEnum<{
303
309
  compact: "compact";
@@ -395,11 +401,11 @@ export declare const ClarifyQuestionsSchema: z.ZodObject<{
395
401
  dark: "dark";
396
402
  }>>;
397
403
  radius: z.ZodOptional<z.ZodEnum<{
404
+ none: "none";
398
405
  sm: "sm";
399
406
  md: "md";
400
407
  lg: "lg";
401
408
  xl: "xl";
402
- none: "none";
403
409
  }>>;
404
410
  density: z.ZodOptional<z.ZodEnum<{
405
411
  compact: "compact";
@@ -2944,6 +2950,7 @@ export declare const PrepareVersionPreviewResponseSchema: z.ZodObject<{
2944
2950
  retryable: z.ZodOptional<z.ZodBoolean>;
2945
2951
  }, z.core.$strip>;
2946
2952
  export type PrepareVersionPreviewResponse = z.infer<typeof PrepareVersionPreviewResponseSchema>;
2953
+ export declare const DEPLOYMENT_ENTITLEMENT_REQUIRED_ERROR_CODE: "DEPLOYMENT_ENTITLEMENT_REQUIRED";
2947
2954
  export declare const DeploymentStatusSchema: z.ZodEnum<{
2948
2955
  queued: "queued";
2949
2956
  preparing_source: "preparing_source";
@@ -3476,11 +3483,11 @@ export declare const VisualThemeSchema: z.ZodObject<{
3476
3483
  dark: "dark";
3477
3484
  }>>;
3478
3485
  radius: z.ZodOptional<z.ZodEnum<{
3486
+ none: "none";
3479
3487
  sm: "sm";
3480
3488
  md: "md";
3481
3489
  lg: "lg";
3482
3490
  xl: "xl";
3483
- none: "none";
3484
3491
  }>>;
3485
3492
  density: z.ZodOptional<z.ZodEnum<{
3486
3493
  compact: "compact";
@@ -3658,11 +3665,11 @@ export declare const SiteDesignContextSchema: z.ZodObject<{
3658
3665
  dark: "dark";
3659
3666
  }>>;
3660
3667
  radius: z.ZodOptional<z.ZodEnum<{
3668
+ none: "none";
3661
3669
  sm: "sm";
3662
3670
  md: "md";
3663
3671
  lg: "lg";
3664
3672
  xl: "xl";
3665
- none: "none";
3666
3673
  }>>;
3667
3674
  imagePalette: z.ZodOptional<z.ZodObject<{
3668
3675
  background: z.ZodOptional<z.ZodString>;
@@ -3944,11 +3951,11 @@ export declare const DesignPlanSchema: z.ZodObject<{
3944
3951
  dark: "dark";
3945
3952
  }>>;
3946
3953
  radius: z.ZodOptional<z.ZodEnum<{
3954
+ none: "none";
3947
3955
  sm: "sm";
3948
3956
  md: "md";
3949
3957
  lg: "lg";
3950
3958
  xl: "xl";
3951
- none: "none";
3952
3959
  }>>;
3953
3960
  imagePalette: z.ZodOptional<z.ZodObject<{
3954
3961
  background: z.ZodOptional<z.ZodString>;
@@ -4075,11 +4082,11 @@ export declare const DesignPlanPatchSchema: z.ZodObject<{
4075
4082
  dark: "dark";
4076
4083
  }>>;
4077
4084
  radius: z.ZodOptional<z.ZodEnum<{
4085
+ none: "none";
4078
4086
  sm: "sm";
4079
4087
  md: "md";
4080
4088
  lg: "lg";
4081
4089
  xl: "xl";
4082
- none: "none";
4083
4090
  }>>;
4084
4091
  density: z.ZodEnum<{
4085
4092
  compact: "compact";
@@ -4361,11 +4368,11 @@ export declare const SitemapSchema: z.ZodObject<{
4361
4368
  dark: "dark";
4362
4369
  }>>;
4363
4370
  radius: z.ZodOptional<z.ZodEnum<{
4371
+ none: "none";
4364
4372
  sm: "sm";
4365
4373
  md: "md";
4366
4374
  lg: "lg";
4367
4375
  xl: "xl";
4368
- none: "none";
4369
4376
  }>>;
4370
4377
  density: z.ZodOptional<z.ZodEnum<{
4371
4378
  compact: "compact";
@@ -4686,11 +4693,11 @@ export declare const SitemapAnswerSchema: z.ZodObject<{
4686
4693
  dark: "dark";
4687
4694
  }>>;
4688
4695
  radius: z.ZodOptional<z.ZodEnum<{
4696
+ none: "none";
4689
4697
  sm: "sm";
4690
4698
  md: "md";
4691
4699
  lg: "lg";
4692
4700
  xl: "xl";
4693
- none: "none";
4694
4701
  }>>;
4695
4702
  density: z.ZodOptional<z.ZodEnum<{
4696
4703
  compact: "compact";
@@ -4756,11 +4763,11 @@ export declare const SitemapRunInputSchema: z.ZodObject<{
4756
4763
  dark: "dark";
4757
4764
  }>>;
4758
4765
  radius: z.ZodOptional<z.ZodEnum<{
4766
+ none: "none";
4759
4767
  sm: "sm";
4760
4768
  md: "md";
4761
4769
  lg: "lg";
4762
4770
  xl: "xl";
4763
- none: "none";
4764
4771
  }>>;
4765
4772
  density: z.ZodOptional<z.ZodEnum<{
4766
4773
  compact: "compact";
@@ -5171,11 +5178,11 @@ export declare const SitemapStreamEventSchema: z.ZodDiscriminatedUnion<[z.ZodObj
5171
5178
  dark: "dark";
5172
5179
  }>>;
5173
5180
  radius: z.ZodOptional<z.ZodEnum<{
5181
+ none: "none";
5174
5182
  sm: "sm";
5175
5183
  md: "md";
5176
5184
  lg: "lg";
5177
5185
  xl: "xl";
5178
- none: "none";
5179
5186
  }>>;
5180
5187
  density: z.ZodOptional<z.ZodEnum<{
5181
5188
  compact: "compact";
@@ -5352,11 +5359,11 @@ export declare const SitemapRecordSchema: z.ZodObject<{
5352
5359
  dark: "dark";
5353
5360
  }>>;
5354
5361
  radius: z.ZodOptional<z.ZodEnum<{
5362
+ none: "none";
5355
5363
  sm: "sm";
5356
5364
  md: "md";
5357
5365
  lg: "lg";
5358
5366
  xl: "xl";
5359
- none: "none";
5360
5367
  }>>;
5361
5368
  density: z.ZodOptional<z.ZodEnum<{
5362
5369
  compact: "compact";
@@ -5493,11 +5500,11 @@ export declare const PersistSiteSitemapRequestSchema: z.ZodObject<{
5493
5500
  dark: "dark";
5494
5501
  }>>;
5495
5502
  radius: z.ZodOptional<z.ZodEnum<{
5503
+ none: "none";
5496
5504
  sm: "sm";
5497
5505
  md: "md";
5498
5506
  lg: "lg";
5499
5507
  xl: "xl";
5500
- none: "none";
5501
5508
  }>>;
5502
5509
  density: z.ZodOptional<z.ZodEnum<{
5503
5510
  compact: "compact";
@@ -5851,11 +5858,11 @@ export declare const PersistSiteSitemapResponseSchema: z.ZodObject<{
5851
5858
  dark: "dark";
5852
5859
  }>>;
5853
5860
  radius: z.ZodOptional<z.ZodEnum<{
5861
+ none: "none";
5854
5862
  sm: "sm";
5855
5863
  md: "md";
5856
5864
  lg: "lg";
5857
5865
  xl: "xl";
5858
- none: "none";
5859
5866
  }>>;
5860
5867
  density: z.ZodOptional<z.ZodEnum<{
5861
5868
  compact: "compact";
@@ -5936,11 +5943,11 @@ export declare const ClarifySessionRecordSchema: z.ZodObject<{
5936
5943
  dark: "dark";
5937
5944
  }>>;
5938
5945
  radius: z.ZodOptional<z.ZodEnum<{
5946
+ none: "none";
5939
5947
  sm: "sm";
5940
5948
  md: "md";
5941
5949
  lg: "lg";
5942
5950
  xl: "xl";
5943
- none: "none";
5944
5951
  }>>;
5945
5952
  density: z.ZodOptional<z.ZodEnum<{
5946
5953
  compact: "compact";
@@ -6032,11 +6039,11 @@ export declare const ClarifySessionRecordSchema: z.ZodObject<{
6032
6039
  dark: "dark";
6033
6040
  }>>;
6034
6041
  radius: z.ZodOptional<z.ZodEnum<{
6042
+ none: "none";
6035
6043
  sm: "sm";
6036
6044
  md: "md";
6037
6045
  lg: "lg";
6038
6046
  xl: "xl";
6039
- none: "none";
6040
6047
  }>>;
6041
6048
  density: z.ZodOptional<z.ZodEnum<{
6042
6049
  compact: "compact";
@@ -6115,11 +6122,11 @@ export declare const PersistClarifyAnswersRequestSchema: z.ZodObject<{
6115
6122
  dark: "dark";
6116
6123
  }>>;
6117
6124
  radius: z.ZodOptional<z.ZodEnum<{
6125
+ none: "none";
6118
6126
  sm: "sm";
6119
6127
  md: "md";
6120
6128
  lg: "lg";
6121
6129
  xl: "xl";
6122
- none: "none";
6123
6130
  }>>;
6124
6131
  density: z.ZodOptional<z.ZodEnum<{
6125
6132
  compact: "compact";
@@ -6185,11 +6192,11 @@ export declare const PersistClarifyAnswersRequestSchema: z.ZodObject<{
6185
6192
  dark: "dark";
6186
6193
  }>>;
6187
6194
  radius: z.ZodOptional<z.ZodEnum<{
6195
+ none: "none";
6188
6196
  sm: "sm";
6189
6197
  md: "md";
6190
6198
  lg: "lg";
6191
6199
  xl: "xl";
6192
- none: "none";
6193
6200
  }>>;
6194
6201
  density: z.ZodOptional<z.ZodEnum<{
6195
6202
  compact: "compact";
@@ -6308,11 +6315,11 @@ export declare const PersistClarifyAnswersResponseSchema: z.ZodObject<{
6308
6315
  dark: "dark";
6309
6316
  }>>;
6310
6317
  radius: z.ZodOptional<z.ZodEnum<{
6318
+ none: "none";
6311
6319
  sm: "sm";
6312
6320
  md: "md";
6313
6321
  lg: "lg";
6314
6322
  xl: "xl";
6315
- none: "none";
6316
6323
  }>>;
6317
6324
  density: z.ZodOptional<z.ZodEnum<{
6318
6325
  compact: "compact";
@@ -6404,11 +6411,11 @@ export declare const PersistClarifyAnswersResponseSchema: z.ZodObject<{
6404
6411
  dark: "dark";
6405
6412
  }>>;
6406
6413
  radius: z.ZodOptional<z.ZodEnum<{
6414
+ none: "none";
6407
6415
  sm: "sm";
6408
6416
  md: "md";
6409
6417
  lg: "lg";
6410
6418
  xl: "xl";
6411
- none: "none";
6412
6419
  }>>;
6413
6420
  density: z.ZodOptional<z.ZodEnum<{
6414
6421
  compact: "compact";
@@ -6500,11 +6507,11 @@ export declare const UpdateClarifyArchetypeRequestSchema: z.ZodObject<{
6500
6507
  dark: "dark";
6501
6508
  }>>;
6502
6509
  radius: z.ZodOptional<z.ZodEnum<{
6510
+ none: "none";
6503
6511
  sm: "sm";
6504
6512
  md: "md";
6505
6513
  lg: "lg";
6506
6514
  xl: "xl";
6507
- none: "none";
6508
6515
  }>>;
6509
6516
  density: z.ZodOptional<z.ZodEnum<{
6510
6517
  compact: "compact";
@@ -6631,11 +6638,11 @@ export declare const DesignPlanRecordSchema: z.ZodObject<{
6631
6638
  dark: "dark";
6632
6639
  }>>;
6633
6640
  radius: z.ZodOptional<z.ZodEnum<{
6641
+ none: "none";
6634
6642
  sm: "sm";
6635
6643
  md: "md";
6636
6644
  lg: "lg";
6637
6645
  xl: "xl";
6638
- none: "none";
6639
6646
  }>>;
6640
6647
  imagePalette: z.ZodOptional<z.ZodObject<{
6641
6648
  background: z.ZodOptional<z.ZodString>;
@@ -6786,11 +6793,11 @@ export declare const PersistSiteDesignPlanRequestSchema: z.ZodObject<{
6786
6793
  dark: "dark";
6787
6794
  }>>;
6788
6795
  radius: z.ZodOptional<z.ZodEnum<{
6796
+ none: "none";
6789
6797
  sm: "sm";
6790
6798
  md: "md";
6791
6799
  lg: "lg";
6792
6800
  xl: "xl";
6793
- none: "none";
6794
6801
  }>>;
6795
6802
  imagePalette: z.ZodOptional<z.ZodObject<{
6796
6803
  background: z.ZodOptional<z.ZodString>;
@@ -6943,11 +6950,11 @@ export declare const PersistSiteDesignPlanResponseSchema: z.ZodObject<{
6943
6950
  dark: "dark";
6944
6951
  }>>;
6945
6952
  radius: z.ZodOptional<z.ZodEnum<{
6953
+ none: "none";
6946
6954
  sm: "sm";
6947
6955
  md: "md";
6948
6956
  lg: "lg";
6949
6957
  xl: "xl";
6950
- none: "none";
6951
6958
  }>>;
6952
6959
  imagePalette: z.ZodOptional<z.ZodObject<{
6953
6960
  background: z.ZodOptional<z.ZodString>;
@@ -7758,11 +7765,11 @@ export declare const AgentEventSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
7758
7765
  dark: "dark";
7759
7766
  }>>;
7760
7767
  radius: z.ZodOptional<z.ZodEnum<{
7768
+ none: "none";
7761
7769
  sm: "sm";
7762
7770
  md: "md";
7763
7771
  lg: "lg";
7764
7772
  xl: "xl";
7765
- none: "none";
7766
7773
  }>>;
7767
7774
  density: z.ZodOptional<z.ZodEnum<{
7768
7775
  compact: "compact";
@@ -8471,11 +8478,11 @@ export declare const AgentEventRecordSchema: z.ZodObject<{
8471
8478
  dark: "dark";
8472
8479
  }>>;
8473
8480
  radius: z.ZodOptional<z.ZodEnum<{
8481
+ none: "none";
8474
8482
  sm: "sm";
8475
8483
  md: "md";
8476
8484
  lg: "lg";
8477
8485
  xl: "xl";
8478
- none: "none";
8479
8486
  }>>;
8480
8487
  density: z.ZodOptional<z.ZodEnum<{
8481
8488
  compact: "compact";
@@ -9181,11 +9188,11 @@ export declare const AppendAgentEventRequestSchema: z.ZodObject<{
9181
9188
  dark: "dark";
9182
9189
  }>>;
9183
9190
  radius: z.ZodOptional<z.ZodEnum<{
9191
+ none: "none";
9184
9192
  sm: "sm";
9185
9193
  md: "md";
9186
9194
  lg: "lg";
9187
9195
  xl: "xl";
9188
- none: "none";
9189
9196
  }>>;
9190
9197
  density: z.ZodOptional<z.ZodEnum<{
9191
9198
  compact: "compact";
@@ -9930,11 +9937,11 @@ export declare const AppendAgentEventResponseSchema: z.ZodDiscriminatedUnion<[z.
9930
9937
  dark: "dark";
9931
9938
  }>>;
9932
9939
  radius: z.ZodOptional<z.ZodEnum<{
9940
+ none: "none";
9933
9941
  sm: "sm";
9934
9942
  md: "md";
9935
9943
  lg: "lg";
9936
9944
  xl: "xl";
9937
- none: "none";
9938
9945
  }>>;
9939
9946
  density: z.ZodOptional<z.ZodEnum<{
9940
9947
  compact: "compact";
@@ -10680,11 +10687,11 @@ export declare const AppendAgentEventResponseSchema: z.ZodDiscriminatedUnion<[z.
10680
10687
  dark: "dark";
10681
10688
  }>>;
10682
10689
  radius: z.ZodOptional<z.ZodEnum<{
10690
+ none: "none";
10683
10691
  sm: "sm";
10684
10692
  md: "md";
10685
10693
  lg: "lg";
10686
10694
  xl: "xl";
10687
- none: "none";
10688
10695
  }>>;
10689
10696
  density: z.ZodOptional<z.ZodEnum<{
10690
10697
  compact: "compact";
@@ -11398,11 +11405,11 @@ export declare const ListAgentEventsResponseSchema: z.ZodObject<{
11398
11405
  dark: "dark";
11399
11406
  }>>;
11400
11407
  radius: z.ZodOptional<z.ZodEnum<{
11408
+ none: "none";
11401
11409
  sm: "sm";
11402
11410
  md: "md";
11403
11411
  lg: "lg";
11404
11412
  xl: "xl";
11405
- none: "none";
11406
11413
  }>>;
11407
11414
  density: z.ZodOptional<z.ZodEnum<{
11408
11415
  compact: "compact";
@@ -12195,7 +12202,7 @@ export declare const REST_API_ENDPOINTS: readonly [{
12195
12202
  readonly status: "implemented";
12196
12203
  readonly request_body_schema: "CreateDeploymentRequestSchema";
12197
12204
  readonly response_schema: "CreateDeploymentResponseSchema";
12198
- readonly notes: readonly ["The API returns after creating the deployment record and queue job; worker-service claims deployment_jobs for build and Cloudflare publish."];
12205
+ readonly notes: readonly ["Before creating any deployment record or queue job, the API verifies the site's active subscription; an inactive subscription returns 403 DEPLOYMENT_ENTITLEMENT_REQUIRED, while an unavailable entitlement source prevents deployment creation.", "The API returns after creating the deployment record and queue job; worker-service claims deployment_jobs for build and Cloudflare publish."];
12199
12206
  }, {
12200
12207
  readonly method: "GET";
12201
12208
  readonly path: "/sites/:site_id/deployments/current";