@designfever/web-review-kit 0.3.0 → 0.4.1

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 (24) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +18 -1
  3. package/dist/{chunk-I76WEDLA.js → chunk-6L2KJ7XL.js} +1115 -110
  4. package/dist/chunk-6L2KJ7XL.js.map +1 -0
  5. package/dist/index.cjs +1114 -109
  6. package/dist/index.cjs.map +1 -1
  7. package/dist/index.d.cts +2 -2
  8. package/dist/index.d.ts +2 -2
  9. package/dist/index.js +1 -1
  10. package/dist/react-shell.cjs +3256 -855
  11. package/dist/react-shell.cjs.map +1 -1
  12. package/dist/react-shell.d.cts +11 -3
  13. package/dist/react-shell.d.ts +11 -3
  14. package/dist/react-shell.js +2089 -689
  15. package/dist/react-shell.js.map +1 -1
  16. package/dist/{types-Cf2x5ky6.d.cts → types-D_qYtwTs.d.cts} +4 -1
  17. package/dist/{types-Cf2x5ky6.d.ts → types-D_qYtwTs.d.ts} +4 -1
  18. package/docs/adaptor.sample.ts +2 -0
  19. package/docs/architecture.md +3 -0
  20. package/docs/installation.md +26 -1
  21. package/docs/release-notes-0.3.0.md +94 -0
  22. package/docs/release-notes-0.4.0.md +144 -0
  23. package/package.json +2 -2
  24. package/dist/chunk-I76WEDLA.js.map +0 -1
package/dist/react-shell.d.cts CHANGED
@@ -1,4 +1,4 @@
1
- import { f as ReviewItemScope, r as ReviewSource, n as ReviewMode, W as WebReviewKitAdapter, a as ReviewItemStatus, e as ReviewItem, p as ReviewRulerConfig } from './types-Cf2x5ky6.cjs';
1
+ import { f as ReviewItemScope, r as ReviewSource, n as ReviewMode, W as WebReviewKitAdapter, a as ReviewItemStatus, e as ReviewItem, p as ReviewRulerConfig } from './types-D_qYtwTs.cjs';
2
2
  import React from 'react';
3
3
 
4
4
  type ReviewShellViewportKind = Exclude<ReviewItemScope, 'dom'>;
@@ -14,6 +14,12 @@ type ReviewShellPage = {
14
14
  href: string;
15
15
  };
16
16
  type ReviewShellGlobEntries = Record<string, unknown>;
17
+ type ReviewSourceEditor = 'vscode' | 'cursor' | 'webstorm' | 'custom';
18
+ type ReviewSourceInspectorOptions = {
19
+ enabled?: boolean;
20
+ editor?: ReviewSourceEditor;
21
+ urlTemplate?: string;
22
+ };
17
23
  type ReviewShellStatusOption = {
18
24
  value: ReviewItemStatus;
19
25
  label: string;
@@ -103,15 +109,17 @@ interface ReviewShellProps {
103
109
  presets?: ReviewShellViewportPreset[];
104
110
  ruler?: ReviewRulerConfig;
105
111
  initialPrompt?: string;
112
+ adjustmentLabel?: string;
106
113
  reviewPathPrefix?: string;
107
114
  sourceRoot?: string;
115
+ sourceInspector?: ReviewSourceInspectorOptions;
108
116
  presence?: ReviewPresenceAdapter;
109
117
  }
110
118
  interface ReviewShellMountOptions extends ReviewShellProps {
111
119
  rootId?: string;
112
120
  }
113
121
 
114
- declare const ReviewShell: ({ projectId, pages, adapters, presets, ruler, initialPrompt, reviewPathPrefix, sourceRoot, presence }: ReviewShellProps) => React.JSX.Element;
122
+ declare const ReviewShell: ({ projectId, pages, adapters, presets, ruler, initialPrompt, adjustmentLabel, reviewPathPrefix, sourceRoot, sourceInspector, presence }: ReviewShellProps) => React.JSX.Element;
115
123
 
116
124
  declare const createReviewPagesFromGlob: (entries: ReviewShellGlobEntries, options?: CreateReviewPagesOptions) => ReviewShellPage[];
117
125
 
@@ -158,4 +166,4 @@ declare const createSupabasePresenceAdapter: ({ client, channelPrefix, private:
158
166
 
159
167
  declare const mountReviewShell: (options: ReviewShellMountOptions) => void;
160
168
 
161
- export { type CreateReviewPagesOptions, DEFAULT_REVIEW_VIEWPORT_PRESETS, type LocalPresenceAdapterOptions, type ReviewPresenceAdapter, type ReviewPresenceContext, type ReviewPresenceSession, type ReviewPresenceState, type ReviewPresenceStatus, type ReviewPresenceUser, ReviewShell, type ReviewShellAdapter, type ReviewShellAdapters, type ReviewShellGlobEntries, type ReviewShellMountOptions, type ReviewShellPage, type ReviewShellProps, type ReviewShellStatusOption, type ReviewShellViewportKind, type ReviewShellViewportPreset, type SupabasePresenceAdapterOptions, type SupabasePresenceClient, createFallbackPresenceAdapter, createLocalPresenceAdapter, createReviewPagesFromGlob, createSupabasePresenceAdapter, mountReviewShell };
169
+ export { type CreateReviewPagesOptions, DEFAULT_REVIEW_VIEWPORT_PRESETS, type LocalPresenceAdapterOptions, type ReviewPresenceAdapter, type ReviewPresenceContext, type ReviewPresenceSession, type ReviewPresenceState, type ReviewPresenceStatus, type ReviewPresenceUser, ReviewShell, type ReviewShellAdapter, type ReviewShellAdapters, type ReviewShellGlobEntries, type ReviewShellMountOptions, type ReviewShellPage, type ReviewShellProps, type ReviewShellStatusOption, type ReviewShellViewportKind, type ReviewShellViewportPreset, type ReviewSourceEditor, type ReviewSourceInspectorOptions, type SupabasePresenceAdapterOptions, type SupabasePresenceClient, createFallbackPresenceAdapter, createLocalPresenceAdapter, createReviewPagesFromGlob, createSupabasePresenceAdapter, mountReviewShell };
package/dist/react-shell.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { f as ReviewItemScope, r as ReviewSource, n as ReviewMode, W as WebReviewKitAdapter, a as ReviewItemStatus, e as ReviewItem, p as ReviewRulerConfig } from './types-Cf2x5ky6.js';
1
+ import { f as ReviewItemScope, r as ReviewSource, n as ReviewMode, W as WebReviewKitAdapter, a as ReviewItemStatus, e as ReviewItem, p as ReviewRulerConfig } from './types-D_qYtwTs.js';
2
2
  import React from 'react';
3
3
 
4
4
  type ReviewShellViewportKind = Exclude<ReviewItemScope, 'dom'>;
@@ -14,6 +14,12 @@ type ReviewShellPage = {
14
14
  href: string;
15
15
  };
16
16
  type ReviewShellGlobEntries = Record<string, unknown>;
17
+ type ReviewSourceEditor = 'vscode' | 'cursor' | 'webstorm' | 'custom';
18
+ type ReviewSourceInspectorOptions = {
19
+ enabled?: boolean;
20
+ editor?: ReviewSourceEditor;
21
+ urlTemplate?: string;
22
+ };
17
23
  type ReviewShellStatusOption = {
18
24
  value: ReviewItemStatus;
19
25
  label: string;
@@ -103,15 +109,17 @@ interface ReviewShellProps {
103
109
  presets?: ReviewShellViewportPreset[];
104
110
  ruler?: ReviewRulerConfig;
105
111
  initialPrompt?: string;
112
+ adjustmentLabel?: string;
106
113
  reviewPathPrefix?: string;
107
114
  sourceRoot?: string;
115
+ sourceInspector?: ReviewSourceInspectorOptions;
108
116
  presence?: ReviewPresenceAdapter;
109
117
  }
110
118
  interface ReviewShellMountOptions extends ReviewShellProps {
111
119
  rootId?: string;
112
120
  }
113
121
 
114
- declare const ReviewShell: ({ projectId, pages, adapters, presets, ruler, initialPrompt, reviewPathPrefix, sourceRoot, presence }: ReviewShellProps) => React.JSX.Element;
122
+ declare const ReviewShell: ({ projectId, pages, adapters, presets, ruler, initialPrompt, adjustmentLabel, reviewPathPrefix, sourceRoot, sourceInspector, presence }: ReviewShellProps) => React.JSX.Element;
115
123
 
116
124
  declare const createReviewPagesFromGlob: (entries: ReviewShellGlobEntries, options?: CreateReviewPagesOptions) => ReviewShellPage[];
117
125
 
@@ -158,4 +166,4 @@ declare const createSupabasePresenceAdapter: ({ client, channelPrefix, private:
158
166
 
159
167
  declare const mountReviewShell: (options: ReviewShellMountOptions) => void;
160
168
 
161
- export { type CreateReviewPagesOptions, DEFAULT_REVIEW_VIEWPORT_PRESETS, type LocalPresenceAdapterOptions, type ReviewPresenceAdapter, type ReviewPresenceContext, type ReviewPresenceSession, type ReviewPresenceState, type ReviewPresenceStatus, type ReviewPresenceUser, ReviewShell, type ReviewShellAdapter, type ReviewShellAdapters, type ReviewShellGlobEntries, type ReviewShellMountOptions, type ReviewShellPage, type ReviewShellProps, type ReviewShellStatusOption, type ReviewShellViewportKind, type ReviewShellViewportPreset, type SupabasePresenceAdapterOptions, type SupabasePresenceClient, createFallbackPresenceAdapter, createLocalPresenceAdapter, createReviewPagesFromGlob, createSupabasePresenceAdapter, mountReviewShell };
169
+ export { type CreateReviewPagesOptions, DEFAULT_REVIEW_VIEWPORT_PRESETS, type LocalPresenceAdapterOptions, type ReviewPresenceAdapter, type ReviewPresenceContext, type ReviewPresenceSession, type ReviewPresenceState, type ReviewPresenceStatus, type ReviewPresenceUser, ReviewShell, type ReviewShellAdapter, type ReviewShellAdapters, type ReviewShellGlobEntries, type ReviewShellMountOptions, type ReviewShellPage, type ReviewShellProps, type ReviewShellStatusOption, type ReviewShellViewportKind, type ReviewShellViewportPreset, type ReviewSourceEditor, type ReviewSourceInspectorOptions, type SupabasePresenceAdapterOptions, type SupabasePresenceClient, createFallbackPresenceAdapter, createLocalPresenceAdapter, createReviewPagesFromGlob, createSupabasePresenceAdapter, mountReviewShell };