@saywright/vite 0.0.0-stage → 0.1.0

package/dist/protocol.js

@@ -0,0 +1,64 @@
+//#region src/protocol.ts
+/**
+* Message protocol between the Saywright studio (parent window) and the
+* bridge running inside the target app (iframe). Both sides check `ns` and the
+* message source before trusting anything.
+*/
+var NS = "saywright";
+/**
+* The plugin in an app and the studio are updated separately, so each side
+* says which version of this protocol it speaks (`v`, in hello and ready) and
+* the oldest of the other side's it still works with (`oldest`). Raise
+* PROTOCOL_VERSION when a message changes in a way an older side can't follow,
+* and OLDEST_PROTOCOL when this side stops understanding an older one; adding
+* a message or an optional field needs neither (unknown ones are ignored).
+*/
+var PROTOCOL_VERSION = 1;
+var OLDEST_PROTOCOL = 1;
+/** Which side has to be updated for a studio and an app's bridge to work together: the app's plugin, the studio, or neither. */
+function outdated(studio, bridge) {
+	if (bridge.v < (studio.oldest ?? studio.v)) return "plugin";
+	if (studio.v < (bridge.oldest ?? bridge.v)) return "studio";
+	return null;
+}
+/** Where the studio runs unless told otherwise. Not 5173: that is Vite's own default, where your app likely runs. */
+var STUDIO_PORT = 7357;
+var STUDIO_URL = `http://localhost:${STUDIO_PORT}`;
+/** Attribute names injected by the Vite plugin at compile time. */
+var SRC_ATTR = "data-ds-src";
+var NAME_ATTR = "data-ds-name";
+function isStudioMessage(data) {
+	return !!data && typeof data === "object" && data.ns === "saywright" && typeof data.type === "string";
+}
+var JS_ESCAPES = {
+	"\\": "\\\\",
+	"'": "\\'",
+	"\n": "\\n",
+	"\r": "\\r",
+	"\u2028": "\\u2028",
+	"\u2029": "\\u2029"
+};
+/**
+* Text from a page as a single-quoted JavaScript string, for the locators and
+* tests Saywright writes: quotes, backslashes and every kind of line break are
+* escaped, so no text can end the string or the line it is on.
+*/
+function jsString(s) {
+	return `'${s.replace(/[\\'\n\r\u2028\u2029]/g, (c) => JS_ESCAPES[c])}'`;
+}
+/** Text from a page in a `//` comment: on one line, whatever line breaks it had. */
+function jsComment(s) {
+	return s.replace(/[\r\n\u2028\u2029]+/g, " ");
+}
+/** Parse "path/to/File.tsx:12:5" into parts. Paths may contain colons on Windows drive letters, so split from the right. */
+function parseSrc(src) {
+	const m = /^(.*):(\d+):(\d+)$/.exec(src);
+	if (!m) return null;
+	return {
+		file: m[1],
+		line: Number(m[2]),
+		col: Number(m[3])
+	};
+}
+//#endregion
+export { NAME_ATTR, NS, OLDEST_PROTOCOL, PROTOCOL_VERSION, SRC_ATTR, STUDIO_PORT, STUDIO_URL, isStudioMessage, jsComment, jsString, outdated, parseSrc };

package/package.json

@@ -1,6 +1,67 @@
 {
   "name": "@saywright/vite",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Vite plugin for Saywright: traces every element of your running React app to its file and line, so you can point at it and say what to change. Dev server only.",
+  "keywords": [
+    "vite",
+    "vite-plugin",
+    "react",
+    "saywright",
+    "click-to-source",
+    "click-to-component",
+    "open-in-editor",
+    "source-location",
+    "developer-tools",
+    "devtools",
+    "visual-editing"
+  ],
+  "license": "Apache-2.0",
+  "homepage": "https://github.com/ahmedbakr/saywright/tree/main/packages/vite#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ahmedbakr/saywright.git",
+    "directory": "packages/vite"
+  },
+  "bugs": "https://github.com/ahmedbakr/saywright/issues",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./types/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./protocol": {
+      "source": "./src/protocol.ts",
+      "types": "./dist/protocol.d.ts",
+      "default": "./dist/protocol.js"
+    },
+    "./client": {
+      "source": "./src/client/index.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "types",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": "^22.18.0 || >=24.11.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "node build.mjs",
+    "prepack": "node build.mjs",
+    "typecheck": "tsc -p tsconfig.json"
+  },
+  "dependencies": {
+    "@babel/parser": "^8.0.7",
+    "magic-string": "^1.4.3"
+  },
+  "peerDependencies": {
+    "vite": ">=4"
+  }
+}

package/types/index.d.ts

@@ -0,0 +1,18 @@
+import type { Plugin } from 'vite';
+
+export interface SaywrightOptions {
+  /** Files to annotate. Default: .jsx and .tsx files. */
+  include?: RegExp;
+  /** Files to skip. Default: node_modules. */
+  exclude?: RegExp;
+  /** Extra studio origins allowed to talk to the bridge (the studio that announced itself, or the default address, always is). */
+  studioOrigins?: string[];
+  /** Where the studio runs. Default: what the studio announces when it starts, else http://localhost:7357. */
+  studio?: string;
+  /** Show the test-session recorder when the app is open in its own tab. Default: true. */
+  widget?: boolean;
+}
+
+/** Makes a Vite + React app pointable from Saywright (dev server only). */
+export default function saywright(options?: SaywrightOptions): Plugin;
+export { saywright };