datatable-axios 0.0.9 → 1.1.0

package/.github/workflows/publish.yml

@@ -0,0 +1,51 @@
+name: Publish to npm
+
+on:
+  push:
+    branches: [main]
+
+permissions:
+  contents: write
+  issues: write
+  pull-requests: write
+  id-token: write
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "24"
+          cache: "npm"
+
+      - run: npm ci
+
+      - run: npm run lint
+
+      - run: npm run format:check
+
+      - run: npm test
+
+  release:
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "24"
+          registry-url: "https://registry.npmjs.org"
+          cache: "npm"
+
+      - run: npm ci
+
+      - run: npx semantic-release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/sonar.yml

@@ -0,0 +1,28 @@
+name: SonarCloud
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  sonar:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "24"
+          cache: "npm"
+
+      - run: npm ci
+
+      - run: npm run test:coverage
+
+      - uses: SonarSource/sonarqube-scan-action@v6
+        env:
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

package/.prettierignore

@@ -0,0 +1,4 @@
+node_modules
+package-lock.json
+dist
+docs

package/.prettierrc.json

@@ -0,0 +1,8 @@
+{
+  "semi": true,
+  "singleQuote": false,
+  "trailingComma": "all",
+  "printWidth": 100,
+  "tabWidth": 2,
+  "arrowParens": "always"
+}

package/.releaserc.json

@@ -0,0 +1,16 @@
+{
+  "branches": ["main"],
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    "@semantic-release/npm",
+    "@semantic-release/github",
+    [
+      "@semantic-release/git",
+      {
+        "assets": ["package.json", "package-lock.json"],
+        "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+      }
+    ]
+  ]
+}

package/CHANGELOG.md

@@ -0,0 +1,78 @@
+# Changelog
+
+All notable changes to this project are documented in this file. Format is
+based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
+
+## [1.0.0] - 2026-09-06
+
+Modernization relaunch — no public API changes.
+
+- Add ESLint + Prettier configuration.
+- Add unit tests (`node:test`) covering `get`/`post`/`put` with and without
+  `page`/`paginate`/`search` query parameters.
+- Add GitHub Actions workflows for CI/publish and SonarCloud analysis.
+- Add semantic-release configuration for automated npm publishing.
+- Simplify `datatable.js` request methods to return the underlying
+  `window.axios` promise directly instead of wrapping it in a redundant
+  `new Promise(async ...)` executor (behavior unchanged).
+
+## [0.0.11] - 2023-09-07
+
+Note: not published to npm (latest published version is 0.0.10); dated from
+the version-bump commit `6842c9b`.
+
+- Add JSDoc comments across `datatable.js`.
+- Fix `searchParams` variable scoping (moved from global to local scope).
+- Change `const` to `let` for reassigned variables.
+- Add `publish` npm script.
+- Various README/documentation and image/branding refinements (author info,
+  npm install instructions, header meta tags, permission policy meta, OG
+  images, copy-code notification, `.vscode` gitignore entry).
+
+## [0.0.10] - 2023-08-21
+
+- Add documentation link to README.
+
+## [0.0.9] - 2023-08-21
+
+- Add license.
+- Add pros & cons section, badge information, and general documentation to
+  README.
+- Correct README API URL and text.
+- Add npm website reference.
+
+## [0.0.8] - 2023-08-20
+
+- Add code comments and reorganize README.
+
+## [0.0.7] - 2023-08-20
+
+- Change package export file configuration.
+
+## [0.0.6] - 2023-08-20
+
+- Add `.npmignore`.
+
+## [0.0.5] - 2023-08-20
+
+- Add `rollup.config.js` for bundling.
+- Add `peerDependencies` to `package.json`.
+- Update `package.json` keywords.
+
+## [0.0.4] - 2023-08-20
+
+- Change all files (internal restructuring).
+
+## [0.0.3] - 2023-08-20
+
+- Fix: add `axios` dependency.
+
+## [0.0.2] - 2023-08-20
+
+- Remove unused `datatable` constructor.
+
+## [0.0.1] - 2023-08-20
+
+- Initial release: `datatable` class with `get`/`post`/`put` methods that
+  proxy `window.axios` requests, appending `page`/`paginate`/`search` query
+  parameters when present in the current page's URL.

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2023 Mahmudun Nabi Kajal
-
-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) 2023 Mahmudun Nabi Kajal
+
+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,137 +1,176 @@
-# Datatable Axios
-[![mahmudunnabikajal - datatable-axios](https://img.shields.io/static/v1?label=mahmudunnabikajal&message=datatable-axios&color=blue&logo=github)](https://github.com/mahmudunnabikajal/datatable-axios "Go to GitHub repo")
-[![Latest Stable Version](https://img.shields.io/npm/v/datatable-axios.svg)](https://www.npmjs.com/package/datatable-axios)
-[![NPM Downloads](https://img.shields.io/npm/dt/datatable-axios.svg)](https://www.npmjs.com/package/datatable-axios)
-[![License](https://img.shields.io/badge/License-MIT-blue)](#license)
-<!-- [![Documentation](https://img.shields.io/badge/Documentation-blue)](./docs/index.html "Go to project documentation") -->
-
-
-Datatable Axios is a simple and convenient npm package that helps you make GET, POST, and PUT requests with ease, while handling search parameters and pagination seamlessly. It's built on top of the popular Axios library, making it reliable and efficient for your data fetching needs.
-
-&nbsp;
-# Installation
-You can install Datatable Axios using npm:
-
-```bash
-npm install datatable-axios
-```
-&nbsp;
-# Why Datatable Axios?
-Simplify your `HTTP calls without repetition`. Say goodbye to repeating steps for every datatable request!
-
-- **`Cons:`** Without using the library, you can achieve the same functionality in Axios which `isn't readable & reusable`.
-```js
-const response = await axios.get('http://example.com/api/v1/products?page=2&paginate=25&search=we');
-console.log(response.data);
-```
-- **`Pros:`** After using this library, you can achieve the same functionality of Axios in a `readable & reusable way`
-```js
-const response = await datatable.get('products');
-console.log(response.data);
-```
-&nbsp;
-# Usage
-To get started with Datatable Axios, follow these simple steps:
-
-- use global axios plugin setup in `axios.js` (optional)
-``` js
-import axios from "axios"
-
-// Make the axios library globally available on the window object
-window.axios = axios
-// Set your base API URL for seamless requests
-window.axios.defaults.baseURL = "http://example.com/api/v1/"
-
-// Other configuration here
-```
-
-- Import the package at the top of your JavaScript file:
-
-```js
-import datatable from 'datatable-axios'
-```
-- Initialize an instance of the Datatable class:
-
-```js
-const datatable = new Datatable();
-```
-&nbsp;
-# Use of API URL:
-
-- When you have a global `axios.js` configuration setting with baseURL, simplify calls API by using just the path:
-```js
-const response = await datatable.get('products');
-console.log(response.data);
-```
-- If you're not utilizing a global `axios.js` configuration for with baseURL, include the full URL when making API calls:
-```js
-const response = await datatable.get('http://example.com/api/v1/products');
-console.log(response.data);
-```
-&nbsp;
-# Use of HTTP requests:
-
-- Perform a GET request:
-```js
-const response = await datatable.get('url or path');
-console.log(response.data); // Display the fetched data
-```
-- Perform a POST request:
-```js
-const response = await datatable.post('url or path');
-console.log(response.data); // Display the response data
-```
-- Perform a PUT request:
-```js
-const response = await datatable.put('url or path');
-console.log(response.data); // Display the updated data
-```
-&nbsp;
-# Example of HTTP call:
-- Example 1 : 
-```js
-datatable.get('http://example.com/api/v1/products')
-  .then(response => {
-    console.log("Data fetched successfully:", response.data);
-  })
-  .catch(error => {
-    console.error("An error occurred:", error);
-  });
-```
-- Example 2 : 
-```js
-try {
-  const response = await datatable.get('/api/v1/products');
-  console.log("Data fetched successfully:", response.data);
-} catch (error) {
-  console.error("An error occurred:", error);
-}
-```
-**`Note:`** Similar usage for POST and PUT requests
-<!-- # Advanced Usage
-You can also pass search parameters, pagination, and search queries to your requests:
-
-```js
-// Append search parameters to the URL
-const response = await datatable.get('https://api.example.com/data', {
-  page: 1,
-  paginate: 10,
-  search: 'keyword',
-});
-console.log(response.data);
-``` -->
-
-&nbsp;
-# Contributing
-We welcome contributions to enhance Datatable Axios! Feel free to open issues for bug reports or feature requests. If you'd like to contribute code, please fork the repository, make your changes, and submit a pull request.
-
-&nbsp;
-# License
-Released under [MIT License](LICENSE) by [@mahmudunnabikajal](https://github.com/mahmudunnabikajal).
-
-&nbsp;
-# Author
-Mahmudun Nabi Kajal<br />
-Contact:  [Linkedin](https://www.linkedin.com/in/mahmudun-nabi-kajal/), [GitHub](https://github.com/mahmudunnabikajal), [Gmail](mailto:mahmudunnabikajal)
-
-Feel free to reach out to me for any questions or feedback! I hope Datatable Axios simplifies your data fetching process for your datatable.
+# Datatable Axios
+
+[![mahmudunnabikajal - datatable-axios](https://img.shields.io/static/v1?label=mahmudunnabikajal&message=datatable-axios&color=blue&logo=github)](https://github.com/mahmudunnabikajal/datatable-axios "Go to GitHub repo")
+[![Latest Stable Version](https://img.shields.io/npm/v/datatable-axios.svg)](https://www.npmjs.com/package/datatable-axios)
+[![NPM Downloads](https://img.shields.io/npm/dt/datatable-axios.svg)](https://www.npmjs.com/package/datatable-axios)
+[![License](https://img.shields.io/badge/License-MIT-blue)](#license)
+[![Documentation](https://img.shields.io/badge/Documentation-blue)](https://mahmudunnabikajal.github.io/datatable-axios/ "Go to project documentation")
+
+Datatable Axios is a simple and convenient npm package that helps you make GET, POST, and PUT requests with ease, while handling search parameters and pagination seamlessly. It's built on top of the popular Axios library, making it reliable and efficient for your data fetching needs.
+
+&nbsp;
+
+# Installation
+
+You can install Datatable Axios using npm:
+
+```bash
+npm install datatable-axios
+```
+
+&nbsp;
+
+# Why Datatable Axios?
+
+Simplify your `HTTP calls without repetition`. Say goodbye to repeating steps for every datatable request!
+
+- **`Cons:`** Without using the library, you can achieve the same functionality in Axios which _**isn't readable & reusable**_.
+
+```js
+const response = await axios.get("http://example.com/api/v1/products?page=2&paginate=25&search=we");
+console.log(response.data);
+```
+
+- **`Pros:`** After using this library, you can achieve the same functionality of Axios in a _**readable & reusable way**_
+
+```js
+const response = await datatable.get("products");
+console.log(response.data);
+```
+
+&nbsp;
+
+# Usage
+
+To get started with Datatable Axios, follow these simple steps:
+
+- use global axios plugin setup in `axios.js` (optional)
+
+```js
+import axios from "axios";
+
+// Make the axios library globally available on the window object
+window.axios = axios;
+// Set your base API URL for seamless requests
+window.axios.defaults.baseURL = "http://example.com/api/v1/";
+
+// Other configuration here
+```
+
+- Import the package at the top of your JavaScript file:
+
+```js
+import datatable from "datatable-axios";
+```
+
+- Initialize an instance of the Datatable class:
+
+```js
+const datatable = new Datatable();
+```
+
+&nbsp;
+
+# Use of API URL:
+
+- When you have a global `axios.js` configuration setting with baseURL, simplify calls API by using just the path:
+
+```js
+const response = await datatable.get("products");
+console.log(response.data);
+```
+
+- If you're not utilizing a global `axios.js` configuration for with baseURL, include the full URL when making API calls:
+
+```js
+const response = await datatable.get("http://example.com/api/v1/products");
+console.log(response.data);
+```
+
+&nbsp;
+
+# Use of HTTP requests:
+
+- Perform a GET request:
+
+```js
+const response = await datatable.get("url or path");
+console.log(response.data); // Display the fetched data
+```
+
+- Perform a POST request:
+
+```js
+const response = await datatable.post("url or path");
+console.log(response.data); // Display the response data
+```
+
+- Perform a PUT request:
+
+```js
+const response = await datatable.put("url or path");
+console.log(response.data); // Display the updated data
+```
+
+&nbsp;
+
+# Example of HTTP call:
+
+- Example 1 :
+
+```js
+datatable
+  .get("http://example.com/api/v1/products")
+  .then((response) => {
+    console.log("Data fetched successfully:", response.data);
+  })
+  .catch((error) => {
+    console.error("An error occurred:", error);
+  });
+```
+
+- Example 2 :
+
+```js
+try {
+  const response = await datatable.get("/api/v1/products");
+  console.log("Data fetched successfully:", response.data);
+} catch (error) {
+  console.error("An error occurred:", error);
+}
+```
+
+**`Note:`** Similar usage for POST and PUT requests
+<!-- # Advanced Usage
+You can also pass search parameters, pagination, and search queries to your requests:
+
+```js
+// Append search parameters to the URL
+const response = await datatable.get('https://api.example.com/data', {
+  page: 1,
+  paginate: 10,
+  search: 'keyword',
+});
+console.log(response.data);
+``` -->
+
+&nbsp;
+
+# Contributing
+
+We welcome contributions to enhance Datatable Axios! Feel free to open issues for bug reports or feature requests. If you'd like to contribute code, please fork the repository, make your changes, and submit a pull request.
+
+&nbsp;
+
+# License
+
+Released under [MIT License](LICENSE) by [@mahmudunnabikajal](https://github.com/mahmudunnabikajal).
+
+&nbsp;
+
+# Author
+
+Mahmudun Nabi Kajal<br />
+Contact: [Linkedin](https://www.linkedin.com/in/mahmudun-nabi-kajal/), [GitHub](https://github.com/mahmudunnabikajal), [Gmail](mailto:mahmudunnabikajal), [Website](http://mahmudunnabikajal.com/)
+
+Feel free to reach out to me for any questions or feedback! I hope Datatable Axios simplifies your data fetching process for your datatable.