arri 0.36.0 → 0.36.1

package/README.md

@@ -18,6 +18,7 @@ Typescript implementation of Arri RPC. It's built on top of [H3](https://github.
 -   [Key Concepts](#key-concepts)
     -   [Arri Definition File](#arri-definition-file)
     -   [How Procedures Map To Endpoints](#how-procedures-map-to-endpoints)
+    -   [H3 Support](#h3-support)
 -   [Arri CLI](#arri-cli)
 
 ## Quickstart
@@ -480,6 +481,37 @@ 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';
+```
+
+#### Accessing H3 Events
+You can access H3 events from inside procedures handlers.
+
+```ts
+defineRpc({
+  params: undefined,
+  response: undefined,
+  handler(_, event) {
+    getRequestIP(event);
+  }
+)
+
+defineEventStreamRpc({
+  params: undefined,
+  response: undefined,
+  handler(_, event) {
+    getRequestIP(event);
+  }
+)
+```
+
 ## Arri CLI
 
 ```bash

package/dist/cli.cjs

@@ -11,7 +11,7 @@ const esbuild = require('esbuild');
 const esbuildPluginReplace = require('esbuild-plugin-replace');
 const path = require('pathe');
 const prettier = require('prettier');
-const config = require('./shared/arri.087dabd0.cjs');
+const config = require('./shared/arri.8e96548e.cjs');
 const consola = require('consola');
 const globby = require('globby');
 const scule = require('scule');

package/dist/cli.mjs

@@ -10,7 +10,7 @@ import { build as build$1 } from 'esbuild';
 import { replace } from 'esbuild-plugin-replace';
 import path from 'pathe';
 import prettier from 'prettier';
-import { q as defaultConfig, o as isArriConfig, p as isResolvedArriConfig, a as DEV_DEFINITION_ENDPOINT } from './shared/arri.b0950dad.mjs';
+import { q as defaultConfig, o as isArriConfig, p as isResolvedArriConfig, a as DEV_DEFINITION_ENDPOINT } from './shared/arri.b1ff441a.mjs';
 import { createConsola } from 'consola';
 import { globby } from 'globby';
 import { camelCase, kebabCase } from 'scule';

package/dist/index.cjs

@@ -1,8 +1,9 @@
 'use strict';
 
-const config = require('./shared/arri.087dabd0.cjs');
+const config = require('./shared/arri.8e96548e.cjs');
 const h3 = require('h3');
 require('arri-codegen-utils');
+require('consola');
 require('arri-validate');
 require('h3-sse');
 require('scule');

package/dist/index.d.cts

@@ -195,6 +195,7 @@ declare class ArriApp implements ArriRouterBase {
     private readonly _onBeforeResponse;
     private readonly _onError;
     private readonly _debug;
+    readonly definitionPath: string;
     constructor(opts?: ArriOptions);
     use(input: Middleware | ArriRouter): void;
     rpc<TIsEventStream extends boolean = false, TParams extends AObjectSchema<any, any> | undefined = undefined, TResponse extends AObjectSchema<any, any> | undefined = undefined>(procedure: NamedRpc<TIsEventStream, TParams, TResponse>): void;

package/dist/index.d.mts

@@ -195,6 +195,7 @@ declare class ArriApp implements ArriRouterBase {
     private readonly _onBeforeResponse;
     private readonly _onError;
     private readonly _debug;
+    readonly definitionPath: string;
     constructor(opts?: ArriOptions);
     use(input: Middleware | ArriRouter): void;
     rpc<TIsEventStream extends boolean = false, TParams extends AObjectSchema<any, any> | undefined = undefined, TResponse extends AObjectSchema<any, any> | undefined = undefined>(procedure: NamedRpc<TIsEventStream, TParams, TResponse>): void;

package/dist/index.d.ts

@@ -195,6 +195,7 @@ declare class ArriApp implements ArriRouterBase {
     private readonly _onBeforeResponse;
     private readonly _onError;
     private readonly _debug;
+    readonly definitionPath: string;
     constructor(opts?: ArriOptions);
     use(input: Middleware | ArriRouter): void;
     rpc<TIsEventStream extends boolean = false, TParams extends AObjectSchema<any, any> | undefined = undefined, TResponse extends AObjectSchema<any, any> | undefined = undefined>(procedure: NamedRpc<TIsEventStream, TParams, TResponse>): void;

package/dist/index.mjs

@@ -1,6 +1,7 @@
-export { A as ArriApp, t as ArriRouter, j as ArriServerError, k as ArriServerErrorResponse, a as DEV_DEFINITION_ENDPOINT, D as DEV_ENDPOINT_ROOT, E as EventStreamConnection, c as createAppDefinition, e as createHttpRpcDefinition, q as defaultConfig, s as defineConfig, l as defineError, y as defineEventStreamRpc, u as defineRoute, d as defineRpc, m as errorResponseFromValidationErrors, f as getRpcParamName, g as getRpcPath, h as getRpcResponseName, n as handleH3Error, x as handleRoute, o as isArriConfig, z as isEventStreamRpc, p as isResolvedArriConfig, b as isRpc, i as isRpcParamSchema, B as registerEventStreamRpc, w as registerRoute, r as registerRpc, v as validateRpcRequestInput } from './shared/arri.b0950dad.mjs';
+export { A as ArriApp, t as ArriRouter, j as ArriServerError, k as ArriServerErrorResponse, a as DEV_DEFINITION_ENDPOINT, D as DEV_ENDPOINT_ROOT, E as EventStreamConnection, c as createAppDefinition, e as createHttpRpcDefinition, q as defaultConfig, s as defineConfig, l as defineError, y as defineEventStreamRpc, u as defineRoute, d as defineRpc, m as errorResponseFromValidationErrors, f as getRpcParamName, g as getRpcPath, h as getRpcResponseName, n as handleH3Error, x as handleRoute, o as isArriConfig, z as isEventStreamRpc, p as isResolvedArriConfig, b as isRpc, i as isRpcParamSchema, B as registerEventStreamRpc, w as registerRoute, r as registerRpc, v as validateRpcRequestInput } from './shared/arri.b1ff441a.mjs';
 export * from 'h3';
 import 'arri-codegen-utils';
+import 'consola';
 import 'arri-validate';
 import 'h3-sse';
 import 'scule';

package/dist/shared/{arri.087dabd0.cjs → arri.8e96548e.cjs}

@@ -1,11 +1,16 @@
 'use strict';
 
 const arriCodegenUtils = require('arri-codegen-utils');
+const consola = require('consola');
 const h3 = require('h3');
 const arriValidate = require('arri-validate');
 const h3Sse = require('h3-sse');
 const scule = require('scule');
 
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
+
+const consola__default = /*#__PURE__*/_interopDefaultCompat(consola);
+
 var __defProp$3 = Object.defineProperty;
 var __defNormalProp$3 = (obj, key, value) => key in obj ? __defProp$3(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
 var __publicField$3 = (obj, key, value) => {
@@ -871,6 +876,7 @@ class ArriApp {
     __publicField(this, "_onBeforeResponse");
     __publicField(this, "_onError");
     __publicField(this, "_debug");
+    __publicField(this, "definitionPath");
     this.appInfo = opts?.appInfo;
     this.h3App = h3.createApp({
       debug: opts?.debug
@@ -883,11 +889,15 @@ class ArriApp {
     this._rpcRoutePrefix = opts?.rpcRoutePrefix ?? "";
     this._rpcDefinitionPath = opts?.rpcDefinitionPath ?? "__definition";
     this.h3App.use(this.h3Router);
+    this.definitionPath = this._rpcRoutePrefix ? `/${this._rpcRoutePrefix}/${this._rpcDefinitionPath}`.split("//").join("/") : `/${this._rpcDefinitionPath}`;
     this.h3Router.get(
-      this._rpcRoutePrefix ? `/${this._rpcRoutePrefix}/${this._rpcDefinitionPath}`.split("//").join("/") : `/${this._rpcDefinitionPath}`,
+      this.definitionPath,
       h3.eventHandler(() => this.getAppDefinition())
     );
     if (process.env.ARRI_DEV_MODE === "true") {
+      consola__default.info(
+        `Arri definition available at \`http://<host>${this.definitionPath}\``
+      );
       this.h3Router.get(
         DEV_DEFINITION_ENDPOINT,
         h3.eventHandler(() => this.getAppDefinition())

package/dist/shared/{arri.b0950dad.mjs → arri.b1ff441a.mjs}

@@ -1,4 +1,5 @@
 import { isRpcHttpMethod, removeDisallowedChars, SCHEMA_VERSION } from 'arri-codegen-utils';
+import consola from 'consola';
 import { isError, setResponseStatus, setResponseHeader, send, eventHandler, isPreflightRequest, readRawBody, getValidatedQuery, defineEventHandler, getQuery, setHeader, createRouter, createApp } from 'h3';
 import { a, isAObjectSchema, isADiscriminatorSchema } from 'arri-validate';
 import { createEventStream } from 'h3-sse';
@@ -869,6 +870,7 @@ class ArriApp {
     __publicField(this, "_onBeforeResponse");
     __publicField(this, "_onError");
     __publicField(this, "_debug");
+    __publicField(this, "definitionPath");
     this.appInfo = opts?.appInfo;
     this.h3App = createApp({
       debug: opts?.debug
@@ -881,11 +883,15 @@ class ArriApp {
     this._rpcRoutePrefix = opts?.rpcRoutePrefix ?? "";
     this._rpcDefinitionPath = opts?.rpcDefinitionPath ?? "__definition";
     this.h3App.use(this.h3Router);
+    this.definitionPath = this._rpcRoutePrefix ? `/${this._rpcRoutePrefix}/${this._rpcDefinitionPath}`.split("//").join("/") : `/${this._rpcDefinitionPath}`;
     this.h3Router.get(
-      this._rpcRoutePrefix ? `/${this._rpcRoutePrefix}/${this._rpcDefinitionPath}`.split("//").join("/") : `/${this._rpcDefinitionPath}`,
+      this.definitionPath,
       eventHandler(() => this.getAppDefinition())
     );
     if (process.env.ARRI_DEV_MODE === "true") {
+      consola.info(
+        `Arri definition available at \`http://<host>${this.definitionPath}\``
+      );
       this.h3Router.get(
         DEV_DEFINITION_ENDPOINT,
         eventHandler(() => this.getAppDefinition())

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "arri",
-  "version": "0.36.0",
+  "version": "0.36.1",
   "type": "module",
   "license": "MIT",
   "author": {
@@ -43,10 +43,10 @@
     "prettier": "^3.2.5",
     "scule": "^1.3.0",
     "uncrypto": "^0.1.3",
-    "arri-codegen-dart": "0.36.0",
-    "arri-codegen-ts": "0.36.0",
-    "arri-codegen-utils": "0.36.0",
-    "arri-validate": "0.36.0"
+    "arri-codegen-utils": "0.36.1",
+    "arri-validate": "0.36.1",
+    "arri-codegen-ts": "0.36.1",
+    "arri-codegen-dart": "0.36.1"
   },
   "devDependencies": {
     "@types/degit": "^2.8.6",