janela 0.6.0 → 0.7.0

package/README.md

@@ -138,7 +138,7 @@ framework templates' default.
 
 ```ts
 // src-host/main.ts
-import { defineCommands, defineEvents, type JanelaApp } from "janela/host";
+import type { JanelaApp } from "janela/host";
 
 export type AppCommands = {
   add:   { args: { a: number; b: number }; result: number };
@@ -147,13 +147,11 @@ export type AppCommands = {
 };
 export type AppEvents = { added: number };
 
-export const commands = defineCommands<AppCommands>();
-export const events = defineEvents<AppEvents>();
-
-export type App = { commands: typeof commands; events: typeof events };
+/** The app, carrying its contract. This is what the page imports. */
+export type App = JanelaApp<AppCommands, AppEvents>;
 
 // Typing the app with the contract is what makes the methods below checked.
-export function setup(app: JanelaApp<AppCommands, AppEvents>): void {
+export function setup(app: App): void {
   app.command("add", (args) => {            // args inferred: { a: number; b: number }
     app.emit("added", args.a + args.b);     // event name and payload checked
     return args.a + args.b;                 // return type checked against the contract
@@ -312,6 +310,37 @@ nested modal loop would otherwise re-enter the host loop underneath a live TS
 frame; [docs/native-shell.md](../../docs/native-shell.md) has the details, the
 per-platform table, and the Windows GUI-subsystem note.
 
+## Migrating from 0.6.x
+
+The contract lives entirely in the types now, so the runtime tokens are gone.
+Name the app instead of wrapping its two tables:
+
+```ts
+// before (0.6.x)
+import { defineCommands, defineEvents, type JanelaApp } from "janela/host";
+
+export const commands = defineCommands<AppCommands>();
+export const events = defineEvents<AppEvents>();
+export type App = { commands: typeof commands; events: typeof events };
+
+export function setup(app: JanelaApp<AppCommands, AppEvents>): void { … }
+
+// after (0.7.x)
+import type { JanelaApp } from "janela/host";
+
+export type App = JanelaApp<AppCommands, AppEvents>;
+
+export function setup(app: App): void { … }
+```
+
+`AppCommands` and `AppEvents` are unchanged, and so is every page: the
+frontend still writes `createClient<App>()` and `client.invoke(...)`, because
+`createClient` reads the contract off either shape.
+
+`defineCommands` and `defineEvents` still exist and still work — they are
+`@deprecated` no-ops that only ever carried types — so a 0.6.x project keeps
+compiling and running untouched.
+
 ## Migrating from 0.5.x
 
 The contract now rides on the app itself, so the standalone registrars are no
@@ -333,14 +362,13 @@ export function setup(app: JanelaApp<AppCommands, AppEvents>): void {
 }
 ```
 
-Declare each contract as a named type so the same one feeds `defineCommands`
-and the `setup` signature:
+Declare each contract as a named type and hand both to the app (0.7.x drops
+the `defineCommands` / `defineEvents` tokens entirely — see above):
 
 ```ts
 export type AppCommands = { add: { args: { a: number; b: number }; result: number } };
 export type AppEvents = { added: number };
-export const commands = defineCommands<AppCommands>();
-export const events = defineEvents<AppEvents>();
+export type App = JanelaApp<AppCommands, AppEvents>;
 ```
 
 `on`, `onAsync` and `emit` still work — they are `@deprecated` one-line
@@ -358,9 +386,11 @@ Two things are new:
 
 - `listen()` (and the injected `janela.listen`) now **return a disposer**.
   Previously they returned nothing, so existing code is unaffected.
-- The **typed contract** — `defineCommands` / `defineEvents` on the host,
+- The **typed contract** — a contract-typed app on the host,
   `createClient<App>()` on the page. The framework templates now scaffold with
-  it. See [The typed contract](#the-typed-contract).
+  it. See [The typed contract](#the-typed-contract). (0.4.x shipped this with
+  `defineCommands` / `defineEvents` tokens; 0.7.x replaced them with the `App`
+  type alias below, and the tokens are deprecated but still work.)
 
 To adopt it in an existing app, declare what the host already exposes and swap
 the registrations:
@@ -373,10 +403,11 @@ app.command("add", (args) => {
 });
 
 // after
-export const commands = defineCommands<{
+export type AppCommands = {
   add: { args: { a: number; b: number }; result: number };
-}>();
-export type App = { commands: typeof commands; events: typeof events };
+};
+export type AppEvents = { added: number };
+export type App = JanelaApp<AppCommands, AppEvents>;
 
 app.command("add", (args) => args.a + args.b);   // args inferred, no cast
 ```

package/api/index.d.ts

@@ -6,6 +6,7 @@
  * parse.
  */
 
+import type { JanelaApp } from "../runtime/janela";
 import type { CommandShapes, Commands, Events } from "../runtime/types";
 
 /** Removes a subscription created by `listen` / `client.on`. */
@@ -50,17 +51,36 @@ export declare function listen<T = unknown>(
 // Typed contract
 // ---------------------------------------------------------------------------
 
-/** Anything shaped like a host contract module's exported `App` type. */
+/**
+ * Anything shaped like a host contract module's exported `App` type.
+ *
+ * @deprecated The `{ commands, events }` wrapper of 0.5.x/0.6.x. Export
+ * `type App = JanelaApp<AppCommands, AppEvents>` instead.
+ */
 export interface Contract {
   commands: Commands<CommandShapes>;
   events: Events<unknown>;
 }
 
-/** The command table declared by a contract. */
-export type CommandsOf<A> = A extends { commands: Commands<infer M> } ? M : never;
+/**
+ * The command table declared by a contract.
+ *
+ * Reads the contract off a `JanelaApp<C, E>` — what a host's `App` type is
+ * from 0.7.0 — and falls back to the 0.5.x/0.6.x `{ commands, events }`
+ * wrapper, so a project written against either shape keeps checking.
+ */
+export type CommandsOf<A> = A extends JanelaApp<infer M, infer _E>
+  ? M
+  : A extends { commands: Commands<infer M> }
+    ? M
+    : never;
 
-/** The event table declared by a contract. */
-export type EventsOf<A> = A extends { events: Events<infer E> } ? E : never;
+/** The event table declared by a contract; see CommandsOf for the two shapes. */
+export type EventsOf<A> = A extends JanelaApp<infer _M, infer E>
+  ? E
+  : A extends { events: Events<infer E> }
+    ? E
+    : never;
 
 /**
  * A client bound to a host contract: command names, argument shapes, result
@@ -89,7 +109,7 @@ export interface JanelaClient<A> {
  * Build a client checked against a host's contract.
  *
  * ```ts
- * import type { App } from "../src-host/main";
+ * import type { App } from "../src-host/main";   // App = JanelaApp<Cmds, Evts>
  * const client = createClient<App>();
  * const sum = await client.invoke("add", { a: 2, b: 40 });   // number
  * const off = client.on("added", (v) => console.log(v));      // v: number

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "janela",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "Desktop apps in pure TypeScript, compiled to native. No Rust, no Node, no Electron.",
   "type": "module",
   "bin": {

package/runtime/types.ts

@@ -85,11 +85,10 @@ export interface WindowConfig {
 // Payloads still cross as JSON, so these types are compile-time only. Nothing
 // validates a malformed payload at runtime.
 //
-// SHAPE NOTE: the registrars below are standalone generic FUNCTIONS taking the
-// contract as a value, rather than methods on a returned registrar object.
-// That is not a style choice — scriptc cannot dispatch a generic method
-// through an interface-typed receiver (SC1090), so `commands.on(...)` does not
-// compile in a host build, while `on(app, commands, ...)` does.
+// The contract is carried by the app's own type — `JanelaApp<Commands, Events>`
+// — so the tables below are types and nothing more. The `Commands`/`Events`
+// tokens and their `define*` constructors are the 0.5.x/0.6.x shape, kept so
+// projects written against it still compile.
 
 /** One command's argument and result types. */
 export interface CommandShape {
@@ -116,17 +115,25 @@ export interface Events<E> {
 /**
  * Declare the commands a host exposes.
  *
+ * @deprecated The contract needs no runtime token. Declare the tables as
+ * types and name the app itself:
+ *
  * ```ts
- * export const commands = defineCommands<{
- *   add: { args: { a: number; b: number }; result: number };
- * }>();
+ * export type AppCommands = { add: { args: { a: number; b: number }; result: number } };
+ * export type AppEvents = { added: number };
+ * export type App = JanelaApp<AppCommands, AppEvents>;
+ * export function setup(app: App): void { … }
  * ```
  */
 export function defineCommands<M extends CommandShapes>(): Commands<M> {
   return {};
 }
 
-/** Declare the events a host emits: `defineEvents<{ added: number }>()`. */
+/**
+ * Declare the events a host emits: `defineEvents<{ added: number }>()`.
+ *
+ * @deprecated Pass the event table to `JanelaApp` instead — see defineCommands.
+ */
 export function defineEvents<E>(): Events<E> {
   return {};
 }

package/templates/react/files/src-host/main.ts

@@ -1,9 +1,10 @@
 // src-host/main.ts — your app's backend, compiled to native code by scriptc.
 //
-// The contract below is the single declaration of what this app exposes. The
-// frontend imports `App` with `import type`, so the page is checked against
-// these exact types — command names, argument shapes, results and event
-// payloads — with no code generation and nothing to keep in sync.
+// The two tables below are the single declaration of what this app exposes,
+// and `App` names an app that carries them. The frontend imports `App` with
+// `import type`, so the page is checked against these exact types — command
+// names, argument shapes, results and event payloads — with no code
+// generation and nothing to keep in sync.
 //
 // Two gotchas inherited from scriptc:
 //   - never use a bare FFI-backed call as a complete variable initializer;
@@ -12,7 +13,7 @@
 //     an `undefined` argument lowers to a zero-parameter function and fails
 //     to compile.
 
-import { defineCommands, defineEvents, type JanelaApp } from "janela/host";
+import type { JanelaApp } from "janela/host";
 
 /** Every command this app answers. Declared once; the page checks against it. */
 export type AppCommands = {
@@ -28,16 +29,13 @@ export type AppEvents = {
   added: number;
 };
 
-export const commands = defineCommands<AppCommands>();
-export const events = defineEvents<AppEvents>();
-
 /** The contract the page imports with `import type { App } from "../src-host/main"`. */
-export type App = { commands: typeof commands; events: typeof events };
+export type App = JanelaApp<AppCommands, AppEvents>;
 
 // Typing the app with the contract is what makes `app.command` checked: the
 // name must be one of the declared ones, `args` is inferred from it, and the
 // return value has to match. Same for `app.emit`.
-export function setup(app: JanelaApp<AppCommands, AppEvents>): void {
+export function setup(app: App): void {
   app.command("add", (args) => {
     const sum = args.a + args.b;
     app.emit("added", sum);

package/templates/solid/files/src-host/main.ts

@@ -1,9 +1,10 @@
 // src-host/main.ts — your app's backend, compiled to native code by scriptc.
 //
-// The contract below is the single declaration of what this app exposes. The
-// frontend imports `App` with `import type`, so the page is checked against
-// these exact types — command names, argument shapes, results and event
-// payloads — with no code generation and nothing to keep in sync.
+// The two tables below are the single declaration of what this app exposes,
+// and `App` names an app that carries them. The frontend imports `App` with
+// `import type`, so the page is checked against these exact types — command
+// names, argument shapes, results and event payloads — with no code
+// generation and nothing to keep in sync.
 //
 // Two gotchas inherited from scriptc:
 //   - never use a bare FFI-backed call as a complete variable initializer;
@@ -12,7 +13,7 @@
 //     an `undefined` argument lowers to a zero-parameter function and fails
 //     to compile.
 
-import { defineCommands, defineEvents, type JanelaApp } from "janela/host";
+import type { JanelaApp } from "janela/host";
 
 /** Every command this app answers. Declared once; the page checks against it. */
 export type AppCommands = {
@@ -28,16 +29,13 @@ export type AppEvents = {
   added: number;
 };
 
-export const commands = defineCommands<AppCommands>();
-export const events = defineEvents<AppEvents>();
-
 /** The contract the page imports with `import type { App } from "../src-host/main"`. */
-export type App = { commands: typeof commands; events: typeof events };
+export type App = JanelaApp<AppCommands, AppEvents>;
 
 // Typing the app with the contract is what makes `app.command` checked: the
 // name must be one of the declared ones, `args` is inferred from it, and the
 // return value has to match. Same for `app.emit`.
-export function setup(app: JanelaApp<AppCommands, AppEvents>): void {
+export function setup(app: App): void {
   app.command("add", (args) => {
     const sum = args.a + args.b;
     app.emit("added", sum);

package/templates/svelte/files/src-host/main.ts

@@ -1,9 +1,10 @@
 // src-host/main.ts — your app's backend, compiled to native code by scriptc.
 //
-// The contract below is the single declaration of what this app exposes. The
-// frontend imports `App` with `import type`, so the page is checked against
-// these exact types — command names, argument shapes, results and event
-// payloads — with no code generation and nothing to keep in sync.
+// The two tables below are the single declaration of what this app exposes,
+// and `App` names an app that carries them. The frontend imports `App` with
+// `import type`, so the page is checked against these exact types — command
+// names, argument shapes, results and event payloads — with no code
+// generation and nothing to keep in sync.
 //
 // Two gotchas inherited from scriptc:
 //   - never use a bare FFI-backed call as a complete variable initializer;
@@ -12,7 +13,7 @@
 //     an `undefined` argument lowers to a zero-parameter function and fails
 //     to compile.
 
-import { defineCommands, defineEvents, type JanelaApp } from "janela/host";
+import type { JanelaApp } from "janela/host";
 
 /** Every command this app answers. Declared once; the page checks against it. */
 export type AppCommands = {
@@ -28,16 +29,13 @@ export type AppEvents = {
   added: number;
 };
 
-export const commands = defineCommands<AppCommands>();
-export const events = defineEvents<AppEvents>();
-
 /** The contract the page imports with `import type { App } from "../src-host/main"`. */
-export type App = { commands: typeof commands; events: typeof events };
+export type App = JanelaApp<AppCommands, AppEvents>;
 
 // Typing the app with the contract is what makes `app.command` checked: the
 // name must be one of the declared ones, `args` is inferred from it, and the
 // return value has to match. Same for `app.emit`.
-export function setup(app: JanelaApp<AppCommands, AppEvents>): void {
+export function setup(app: App): void {
   app.command("add", (args) => {
     const sum = args.a + args.b;
     app.emit("added", sum);

package/templates/vue/files/src-host/main.ts

@@ -1,9 +1,10 @@
 // src-host/main.ts — your app's backend, compiled to native code by scriptc.
 //
-// The contract below is the single declaration of what this app exposes. The
-// frontend imports `App` with `import type`, so the page is checked against
-// these exact types — command names, argument shapes, results and event
-// payloads — with no code generation and nothing to keep in sync.
+// The two tables below are the single declaration of what this app exposes,
+// and `App` names an app that carries them. The frontend imports `App` with
+// `import type`, so the page is checked against these exact types — command
+// names, argument shapes, results and event payloads — with no code
+// generation and nothing to keep in sync.
 //
 // Two gotchas inherited from scriptc:
 //   - never use a bare FFI-backed call as a complete variable initializer;
@@ -12,7 +13,7 @@
 //     an `undefined` argument lowers to a zero-parameter function and fails
 //     to compile.
 
-import { defineCommands, defineEvents, type JanelaApp } from "janela/host";
+import type { JanelaApp } from "janela/host";
 
 /** Every command this app answers. Declared once; the page checks against it. */
 export type AppCommands = {
@@ -28,16 +29,13 @@ export type AppEvents = {
   added: number;
 };
 
-export const commands = defineCommands<AppCommands>();
-export const events = defineEvents<AppEvents>();
-
 /** The contract the page imports with `import type { App } from "../src-host/main"`. */
-export type App = { commands: typeof commands; events: typeof events };
+export type App = JanelaApp<AppCommands, AppEvents>;
 
 // Typing the app with the contract is what makes `app.command` checked: the
 // name must be one of the declared ones, `args` is inferred from it, and the
 // return value has to match. Same for `app.emit`.
-export function setup(app: JanelaApp<AppCommands, AppEvents>): void {
+export function setup(app: App): void {
   app.command("add", (args) => {
     const sum = args.a + args.b;
     app.emit("added", sum);