@usgb/forms 1.0.4 → 1.0.5

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/README.md +41 -34
  2. package/dist/{forms-manifest.1.0.4.json → forms-manifest.1.0.5.json} +368 -25
  3. package/dist/forms-manifest.json +368 -25
  4. package/dist/index.js +293 -292
  5. package/dist/src/contract/types.d.ts +7 -1
  6. package/dist/src/contract/types.d.ts.map +1 -1
  7. package/dist/src/form/useUsgbFormSession.d.ts.map +1 -1
  8. package/dist/src/index.d.ts +1 -1
  9. package/dist/src/index.d.ts.map +1 -1
  10. package/dist/usgb-forms.1.0.5.js +44 -0
  11. package/dist/usgb-forms.js +11 -11
  12. package/forms-manifest.json +368 -25
  13. package/package.json +1 -1
  14. package/dist/usgb-forms.1.0.4.js +0 -44
package/forms-manifest.json CHANGED
@@ -240,7 +240,7 @@
240
240
  }
241
241
  },
242
242
  "forms": {
243
- "magento-fik": {
243
+ "magento-fik-10dlc": {
244
244
  "definitionVersion": "1",
245
245
  "kind": "lead",
246
246
  "flow": { "type": "single" },
@@ -269,7 +269,7 @@
269
269
  }
270
270
  ],
271
271
  "editor": {
272
- "label": "Magento FIK",
272
+ "label": "Magento FIK 10DLC",
273
273
  "description": "First name, last name, and email required; phone optional. Optional checkboxes: transactional SMS (lead-tcpa v1), marketing SMS (lead-sms v1), and terms and privacy (lead-tospp v1).",
274
274
  "whenToUse": "TBD",
275
275
  "whenNotToUse": "TBD",
@@ -289,7 +289,7 @@
289
289
  "requiredLegalUrls": ["userAgreement", "privacyPolicy"]
290
290
  }
291
291
  },
292
- "magento-ira-kick-article": {
292
+ "magento-ira-401k": {
293
293
  "definitionVersion": "1",
294
294
  "kind": "lead",
295
295
  "flow": { "type": "single" },
@@ -308,7 +308,7 @@
308
308
  }
309
309
  ],
310
310
  "editor": {
311
- "label": "Magento IRA Kick Article",
311
+ "label": "Magento IRA 401k",
312
312
  "description": "First name, last name, email, and phone required. Optional telephone and SMS consent checkbox with linked terms and privacy (lead-tcpa v2).",
313
313
  "whenToUse": "TBD",
314
314
  "whenNotToUse": "TBD",
@@ -328,7 +328,7 @@
328
328
  "requiredLegalUrls": ["userAgreement", "privacyPolicy"]
329
329
  }
330
330
  },
331
- "magento-fik-blog-rail": {
331
+ "magento-fik": {
332
332
  "definitionVersion": "1",
333
333
  "kind": "lead",
334
334
  "flow": { "type": "single" },
@@ -347,7 +347,7 @@
347
347
  }
348
348
  ],
349
349
  "editor": {
350
- "label": "Magento FIK Blog Rail",
350
+ "label": "Magento FIK",
351
351
  "description": "First name, last name, email, and phone required. Required automated text-message consent checkbox with linked terms of service and privacy policy (lead-tcpa v3).",
352
352
  "whenToUse": "TBD",
353
353
  "whenNotToUse": "TBD",
@@ -367,23 +367,66 @@
367
367
  "requiredLegalUrls": ["userAgreement", "privacyPolicy"]
368
368
  }
369
369
  },
370
- "main-investors-kit-notice": {
370
+ "magento-footer": {
371
371
  "definitionVersion": "1",
372
- "kind": "lead",
372
+ "kind": "newsletter",
373
373
  "flow": { "type": "single" },
374
+ "fields": [{ "name": "email", "required": true }],
375
+ "ctaLabel": "SUBSCRIBE",
376
+ "editor": {
377
+ "label": "Magento Footer",
378
+ "description": "Email only. No consent.",
379
+ "whenToUse": "TBD",
380
+ "whenNotToUse": "TBD",
381
+ "options": [
382
+ "appearance",
383
+ "heading",
384
+ "subheading",
385
+ "ctaLabel",
386
+ "successMessage",
387
+ "successUrl"
388
+ ],
389
+ "supportedAppearances": ["on-light", "on-dark"],
390
+ "supportedVariants": [],
391
+ "requiredLegalUrls": []
392
+ }
393
+ },
394
+ "wp-full-lead": {
395
+ "definitionVersion": "1",
396
+ "kind": "lead",
397
+ "flow": {
398
+ "type": "single"
399
+ },
374
400
  "fields": [
375
- { "name": "firstname", "required": true, "group": "name" },
376
- { "name": "lastname", "required": true, "group": "name" },
377
- { "name": "email", "required": true },
378
- { "name": "phone", "required": false }
401
+ {
402
+ "name": "firstname",
403
+ "required": true,
404
+ "group": "name"
405
+ },
406
+ {
407
+ "name": "lastname",
408
+ "required": true,
409
+ "group": "name"
410
+ },
411
+ {
412
+ "name": "email",
413
+ "required": true
414
+ },
415
+ {
416
+ "name": "phone",
417
+ "required": true
418
+ }
379
419
  ],
380
- "ctaLabel": "CLAIM YOUR OFFER",
420
+ "ctaLabel": "Submit",
381
421
  "consents": [
382
- { "definitionId": "lead-clickwrap", "definitionVersion": "2" }
422
+ {
423
+ "definitionId": "lead-clickwrap",
424
+ "definitionVersion": "2"
425
+ }
383
426
  ],
384
427
  "editor": {
385
- "label": "Main Investors Kit (clickwrap)",
386
- "description": "First name, last name, and email required; phone optional. Clickwrap notice only (lead-clickwrap v2); no consent checkboxes.",
428
+ "label": "Full Lead Form (WP GF 1)",
429
+ "description": "First name, last name, email, and phone required. Clickwrap notice only (lead-clickwrap v2); no consent checkboxes. GF form 1 → HubSpot 1ebf148f.",
387
430
  "whenToUse": "TBD",
388
431
  "whenNotToUse": "TBD",
389
432
  "options": [
@@ -402,28 +445,328 @@
402
445
  "requiredLegalUrls": ["privacyPolicy", "userAgreement"]
403
446
  }
404
447
  },
405
- "newsletter": {
448
+ "wp-request-call-back": {
406
449
  "definitionVersion": "1",
407
- "kind": "newsletter",
408
- "flow": { "type": "single" },
409
- "fields": [{ "name": "email", "required": true }],
410
- "ctaLabel": "SUBSCRIBE",
450
+ "kind": "lead",
451
+ "flow": {
452
+ "type": "single"
453
+ },
454
+ "fields": [
455
+ {
456
+ "name": "firstname",
457
+ "required": true,
458
+ "group": "name"
459
+ },
460
+ {
461
+ "name": "lastname",
462
+ "required": true,
463
+ "group": "name"
464
+ },
465
+ {
466
+ "name": "email",
467
+ "required": true
468
+ },
469
+ {
470
+ "name": "phone",
471
+ "required": true
472
+ }
473
+ ],
474
+ "ctaLabel": "Submit",
475
+ "consents": [
476
+ {
477
+ "definitionId": "lead-clickwrap",
478
+ "definitionVersion": "2"
479
+ }
480
+ ],
411
481
  "editor": {
412
- "label": "Newsletter",
413
- "description": "Email only. No consent.",
482
+ "label": "Request Call Back (WP GF 11)",
483
+ "description": "First name, last name, email, and phone required. Clickwrap notice only (lead-clickwrap v2). Host sets `requested_callback=true` as context. GF form 11 → HubSpot 25c0c6ca.",
414
484
  "whenToUse": "TBD",
415
485
  "whenNotToUse": "TBD",
416
486
  "options": [
417
487
  "appearance",
488
+ "variant",
489
+ "twoColumn",
418
490
  "heading",
419
491
  "subheading",
420
492
  "ctaLabel",
493
+ "legalUrls",
421
494
  "successMessage",
422
495
  "successUrl"
423
496
  ],
424
497
  "supportedAppearances": ["on-light", "on-dark"],
425
- "supportedVariants": [],
426
- "requiredLegalUrls": []
498
+ "supportedVariants": ["dense", "large", "sidebar"],
499
+ "requiredLegalUrls": ["privacyPolicy", "userAgreement"]
500
+ }
501
+ },
502
+ "wp-investor-kit-lead-nurturing": {
503
+ "definitionVersion": "1",
504
+ "kind": "lead",
505
+ "flow": {
506
+ "type": "single"
507
+ },
508
+ "fields": [
509
+ {
510
+ "name": "firstname",
511
+ "required": true,
512
+ "group": "name"
513
+ },
514
+ {
515
+ "name": "lastname",
516
+ "required": true,
517
+ "group": "name"
518
+ },
519
+ {
520
+ "name": "email",
521
+ "required": true
522
+ },
523
+ {
524
+ "name": "phone",
525
+ "required": true
526
+ }
527
+ ],
528
+ "ctaLabel": "Submit",
529
+ "consents": [
530
+ {
531
+ "definitionId": "lead-clickwrap",
532
+ "definitionVersion": "2"
533
+ }
534
+ ],
535
+ "editor": {
536
+ "label": "Investor Kit Lead Nurturing (WP GF 13)",
537
+ "description": "First name, last name, email, and phone required. Clickwrap notice only (lead-clickwrap v2). GF form 13 → HubSpot 1ebf148f.",
538
+ "whenToUse": "TBD",
539
+ "whenNotToUse": "TBD",
540
+ "options": [
541
+ "appearance",
542
+ "variant",
543
+ "twoColumn",
544
+ "heading",
545
+ "subheading",
546
+ "ctaLabel",
547
+ "legalUrls",
548
+ "successMessage",
549
+ "successUrl"
550
+ ],
551
+ "supportedAppearances": ["on-light", "on-dark"],
552
+ "supportedVariants": ["dense", "large", "sidebar"],
553
+ "requiredLegalUrls": ["privacyPolicy", "userAgreement"]
554
+ }
555
+ },
556
+ "wp-product-launch": {
557
+ "definitionVersion": "1",
558
+ "kind": "lead",
559
+ "flow": {
560
+ "type": "single"
561
+ },
562
+ "fields": [
563
+ {
564
+ "name": "firstname",
565
+ "required": true,
566
+ "group": "name"
567
+ },
568
+ {
569
+ "name": "lastname",
570
+ "required": true,
571
+ "group": "name"
572
+ },
573
+ {
574
+ "name": "email",
575
+ "required": true
576
+ },
577
+ {
578
+ "name": "phone",
579
+ "required": true
580
+ }
581
+ ],
582
+ "ctaLabel": "Reserve Yours Today",
583
+ "consents": [
584
+ {
585
+ "definitionId": "lead-clickwrap",
586
+ "definitionVersion": "2"
587
+ }
588
+ ],
589
+ "editor": {
590
+ "label": "Product Launch (WP GF 15)",
591
+ "description": "First name, last name, email, and phone required. Clickwrap notice only (lead-clickwrap v2). Product IPO/pre-IPO pages. GF form 15 → HubSpot 950c50a1.",
592
+ "whenToUse": "TBD",
593
+ "whenNotToUse": "TBD",
594
+ "options": [
595
+ "appearance",
596
+ "variant",
597
+ "twoColumn",
598
+ "heading",
599
+ "subheading",
600
+ "ctaLabel",
601
+ "legalUrls",
602
+ "successMessage",
603
+ "successUrl"
604
+ ],
605
+ "supportedAppearances": ["on-light", "on-dark"],
606
+ "supportedVariants": ["dense", "large", "sidebar"],
607
+ "requiredLegalUrls": ["privacyPolicy", "userAgreement"]
608
+ }
609
+ },
610
+ "wp-ira-full-lead": {
611
+ "definitionVersion": "1",
612
+ "kind": "lead",
613
+ "flow": {
614
+ "type": "single"
615
+ },
616
+ "fields": [
617
+ {
618
+ "name": "firstname",
619
+ "required": true,
620
+ "group": "name"
621
+ },
622
+ {
623
+ "name": "lastname",
624
+ "required": true,
625
+ "group": "name"
626
+ },
627
+ {
628
+ "name": "email",
629
+ "required": true
630
+ },
631
+ {
632
+ "name": "phone",
633
+ "required": true
634
+ }
635
+ ],
636
+ "ctaLabel": "Submit",
637
+ "consents": [
638
+ {
639
+ "definitionId": "lead-clickwrap",
640
+ "definitionVersion": "2"
641
+ }
642
+ ],
643
+ "editor": {
644
+ "label": "IRA Full Lead Form (WP GF 20)",
645
+ "description": "First name, last name, email, and phone required. Clickwrap notice only (lead-clickwrap v2). Host sets `ira_lead=true` as context. GF form 20 → HubSpot b42770ef.",
646
+ "whenToUse": "TBD",
647
+ "whenNotToUse": "TBD",
648
+ "options": [
649
+ "appearance",
650
+ "variant",
651
+ "twoColumn",
652
+ "heading",
653
+ "subheading",
654
+ "ctaLabel",
655
+ "legalUrls",
656
+ "successMessage",
657
+ "successUrl"
658
+ ],
659
+ "supportedAppearances": ["on-light", "on-dark"],
660
+ "supportedVariants": ["dense", "large", "sidebar"],
661
+ "requiredLegalUrls": ["privacyPolicy", "userAgreement"]
662
+ }
663
+ },
664
+ "wp-affiliate-ira-full-lead": {
665
+ "definitionVersion": "1",
666
+ "kind": "lead",
667
+ "flow": {
668
+ "type": "single"
669
+ },
670
+ "fields": [
671
+ {
672
+ "name": "firstname",
673
+ "required": true,
674
+ "group": "name"
675
+ },
676
+ {
677
+ "name": "lastname",
678
+ "required": true,
679
+ "group": "name"
680
+ },
681
+ {
682
+ "name": "email",
683
+ "required": true
684
+ },
685
+ {
686
+ "name": "phone",
687
+ "required": true
688
+ }
689
+ ],
690
+ "ctaLabel": "Submit",
691
+ "consents": [
692
+ {
693
+ "definitionId": "lead-clickwrap",
694
+ "definitionVersion": "2"
695
+ }
696
+ ],
697
+ "editor": {
698
+ "label": "Affiliate — IRA Full Lead Form (WP GF 21)",
699
+ "description": "First name, last name, email, and phone required. Clickwrap notice only (lead-clickwrap v2). Host supplies affiliate_id/affiliate_offer_id/affiliate_transaction_id as context (not schema fields). GF form 21 → HubSpot 1d4e44b3.",
700
+ "whenToUse": "TBD",
701
+ "whenNotToUse": "TBD",
702
+ "options": [
703
+ "appearance",
704
+ "variant",
705
+ "twoColumn",
706
+ "heading",
707
+ "subheading",
708
+ "ctaLabel",
709
+ "legalUrls",
710
+ "successMessage",
711
+ "successUrl"
712
+ ],
713
+ "supportedAppearances": ["on-light", "on-dark"],
714
+ "supportedVariants": ["dense", "large", "sidebar"],
715
+ "requiredLegalUrls": ["privacyPolicy", "userAgreement"]
716
+ }
717
+ },
718
+ "wp-full-lead-captcha": {
719
+ "definitionVersion": "1",
720
+ "kind": "lead",
721
+ "flow": {
722
+ "type": "single"
723
+ },
724
+ "fields": [
725
+ {
726
+ "name": "firstname",
727
+ "required": true,
728
+ "group": "name"
729
+ },
730
+ {
731
+ "name": "lastname",
732
+ "required": true,
733
+ "group": "name"
734
+ },
735
+ {
736
+ "name": "email",
737
+ "required": true
738
+ },
739
+ {
740
+ "name": "phone",
741
+ "required": true
742
+ }
743
+ ],
744
+ "ctaLabel": "Submit",
745
+ "consents": [
746
+ {
747
+ "definitionId": "lead-clickwrap",
748
+ "definitionVersion": "2"
749
+ }
750
+ ],
751
+ "editor": {
752
+ "label": "Full Lead Form — captcha (WP GF 22)",
753
+ "description": "First name, last name, email, and phone required. Clickwrap notice only (lead-clickwrap v2). reCAPTCHA is a host bot-control concern, not a schema field. GF form 22 → HubSpot 034c00e5.",
754
+ "whenToUse": "TBD",
755
+ "whenNotToUse": "TBD",
756
+ "options": [
757
+ "appearance",
758
+ "variant",
759
+ "twoColumn",
760
+ "heading",
761
+ "subheading",
762
+ "ctaLabel",
763
+ "legalUrls",
764
+ "successMessage",
765
+ "successUrl"
766
+ ],
767
+ "supportedAppearances": ["on-light", "on-dark"],
768
+ "supportedVariants": ["dense", "large", "sidebar"],
769
+ "requiredLegalUrls": ["privacyPolicy", "userAgreement"]
427
770
  }
428
771
  }
429
772
  },
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@usgb/forms",
3
- "version": "1.0.4",
3
+ "version": "1.0.5",
4
4
  "description": "Shared USGB lead-form package for PWA and WordPress",
5
5
  "type": "module",
6
6
  "license": "MIT",