Docs, export utils from ESM package

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+	"typescript.tsdk": "node_modules\\typescript\\lib"
+}

README.md

@@ -64,6 +64,8 @@ hsv(244, 100%, 100%, 0.6)
 
 [typedocs](https://kurkle.github.io/color/)
 
+**note** The docs are for the ESM module. UMD module only exports the [default export](https://kurkle.github.io/color/globals.html#_default)
+
 ## Benchmarks
 
 [benchmarks](https://kurkle.github.io/color/dev/bench/)

color.d.ts

@@ -36,7 +36,7 @@ export function hexParse(str: string): {
  */
 export function hexString(v: RGBA): string | RGBA;
 /**
- * Rounds to decimal to nearest integer
+ * Rounds decimal to nearest integer
  * @param {number} v - the number to round
  */
 export function round(v: number): number;
@@ -137,9 +137,15 @@ export class Color {
      * @param {Color|RGBA|string|number[]} input
      */
     constructor(input: string | number[] | Color | RGBA);
-    /** @type {RGBA} */
+    /**
+     * @type {RGBA}
+     * @hidden
+     **/
     _rgb: RGBA;
-    /** @type {boolean} */
+    /**
+     * @type {boolean}
+     * @hidden
+     **/
     _valid: boolean;
     /**
      * `true` if this is a valid color

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kurkle/color",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "description": "css color parsing, manupulation and conversion",
   "main": "dist/color.js",
   "module": "dist/color.esm.js",

packed.js

@@ -45,6 +45,7 @@ function unpack(obj) {
 	return unpacked;
 }
 
+/** @hidden */
 export const names = unpack({
   OiceXe: 'f0f8ff',
   antiquewEte: 'faebd7',

rollup.config.js

@@ -6,6 +6,7 @@ import visualizer from 'rollup-plugin-visualizer';
 import {version, homepage} from './package.json';
 
 const input = 'src/index.js';
+const inputESM = 'src/index.esm.js';
 const banner = `/*!
  * @kurkle/color v${version}
  * ${homepage}
@@ -53,7 +54,7 @@ export default [
 		}
 	},
 	{
-		input: input,
+		input: inputESM,
 		plugins: [
 			cleanup({
 				sourcemap: true
@@ -68,7 +69,7 @@ export default [
 		}
 	},
 	{
-		input: input,
+		input: inputESM,
 		plugins: [
 			terser({
 				output: {

src/byte.js

@@ -1,10 +1,10 @@
 /**
  * @packageDocumentation
- * @module helpers
+ * @module utils
  */
 
 /**
- * Rounds to decimal to nearest integer
+ * Rounds decimal to nearest integer
  * @param {number} v - the number to round
  */
 export function round(v) {

src/hex.js

@@ -1,6 +1,6 @@
 /**
  * @packageDocumentation
- * @module helpers
+ * @module utils
  */
 
 /**

src/hue.js

@@ -1,6 +1,6 @@
 /**
  * @packageDocumentation
- * @module helpers
+ * @module utils
  */
 
 import {b2n, n2p, n2b, p2b} from './byte';

src/index.esm.js

@@ -0,0 +1,31 @@
+/**
+ * @packageDocumentation
+ * @module index
+ */
+
+import Color from './color';
+
+export {Color};
+export * from './byte';
+export * from './hex';
+export * from './hue';
+export * from './names';
+export * from './rgb';
+
+/**
+ * @typedef {Object} RGBA
+ * @property {number} r - red [0..255]
+ * @property {number} g - green [0..255]
+ * @property {number} b - blue [0..255]
+ * @property {number} a - alpha [0..1]
+ * @internal
+ */
+
+/**
+ * Construct new Color instance
+ * @param {Color|RGBA|string|number[]} input
+ * @internal
+ */
+export default function(input) {
+	return new Color(input);
+}

src/index.js

@@ -1,4 +1,3 @@
-
 /**
  * @packageDocumentation
  * @module index
@@ -12,11 +11,13 @@ import Color from './color';
  * @property {number} g - green [0..255]
  * @property {number} b - blue [0..255]
  * @property {number} a - alpha [0..1]
+ * @internal
  */
 
 /**
  * Construct new Color instance
  * @param {Color|RGBA|string|number[]} input
+ * @internal
  */
 export default function(input) {
 	return new Color(input);

src/names.js

@@ -1,6 +1,6 @@
 /**
  * @packageDocumentation
- * @module helpers
+ * @module utils
  */
 
 import {names} from '../packed';

src/rgb.js

@@ -1,6 +1,6 @@
 /**
  * @packageDocumentation
- * @module helpers
+ * @module utils
  */
 
 import {p2b, b2n} from './byte';

tsconfig.json

@@ -1,7 +1,7 @@
 {
 	"compilerOptions": {
-		"target": "es6",
-		"module": "es6",
+		"target": "ES6",
+		"module": "ES6",
 		"moduleResolution": "Node",
 		"allowJs": true,
 		"checkJs": true,
@@ -11,21 +11,17 @@
 		"esModuleInterop": true,
 		"noImplicitThis": true
 	},
-	"include": [
-		"./src/index.js"
+	"files": [
+		"./color.d.ts"
 	],
 	"typedocOptions": {
 		"name": "@kurkle/color",
-		"mode": "modules",
-		"excludeExternals": true,
+		"mode": "file",
+
+		"includeDeclarations": true,
+		"exclude": ["./node_modules/**/*"],
+
 		"target": "ES6",
-		"template": "minimal",
-		"includes": [
-			"./src"
-		],
-		"plugins": [
-			"typedoc-plugin-external-module-name",
-		],
-		"out": "./docs"
+		"out": "./docs",
 	},
 }

util/pack.js

@@ -153,5 +153,5 @@ function unpack(obj) {
 }
 
 `;
-	fs.writeFileSync('./packed.js', unpack + 'export const names = unpack(' + util.inspect(packed) + ');\n', 'utf-8');
+	fs.writeFileSync('./packed.js', unpack + '/** @hidden */\nexport const names = unpack(' + util.inspect(packed) + ');\n', 'utf-8');
 };