@mtorre4580/is-deprecated 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Matias Daniel Torre
+
+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

@@ -0,0 +1,87 @@
+# deprecated
+
+A utility library designed to notify about deprecated functions or methods within objects.
+
+<img  width="128" height="128" src="https://github.com/mtorre4580/deprecated/blob/main/deprecated.png?raw=true" />
+
+## Installation
+
+```
+npm i deprecated
+```
+
+## Parameters
+
+- obj (Object|Function): The object or function to check for deprecation.
+
+- config (Object): Configuration object with the following properties:
+  - method (String): The method name to be deprecated within the object.
+  - message (String): Custom deprecation message (default: 'This will be deprecated soon').
+  - logger (Object): Logger object for warning messages (default: console).
+  - sendMetrics (Function): Function to send metrics upon deprecation (default: empty function).
+
+## Usage
+
+Function to notify about deprecation and wrap the function/method with deprecation warnings.
+
+### With Function
+
+```js
+import deprecated from "deprecated";
+
+// Function to add the deprecated helper
+const myFunction = (arg1, arg2) => {};
+
+// Basic config
+const config = {
+  message:
+    "myFunction will be removed in the next release, please replace with this https://www.npmjs.com",
+};
+
+// Create the wrapper to use
+const deprecatedMyFunction = deprecated(myFunction, config);
+
+// Call the wrapper function to see the warning
+deprecatedMyFunction('', {});
+```
+
+### With Function in Object
+
+```js
+import deprecated from "deprecated";
+
+// Object to apply the deprecated method
+const API = {
+  timeout: 5000,
+  getUsers() {
+    return new Promise((resolve, reject) => {
+      setTimeOut(() => {
+        resolve([
+          { id: 2, name: "Matias" },
+          { id: 3, name: "Belen" },
+        ]);
+      }, 1000);
+    });
+  },
+  getUsersV2() {},
+};
+
+// Basic config
+const config = {
+  message: "getUsers is deprecated in the next release, please with getUsersV2",
+  method: "getUsers",
+};
+
+// Create the wrapper to use
+const APIWithDeprecated = deprecated(API, config);
+
+// Call the wrapper function to see the warning
+const users = await APIWithDeprecated.getUsers();
+```
+
+## Best Practices
+
+- To building time use the jsdoc decorator [@deprecated](https://jsdoc.app/tags-deprecated) in the code
+- To runtime use the function from this lib `deprecated` to notify in the console
+- The sendMetrics function allows to get more insight what app is using the deprecated method to notify the team
+- You can use any environment variable to apply the wrapper or not, if you only need to run in development or staging

package/dist/deprecated.es.js

@@ -0,0 +1,28 @@
+var f = (e, r) => () => (r || e((r = { exports: {} }).exports, r), r.exports);
+var h = f((w, c) => {
+  function u(e) {
+    return typeof e == "function";
+  }
+  function a(e, r) {
+    const {
+      method: n = null,
+      message: t = "This will be deprecated soon",
+      logger: o = console,
+      sendMetrics: i = () => {
+      }
+    } = r || {};
+    if (e == null)
+      throw new Error("The param obj is required");
+    if (u(e))
+      return o.warn(t), i(), (...s) => e(...s);
+    if (!u(e[n]))
+      throw new Error("The object not have the method defined");
+    return new Proxy(e, {
+      get(s, d) {
+        return d === n && (o.warn(t), i()), Reflect.get(...arguments);
+      }
+    });
+  }
+  c.exports = a;
+});
+export default h();

package/dist/deprecated.umd.js

@@ -0,0 +1 @@
+(function(n){typeof define=="function"&&define.amd?define(n):n()})(function(){"use strict";function n(e){return typeof e=="function"}function f(e,d){const{method:t=null,message:r="This will be deprecated soon",logger:i=console,sendMetrics:o=()=>{}}=d||{};if(e==null)throw new Error("The param obj is required");if(n(e))return i.warn(r),o(),(...u)=>e(...u);if(!n(e[t]))throw new Error("The object not have the method defined");return new Proxy(e,{get(u,c){return c===t&&(i.warn(r),o()),Reflect.get(...arguments)}})}module.exports=f});

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@mtorre4580/is-deprecated",
+  "version": "0.0.1",
+  "description": "Library to deprecated properties and methods in objects or functions",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mtorre4580/deprecated"
+  },
+  "homepage": "https://github.com/mtorre4580/deprecated/blob/main/README.md",
+  "bugs": {
+    "url": "https://github.com/mtorre4580/deprecated/issues"
+  },
+  "keywords": [
+    "deprecated",
+    "deprecated",
+    "javascript",
+    "nodejs"
+  ],
+  "author": "mtorre4580",
+  "files":["dist"],
+  "main":"./dist/deprecated.umd.js",
+  "module":"./dist/deprecated.es.js",
+  "exports": {
+    ".": {
+      "import": "./dist/deprecated.es.js",
+      "require": "./dist/deprecated.umd.js"
+    }
+  },
+  "scripts": {
+    "prepare": "husky install",
+    "dev": "vite",
+    "build": "vite build",
+    "preview": "vite preview",
+    "lint": "eslint '**/*.js'",
+    "lint:fix": "eslint '**/*.js' --fix",
+    "test": "jest --config jest.config.js",
+    "test:coverage": "jest --config jest.config.js --coverage",
+    "test:ci": "node --expose-gc ./node_modules/.bin/jest --ci --bail --runInBand --logHeapUsage --coverage",
+    "update-changelog": "git fetch && auto-changelog",
+    "audit": "yarn audit --groups 'dependencies devDependencies'"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^18.4.3",
+    "@commitlint/config-conventional": "^18.4.3",
+    "@types/jest": "^29.5.11",
+    "@types/node": "^20.10.4",
+    "auto-changelog": "^2.4.0",
+    "eslint": "^8.56.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-plugin-import": "^2.29.1",
+    "husky": "^8.0.3",
+    "jest": "^29.7.0",
+    "vite": "^5.0.10"
+  },
+  "auto-changelog": {
+    "output": "CHANGELOG.md",
+    "template": "update-changelog.hbs",
+    "unreleased": false,
+    "commitLimit": false,
+    "startingVersion": "0.0.1",
+    "sortCommits": "date-desc",
+    "hideEmptyReleases": true
+  },
+  "engines": {
+    "node": ">=16"
+  }
+}