feat: codegen and router refactor (#106)

Author: andogq

.changes/router-refactor.md

@@ -0,0 +1,7 @@
+---
+"qubit": major
+---
+
+**(BREAKING)** Refactor router to separate RPC functionality from type generation functionality.
+Now, use `router.as_codegen().write_type(path, TypeScript::new())` to generate types, and
+`router.as_rpc(ctx).into_service()` to build the service.

Cargo.lock

@@ -38,6 +38,7 @@ urlencoding = "2.1.3"
 derive_more = { version = "2.0.1", features = ["deref"] }
 linkme = "0.3.33"
 lazy_static = "1.5.0"
+thiserror = "2.0.12"
 
 [features]
 ts-format = ["ts-rs/format"]

Cargo.toml

@@ -65,14 +65,18 @@ async fn hello_world() -> String {
 let router = Router::new()
     .handler(hello_world);
 
-router.write_bindings_to_dir("./bindings");
+router
+    .as_codegen()
+    .write_type("./bindings", TypeScript::new());
 ```
 
 3. Attach the Qubit router to an Axum router, and start it
 
 ```rs
 // Create a service and handle
-let (qubit_service, qubit_handle) = router.to_service(());
+let (qubit_service, qubit_handle) = router
+    .as_rpc()
+    .into_service(());
 
 // Nest into an Axum router
 let axum_router = axum::Router::<()>::new()

README.md

@@ -1,15 +1,16 @@
 /* eslint-disable */
 // @ts-nocheck
-/*    @@@@@@@@@@@@@ & ###############
+/*
+      @@@@@@@@@@@@@ & ###############
    @@@@@@@@@@@@@@ &&& ###############
  @@@@@@@@@@@@@@ &&&&& ###############
 ############### &&&&& ###############
 ######## Generated by Qubit! ########
 ############### &&&&& ###############
 ############### &&&&& @@@@@@@@@@@@@@
 ############### && @@@@@@@@@@@@@@
-############### & @@@@@@@@@@@@@    */
+############### & @@@@@@@@@@@@@
 
+*/
 import type { Query, Mutation, Subscription } from "@qubit-rs/client";
 export type QubitServer = { echo_cookie: Query<[], string>, secret_endpoint: Query<[], string>, };
-

examples/authentication/Cargo.lock

@@ -1,13 +1,13 @@
 use std::net::SocketAddr;
 
 use axum::{
-    Form,
     response::{IntoResponse, Response},
     routing::post,
+    Form,
 };
 use cookie::Cookie;
-use hyper::{StatusCode, header::SET_COOKIE};
-use qubit::{ErrorCode, Extensions, FromRequestExtensions, Router, RpcError, handler};
+use hyper::{header::SET_COOKIE, StatusCode};
+use qubit::{handler, ErrorCode, Extensions, FromRequestExtensions, Router, RpcError, TypeScript};
 use serde::Deserialize;
 use tokio::net::TcpListener;
 use tower::ServiceBuilder;
@@ -114,9 +114,12 @@ async fn main() {
     let router = Router::<()>::new()
         .handler(echo_cookie)
         .handler(secret_endpoint);
-    router.generate_type("./auth-demo/src/bindings.ts").unwrap();
+    router
+        .as_codegen()
+        .write_type("./auth-demo/src/bindings.ts", TypeScript::new())
+        .unwrap();
 
-    let (qubit_service, handle) = router.into_service(());
+    let (qubit_service, handle) = router.as_rpc(()).into_service();
 
     let qubit_service = ServiceBuilder::new()
         .map_request(|mut req: hyper::Request<_>| {

examples/authentication/auth-demo/src/bindings.ts

@@ -1,21 +1,22 @@
 /* eslint-disable */
 // @ts-nocheck
-/*    @@@@@@@@@@@@@ & ###############
+/*
+      @@@@@@@@@@@@@ & ###############
    @@@@@@@@@@@@@@ &&& ###############
  @@@@@@@@@@@@@@ &&&&& ###############
 ############### &&&&& ###############
 ######## Generated by Qubit! ########
 ############### &&&&& ###############
 ############### &&&&& @@@@@@@@@@@@@@
 ############### && @@@@@@@@@@@@@@
-############### & @@@@@@@@@@@@@    */
+############### & @@@@@@@@@@@@@
 
+*/
 import type { Query, Mutation, Subscription } from "@qubit-rs/client";
 export type User = { name: string, email: string, age: number, metadata: Metadata, };
+export type Test = { a: number, b: boolean, };
+export type Metadata = { param_a: string, param_b: number, param_c: boolean, more_metadata: Metadata | null, };
 export type UniqueType = { value: number, };
 export type NestedStruct = { a: number, b: boolean, };
-export type Test = { a: number, b: boolean, };
 export type MyEnum = "A" | { "B": number } | { "C": { field: number, } } | { "D": NestedStruct };
-export type Metadata = { param_a: string, param_b: number, param_c: boolean, more_metadata: Metadata | null, };
-export type QubitServer = { user: { asdf: Query<[], null>, create: Mutation<[name: string, email: string, age: number], User>, list: Query<[], Array<Test>>, someHandler: Query<[_id: string], User>, }, array: Query<[], Array<string>>, array_type: Query<[], Array<UniqueType>>, count: Mutation<[], number>, countdown: Subscription<[min: number, max: number], number>, enum_test: Query<[], MyEnum>, version: Query<[], string>, };
-
+export type QubitServer = { array: Query<[], Array<string>>, array_type: Query<[], Array<UniqueType>>, count: Mutation<[], number>, countdown: Subscription<[min: number, max: number], number>, enum_test: Query<[], MyEnum>, version: Query<[], string>, user: { asdf: Query<[], null>, create: Mutation<[name: string, email: string, age: number], User>, list: Query<[], Array<Test>>, someHandler: Query<[_id: string], User>, }, };

examples/authentication/src/main.rs

@@ -1,13 +1,13 @@
 use std::{
     net::SocketAddr,
     sync::{
-        Arc,
         atomic::{AtomicUsize, Ordering},
+        Arc,
     },
     time::Duration,
 };
 
-use futures::{Stream, StreamExt, stream};
+use futures::{stream, Stream, StreamExt};
 use qubit::*;
 
 use axum::routing::get;
@@ -213,10 +213,12 @@ async fn main() {
         .nest("user", user::create_router());
 
     // Save the router's bindings
-    app.generate_type("./bindings.ts").unwrap();
+    app.as_codegen()
+        .write_type("./bindings.ts", TypeScript::new())
+        .unwrap();
 
     // Create a service and handle for the app
-    let (app_service, app_handle) = app.into_service(AppCtx::default());
+    let (app_service, app_handle) = app.as_rpc(AppCtx::default()).into_service();
 
     // Set up the axum router
     let router = axum::Router::<()>::new()