api-def 0.7.0-alpha.1 → 0.7.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2019 James Waterhouse
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+MIT License
+
+Copyright (c) 2019 James Waterhouse
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

package/README.md

@@ -1,34 +1,34 @@
-# [api-def](https://github.com/Censkh/api-def/) · [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Censkh/api-def/blob/master/LICENSE) [![npm version](https://img.shields.io/npm/v/api-def.svg?style=flat)](https://www.npmjs.com/package/api-def) [![build status](https://img.shields.io/github/workflow/status/censkh/api-def/Node.js%20CI)](https://github.com/Censkh/api-def/actions)
-
-Typed APIs with middleware support
-
-API def provides a unified way to type your endpoints allowing for compile time checking of query, body, response and even url parameters
-
-``` npm i api-def ```
-
-- [Documentation](https://censkh.github.io/api-def/)
-
-```typescript
-import {Api} from "api-def";
-
-const api = new Api({
-  baseUrl: "https://my-api/",
-  name: "My API",
-});
-
-const fetchData = api.endpoint()
-    .queryOf<{ includeAwesome: boolean; }>()
-    .responseOf<{ data: {awesome: boolean; } }>()
-    .build({
-      id: "fetch_data",
-      method: "get",
-      path: "/data"
-    });
-
-// calls GET https://my-api/data?includeAwesome=true
-const res = await fetchData.submit({
-  query: {includeAwesome: true}
-});
-
-console.log(res.data); // { data: { awesome: true } }
-```
+# [api-def](https://github.com/Censkh/api-def/) &middot; [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Censkh/api-def/blob/master/LICENSE) [![npm version](https://img.shields.io/npm/v/api-def.svg?style=flat)](https://www.npmjs.com/package/api-def) [![build status](https://img.shields.io/github/workflow/status/censkh/api-def/Node.js%20CI)](https://github.com/Censkh/api-def/actions)
+
+Typed APIs with middleware support
+
+API def provides a unified way to type your endpoints allowing for compile time checking of query, body, response and even url parameters
+
+``` npm i api-def ```
+
+- [Documentation](https://censkh.github.io/api-def/)
+
+```typescript
+import {Api} from "api-def";
+
+const api = new Api({
+  baseUrl: "https://my-api/",
+  name: "My API",
+});
+
+const fetchData = api.endpoint()
+    .queryOf<{ includeAwesome: boolean; }>()
+    .responseOf<{ data: {awesome: boolean; } }>()
+    .build({
+      id: "fetch_data",
+      method: "get",
+      path: "/data"
+    });
+
+// calls GET https://my-api/data?includeAwesome=true
+const res = await fetchData.submit({
+  query: {includeAwesome: true}
+});
+
+console.log(res.data); // { data: { awesome: true } }
+```

package/cjs/MockingTypes.d.ts

@@ -7,6 +7,7 @@ export interface MockRequest<R = any, P extends Params | undefined = Params | un
     body: B;
     query: Q;
     headers: Readonly<Headers>;
+    url: string;
 }
 export interface MockResponse<R = any, P extends Params | undefined = Params | undefined, Q extends Query | undefined = Query | undefined, B extends Body | undefined = Body | undefined> {
     statusCode: number;

package/cjs/RequestContext.js

@@ -37,7 +37,6 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 var Utils = require("./Utils");
-var url_1 = require("url");
 var contextIdCounter = 0;
 var RequestContext = /** @class */ (function () {
     function RequestContext(backend, host, config, computedPath, mocking) {
@@ -132,7 +131,7 @@ var RequestContext = /** @class */ (function () {
             var contentTypeKey = Object.keys(this.computedConfig.headers).find(function (key) { return key.toLowerCase() === "content-type"; });
             var contentType = contentTypeKey && ((_a = this.computedConfig.headers[contentTypeKey]) === null || _a === void 0 ? void 0 : _a.toString());
             if (contentType === "application/x-www-form-urlencoded") {
-                var searchParams = new url_1.URLSearchParams();
+                var searchParams = new URLSearchParams();
                 for (var _i = 0, _b = Object.keys(this.computedConfig.body); _i < _b.length; _i++) {
                     var key = _b[_i];
                     var value = this.computedConfig.body[key];

package/cjs/backend/MockRequestBackend.js

@@ -82,6 +82,7 @@ var MockRequestBackend = /** @class */ (function () {
                             params: (_b = context.computedConfig.params) !== null && _b !== void 0 ? _b : {},
                             query: context.computedConfig.query,
                             headers: (_c = context.computedConfig.headers) !== null && _c !== void 0 ? _c : {},
+                            url: context.getRequestUrl().toString(),
                         };
                         res = {
                             statusCode: -1,

package/esm/MockingTypes.d.ts

@@ -7,6 +7,7 @@ export interface MockRequest<R = any, P extends Params | undefined = Params | un
     body: B;
     query: Q;
     headers: Readonly<Headers>;
+    url: string;
 }
 export interface MockResponse<R = any, P extends Params | undefined = Params | undefined, Q extends Query | undefined = Query | undefined, B extends Body | undefined = Body | undefined> {
     statusCode: number;

package/esm/RequestContext.js

@@ -35,7 +35,6 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 import * as Utils from "./Utils";
-import { URLSearchParams } from "url";
 var contextIdCounter = 0;
 var RequestContext = /** @class */ (function () {
     function RequestContext(backend, host, config, computedPath, mocking) {

package/esm/backend/MockRequestBackend.js

@@ -80,6 +80,7 @@ var MockRequestBackend = /** @class */ (function () {
                             params: (_b = context.computedConfig.params) !== null && _b !== void 0 ? _b : {},
                             query: context.computedConfig.query,
                             headers: (_c = context.computedConfig.headers) !== null && _c !== void 0 ? _c : {},
+                            url: context.getRequestUrl().toString(),
                         };
                         res = {
                             statusCode: -1,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "api-def",
-  "version": "0.7.0-alpha.1",
+  "version": "0.7.0",
   "description": "Typed API definitions with middleware support",
   "main": "cjs/index.js",
   "types": "esm/index.d.ts",
@@ -66,6 +66,7 @@
     "@typescript-eslint/eslint-plugin": "4.28.5",
     "@typescript-eslint/parser": "4.28.5",
     "ava": "5.0.1",
+    "axios": "1.1.3",
     "cross-env": "7.0.3",
     "eslint": "7.31.0",
     "eslint-watch": "7.0.0",