@design-embed/target-react 0.1.0 → 1.0.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2026 Jin-Woo Lee
+Copyright (c) 2026 Jin Woo Lee
 
 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:
 

package/README.md

@@ -2,4 +2,69 @@
 
 React target support for design-embed.
 
-It provides React-oriented emission behavior for generated views. The target focuses on producing deterministic component output that can reference configured project components and style conventions, making design HTML embeddable in React codebases.
+It provides React-oriented emission behavior for generated views. The target focuses on producing deterministic component output and visual regression tests, making design HTML embeddable in React codebases.
+
+## Usage
+
+```typescript
+import { defineConfig } from "design-embed";
+import { ReactTarget } from "@design-embed/target-react";
+
+export default defineConfig({
+  output: {
+    target: new ReactTarget(),
+    viewName: "WelcomeHero",
+    viewsDir: "src/generated/views",
+    styleMode: "inline",
+  },
+  components: [
+    {
+      selector: "button[data-role='primary']",
+      component: "Button",
+      props: { variant: "primary", children: "$text" },
+    },
+  ],
+});
+```
+
+`ReactTarget` is a class — instantiate it with `new ReactTarget()` each time you configure an output target.
+
+## Generated output
+
+For the config above, design-embed produces:
+
+```text
+src/generated/views/
+  WelcomeHero.view.tsx   ← main view, imports Button locally
+  Button.view.tsx        ← Button component scaffold
+```
+
+`WelcomeHero.view.tsx`:
+```tsx
+import { Button } from "./Button.view";
+
+export function WelcomeHero() {
+  return (
+    <section>
+      <Button variant="primary">Get Started</Button>
+    </section>
+  );
+}
+```
+
+Every component mapping produces a separate `{ComponentName}.view.tsx` file. The main view always imports from those local files.
+
+## Visual tests
+
+When `generateTests: true` is passed to `embed()` (or via `generate-tests` CLI command), a Playwright component test is generated for each output file:
+
+```text
+src/generated/views/tests/
+  WelcomeHero.reference.html    ← source HTML snapshot
+  WelcomeHero.visual.spec.tsx   ← full view screenshot + layout test
+  Button.visual.spec.tsx        ← component-level test
+```
+
+The **component spec** locates the matched HTML element in the reference snapshot using its CSS selector, screenshots it, then mounts the React component in isolation and compares. Re-running `embed` in CI updates the reference HTML — tests then fail for any component that no longer matches the updated design.
+
+Requires `@playwright/experimental-ct-react` in the consuming project.

package/dist/design-embed/src/core/diagnostics/diagnostic.d.mts

@@ -0,0 +1,16 @@
+import { SourceLocation } from "../nodes.mjs";
+
+//#region packages/design-embed/src/core/diagnostics/diagnostic.d.ts
+type DiagnosticSeverity = "error" | "warning" | "info";
+interface Diagnostic {
+  code: string;
+  message: string;
+  severity: DiagnosticSeverity;
+  file?: string;
+  source?: SourceLocation;
+  selector?: string;
+  property?: string;
+  details?: Record<string, unknown>;
+}
+//#endregion
+export { Diagnostic };

package/dist/design-embed/src/core/nodes.d.mts

@@ -0,0 +1,63 @@
+//#region packages/design-embed/src/core/nodes.d.ts
+/**
+ * Location in the source HTML file.
+ */
+interface SourceLocation {
+  /** Absolute offset in characters. */
+  offset: number;
+  /** 1-based line number. */
+  line: number;
+  /** 1-based column number. */
+  column: number;
+}
+/**
+ * A normalized node in the design AST.
+ */
+interface DesignNode {
+  /** The type of node. */
+  kind: "element" | "text" | "component";
+  /** HTML tag name (for element kind). */
+  tagName?: string;
+  /** HTML attributes (for element kind). */
+  attributes?: Record<string, string>;
+  /** Parsed inline styles (for element kind). */
+  styles?: Record<string, string>;
+  /** Utility classes to apply. */
+  generatedClassNames?: string[];
+  /** Child nodes. */
+  children?: DesignNode[];
+  /** Inner text content (for text kind). */
+  text?: string;
+  /** Original location in the source HTML. */
+  source?: SourceLocation;
+  /** Component name (for component kind). */
+  component?: string;
+  /** Named export of the component. */
+  importName?: string;
+  /** Mapped prop values for the component. */
+  props?: Record<string, PropValue>;
+  /** Import path of the component. */
+  importPath?: string;
+  /**
+   * The original element node a component was mapped from. Retained so
+   * targets can reconstruct the element's structure when emitting the
+   * component implementation.
+   */
+  sourceElement?: DesignNode;
+}
+/**
+ * A value passed to a component prop.
+ */
+type PropValue = {
+  kind: "literal";
+  value: string | number | boolean; /** Source attribute name when the prop is bound to `$attr.*`. */
+  attribute?: string;
+} | {
+  kind: "text";
+  value: string;
+} | {
+  kind: "children";
+  value: DesignNode[];
+};
+//#endregion
+export { DesignNode, SourceLocation };

package/dist/design-embed/src/core/plugins/pluginApi.d.mts

@@ -0,0 +1,41 @@
+import { Diagnostic } from "../diagnostics/diagnostic.mjs";
+
+//#region packages/design-embed/src/core/plugins/pluginApi.d.ts
+/**
+ * Represents a file generated by the compiler.
+ */
+interface GeneratedFile {
+  /** Relative path from the output directory. */
+  path: string;
+  /** File content. */
+  contents: string;
+}
+interface GeneratedAsset {
+  path: string;
+  contents?: string | Uint8Array;
+  sourceUrl?: string;
+}
+interface SourcePlugin {
+  name: string;
+  run(input: SourcePluginInput): Promise<SourcePluginResult>;
+}
+interface SourcePluginInput {
+  cwd: string;
+  config?: unknown;
+}
+interface SourcePluginResult {
+  html?: string;
+  css?: string;
+  assets?: GeneratedAsset[];
+  files?: GeneratedFile[];
+  diagnostics: Diagnostic[];
+}
+interface TargetEmitResult {
+  files: GeneratedFile[];
+}
+interface TargetTestGenerateResult {
+  files: GeneratedFile[];
+  diagnostics: Diagnostic[];
+}
+//#endregion
+export { SourcePlugin, TargetEmitResult, TargetTestGenerateResult };

package/dist/design-embed/src/core/types.d.mts

@@ -0,0 +1,98 @@
+import { DesignNode } from "./nodes.mjs";
+import { SourcePlugin, TargetEmitResult, TargetTestGenerateResult } from "./plugins/pluginApi.mjs";
+import { Diagnostic } from "./diagnostics/diagnostic.mjs";
+
+//#region packages/design-embed/src/core/types.d.ts
+interface TargetEmitInput {
+  nodes: DesignNode[];
+  css?: string;
+  config?: DesignEmbedConfig;
+  diagnostics: Diagnostic[];
+}
+interface TargetEmitter {
+  emit(input: TargetEmitInput): TargetEmitResult;
+}
+interface TargetTestGenerateInput {
+  html: string;
+  css?: string;
+  config: DesignEmbedConfig;
+}
+interface TargetTestGenerator {
+  generateTests(input: TargetTestGenerateInput): TargetTestGenerateResult;
+}
+type StyleMode = "inline" | "css-modules" | "tailwind";
+interface ComponentMapping {
+  selector: string;
+  component: string;
+  props?: Record<string, string>;
+}
+interface TokenConfig {
+  spacing?: {
+    unit?: "px" | "rem";
+    threshold?: number;
+    values?: Record<string, number>;
+  };
+  sizing?: NumericTokenGroup;
+  typography?: NumericTokenGroup;
+  radius?: Record<string, number>;
+  borderWidth?: Record<string, number>;
+  shadow?: Record<string, string>;
+  colors?: Record<string, string>;
+  colorThreshold?: number;
+}
+interface NumericTokenGroup {
+  unit?: "px" | "rem";
+  threshold?: number;
+  values?: Record<string, number>;
+}
+type StyleMappings = Record<string, Record<string, string>>;
+interface TestGenerationConfig {
+  outputDir?: string;
+  runner?: "playwright";
+  viewports?: TestViewport[];
+  states?: TestState[];
+  assertions?: TestAssertions;
+}
+interface TestViewport {
+  name?: string;
+  width: number;
+  height: number;
+}
+interface TestState {
+  name: string;
+  hover?: string;
+  focus?: string;
+  click?: string;
+  waitFor?: string;
+}
+interface TestAssertions {
+  screenshot?: boolean;
+  layout?: boolean;
+  layoutTolerance?: number;
+  selectors?: string[];
+  /**
+   * Per-pixel color sensitivity (0-1) for the screenshot comparison. Smaller
+   * is stricter. Defaults to 0.2.
+   */
+  screenshotThreshold?: number;
+  /**
+   * Maximum number of differing pixels tolerated in the screenshot
+   * comparison. Defaults to 0 (byte-exact).
+   */
+  screenshotMaxDiffPixels?: number;
+}
+interface DesignEmbedConfig {
+  output?: {
+    viewsDir?: string | URL;
+    target?: "html" | TargetEmitter;
+    viewName?: string;
+    styleMode?: StyleMode;
+  };
+  components?: ComponentMapping[];
+  tokens?: TokenConfig;
+  styleMappings?: StyleMappings;
+  source?: SourcePlugin;
+  tests?: TestGenerationConfig;
+}
+//#endregion
+export { TargetEmitInput, TargetEmitter, TargetTestGenerateInput, TargetTestGenerator };

package/dist/index.d.mts

@@ -0,0 +1,20 @@
+import { DesignNode } from "./design-embed/src/core/nodes.mjs";
+import { TargetEmitResult, TargetTestGenerateResult } from "./design-embed/src/core/plugins/pluginApi.mjs";
+import { TargetEmitInput, TargetEmitter, TargetTestGenerateInput, TargetTestGenerator } from "./design-embed/src/core/types.mjs";
+
+//#region packages/target-react/src/index.d.ts
+declare class ReactTarget implements TargetEmitter, TargetTestGenerator {
+  emit({
+    nodes,
+    css,
+    config,
+    diagnostics
+  }: TargetEmitInput): TargetEmitResult;
+  generateTests(input: TargetTestGenerateInput): TargetTestGenerateResult;
+}
+declare const reactTestGenerator: TargetTestGenerator;
+declare function emitReactView(nodes: DesignNode[], viewName: string, options?: {
+  cssModulePath?: string;
+}): string;
+//#endregion
+export { ReactTarget, emitReactView, reactTestGenerator };