@opentui/solid 0.2.1 → 0.2.3

package/package.json

@@ -4,7 +4,7 @@
   "main": "index.js",
   "types": "index.d.ts",
   "type": "module",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "description": "SolidJS renderer for OpenTUI",
   "license": "MIT",
   "repository": {
@@ -29,13 +29,17 @@
       "types": "./scripts/runtime-plugin-support.d.ts",
       "import": "./scripts/runtime-plugin-support.ts"
     },
+    "./runtime-plugin-support/configure": {
+      "types": "./scripts/runtime-plugin-support-configure.d.ts",
+      "import": "./scripts/runtime-plugin-support-configure.ts"
+    },
     "./jsx-runtime": "./jsx-runtime.d.ts",
     "./jsx-dev-runtime": "./jsx-runtime.d.ts"
   },
   "dependencies": {
     "@babel/core": "7.28.0",
     "@babel/preset-typescript": "7.27.1",
-    "@opentui/core": "0.2.1",
+    "@opentui/core": "0.2.3",
     "babel-plugin-module-resolver": "5.0.2",
     "babel-preset-solid": "1.9.12",
     "entities": "7.0.1",

package/scripts/runtime-plugin-support-configure.d.ts

@@ -0,0 +1,7 @@
+import { type RuntimeModuleEntry, type RuntimePluginRewriteOptions } from "@opentui/core/runtime-plugin";
+export interface SolidRuntimePluginSupportOptions {
+    additional?: Record<string, RuntimeModuleEntry>;
+    core?: RuntimeModuleEntry;
+    rewrite?: RuntimePluginRewriteOptions;
+}
+export declare function ensureRuntimePluginSupport(options?: SolidRuntimePluginSupportOptions): boolean;

package/scripts/runtime-plugin-support-configure.ts

@@ -0,0 +1,109 @@
+import { plugin as registerBunPlugin } from "bun"
+import * as coreRuntime from "@opentui/core"
+import {
+  createRuntimePlugin,
+  isCoreRuntimeModuleSpecifier,
+  runtimeModuleIdForSpecifier,
+  type RuntimeModuleEntry,
+  type RuntimePluginRewriteOptions,
+} from "@opentui/core/runtime-plugin"
+import * as solidJsRuntime from "solid-js"
+import * as solidJsStoreRuntime from "solid-js/store"
+import * as solidRuntime from "../index.js"
+import { ensureSolidTransformPlugin } from "./solid-plugin.js"
+
+const runtimePluginSupportInstalledKey = Symbol.for("opentui.solid.runtime-plugin-support")
+
+export interface SolidRuntimePluginSupportOptions {
+  additional?: Record<string, RuntimeModuleEntry>
+  core?: RuntimeModuleEntry
+  rewrite?: RuntimePluginRewriteOptions
+}
+
+interface RuntimePluginSupportInstall {
+  specifiers: ReadonlySet<string>
+  core: RuntimeModuleEntry
+  rewriteKey: string
+}
+
+type RuntimePluginSupportState = typeof globalThis & {
+  [runtimePluginSupportInstalledKey]?: RuntimePluginSupportInstall
+}
+
+const defaultRuntimeModules: Record<string, RuntimeModuleEntry> = {
+  "@opentui/solid": solidRuntime as Record<string, unknown>,
+  "solid-js": solidJsRuntime as Record<string, unknown>,
+  "solid-js/store": solidJsStoreRuntime as Record<string, unknown>,
+}
+
+function normalizeRewriteKey(rewrite: RuntimePluginRewriteOptions | undefined): string {
+  return `${rewrite?.nodeModulesRuntimeSpecifiers ?? true}:${rewrite?.nodeModulesBareSpecifiers ?? false}`
+}
+
+function createRuntimeModules(options?: SolidRuntimePluginSupportOptions): Record<string, RuntimeModuleEntry> {
+  return {
+    ...defaultRuntimeModules,
+    ...(options?.additional ?? {}),
+  }
+}
+
+function assertCompatibleInstall(
+  install: RuntimePluginSupportInstall,
+  modules: Record<string, RuntimeModuleEntry>,
+  options?: SolidRuntimePluginSupportOptions,
+): void {
+  for (const specifier of Object.keys(modules)) {
+    if (!install.specifiers.has(specifier)) {
+      throw new Error(
+        `OpenTUI Solid runtime plugin support is already installed without ${specifier}. Call ensureRuntimePluginSupport({ additional }) from @opentui/solid/runtime-plugin-support/configure before importing @opentui/solid/runtime-plugin-support.`,
+      )
+    }
+  }
+
+  if (options?.core && options.core !== install.core) {
+    throw new Error("OpenTUI Solid runtime plugin support is already installed with a different core runtime module.")
+  }
+
+  if (options?.rewrite && normalizeRewriteKey(options.rewrite) !== install.rewriteKey) {
+    throw new Error("OpenTUI Solid runtime plugin support is already installed with different rewrite options.")
+  }
+}
+
+export function ensureRuntimePluginSupport(options: SolidRuntimePluginSupportOptions = {}): boolean {
+  const state = globalThis as RuntimePluginSupportState
+  const modules = createRuntimeModules(options)
+  const core = options.core ?? (coreRuntime as Record<string, unknown>)
+  const rewriteKey = normalizeRewriteKey(options.rewrite)
+
+  const install = state[runtimePluginSupportInstalledKey]
+  if (install) {
+    assertCompatibleInstall(install, modules, options)
+    return false
+  }
+
+  ensureSolidTransformPlugin({
+    moduleName: runtimeModuleIdForSpecifier("@opentui/solid"),
+    resolvePath(specifier) {
+      if (!isCoreRuntimeModuleSpecifier(specifier) && !modules[specifier]) {
+        return null
+      }
+
+      return runtimeModuleIdForSpecifier(specifier)
+    },
+  })
+
+  registerBunPlugin(
+    createRuntimePlugin({
+      core,
+      additional: modules,
+      rewrite: options.rewrite,
+    }),
+  )
+
+  state[runtimePluginSupportInstalledKey] = {
+    specifiers: new Set(Object.keys(modules)),
+    core,
+    rewriteKey,
+  }
+  return true
+}

package/scripts/runtime-plugin-support.d.ts

@@ -1 +1,3 @@
-export declare function ensureRuntimePluginSupport(): boolean;
+import { ensureRuntimePluginSupport } from "./runtime-plugin-support-configure.js";
+export { ensureRuntimePluginSupport };
+export type { SolidRuntimePluginSupportOptions } from "./runtime-plugin-support-configure.js";

package/scripts/runtime-plugin-support.ts

@@ -1,76 +1,6 @@
-import { plugin as registerBunPlugin } from "bun"
-import * as coreRuntime from "@opentui/core"
-import {
-  createRuntimePlugin,
-  isCoreRuntimeModuleSpecifier,
-  runtimeModuleIdForSpecifier,
-  type RuntimeModuleEntry,
-} from "@opentui/core/runtime-plugin"
-import * as solidJsRuntime from "solid-js"
-import * as solidJsStoreRuntime from "solid-js/store"
-import * as solidRuntime from "../index.js"
-import { ensureSolidTransformPlugin } from "./solid-plugin.js"
+import { ensureRuntimePluginSupport } from "./runtime-plugin-support-configure.js"
 
-const runtimePluginSupportInstalledKey = Symbol.for("opentui.solid.runtime-plugin-support")
-const THREE_RUNTIME_SPECIFIER = "@opentui/three"
-
-type RuntimePluginSupportState = typeof globalThis & {
-  [runtimePluginSupportInstalledKey]?: boolean
-}
-
-const loadThreeRuntimeModule = async (): Promise<Record<string, unknown>> => {
-  try {
-    return (await importRuntimeModule(THREE_RUNTIME_SPECIFIER)) as Record<string, unknown>
-  } catch (error) {
-    const message = error instanceof Error ? error.message : String(error)
-    throw new Error(
-      `Failed to load @opentui/three runtime module. Install @opentui/three in the host app before loading 3D plugins. ${message}`,
-    )
-  }
-}
-
-function importRuntimeModule(specifier: string): Promise<Record<string, unknown>> {
-  return import(specifier) as Promise<Record<string, unknown>>
-}
-
-const additionalRuntimeModules: Record<string, RuntimeModuleEntry> = {
-  [THREE_RUNTIME_SPECIFIER]: loadThreeRuntimeModule,
-  "@opentui/solid": solidRuntime as Record<string, unknown>,
-  "solid-js": solidJsRuntime as Record<string, unknown>,
-  "solid-js/store": solidJsStoreRuntime as Record<string, unknown>,
-}
-
-const resolveRuntimeSpecifier = (specifier: string): string | null => {
-  if (!isCoreRuntimeModuleSpecifier(specifier) && !additionalRuntimeModules[specifier]) {
-    return null
-  }
-
-  return runtimeModuleIdForSpecifier(specifier)
-}
-
-export function ensureRuntimePluginSupport(): boolean {
-  const state = globalThis as RuntimePluginSupportState
-
-  if (state[runtimePluginSupportInstalledKey]) {
-    return false
-  }
-
-  ensureSolidTransformPlugin({
-    moduleName: runtimeModuleIdForSpecifier("@opentui/solid"),
-    resolvePath(specifier) {
-      return resolveRuntimeSpecifier(specifier)
-    },
-  })
-
-  registerBunPlugin(
-    createRuntimePlugin({
-      core: coreRuntime as Record<string, unknown>,
-      additional: additionalRuntimeModules,
-    }),
-  )
-
-  state[runtimePluginSupportInstalledKey] = true
-  return true
-}
+export { ensureRuntimePluginSupport }
+export type { SolidRuntimePluginSupportOptions } from "./runtime-plugin-support-configure.js"
 
 ensureRuntimePluginSupport()