color-bits 1.0.2 → 1.0.4

package/README.md

@@ -44,7 +44,7 @@ Due to the compact representation, `color-bits` preserves **at most 8 bits of pr
  - Yes: `oklab(59.69% 0.1007 0.1191)`
  - No: `oklab(from green l a b / 0.5)`
 
-When parsing and converting non-sRGB color spaces, `color-bits` behaves the same as browsers behave, which differs from the formal CSS spec! In technical terms: non-sRGB color spaces with a wider gamut are converted using clipping rather than gamut-mapping.
+When parsing and converting non-sRGB color spaces, `color-bits` behaves the same as browsers do, which differs from the formal CSS spec! In technical terms: non-sRGB color spaces with a wider gamut are converted using clipping rather than gamut-mapping.
 
 For performance reasons, the representation is `int32`, not `uint32`. It is expected if you see negative numbers when you print the color value.
 
@@ -52,8 +52,8 @@ Every function is tree-shakeable, so the bundle size cost should be from 1.5kb t
 
 ### 📚 Documentation
 
-[Documentation: `'color-bits'`](https://github.com/romgrk/color-bits/tree/master/docs/README.md)  
-[Documentation: `'color-bits/string'`](https://github.com/romgrk/color-bits/tree/master/docs/string/README.md)  
+[Docs for color-bits](https://github.com/romgrk/color-bits/tree/master/docs/README.md)  
+[Docs for color-bits/string](https://github.com/romgrk/color-bits/tree/master/docs/string/README.md)  
 
 If you're storing and manipulating colors frequently, you should use the `color-bits` exports directly, e.g.
 
@@ -61,24 +61,23 @@ If you're storing and manipulating colors frequently, you should use the `color-
 import * as Color from 'color-bits'
 
 const background = Color.parse('#232323')
-const seeThrough = Color.alpha(backround, 0.5)
+const seeThrough = Color.alpha(background, 0.5)
 const output = Color.format(seeThrough) // #RRGGBBAA string
 ```
 
-The `color-bits/string` exports wrap some of the functions to accept string colors as input/output, which may be used if you're not storing the colors but just transforming them on the fly.
+The `color-bits/string` module wraps some of the functions to accept string colors as input/output, which may be useful if you're not storing the colors but just transforming them on the fly. It can be faster than calling the functions separately in some cases.
 
 ```tsx
 import * as Color from 'color-bits/string'
 
-const background = '#232323'
-const output = Color.alpha(backround, 0.5) // #RRGGBBAA string
+const output = Color.alpha('#232323', 0.5) // #RRGGBBAA string
 ```
 
 ### 📜 License
 
 I release any of the code I wrote here to the public domain. Feel free to copy/paste in part or in full without attribution.
 
-Some parts of the codebase have been extracted from Chrome's devtools, MaterialUI, and stackoverflow, those contain a license notice or attribution in code comments, inline.
+Some parts of the codebase have been extracted from Chrome's devtools, MaterialUI, and stackoverflow, those contain a license notice or attribution in code comments, inline. Everything is MIT-compatible.
 
 <p align="center">
   <small>🔴🟠🟡🟢🔵🟣</small>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "color-bits",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "main": "index.js",
   "sideEffects": false,
   "exports": {
@@ -8,6 +8,7 @@
     "./*": "./build/*",
     "./string": "./build/string.js"
   },
+  "types": "./build/index.d.ts",
   "keywords": [
     "color",
     "colors"

package/build/transform.d.ts

@@ -1,19 +0,0 @@
-import { Color } from './core';
-/**
- * Modifies color alpha channel.
- * @param color - Color
- * @param value - Value in the range [0, 1]
- */
-export declare function alpha(color: Color, value: number): Color;
-/**
- * Darkens a color.
- * @param color - Color
- * @param coefficient - Multiplier in the range [0, 1]
- */
-export declare function darken(color: Color, coefficient: number): Color;
-/**
- * Lighten a color.
- * @param color - Color
- * @param coefficient - Multiplier in the range [0, 1]
- */
-export declare function lighten(color: Color, coefficient: number): Color;

package/build/transform.js

@@ -1,40 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.alpha = alpha;
-exports.darken = darken;
-exports.lighten = lighten;
-const core_1 = require("./core");
-/**
- * Modifies color alpha channel.
- * @param color - Color
- * @param value - Value in the range [0, 1]
- */
-function alpha(color, value) {
-    return (0, core_1.setAlpha)(color, Math.round(value * 255));
-}
-/**
- * Darkens a color.
- * @param color - Color
- * @param coefficient - Multiplier in the range [0, 1]
- */
-function darken(color, coefficient) {
-    const r = (0, core_1.getRed)(color);
-    const g = (0, core_1.getGreen)(color);
-    const b = (0, core_1.getBlue)(color);
-    const a = (0, core_1.getAlpha)(color);
-    const factor = 1 - coefficient;
-    return (0, core_1.newColor)(r * factor, g * factor, b * factor, a);
-}
-/**
- * Lighten a color.
- * @param color - Color
- * @param coefficient - Multiplier in the range [0, 1]
- */
-function lighten(color, coefficient) {
-    const r = (0, core_1.getRed)(color);
-    const g = (0, core_1.getGreen)(color);
-    const b = (0, core_1.getBlue)(color);
-    const a = (0, core_1.getAlpha)(color);
-    return (0, core_1.newColor)(r + (255 - r) * coefficient, g + (255 - g) * coefficient, b + (255 - b) * coefficient, a);
-}
-//# sourceMappingURL=transform.js.map

package/build/transform.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"transform.js","sourceRoot":"","sources":["../src/transform.ts"],"names":[],"mappings":";;AAeA,sBAEC;AAOD,wBAcC;AAOD,0BAYC;AAzDD,iCAQgB;AAEhB;;;;GAIG;AACH,SAAgB,KAAK,CAAC,KAAY,EAAE,KAAa;IAC/C,OAAO,IAAA,eAAQ,EAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,GAAG,CAAC,CAAC,CAAA;AACjD,CAAC;AAED;;;;GAIG;AACH,SAAgB,MAAM,CAAC,KAAY,EAAE,WAAmB;IACtD,MAAM,CAAC,GAAG,IAAA,aAAM,EAAC,KAAK,CAAC,CAAC;IACxB,MAAM,CAAC,GAAG,IAAA,eAAQ,EAAC,KAAK,CAAC,CAAC;IAC1B,MAAM,CAAC,GAAG,IAAA,cAAO,EAAC,KAAK,CAAC,CAAC;IACzB,MAAM,CAAC,GAAG,IAAA,eAAQ,EAAC,KAAK,CAAC,CAAC;IAE1B,MAAM,MAAM,GAAG,CAAC,GAAG,WAAW,CAAC;IAE/B,OAAO,IAAA,eAAQ,EACb,CAAC,GAAG,MAAM,EACV,CAAC,GAAG,MAAM,EACV,CAAC,GAAG,MAAM,EACV,CAAC,CACF,CAAA;AACH,CAAC;AAED;;;;GAIG;AACH,SAAgB,OAAO,CAAC,KAAY,EAAE,WAAmB;IACvD,MAAM,CAAC,GAAG,IAAA,aAAM,EAAC,KAAK,CAAC,CAAC;IACxB,MAAM,CAAC,GAAG,IAAA,eAAQ,EAAC,KAAK,CAAC,CAAC;IAC1B,MAAM,CAAC,GAAG,IAAA,cAAO,EAAC,KAAK,CAAC,CAAC;IACzB,MAAM,CAAC,GAAG,IAAA,eAAQ,EAAC,KAAK,CAAC,CAAC;IAE1B,OAAO,IAAA,eAAQ,EACb,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,WAAW,EAC3B,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,WAAW,EAC3B,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,WAAW,EAC3B,CAAC,CACF,CAAA;AACH,CAAC"}

package/build/transformString.d.ts

@@ -1,3 +0,0 @@
-export declare function alpha(color: string, value: number): number;
-export declare function darken(color: string, value: number): number;
-export declare function lighten(color: string, value: number): number;

package/build/transformString.js

@@ -1,35 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.alpha = alpha;
-exports.darken = darken;
-exports.lighten = lighten;
-const core_1 = require("./core");
-const parse_1 = require("./parse");
-const Transform = __importStar(require("./transform"));
-function alpha(color, value) { return (0, core_1.from)(Transform.alpha((0, parse_1.parse)(color), value)); }
-function darken(color, value) { return (0, core_1.from)(Transform.darken((0, parse_1.parse)(color), value)); }
-function lighten(color, value) { return (0, core_1.from)(Transform.lighten((0, parse_1.parse)(color), value)); }
-//# sourceMappingURL=transformString.js.map

package/build/transformString.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"transformString.js","sourceRoot":"","sources":["../src/transformString.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAIA,sBAAyG;AACzG,wBAA2G;AAC3G,0BAA6G;AAN7G,iCAA6B;AAC7B,mCAA+B;AAC/B,uDAAwC;AAExC,SAAgB,KAAK,CAAC,KAAa,EAAE,KAAa,IAAI,OAAO,IAAA,WAAI,EAAC,SAAS,CAAC,KAAK,CAAC,IAAA,aAAK,EAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC,CAAA,CAAC,CAAC;AACzG,SAAgB,MAAM,CAAC,KAAa,EAAE,KAAa,IAAI,OAAO,IAAA,WAAI,EAAC,SAAS,CAAC,MAAM,CAAC,IAAA,aAAK,EAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC,CAAA,CAAC,CAAC;AAC3G,SAAgB,OAAO,CAAC,KAAa,EAAE,KAAa,IAAI,OAAO,IAAA,WAAI,EAAC,SAAS,CAAC,OAAO,CAAC,IAAA,aAAK,EAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC,CAAA,CAAC,CAAC"}