@bodhiapp/setup-modal-types 0.0.20 → 0.0.21

package/dist/state.d.ts

@@ -0,0 +1,42 @@
+import { Browser, EnvState, OS } from './platform';
+import { ExtensionState } from './extension';
+import { ServerState } from './server';
+import { LnaServerState, LnaState } from './lna';
+export declare enum SetupStep {
+    PLATFORM_CHECK = "platform-check",
+    SERVER_SETUP = "server-setup",
+    LNA_SETUP = "lna-setup",
+    EXTENSION_SETUP = "extension-setup",
+    COMPLETE = "complete"
+}
+export type SelectedConnection = 'lna' | 'extension' | null;
+export interface UserConfirmations {
+    /** Whether user has confirmed server installation */
+    serverInstall: boolean;
+}
+export declare const DEFAULT_USER_CONFIRMATIONS: UserConfirmations;
+export interface SetupState {
+    /** Extension state details */
+    extension: ExtensionState;
+    /** Server state details (via extension) */
+    server: ServerState;
+    /** LNA connection state */
+    lna: LnaState;
+    /** Server state details (via LNA) */
+    lnaServer: LnaServerState;
+    /** Environment detection */
+    env: EnvState;
+    /** Browser platforms list */
+    browsers: Browser[];
+    /** Operating systems list */
+    os: OS[];
+    /** User confirmations for manual steps */
+    userConfirmations: UserConfirmations;
+    /** User's preferred connection method (null = auto-select based on priority) */
+    selectedConnection: SelectedConnection;
+}
+/**
+ * Default setup state used during initialization before parent sends real state
+ * Represents "loading" state - unknown platform, no extension, no server
+ */
+export declare const DEFAULT_SETUP_STATE: SetupState;

package/dist/type-guards.d.ts

@@ -0,0 +1,26 @@
+import { ExtensionState, ExtensionStateNotReady, ExtensionStateReady } from './extension';
+import { ServerState, ServerStateError, ServerStatePending, ServerStateReachable, ServerStateReady, ServerStateUnreachable } from './server';
+import { LnaServerState, LnaServerStateError, LnaServerStatePending, LnaServerStateReady, LnaServerStateResourceAdmin, LnaServerStateSetup, LnaState, LnaStateDenied, LnaStateGranted, LnaStatePrompt, LnaStateSkipped, LnaStateUnreachable, LnaStateUnsupported } from './lna';
+import { Browser, NotSupportedBrowser, NotSupportedOS, OS, SupportedBrowser, SupportedOS } from './platform';
+export declare function isExtensionStateReady(ext: ExtensionState): ext is ExtensionStateReady;
+export declare function isExtensionStateNotReady(ext: ExtensionState): ext is ExtensionStateNotReady;
+export declare function isServerStateReady(server: ServerState): server is ServerStateReady;
+export declare function isServerStateReachable(server: ServerState): server is ServerStateReachable;
+export declare function isServerStatePending(server: ServerState): server is ServerStatePending;
+export declare function isServerStateUnreachable(server: ServerState): server is ServerStateUnreachable;
+export declare function isServerStateError(server: ServerState): server is ServerStateError;
+export declare function isLnaStatePrompt(lna: LnaState): lna is LnaStatePrompt;
+export declare function isLnaStateSkipped(lna: LnaState): lna is LnaStateSkipped;
+export declare function isLnaStateGranted(lna: LnaState): lna is LnaStateGranted;
+export declare function isLnaStateUnreachable(lna: LnaState): lna is LnaStateUnreachable;
+export declare function isLnaStateDenied(lna: LnaState): lna is LnaStateDenied;
+export declare function isLnaStateUnsupported(lna: LnaState): lna is LnaStateUnsupported;
+export declare function isLnaServerStatePending(server: LnaServerState): server is LnaServerStatePending;
+export declare function isLnaServerStateReady(server: LnaServerState): server is LnaServerStateReady;
+export declare function isLnaServerStateSetup(server: LnaServerState): server is LnaServerStateSetup;
+export declare function isLnaServerStateResourceAdmin(server: LnaServerState): server is LnaServerStateResourceAdmin;
+export declare function isLnaServerStateError(server: LnaServerState): server is LnaServerStateError;
+export declare function isSupportedBrowser(browser: Browser): browser is SupportedBrowser;
+export declare function isNotSupportedBrowser(browser: Browser): browser is NotSupportedBrowser;
+export declare function isSupportedOS(os: OS): os is SupportedOS;
+export declare function isNotSupportedOS(os: OS): os is NotSupportedOS;

package/package.json

@@ -1,20 +1,29 @@
 {
   "name": "@bodhiapp/setup-modal-types",
-  "version": "0.0.20",
+  "version": "0.0.21",
   "description": "TypeScript types for Bodhi Setup Modal",
   "type": "module",
-  "main": "index.ts",
-  "types": "index.ts",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "exports": {
     ".": {
-      "types": "./index.ts",
-      "import": "./index.ts",
-      "require": "./index.ts"
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
     }
   },
   "files": [
-    "*.ts"
+    "dist"
   ],
+  "scripts": {
+    "build": "vite build",
+    "clean": "rimraf dist"
+  },
+  "devDependencies": {
+    "vite": "^7.1.12",
+    "vite-plugin-dts": "^4.5.4",
+    "rimraf": "^6.0.1",
+    "typescript": "^5.8.3"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/BodhiSearch/bodhi-js.git",

package/extension.ts

@@ -1,31 +0,0 @@
-// Extension error codes
-export type ExtensionErrorCode = 'ext-not-installed' | 'ext-connection-failed' | 'ext-unsupported-version';
-
-// Extension error code constants
-export const EXT_NOT_INSTALLED: ExtensionErrorCode = 'ext-not-installed';
-export const EXT_CONNECTION_FAILED: ExtensionErrorCode = 'ext-connection-failed';
-export const EXT_UNSUPPORTED_VERSION: ExtensionErrorCode = 'ext-unsupported-version';
-
-// Extension state interfaces
-export interface ExtensionStateReady {
-  /** Current extension status */
-  status: 'ready';
-  /** Extension version */
-  version: string;
-  /** Extension ID (always present when ready) */
-  id: string;
-}
-
-export interface ExtensionStateNotReady {
-  /** Current extension status */
-  status: 'unreachable' | 'not-installed' | 'unsupported';
-  /** Error details */
-  error: {
-    /** Error message */
-    message: string;
-    /** Error code */
-    code: ExtensionErrorCode;
-  };
-}
-
-export type ExtensionState = ExtensionStateReady | ExtensionStateNotReady;

package/lna.ts

@@ -1,75 +0,0 @@
-// LNA error codes
-export type LnaErrorCode = 'lna-unreachable' | 'lna-permission-denied';
-
-// LNA error code constants
-export const LNA_UNREACHABLE: LnaErrorCode = 'lna-unreachable';
-export const LNA_PERMISSION_DENIED: LnaErrorCode = 'lna-permission-denied';
-
-// LNA (Local Network Access) state interfaces
-// Aligned with browser permission API states: prompt, granted, denied
-export interface LnaStatePrompt {
-  status: 'prompt';
-  serverUrl?: string; // For URL input default from localStorage
-}
-
-export interface LnaStateSkipped {
-  status: 'skipped';
-  serverUrl?: string; // For URL input default from localStorage
-}
-
-export interface LnaStateGranted {
-  status: 'granted';
-  serverUrl: string;
-}
-
-export interface LnaStateUnreachable {
-  status: 'unreachable';
-  serverUrl: string;
-  error: {
-    message: string;
-    code: LnaErrorCode;
-  };
-}
-
-export interface LnaStateDenied {
-  status: 'denied';
-  error: {
-    message: string;
-    code: LnaErrorCode;
-  };
-}
-
-export interface LnaStateUnsupported {
-  status: 'unsupported';
-}
-
-export type LnaState = LnaStatePrompt | LnaStateSkipped | LnaStateGranted | LnaStateUnreachable | LnaStateDenied | LnaStateUnsupported;
-
-// LNA Server state interfaces
-export interface LnaServerStatePending {
-  status: 'pending-lna-ready';
-}
-
-export interface LnaServerStateReady {
-  status: 'ready';
-  version: string;
-}
-
-export interface LnaServerStateSetup {
-  status: 'setup';
-  version: string;
-}
-
-export interface LnaServerStateResourceAdmin {
-  status: 'resource-admin';
-  version: string;
-}
-
-export interface LnaServerStateError {
-  status: 'error';
-  error: {
-    message: string;
-  };
-}
-
-export type LnaServerState = LnaServerStatePending | LnaServerStateReady | LnaServerStateSetup | LnaServerStateResourceAdmin | LnaServerStateError;

package/message-types.ts

@@ -1,185 +0,0 @@
-/**
- * Message Type Registry - Single source of truth for all protocol message types
- *
- * This registry maps message type strings to their payload/response shapes.
- * All other types (RequestPayload, ResponsePayload, etc.) are derived from this registry.
- *
- * Design: Each entry defines:
- * - request: The payload type sent with the request
- * - response: The payload type expected in the response
- *
- * For events (one-way messages), response is void.
- */
-
-import type { SetupState } from './state';
-
-/**
- * Central registry mapping message types to their payload/response shapes
- * Single source of truth - everything else is inferred!
- */
-export interface MessageTypeRegistry {
-  // === Modal → Parent (Commands) ===
-
-  /**
-   * Modal is ready and requesting initial state
-   * Sent on modal mount
-   */
-  'modal:ready': {
-    request: void;
-    response: { setupState: SetupState };
-  };
-
-  /**
-   * User requested to refresh platform detection
-   * Triggers re-detection of browser, OS, extension, server
-   */
-  'modal:refresh': {
-    request: void;
-    response: { setupState: SetupState };
-  };
-
-  /**
-   * User requested to close the modal
-   * Parent should hide/destroy modal
-   */
-  'modal:close': {
-    request: void;
-    response: void;
-  };
-
-  /**
-   * Setup completed successfully
-   * Signals parent that user has finished setup
-   */
-  'modal:complete': {
-    request: void;
-    response: void;
-  };
-
-  /**
-   * User requested LNA connection to specific server URL
-   * Triggers LNA permission request and connection attempt
-   */
-  'modal:lna:connect': {
-    request: { serverUrl: string };
-    response: { success: boolean };
-  };
-
-  /**
-   * User chose to skip LNA setup
-   * Falls back to extension-only mode
-   */
-  'modal:lna:skip': {
-    request: void;
-    response: { success: boolean };
-  };
-
-  /**
-   * User confirmed server installation status
-   * Used when server needs to be installed
-   */
-  'modal:confirm-server-install': {
-    request: { confirmed: boolean };
-    response: { success: boolean };
-  };
-
-  /**
-   * User selected preferred connection method
-   * Allows choosing between LNA and Extension paths
-   */
-  'modal:select-connection': {
-    request: { connection: 'lna' | 'extension' };
-    response: { success: boolean };
-  };
-
-  // === Parent → Modal (Events) ===
-
-  /**
-   * Parent sending updated state to modal
-   * Fired when platform detection results change
-   */
-  'parent:state-update': {
-    request: { setupState: SetupState };
-    response: void;
-  };
-}
-
-// === Derived Types with Full Inference ===
-
-/**
- * Union of all valid message type strings
- * Derived from MessageTypeRegistry keys
- */
-export type MessageType = keyof MessageTypeRegistry;
-
-/**
- * Extract request payload type for a given message type
- * Returns the 'request' field from the registry entry
- */
-export type RequestPayload<T extends MessageType> = MessageTypeRegistry[T]['request'];
-
-/**
- * Extract response payload type for a given message type
- * Returns the 'response' field from the registry entry
- */
-export type ResponsePayload<T extends MessageType> = MessageTypeRegistry[T]['response'];
-
-/**
- * Message type constants - Type-safe identifiers
- *
- * @example
- * switch (message.type) {
- *   case MSG.MODAL_READY:
- *     // Type-safe constant, no typos possible
- *     break;
- * }
- */
-export const MSG = {
-  // Modal lifecycle
-  MODAL_READY: 'modal:ready',
-  MODAL_REFRESH: 'modal:refresh',
-  MODAL_CLOSE: 'modal:close',
-  MODAL_COMPLETE: 'modal:complete',
-
-  // LNA actions
-  MODAL_LNA_CONNECT: 'modal:lna:connect',
-  MODAL_LNA_SKIP: 'modal:lna:skip',
-
-  // Server confirmation
-  MODAL_CONFIRM_SERVER_INSTALL: 'modal:confirm-server-install',
-
-  // Connection selection
-  MODAL_SELECT_CONNECTION: 'modal:select-connection',
-
-  // Parent → Modal events
-  PARENT_STATE_UPDATE: 'parent:state-update',
-} as const;
-
-/**
- * Type guard that narrows RequestMessage to specific type WITH payload typing
- *
- * Use this for full type safety when you need access to typed payload fields.
- * The guard narrows the generic RequestMessage to RequestMessage<T> where T
- * determines the payload type.
- *
- * @example
- * if (isMessageType(msg, MSG.MODAL_LNA_CONNECT)) {
- *   // msg.payload is { serverUrl: string } - fully typed!
- *   console.log(msg.payload.serverUrl); // Autocomplete works!
- * }
- */
-export function isMessageType<T extends MessageType>(msg: { type: string }, type: T): msg is { type: T } {
-  return msg.type === type;
-}
-
-/**
- * Type-safe request handler map
- * Enforces correct payload access AND correct return type for each message
- *
- * Each handler receives a RequestMessage<K> where K is the specific message type,
- * providing full type safety for payload access. The handler must return the
- * correct ResponsePayload<K> type.
- */
-export type RequestHandlers = {
-  [K in MessageType]?: (msg: { type: K; requestId: string; payload: RequestPayload<K> }) => ResponsePayload<K>;
-};

package/platform.ts

@@ -1,43 +0,0 @@
-// Browser and OS type definitions
-export type BrowserType = 'chrome' | 'edge' | 'firefox' | 'safari' | 'unknown';
-export type OSType = 'macos' | 'windows' | 'linux' | 'unknown';
-
-// Environment state interface
-export interface EnvState {
-  os: OSType;
-  browser: BrowserType;
-}
-
-// Browser platform definitions
-export interface SupportedBrowser {
-  id: BrowserType;
-  status: 'supported';
-  name: string;
-  extension_url: string;
-}
-
-export interface NotSupportedBrowser {
-  id: BrowserType;
-  status: 'not-supported';
-  name: string;
-  github_issue_url?: string;
-}
-
-export type Browser = SupportedBrowser | NotSupportedBrowser;
-
-// OS platform definitions
-export interface SupportedOS {
-  id: OSType;
-  status: 'supported';
-  name: string;
-  download_url: string;
-}
-
-export interface NotSupportedOS {
-  id: OSType;
-  status: 'not-supported';
-  name: string;
-  github_issue_url?: string;
-}
-
-export type OS = SupportedOS | NotSupportedOS;

package/protocol.ts

@@ -1,97 +0,0 @@
-/**
- * Core protocol types for setup-modal ↔ parent communication
- *
- * Design principles:
- * - Type-safe request/response correlation
- * - Discriminated unions for message kinds
- * - Branded types for ID safety
- * - Full TypeScript inference from MessageTypeRegistry
- */
-
-import type { MessageType, RequestPayload, ResponsePayload } from './message-types';
-
-/** Branded type for type-safe request IDs */
-export type RequestId = string & { readonly __brand: 'RequestId' };
-
-/** Message kind discriminator */
-export type MessageKind = 'request' | 'response' | 'error' | 'event';
-
-/**
- * Request message - expects a response
- * Sent by either modal or parent to request an action
- */
-export interface RequestMessage<T extends MessageType = MessageType> {
-  readonly kind: 'request';
-  readonly type: T;
-  readonly requestId: RequestId;
-  readonly payload: RequestPayload<T>;
-}
-
-/**
- * Response message - correlates to a request
- * Sent in response to a RequestMessage with matching requestId
- */
-export interface ResponseMessage<T extends MessageType = MessageType> {
-  readonly kind: 'response';
-  readonly type: T;
-  readonly requestId: RequestId;
-  readonly payload: ResponsePayload<T>;
-}
-
-/**
- * Error response - indicates request failure
- * Sent instead of ResponseMessage when request cannot be fulfilled
- */
-export interface ErrorMessage {
-  readonly kind: 'error';
-  readonly requestId: RequestId;
-  readonly error: {
-    code: string;
-    message: string;
-    details?: unknown;
-  };
-}
-
-/**
- * Event message - fire-and-forget notification
- * No response expected, used for one-way state updates
- */
-export interface EventMessage<T extends MessageType = MessageType> {
-  readonly kind: 'event';
-  readonly type: T;
-  readonly payload: RequestPayload<T>;
-}
-
-/**
- * Union of all protocol messages
- * Discriminated by 'kind' field for type narrowing
- */
-export type ProtocolMessage = RequestMessage | ResponseMessage | ErrorMessage | EventMessage;
-
-/**
- * Type guard to check if message is a request
- */
-export function isRequestMessage(msg: ProtocolMessage): msg is RequestMessage {
-  return msg.kind === 'request';
-}
-
-/**
- * Type guard to check if message is a response
- */
-export function isResponseMessage(msg: ProtocolMessage): msg is ResponseMessage {
-  return msg.kind === 'response';
-}
-
-/**
- * Type guard to check if message is an error
- */
-export function isErrorMessage(msg: ProtocolMessage): msg is ErrorMessage {
-  return msg.kind === 'error';
-}
-
-/**
- * Type guard to check if message is an event
- */
-export function isEventMessage(msg: ProtocolMessage): msg is EventMessage {
-  return msg.kind === 'event';
-}

package/server.ts

@@ -1,82 +0,0 @@
-// Server error codes
-export type ServerErrorCode =
-  | 'server-pending-ext-ready'
-  | 'server-conn-refused'
-  | 'server-conn-timeout'
-  | 'server-not-found'
-  | 'server-network-unreachable'
-  | 'server-service-unavailable'
-  | 'server-unexpected-error'
-  | 'server-in-setup-status'
-  | 'server-in-admin-status';
-
-// Server error code constants
-export const SERVER_PENDING_EXT_READY: ServerErrorCode = 'server-pending-ext-ready';
-export const SERVER_CONN_REFUSED: ServerErrorCode = 'server-conn-refused';
-export const SERVER_CONN_TIMEOUT: ServerErrorCode = 'server-conn-timeout';
-export const SERVER_NOT_FOUND: ServerErrorCode = 'server-not-found';
-export const SERVER_NETWORK_UNREACHABLE: ServerErrorCode = 'server-network-unreachable';
-export const SERVER_SERVICE_UNAVAILABLE: ServerErrorCode = 'server-service-unavailable';
-export const SERVER_UNEXPECTED_ERROR: ServerErrorCode = 'server-unexpected-error';
-export const SERVER_IN_SETUP_STATUS: ServerErrorCode = 'server-in-setup-status';
-export const SERVER_IN_ADMIN_STATUS: ServerErrorCode = 'server-in-admin-status';
-
-// Server state interfaces
-export interface ServerStateReady {
-  /** Current server status */
-  status: 'ready';
-  /** Server version */
-  version: string;
-}
-
-export interface ServerStateReachable {
-  /** Current server status */
-  status: 'setup' | 'resource-admin';
-  /** Server version */
-  version: string;
-  /** Error details */
-  error: {
-    /** Error message */
-    message: string;
-    /** Error code */
-    code: ServerErrorCode;
-  };
-}
-
-export interface ServerStatePending {
-  /** Current server status */
-  status: 'pending-extension-ready';
-  /** Error details */
-  error: {
-    /** Error message */
-    message: string;
-    /** Error code */
-    code: ServerErrorCode;
-  };
-}
-
-export interface ServerStateUnreachable {
-  /** Current server status */
-  status: 'unreachable';
-  /** Error details */
-  error: {
-    /** Error message */
-    message: string;
-    /** Error code */
-    code: ServerErrorCode;
-  };
-}
-
-export interface ServerStateError {
-  /** Current server status */
-  status: 'error';
-  /** Error details */
-  error: {
-    /** Error message */
-    message: string;
-    /** Error code */
-    code: ServerErrorCode;
-  };
-}
-
-export type ServerState = ServerStateReady | ServerStateReachable | ServerStatePending | ServerStateUnreachable | ServerStateError;

package/state.ts

@@ -1,65 +0,0 @@
-import type { Browser, EnvState, OS } from './platform';
-import type { ExtensionState } from './extension';
-import type { ServerState } from './server';
-import type { LnaServerState, LnaState } from './lna';
-
-// Step enum for navigation
-export enum SetupStep {
-  PLATFORM_CHECK = 'platform-check',
-  SERVER_SETUP = 'server-setup',
-  LNA_SETUP = 'lna-setup',
-  EXTENSION_SETUP = 'extension-setup',
-  COMPLETE = 'complete',
-}
-
-// Selected connection type for user preference
-export type SelectedConnection = 'lna' | 'extension' | null;
-
-// User confirmations interface for manual confirmation states
-export interface UserConfirmations {
-  /** Whether user has confirmed server installation */
-  serverInstall: boolean;
-}
-
-// Default user confirmations
-export const DEFAULT_USER_CONFIRMATIONS: UserConfirmations = {
-  serverInstall: false,
-};
-
-// Main setup state interface
-export interface SetupState {
-  /** Extension state details */
-  extension: ExtensionState;
-  /** Server state details (via extension) */
-  server: ServerState;
-  /** LNA connection state */
-  lna: LnaState;
-  /** Server state details (via LNA) */
-  lnaServer: LnaServerState;
-  /** Environment detection */
-  env: EnvState;
-  /** Browser platforms list */
-  browsers: Browser[];
-  /** Operating systems list */
-  os: OS[];
-  /** User confirmations for manual steps */
-  userConfirmations: UserConfirmations;
-  /** User's preferred connection method (null = auto-select based on priority) */
-  selectedConnection: SelectedConnection;
-}
-
-/**
- * Default setup state used during initialization before parent sends real state
- * Represents "loading" state - unknown platform, no extension, no server
- */
-export const DEFAULT_SETUP_STATE: SetupState = {
-  extension: { status: 'not-installed', error: { message: 'Loading...', code: 'ext-not-installed' } },
-  server: { status: 'pending-extension-ready', error: { message: 'Loading...', code: 'server-pending-ext-ready' } },
-  lna: { status: 'prompt' },
-  lnaServer: { status: 'pending-lna-ready' },
-  env: { browser: 'unknown', os: 'unknown' },
-  browsers: [],
-  os: [],
-  userConfirmations: DEFAULT_USER_CONFIRMATIONS,
-  selectedConnection: null,
-};