mappersmith - npm Package Compare versions

Comparing version 2.32.1 to 2.33.0

mappersmith.js

@@ -16,3 +16,3 @@ "use strict";
 /* global VERSION */
-var version = "2.32.1";
+var version = "2.33.0";
 exports.version = version;
@@ -19,0 +19,0 @@ var configs = {

method-descriptor.js

@@ -12,3 +12,3 @@ "use strict";
  *   @param {String} obj.host
- *   @param {String} obj.path
+ *   @param {String|Function} obj.path
  *   @param {String} obj.method
@@ -15,0 +15,0 @@ *   @param {Object} obj.headers

package.json

 {
   "name": "mappersmith",
-  "version": "2.32.1",
+  "version": "2.33.0",
   "description": "It is a lightweight rest client for node.js and the browser",
@@ -5,0 +5,0 @@ "author": "Tulio Ornelas <[e-mail]>",

README.md

@@ -125,3 +125,3 @@ [![npm version](https://badge.fury.io/js/mappersmith.svg)](http://badge.fury.io/js/mappersmith)
       // {group} is also a dynamic segment but it has default value "general"
-      byGroup: { path: '/users/groups/{group}', params: { group: 'general' } }
+      byGroup: { path: '/users/groups/{group}', params: { group: 'general' } },
 
@@ -144,3 +144,6 @@ // {market?} is an optional dynamic segment. If called without a value
       // constructing the query string
-      bySubject: { path: '/blogs', queryParamAlias: { subjectId: 'subject_id' } }
+      bySubject: { path: '/blogs', queryParamAlias: { subjectId: 'subject_id' } },
+
+      // `path` is a function to map passed params to a custom path
+      byDate: { path: ({date}) => `${date.getYear()}/${date.getMonth()}/${date.getDate()}` }
     }
@@ -147,0 +150,0 @@ }

request.js

@@ -80,10 +80,16 @@ "use strict";
 
-    var path = this.methodDescriptor.path;
+    var params = this.params();
+    var path;
 
-    if (this.methodDescriptor.path[0] !== '/') {
-      path = "/".concat(this.methodDescriptor.path);
+    if (typeof this.methodDescriptor.path === 'function') {
+      path = this.methodDescriptor.path(params);
+    } else {
+      path = this.methodDescriptor.path;
     }
 
-    var params = this.params(); // RegExp with 'g'-flag is stateful, therefore defining it locally
+    if (path[0] !== '/') {
+      path = "/".concat(path);
+    } // RegExp with 'g'-flag is stateful, therefore defining it locally
 
+
     var regexp = new RegExp(REGEXP_DYNAMIC_SEGMENT, 'g');
@@ -90,0 +96,0 @@ var dynamicSegmentKeys = [];

typings/index.d.ts

@@ -13,2 +13,3 @@ /// <reference path="./middleware/basic-auth.d.ts" />
 declare module 'mappersmith' {
+
   export interface Headers {
@@ -26,3 +27,3 @@ readonly [header: string]: string
     readonly timeout?: number
-    [param: string]: object | string | number | undefined
+    [param: string]: object | string | number | boolean | undefined
   }
@@ -141,3 +142,2 @@
   export interface HTTPGateway extends Gateway, NetworkGateway {
-    configure(): object
     createResponse(response: Response, rawData: string): Response
@@ -165,5 +165,21 @@ onError(error: Error): void
 
+  export interface HTTPRequestParams {
+    [key: string]: any
+  }
+
+  export interface HTTPGatewayConfiguration {
+    configure?(requestParams: HTTPRequestParams): HTTPRequestParams
+    onRequestWillStart?(requestParams: HTTPRequestParams): void
+    onRequestSocketAssigned?(requestParams: HTTPRequestParams): void
+    onSocketLookup?(requestParams: HTTPRequestParams): void
+    onSocketConnect?(requestParams: HTTPRequestParams): void
+    onSocketSecureConnect?(requestParams: HTTPRequestParams): void
+    onResponseReadable?(requestParams: HTTPRequestParams): void
+    onResponseEnd?(requestParams: HTTPRequestParams): void
+    useSocketConnectionTimeout?: boolean
+  }
+
   export interface GatewayConfiguration {
     Fetch: object
-    HTTP: Partial<HTTPGateway>
+    HTTP: HTTPGatewayConfiguration
     Mock: object
@@ -170,0 +186,0 @@ XHR: Partial<XhrGateway>

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

151264

increased by0.62%

Lines of code

2859

increased by0.63%

Number of lines in readme file

1360

increased by0.22%

No dependency changes