@vcp-dev/site-edit-bridge 0.3.14

package/dist/window-message.d.ts

@@ -0,0 +1,337 @@
+import type { SiteEditCommandSuccess, SiteEditEvent, SiteEditObjectEditContext, SiteEditObjectSummary, SiteEditGetClassNameSourceCommandResult, SiteEditOperationCommandResult, SiteEditOperationRequest, SiteEditRenderDocument } from "@vcp-dev/contracts";
+export declare const VCP_WINDOW_MESSAGE_SOURCE = "vcp-window-message";
+export declare const VCP_WINDOW_MESSAGE_VERSION = 1;
+export type VcpWindowMessageEnvelope<TNamespace extends string = string, TChannel extends string = string, TBody = unknown> = {
+    source: typeof VCP_WINDOW_MESSAGE_SOURCE;
+    version: typeof VCP_WINDOW_MESSAGE_VERSION;
+    namespace: TNamespace;
+    channel: TChannel;
+    sessionKey?: string;
+    body: TBody;
+};
+export declare function createVcpWindowMessageEnvelope<TNamespace extends string, TChannel extends string, TBody>(input: {
+    namespace: TNamespace;
+    channel: TChannel;
+    body: TBody;
+    sessionKey?: string;
+}): VcpWindowMessageEnvelope<TNamespace, TChannel, TBody>;
+export declare function isVcpWindowMessageEnvelope(value: unknown): value is VcpWindowMessageEnvelope;
+export declare const SITE_EDIT_WINDOW_MESSAGE_NAMESPACE = "site-edit";
+export declare const SITE_EDIT_FRAME_RUNTIME_CHANNEL = "frame-runtime";
+export type SiteEditFrameRuntimeRef = {
+    key: string;
+    instanceIndex?: number;
+    instanceCount?: number;
+    textSegmentIndex?: number;
+};
+export type SiteEditFrameRuntimeStarted = {
+    ref: SiteEditFrameRuntimeRef;
+};
+export type SiteEditFrameRuntimeHitDetailLevel = "summary" | "full";
+export type SiteEditFrameRuntimeScrollMetrics = {
+    scrollX: number;
+    scrollY: number;
+    scrollWidth: number;
+    scrollHeight: number;
+    viewportWidth: number;
+    viewportHeight: number;
+};
+export type SiteEditFrameRuntimePointerEventKind = "pointer-down" | "pointer-move" | "pointer-up" | "pointer-cancel" | "pointer-click" | "pointer-double-click";
+export type SiteEditFrameRuntimeNodePatch = {
+    attributes?: Record<string, string | null>;
+    className?: string;
+    style?: Record<string, string | number | null | undefined>;
+};
+export type SiteEditFrameRuntimeNodePatchPreviewMeta = {
+    sessionId: string;
+    revision: number;
+    responseDetail?: "none" | "summary" | "full";
+};
+export type SiteEditFrameRuntimeNodePatchAck = {
+    applied: boolean;
+    appliedRevision?: number;
+    stale?: boolean;
+    duplicate?: boolean;
+    latestRevision?: number;
+};
+/**
+ * Theme try-on override applied in the preview frame without writing files.
+ * A second set replaces the previous override entirely.
+ */
+export type SiteEditFrameRuntimeThemeOverride = {
+    /** CSS custom properties applied to the document element; non `--` keys are ignored. */
+    variables: Record<string, string>;
+    /** Stylesheet hrefs injected as `link[data-vcp-theme-preview]` elements, deduped by href. */
+    stylesheets?: string[];
+};
+export type SiteEditFrameRuntimeDropRelation = "before" | "after" | "append" | "prepend" | "none";
+export type SiteEditFrameRuntimeDropRejectionReason = "no-editable-hit" | "no-accepting-parent" | "self-or-descendant" | "operation-boundary-blocked";
+export type SiteEditFrameRuntimeDropTarget = {
+    anchorHit: SiteEditFrameRuntimeHit | null;
+    targetParentHit: SiteEditFrameRuntimeHit | null;
+    relation: SiteEditFrameRuntimeDropRelation;
+    indicatorOrientation?: "horizontal" | "vertical";
+    indicatorBounds?: {
+        top: number;
+        left: number;
+        width: number;
+        height: number;
+    };
+    rejectionReason?: SiteEditFrameRuntimeDropRejectionReason;
+};
+export type SiteEditFrameRuntimeRequestBody = {
+    type: "request";
+    id: string;
+    kind: "hit-test-at-point" | "start-text-edit-at-point";
+    payload: {
+        x: number;
+        y: number;
+        detailLevel?: SiteEditFrameRuntimeHitDetailLevel;
+    };
+} | {
+    type: "request";
+    id: string;
+    kind: "get-scroll-metrics";
+    payload: Record<string, never>;
+} | {
+    type: "request";
+    id: string;
+    kind: "scroll-to";
+    payload: {
+        x: number;
+        y: number;
+    };
+} | {
+    type: "request";
+    id: string;
+    kind: "scroll-by";
+    payload: {
+        deltaX: number;
+        deltaY: number;
+    };
+} | {
+    type: "request";
+    id: string;
+    kind: "set-interaction-mode";
+    payload: {
+        enabled: boolean;
+    };
+} | {
+    type: "request";
+    id: string;
+    kind: "set-theme-override";
+    payload: SiteEditFrameRuntimeThemeOverride;
+} | {
+    type: "request";
+    id: string;
+    kind: "clear-theme-override";
+    payload: Record<string, never>;
+} | {
+    type: "request";
+    id: string;
+    kind: "get-theme-variables";
+    payload: {
+        names: string[];
+    };
+} | {
+    type: "request";
+    id: string;
+    kind: "compute-drop-target-at-point";
+    payload: {
+        x: number;
+        y: number;
+        dragKind: "insert" | "move";
+        movingRef?: SiteEditFrameRuntimeRef;
+    };
+} | {
+    type: "request";
+    id: string;
+    kind: "observe-node-bounds" | "clear-node-bounds-observer";
+    payload: {
+        ref?: SiteEditFrameRuntimeRef;
+    };
+} | {
+    type: "request";
+    id: string;
+    kind: "apply-node-patch";
+    payload: {
+        ref: SiteEditFrameRuntimeRef;
+        patch: SiteEditFrameRuntimeNodePatch;
+        preview?: SiteEditFrameRuntimeNodePatchPreviewMeta;
+    };
+} | {
+    type: "request";
+    id: string;
+    kind: "get-hit-by-ref" | "get-path-by-ref";
+    payload: {
+        ref: SiteEditFrameRuntimeRef;
+    };
+} | {
+    type: "request";
+    id: string;
+    kind: "bridge-get-document" | "bridge-ensure-document-version";
+    payload: {
+        routeId: string;
+        minVersion?: number;
+    };
+} | {
+    type: "request";
+    id: string;
+    kind: "bridge-get-object-summary" | "bridge-get-object-edit-context" | "bridge-get-class-name-source";
+    payload: {
+        key: string;
+        routeId?: string;
+    };
+} | {
+    type: "request";
+    id: string;
+    kind: "bridge-execute";
+    payload: {
+        request: SiteEditOperationRequest;
+    };
+} | {
+    type: "request";
+    id: string;
+    kind: "bridge-undo" | "bridge-redo";
+    payload: Record<string, never>;
+} | {
+    type: "request";
+    id: string;
+    kind: "bridge-subscribe" | "bridge-unsubscribe";
+    payload: {
+        subscriptionId: string;
+    };
+};
+export type SiteEditFrameRuntimeSpacing = {
+    marginTop: number;
+    marginRight: number;
+    marginBottom: number;
+    marginLeft: number;
+    paddingTop: number;
+    paddingRight: number;
+    paddingBottom: number;
+    paddingLeft: number;
+    borderTopWidth: number;
+    borderRightWidth: number;
+    borderBottomWidth: number;
+    borderLeftWidth: number;
+    columnGap: number;
+    rowGap: number;
+};
+export type SiteEditFrameRuntimeRect = {
+    top: number;
+    left: number;
+    width: number;
+    height: number;
+};
+export type SiteEditFrameRuntimeHit = {
+    ref: SiteEditFrameRuntimeRef;
+    key: string;
+    detailLevel: SiteEditFrameRuntimeHitDetailLevel;
+    tagName: string;
+    sourceKind?: string;
+    componentName?: string;
+    sourceFile?: string;
+    parentKey?: string;
+    textPreview?: string;
+    dataset?: Record<string, string>;
+    attributes?: Record<string, string>;
+    runtimeFlags: {
+        selectable: boolean;
+        movable: boolean;
+        removable: boolean;
+        textEditable: boolean;
+        container: boolean;
+    };
+    layout?: {
+        display: string;
+        flexDirection?: string;
+        gridAutoFlow?: string;
+        indicatorOrientation: "horizontal" | "vertical";
+    };
+    rect: SiteEditFrameRuntimeRect;
+    childRects?: SiteEditFrameRuntimeRect[];
+    spacing?: SiteEditFrameRuntimeSpacing;
+};
+export type SiteEditFrameRuntimeResponseBody = {
+    type: "response";
+    id: string;
+    ok: boolean;
+    result?: SiteEditFrameRuntimeStarted | SiteEditFrameRuntimeHit | SiteEditFrameRuntimeNodePatchAck | SiteEditFrameRuntimeHit[] | SiteEditFrameRuntimeDropTarget | SiteEditFrameRuntimeScrollMetrics | SiteEditCommandSuccess<SiteEditRenderDocument> | SiteEditCommandSuccess<SiteEditObjectSummary> | SiteEditCommandSuccess<SiteEditObjectEditContext> | SiteEditGetClassNameSourceCommandResult | SiteEditOperationCommandResult | (SiteEditFrameRuntimeScrollMetrics & {
+        scrolled: true;
+    }) | {
+        interactionEnabled: boolean;
+    } | {
+        themeOverrideApplied: true;
+    } | {
+        themeOverrideCleared: true;
+    } | Record<string, string> | {
+        subscribed: true;
+    } | {
+        unsubscribed: true;
+    } | {
+        observing: true;
+    } | {
+        cleared: true;
+    };
+    error?: string;
+};
+export type SiteEditFrameRuntimeEventBody = {
+    type: "event";
+    kind: "text-edit-commit" | "text-edit-cancel" | "text-edit-exit" | "text-edit-input";
+    payload: {
+        ref: SiteEditFrameRuntimeRef;
+        value?: string;
+        hit?: SiteEditFrameRuntimeHit;
+    };
+} | {
+    type: "event";
+    kind: "node-bounds-change";
+    payload: {
+        hit: SiteEditFrameRuntimeHit;
+    };
+} | {
+    type: "event";
+    kind: "bridge-event";
+    payload: {
+        subscriptionId: string;
+        event: SiteEditEvent;
+    };
+} | {
+    type: "event";
+    kind: SiteEditFrameRuntimePointerEventKind;
+    payload: {
+        clientX: number;
+        clientY: number;
+        buttons?: number;
+        hit: SiteEditFrameRuntimeHit | null;
+    };
+} | {
+    type: "event";
+    kind: "route-ready";
+    payload: {
+        routeId: string;
+        version?: number;
+    };
+} | {
+    type: "event";
+    kind: "scroll";
+    payload: {
+        metrics: SiteEditFrameRuntimeScrollMetrics;
+    };
+};
+export type SiteEditFrameRuntimeBody = SiteEditFrameRuntimeRequestBody | SiteEditFrameRuntimeResponseBody | SiteEditFrameRuntimeEventBody;
+export type SiteEditFrameRuntimeMessage = VcpWindowMessageEnvelope<typeof SITE_EDIT_WINDOW_MESSAGE_NAMESPACE, typeof SITE_EDIT_FRAME_RUNTIME_CHANNEL, SiteEditFrameRuntimeBody>;
+export type SiteEditFrameRuntimeRequestMessage = SiteEditFrameRuntimeMessage & {
+    body: SiteEditFrameRuntimeRequestBody;
+};
+export type SiteEditFrameRuntimeResponseMessage = SiteEditFrameRuntimeMessage & {
+    body: SiteEditFrameRuntimeResponseBody;
+};
+export type SiteEditFrameRuntimeEventMessage = SiteEditFrameRuntimeMessage & {
+    body: SiteEditFrameRuntimeEventBody;
+};
+export declare function createSiteEditFrameRuntimeMessage(body: SiteEditFrameRuntimeBody, options?: {
+    sessionKey?: string;
+}): SiteEditFrameRuntimeMessage;
+export declare function isSiteEditFrameRuntimeMessage(value: unknown): value is SiteEditFrameRuntimeMessage;

package/dist/window-message.js

@@ -0,0 +1 @@
+var s="vcp-window-message",i=1;function r(e){return{source:s,version:1,namespace:e.namespace,channel:e.channel,...e.sessionKey?{sessionKey:e.sessionKey}:{},body:e.body}}function c(e){if(typeof e!="object"||e===null)return!1;let n=e;return n.source===s&&n.version===1&&typeof n.namespace=="string"&&typeof n.channel=="string"&&"body"in n}var o="site-edit",t="frame-runtime";function E(e,n={}){return r({namespace:o,channel:t,sessionKey:n.sessionKey,body:e})}function a(e){return!c(e)||e.namespace!==o||e.channel!==t?!1:typeof e.body?.type=="string"}export{t as SITE_EDIT_FRAME_RUNTIME_CHANNEL,o as SITE_EDIT_WINDOW_MESSAGE_NAMESPACE,s as VCP_WINDOW_MESSAGE_SOURCE,i as VCP_WINDOW_MESSAGE_VERSION,E as createSiteEditFrameRuntimeMessage,r as createVcpWindowMessageEnvelope,a as isSiteEditFrameRuntimeMessage,c as isVcpWindowMessageEnvelope};

package/package.json

@@ -0,0 +1,87 @@
+{
+  "name": "@vcp-dev/site-edit-bridge",
+  "version": "0.3.14",
+  "type": "module",
+  "license": "UNLICENSED",
+  "repository": {
+    "type": "git",
+    "url": "git+https://gitlab.cedemo.cn/vibe-coding-platform/vcp.git"
+  },
+  "homepage": "https://gitlab.cedemo.cn/vibe-coding-platform/vcp",
+  "bugs": {
+    "url": "https://gitlab.cedemo.cn/vibe-coding-platform/vcp/-/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "bin": {
+    "vcp-site-edit-next-dev-server": "dist/start-next-dev-server.js"
+  },
+  "exports": {
+    ".": {
+      "development": "./src/index.ts",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./client": {
+      "development": "./src/client.ts",
+      "types": "./dist/client.d.ts",
+      "default": "./dist/client.js"
+    },
+    "./auto-bootstrap": {
+      "development": "./src/auto-bootstrap.ts",
+      "types": "./dist/auto-bootstrap.d.ts",
+      "default": "./dist/auto-bootstrap.js"
+    },
+    "./document-codec": {
+      "development": "./src/document-codec.ts",
+      "types": "./dist/document-codec.d.ts",
+      "default": "./dist/document-codec.js"
+    },
+    "./designer-trace": {
+      "development": "./src/designer-trace.ts",
+      "types": "./dist/designer-trace.d.ts",
+      "default": "./dist/designer-trace.js"
+    },
+    "./window-message": {
+      "development": "./src/window-message.ts",
+      "types": "./dist/window-message.d.ts",
+      "default": "./dist/window-message.js"
+    },
+    "./server": {
+      "development": "./src/server.ts",
+      "types": "./dist/server.d.ts",
+      "default": "./dist/server.js"
+    },
+    "./next-dev-server": {
+      "development": "./src/next-dev-server.ts",
+      "types": "./dist/next-dev-server.d.ts",
+      "default": "./dist/next-dev-server.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=24.0.0"
+  },
+  "scripts": {
+    "build": "pnpm --dir ../contracts build && pnpm --dir ../site-edit-engine build && node -e \"require('node:fs').rmSync('dist', { recursive: true, force: true })\" && tsc -p tsconfig.build.json",
+    "test": "vitest run --root ../.. packages/site-edit-bridge/src",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
+  },
+  "dependencies": {
+    "@vcp-dev/contracts": "0.3.14",
+    "@vcp-dev/site-edit-engine": "0.3.14",
+    "@types/ws": "^8.18.1",
+    "ws": "^8.20.1"
+  },
+  "devDependencies": {
+    "@types/node": "^24.0.0",
+    "typescript": "^5.8.0",
+    "vitest": "^3.2.0"
+  }
+}