@designfever/web-review-kit 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.
Files changed (41) hide show
  1. package/.env.sample +29 -0
  2. package/README.md +35 -10
  3. package/dist/chunk-AB5B6O77.js +584 -0
  4. package/dist/chunk-AB5B6O77.js.map +1 -0
  5. package/dist/{chunk-IN36JHEU.js → chunk-RPVLRULC.js} +504 -143
  6. package/dist/chunk-RPVLRULC.js.map +1 -0
  7. package/dist/image.types-BmzkFSPX.d.cts +71 -0
  8. package/dist/image.types-BmzkFSPX.d.ts +71 -0
  9. package/dist/index.cjs +1019 -144
  10. package/dist/index.cjs.map +1 -1
  11. package/dist/index.d.cts +27 -3
  12. package/dist/index.d.ts +27 -3
  13. package/dist/index.js +50 -3
  14. package/dist/index.js.map +1 -1
  15. package/dist/react-shell.cjs +10293 -5185
  16. package/dist/react-shell.cjs.map +1 -1
  17. package/dist/react-shell.d.cts +37 -4
  18. package/dist/react-shell.d.ts +37 -4
  19. package/dist/react-shell.js +9624 -4856
  20. package/dist/react-shell.js.map +1 -1
  21. package/dist/token-Dt-ZH-YO.d.cts +88 -0
  22. package/dist/token-nJXPPdYX.d.ts +88 -0
  23. package/dist/{types-DFHHVRBc.d.cts → types-DT9Z66mV.d.cts} +13 -1
  24. package/dist/{types-DFHHVRBc.d.ts → types-DT9Z66mV.d.ts} +13 -1
  25. package/dist/vite.cjs +1116 -5
  26. package/dist/vite.cjs.map +1 -1
  27. package/dist/vite.d.cts +45 -1
  28. package/dist/vite.d.ts +45 -1
  29. package/dist/vite.js +800 -5
  30. package/dist/vite.js.map +1 -1
  31. package/docs/README.md +11 -7
  32. package/docs/adapters.md +126 -0
  33. package/docs/adaptor.sample.ts +13 -1
  34. package/docs/architecture.md +2 -1
  35. package/docs/code-review-0.6.0.md +232 -0
  36. package/docs/db-setup.md +4 -2
  37. package/docs/figma-image-mvp-0.7.0.md +327 -0
  38. package/docs/installation.md +39 -7
  39. package/docs/release-notes-0.7.0.md +128 -0
  40. package/package.json +6 -2
  41. package/dist/chunk-IN36JHEU.js.map +0 -1
@@ -0,0 +1,71 @@
1
+ type ReviewFigmaImageFormat = 'webp' | 'png' | 'jpg';
2
+ declare const DEFAULT_REVIEW_FIGMA_IMAGE_FORMAT = "webp";
3
+ type ReviewFigmaImageViewport = {
4
+ label?: string;
5
+ width?: number;
6
+ height?: number;
7
+ scope?: 'mobile' | 'tablet' | 'desktop' | 'wide';
8
+ };
9
+ type ReviewFigmaRouteTarget = {
10
+ type: 'route';
11
+ projectId: string;
12
+ pageUrl: string;
13
+ viewport?: ReviewFigmaImageViewport;
14
+ slot?: string;
15
+ };
16
+ type ReviewFigmaNodeTarget = {
17
+ type: 'figma-node';
18
+ projectId: string;
19
+ fileKey: string;
20
+ nodeId: string;
21
+ };
22
+ type ReviewFigmaImageTarget = ReviewFigmaRouteTarget | ReviewFigmaNodeTarget;
23
+ type ReviewFigmaImage = {
24
+ id: string;
25
+ projectId: string;
26
+ target: ReviewFigmaImageTarget;
27
+ figmaUrl: string;
28
+ fileKey: string;
29
+ nodeId: string;
30
+ imageUrl: string;
31
+ imageFormat: ReviewFigmaImageFormat;
32
+ mimeType: string;
33
+ label?: string;
34
+ order: number;
35
+ storageKey?: string;
36
+ width?: number;
37
+ height?: number;
38
+ byteSize?: number;
39
+ createdAt: string;
40
+ updatedAt: string;
41
+ };
42
+ type ReviewFigmaImageAssetInput = {
43
+ dataUrl: string;
44
+ imageFormat: ReviewFigmaImageFormat;
45
+ mimeType: string;
46
+ byteSize?: number;
47
+ width?: number;
48
+ height?: number;
49
+ };
50
+ type AddReviewFigmaImageInput = {
51
+ target: ReviewFigmaImageTarget;
52
+ figmaUrl: string;
53
+ label?: string;
54
+ order?: number;
55
+ imageFormat?: ReviewFigmaImageFormat;
56
+ asset?: ReviewFigmaImageAssetInput;
57
+ };
58
+ type UpdateReviewFigmaImageInput = Partial<Pick<ReviewFigmaImage, 'label' | 'order'>>;
59
+ type ReorderReviewFigmaImagesInput = {
60
+ target: ReviewFigmaImageTarget;
61
+ imageIds: string[];
62
+ };
63
+ interface ReviewFigmaImageStore {
64
+ listImages(target: ReviewFigmaImageTarget): Promise<ReviewFigmaImage[]>;
65
+ addImage(input: AddReviewFigmaImageInput): Promise<ReviewFigmaImage>;
66
+ updateImage(id: string, patch: UpdateReviewFigmaImageInput): Promise<ReviewFigmaImage>;
67
+ reorderImages(input: ReorderReviewFigmaImagesInput): Promise<ReviewFigmaImage[]>;
68
+ deleteImage(id: string): Promise<void>;
69
+ }
70
+
71
+ export { type AddReviewFigmaImageInput as A, DEFAULT_REVIEW_FIGMA_IMAGE_FORMAT as D, type ReviewFigmaImageStore as R, type UpdateReviewFigmaImageInput as U, type ReviewFigmaImageFormat as a, type ReviewFigmaImageTarget as b, type ReorderReviewFigmaImagesInput as c, type ReviewFigmaImage as d, type ReviewFigmaImageAssetInput as e, type ReviewFigmaImageViewport as f, type ReviewFigmaNodeTarget as g, type ReviewFigmaRouteTarget as h };
@@ -0,0 +1,71 @@
1
+ type ReviewFigmaImageFormat = 'webp' | 'png' | 'jpg';
2
+ declare const DEFAULT_REVIEW_FIGMA_IMAGE_FORMAT = "webp";
3
+ type ReviewFigmaImageViewport = {
4
+ label?: string;
5
+ width?: number;
6
+ height?: number;
7
+ scope?: 'mobile' | 'tablet' | 'desktop' | 'wide';
8
+ };
9
+ type ReviewFigmaRouteTarget = {
10
+ type: 'route';
11
+ projectId: string;
12
+ pageUrl: string;
13
+ viewport?: ReviewFigmaImageViewport;
14
+ slot?: string;
15
+ };
16
+ type ReviewFigmaNodeTarget = {
17
+ type: 'figma-node';
18
+ projectId: string;
19
+ fileKey: string;
20
+ nodeId: string;
21
+ };
22
+ type ReviewFigmaImageTarget = ReviewFigmaRouteTarget | ReviewFigmaNodeTarget;
23
+ type ReviewFigmaImage = {
24
+ id: string;
25
+ projectId: string;
26
+ target: ReviewFigmaImageTarget;
27
+ figmaUrl: string;
28
+ fileKey: string;
29
+ nodeId: string;
30
+ imageUrl: string;
31
+ imageFormat: ReviewFigmaImageFormat;
32
+ mimeType: string;
33
+ label?: string;
34
+ order: number;
35
+ storageKey?: string;
36
+ width?: number;
37
+ height?: number;
38
+ byteSize?: number;
39
+ createdAt: string;
40
+ updatedAt: string;
41
+ };
42
+ type ReviewFigmaImageAssetInput = {
43
+ dataUrl: string;
44
+ imageFormat: ReviewFigmaImageFormat;
45
+ mimeType: string;
46
+ byteSize?: number;
47
+ width?: number;
48
+ height?: number;
49
+ };
50
+ type AddReviewFigmaImageInput = {
51
+ target: ReviewFigmaImageTarget;
52
+ figmaUrl: string;
53
+ label?: string;
54
+ order?: number;
55
+ imageFormat?: ReviewFigmaImageFormat;
56
+ asset?: ReviewFigmaImageAssetInput;
57
+ };
58
+ type UpdateReviewFigmaImageInput = Partial<Pick<ReviewFigmaImage, 'label' | 'order'>>;
59
+ type ReorderReviewFigmaImagesInput = {
60
+ target: ReviewFigmaImageTarget;
61
+ imageIds: string[];
62
+ };
63
+ interface ReviewFigmaImageStore {
64
+ listImages(target: ReviewFigmaImageTarget): Promise<ReviewFigmaImage[]>;
65
+ addImage(input: AddReviewFigmaImageInput): Promise<ReviewFigmaImage>;
66
+ updateImage(id: string, patch: UpdateReviewFigmaImageInput): Promise<ReviewFigmaImage>;
67
+ reorderImages(input: ReorderReviewFigmaImagesInput): Promise<ReviewFigmaImage[]>;
68
+ deleteImage(id: string): Promise<void>;
69
+ }
70
+
71
+ export { type AddReviewFigmaImageInput as A, DEFAULT_REVIEW_FIGMA_IMAGE_FORMAT as D, type ReviewFigmaImageStore as R, type UpdateReviewFigmaImageInput as U, type ReviewFigmaImageFormat as a, type ReviewFigmaImageTarget as b, type ReorderReviewFigmaImagesInput as c, type ReviewFigmaImage as d, type ReviewFigmaImageAssetInput as e, type ReviewFigmaImageViewport as f, type ReviewFigmaNodeTarget as g, type ReviewFigmaRouteTarget as h };