arri 0.16.3 → 0.16.4

package/README.md

@@ -9,8 +9,10 @@ Typescript implementation of Arri RPC. It's built on top of [H3](https://github.
     -   [Install Dependencies](#install-dependencies)
     -   [Scaffold Your Project](#scaffold-your-project)
 -   [Usage](#usage)
-    -   [File-Based Routing](#file-based-routing)
-    -   [Manual Routing](#manual-routing)
+    -   [Creating Procedures](#creating-procedures)
+        -   [File-Based Routing](#file-based-routing)
+        -   [Manual Routing](#manual-routing)
+        -   [Creating Event Stream Procedures](#creating-event-stream-procedures)
     -   [Adding Non-RPC Routes](#adding-non-rpc-routes)
     -   [Adding Middleware](#adding-middleware)
 -   [Key Concepts](#key-concepts)
@@ -151,7 +153,7 @@ Setup your npm scripts:
 
 ### Creating Procedures
 
-#### File Based Routing
+#### File Based Router
 
 Arri RPC comes with an optional file based router that will automatically register functions in the `./procedures` directory that end with the `.rpc.ts` file extension.
 
@@ -198,6 +200,8 @@ export default defineConfig({
 
 #### Manual Routing
 
+For those that want to opt out of the file-based routing system you can manually register procedures like so.
+
 ```ts
 // using the app instance
 const app = new ArriApp()
@@ -214,10 +218,15 @@ app.use(router)
 
 Event stream procedures make use of [Server Sent Events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events) to stream events to clients.
 
-Normal events will have the event type `message`. Error events will have the event type `error`, and a `done` event will be sent when closing the connection. Additionally the `EventStreamConnection` will periodically since a `ping` event to keep the connection alive
+Arri Event streams sent the following event types:
+
+-   `message` - A standard message with the response data serialized as JSON
+-   `error` - An error message with an `ArriRequestError` sent as JSON
+-   `done` - A message to tell clients that there will be no more events
+-   `ping` - A message periodically sent by the server to keep the connection alive.
 
 ```ts
-/// standard event ///
+/// message event ///
 id: string | undefined;
 event: "message";
 data: Response; // whatever you have specified as the response serialized to json

package/dist/cli.cjs

@@ -12,7 +12,7 @@ const esbuild = require('esbuild');
 const esbuildPluginReplace = require('esbuild-plugin-replace');
 const path = require('pathe');
 const prettier = require('prettier');
-const config = require('./shared/arri.beaf548c.cjs');
+const config = require('./shared/arri.9c3d197c.cjs');
 const globby = require('globby');
 const scule = require('scule');
 const arriCodegenDart = require('arri-codegen-dart');

package/dist/cli.mjs

@@ -11,7 +11,7 @@ import { build as build$1 } from 'esbuild';
 import { replace } from 'esbuild-plugin-replace';
 import path from 'pathe';
 import prettier from 'prettier';
-import { n as defaultConfig, m as isResolvedArriConfig, a as DEV_DEFINITION_ENDPOINT } from './shared/arri.ff70fe08.mjs';
+import { n as defaultConfig, m as isResolvedArriConfig, a as DEV_DEFINITION_ENDPOINT } from './shared/arri.883e4574.mjs';
 import { globby } from 'globby';
 import { camelCase, kebabCase } from 'scule';
 import { dartClientGenerator } from 'arri-codegen-dart';

package/dist/index.cjs

@@ -1,6 +1,6 @@
 'use strict';
 
-const config = require('./shared/arri.beaf548c.cjs');
+const config = require('./shared/arri.9c3d197c.cjs');
 const h3 = require('h3');
 require('arri-validate');
 require('arri-codegen-utils');

package/dist/index.mjs

@@ -1,4 +1,4 @@
-export { A as ArriApp, p as ArriRouter, a as DEV_DEFINITION_ENDPOINT, D as DEV_ENDPOINT_ROOT, E as ErrorResponse, B as EventStreamConnection, c as createRpcDefinition, n as defaultConfig, o as defineConfig, h as defineError, w as defineEventStreamRpc, q as defineRoute, d as defineRpc, j as errorResponseFromValidationErrors, y as formatSse, z as formatSseList, e as getRpcParamName, g as getRpcPath, f as getRpcResponseName, k as handleH3Error, t as handleRoute, l as isArriConfig, x as isEventStreamRpc, m as isResolvedArriConfig, b as isRpc, i as isRpcParamSchema, C as registerEventStreamRpc, s as registerRoute, r as registerRpc, u as setSseHeaders, v as validateRpcRequestInput } from './shared/arri.ff70fe08.mjs';
+export { A as ArriApp, p as ArriRouter, a as DEV_DEFINITION_ENDPOINT, D as DEV_ENDPOINT_ROOT, E as ErrorResponse, B as EventStreamConnection, c as createRpcDefinition, n as defaultConfig, o as defineConfig, h as defineError, w as defineEventStreamRpc, q as defineRoute, d as defineRpc, j as errorResponseFromValidationErrors, y as formatSse, z as formatSseList, e as getRpcParamName, g as getRpcPath, f as getRpcResponseName, k as handleH3Error, t as handleRoute, l as isArriConfig, x as isEventStreamRpc, m as isResolvedArriConfig, b as isRpc, i as isRpcParamSchema, C as registerEventStreamRpc, s as registerRoute, r as registerRpc, u as setSseHeaders, v as validateRpcRequestInput } from './shared/arri.883e4574.mjs';
 export * from 'h3';
 import 'arri-validate';
 import 'arri-codegen-utils';

package/dist/shared/{arri.ff70fe08.mjs → arri.883e4574.mjs}

@@ -1,4 +1,4 @@
-import { createError, isError, setResponseStatus, send, eventHandler, isPreflightRequest, setResponseHeader, readRawBody, getValidatedQuery, setHeaders, getHeader, sendStream, defineEventHandler, getQuery, setHeader, createRouter, createApp, sendError } from 'h3';
+import { createError, isError, setResponseStatus, send, eventHandler, isPreflightRequest, setResponseHeader, readRawBody, getValidatedQuery, setHeaders, getHeader, defineEventHandler, getQuery, setHeader, createRouter, createApp, sendError } from 'h3';
 import { a, isAObjectSchema, isARecordSchema, isADiscriminatorSchema } from 'arri-validate';
 import { isRpcHttpMethod, removeDisallowedChars } from 'arri-codegen-utils';
 import { kebabCase, pascalCase } from 'scule';
@@ -482,7 +482,6 @@ class EventStreamConnection {
    */
   start() {
     this.h3Event._handled = true;
-    void sendStream(this.h3Event, this.readable);
     this.pingInterval = setInterval(async () => {
       await this.publishEvent({
         id: this.lastEventId,
@@ -538,11 +537,11 @@ class EventStreamConnection {
   }
   async publishEvents(events) {
     const payload = formatSseList(events);
-    await this.writer.write(this.encoder.encode(payload));
+    this.h3Event.node.res.write(payload);
   }
   async publishEvent(event) {
     const payload = formatSse(event);
-    await this.writer.write(this.encoder.encode(payload));
+    this.h3Event.node.res.write(payload);
   }
   async cleanup() {
     if (this.pingInterval) {

package/dist/shared/{arri.beaf548c.cjs → arri.9c3d197c.cjs}

@@ -484,7 +484,6 @@ class EventStreamConnection {
    */
   start() {
     this.h3Event._handled = true;
-    void h3.sendStream(this.h3Event, this.readable);
     this.pingInterval = setInterval(async () => {
       await this.publishEvent({
         id: this.lastEventId,
@@ -540,11 +539,11 @@ class EventStreamConnection {
   }
   async publishEvents(events) {
     const payload = formatSseList(events);
-    await this.writer.write(this.encoder.encode(payload));
+    this.h3Event.node.res.write(payload);
   }
   async publishEvent(event) {
     const payload = formatSse(event);
-    await this.writer.write(this.encoder.encode(payload));
+    this.h3Event.node.res.write(payload);
   }
   async cleanup() {
     if (this.pingInterval) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "arri",
-  "version": "0.16.3",
+  "version": "0.16.4",
   "type": "module",
   "license": "MIT",
   "author": {
@@ -40,10 +40,10 @@
     "prettier": "^3.1.0",
     "scule": "^1.1.1",
     "uncrypto": "^0.1.3",
-    "arri-codegen-dart": "0.16.3",
-    "arri-validate": "0.16.3",
-    "arri-codegen-ts": "0.16.3",
-    "arri-codegen-utils": "0.16.3"
+    "arri-codegen-dart": "0.16.4",
+    "arri-codegen-utils": "0.16.4",
+    "arri-codegen-ts": "0.16.4",
+    "arri-validate": "0.16.4"
   },
   "peerDependencies": {
     "listhen": "1.x"