@vergelijkdirect/comparison-forms 2.0.0-rc.9 → 2.0.1

package/dist/vue/comparison-forms.d.ts

@@ -5,9 +5,9 @@ import { PublicProps } from 'vue';
 import { Ref } from 'vue';
 
 declare const __VLS_export: DefineComponent<__VLS_Props, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
-    submit: (model: BikeFormData) => any;
+    submitted: (model: BikeFormData) => any;
 }, string, PublicProps, Readonly<__VLS_Props> & Readonly<{
-    onSubmit?: ((model: BikeFormData) => any) | undefined;
+    onSubmitted?: ((model: BikeFormData) => any) | undefined;
 }>, {
     title: string;
     flat: boolean;
@@ -21,9 +21,9 @@ declare const __VLS_export: DefineComponent<__VLS_Props, {}, {}, {}, {}, Compone
 }, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
 
 declare const __VLS_export_10: DefineComponent<__VLS_Props_10, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
-    submit: (model: MopedFormData) => any;
+    submitted: (model: MopedFormData) => any;
 }, string, PublicProps, Readonly<__VLS_Props_10> & Readonly<{
-    onSubmit?: ((model: MopedFormData) => any) | undefined;
+    onSubmitted?: ((model: MopedFormData) => any) | undefined;
 }>, {
     title: string;
     flat: boolean;
@@ -37,9 +37,9 @@ declare const __VLS_export_10: DefineComponent<__VLS_Props_10, {}, {}, {}, {}, C
 }, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
 
 declare const __VLS_export_11: DefineComponent<__VLS_Props_11, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
-    submit: (model: MotorFormData) => any;
+    submitted: (model: MotorFormData) => any;
 }, string, PublicProps, Readonly<__VLS_Props_11> & Readonly<{
-    onSubmit?: ((model: MotorFormData) => any) | undefined;
+    onSubmitted?: ((model: MotorFormData) => any) | undefined;
 }>, {
     title: string;
     flat: boolean;
@@ -53,9 +53,9 @@ declare const __VLS_export_11: DefineComponent<__VLS_Props_11, {}, {}, {}, {}, C
 }, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
 
 declare const __VLS_export_12: DefineComponent<__VLS_Props_12, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
-    submit: (model: CarFormData) => any;
+    submitted: (model: CarFormData) => any;
 }, string, PublicProps, Readonly<__VLS_Props_12> & Readonly<{
-    onSubmit?: ((model: CarFormData) => any) | undefined;
+    onSubmitted?: ((model: CarFormData) => any) | undefined;
 }>, {
     title: string;
     flat: boolean;
@@ -69,9 +69,9 @@ declare const __VLS_export_12: DefineComponent<__VLS_Props_12, {}, {}, {}, {}, C
 }, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
 
 declare const __VLS_export_13: DefineComponent<__VLS_Props_13, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
-    submit: (model: BusinessCarFormData) => any;
+    submitted: (model: BusinessCarFormData) => any;
 }, string, PublicProps, Readonly<__VLS_Props_13> & Readonly<{
-    onSubmit?: ((model: BusinessCarFormData) => any) | undefined;
+    onSubmitted?: ((model: BusinessCarFormData) => any) | undefined;
 }>, {
     title: string;
     flat: boolean;
@@ -85,9 +85,9 @@ declare const __VLS_export_13: DefineComponent<__VLS_Props_13, {}, {}, {}, {}, C
 }, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
 
 declare const __VLS_export_14: DefineComponent<__VLS_Props_14, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
-    submit: (model: BusinessLiabilityFormData) => any;
+    submitted: (model: BusinessLiabilityFormData) => any;
 }, string, PublicProps, Readonly<__VLS_Props_14> & Readonly<{
-    onSubmit?: ((model: BusinessLiabilityFormData) => any) | undefined;
+    onSubmitted?: ((model: BusinessLiabilityFormData) => any) | undefined;
 }>, {
     title: string;
     flat: boolean;
@@ -116,22 +116,27 @@ declare const __VLS_export_15: DefineComponent<ComparisonFormFlowProps, {}, {},
 declare const __VLS_export_16: DefineComponent<RiskScannerFormProps, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<RiskScannerFormProps> & Readonly<{}>, {
     title: string;
     description: string;
+    qaId: string;
+    thankyouPageTemplate: string;
     buttonText: string;
     showTitle: boolean;
-    qaOptions: Partial<QaOptions>;
+    qaUrl: string;
+    currentItemId: string;
+    nextItemId: string;
 }, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
 
 declare const __VLS_export_17: DefineComponent<QuestionnaireSharedProps, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<QuestionnaireSharedProps> & Readonly<{}>, {
     title: string;
     description: string;
+    thankyouPageTemplate: string;
     buttonText: string;
     showTitle: boolean;
 }, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
 
 declare const __VLS_export_2: DefineComponent<__VLS_Props_2, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
-    submit: (model: PetFormData) => any;
+    submitted: (model: PetFormData) => any;
 }, string, PublicProps, Readonly<__VLS_Props_2> & Readonly<{
-    onSubmit?: ((model: PetFormData) => any) | undefined;
+    onSubmitted?: ((model: PetFormData) => any) | undefined;
 }>, {
     title: string;
     flat: boolean;
@@ -145,9 +150,9 @@ declare const __VLS_export_2: DefineComponent<__VLS_Props_2, {}, {}, {}, {}, Com
 }, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
 
 declare const __VLS_export_3: DefineComponent<__VLS_Props_3, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
-    submit: (model: CaravanFormData) => any;
+    submitted: (model: CaravanFormData) => any;
 }, string, PublicProps, Readonly<__VLS_Props_3> & Readonly<{
-    onSubmit?: ((model: CaravanFormData) => any) | undefined;
+    onSubmitted?: ((model: CaravanFormData) => any) | undefined;
 }>, {
     title: string;
     flat: boolean;
@@ -161,9 +166,9 @@ declare const __VLS_export_3: DefineComponent<__VLS_Props_3, {}, {}, {}, {}, Com
 }, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
 
 declare const __VLS_export_4: DefineComponent<__VLS_Props_4, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
-    submit: (model: TravelFormData) => any;
+    submitted: (model: TravelFormData) => any;
 }, string, PublicProps, Readonly<__VLS_Props_4> & Readonly<{
-    onSubmit?: ((model: TravelFormData) => any) | undefined;
+    onSubmitted?: ((model: TravelFormData) => any) | undefined;
 }>, {
     title: string;
     flat: boolean;
@@ -177,9 +182,9 @@ declare const __VLS_export_4: DefineComponent<__VLS_Props_4, {}, {}, {}, {}, Com
 }, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
 
 declare const __VLS_export_5: DefineComponent<__VLS_Props_5, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
-    submit: (model: LiabilityFormData) => any;
+    submitted: (model: LiabilityFormData) => any;
 }, string, PublicProps, Readonly<__VLS_Props_5> & Readonly<{
-    onSubmit?: ((model: LiabilityFormData) => any) | undefined;
+    onSubmitted?: ((model: LiabilityFormData) => any) | undefined;
 }>, {
     title: string;
     flat: boolean;
@@ -193,9 +198,9 @@ declare const __VLS_export_5: DefineComponent<__VLS_Props_5, {}, {}, {}, {}, Com
 }, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
 
 declare const __VLS_export_6: DefineComponent<__VLS_Props_6, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
-    submit: (model: HouseFormData) => any;
+    submitted: (model: HouseFormData) => any;
 }, string, PublicProps, Readonly<__VLS_Props_6> & Readonly<{
-    onSubmit?: ((model: HouseFormData) => any) | undefined;
+    onSubmitted?: ((model: HouseFormData) => any) | undefined;
 }>, {
     title: string;
     flat: boolean;
@@ -209,9 +214,9 @@ declare const __VLS_export_6: DefineComponent<__VLS_Props_6, {}, {}, {}, {}, Com
 }, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
 
 declare const __VLS_export_7: DefineComponent<__VLS_Props_7, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
-    submit: (model: LegalFormData) => any;
+    submitted: (model: LegalFormData) => any;
 }, string, PublicProps, Readonly<__VLS_Props_7> & Readonly<{
-    onSubmit?: ((model: LegalFormData) => any) | undefined;
+    onSubmitted?: ((model: LegalFormData) => any) | undefined;
 }>, {
     title: string;
     flat: boolean;
@@ -225,9 +230,9 @@ declare const __VLS_export_7: DefineComponent<__VLS_Props_7, {}, {}, {}, {}, Com
 }, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
 
 declare const __VLS_export_8: DefineComponent<__VLS_Props_8, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
-    submit: (model: PackageFormData) => any;
+    submitted: (model: PackageFormData) => any;
 }, string, PublicProps, Readonly<__VLS_Props_8> & Readonly<{
-    onSubmit?: ((model: PackageFormData) => any) | undefined;
+    onSubmitted?: ((model: PackageFormData) => any) | undefined;
 }>, {
     title: string;
     flat: boolean;
@@ -241,9 +246,9 @@ declare const __VLS_export_8: DefineComponent<__VLS_Props_8, {}, {}, {}, {}, Com
 }, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
 
 declare const __VLS_export_9: DefineComponent<__VLS_Props_9, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
-    submit: (model: LoanFormData) => any;
+    submitted: (model: LoanFormData) => any;
 }, string, PublicProps, Readonly<__VLS_Props_9> & Readonly<{
-    onSubmit?: ((model: LoanFormData) => any) | undefined;
+    onSubmitted?: ((model: LoanFormData) => any) | undefined;
 }>, {
     title: string;
     flat: boolean;
@@ -289,9 +294,9 @@ declare interface AddressBearingFormData {
 }
 
 declare interface AddressData {
-    zipCode?: string;
-    houseNumber?: string;
-    houseNumberAddition?: string;
+    zipCode: string;
+    houseNumber: string;
+    houseNumberAddition: string;
     city?: string;
     street?: string;
 }
@@ -301,8 +306,7 @@ declare interface BaseVehicleData {
     Brand: string;
     Model: string;
     VehicleType: string;
-    ManufacturingYear: string | number;
-    [key: string]: unknown;
+    ManufacturingYear: number;
 }
 
 export declare const BikeForm: typeof __VLS_export;
@@ -340,17 +344,17 @@ export declare const CaravanForm: typeof __VLS_export_3;
 
 export declare interface CaravanFormData {
     TypeOfCaravan: string | null;
-    NewOrOccasion: YesNo;
+    NewOrOccasion: YesNoValue;
     BuildYear: string | null;
 }
 
 export declare function caravanPresenter(data: CaravanFormData): ComparisonPayload;
 
 declare interface CarData extends BaseVehicleData {
-    BrandLogo: string;
     Type: string;
-    CatalogValue: string | number | null;
-    DayValue: string | number | null;
+    BrandLogo: string;
+    DayValue: number;
+    CatalogValue: number;
     TheftProtectionClass: string;
     CarAlarmRequirement: string;
 }
@@ -481,18 +485,28 @@ export declare interface ComparisonPayload {
 
 declare interface ComparisonUserFields {
     birthdate?: string;
-    zipcode?: string;
+    zipCode?: string;
     houseNumber?: string;
     houseNumberAddition?: string;
     email?: string;
     kidsAmount?: number;
-    familyComposition?: FamilyComposition;
+    familyComposition?: FamilyCompositionValue;
     firstName?: string;
     phoneNumber?: string;
     city?: string;
     street?: string;
 }
 
+/**
+ * Registers the QA-renderer api for every questionnaire on the page, so a host
+ * that embeds `<vd-risk-scanner>` in many places sets the url once at bootstrap
+ * instead of on each element. A `qa-url` prop/attribute still wins over this.
+ *
+ * There is deliberately **no** default: unconfigured and without a prop, the
+ * form throws.
+ */
+export declare const configureQa: (config: QaConfig) => void;
+
 declare enum FamilyComposition {
     FamilyWithChildren = "I",
     FamilyWithoutChildren = "H",
@@ -501,13 +515,15 @@ declare enum FamilyComposition {
 }
 
 declare interface FamilyCompositionFormData {
-    familyComposition: FamilyComposition;
+    familyComposition: FamilyCompositionValue;
 }
 
+declare type FamilyCompositionValue = `${FamilyComposition}`;
+
 export declare const HouseForm: typeof __VLS_export_6;
 
 export declare interface HouseFormData extends AddressBearingFormData, FamilyCompositionFormData {
-    ownedBuilding: YesNo;
+    ownedBuilding: YesNoValue;
 }
 
 export declare function housePresenter(data: HouseFormData): ComparisonPayload;
@@ -515,7 +531,7 @@ export declare function housePresenter(data: HouseFormData): ComparisonPayload;
 export declare const LegalForm: typeof __VLS_export_7;
 
 export declare interface LegalFormData extends AddressBearingFormData, BirthdateFormData, FamilyCompositionFormData {
-    ownedBuilding: YesNo;
+    ownedBuilding: YesNoValue;
     familySize: string;
 }
 
@@ -532,21 +548,20 @@ export declare const LoanForm: typeof __VLS_export_9;
 
 export declare interface LoanFormData extends BirthdateFormData, FamilyCompositionFormData {
     LoanPurpose: string;
-    LoanAmount: number | null;
+    LoanAmount: number;
 }
 
 export declare function loanPresenter(data: LoanFormData): ComparisonPayload;
 
 declare interface MopedData extends BaseVehicleData {
     Type: string;
+    CatalogValue: string;
     TypeOfMoped: string;
-    CatalogValue: string | null;
     CylinderCapacity: string;
-    EnginePower: string | number | null;
+    Weight: string;
+    MaximumPower: string | number;
+    EnginePower: string | number;
     Fuel: string;
-    MaximumPower: string;
-    SignCode?: string;
-    Weight: number | string | null;
 }
 
 export declare const MopedForm: typeof __VLS_export_10;
@@ -557,20 +572,18 @@ export declare interface MopedFormData extends VehicleFormData<MopedData>, Addre
 export declare function mopedPresenter(data: MopedFormData): ComparisonPayload;
 
 declare interface MotorData extends BaseVehicleData {
-    BrandLogo: string;
     Type: string;
-    Source?: string;
-    CatalogValue: string | null;
-    DayValue: string | null;
+    BrandLogo: string;
+    DayValue: string;
+    CatalogValue: string;
+    EnginePower: number;
     CylinderCapacity: string;
-    EnginePower: number | null;
+    Weight: number;
+    WeightEmpty: string;
     Fuel: string;
+    Source: string;
+    Wheels: number;
     VehicleCategory: string;
-    Weight: number | null;
-    WeightEmpty: string;
-    Wheels?: number;
-    NumberOfKilowatts?: string;
-    MotorType?: string;
 }
 
 export declare const MotorForm: typeof __VLS_export_11;
@@ -593,47 +606,65 @@ declare enum PaymentTerm {
     ShortTerm = "S"
 }
 
+declare type PaymentTermValue = `${PaymentTerm}`;
+
 export declare const PetForm: typeof __VLS_export_2;
 
 export declare interface PetFormData {
     kind: string;
     age: string;
-    zipcode: string;
+    zipCode: string;
 }
 
 export declare function petPresenter(data: PetFormData): ComparisonPayload;
 
-export declare interface QaOptions {
-    qaId: string;
-    thankyouPageTemplate?: string;
-    qaUrl?: string;
-    currentItemId?: string;
-    nextItemId?: string;
+export declare interface QaConfig {
+    /** base url of the QA-renderer api (a missing trailing slash is normalized by the forms) */
+    url: string;
 }
 
 export declare const QuestionnaireForm: typeof __VLS_export_17;
 
 export declare type QuestionnaireFormProps = QuestionnaireSharedProps;
 
+/**
+ * The shared public API of every questionnaire (QA-renderer quiz starter).
+ * Deliberately independent from the comparison forms' `ComparisonFormProps` —
+ * questionnaires are VD-internal drop-ins, their contract evolves separately.
+ *
+ * On master (1.x) this contract was `link`/`title`/`description`/`buttonText`/
+ * `showTitle` + an `additionalOptions` object carrying the QA params; 2.x
+ * flattens those params into plain props, keeping the master names
+ * (`thankyouPageTemplate` still lands in the url as the `template` query param).
+ */
 export declare interface QuestionnaireSharedProps {
+    /** base page url of the quiz app; `{qaId, template, …}` are merged into its query */
     link: string;
+    qaId: string;
+    thankyouPageTemplate?: string;
     title?: string;
     description?: string;
     buttonText?: string;
     showTitle?: boolean;
-    qaOptions: QaOptions;
 }
 
 export declare const RiskScannerForm: typeof __VLS_export_16;
 
-export declare interface RiskScannerFormProps extends Omit<QuestionnaireSharedProps, 'qaOptions'> {
-    qaOptions?: Partial<QaOptions>;
+export declare interface RiskScannerFormProps extends Omit<QuestionnaireSharedProps, 'qaId'> {
+    /**
+     * base url of the QA API (a missing trailing slash is normalized internally);
+     * falls back to `configureQa({ url })` — submitting without either throws
+     */
+    qaUrl?: string;
+    qaId?: string;
+    currentItemId?: string;
+    nextItemId?: string;
 }
 
 export declare const TravelForm: typeof __VLS_export_4;
 
 export declare interface TravelFormData extends BirthdateFormData {
-    PaymentTerm: PaymentTerm;
+    PaymentTerm: PaymentTermValue;
 }
 
 export declare function travelPresenter(data: TravelFormData): ComparisonPayload;
@@ -653,7 +684,7 @@ declare interface UseComparisonSubmitOptions {
 
 declare interface VehicleFormData<TVehicle> {
     licensePlate: string;
-    vehicle: TVehicle | null;
+    vehicle: TVehicle;
 }
 
 declare enum YesNo {
@@ -661,4 +692,6 @@ declare enum YesNo {
     No = "N"
 }
 
+declare type YesNoValue = `${YesNo}`;
+
 export { }