@proto-labs-inc/wire 0.1.1 → 0.2.1

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export declare const PROTOCOL_VERSION = 2;
+export declare const PROTOCOL_VERSION = 3;
 export type ResolvedPreviewTheme = "light" | "dark";
 export interface StateDef {
     id: string;
@@ -48,6 +48,8 @@ export interface VariantDef {
     reference?: VariantLink;
 }
 export interface ReferenceDef {
+    /** Aggregator that supplied the reference, independent of its destination URL. */
+    source?: "mobbin" | "refero" | "nicelydone" | "landingfolio" | "recent";
     app: string;
     url: string;
     note?: string;
@@ -88,6 +90,8 @@ export interface VariantSetDef {
 }
 export interface Manifest {
     schemaVersion: 2;
+    /** Trusted Frame app origin, configured by the workspace owner. */
+    frameOrigin?: string;
     /** the slug */
     name: string;
     port: number;
@@ -132,10 +136,11 @@ export type FrameToRig = {
     variant: string;
 } | {
     type: "focus-target";
-    id: string | null;
+    selector: string | null;
+    visibility?: "always" | "if-outside-viewport";
 } | {
     type: "measure-target";
-    id: string;
+    selector: string;
 } | {
     type: "set-comment-mode";
     on: boolean;
@@ -164,6 +169,9 @@ export interface CommentAnchor {
     height: number;
 }
 export type RigToFrame = {
+    type: "frame-tools-status";
+    status: "loading" | "ready" | "unavailable";
+} | {
     type: "hello";
     protocolVersion: number;
     rigVersion: string;
@@ -175,14 +183,14 @@ export type RigToFrame = {
     search: string;
 } | {
     type: "comment-target-picked";
-    /** the clicked [data-proto-id], if the click landed on a marked component */
-    targetId: string | null;
+    /** CSS selector for the exact selected element. */
+    selector: string;
     /** Used by the Frame to place the composer beside the selection. */
     anchor: CommentAnchor;
 } | {
     type: "comment-capture";
-    /** the clicked [data-proto-id], if the click landed on a marked component */
-    targetId: string | null;
+    /** CSS selector for the exact selected element. */
+    selector: string;
     /** PNG data URL with the highlight composited in; null if capture failed
         (e.g. modern-screenshot not installed) — the comment still works */
     image: string | null;
@@ -204,12 +212,12 @@ export type RigToFrame = {
     type: "target-focus-dismissed";
 } | {
     type: "target-measured";
-    targetId: string;
-    /** Null when no matching registered component exists in the current state. */
+    selector: string;
+    /** Null when no matching element exists in the current state. */
     anchor: CommentAnchor | null;
 } | {
     type: "variant-set-target-picked";
-    targetId: string;
+    selector: string;
     /** Used by the Frame to place the variant-set brief beside the selection. */
     anchor: CommentAnchor;
 } | {

package/dist/index.js

@@ -1,4 +1,4 @@
-export const PROTOCOL_VERSION = 2;
+export const PROTOCOL_VERSION = 3;
 // ─── URL param conventions ─────────────────────────────────────────
 export const STATE_PARAM = "state";
 export const variantParam = (component) => `v.${component}`;
@@ -67,8 +67,9 @@ export function isFrameToRig(d) {
         (t === "set-theme" &&
             (message.theme === "light" || message.theme === "dark")) ||
         t === "set-variant" ||
-        t === "focus-target" ||
-        t === "measure-target" ||
+        (t === "focus-target" && (message.selector === null || typeof message.selector === "string") &&
+            (message.visibility === undefined || message.visibility === "always" || message.visibility === "if-outside-viewport")) ||
+        (t === "measure-target" && typeof message.selector === "string") ||
         t === "set-comment-mode" ||
         t === "capture-comment" ||
         t === "set-variant-set-picker" ||
@@ -77,16 +78,17 @@ export function isFrameToRig(d) {
 export function isRigToFrame(d) {
     if (typeof d !== "object" || d === null)
         return false;
-    const t = d.type;
-    return (t === "hello" ||
+    const message = d;
+    const t = message.type;
+    if (["comment-target-picked", "comment-capture", "variant-set-target-picked", "target-measured"].includes(t)) {
+        return typeof message.selector === "string";
+    }
+    return ((t === "frame-tools-status" && ["loading", "ready", "unavailable"].includes(message.status)) ||
+        t === "hello" ||
         t === "state-changed" ||
-        t === "comment-target-picked" ||
-        t === "comment-capture" ||
         t === "thumbnail-capture" ||
         t === "comment-mode-exited" ||
         t === "target-focus-dismissed" ||
-        t === "target-measured" ||
-        t === "variant-set-target-picked" ||
         t === "variant-set-picker-exited" ||
         t === "element-preview-bounds" ||
         t === "element-target-picked" ||

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@proto-labs-inc/wire",
-  "version": "0.1.1",
+  "version": "0.2.1",
   "description": "The typed contract between Proto's Frame and the rig inside a prototype: bridge messages and the prototype.json schema.",
   "license": "MIT",
   "repository": {