arri 0.42.0 → 0.42.1

package/README.md

@@ -13,6 +13,7 @@ Typescript implementation of Arri RPC. It's built on top of [H3](https://github.
         -   [File-Based Routing](#file-based-routing)
         -   [Manual Routing](#manual-routing)
         -   [Creating Event Stream Procedures](#creating-event-stream-procedures)
+        -   [Creating Websocket Procedures](#creating-websocket-procedures)
     -   [Adding Non-RPC Routes](#adding-non-rpc-routes)
     -   [Adding Middleware](#adding-middleware)
 -   [Key Concepts](#key-concepts)
@@ -277,6 +278,68 @@ stream.end()
 stream.on(e: 'request:close' | 'close', callback: () => any)
 ```
 
+### Creating Websocket Procedures
+
+```ts
+// Websocket procedures work really well with discriminated unions
+const IncomingMsg = a.discriminator('type', {
+    FOO: a.object({
+        message: a.string(),
+    }),
+    PING: a.object({
+        message: a.string(),
+    })
+});
+
+const OutgoingMsg = a.discriminator('type', {
+    BAR: a.object({
+        message: a.string(),
+    }),
+    PONG: a.object({
+    message: a.string()
+    })
+});
+
+export default defineWebsocketRpc(
+    params: IncomingMsg,
+    response: OutgoingMsg,
+    handler: {
+        onOpen: (peer) => {},
+        onMessage: (peer, message) => {
+            switch(message.type) {
+                case "FOO":
+                    peer.send({
+                        type: "BAR",
+                        message: "You sent a FOO message"
+                    });
+                    break;
+                case "PING":
+                    peer.send({
+                        type: "PONG",
+                        message: "You sent a PING message"
+                    });
+                    break;
+            }
+        },
+        onError: (peer, error) => {}
+    }
+)
+```
+
+Under the hook Websocket RPCs use [crossws](https://crossws.unjs.io/).
+
+The possible payloads sent by the server will look like the following:
+
+```
+event: message
+data: <response serialized to json>
+```
+
+```
+event: error
+data: {"code": <some-err-code>, "message": <some-error-msg>}
+```
+
 ### Adding Non-RPC Routes
 
 You can also add generic endpoints for instances when a message-based RPC endpoint doesn't fit.
@@ -467,16 +530,19 @@ The supported HTTP methods are as follows:
 When using a get method the RPC params will be mapped as query parameters which will be coerced into their type using the `a.coerce` method from `arri-validate`. Get methods support all basic scalar types however arrays and nested objects are not supported.
 
 ### H3 Support
+
 Arri is built on top of [H3](https://h3.unjs.io/utils/request#getrequestipevent) so many of the concepts that apply to H3 also apply to Arri.
 
 #### Accessing Utilities
+
 Arri re-eports all of the H3 utilities.
 
 ```ts
-import { getRequestIP, setResponseHeader } from 'arri';
+import { getRequestIP, setResponseHeader } from "arri";
 ```
 
 #### Accessing H3 Events
+
 You can access H3 events from inside procedures handlers.
 
 ```ts
@@ -508,6 +574,9 @@ arri build [flags]
 
 # create a new project
 arri init [dir]
+
+# run codegen
+arri codegen [path-to-definition-file]
 ```
 
 ## Development

package/dist/cli.cjs

@@ -273,8 +273,8 @@ async function bundleAppEntry(config, allowCodegen = true) {
     bundle: true,
     packages: "external",
     format: "esm",
-    sourcemap: true,
-    minifyWhitespace: true,
+    sourcemap: config.esbuild.sourcemap ?? true,
+    minify: config.esbuild.minify ?? true,
     banner: {
       js: `import { createRequire as topLevelCreateRequire } from 'module';
 const require = topLevelCreateRequire(import.meta.url);`
@@ -503,10 +503,10 @@ export default app.h3App;`;
     outfile: path__default.resolve(config.rootDir, ".output", OUT_APP_FILE),
     format: "esm",
     bundle: true,
-    sourcemap: true,
-    target: "node20",
-    platform: "node",
-    packages: "external"
+    packages: "external",
+    sourcemap: config.esbuild.sourcemap ?? true,
+    target: config.esbuild.target ?? "node20",
+    platform: config.esbuild.platform ?? "node"
   });
 }
 async function startDevServer(config) {
@@ -609,7 +609,7 @@ async function generateClients(config$1) {
     }
     logger.log(`Generating client code...`);
     const clientCount = config$1.generators.length;
-    await Promise.all(
+    await Promise.allSettled(
       config$1.generators.map(
         (generator) => generator.generator(result, true)
       )
@@ -618,7 +618,7 @@ async function generateClients(config$1) {
       `Generated ${clientCount} client${clientCount === 1 ? "" : "s"}`
     );
   } catch (err) {
-    console.error(err);
+    logger.error(err);
   }
 }
 async function createEntryModule(config) {

package/dist/cli.mjs

@@ -250,8 +250,8 @@ async function bundleAppEntry(config, allowCodegen = true) {
     bundle: true,
     packages: "external",
     format: "esm",
-    sourcemap: true,
-    minifyWhitespace: true,
+    sourcemap: config.esbuild.sourcemap ?? true,
+    minify: config.esbuild.minify ?? true,
     banner: {
       js: `import { createRequire as topLevelCreateRequire } from 'module';
 const require = topLevelCreateRequire(import.meta.url);`
@@ -480,10 +480,10 @@ export default app.h3App;`;
     outfile: path.resolve(config.rootDir, ".output", OUT_APP_FILE),
     format: "esm",
     bundle: true,
-    sourcemap: true,
-    target: "node20",
-    platform: "node",
-    packages: "external"
+    packages: "external",
+    sourcemap: config.esbuild.sourcemap ?? true,
+    target: config.esbuild.target ?? "node20",
+    platform: config.esbuild.platform ?? "node"
   });
 }
 async function startDevServer(config) {
@@ -586,7 +586,7 @@ async function generateClients(config) {
     }
     logger.log(`Generating client code...`);
     const clientCount = config.generators.length;
-    await Promise.all(
+    await Promise.allSettled(
       config.generators.map(
         (generator) => generator.generator(result, true)
       )
@@ -595,7 +595,7 @@ async function generateClients(config) {
       `Generated ${clientCount} client${clientCount === 1 ? "" : "s"}`
     );
   } catch (err) {
-    console.error(err);
+    logger.error(err);
   }
 }
 async function createEntryModule(config) {

package/dist/codegen.cjs

@@ -2,8 +2,10 @@
 
 const arriCodegenDart = require('arri-codegen-dart');
 const arriCodegenTs = require('arri-codegen-ts');
+const arriCodegenUtils = require('arri-codegen-utils');
 
 
 
 exports.dartClientGenerator = arriCodegenDart.dartClientGenerator;
 exports.typescriptClientGenerator = arriCodegenTs.typescriptClientGenerator;
+exports.createAppDefinition = arriCodegenUtils.createAppDefinition;

package/dist/codegen.d.cts

@@ -1,2 +1,3 @@
 export { dartClientGenerator } from 'arri-codegen-dart';
 export { typescriptClientGenerator } from 'arri-codegen-ts';
+export { AppDefinition, createAppDefinition } from 'arri-codegen-utils';

package/dist/codegen.d.mts

@@ -1,2 +1,3 @@
 export { dartClientGenerator } from 'arri-codegen-dart';
 export { typescriptClientGenerator } from 'arri-codegen-ts';
+export { AppDefinition, createAppDefinition } from 'arri-codegen-utils';

package/dist/codegen.d.ts

@@ -1,2 +1,3 @@
 export { dartClientGenerator } from 'arri-codegen-dart';
 export { typescriptClientGenerator } from 'arri-codegen-ts';
+export { AppDefinition, createAppDefinition } from 'arri-codegen-utils';

package/dist/codegen.mjs

@@ -1,2 +1,3 @@
 export { dartClientGenerator } from 'arri-codegen-dart';
 export { typescriptClientGenerator } from 'arri-codegen-ts';
+export { createAppDefinition } from 'arri-codegen-utils';

package/dist/index.d.cts

@@ -290,7 +290,7 @@ interface ArriConfig {
     procedureGlobPatterns?: string[];
     generators?: Array<ClientGenerator<any>>;
     buildDir?: string;
-    esbuild?: Omit<BuildOptions, "outfile" | "outdir" | "entryNames" | "entryPoints">;
+    esbuild?: Omit<BuildOptions, "bundle" | "format" | "outfile" | "outdir" | "entryNames" | "entryPoints" | "packages">;
     https?: {
         cert: string;
         key: string;

package/dist/index.d.mts

@@ -290,7 +290,7 @@ interface ArriConfig {
     procedureGlobPatterns?: string[];
     generators?: Array<ClientGenerator<any>>;
     buildDir?: string;
-    esbuild?: Omit<BuildOptions, "outfile" | "outdir" | "entryNames" | "entryPoints">;
+    esbuild?: Omit<BuildOptions, "bundle" | "format" | "outfile" | "outdir" | "entryNames" | "entryPoints" | "packages">;
     https?: {
         cert: string;
         key: string;

package/dist/index.d.ts

@@ -290,7 +290,7 @@ interface ArriConfig {
     procedureGlobPatterns?: string[];
     generators?: Array<ClientGenerator<any>>;
     buildDir?: string;
-    esbuild?: Omit<BuildOptions, "outfile" | "outdir" | "entryNames" | "entryPoints">;
+    esbuild?: Omit<BuildOptions, "bundle" | "format" | "outfile" | "outdir" | "entryNames" | "entryPoints" | "packages">;
     https?: {
         cert: string;
         key: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "arri",
-  "version": "0.42.0",
+  "version": "0.42.1",
   "type": "module",
   "license": "MIT",
   "author": {
@@ -47,13 +47,13 @@
     "scule": "^1.3.0",
     "source-map-support": "^0.5.21",
     "uncrypto": "^0.1.3",
-    "arri-codegen-ts": "0.42.0",
-    "arri-codegen-utils": "0.42.0",
-    "arri-codegen-dart": "0.42.0",
-    "arri-validate": "0.42.0"
+    "arri-codegen-dart": "0.42.1",
+    "arri-codegen-utils": "0.42.1",
+    "arri-validate": "0.42.1",
+    "arri-codegen-ts": "0.42.1"
   },
   "devDependencies": {
     "@types/degit": "^2.8.6",
-    "bun-types": "^1.1.4"
+    "bun-types": "^1.1.7"
   }
 }