@ adobe/ dedesign-data-wasm (英语)

网页大会装订 design-data-core - 查询、验证、, 解析,以及来自 JavaScript 或 TypeScript 的 diff Spectrum 设计符号, 带有 零本地依赖.

生成类型Script类型直接取自 Rust 类型通过 tsy- next (帮助) ——无手工维护 平行类型表面.

安装

pnpm add @adobe/design-data-wasm

释放核查

运行 moon run sdk-wasm:verify-package 建立目标并检查 发布前装入的软件包 。 检查在临时安装焦油丸 工作空间外的消费者和通过节点运行嵌入式数据查询 和网络入口。 还检查绑定物、类型和二进制 已存在且有效。 它不发布软件包.

抓图和稳定的发布工作流程在下载后运行相同的检查 他们的建筑文物.

使用量

节点.js(同步-否) init() (所需)

这个 node 导出条件确定为同步的 CommonJS 构建; 已命名 进口通过Cjs-moule-lexer在无害环境管理中发挥作用.

import { Dataset, getValues, findValue } from "@adobe/design-data-wasm";

// Use the canonical embedded Spectrum dataset (zero config):
const ds = Dataset.embedded();

// Or build a dataset from your own token objects:
const tokens = JSON.parse(fs.readFileSync("my-tokens.json", "utf-8"));
const customDs = Dataset.fromTokens(tokens);

// Query
const colorTokens = ds.query("property=color,colorScheme=dark");
console.log(colorTokens[0].name, colorTokens[0].raw.value);

// Validate (relational rules — structural/JSON-Schema checks require the CLI)
const { valid, errors } = ds.validate();

// Resolve a property in a given context
const result = ds.resolve("background", {
  colorScheme: "dark",
  scale: "medium",
});
if (result)
  console.log(result.token.raw.value, "specificity:", result.specificity);

// Diff two datasets
const oldDs = Dataset.fromTokens(oldTokens);
const newDs = Dataset.fromTokens(newTokens);
const diff = oldDs.diff(newDs);
console.log(`${diff.added.length} added, ${diff.deleted.length} deleted`);

浏览器/ 捆绑器( 需要) await init()(中文(简体) )

这个 browser 导出条件解决了浏览器的无害环境管理构建。 打电话 init() 带有 URL 的 .wasm 使用任何 API 之前的文件.

Deno、Bun和非标准捆绑商的说明: 软件包 default 导出 条件也解决网络(浏览器无害环境管理)的构建,因此运行时间或捆绑器可以 不尊重这个 node 或者说 browser 条件会得到这个建筑和 必须 调用 await init() 在使用任何 API 之前.

import init, { Dataset } from "@adobe/design-data-wasm";
// or explicit browser path:
import init, {
  Dataset,
} from "@adobe/design-data-wasm/pkg/web/design_data_wasm.js";

await init(); // pass wasm URL if needed: await init(new URL('./wasm/design_data_wasm_bg.wasm', import.meta.url))

const ds = Dataset.fromTokens(tokens);
const results = ds.query("property=color");

API 密码

遗留兼容性输出

ds.legacyOutput() 返回由遗留输出文件名键入的普通对象. 每个文件包含由遗留名键入的符号条目,包括已重建 模式集和别名。 嵌入式数据集包括组件/托接关系. 不包含非默认对比记录, 匹配本地图遗留输出 .

const byFile = ds.legacyOutput();
const flat = Object.assign({}, ...Object.values(byFile));
console.log(flat['picker-border-width'].value);

Dataset

登记册助手

这些与被腐烂的 @adobe/design-system-registry API,接受 { values: [...] } JSON 形状来自 @adobe/spectrum-design-data/registry/*.json。 。 。 .

嵌入式登记册助手

由编译时间嵌入的登记册数据支持的快速查询(没有 JSON 参数) 所需:

类型脚本

类型来自rust structs;不需要并行声明.

import type {
  TokenResult,
  ValidationResult,
  DiffResult,
  ResolveResult,
} from "@adobe/design-data-wasm";

许可证

阿帕奇-2.0 — 见 自由主义。 。 。 .