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

Comparing version 1.0.0 to 1.1.0

CHANGELOG.md

@@ -0,1 +1,13 @@
+# [1.1.0](https://github.com/ideal-postcodes/core-interface/compare/1.0.0...1.1.0) (2019-06-05)
+
+
+### Bug Fixes
+
+* **Resource:** Escape ID by default ([b94d4f3](https://github.com/ideal-postcodes/core-interface/commit/b94d4f3))
+
+
+### Features
+
+* **Client:** Export client config ([8dd2a37](https://github.com/ideal-postcodes/core-interface/commit/8dd2a37))
+
 # 1.0.0 (2019-06-04)
@@ -2,0 +14,0 @@

dist/index.d.ts

 /**
  * Constants
  */
+/**
+ * Default API endpoint
+ */
 export declare const API_URL = "api.ideal-postcodes.co.uk";
+/**
+ * Use TLS by default. Set to `true`
+ */
 export declare const TLS = true;
+/**
+ * Default API Version number. Defaults to "v1"
+ */
 export declare const VERSION = "v1";
+/**
+ * Default HTTP timeout in milliseconds. Defaults to 10s
+ */
 export declare const TIMEOUT = 10000;
 export declare const STRICT_AUTHORISATION = false;
-export { Client } from "./client";
+export { Client, Config } from "./client";
 export { Agent, HttpRequest, HttpResponse } from "./agent";
@@ -11,0 +23,0 @@ import { Address } from "../node_modules/@ideal-postcodes/api-typings";

dist/index.js

 "use strict";
+/**
+ * Constants
+ */
 var __importStar = (this && this.__importStar) || function (mod) {
@@ -11,7 +14,16 @@ if (mod && mod.__esModule) return mod;
 /**
- * Constants
+ * Default API endpoint
  */
 exports.API_URL = "api.ideal-postcodes.co.uk";
+/**
+ * Use TLS by default. Set to `true`
+ */
 exports.TLS = true;
+/**
+ * Default API Version number. Defaults to "v1"
+ */
 exports.VERSION = "v1";
+/**
+ * Default HTTP timeout in milliseconds. Defaults to 10s
+ */
 exports.TIMEOUT = 10000;
@@ -18,0 +30,0 @@ /*

dist/resources/resource.js

@@ -7,3 +7,8 @@ "use strict";
 var toRetrieveUrl = function (options, id) {
-    return [options.client.url(), options.resource, id, options.action]
+    return [
+        options.client.url(),
+        options.resource,
+        encodeURIComponent(id),
+        options.action,
+    ]
         .filter(function (e) { return e !== undefined; })
@@ -10,0 +15,0 @@ .join("/");

package.json

 {
   "name": "@ideal-postcodes/core-interface",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Interface specification for javascript based API Clients to api.ideal-postcodes.co.uk",
@@ -5,0 +5,0 @@ "author": {

README.md

@@ -9,2 +9,3 @@ <h1 align="center">
 [![BrowserStack Status](https://www.browserstack.com/automate/badge.svg?badge_key=RGl2bTU2Z3l4MGZNR1ZZREpyajlNaXZFMElZMkNCNENKRHNCMCtyVTBrbz0tLXdVODl3TlRJejA1MWpiTzYzaTBsZ1E9PQ==--8eb0b38bd782e0145dc4dc01e093c861828dbfa8)](https://www.browserstack.com/automate/public-build/RGl2bTU2Z3l4MGZNR1ZZREpyajlNaXZFMElZMkNCNENKRHNCMCtyVTBrbz0tLXdVODl3TlRJejA1MWpiTzYzaTBsZ1E9PQ==--8eb0b38bd782e0145dc4dc01e093c861828dbfa8)
+[![npm version](https://badge.fury.io/js/%40ideal-postcodes%2Fcore-interface.svg)](https://badge.fury.io/js/%40ideal-postcodes%2Fcore-interface)
 
@@ -17,3 +18,3 @@ `@ideal-postcodes/core-interface` is an environment agnostic implementation of the Ideal Postcodes javascript API client interface.
 
-- [API Documentation](https://core-interface.ideal-postcodes.co.uk/)
+- [API Documentation](https://core-interface.ideal-postcodes.dev/)
 - [NPM Module](https://www.npmjs.com/package/@ideal-postcodes/core-interface)
@@ -20,0 +21,0 @@ - [Github Repository](https://github.com/ideal-postcodes/core-interface)

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

60401

increased by1.73%

Lines of code

1184

increased by2.51%

Number of lines in readme file

319

increased by0.31%

No dependency changes