@nanotime/http-please - npm Package Compare versions

Comparing version 0.1.1 to 1.0.0

dist/index.js

@@ -1,20 +0,20 @@
-var p = Object.defineProperty;
-var g = (r, t, e) => t in r ? p(r, t, { enumerable: !0, configurable: !0, writable: !0, value: e }) : r[t] = e;
-var c = (r, t, e) => (g(r, typeof t != "symbol" ? t + "" : t, e), e), m = (r, t, e) => {
-  if (!t.has(r))
+var g = Object.defineProperty;
+var f = (s, t, e) => t in s ? g(s, t, { enumerable: !0, configurable: !0, writable: !0, value: e }) : s[t] = e;
+var h = (s, t, e) => (f(s, typeof t != "symbol" ? t + "" : t, e), e), w = (s, t, e) => {
+  if (!t.has(s))
     throw TypeError("Cannot " + e);
 };
-var h = (r, t, e) => (m(r, t, "read from private field"), e ? e.call(r) : t.get(r)), f = (r, t, e) => {
-  if (t.has(r))
+var c = (s, t, e) => (w(s, t, "read from private field"), e ? e.call(s) : t.get(s)), p = (s, t, e) => {
+  if (t.has(s))
     throw TypeError("Cannot add the same private member more than once");
-  t instanceof WeakSet ? t.add(r) : t.set(r, e);
+  t instanceof WeakSet ? t.add(s) : t.set(s, e);
 };
-var a;
-class w {
-  constructor({ url: t, options: e, resolver: s = "json", plugins: n }) {
-    c(this, "url");
-    c(this, "options");
-    c(this, "resolver");
-    f(this, a, ["get", "post", "put", "delete", "fetch", "formatUrl"]);
-    this.url = new URL(t), this.options = e, this.resolver = s, this.registerPlugins(n);
+var u;
+class m {
+  constructor({ url: t, options: e, resolver: n = "json", plugins: r }) {
+    h(this, "url");
+    h(this, "options");
+    h(this, "resolver");
+    p(this, u, ["get", "post", "put", "delete", "fetch", "formatUrl"]);
+    this.url = new URL(t), this.options = e, this.resolver = n, this.registerPlugins(r);
   }
@@ -29,13 +29,13 @@ /**
     t.forEach((e) => {
-      let s;
-      if (Object.keys(e()).some((i) => (s = i, h(this, a).find((u) => u === i))))
-        throw new Error(`${s} is already registered`);
-      h(this, a).push(s);
+      let n;
+      if (Object.keys(e()).some((a) => (n = a, c(this, u).find((i) => i === a))))
+        throw new Error(`${n} is already registered`);
+      c(this, u).push(n);
     });
   }
   get plugins() {
-    return h(this, a);
+    return c(this, u);
   }
 }
-a = new WeakMap();
+u = new WeakMap();
 class d {
@@ -77,11 +77,15 @@ constructor() {
      */
-    async request(r, t = {}) {
+    async request(s, t = {}) {
       let e;
-      const s = this.requestInterceptors.get().reverse(), n = this.responseInterceptors.get(), o = fetch(r, {
+      const n = this.requestInterceptors.get().reverse(), r = this.responseInterceptors.get(), o = (i) => fetch(s, {
         ...this.options,
-        ...t
-      }), i = [...s, [o], ...n];
-      for (; i.length; ) {
-        const [u, l] = i.shift();
-        e = o.then(u, l);
+        ...i
+      }), a = [...n, [o, void 0], ...r];
+      for (e = Promise.resolve({
+        url: this.url,
+        resolver: this.resolver,
+        options: { ...this.options, ...t }
+      }); a.length; ) {
+        const [i, l] = a.shift();
+        e = e.then(i, l);
       }
@@ -92,3 +96,3 @@ return e;
 }
-function U() {
+function y() {
   return {
@@ -100,16 +104,17 @@ /**
      *   - path {string} - The path to retrieve data from.
-     *   - query {object} - Optional query parameters.
      *   - opts {object} - Additional options for the request.
      * @return {Promise<object>} - A promise that resolves to the response object.
      */
-    async get({ path: r, query: t, opts: e }) {
-      const s = this.formatUrl(r, t), n = await this.request(s, {
+    async get({ path: s = "", opts: t, resolver: e = "" }) {
+      const n = new URL(this.url);
+      n.pathname = s;
+      const r = await this.request(n, {
         method: "GET",
-        ...e
+        ...t
       });
-      return n.data = await n[this.resolver](), n;
+      return r.data = await r[e || this.resolver](), r;
     }
   };
 }
-function y() {
+function U() {
   return {
@@ -121,3 +126,2 @@ /**
      * - path {string} - The path for the request.
-     * - query {object} - The query parameters for the request.
      * - body {object} - The body of the request.
@@ -127,9 +131,11 @@ * - opts {object} - Additional options for the request.
      */
-    async post({ path: r, query: t, body: e, opts: s }) {
-      const n = this.formatUrl(r, t), o = await this.request(n, {
+    async post({ path: s = "", body: t, opts: e, resolver: n = "" }) {
+      const r = new URL(this.url);
+      r.pathname = s;
+      const o = await this.request(r, {
         method: "POST",
-        body: JSON.stringify(e),
-        ...s
+        body: JSON.stringify(t),
+        ...e
       });
-      return o.data = await o[this.resolver](), o;
+      return o.data = await o[n || this.resolver](), o;
     }
@@ -145,3 +151,2 @@ };
      *   - {string} path - The path for the PUT request.
-     *   - {object} query - The query parameters for the request.
      *   - {object} body - The request body.
@@ -151,13 +156,15 @@ *   - {object} opts - The options for the request.
      */
-    async put({ path: r, query: t, body: e, opts: s }) {
-      const n = this.formatUrl(r, t), o = await this.request(n, {
+    async put({ path: s = "", body: t, opts: e, resolver: n = "" }) {
+      const r = new URL(this.url);
+      r.pathname = s;
+      const o = await this.request(r, {
         method: "PUT",
-        body: JSON.stringify(e),
-        ...s
+        body: JSON.stringify(t),
+        ...e
       });
-      return o.data = await o[this.resolver](), o;
+      return o.data = await o[n || this.resolver](), o;
     }
   };
 }
-function v() {
+function I() {
   return {
@@ -173,45 +180,26 @@ /**
      */
-    async delete({ path: r, query: t, opts: e }) {
-      const s = this.formatUrl(r, t), n = await this.request(s, {
+    async delete({ path: s = "", opts: t, resolver: e = "" }) {
+      const n = new URL(this.url);
+      n.pathname = s;
+      const r = await this.request(n, {
         method: "DELETE",
-        ...e
+        ...t
       });
-      return n.data = await n[this.resolver](), n;
+      return r.data = await r[e || this.resolver](), r;
     }
   };
 }
-function I() {
-  return {
-    /**
-     * Formats a URL with the given path and parameters.
-     *
-     * @param {string} path - The path of the URL.
-     * @param {object} params - The parameters to be added to the URL.
-     * @return {string} The formatted URL.
-     */
-    formatUrl(r, t) {
-      if (!t)
-        return `${this.url.origin}${r}${this.url.searchParams}`;
-      const e = new URLSearchParams([
-        ...Array.from(this.url.searchParams.entries()),
-        ...Object.entries(t)
-      ]).toString();
-      return `${this.url.origin}${r}?${e}`;
-    }
-  };
-}
 function E({
-  options: r,
+  options: s,
   url: t,
   resolver: e,
-  plugins: s = []
+  plugins: n = []
 }) {
-  const n = new w({ url: t, options: r, resolver: e, plugins: s }), o = s.reduce((u, l) => ({ ...u, ...l() }), {});
+  const r = new m({ url: t, options: s, resolver: e, plugins: n }), o = n.reduce((i, l) => ({ ...i, ...l() }), {});
   return {
-    ...n,
+    ...r,
     ...P(),
+    ...y(),
     ...U(),
-    ...y(),
     ...q(),
-    ...v(),
     ...I(),
@@ -218,0 +206,0 @@ ...o

package.json

 {
   "name": "@nanotime/http-please",
   "private": false,
-  "version": "0.1.1",
+  "version": "1.0.0",
   "type": "module",
-  "main": "./dist/index.js",
-  "module": "./dist/index.js",
-  "types": "./dist/index.d.ts",
   "exports": {
     ".": {
       "import": "./dist/index.js"
+    },
+    "./plugins": {
+      "import": "./dist/plugins.js"
     }
@@ -13,0 +13,0 @@ },

README.md

@@ -1,19 +0,248 @@
-# htt-please
+<!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 -->
 
-Hello, this is a simple didactic repository that aims to create a fetch API wrapper
-with typings and extensible with plugins.
+<a name="readme-top"></a>
 
-## Repo rules
+<!--
+*** Thanks for checking out the Best-README-Template. If you have a suggestion
+*** that would make this better, please fork the repo and create a pull request
+*** or simply open an issue with the tag "enhancement".
+*** Don't forget to give the project a star!
+*** Thanks again! Now go create something AMAZING! :D
+-->
 
-- Everything must be tested
-- Commits should be done using `npm run commit`
-- Styleguide is enforced
+<!-- PROJECT SHIELDS -->
+<!--
+*** I'm using markdown "reference style" links for readability.
+*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
+*** See the bottom of this document for the declaration of the reference variables
+*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
+*** https://www.markdownguide.org/basic-syntax/#reference-style-links
+-->
+<!-- [![Contributors][contributors-shield]][contributors-url]
+[![Forks][forks-shield]][forks-url]
+[![Stargazers][stars-shield]][stars-url]
+[![Issues][issues-shield]][issues-url]
+[![MIT License][license-shield]][license-url]
+[![LinkedIn][linkedin-shield]][linkedin-url] -->
 
-## Tools
+<!-- PROJECT LOGO -->
+<br />
+<div align="center">
+  <a href="https://github.com/@nanotime/http-please">
+    <img src="images/logo.png" alt="Logo" width="80" height="80">
+  </a>
 
-The repo is growing in some tools, the commiting part is taken by `better-commits` package and
-the branching is taken by `better-branch`, you just need to use `npm run commmit` or `npm run branch` to use them.
+<h3 align="center">Http Please</h3>
 
-Testing is taken by `vitest` and building by `vite`.
+  <p align="center">
+    An Fetch API wrapper writen in vainilla JS
+    <br />
+    <!-- <a href="https://github.com/@nanotime/http-please"><strong>Explore the docs »</strong></a> -->
+    <br />
+    <br />
+    <!-- <a href="https://github.com/@nanotime/http-please">View Demo</a> -->
+    ·
+    <a href="https://github.com/nanotime/http-please/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/nanotime/http-please/issues">Request Feature</a>
+  </p>
+</div>
 
-That's it for the moment
+<!-- TABLE OF CONTENTS -->
+<details>
+  <summary>Table of Contents</summary>
+  <ol>
+    <li>
+      <a href="#about-the-project">About The Project</a>
+      <!-- <ul>
+        <li><a href="#built-with">Built With</a></li>
+      </ul> -->
+    </li>
+    <li>
+      <a href="#getting-started">Getting Started</a>
+      <ul>
+        <!-- <li><a href="#prerequisites">Prerequisites</a></li> -->
+        <li><a href="#installation">Installation</a></li>
+      </ul>
+    </li>
+    <li><a href="#usage">Usage</a></li>
+    <!-- <li><a href="#roadmap">Roadmap</a></li> -->
+    <li><a href="#contributing">Contributing</a></li>
+    <li><a href="#license">License</a></li>
+    <!-- <li><a href="#contact">Contact</a></li> -->
+    <!-- <li><a href="#acknowledgments">Acknowledgments</a></li> -->
+  </ol>
+</details>
+
+<!-- ABOUT THE PROJECT -->
+
+## About The Project
+
+<!-- [![Product Name Screen Shot][product-screenshot]](https://example.com) -->
+
+<!-- Here's a blank template to get started: To avoid retyping too much info. Do a search and replace with your text editor for the following: `@nanotime`, `http-please`, `twitter_handle`, `linkedin_username`, `email_client`, `email`, `project_title`, `project_description` -->
+
+http-please is a Fetch API wrapper library written in vanilla JS that was born as an educational project to learn how to apply design patterns and build npm packages with all the guarantees you would expect from a production-ready package.
+
+The goal is not to create a package used by everyone that dethrones the big ones, but a contained package that is easy to extend where any programmer can contribute and understand more about how this world of libraries works.
+
+Oh yes! And it works, you can use it for your personal projects, after all it's fetch...
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- ### Built With -->
+
+<!-- * [![Vite][Vite.js]][Vite-url] -->
+<!-- * [![React][React.js]][React-url] -->
+<!-- * [![Vue][Vue.js]][Vue-url] -->
+<!-- * [![Angular][Angular.io]][Angular-url] -->
+<!-- * [![Svelte][Svelte.dev]][Svelte-url] -->
+<!-- * [![Laravel][Laravel.com]][Laravel-url] -->
+<!-- * [![Bootstrap][Bootstrap.com]][Bootstrap-url] -->
+<!-- * [![JQuery][JQuery.com]][JQuery-url] -->
+
+<!-- <p align="right">(<a href="#readme-top">back to top</a>)</p> -->
+
+<!-- GETTING STARTED -->
+
+## Getting Started
+
+Let's go, then...
+
+<!-- Using this lib is easiest like:
+
+```sh
+npm i -S @nanotime/http-please
+``` -->
+
+### Installation
+
+1. Install the library `npm i -D @nanotime/http-please`
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- USAGE EXAMPLES -->
+
+## Usage
+
+Using this library is not different to use any other NPM library, just import it after the install
+and call the compositor:
+
+```js
+// Import the lib
+import CreateHttpPlease from '@nanotime/http-please';
+
+// Create an instance
+const http = CreateHttpPlease({
+  url: 'http://example.com',
+  options: { ... }
+})
+
+// Make a call
+http.get({ path: '/foo' }).then(res => console.log(res.data));
+
+// It can be done also with async/await
+
+async function getFoo() {
+  const response = await http.get({ path: 'foo' });
+  console.log(response);
+  return response;
+}
+
+getFoo(); // log response
+```
+
+_For more examples, please refer to the [Documentation](https://github.com/nanotime/http-please/wiki)_
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- ROADMAP -->
+<!-- ## Roadmap
+
+- [ ] Feature 1
+- [ ] Feature 2
+- [ ] Feature 3
+    - [ ] Nested Feature
+
+See the [open issues](https://github.com/@nanotime/http-please/issues) for a full list of proposed features (and known issues).
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p> -->
+
+<!-- CONTRIBUTING -->
+
+## Contributing
+
+Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "feature".
+Don't forget to give the project a star! Thanks again!
+
+**Important note**: this project has some strict rules (husky, testing, etc) for commiting and tools to help on it, don't make commits using the git command, instead just run `npm run commit`, this wil guide you on the correct standard way to commiting in this project. There is also a command `npm run branch` that can help you to create branch in a proper way.
+
+1. Fork the Project
+2. Create your Feature Branch (`npm run branch`)
+3. Commit your Changes (`npm run commit'`)
+4. Push to the Branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- LICENSE -->
+
+## License
+
+Distributed under the MIT License. See `LICENSE.txt` for more information.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- CONTACT -->
+<!-- ## Contact
+
+Your Name - [@twitter_handle](https://twitter.com/twitter_handle) - email@email_client.com
+
+Project Link: [https://github.com/@nanotime/http-please](https://github.com/@nanotime/http-please)
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p> -->
+
+<!-- ACKNOWLEDGMENTS -->
+<!-- ## Acknowledgments
+
+* []()
+* []()
+* []()
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p> -->
+
+<!-- MARKDOWN LINKS & IMAGES -->
+<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
+
+<!-- [contributors-shield]: https://img.shields.io/github/contributors/@nanotime/http-please.svg?style=for-the-badge
+[contributors-url]: https://github.com/@nanotime/http-please/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/@nanotime/http-please.svg?style=for-the-badge
+[forks-url]: https://github.com/@nanotime/http-please/network/members
+[stars-shield]: https://img.shields.io/github/stars/@nanotime/http-please.svg?style=for-the-badge
+[stars-url]: https://github.com/@nanotime/http-please/stargazers
+[issues-shield]: https://img.shields.io/github/issues/@nanotime/http-please.svg?style=for-the-badge
+[issues-url]: https://github.com/@nanotime/http-please/issues
+[license-shield]: https://img.shields.io/github/license/@nanotime/http-please.svg?style=for-the-badge
+[license-url]: https://github.com/@nanotime/http-please/blob/master/LICENSE.txt
+[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
+[linkedin-url]: https://linkedin.com/in/linkedin_username
+[product-screenshot]: images/screenshot.png
+[Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white
+[Next-url]: https://nextjs.org/
+[React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB
+[React-url]: https://reactjs.org/
+[Vue.js]: https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vuedotjs&logoColor=4FC08D
+[Vue-url]: https://vuejs.org/
+[Angular.io]: https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular&logoColor=white
+[Angular-url]: https://angular.io/
+[Svelte.dev]: https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00
+[Svelte-url]: https://svelte.dev/
+[Laravel.com]: https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge&logo=laravel&logoColor=white
+[Laravel-url]: https://laravel.com
+[Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white
+[Bootstrap-url]: https://getbootstrap.com
+[JQuery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white
+[JQuery-url]: https://jquery.com -->
+<!-- [Vite-url]: https://vitejs.dev/ -->

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

19110

increased by90%

Number of package files

5

increased by25%

Lines of code

223

increased by4.21%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

249

increased by1145%

No dependency changes