browser-runtime-octane 0.0.0-stage → 0.0.1

package/README.md

@@ -1,3 +1,29 @@
-# Temporary Holding Version
+# browser-runtime-octane
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Octane compiler and renderer plugin for [`browser-module-runtime`](https://www.npmjs.com/package/browser-module-runtime).
+
+## Install
+
+```sh
+npm install browser-module-runtime@0.0.1 browser-runtime-octane@0.0.1 octane@0.2.3
+```
+
+## Usage
+
+```js
+import {createRuntime} from 'browser-module-runtime';
+import {octane} from 'browser-runtime-octane';
+
+const runtime = createRuntime({plugins:[octane({version:'0.2.3'})]});
+runtime.define('/Counter.tsrx', `
+  import {useState} from 'octane';
+  export default function Counter() @{
+    const [count,setCount]=useState(0);
+    <button onClick={() => setCount(count+1)}>Count: {count}</button>
+  }
+`, {type:'octane'});
+const handle = await runtime.mount({module:'/Counter.tsrx',target:'#app'});
+// Later: await handle.dispose(); await runtime.dispose();
+```
+
+`type="octane"` delegates JSX, TSX, and TSRX detection to Octane's browser compiler (`octane/compiler`). Rendering uses `octane.createRoot`; the returned mount handle owns cleanup. An exact Octane `version` contributes its package-root mapping so generated `octane/internal/*` imports resolve through the runtime linker.

package/index.d.ts

@@ -0,0 +1,2 @@
+import type {RuntimePlugin} from 'browser-module-runtime';
+export declare function octane(options?:Record<string,unknown>):RuntimePlugin;

package/package.json

@@ -1,6 +1,41 @@
 {
   "name": "browser-runtime-octane",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.0.1",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./src/index.js"
+    }
+  },
+  "files": [
+    "src",
+    "index.d.ts",
+    "README.md"
+  ],
+  "peerDependenciesMeta": {
+    "octane": {
+      "optional": true
+    }
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "peerDependencies": {
+    "browser-module-runtime": "0.0.1",
+    "octane": "*"
+  },
+  "description": "Octane JSX, TSX, and TSRX compiler and renderer adapter for browser-module-runtime.",
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "browser",
+    "esm",
+    "runtime",
+    "modules",
+    "compiler",
+    "adapter",
+    "octane"
+  ]
+}

package/src/index.d.ts

@@ -0,0 +1 @@
+export * from '../index.js';

package/src/index.js

@@ -0,0 +1,34 @@
+/** Official Octane browser compiler uses compile(source, filename, options).
+ * Compiled TSRX/TSX/JSX is owned by Octane, not by the generic runtime. */
+export function octane({compiler,renderer,version='unverified',provider='esm.sh',compilerOptions={}}={}) {
+  let octaneRenderer=renderer;
+  let octaneCompiler=compiler;
+  let ownerRuntime;
+  const packageEntries=/^\d+\.\d+\.\d+(?:[-+][0-9A-Za-z.-]+)?$/.test(String(version))
+    ? {octane:{provider,version:String(version)}} : {};
+  return {
+    name:'octane',version:String(version),packageEntries,
+    configure({runtime}){ownerRuntime=runtime;},
+    compilers:[{
+      types:['octane'],extensions:['.tsrx','.tsx','.jsx'],
+      async compile(source,{id}) {
+        octaneCompiler ||= await (ownerRuntime ? ownerRuntime.import('octane/compiler') : import('octane/compiler'));
+        const invoke=typeof octaneCompiler==='function'?octaneCompiler:octaneCompiler.compile?.bind(octaneCompiler);
+        if(typeof invoke!=='function')throw new Error('octane/compiler must expose compile(source, filename, options)');
+        const result=await invoke(source,id,{mode:'client',...compilerOptions});
+        if(typeof result==='string')return {code:result};
+        if(!result||typeof result.code!=='string')throw new TypeError('Octane compiler must return a code string or {code, assets}.');
+        return result;
+      }
+    }],
+    renderers:[{
+      name:'octane',types:['octane'],
+      async mount({component,target,props}) {
+        octaneRenderer ||= await (ownerRuntime ? ownerRuntime.import('octane') : import('octane'));
+        const root=octaneRenderer.createRoot(target);
+        root.render(component,props);
+        return {dispose:()=>root.unmount()};
+      }
+    }]
+  };
+}