uidex 0.3.0 → 0.5.0

package/dist/cloud/index.d.cts

@@ -1,89 +1,10 @@
-interface ConsoleLogEntry {
-    level: "log" | "warn" | "error" | "info";
-    message: string;
-    timestamp: string;
-}
-interface NetworkErrorEntry {
-    url: string;
-    method: string;
-    status: number | null;
-    statusText: string | null;
-    timestamp: string;
-}
-interface Viewport {
-    width: number;
-    height: number;
-}
-interface SourceRef {
-    filePath: string;
-    line: number;
-}
-interface FeedbackSuggestedTarget {
-    integrationId: string;
-    targetConfig: Record<string, unknown>;
-}
-interface FeedbackPayload {
-    type: "bug" | "feature" | "improvement" | "question";
-    severity: "low" | "medium" | "high" | "critical";
-    title?: string;
-    description: string;
-    componentId: string;
-    element?: string | null;
-    sources?: SourceRef[];
-    url: string;
-    path: string;
-    route?: string | null;
-    pageTitle?: string;
-    sessionId?: string;
-    reporterEmail?: string;
-    reporterName?: string;
-    timestamp: string;
-    viewport: Viewport;
-    screen: Viewport;
-    userAgent: string;
-    locale?: string;
-    environment?: string;
-    appVersion?: string;
-    consoleLogs?: ConsoleLogEntry[];
-    networkErrors?: NetworkErrorEntry[];
-    metadata?: Record<string, string>;
-    screenshot?: string;
-    suggestedTarget?: FeedbackSuggestedTarget;
-}
-interface FeedbackExternalLink {
-    ok: boolean;
-    url?: string;
-    key?: string;
-    error?: string;
-}
-interface FeedbackResult {
+import { ReportPayload, ReportResult, IngestConfig, ReportListResponse, PinRecord, ArchiveReason } from '@uidex/api-client';
+export { ArchiveReason, IngestConfig, PinRecord, ReportListRecord, ReportListResponse, ReportPayload, ReportResult } from '@uidex/api-client';
+
+interface UserIdentity {
     id: string;
-    sequenceNumber: number;
-    externalLink?: FeedbackExternalLink;
-}
-interface IngestConfigEpic {
-    key: string;
-    summary: string;
-    status: string;
-}
-interface IngestConfig {
-    hasJira: boolean;
-    integrationId?: string;
-    epics?: IngestConfigEpic[];
-}
-/**
- * Generic so third-party adapters (e.g. `uidex-cloud`) can plug in their own
- * payload/result/integration shapes. SDK-bundled `cloud()` returns the
- * defaulted form. `ViewContext.cloud` uses the fully-open variant; consumers
- * that need the SDK shape narrow with `as CloudAdapter`.
- */
-interface CloudAdapter<TPayload = FeedbackPayload, TResult = FeedbackResult, TIntegrations = {
-    getConfig(): Promise<IngestConfig>;
-}> {
-    readonly feedback: {
-        submit(payload: TPayload): Promise<TResult>;
-    };
-    readonly integrations: TIntegrations;
+    name?: string;
+    avatar?: string;
 }
 
 declare const DEFAULT_CLOUD_ENDPOINT = "https://app.uidex.dev";
@@ -91,6 +12,10 @@ interface CloudOptions {
     projectKey: string;
     endpoint?: string;
     fetch?: typeof fetch;
+    git?: {
+        branch?: string;
+        commit?: string;
+    };
 }
 declare class CloudError extends Error {
     readonly status: number;
@@ -102,7 +27,56 @@ declare class CloudError extends Error {
         details?: unknown;
     });
 }
+type RealtimePresenceUser = {
+    userId: string;
+    name: string;
+    avatar: string | null;
+};
+type RealtimeChannelState = "connecting" | "connected" | "disconnected";
+interface RealtimeConnectOpts {
+    user: UserIdentity;
+    route: string;
+}
+interface RealtimeChannel {
+    readonly state: RealtimeChannelState;
+    connect(): void;
+    disconnect(): void;
+    joinRoute(route: string): void;
+    onPresence(cb: (users: RealtimePresenceUser[]) => void): () => void;
+    onPin(cb: (pin: PinRecord) => void): () => void;
+}
+interface CloudAdapter<TPayload = ReportPayload, TResult = ReportResult, TIntegrations = {
+    getConfig(): Promise<IngestConfig>;
+    getCachedConfig(): IngestConfig | null;
+}> {
+    readonly reports: {
+        submit(payload: TPayload): Promise<TResult>;
+        list?(opts?: {
+            page?: number;
+            limit?: number;
+        }): Promise<ReportListResponse>;
+    };
+    readonly integrations: TIntegrations;
+    readonly realtime: {
+        connect(opts: RealtimeConnectOpts): RealtimeChannel;
+    };
+    readonly pins: {
+        list(params: {
+            route?: string;
+            entities?: string;
+        }): Promise<PinRecord[]>;
+        archive(reportId: string, reason?: ArchiveReason): Promise<void>;
+    };
+}
 
 declare function cloud(options: CloudOptions): CloudAdapter;
 
-export { type CloudAdapter, CloudError, type CloudOptions, DEFAULT_CLOUD_ENDPOINT, type FeedbackExternalLink, type FeedbackPayload, type FeedbackResult, type FeedbackSuggestedTarget, type IngestConfig, type IngestConfigEpic, type SourceRef, cloud };
+type RealtimeChannelOptions = {
+    /** Builds the WebSocket URL on each (re)connect attempt. Allows the caller to refresh `route` query params. */
+    buildUrl: () => string;
+    /** Optional WebSocket constructor override (testing). Defaults to `globalThis.WebSocket`. */
+    WebSocketImpl?: typeof WebSocket;
+};
+declare function createRealtimeChannel(options: RealtimeChannelOptions): RealtimeChannel;
+
+export { type CloudAdapter, CloudError, type CloudOptions, DEFAULT_CLOUD_ENDPOINT, type RealtimeChannel, type RealtimeChannelState, type RealtimeConnectOpts, type RealtimePresenceUser, cloud, createRealtimeChannel };

package/dist/cloud/index.d.ts

@@ -1,89 +1,10 @@
-interface ConsoleLogEntry {
-    level: "log" | "warn" | "error" | "info";
-    message: string;
-    timestamp: string;
-}
-interface NetworkErrorEntry {
-    url: string;
-    method: string;
-    status: number | null;
-    statusText: string | null;
-    timestamp: string;
-}
-interface Viewport {
-    width: number;
-    height: number;
-}
-interface SourceRef {
-    filePath: string;
-    line: number;
-}
-interface FeedbackSuggestedTarget {
-    integrationId: string;
-    targetConfig: Record<string, unknown>;
-}
-interface FeedbackPayload {
-    type: "bug" | "feature" | "improvement" | "question";
-    severity: "low" | "medium" | "high" | "critical";
-    title?: string;
-    description: string;
-    componentId: string;
-    element?: string | null;
-    sources?: SourceRef[];
-    url: string;
-    path: string;
-    route?: string | null;
-    pageTitle?: string;
-    sessionId?: string;
-    reporterEmail?: string;
-    reporterName?: string;
-    timestamp: string;
-    viewport: Viewport;
-    screen: Viewport;
-    userAgent: string;
-    locale?: string;
-    environment?: string;
-    appVersion?: string;
-    consoleLogs?: ConsoleLogEntry[];
-    networkErrors?: NetworkErrorEntry[];
-    metadata?: Record<string, string>;
-    screenshot?: string;
-    suggestedTarget?: FeedbackSuggestedTarget;
-}
-interface FeedbackExternalLink {
-    ok: boolean;
-    url?: string;
-    key?: string;
-    error?: string;
-}
-interface FeedbackResult {
+import { ReportPayload, ReportResult, IngestConfig, ReportListResponse, PinRecord, ArchiveReason } from '@uidex/api-client';
+export { ArchiveReason, IngestConfig, PinRecord, ReportListRecord, ReportListResponse, ReportPayload, ReportResult } from '@uidex/api-client';
+
+interface UserIdentity {
     id: string;
-    sequenceNumber: number;
-    externalLink?: FeedbackExternalLink;
-}
-interface IngestConfigEpic {
-    key: string;
-    summary: string;
-    status: string;
-}
-interface IngestConfig {
-    hasJira: boolean;
-    integrationId?: string;
-    epics?: IngestConfigEpic[];
-}
-/**
- * Generic so third-party adapters (e.g. `uidex-cloud`) can plug in their own
- * payload/result/integration shapes. SDK-bundled `cloud()` returns the
- * defaulted form. `ViewContext.cloud` uses the fully-open variant; consumers
- * that need the SDK shape narrow with `as CloudAdapter`.
- */
-interface CloudAdapter<TPayload = FeedbackPayload, TResult = FeedbackResult, TIntegrations = {
-    getConfig(): Promise<IngestConfig>;
-}> {
-    readonly feedback: {
-        submit(payload: TPayload): Promise<TResult>;
-    };
-    readonly integrations: TIntegrations;
+    name?: string;
+    avatar?: string;
 }
 
 declare const DEFAULT_CLOUD_ENDPOINT = "https://app.uidex.dev";
@@ -91,6 +12,10 @@ interface CloudOptions {
     projectKey: string;
     endpoint?: string;
     fetch?: typeof fetch;
+    git?: {
+        branch?: string;
+        commit?: string;
+    };
 }
 declare class CloudError extends Error {
     readonly status: number;
@@ -102,7 +27,56 @@ declare class CloudError extends Error {
         details?: unknown;
     });
 }
+type RealtimePresenceUser = {
+    userId: string;
+    name: string;
+    avatar: string | null;
+};
+type RealtimeChannelState = "connecting" | "connected" | "disconnected";
+interface RealtimeConnectOpts {
+    user: UserIdentity;
+    route: string;
+}
+interface RealtimeChannel {
+    readonly state: RealtimeChannelState;
+    connect(): void;
+    disconnect(): void;
+    joinRoute(route: string): void;
+    onPresence(cb: (users: RealtimePresenceUser[]) => void): () => void;
+    onPin(cb: (pin: PinRecord) => void): () => void;
+}
+interface CloudAdapter<TPayload = ReportPayload, TResult = ReportResult, TIntegrations = {
+    getConfig(): Promise<IngestConfig>;
+    getCachedConfig(): IngestConfig | null;
+}> {
+    readonly reports: {
+        submit(payload: TPayload): Promise<TResult>;
+        list?(opts?: {
+            page?: number;
+            limit?: number;
+        }): Promise<ReportListResponse>;
+    };
+    readonly integrations: TIntegrations;
+    readonly realtime: {
+        connect(opts: RealtimeConnectOpts): RealtimeChannel;
+    };
+    readonly pins: {
+        list(params: {
+            route?: string;
+            entities?: string;
+        }): Promise<PinRecord[]>;
+        archive(reportId: string, reason?: ArchiveReason): Promise<void>;
+    };
+}
 
 declare function cloud(options: CloudOptions): CloudAdapter;
 
-export { type CloudAdapter, CloudError, type CloudOptions, DEFAULT_CLOUD_ENDPOINT, type FeedbackExternalLink, type FeedbackPayload, type FeedbackResult, type FeedbackSuggestedTarget, type IngestConfig, type IngestConfigEpic, type SourceRef, cloud };
+type RealtimeChannelOptions = {
+    /** Builds the WebSocket URL on each (re)connect attempt. Allows the caller to refresh `route` query params. */
+    buildUrl: () => string;
+    /** Optional WebSocket constructor override (testing). Defaults to `globalThis.WebSocket`. */
+    WebSocketImpl?: typeof WebSocket;
+};
+declare function createRealtimeChannel(options: RealtimeChannelOptions): RealtimeChannel;
+
+export { type CloudAdapter, CloudError, type CloudOptions, DEFAULT_CLOUD_ENDPOINT, type RealtimeChannel, type RealtimeChannelState, type RealtimeConnectOpts, type RealtimePresenceUser, cloud, createRealtimeChannel };