@designfever/web-review-kit 0.7.3 → 0.8.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.
Files changed (36) hide show
  1. package/README.md +7 -4
  2. package/dist/{chunk-RPVLRULC.js → chunk-4ZP7B7R6.js} +2345 -1786
  3. package/dist/chunk-4ZP7B7R6.js.map +1 -0
  4. package/dist/index.cjs +2348 -1793
  5. package/dist/index.cjs.map +1 -1
  6. package/dist/index.d.cts +11 -4
  7. package/dist/index.d.ts +11 -4
  8. package/dist/index.js +8 -2
  9. package/dist/index.js.map +1 -1
  10. package/dist/react-shell.cjs +14508 -11099
  11. package/dist/react-shell.cjs.map +1 -1
  12. package/dist/react-shell.d.cts +5 -4
  13. package/dist/react-shell.d.ts +5 -4
  14. package/dist/react-shell.js +10634 -7710
  15. package/dist/react-shell.js.map +1 -1
  16. package/dist/{types-DT9Z66mV.d.cts → types-BM8E7BFV.d.cts} +63 -3
  17. package/dist/{types-DT9Z66mV.d.ts → types-BM8E7BFV.d.ts} +63 -3
  18. package/dist/vite.cjs +344 -48
  19. package/dist/vite.cjs.map +1 -1
  20. package/dist/vite.d.cts +2 -0
  21. package/dist/vite.d.ts +2 -0
  22. package/dist/vite.js +345 -49
  23. package/dist/vite.js.map +1 -1
  24. package/docs/README.md +19 -13
  25. package/docs/adapters.md +27 -4
  26. package/docs/adaptor.sample.ts +53 -3
  27. package/docs/architecture.md +117 -3
  28. package/docs/figma-overlay.md +51 -0
  29. package/docs/grid-overlay.md +5 -0
  30. package/docs/installation.md +23 -8
  31. package/docs/release-notes-0.8.0.md +175 -0
  32. package/docs/testing.md +68 -0
  33. package/package.json +14 -5
  34. package/dist/chunk-RPVLRULC.js.map +0 -1
  35. package/docs/code-review-0.6.0.md +0 -232
  36. package/docs/figma-image-mvp-0.7.0.md +0 -330
package/dist/react-shell.d.cts CHANGED
@@ -1,4 +1,4 @@
1
- import { f as ReviewItemScope, s as ReviewSource, o as ReviewMode, W as WebReviewKitAdapter, x as ReviewFieldsConfig, a as ReviewItemStatus, k as ReviewAssigneeOption, e as ReviewItem, q as ReviewRulerConfig } from './types-DT9Z66mV.cjs';
1
+ import { f as ReviewItemScope, z as ReviewSource, v as ReviewMode, W as WebReviewKitAdapter, F as ReviewFieldsConfig, a as ReviewItemStatus, k as ReviewAssigneeOption, e as ReviewItem, x as ReviewRulerConfig } from './types-BM8E7BFV.cjs';
2
2
  import { R as ReviewFigmaImageStore, a as ReviewFigmaImageFormat } from './image.types-BmzkFSPX.cjs';
3
3
  import * as react from 'react';
4
4
 
@@ -44,7 +44,7 @@ type ReviewShellStatusOption = {
44
44
  label: string;
45
45
  };
46
46
  type ReviewShellAssigneeOption = ReviewAssigneeOption;
47
- type ReviewShellWriteMode = 'dom' | 'note' | 'area';
47
+ type ReviewShellWriteMode = 'dom' | 'area';
48
48
  type ReviewShellUpdateStatusInput = {
49
49
  id: string;
50
50
  item: ReviewItem;
@@ -60,7 +60,7 @@ type ReviewShellUpdateAssigneeInput = {
60
60
  assigneeOption?: ReviewShellAssigneeOption;
61
61
  assigneeIndex: number;
62
62
  };
63
- type ReviewShellSubmissionPatch = Partial<Pick<ReviewItem, 'externalIssueId' | 'externalIssueUrl' | 'submittedAt' | 'submitStatus' | 'submitError'>>;
63
+ type ReviewShellSubmissionPatch = Partial<Pick<ReviewItem, 'attachments' | 'externalLinks' | 'externalIssueId' | 'externalIssueUrl' | 'submittedAt' | 'submitStatus' | 'submitError'>>;
64
64
  type ReviewShellSyncSubmissionInput = {
65
65
  id: string;
66
66
  item: ReviewItem;
@@ -74,6 +74,7 @@ type ReviewShellAdapter = {
74
74
  list: WebReviewKitAdapter['list'];
75
75
  create?: WebReviewKitAdapter['create'];
76
76
  update?: WebReviewKitAdapter['update'];
77
+ uploadAttachment?: WebReviewKitAdapter['uploadAttachment'];
77
78
  fields?: ReviewFieldsConfig;
78
79
  statusOptions?: readonly ReviewShellStatusOption[];
79
80
  assigneeTitle?: string;
@@ -159,7 +160,7 @@ interface ReviewShellMountOptions extends ReviewShellProps {
159
160
  rootId?: string;
160
161
  }
161
162
 
162
- declare const ReviewShell: ({ projectId, pages, adapters, presets, ruler, initialPrompt, adjustmentLabel, reviewPathPrefix, sourceRoot, sourceInspector, presence, figmaImages, }: ReviewShellProps) => react.JSX.Element;
163
+ declare const ReviewShell: (props: ReviewShellProps) => react.JSX.Element;
163
164
 
164
165
  interface FigmaDevOverlayMountOptions {
165
166
  rootId?: string;
package/dist/react-shell.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { f as ReviewItemScope, s as ReviewSource, o as ReviewMode, W as WebReviewKitAdapter, x as ReviewFieldsConfig, a as ReviewItemStatus, k as ReviewAssigneeOption, e as ReviewItem, q as ReviewRulerConfig } from './types-DT9Z66mV.js';
1
+ import { f as ReviewItemScope, z as ReviewSource, v as ReviewMode, W as WebReviewKitAdapter, F as ReviewFieldsConfig, a as ReviewItemStatus, k as ReviewAssigneeOption, e as ReviewItem, x as ReviewRulerConfig } from './types-BM8E7BFV.js';
2
2
  import { R as ReviewFigmaImageStore, a as ReviewFigmaImageFormat } from './image.types-BmzkFSPX.js';
3
3
  import * as react from 'react';
4
4
 
@@ -44,7 +44,7 @@ type ReviewShellStatusOption = {
44
44
  label: string;
45
45
  };
46
46
  type ReviewShellAssigneeOption = ReviewAssigneeOption;
47
- type ReviewShellWriteMode = 'dom' | 'note' | 'area';
47
+ type ReviewShellWriteMode = 'dom' | 'area';
48
48
  type ReviewShellUpdateStatusInput = {
49
49
  id: string;
50
50
  item: ReviewItem;
@@ -60,7 +60,7 @@ type ReviewShellUpdateAssigneeInput = {
60
60
  assigneeOption?: ReviewShellAssigneeOption;
61
61
  assigneeIndex: number;
62
62
  };
63
- type ReviewShellSubmissionPatch = Partial<Pick<ReviewItem, 'externalIssueId' | 'externalIssueUrl' | 'submittedAt' | 'submitStatus' | 'submitError'>>;
63
+ type ReviewShellSubmissionPatch = Partial<Pick<ReviewItem, 'attachments' | 'externalLinks' | 'externalIssueId' | 'externalIssueUrl' | 'submittedAt' | 'submitStatus' | 'submitError'>>;
64
64
  type ReviewShellSyncSubmissionInput = {
65
65
  id: string;
66
66
  item: ReviewItem;
@@ -74,6 +74,7 @@ type ReviewShellAdapter = {
74
74
  list: WebReviewKitAdapter['list'];
75
75
  create?: WebReviewKitAdapter['create'];
76
76
  update?: WebReviewKitAdapter['update'];
77
+ uploadAttachment?: WebReviewKitAdapter['uploadAttachment'];
77
78
  fields?: ReviewFieldsConfig;
78
79
  statusOptions?: readonly ReviewShellStatusOption[];
79
80
  assigneeTitle?: string;
@@ -159,7 +160,7 @@ interface ReviewShellMountOptions extends ReviewShellProps {
159
160
  rootId?: string;
160
161
  }
161
162
 
162
- declare const ReviewShell: ({ projectId, pages, adapters, presets, ruler, initialPrompt, adjustmentLabel, reviewPathPrefix, sourceRoot, sourceInspector, presence, figmaImages, }: ReviewShellProps) => react.JSX.Element;
163
+ declare const ReviewShell: (props: ReviewShellProps) => react.JSX.Element;
163
164
 
164
165
  interface FigmaDevOverlayMountOptions {
165
166
  rootId?: string;