@ancon/wildcat-utils 1.6.0 → 1.7.0

package/dist/color/brighten.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Brighten the HEX color a given amount.
+ *
+ * @param hex - The color HEX code
+ * @param amount - The amount to brighten by. The valid range is 0 to 100. Default value: 10.
+ * @returns The brightened HEX color code
+ */
+export default function brighten(hex: string, amount?: number): string;

package/dist/color/brighten.js

@@ -0,0 +1,17 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const tinycolor2_1 = __importDefault(require("tinycolor2"));
+/**
+ * Brighten the HEX color a given amount.
+ *
+ * @param hex - The color HEX code
+ * @param amount - The amount to brighten by. The valid range is 0 to 100. Default value: 10.
+ * @returns The brightened HEX color code
+ */
+function brighten(hex, amount) {
+    return (0, tinycolor2_1.default)(hex).brighten(amount).toString();
+}
+exports.default = brighten;

package/dist/color/darken.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Darken the color a given amount. Providing 100 will always return black.
+ *
+ * @param hex - The color HEX code
+ * @param amount - The amount to darken by. The valid range is 0 to 100. Default value: 10.
+ * @returns The darkened HEX color code
+ */
+export default function darken(hex: string, amount?: number): string;

package/dist/color/darken.js

@@ -0,0 +1,17 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const tinycolor2_1 = __importDefault(require("tinycolor2"));
+/**
+ * Darken the color a given amount. Providing 100 will always return black.
+ *
+ * @param hex - The color HEX code
+ * @param amount - The amount to darken by. The valid range is 0 to 100. Default value: 10.
+ * @returns The darkened HEX color code
+ */
+function darken(hex, amount) {
+    return (0, tinycolor2_1.default)(hex).darken(amount).toString();
+}
+exports.default = darken;

package/dist/color/index.d.ts

@@ -0,0 +1,4 @@
+import lighten from './lighten';
+import brighten from './brighten';
+import darken from './darken';
+export { lighten, brighten, darken };

package/dist/color/index.js

@@ -0,0 +1,12 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.darken = exports.brighten = exports.lighten = void 0;
+const lighten_1 = __importDefault(require("./lighten"));
+exports.lighten = lighten_1.default;
+const brighten_1 = __importDefault(require("./brighten"));
+exports.brighten = brighten_1.default;
+const darken_1 = __importDefault(require("./darken"));
+exports.darken = darken_1.default;

package/dist/color/lighten.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Lighten the given hex color a given amount. Providing 100 will always return white.
+ *
+ * @param hex - The color HEX code
+ * @param amount - The amount to lighten by. The valid range is 0 to 100. Default value: 10.
+ * @returns The lightened HEX color
+ */
+export default function lighten(hex: string, amount?: number): string;

package/dist/color/lighten.js

@@ -0,0 +1,17 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const tinycolor2_1 = __importDefault(require("tinycolor2"));
+/**
+ * Lighten the given hex color a given amount. Providing 100 will always return white.
+ *
+ * @param hex - The color HEX code
+ * @param amount - The amount to lighten by. The valid range is 0 to 100. Default value: 10.
+ * @returns The lightened HEX color
+ */
+function lighten(hex, amount) {
+    return (0, tinycolor2_1.default)(hex).lighten(amount).toString();
+}
+exports.default = lighten;

package/dist/index.d.ts

@@ -3,3 +3,4 @@ export * from './outlet';
 export * from './versioning';
 export * from './api';
 export * from './string';
+export * from './color';

package/dist/index.js

@@ -15,3 +15,4 @@ __exportStar(require("./outlet"), exports);
 __exportStar(require("./versioning"), exports);
 __exportStar(require("./api"), exports);
 __exportStar(require("./string"), exports);
+__exportStar(require("./color"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ancon/wildcat-utils",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "",
   "repository": "git@bitbucket.org:anconab/wildcat.client.utils.git",
   "main": "dist/index.js",
@@ -28,6 +28,7 @@
     "@semantic-release/npm": "^8.0.3",
     "@semantic-release/release-notes-generator": "^10.0.3",
     "@types/jest": "^27.0.3",
+    "@types/tinycolor2": "^1.4.3",
     "@typescript-eslint/eslint-plugin": "^5.8.1",
     "@typescript-eslint/parser": "^5.8.1",
     "axios": "^0.27.2",
@@ -99,5 +100,7 @@
       ]
     ]
   },
-  "dependencies": {}
+  "dependencies": {
+    "tinycolor2": "^1.4.2"
+  }
 }