@ideal-postcodes/core-interface - npm Package Compare versions

Comparing version 2.0.2 to 2.0.3

CHANGELOG.md

@@ -0,1 +1,8 @@
+## [2.0.3](https://github.com/ideal-postcodes/core-interface/compare/2.0.2...2.0.3) (2021-07-23)
+
+
+### Bug Fixes
+
+* **ESM:** Pin target output to ES2020 ([78a8b74](https://github.com/ideal-postcodes/core-interface/commit/78a8b7464290710b69bb9d9abbff5413cfc7dca6))
+
 ## [2.0.2](https://github.com/ideal-postcodes/core-interface/compare/2.0.1...2.0.2) (2021-07-19)
@@ -2,0 +9,0 @@

dist/agent.d.ts

@@ -45,4 +45,2 @@ /**
 /**
- * HttpRequest
- *
  * Describes HTTP request
@@ -49,0 +47,0 @@ */

dist/resources/addresses.d.ts

@@ -8,3 +8,3 @@ import { AddressQueryResponse } from "@ideal-postcodes/api-typings";
  */
-interface Query extends OptionalStringMap {
+export interface Query extends OptionalStringMap {
     api_key?: string;
@@ -37,3 +37,3 @@ licensee?: string;
 }
-interface Request {
+export interface Request {
     query?: Query;
@@ -43,3 +43,3 @@ header?: Header;
 }
-interface Response extends HttpResponse {
+export interface Response extends HttpResponse {
     body: AddressQueryResponse;
@@ -46,0 +46,0 @@ }

dist/resources/autocomplete.d.ts

@@ -5,3 +5,3 @@ import { AddressSuggestionResponse } from "@ideal-postcodes/api-typings";
 import { HttpResponse } from "../agent";
-interface Query extends OptionalStringMap {
+export interface Query extends OptionalStringMap {
     api_key?: string;
@@ -33,3 +33,3 @@ licensee?: string;
 }
-interface Request {
+export interface Request {
     query?: Query;
@@ -39,3 +39,3 @@ header?: Header;
 }
-interface Response extends HttpResponse {
+export interface Response extends HttpResponse {
     body: AddressSuggestionResponse;
@@ -42,0 +42,0 @@ }

dist/resources/keys.d.ts

@@ -5,6 +5,6 @@ import { PublicKeyResponse, PrivateKeyResponse, KeyUsageResponse } from "@ideal-postcodes/api-typings";
 import { HttpResponse } from "../agent";
-interface RetrieveQuery extends OptionalStringMap {
+export interface RetrieveQuery extends OptionalStringMap {
     user_token?: string;
 }
-interface RetrieveUsageQuery extends RetrieveQuery {
+export interface RetrieveUsageQuery extends RetrieveQuery {
     start?: string;
@@ -18,3 +18,3 @@ end?: string;
 }
-interface Request {
+export interface Request {
     query?: RetrieveQuery;
@@ -24,10 +24,10 @@ header?: Header;
 }
-interface UsageRequest extends Request {
+export interface UsageRequest extends Request {
     query?: RetrieveUsageQuery;
 }
-declare type KeyResponse = PublicKeyResponse | PrivateKeyResponse;
-interface Response extends HttpResponse {
+export declare type KeyResponse = PublicKeyResponse | PrivateKeyResponse;
+export interface Response extends HttpResponse {
     body: KeyResponse;
 }
-interface UsageResponse extends HttpResponse {
+export interface UsageResponse extends HttpResponse {
     body: KeyUsageResponse;
@@ -34,0 +34,0 @@ }

dist/resources/postcodes.d.ts

@@ -5,3 +5,3 @@ import { PostcodesResponse } from "@ideal-postcodes/api-typings";
 import { HttpResponse } from "../agent";
-interface Query extends OptionalStringMap {
+export interface Query extends OptionalStringMap {
     api_key?: string;
@@ -17,3 +17,3 @@ licensee?: string;
 }
-interface Request {
+export interface Request {
     query?: Query;
@@ -23,3 +23,3 @@ header?: Header;
 }
-interface Response extends HttpResponse {
+export interface Response extends HttpResponse {
     body: PostcodesResponse;
@@ -26,0 +26,0 @@ }

dist/resources/resource.d.ts

 import { OptionalStringMap } from "../util";
 import { Client } from "../client";
 import { HttpResponse } from "../agent";
-interface Options {
+export interface Options {
     resource: string;
@@ -14,3 +14,3 @@ action?: string;
 }
-interface Response<U> extends HttpResponse {
+export interface Response<U> extends HttpResponse {
     body: U;
@@ -20,2 +20,1 @@ }
 export declare const listMethod: <T extends Request, U>(options: Options) => (request: T) => Promise<Response<U>>;
-export {};

dist/resources/udprn.d.ts

@@ -5,3 +5,3 @@ import { UdprnResponse } from "@ideal-postcodes/api-typings";
 import { HttpResponse } from "../agent";
-interface Query extends OptionalStringMap {
+export interface Query extends OptionalStringMap {
     api_key?: string;
@@ -12,7 +12,7 @@ licensee?: string;
 }
-interface Header extends OptionalStringMap {
+export interface Header extends OptionalStringMap {
     Authorization?: string;
     "IDPC-Source-IP"?: string;
 }
-interface Request {
+export interface Request {
     query?: Query;
@@ -22,3 +22,3 @@ header?: Header;
 }
-interface Response extends HttpResponse {
+export interface Response extends HttpResponse {
     body: UdprnResponse;
@@ -30,2 +30,1 @@ }
 export declare const retrieve: Retrieve;
-export {};

dist/resources/umprn.d.ts

@@ -5,3 +5,3 @@ import { UmprnResponse } from "@ideal-postcodes/api-typings";
 import { HttpResponse } from "../agent";
-interface Query extends OptionalStringMap {
+export interface Query extends OptionalStringMap {
     api_key?: string;
@@ -12,7 +12,7 @@ licensee?: string;
 }
-interface Header extends OptionalStringMap {
+export interface Header extends OptionalStringMap {
     Authorization?: string;
     "IDPC-Source-IP"?: string;
 }
-interface Request {
+export interface Request {
     query?: Query;
@@ -22,3 +22,3 @@ header?: Header;
 }
-interface Response extends HttpResponse {
+export interface Response extends HttpResponse {
     body: UmprnResponse;
@@ -30,2 +30,1 @@ }
 export declare const retrieve: Retrieve;
-export {};

esm/agent.d.ts

@@ -45,4 +45,2 @@ /**
 /**
- * HttpRequest
- *
  * Describes HTTP request
@@ -49,0 +47,0 @@ */

esm/client.js

@@ -27,3 +27,2 @@ /**
 export class Client {
-    config;
     constructor(config) {
@@ -30,0 +29,0 @@ this.config = { ...defaults, ...config };

esm/error.js

@@ -15,5 +15,2 @@ /**
 export class IdealPostcodesError extends Error {
-    __proto__;
-    httpStatus;
-    metadata;
     /**
@@ -44,6 +41,2 @@ * Instantiate IdealPostcodesError
     /**
-     * Raw HTTP response
-     */
-    response;
-    /**
      * Returns an API error instance
@@ -50,0 +43,0 @@ */

esm/resources/addresses.d.ts

@@ -8,3 +8,3 @@ import { AddressQueryResponse } from "@ideal-postcodes/api-typings";
  */
-interface Query extends OptionalStringMap {
+export interface Query extends OptionalStringMap {
     api_key?: string;
@@ -37,3 +37,3 @@ licensee?: string;
 }
-interface Request {
+export interface Request {
     query?: Query;
@@ -43,3 +43,3 @@ header?: Header;
 }
-interface Response extends HttpResponse {
+export interface Response extends HttpResponse {
     body: AddressQueryResponse;
@@ -46,0 +46,0 @@ }

esm/resources/autocomplete.d.ts

@@ -5,3 +5,3 @@ import { AddressSuggestionResponse } from "@ideal-postcodes/api-typings";
 import { HttpResponse } from "../agent";
-interface Query extends OptionalStringMap {
+export interface Query extends OptionalStringMap {
     api_key?: string;
@@ -33,3 +33,3 @@ licensee?: string;
 }
-interface Request {
+export interface Request {
     query?: Query;
@@ -39,3 +39,3 @@ header?: Header;
 }
-interface Response extends HttpResponse {
+export interface Response extends HttpResponse {
     body: AddressSuggestionResponse;
@@ -42,0 +42,0 @@ }

esm/resources/keys.d.ts

@@ -5,6 +5,6 @@ import { PublicKeyResponse, PrivateKeyResponse, KeyUsageResponse } from "@ideal-postcodes/api-typings";
 import { HttpResponse } from "../agent";
-interface RetrieveQuery extends OptionalStringMap {
+export interface RetrieveQuery extends OptionalStringMap {
     user_token?: string;
 }
-interface RetrieveUsageQuery extends RetrieveQuery {
+export interface RetrieveUsageQuery extends RetrieveQuery {
     start?: string;
@@ -18,3 +18,3 @@ end?: string;
 }
-interface Request {
+export interface Request {
     query?: RetrieveQuery;
@@ -24,10 +24,10 @@ header?: Header;
 }
-interface UsageRequest extends Request {
+export interface UsageRequest extends Request {
     query?: RetrieveUsageQuery;
 }
-declare type KeyResponse = PublicKeyResponse | PrivateKeyResponse;
-interface Response extends HttpResponse {
+export declare type KeyResponse = PublicKeyResponse | PrivateKeyResponse;
+export interface Response extends HttpResponse {
     body: KeyResponse;
 }
-interface UsageResponse extends HttpResponse {
+export interface UsageResponse extends HttpResponse {
     body: KeyUsageResponse;
@@ -34,0 +34,0 @@ }

esm/resources/postcodes.d.ts

@@ -5,3 +5,3 @@ import { PostcodesResponse } from "@ideal-postcodes/api-typings";
 import { HttpResponse } from "../agent";
-interface Query extends OptionalStringMap {
+export interface Query extends OptionalStringMap {
     api_key?: string;
@@ -17,3 +17,3 @@ licensee?: string;
 }
-interface Request {
+export interface Request {
     query?: Query;
@@ -23,3 +23,3 @@ header?: Header;
 }
-interface Response extends HttpResponse {
+export interface Response extends HttpResponse {
     body: PostcodesResponse;
@@ -26,0 +26,0 @@ }

esm/resources/resource.d.ts

 import { OptionalStringMap } from "../util";
 import { Client } from "../client";
 import { HttpResponse } from "../agent";
-interface Options {
+export interface Options {
     resource: string;
@@ -14,3 +14,3 @@ action?: string;
 }
-interface Response<U> extends HttpResponse {
+export interface Response<U> extends HttpResponse {
     body: U;
@@ -20,2 +20,1 @@ }
 export declare const listMethod: <T extends Request, U>(options: Options) => (request: T) => Promise<Response<U>>;
-export {};

esm/resources/udprn.d.ts

@@ -5,3 +5,3 @@ import { UdprnResponse } from "@ideal-postcodes/api-typings";
 import { HttpResponse } from "../agent";
-interface Query extends OptionalStringMap {
+export interface Query extends OptionalStringMap {
     api_key?: string;
@@ -12,7 +12,7 @@ licensee?: string;
 }
-interface Header extends OptionalStringMap {
+export interface Header extends OptionalStringMap {
     Authorization?: string;
     "IDPC-Source-IP"?: string;
 }
-interface Request {
+export interface Request {
     query?: Query;
@@ -22,3 +22,3 @@ header?: Header;
 }
-interface Response extends HttpResponse {
+export interface Response extends HttpResponse {
     body: UdprnResponse;
@@ -30,2 +30,1 @@ }
 export declare const retrieve: Retrieve;
-export {};

esm/resources/umprn.d.ts

@@ -5,3 +5,3 @@ import { UmprnResponse } from "@ideal-postcodes/api-typings";
 import { HttpResponse } from "../agent";
-interface Query extends OptionalStringMap {
+export interface Query extends OptionalStringMap {
     api_key?: string;
@@ -12,7 +12,7 @@ licensee?: string;
 }
-interface Header extends OptionalStringMap {
+export interface Header extends OptionalStringMap {
     Authorization?: string;
     "IDPC-Source-IP"?: string;
 }
-interface Request {
+export interface Request {
     query?: Query;
@@ -22,3 +22,3 @@ header?: Header;
 }
-interface Response extends HttpResponse {
+export interface Response extends HttpResponse {
     body: UmprnResponse;
@@ -30,2 +30,1 @@ }
 export declare const retrieve: Retrieve;
-export {};

package.json

 {
   "name": "@ideal-postcodes/core-interface",
-  "version": "2.0.2",
+  "version": "2.0.3",
   "description": "Interface specification for javascript based API Clients to api.ideal-postcodes.co.uk",
@@ -121,4 +121,4 @@ "author": {
     "dotenv": "~8.2.0",
-    "eslint": "~7.30.0",
-    "eslint-plugin-compat": "~3.9.0",
+    "eslint": "~7.31.0",
+    "eslint-plugin-compat": "~3.11.1",
     "karma": "~6.3.3",
@@ -125,0 +125,0 @@ "karma-chrome-launcher": "~3.1.0",

README.md

@@ -72,6 +72,4 @@ <h1 align="center">
 
-[Client class docs](https://core-interface.ideal-postcodes.dev/classes/client.html)
+[Client configuration options](https://core-interface.ideal-postcodes.dev/interfaces/client.config)
 
-[Client configuration options](https://core-interface.ideal-postcodes.dev/interfaces/config.html)
-
 ---
@@ -110,6 +108,4 @@
 
-`lookupPostcode` [docs](https://core-interface.ideal-postcodes.dev/classes/client.html#lookuppostcode)
+`lookupPostcode` [docs](https://core-interface.ideal-postcodes.dev/modules/helper_methods#lookupPostcode)
 
-`lookupPostcode` [options](https://core-interface.ideal-postcodes.dev/interfaces/lookuppostcodeoptions.html)
-
 #### Search for an Address
@@ -134,6 +130,4 @@
 
-`lookupAddress` [docs](https://core-interface.ideal-postcodes.dev/classes/client.html#lookupaddress)
+`lookupAddress` [docs](https://core-interface.ideal-postcodes.dev/modules/helper_methods#lookupAddress)
 
-`lookupAddress` [options](https://core-interface.ideal-postcodes.dev/interfaces/lookupaddressoptions.html)
-
 #### Search for an Address by UDPRN
@@ -160,6 +154,4 @@
 
-`lookupUdprn` [docs](https://core-interface.ideal-postcodes.dev/classes/client.html#lookupudprn)
+`lookupUdprn` [docs](https://core-interface.ideal-postcodes.dev/modules/helper_methods#lookupUdprn)
 
-`lookupUdprn` [options](https://core-interface.ideal-postcodes.dev/interfaces/lookupudprnoptions.html)
-
 #### Search for an Address by UMPRN
@@ -186,6 +178,4 @@
 
-`lookupUmprn` [docs](https://core-interface.ideal-postcodes.dev/classes/client.html#lookupumprn)
+`lookupUmprn` [docs](https://core-interface.ideal-postcodes.dev/modules/helper_methods#lookupUmprn)
 
-`lookupUmprn` [options](https://core-interface.ideal-postcodes.dev/interfaces/lookupumprnoptions.html)
-
 #### Check Key Usability
@@ -201,6 +191,4 @@
 
-`checkKeyUsability` [docs](https://core-interface.ideal-postcodes.dev/classes/client.html#checkkeyusability)
+`checkKeyUsability` [docs](https://core-interface.ideal-postcodes.dev/modules/helper_methods#checkKeyUsability)
 
-`checkKeyUsability` [options](https://core-interface.ideal-postcodes.dev/interfaces/checkkeyusabilityoptions.html)
-
 ---
@@ -332,3 +320,3 @@
 
-[Address resource client docs](https://core-interface.ideal-postcodes.dev/interfaces/addressresource.html)
+[Address resource client docs](https://core-interface.ideal-postcodes.dev/modules/resources_addresses.html)
 
@@ -359,3 +347,3 @@ #### Autocomplete
 
-[Autocomplete resource client docs](https://core-interface.ideal-postcodes.dev/interfaces/autocompleteresource.html)
+[Autocomplete resource client docs](https://core-interface.ideal-postcodes.dev/modules/resources_autocomplete.html)
 
@@ -383,3 +371,3 @@ #### UDPRN
 
-[UDPRN resource client docs](https://core-interface.ideal-postcodes.dev/interfaces/udprnresource.html)
+[UDPRN resource client docs](https://core-interface.ideal-postcodes.dev/modules/resources_udprn.html)
 
@@ -407,3 +395,3 @@ #### UMPRN
 
-[UMPRN resource client docs](https://core-interface.ideal-postcodes.dev/interfaces/umprnresource.html)
+[UMPRN resource client docs](https://core-interface.ideal-postcodes.dev/modules/resources_umprn.html)
 
@@ -425,3 +413,3 @@ #### Keys
 
-[Method docs](https://core-interface.ideal-postcodes.dev/interfaces/keyresource.html#retrieve)
+[Method docs](https://core-interface.ideal-postcodes.dev/modules/resources_keys.html#retrieve)
 
@@ -445,3 +433,3 @@ Get private information on key (requires user_token)
 
-[Method docs](https://core-interface.ideal-postcodes.dev/interfaces/keyresource.html#retrieve)
+[Method docs](https://core-interface.ideal-postcodes.dev/modules/resources_keys.html#retrieve)
 
@@ -465,7 +453,7 @@ Get key usage data
 
-[Method docs](https://core-interface.ideal-postcodes.dev/interfaces/keyresource.html#usage)
+[Method docs](https://core-interface.ideal-postcodes.dev/modules/resources_keys.html#usage)
 
 [Keys resource HTTP API documentation](https://ideal-postcodes.co.uk/documentation/keys)
 
-[Key resource client docs](https://core-interface.ideal-postcodes.dev/interfaces/keyresource.html)
+[Key resource client docs](https://core-interface.ideal-postcodes.dev/modules/resources_keys.html)
 
@@ -484,3 +472,3 @@ ---
 try {
-  const addresses = lookupPostcode({ client, postcode: "SW1A2AA" });
+  const addresses = await lookupPostcode({ client, postcode: "SW1A2AA" });
 } catch (error) {
@@ -504,3 +492,3 @@ if (error instanceof IdpcInvalidKeyError) {
 try {
-  const addresses = lookupPostcode({ client, postcode: "SW1A2AA" });
+  const addresses = await lookupPostcode({ client, postcode: "SW1A2AA" });
 } catch (error) {
@@ -522,4 +510,4 @@ if (error instanceof IdpcRequestFailedError) {
 
-- Class implementations for [Ideal Postcodes API errors](https://core-interface.ideal-postcodes.dev/classes/idpcapierror.html) that inherit from `Error`
-- A [parser](https://core-interface.ideal-postcodes.dev/globals.html#parse) that converts raw error data into one of these error instances
+- Class implementations for [Ideal Postcodes API errors](https://core-interface.ideal-postcodes.dev/classes/errors.idpcapierror) that inherit from `Error`
+- A [parser](https://core-interface.ideal-postcodes.dev/modules/errors#parse) that converts raw error data into one of these error instances
 
@@ -530,3 +518,3 @@ #### Error Usage
 
-Errors that don't inherit from [`IdealPostcodesError`](https://core-interface.ideal-postcodes.dev/classes/idealpostcodeserror.html) would indicate some kind of error external to the API (e.g. bad network, request timeout).
+Errors that don't inherit from [`IdealPostcodesError`](https://core-interface.ideal-postcodes.dev/classes/errors.idealpostcodeserror) would indicate some kind of error external to the API (e.g. bad network, request timeout).
 
@@ -533,0 +521,0 @@ ```javascript

No alert changes

Worsened metrics

Total package byte prevSize

128514

decreased by-0.14%

Lines of code

3457

decreased by-0.52%

Number of lines in readme file

584

decreased by-2.01%

No dependency changes