@proto-labs-inc/wire 0.2.0 → 0.2.2

package/dist/index.d.ts

@@ -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;
@@ -123,6 +125,16 @@ export declare const ELEMENT_STYLE_PROPERTIES: readonly ["color", "background-co
 export type ElementStyleProperty = typeof ELEMENT_STYLE_PROPERTIES[number];
 export type ElementStyles = Partial<Record<ElementStyleProperty, string>>;
 export type FrameToRig = {
+    type: "set-edit-markers";
+    markers: {
+        selector: string;
+        number: number;
+        point?: {
+            x: number;
+            y: number;
+        };
+    }[];
+} | {
     type: "set-state";
     id: string;
 } | {
@@ -135,15 +147,13 @@ export type FrameToRig = {
 } | {
     type: "focus-target";
     selector: string | null;
+    visibility?: "always" | "if-outside-viewport";
 } | {
     type: "measure-target";
     selector: string;
 } | {
     type: "set-comment-mode";
     on: boolean;
-} | {
-    type: "capture-comment";
-    requestId: string;
 } | {
     type: "set-variant-set-picker";
     on: boolean;
@@ -157,6 +167,17 @@ export type FrameToRig = {
 } | {
     type: "release-element";
     selectionId: string;
+} | {
+    type: "restore-selection";
+    selector: string;
+    anchor: CommentAnchor;
+    kind: "element";
+    selectionId: string;
+} | {
+    type: "restore-selection";
+    selector: string;
+    anchor: CommentAnchor;
+    kind: "comment" | "variantSet";
 };
 export interface CommentAnchor {
     /** Bounds of the selected component in the prototype viewport. */
@@ -184,17 +205,6 @@ export type RigToFrame = {
     selector: string;
     /** Used by the Frame to place the composer beside the selection. */
     anchor: CommentAnchor;
-} | {
-    type: "comment-capture";
-    /** 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;
-    /** The requestId of the capture-comment this answers. */
-    requestId: string;
-    /** Used by the Frame to place the composer beside the selection. */
-    anchor: CommentAnchor;
 } | {
     type: "thumbnail-capture";
     /** Image data URL of the current viewport, or null when capture failed. */
@@ -221,6 +231,11 @@ export type RigToFrame = {
     type: "variant-set-picker-exited";
 } | {
     type: "element-target-picked";
+    /** Click position as fractions of the selected element bounds. */
+    point?: {
+        x: number;
+        y: number;
+    };
     inspection?: {
         selectionId: string;
         styles: ElementStyles;

package/dist/index.js

@@ -55,6 +55,18 @@ export function isFrameToRig(d) {
     if (typeof d !== "object" || d === null)
         return false;
     const message = d;
+    if (message.type === "set-edit-markers") {
+        const markers = d.markers;
+        return Array.isArray(markers) && markers.every(marker => marker && typeof marker.selector === "string" && Number.isSafeInteger(marker.number) && marker.number > 0 &&
+            (marker.point === undefined || (marker.point && [marker.point.x, marker.point.y].every(value => typeof value === "number" && Number.isFinite(value) && value >= 0 && value <= 1))));
+    }
+    if (message.type === "restore-selection") {
+        const anchor = message.anchor;
+        return typeof message.selector === "string" && typeof anchor === "object" && anchor !== null &&
+            [anchor.x, anchor.y, anchor.width, anchor.height].every(value => typeof value === "number" && Number.isFinite(value)) &&
+            (message.kind === "comment" || message.kind === "variantSet" ||
+                (message.kind === "element" && typeof message.selectionId === "string"));
+    }
     if (message.type === "release-element")
         return typeof message.selectionId === "string";
     if (message.type === "preview-element-styles") {
@@ -67,10 +79,10 @@ export function isFrameToRig(d) {
         (t === "set-theme" &&
             (message.theme === "light" || message.theme === "dark")) ||
         t === "set-variant" ||
-        (t === "focus-target" && (message.selector === null || typeof message.selector === "string")) ||
+        (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" ||
         t === "set-element-picker");
 }
@@ -79,7 +91,7 @@ export function isRigToFrame(d) {
         return false;
     const message = d;
     const t = message.type;
-    if (["comment-target-picked", "comment-capture", "variant-set-target-picked", "target-measured"].includes(t)) {
+    if (["comment-target-picked", "variant-set-target-picked", "target-measured"].includes(t)) {
         return typeof message.selector === "string";
     }
     return ((t === "frame-tools-status" && ["loading", "ready", "unavailable"].includes(message.status)) ||

package/package.json

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