@canonical/token-types 0.1.0

package/dist/esm/artifact/types.js

@@ -0,0 +1,9 @@
+/**
+ * Canonical artifact types — the JSON contract between the Terrazzo CSS plugin
+ * (producer) and the LSP (consumer).
+ *
+ * This is the single source of truth. Both `@canonical/terrazzo-plugin-css` and
+ * `@canonical/terrazzo-lsp` import from this package.
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/dist/esm/artifact/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/artifact/types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG"}

package/dist/esm/index.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":""}

package/dist/types/artifact/types.d.ts

@@ -0,0 +1,88 @@
+/**
+ * Canonical artifact types — the JSON contract between the Terrazzo CSS plugin
+ * (producer) and the LSP (consumer).
+ *
+ * This is the single source of truth. Both `@canonical/terrazzo-plugin-css` and
+ * `@canonical/terrazzo-lsp` import from this package.
+ */
+/** Tier classification for a token. */
+export type TokenTier = "primitive" | "semantic" | "derived";
+/** Derivation formula kind for derived-tier tokens. */
+export type DerivationKind = "hover" | "active" | "disabled" | "delta" | "channel-modifier" | "channel-surface";
+/** An at-rule context surrounding a declaration (e.g. `@layer ds.modifiers`). */
+export interface ArtifactAtRule {
+    /** At-rule name (e.g. "layer", "media"). */
+    name: string;
+    /** At-rule prelude (e.g. "ds.modifiers", "(prefers-color-scheme: dark)"). */
+    prelude: string;
+}
+/** A declaration site for an artifact token. */
+export interface ArtifactDeclaration {
+    /** CSS selector (e.g. ":root", ".warning", "*"). */
+    selector: string;
+    /** CSS output file (e.g. "modifiers.theme.css"). */
+    file: string;
+    /** 0-indexed line number in the CSS output file. */
+    line: number;
+    /** Enclosing at-rules, innermost-first (e.g. `@layer`, `@media`). */
+    atRules?: ArtifactAtRule[];
+}
+/** A single token entry in the artifact JSON. */
+export interface ArtifactToken {
+    /** CSS custom property name as emitted. */
+    cssVar: string;
+    /** DTCG token ID from source, or `null` for derived tokens. */
+    id: string | null;
+    /** DTCG $type. */
+    type: string;
+    /** Token tier classification. */
+    tier: TokenTier;
+    /** DTCG $description. */
+    description?: string;
+    /** Full alias resolution chain (token IDs). */
+    aliasChain?: string[];
+    /** Resolved CSS value (mode-invariant tokens). */
+    value?: string;
+    /** Light-mode resolved CSS value. */
+    valueLight?: string;
+    /** Dark-mode resolved CSS value. */
+    valueDark?: string;
+    /** `true` when valueLight !== valueDark. */
+    isPaired: boolean;
+    /** DTCG source file path (relative). */
+    sourceFile?: string;
+    /** Line number in the DTCG source file. */
+    sourceLine?: number;
+    /** CSS output file containing this token's declaration. */
+    cssOutputFile: string;
+    /** 0-indexed line number in the CSS output file (legacy, prefer `declarations`). */
+    cssOutputLine?: number;
+    /** Declaration sites: where this token is provided in the CSS output. */
+    declarations?: ArtifactDeclaration[];
+    /** CSS var name of the source token (derived tier). */
+    derivedFrom?: string;
+    /** Formula kind (derived tier). */
+    derivation?: DerivationKind;
+    /** `true` when the token has a CSS `@property` registration. */
+    registered?: boolean;
+    /** `@property` syntax (e.g. `"<color>"`). */
+    syntax?: string | null;
+    /** `@property` inherits flag. */
+    inherits?: boolean | null;
+    /** `@property` initial-value. */
+    initialValue?: string | null;
+    /** DTCG $extensions passthrough. */
+    extensions?: Record<string, unknown>;
+}
+/** The complete artifact: CSS variable name → token metadata. */
+export type Artifact = Record<string, ArtifactToken>;
+/**
+ * Wrapped artifact format (supports legacy/spec envelope).
+ * The plugin may emit either flat or wrapped.
+ */
+export type ArtifactEnvelope = Artifact | {
+    version: string;
+    generator: string;
+    tokens: Artifact;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types/artifact/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/artifact/types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAMH,uCAAuC;AACvC,MAAM,MAAM,SAAS,GAAG,WAAW,GAAG,UAAU,GAAG,SAAS,CAAC;AAE7D,uDAAuD;AACvD,MAAM,MAAM,cAAc,GACtB,OAAO,GACP,QAAQ,GACR,UAAU,GACV,OAAO,GACP,kBAAkB,GAClB,iBAAiB,CAAC;AAMtB,iFAAiF;AACjF,MAAM,WAAW,cAAc;IAC7B,4CAA4C;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb,6EAA6E;IAC7E,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,gDAAgD;AAChD,MAAM,WAAW,mBAAmB;IAClC,oDAAoD;IACpD,QAAQ,EAAE,MAAM,CAAC;IACjB,oDAAoD;IACpD,IAAI,EAAE,MAAM,CAAC;IACb,oDAAoD;IACpD,IAAI,EAAE,MAAM,CAAC;IACb,qEAAqE;IACrE,OAAO,CAAC,EAAE,cAAc,EAAE,CAAC;CAC5B;AAMD,iDAAiD;AACjD,MAAM,WAAW,aAAa;IAC5B,2CAA2C;IAC3C,MAAM,EAAE,MAAM,CAAC;IAEf,+DAA+D;IAC/D,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAElB,kBAAkB;IAClB,IAAI,EAAE,MAAM,CAAC;IAEb,iCAAiC;IACjC,IAAI,EAAE,SAAS,CAAC;IAEhB,yBAAyB;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,+CAA+C;IAC/C,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IAEtB,kDAAkD;IAClD,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,qCAAqC;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,oCAAoC;IACpC,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,4CAA4C;IAC5C,QAAQ,EAAE,OAAO,CAAC;IAElB,wCAAwC;IACxC,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,2CAA2C;IAC3C,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,2DAA2D;IAC3D,aAAa,EAAE,MAAM,CAAC;IAEtB,oFAAoF;IACpF,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,yEAAyE;IACzE,YAAY,CAAC,EAAE,mBAAmB,EAAE,CAAC;IAIrC,uDAAuD;IACvD,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,mCAAmC;IACnC,UAAU,CAAC,EAAE,cAAc,CAAC;IAI5B,gEAAgE;IAChE,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB,6CAA6C;IAC7C,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,iCAAiC;IACjC,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE1B,iCAAiC;IACjC,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,oCAAoC;IACpC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACtC;AAMD,iEAAiE;AACjE,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;AAErD;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GACxB,QAAQ,GACR;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,QAAQ,CAAA;CAAE,CAAC"}

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export type { Artifact, ArtifactAtRule, ArtifactDeclaration, ArtifactEnvelope, ArtifactToken, DerivationKind, TokenTier, } from "./artifact/types.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,QAAQ,EACR,cAAc,EACd,mBAAmB,EACnB,gBAAgB,EAChB,aAAa,EACb,cAAc,EACd,SAAS,GACV,MAAM,qBAAqB,CAAC"}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@canonical/token-types",
+  "version": "0.1.0",
+  "description": "Shared types for Canonical design token tooling.",
+  "type": "module",
+  "license": "LGPL-3.0",
+  "author": {
+    "email": "webteam@canonical.com",
+    "name": "Canonical Webteam"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/canonical/design-tokens"
+  },
+  "bugs": {
+    "url": "https://github.com/canonical/design-tokens/issues"
+  },
+  "homepage": "https://github.com/canonical/design-tokens#readme",
+  "engines": {
+    "bun": ">=1.3",
+    "node": ">=22"
+  },
+  "keywords": [
+    "design-tokens",
+    "typescript",
+    "canonical",
+    "dtcg"
+  ],
+  "main": "dist/esm/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/types/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "check": "bun run check:ts",
+    "check:ts": "tsc --noEmit"
+  },
+  "devDependencies": {
+    "@canonical/typescript-config-base": "^0.10.0-experimental.4",
+    "typescript": "^5.9.3"
+  }
+}