janela 0.7.0 → 0.8.0

package/README.md

@@ -141,9 +141,10 @@ framework templates' default.
 import type { JanelaApp } from "janela/host";
 
 export type AppCommands = {
-  add:   { args: { a: number; b: number }; result: number };
-  greet: { args: { name: string };         result: string };
-  wait:  { args: { ms: number };           result: string };
+  add:   (args: { a: number; b: number }) => number;
+  greet: (args: { name: string }) => string;
+  wait:  (args: { ms: number }) => string;
+  quit:  () => void;                        // a command that takes nothing
 };
 export type AppEvents = { added: number };
 
@@ -195,11 +196,23 @@ Two things worth knowing:
   own declarations rather than from an assertion you write by hand, which is
   only possible because both sides are TypeScript.
 
-Write `args: null` for a command that takes nothing — `args: undefined`
-lowers to a zero-parameter function and fails to compile.
+A command that takes nothing is declared `() => void`, and its handler
+returns `null` — every command answers the page's promise with a value, so
+`void` is normalised to `null`. The page calls it as
+`client.invoke("quit", null)`.
 
-The untyped `invoke` / `listen` still work unchanged; the contract is
-additive, and the `vanilla` template still uses the global.
+An **event payload is a single value** of any JSON-shaped type. For an event
+carrying several things, prefer an object (`{ done: number; total: number }`):
+adding a field later does not break existing listeners, and the names read
+better at the call site. A tuple works too, but note that only the payload
+*value* may be a tuple — the varargs spelling `app.emit("progress", 3, 10)`
+does not compile (`SC2011: values of type '[done: number, total: number]'
+have no static representation`, which would require `--dynamic` and ~620 KB
+of embedded engine).
+
+The `{ args; result }` record form of 0.5.x–0.7.x is still accepted, and the
+untyped `invoke` / `listen` still work unchanged; the contract is additive,
+and the `vanilla` template still uses the global.
 
 ## Async commands
 
@@ -310,6 +323,30 @@ 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.7.x
+
+Commands are declared as the functions they are. The old `{ args; result }`
+record form still compiles, so this is optional — but the function form is
+shorter, and a command that takes nothing is finally natural to write.
+
+```ts
+// 0.7.x
+export type AppCommands = {
+  add:  { args: { a: number; b: number }; result: number };
+  quit: { args: null; result: null };
+};
+
+// 0.8.0
+export type AppCommands = {
+  add:  (args: { a: number; b: number }) => number;
+  quit: () => void;
+};
+```
+
+Nothing else changes: `export type App = JanelaApp<AppCommands, AppEvents>`,
+`setup(app: App)`, `app.command(...)` and the page's `createClient<App>()` are
+all as they were. A handler for a `() => void` command returns `null`.
+
 ## Migrating from 0.6.x
 
 The contract lives entirely in the types now, so the runtime tokens are gone.

package/api/index.d.ts

@@ -6,7 +6,7 @@
  * parse.
  */
 
-import type { JanelaApp } from "../runtime/janela";
+import type { JanelaAppImpl } from "../runtime/janela";
 import type { CommandShapes, Commands, Events } from "../runtime/types";
 
 /** Removes a subscription created by `listen` / `client.on`. */
@@ -65,18 +65,22 @@ export interface Contract {
 /**
  * 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.
+ * Reads the contract off the app type — what a host's `App` 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.
+ *
+ * The inference targets the class rather than the `JanelaApp` alias: the
+ * alias applies `Norm<C>`, which cannot be inferred backwards, and the
+ * normalised table is what indexing wants in any case.
  */
-export type CommandsOf<A> = A extends JanelaApp<infer M, infer _E>
+export type CommandsOf<A> = A extends JanelaAppImpl<infer M, infer _E>
   ? M
   : A extends { commands: Commands<infer M> }
     ? M
     : 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>
+export type EventsOf<A> = A extends JanelaAppImpl<infer _M, infer E>
   ? E
   : A extends { events: Events<infer E> }
     ? E

package/bin/janela.mjs

@@ -516,17 +516,19 @@ function build(root, { devUrl = null, gui = true } = {}) {
     join(buildDir, "entry.ts"),
     `// Generated by janela — do not edit.\n` +
       `import { createApp } from "./janela";\n` +
-      `import type { CommandShapes, JanelaApp } from "./janela";\n` +
+      `import type { CommandShapes, JanelaAppImpl } from "./janela";\n` +
       `import { WINDOW } from "./config";\n` +
       `import { INDEX_HTML } from "./frontend";\n` +
       `import { setup } from "./main";\n\n` +
       `// The app's type parameters are read back off setup()'s own signature,\n` +
-      `// so a contract-typed setup(app: JanelaApp<App>) and a plain\n` +
-      `// setup(app: JanelaApp) each get an app instantiated to match. scriptc\n` +
-      `// monomorphises generic classes, so the right instantiation must be\n` +
-      `// CONSTRUCTED here - no cast can bridge JanelaApp<A> and JanelaApp<B>.\n` +
-      `type CmdsOf<F> = F extends (app: JanelaApp<infer C, infer _E>) => void ? C : CommandShapes;\n` +
-      `type EvtsOf<F> = F extends (app: JanelaApp<infer _C, infer E>) => void ? E : Record<string, unknown>;\n\n` +
+      `// so a contract-typed setup(app: App) and a plain setup(app: JanelaApp)\n` +
+      `// each get an app instantiated to match. scriptc monomorphises generic\n` +
+      `// classes, so the right instantiation must be CONSTRUCTED here - no cast\n` +
+      `// can bridge two of them. The inference reads the CLASS, not the\n` +
+      `// JanelaApp alias: the alias applies Norm<C>, which cannot be reversed,\n` +
+      `// and what is wanted here is the normalised table anyway.\n` +
+      `type CmdsOf<F> = F extends (app: JanelaAppImpl<infer C, infer _E>) => void ? C : CommandShapes;\n` +
+      `type EvtsOf<F> = F extends (app: JanelaAppImpl<infer _C, infer E>) => void ? E : Record<string, unknown>;\n\n` +
       `const app = createApp<CmdsOf<typeof setup>, EvtsOf<typeof setup>>(WINDOW);\n` +
       `setup(app);\n` +
       `const rc = app.run(INDEX_HTML) + 0;\n` +

package/package.json

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

package/runtime/janela.ts

@@ -83,11 +83,16 @@ const BOOTSTRAP =
 // user's editor can see them). Re-exported here because the compiled build
 // resolves them through this module — see the specifier rewrite in the CLI.
 export type {
+  ArgsOf,
   AsyncCommandHandler,
   CommandHandler,
   CommandShape,
   CommandShapes,
+  CommandSpec,
+  CommandSpecs,
   Commands,
+  Norm,
+  ResultOf,
   DialogFilter,
   Events,
   FsCallback,
@@ -105,7 +110,9 @@ import type {
   AsyncCommandHandler,
   CommandHandler,
   CommandShapes,
+  CommandSpecs,
   Commands,
+  Norm,
   DialogFilter,
   Events,
   FsCallback,
@@ -156,7 +163,7 @@ const TICK_DRAIN_MS = 4;
  * interface (being signature-only) never is. A class receiver works even as a
  * plain function parameter, which is what `setup(app)` is.
  */
-export class JanelaApp<
+export class JanelaAppImpl<
   C extends CommandShapes = CommandShapes,
   E = Record<string, unknown>,
 > {
@@ -571,11 +578,34 @@ export class JanelaApp<
   }
 }
 
+/**
+ * A running janela app, typed by the contract it serves.
+ *
+ * This is an alias rather than the class itself so that a contract may be
+ * written as plain function types: `Norm` converts it to the record form the
+ * class indexes, at a point where the table is still concrete. Writing the
+ * record form directly keeps working — `Norm` is idempotent.
+ *
+ * ```ts
+ * export type AppCommands = { add: (args: { a: number; b: number }) => number };
+ * export type AppEvents = { added: number };
+ * export type App = JanelaApp<AppCommands, AppEvents>;
+ *
+ * export function setup(app: App): void {
+ *   app.command("add", (args) => args.a + args.b);   // args inferred, result checked
+ * }
+ * ```
+ */
+export type JanelaApp<
+  C extends CommandSpecs = CommandShapes,
+  E = Record<string, unknown>,
+> = JanelaAppImpl<Norm<C>, E>;
+
 export function createApp<
   C extends CommandShapes = CommandShapes,
   E = Record<string, unknown>,
->(cfg: WindowConfig): JanelaApp<C, E> {
-  return new JanelaApp<C, E>(cfg);
+>(cfg: WindowConfig): JanelaAppImpl<C, E> {
+  return new JanelaAppImpl<C, E>(cfg);
 }
 
 // ---------------------------------------------------------------------------
@@ -586,7 +616,7 @@ export function createApp<
 
 /** @deprecated Use `app.command(name, handler)` on a contract-typed app. */
 export function on<M extends CommandShapes, K extends keyof M & string>(
-  app: JanelaApp,
+  app: JanelaAppImpl,
   _commands: Commands<M>,
   name: K,
   handler: (args: M[K]["args"]) => M[K]["result"],
@@ -596,7 +626,7 @@ export function on<M extends CommandShapes, K extends keyof M & string>(
 
 /** @deprecated Use `app.commandAsync(name, handler)` on a contract-typed app. */
 export function onAsync<M extends CommandShapes, K extends keyof M & string>(
-  app: JanelaApp,
+  app: JanelaAppImpl,
   _commands: Commands<M>,
   name: K,
   handler: (
@@ -615,7 +645,7 @@ export function onAsync<M extends CommandShapes, K extends keyof M & string>(
 
 /** @deprecated Use `app.emit(event, payload)` on a contract-typed app. */
 export function emit<E, K extends keyof E & string>(
-  app: JanelaApp,
+  app: JanelaAppImpl,
   _events: Events<E>,
   name: K,
   payload: E[K],

package/runtime/types.ts

@@ -90,15 +90,78 @@ export interface WindowConfig {
 // 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. */
+/**
+ * One command's argument and result types, in normalised form.
+ *
+ * This is what the app class works with internally. A contract is *written*
+ * as plain function types — see CommandSpec — and normalised to this by
+ * `Norm` before it reaches the class.
+ */
 export interface CommandShape {
   args: unknown;
   result: unknown;
 }
 
-/** A contract's command table: name → shape. */
+/** A normalised command table: name → shape. */
 export type CommandShapes = Record<string, CommandShape>;
 
+/**
+ * How a command may be declared in a contract: as a plain function type
+ * (preferred), or as the `{ args; result }` record of 0.5.x–0.7.x.
+ *
+ * ```ts
+ * type AppCommands = {
+ *   add: (args: { a: number; b: number }) => number;
+ *   quit: () => void;                                    // no arguments
+ *   legacy: { args: { name: string }; result: string };  // still accepted
+ * };
+ * ```
+ */
+export type CommandSpec = ((...args: never[]) => unknown) | CommandShape;
+
+/** A contract's command table as written: name → spec. */
+export type CommandSpecs = Record<string, CommandSpec>;
+
+/**
+ * The argument type of a declared command. A function's single parameter, or
+ * a record's `args`. A command declared with no parameters takes `null` — the
+ * page's `invoke(name)` sends null, and nothing is lost.
+ */
+export type ArgsOf<F> = F extends (...a: infer P) => unknown
+  ? P extends [infer A]
+    ? A
+    : null
+  : F extends { args: infer A }
+    ? A
+    : null;
+
+/**
+ * The result type of a declared command. `void` is normalised to `null`:
+ * every command answers the page's promise with a value, and scriptc has no
+ * conversion from a void value to the `unknown` the handler table holds.
+ */
+export type ResultOf<F> = F extends (...a: never[]) => infer R
+  ? [R] extends [void]
+    ? null
+    : R
+  : F extends { result: infer R }
+    ? R
+    : never;
+
+/**
+ * Normalise a written contract to the record form the app class indexes.
+ *
+ * This runs where `C` is still concrete — in the `JanelaApp<C, E>` alias, one
+ * step before the class — on purpose. scriptc cannot compile a *value* whose
+ * type is an unresolved conditional or a mapped type indexed by a type
+ * parameter (`SC2001: values of type 'ArgsOf<C[K]>' cannot be compiled yet`),
+ * so the class body only ever sees plain indexed access on a record.
+ * Idempotent: normalising a record-form table returns it unchanged.
+ */
+export type Norm<C> = {
+  [K in keyof C]: { args: ArgsOf<C[K]>; result: ResultOf<C[K]> };
+};
+
 /**
  * A declared command contract. Carries `M` at the type level only — the value
  * is empty, and exists so that inference has something to read at a call site.
@@ -119,7 +182,7 @@ export interface Events<E> {
  * types and name the app itself:
  *
  * ```ts
- * export type AppCommands = { add: { args: { a: number; b: number }; result: number } };
+ * export type AppCommands = { add: (args: { a: number; b: number }) => number };
  * export type AppEvents = { added: number };
  * export type App = JanelaApp<AppCommands, AppEvents>;
  * export function setup(app: App): void { … }

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

@@ -9,19 +9,18 @@
 // Two gotchas inherited from scriptc:
 //   - never use a bare FFI-backed call as a complete variable initializer;
 //     wrap it in any expression (`+ 0`);
-//   - write `args: null` for a command that takes nothing, not `undefined` —
-//     an `undefined` argument lowers to a zero-parameter function and fails
-//     to compile.
+//   - a command that returns nothing is declared `() => void` and its handler
+//     returns `null`; every command answers the page's promise with a value.
 
 import type { JanelaApp } from "janela/host";
 
 /** Every command this app answers. Declared once; the page checks against it. */
 export type AppCommands = {
-  add: { args: { a: number; b: number }; result: number };
-  greet: { args: { name: string }; result: string };
-  log: { args: string; result: null };
-  wait: { args: { ms: number }; result: string };
-  quit: { args: null; result: null };
+  add: (args: { a: number; b: number }) => number;
+  greet: (args: { name: string }) => string;
+  log: (args: string) => void;
+  wait: (args: { ms: number }) => string;
+  quit: () => void;
 };
 
 /** Every event this app emits, and what each one carries. */

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

@@ -9,19 +9,18 @@
 // Two gotchas inherited from scriptc:
 //   - never use a bare FFI-backed call as a complete variable initializer;
 //     wrap it in any expression (`+ 0`);
-//   - write `args: null` for a command that takes nothing, not `undefined` —
-//     an `undefined` argument lowers to a zero-parameter function and fails
-//     to compile.
+//   - a command that returns nothing is declared `() => void` and its handler
+//     returns `null`; every command answers the page's promise with a value.
 
 import type { JanelaApp } from "janela/host";
 
 /** Every command this app answers. Declared once; the page checks against it. */
 export type AppCommands = {
-  add: { args: { a: number; b: number }; result: number };
-  greet: { args: { name: string }; result: string };
-  log: { args: string; result: null };
-  wait: { args: { ms: number }; result: string };
-  quit: { args: null; result: null };
+  add: (args: { a: number; b: number }) => number;
+  greet: (args: { name: string }) => string;
+  log: (args: string) => void;
+  wait: (args: { ms: number }) => string;
+  quit: () => void;
 };
 
 /** Every event this app emits, and what each one carries. */

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

@@ -9,19 +9,18 @@
 // Two gotchas inherited from scriptc:
 //   - never use a bare FFI-backed call as a complete variable initializer;
 //     wrap it in any expression (`+ 0`);
-//   - write `args: null` for a command that takes nothing, not `undefined` —
-//     an `undefined` argument lowers to a zero-parameter function and fails
-//     to compile.
+//   - a command that returns nothing is declared `() => void` and its handler
+//     returns `null`; every command answers the page's promise with a value.
 
 import type { JanelaApp } from "janela/host";
 
 /** Every command this app answers. Declared once; the page checks against it. */
 export type AppCommands = {
-  add: { args: { a: number; b: number }; result: number };
-  greet: { args: { name: string }; result: string };
-  log: { args: string; result: null };
-  wait: { args: { ms: number }; result: string };
-  quit: { args: null; result: null };
+  add: (args: { a: number; b: number }) => number;
+  greet: (args: { name: string }) => string;
+  log: (args: string) => void;
+  wait: (args: { ms: number }) => string;
+  quit: () => void;
 };
 
 /** Every event this app emits, and what each one carries. */

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

@@ -9,19 +9,18 @@
 // Two gotchas inherited from scriptc:
 //   - never use a bare FFI-backed call as a complete variable initializer;
 //     wrap it in any expression (`+ 0`);
-//   - write `args: null` for a command that takes nothing, not `undefined` —
-//     an `undefined` argument lowers to a zero-parameter function and fails
-//     to compile.
+//   - a command that returns nothing is declared `() => void` and its handler
+//     returns `null`; every command answers the page's promise with a value.
 
 import type { JanelaApp } from "janela/host";
 
 /** Every command this app answers. Declared once; the page checks against it. */
 export type AppCommands = {
-  add: { args: { a: number; b: number }; result: number };
-  greet: { args: { name: string }; result: string };
-  log: { args: string; result: null };
-  wait: { args: { ms: number }; result: string };
-  quit: { args: null; result: null };
+  add: (args: { a: number; b: number }) => number;
+  greet: (args: { name: string }) => string;
+  log: (args: string) => void;
+  wait: (args: { ms: number }) => string;
+  quit: () => void;
 };
 
 /** Every event this app emits, and what each one carries. */