@designfever/web-review-kit 0.1.0

package/dist/react-shell.d.cts

@@ -0,0 +1,156 @@
+import React from 'react';
+import { f as ReviewItemScope, s as ReviewSource, o as ReviewMode, W as WebReviewKitAdapter, a as ReviewItemStatus, e as ReviewItem, q as ReviewRulerConfig } from './types-D_mNjOHx.cjs';
+
+type ReviewShellViewportKind = Exclude<ReviewItemScope, 'dom'>;
+type ReviewShellViewportPreset = {
+    label: string;
+    width: number;
+    height: number;
+    kind?: ReviewShellViewportKind;
+    designWidth?: number;
+    designHeight?: number;
+};
+type ReviewShellPage = {
+    href: string;
+};
+type ReviewShellGlobEntries = Record<string, unknown>;
+type ReviewShellStatusOption = {
+    value: ReviewItemStatus;
+    label: string;
+};
+type ReviewShellUpdateStatusInput = {
+    id: string;
+    item: ReviewItem;
+    status: ReviewItemStatus;
+    statusOption: ReviewShellStatusOption;
+    statusIndex: number;
+};
+type ReviewShellSubmissionPatch = Partial<Pick<ReviewItem, 'externalIssueId' | 'externalIssueUrl' | 'submittedAt' | 'submitStatus' | 'submitError'>>;
+type ReviewShellSyncSubmissionInput = {
+    id: string;
+    item: ReviewItem;
+    patch: ReviewShellSubmissionPatch;
+};
+type ReviewShellAdapter = {
+    label: ReviewSource;
+    pageId?: string;
+    get: WebReviewKitAdapter['get'];
+    list: WebReviewKitAdapter['list'];
+    create: WebReviewKitAdapter['create'];
+    statusOptions?: readonly ReviewShellStatusOption[];
+    updateStatus?: (input: ReviewShellUpdateStatusInput) => Promise<ReviewItem>;
+    syncSubmission?: (input: ReviewShellSyncSubmissionInput) => Promise<ReviewItem>;
+    remove?: WebReviewKitAdapter['remove'];
+};
+type ReviewShellAdapterMap = {
+    local: WebReviewKitAdapter;
+    remote?: WebReviewKitAdapter | null;
+    remotePageId?: string;
+};
+type ReviewShellAdapters = ReviewShellAdapterMap | ReviewShellAdapter[];
+type ReviewPresenceStatus = 'idle' | 'reviewing' | 'editing';
+type ReviewPresenceViewport = {
+    label: string;
+    width: number;
+    height: number;
+    kind: ReviewShellViewportKind;
+};
+type ReviewPresenceState = {
+    projectId: string;
+    sessionId: string;
+    userId: string;
+    displayName: string;
+    color: string;
+    routeKey: string;
+    target: string;
+    source: ReviewSource;
+    viewport: ReviewPresenceViewport;
+    mode: ReviewMode;
+    selectedItemId?: string | null;
+    selectedReviewNumber?: number | null;
+    status: ReviewPresenceStatus;
+    updatedAt: string;
+};
+type ReviewPresenceUser = ReviewPresenceState;
+type ReviewPresenceContext = {
+    projectId: string;
+    sessionId: string;
+    userId: string;
+    displayName: string;
+    color: string;
+    initialState: ReviewPresenceState;
+};
+type ReviewPresenceSession = {
+    update: (state: Partial<ReviewPresenceState>) => void | Promise<void>;
+    subscribe: (callback: (users: ReviewPresenceUser[]) => void) => () => void;
+    disconnect: () => void | Promise<void>;
+};
+type ReviewPresenceAdapter = {
+    label: string;
+    connect: (context: ReviewPresenceContext) => Promise<ReviewPresenceSession> | ReviewPresenceSession;
+};
+interface CreateReviewPagesOptions {
+    root?: string;
+    exclude?: (href: string) => boolean;
+}
+interface ReviewShellProps {
+    projectId: string;
+    pages: ReviewShellPage[];
+    adapters: ReviewShellAdapters;
+    presets?: ReviewShellViewportPreset[];
+    ruler?: ReviewRulerConfig;
+    initialPrompt?: string;
+    reviewPathPrefix?: string;
+    presence?: ReviewPresenceAdapter;
+}
+interface ReviewShellMountOptions extends ReviewShellProps {
+    rootId?: string;
+}
+
+declare const createReviewPagesFromGlob: (entries: ReviewShellGlobEntries, options?: CreateReviewPagesOptions) => ReviewShellPage[];
+
+declare const DEFAULT_REVIEW_VIEWPORT_PRESETS: ReviewShellViewportPreset[];
+
+type LocalPresenceAdapterOptions = {
+    channelName?: string;
+    heartbeatMs?: number;
+    staleMs?: number;
+};
+declare const createLocalPresenceAdapter: (options?: LocalPresenceAdapterOptions) => ReviewPresenceAdapter;
+declare const createFallbackPresenceAdapter: (primaryAdapter: ReviewPresenceAdapter, fallbackAdapter: ReviewPresenceAdapter) => ReviewPresenceAdapter;
+
+type SupabaseRealtimeStatus = 'SUBSCRIBED' | 'CHANNEL_ERROR' | 'TIMED_OUT' | 'CLOSED' | string;
+type SupabaseRealtimeChannel = {
+    topic?: string;
+    on: (type: 'presence', filter: {
+        event: 'sync' | 'join' | 'leave';
+    }, callback: () => void) => SupabaseRealtimeChannel;
+    subscribe: (callback: (status: SupabaseRealtimeStatus, error?: Error) => void) => SupabaseRealtimeChannel;
+    track: (payload: ReviewPresenceUser) => Promise<unknown>;
+    untrack: () => Promise<unknown>;
+    presenceState: () => Record<string, unknown[]>;
+    teardown?: () => void;
+};
+type SupabasePresenceClient = {
+    channel: (topic: string, options?: {
+        config?: {
+            private?: boolean;
+            presence?: {
+                key?: string;
+            };
+        };
+    }) => SupabaseRealtimeChannel;
+    getChannels?: () => SupabaseRealtimeChannel[];
+    removeChannel: (channel: SupabaseRealtimeChannel) => Promise<unknown>;
+};
+type SupabasePresenceAdapterOptions = {
+    client: SupabasePresenceClient;
+    channelPrefix?: string;
+    private?: boolean;
+};
+declare const createSupabasePresenceAdapter: ({ client, channelPrefix, private: isPrivate, }: SupabasePresenceAdapterOptions) => ReviewPresenceAdapter;
+
+declare const ReviewShell: ({ projectId, pages, adapters, presets, ruler, initialPrompt, reviewPathPrefix, presence }: ReviewShellProps) => React.JSX.Element;
+declare const mountReviewShell: (options: ReviewShellMountOptions) => void;
+
+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 };

package/dist/react-shell.d.ts

@@ -0,0 +1,156 @@
+import React from 'react';
+import { f as ReviewItemScope, s as ReviewSource, o as ReviewMode, W as WebReviewKitAdapter, a as ReviewItemStatus, e as ReviewItem, q as ReviewRulerConfig } from './types-D_mNjOHx.js';
+
+type ReviewShellViewportKind = Exclude<ReviewItemScope, 'dom'>;
+type ReviewShellViewportPreset = {
+    label: string;
+    width: number;
+    height: number;
+    kind?: ReviewShellViewportKind;
+    designWidth?: number;
+    designHeight?: number;
+};
+type ReviewShellPage = {
+    href: string;
+};
+type ReviewShellGlobEntries = Record<string, unknown>;
+type ReviewShellStatusOption = {
+    value: ReviewItemStatus;
+    label: string;
+};
+type ReviewShellUpdateStatusInput = {
+    id: string;
+    item: ReviewItem;
+    status: ReviewItemStatus;
+    statusOption: ReviewShellStatusOption;
+    statusIndex: number;
+};
+type ReviewShellSubmissionPatch = Partial<Pick<ReviewItem, 'externalIssueId' | 'externalIssueUrl' | 'submittedAt' | 'submitStatus' | 'submitError'>>;
+type ReviewShellSyncSubmissionInput = {
+    id: string;
+    item: ReviewItem;
+    patch: ReviewShellSubmissionPatch;
+};
+type ReviewShellAdapter = {
+    label: ReviewSource;
+    pageId?: string;
+    get: WebReviewKitAdapter['get'];
+    list: WebReviewKitAdapter['list'];
+    create: WebReviewKitAdapter['create'];
+    statusOptions?: readonly ReviewShellStatusOption[];
+    updateStatus?: (input: ReviewShellUpdateStatusInput) => Promise<ReviewItem>;
+    syncSubmission?: (input: ReviewShellSyncSubmissionInput) => Promise<ReviewItem>;
+    remove?: WebReviewKitAdapter['remove'];
+};
+type ReviewShellAdapterMap = {
+    local: WebReviewKitAdapter;
+    remote?: WebReviewKitAdapter | null;
+    remotePageId?: string;
+};
+type ReviewShellAdapters = ReviewShellAdapterMap | ReviewShellAdapter[];
+type ReviewPresenceStatus = 'idle' | 'reviewing' | 'editing';
+type ReviewPresenceViewport = {
+    label: string;
+    width: number;
+    height: number;
+    kind: ReviewShellViewportKind;
+};
+type ReviewPresenceState = {
+    projectId: string;
+    sessionId: string;
+    userId: string;
+    displayName: string;
+    color: string;
+    routeKey: string;
+    target: string;
+    source: ReviewSource;
+    viewport: ReviewPresenceViewport;
+    mode: ReviewMode;
+    selectedItemId?: string | null;
+    selectedReviewNumber?: number | null;
+    status: ReviewPresenceStatus;
+    updatedAt: string;
+};
+type ReviewPresenceUser = ReviewPresenceState;
+type ReviewPresenceContext = {
+    projectId: string;
+    sessionId: string;
+    userId: string;
+    displayName: string;
+    color: string;
+    initialState: ReviewPresenceState;
+};
+type ReviewPresenceSession = {
+    update: (state: Partial<ReviewPresenceState>) => void | Promise<void>;
+    subscribe: (callback: (users: ReviewPresenceUser[]) => void) => () => void;
+    disconnect: () => void | Promise<void>;
+};
+type ReviewPresenceAdapter = {
+    label: string;
+    connect: (context: ReviewPresenceContext) => Promise<ReviewPresenceSession> | ReviewPresenceSession;
+};
+interface CreateReviewPagesOptions {
+    root?: string;
+    exclude?: (href: string) => boolean;
+}
+interface ReviewShellProps {
+    projectId: string;
+    pages: ReviewShellPage[];
+    adapters: ReviewShellAdapters;
+    presets?: ReviewShellViewportPreset[];
+    ruler?: ReviewRulerConfig;
+    initialPrompt?: string;
+    reviewPathPrefix?: string;
+    presence?: ReviewPresenceAdapter;
+}
+interface ReviewShellMountOptions extends ReviewShellProps {
+    rootId?: string;
+}
+
+declare const createReviewPagesFromGlob: (entries: ReviewShellGlobEntries, options?: CreateReviewPagesOptions) => ReviewShellPage[];
+
+declare const DEFAULT_REVIEW_VIEWPORT_PRESETS: ReviewShellViewportPreset[];
+
+type LocalPresenceAdapterOptions = {
+    channelName?: string;
+    heartbeatMs?: number;
+    staleMs?: number;
+};
+declare const createLocalPresenceAdapter: (options?: LocalPresenceAdapterOptions) => ReviewPresenceAdapter;
+declare const createFallbackPresenceAdapter: (primaryAdapter: ReviewPresenceAdapter, fallbackAdapter: ReviewPresenceAdapter) => ReviewPresenceAdapter;
+
+type SupabaseRealtimeStatus = 'SUBSCRIBED' | 'CHANNEL_ERROR' | 'TIMED_OUT' | 'CLOSED' | string;
+type SupabaseRealtimeChannel = {
+    topic?: string;
+    on: (type: 'presence', filter: {
+        event: 'sync' | 'join' | 'leave';
+    }, callback: () => void) => SupabaseRealtimeChannel;
+    subscribe: (callback: (status: SupabaseRealtimeStatus, error?: Error) => void) => SupabaseRealtimeChannel;
+    track: (payload: ReviewPresenceUser) => Promise<unknown>;
+    untrack: () => Promise<unknown>;
+    presenceState: () => Record<string, unknown[]>;
+    teardown?: () => void;
+};
+type SupabasePresenceClient = {
+    channel: (topic: string, options?: {
+        config?: {
+            private?: boolean;
+            presence?: {
+                key?: string;
+            };
+        };
+    }) => SupabaseRealtimeChannel;
+    getChannels?: () => SupabaseRealtimeChannel[];
+    removeChannel: (channel: SupabaseRealtimeChannel) => Promise<unknown>;
+};
+type SupabasePresenceAdapterOptions = {
+    client: SupabasePresenceClient;
+    channelPrefix?: string;
+    private?: boolean;
+};
+declare const createSupabasePresenceAdapter: ({ client, channelPrefix, private: isPrivate, }: SupabasePresenceAdapterOptions) => ReviewPresenceAdapter;
+
+declare const ReviewShell: ({ projectId, pages, adapters, presets, ruler, initialPrompt, reviewPathPrefix, presence }: ReviewShellProps) => React.JSX.Element;
+declare const mountReviewShell: (options: ReviewShellMountOptions) => void;
+
+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 };