@tokens-studio/tokenscript-schemas 0.1.2 → 0.2.0

package/bundled/functions/tetradic.json

@@ -1,24 +0,0 @@
-{
-  "name": "Tetradic",
-  "type": "function",
-  "description": "Generates tetradic (square) colors - four hues equally spaced 90° apart. Creates rich, complex palettes with two complementary pairs.",
-  "keyword": "tetradic",
-  "input": {
-    "type": "object",
-    "properties": {
-      "color": {
-        "type": "color",
-        "description": "Base color"
-      }
-    }
-  },
-  "script": {
-    "type": "https://schema.tokenscript.dev.gcp.tokens.studio/api/v1/core/tokenscript/0/",
-    "script": "// Generate tetradic (square) colors (90° apart)\n// Returns [base, base+90°, base+180°, base+270°]\n//\n// Use case: Rich, complex palettes\n// Contains two complementary pairs\n\nvariable input: List = {input};\nvariable base: Color.OKLCH = input.get(0).to.oklch();\n\nvariable result: List;\n\n// Base color (0°)\nresult = result, base.to.srgb();\n\n// +90°\nvariable h2: Number = base.h + 90;\nif (h2 >= 360) [ h2 = h2 - 360; ];\nvariable c2: Color.OKLCH;\nc2.l = base.l; c2.c = base.c; c2.h = h2;\nresult = result, c2.to.srgb();\n\n// +180° (complement)\nvariable h3: Number = base.h + 180;\nif (h3 >= 360) [ h3 = h3 - 360; ];\nvariable c3: Color.OKLCH;\nc3.l = base.l; c3.c = base.c; c3.h = h3;\nresult = result, c3.to.srgb();\n\n// +270°\nvariable h4: Number = base.h + 270;\nif (h4 >= 360) [ h4 = h4 - 360; ];\nvariable c4: Color.OKLCH;\nc4.l = base.l; c4.c = base.c; c4.h = h4;\nresult = result, c4.to.srgb();\n\nreturn result;"
-  },
-  "requirements": [
-    "https://schema.tokenscript.dev.gcp.tokens.studio/api/v1/core/oklch-color/0/",
-    "https://schema.tokenscript.dev.gcp.tokens.studio/api/v1/core/srgb-color/0/"
-  ],
-  "slug": "tetradic"
-}

package/bundled/functions/tint_scale.json

@@ -1,36 +0,0 @@
-{
-  "name": "Tint Scale",
-  "type": "function",
-  "description": "Creates a sequential scale of tints from a base color. Varies lightness while preserving hue and adjusting chroma proportionally. Perfect for sequential/quantitative data visualization.",
-  "keyword": "tint_scale",
-  "input": {
-    "type": "object",
-    "properties": {
-      "color": {
-        "type": "color",
-        "description": "Base color for the scale"
-      },
-      "count": {
-        "type": "number",
-        "description": "Number of tints to generate. Default is 9"
-      },
-      "light_start": {
-        "type": "number",
-        "description": "Lightness of lightest tint (0-1). Default is 0.95"
-      },
-      "light_end": {
-        "type": "number",
-        "description": "Lightness of darkest tint (0-1). Default is 0.25"
-      }
-    }
-  },
-  "script": {
-    "type": "https://schema.tokenscript.dev.gcp.tokens.studio/api/v1/core/tokenscript/0/",
-    "script": "// Create a sequential tint scale from a base color\n// Varies lightness while preserving hue and scaling chroma\n//\n// Ideal for: choropleth maps, intensity scales, single-hue heatmaps\n// Chroma is scaled proportionally to maintain color harmony\n\nvariable input: List = {input};\nvariable base: Color.OKLCH = input.get(0).to.oklch();\n\n// Default count is 9\nvariable count: Number = 9;\nif (input.length() > 1) [\n    count = input.get(1);\n];\n\n// Default light_start is 0.95 (nearly white)\nvariable light_start: Number = 0.95;\nif (input.length() > 2) [\n    light_start = input.get(2);\n];\n\n// Default light_end is 0.25 (dark)\nvariable light_end: Number = 0.25;\nif (input.length() > 3) [\n    light_end = input.get(3);\n];\n\n// Base color properties\nvariable base_h: Number = base.h;\nvariable base_c: Number = base.c;\nvariable base_l: Number = base.l;\n\n// Calculate chroma scaling factor (chroma decreases at extreme lightness)\nvariable max_c: Number = base_c * 1.2;\n\nvariable result: List;\nvariable i: Number = 0;\nvariable t: Number = 0;\nvariable step_l: Number = 0;\nvariable l_dist: Number = 0;\nvariable chroma_scale: Number = 0;\nvariable step_c: Number = 0;\nvariable color: Color.OKLCH;\n\nwhile (i < count) [\n    t = i / (count - 1);\n    \n    // Interpolate lightness\n    step_l = light_start + (light_end - light_start) * t;\n    \n    // Scale chroma based on lightness distance from optimal (~0.6)\n    // Chroma is highest in midtones, lower at extremes\n    l_dist = step_l - 0.6;\n    if (l_dist < 0) [ l_dist = 0 - l_dist; ];\n    chroma_scale = 1 - l_dist * 1.5;\n    if (chroma_scale < 0.1) [ chroma_scale = 0.1; ];\n    step_c = max_c * chroma_scale;\n    \n    // Clamp chroma\n    if (step_c > 0.4) [ step_c = 0.4; ];\n    \n    color.l = step_l;\n    color.c = step_c;\n    color.h = base_h;\n    \n    result = result, color.to.srgb();\n    i = i + 1;\n];\n\nreturn result;"
-  },
-  "requirements": [
-    "https://schema.tokenscript.dev.gcp.tokens.studio/api/v1/core/oklch-color/0/",
-    "https://schema.tokenscript.dev.gcp.tokens.studio/api/v1/core/srgb-color/0/"
-  ],
-  "slug": "tint_scale"
-}

package/bundled/functions/to_gamut.json

@@ -1,59 +0,0 @@
-{
-  "name": "to_gamut",
-  "type": "function",
-  "description": "Maps a color into a target gamut using the CSS Color Level 4 gamut mapping algorithm. This preserves the perceptual lightness and hue while reducing chroma until the color fits within the target color space. Uses OKLCH for perceptually uniform mapping and binary search with Delta E OK for convergence. Essential for wide-gamut to sRGB conversion in design systems.",
-  "keyword": "to_gamut",
-  "requirements": [
-    "https://schema.tokenscript.dev.gcp.tokens.studio/api/v1/core/srgb-color/0/",
-    "https://schema.tokenscript.dev.gcp.tokens.studio/api/v1/core/oklch-color/0/"
-  ],
-  "schema": {
-    "type": "object",
-    "properties": {
-      "input": {
-        "type": "array",
-        "items": [
-          {
-            "description": "Color to map into gamut",
-            "type": "color"
-          },
-          {
-            "description": "Target gamut/space (default 'srgb')",
-            "type": "string"
-          }
-        ],
-        "minItems": 1,
-        "maxItems": 2
-      }
-    },
-    "required": [
-      "input"
-    ]
-  },
-  "returns": {
-    "type": "color",
-    "description": "Color mapped into the target gamut"
-  },
-  "script": {
-    "type": "https://schema.tokenscript.dev.gcp.tokens.studio/api/v1/core/tokenscript/0/",
-    "script": "// to_gamut: Perceptual gamut mapping (CSS Color Level 4 algorithm)\n// Reference: CSS Color Level 4, Section 13.2 Gamut Mapping\n// Reference: https://www.w3.org/TR/css-color-4/#gamut-mapping\n//\n// Maps out-of-gamut colors into sRGB while preserving perceptual\n// intent. Uses OKLCH space with binary search on chroma:\n//   - Lightness and hue are preserved\n//   - Chroma is reduced until the color fits in gamut\n//\n// This is the CSS Gamut Mapping Algorithm (GMA) used by browsers.\n\nvariable input: List = {input};\nvariable color: Color.OKLCH = input.get(0).to.oklch();\n\n// Target space (default sRGB) - currently only supports sRGB\nvariable target_space: String = \"srgb\";\nif (input.length() > 1) [\n    target_space = input.get(1);\n];\n\n// Constants\nvariable epsilon: Number = 0.0001;\nvariable neg_epsilon: Number = 0 - epsilon;\nvariable one_plus_eps: Number = 1 + epsilon;\n\n// Check if already in gamut by converting and checking bounds\nvariable test_color: Color.SRGB = color.to.srgb();\nvariable in_gamut: Boolean = true;\n\n// Check if sRGB values are in range [0, 1]\nif (test_color.r < neg_epsilon) [ in_gamut = false; ];\nif (test_color.r > one_plus_eps) [ in_gamut = false; ];\nif (test_color.g < neg_epsilon) [ in_gamut = false; ];\nif (test_color.g > one_plus_eps) [ in_gamut = false; ];\nif (test_color.b < neg_epsilon) [ in_gamut = false; ];\nif (test_color.b > one_plus_eps) [ in_gamut = false; ];\n\n// If already in gamut, return clamped version\nif (in_gamut) [\n    variable clamped: Color.SRGB;\n    clamped.r = min(1, max(0, test_color.r));\n    clamped.g = min(1, max(0, test_color.g));\n    clamped.b = min(1, max(0, test_color.b));\n    return clamped;\n];\n\n// Binary search: reduce chroma until in gamut\nvariable min_c: Number = 0;\nvariable max_c: Number = color.c;\nvariable current: Color.OKLCH;\ncurrent.l = color.l;\ncurrent.h = color.h;\n\nvariable iterations: Number = 0;\nvariable max_iterations: Number = 25;\n\nwhile (max_c - min_c > epsilon) [\n    if (iterations >= max_iterations) [\n        max_c = min_c;  // Force exit\n    ];\n    \n    variable mid_c: Number = (min_c + max_c) / 2;\n    current.c = mid_c;\n    \n    variable test: Color.SRGB = current.to.srgb();\n    variable test_in_gamut: Boolean = true;\n    \n    if (test.r < neg_epsilon) [ test_in_gamut = false; ];\n    if (test.r > one_plus_eps) [ test_in_gamut = false; ];\n    if (test.g < neg_epsilon) [ test_in_gamut = false; ];\n    if (test.g > one_plus_eps) [ test_in_gamut = false; ];\n    if (test.b < neg_epsilon) [ test_in_gamut = false; ];\n    if (test.b > one_plus_eps) [ test_in_gamut = false; ];\n    \n    if (test_in_gamut) [\n        // We can try higher chroma\n        min_c = mid_c;\n    ] else [\n        // Need to reduce chroma\n        max_c = mid_c;\n    ];\n    \n    iterations = iterations + 1;\n];\n\n// Use the last valid chroma\ncurrent.c = min_c;\nvariable result: Color.SRGB = current.to.srgb();\n\n// Final clamp for any floating point errors\nvariable final_result: Color.SRGB;\nfinal_result.r = min(1, max(0, result.r));\nfinal_result.g = min(1, max(0, result.g));\nfinal_result.b = min(1, max(0, result.b));\n\nreturn final_result;"
-  },
-  "examples": [
-    {
-      "description": "Map out-of-gamut P3 color to sRGB",
-      "input": [
-        "oklch(0.8 0.3 150)",
-        "srgb"
-      ],
-      "output": "Color with reduced chroma that fits sRGB"
-    },
-    {
-      "description": "In-gamut color returns unchanged",
-      "input": [
-        "#ff0000"
-      ],
-      "output": "#ff0000"
-    }
-  ],
-  "slug": "to_gamut"
-}

package/bundled/functions/triadic.json

@@ -1,24 +0,0 @@
-{
-  "name": "Triadic",
-  "type": "function",
-  "description": "Generates triadic colors - three hues equally spaced 120° apart on the color wheel. Creates vibrant, balanced palettes with high contrast.",
-  "keyword": "triadic",
-  "input": {
-    "type": "object",
-    "properties": {
-      "color": {
-        "type": "color",
-        "description": "Base color"
-      }
-    }
-  },
-  "script": {
-    "type": "https://schema.tokenscript.dev.gcp.tokens.studio/api/v1/core/tokenscript/0/",
-    "script": "// Generate triadic colors (120° apart)\n// Returns [base, base+120°, base+240°]\n//\n// Use case: Vibrant, balanced palettes\n// Example: Red → Green → Blue\n\nvariable input: List = {input};\nvariable base: Color.OKLCH = input.get(0).to.oklch();\n\nvariable result: List;\n\n// Base color\nresult = result, base.to.srgb();\n\n// +120°\nvariable h2: Number = base.h + 120;\nif (h2 >= 360) [ h2 = h2 - 360; ];\nvariable c2: Color.OKLCH;\nc2.l = base.l; c2.c = base.c; c2.h = h2;\nresult = result, c2.to.srgb();\n\n// +240°\nvariable h3: Number = base.h + 240;\nif (h3 >= 360) [ h3 = h3 - 360; ];\nvariable c3: Color.OKLCH;\nc3.l = base.l; c3.c = base.c; c3.h = h3;\nresult = result, c3.to.srgb();\n\nreturn result;"
-  },
-  "requirements": [
-    "https://schema.tokenscript.dev.gcp.tokens.studio/api/v1/core/oklch-color/0/",
-    "https://schema.tokenscript.dev.gcp.tokens.studio/api/v1/core/srgb-color/0/"
-  ],
-  "slug": "triadic"
-}

package/bundled/functions/vibrant.json

@@ -1,59 +0,0 @@
-{
-  "name": "vibrant",
-  "type": "function",
-  "description": "Increases a color's chroma toward a vibrant level. Preserves lightness and hue while boosting colorfulness. The optional amount parameter controls the intensity (0-1, default 0.5). Uses OKLCH for perceptually uniform chroma adjustment. Useful for creating attention-grabbing accents or active states from muted base colors.",
-  "keyword": "vibrant",
-  "requirements": [
-    "https://schema.tokenscript.dev.gcp.tokens.studio/api/v1/core/srgb-color/0/",
-    "https://schema.tokenscript.dev.gcp.tokens.studio/api/v1/core/oklch-color/0/"
-  ],
-  "schema": {
-    "type": "object",
-    "properties": {
-      "input": {
-        "type": "array",
-        "items": [
-          {
-            "description": "Color to make vibrant",
-            "type": "color"
-          },
-          {
-            "description": "Amount (0-1, default 0.5). Higher = more vibrant.",
-            "type": "number"
-          }
-        ],
-        "minItems": 1,
-        "maxItems": 2
-      }
-    },
-    "required": [
-      "input"
-    ]
-  },
-  "returns": {
-    "type": "color",
-    "description": "More vibrant version of the color"
-  },
-  "script": {
-    "type": "https://schema.tokenscript.dev.gcp.tokens.studio/api/v1/core/tokenscript/0/",
-    "script": "// vibrant: Increase chroma toward maximum colorfulness\n// Preserves lightness and hue\n// Amount controls how much to boost (0-1)\n\nvariable input: List = {input};\nvariable color: Color.OKLCH = input.get(0).to.oklch();\n\n// Default amount\nvariable amount: Number = 0.5;\nif (input.length() > 1) [\n    amount = input.get(1);\n];\n\n// Target maximum chroma for sRGB at this lightness (approximate)\n// Real max varies by hue and lightness, but 0.3 is a reasonable target\nvariable max_chroma: Number = 0.3;\n\n// Increase chroma toward max\nvariable current_c: Number = color.c;\nvariable new_c: Number = current_c + (max_chroma - current_c) * amount;\n\n// Create result\nvariable result: Color.OKLCH;\nresult.l = color.l;\nresult.c = new_c;\nresult.h = color.h;\n\nreturn result;"
-  },
-  "examples": [
-    {
-      "description": "Make muted blue more vibrant",
-      "input": [
-        "#6688aa"
-      ],
-      "output": "More saturated blue"
-    },
-    {
-      "description": "Full vibrancy",
-      "input": [
-        "#808080",
-        1
-      ],
-      "output": "Still gray (no hue to enhance)"
-    }
-  ],
-  "slug": "vibrant"
-}

package/bundled/functions/warmer.json

@@ -1,52 +0,0 @@
-{
-  "name": "warmer",
-  "type": "function",
-  "description": "Shifts a color's hue towards warm colors (orange, ~60° in OKLCH). The amount parameter controls how much to shift, from 0 (no change) to 1 (fully warm). Preserves lightness and chroma.",
-  "keyword": "warmer",
-  "requirements": [
-    "https://schema.tokenscript.dev.gcp.tokens.studio/api/v1/core/srgb-color/0/",
-    "https://schema.tokenscript.dev.gcp.tokens.studio/api/v1/core/oklch-color/0/"
-  ],
-  "schema": {
-    "type": "object",
-    "properties": {
-      "input": {
-        "type": "array",
-        "items": [
-          {
-            "description": "Color to warm",
-            "type": "color"
-          },
-          {
-            "description": "Amount to shift (0-1), default 0.25",
-            "type": "number"
-          }
-        ],
-        "minItems": 1,
-        "maxItems": 2
-      }
-    },
-    "required": [
-      "input"
-    ]
-  },
-  "returns": {
-    "type": "color",
-    "description": "Color shifted towards warm hues"
-  },
-  "script": {
-    "type": "https://schema.tokenscript.dev.gcp.tokens.studio/api/v1/core/tokenscript/0/",
-    "script": "// warmer: Shift hue towards warm colors\n//\n// Warm colors are centered around orange (~60° in OKLCH).\n// The function interpolates the hue towards this target via\n// the shortest angular path on the hue wheel.\n//\n// Parameters:\n//   color  - Input color\n//   amount - Shift amount (0 = no change, 1 = fully warm), default 0.25\n//\n// Preserves lightness and chroma.\n\nvariable input: List = {input};\nvariable color: Color.OKLCH = input.get(0).to.oklch();\nvariable amount: Number = 0.25;\n\nif (input.length() > 1) [\n    amount = input.get(1);\n];\n\n// Warm hue target (orange in OKLCH is around 60°)\nvariable warm_hue: Number = 60;\n\n// Calculate shortest path hue difference\nvariable hue_diff: Number = warm_hue - color.h;\n\n// Wrap to shortest path\nif (hue_diff > 180) [ hue_diff = hue_diff - 360; ];\nif (hue_diff < -180) [ hue_diff = hue_diff + 360; ];\n\n// Apply interpolation\nvariable new_hue: Number = color.h + (hue_diff * amount);\n\n// Normalize to 0-360\nif (new_hue < 0) [ new_hue = new_hue + 360; ];\nif (new_hue >= 360) [ new_hue = new_hue - 360; ];\n\n// Create result\nvariable result: Color.OKLCH;\nresult.l = color.l;\nresult.c = color.c;\nresult.h = new_hue;\n\nreturn result;"
-  },
-  "examples": [
-    {
-      "description": "Make blue warmer",
-      "input": [
-        "#0000ff",
-        0.5
-      ],
-      "output": "Blue shifted towards purple/magenta"
-    }
-  ],
-  "slug": "warmer"
-}

package/bundled/functions/wcag_level.json

@@ -1,60 +0,0 @@
-{
-  "name": "wcag_level",
-  "type": "function",
-  "description": "Returns the WCAG 2.1 compliance level for a foreground/background color pair. Returns 'AAA' (ratio >= 7:1), 'AA' (ratio >= 4.5:1), 'AA-large' (ratio >= 3:1), or 'fail' (ratio < 3:1). Based on W3C WCAG 2.1 Success Criteria 1.4.3 and 1.4.6.",
-  "keyword": "wcag_level",
-  "requirements": [
-    "https://schema.tokenscript.dev.gcp.tokens.studio/api/v1/core/srgb-color/0/",
-    "https://schema.tokenscript.dev.gcp.tokens.studio/api/v1/core/xyz-d65-color/0/"
-  ],
-  "schema": {
-    "type": "object",
-    "properties": {
-      "input": {
-        "type": "array",
-        "items": [
-          {
-            "description": "Foreground color (text)",
-            "type": "color"
-          },
-          {
-            "description": "Background color",
-            "type": "color"
-          }
-        ],
-        "minItems": 2,
-        "maxItems": 2
-      }
-    },
-    "required": [
-      "input"
-    ]
-  },
-  "returns": {
-    "type": "string",
-    "description": "WCAG level: 'AAA', 'AA', 'AA-large', or 'fail'"
-  },
-  "script": {
-    "type": "https://schema.tokenscript.dev.gcp.tokens.studio/api/v1/core/tokenscript/0/",
-    "script": "// wcag_level: Determine WCAG 2.1 compliance level for a color pair\n// Reference: WCAG 2.1 Success Criterion 1.4.3 (Contrast Minimum)\n// Reference: WCAG 2.1 Success Criterion 1.4.6 (Contrast Enhanced)\n// Reference: https://www.w3.org/TR/WCAG21/#contrast-minimum\n//\n// Returns one of:\n//   \"AAA\"      - Ratio >= 7:1 (enhanced contrast for normal text)\n//   \"AA\"       - Ratio >= 4.5:1 (minimum for normal text)\n//   \"AA-large\" - Ratio >= 3:1 (minimum for large text: 18pt or 14pt bold)\n//   \"fail\"     - Ratio < 3:1 (does not meet any criterion)\n\nvariable input: List = {input};\nvariable fg_xyz: Color.XYZD65 = input.get(0).to.xyzd65();\nvariable bg_xyz: Color.XYZD65 = input.get(1).to.xyzd65();\n\nvariable l1: Number = fg_xyz.y;\nvariable l2: Number = bg_xyz.y;\n\n// Ensure l1 is the lighter of the two\nif (l2 > l1) [\n    variable temp: Number = l1;\n    l1 = l2;\n    l2 = temp;\n];\n\n// Calculate contrast ratio per WCAG formula\n// Ratio = (L1 + 0.05) / (L2 + 0.05)\nvariable ratio: Number = (l1 + 0.05) / (l2 + 0.05);\n\n// Determine WCAG level\n// AAA: ratio >= 7:1 (enhanced contrast)\n// AA: ratio >= 4.5:1 (minimum for normal text)\n// AA-large: ratio >= 3:1 (minimum for large text, 18pt+ or 14pt+ bold)\n// fail: ratio < 3:1\n\nvariable result: String = \"fail\";\n\nif (ratio >= 7) [\n    result = \"AAA\";\n] else [\n    if (ratio >= 4.5) [\n        result = \"AA\";\n    ] else [\n        if (ratio >= 3) [\n            result = \"AA-large\";\n        ];\n    ];\n];\n\nreturn result;"
-  },
-  "examples": [
-    {
-      "description": "Black on white passes AAA",
-      "input": [
-        "#000000",
-        "#ffffff"
-      ],
-      "output": "AAA"
-    },
-    {
-      "description": "Gray on white may only pass AA-large",
-      "input": [
-        "#767676",
-        "#ffffff"
-      ],
-      "output": "AA"
-    }
-  ],
-  "slug": "wcag_level"
-}