@primitiv-ui/tokens 0.1.0 → 0.1.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Simon Revill
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -3,8 +3,8 @@
 The DTCG-conformant token layer that sits between the Figma source of
 truth and any downstream consumer.
 
-Internal-only — this package is not published. It is the destination
-the `primitiv-sync-figma-plugin` writes to, and the source any future
+Published to npm and JSR as `@primitiv-ui/tokens`. It is the destination
+the `primitiv-sync-figma-plugin` writes to, and the source any downstream
 token transformer (e.g. CSS variables, Tailwind config) reads from.
 
 ## Layout

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@primitiv-ui/tokens",
-  "version": "0.1.0",
+  "version": "0.1.2",
+  "description": "The DTCG-conformant design-token layer for the Primitiv ecosystem, plus helpers that transform Figma variable exports into DTCG JSON.",
   "type": "module",
   "main": "src/index.ts",
   "types": "src/index.ts",

package/src/dtcg.ts

@@ -8,6 +8,7 @@
  * it but is a separate module.
  */
 
+/** A Figma variable collection as surfaced by the Plugin Variables API — its modes and default mode. */
 export type FigmaCollection = {
   id: string
   name: string
@@ -15,12 +16,16 @@ export type FigmaCollection = {
   defaultModeId: string
 }
 
+/** The resolved primitive type of a Figma variable. */
 export type FigmaResolvedType = 'BOOLEAN' | 'COLOR' | 'FLOAT' | 'STRING'
 
+/** An RGBA colour as Figma reports it — each channel in the 0–1 range. */
 export type FigmaRgba = { r: number; g: number; b: number; a: number }
 
+/** A Figma variable alias — a reference to another variable by id. */
 export type FigmaAlias = { type: 'VARIABLE_ALIAS'; id: string }
 
+/** A single Figma variable with its per-mode values. */
 export type FigmaVariable = {
   id: string
   name: string
@@ -29,15 +34,19 @@ export type FigmaVariable = {
   valuesByMode: Record<string, unknown>
 }
 
+/** A DTCG token `$type`. */
 export type DtcgType = 'string' | 'number' | 'color' | 'boolean'
 
+/** A resolved DTCG token `$value`. */
 export type DtcgValue = string | number | boolean
 
+/** A DTCG token — a `$type` / `$value` pair. */
 export type DtcgToken = {
   $type: DtcgType
   $value: DtcgValue
 }
 
+/** A DTCG group — a tree of nested groups and tokens. */
 export type DtcgGroup = { [key: string]: DtcgGroup | DtcgToken }
 
 /** One DTCG file per Figma collection. */