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

Comparing version 1.5.0 to 1.6.0

CHANGELOG.md

@@ -0,1 +1,8 @@
+# [1.6.0](https://github.com/ideal-postcodes/core-interface/compare/1.5.0...1.6.0) (2020-07-27)
+
+
+### Features
+
+* **Query:** Allow non-string query attributes ([2de56cb](https://github.com/ideal-postcodes/core-interface/commit/2de56cb1905e04b6376e5a2a4dc52a9b65aff7be))
+
 # [1.5.0](https://github.com/ideal-postcodes/core-interface/compare/1.4.0...1.5.0) (2020-02-05)
@@ -2,0 +9,0 @@

dist/client.js

@@ -13,10 +13,23 @@ "use strict";
 };
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
 var __importStar = (this && this.__importStar) || function (mod) {
     if (mod && mod.__esModule) return mod;
     var result = {};
-    if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
-    result["default"] = mod;
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.Client = void 0;
 var error_1 = require("./error");
@@ -23,0 +36,0 @@ var errors = __importStar(require("./error"));

dist/error.d.ts

@@ -166,3 +166,3 @@ import { HttpResponse } from "./agent";
  */
-export declare const parse: (response: HttpResponse) => void | Error;
+export declare const parse: (response: HttpResponse) => Error | void;
 export {};

dist/error.js

@@ -16,2 +16,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.parse = exports.IdpcServerError = exports.IdpcUmprnNotFoundError = exports.IdpcUdprnNotFoundError = exports.IdpcKeyNotFoundError = exports.IdpcPostcodeNotFoundError = exports.IdpcResourceNotFoundError = exports.IdpcLimitReachedError = exports.IdpcBalanceDepletedError = exports.IdpcRequestFailedError = exports.IdpcInvalidKeyError = exports.IdpcUnauthorisedError = exports.IdpcBadRequestError = exports.IdpcApiError = exports.IdealPostcodesError = void 0;
 // Take note of https://github.com/Microsoft/TypeScript/issues/13965
@@ -18,0 +19,0 @@ /**

dist/index.js

@@ -5,10 +5,23 @@ "use strict";
  */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
 var __importStar = (this && this.__importStar) || function (mod) {
     if (mod && mod.__esModule) return mod;
     var result = {};
-    if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
-    result["default"] = mod;
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.errors = exports.STRICT_AUTHORISATION = exports.TIMEOUT = exports.VERSION = exports.TLS = exports.API_URL = void 0;
 /**
@@ -37,5 +50,5 @@ * Default API endpoint
 var client_1 = require("./client");
-exports.Client = client_1.Client;
+Object.defineProperty(exports, "Client", { enumerable: true, get: function () { return client_1.Client; } });
 var errors = __importStar(require("./error"));
 exports.errors = errors;
 //# sourceMappingURL=index.js.map

dist/resources/addresses.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.create = void 0;
 var resource_1 = require("./resource");
@@ -4,0 +5,0 @@ var resource = "addresses";

dist/resources/autocomplete.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.create = void 0;
 var resource_1 = require("./resource");
@@ -4,0 +5,0 @@ var resource = "autocomplete/addresses";

dist/resources/keys.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.create = void 0;
 var resource_1 = require("./resource");
@@ -4,0 +5,0 @@ var resource = "keys";

dist/resources/postcodes.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.create = void 0;
 var resource_1 = require("./resource");
@@ -4,0 +5,0 @@ var resource = "postcodes";

dist/resources/resource.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.listMethod = exports.retrieveMethod = void 0;
 var util_1 = require("../util");
@@ -4,0 +5,0 @@ var error_1 = require("../error");

dist/resources/udprn.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.create = void 0;
 var resource_1 = require("./resource");
@@ -4,0 +5,0 @@ var resource = "udprn";

dist/resources/umprn.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.create = void 0;
 var resource_1 = require("./resource");
@@ -4,0 +5,0 @@ var resource = "umprn";

dist/types.d.ts

@@ -98,1 +98,5 @@ import { Address } from "@ideal-postcodes/api-typings";
 }
+/**
+ * QueryValue
+ */
+export declare type QueryValue = undefined | number | string | (string | number)[];

dist/util.d.ts

 import { Client } from "./client";
-import { Authenticable, Paginateable, AdminAuthenticable, Taggable, HttpOptions, Filterable } from "./types";
+import { Header } from "./agent";
+import { Authenticable, Paginateable, AdminAuthenticable, Taggable, HttpOptions, Filterable, QueryValue } from "./types";
 export interface OptionalStringMap {
-    [key: string]: string | undefined;
+    [key: string]: QueryValue;
 }
@@ -33,3 +34,3 @@ import { StringMap } from "./agent";
  */
-export declare const toHeader: ({ header }: OptionalHeader, client: Client) => StringMap;
+export declare const toHeader: ({ header }: OptionalHeader, client: Client) => Header;
 declare type AuthenticationOptions = Partial<Authenticable & AdminAuthenticable>;
@@ -41,3 +42,3 @@ /**
  */
-export declare const toAuthHeader: (client: Client, options: Partial<Authenticable & AdminAuthenticable>) => string;
+export declare const toAuthHeader: (client: Client, options: AuthenticationOptions) => string;
 interface AppendAuthorizationOptions {
@@ -44,0 +45,0 @@ options: AuthenticationOptions;

dist/util.js

@@ -14,2 +14,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.appendPage = exports.appendTags = exports.appendFilter = exports.appendIp = exports.appendAuthorization = exports.toAuthHeader = exports.toHeader = exports.toTimeout = exports.toStringMap = void 0;
 /**
@@ -25,4 +26,5 @@ * toQuery
         var value = optional[key];
-        if (isString(value))
-            result[key] = value;
+        var reduce = reduceStringMap(value);
+        if (reduce.length > 0)
+            result[key] = reduce;
         return result;
@@ -32,2 +34,20 @@ }, {});
 var isString = function (i) { return typeof i === "string"; };
+var isArray = function (i) { return Array.isArray(i); };
+var reduceStringMap = function (value) {
+    var result = [];
+    if (isArray(value)) {
+        value.forEach(function (val) {
+            if (isNumber(val))
+                result.push(val.toString());
+            if (isString(val))
+                result.push(val);
+        });
+        return result.join(",");
+    }
+    if (isNumber(value))
+        return value.toString();
+    if (isString(value))
+        return value;
+    return "";
+};
 var isNumber = function (n) { return typeof n === "number"; };
@@ -34,0 +54,0 @@ /**

package.json

 {
   "name": "@ideal-postcodes/core-interface",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "description": "Interface specification for javascript based API Clients to api.ideal-postcodes.co.uk",
@@ -93,42 +93,43 @@ "author": {
   "devDependencies": {
-    "@cablanchard/eslint-config": "~1.1.1",
+    "@cablanchard/eslint-config": "~2.0.1",
     "@cablanchard/semantic-release": "~1.3.1",
     "@cablanchard/tsconfig": "1.0.0",
     "@cablanchard/tslint": "0.0.1",
-    "@ideal-postcodes/api-fixtures": "~0.1.0",
-    "@ideal-postcodes/api-typings": "~1.1.0",
-    "@ideal-postcodes/supported-browsers": "~1.2.0",
+    "@ideal-postcodes/api-fixtures": "~1.1.0",
+    "@ideal-postcodes/api-typings": "~2.0.0",
+    "@ideal-postcodes/supported-browsers": "~2.3.2",
     "@types/chai": "~4.2.0",
     "@types/dotenv": "~8.2.0",
-    "@types/karma": "~3.0.3",
-    "@types/mocha": "~7.0.1",
-    "@types/node": "~13.7.0",
-    "@types/prettier": "~1.19.0",
-    "@types/puppeteer": "~2.0.0",
-    "@types/sinon": "~7.5.0",
-    "babel-polyfill": "~6.26.0",
+    "@types/karma": "~5.0.0",
+    "@types/mocha": "~8.0.0",
+    "@types/node": "~14.0.5",
+    "@types/prettier": "~2.0.0",
+    "@types/puppeteer": "~3.0.0",
+    "@types/sinon": "~9.0.1",
     "chai": "~4.2.0",
-    "codecov": "~3.6.1",
+    "codecov": "~3.7.0",
+    "core-js": "~3.6.4",
     "dotenv": "~8.2.0",
-    "eslint": "~6.8.0",
-    "karma": "~4.4.0",
-    "karma-cbt-launcher": "~0.4.6",
+    "eslint": "~7.5.0",
+    "karma": "~5.1.0",
     "karma-chrome-launcher": "~3.1.0",
     "karma-cli": "~2.0.0",
-    "karma-mocha": "~1.3.0",
-    "karma-polyfill": "~1.0.0",
-    "karma-typescript": "~4.1.0",
-    "mocha": "~7.0.0",
-    "nyc": "~15.0.0",
-    "prettier": "~1.19.1",
-    "puppeteer": "~2.1.0",
-    "semantic-release": "~15.14.0",
-    "sinon": "~8.1.0",
+    "karma-mocha": "~2.0.0",
+    "karma-polyfill": "~1.1.0",
+    "karma-sauce-launcher": "~1.2.0",
+    "karma-typescript": "~5.0.0",
+    "mocha": "~8.0.1",
+    "nyc": "~15.1.0",
+    "prettier": "~2.0.2",
+    "puppeteer": "~5.2.0",
+    "regenerator-runtime": "~0.13.3",
+    "semantic-release": "~17.1.0",
+    "sinon": "~9.0.0",
     "source-map-support": "~0.5.10",
-    "ts-node": "~8.6.1",
-    "tslint": "~5.20.0",
+    "ts-node": "~8.10.1",
+    "tslint": "~6.1.2",
     "type-zoo": "~3.4.0",
-    "typedoc": "~0.16.2",
-    "typescript": "~3.7.2"
+    "typedoc": "~0.17.1",
+    "typescript": "~3.9.3"
   }
 }

README.md

@@ -8,4 +8,7 @@ <h1 align="center">
 [![CircleCI](https://circleci.com/gh/ideal-postcodes/core-interface/tree/master.svg?style=svg)](https://circleci.com/gh/ideal-postcodes/core-interface/tree/master)
+![Cross Browser Testing](https://github.com/ideal-postcodes/core-interface/workflows/Cross%20Browser%20Testing/badge.svg?branch=saucelabs)
+[![Release](https://github.com/ideal-postcodes/core-interface/workflows/Release/badge.svg)](https://github.com/ideal-postcodes/core-interface/actions)
+[![codecov](https://codecov.io/gh/ideal-postcodes/core-interface/branch/master/graph/badge.svg)](https://codecov.io/gh/ideal-postcodes/core-interface)
 ![Dependency Status](https://david-dm.org/ideal-postcodes/core-interface.svg)
-[![codecov](https://codecov.io/gh/ideal-postcodes/core-interface/branch/master/graph/badge.svg)](https://codecov.io/gh/ideal-postcodes/core-interface)
+
 [![npm version](https://badge.fury.io/js/%40ideal-postcodes%2Fcore-interface.svg)](https://badge.fury.io/js/%40ideal-postcodes%2Fcore-interface)
@@ -12,0 +15,0 @@ ![npm bundle size (scoped)](https://img.shields.io/bundlephobia/min/@ideal-postcodes/core-interface.svg?color=%234c1&style=popout)

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

96896

increased by4.92%

Lines of code

1745

increased by3.56%

Number of lines in readme file

547

increased by0.55%

Worsened metrics

Dev dependency count

40

increased by2.56%

No dependency changes