@bodhiapp/setup-modal-v2-types 0.0.35

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export type { ProbeStatusV2, ServerStatusV2, BrowserInfoV2, SetupStateV2 } from './state';
+export { DEFAULT_LOCAL_URL, CLOUD_URL, INSTALL_URL, DEFAULT_SETUP_STATE_V2 } from './state';
+export type { MessageTypeRegistryV2, MessageTypeV2, RequestPayloadV2, ResponsePayloadV2, RequestHandlersV2 } from './messages';
+export { MSG_V2, isMessageTypeV2 } from './messages';
+export type { RequestIdV2, MessageKindV2, RequestMessageV2, ResponseMessageV2, ErrorMessageV2, EventMessageV2, ProtocolMessageV2, } from './protocol';
+export { isRequestMessageV2, isResponseMessageV2, isErrorMessageV2, isEventMessageV2 } from './protocol';
+export { isProbeIdle, isProbing, isConnected, isNotReady, isProbeError, isNetworkError, isTerminalStatus } from './type-guards';

package/dist/index.js

@@ -0,0 +1,70 @@
+const DEFAULT_LOCAL_URL = "http://localhost:1135";
+const CLOUD_URL = "https://cloud.getbodhi.app";
+const INSTALL_URL = "https://getbodhi.app";
+const DEFAULT_SETUP_STATE_V2 = {
+  probeStatus: "idle",
+  serverUrl: DEFAULT_LOCAL_URL,
+  browser: { name: "unknown", version: 0, supported: false }
+};
+const MSG_V2 = {
+  MODAL_READY: "modal:ready",
+  MODAL_PROBE: "modal:probe",
+  MODAL_COMPLETE: "modal:complete",
+  MODAL_CLOSE: "modal:close",
+  PARENT_STATE_UPDATE: "parent:state-update"
+};
+function isMessageTypeV2(msg, type) {
+  return msg.type === type;
+}
+function isRequestMessageV2(msg) {
+  return msg.kind === "request";
+}
+function isResponseMessageV2(msg) {
+  return msg.kind === "response";
+}
+function isErrorMessageV2(msg) {
+  return msg.kind === "error";
+}
+function isEventMessageV2(msg) {
+  return msg.kind === "event";
+}
+function isProbeIdle(state) {
+  return state.probeStatus === "idle";
+}
+function isProbing(state) {
+  return state.probeStatus === "probing";
+}
+function isConnected(state) {
+  return state.probeStatus === "connected";
+}
+function isNotReady(state) {
+  return state.probeStatus === "not-ready";
+}
+function isProbeError(state) {
+  return state.probeStatus === "error";
+}
+function isNetworkError(state) {
+  return state.probeStatus === "network-error";
+}
+function isTerminalStatus(status) {
+  return status === "connected";
+}
+export {
+  CLOUD_URL,
+  DEFAULT_LOCAL_URL,
+  DEFAULT_SETUP_STATE_V2,
+  INSTALL_URL,
+  MSG_V2,
+  isConnected,
+  isErrorMessageV2,
+  isEventMessageV2,
+  isMessageTypeV2,
+  isNetworkError,
+  isNotReady,
+  isProbeError,
+  isProbeIdle,
+  isProbing,
+  isRequestMessageV2,
+  isResponseMessageV2,
+  isTerminalStatus
+};

package/dist/messages.d.ts

@@ -0,0 +1,51 @@
+import { SetupStateV2 } from './state';
+export interface MessageTypeRegistryV2 {
+    'modal:ready': {
+        request: void;
+        response: {
+            setupState: SetupStateV2;
+        };
+    };
+    'modal:probe': {
+        request: {
+            serverUrl: string;
+        };
+        response: {
+            setupState: SetupStateV2;
+        };
+    };
+    'modal:complete': {
+        request: void;
+        response: void;
+    };
+    'modal:close': {
+        request: void;
+        response: void;
+    };
+    'parent:state-update': {
+        request: SetupStateV2;
+        response: void;
+    };
+}
+export type MessageTypeV2 = keyof MessageTypeRegistryV2;
+export type RequestPayloadV2<T extends MessageTypeV2> = MessageTypeRegistryV2[T]['request'];
+export type ResponsePayloadV2<T extends MessageTypeV2> = MessageTypeRegistryV2[T]['response'];
+export declare const MSG_V2: {
+    readonly MODAL_READY: "modal:ready";
+    readonly MODAL_PROBE: "modal:probe";
+    readonly MODAL_COMPLETE: "modal:complete";
+    readonly MODAL_CLOSE: "modal:close";
+    readonly PARENT_STATE_UPDATE: "parent:state-update";
+};
+export type RequestHandlersV2 = {
+    [K in MessageTypeV2]?: (msg: {
+        type: K;
+        requestId: string;
+        payload: RequestPayloadV2<K>;
+    }) => ResponsePayloadV2<K> | Promise<ResponsePayloadV2<K>>;
+};
+export declare function isMessageTypeV2<T extends MessageTypeV2>(msg: {
+    type: string;
+}, type: T): msg is {
+    type: T;
+};

package/dist/protocol.d.ts

@@ -0,0 +1,36 @@
+import { MessageTypeV2, RequestPayloadV2, ResponsePayloadV2 } from './messages';
+export type RequestIdV2 = string & {
+    readonly __brand: 'RequestIdV2';
+};
+export type MessageKindV2 = 'request' | 'response' | 'error' | 'event';
+export interface RequestMessageV2<T extends MessageTypeV2 = MessageTypeV2> {
+    readonly kind: 'request';
+    readonly type: T;
+    readonly requestId: RequestIdV2;
+    readonly payload: RequestPayloadV2<T>;
+}
+export interface ResponseMessageV2<T extends MessageTypeV2 = MessageTypeV2> {
+    readonly kind: 'response';
+    readonly type: T;
+    readonly requestId: RequestIdV2;
+    readonly payload: ResponsePayloadV2<T>;
+}
+export interface ErrorMessageV2 {
+    readonly kind: 'error';
+    readonly requestId: RequestIdV2;
+    readonly error: {
+        code: string;
+        message: string;
+        details?: unknown;
+    };
+}
+export interface EventMessageV2<T extends MessageTypeV2 = MessageTypeV2> {
+    readonly kind: 'event';
+    readonly type: T;
+    readonly payload: RequestPayloadV2<T>;
+}
+export type ProtocolMessageV2 = RequestMessageV2 | ResponseMessageV2 | ErrorMessageV2 | EventMessageV2;
+export declare function isRequestMessageV2(msg: ProtocolMessageV2): msg is RequestMessageV2;
+export declare function isResponseMessageV2(msg: ProtocolMessageV2): msg is ResponseMessageV2;
+export declare function isErrorMessageV2(msg: ProtocolMessageV2): msg is ErrorMessageV2;
+export declare function isEventMessageV2(msg: ProtocolMessageV2): msg is EventMessageV2;

package/dist/state.d.ts

@@ -0,0 +1,21 @@
+export type ProbeStatusV2 = 'idle' | 'probing' | 'connected' | 'not-ready' | 'error' | 'network-error';
+export type ServerStatusV2 = 'ready' | 'setup' | 'resource_admin' | 'unreachable' | 'error';
+export interface BrowserInfoV2 {
+    name: string;
+    version: number;
+    supported: boolean;
+}
+export interface SetupStateV2 {
+    serverUrl: string;
+    browser: BrowserInfoV2;
+    probeStatus: ProbeStatusV2;
+    serverStatus?: ServerStatusV2;
+    error?: {
+        code: string;
+        message: string;
+    };
+}
+export declare const DEFAULT_LOCAL_URL = "http://localhost:1135";
+export declare const CLOUD_URL = "https://cloud.getbodhi.app";
+export declare const INSTALL_URL = "https://getbodhi.app";
+export declare const DEFAULT_SETUP_STATE_V2: SetupStateV2;

package/dist/type-guards.d.ts

@@ -0,0 +1,8 @@
+import { ProbeStatusV2, SetupStateV2 } from './state';
+export declare function isProbeIdle(state: SetupStateV2): boolean;
+export declare function isProbing(state: SetupStateV2): boolean;
+export declare function isConnected(state: SetupStateV2): boolean;
+export declare function isNotReady(state: SetupStateV2): boolean;
+export declare function isProbeError(state: SetupStateV2): boolean;
+export declare function isNetworkError(state: SetupStateV2): boolean;
+export declare function isTerminalStatus(status: ProbeStatusV2): boolean;

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@bodhiapp/setup-modal-v2-types",
+  "version": "0.0.35",
+  "description": "TypeScript types for Bodhi Setup Modal v2",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "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",
+    "directory": "setup-modal-v2/src/types"
+  },
+  "license": "MIT",
+  "author": "BodhiSearch",
+  "publishConfig": {
+    "access": "public"
+  }
+}