@adobe/design-data-wasm 0.9.0 → 0.10.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/design-data-wasm",
-  "version": "0.9.0",
+  "version": "0.10.1",
   "description": "WebAssembly bindings for design-data-core — query, validate, resolve, diff, and registry helpers for Spectrum design tokens",
   "type": "module",
   "main": "./pkg/node/design_data_wasm.js",

package/pkg/node/design_data_wasm.d.ts

@@ -28,6 +28,16 @@ export type TokenResultArray = TokenResult[];
  */
 export type ResolutionContext = Map<string, string>;
 
+/**
+ * A non-winning candidate returned with a property resolution.
+ */
+export interface ResolveAlternative {
+    name: string;
+    uuid: string | undefined;
+    deprecated: boolean;
+    deprecatedIn: string | undefined;
+}
+
 /**
  * A registry vocabulary object as read from `registry/*.json`.
  */
@@ -80,6 +90,11 @@ export interface SuggestResult {
 export interface ResolveResult {
     token: TokenResult;
     specificity: number;
+    deprecated: boolean;
+    deprecatedIn: string | undefined;
+    candidateCount: number;
+    ambiguous: boolean;
+    alternatives: ResolveAlternative[];
 }
 
 /**
@@ -161,6 +176,17 @@ export interface RenamedToken {
     propertyChanges: PropertyChange[];
 }
 
+/**
+ * Optional name-object fields used to narrow property resolution.
+ */
+export interface ResolveNarrowing {
+    component: string | undefined;
+    variant: string | undefined;
+    state: string | undefined;
+    colorRole: string | undefined;
+    excludeDeprecated?: boolean;
+}
+
 /**
  * Severity level of a validation diagnostic.
  */
@@ -293,8 +319,13 @@ export class Dataset {
      *
      * **Syntax:** `key=value` pairs separated by `,` (AND) or `|` (OR).
      * Use `!=` for negation and `*` as a wildcard suffix or prefix.
-     * Valid keys: `property`, `component`, `variant`, `state`, `colorScheme`,
-     * `scale`, `contrast`, `uuid`, `$schema`.
+     * Valid parser keys: `property`, `component`, `variant`, `state`,
+     * `colorScheme`, `scale`, `contrast`, `uuid`, `$schema`.
+     *
+     * `component` remains accepted for compatibility, but it is not a
+     * meaningfully indexed field in the embedded dataset and usually returns no
+     * matches. Prefer `describe_component` and `tokenBindings` metadata for
+     * component-aware discovery.
      *
      * ```js
      * const results = ds.query("property=color,colorScheme=dark");
@@ -312,11 +343,14 @@ export class Dataset {
      * no token matches the property+context combination.
      *
      * ```js
-     * const result = ds.resolve("background", { colorScheme: "dark", scale: "medium" });
+     * const result = ds.resolve("background", { colorScheme: "dark", scale: "medium" }, {
+     *   variant: "accent",
+     *   state: "hover",
+     * });
      * if (result) console.log(result.token.raw.value);
      * ```
      */
-    resolve(property: string, context: ResolutionContext): ResolveResult | undefined;
+    resolve(property: string, context: ResolutionContext, narrowing?: ResolveNarrowing | null): ResolveResult | undefined;
     /**
      * Resolve a legacy token reference by slug in a given context, returning
      * the terminal value and the full alias chain.

package/pkg/node/design_data_wasm.js

@@ -118,8 +118,13 @@ class Dataset {
      *
      * **Syntax:** `key=value` pairs separated by `,` (AND) or `|` (OR).
      * Use `!=` for negation and `*` as a wildcard suffix or prefix.
-     * Valid keys: `property`, `component`, `variant`, `state`, `colorScheme`,
-     * `scale`, `contrast`, `uuid`, `$schema`.
+     * Valid parser keys: `property`, `component`, `variant`, `state`,
+     * `colorScheme`, `scale`, `contrast`, `uuid`, `$schema`.
+     *
+     * `component` remains accepted for compatibility, but it is not a
+     * meaningfully indexed field in the embedded dataset and usually returns no
+     * matches. Prefer `describe_component` and `tokenBindings` metadata for
+     * component-aware discovery.
      *
      * ```js
      * const results = ds.query("property=color,colorScheme=dark");
@@ -147,17 +152,21 @@ class Dataset {
      * no token matches the property+context combination.
      *
      * ```js
-     * const result = ds.resolve("background", { colorScheme: "dark", scale: "medium" });
+     * const result = ds.resolve("background", { colorScheme: "dark", scale: "medium" }, {
+     *   variant: "accent",
+     *   state: "hover",
+     * });
      * if (result) console.log(result.token.raw.value);
      * ```
      * @param {string} property
      * @param {ResolutionContext} context
+     * @param {ResolveNarrowing | null} [narrowing]
      * @returns {ResolveResult | undefined}
      */
-    resolve(property, context) {
+    resolve(property, context, narrowing) {
         const ptr0 = passStringToWasm0(property, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
         const len0 = WASM_VECTOR_LEN;
-        const ret = wasm.dataset_resolve(this.__wbg_ptr, ptr0, len0, context);
+        const ret = wasm.dataset_resolve(this.__wbg_ptr, ptr0, len0, context, isLikeNone(narrowing) ? 0 : addToExternrefTable0(narrowing));
         if (ret[2]) {
             throw takeFromExternrefTable0(ret[1]);
         }

package/pkg/node/design_data_wasm_bg.wasm.d.ts

@@ -8,7 +8,7 @@ export const dataset_primer: (a: number) => [number, number, number];
 export const dataset_query: (a: number, b: number, c: number) => [number, number, number];
 export const dataset_suggest: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number, number];
 export const dataset_validate: (a: number) => any;
-export const dataset_resolve: (a: number, b: number, c: number, d: any) => [number, number, number];
+export const dataset_resolve: (a: number, b: number, c: number, d: any, e: number) => [number, number, number];
 export const dataset_resolveReference: (a: number, b: number, c: number, d: any) => [number, number, number];
 export const dataset_diff: (a: number, b: number) => [number, number, number];
 export const dataset_tokenCount: (a: number) => number;

package/pkg/web/design_data_wasm.d.ts

@@ -28,6 +28,16 @@ export type TokenResultArray = TokenResult[];
  */
 export type ResolutionContext = Map<string, string>;
 
+/**
+ * A non-winning candidate returned with a property resolution.
+ */
+export interface ResolveAlternative {
+    name: string;
+    uuid: string | undefined;
+    deprecated: boolean;
+    deprecatedIn: string | undefined;
+}
+
 /**
  * A registry vocabulary object as read from `registry/*.json`.
  */
@@ -80,6 +90,11 @@ export interface SuggestResult {
 export interface ResolveResult {
     token: TokenResult;
     specificity: number;
+    deprecated: boolean;
+    deprecatedIn: string | undefined;
+    candidateCount: number;
+    ambiguous: boolean;
+    alternatives: ResolveAlternative[];
 }
 
 /**
@@ -161,6 +176,17 @@ export interface RenamedToken {
     propertyChanges: PropertyChange[];
 }
 
+/**
+ * Optional name-object fields used to narrow property resolution.
+ */
+export interface ResolveNarrowing {
+    component: string | undefined;
+    variant: string | undefined;
+    state: string | undefined;
+    colorRole: string | undefined;
+    excludeDeprecated?: boolean;
+}
+
 /**
  * Severity level of a validation diagnostic.
  */
@@ -293,8 +319,13 @@ export class Dataset {
      *
      * **Syntax:** `key=value` pairs separated by `,` (AND) or `|` (OR).
      * Use `!=` for negation and `*` as a wildcard suffix or prefix.
-     * Valid keys: `property`, `component`, `variant`, `state`, `colorScheme`,
-     * `scale`, `contrast`, `uuid`, `$schema`.
+     * Valid parser keys: `property`, `component`, `variant`, `state`,
+     * `colorScheme`, `scale`, `contrast`, `uuid`, `$schema`.
+     *
+     * `component` remains accepted for compatibility, but it is not a
+     * meaningfully indexed field in the embedded dataset and usually returns no
+     * matches. Prefer `describe_component` and `tokenBindings` metadata for
+     * component-aware discovery.
      *
      * ```js
      * const results = ds.query("property=color,colorScheme=dark");
@@ -312,11 +343,14 @@ export class Dataset {
      * no token matches the property+context combination.
      *
      * ```js
-     * const result = ds.resolve("background", { colorScheme: "dark", scale: "medium" });
+     * const result = ds.resolve("background", { colorScheme: "dark", scale: "medium" }, {
+     *   variant: "accent",
+     *   state: "hover",
+     * });
      * if (result) console.log(result.token.raw.value);
      * ```
      */
-    resolve(property: string, context: ResolutionContext): ResolveResult | undefined;
+    resolve(property: string, context: ResolutionContext, narrowing?: ResolveNarrowing | null): ResolveResult | undefined;
     /**
      * Resolve a legacy token reference by slug in a given context, returning
      * the terminal value and the full alias chain.
@@ -462,7 +496,7 @@ export interface InitOutput {
     readonly dataset_query: (a: number, b: number, c: number) => [number, number, number];
     readonly dataset_suggest: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number, number];
     readonly dataset_validate: (a: number) => any;
-    readonly dataset_resolve: (a: number, b: number, c: number, d: any) => [number, number, number];
+    readonly dataset_resolve: (a: number, b: number, c: number, d: any, e: number) => [number, number, number];
     readonly dataset_resolveReference: (a: number, b: number, c: number, d: any) => [number, number, number];
     readonly dataset_diff: (a: number, b: number) => [number, number, number];
     readonly dataset_tokenCount: (a: number) => number;

package/pkg/web/design_data_wasm.js

@@ -118,8 +118,13 @@ export class Dataset {
      *
      * **Syntax:** `key=value` pairs separated by `,` (AND) or `|` (OR).
      * Use `!=` for negation and `*` as a wildcard suffix or prefix.
-     * Valid keys: `property`, `component`, `variant`, `state`, `colorScheme`,
-     * `scale`, `contrast`, `uuid`, `$schema`.
+     * Valid parser keys: `property`, `component`, `variant`, `state`,
+     * `colorScheme`, `scale`, `contrast`, `uuid`, `$schema`.
+     *
+     * `component` remains accepted for compatibility, but it is not a
+     * meaningfully indexed field in the embedded dataset and usually returns no
+     * matches. Prefer `describe_component` and `tokenBindings` metadata for
+     * component-aware discovery.
      *
      * ```js
      * const results = ds.query("property=color,colorScheme=dark");
@@ -147,17 +152,21 @@ export class Dataset {
      * no token matches the property+context combination.
      *
      * ```js
-     * const result = ds.resolve("background", { colorScheme: "dark", scale: "medium" });
+     * const result = ds.resolve("background", { colorScheme: "dark", scale: "medium" }, {
+     *   variant: "accent",
+     *   state: "hover",
+     * });
      * if (result) console.log(result.token.raw.value);
      * ```
      * @param {string} property
      * @param {ResolutionContext} context
+     * @param {ResolveNarrowing | null} [narrowing]
      * @returns {ResolveResult | undefined}
      */
-    resolve(property, context) {
+    resolve(property, context, narrowing) {
         const ptr0 = passStringToWasm0(property, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
         const len0 = WASM_VECTOR_LEN;
-        const ret = wasm.dataset_resolve(this.__wbg_ptr, ptr0, len0, context);
+        const ret = wasm.dataset_resolve(this.__wbg_ptr, ptr0, len0, context, isLikeNone(narrowing) ? 0 : addToExternrefTable0(narrowing));
         if (ret[2]) {
             throw takeFromExternrefTable0(ret[1]);
         }

package/pkg/web/design_data_wasm_bg.wasm.d.ts

@@ -8,7 +8,7 @@ export const dataset_primer: (a: number) => [number, number, number];
 export const dataset_query: (a: number, b: number, c: number) => [number, number, number];
 export const dataset_suggest: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number, number];
 export const dataset_validate: (a: number) => any;
-export const dataset_resolve: (a: number, b: number, c: number, d: any) => [number, number, number];
+export const dataset_resolve: (a: number, b: number, c: number, d: any, e: number) => [number, number, number];
 export const dataset_resolveReference: (a: number, b: number, c: number, d: any) => [number, number, number];
 export const dataset_diff: (a: number, b: number) => [number, number, number];
 export const dataset_tokenCount: (a: number) => number;