Shared Types

/**
 * @format uuid
 */
export type UUID = string;

/**
 * @format email
 */
export type Email = string;

/**
 * @format uri
 * @pattern ^https?://
 */
export type URL = string;

/**
 * @format date-time
 * @pattern ^([0-9]+)-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])[Tt]([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)(\.[0-9]+)?(([Zz])|([\ +|\-]([01][0-9]|2[0-3]):[0-5][0-9]))$
 */
export type DateTime = string;

/**
 * @format date
 */
export type Date = string;

export type Area = {
  squareMetres: number;
  hectares?: number;
};

export type Integer = number;

export interface SiteAddress {
  /** Single line address description */
  title: string;
  /** Easting coordinate in British National Grid (OSGB36) */
  x: number;
  /** Northing coordinate in British National Grid (OSGB36) */
  y: number;
  /** Latitude coordinate in EPSG:4326 (WGS84) */
  latitude: number;
  /** Longitude coordinate in EPSG:4326 (WGS84) */
  longitude: number;
}

export interface ProposedAddress extends SiteAddress {
  source: 'Proposed by applicant';
}

export interface OSAddress extends SiteAddress {
  /** Unique Property Reference Number (max 12 characters) */
  uprn: string;
  /** Unique Street Reference Number (max 8 characters) */
  usrn: string;
  /** Primary Addressable Object (PAO) start and/or description */
  pao: string;
  /** Primary Addressable Object (PAO) end range */
  paoEnd?: string;
  /** Secondary Addressable Object (SAO) start and/or description */
  sao?: string;
  /** Secondary Addressable Object (SAO) end range */
  saoEnd?: string;
  street: string;
  town: string;
  postcode: string;
  organisation?: string;
  singleLine: string;
  source: 'Ordnance Survey';
}

export interface Address {
  line1: string;
  line2?: string;
  town: string;
  county?: string;
  postcode: string;
  country?: string;
}

export type UserAddress = {sameAsSiteAddress: true} | UserAddressNotSameSite;

export interface UserAddressNotSameSite extends Address {
  sameAsSiteAddress: false;
}

export type ContactDetails = {
  name: {
    title?: string;
    first: string;
    last: string;
  };
  email: Email;
  phone: {
    primary: string;
  };
  company?: {
    name: string;
  };
};

export interface User {
  role: 'applicant' | 'agent' | 'proxy';
}

export interface Response {
  value: string;
  metadata?: ResponseMetaData;
}

export interface ResponseMetaData {
  flags?: Array<string>;
  options?: Array<string> | Array<Response>;
}

export interface QuestionAndResponses {
  question: string;
  responses: Array<Response> | string;
  metadata?: QuestionMetaData;
}

export interface QuestionMetaData {
  autoAnswered?: boolean;
  policyRefs?: Array<{
    text: string;
    url?: URL;
  }>;
  sectionName?: string;
  id?: string;
  tags?: Array<string>;
}

export type Responses = QuestionAndResponses[];

export type Site = {
  /** The property address */
  address: ProposedAddress | OSAddress;
  /** Development corporations containing this address */
  developmentCorporations?: string[];
  /** UK Local Authority Districts (LAD) */
  localAuthorityDistrict: string[];
  /** UK Local Planning Authorities (LPA) */
  localPlanningAuthority?: string[];
  /** Ward name */
  ward: string;
  /** Region name */
  region: Region;
  /** HM Land Registry boundary (blue line) */
  boundary?: GeoBoundary;
};

export type OwnersInterest =
  | 'owner'
  | 'owner.sole'
  | 'owner.co'
  | 'lessee'
  | 'occupier'
  | 'other';

export interface Ownership {
  interest?: OwnersInterest;
  interestDescription?: string;
  certificate?: 'a' | 'b' | 'c' | 'd';
  /** Does the land have any agricultural tenants? */
  agriculturalTenants?: boolean;
  /** Has requisite notice been given? */
  noticeGiven?: boolean;
  /** Has notice been published in a newspaper? */
  noticePublished?: {
    status: boolean;
    date?: Date;
    newspaperName?: string;
  };
  /** Do you know the names of all owners? */
  ownersKnown?: 'all' | 'some' | 'none';
  owners?: Owners[];
  /** Declaration of accuracy */
  declaration?: {
    accurate: true;
  };
}

export type Owners = OwnersNoticeGiven | OwnersNoNoticeGiven | OwnersNoticeDate;

export interface BaseOwners {
  name: string;
  address: Address;
}

export interface OwnersNoticeDate extends BaseOwners {
  noticeDate: Date;
}

export interface OwnersInterestedInLand extends BaseOwners {
  interest: string;
}

export interface OwnersNoticeGiven extends OwnersInterestedInLand {
  noticeGiven: true;
}

export interface OwnersNoNoticeGiven extends OwnersInterestedInLand {
  noticeGiven: false;
  noNoticeReason: string;
}

export interface Declaration {
  accurate: boolean;
  connection: {
    value:
      | 'employee'
      | 'relation.employee'
      | 'electedMember'
      | 'relation.electedMember'
      | 'none';
    description?: string;
  };
}

export interface Fee {
  /** Total calculated fee in GBP */
  calculated: number;
  /** Total calculated VAT in GBP */
  calculatedVAT?: number;
  /** Total payable fee after exemptions in GBP */
  payable: number;
  /** Total payable VAT in GBP */
  payableVAT?: number;
  /** PlanX service charge in GBP */
  serviceCharge?: number;
  serviceChargeVAT?: number;
  /** Fast Track fee in GBP */
  fastTrack?: number;
  fastTrackVAT?: number;
  /** Payment processing fee in GBP */
  paymentProcessing?: number;
  paymentProcessingVAT?: number;
  /** Breakdown by category */
  category?: {
    one?: number;      // New homes
    two?: number;      // Other new buildings
    three?: number;    // Agricultural buildings
    four?: number;     // Glasshouses
    five?: number;     // Plant equipment
    sixAndSeven?: number; // Home or curtilage
    eight?: number;    // Car parks
    nine?: number;     // Exploratory drilling
    ten?: number;      // Oil or gas
    eleven?: { one?: number; two?: number; };
    twelve?: { one?: number; two?: number; };
    thirteen?: number; // Waste disposal
    fourteen?: number; // Other change of use
  };
  exemption: {
    disability: boolean;
    resubmission: boolean;
  };
  reduction: {
    alternative: boolean;
    parishCouncil: boolean;
    sports: boolean;
  };
  reference?: {
    govPay: string;
    metadata?: Record<string, string | number | boolean>;
  };
}

export interface FeeNotApplicable {
  notApplicable: true;
}

export type Materials = {
  boundary?: string;
  ceiling?: string;
  chimney?: string;
  door?: string;
  doorInternal?: string;
  floor?: string;
  lighting?: string;
  rainwater?: string;
  roof?: string;
  surface?: string;
  wall?: string;
  wallInternal?: string;
  window?: string;
  other?: string;
};