@canonical/token-types 0.1.0 → 0.3.0

package/dist/esm/artifact/types.js

@@ -5,5 +5,30 @@
  * This is the single source of truth. Both `@canonical/terrazzo-plugin-css` and
  * `@canonical/terrazzo-lsp` import from this package.
  */
-export {};
+/** Shared list of known DTCG token type literals recognised by Canonical tooling. */
+export const KNOWN_DTCG_TOKEN_TYPES = [
+    "color",
+    "dimension",
+    "number",
+    "typography",
+    "fontFamily",
+    "fontWeight",
+    "fontStyle",
+    "figureStyle",
+    "textDecoration",
+    "letterCase",
+    "fontPosition",
+    "duration",
+    "cubicBezier",
+    "gradient",
+    "border",
+    "shadow",
+    "transition",
+    "strokeStyle",
+];
+/** Runtime guard for narrowing unknown strings to the shared known DTCG set. */
+export function isKnownDtcgTokenType(value) {
+    return (typeof value === "string" &&
+        KNOWN_DTCG_TOKEN_TYPES.includes(value));
+}
 //# sourceMappingURL=types.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/artifact/types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/artifact/types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAuBH,qFAAqF;AACrF,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACpC,OAAO;IACP,WAAW;IACX,QAAQ;IACR,YAAY;IACZ,YAAY;IACZ,YAAY;IACZ,WAAW;IACX,aAAa;IACb,gBAAgB;IAChB,YAAY;IACZ,cAAc;IACd,UAAU;IACV,aAAa;IACb,UAAU;IACV,QAAQ;IACR,QAAQ;IACR,YAAY;IACZ,aAAa;CACL,CAAC;AAiBX,gFAAgF;AAChF,MAAM,UAAU,oBAAoB,CAClC,KAAgC;IAEhC,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;QACxB,sBAA4C,CAAC,QAAQ,CAAC,KAAK,CAAC,CAC9D,CAAC;AACJ,CAAC"}

package/dist/esm/artifact/types.test-d.js

@@ -0,0 +1,119 @@
+/**
+ * Type-level tests for @canonical/token-types (Q34).
+ *
+ * Uses vitest `expectTypeOf` to verify the type contracts at compile time.
+ * No runtime assertions — these tests validate the type system only.
+ */
+import { describe, expectTypeOf, it } from "vitest";
+describe("DtcgTokenType", () => {
+    it("exposes the shared known DTCG literals as a narrower contract", () => {
+        expectTypeOf().toMatchTypeOf();
+        expectTypeOf().toMatchTypeOf();
+        expectTypeOf().toMatchTypeOf();
+    });
+    it("accepts known DTCG type literals", () => {
+        expectTypeOf().toMatchTypeOf();
+        expectTypeOf().toMatchTypeOf();
+        expectTypeOf().toMatchTypeOf();
+        expectTypeOf().toMatchTypeOf();
+        expectTypeOf().toMatchTypeOf();
+        expectTypeOf().toMatchTypeOf();
+        expectTypeOf().toMatchTypeOf();
+    });
+    it("accepts arbitrary strings (backward compat)", () => {
+        expectTypeOf().toMatchTypeOf();
+        expectTypeOf().toMatchTypeOf();
+    });
+    it("is assignable to ArtifactToken.type", () => {
+        expectTypeOf().toEqualTypeOf();
+    });
+});
+describe("TokenTier", () => {
+    it("is a union of three known literals", () => {
+        expectTypeOf().toMatchTypeOf();
+        expectTypeOf().toMatchTypeOf();
+        expectTypeOf().toMatchTypeOf();
+    });
+    it("rejects unknown tiers", () => {
+        expectTypeOf().not.toMatchTypeOf();
+    });
+    it("exposes an open artifact tier contract for consumers", () => {
+        expectTypeOf().toMatchTypeOf();
+        expectTypeOf().toMatchTypeOf();
+    });
+});
+describe("DerivationKind", () => {
+    it("includes hover, active, disabled, delta, channel-modifier, channel-surface", () => {
+        expectTypeOf().toMatchTypeOf();
+        expectTypeOf().toMatchTypeOf();
+        expectTypeOf().toMatchTypeOf();
+        expectTypeOf().toMatchTypeOf();
+        expectTypeOf().toMatchTypeOf();
+        expectTypeOf().toMatchTypeOf();
+    });
+    it("exposes an open artifact derivation contract for consumers", () => {
+        expectTypeOf().toMatchTypeOf();
+        expectTypeOf().toMatchTypeOf();
+    });
+});
+describe("ArtifactToken", () => {
+    it("has required fields", () => {
+        expectTypeOf().toHaveProperty("cssVar");
+        expectTypeOf().toHaveProperty("id");
+        expectTypeOf().toHaveProperty("type");
+        expectTypeOf().toHaveProperty("tier");
+        expectTypeOf().toHaveProperty("isPaired");
+        expectTypeOf().toHaveProperty("cssOutputFile");
+    });
+    it("has optional derived-tier fields", () => {
+        expectTypeOf().toEqualTypeOf();
+        expectTypeOf().toEqualTypeOf();
+    });
+    it("id is string | null (derived tokens have null id)", () => {
+        expectTypeOf().toEqualTypeOf();
+    });
+    it("uses the open artifact tier contract", () => {
+        expectTypeOf().toEqualTypeOf();
+    });
+});
+describe("artifact token init contracts", () => {
+    it("uses the shared DTCG vocabulary for DTCG-sourced token builders", () => {
+        expectTypeOf().toEqualTypeOf();
+    });
+    it("uses the shared derivation contract for derived token builders", () => {
+        expectTypeOf().toEqualTypeOf();
+    });
+});
+describe("shared artifact field groups", () => {
+    it("keep shared metadata and runtime fields aligned", () => {
+        expectTypeOf().toEqualTypeOf();
+        expectTypeOf().toEqualTypeOf();
+        expectTypeOf().toEqualTypeOf();
+        expectTypeOf().toEqualTypeOf();
+        expectTypeOf().toEqualTypeOf();
+    });
+});
+describe("ArtifactDeclaration", () => {
+    it("has selector, file, and line", () => {
+        expectTypeOf().toHaveProperty("selector");
+        expectTypeOf().toHaveProperty("file");
+        expectTypeOf().toHaveProperty("line");
+    });
+    it("has optional atRules array", () => {
+        expectTypeOf().toEqualTypeOf();
+    });
+});
+describe("Artifact", () => {
+    it("is Record<string, ArtifactToken>", () => {
+        expectTypeOf().toEqualTypeOf();
+    });
+});
+describe("ArtifactEnvelope", () => {
+    it("accepts flat artifact", () => {
+        expectTypeOf().toMatchTypeOf();
+    });
+    it("accepts wrapped artifact", () => {
+        expectTypeOf().toMatchTypeOf();
+    });
+});
+//# sourceMappingURL=types.test-d.js.map

package/dist/esm/artifact/types.test-d.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.test-d.js","sourceRoot":"","sources":["../../../src/artifact/types.test-d.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAyBpD,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;IAC7B,EAAE,CAAC,+DAA+D,EAAE,GAAG,EAAE;QACvE,YAAY,EAAW,CAAC,aAAa,EAAsB,CAAC;QAC5D,YAAY,EAAc,CAAC,aAAa,EAAsB,CAAC;QAC/D,YAAY,EAAc,CAAC,aAAa,EAAsB,CAAC;IACjE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kCAAkC,EAAE,GAAG,EAAE;QAC1C,YAAY,EAAW,CAAC,aAAa,EAAiB,CAAC;QACvD,YAAY,EAAe,CAAC,aAAa,EAAiB,CAAC;QAC3D,YAAY,EAAY,CAAC,aAAa,EAAiB,CAAC;QACxD,YAAY,EAAgB,CAAC,aAAa,EAAiB,CAAC;QAC5D,YAAY,EAAgB,CAAC,aAAa,EAAiB,CAAC;QAC5D,YAAY,EAAgB,CAAC,aAAa,EAAiB,CAAC;QAC5D,YAAY,EAAe,CAAC,aAAa,EAAiB,CAAC;IAC7D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;QACrD,YAAY,EAAiB,CAAC,aAAa,EAAiB,CAAC;QAC7D,YAAY,EAAa,CAAC,aAAa,EAAiB,CAAC;IAC3D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;QAC7C,YAAY,EAAyB,CAAC,aAAa,EAAiB,CAAC;IACvE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;IACzB,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;QAC5C,YAAY,EAAe,CAAC,aAAa,EAAa,CAAC;QACvD,YAAY,EAAc,CAAC,aAAa,EAAa,CAAC;QACtD,YAAY,EAAa,CAAC,aAAa,EAAa,CAAC;IACvD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uBAAuB,EAAE,GAAG,EAAE;QAC/B,YAAY,EAAa,CAAC,GAAG,CAAC,aAAa,EAAa,CAAC;IAC3D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;QAC9D,YAAY,EAAc,CAAC,aAAa,EAAkB,CAAC;QAC3D,YAAY,EAAmB,CAAC,aAAa,EAAgB,CAAC;IAChE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;IAC9B,EAAE,CAAC,4EAA4E,EAAE,GAAG,EAAE;QACpF,YAAY,EAAW,CAAC,aAAa,EAAkB,CAAC;QACxD,YAAY,EAAY,CAAC,aAAa,EAAkB,CAAC;QACzD,YAAY,EAAc,CAAC,aAAa,EAAkB,CAAC;QAC3D,YAAY,EAAW,CAAC,aAAa,EAAkB,CAAC;QACxD,YAAY,EAAsB,CAAC,aAAa,EAAkB,CAAC;QACnE,YAAY,EAAqB,CAAC,aAAa,EAAkB,CAAC;IACpE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4DAA4D,EAAE,GAAG,EAAE;QACpE,YAAY,EAAW,CAAC,aAAa,EAAuB,CAAC;QAC7D,YAAY,EAAsB,CAAC,aAAa,EAA0B,CAAC;IAC7E,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;IAC7B,EAAE,CAAC,qBAAqB,EAAE,GAAG,EAAE;QAC7B,YAAY,EAAiB,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QACvD,YAAY,EAAiB,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QACnD,YAAY,EAAiB,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QACrD,YAAY,EAAiB,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QACrD,YAAY,EAAiB,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;QACzD,YAAY,EAAiB,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;IAChE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kCAAkC,EAAE,GAAG,EAAE;QAC1C,YAAY,EAAgC,CAAC,aAAa,EAEvD,CAAC;QACJ,YAAY,EAA+B,CAAC,aAAa,EAEtD,CAAC;IACN,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mDAAmD,EAAE,GAAG,EAAE;QAC3D,YAAY,EAAuB,CAAC,aAAa,EAAiB,CAAC;IACrE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAC9C,YAAY,EAAyB,CAAC,aAAa,EAAgB,CAAC;IACtE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,+BAA+B,EAAE,GAAG,EAAE;IAC7C,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;QACzE,YAAY,EAA6B,CAAC,aAAa,EAAiB,CAAC;IAC3E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;QACxE,YAAY,EAA0C,CAAC,aAAa,EAEjE,CAAC;IACN,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,8BAA8B,EAAE,GAAG,EAAE;IAC5C,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;QACzD,YAAY,EAAkC,CAAC,aAAa,EAEzD,CAAC;QACJ,YAAY,EAA2C,CAAC,aAAa,EAElE,CAAC;QACJ,YAAY,EAAyC,CAAC,aAAa,EAEhE,CAAC;QACJ,YAAY,EAAwC,CAAC,aAAa,EAE/D,CAAC;QACJ,YAAY,EAA0C,CAAC,aAAa,EAEjE,CAAC;IACN,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;IACnC,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;QACtC,YAAY,EAAuB,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;QAC/D,YAAY,EAAuB,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAC3D,YAAY,EAAuB,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IAC7D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4BAA4B,EAAE,GAAG,EAAE;QACpC,YAAY,EAAkC,CAAC,aAAa,EAEzD,CAAC;IACN,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;IACxB,EAAE,CAAC,kCAAkC,EAAE,GAAG,EAAE;QAC1C,YAAY,EAAY,CAAC,aAAa,EAAiC,CAAC;IAC1E,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAChC,EAAE,CAAC,uBAAuB,EAAE,GAAG,EAAE;QAC/B,YAAY,EAAY,CAAC,aAAa,EAAoB,CAAC;IAC7D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0BAA0B,EAAE,GAAG,EAAE;QAClC,YAAY,EAA2B,CAAC,aAAa,EAAoB,CAAC;IAC5E,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/esm/index.js

@@ -1,2 +1,2 @@
-export {};
+export { isKnownDtcgTokenType, KNOWN_DTCG_TOKEN_TYPES, } from "./artifact/types.js";
 //# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":""}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EACpB,sBAAsB,GACvB,MAAM,qBAAqB,CAAC"}

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

@@ -5,10 +5,42 @@
  * 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";
+/** Canonical tier literals emitted by Canonical token producers. */
+export type KnownTokenTier = "primitive" | "semantic" | "derived";
+/** Tier classification for Canonical-produced tokens. */
+export type TokenTier = KnownTokenTier;
+/**
+ * Tier strings carried by artifacts.
+ *
+ * Consumers should distinguish known tiers, but must tolerate non-Canonical
+ * tier strings from other producers.
+ */
+export type ArtifactTier = KnownTokenTier | (string & {});
+/** Shared list of known DTCG token type literals recognised by Canonical tooling. */
+export declare const KNOWN_DTCG_TOKEN_TYPES: readonly ["color", "dimension", "number", "typography", "fontFamily", "fontWeight", "fontStyle", "figureStyle", "textDecoration", "letterCase", "fontPosition", "duration", "cubicBezier", "gradient", "border", "shadow", "transition", "strokeStyle"];
+/** Known DTCG token type literals recognised by Canonical tooling. */
+export type KnownDtcgTokenType = (typeof KNOWN_DTCG_TOKEN_TYPES)[number];
+/**
+ * DTCG $type values used by the Canonical token system.
+ *
+ * The `(string & {})` arm preserves backward compatibility — callers may
+ * pass arbitrary strings without a type error, but autocomplete still
+ * suggests the known literals.
+ */
+export type DtcgTokenType = KnownDtcgTokenType | (string & {});
+/** Runtime guard for narrowing unknown strings to the shared known DTCG set. */
+export declare function isKnownDtcgTokenType(value: string | null | undefined): value is KnownDtcgTokenType;
+/** Canonical derivation literals emitted by Canonical token producers. */
+export type KnownDerivationKind = "hover" | "active" | "disabled" | "delta" | "channel-modifier" | "channel-surface";
+/** Derivation formula kind for Canonical-produced derived tokens. */
+export type DerivationKind = KnownDerivationKind;
+/**
+ * Derivation strings carried by artifacts.
+ *
+ * Consumers should recognise known derivations, but must tolerate
+ * non-Canonical derivation strings from other producers.
+ */
+export type ArtifactDerivationKind = KnownDerivationKind | (string & {});
 /** An at-rule context surrounding a declaration (e.g. `@layer ds.modifiers`). */
 export interface ArtifactAtRule {
     /** At-rule name (e.g. "layer", "media"). */
@@ -27,20 +59,23 @@ export interface ArtifactDeclaration {
     /** 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;
+/** Shared artifact metadata fields carried across producer and consumer layers. */
+export interface ArtifactMetadataFields {
     /** DTCG token ID from source, or `null` for derived tokens. */
     id: string | null;
     /** DTCG $type. */
-    type: string;
+    type: DtcgTokenType;
     /** Token tier classification. */
-    tier: TokenTier;
+    tier: ArtifactTier;
     /** DTCG $description. */
     description?: string;
     /** Full alias resolution chain (token IDs). */
     aliasChain?: string[];
+    /** DTCG $extensions passthrough. */
+    extensions?: Record<string, unknown>;
+}
+/** Shared resolved value fields carried in artifacts. */
+export interface ArtifactResolvedValueFields {
     /** Resolved CSS value (mode-invariant tokens). */
     value?: string;
     /** Light-mode resolved CSS value. */
@@ -49,6 +84,9 @@ export interface ArtifactToken {
     valueDark?: string;
     /** `true` when valueLight !== valueDark. */
     isPaired: boolean;
+}
+/** Shared source-location fields carried in artifacts. */
+export interface ArtifactSourceFields {
     /** DTCG source file path (relative). */
     sourceFile?: string;
     /** Line number in the DTCG source file. */
@@ -59,10 +97,16 @@ export interface ArtifactToken {
     cssOutputLine?: number;
     /** Declaration sites: where this token is provided in the CSS output. */
     declarations?: ArtifactDeclaration[];
+}
+/** Shared derived-token fields carried in artifacts. */
+export interface ArtifactDerivationFields {
     /** CSS var name of the source token (derived tier). */
     derivedFrom?: string;
     /** Formula kind (derived tier). */
-    derivation?: DerivationKind;
+    derivation?: ArtifactDerivationKind;
+}
+/** Shared CSS `@property` registration fields carried in artifacts. */
+export interface ArtifactRegistrationFields {
     /** `true` when the token has a CSS `@property` registration. */
     registered?: boolean;
     /** `@property` syntax (e.g. `"<color>"`). */
@@ -71,18 +115,73 @@ export interface ArtifactToken {
     inherits?: boolean | null;
     /** `@property` initial-value. */
     initialValue?: string | null;
-    /** DTCG $extensions passthrough. */
-    extensions?: Record<string, unknown>;
+}
+/** A single token entry in the artifact JSON. */
+export interface ArtifactToken extends ArtifactMetadataFields, ArtifactResolvedValueFields, ArtifactSourceFields, ArtifactDerivationFields, ArtifactRegistrationFields {
+    /** CSS custom property name as emitted. */
+    cssVar: string;
+}
+/** Input contract for constructing a DTCG-sourced artifact token. */
+export interface ArtifactTokenInit {
+    /** CSS custom property name as emitted. */
+    cssVar: string;
+    /** DTCG token ID from source. */
+    id: string;
+    /** DTCG $type. */
+    type: DtcgTokenType;
+    /** Token tier classification. */
+    tier: TokenTier;
+    /** CSS output file containing this token's declaration. */
+    cssOutputFile: string;
+    /** DTCG $description. */
+    description?: string;
+    /** Declaration sites emitted in CSS output. */
+    declarations?: ArtifactDeclaration[];
+    /** Full alias resolution chain (token IDs). */
+    aliasChain?: string[];
+    /** Light-mode resolved CSS value. */
+    valueLight?: string;
+    /** Dark-mode resolved CSS value. */
+    valueDark?: string;
+    /** DTCG source file path (relative). */
+    sourceFile?: string;
+    /** Line number in the DTCG source file. */
+    sourceLine?: number;
+}
+/** Input contract for constructing a derived or plugin-generated artifact token. */
+export interface DerivedArtifactTokenInit {
+    /** CSS custom property name as emitted. */
+    cssVar: string;
+    /** DTCG $type. */
+    type: DtcgTokenType;
+    /** Token tier classification. */
+    tier: TokenTier;
+    /** CSS output file containing this token's declaration. */
+    cssOutputFile: string;
+    /** CSS var name of the source token. */
+    derivedFrom: string;
+    /** Formula kind for the derived token. */
+    derivation: DerivationKind;
+    /** DTCG $description. */
+    description?: string;
+    /** Declaration sites emitted in CSS output. */
+    declarations?: ArtifactDeclaration[];
+    /** Light-mode resolved CSS value. */
+    valueLight?: string;
+    /** Dark-mode resolved CSS value. */
+    valueDark?: string;
 }
 /** The complete artifact: CSS variable name → token metadata. */
 export type Artifact = Record<string, ArtifactToken>;
+/** Wrapped artifact payload with metadata envelope. */
+export interface WrappedArtifactEnvelope {
+    version: string;
+    generator: string;
+    tokens: Artifact;
+}
 /**
  * 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;
-};
+export type ArtifactEnvelope = Artifact | WrappedArtifactEnvelope;
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +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"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/artifact/types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAMH,oEAAoE;AACpE,MAAM,MAAM,cAAc,GAAG,WAAW,GAAG,UAAU,GAAG,SAAS,CAAC;AAElE,yDAAyD;AACzD,MAAM,MAAM,SAAS,GAAG,cAAc,CAAC;AAEvC;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GACpB,cAAc,GAEd,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;AAElB,qFAAqF;AACrF,eAAO,MAAM,sBAAsB,yPAmBzB,CAAC;AAEX,sEAAsE;AACtE,MAAM,MAAM,kBAAkB,GAAG,CAAC,OAAO,sBAAsB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEzE;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,GACrB,kBAAkB,GAElB,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;AAElB,gFAAgF;AAChF,wBAAgB,oBAAoB,CAClC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAC/B,KAAK,IAAI,kBAAkB,CAK7B;AAED,0EAA0E;AAC1E,MAAM,MAAM,mBAAmB,GAC3B,OAAO,GACP,QAAQ,GACR,UAAU,GACV,OAAO,GACP,kBAAkB,GAClB,iBAAiB,CAAC;AAEtB,qEAAqE;AACrE,MAAM,MAAM,cAAc,GAAG,mBAAmB,CAAC;AAEjD;;;;;GAKG;AACH,MAAM,MAAM,sBAAsB,GAC9B,mBAAmB,GAEnB,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;AAMlB,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;AAED,mFAAmF;AACnF,MAAM,WAAW,sBAAsB;IACrC,+DAA+D;IAC/D,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAClB,kBAAkB;IAClB,IAAI,EAAE,aAAa,CAAC;IACpB,iCAAiC;IACjC,IAAI,EAAE,YAAY,CAAC;IACnB,yBAAyB;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,+CAA+C;IAC/C,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,oCAAoC;IACpC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACtC;AAED,yDAAyD;AACzD,MAAM,WAAW,2BAA2B;IAC1C,kDAAkD;IAClD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,qCAAqC;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,oCAAoC;IACpC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,4CAA4C;IAC5C,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,0DAA0D;AAC1D,MAAM,WAAW,oBAAoB;IACnC,wCAAwC;IACxC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,2CAA2C;IAC3C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,2DAA2D;IAC3D,aAAa,EAAE,MAAM,CAAC;IACtB,oFAAoF;IACpF,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,yEAAyE;IACzE,YAAY,CAAC,EAAE,mBAAmB,EAAE,CAAC;CACtC;AAED,wDAAwD;AACxD,MAAM,WAAW,wBAAwB;IACvC,uDAAuD;IACvD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mCAAmC;IACnC,UAAU,CAAC,EAAE,sBAAsB,CAAC;CACrC;AAED,uEAAuE;AACvE,MAAM,WAAW,0BAA0B;IACzC,gEAAgE;IAChE,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,6CAA6C;IAC7C,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,iCAAiC;IACjC,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC1B,iCAAiC;IACjC,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAMD,iDAAiD;AACjD,MAAM,WAAW,aACf,SAAQ,sBAAsB,EAC5B,2BAA2B,EAC3B,oBAAoB,EACpB,wBAAwB,EACxB,0BAA0B;IAC5B,2CAA2C;IAC3C,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,qEAAqE;AACrE,MAAM,WAAW,iBAAiB;IAChC,2CAA2C;IAC3C,MAAM,EAAE,MAAM,CAAC;IACf,iCAAiC;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,kBAAkB;IAClB,IAAI,EAAE,aAAa,CAAC;IACpB,iCAAiC;IACjC,IAAI,EAAE,SAAS,CAAC;IAChB,2DAA2D;IAC3D,aAAa,EAAE,MAAM,CAAC;IACtB,yBAAyB;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,+CAA+C;IAC/C,YAAY,CAAC,EAAE,mBAAmB,EAAE,CAAC;IACrC,+CAA+C;IAC/C,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,qCAAqC;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,oCAAoC;IACpC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,wCAAwC;IACxC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,2CAA2C;IAC3C,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,oFAAoF;AACpF,MAAM,WAAW,wBAAwB;IACvC,2CAA2C;IAC3C,MAAM,EAAE,MAAM,CAAC;IACf,kBAAkB;IAClB,IAAI,EAAE,aAAa,CAAC;IACpB,iCAAiC;IACjC,IAAI,EAAE,SAAS,CAAC;IAChB,2DAA2D;IAC3D,aAAa,EAAE,MAAM,CAAC;IACtB,wCAAwC;IACxC,WAAW,EAAE,MAAM,CAAC;IACpB,0CAA0C;IAC1C,UAAU,EAAE,cAAc,CAAC;IAC3B,yBAAyB;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,+CAA+C;IAC/C,YAAY,CAAC,EAAE,mBAAmB,EAAE,CAAC;IACrC,qCAAqC;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,oCAAoC;IACpC,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAMD,iEAAiE;AACjE,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;AAErD,uDAAuD;AACvD,MAAM,WAAW,uBAAuB;IACtC,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,QAAQ,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GACxB,QAAQ,GACR,uBAAuB,CAAC"}

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

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.test-d.d.ts.map

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

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

package/dist/types/index.d.ts

@@ -1,2 +1,3 @@
-export type { Artifact, ArtifactAtRule, ArtifactDeclaration, ArtifactEnvelope, ArtifactToken, DerivationKind, TokenTier, } from "./artifact/types.js";
+export { isKnownDtcgTokenType, KNOWN_DTCG_TOKEN_TYPES, } from "./artifact/types.js";
+export type { Artifact, ArtifactAtRule, ArtifactDeclaration, ArtifactDerivationKind, ArtifactDerivationFields, ArtifactEnvelope, ArtifactMetadataFields, ArtifactRegistrationFields, ArtifactResolvedValueFields, ArtifactSourceFields, ArtifactToken, ArtifactTokenInit, ArtifactTier, DerivationKind, DerivedArtifactTokenInit, DtcgTokenType, KnownDerivationKind, KnownTokenTier, KnownDtcgTokenType, TokenTier, WrappedArtifactEnvelope, } from "./artifact/types.js";
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +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"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EACpB,sBAAsB,GACvB,MAAM,qBAAqB,CAAC;AAC7B,YAAY,EACV,QAAQ,EACR,cAAc,EACd,mBAAmB,EACnB,sBAAsB,EACtB,wBAAwB,EACxB,gBAAgB,EAChB,sBAAsB,EACtB,0BAA0B,EAC1B,2BAA2B,EAC3B,oBAAoB,EACpB,aAAa,EACb,iBAAiB,EACjB,YAAY,EACZ,cAAc,EACd,wBAAwB,EACxB,aAAa,EACb,mBAAmB,EACnB,cAAc,EACd,kBAAkB,EAClB,SAAS,EACT,uBAAuB,GACxB,MAAM,qBAAqB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@canonical/token-types",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "Shared types for Canonical design token tooling.",
   "type": "module",
   "license": "LGPL-3.0",
@@ -35,10 +35,12 @@
   "scripts": {
     "build": "tsc -p tsconfig.build.json",
     "check": "bun run check:ts",
-    "check:ts": "tsc --noEmit"
+    "check:ts": "tsc --noEmit",
+    "test": "vitest run --typecheck.only"
   },
   "devDependencies": {
-    "@canonical/typescript-config-base": "^0.10.0-experimental.4",
-    "typescript": "^5.9.3"
+    "@canonical/typescript-config-base": "^0.12.0",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.18"
   }
 }