@vcp-dev/contracts 0.6.11 → 0.7.0

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 (70) hide show
  1. package/README.md +5 -4
  2. package/dist/business-facts.d.ts +23 -0
  3. package/dist/cms-page-directory.d.ts +40 -4
  4. package/dist/colorway-distinctness.js +1 -1
  5. package/dist/connect-dynamic-collection.d.ts +6 -6
  6. package/dist/connect-form.d.ts +6 -6
  7. package/dist/conversion-hints.d.ts +37 -0
  8. package/dist/crawler-task-service.d.ts +244 -2
  9. package/dist/custom-domain.d.ts +119 -239
  10. package/dist/customer-materials.d.ts +5 -5
  11. package/dist/deployment-lifecycle.d.ts +45 -0
  12. package/dist/design-tokens.d.ts +1 -0
  13. package/dist/design-tokens.js +1 -1
  14. package/dist/e2b-preview-proxy.d.ts +5 -0
  15. package/dist/external-site-edit.d.ts +9 -0
  16. package/dist/firecrawl-internal.d.ts +19 -0
  17. package/dist/font-catalog.d.ts +5 -2
  18. package/dist/form-design.d.ts +54 -12
  19. package/dist/google-search-console.d.ts +1 -0
  20. package/dist/index.d.ts +3095 -818
  21. package/dist/index.js +1 -1
  22. package/dist/industry-classification.d.ts +43 -0
  23. package/dist/input-context-bundle.d.ts +10 -0
  24. package/dist/internal-entity-id.d.ts +1 -0
  25. package/dist/knowledge-category.d.ts +20 -0
  26. package/dist/knowledge-source-readiness.d.ts +94 -0
  27. package/dist/launcher-prompt-templates.d.ts +117 -14
  28. package/dist/migration-products.d.ts +45 -0
  29. package/dist/page-slug.d.ts +2 -0
  30. package/dist/page-template.d.ts +95 -0
  31. package/dist/site-build.d.ts +563 -0
  32. package/dist/site-design-presets.d.ts +20 -0
  33. package/dist/site-edit-capability.d.ts +13 -1
  34. package/dist/site-edit-class-name-source.d.ts +40 -8
  35. package/dist/site-edit-command-result.d.ts +15 -4
  36. package/dist/site-edit-composition.d.ts +13 -0
  37. package/dist/site-edit-event.d.ts +68 -14
  38. package/dist/site-edit-history-status.d.ts +193 -0
  39. package/dist/site-edit-operation.d.ts +152 -51
  40. package/dist/site-edit-page-composition.d.ts +101 -22
  41. package/dist/site-edit-patch-plan.d.ts +49 -3
  42. package/dist/site-edit-render-document.d.ts +54 -8
  43. package/dist/site-edit-session.d.ts +5 -2
  44. package/dist/site-edit-source.d.ts +60 -11
  45. package/dist/site-edit-version.d.ts +1 -1
  46. package/dist/site-extra-requirement.d.ts +31 -0
  47. package/dist/site-locale.d.ts +20 -0
  48. package/dist/site-localization-fields.d.ts +196 -0
  49. package/dist/site-localization-scope.d.ts +95 -0
  50. package/dist/site-preview.d.ts +15 -0
  51. package/dist/site-publish-domain.d.ts +680 -0
  52. package/dist/site-publish-workflow.d.ts +612 -0
  53. package/dist/site-workflow-completions.d.ts +163 -0
  54. package/dist/site-workflow.d.ts +231 -211
  55. package/dist/sitemap-navigation.d.ts +4 -1
  56. package/dist/step2-page-selection.d.ts +88 -0
  57. package/dist/step2-site-initialization.d.ts +321 -30
  58. package/dist/step3-digital-employee-analysis.d.ts +177 -211
  59. package/dist/step4-diagnosis.d.ts +72 -4
  60. package/dist/step5-strategy.d.ts +5549 -170
  61. package/dist/step6-design.d.ts +778 -464
  62. package/dist/subsite-localization-input.d.ts +121 -0
  63. package/dist/subsite-mount-path.d.ts +23 -0
  64. package/dist/subsite-visible-text-export.d.ts +22 -0
  65. package/dist/template-upgrade-observability.d.ts +2 -2
  66. package/dist/theme-presets.d.ts +56 -1
  67. package/dist/workspace-design-apply.d.ts +5 -0
  68. package/dist/workspace-resource-operation.d.ts +58 -24
  69. package/package.json +1 -1
  70. package/dist/publish-quality.d.ts +0 -92
@@ -24,6 +24,7 @@ export declare const FirecrawlCrawlCreateRequestSchema: z.ZodObject<{
24
24
  limit: z.ZodNumber;
25
25
  max_discovery_depth: z.ZodLiteral<1>;
26
26
  crawl_entire_domain: z.ZodLiteral<false>;
27
+ allow_subdomains: z.ZodLiteral<true>;
27
28
  sitemap: z.ZodLiteral<"skip">;
28
29
  }, z.core.$strict>;
29
30
  export declare const FirecrawlCrawlCreatedResponseSchema: z.ZodObject<{
@@ -41,6 +42,22 @@ export declare const FirecrawlCrawlStatusResponseSchema: z.ZodObject<{
41
42
  next: z.ZodOptional<z.ZodString>;
42
43
  expires_at: z.ZodString;
43
44
  }, z.core.$strict>;
45
+ /**
46
+ * 单页同步抓取:给只要一份完整 DOM、不需要异步批次的调用方用。
47
+ * formats 与 only_main_content 都锁死,避免这个端点漂成通用抓取入口——
48
+ * 正文提取会丢掉 meta、form、script,而那正是调用方要的东西。
49
+ */
50
+ export declare const FirecrawlScrapeRequestSchema: z.ZodObject<{
51
+ url: z.ZodString;
52
+ formats: z.ZodTuple<[z.ZodLiteral<"rawHtml">], null>;
53
+ only_main_content: z.ZodLiteral<false>;
54
+ max_age: z.ZodNumber;
55
+ }, z.core.$strict>;
56
+ export declare const FirecrawlScrapeResponseSchema: z.ZodObject<{
57
+ url: z.ZodString;
58
+ raw_html: z.ZodString;
59
+ status_code: z.ZodNullable<z.ZodNumber>;
60
+ }, z.core.$strict>;
44
61
  export declare const FirecrawlBatchCreateRequestSchema: z.ZodObject<{
45
62
  urls: z.ZodArray<z.ZodString>;
46
63
  formats: z.ZodTuple<[z.ZodLiteral<"rawHtml">], null>;
@@ -94,6 +111,8 @@ export type FirecrawlMapResponse = z.infer<typeof FirecrawlMapResponseSchema>;
94
111
  export type FirecrawlCrawlCreateRequest = z.infer<typeof FirecrawlCrawlCreateRequestSchema>;
95
112
  export type FirecrawlCrawlCreatedResponse = z.infer<typeof FirecrawlCrawlCreatedResponseSchema>;
96
113
  export type FirecrawlCrawlStatusResponse = z.infer<typeof FirecrawlCrawlStatusResponseSchema>;
114
+ export type FirecrawlScrapeRequest = z.infer<typeof FirecrawlScrapeRequestSchema>;
115
+ export type FirecrawlScrapeResponse = z.infer<typeof FirecrawlScrapeResponseSchema>;
97
116
  export type FirecrawlBatchCreateRequest = z.infer<typeof FirecrawlBatchCreateRequestSchema>;
98
117
  export type FirecrawlBatchCreatedResponse = z.infer<typeof FirecrawlBatchCreatedResponseSchema>;
99
118
  export type FirecrawlBatchPage = z.infer<typeof FirecrawlBatchPageSchema>;
@@ -70,8 +70,8 @@ export declare function siteFontVariables(fonts?: {
70
70
  };
71
71
  /** A curated heading/body pairing surfaced by the workspace design panel. */
72
72
  export interface FontPairing {
73
- /** Stable kebab-case id persisted nowhere; used for UI selection state. */
74
- id: string;
73
+ /** Stable kebab-case id persisted by Step6 and reused by the design panel. */
74
+ id: FontPairingId;
75
75
  /** Display name key into NEXT_FONT_REGISTRY. */
76
76
  heading: string;
77
77
  /** Display name key into NEXT_FONT_REGISTRY. */
@@ -82,4 +82,7 @@ export interface FontPairing {
82
82
  * NEXT_FONT_REGISTRY display-name key (enforced by font-catalog.test.ts).
83
83
  * CJK pairings stay system-stack only (`download: false` entries).
84
84
  */
85
+ export declare const FONT_PAIRING_IDS: readonly ["archivo-inter", "playfair-source-sans", "space-grotesk-manrope", "fraunces-libre-franklin", "noto-serif-sc-noto-sans-sc", "noto-sans-sc"];
86
+ export type FontPairingId = (typeof FONT_PAIRING_IDS)[number];
85
87
  export declare const FONT_PAIRINGS: readonly FontPairing[];
88
+ export declare function getFontPairing(id: FontPairingId): FontPairing;
@@ -31,8 +31,8 @@ export declare const FormSpecFieldNodeSchema: z.ZodObject<{
31
31
  boolean: "boolean";
32
32
  date: "date";
33
33
  file: "file";
34
- email: "email";
35
34
  text: "text";
35
+ email: "email";
36
36
  select: "select";
37
37
  multiselect: "multiselect";
38
38
  textarea: "textarea";
@@ -66,8 +66,8 @@ export declare const FormSpecNodeSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
66
66
  boolean: "boolean";
67
67
  date: "date";
68
68
  file: "file";
69
- email: "email";
70
69
  text: "text";
70
+ email: "email";
71
71
  select: "select";
72
72
  multiselect: "multiselect";
73
73
  textarea: "textarea";
@@ -221,8 +221,8 @@ export declare const FormSpecV1Schema: z.ZodObject<{
221
221
  boolean: "boolean";
222
222
  date: "date";
223
223
  file: "file";
224
- email: "email";
225
224
  text: "text";
225
+ email: "email";
226
226
  select: "select";
227
227
  multiselect: "multiselect";
228
228
  textarea: "textarea";
@@ -259,8 +259,8 @@ export declare const FormSpecV1Schema: z.ZodObject<{
259
259
  boolean: "boolean";
260
260
  date: "date";
261
261
  file: "file";
262
- email: "email";
263
262
  text: "text";
263
+ email: "email";
264
264
  select: "select";
265
265
  multiselect: "multiselect";
266
266
  textarea: "textarea";
@@ -281,6 +281,48 @@ export declare const FormSpecV1Schema: z.ZodObject<{
281
281
  }, z.core.$strict>;
282
282
  }, z.core.$strict>;
283
283
  export type FormSpecV1 = z.infer<typeof FormSpecV1Schema>;
284
+ /**
285
+ * The FORM_SPEC field paths that carry visitor-facing prose, written with `*`
286
+ * for every array index. This is the single source of truth shared by the
287
+ * generator (which writes the spec) and by any consumer that rewrites text in
288
+ * a generated site — subsite content localization is the first such consumer.
289
+ *
290
+ * It is a whitelist on purpose. A generated `form-*.spec.ts` is a mixed file:
291
+ * most of it is machine values that must survive byte-for-byte, and only these
292
+ * three families are prose. Two of the machine values fail *silently* when
293
+ * rewritten, which is why neither file-level exclusion nor a field-name
294
+ * denylist is good enough here:
295
+ *
296
+ * - `binding.form_code` is the CMS form binding code. Rewrite it and the form
297
+ * still renders, still validates and still submits — into nothing. There is
298
+ * no build error and no runtime error, only submissions that stop arriving.
299
+ * - `content_locale` is the locale tag the runtime resolves template copy
300
+ * against. It must be set deterministically by whoever owns the locale
301
+ * decision, never derived from a translated string.
302
+ *
303
+ * The three families below match the per-locale text that
304
+ * `FormTemplateV1Schema` already carries in the template catalog
305
+ * (`copy.*`, field labels, option labels): the spec is where a template lands
306
+ * after it is instantiated, so the same three families stay translatable and
307
+ * everything else stays machine-owned. `retired.*.last_label` is deliberately
308
+ * excluded — those are bookkeeping copies used to match already-retired fields
309
+ * and options, never rendered.
310
+ *
311
+ * The list is kept honest by an exhaustiveness test that enumerates every
312
+ * string-typed leaf of `FormSpecV1Schema`: adding a string field to the schema
313
+ * fails that test until the new field is classified as prose or machine, so
314
+ * the list cannot silently drift away from the schema it describes.
315
+ */
316
+ export declare const FORM_SPEC_LOCALIZABLE_FIELD_PATHS: readonly ["copy.title", "copy.description", "copy.submit_button", "copy.success_message", "copy.error_message", "nodes.*.label", "nodes.*.options.*.label"];
317
+ export type FormSpecLocalizableFieldPath = (typeof FORM_SPEC_LOCALIZABLE_FIELD_PATHS)[number];
318
+ /**
319
+ * Normalizes one concrete FORM_SPEC field path (array indices as numbers or
320
+ * digit strings) and looks it up in {@link FORM_SPEC_LOCALIZABLE_FIELD_PATHS}.
321
+ *
322
+ * Fails closed: anything the list does not name — including paths from a spec
323
+ * shape this contract does not know — is reported as not localizable.
324
+ */
325
+ export declare function isFormSpecLocalizableFieldPath(path: readonly (string | number)[]): boolean;
284
326
  export type FormSpecIdentityTransitionIssue = {
285
327
  code: "FIELD_IDENTITY_CHANGED";
286
328
  field_name: string;
@@ -697,8 +739,8 @@ export declare const FormTemplateV1Schema: z.ZodObject<{
697
739
  boolean: "boolean";
698
740
  date: "date";
699
741
  file: "file";
700
- email: "email";
701
742
  text: "text";
743
+ email: "email";
702
744
  select: "select";
703
745
  multiselect: "multiselect";
704
746
  textarea: "textarea";
@@ -1167,8 +1209,8 @@ export declare const FormTemplateCatalogResponseSchema: z.ZodObject<{
1167
1209
  boolean: "boolean";
1168
1210
  date: "date";
1169
1211
  file: "file";
1170
- email: "email";
1171
1212
  text: "text";
1213
+ email: "email";
1172
1214
  select: "select";
1173
1215
  multiselect: "multiselect";
1174
1216
  textarea: "textarea";
@@ -1644,8 +1686,8 @@ export declare const FormDesignOpenResponseSchema: z.ZodObject<{
1644
1686
  boolean: "boolean";
1645
1687
  date: "date";
1646
1688
  file: "file";
1647
- email: "email";
1648
1689
  text: "text";
1690
+ email: "email";
1649
1691
  select: "select";
1650
1692
  multiselect: "multiselect";
1651
1693
  textarea: "textarea";
@@ -1682,8 +1724,8 @@ export declare const FormDesignOpenResponseSchema: z.ZodObject<{
1682
1724
  boolean: "boolean";
1683
1725
  date: "date";
1684
1726
  file: "file";
1685
- email: "email";
1686
1727
  text: "text";
1728
+ email: "email";
1687
1729
  select: "select";
1688
1730
  multiselect: "multiselect";
1689
1731
  textarea: "textarea";
@@ -1874,8 +1916,8 @@ export declare const FormDesignSaveRequestSchema: z.ZodObject<{
1874
1916
  boolean: "boolean";
1875
1917
  date: "date";
1876
1918
  file: "file";
1877
- email: "email";
1878
1919
  text: "text";
1920
+ email: "email";
1879
1921
  select: "select";
1880
1922
  multiselect: "multiselect";
1881
1923
  textarea: "textarea";
@@ -1912,8 +1954,8 @@ export declare const FormDesignSaveRequestSchema: z.ZodObject<{
1912
1954
  boolean: "boolean";
1913
1955
  date: "date";
1914
1956
  file: "file";
1915
- email: "email";
1916
1957
  text: "text";
1958
+ email: "email";
1917
1959
  select: "select";
1918
1960
  multiselect: "multiselect";
1919
1961
  textarea: "textarea";
@@ -2639,8 +2681,8 @@ export declare const FormDesignOperationRecordSchema: z.ZodObject<{
2639
2681
  boolean: "boolean";
2640
2682
  date: "date";
2641
2683
  file: "file";
2642
- email: "email";
2643
2684
  text: "text";
2685
+ email: "email";
2644
2686
  select: "select";
2645
2687
  multiselect: "multiselect";
2646
2688
  textarea: "textarea";
@@ -2677,8 +2719,8 @@ export declare const FormDesignOperationRecordSchema: z.ZodObject<{
2677
2719
  boolean: "boolean";
2678
2720
  date: "date";
2679
2721
  file: "file";
2680
- email: "email";
2681
2722
  text: "text";
2723
+ email: "email";
2682
2724
  select: "select";
2683
2725
  multiselect: "multiselect";
2684
2726
  textarea: "textarea";
@@ -148,6 +148,7 @@ type LegacyGscStateInput = GscStateInput & {
148
148
  };
149
149
  export declare function deriveVcpGscState(input: GscStateInput, currentDomain: string | null | undefined): VcpGscState;
150
150
  export declare function deriveVcpGscState(input: LegacyGscStateInput): VcpGscState;
151
+ export declare function doesGscPropertyMatchDomain(gscSiteUrl: string | null | undefined, propertyType: GscPropertyType | null | undefined, currentDomain: string | null | undefined): boolean;
151
152
  export declare const GscAuthStartRequestSchema: z.ZodObject<{}, z.core.$strict>;
152
153
  export type GscAuthStartRequest = StartGscAuthRequest;
153
154
  export declare const GscAuthStartDataSchema: z.ZodObject<{