@aceandtate/clicktoaddress - npm Package Compare versions

Comparing version 0.1.10 to 0.1.11

dist/index.d.ts

@@ -1,63 +0,8 @@
-declare type Fetch = (url: string, options: object) => Promise<Response>;
-interface ClientOptions {
-    key: string;
-    endpoint?: string;
-    fetch?: Fetch;
-    options?: object;
-}
-interface CountriesArgs {
-    language?: string;
-    ip?: string;
-}
-interface FindArgs {
-    country: string;
-    query: string;
-}
-interface RetrieveArgs {
-    country: string;
-    id: string;
-    lines?: number;
-}
+import { ClientOptions, CountriesArgs, FindArgs, RetrieveArgs } from './types';
+declare type ApiOptions = CountriesArgs | FindArgs | RetrieveArgs;
 export default function createClient({ key, endpoint, fetch, options }: ClientOptions): {
-    get: (path: string, args: object) => Promise<any>;
+    get: (path: string, args: ApiOptions) => Promise<any>;
     countries: (args: CountriesArgs) => Promise<{
         get: (query: string) => Promise<{
-            get: () => Promise<{
-                administrative_area: string;
-                alternative_administrative_area: string;
-                alternative_locality: string;
-                alternative_province: string;
-                building_name: string;
-                building_number: string;
-                company_name: string;
-                country_name: string;
-                department_name: string;
-                dependent_locality: string;
-                dependent_street_name: string;
-                dependent_street_prefix: string;
-                dependent_street_suffix: string;
-                double_dependent_locality: string;
-                double_dependent_street_name: string;
-                double_dependent_street_prefix: string;
-                double_dependent_street_suffix: string;
-                level_name: string;
-                line_1: string;
-                line_2: string;
-                line_3: string;
-                line_4: string;
-                line_5: string;
-                locality: string;
-                post_office_box_number: string;
-                post_office_reference_1: string;
-                post_office_reference_2: string;
-                postal_code: string;
-                province: string;
-                province_code: string;
-                province_name: string;
-                street_name: string;
-                street_prefix: string;
-                street_suffix: string;
-                sub_building_name: string;
-                unit_name: string;
-            }>;
+            get: () => Promise<import("./types").RetrieveResponseResult>;
             id: string;
@@ -68,81 +13,7 @@ }[]>;
     find: (args: FindArgs) => Promise<{
-        get: () => Promise<{
-            administrative_area: string;
-            alternative_administrative_area: string;
-            alternative_locality: string;
-            alternative_province: string;
-            building_name: string;
-            building_number: string;
-            company_name: string;
-            country_name: string;
-            department_name: string;
-            dependent_locality: string;
-            dependent_street_name: string;
-            dependent_street_prefix: string;
-            dependent_street_suffix: string;
-            double_dependent_locality: string;
-            double_dependent_street_name: string;
-            double_dependent_street_prefix: string;
-            double_dependent_street_suffix: string;
-            level_name: string;
-            line_1: string;
-            line_2: string;
-            line_3: string;
-            line_4: string;
-            line_5: string;
-            locality: string;
-            post_office_box_number: string;
-            post_office_reference_1: string;
-            post_office_reference_2: string;
-            postal_code: string;
-            province: string;
-            province_code: string;
-            province_name: string;
-            street_name: string;
-            street_prefix: string;
-            street_suffix: string;
-            sub_building_name: string;
-            unit_name: string;
-        }>;
+        get: () => Promise<import("./types").RetrieveResponseResult>;
         id: string;
     }[]>;
-    retrieve: (args: RetrieveArgs) => Promise<{
-        administrative_area: string;
-        alternative_administrative_area: string;
-        alternative_locality: string;
-        alternative_province: string;
-        building_name: string;
-        building_number: string;
-        company_name: string;
-        country_name: string;
-        department_name: string;
-        dependent_locality: string;
-        dependent_street_name: string;
-        dependent_street_prefix: string;
-        dependent_street_suffix: string;
-        double_dependent_locality: string;
-        double_dependent_street_name: string;
-        double_dependent_street_prefix: string;
-        double_dependent_street_suffix: string;
-        level_name: string;
-        line_1: string;
-        line_2: string;
-        line_3: string;
-        line_4: string;
-        line_5: string;
-        locality: string;
-        post_office_box_number: string;
-        post_office_reference_1: string;
-        post_office_reference_2: string;
-        postal_code: string;
-        province: string;
-        province_code: string;
-        province_name: string;
-        street_name: string;
-        street_prefix: string;
-        street_suffix: string;
-        sub_building_name: string;
-        unit_name: string;
-    }>;
+    retrieve: (args: RetrieveArgs) => Promise<import("./types").RetrieveResponseResult>;
 };
 export {};

dist/index.js

 "use strict";
-var __assign = (this && this.__assign) || Object.assign || function(t) {
-    for (var s, i = 1, n = arguments.length; i < n; i++) {
-        s = arguments[i];
-        for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-            t[p] = s[p];
-    }
-    return t;
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
 };
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
         function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
         function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
         step((generator = generator.apply(thisArg, _arguments || [])).next());
@@ -47,2 +51,3 @@ });
 var isomorphicFetch = require("isomorphic-fetch");
+var mapRetrievedResult_1 = require("./mapRetrievedResult");
 var API_ENDPOINT = "https://api.craftyclicks.co.uk/address/1.1/";
@@ -65,3 +70,3 @@ var defaultOptions = {
                     url = "" + endpoint + path;
-                    requestOptions = __assign({}, options, { body: JSON.stringify(__assign({}, args, { key: key })) });
+                    requestOptions = __assign(__assign({}, options), { body: JSON.stringify(__assign(__assign({}, args), { key: key })) });
                     return [4, fetch(url, requestOptions)];
@@ -82,3 +87,3 @@ case 1:
         return api("countries", args).then(function (data) {
-            return data.countries.map(function (country) { return (__assign({}, country, { get: function (query) { return find({ country: country.code, query: query }); } })); });
+            return data.countries.map(function (country) { return (__assign(__assign({}, country), { get: function (query) { return find({ country: country.code, query: query }); } })); });
         });
@@ -88,7 +93,7 @@ };
         return api("find", args).then(function (data) {
-            return data.results.map(function (result) { return (__assign({}, result, { get: function () { return retrieve({ country: args.country, id: result.id }); } })); });
+            return data.results.map(function (result) { return (__assign(__assign({}, result), { get: function () { return retrieve({ country: args.country, id: result.id }); } })); });
         });
     };
     var retrieve = function (args) {
-        return api("retrieve", args).then(function (data) { return data.result; });
+        return api("retrieve", args).then(function (data) { return mapRetrievedResult_1.default(args, data.result); });
     };
@@ -95,0 +100,0 @@ return {

package.json

 {
   "name": "@aceandtate/clicktoaddress",
-  "version": "0.1.10",
+  "version": "0.1.11",
   "description": "A clicktoaddress client",
@@ -31,7 +31,7 @@ "main": "dist/index.js",
   "devDependencies": {
-    "@types/isomorphic-fetch": "0.0.34",
-    "@types/jest": "^23.1.4",
-    "jest": "^23.3.0",
-    "ts-jest": "^23.0.0",
-    "typescript": "^2.9.2"
+    "@types/isomorphic-fetch": "0.0.35",
+    "@types/jest": "^24.0.18",
+    "jest": "^24.9.0",
+    "ts-jest": "^24.1.0",
+    "typescript": "^3.6.3"
   },
@@ -38,0 +38,0 @@ "jest": {

src/index.test.ts

@@ -25,7 +25,7 @@ import createClient from ".";
     const { get } = clientWithMock({ fetch });
-    const response = await get("something", { my: "arg" });
+    const response = await get("something", { country: 'MX', query: 'query' });
     expect(fetch).toHaveBeenCalledWith(
       "https://api.craftyclicks.co.uk/address/1.1/something",
       {
-        body: '{"my":"arg","key":"some key"}',
+        body: JSON.stringify({ country: 'MX', query: 'query', key: 'some key' }),
         mode: "cors",
@@ -32,0 +32,0 @@ headers: { "Content-Type": "application/json; charset=utf-8" },

src/index.ts

 import * as isomorphicFetch from "isomorphic-fetch";
+import mapRetrievedResult from "./mapRetrievedResult";
 
+import {
+  ClientOptions,
+  CountriesArgs,
+  CountriesResponse,
+  FindArgs,
+  FindResponse,
+  RetrieveArgs,
+  RetrieveResponse
+} from './types';
+
 const API_ENDPOINT = "https://api.craftyclicks.co.uk/address/1.1/";
@@ -12,79 +23,4 @@ const defaultOptions = {
 
-type Fetch = (url: string, options: object) => Promise<Response>;
-interface ClientOptions {
-  key: string;
-  endpoint?: string;
-  fetch?: Fetch;
-  options?: object;
-}
+type ApiOptions = CountriesArgs | FindArgs | RetrieveArgs;
 
-interface CountriesArgs {
-  language?: string;
-  ip?: string;
-}
-
-interface CountriesResponse {
-  countries: Array<{
-    code: string;
-  }>;
-}
-
-interface FindArgs {
-  country: string;
-  query: string;
-}
-
-interface FindResponse {
-  results: Array<{
-    id: string;
-  }>;
-}
-
-interface RetrieveArgs {
-  country: string;
-  id: string;
-  lines?: number;
-}
-
-interface RetrieveResponse {
-  result: {
-    administrative_area: string;
-    alternative_administrative_area: string;
-    alternative_locality: string;
-    alternative_province: string;
-    building_name: string;
-    building_number: string;
-    company_name: string;
-    country_name: string;
-    department_name: string;
-    dependent_locality: string;
-    dependent_street_name: string;
-    dependent_street_prefix: string;
-    dependent_street_suffix: string;
-    double_dependent_locality: string;
-    double_dependent_street_name: string;
-    double_dependent_street_prefix: string;
-    double_dependent_street_suffix: string;
-    level_name: string;
-    line_1: string;
-    line_2: string;
-    line_3: string;
-    line_4: string;
-    line_5: string;
-    locality: string;
-    post_office_box_number: string;
-    post_office_reference_1: string;
-    post_office_reference_2: string;
-    postal_code: string;
-    province: string;
-    province_code: string;
-    province_name: string;
-    street_name: string;
-    street_prefix: string;
-    street_suffix: string;
-    sub_building_name: string;
-    unit_name: string;
-  };
-}
-
 export default function createClient({
@@ -96,3 +32,3 @@ key,
 }: ClientOptions) {
-  const api = async (path: string, args: object) => {
+  const api = async (path: string, args: ApiOptions) => {
     const url = `${endpoint}${path}`;
@@ -132,3 +68,3 @@ const requestOptions = {
   const retrieve = (args: RetrieveArgs) =>
-    api("retrieve", args).then((data: RetrieveResponse) => data.result);
+    api("retrieve", args).then((data: RetrieveResponse) => mapRetrievedResult(args, data.result));
 
@@ -135,0 +71,0 @@ return {

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

22352

increased by12.5%

Number of package files

17

increased by112.5%

Lines of code

451

increased by11.08%

Worsened metrics

Number of medium supply chain risk alerts

2

increased by100%

No dependency changes