@popmelt.com/core 0.18.0 → 0.18.2

package/dist/index.d.mts

@@ -1,7 +1,8 @@
 import * as react from 'react';
 import { PropsWithChildren } from 'react';
-import { I as ImageRecognitionProvider, V as VideoTrackingProvider, P as PopmeltSubjectAdapter, a as ImageSubjectAdapterOptions, b as VideoSubjectAdapterOptions, A as Annotation, E as ElementInfo, c as AnnotationAttachment, S as SubjectFeedbackAttachment, d as StyleModification, T as TextModification, D as DomModification, e as SpacingTokenChange } from './video-adapter-DzNtG67g.mjs';
-export { f as AnnotationType, B as BridgeStatus, C as ClaudeResponse, g as ImageObjectContext, O as OpaqueTargetReference, h as Point, i as PopmeltSubject, j as PopmeltSubjectBounds, k as PopmeltSubjectCreationSession, l as PopmeltSubjectTrackingAnchor, m as PopmeltSurfaceSnapshot, R as ReactSourceLocation, n as StyleChange, o as ToolType, p as VideoObjectContext } from './video-adapter-DzNtG67g.mjs';
+import { A as Annotation, P as PopmeltSubjectAdapter, E as ElementInfo, a as AnnotationAttachment, S as SubjectFeedbackAttachment, b as StyleModification, T as TextModification, D as DomModification, c as SpacingTokenChange } from './subjects-CeqtFged.mjs';
+export { d as AnnotationType, B as BridgeStatus, C as ClaudeResponse, I as ImageObjectContext, O as OpaqueTargetReference, e as Point, f as PopmeltSubject, g as PopmeltSubjectBounds, h as PopmeltSubjectCreationSession, i as PopmeltSubjectTrackingAnchor, j as PopmeltSurfaceSnapshot, R as ReactSourceLocation, k as StyleChange, l as ToolType, V as VideoObjectContext } from './subjects-CeqtFged.mjs';
+import { I as ImageRecognitionProvider, V as VideoTrackingProvider, a as ImageSubjectAdapterOptions, b as VideoSubjectAdapterOptions } from './video-adapter-Gq8saCDn.mjs';
 
 /** Client-side envelope used for persisted and streaming bridge events. */
 type BridgeEvent = {
@@ -10,6 +11,28 @@ type BridgeEvent = {
     timestamp: number;
 };
 
+type CommentMetaValue = null | boolean | number | string | CommentMetaValue[] | {
+    [key: string]: CommentMetaValue;
+};
+/** User-owned, JSON-serializable context captured with a human comment turn. */
+type CommentMeta = Record<string, CommentMetaValue>;
+type CommentMetaContext = {
+    kind: 'annotation';
+    timestamp: number;
+    url: string;
+    pathname: string;
+    annotations: readonly Readonly<Annotation>[];
+} | {
+    kind: 'reply';
+    timestamp: number;
+    url: string;
+    pathname: string;
+    threadId: string;
+    reply: string;
+    annotations: readonly Readonly<Annotation>[];
+};
+type GetCommentMeta = (context: CommentMetaContext) => CommentMeta | undefined | Promise<CommentMeta | undefined>;
+
 type PopmeltExtensionRuntime = {
     /** Optional perception contribution for Core's built-in image adapter. */
     imageRecognition?: ImageRecognitionProvider;
@@ -33,6 +56,12 @@ type ImageAnnotationOptions = Omit<ImageSubjectAdapterOptions, 'id'>;
 
 type VideoAnnotationOptions = Omit<VideoSubjectAdapterOptions, 'id'>;
 
+type PopmeltContextValue = {
+    isEnabled: boolean;
+    registerSubjectAdapter(adapter: PopmeltSubjectAdapter): () => void;
+};
+declare function usePopmelt(): PopmeltContextValue;
+
 declare global {
     interface Window {
         __POPMELT_BRIDGE_URL__?: string;
@@ -40,9 +69,6 @@ declare global {
     }
 }
 
-type PopmeltContextValue = {
-    isEnabled: boolean;
-};
 type PopmeltProviderProps = PropsWithChildren<{
     enabled?: boolean;
     bridgeUrl?: string;
@@ -59,9 +85,10 @@ type PopmeltProviderProps = PropsWithChildren<{
     imageAnnotation?: boolean | ImageAnnotationOptions;
     /** Manual video annotation is on by default; See may contribute tracking. */
     videoAnnotation?: boolean | VideoAnnotationOptions;
+    /** Capture application-owned JSON context with each submitted human turn. */
+    getCommentMeta?: GetCommentMeta;
 }>;
-declare function PopmeltProvider({ children, enabled, bridgeUrl, projectId: projectIdProp, navigate: navigateProp, subjectAdapters, extensions, imageAnnotation, videoAnnotation, }: PopmeltProviderProps): react.JSX.Element;
-declare function usePopmelt(): PopmeltContextValue;
+declare function PopmeltProvider({ children, enabled, bridgeUrl, projectId: projectIdProp, navigate: navigateProp, subjectAdapters, extensions, imageAnnotation, videoAnnotation, getCommentMeta, }: PopmeltProviderProps): react.JSX.Element;
 
 type AnnotationData = {
     id: string;
@@ -93,6 +120,7 @@ type FeedbackData = {
     domModifications?: DomModification[];
     inspectedElement?: ElementInfo;
     spacingTokenChanges?: SpacingTokenChange[];
+    meta?: CommentMeta;
 };
 
-export { Annotation, type BridgeEvent, ElementInfo, type FeedbackData, type ImageAnnotationOptions, type PopmeltExtension, type PopmeltExtensionRuntime, PopmeltProvider, type PopmeltProviderProps, PopmeltSubjectAdapter, StyleModification, type VideoAnnotationOptions, usePopmelt };
+export { Annotation, type BridgeEvent, type CommentMeta, type CommentMetaContext, type CommentMetaValue, ElementInfo, type FeedbackData, type GetCommentMeta, type ImageAnnotationOptions, type PopmeltExtension, type PopmeltExtensionRuntime, PopmeltProvider, type PopmeltProviderProps, PopmeltSubjectAdapter, StyleModification, type VideoAnnotationOptions, usePopmelt };