arri 0.44.0 → 0.45.0

package/dist/index.d.ts

@@ -1,282 +1,10 @@
-import { HttpMethod, WsRpcDefinition, RpcHttpMethod, HttpRpcDefinition, SchemaFormProperties, SchemaFormDiscriminator, SchemaFormValues, AppDefinition, ClientGenerator } from 'arri-codegen-utils';
-import { AObjectSchema, a, ValidationError, ASchema, InferType, ValueError, CompiledValidator, ADiscriminatorSchema } from 'arri-validate';
-import { H3Error, H3Event, H3EventContext, Router, App } from 'h3';
-export * from 'h3';
-import { EventStream } from 'h3-sse';
-import { Peer, WSError } from 'crossws';
+export { dartClientGenerator } from '@arrirpc/codegen-dart';
+export { typescriptClientGenerator } from '@arrirpc/codegen-ts';
+export { kotlinClientGenerator } from '@arrirpc/codegen-kotlin';
+import { ClientGenerator } from '@arrirpc/codegen-utils';
+export { AppDefinition, createAppDefinition } from '@arrirpc/codegen-utils';
 import { BuildOptions } from 'esbuild';
 
-declare class ArriServerError extends Error {
-    code: number;
-    data?: any;
-    constructor(err: {
-        code: number;
-        message: string;
-        data?: any;
-        stack?: string;
-    });
-}
-declare const ArriServerErrorResponse: AObjectSchema<{
-    code: number;
-    message: string;
-    stack?: string[] | undefined;
-    data?: any;
-}, false>;
-type ArriServerErrorResponse = a.infer<typeof ArriServerErrorResponse>;
-declare function defineError(statusCode: StatusCode, input?: Partial<Omit<ArriServerErrorResponse, "code" | "stack">>): ArriServerError;
-declare function errorResponseFromValidationErrors(errors: ValidationError["errors"], prefixText?: string): H3Error;
-type StatusCode = number | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 419 | 420 | 421 | 422 | 423 | 424 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504 | 505 | 507 | 511;
-declare function handleH3Error(err: unknown, event: H3Event, onError: ArriOptions["onError"], debug: boolean): Promise<void>;
-
-type ArriEventContext = Record<string, any>;
-interface RpcEventContext<TParams = undefined> extends ArriEventContext, Omit<H3EventContext, "params"> {
-    rpcName: string;
-    params: TParams;
-}
-interface RpcPostEventContext<TParams = undefined, TResponse = undefined> extends RpcEventContext<TParams> {
-    response: TResponse;
-}
-interface RouteEventContext<TPath extends string, TQuery extends Record<any, any> = any, TBody = any> extends ArriEventContext, H3EventContext {
-    params: ExtractParams<TPath>;
-    query: TQuery;
-    body: TBody;
-}
-interface RoutePostEventContext<TPath extends string, TQuery extends Record<any, any> = any, TBody = any, TResponse = any> extends RouteEventContext<TPath, TQuery, TBody> {
-    response: TResponse;
-}
-interface MiddlewareEventContext extends ArriEventContext, H3EventContext {
-    rpcName?: string;
-}
-
-interface MiddlewareEvent extends H3Event {
-    context: MiddlewareEventContext;
-}
-type Middleware = (event: MiddlewareEvent) => void | Promise<void>;
-declare const defineMiddleware: (middleware: Middleware) => Middleware;
-type ExtractParam<Path, NextPart> = Path extends `:${infer Param}` ? Record<Param, string> & NextPart : NextPart;
-type ExtractParams<Path> = Path extends `${infer Segment}/${infer Rest}` ? ExtractParam<Segment, ExtractParams<Rest>> : ExtractParam<Path, {}>;
-
-interface RouteEvent<TPath extends string, TQuery extends Record<any, any> = any, TBody = any> extends H3Event {
-    context: RouteEventContext<TPath, TQuery, TBody>;
-}
-interface PostRouteEvent<TPath extends string, TQuery extends Record<any, any> = any, TBody = any, TResponse = any> extends H3Event {
-    context: RoutePostEventContext<TPath, TQuery, TBody, TResponse>;
-}
-interface ArriRoute<TPath extends string, TQuery extends AObjectSchema<any, any> = any, TBody extends ASchema<any> = any, TResponse = any> {
-    path: TPath;
-    method: HttpMethod | HttpMethod[];
-    query?: TQuery;
-    body?: TBody;
-    handler: (event: RouteEvent<TPath, InferType<TQuery>, InferType<TBody>>) => TResponse;
-    postHandler?: (event: PostRouteEvent<TPath, InferType<TQuery>, InferType<TBody>, Awaited<TResponse>>) => any;
-}
-declare function defineRoute<TPath extends string, TQuery extends AObjectSchema<any, any> = any, TBody extends AObjectSchema<any, any> = any, TResponse = any>(route: ArriRoute<TPath, TQuery, TBody, TResponse>): ArriRoute<TPath, TQuery, TBody, TResponse>;
-type RouteOptions = Pick<ArriOptions, "onAfterResponse" | "onBeforeResponse" | "onError" | "onRequest" | "debug"> & {
-    middleware: Middleware[];
-};
-declare function registerRoute(router: Router, route: ArriRoute<any>, opts: RouteOptions): void;
-declare function handleRoute(router: Router, method: HttpMethod, route: ArriRoute<any>, opts: RouteOptions): void;
-
-declare function defineEventStreamRpc<TParams extends RpcParamSchema | undefined = undefined, TResponse extends RpcParamSchema | undefined | never = undefined>(config: Omit<EventStreamRpc<TParams, TResponse>, "isEventStream" | "transport">): EventStreamRpc<TParams, TResponse>;
-declare function isEventStreamRpc(input: unknown): input is EventStreamRpc<any, any>;
-interface EventStreamRpc<TParams extends RpcParamSchema | undefined = undefined, TResponse extends RpcParamSchema | undefined = undefined> extends Omit<Rpc<true, TParams, TResponse>, "handler" | "postHandler"> {
-    isEventStream: true;
-    handler: EventStreamRpcHandler<TParams extends RpcParamSchema ? InferType<TParams> : undefined, TResponse extends RpcParamSchema ? InferType<TResponse> : undefined>;
-}
-type EventStreamRpcHandler<TParams, TResponse> = (context: EventStreamRpcHandlerContext<TParams, TResponse>, event: RpcEvent<TResponse>) => void | Promise<void>;
-interface EventStreamRpcHandlerContext<TParams = any, TResponse = any> extends RpcEventContext<TParams> {
-    stream: EventStreamConnection<TResponse>;
-}
-interface EventStreamConnectionOptions<TData> {
-    validator: (input: unknown) => input is TData;
-    validationErrors: (input: unknown) => ValueError[];
-    serializer: (input: TData) => string;
-    pingInterval?: number;
-}
-declare class EventStreamConnection<TData> {
-    readonly lastEventId?: string;
-    private readonly validationErrors;
-    private readonly validator;
-    private readonly serializer;
-    private pingInterval;
-    private readonly pingIntervalMs;
-    readonly eventStream: EventStream;
-    constructor(event: H3Event, opts: EventStreamConnectionOptions<TData>);
-    /**
-     * Send the stream to the client. This must be called before sending any events.
-     */
-    send(): void;
-    /**
-     * Publish a new event. Events published with this hook will trigger the `onData()` hooks of any connected clients.
-     */
-    push(data: TData[], eventId?: string): Promise<void>;
-    push(data: TData, eventId?: string): Promise<void>;
-    /**
-     * Publish an error event. This will trigger the `onError` hooks of any connected clients.
-     */
-    pushError(error: ArriServerErrorResponse, eventId?: string): Promise<void>;
-    private cleanup;
-    /**
-     * Tell clients that the stream has ended and close the connection.
-     */
-    close(): Promise<void>;
-    onClose(cb: () => any): void;
-}
-declare function registerEventStreamRpc(router: Router, path: string, procedure: EventStreamRpc<any, any> & {
-    name: string;
-}, opts: RouteOptions): void;
-
-interface NamedWebsocketRpc<TParams extends RpcParamSchema | undefined = undefined, TResponse extends RpcParamSchema | undefined = undefined> extends WebsocketRpc<TParams, TResponse> {
-    name: string;
-}
-interface WebsocketRpc<TParams extends RpcParamSchema | undefined = undefined, TResponse extends RpcParamSchema | undefined = undefined> {
-    transport: "ws";
-    description?: string;
-    path?: string;
-    isDeprecated?: boolean;
-    params: TParams;
-    response: TResponse;
-    pingInterval?: boolean;
-    handler: WebSocketRpcHandler<TParams extends RpcParamSchema ? InferType<TParams> : undefined, TResponse extends RpcParamSchema ? InferType<TResponse> : undefined> | (() => WebSocketRpcHandler<TParams extends RpcParamSchema ? InferType<TParams> : undefined, TResponse extends RpcParamSchema ? InferType<TResponse> : undefined>);
-}
-interface WsPeerOpts<TResponse> {
-    validator?: CompiledValidator<ASchema<TResponse>>;
-    context: WsPeerContext;
-}
-interface WsPeerContext extends Record<string, any> {
-    rpcName: string;
-    queryParams?: Record<string, string>;
-    clientAddress?: string;
-}
-declare class WsPeer<TResponse> {
-    private readonly _peer;
-    private readonly _validator?;
-    context: WsPeerContext;
-    url: string;
-    constructor(peer: Peer, opts: WsPeerOpts<TResponse>);
-    send(data: TResponse): number | undefined;
-    sendError(err: ArriServerErrorResponse): number;
-    close(): void;
-    subscribe(channel: string): void;
-    unsubscribe(channel: string): void;
-    publish(channel: string, message: TResponse): void;
-    readyState(): (0 | 1 | 2 | 3) | -1;
-}
-interface WebSocketRpcHandler<TParams, TResponse> {
-    onOpen: (peer: WsPeer<TResponse>) => void;
-    onMessage: (peer: WsPeer<TResponse>, message: TParams) => void;
-    onClose: (peer: WsPeer<TResponse>, details: {
-        code?: number;
-        reason?: string;
-    }) => void;
-    onError: (peer: WsPeer<TResponse>, error: WSError) => void;
-}
-declare function defineWebsocketRpc<TParams extends RpcParamSchema | undefined, TResponse extends RpcParamSchema | undefined>(def: Omit<WebsocketRpc<TParams, TResponse>, "transport">): WebsocketRpc<TParams, TResponse>;
-declare function registerWebsocketRpc(router: Router, path: string, rpc: NamedWebsocketRpc<any, any>): void;
-declare function createWsRpcDefinition(rpcName: string, path: string, rpc: NamedWebsocketRpc<any, any>): WsRpcDefinition;
-
-type RpcParamSchema<TObjectInner = any, TDiscriminatorInner = any> = AObjectSchema<TObjectInner> | ADiscriminatorSchema<TDiscriminatorInner>;
-declare function isRpcParamSchema(input: unknown): input is RpcParamSchema;
-interface NamedRpc<TIsEventStream extends boolean = false, TParams extends RpcParamSchema | undefined = undefined, TResponse extends RpcParamSchema | undefined = undefined> extends Rpc<TIsEventStream, TParams, TResponse> {
-    name: string;
-}
-interface Rpc<TIsEventStream extends boolean = false, TParams extends RpcParamSchema | undefined = undefined, TResponse extends RpcParamSchema | undefined = undefined> {
-    transport: "http";
-    method?: RpcHttpMethod;
-    path?: string;
-    description?: string;
-    params: TParams;
-    response: TResponse;
-    isDeprecated?: boolean;
-    isEventStream?: TIsEventStream;
-    pingInterval?: TIsEventStream extends true ? number : undefined;
-    handler: TIsEventStream extends true ? EventStreamRpcHandler<TParams extends RpcParamSchema ? InferType<TParams> : undefined, TResponse extends RpcParamSchema ? InferType<TResponse> : undefined> : RpcHandler<TParams extends RpcParamSchema ? InferType<TParams> : undefined, TResponse extends RpcParamSchema ? InferType<TResponse> : void>;
-    postHandler?: TIsEventStream extends true ? undefined : RpcPostHandler<TParams extends RpcParamSchema ? InferType<TParams> : undefined, TResponse extends RpcParamSchema ? InferType<TResponse> : undefined>;
-}
-type HttpRpc<TParams extends RpcParamSchema | undefined, TResponse extends RpcParamSchema | undefined> = Omit<Rpc<false, TParams, TResponse>, "isEventStream">;
-interface RpcEvent<TParams = undefined> extends Omit<H3Event, "context"> {
-    context: RpcEventContext<TParams>;
-}
-interface RpcPostEvent<TParams = undefined, TResponse = undefined> extends Omit<H3Event, "context"> {
-    context: RpcPostEventContext<TParams, TResponse>;
-}
-type RpcHandler<TParams, TResponse> = (context: RpcEventContext<TParams>, event: RpcEvent<TParams>) => TResponse | Promise<TResponse>;
-type RpcPostHandler<TParams, TResponse> = (context: RpcPostEventContext<TParams, TResponse>, event: RpcPostEvent<TParams, TResponse>) => any;
-declare function isRpc(input: unknown): input is Rpc<any, any>;
-declare function defineRpc<TParams extends RpcParamSchema | undefined = undefined, TResponse extends RpcParamSchema | undefined | never = undefined>(config: Omit<HttpRpc<TParams, TResponse>, "transport">): Rpc<false, TParams, TResponse>;
-declare function createHttpRpcDefinition(rpcName: string, httpPath: string, procedure: Rpc<any, any, any>): HttpRpcDefinition;
-declare function getRpcPath(rpcName: string, prefix?: string): string;
-declare function getRpcParamName(rpcName: string, procedure: Rpc<any, any, any> | WebsocketRpc<any, any>): string | undefined;
-declare function getRpcResponseName(rpcName: string, procedure: Rpc<any, any, any> | WebsocketRpc<any, any>): string | undefined;
-declare function registerRpc(router: Router, path: string, procedure: NamedRpc<any, any, any>, opts: RouteOptions): void;
-declare function validateRpcRequestInput(event: H3Event, httpMethod: RpcHttpMethod, schema: ASchema): Promise<void>;
-
-interface ArriRouterBase {
-    rpc: <TIsEventStream extends boolean, TParams extends AObjectSchema<any, any> | undefined, TResponse extends AObjectSchema<any, any> | undefined>(procedure: Omit<NamedRpc<TIsEventStream, TParams, TResponse>, "transport">) => void;
-    wsRpc: <TParams extends RpcParamSchema | undefined, TResponse extends RpcParamSchema | undefined>(procedure: Omit<NamedWebsocketRpc<TParams, TResponse>, "transport">) => void;
-    route: <TPath extends string, TQuery extends AObjectSchema<any, any> = any, TBody extends ASchema<any> = any, TResponse = any>(route: ArriRoute<TPath, TQuery, TBody, TResponse>) => void;
-    registerModels: (models: ModelMap) => void;
-}
-declare class ArriRouter implements ArriRouterBase {
-    private readonly procedures;
-    private readonly routes;
-    private readonly models;
-    rpc<TIsEventStream extends boolean = false, TParams extends AObjectSchema<any, any> | undefined = undefined, TResponse extends AObjectSchema<any, any> | undefined = undefined>(procedure: Omit<NamedRpc<TIsEventStream, TParams, TResponse>, "transport">): void;
-    wsRpc<TParams extends RpcParamSchema | undefined, TResponse extends RpcParamSchema | undefined>(procedure: Omit<NamedWebsocketRpc<TParams, TResponse>, "transport">): void;
-    route<TPath extends string, TQuery extends AObjectSchema<any, any> = any, TBody extends ASchema<any> = any, TResponse = any>(route: ArriRoute<TPath, TQuery, TBody, TResponse>): void;
-    registerModels(models: ModelMap): void;
-    getProcedures(): (NamedWebsocketRpc<any, any> | NamedRpc<any, any, any>)[];
-    getRoutes(): ArriRoute<any, any, any, any>[];
-    getModels(): ModelMap;
-}
-
-declare const DEV_ENDPOINT_ROOT = "/__arri_dev__";
-declare const DEV_DEFINITION_ENDPOINT = "/__arri_dev__/__definition";
-type ModelMap = Record<string, SchemaFormProperties | SchemaFormDiscriminator | SchemaFormValues>;
-declare const createAppDefinition: (def: AppDefinition) => AppDefinition;
-declare class ArriApp implements ArriRouterBase {
-    __isArri__: boolean;
-    readonly h3App: App;
-    readonly h3Router: Router;
-    private readonly _rpcDefinitionPath;
-    private readonly _rpcRoutePrefix;
-    appInfo: AppDefinition["info"];
-    private _procedures;
-    private _models;
-    private readonly _middlewares;
-    private readonly _onRequest;
-    private readonly _onAfterResponse;
-    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: Omit<NamedRpc<TIsEventStream, TParams, TResponse>, "transport">): void;
-    wsRpc<TParams extends RpcParamSchema | undefined, TResponse extends RpcParamSchema | undefined>(procedure: Omit<NamedWebsocketRpc<TParams, TResponse>, "transport">): void;
-    route<TPath extends string, TQuery extends AObjectSchema<any, any>, TBody extends ASchema<any>, TResponse = any>(route: ArriRoute<TPath, TQuery, TBody, TResponse>): void;
-    registerModels(models: ModelMap): void;
-    getAppDefinition(): AppDefinition;
-}
-interface ArriOptions {
-    debug?: boolean;
-    /**
-     * Metadata to display in the __definition.json file
-     */
-    appInfo?: AppDefinition["info"];
-    rpcRoutePrefix?: string;
-    /**
-     * Defaults to /__definitions
-     * This parameters also takes the rpcRoutePrefix option into account
-     */
-    rpcDefinitionPath?: string;
-    disableDefaultRoute?: boolean;
-    onRequest?: (event: MiddlewareEvent) => void | Promise<void>;
-    onAfterResponse?: (event: MiddlewareEvent) => void | Promise<void>;
-    onBeforeResponse?: (event: MiddlewareEvent) => void | Promise<void>;
-    onError?: (error: ArriServerError, event: MiddlewareEvent) => void | Promise<void>;
-}
-
 interface ArriConfig {
     port?: number;
     entry?: string;
@@ -310,4 +38,6 @@ type ResolvedArriConfig = Required<ArriConfig>;
 declare const defaultConfig: Required<ArriConfig>;
 declare function defineConfig(config: ArriConfig): ResolvedArriConfig;
 
-export { ArriApp, type ArriConfig, type ArriEventContext, type ArriOptions, type ArriRoute, ArriRouter, type ArriRouterBase, ArriServerError, ArriServerErrorResponse, DEV_DEFINITION_ENDPOINT, DEV_ENDPOINT_ROOT, EventStreamConnection, type EventStreamConnectionOptions, type EventStreamRpc, type EventStreamRpcHandler, type EventStreamRpcHandlerContext, type ExtractParam, type ExtractParams, type HttpRpc, type Middleware, type MiddlewareEvent, type MiddlewareEventContext, type ModelMap, type NamedRpc, type NamedWebsocketRpc, type PostRouteEvent, type ResolvedArriConfig, type RouteEvent, type RouteEventContext, type RouteOptions, type RoutePostEventContext, type Rpc, type RpcEvent, type RpcEventContext, type RpcHandler, type RpcParamSchema, type RpcPostEvent, type RpcPostEventContext, type RpcPostHandler, type StatusCode, type WebSocketRpcHandler, type WebsocketRpc, WsPeer, type WsPeerContext, createAppDefinition, createHttpRpcDefinition, createWsRpcDefinition, defaultConfig, defineConfig, defineError, defineEventStreamRpc, defineMiddleware, defineRoute, defineRpc, defineWebsocketRpc, errorResponseFromValidationErrors, getRpcParamName, getRpcPath, getRpcResponseName, handleH3Error, handleRoute, isArriConfig, isEventStreamRpc, isResolvedArriConfig, isRpc, isRpcParamSchema, registerEventStreamRpc, registerRoute, registerRpc, registerWebsocketRpc, validateRpcRequestInput };
+declare const DEV_DEFINITION_ENDPOINT = "/__arri_dev__/__definition";
+
+export { type ArriConfig, DEV_DEFINITION_ENDPOINT, type ResolvedArriConfig, defaultConfig, defineConfig, isArriConfig, isResolvedArriConfig };

package/dist/index.mjs

@@ -1,10 +1,16 @@
-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, W as WsPeer, c as createAppDefinition, e as createHttpRpcDefinition, G as createWsRpcDefinition, q as defaultConfig, s as defineConfig, l as defineError, y as defineEventStreamRpc, u as defineRoute, d as defineRpc, C as defineWebsocketRpc, 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, F as registerWebsocketRpc, v as validateRpcRequestInput } from './shared/arri.c3a553fc.mjs';
-export * from 'h3';
-import 'arri-codegen-utils';
-import 'arri-validate';
-import 'h3-sse';
+export { dartClientGenerator } from '@arrirpc/codegen-dart';
+export { typescriptClientGenerator } from '@arrirpc/codegen-ts';
+export { kotlinClientGenerator } from '@arrirpc/codegen-kotlin';
+export { createAppDefinition } from '@arrirpc/codegen-utils';
+export { D as DEV_DEFINITION_ENDPOINT, d as defaultConfig, b as defineConfig, i as isArriConfig, a as isResolvedArriConfig } from './shared/arri.e5993636.mjs';
+import 'node:fs';
+import 'node:fs/promises';
+import '@joshmossas/listhen';
+import 'c12';
+import 'citty';
+import 'esbuild';
+import 'ofetch';
+import 'pathe';
+import 'consola';
+import 'prettier';
 import 'scule';
-
-const defineMiddleware = (middleware) => middleware;
-
-export { defineMiddleware };