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

Comparing version 3.0.0 to 3.1.0

CHANGELOG.md

@@ -0,1 +1,8 @@
+# [3.1.0](https://github.com/ideal-postcodes/core-interface/compare/3.0.0...3.1.0) (2022-04-04)
+
+
+### Features
+
+* **USA:** Resolve addreses in US format ([76aff0c](https://github.com/ideal-postcodes/core-interface/commit/76aff0c9c462c7e53f890d04b48bdd764eab6acd))
+
 # [3.0.0](https://github.com/ideal-postcodes/core-interface/compare/2.0.3...3.0.0) (2022-02-14)
@@ -2,0 +9,0 @@

dist/resources/autocomplete.d.ts

@@ -1,2 +0,2 @@
-import { AddressSuggestionResponse, GbrResolveResponse } from "../types";
+import { AddressSuggestionResponse, GbrResolveResponse, UsaResolveResponse } from "../types";
 import { OptionalStringMap } from "../util";
@@ -53,3 +53,10 @@ import { Client } from "../client";
 }
+export declare const usa: Usa;
+export interface UsaResponse extends HttpResponse {
+    body: UsaResolveResponse;
+}
+export interface Usa {
+    (client: Client, id: string, request: Request): Promise<UsaResponse>;
+}
 export declare const gbr: Gbr;
 export {};

dist/resources/autocomplete.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.gbr = exports.list = void 0;
+exports.gbr = exports.usa = exports.list = void 0;
 var resource_1 = require("./resource");
@@ -11,2 +11,11 @@ var resource = "autocomplete/addresses";
 // Resolves address to the GBR format
+var usa = function (client, id, request) {
+    return (0, resource_1.retrieveMethod)({
+        resource: resource,
+        client: client,
+        action: "usa",
+    })(id, request);
+};
+exports.usa = usa;
+// Resolves address to the GBR format
 var gbr = function (client, id, request) {
@@ -13,0 +22,0 @@ return (0, resource_1.retrieveMethod)({

dist/types.d.ts

@@ -7,2 +7,3 @@ /**
 export declare type AddressSuggestionResponse = paths["/autocomplete/addresses"]["get"]["responses"][200]["content"]["application/json"];
+export declare type UsaResolveResponse = paths["/autocomplete/addresses/{address}/usa"]["get"]["responses"][200]["content"]["application/json"];
 export declare type GbrResolveResponse = paths["/autocomplete/addresses/{address}/gbr"]["get"]["responses"][200]["content"]["application/json"];
@@ -9,0 +10,0 @@ export declare type PublicKeyResponse = paths["/keys/{key}"]["get"]["responses"][200]["content"]["application/json"];

esm/resources/autocomplete.d.ts

@@ -1,2 +0,2 @@
-import { AddressSuggestionResponse, GbrResolveResponse } from "../types";
+import { AddressSuggestionResponse, GbrResolveResponse, UsaResolveResponse } from "../types";
 import { OptionalStringMap } from "../util";
@@ -53,3 +53,10 @@ import { Client } from "../client";
 }
+export declare const usa: Usa;
+export interface UsaResponse extends HttpResponse {
+    body: UsaResolveResponse;
+}
+export interface Usa {
+    (client: Client, id: string, request: Request): Promise<UsaResponse>;
+}
 export declare const gbr: Gbr;
 export {};

esm/resources/autocomplete.js

@@ -5,2 +5,8 @@ import { listMethod, retrieveMethod } from "./resource";
 // Resolves address to the GBR format
+export const usa = (client, id, request) => retrieveMethod({
+    resource,
+    client,
+    action: "usa",
+})(id, request);
+// Resolves address to the GBR format
 export const gbr = (client, id, request) => retrieveMethod({
@@ -7,0 +13,0 @@ resource,

esm/types.d.ts

@@ -7,2 +7,3 @@ /**
 export declare type AddressSuggestionResponse = paths["/autocomplete/addresses"]["get"]["responses"][200]["content"]["application/json"];
+export declare type UsaResolveResponse = paths["/autocomplete/addresses/{address}/usa"]["get"]["responses"][200]["content"]["application/json"];
 export declare type GbrResolveResponse = paths["/autocomplete/addresses/{address}/gbr"]["get"]["responses"][200]["content"]["application/json"];
@@ -9,0 +10,0 @@ export declare type PublicKeyResponse = paths["/keys/{key}"]["get"]["responses"][200]["content"]["application/json"];

package.json

 {
   "name": "@ideal-postcodes/core-interface",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "Interface specification for javascript based API Clients to api.ideal-postcodes.co.uk",
@@ -105,3 +105,3 @@ "author": {
   "dependencies": {
-    "@ideal-postcodes/openapi": "~1.1.0"
+    "@ideal-postcodes/openapi": "~1.2.0-beta.4"
   },
@@ -108,0 +108,0 @@ "devDependencies": {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

135245

increased by1.08%

Lines of code

3549

increased by0.88%

Dependency changes

• + Added@ideal-postcodes/openapi@1.2.0(transitive)

• - Removed@ideal-postcodes/openapi@1.1.0(transitive)

• Updated@ideal-postcodes/openapi@~1.2.0-beta.4