@amplifyup/sdk 0.3.0 → 0.3.1-uat.105.g9d5f4eb

package/dist/index.d.mts

@@ -165,7 +165,12 @@ interface components {
             id: string;
             key: string;
             version: number;
+            title?: string;
+            intro?: string;
+            /** @description Every field, in order. Renderers that ignore `steps` show these on one page. */
             fields: components["schemas"]["FormField"][];
+            /** @description Headings, paragraphs and fields per step. Absent means one step with `fields` in order. */
+            steps?: components["schemas"]["FormStep"][];
             submit: components["schemas"]["FormSubmitSettings"];
             onSuccess: components["schemas"]["FormOnSuccess"];
             honeypot: components["schemas"]["FormHoneypot"];
@@ -177,27 +182,55 @@ interface components {
             label?: string;
             required?: boolean;
             placeholder?: string;
-            /** @description For `select`. */
+            /** @description For `select`, `radio` and `checkboxes`. */
             options?: components["schemas"]["FormFieldOption"][];
             /** @description Initial value; the posted value for `hidden`. */
             defaultValue?: string;
+            /** @description Half-width fields sit side by side on wide screens. Defaults to full. */
+            width?: components["schemas"]["FormFieldWidth"];
+            /** @description For `hidden`: filled from this parameter of the page URL, when present. */
+            fromQuery?: components["schemas"]["FormQueryParam"];
         };
         FormFieldOption: {
             label: string;
             value: string;
         };
         /**
-         * @description Delivery API for published forms, as the form packages see it. GET  /v1/forms/{formId}?trackingId=          → FormDefinition POST /v1/forms/{formId}/submit?trackingId=   → SubmitFormSuccess | 422 SubmitFormValidationError
+         * @description Delivery API for published forms, as the form packages see it. GET  /v1/forms/{formId}?trackingId=          → FormDefinition POST /v1/forms/{formId}/submit?trackingId=   → SubmitFormSuccess | 422 SubmitFormValidationError   Optional header `x-amplifyup-consent: granted | denied` — what the site's consent banner reported.
          *
          *     Source of truth for `openapi/delivery.json` (scripts/generate-openapi.mjs). Never carries mapping metadata: what a submission writes to is platform-only.
          * @enum {string}
          */
-        FormFieldType: "text" | "email" | "phone" | "textarea" | "select" | "checkbox" | "hidden";
+        FormFieldType: "text" | "email" | "phone" | "number" | "date" | "textarea" | "select" | "radio" | "checkboxes" | "checkbox" | "consent" | "hidden";
+        /** @enum {string} */
+        FormFieldWidth: "full" | "half";
         FormHoneypot: {
             /** @description Field name to post empty; bots that fill it are dropped. */
             name: string;
         };
         FormOnSuccess: components["schemas"]["FormSuccessMessage"] | components["schemas"]["FormSuccessRedirect"];
+        /**
+         * @description UTM parameters a hidden field can be filled from.
+         * @enum {string}
+         */
+        FormQueryParam: "utm_source" | "utm_medium" | "utm_campaign" | "utm_term" | "utm_content";
+        /** @description One page of a multi-step form, in display order. */
+        FormStep: {
+            title?: string;
+            items: components["schemas"]["FormStepItem"][];
+        };
+        FormStepField: {
+            /** @constant */
+            kind: "field";
+            /** @description A key in `fields`. */
+            key: string;
+        };
+        FormStepItem: components["schemas"]["FormStepField"] | components["schemas"]["FormStepText"];
+        FormStepText: {
+            /** @enum {string} */
+            kind: "heading" | "paragraph";
+            text: string;
+        };
         FormSubmitSettings: {
             label: string;
         };
@@ -211,12 +244,15 @@ interface components {
             type: "redirect";
             url: string;
         };
-        FormValue: string | boolean;
+        /** @description Text for most fields, true/false for `checkbox` and `consent`, the chosen values for `checkboxes`. */
+        FormValue: string | boolean | string[];
         SubmitFormRequest: {
             /** @description Field values by key, including the honeypot key. */
             values: {
                 [key: string]: components["schemas"]["FormValue"];
             };
+            /** @description The page the form was on. Only its path and UTM parameters are kept. */
+            page?: string;
         };
         SubmitFormSuccess: {
             onSuccess: components["schemas"]["FormOnSuccess"];
@@ -351,9 +387,23 @@ declare const getFormDefinition: (formId: string, options?: FormRequestOptions)
 /**
  * Submit a form. Field errors (422) come back as `{ ok: false, errors }`;
  * anything else that fails throws. Never submits from a Composer preview.
+ * Sends the visitor's consent (see `setConsent`) and the page it was on;
+ * only the page's path and UTM parameters are kept.
  */
 declare const submitForm: (formId: string, values: FormValues, options?: FormRequestOptions) => Promise<SubmitFormResult>;
 
+/**
+ * What the site's consent banner reported for this visitor. Amplify UP sends
+ * it with form submissions; without it, answers are kept only if the site is
+ * set to treat visitors who haven't chosen as agreed.
+ *
+ * Call `setConsent('granted')` or `setConsent('denied')` whenever your banner
+ * learns the visitor's choice, and `setConsent(null)` to forget it.
+ */
+type ConsentState = 'granted' | 'denied';
+declare function setConsent(state: ConsentState | null): void;
+declare function getConsent(): ConsentState | null;
+
 /**
  * Map Edge /v1/resolve payload → PageConfig for AmplifyRenderer.
  * Prefers `tree` (full page skeleton with zones spliced in); falls back to
@@ -829,4 +879,4 @@ declare const verifyAWSConnection: () => {
 
 declare const _default: AmplifyUpSDK;
 
-export { ANON_COOKIE_NAME, AmplifyContentMeta, AmplifyPageContextInput, AmplifyUpConfig, AmplifyUpSDK, AmplifyUpTarget, CDPAdapter, ContentSource, DWELL_ACTIVITY_IDLE_MS, DeliveryRequestError, EdgeResolveError, EventProperties, EventTrackingConfig$1 as EventTrackingConfig, type FetchContentOptions, type FetchContentResult, type FormDefinition, type FormField, type FormFieldOption, type FormFieldType, type FormOnSuccess, type FormValue, type FormValues, IdentifyInput, IdentifyTraits, PageConfig, PageDataSnapshot, PageTaxonomies, ProfileFieldsInput, SESSION_COOKIE_NAME, SESSION_IDLE_GAP_MS, type SubmitFormResult, buildLayoutProviderUrl, buildPageRenderUrl, cleanupEventTracking, _default as default, fetchContent, fetchEdgeResolve, fetchPageConfig, getDiagnostics, getFormDefinition, getInstanceId, getOrchestratorUrl, getSDK, getSessionId, getStatus, getTarget, getTrackingId, getUserId, identify, init, mapResolvedToPageConfig, normalizeRoute, page, refreshEventTracking, reset, routeChange, setProfileFields, setupComponentViewTracking, setupEventTracking, submitForm, testTracking, track, trackClick, trackContentEngagement, trackContentView, trackFormFieldInteraction, trackFormSubmit, verifyAWSConnection };
+export { ANON_COOKIE_NAME, AmplifyContentMeta, AmplifyPageContextInput, AmplifyUpConfig, AmplifyUpSDK, AmplifyUpTarget, CDPAdapter, type ConsentState, ContentSource, DWELL_ACTIVITY_IDLE_MS, DeliveryRequestError, EdgeResolveError, EventProperties, EventTrackingConfig$1 as EventTrackingConfig, type FetchContentOptions, type FetchContentResult, type FormDefinition, type FormField, type FormFieldOption, type FormFieldType, type FormOnSuccess, type FormValue, type FormValues, IdentifyInput, IdentifyTraits, PageConfig, PageDataSnapshot, PageTaxonomies, ProfileFieldsInput, SESSION_COOKIE_NAME, SESSION_IDLE_GAP_MS, type SubmitFormResult, buildLayoutProviderUrl, buildPageRenderUrl, cleanupEventTracking, _default as default, fetchContent, fetchEdgeResolve, fetchPageConfig, getConsent, getDiagnostics, getFormDefinition, getInstanceId, getOrchestratorUrl, getSDK, getSessionId, getStatus, getTarget, getTrackingId, getUserId, identify, init, mapResolvedToPageConfig, normalizeRoute, page, refreshEventTracking, reset, routeChange, setConsent, setProfileFields, setupComponentViewTracking, setupEventTracking, submitForm, testTracking, track, trackClick, trackContentEngagement, trackContentView, trackFormFieldInteraction, trackFormSubmit, verifyAWSConnection };

package/dist/index.d.ts

@@ -165,7 +165,12 @@ interface components {
             id: string;
             key: string;
             version: number;
+            title?: string;
+            intro?: string;
+            /** @description Every field, in order. Renderers that ignore `steps` show these on one page. */
             fields: components["schemas"]["FormField"][];
+            /** @description Headings, paragraphs and fields per step. Absent means one step with `fields` in order. */
+            steps?: components["schemas"]["FormStep"][];
             submit: components["schemas"]["FormSubmitSettings"];
             onSuccess: components["schemas"]["FormOnSuccess"];
             honeypot: components["schemas"]["FormHoneypot"];
@@ -177,27 +182,55 @@ interface components {
             label?: string;
             required?: boolean;
             placeholder?: string;
-            /** @description For `select`. */
+            /** @description For `select`, `radio` and `checkboxes`. */
             options?: components["schemas"]["FormFieldOption"][];
             /** @description Initial value; the posted value for `hidden`. */
             defaultValue?: string;
+            /** @description Half-width fields sit side by side on wide screens. Defaults to full. */
+            width?: components["schemas"]["FormFieldWidth"];
+            /** @description For `hidden`: filled from this parameter of the page URL, when present. */
+            fromQuery?: components["schemas"]["FormQueryParam"];
         };
         FormFieldOption: {
             label: string;
             value: string;
         };
         /**
-         * @description Delivery API for published forms, as the form packages see it. GET  /v1/forms/{formId}?trackingId=          → FormDefinition POST /v1/forms/{formId}/submit?trackingId=   → SubmitFormSuccess | 422 SubmitFormValidationError
+         * @description Delivery API for published forms, as the form packages see it. GET  /v1/forms/{formId}?trackingId=          → FormDefinition POST /v1/forms/{formId}/submit?trackingId=   → SubmitFormSuccess | 422 SubmitFormValidationError   Optional header `x-amplifyup-consent: granted | denied` — what the site's consent banner reported.
          *
          *     Source of truth for `openapi/delivery.json` (scripts/generate-openapi.mjs). Never carries mapping metadata: what a submission writes to is platform-only.
          * @enum {string}
          */
-        FormFieldType: "text" | "email" | "phone" | "textarea" | "select" | "checkbox" | "hidden";
+        FormFieldType: "text" | "email" | "phone" | "number" | "date" | "textarea" | "select" | "radio" | "checkboxes" | "checkbox" | "consent" | "hidden";
+        /** @enum {string} */
+        FormFieldWidth: "full" | "half";
         FormHoneypot: {
             /** @description Field name to post empty; bots that fill it are dropped. */
             name: string;
         };
         FormOnSuccess: components["schemas"]["FormSuccessMessage"] | components["schemas"]["FormSuccessRedirect"];
+        /**
+         * @description UTM parameters a hidden field can be filled from.
+         * @enum {string}
+         */
+        FormQueryParam: "utm_source" | "utm_medium" | "utm_campaign" | "utm_term" | "utm_content";
+        /** @description One page of a multi-step form, in display order. */
+        FormStep: {
+            title?: string;
+            items: components["schemas"]["FormStepItem"][];
+        };
+        FormStepField: {
+            /** @constant */
+            kind: "field";
+            /** @description A key in `fields`. */
+            key: string;
+        };
+        FormStepItem: components["schemas"]["FormStepField"] | components["schemas"]["FormStepText"];
+        FormStepText: {
+            /** @enum {string} */
+            kind: "heading" | "paragraph";
+            text: string;
+        };
         FormSubmitSettings: {
             label: string;
         };
@@ -211,12 +244,15 @@ interface components {
             type: "redirect";
             url: string;
         };
-        FormValue: string | boolean;
+        /** @description Text for most fields, true/false for `checkbox` and `consent`, the chosen values for `checkboxes`. */
+        FormValue: string | boolean | string[];
         SubmitFormRequest: {
             /** @description Field values by key, including the honeypot key. */
             values: {
                 [key: string]: components["schemas"]["FormValue"];
             };
+            /** @description The page the form was on. Only its path and UTM parameters are kept. */
+            page?: string;
         };
         SubmitFormSuccess: {
             onSuccess: components["schemas"]["FormOnSuccess"];
@@ -351,9 +387,23 @@ declare const getFormDefinition: (formId: string, options?: FormRequestOptions)
 /**
  * Submit a form. Field errors (422) come back as `{ ok: false, errors }`;
  * anything else that fails throws. Never submits from a Composer preview.
+ * Sends the visitor's consent (see `setConsent`) and the page it was on;
+ * only the page's path and UTM parameters are kept.
  */
 declare const submitForm: (formId: string, values: FormValues, options?: FormRequestOptions) => Promise<SubmitFormResult>;
 
+/**
+ * What the site's consent banner reported for this visitor. Amplify UP sends
+ * it with form submissions; without it, answers are kept only if the site is
+ * set to treat visitors who haven't chosen as agreed.
+ *
+ * Call `setConsent('granted')` or `setConsent('denied')` whenever your banner
+ * learns the visitor's choice, and `setConsent(null)` to forget it.
+ */
+type ConsentState = 'granted' | 'denied';
+declare function setConsent(state: ConsentState | null): void;
+declare function getConsent(): ConsentState | null;
+
 /**
  * Map Edge /v1/resolve payload → PageConfig for AmplifyRenderer.
  * Prefers `tree` (full page skeleton with zones spliced in); falls back to
@@ -829,4 +879,4 @@ declare const verifyAWSConnection: () => {
 
 declare const _default: AmplifyUpSDK;
 
-export { ANON_COOKIE_NAME, AmplifyContentMeta, AmplifyPageContextInput, AmplifyUpConfig, AmplifyUpSDK, AmplifyUpTarget, CDPAdapter, ContentSource, DWELL_ACTIVITY_IDLE_MS, DeliveryRequestError, EdgeResolveError, EventProperties, EventTrackingConfig$1 as EventTrackingConfig, type FetchContentOptions, type FetchContentResult, type FormDefinition, type FormField, type FormFieldOption, type FormFieldType, type FormOnSuccess, type FormValue, type FormValues, IdentifyInput, IdentifyTraits, PageConfig, PageDataSnapshot, PageTaxonomies, ProfileFieldsInput, SESSION_COOKIE_NAME, SESSION_IDLE_GAP_MS, type SubmitFormResult, buildLayoutProviderUrl, buildPageRenderUrl, cleanupEventTracking, _default as default, fetchContent, fetchEdgeResolve, fetchPageConfig, getDiagnostics, getFormDefinition, getInstanceId, getOrchestratorUrl, getSDK, getSessionId, getStatus, getTarget, getTrackingId, getUserId, identify, init, mapResolvedToPageConfig, normalizeRoute, page, refreshEventTracking, reset, routeChange, setProfileFields, setupComponentViewTracking, setupEventTracking, submitForm, testTracking, track, trackClick, trackContentEngagement, trackContentView, trackFormFieldInteraction, trackFormSubmit, verifyAWSConnection };
+export { ANON_COOKIE_NAME, AmplifyContentMeta, AmplifyPageContextInput, AmplifyUpConfig, AmplifyUpSDK, AmplifyUpTarget, CDPAdapter, type ConsentState, ContentSource, DWELL_ACTIVITY_IDLE_MS, DeliveryRequestError, EdgeResolveError, EventProperties, EventTrackingConfig$1 as EventTrackingConfig, type FetchContentOptions, type FetchContentResult, type FormDefinition, type FormField, type FormFieldOption, type FormFieldType, type FormOnSuccess, type FormValue, type FormValues, IdentifyInput, IdentifyTraits, PageConfig, PageDataSnapshot, PageTaxonomies, ProfileFieldsInput, SESSION_COOKIE_NAME, SESSION_IDLE_GAP_MS, type SubmitFormResult, buildLayoutProviderUrl, buildPageRenderUrl, cleanupEventTracking, _default as default, fetchContent, fetchEdgeResolve, fetchPageConfig, getConsent, getDiagnostics, getFormDefinition, getInstanceId, getOrchestratorUrl, getSDK, getSessionId, getStatus, getTarget, getTrackingId, getUserId, identify, init, mapResolvedToPageConfig, normalizeRoute, page, refreshEventTracking, reset, routeChange, setConsent, setProfileFields, setupComponentViewTracking, setupEventTracking, submitForm, testTracking, track, trackClick, trackContentEngagement, trackContentView, trackFormFieldInteraction, trackFormSubmit, verifyAWSConnection };

package/dist/index.js

@@ -1132,6 +1132,39 @@ async function fetchContent(options) {
   }
 }
 
+// src/consent.ts
+var STORAGE_KEY = "amplifyup_consent";
+var current = null;
+var loaded = false;
+function readStored() {
+  try {
+    const value = typeof window !== "undefined" ? window.localStorage.getItem(STORAGE_KEY) : null;
+    return value === "granted" || value === "denied" ? value : null;
+  } catch {
+    return null;
+  }
+}
+function writeStored(state) {
+  try {
+    if (typeof window === "undefined") return;
+    if (state) window.localStorage.setItem(STORAGE_KEY, state);
+    else window.localStorage.removeItem(STORAGE_KEY);
+  } catch {
+  }
+}
+function setConsent(state) {
+  current = state;
+  loaded = true;
+  writeStored(state);
+}
+function getConsent() {
+  if (!loaded) {
+    current = readStored();
+    loaded = true;
+  }
+  return current;
+}
+
 // src/delivery/forms.ts
 var DeliveryRequestError = class extends Error {
   constructor(message, status) {
@@ -1171,10 +1204,16 @@ var submitForm = async (formId, values, options = {}) => {
     throw new DeliveryRequestError("Forms do not submit in preview.", 0);
   }
   const fetchFn = options.fetch ?? globalThis.fetch.bind(globalThis);
+  const consent = getConsent();
+  const page2 = typeof window !== "undefined" ? window.location.href : void 0;
   const response = await fetchFn(formUrl(formId, "/submit"), {
     method: "POST",
-    headers: { Accept: "application/json", "Content-Type": "application/json" },
-    body: JSON.stringify({ values })
+    headers: {
+      Accept: "application/json",
+      "Content-Type": "application/json",
+      ...consent ? { "x-amplifyup-consent": consent } : {}
+    },
+    body: JSON.stringify({ values, page: page2 })
   });
   if (response.status === 422) {
     const body2 = await response.json();
@@ -3629,16 +3668,16 @@ Available Console Commands:
   }
   buildComponentHierarchy(element) {
     const hierarchy = [];
-    let current = element;
+    let current2 = element;
     let sawPageSlot = false;
-    while (current) {
-      if (current.hasAttribute("data-amplifyup-component") || current.hasAttribute("data-component-id") || current.hasAttribute("data-amplifyup-slot") || current.hasAttribute("data-slot-id") || current.hasAttribute("data-node-id") || current.hasAttribute("data-amplifyup-node")) {
-        hierarchy.push(current);
-        if (current.getAttribute("data-slot-source") === "page") {
+    while (current2) {
+      if (current2.hasAttribute("data-amplifyup-component") || current2.hasAttribute("data-component-id") || current2.hasAttribute("data-amplifyup-slot") || current2.hasAttribute("data-slot-id") || current2.hasAttribute("data-node-id") || current2.hasAttribute("data-amplifyup-node")) {
+        hierarchy.push(current2);
+        if (current2.getAttribute("data-slot-source") === "page") {
           sawPageSlot = true;
         }
       }
-      current = current.parentElement;
+      current2 = current2.parentElement;
     }
     const ordered = hierarchy.reverse();
     if (!sawPageSlot) {
@@ -3880,6 +3919,7 @@ exports.fetchEdgeQuery = fetchEdgeQuery;
 exports.fetchEdgeResolve = fetchEdgeResolve;
 exports.fetchEdgeSelect = fetchEdgeSelect;
 exports.fetchPageConfig = fetchPageConfig;
+exports.getConsent = getConsent;
 exports.getDiagnostics = getDiagnostics;
 exports.getFormDefinition = getFormDefinition;
 exports.getInstanceId = getInstanceId2;
@@ -3910,6 +3950,7 @@ exports.resolveAmplifyUpUrls = resolveAmplifyUpUrls;
 exports.routeChange = routeChange;
 exports.searchSpec = searchSpec;
 exports.selectVariants = selectVariants;
+exports.setConsent = setConsent;
 exports.setProfileFields = setProfileFields;
 exports.setupComponentViewTracking = setupComponentViewTracking;
 exports.setupEventTracking = setupEventTracking;