web-remarq 0.6.0 → 0.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +27 -2
- package/dist/core/index.cjs +101 -5
- package/dist/core/index.cjs.map +1 -1
- package/dist/core/index.d.cts +39 -3
- package/dist/core/index.d.ts +39 -3
- package/dist/core/index.js +96 -4
- package/dist/core/index.js.map +1 -1
- package/dist/index.cjs +456 -76
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +34 -3
- package/dist/index.d.ts +34 -3
- package/dist/index.js +456 -76
- package/dist/index.js.map +1 -1
- package/dist/web-remarq.global.global.js +456 -76
- package/dist/web-remarq.global.global.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -22,6 +22,16 @@ interface ElementFingerprint {
|
|
|
22
22
|
detectedSource: string | null;
|
|
23
23
|
detectedComponent: string | null;
|
|
24
24
|
}
|
|
25
|
+
type AnnotationStatus = 'pending' | 'in_progress' | 'fixed_unverified' | 'verified' | 'dismissed';
|
|
26
|
+
type Actor = 'designer' | 'agent' | 'developer';
|
|
27
|
+
type AnnotationEventType = 'created' | 'acknowledged' | 'fix_claimed' | 'verified' | 'rejected' | 'dismissed' | 'reopened' | 'migrated';
|
|
28
|
+
interface AnnotationEvent {
|
|
29
|
+
type: AnnotationEventType;
|
|
30
|
+
actor: Actor | null;
|
|
31
|
+
actorName?: string;
|
|
32
|
+
timestamp: number;
|
|
33
|
+
reason?: string;
|
|
34
|
+
}
|
|
25
35
|
interface Annotation {
|
|
26
36
|
id: string;
|
|
27
37
|
comment: string;
|
|
@@ -30,7 +40,8 @@ interface Annotation {
|
|
|
30
40
|
viewport: string;
|
|
31
41
|
viewportBucket: number;
|
|
32
42
|
timestamp: number;
|
|
33
|
-
status:
|
|
43
|
+
status: AnnotationStatus;
|
|
44
|
+
lifecycle: AnnotationEvent[];
|
|
34
45
|
}
|
|
35
46
|
interface AnnotationStore {
|
|
36
47
|
version: 1;
|
|
@@ -69,14 +80,21 @@ interface AgentAnnotationSource {
|
|
|
69
80
|
column: number;
|
|
70
81
|
component: string | null;
|
|
71
82
|
}
|
|
83
|
+
interface AgentLifecycleEvent {
|
|
84
|
+
type: AnnotationEventType;
|
|
85
|
+
actor: Actor | null;
|
|
86
|
+
timestamp: number;
|
|
87
|
+
reason?: string;
|
|
88
|
+
}
|
|
72
89
|
interface AgentAnnotation {
|
|
73
90
|
id: string;
|
|
74
91
|
route: string;
|
|
75
92
|
comment: string;
|
|
76
|
-
status:
|
|
93
|
+
status: AnnotationStatus;
|
|
77
94
|
timestamp: number;
|
|
78
95
|
source: AgentAnnotationSource | null;
|
|
79
96
|
searchHints: AgentSearchHints;
|
|
97
|
+
lifecycle: AgentLifecycleEvent[];
|
|
80
98
|
}
|
|
81
99
|
interface AgentExport {
|
|
82
100
|
version: 1;
|
|
@@ -98,6 +116,11 @@ interface StorageAdapter {
|
|
|
98
116
|
readonly isMemoryOnly?: boolean;
|
|
99
117
|
}
|
|
100
118
|
|
|
119
|
+
interface TransitionOpts {
|
|
120
|
+
actor?: Actor;
|
|
121
|
+
actorName?: string;
|
|
122
|
+
reason?: string;
|
|
123
|
+
}
|
|
101
124
|
declare const WebRemarq: {
|
|
102
125
|
init(opts?: WebRemarqOptions): void;
|
|
103
126
|
destroy(): void;
|
|
@@ -107,6 +130,14 @@ declare const WebRemarq: {
|
|
|
107
130
|
import(file: File): Promise<ImportResult>;
|
|
108
131
|
getAnnotations(route?: string): Annotation[];
|
|
109
132
|
clearAll(): void;
|
|
133
|
+
acknowledge(id: string, opts?: TransitionOpts): void;
|
|
134
|
+
claimFix(id: string, opts?: TransitionOpts): void;
|
|
135
|
+
verify(id: string, opts?: TransitionOpts): void;
|
|
136
|
+
reject(id: string, opts?: TransitionOpts): void;
|
|
137
|
+
dismiss(id: string, opts?: TransitionOpts): void;
|
|
138
|
+
reopen(id: string, opts?: TransitionOpts): void;
|
|
139
|
+
/** @deprecated Use verify() instead. */
|
|
140
|
+
markResolved(id: string): void;
|
|
110
141
|
};
|
|
111
142
|
|
|
112
143
|
declare class LocalStorageAdapter implements StorageAdapter {
|
|
@@ -121,4 +152,4 @@ declare class LocalStorageAdapter implements StorageAdapter {
|
|
|
121
152
|
private persist;
|
|
122
153
|
}
|
|
123
154
|
|
|
124
|
-
export { type AgentAnnotation, type AgentExport, type Annotation, type AnnotationStore, type CSSModuleClass, type ElementFingerprint, type ImportResult, LocalStorageAdapter, type StorageAdapter, type StorageChangeEvent, type ToolbarPosition, WebRemarq, type WebRemarqOptions };
|
|
155
|
+
export { type Actor, type AgentAnnotation, type AgentExport, type AgentLifecycleEvent, type Annotation, type AnnotationEvent, type AnnotationEventType, type AnnotationStatus, type AnnotationStore, type CSSModuleClass, type ElementFingerprint, type ImportResult, LocalStorageAdapter, type StorageAdapter, type StorageChangeEvent, type ToolbarPosition, WebRemarq, type WebRemarqOptions };
|
package/dist/index.d.ts
CHANGED
|
@@ -22,6 +22,16 @@ interface ElementFingerprint {
|
|
|
22
22
|
detectedSource: string | null;
|
|
23
23
|
detectedComponent: string | null;
|
|
24
24
|
}
|
|
25
|
+
type AnnotationStatus = 'pending' | 'in_progress' | 'fixed_unverified' | 'verified' | 'dismissed';
|
|
26
|
+
type Actor = 'designer' | 'agent' | 'developer';
|
|
27
|
+
type AnnotationEventType = 'created' | 'acknowledged' | 'fix_claimed' | 'verified' | 'rejected' | 'dismissed' | 'reopened' | 'migrated';
|
|
28
|
+
interface AnnotationEvent {
|
|
29
|
+
type: AnnotationEventType;
|
|
30
|
+
actor: Actor | null;
|
|
31
|
+
actorName?: string;
|
|
32
|
+
timestamp: number;
|
|
33
|
+
reason?: string;
|
|
34
|
+
}
|
|
25
35
|
interface Annotation {
|
|
26
36
|
id: string;
|
|
27
37
|
comment: string;
|
|
@@ -30,7 +40,8 @@ interface Annotation {
|
|
|
30
40
|
viewport: string;
|
|
31
41
|
viewportBucket: number;
|
|
32
42
|
timestamp: number;
|
|
33
|
-
status:
|
|
43
|
+
status: AnnotationStatus;
|
|
44
|
+
lifecycle: AnnotationEvent[];
|
|
34
45
|
}
|
|
35
46
|
interface AnnotationStore {
|
|
36
47
|
version: 1;
|
|
@@ -69,14 +80,21 @@ interface AgentAnnotationSource {
|
|
|
69
80
|
column: number;
|
|
70
81
|
component: string | null;
|
|
71
82
|
}
|
|
83
|
+
interface AgentLifecycleEvent {
|
|
84
|
+
type: AnnotationEventType;
|
|
85
|
+
actor: Actor | null;
|
|
86
|
+
timestamp: number;
|
|
87
|
+
reason?: string;
|
|
88
|
+
}
|
|
72
89
|
interface AgentAnnotation {
|
|
73
90
|
id: string;
|
|
74
91
|
route: string;
|
|
75
92
|
comment: string;
|
|
76
|
-
status:
|
|
93
|
+
status: AnnotationStatus;
|
|
77
94
|
timestamp: number;
|
|
78
95
|
source: AgentAnnotationSource | null;
|
|
79
96
|
searchHints: AgentSearchHints;
|
|
97
|
+
lifecycle: AgentLifecycleEvent[];
|
|
80
98
|
}
|
|
81
99
|
interface AgentExport {
|
|
82
100
|
version: 1;
|
|
@@ -98,6 +116,11 @@ interface StorageAdapter {
|
|
|
98
116
|
readonly isMemoryOnly?: boolean;
|
|
99
117
|
}
|
|
100
118
|
|
|
119
|
+
interface TransitionOpts {
|
|
120
|
+
actor?: Actor;
|
|
121
|
+
actorName?: string;
|
|
122
|
+
reason?: string;
|
|
123
|
+
}
|
|
101
124
|
declare const WebRemarq: {
|
|
102
125
|
init(opts?: WebRemarqOptions): void;
|
|
103
126
|
destroy(): void;
|
|
@@ -107,6 +130,14 @@ declare const WebRemarq: {
|
|
|
107
130
|
import(file: File): Promise<ImportResult>;
|
|
108
131
|
getAnnotations(route?: string): Annotation[];
|
|
109
132
|
clearAll(): void;
|
|
133
|
+
acknowledge(id: string, opts?: TransitionOpts): void;
|
|
134
|
+
claimFix(id: string, opts?: TransitionOpts): void;
|
|
135
|
+
verify(id: string, opts?: TransitionOpts): void;
|
|
136
|
+
reject(id: string, opts?: TransitionOpts): void;
|
|
137
|
+
dismiss(id: string, opts?: TransitionOpts): void;
|
|
138
|
+
reopen(id: string, opts?: TransitionOpts): void;
|
|
139
|
+
/** @deprecated Use verify() instead. */
|
|
140
|
+
markResolved(id: string): void;
|
|
110
141
|
};
|
|
111
142
|
|
|
112
143
|
declare class LocalStorageAdapter implements StorageAdapter {
|
|
@@ -121,4 +152,4 @@ declare class LocalStorageAdapter implements StorageAdapter {
|
|
|
121
152
|
private persist;
|
|
122
153
|
}
|
|
123
154
|
|
|
124
|
-
export { type AgentAnnotation, type AgentExport, type Annotation, type AnnotationStore, type CSSModuleClass, type ElementFingerprint, type ImportResult, LocalStorageAdapter, type StorageAdapter, type StorageChangeEvent, type ToolbarPosition, WebRemarq, type WebRemarqOptions };
|
|
155
|
+
export { type Actor, type AgentAnnotation, type AgentExport, type AgentLifecycleEvent, type Annotation, type AnnotationEvent, type AnnotationEventType, type AnnotationStatus, type AnnotationStore, type CSSModuleClass, type ElementFingerprint, type ImportResult, LocalStorageAdapter, type StorageAdapter, type StorageChangeEvent, type ToolbarPosition, WebRemarq, type WebRemarqOptions };
|