Sanity Library Reference Docs
    Preparing search index...
    VisualEditingNodeMsg:
        | { data: SanityNode
        | SanityStegaNode; type: "visual-editing/focus" }
        | { data: SanityNode | SanityStegaNode; type: "overlay/focus" }
        | { data: HistoryUpdate; type: "visual-editing/navigate" }
        | { data: HistoryUpdate; type: "overlay/navigate" }
        | { data: { enabled: boolean }; type: "visual-editing/toggle" }
        | { data: { enabled: boolean }; type: "overlay/toggle" }
        | { data: { title: string }; type: "visual-editing/meta" }
        | {
            data: {
                dataset?: string;
                documents: ContentSourceMapDocuments;
                perspective: ClientPerspective;
                projectId?: string;
            };
            type: "visual-editing/documents";
        }
        | {
            data: undefined;
            response: { snapshots: PreviewSnapshot[] };
            type: "visual-editing/preview-snapshots";
        }
        | { data: HistoryRefresh; type: "visual-editing/refreshing" }
        | { data: HistoryRefresh; type: "visual-editing/refreshed" }
        | {
            data: undefined;
            response: { schema: SchemaType[] };
            type: "visual-editing/schema";
        }
        | {
            data: { paths: UnresolvedPath[] };
            response: { types: ResolvedSchemaTypeMap };
            type: "visual-editing/schema-union-types";
        }
        | {
            data: { documentIds: string[] };
            type: "visual-editing/observe-documents";
        }
        | {
            data: { documentId: string };
            response: {
                snapshot: SanityDocument<Record<string, any>> | undefined | void;
            };
            type: "visual-editing/fetch-snapshot";
        }
        | {
            data: { mutations: any[]; transactionId: string
            | undefined };
            response: any;
            type: "visual-editing/mutate";
        }
        | {
            data: undefined;
            response: { event: WelcomeEvent };
            type: "visual-editing/snapshot-welcome";
        }
        | {
            data: undefined;
            response: { perspective: ClientPerspective };
            type: "visual-editing/fetch-perspective";
        }
        | {
            data: undefined;
            response: { features: Record<string, boolean> };
            type: "visual-editing/features";
        }
        | {
            data: undefined;
            response: { state: SerializableObject };
            type: "visual-editing/shared-state";
        }
        | { data: { data: any; event: any }; type: "visual-editing/telemetry-log" }
        | { data: { origin: string }; type: "visual-editing/status" }

    Type declaration

    • { data: SanityNode | SanityStegaNode; type: "visual-editing/focus" }
    • { data: SanityNode | SanityStegaNode; type: "overlay/focus" }
    • { data: HistoryUpdate; type: "visual-editing/navigate" }
    • { data: HistoryUpdate; type: "overlay/navigate" }
    • { data: { enabled: boolean }; type: "visual-editing/toggle" }
    • { data: { enabled: boolean }; type: "overlay/toggle" }
    • { data: { title: string }; type: "visual-editing/meta" }
    • {
          data: {
              dataset?: string;
              documents: ContentSourceMapDocuments;
              perspective: ClientPerspective;
              projectId?: string;
          };
          type: "visual-editing/documents";
      }
    • {
          data: undefined;
          response: { snapshots: PreviewSnapshot[] };
          type: "visual-editing/preview-snapshots";
      }
    • { data: HistoryRefresh; type: "visual-editing/refreshing" }
    • { data: HistoryRefresh; type: "visual-editing/refreshed" }
    • {
          data: undefined;
          response: { schema: SchemaType[] };
          type: "visual-editing/schema";
      }
    • {
          data: { paths: UnresolvedPath[] };
          response: { types: ResolvedSchemaTypeMap };
          type: "visual-editing/schema-union-types";
      }
    • { data: { documentIds: string[] }; type: "visual-editing/observe-documents" }
    • {
          data: { documentId: string };
          response: {
              snapshot: SanityDocument<Record<string, any>> | undefined | void;
          };
          type: "visual-editing/fetch-snapshot";
      }
    • {
          data: { mutations: any[]; transactionId: string | undefined };
          response: any;
          type: "visual-editing/mutate";
      }
    • {
          data: undefined;
          response: { event: WelcomeEvent };
          type: "visual-editing/snapshot-welcome";
      }
    • {
          data: undefined;
          response: { perspective: ClientPerspective };
          type: "visual-editing/fetch-perspective";
      }
    • {
          data: undefined;
          response: { features: Record<string, boolean> };
          type: "visual-editing/features";
      }
    • {
          data: undefined;
          response: { state: SerializableObject };
          type: "visual-editing/shared-state";
      }
    • { data: { data: any; event: any }; type: "visual-editing/telemetry-log" }
    • { data: { origin: string }; type: "visual-editing/status" }
      • data: { origin: string }
      • type: "visual-editing/status"

        Special event related to the presentation/status event, where comlink is unable to connect, and we're asking for some status information to detect if the URL origin is misconfigured.