arri 0.1.0-beta.8 → 0.1.1

package/README.md

@@ -1,11 +1,167 @@
-# arri-rpc
+# Arri RPC
 
-This library was generated with [Nx](https://nx.dev).
+## Installation
 
-## Building
+```bash
+# npm
+npm install arri arri-validate
+
+# pnpm
+pnpm install arri arri-validate
+```
+
+## Basic Setup Example
+
+Create an `arri.config.ts` in the project directory
+
+```ts
+// arri.config.ts
+import { defineConfig } from "arri";
+import {
+    typescriptClientGenerator,
+    dartClientGenerator,
+} from "arri/dist/codegen";
+
+export default defineConfig({
+    entry: "app.ts",
+    port: 3000,
+    srcDir: "src",
+    clientGenerators: [
+        typescriptClientGenerator({
+            // options
+        }),
+        dartClientGenerator({
+            // options
+        }),
+    ],
+});
+```
+
+Create an `app.ts` file in the source directory
+
+```ts
+// ./src/app.ts
+import { ArriApp } from "arri";
+import { a } from "arri-validate";
+
+const app = new ArriApp();
+
+app.rpc("sayHello", {
+    params: a.object({
+        name: a.string(),
+    }),
+    response: a.object({
+        message: a.string(),
+    }),
+    handler({ params }) {
+        return {
+            message: `Hello ${params.name}`,
+        };
+    },
+});
+
+export default app;
+```
+
+Setup your npm scripts:
+
+```json
+{
+    "scripts": {
+        "dev": "arri dev",
+        "build": "arri build"
+    }
+}
+```
+
+Start the dev server:
+
+```bash
+npm run dev
+```
+
+## File Based Routing
+
+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.
+
+```fs
+|-- src
+   |-- procedures
+      |-- sayHello.rpc.ts // becomes sayHello()
+      |-- users
+          |-- getUser.rpc.ts // becomes users.getUser()
+          |-- updateUser.rpc.ts // becomes users.updateUser()
+```
+
+Example `.rpc.ts` file
+
+```ts
+// ./src/users/getUser.rpc.ts
+import { defineRpc } from "arri";
+import { a } from "arri-validate";
+
+export default defineRpc({
+    params: a.object({
+        userId: a.string(),
+    }),
+    response: a.object({
+        id: a.string(),
+        name: a.string(),
+        createdAt: a.timestamp(),
+    }),
+    handler({ params }) {
+        // function body
+    },
+});
+```
+
+### Customizing the File Based Router
+
+```ts
+export default defineConfig({
+    // rest of config
+    procedureDir: "procedures", // change which directory to look for procedures (This is relative to the srcDir)
+    procedureGlobPatterns: ["**/*.rpc.ts"], // change the file name glob pattern for finding rpcs
+});
+```
+
+## Adding Non-RPC Endpoints
+
+```ts
+app.route({
+    method: "get",
+    path: "/hello-world",
+    handler(event) {
+        return "hello world";
+    },
+});
+```
+
+## Creating sub routers
+
+```ts
+import { ArriApp, ArriRouter } from "arri";
+
+const app = new ArriApp();
+const router = new ArriRouter();
+
+router.rpc({
+    // rpc config
+});
+
+router.route({
+    // route config
+});
+
+app.use(router);
+```
+
+## Developing
+
+### Building
 
 Run `nx build arri-rpc` to build the library.
 
-## Running unit tests
+### Running unit tests
 
-Run `nx test arri-rpc` to execute the unit tests via [Jest](https://jestjs.io).
+Run `nx test arri-rpc` to execute the unit tests via Vitest.

package/dist/cli.cjs

@@ -11,7 +11,7 @@ const consola = require('consola');
 const esbuild = require('esbuild');
 const path = require('pathe');
 const prettier = require('prettier');
-const config = require('./shared/arri.eea9df0a.cjs');
+const config = require('./shared/arri.ed4bd5e1.cjs');
 const globby = require('globby');
 const scule = require('scule');
 const arriCodegenDart = require('arri-codegen-dart');

package/dist/cli.mjs

@@ -10,7 +10,7 @@ import * as esbuild from 'esbuild';
 import { build as build$1 } from 'esbuild';
 import path from 'pathe';
 import prettier from 'prettier';
-import { m as defaultConfig, l as isResolvedArriConfig, a as DEV_DEFINITION_ENDPOINT } from './shared/arri.16b8531c.mjs';
+import { m as defaultConfig, l as isResolvedArriConfig, a as DEV_DEFINITION_ENDPOINT } from './shared/arri.121d68e9.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.eea9df0a.cjs');
+const config = require('./shared/arri.ed4bd5e1.cjs');
 const h3 = require('h3');
 require('arri-validate');
 require('arri-codegen-utils');

package/dist/index.mjs

@@ -1,4 +1,4 @@
-export { A as ArriApp, o as ArriRouter, a as DEV_DEFINITION_ENDPOINT, D as DEV_ENDPOINT_ROOT, E as ErrorResponse, c as createRpcDefinition, m as defaultConfig, n as defineConfig, f as defineError, p as defineRoute, d as defineRpc, h as errorResponseFromValidationErrors, b as getRpcParamName, g as getRpcPath, e as getRpcResponseName, j as handleH3Error, s as handleRoute, k as isArriConfig, l as isResolvedArriConfig, i as isRpc, q as registerRoute, r as registerRpc } from './shared/arri.16b8531c.mjs';
+export { A as ArriApp, o as ArriRouter, a as DEV_DEFINITION_ENDPOINT, D as DEV_ENDPOINT_ROOT, E as ErrorResponse, c as createRpcDefinition, m as defaultConfig, n as defineConfig, f as defineError, p as defineRoute, d as defineRpc, h as errorResponseFromValidationErrors, b as getRpcParamName, g as getRpcPath, e as getRpcResponseName, j as handleH3Error, s as handleRoute, k as isArriConfig, l as isResolvedArriConfig, i as isRpc, q as registerRoute, r as registerRpc } from './shared/arri.121d68e9.mjs';
 export * from 'h3';
 import 'arri-validate';
 import 'arri-codegen-utils';

package/dist/shared/{arri.16b8531c.mjs → arri.121d68e9.mjs}

@@ -270,7 +270,12 @@ function getRpcResponseDefinition(rpcName, procedure) {
   return name;
 }
 function registerRpc(router, path, procedure, opts) {
-  const responseValidator = procedure.response ? a.compile(procedure.response) : void 0;
+  let responseValidator;
+  try {
+    responseValidator = procedure.response ? a.compile(procedure.response) : void 0;
+  } catch (err) {
+    console.error("ERROR COMPILING VALIDATOR", err);
+  }
   const httpMethod = procedure.method ?? "post";
   const handler = eventHandler(async (event) => {
     event.context.rpcName = procedure.name;

package/dist/shared/{arri.eea9df0a.cjs → arri.ed4bd5e1.cjs}

@@ -272,7 +272,12 @@ function getRpcResponseDefinition(rpcName, procedure) {
   return name;
 }
 function registerRpc(router, path, procedure, opts) {
-  const responseValidator = procedure.response ? arriValidate.a.compile(procedure.response) : void 0;
+  let responseValidator;
+  try {
+    responseValidator = procedure.response ? arriValidate.a.compile(procedure.response) : void 0;
+  } catch (err) {
+    console.error("ERROR COMPILING VALIDATOR", err);
+  }
   const httpMethod = procedure.method ?? "post";
   const handler = h3.eventHandler(async (event) => {
     event.context.rpcName = procedure.name;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "arri",
-  "version": "0.1.0-beta.8",
+  "version": "0.1.1",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
@@ -31,10 +31,10 @@
     "pathe": "^1.1.1",
     "prettier": "^3.0.3",
     "scule": "^1.0.0",
-    "arri-codegen-dart": "0.1.0-beta.8",
-    "arri-validate": "0.1.0-beta.8",
-    "arri-codegen-utils": "0.1.0-beta.8",
-    "arri-codegen-ts": "0.1.0-beta.8"
+    "arri-codegen-ts": "0.1.1",
+    "arri-codegen-dart": "0.1.1",
+    "arri-codegen-utils": "0.1.1",
+    "arri-validate": "0.1.1"
   },
   "devDependencies": {
     "bun-types": "^1.0.5"