@ankhorage/color-theory 0.0.4 → 0.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/README.md +75 -16
  3. package/package.json +9 -9
package/CHANGELOG.md CHANGED
@@ -1,5 +1,12 @@
1
1
  # @ankhorage/color-theory
2
2
 
3
+ ## 0.0.5
4
+
5
+ ### Patch Changes
6
+
7
+ - bdb341f: Update docs
8
+ - Update Docs
9
+
3
10
  ## 0.0.4
4
11
 
5
12
  ### Patch Changes
package/README.md CHANGED
@@ -1,27 +1,86 @@
1
+ <!-- markdownlint-disable MD013 MD033 -->
2
+ <!-- This file is generated by Paradox. Do not edit manually. -->
3
+
1
4
  # @ankhorage/color-theory
2
5
 
6
+ ![license: MIT](././paradox/badges/license.svg) ![npm: v0.0.4](././paradox/badges/npm.svg) ![runtime: bun](././paradox/badges/runtime.svg) ![typescript: strict](././paradox/badges/typescript.svg) ![eslint: checked](././paradox/badges/eslint.svg) ![prettier: checked](././paradox/badges/prettier.svg) ![build: checked](././paradox/badges/build.svg) ![tests: checked](././paradox/badges/tests.svg) ![docs: paradox](././paradox/badges/docs.svg)
7
+
3
8
  Standalone color theory, harmony, swatch, contrast, and theme color generation utilities.
4
9
 
5
- ## Semantic status colors
10
+ ## Generated documentation
6
11
 
7
- Generate deterministic swatches for semantic status roles like `danger`, `success`, and `warning`.
12
+ - [Interactive documentation app](././paradox/index.html)
13
+ - [Public API reference](././paradox/exports.md)
14
+ - [Component registry](././paradox/components.md)
15
+ - [Architecture overview](././paradox/diagrams/architecture-overview.mmd)
16
+ - [Module relationships](././paradox/diagrams/module-relationships.mmd)
17
+ - [Export graph](././paradox/diagrams/export-graph.mmd)
18
+ - [assertHexColor sequence](././paradox/diagrams/sequences/assert-hex-color.mmd)
19
+ - [getReadableForeground sequence](././paradox/diagrams/sequences/get-readable-foreground.mmd)
20
+ - [getThemeModePrimaryHex sequence](././paradox/diagrams/sequences/get-theme-mode-primary-hex.mmd)
21
+ - [parseHexColorOrThrow sequence](././paradox/diagrams/sequences/parse-hex-color-or-throw.mmd)
8
22
 
9
- ```ts
10
- import { createDefaultSemanticStatusSwatches } from '@ankhorage/color-theory';
23
+ ## Architecture preview
11
24
 
12
- const status = createDefaultSemanticStatusSwatches();
13
- status.seeds.danger; // "#ef4444"
14
- status.swatches.danger[500]; // "#ef4444"
25
+ <details>
26
+ <summary>Architecture overview</summary>
27
+
28
+ ```mermaid
29
+ graph TD
30
+ package__ankhorage_color_theory["@ankhorage/color-theory"]
31
+ entrypoint_src_index_ts["src/index.ts"]
32
+ package__ankhorage_color_theory --> entrypoint_src_index_ts
33
+ module_src_contrast_ts["src/contrast.ts"]
34
+ package__ankhorage_color_theory -.-> module_src_contrast_ts
35
+ module_src_contrast_ts --> module_src_hex_ts
36
+ module_src_contrast_ts --> module_src_internal_culori_ts
37
+ module_src_culori_fn_ts["src/culori-fn.ts"]
38
+ package__ankhorage_color_theory -.-> module_src_culori_fn_ts
39
+ module_src_culori_ts["src/culori.ts"]
40
+ package__ankhorage_color_theory -.-> module_src_culori_ts
41
+ module_src_harmony_ts["src/harmony.ts"]
42
+ package__ankhorage_color_theory -.-> module_src_harmony_ts
43
+ module_src_harmony_ts --> module_src_hex_ts
44
+ module_src_harmony_ts --> module_src_internal_culori_ts
45
+ module_src_hex_ts["src/hex.ts"]
46
+ package__ankhorage_color_theory -.-> module_src_hex_ts
47
+ module_src_index_ts["src/index.ts"]
48
+ module_src_internal_culori_ts["src/internal-culori.ts"]
49
+ package__ankhorage_color_theory -.-> module_src_internal_culori_ts
50
+ module_src_internal_culori_ts --> module_src_hex_ts
51
+ module_src_neutral_ts["src/neutral.ts"]
52
+ package__ankhorage_color_theory -.-> module_src_neutral_ts
53
+ module_src_neutral_ts --> module_src_harmony_ts
54
+ module_src_neutral_ts --> module_src_hex_ts
55
+ module_src_neutral_ts --> module_src_internal_culori_ts
56
+ module_src_neutral_ts --> module_src_swatches_ts
57
+ module_src_semantic_status_ts["src/semantic-status.ts"]
58
+ package__ankhorage_color_theory -.-> module_src_semantic_status_ts
59
+ module_src_semantic_status_ts --> module_src_hex_ts
60
+ module_src_semantic_status_ts --> module_src_swatches_ts
61
+ module_src_semantics_ts["src/semantics.ts"]
62
+ package__ankhorage_color_theory -.-> module_src_semantics_ts
63
+ module_src_semantics_ts --> module_src_harmony_ts
64
+ module_src_semantics_ts --> module_src_swatches_ts
65
+ module_src_swatches_ts["src/swatches.ts"]
66
+ package__ankhorage_color_theory -.-> module_src_swatches_ts
67
+ module_src_swatches_ts --> module_src_hex_ts
68
+ module_src_swatches_ts --> module_src_internal_culori_ts
69
+ module_src_theme_colors_ts["src/theme-colors.ts"]
70
+ package__ankhorage_color_theory -.-> module_src_theme_colors_ts
71
+ module_src_theme_colors_ts --> module_src_harmony_ts
72
+ module_src_theme_colors_ts --> module_src_hex_ts
73
+ module_src_theme_colors_ts --> module_src_neutral_ts
74
+ module_src_theme_colors_ts --> module_src_swatches_ts
15
75
  ```
16
76
 
17
- Override defaults by passing your own seeds (throws on invalid hex input):
77
+ </details>
18
78
 
19
- ```ts
20
- import { createSemanticStatusSwatches } from '@ankhorage/color-theory';
79
+ ## Path resolution
21
80
 
22
- const status = createSemanticStatusSwatches({
23
- danger: '#ef4444',
24
- success: '#22c55e',
25
- warning: '#f59e0b',
26
- });
27
- ```
81
+ - Config discovery: searches upward from `process.cwd()` for `paradox.config.ts/js/mjs/cjs` (required; no fallback).
82
+ - Package root: defaults to the directory containing `paradox.config.*`; `package.root` (when relative) resolves relative to that directory.
83
+ - Output directory: defaults to `paradox/`; `output.dir` (when relative) resolves relative to the resolved package root and must stay inside it.
84
+ - Modes:
85
+ - `safe`: writes generated artifacts only under the output directory
86
+ - `write`: additionally updates `<packageRoot>/README.md`
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@ankhorage/color-theory",
3
3
  "type": "module",
4
- "version": "0.0.4",
4
+ "version": "0.0.5",
5
5
  "description": "Standalone color theory, harmony, swatch, contrast, and theme color generation utilities.",
6
6
  "homepage": "https://github.com/ankhorage/color-theory#readme",
7
7
  "bugs": {
@@ -61,24 +61,24 @@
61
61
  "build": "rm -rf dist tsconfig.tsbuildinfo && bun x tsc -p tsconfig.json",
62
62
  "changeset": "changeset",
63
63
  "changeset:status": "changeset status --since=origin/main",
64
- "knip": "knip",
65
- "lint": "eslint . --max-warnings=0",
66
- "lint:fix": "eslint . --fix --max-warnings=0",
67
- "format": "prettier --write .",
68
- "paradox": "bunx @ankhorage/paradox",
64
+ "knip": "ankhorage-knip",
65
+ "lint": "ankhorage-eslint . --max-warnings=0",
66
+ "lint:fix": "ankhorage-eslint . --fix --max-warnings=0",
67
+ "format": "ankhorage-prettier --write .",
68
+ "format:check": "ankhorage-prettier --check .",
69
+ "docs": "paradox",
69
70
  "prepack": "bun run build",
70
71
  "test": "bun test src",
71
72
  "typecheck": "bun x tsc --noEmit -p tsconfig.json",
72
73
  "version-packages": "changeset version"
73
74
  },
74
75
  "devDependencies": {
75
- "@ankhorage/devtools": "^1.0.1",
76
- "@ankhorage/paradox": "^0.0.3",
76
+ "@ankhorage/devtools": "^1.0.5",
77
+ "@ankhorage/paradox": "^0.1.5",
77
78
  "@changesets/cli": "^2.31.0",
78
79
  "@types/bun": "^1.3.13",
79
80
  "@types/culori": "^4.0.1",
80
81
  "@types/node": "^25.6.0",
81
- "knip": "^5.88.1",
82
82
  "typescript": "^5.9.3"
83
83
  },
84
84
  "packageManager": "bun@1.3.13"