feat(OpenAPI): Migrate from api-typings to openapi spec

BREAKING CHANGE: Core-Interface typings now uses
@ideal-postcodes/openapi

Author: cblanc

README.md

@@ -24,7 +24,7 @@ If you are looking for the browser or Node.js client which implements this inter
 - [API Documentation](https://core-interface.ideal-postcodes.dev/)
 - [npm Module](https://www.npmjs.com/package/@ideal-postcodes/core-interface)
 - [GitHub Repository](https://github.com/ideal-postcodes/core-interface)
-- [Typings Repository](https://github.com/ideal-postcodes/api-typings)
+- [Typings Repository](https://github.com/ideal-postcodes/openapi)
 - [Fixtures Repository](https://github.com/ideal-postcodes/api-fixtures)
 
 ## Downstream Clients

lib/error.ts

@@ -5,7 +5,9 @@
  */
 
 import { HttpResponse } from "./agent";
-import { ApiErrorResponse } from "@ideal-postcodes/api-typings";
+import { components } from "@ideal-postcodes/openapi";
+
+export type ApiErrorResponse = components["schemas"]["ErrorResponse"];
 
 /**
  * IdealPostcodesErrorOptions

lib/helpers.ts

@@ -21,7 +21,13 @@ import {
   IdpcUmprnNotFoundError,
   IdpcUdprnNotFoundError,
 } from "./error";
-import { Address, KeyStatus } from "@ideal-postcodes/api-typings";
+import {
+  UkAddress,
+  PafAddress,
+  NybAddress,
+  MrAddress,
+  KeyStatus,
+} from "./types";
 import {
   Authenticable,
   Filterable,
@@ -166,7 +172,7 @@ export const ping = (client: Client): Promise<HttpResponse> => {
  */
 export const lookupPostcode = (
   options: LookupPostcodeOptions
-): Promise<Address[]> => {
+): Promise<PafAddress[]> => {
   const queryOptions = toAddressIdQuery(options);
 
   const { page } = options;
@@ -190,7 +196,7 @@ export const lookupPostcode = (
  */
 export const lookupAddress = (
   options: LookupAddressOptions
-): Promise<Address[]> => {
+): Promise<UkAddress[]> => {
   const header: StringMap = {};
   const query: StringMap = { query: options.query };
   const { client } = options;
@@ -243,7 +249,7 @@ const toAddressIdQuery = (options: LookupIdOptions): Request => {
  */
 export const lookupUdprn = (
   options: LookupUdprnOptions
-): Promise<Address | null> => {
+): Promise<PafAddress | NybAddress | null> => {
   const queryOptions = toAddressIdQuery(options);
   return udprn
     .retrieve(options.client, options.udprn.toString(), queryOptions)
@@ -265,7 +271,7 @@ export const lookupUdprn = (
  */
 export const lookupUmprn = (
   options: LookupUmprnOptions
-): Promise<Address | null> => {
+): Promise<MrAddress | null> => {
   const queryOptions = toAddressIdQuery(options);
   return umprn
     .retrieve(options.client, options.umprn.toString(), queryOptions)

lib/resources/addresses.ts

@@ -1,5 +1,5 @@
 import { listMethod } from "./resource";
-import { AddressQueryResponse } from "@ideal-postcodes/api-typings";
+import { AddressResponse } from "../types";
 import { OptionalStringMap } from "../util";
 import { Client } from "../client";
 import { HttpResponse } from "../agent";
@@ -53,7 +53,7 @@ export interface Request {
 }
 
 export interface Response extends HttpResponse {
-  body: AddressQueryResponse;
+  body: AddressResponse;
 }
 
 const resource = "addresses";
@@ -63,4 +63,4 @@ export interface List {
 }
 
 export const list: List = (client, request) =>
-  listMethod<Request, AddressQueryResponse>({ resource, client })(request);
+  listMethod<Request, AddressResponse>({ resource, client })(request);

lib/resources/keys.ts

@@ -3,7 +3,7 @@ import {
   PublicKeyResponse,
   PrivateKeyResponse,
   KeyUsageResponse,
-} from "@ideal-postcodes/api-typings";
+} from "../types";
 import { OptionalStringMap } from "../util";
 import { Client } from "../client";
 import { HttpResponse } from "../agent";

lib/resources/postcodes.ts

@@ -1,5 +1,5 @@
 import { retrieveMethod } from "./resource";
-import { PostcodesResponse } from "@ideal-postcodes/api-typings";
+import { PostcodesResponse } from "../types";
 import { OptionalStringMap } from "../util";
 import { Client } from "../client";
 import { HttpResponse } from "../agent";

lib/resources/udprn.ts

@@ -1,5 +1,5 @@
 import { retrieveMethod } from "./resource";
-import { UdprnResponse } from "@ideal-postcodes/api-typings";
+import { UdprnResponse } from "../types";
 import { OptionalStringMap } from "../util";
 import { Client } from "../client";
 import { HttpResponse } from "../agent";

lib/resources/umprn.ts

@@ -1,5 +1,5 @@
 import { retrieveMethod } from "./resource";
-import { UmprnResponse } from "@ideal-postcodes/api-typings";
+import { UmprnResponse } from "../types";
 import { OptionalStringMap } from "../util";
 import { Client } from "../client";
 import { HttpResponse } from "../agent";

lib/types.ts

@@ -2,7 +2,44 @@
  * @module Misc Types
  */
 
-import { Address } from "@ideal-postcodes/api-typings";
+import { paths, components } from "@ideal-postcodes/openapi";
+
+export type AddressResponse =
+  paths["/addresses"]["get"]["responses"][200]["content"]["application/json"];
+
+export type AddressSuggestionResponse =
+  paths["/autocomplete/addresses"]["get"]["responses"][200]["content"]["application/json"];
+
+export type GbrResolveResponse =
+  paths["/autocomplete/addresses/{address}/gbr"]["get"]["responses"][200]["content"]["application/json"];
+
+export type PublicKeyResponse =
+  paths["/keys/{key}"]["get"]["responses"][200]["content"]["application/json"];
+
+export type PrivateKeyResponse =
+  paths["/keys/{key}/details"]["get"]["responses"][200]["content"]["application/json"];
+
+export type KeyUsageResponse =
+  paths["/keys/{key}/usage"]["get"]["responses"][200]["content"]["application/json"];
+
+export type PostcodesResponse =
+  paths["/postcodes/{postcode}"]["get"]["responses"][200]["content"]["application/json"];
+
+export type UdprnResponse =
+  paths["/udprn/{udprn}"]["get"]["responses"][200]["content"]["application/json"];
+
+export type UmprnResponse =
+  paths["/umprn/{umprn}"]["get"]["responses"][200]["content"]["application/json"];
+
+export type KeyStatus = components["schemas"]["ApiKey"];
+
+export type PafAddress = components["schemas"]["PafAddress"];
+
+export type MrAddress = components["schemas"]["MrAddress"];
+
+export type NybAddress = components["schemas"]["NybAddress"];
+
+export type UkAddress = PafAddress | MrAddress | NybAddress;
 
 /**
  * Authenticable
@@ -35,7 +72,7 @@ export interface AdminAuthenticable {
 /**
  * Address object attributes
  */
-export type AddressKeys = keyof Address;
+export type AddressKeys = keyof components["schemas"]["PafAddress"];
 
 /**
  * Filterable