@kidthales/tol-palettes 0.0.0-stage → 0.2.0

package/package.json

@@ -1,6 +1,84 @@
 {
   "name": "@kidthales/tol-palettes",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.2.0",
+  "description": "Paul Tol colour scheme data (values only, with attribution) and generators for CSS, JS/TS, Python, Godot, and GPL/Aseprite.",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "license": "BSD-3-Clause",
+  "author": "kidthales",
+  "type": "module",
+  "main": "./dist/js/index.js",
+  "types": "./dist/js/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kidthales/tol-palettes.git"
+  },
+  "homepage": "https://github.com/kidthales/tol-palettes#readme",
+  "bugs": {
+    "url": "https://github.com/kidthales/tol-palettes/issues"
+  },
+  "keywords": [
+    "paul-tol",
+    "color-schemes",
+    "colorblind-safe",
+    "palettes",
+    "dataviz",
+    "accessible",
+    "wcag",
+    "css",
+    "aseprite",
+    "godot",
+    "python"
+  ],
+  "files": [
+    "dist/css/",
+    "dist/js/",
+    "dist/json/",
+    "dist/py/tol_palettes.py",
+    "dist/godot/",
+    "dist/gpl/",
+    "dist/aseprite/",
+    "data/",
+    "schema/",
+    "NOTICE",
+    "LICENSE",
+    "README.md"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/js/index.d.ts",
+      "default": "./dist/js/index.js"
+    },
+    "./schemes.json": "./dist/json/schemes.json",
+    "./css/*": "./dist/css/*",
+    "./js/*": "./dist/js/*",
+    "./py/*": "./dist/py/*",
+    "./godot/*": "./dist/godot/*",
+    "./gpl/*": "./dist/gpl/*",
+    "./aseprite/*": "./dist/aseprite/*",
+    "./package.json": "./package.json"
+  },
+  "sideEffects": false,
+  "engines": {
+    "node": ">=22"
+  },
+  "scripts": {
+    "lint": "node tools/lint.mjs",
+    "test": "npm run lint && node --test",
+    "validate": "node tools/validate.mjs",
+    "extract": "node tools/extract.mjs",
+    "generate:css": "node tools/generate-css.mjs",
+    "generate:js": "node tools/generate-js.mjs",
+    "generate:py": "node tools/generate-py.mjs",
+    "generate:game": "node tools/generate-game.mjs",
+    "package:assets": "node tools/package-assets.mjs",
+    "generate:gallery": "node tools/generate-gallery.mjs",
+    "generate": "npm run generate:css && npm run generate:js && npm run generate:py && npm run generate:game && npm run package:assets && npm run generate:gallery",
+    "ci:local": "pwsh -NoProfile -ExecutionPolicy Bypass ./scripts/ci-local.ps1"
+  },
+  "devDependencies": {
+    "ajv": "^8.17.1"
+  }
+}

package/schema/scheme.schema.json

@@ -0,0 +1,90 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/kidthales/tol-palettes/schema/scheme.schema.json",
+  "title": "tol-palettes scheme",
+  "description": "One colour scheme. Colour values only; a colour 'name' is present only when the official source (tol_colors.py) provides one.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["id", "kind", "colors", "interpolation", "source"],
+  "properties": {
+    "id": { "type": "string", "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$" },
+    "kind": { "enum": ["qualitative", "diverging", "sequential", "special"] },
+    "colors": {
+      "description": "Colours in the source's default order.",
+      "type": "array",
+      "minItems": 1,
+      "items": { "$ref": "#/$defs/color" }
+    },
+    "extras": {
+      "description": "Additional colours that exist only in tol_colors.py (for example black), kept apart from the notes page's list.",
+      "type": "array",
+      "minItems": 1,
+      "items": { "$ref": "#/$defs/color" }
+    },
+    "bad": { "$ref": "#/$defs/hex", "description": "Colour intended for missing/bad data, as given by the source." },
+    "interpolation": {
+      "description": "How the source says the colours may be used: none (discrete only), linear (intended to be interpolated) or either.",
+      "enum": ["none", "linear", "either"]
+    },
+    "discreteIndexes": {
+      "description": "Indexes into colors that form the discrete variant when it differs from using every colour.",
+      "type": "array",
+      "minItems": 1,
+      "items": { "type": "integer", "minimum": 0 }
+    },
+    "lut": {
+      "description": "Discrete rainbow only: lut[n-1] lists the indexes into colors used when n colours are requested.",
+      "type": "array",
+      "minItems": 1,
+      "items": { "type": "array", "minItems": 1, "items": { "type": "integer", "minimum": 0 } }
+    },
+    "lutBad": {
+      "description": "Discrete rainbow only: bad-data colour overrides keyed by requested length.",
+      "type": "object",
+      "additionalProperties": { "$ref": "#/$defs/hex" }
+    },
+    "subranges": {
+      "description": "Named sub-ranges of colors (inclusive indexes), with the bad-data colour that goes with each.",
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["id", "from", "to"],
+        "properties": {
+          "id": { "type": "string", "minLength": 1 },
+          "from": { "type": "integer", "minimum": 0 },
+          "to": { "type": "integer", "minimum": 0 },
+          "bad": { "$ref": "#/$defs/hex" }
+        }
+      }
+    },
+    "source": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["retrieved"],
+      "anyOf": [{ "required": ["siteFigure"] }, { "required": ["module"] }],
+      "properties": {
+        "siteFigure": { "type": "string", "pattern": "^fig:" },
+        "siteUrl": { "type": "string", "format": "uri" },
+        "module": { "type": "string", "minLength": 1 },
+        "moduleName": { "type": "string", "minLength": 1 },
+        "moduleVersion": { "type": "string", "minLength": 1 },
+        "retrieved": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" },
+        "notes": { "type": "array", "items": { "type": "string", "minLength": 1 } }
+      }
+    }
+  },
+  "$defs": {
+    "hex": { "type": "string", "pattern": "^#[0-9A-F]{6}$" },
+    "color": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["hex"],
+      "properties": {
+        "hex": { "$ref": "#/$defs/hex" },
+        "name": { "type": "string", "minLength": 1 }
+      }
+    }
+  }
+}