@usgb/forms 1.0.5 → 1.0.6
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.
- package/README.md +22 -7
- package/dist/{forms-manifest.1.0.5.json → forms-manifest.1.0.6.json} +2 -2
- package/dist/forms-manifest.json +2 -2
- package/dist/index.js +194 -186
- package/dist/src/contract/types.d.ts +4 -4
- package/dist/src/contract/types.d.ts.map +1 -1
- package/dist/src/definitions/consents.d.ts +28 -6
- package/dist/src/definitions/consents.d.ts.map +1 -1
- package/dist/src/form/useUsgbFormSession.d.ts.map +1 -1
- package/dist/{usgb-forms.1.0.5.js → usgb-forms.1.0.6.js} +10 -10
- package/dist/usgb-forms.js +10 -10
- package/forms-manifest.json +2 -2
- package/package.json +1 -1
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
export type HostId = 'pwa' | 'wordpress';
|
|
2
|
-
/**
|
|
3
|
-
export type ConsentPayload = Record<string, boolean | string>;
|
|
4
|
-
/** One submitted contact field, e.g. `{ name: 'email', value: 'a@b.com' }`. */
|
|
2
|
+
/** One submitted contact or consent field, e.g. `{ name: 'email', value: 'a@b.com' }`. */
|
|
5
3
|
export interface SubmissionField {
|
|
6
4
|
name: string;
|
|
7
5
|
value: string | boolean;
|
|
8
6
|
}
|
|
7
|
+
/** Consent fields in the same `{ name, value }` list shape as `data`. */
|
|
8
|
+
export type ConsentPayload = SubmissionField[];
|
|
9
9
|
export interface SubmissionPayload {
|
|
10
10
|
formId: string;
|
|
11
11
|
definitionVersion: string;
|
|
@@ -13,7 +13,7 @@ export interface SubmissionPayload {
|
|
|
13
13
|
idempotencyKey: string;
|
|
14
14
|
/** Contact fields in catalog order, one `{ name, value }` entry per field. */
|
|
15
15
|
data: SubmissionField[];
|
|
16
|
-
/** Grant, opt-in date, and language
|
|
16
|
+
/** Grant, opt-in date, and language entries for pinned policies. */
|
|
17
17
|
consents?: ConsentPayload;
|
|
18
18
|
}
|
|
19
19
|
export interface SubmitResult {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/contract/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,MAAM,GAAG,KAAK,GAAG,WAAW,CAAA;AAExC,
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/contract/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,MAAM,GAAG,KAAK,GAAG,WAAW,CAAA;AAExC,0FAA0F;AAC1F,MAAM,WAAW,eAAe;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,GAAG,OAAO,CAAA;CAC1B;AAED,yEAAyE;AACzE,MAAM,MAAM,cAAc,GAAG,eAAe,EAAE,CAAA;AAE9C,MAAM,WAAW,iBAAiB;IAC9B,MAAM,EAAE,MAAM,CAAA;IACd,iBAAiB,EAAE,MAAM,CAAA;IACzB,yBAAyB,EAAE,MAAM,CAAA;IACjC,cAAc,EAAE,MAAM,CAAA;IACtB,8EAA8E;IAC9E,IAAI,EAAE,eAAe,EAAE,CAAA;IACvB,oEAAoE;IACpE,QAAQ,CAAC,EAAE,cAAc,CAAA;CAC5B;AAED,MAAM,WAAW,YAAY;IACzB,MAAM,EAAE,UAAU,GAAG,QAAQ,CAAA;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,yEAAyE;AACzE,MAAM,WAAW,SAAS;IACtB,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,oBAAoB,CAAC,EAAE,MAAM,CAAA;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAA;CACvB;AAED,MAAM,MAAM,WAAW,GAAG,MAAM,SAAS,CAAA;AAEzC;;;GAGG;AACH,eAAO,MAAM,eAAe;;;;;;;CAOoB,CAAA;AAEhD,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,eAAe,CAAC,CAAC,WAAW,CAAC,CAAA;AAEhE,iFAAiF;AACjF,eAAO,MAAM,cAAc,EAAE,SAO5B,CAAA;AAED,qGAAqG;AACrG,wBAAgB,mBAAmB,CAC/B,IAAI,EAAE,SAAS,GAAG,SAAS,EAC3B,QAAQ,EAAE,SAAS,WAAW,EAAE,GACjC,IAAI,IAAI,SAAS,CAEnB;AAED,MAAM,WAAW,WAAW;IACxB,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,uBAAuB;IACpC,MAAM,EAAE,OAAO,GAAG,WAAW,GAAG,SAAS,CAAA;IACzC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACtC;AAED,MAAM,WAAW,WAAW;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAA;IACzD,6CAA6C;IAC7C,eAAe,CAAC,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CAAA;IACvD,6CAA6C;IAC7C,eAAe,CAAC,CACZ,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC9B,OAAO,CAAC,uBAAuB,CAAC,CAAA;IACnC,gDAAgD;IAChD,UAAU,CAAC,CACP,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,iBAAiB,GAC3B,OAAO,CAAC,YAAY,CAAC,CAAA;CAC3B;AAED,MAAM,MAAM,cAAc,GAAG,UAAU,GAAG,SAAS,CAAA;AAEnD,wDAAwD;AACxD,MAAM,MAAM,WAAW,GAAG,OAAO,GAAG,OAAO,GAAG,SAAS,CAAA;AAEvD,MAAM,MAAM,kBAAkB,GACxB;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GAChC;IAAE,IAAI,EAAE,oBAAoB,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,EAAE,CAAA;CAAE,GAChE;IAAE,IAAI,EAAE,gBAAgB,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GAC1C;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,UAAU,CAAA;CAAE,GACvD;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,CAAA;AAE3D,MAAM,MAAM,aAAa,GAAG,CAAC,KAAK,EAAE,kBAAkB,KAAK,IAAI,CAAA"}
|
|
@@ -25,11 +25,19 @@ interface ConsentDefinitionBase {
|
|
|
25
25
|
export interface ConsentCheckboxDefinition extends ConsentDefinitionBase {
|
|
26
26
|
type: 'checkbox';
|
|
27
27
|
name: string;
|
|
28
|
-
/**
|
|
29
|
-
|
|
28
|
+
/**
|
|
29
|
+
* YYYY-MM-DD field sent only when this checkbox is checked
|
|
30
|
+
* (e.g. `tcpa_form_opt_in_date`). Omitted when unchecked.
|
|
31
|
+
*/
|
|
32
|
+
grantDateField: string;
|
|
30
33
|
}
|
|
31
34
|
export interface ConsentNoticeDefinition extends ConsentDefinitionBase {
|
|
32
35
|
type: 'notice';
|
|
36
|
+
/**
|
|
37
|
+
* YYYY-MM-DD field sent because submit is the acknowledgment
|
|
38
|
+
* (e.g. `tcpa_form_opt_in_date`). Notices have no grant flag.
|
|
39
|
+
*/
|
|
40
|
+
optInDateField: string;
|
|
33
41
|
}
|
|
34
42
|
/** One catalog policy = one checkbox or one notice. */
|
|
35
43
|
export type ConsentDefinition = ConsentCheckboxDefinition | ConsentNoticeDefinition;
|
|
@@ -64,20 +72,34 @@ export declare const LEAD_SMS: ConsentCheckboxDefinition;
|
|
|
64
72
|
*/
|
|
65
73
|
export declare const LEAD_TOSPP: ConsentCheckboxDefinition;
|
|
66
74
|
/**
|
|
67
|
-
* Clickwrap notice found on WordPress lead forms. It has no
|
|
68
|
-
*
|
|
75
|
+
* Clickwrap notice found on WordPress lead forms. It has no grant flag.
|
|
76
|
+
* Submitting the form is the acknowledgment: the payload sends
|
|
77
|
+
* `tcpa_consent_language` and `tcpa_form_opt_in_date`.
|
|
69
78
|
*/
|
|
70
79
|
export declare const LEAD_CLICKWRAP: ConsentNoticeDefinition;
|
|
71
80
|
/**
|
|
72
81
|
* lead-clickwrap v2 — submit notice covering terms, privacy, and text/call
|
|
73
|
-
* consent.
|
|
82
|
+
* consent. Records the shown copy as `tcpa_consent_language` and the submit
|
|
83
|
+
* date as `tcpa_form_opt_in_date` (same keys as v1). No grant flag.
|
|
84
|
+
* "Terms & Conditions" is the user agreement.
|
|
74
85
|
*/
|
|
75
86
|
export declare const LEAD_CLICKWRAP_V2: ConsentNoticeDefinition;
|
|
76
87
|
export declare const CONSENT_DEFINITIONS: Record<string, ConsentDefinition>;
|
|
77
88
|
export declare function getConsentDefinition(definitionId: string, definitionVersion: string): ConsentDefinition | undefined;
|
|
78
89
|
/** Resolve form recipe pins. `null` means a pin is missing from the catalog. */
|
|
79
90
|
export declare function resolveFormConsents(refs: FormConsentRef[] | undefined): FormConsent[] | null;
|
|
80
|
-
/**
|
|
91
|
+
/**
|
|
92
|
+
* Opt-in date as `YYYY-MM-DD`.
|
|
93
|
+
* Uses UTC. The timezone is not confirmed; UTC is the current choice.
|
|
94
|
+
*/
|
|
95
|
+
export declare function formatConsentOptInDate(now?: Date): string;
|
|
96
|
+
/**
|
|
97
|
+
* Consent fields for submit, in `{ name, value }` order.
|
|
98
|
+
* Each policy sends its displayed language.
|
|
99
|
+
* A checkbox also sends its grant flag (`true` or `false`).
|
|
100
|
+
* Its opt-in date is included only when that checkbox is checked.
|
|
101
|
+
* A notice sends its opt-in date and no grant flag, because submit is the acknowledgment.
|
|
102
|
+
*/
|
|
81
103
|
export declare function collectConsentPayload(consents: readonly FormConsent[], values: Record<string, string | boolean>, urls: LegalUrls, optInDate: string): ConsentPayload | undefined;
|
|
82
104
|
export declare function collectRequiredLegalUrls(consents: readonly ConsentDefinition[]): LegalUrlKey[];
|
|
83
105
|
export declare function isConsentCheckbox(consent: FormConsent): consent is FormConsentCheckbox;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"consents.d.ts","sourceRoot":"","sources":["../../../src/definitions/consents.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AACtC,OAAO,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAC/E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAE7C,qEAAqE;AACrE,MAAM,WAAW,gBAAgB;IAC7B,OAAO,EAAE,SAAS,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAA;CACnB;AAED;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,CAAC,CAAC,IAAI,EAAE,SAAS,KAAK,gBAAgB,CAAC,CAAA;AAE1E,UAAU,qBAAqB;IAC3B,YAAY,EAAE,MAAM,CAAA;IACpB,iBAAiB,EAAE,MAAM,CAAA;IACzB,wEAAwE;IACxE,iBAAiB,EAAE,WAAW,EAAE,CAAA;IAChC,2EAA2E;IAC3E,WAAW,EAAE,MAAM,CAAA;IACnB,gFAAgF;IAChF,IAAI,EAAE,WAAW,CAAA;CACpB;AAED,MAAM,WAAW,yBAA0B,SAAQ,qBAAqB;IACpE,IAAI,EAAE,UAAU,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ
|
|
1
|
+
{"version":3,"file":"consents.d.ts","sourceRoot":"","sources":["../../../src/definitions/consents.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AACtC,OAAO,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAC/E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAE7C,qEAAqE;AACrE,MAAM,WAAW,gBAAgB;IAC7B,OAAO,EAAE,SAAS,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAA;CACnB;AAED;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,CAAC,CAAC,IAAI,EAAE,SAAS,KAAK,gBAAgB,CAAC,CAAA;AAE1E,UAAU,qBAAqB;IAC3B,YAAY,EAAE,MAAM,CAAA;IACpB,iBAAiB,EAAE,MAAM,CAAA;IACzB,wEAAwE;IACxE,iBAAiB,EAAE,WAAW,EAAE,CAAA;IAChC,2EAA2E;IAC3E,WAAW,EAAE,MAAM,CAAA;IACnB,gFAAgF;IAChF,IAAI,EAAE,WAAW,CAAA;CACpB;AAED,MAAM,WAAW,yBAA0B,SAAQ,qBAAqB;IACpE,IAAI,EAAE,UAAU,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAA;CACzB;AAED,MAAM,WAAW,uBAAwB,SAAQ,qBAAqB;IAClE,IAAI,EAAE,QAAQ,CAAA;IACd;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAA;CACzB;AAED,uDAAuD;AACvD,MAAM,MAAM,iBAAiB,GACvB,yBAAyB,GACzB,uBAAuB,CAAA;AAE7B,0DAA0D;AAC1D,MAAM,MAAM,mBAAmB,GAAG,yBAAyB,GAAG;IAC1D,QAAQ,EAAE,OAAO,CAAA;CACpB,CAAA;AAED,yDAAyD;AACzD,MAAM,MAAM,WAAW,GAAG,mBAAmB,GAAG,uBAAuB,CAAA;AAEvE,wBAAgB,kBAAkB,CAC9B,IAAI,EAAE,WAAW,EACjB,IAAI,EAAE,SAAS,GAChB,gBAAgB,CAKlB;AA2CD;;;GAGG;AACH,eAAO,MAAM,SAAS,EAAE,yBASvB,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,YAAY,EAAE,yBAe1B,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,YAAY,EAAE,yBAe1B,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,QAAQ,EAAE,yBAStB,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,UAAU,EAAE,yBAexB,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,cAAc,EAAE,uBA0B5B,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,EAAE,uBAc/B,CAAA;AAaD,eAAO,MAAM,mBAAmB,mCAQ/B,CAAA;AAED,wBAAgB,oBAAoB,CAChC,YAAY,EAAE,MAAM,EACpB,iBAAiB,EAAE,MAAM,GAC1B,iBAAiB,GAAG,SAAS,CAE/B;AAED,gFAAgF;AAChF,wBAAgB,mBAAmB,CAC/B,IAAI,EAAE,cAAc,EAAE,GAAG,SAAS,GACnC,WAAW,EAAE,GAAG,IAAI,CAoBtB;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CAAC,GAAG,GAAE,IAAiB,GAAG,MAAM,CAErE;AAED;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CACjC,QAAQ,EAAE,SAAS,WAAW,EAAE,EAChC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,EACxC,IAAI,EAAE,SAAS,EACf,SAAS,EAAE,MAAM,GAClB,cAAc,GAAG,SAAS,CAmB5B;AAED,wBAAgB,wBAAwB,CACpC,QAAQ,EAAE,SAAS,iBAAiB,EAAE,GACvC,WAAW,EAAE,CAQf;AAED,wBAAgB,iBAAiB,CAC7B,OAAO,EAAE,WAAW,GACrB,OAAO,IAAI,mBAAmB,CAEhC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useUsgbFormSession.d.ts","sourceRoot":"","sources":["../../../src/form/useUsgbFormSession.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAA;AAC/C,OAAO,EAEH,KAAK,WAAW,EAChB,KAAK,eAAe,EACvB,MAAM,iBAAiB,CAAA;AACxB,OAAO,
|
|
1
|
+
{"version":3,"file":"useUsgbFormSession.d.ts","sourceRoot":"","sources":["../../../src/form/useUsgbFormSession.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAA;AAC/C,OAAO,EAEH,KAAK,WAAW,EAChB,KAAK,eAAe,EACvB,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAKH,KAAK,WAAW,EACnB,MAAM,yBAAyB,CAAA;AAGhC,OAAO,KAAK,EAAE,cAAc,EAAgB,MAAM,sBAAsB,CAAA;AAExE,OAAO,KAAK,EACR,aAAa,EACb,WAAW,EACX,SAAS,EAET,iBAAiB,EACpB,MAAM,mBAAmB,CAAA;AAE1B,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,CAAA;AAEzD,MAAM,MAAM,aAAa,GACnB;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAChB;IAAE,IAAI,EAAE,YAAY,CAAA;CAAE,GACtB;IAAE,IAAI,EAAE,UAAU,CAAA;CAAE,GACpB;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,CAAA;AAgB1C,iBAAS,kBAAkB,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAG9D;AAED,MAAM,WAAW,sBAAsB;IACnC,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,cAAc,CAAA;IAC1B,SAAS,CAAC,EAAE,SAAS,CAAA;IACrB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE,WAAW,CAAA;IACpB,SAAS,CAAC,EAAE,aAAa,CAAA;IACzB,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,IAAI,CAAA;IACjD,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,MAAM,KAAK,IAAI,CAAA;CACpE;AAED,MAAM,WAAW,eAAe;IAC5B,QAAQ,EAAE,eAAe,CAAC,UAAU,CAAC,CAAA;IACrC,MAAM,EAAE,WAAW,CAAC,UAAU,CAAC,CAAA;IAC/B,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChC,sFAAsF;IACtF,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACjC,WAAW,EAAE,WAAW,EAAE,CAAA;IAC1B,OAAO,EAAE,aAAa,CAAA;IACtB,QAAQ,EAAE,CAAC,KAAK,CAAC,EAAE,kBAAkB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;CAC1D;AAED,wBAAgB,kBAAkB,CAAC,EAC/B,MAAM,EACN,UAAU,EACV,SAAS,EACT,UAAU,EACV,OAAO,EACP,SAAS,EACT,UAAU,EACV,QAAQ,EACX,EAAE,sBAAsB,GAAG,eAAe,CAsJ1C;AAED,OAAO,EAAE,kBAAkB,EAAE,CAAA"}
|