Debug config validate by ameerf-wix · Pull Request #238 · wix/interact

ameerf-wix · 2026-06-01T14:01:30Z

Description

Related Issue

Checklist

I have read the Contributing Guide
I have added/updated tests for my changes (if applicable)
I have updated documentation/rules/skills (if applicable)

Screenshots / Demos

Additional Notes

…debug_config_validate

github-actions · 2026-06-01T14:01:49Z

Generated `llms.txt` preview

llms.txt

# @wix/interact

> Declarative, configuration-driven interaction library — web-native, AI-ready, and framework-agnostic.

- Install: `npm install @wix/interact @wix/motion-presets`
- Three entry points: vanilla JS (`@wix/interact`), React (`@wix/interact/react`), Web Components (`@wix/interact/web`)
- Five trigger types: hover, click, viewEnter, viewProgress, pointerMove
- Effects via named presets (`@wix/motion-presets`), keyframes, CSS transitions, or custom JS callbacks
- Configs are JSON-serializable -- designed for LLM generation

## Docs

- [Full Reference](https://wix.github.io/interact/rules/full-lean.md): Declarative configuration-driven interaction library. Binds animations to triggers via JSON config. (700 lines)
- [Integration Guide](https://wix.github.io/interact/rules/integration.md): Rules for integrating `@wix/interact` into a webpage — binding animations and effects to user-driven triggers via declarative configuration. (334 lines)
- [Validation Guide](https://wix.github.io/interact/rules/validate.md): Rules for using `@wix/interact-validate` — validate an `InteractConfig` before it reaches the runtime. (271 lines)

## Optional

- [Click Trigger Rules for @wix/interact](https://wix.github.io/interact/rules/click.md): This document contains rules for generating click-triggered interactions in `@wix/interact`. (189 lines)
- [Hover Trigger Rules for @wix/interact](https://wix.github.io/interact/rules/hover.md): This document contains rules for generating hover-triggered interactions in `@wix/interact`. (191 lines)
- [PointerMove Trigger Rules for @wix/interact](https://wix.github.io/interact/rules/pointermove.md): These rules help generate pointer-driven interactions using `@wix/interact`. (279 lines)
- [ViewEnter Trigger Rules for @wix/interact](https://wix.github.io/interact/rules/viewenter.md): This document contains rules for generating interactions that respond to elements entering the viewport using the `@wix/interact`. (226 lines)
- [ViewProgress Trigger Rules for @wix/interact](https://wix.github.io/interact/rules/viewprogress.md): These rules help generate scroll-driven interactions using `@wix/interact`. (196 lines)
- [All rules in one file](https://wix.github.io/interact/llms-full.txt): Complete concatenation (2386 lines)

llms-full.txt header

# @wix/interact v2.4.0 -- AI Rules Reference
# https://wix.github.io/interact/llms.txt
# 8 files, 2386 lines

Download full files from workflow artifacts, or run node scripts/generate-llms.mjs locally.

ydaniv · 2026-06-01T17:45:50Z

I think it's important we don't build that as part of the library.
It adds dependencies, and it will add bloat. We can't count on users just picking what they need and tree-shake it.
Usually users will import from CDN, or just import the library as-is.
And also tools that check the build size will show a much larger size which reflects bad visually.

…debug_config_validate

ydaniv · 2026-06-24T11:27:13Z

+    },
+    sourcemap: true,
+    rollupOptions: {
+      external: ['zod', '@wix/interact'],


Is it correct to have Zod as external? So it's not bundled with the validate package?

ydaniv · 2026-06-24T11:29:08Z

+{
+  "name": "@wix/interact-validate",
+  "version": "1.0.0",
+  "description": "Schema + referential + semantic validation for @wix/interact's InteractConfig, powered by zod.",


I think we can drop the "powered by zod" part

ydaniv · 2026-06-24T11:38:26Z

+  'viewProgress',
+  'pointerMove',
+  'animationEnd',
+  'pageVisible',


This is currently Wix-only. Should we keep it here?

ydaniv · 2026-06-24T11:41:11Z

+    trigger: z.enum(['viewEnter', 'pageVisible']),
+    params: ViewEnterParams.optional(),


pageVisible, besides being Wix-only, is a wrapper above viewEnter + triggerType: 'state', which is now on the effect. It's becoming somewhat problematic to keep.

ydaniv · 2026-06-24T15:19:50Z

 const DOCS_LINK_TITLES = new Map([
  ['full-lean.md', 'Full Reference'],
  ['integration.md', 'Integration Guide'],
+  ['validate.md', 'Validation Guide'],


Do we really need this doc concatenated inside the llms.txt?

ydaniv · 2026-06-24T15:22:10Z

+  INVALID_MEDIA_QUERY: 'VALID_MEDIA_QUERIES',
+};
+
+function finalize(errors: ValidationError[], options: ValidateOptions = {}): ValidationResult {


nit: maybe move all this code into a separate file and have the index just import/export?

ydaniv · 2026-06-24T15:24:01Z

+  result.sort((a, b) => {
+    const pa = a.path.join('\0');
+    const pb = b.path.join('\0');
+    return pa < pb ? -1 : pa > pb ? 1 : 0;


What are we comparing here? Length of string? Or do these strings represent numbers?

ydaniv · 2026-06-24T15:30:33Z

+
+Rules for using `@wix/interact-validate` — validate an `InteractConfig` before it reaches the runtime.
+
+`@wix/interact-validate` is a standalone, zod-powered validator for the `@wix/interact` `InteractConfig` shape. It runs **statically** (no DOM, no browser, no runtime), so it is safe in build tools, CI, and server-side code. It is a separate package from `@wix/interact` and declares `@wix/interact` as a peer dependency (`^2.4.0`) — its config types come from there, so the two never drift.


Not sure it's safe to have a version inside the doc:

Suggested change

`@wix/interact-validate` is a standalone, zod-powered validator for the `@wix/interact` `InteractConfig` shape. It runs **statically** (no DOM, no browser, no runtime), so it is safe in build tools, CI, and server-side code. It is a separate package from `@wix/interact` and declares `@wix/interact` as a peer dependency (`^2.4.0`) — its config types come from there, so the two never drift.

`@wix/interact-validate` is a standalone, zod-powered validator for the `@wix/interact` `InteractConfig` shape. It runs **statically** (no DOM, no browser, no runtime), so it is safe in build tools, CI, and server-side code.

ydaniv · 2026-06-24T15:37:14Z

+npm install @wix/interact-validate
+```
+
+`@wix/interact` is a **peer dependency** (`^2.4.0`) — the config types come from there, so the validator never drifts from the runtime shape. `zod` (`^4`) is a regular dependency.


Let's remove the version from the doc, it's already part of same repo, they should be progressing together anyhow.

ameerf-wix added 5 commits June 1, 2026 16:29

copying files + adding plan to integrate

340031a

basic setup of validate sub-path

371deff

updating deps

9c2834b

Merge branch 'debug_config_validate' of github.com:wix/interact into …

06b56f2

…debug_config_validate

updating plan's todo

0f02ad2

ameerf-wix added 4 commits June 1, 2026 17:42

phase 1

e17c2cc

lint

234b246

lint

8d9c089

phases 2 + 3

bf4c582

ameerf-wix added 19 commits June 1, 2026 23:18

phases 4

6cc5836

phases 4

8cbe19f

phase 5

48eaccd

tests revealed fix

80f80ac

moving to a different package

4c858ff

yarn install

433dc0c

Merge branch 'debug_config_validate' of github.com:wix/interact into …

210d099

…debug_config_validate

fixing build

bf49eee

Merge branch 'master' into debug_config_validate

28e232c

predicate is required

f800425

Merge branch 'debug_config_validate' of github.com:wix/interact into …

a9540a0

…debug_config_validate

fixing predicate

4d46fc2

fixing predicate

91b3b9b

fixing predicate

c0a9a23

animationEnd fix

4444ea1

no real need for factory

a165109

triggerEffectCompatible

ff5c541

triggerEffectCompatible

c39bf43

schema fixes

20aab92

ameerf-wix added 5 commits June 10, 2026 13:31

validation severity logic fixes

18fb0fd

context building fix

a8d89eb

context building fix

76f899a

refactor

c328cd1

final touches

56d5274

ameerf-wix marked this pull request as ready for review June 18, 2026 12:52

ameerf-wix added 5 commits June 18, 2026 15:53

final touches

bb25265

final touches

0a8246d

final touches

3721d07

documentation and rules

c33fc9d

Merge branch 'master' into debug_config_validate

41146fa

ydaniv requested changes Jun 24, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Debug config validate#238

Debug config validate#238
ameerf-wix wants to merge 38 commits into
masterfrom
debug_config_validate

ameerf-wix commented Jun 1, 2026

Uh oh!

github-actions Bot commented Jun 1, 2026 •

edited

Loading

Uh oh!

ydaniv commented Jun 1, 2026

Uh oh!

ydaniv Jun 24, 2026

Uh oh!

ydaniv Jun 24, 2026

Uh oh!

ydaniv Jun 24, 2026

Uh oh!

ydaniv Jun 24, 2026

Uh oh!

ydaniv Jun 24, 2026

Uh oh!

ydaniv Jun 24, 2026

Uh oh!

ydaniv Jun 24, 2026

Uh oh!

ydaniv Jun 24, 2026

Uh oh!

ydaniv Jun 24, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		trigger: z.enum(['viewEnter', 'pageVisible']),
		params: ViewEnterParams.optional(),


		Rules for using `@wix/interact-validate` — validate an `InteractConfig` before it reaches the runtime.

		`@wix/interact-validate` is a standalone, zod-powered validator for the `@wix/interact` `InteractConfig` shape. It runs statically (no DOM, no browser, no runtime), so it is safe in build tools, CI, and server-side code. It is a separate package from `@wix/interact` and declares `@wix/interact` as a peer dependency (`^2.4.0`) — its config types come from there, so the two never drift.

Uh oh!

Conversation

ameerf-wix commented Jun 1, 2026

Description

Related Issue

Checklist

Screenshots / Demos

Additional Notes

Uh oh!

github-actions Bot commented Jun 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Generated llms.txt preview

Uh oh!

ydaniv commented Jun 1, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

github-actions Bot commented Jun 1, 2026 •

edited

Loading

Generated `llms.txt` preview