@fragus/sam-types 1.1.6 → 1.1.7

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.1.6",
+  "version": "1.1.7",
   "name": "@fragus/sam-types",
   "description": "Typescript interfaces for all types used to communicate between SAM client(s) and the SAM API",
   "author": "Fragus",

package/types/accessKey/index.d.ts

@@ -1,8 +1,5 @@
 import { AccessKeyPermission, AccessKeyService, TIsoCountry } from '../index'
 
-/** How an access key chooses its providers: country-scoped, manually scoped, or group-scoped. */
-export type TAccessKeyScopeMode = 'all' | 'manual' | 'group'
-
 export interface IAccessKey {
   accessKeyId: number
   apiKey: string
@@ -13,7 +10,5 @@ export interface IAccessKey {
   contractProviderIds: number[]
   allProvidersAllowed: boolean
   isoCountries: TIsoCountry[] // scope for allProvidersAllowed; non-empty when it is true
-  scopeMode: TAccessKeyScopeMode
-  contractProviderGroupId: number | null // set only in 'group' mode; resolved live at request time
   description?: string
 }

package/types/admin/contractCreation/contractCreation.d.ts

@@ -150,6 +150,23 @@ interface ICommonContractCreationRequest extends ICommonContractUpdateRequest {
   invoiceCustomerId?: number
   invoiceCustomer?: IAdminCustomer
   isDownpaymentDistributed: boolean
+  /**
+   * What the seller agreed one service would cost, sent only where they put it on the agreement:
+   * the template proposes a basis, they adjust it, and an unticked one is not an agreement.
+   * Money is ex VAT, in the contract's currency.
+   */
+  serviceCostOilPricePerLitre?: number | null
+  serviceCostOilLitresPerService?: number | null
+  serviceCostLabourRatePerHour?: number | null
+  serviceCostLabourHoursPerService?: number | null
+  /** How many services the seller expects over the term; what the cost per service is multiplied by. */
+  serviceCostNumberOfServices?: number | null
+  /**
+   * Replacing the HV traction battery, where the template covers it and the vehicle is electric.
+   * Once
+   * over the term rather than once per service: a battery is not a service item.
+   */
+  serviceCostBattery?: number | null
 }
 
 export interface IContractAdjustmentRequest extends ICommonContractUpdateRequest {

package/types/admin/contractCreation/priceCalculation.d.ts

@@ -80,4 +80,19 @@ export interface IContractCalculationResponse {
   providerShare: PriceSpecification
   x_debugData?: any // For debugging purposes.
   serviceInfo?: string[] // Service information, mainly for ax.
+  /**
+   * Present only when the price came from a price prediction template. Caveats are codes with
+   * parameters rather than sentences, so the client renders them in the reader's own language;
+   * a code the client does not know can be dropped safely, which lets the API add more freely.
+   */
+  pricePrediction?: {
+    /**
+     * Which source answered. `AI` means nothing comparable has ever been sold on this kind of
+     * vehicle, so the figure is reasoned from the vehicle itself rather than from what we charged.
+     */
+    source?: 'Comparables' | 'AI'
+    confidence: 'high' | 'medium' | 'low'
+    comparableCount?: number
+    caveats?: Array<{ code: string; params?: { [key: string]: string | number } }>
+  }
 }

package/types/admin/vehicleBlacklist/index.d.ts

@@ -6,10 +6,6 @@ export interface IBlacklistedVehicleRequest {
     add: number[]
     remove: number[]
   }
-  contractProviderGroupIds?: {
-    add: number[]
-    remove: number[]
-  }
 }
 
 export interface IBlacklistedVehicleResponse {
@@ -18,21 +14,11 @@ export interface IBlacklistedVehicleResponse {
   model: string
   fuelType: string
   parentRecord?: boolean
-  groupRecord?: boolean
 }
 
 export interface IBlacklistedVehicleListRecord extends IBlacklistedVehicleResponse {
-  // Null on a group-owned entry: the two owners are exclusive.
-  providerId: number | null
-  providerName: string | null
-  contractProviderGroupId: number | null
-  contractProviderGroupName: string | null
-}
-
-/** Which providers and groups a blacklisted vehicle is registered for. */
-export interface IBlacklistedVehicleScope {
-  providerIds: number[]
-  contractProviderGroupIds: number[]
+  providerId: number
+  providerName: string
 }
 
 export type BlacklistedVehicleOrderByType = 'id' | 'brand' | 'model' | 'fuelType'

package/types/contractProviderFlags.d.ts

@@ -1,17 +1,13 @@
 export type TContractProviderFlagKey = 'RENAULT_UNIQ_PDF_FORMAT'
 
-/** Exactly one of the two ids is sent: a flag row is owned by a provider or by a group. */
 export interface ContractProviderFlagRequest {
-  contractProviderId?: number
-  contractProviderGroupId?: number
+  contractProviderId: number
 }
 
 export interface ContractProviderFlagResponse {
   id: number
   featureKey: TContractProviderFlagKey
-  contractProviderId: number | null
-  contractProviderName: string | null
-  contractProviderGroupId: number | null
-  contractProviderGroupName: string | null
+  contractProviderId: number
+  contractProviderName: string
   updatedByUser: string
 }

package/types/contractTemplate.d.ts

@@ -4,7 +4,7 @@ import { PriceSpecification } from './priceSpecification'
 import { ITermsOfServiceRequest, ITermsOfServiceResponse } from './termsOfService'
 import { TV4PTPaymentType, TV4PTProductType } from './v4PricingTool'
 
-export type PriceSource = 'Pricelist' | 'Autoexperten' | 'V4PricingTool'
+export type PriceSource = 'Pricelist' | 'Autoexperten' | 'V4PricingTool' | 'PricePrediction'
 
 export interface IContractTemplateCloneRequest {
   templateIds: number[]
@@ -34,6 +34,42 @@ export interface IGenericContractTemplateRequest {
   overdrivenCharge: PriceSpecification
   totalPriceFactorInTenthOfCents: number | null
   disableServiceInfoFile: boolean | null
+  /**
+   * Price prediction templates only: the terms that may be sold, in months. Whole years only
+   * (12, 24, ... ), never above 84. There is no price list to read the available terms off, so
+   * they come from here instead; leave empty to offer every term up to 84.
+   */
+  predictionDurationMonths: number[] | null
+  /**
+   * Price prediction templates only: the mileage allowances that may be sold, in km over the whole
+   * agreement. The same allowances are offered whatever the term, which is how price lists work.
+   */
+  predictionMileageKm: number[] | null
+  /**
+   * Price prediction templates only: the fuel types this template may be sold on. Empty or
+   * absent means every fuel; the vehicle lookup drops the template for anything not listed.
+   */
+  predictionFuelTypes: string[] | null
+  /**
+   * Price prediction templates only: what one service is expected to cost, used as the starting
+   * point an operator adjusts from. Money is ex VAT, in the provider's currency.
+   */
+  predictionOilPricePerLitre: number | null
+  predictionOilLitresPerService: number | null
+  predictionLabourRatePerHour: number | null
+  predictionLabourHoursPerService: number | null
+  /**
+   * Price prediction templates only: whether this agreement covers replacing the HV traction
+   * battery of an electric vehicle, never the 12 V battery. Off unless a provider deliberately turns it on -- it is the
+   * one bill that dwarfs everything else an agreement covers.
+   */
+  predictionCoversBattery: boolean | null
+  /**
+   * Price prediction templates only: what replacing that HV traction battery is expected to cost,
+   * ex VAT in
+   * the provider's currency. Only meaningful where the cover is on.
+   */
+  predictionBatteryCost: number | null
 }
 
 export interface IContractTemplateRequest extends IGenericContractTemplateRequest {
@@ -74,6 +110,42 @@ export interface IGenericContractTemplateResponse {
   maxEndMileage?: number
   totalPriceFactorInTenthOfCents: number | null
   disableServiceInfoFile: boolean | null
+  /**
+   * Price prediction templates only: the terms that may be sold, in months. Whole years only
+   * (12, 24, ... ), never above 84. There is no price list to read the available terms off, so
+   * they come from here instead; leave empty to offer every term up to 84.
+   */
+  predictionDurationMonths: number[] | null
+  /**
+   * Price prediction templates only: the mileage allowances that may be sold, in km over the whole
+   * agreement. The same allowances are offered whatever the term, which is how price lists work.
+   */
+  predictionMileageKm: number[] | null
+  /**
+   * Price prediction templates only: the fuel types this template may be sold on. Empty or
+   * absent means every fuel; the vehicle lookup drops the template for anything not listed.
+   */
+  predictionFuelTypes: string[] | null
+  /**
+   * Price prediction templates only: what one service is expected to cost, used as the starting
+   * point an operator adjusts from. Money is ex VAT, in the provider's currency.
+   */
+  predictionOilPricePerLitre: number | null
+  predictionOilLitresPerService: number | null
+  predictionLabourRatePerHour: number | null
+  predictionLabourHoursPerService: number | null
+  /**
+   * Price prediction templates only: whether this agreement covers replacing the HV traction
+   * battery of an electric vehicle, never the 12 V battery. Off unless a provider deliberately turns it on -- it is the
+   * one bill that dwarfs everything else an agreement covers.
+   */
+  predictionCoversBattery: boolean | null
+  /**
+   * Price prediction templates only: what replacing that HV traction battery is expected to cost,
+   * ex VAT in
+   * the provider's currency. Only meaningful where the cover is on.
+   */
+  predictionBatteryCost: number | null
 }
 
 export interface IContractTemplateResponse extends IGenericContractTemplateResponse {

package/types/dashboardBanner.d.ts

@@ -1,39 +1,32 @@
-import { TIsoCountry } from './country'
-
+import { TIsoCountry } from './country';
 /**
  * Request body for creating or updating a dashboard banner (Superadmin)
  */
 export interface DashboardBannerRequest {
-  text: string
-  /**
-   * Exactly one of the two targets the banner: a whole country, or the members of one provider group.
-   * A group banner takes precedence over a country one.
-   */
-  countryIso?: TIsoCountry | null
-  contractProviderGroupId?: number | null
-  /**
-   * ISO date string (YYYY-MM-DD) for the start date of the banner
-   */
-  startDate: string
-  /**
-   * ISO date string (YYYY-MM-DD) for the end date of the banner
-   */
-  endDate: string
+    text: string;
+    countryIso: TIsoCountry;
+    /**
+     * ISO date string (YYYY-MM-DD) for the start date of the banner
+     */
+    startDate: string;
+    /**
+     * ISO date string (YYYY-MM-DD) for the end date of the banner
+     */
+    endDate: string;
 }
 /**
  * Response body for retrieving a dashboard banner (Superadmin)
  */
 export interface DashboardBannerResponse extends DashboardBannerRequest {
-  id: number
-  contractProviderGroupName: string | null
-  /**
-   * Email of the user who last updated the banner
-   */
-  updatedByUser: string
+    id: number;
+    /**
+     * Email of the user who last updated the banner
+     */
+    updatedByUser: string;
 }
 /**
  * Response body for retrieving dashboard banner text in Admin
  */
 export interface ProviderDashboardBannerResponse {
-  text: string
+    text: string;
 }

package/types/emailCampaign.d.ts

@@ -10,19 +10,12 @@ export declare enum EmailCampaignStatus {
 }
 export declare type EmailCampaignRole = 'admin' | 'seller';
 export declare type EmailCampaignSelectionMode = 'all' | 'subset';
-export declare type EmailCampaignProviderMode = EmailCampaignSelectionMode | 'group';
 export declare type EmailCampaignProviderSelection = {
     providerMode: 'all';
     selectedProviderIds: null;
-    selectedGroupIds: null;
 } | {
     providerMode: 'subset';
     selectedProviderIds: number[];
-    selectedGroupIds: null;
-} | {
-    providerMode: 'group';
-    selectedProviderIds: null;
-    selectedGroupIds: number[];
 };
 export declare type EmailCampaignRecipientSelection = {
     recipientMode: 'all';

package/types/emailCampaign.ts

@@ -21,15 +21,11 @@ export type EmailCampaignRole = 'admin' | 'seller'
 // How a pool (providers or recipients) is narrowed: 'all' = every match, 'subset' = explicit ids.
 export type EmailCampaignSelectionMode = 'all' | 'subset'
 
-// The provider dimension has a third mode the recipient dimension does not: 'group'.
-export type EmailCampaignProviderMode = EmailCampaignSelectionMode | 'group'
-
 // Provider dimension: mode is discriminated against its selection, so an invalid combination can't type-check.
 // The candidate-pool filter (`filters`) is carried separately on the request/detail DTOs.
 export type EmailCampaignProviderSelection =
-  | { providerMode: 'all'; selectedProviderIds: null; selectedGroupIds: null }
-  | { providerMode: 'subset'; selectedProviderIds: number[]; selectedGroupIds: null }
-  | { providerMode: 'group'; selectedProviderIds: null; selectedGroupIds: number[] }
+  | { providerMode: 'all'; selectedProviderIds: null }
+  | { providerMode: 'subset'; selectedProviderIds: number[] }
 
 // Recipient dimension: mode is discriminated against its user picks.
 export type EmailCampaignRecipientSelection =

package/types/index.d.ts

@@ -180,6 +180,7 @@ export * from './outage';
 export * from './payment';
 export * from './priceCalculation';
 export * from './priceSpecification';
+export * from './pricePrediction';
 export * from './product';
 export * from './providerBranding';
 export * from './queryParams';
@@ -219,4 +220,3 @@ export * from './ISendEmail';
 export * from './emailCampaign';
 export * from './contractProviderFlags';
 export * from './providerDocument';
-export * from './contractProviderGroup';

package/types/index.js

@@ -170,5 +170,6 @@ var AccessKeyService;
     AccessKeyService[AccessKeyService["WorkshopOperation"] = 1] = "WorkshopOperation";
     AccessKeyService[AccessKeyService["Report"] = 2] = "Report";
 })(AccessKeyService = exports.AccessKeyService || (exports.AccessKeyService = {}));
+__export(require("./pricePrediction"));
 __export(require("./emailCampaign"));
 //# sourceMappingURL=index.js.map

package/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;;;AAAA,IAAY,aAgBX;AAhBD,WAAY,aAAa;IACvB,mDAAS,CAAA;IACT,qDAAW,CAAA;IACX,mEAAkB,CAAA;IAClB,mEAAkB,CAAA;IAClB,qEAAmB,CAAA;IACnB,uDAAY,CAAA;IACZ,qEAAmB,CAAA;IACnB,2FAA8B,CAAA;IAC9B,6DAAe,CAAA;IACf,qFAA2B,CAAA;IAC3B,+DAAgB,CAAA;IAChB,2DAAc,CAAA;IACd,yDAAa,CAAA;IACb,yDAAa,CAAA;IACb,uEAAoB,CAAA;AACtB,CAAC,EAhBW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAgBxB;AAED,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,uDAAY,CAAA;IACZ,2DAAc,CAAA;IACd,+DAAgB,CAAA;AAClB,CAAC,EAJW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAIxB;AAED,IAAY,MAMX;AAND,WAAY,MAAM;IAChB,iCAAO,CAAA;IACP,mCAAI,CAAA;IACJ,mCAAI,CAAA;IACJ,2CAAQ,CAAA;IACR,yCAAO,CAAA;AACT,CAAC,EANW,MAAM,GAAN,cAAM,KAAN,cAAM,QAMjB;AAED,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,+CAAO,CAAA;IACP,qDAAM,CAAA;IACN,mDAAK,CAAA;AACP,CAAC,EAJW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAIxB;AAED,IAAY,gBAOX;AAPD,WAAY,gBAAgB;IAC1B,yDAAO,CAAA;IACP,yDAAO,CAAA;IACP,yDAAO,CAAA;IACP,yDAAO,CAAA;IACP,yDAAO,CAAA;IACP,yDAAO,CAAA;AACT,CAAC,EAPW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAO3B;AAED,IAAY,kBAyDX;AAzDD,WAAY,kBAAkB;IAC5B,8FAA0B,CAAA;IAC1B,iEAAY,CAAA;IACZ,uEAAe,CAAA;IACf,iEAAY,CAAA;IACZ,6EAAkB,CAAA;IAClB,2EAAiB,CAAA;IACjB,+FAA2B,CAAA;IAC3B,sGAA+B,CAAA;IAC/B,0EAAiB,CAAA;IACjB,0EAAiB,CAAA;IACjB,sEAAe,CAAA;IACf,2GAAiC,CAAA;IACjC,iGAA4B,CAAA;IAC5B,yGAAgC,CAAA;IAChC,iGAA4B,CAAA;IAC5B,uGAA+B,CAAA;IAC/B,6GAAkC,CAAA;IAClC,oGAA8B,CAAA;IAC9B,kGAA6B,CAAA;IAC7B,6GAAkC,CAAA;IAClC,yGAAgC,CAAA;IAChC,yGAAgC,CAAA;IAChC,2EAAiB,CAAA;IACjB,2EAAiB,CAAA;IACjB,6EAAkB,CAAA;IAClB,qEAAc,CAAA;IACd,wGAAgC,CAAA;IAChC,kFAAqB,CAAA;IACrB,gFAAoB,CAAA;IACpB,sFAAuB,CAAA;IACvB,iEAAY,CAAA;IACZ,iFAAoB,CAAA;IACpB,mGAA6B,CAAA;IAC7B,uFAAuB,CAAA;IACvB,yFAAwB,CAAA;IACxB,uFAAuB,CAAA;IACvB,iEAAY,CAAA;IACZ,qGAA8B,CAAA;IAC9B,qGAA8B,CAAA;IAC9B,mEAAa,CAAA;IACb,yFAAwB,CAAA;IACxB,qGAA8B,CAAA;IAC9B,yEAAgB,CAAA;IAChB,gGAA4B,CAAA;IAC5B,uEAAe,CAAA;IACf,uFAAuB,CAAA;IACvB,uEAAe,CAAA;IACf,gGAA4B,CAAA;IAC5B,2FAAyB,CAAA;IACzB,yFAAwB,CAAA;IACxB,mGAA6B,CAAA;IAC7B,2FAAyB,CAAA;IACzB,2FAAyB,CAAA;IACzB,iEAAY,CAAA;IACZ,oEAAc,CAAA;IACd,gEAAY,CAAA;AACd,CAAC,EAzDW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAyD7B;AAED,IAAY,oBAeX;AAfD,WAAY,oBAAoB;IAC9B,8EAAgB,CAAA;IAChB,oGAA2B,CAAA;IAC3B,0FAAsB,CAAA;IACtB,gHAAiC,CAAA;IACjC,kFAAkB,CAAA;IAClB,2FAA2F;IAC3F,sFAAoB,CAAA;IACpB,kHAAkH;IAClH,0DAA0D;IAC1D,8FAAwB,CAAA;IACxB,0DAA0D;IAC1D,kFAAkB,CAAA;IAClB,0FAAsB,CAAA;IACtB,mFAAmB,CAAA;AACrB,CAAC,EAfW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAe/B;AAED,IAAY,gBAEX;AAFD,WAAY,gBAAgB;IAC1B,6EAAoB,CAAA;AACtB,CAAC,EAFW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAE3B;AAID,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC7B,2DAAO,CAAA;IACP,iEAAU,CAAA;IACV,6DAAQ,CAAA;AACV,CAAC,EAJW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAI9B;AAED,IAAY,qBAKX;AALD,WAAY,qBAAqB;IAC/B,6EAAc,CAAA;IACd,+EAAW,CAAA;IACX,mFAAa,CAAA;IACb,uFAAe,CAAA;AACjB,CAAC,EALW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAKhC;AAED,IAAY,aAKX;AALD,WAAY,aAAa;IACvB,mDAAS,CAAA;IACT,6DAAU,CAAA;IACV,+CAAG,CAAA;IACH,uDAAO,CAAA;AACT,CAAC,EALW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAKxB;AAED,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,6CAAS,CAAA;IACT,6CAAK,CAAA;IACL,yCAAG,CAAA;IACH,iDAAO,CAAA;IACP,iDAAO,CAAA;IACP,mDAAQ,CAAA;AACV,CAAC,EAPW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAOrB;AAED,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC7B,6DAAQ,CAAA;IACR,+DAAK,CAAA;IACL,uEAAS,CAAA;AACX,CAAC,EAJW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAI9B;AAED,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,iFAAqB,CAAA;IACrB,2DAAM,CAAA;AACR,CAAC,EAHW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAG3B;AAsED,qCAA+B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;;;AAAA,IAAY,aAgBX;AAhBD,WAAY,aAAa;IACvB,mDAAS,CAAA;IACT,qDAAW,CAAA;IACX,mEAAkB,CAAA;IAClB,mEAAkB,CAAA;IAClB,qEAAmB,CAAA;IACnB,uDAAY,CAAA;IACZ,qEAAmB,CAAA;IACnB,2FAA8B,CAAA;IAC9B,6DAAe,CAAA;IACf,qFAA2B,CAAA;IAC3B,+DAAgB,CAAA;IAChB,2DAAc,CAAA;IACd,yDAAa,CAAA;IACb,yDAAa,CAAA;IACb,uEAAoB,CAAA;AACtB,CAAC,EAhBW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAgBxB;AAED,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,uDAAY,CAAA;IACZ,2DAAc,CAAA;IACd,+DAAgB,CAAA;AAClB,CAAC,EAJW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAIxB;AAED,IAAY,MAMX;AAND,WAAY,MAAM;IAChB,iCAAO,CAAA;IACP,mCAAI,CAAA;IACJ,mCAAI,CAAA;IACJ,2CAAQ,CAAA;IACR,yCAAO,CAAA;AACT,CAAC,EANW,MAAM,GAAN,cAAM,KAAN,cAAM,QAMjB;AAED,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,+CAAO,CAAA;IACP,qDAAM,CAAA;IACN,mDAAK,CAAA;AACP,CAAC,EAJW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAIxB;AAED,IAAY,gBAOX;AAPD,WAAY,gBAAgB;IAC1B,yDAAO,CAAA;IACP,yDAAO,CAAA;IACP,yDAAO,CAAA;IACP,yDAAO,CAAA;IACP,yDAAO,CAAA;IACP,yDAAO,CAAA;AACT,CAAC,EAPW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAO3B;AAED,IAAY,kBAyDX;AAzDD,WAAY,kBAAkB;IAC5B,8FAA0B,CAAA;IAC1B,iEAAY,CAAA;IACZ,uEAAe,CAAA;IACf,iEAAY,CAAA;IACZ,6EAAkB,CAAA;IAClB,2EAAiB,CAAA;IACjB,+FAA2B,CAAA;IAC3B,sGAA+B,CAAA;IAC/B,0EAAiB,CAAA;IACjB,0EAAiB,CAAA;IACjB,sEAAe,CAAA;IACf,2GAAiC,CAAA;IACjC,iGAA4B,CAAA;IAC5B,yGAAgC,CAAA;IAChC,iGAA4B,CAAA;IAC5B,uGAA+B,CAAA;IAC/B,6GAAkC,CAAA;IAClC,oGAA8B,CAAA;IAC9B,kGAA6B,CAAA;IAC7B,6GAAkC,CAAA;IAClC,yGAAgC,CAAA;IAChC,yGAAgC,CAAA;IAChC,2EAAiB,CAAA;IACjB,2EAAiB,CAAA;IACjB,6EAAkB,CAAA;IAClB,qEAAc,CAAA;IACd,wGAAgC,CAAA;IAChC,kFAAqB,CAAA;IACrB,gFAAoB,CAAA;IACpB,sFAAuB,CAAA;IACvB,iEAAY,CAAA;IACZ,iFAAoB,CAAA;IACpB,mGAA6B,CAAA;IAC7B,uFAAuB,CAAA;IACvB,yFAAwB,CAAA;IACxB,uFAAuB,CAAA;IACvB,iEAAY,CAAA;IACZ,qGAA8B,CAAA;IAC9B,qGAA8B,CAAA;IAC9B,mEAAa,CAAA;IACb,yFAAwB,CAAA;IACxB,qGAA8B,CAAA;IAC9B,yEAAgB,CAAA;IAChB,gGAA4B,CAAA;IAC5B,uEAAe,CAAA;IACf,uFAAuB,CAAA;IACvB,uEAAe,CAAA;IACf,gGAA4B,CAAA;IAC5B,2FAAyB,CAAA;IACzB,yFAAwB,CAAA;IACxB,mGAA6B,CAAA;IAC7B,2FAAyB,CAAA;IACzB,2FAAyB,CAAA;IACzB,iEAAY,CAAA;IACZ,oEAAc,CAAA;IACd,gEAAY,CAAA;AACd,CAAC,EAzDW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAyD7B;AAED,IAAY,oBAeX;AAfD,WAAY,oBAAoB;IAC9B,8EAAgB,CAAA;IAChB,oGAA2B,CAAA;IAC3B,0FAAsB,CAAA;IACtB,gHAAiC,CAAA;IACjC,kFAAkB,CAAA;IAClB,2FAA2F;IAC3F,sFAAoB,CAAA;IACpB,kHAAkH;IAClH,0DAA0D;IAC1D,8FAAwB,CAAA;IACxB,0DAA0D;IAC1D,kFAAkB,CAAA;IAClB,0FAAsB,CAAA;IACtB,mFAAmB,CAAA;AACrB,CAAC,EAfW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAe/B;AAED,IAAY,gBAEX;AAFD,WAAY,gBAAgB;IAC1B,6EAAoB,CAAA;AACtB,CAAC,EAFW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAE3B;AAID,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC7B,2DAAO,CAAA;IACP,iEAAU,CAAA;IACV,6DAAQ,CAAA;AACV,CAAC,EAJW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAI9B;AAED,IAAY,qBAKX;AALD,WAAY,qBAAqB;IAC/B,6EAAc,CAAA;IACd,+EAAW,CAAA;IACX,mFAAa,CAAA;IACb,uFAAe,CAAA;AACjB,CAAC,EALW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAKhC;AAED,IAAY,aAKX;AALD,WAAY,aAAa;IACvB,mDAAS,CAAA;IACT,6DAAU,CAAA;IACV,+CAAG,CAAA;IACH,uDAAO,CAAA;AACT,CAAC,EALW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAKxB;AAED,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,6CAAS,CAAA;IACT,6CAAK,CAAA;IACL,yCAAG,CAAA;IACH,iDAAO,CAAA;IACP,iDAAO,CAAA;IACP,mDAAQ,CAAA;AACV,CAAC,EAPW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAOrB;AAED,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC7B,6DAAQ,CAAA;IACR,+DAAK,CAAA;IACL,uEAAS,CAAA;AACX,CAAC,EAJW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAI9B;AAED,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,iFAAqB,CAAA;IACrB,2DAAM,CAAA;AACR,CAAC,EAHW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAG3B;AAkCD,uCAAiC;AAqCjC,qCAA+B"}

package/types/index.ts

@@ -199,6 +199,7 @@ export * from './outage'
 export * from './payment'
 export * from './priceCalculation'
 export * from './priceSpecification'
+export * from './pricePrediction'
 export * from './product'
 export * from './providerBranding'
 export * from './queryParams'
@@ -238,4 +239,3 @@ export * from './ISendEmail'
 export * from './emailCampaign'
 export * from './contractProviderFlags'
 export * from './providerDocument'
-export * from './contractProviderGroup'

package/types/pricePrediction.d.ts

@@ -0,0 +1,219 @@
+import { IsoLocale } from './locale';
+import { PriceSpecification } from './priceSpecification';
+import { TVehicleType } from './vehicle';
+/**
+ * The contract between the API and the clients for a predicted price.
+ *
+ * It lives here because three repositories were keeping their own copy of it by hand. Admin
+ * redeclared the response shape and said so in a comment; superadmin wrote the duration ladder out
+ * as a literal; the ceiling existed as a separate constant in each of the three. A field added on
+ * one side and forgotten on another was caught only by someone remembering to look.
+ *
+ * What stays in the API is what never crosses the wire: how comparables are matched, what the
+ * model is asked, and every tuning constant behind the estimate.
+ */
+/** Agreements are sold in whole years, so every offered term is a multiple of this. */
+export declare const PREDICTION_DURATION_STEP_MONTHS = 12;
+/** Nothing longer may be sold, whatever a template asks for. */
+export declare const PREDICTION_MAX_DURATION_MONTHS = 108;
+/**
+ * Every term a predicted template may offer when it names none itself: 12, 24 ... up to the
+ * ceiling. Derived rather than written out, so raising the ceiling cannot leave a stale list
+ * behind in another repository.
+ */
+export declare function predictionDurationLadder(): number[];
+/** True for a term that may actually be sold: a whole number of years, up to the ceiling. */
+export declare function isSellablePredictionDuration(months: number): boolean;
+/**
+ * The fuel types a predicted template may be restricted to, as the vehicle catalogue spells them.
+ *
+ * A template that names none supports every fuel: an empty restriction is not "nothing", it is
+ * "no restriction", which is what a provider who never thinks about this should get.
+ */
+export declare const PREDICTION_FUEL_TYPES: string[];
+export declare type TPredictionFuelType = 'Petrol' | 'Diesel' | 'Electric' | 'Hybrid' | 'Diesel-Electric' | 'Cng' | 'Lpg' | 'Lpg-Petrol' | 'Lpg-Diesel';
+/**
+ * Whether a template restricted to these fuel types may be offered on this vehicle. No restriction
+ * means every fuel; an unknown fuel on the vehicle matches nothing but the absence of a rule.
+ */
+export declare function supportsPredictionFuelType(supported: string[] | null | undefined, fuelTypeName: string | null | undefined): boolean;
+/**
+ * How closely the comparable contracts had to match the requested vehicle. Tiers are tried in
+ * order and the first with enough samples wins, so a wide tier signals a weak estimate.
+ */
+export declare type TMatchTier = 'BrandModelFuel' | 'BrandFuelPower' | 'BrandFuel' | 'FuelPower' | 'Fuel';
+export declare type TPredictionConfidence = 'high' | 'medium' | 'low';
+export declare type TPriceSuggestionSource = 'Comparables' | 'AI';
+/**
+ * Why an estimate may be weaker than its single number suggests. Sent as a code and parameters
+ * rather than a sentence: a quote is read on a Danish, Swedish, Finnish or Norwegian screen, and
+ * English prose from the server would land untranslated in the middle of it.
+ *
+ * A client may render only the codes it knows and drop the rest, so the API can add one without
+ * waiting for every client. A dropped code is a reason the seller never sees, though, so a client
+ * that maps these should aim to map all of them.
+ */
+export declare type TPredictionCaveatCode = 'VEHICLE_AGE_UNKNOWN' | 'VEHICLE_AGE_OUTSIDE_COMPARABLES' | 'START_MILEAGE_UNKNOWN' | 'START_MILEAGE_OUTSIDE_COMPARABLES' | 'DURATION_OUTSIDE_COMPARABLES' | 'TOO_FEW_COMPARABLES' | 'SMALL_COMPARABLE_SAMPLE' | 'NO_BRAND_OR_MODEL_HISTORY' | 'MILEAGE_OUTSIDE_COMPARABLES' | 'COST_UNVERIFIED' | 'SEGMENT_UNDERPRICED' | 'COMPARABLES_STALE' | 'AI_DIVERGES_FROM_COMPARABLES' | 'TIMING_BELT_DUE_IN_TERM' | 'PRICED_BY_AI_WITHOUT_COMPARABLES';
+export interface IPredictionCaveat {
+    code: TPredictionCaveatCode;
+    params?: {
+        [key: string]: string | number;
+    };
+    /** English, for the admin prediction endpoint only. Never render this to a customer. */
+    message: string;
+}
+export interface IPricePredictionRequest {
+    brand: string;
+    model: string;
+    fuelType: string;
+    modelYear?: number;
+    /** Preferred over modelYear for the vehicle's age: it is set on far more vehicles. */
+    dateVehicleFirstRegistered?: string;
+    engineMaxPower?: number;
+    vehicleType?: TVehicleType;
+    /** Odometer when the agreement starts, not the allowance it grants. */
+    startMileage?: number;
+    /** The reader's own locale. Their choice wins over the provider's, which stands in when absent. */
+    locale?: IsoLocale;
+    durationMonths: number;
+    /** Allowance over the whole contract, not per year. */
+    mileage: number;
+    adjustmentFactor?: number;
+    /** Annual price drift used to bring old comparables into today's money, e.g. 0.03 for 3%. */
+    annualPriceIndex?: number;
+    /**
+     * Whether the servicing and coverage advice is wanted alongside the price. Defaults to true.
+     * Asking for prose nobody reads is most of the output bill and most of the wait, so a caller
+     * that shows the price alone should say so.
+     */
+    withAdvice?: boolean;
+}
+export interface IPricePercentiles {
+    p25: PriceSpecification;
+    p50: PriceSpecification;
+    p75: PriceSpecification;
+}
+/**
+ * Realized workshop cost for the same comparables. Only populated when enough of them actually
+ * carry cost data, otherwise absence of claims is indistinguishable from claims never recorded.
+ */
+export interface ICostEvidence {
+    contractsWithCost: number;
+    medianMonthlyCost: PriceSpecification;
+    impliedLossRatio: number;
+}
+export interface IPricePredictionBasis {
+    matchTier: TMatchTier;
+    comparableCount: number;
+    contractsWithPrice: number;
+    durationMatched: boolean;
+    vehicleAgeMatched: boolean;
+    startMileageMatched: boolean;
+    requestedStartMileage: number | null;
+    medianComparableStartMileage: number | null;
+    /** Age of the vehicle being priced, from first registration where given, else from model year. */
+    requestedVehicleAgeYears: number | null;
+    /** Median age of the comparable vehicles at the time each of those contracts was sold. */
+    medianComparableVehicleAgeYears: number | null;
+    medianComparableDurationMonths: number;
+    medianComparableMileagePerMonth: number;
+    mileageAdjustment: number;
+    adjustmentFactor: number;
+    annualPriceIndex: number;
+    medianComparableAgeYears: number;
+    /**
+     * Annual drift actually observed between the oldest and newest third of the comparables. Shown
+     * so the applied index can be sanity checked against the data; too noisy on small or
+     * narrow-dated samples to apply automatically.
+     */
+    observedAnnualDrift: number | null;
+    oldestContractStart: string | null;
+    newestContractStart: string | null;
+}
+/**
+ * One estimate of the price. Sources are meant to coexist rather than replace one another: an
+ * added estimate is only worth acting on if it can be read against the others and the evidence.
+ */
+export interface IPriceSuggestion {
+    source: TPriceSuggestionSource;
+    monthlyPrice: PriceSpecification;
+    /** The same figure in sub-units ex-VAT, the unit prices are stored and calculated in. */
+    monthlyPriceMinor: number;
+    /** Adjusted identically to monthlyPrice, so the three figures are directly comparable. */
+    range: {
+        low: PriceSpecification;
+        high: PriceSpecification;
+    };
+    rationale?: string;
+}
+/**
+ * What the model expects this vehicle to need over the term. This is NOT the contract's coverage,
+ * which the template's terms decide. Never quote it as what the customer is entitled to.
+ */
+export interface IAnticipatedServicing {
+    summary: string;
+    items: string[];
+    /**
+     * How many ordinary services fall inside the term. A suggestion for the seller to confirm or
+     * correct, as with the timing belt: it prices an agreement only if they put it there.
+     */
+    ordinaryServicesWithinTerm?: number;
+}
+/**
+ * Whether a timing belt change falls inside the agreed term or mileage. Asked on its own because
+ * it is usually the largest single bill in an agreement, and whether it lands inside the window or
+ * just outside swings the price more than anything else the vehicle will need.
+ */
+export interface ITimingBeltAssessment {
+    dueWithinTerm: 'yes' | 'no' | 'unknown';
+    /** One plain sentence: the interval, where this vehicle sits against it, or that it runs a chain. */
+    note: string;
+    /**
+     * How many changes fall inside the term, where one is due. A suggestion for the seller to
+     * confirm or correct: it is written onto an agreement only if they put it there.
+     */
+    replacementsWithinTerm?: number;
+}
+/**
+ * Whether this electric vehicle is likely to need its HV traction battery replaced during the agreed
+ * term or mileage. Asked only of electric vehicles, and asked because it decides whether a seller
+ * should put the battery on the agreement at all -- it is the largest single thing an agreement
+ * can carry, and the cost is the provider's to bear once it is on there.
+ *
+ * A judgement about the vehicle, not about the warranty: age, distance, chemistry and how hard the
+ * car has been driven. Unknown is a real answer and better than a guess dressed as one.
+ */
+export interface IBatteryAssessment {
+    replacementLikelyWithinTerm: 'yes' | 'no' | 'unknown';
+    /** One plain sentence a seller can repeat: what the battery is likely to do over this term. */
+    note: string;
+}
+/**
+ * What the agreement ought to cover for this vehicle, in the model's own words. Advice for whoever
+ * configures or sells it, never a statement of what a customer has bought.
+ */
+export interface IRecommendedCoverage {
+    summary: string;
+    items: string[];
+}
+/** The model's read on the vehicle. Absent when the integration is disabled or unreachable. */
+export interface IAiReview {
+    confidence: TPredictionConfidence;
+    anticipatedServicing?: IAnticipatedServicing;
+    recommendedCoverage?: IRecommendedCoverage;
+    timingBelt?: ITimingBeltAssessment;
+    battery?: IBatteryAssessment;
+}
+export interface IPricePredictionEvidence {
+    basis: IPricePredictionBasis;
+    /** Prices as recorded on the comparables, before mileage or caller adjustments. */
+    historicalMonthlyPrice: IPricePercentiles;
+    costEvidence?: ICostEvidence;
+    aiReview?: IAiReview;
+}
+export interface IPricePredictionResult {
+    suggestions: IPriceSuggestion[];
+    evidence: IPricePredictionEvidence;
+    caveats: IPredictionCaveat[];
+    confidence: TPredictionConfidence;
+}

package/types/pricePrediction.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * The contract between the API and the clients for a predicted price.
+ *
+ * It lives here because three repositories were keeping their own copy of it by hand. Admin
+ * redeclared the response shape and said so in a comment; superadmin wrote the duration ladder out
+ * as a literal; the ceiling existed as a separate constant in each of the three. A field added on
+ * one side and forgotten on another was caught only by someone remembering to look.
+ *
+ * What stays in the API is what never crosses the wire: how comparables are matched, what the
+ * model is asked, and every tuning constant behind the estimate.
+ */
+/** Agreements are sold in whole years, so every offered term is a multiple of this. */
+exports.PREDICTION_DURATION_STEP_MONTHS = 12;
+/** Nothing longer may be sold, whatever a template asks for. */
+exports.PREDICTION_MAX_DURATION_MONTHS = 108;
+/**
+ * Every term a predicted template may offer when it names none itself: 12, 24 ... up to the
+ * ceiling. Derived rather than written out, so raising the ceiling cannot leave a stale list
+ * behind in another repository.
+ */
+function predictionDurationLadder() {
+    const months = [];
+    for (let m = exports.PREDICTION_DURATION_STEP_MONTHS; m <= exports.PREDICTION_MAX_DURATION_MONTHS; m += exports.PREDICTION_DURATION_STEP_MONTHS) {
+        months.push(m);
+    }
+    return months;
+}
+exports.predictionDurationLadder = predictionDurationLadder;
+/** True for a term that may actually be sold: a whole number of years, up to the ceiling. */
+function isSellablePredictionDuration(months) {
+    return months > 0 && months <= exports.PREDICTION_MAX_DURATION_MONTHS && months % exports.PREDICTION_DURATION_STEP_MONTHS === 0;
+}
+exports.isSellablePredictionDuration = isSellablePredictionDuration;
+/**
+ * The fuel types a predicted template may be restricted to, as the vehicle catalogue spells them.
+ *
+ * A template that names none supports every fuel: an empty restriction is not "nothing", it is
+ * "no restriction", which is what a provider who never thinks about this should get.
+ */
+exports.PREDICTION_FUEL_TYPES = [
+    'Petrol',
+    'Diesel',
+    'Electric',
+    'Hybrid',
+    'Diesel-Electric',
+    'Cng',
+    'Lpg',
+    'Lpg-Petrol',
+    'Lpg-Diesel',
+];
+/**
+ * The same fuel written more than one way. Lookups and imports have filed Danish and Swedish
+ * spellings alongside the canonical English, and a vehicle that arrives as EL must still match a
+ * template that says Electric -- otherwise the restriction silently hides templates that were
+ * meant to be offered.
+ */
+const FUEL_SPELLINGS = [
+    ['PETROL', 'BENZIN', 'BENSIN'],
+    ['ELECTRIC', 'EL', 'EV', 'ELEKTRISK'],
+    ['DIESEL'],
+];
+const canonical = (fuelTypeName) => {
+    const wanted = fuelTypeName.trim().toUpperCase();
+    const group = FUEL_SPELLINGS.find((spellings) => spellings.indexOf(wanted) !== -1);
+    return group ? group[0] : wanted;
+};
+/**
+ * Whether a template restricted to these fuel types may be offered on this vehicle. No restriction
+ * means every fuel; an unknown fuel on the vehicle matches nothing but the absence of a rule.
+ */
+function supportsPredictionFuelType(supported, fuelTypeName) {
+    if (!supported || !supported.length) {
+        return true;
+    }
+    if (!fuelTypeName) {
+        return false;
+    }
+    const wanted = canonical(fuelTypeName);
+    return supported.some((entry) => canonical(entry) === wanted);
+}
+exports.supportsPredictionFuelType = supportsPredictionFuelType;
+//# sourceMappingURL=pricePrediction.js.map

package/types/pricePrediction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pricePrediction.js","sourceRoot":"","sources":["pricePrediction.ts"],"names":[],"mappings":";;AAIA;;;;;;;;;;GAUG;AAEH,uFAAuF;AAC1E,QAAA,+BAA+B,GAAG,EAAE,CAAA;AAEjD,gEAAgE;AACnD,QAAA,8BAA8B,GAAG,GAAG,CAAA;AAEjD;;;;GAIG;AACH,SAAgB,wBAAwB;IACtC,MAAM,MAAM,GAAa,EAAE,CAAA;IAC3B,KACE,IAAI,CAAC,GAAG,uCAA+B,EACvC,CAAC,IAAI,sCAA8B,EACnC,CAAC,IAAI,uCAA+B,EACpC;QACA,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;KACf;IACD,OAAO,MAAM,CAAA;AACf,CAAC;AAVD,4DAUC;AAED,6FAA6F;AAC7F,SAAgB,4BAA4B,CAAC,MAAc;IACzD,OAAO,MAAM,GAAG,CAAC,IAAI,MAAM,IAAI,sCAA8B,IAAI,MAAM,GAAG,uCAA+B,KAAK,CAAC,CAAA;AACjH,CAAC;AAFD,oEAEC;AAGD;;;;;GAKG;AACU,QAAA,qBAAqB,GAAa;IAC7C,QAAQ;IACR,QAAQ;IACR,UAAU;IACV,QAAQ;IACR,iBAAiB;IACjB,KAAK;IACL,KAAK;IACL,YAAY;IACZ,YAAY;CACb,CAAA;AAaD;;;;;GAKG;AACH,MAAM,cAAc,GAAe;IACjC,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC;IAC9B,CAAC,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,CAAC;IACrC,CAAC,QAAQ,CAAC;CACX,CAAA;AAED,MAAM,SAAS,GAAG,CAAC,YAAoB,EAAU,EAAE;IACjD,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAA;IAChD,MAAM,KAAK,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IAElF,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAA;AAClC,CAAC,CAAA;AAED;;;GAGG;AACH,SAAgB,0BAA0B,CACxC,SAAsC,EACtC,YAAuC;IAEvC,IAAI,CAAC,SAAS,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE;QACnC,OAAO,IAAI,CAAA;KACZ;IAED,IAAI,CAAC,YAAY,EAAE;QACjB,OAAO,KAAK,CAAA;KACb;IAED,MAAM,MAAM,GAAG,SAAS,CAAC,YAAY,CAAC,CAAA;IAEtC,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,MAAM,CAAC,CAAA;AAC/D,CAAC;AAfD,gEAeC"}

package/types/pricePrediction.ts

@@ -0,0 +1,320 @@
+import { IsoLocale } from './locale'
+import { PriceSpecification } from './priceSpecification'
+import { TVehicleType } from './vehicle'
+
+/**
+ * The contract between the API and the clients for a predicted price.
+ *
+ * It lives here because three repositories were keeping their own copy of it by hand. Admin
+ * redeclared the response shape and said so in a comment; superadmin wrote the duration ladder out
+ * as a literal; the ceiling existed as a separate constant in each of the three. A field added on
+ * one side and forgotten on another was caught only by someone remembering to look.
+ *
+ * What stays in the API is what never crosses the wire: how comparables are matched, what the
+ * model is asked, and every tuning constant behind the estimate.
+ */
+
+/** Agreements are sold in whole years, so every offered term is a multiple of this. */
+export const PREDICTION_DURATION_STEP_MONTHS = 12
+
+/** Nothing longer may be sold, whatever a template asks for. */
+export const PREDICTION_MAX_DURATION_MONTHS = 108
+
+/**
+ * Every term a predicted template may offer when it names none itself: 12, 24 ... up to the
+ * ceiling. Derived rather than written out, so raising the ceiling cannot leave a stale list
+ * behind in another repository.
+ */
+export function predictionDurationLadder(): number[] {
+  const months: number[] = []
+  for (
+    let m = PREDICTION_DURATION_STEP_MONTHS;
+    m <= PREDICTION_MAX_DURATION_MONTHS;
+    m += PREDICTION_DURATION_STEP_MONTHS
+  ) {
+    months.push(m)
+  }
+  return months
+}
+
+/** True for a term that may actually be sold: a whole number of years, up to the ceiling. */
+export function isSellablePredictionDuration(months: number): boolean {
+  return months > 0 && months <= PREDICTION_MAX_DURATION_MONTHS && months % PREDICTION_DURATION_STEP_MONTHS === 0
+}
+
+
+/**
+ * The fuel types a predicted template may be restricted to, as the vehicle catalogue spells them.
+ *
+ * A template that names none supports every fuel: an empty restriction is not "nothing", it is
+ * "no restriction", which is what a provider who never thinks about this should get.
+ */
+export const PREDICTION_FUEL_TYPES: string[] = [
+  'Petrol',
+  'Diesel',
+  'Electric',
+  'Hybrid',
+  'Diesel-Electric',
+  'Cng',
+  'Lpg',
+  'Lpg-Petrol',
+  'Lpg-Diesel',
+]
+
+export type TPredictionFuelType =
+  | 'Petrol'
+  | 'Diesel'
+  | 'Electric'
+  | 'Hybrid'
+  | 'Diesel-Electric'
+  | 'Cng'
+  | 'Lpg'
+  | 'Lpg-Petrol'
+  | 'Lpg-Diesel'
+
+/**
+ * The same fuel written more than one way. Lookups and imports have filed Danish and Swedish
+ * spellings alongside the canonical English, and a vehicle that arrives as EL must still match a
+ * template that says Electric -- otherwise the restriction silently hides templates that were
+ * meant to be offered.
+ */
+const FUEL_SPELLINGS: string[][] = [
+  ['PETROL', 'BENZIN', 'BENSIN'],
+  ['ELECTRIC', 'EL', 'EV', 'ELEKTRISK'],
+  ['DIESEL'],
+]
+
+const canonical = (fuelTypeName: string): string => {
+  const wanted = fuelTypeName.trim().toUpperCase()
+  const group = FUEL_SPELLINGS.find((spellings) => spellings.indexOf(wanted) !== -1)
+
+  return group ? group[0] : wanted
+}
+
+/**
+ * Whether a template restricted to these fuel types may be offered on this vehicle. No restriction
+ * means every fuel; an unknown fuel on the vehicle matches nothing but the absence of a rule.
+ */
+export function supportsPredictionFuelType(
+  supported: string[] | null | undefined,
+  fuelTypeName: string | null | undefined,
+): boolean {
+  if (!supported || !supported.length) {
+    return true
+  }
+
+  if (!fuelTypeName) {
+    return false
+  }
+
+  const wanted = canonical(fuelTypeName)
+
+  return supported.some((entry) => canonical(entry) === wanted)
+}
+
+/**
+ * How closely the comparable contracts had to match the requested vehicle. Tiers are tried in
+ * order and the first with enough samples wins, so a wide tier signals a weak estimate.
+ */
+export type TMatchTier = 'BrandModelFuel' | 'BrandFuelPower' | 'BrandFuel' | 'FuelPower' | 'Fuel'
+
+export type TPredictionConfidence = 'high' | 'medium' | 'low'
+
+export type TPriceSuggestionSource = 'Comparables' | 'AI'
+
+/**
+ * Why an estimate may be weaker than its single number suggests. Sent as a code and parameters
+ * rather than a sentence: a quote is read on a Danish, Swedish, Finnish or Norwegian screen, and
+ * English prose from the server would land untranslated in the middle of it.
+ *
+ * A client may render only the codes it knows and drop the rest, so the API can add one without
+ * waiting for every client. A dropped code is a reason the seller never sees, though, so a client
+ * that maps these should aim to map all of them.
+ */
+export type TPredictionCaveatCode =
+  | 'VEHICLE_AGE_UNKNOWN'
+  | 'VEHICLE_AGE_OUTSIDE_COMPARABLES'
+  | 'START_MILEAGE_UNKNOWN'
+  | 'START_MILEAGE_OUTSIDE_COMPARABLES'
+  | 'DURATION_OUTSIDE_COMPARABLES'
+  | 'TOO_FEW_COMPARABLES'
+  | 'SMALL_COMPARABLE_SAMPLE'
+  | 'NO_BRAND_OR_MODEL_HISTORY'
+  | 'MILEAGE_OUTSIDE_COMPARABLES'
+  | 'COST_UNVERIFIED'
+  | 'SEGMENT_UNDERPRICED'
+  | 'COMPARABLES_STALE'
+  | 'AI_DIVERGES_FROM_COMPARABLES'
+  | 'TIMING_BELT_DUE_IN_TERM'
+  | 'PRICED_BY_AI_WITHOUT_COMPARABLES'
+
+export interface IPredictionCaveat {
+  code: TPredictionCaveatCode
+  params?: { [key: string]: string | number }
+  /** English, for the admin prediction endpoint only. Never render this to a customer. */
+  message: string
+}
+
+export interface IPricePredictionRequest {
+  brand: string
+  model: string
+  fuelType: string
+  modelYear?: number
+  /** Preferred over modelYear for the vehicle's age: it is set on far more vehicles. */
+  dateVehicleFirstRegistered?: string
+  engineMaxPower?: number
+  vehicleType?: TVehicleType
+  /** Odometer when the agreement starts, not the allowance it grants. */
+  startMileage?: number
+  /** The reader's own locale. Their choice wins over the provider's, which stands in when absent. */
+  locale?: IsoLocale
+  durationMonths: number
+  /** Allowance over the whole contract, not per year. */
+  mileage: number
+  adjustmentFactor?: number
+  /** Annual price drift used to bring old comparables into today's money, e.g. 0.03 for 3%. */
+  annualPriceIndex?: number
+  /**
+   * Whether the servicing and coverage advice is wanted alongside the price. Defaults to true.
+   * Asking for prose nobody reads is most of the output bill and most of the wait, so a caller
+   * that shows the price alone should say so.
+   */
+  withAdvice?: boolean
+}
+
+export interface IPricePercentiles {
+  p25: PriceSpecification
+  p50: PriceSpecification
+  p75: PriceSpecification
+}
+
+/**
+ * Realized workshop cost for the same comparables. Only populated when enough of them actually
+ * carry cost data, otherwise absence of claims is indistinguishable from claims never recorded.
+ */
+export interface ICostEvidence {
+  contractsWithCost: number
+  medianMonthlyCost: PriceSpecification
+  impliedLossRatio: number
+}
+
+export interface IPricePredictionBasis {
+  matchTier: TMatchTier
+  comparableCount: number
+  contractsWithPrice: number
+  durationMatched: boolean
+  vehicleAgeMatched: boolean
+  startMileageMatched: boolean
+  requestedStartMileage: number | null
+  medianComparableStartMileage: number | null
+  /** Age of the vehicle being priced, from first registration where given, else from model year. */
+  requestedVehicleAgeYears: number | null
+  /** Median age of the comparable vehicles at the time each of those contracts was sold. */
+  medianComparableVehicleAgeYears: number | null
+  medianComparableDurationMonths: number
+  medianComparableMileagePerMonth: number
+  mileageAdjustment: number
+  adjustmentFactor: number
+  annualPriceIndex: number
+  medianComparableAgeYears: number
+  /**
+   * Annual drift actually observed between the oldest and newest third of the comparables. Shown
+   * so the applied index can be sanity checked against the data; too noisy on small or
+   * narrow-dated samples to apply automatically.
+   */
+  observedAnnualDrift: number | null
+  oldestContractStart: string | null
+  newestContractStart: string | null
+}
+
+/**
+ * One estimate of the price. Sources are meant to coexist rather than replace one another: an
+ * added estimate is only worth acting on if it can be read against the others and the evidence.
+ */
+export interface IPriceSuggestion {
+  source: TPriceSuggestionSource
+  monthlyPrice: PriceSpecification
+  /** The same figure in sub-units ex-VAT, the unit prices are stored and calculated in. */
+  monthlyPriceMinor: number
+  /** Adjusted identically to monthlyPrice, so the three figures are directly comparable. */
+  range: { low: PriceSpecification; high: PriceSpecification }
+  rationale?: string
+}
+
+/**
+ * What the model expects this vehicle to need over the term. This is NOT the contract's coverage,
+ * which the template's terms decide. Never quote it as what the customer is entitled to.
+ */
+export interface IAnticipatedServicing {
+  summary: string
+  items: string[]
+  /**
+   * How many ordinary services fall inside the term. A suggestion for the seller to confirm or
+   * correct, as with the timing belt: it prices an agreement only if they put it there.
+   */
+  ordinaryServicesWithinTerm?: number
+}
+
+/**
+ * Whether a timing belt change falls inside the agreed term or mileage. Asked on its own because
+ * it is usually the largest single bill in an agreement, and whether it lands inside the window or
+ * just outside swings the price more than anything else the vehicle will need.
+ */
+export interface ITimingBeltAssessment {
+  dueWithinTerm: 'yes' | 'no' | 'unknown'
+  /** One plain sentence: the interval, where this vehicle sits against it, or that it runs a chain. */
+  note: string
+  /**
+   * How many changes fall inside the term, where one is due. A suggestion for the seller to
+   * confirm or correct: it is written onto an agreement only if they put it there.
+   */
+  replacementsWithinTerm?: number
+}
+
+/**
+ * Whether this electric vehicle is likely to need its HV traction battery replaced during the agreed
+ * term or mileage. Asked only of electric vehicles, and asked because it decides whether a seller
+ * should put the battery on the agreement at all -- it is the largest single thing an agreement
+ * can carry, and the cost is the provider's to bear once it is on there.
+ *
+ * A judgement about the vehicle, not about the warranty: age, distance, chemistry and how hard the
+ * car has been driven. Unknown is a real answer and better than a guess dressed as one.
+ */
+export interface IBatteryAssessment {
+  replacementLikelyWithinTerm: 'yes' | 'no' | 'unknown'
+  /** One plain sentence a seller can repeat: what the battery is likely to do over this term. */
+  note: string
+}
+
+/**
+ * What the agreement ought to cover for this vehicle, in the model's own words. Advice for whoever
+ * configures or sells it, never a statement of what a customer has bought.
+ */
+export interface IRecommendedCoverage {
+  summary: string
+  items: string[]
+}
+
+/** The model's read on the vehicle. Absent when the integration is disabled or unreachable. */
+export interface IAiReview {
+  confidence: TPredictionConfidence
+  anticipatedServicing?: IAnticipatedServicing
+  recommendedCoverage?: IRecommendedCoverage
+  timingBelt?: ITimingBeltAssessment
+  battery?: IBatteryAssessment
+}
+
+export interface IPricePredictionEvidence {
+  basis: IPricePredictionBasis
+  /** Prices as recorded on the comparables, before mileage or caller adjustments. */
+  historicalMonthlyPrice: IPricePercentiles
+  costEvidence?: ICostEvidence
+  aiReview?: IAiReview
+}
+
+export interface IPricePredictionResult {
+  suggestions: IPriceSuggestion[]
+  evidence: IPricePredictionEvidence
+  caveats: IPredictionCaveat[]
+  confidence: TPredictionConfidence
+}

package/types/providerDocument.d.ts

@@ -16,16 +16,9 @@ export interface IProviderDocument {
 // Admin sees the document and its upload date only — no internal staff names.
 export interface IProviderDocumentAdminView extends IProviderDocument {}
 
-export interface IProviderDocumentGroup {
-  contractProviderGroupId: number
-  name: string
-}
-
-// Superadmin also sees the acting support users, the tombstone state, and the sharing groups, sorted by
-// name. `groups` is empty on a provider-owned row.
+// Superadmin additionally sees the acting support users and the tombstone state.
 export interface IProviderDocumentSuperadminView extends IProviderDocument {
   uploadedByName: string | null
   deletedAt: string | null
   deletedByName: string | null
-  groups: IProviderDocumentGroup[]
 }

package/types/responseErrors/index.d.ts

@@ -1,7 +1,6 @@
 import { AdjustmentRequestResponseErrors } from './adjustmentRequestResponseErrors'
 import { AdminPaymentErrors } from './adminPaymentErrors'
 import { CalculatorResponseErrors } from './calculatorResponseErrors'
-import { ContractProviderGroupErrors } from './contractProviderGroupErrors'
 import { ContractResponseErrors } from './contractResponseErrors'
 import { GenericResponseErrors } from './genericResponseTypes'
 import { ImportErrors } from './importErrors'
@@ -18,7 +17,6 @@ export type ResponseErrors =
   | AdjustmentRequestResponseErrors
   | AdminPaymentErrors
   | CalculatorResponseErrors
-  | ContractProviderGroupErrors
   | ContractResponseErrors
   | GenericResponseErrors
   | ImportErrors

package/types/contractProviderGroup.d.ts

@@ -1,58 +0,0 @@
-import { ProviderState } from './contractProvider'
-import { EmailCampaignStatus } from './emailCampaign'
-
-export interface IContractProviderGroupMember {
-  contractProviderId: number
-  administrativeName: string
-  isoName: string // country
-  state: ProviderState // lets every picker count Inactive members
-}
-
-export interface IProviderGroupTag {
-  providerGroupTagId: number
-  name: string
-}
-
-export interface IContractProviderGroupListItem {
-  contractProviderGroupId: number
-  name: string
-  description: string | null
-  tags: IProviderGroupTag[]
-  memberCount: number
-  inactiveMemberCount: number
-  archivedAt: string | null // ISO
-  updatedByEmail: string // 'USER NOT FOUND' when the acting user is gone
-}
-
-export type IContractProviderGroupDetail = IContractProviderGroupListItem & {
-  members: IContractProviderGroupMember[]
-  createdAt: string // ISO
-  updatedAt: string // ISO
-}
-
-export interface IContractProviderGroupUsage {
-  accessKeys: { accessKeyId: number; description: string | null }[]
-  emailCampaigns: { id: number; name: string; status: EmailCampaignStatus }[]
-  blacklistEntryCount: number
-  documentCount: number
-  dashboardBannerCount: number
-  featureFlagCount: number
-}
-
-export interface IUpsertContractProviderGroupRequest {
-  name: string
-  description: string | null
-  tags: string[]
-  contractProviderIds: number[]
-}
-
-// The provider-side view of membership: every joinable group, plus any archived group this provider is
-// still in (archived groups can be left but not joined).
-export interface IContractProviderGroupMembership {
-  groups: IContractProviderGroupListItem[]
-  memberGroupIds: number[]
-}
-
-export interface ISetContractProviderGroupsRequest {
-  contractProviderGroupIds: number[] // the full set for one provider; the api diffs it against what is stored
-}

package/types/responseErrors/contractProviderGroupErrors.d.ts

@@ -1,4 +0,0 @@
-export type ContractProviderGroupErrors =
-  | 'CONTRACT_PROVIDER_GROUP_NAME_TAKEN'
-  | 'CONTRACT_PROVIDER_GROUP_IN_USE'
-  | 'CONTRACT_PROVIDER_GROUP_DOCUMENT_SHARED'