arri 0.0.15 → 0.0.17

package/dist/shared/{arri.bb7e9a4e.d.ts → arri.b176bba1.d.cts}

@@ -1,34 +1,54 @@
 import { TObject, TSchema, Static } from '@sinclair/typebox';
 import { Router, H3Event, App, AppOptions } from 'h3';
 
-interface ApplicationDefinition {
-    schemaVersion: "0.0.1";
-    description: string;
-    procedures: Record<string, ProcedureDefinition>;
+interface ApplicationDef {
+    arriSchemaVersion: "0.0.1";
+    info?: {
+        title?: string;
+        description?: string;
+        version?: string;
+    };
+    externalDocs?: {
+        description?: string;
+        url: string;
+    };
+    procedures: Record<string, ProcedureDef>;
     models: Record<string, JsonSchemaObject>;
     errors: Omit<TObject, symbol>;
 }
-interface ProcedureDefinition {
+declare function normalizeWhitespace(input: string): string;
+interface ProcedureDef {
     path: string;
     description?: string;
     method: HttpMethod;
     params: string | undefined;
     response: string | undefined;
 }
-interface ServiceDefinition {
-    [key: string]: ProcedureDefinition | ServiceDefinition;
+declare function isProcedureDef(input: any): input is ProcedureDef;
+interface ServiceDef {
+    [key: string]: ProcedureDef | ServiceDef;
 }
+declare function isServiceDef(input: any): input is ServiceDef;
+declare function isApplicationDef(input: any): input is ApplicationDef;
+declare function unflattenObject(data: Record<string, any>): any;
+declare function unflattenProcedures(procedures: ApplicationDef["procedures"]): Record<string, ProcedureDef | ServiceDef>;
+declare function setNestedObjectProperty<T>(targetProp: string, value: T, object: Record<any, any>): Record<any, any>;
+declare const removeDisallowedChars: (input: string, disallowedChars: string) => string;
 declare const JsonSchemaScalarTypeValues: readonly ["integer", "number", "bigint", "string", "boolean", "Date"];
 declare const JsonSchemaNullTypeValues: readonly ["null", "undefined"];
+declare const JsonSchemaComplexTypeValues: readonly ["object", "list", "array", "Uint8Array"];
 type JsonSchemaType = JsonSchemaScalarType | JsonSchemaNullType | JsonSchemaComplexType;
+type JsonSchemaTypeValue = (typeof JsonSchemaScalarTypeValues)[number] | (typeof JsonSchemaNullTypeValues)[number] | (typeof JsonSchemaComplexTypeValues)[number];
 interface JsonSchemaScalarType {
     title?: string;
     description?: string;
     type: (typeof JsonSchemaScalarTypeValues)[number];
 }
+declare function isJsonSchemaScalarType(input: any): input is JsonSchemaScalarType;
 interface JsonSchemaNullType {
     type: (typeof JsonSchemaNullTypeValues)[number];
 }
+declare function isJsonSchemaNullType(input: any): input is JsonSchemaNullType;
 type JsonSchemaComplexType = JsonSchemaObject | JsonSchemaArray;
 interface JsonSchemaObject {
     $id?: string;
@@ -38,6 +58,7 @@ interface JsonSchemaObject {
     properties: Record<string, JsonSchemaType>;
     required?: string[];
 }
+declare const isJsonSchemaObject: (input: any) => input is JsonSchemaObject;
 interface JsonSchemaArray {
     $id?: string;
     title?: string;
@@ -45,6 +66,23 @@ interface JsonSchemaArray {
     type: "array";
     items: JsonSchemaType;
 }
+declare function isJsonSchemaArray(input: any): input is JsonSchemaArray;
+interface JsonSchemaUint8Array {
+    type: "Uint8Array";
+}
+interface JsonSchemaEnum {
+    anyOf: Array<{
+        type: "string";
+        const: string;
+    }> | Array<{
+        type: "number";
+        const: number;
+    }> | Array<{
+        type: "integer";
+        const: number;
+    }>;
+}
+declare function isJsonSchemaEnum(input: any): input is JsonSchemaEnum;
 
 interface ArriRoute<TPath extends string, TMethod extends HttpMethod, TQuery extends TObject | undefined = undefined, TBody extends TSchema | undefined = undefined, TResponse extends TSchema | undefined = undefined, TFallbackResponse = any> {
     path: TPath;
@@ -101,21 +139,24 @@ type ArriProcedureHandler<TParams, TResponse> = (context: RpcHandlerContext<TPar
 type ArriProcedurePostHandler<TParams, TResponse> = (event: RpcPostHandlerContext<TParams, TResponse>) => any;
 declare function isRpc(input: any): input is ArriProcedure<any, any>;
 declare function defineRpc<TParams extends TObject | undefined = undefined, TResponse extends TObject | undefined | never = undefined>(config: ArriProcedure<TParams, TResponse>): ArriProcedure<TParams, TResponse>;
-declare function createRpcDefinition(rpcName: string, httpPath: string, procedure: ArriProcedure<any, any>): ProcedureDefinition;
+declare function createRpcDefinition(rpcName: string, httpPath: string, procedure: ArriProcedure<any, any>): ProcedureDef;
 declare function getRpcPath(rpcName: string, prefix?: string): string;
 declare function getRpcParamName(rpcName: string, procedure: ArriProcedure<any, any>): string | null;
-declare function getRpcParamDefinition(rpcName: string, procedure: ArriProcedure<any, any>): ProcedureDefinition["params"];
+declare function getRpcParamDefinition(rpcName: string, procedure: ArriProcedure<any, any>): ProcedureDef["params"];
 declare function getRpcResponseName(rpcName: string, procedure: ArriProcedure<any, any>): string | null;
 declare function registerRpc(router: Router, path: string, procedure: ArriProcedure<any, any>, middleware: Middleware[]): void;
 
 interface ArriOptions extends AppOptions {
+    /**
+     * Metadata to display in the __definition.json file
+     */
+    appInfo?: ApplicationDef["info"];
     rpcRoutePrefix?: string;
     /**
      * Defaults to /__definitions
      * This parameters also takes the rpcRoutePrefix option into account
      */
     rpcDefinitionPath?: string;
-    appDescription?: string;
 }
 declare const DEV_ENDPOINT_ROOT = "/__arri_dev__";
 declare const DEV_DEFINITION_ENDPOINT = "/__arri_dev__/definition";
@@ -125,19 +166,26 @@ declare class Arri {
     private readonly h3Router;
     private readonly rpcDefinitionPath;
     private readonly rpcRoutePrefix;
+    appInfo: ApplicationDef["info"];
     private procedures;
     private models;
     private readonly middlewares;
-    private readonly appDescription;
     constructor(opts?: ArriOptions);
     registerMiddleware(middleware: Middleware): void;
     registerRpc<TParams extends TObject | undefined, TResponse extends TObject | undefined>(name: string, procedure: ArriProcedure<TParams, TResponse>): void;
     registerRoute<TPath extends string, TMethod extends HttpMethod = HttpMethod, TQuery extends TObject | undefined = undefined, TBody extends TSchema | undefined = undefined, TResponse extends TSchema | undefined = undefined, TFallbackResponse = any>(route: ArriRoute<TPath, TMethod, TQuery, TBody, TResponse, TFallbackResponse>): void;
-    getAppDefinition(): ApplicationDefinition;
+    getAppDefinition(): ApplicationDef;
     getH3Instance(): App;
 }
 declare const HttpMethodValues: readonly ["get", "post", "put", "patch", "delete", "head"];
 type HttpMethod = (typeof HttpMethodValues)[number];
 declare const isHttpMethod: (input: any) => input is "get" | "post" | "put" | "patch" | "delete" | "head";
 
-export { Arri as A, type ApplicationDefinition as B, DEV_ENDPOINT_ROOT as D, type ExtractParam as E, HttpMethodValues as H, type JsonSchemaObject as J, type Middleware as M, type ProcedureDefinition as P, type RpcHandlerContext as R, type ServiceDefinition as S, DEV_DEFINITION_ENDPOINT as a, type HttpMethod as b, type ArriProcedureBase as c, type ArriProcedure as d, type HandlerContext as e, type RpcPostHandlerContext as f, type ArriProcedureHandler as g, type ArriProcedurePostHandler as h, isHttpMethod as i, isRpc as j, defineRpc as k, createRpcDefinition as l, getRpcPath as m, getRpcParamName as n, getRpcParamDefinition as o, getRpcResponseName as p, type ArriRoute as q, registerRpc as r, defineRoute as s, defineMiddleware as t, type ExtractParams as u, type ArriRouteHandler as v, type RouteHandlerContext as w, type RoutePostHandlerContext as x, type ArriRoutePostHandler as y, registerRoute as z };
+interface ClientGenerator<TOptions extends Record<string, any> | undefined> {
+    generator: (def: ApplicationDef) => any;
+    options: TOptions;
+}
+type ClientGeneratorPlugin<TOptions extends Record<string, any> | undefined> = (options: TOptions) => ClientGenerator<TOptions>;
+declare function defineClientGeneratorPlugin<TOptions extends Record<string, any> | undefined>(plugin: ClientGeneratorPlugin<TOptions>): ClientGeneratorPlugin<TOptions>;
+
+export { isJsonSchemaScalarType as $, Arri as A, type ClientGeneratorPlugin as B, type ClientGenerator as C, DEV_ENDPOINT_ROOT as D, type ExtractParam as E, type ApplicationDef as F, defineClientGeneratorPlugin as G, HttpMethodValues as H, normalizeWhitespace as I, type JsonSchemaObject as J, isProcedureDef as K, isServiceDef as L, type Middleware as M, isApplicationDef as N, unflattenObject as O, type ProcedureDef as P, unflattenProcedures as Q, type RpcHandlerContext as R, type ServiceDef as S, setNestedObjectProperty as T, removeDisallowedChars as U, JsonSchemaScalarTypeValues as V, JsonSchemaNullTypeValues as W, JsonSchemaComplexTypeValues as X, type JsonSchemaType as Y, type JsonSchemaTypeValue as Z, type JsonSchemaScalarType as _, DEV_DEFINITION_ENDPOINT as a, type JsonSchemaNullType as a0, isJsonSchemaNullType as a1, type JsonSchemaComplexType as a2, isJsonSchemaObject as a3, type JsonSchemaArray as a4, isJsonSchemaArray as a5, type JsonSchemaUint8Array as a6, type JsonSchemaEnum as a7, isJsonSchemaEnum as a8, type HttpMethod as b, type ArriProcedureBase as c, type ArriProcedure as d, type HandlerContext as e, type RpcPostHandlerContext as f, type ArriProcedureHandler as g, type ArriProcedurePostHandler as h, isHttpMethod as i, isRpc as j, defineRpc as k, createRpcDefinition as l, getRpcPath as m, getRpcParamName as n, getRpcParamDefinition as o, getRpcResponseName as p, type ArriRoute as q, registerRpc as r, defineRoute as s, defineMiddleware as t, type ExtractParams as u, type ArriRouteHandler as v, type RouteHandlerContext as w, type RoutePostHandlerContext as x, type ArriRoutePostHandler as y, registerRoute as z };

package/dist/shared/{arri.bb7e9a4e.d.cts → arri.b176bba1.d.mts}

@@ -1,34 +1,54 @@
 import { TObject, TSchema, Static } from '@sinclair/typebox';
 import { Router, H3Event, App, AppOptions } from 'h3';
 
-interface ApplicationDefinition {
-    schemaVersion: "0.0.1";
-    description: string;
-    procedures: Record<string, ProcedureDefinition>;
+interface ApplicationDef {
+    arriSchemaVersion: "0.0.1";
+    info?: {
+        title?: string;
+        description?: string;
+        version?: string;
+    };
+    externalDocs?: {
+        description?: string;
+        url: string;
+    };
+    procedures: Record<string, ProcedureDef>;
     models: Record<string, JsonSchemaObject>;
     errors: Omit<TObject, symbol>;
 }
-interface ProcedureDefinition {
+declare function normalizeWhitespace(input: string): string;
+interface ProcedureDef {
     path: string;
     description?: string;
     method: HttpMethod;
     params: string | undefined;
     response: string | undefined;
 }
-interface ServiceDefinition {
-    [key: string]: ProcedureDefinition | ServiceDefinition;
+declare function isProcedureDef(input: any): input is ProcedureDef;
+interface ServiceDef {
+    [key: string]: ProcedureDef | ServiceDef;
 }
+declare function isServiceDef(input: any): input is ServiceDef;
+declare function isApplicationDef(input: any): input is ApplicationDef;
+declare function unflattenObject(data: Record<string, any>): any;
+declare function unflattenProcedures(procedures: ApplicationDef["procedures"]): Record<string, ProcedureDef | ServiceDef>;
+declare function setNestedObjectProperty<T>(targetProp: string, value: T, object: Record<any, any>): Record<any, any>;
+declare const removeDisallowedChars: (input: string, disallowedChars: string) => string;
 declare const JsonSchemaScalarTypeValues: readonly ["integer", "number", "bigint", "string", "boolean", "Date"];
 declare const JsonSchemaNullTypeValues: readonly ["null", "undefined"];
+declare const JsonSchemaComplexTypeValues: readonly ["object", "list", "array", "Uint8Array"];
 type JsonSchemaType = JsonSchemaScalarType | JsonSchemaNullType | JsonSchemaComplexType;
+type JsonSchemaTypeValue = (typeof JsonSchemaScalarTypeValues)[number] | (typeof JsonSchemaNullTypeValues)[number] | (typeof JsonSchemaComplexTypeValues)[number];
 interface JsonSchemaScalarType {
     title?: string;
     description?: string;
     type: (typeof JsonSchemaScalarTypeValues)[number];
 }
+declare function isJsonSchemaScalarType(input: any): input is JsonSchemaScalarType;
 interface JsonSchemaNullType {
     type: (typeof JsonSchemaNullTypeValues)[number];
 }
+declare function isJsonSchemaNullType(input: any): input is JsonSchemaNullType;
 type JsonSchemaComplexType = JsonSchemaObject | JsonSchemaArray;
 interface JsonSchemaObject {
     $id?: string;
@@ -38,6 +58,7 @@ interface JsonSchemaObject {
     properties: Record<string, JsonSchemaType>;
     required?: string[];
 }
+declare const isJsonSchemaObject: (input: any) => input is JsonSchemaObject;
 interface JsonSchemaArray {
     $id?: string;
     title?: string;
@@ -45,6 +66,23 @@ interface JsonSchemaArray {
     type: "array";
     items: JsonSchemaType;
 }
+declare function isJsonSchemaArray(input: any): input is JsonSchemaArray;
+interface JsonSchemaUint8Array {
+    type: "Uint8Array";
+}
+interface JsonSchemaEnum {
+    anyOf: Array<{
+        type: "string";
+        const: string;
+    }> | Array<{
+        type: "number";
+        const: number;
+    }> | Array<{
+        type: "integer";
+        const: number;
+    }>;
+}
+declare function isJsonSchemaEnum(input: any): input is JsonSchemaEnum;
 
 interface ArriRoute<TPath extends string, TMethod extends HttpMethod, TQuery extends TObject | undefined = undefined, TBody extends TSchema | undefined = undefined, TResponse extends TSchema | undefined = undefined, TFallbackResponse = any> {
     path: TPath;
@@ -101,21 +139,24 @@ type ArriProcedureHandler<TParams, TResponse> = (context: RpcHandlerContext<TPar
 type ArriProcedurePostHandler<TParams, TResponse> = (event: RpcPostHandlerContext<TParams, TResponse>) => any;
 declare function isRpc(input: any): input is ArriProcedure<any, any>;
 declare function defineRpc<TParams extends TObject | undefined = undefined, TResponse extends TObject | undefined | never = undefined>(config: ArriProcedure<TParams, TResponse>): ArriProcedure<TParams, TResponse>;
-declare function createRpcDefinition(rpcName: string, httpPath: string, procedure: ArriProcedure<any, any>): ProcedureDefinition;
+declare function createRpcDefinition(rpcName: string, httpPath: string, procedure: ArriProcedure<any, any>): ProcedureDef;
 declare function getRpcPath(rpcName: string, prefix?: string): string;
 declare function getRpcParamName(rpcName: string, procedure: ArriProcedure<any, any>): string | null;
-declare function getRpcParamDefinition(rpcName: string, procedure: ArriProcedure<any, any>): ProcedureDefinition["params"];
+declare function getRpcParamDefinition(rpcName: string, procedure: ArriProcedure<any, any>): ProcedureDef["params"];
 declare function getRpcResponseName(rpcName: string, procedure: ArriProcedure<any, any>): string | null;
 declare function registerRpc(router: Router, path: string, procedure: ArriProcedure<any, any>, middleware: Middleware[]): void;
 
 interface ArriOptions extends AppOptions {
+    /**
+     * Metadata to display in the __definition.json file
+     */
+    appInfo?: ApplicationDef["info"];
     rpcRoutePrefix?: string;
     /**
      * Defaults to /__definitions
      * This parameters also takes the rpcRoutePrefix option into account
      */
     rpcDefinitionPath?: string;
-    appDescription?: string;
 }
 declare const DEV_ENDPOINT_ROOT = "/__arri_dev__";
 declare const DEV_DEFINITION_ENDPOINT = "/__arri_dev__/definition";
@@ -125,19 +166,26 @@ declare class Arri {
     private readonly h3Router;
     private readonly rpcDefinitionPath;
     private readonly rpcRoutePrefix;
+    appInfo: ApplicationDef["info"];
     private procedures;
     private models;
     private readonly middlewares;
-    private readonly appDescription;
     constructor(opts?: ArriOptions);
     registerMiddleware(middleware: Middleware): void;
     registerRpc<TParams extends TObject | undefined, TResponse extends TObject | undefined>(name: string, procedure: ArriProcedure<TParams, TResponse>): void;
     registerRoute<TPath extends string, TMethod extends HttpMethod = HttpMethod, TQuery extends TObject | undefined = undefined, TBody extends TSchema | undefined = undefined, TResponse extends TSchema | undefined = undefined, TFallbackResponse = any>(route: ArriRoute<TPath, TMethod, TQuery, TBody, TResponse, TFallbackResponse>): void;
-    getAppDefinition(): ApplicationDefinition;
+    getAppDefinition(): ApplicationDef;
     getH3Instance(): App;
 }
 declare const HttpMethodValues: readonly ["get", "post", "put", "patch", "delete", "head"];
 type HttpMethod = (typeof HttpMethodValues)[number];
 declare const isHttpMethod: (input: any) => input is "get" | "post" | "put" | "patch" | "delete" | "head";
 
-export { Arri as A, type ApplicationDefinition as B, DEV_ENDPOINT_ROOT as D, type ExtractParam as E, HttpMethodValues as H, type JsonSchemaObject as J, type Middleware as M, type ProcedureDefinition as P, type RpcHandlerContext as R, type ServiceDefinition as S, DEV_DEFINITION_ENDPOINT as a, type HttpMethod as b, type ArriProcedureBase as c, type ArriProcedure as d, type HandlerContext as e, type RpcPostHandlerContext as f, type ArriProcedureHandler as g, type ArriProcedurePostHandler as h, isHttpMethod as i, isRpc as j, defineRpc as k, createRpcDefinition as l, getRpcPath as m, getRpcParamName as n, getRpcParamDefinition as o, getRpcResponseName as p, type ArriRoute as q, registerRpc as r, defineRoute as s, defineMiddleware as t, type ExtractParams as u, type ArriRouteHandler as v, type RouteHandlerContext as w, type RoutePostHandlerContext as x, type ArriRoutePostHandler as y, registerRoute as z };
+interface ClientGenerator<TOptions extends Record<string, any> | undefined> {
+    generator: (def: ApplicationDef) => any;
+    options: TOptions;
+}
+type ClientGeneratorPlugin<TOptions extends Record<string, any> | undefined> = (options: TOptions) => ClientGenerator<TOptions>;
+declare function defineClientGeneratorPlugin<TOptions extends Record<string, any> | undefined>(plugin: ClientGeneratorPlugin<TOptions>): ClientGeneratorPlugin<TOptions>;
+
+export { isJsonSchemaScalarType as $, Arri as A, type ClientGeneratorPlugin as B, type ClientGenerator as C, DEV_ENDPOINT_ROOT as D, type ExtractParam as E, type ApplicationDef as F, defineClientGeneratorPlugin as G, HttpMethodValues as H, normalizeWhitespace as I, type JsonSchemaObject as J, isProcedureDef as K, isServiceDef as L, type Middleware as M, isApplicationDef as N, unflattenObject as O, type ProcedureDef as P, unflattenProcedures as Q, type RpcHandlerContext as R, type ServiceDef as S, setNestedObjectProperty as T, removeDisallowedChars as U, JsonSchemaScalarTypeValues as V, JsonSchemaNullTypeValues as W, JsonSchemaComplexTypeValues as X, type JsonSchemaType as Y, type JsonSchemaTypeValue as Z, type JsonSchemaScalarType as _, DEV_DEFINITION_ENDPOINT as a, type JsonSchemaNullType as a0, isJsonSchemaNullType as a1, type JsonSchemaComplexType as a2, isJsonSchemaObject as a3, type JsonSchemaArray as a4, isJsonSchemaArray as a5, type JsonSchemaUint8Array as a6, type JsonSchemaEnum as a7, isJsonSchemaEnum as a8, type HttpMethod as b, type ArriProcedureBase as c, type ArriProcedure as d, type HandlerContext as e, type RpcPostHandlerContext as f, type ArriProcedureHandler as g, type ArriProcedurePostHandler as h, isHttpMethod as i, isRpc as j, defineRpc as k, createRpcDefinition as l, getRpcPath as m, getRpcParamName as n, getRpcParamDefinition as o, getRpcResponseName as p, type ArriRoute as q, registerRpc as r, defineRoute as s, defineMiddleware as t, type ExtractParams as u, type ArriRouteHandler as v, type RouteHandlerContext as w, type RoutePostHandlerContext as x, type ArriRoutePostHandler as y, registerRoute as z };

package/dist/shared/{arri.bb7e9a4e.d.mts → arri.b176bba1.d.ts}

@@ -1,34 +1,54 @@
 import { TObject, TSchema, Static } from '@sinclair/typebox';
 import { Router, H3Event, App, AppOptions } from 'h3';
 
-interface ApplicationDefinition {
-    schemaVersion: "0.0.1";
-    description: string;
-    procedures: Record<string, ProcedureDefinition>;
+interface ApplicationDef {
+    arriSchemaVersion: "0.0.1";
+    info?: {
+        title?: string;
+        description?: string;
+        version?: string;
+    };
+    externalDocs?: {
+        description?: string;
+        url: string;
+    };
+    procedures: Record<string, ProcedureDef>;
     models: Record<string, JsonSchemaObject>;
     errors: Omit<TObject, symbol>;
 }
-interface ProcedureDefinition {
+declare function normalizeWhitespace(input: string): string;
+interface ProcedureDef {
     path: string;
     description?: string;
     method: HttpMethod;
     params: string | undefined;
     response: string | undefined;
 }
-interface ServiceDefinition {
-    [key: string]: ProcedureDefinition | ServiceDefinition;
+declare function isProcedureDef(input: any): input is ProcedureDef;
+interface ServiceDef {
+    [key: string]: ProcedureDef | ServiceDef;
 }
+declare function isServiceDef(input: any): input is ServiceDef;
+declare function isApplicationDef(input: any): input is ApplicationDef;
+declare function unflattenObject(data: Record<string, any>): any;
+declare function unflattenProcedures(procedures: ApplicationDef["procedures"]): Record<string, ProcedureDef | ServiceDef>;
+declare function setNestedObjectProperty<T>(targetProp: string, value: T, object: Record<any, any>): Record<any, any>;
+declare const removeDisallowedChars: (input: string, disallowedChars: string) => string;
 declare const JsonSchemaScalarTypeValues: readonly ["integer", "number", "bigint", "string", "boolean", "Date"];
 declare const JsonSchemaNullTypeValues: readonly ["null", "undefined"];
+declare const JsonSchemaComplexTypeValues: readonly ["object", "list", "array", "Uint8Array"];
 type JsonSchemaType = JsonSchemaScalarType | JsonSchemaNullType | JsonSchemaComplexType;
+type JsonSchemaTypeValue = (typeof JsonSchemaScalarTypeValues)[number] | (typeof JsonSchemaNullTypeValues)[number] | (typeof JsonSchemaComplexTypeValues)[number];
 interface JsonSchemaScalarType {
     title?: string;
     description?: string;
     type: (typeof JsonSchemaScalarTypeValues)[number];
 }
+declare function isJsonSchemaScalarType(input: any): input is JsonSchemaScalarType;
 interface JsonSchemaNullType {
     type: (typeof JsonSchemaNullTypeValues)[number];
 }
+declare function isJsonSchemaNullType(input: any): input is JsonSchemaNullType;
 type JsonSchemaComplexType = JsonSchemaObject | JsonSchemaArray;
 interface JsonSchemaObject {
     $id?: string;
@@ -38,6 +58,7 @@ interface JsonSchemaObject {
     properties: Record<string, JsonSchemaType>;
     required?: string[];
 }
+declare const isJsonSchemaObject: (input: any) => input is JsonSchemaObject;
 interface JsonSchemaArray {
     $id?: string;
     title?: string;
@@ -45,6 +66,23 @@ interface JsonSchemaArray {
     type: "array";
     items: JsonSchemaType;
 }
+declare function isJsonSchemaArray(input: any): input is JsonSchemaArray;
+interface JsonSchemaUint8Array {
+    type: "Uint8Array";
+}
+interface JsonSchemaEnum {
+    anyOf: Array<{
+        type: "string";
+        const: string;
+    }> | Array<{
+        type: "number";
+        const: number;
+    }> | Array<{
+        type: "integer";
+        const: number;
+    }>;
+}
+declare function isJsonSchemaEnum(input: any): input is JsonSchemaEnum;
 
 interface ArriRoute<TPath extends string, TMethod extends HttpMethod, TQuery extends TObject | undefined = undefined, TBody extends TSchema | undefined = undefined, TResponse extends TSchema | undefined = undefined, TFallbackResponse = any> {
     path: TPath;
@@ -101,21 +139,24 @@ type ArriProcedureHandler<TParams, TResponse> = (context: RpcHandlerContext<TPar
 type ArriProcedurePostHandler<TParams, TResponse> = (event: RpcPostHandlerContext<TParams, TResponse>) => any;
 declare function isRpc(input: any): input is ArriProcedure<any, any>;
 declare function defineRpc<TParams extends TObject | undefined = undefined, TResponse extends TObject | undefined | never = undefined>(config: ArriProcedure<TParams, TResponse>): ArriProcedure<TParams, TResponse>;
-declare function createRpcDefinition(rpcName: string, httpPath: string, procedure: ArriProcedure<any, any>): ProcedureDefinition;
+declare function createRpcDefinition(rpcName: string, httpPath: string, procedure: ArriProcedure<any, any>): ProcedureDef;
 declare function getRpcPath(rpcName: string, prefix?: string): string;
 declare function getRpcParamName(rpcName: string, procedure: ArriProcedure<any, any>): string | null;
-declare function getRpcParamDefinition(rpcName: string, procedure: ArriProcedure<any, any>): ProcedureDefinition["params"];
+declare function getRpcParamDefinition(rpcName: string, procedure: ArriProcedure<any, any>): ProcedureDef["params"];
 declare function getRpcResponseName(rpcName: string, procedure: ArriProcedure<any, any>): string | null;
 declare function registerRpc(router: Router, path: string, procedure: ArriProcedure<any, any>, middleware: Middleware[]): void;
 
 interface ArriOptions extends AppOptions {
+    /**
+     * Metadata to display in the __definition.json file
+     */
+    appInfo?: ApplicationDef["info"];
     rpcRoutePrefix?: string;
     /**
      * Defaults to /__definitions
      * This parameters also takes the rpcRoutePrefix option into account
      */
     rpcDefinitionPath?: string;
-    appDescription?: string;
 }
 declare const DEV_ENDPOINT_ROOT = "/__arri_dev__";
 declare const DEV_DEFINITION_ENDPOINT = "/__arri_dev__/definition";
@@ -125,19 +166,26 @@ declare class Arri {
     private readonly h3Router;
     private readonly rpcDefinitionPath;
     private readonly rpcRoutePrefix;
+    appInfo: ApplicationDef["info"];
     private procedures;
     private models;
     private readonly middlewares;
-    private readonly appDescription;
     constructor(opts?: ArriOptions);
     registerMiddleware(middleware: Middleware): void;
     registerRpc<TParams extends TObject | undefined, TResponse extends TObject | undefined>(name: string, procedure: ArriProcedure<TParams, TResponse>): void;
     registerRoute<TPath extends string, TMethod extends HttpMethod = HttpMethod, TQuery extends TObject | undefined = undefined, TBody extends TSchema | undefined = undefined, TResponse extends TSchema | undefined = undefined, TFallbackResponse = any>(route: ArriRoute<TPath, TMethod, TQuery, TBody, TResponse, TFallbackResponse>): void;
-    getAppDefinition(): ApplicationDefinition;
+    getAppDefinition(): ApplicationDef;
     getH3Instance(): App;
 }
 declare const HttpMethodValues: readonly ["get", "post", "put", "patch", "delete", "head"];
 type HttpMethod = (typeof HttpMethodValues)[number];
 declare const isHttpMethod: (input: any) => input is "get" | "post" | "put" | "patch" | "delete" | "head";
 
-export { Arri as A, type ApplicationDefinition as B, DEV_ENDPOINT_ROOT as D, type ExtractParam as E, HttpMethodValues as H, type JsonSchemaObject as J, type Middleware as M, type ProcedureDefinition as P, type RpcHandlerContext as R, type ServiceDefinition as S, DEV_DEFINITION_ENDPOINT as a, type HttpMethod as b, type ArriProcedureBase as c, type ArriProcedure as d, type HandlerContext as e, type RpcPostHandlerContext as f, type ArriProcedureHandler as g, type ArriProcedurePostHandler as h, isHttpMethod as i, isRpc as j, defineRpc as k, createRpcDefinition as l, getRpcPath as m, getRpcParamName as n, getRpcParamDefinition as o, getRpcResponseName as p, type ArriRoute as q, registerRpc as r, defineRoute as s, defineMiddleware as t, type ExtractParams as u, type ArriRouteHandler as v, type RouteHandlerContext as w, type RoutePostHandlerContext as x, type ArriRoutePostHandler as y, registerRoute as z };
+interface ClientGenerator<TOptions extends Record<string, any> | undefined> {
+    generator: (def: ApplicationDef) => any;
+    options: TOptions;
+}
+type ClientGeneratorPlugin<TOptions extends Record<string, any> | undefined> = (options: TOptions) => ClientGenerator<TOptions>;
+declare function defineClientGeneratorPlugin<TOptions extends Record<string, any> | undefined>(plugin: ClientGeneratorPlugin<TOptions>): ClientGeneratorPlugin<TOptions>;
+
+export { isJsonSchemaScalarType as $, Arri as A, type ClientGeneratorPlugin as B, type ClientGenerator as C, DEV_ENDPOINT_ROOT as D, type ExtractParam as E, type ApplicationDef as F, defineClientGeneratorPlugin as G, HttpMethodValues as H, normalizeWhitespace as I, type JsonSchemaObject as J, isProcedureDef as K, isServiceDef as L, type Middleware as M, isApplicationDef as N, unflattenObject as O, type ProcedureDef as P, unflattenProcedures as Q, type RpcHandlerContext as R, type ServiceDef as S, setNestedObjectProperty as T, removeDisallowedChars as U, JsonSchemaScalarTypeValues as V, JsonSchemaNullTypeValues as W, JsonSchemaComplexTypeValues as X, type JsonSchemaType as Y, type JsonSchemaTypeValue as Z, type JsonSchemaScalarType as _, DEV_DEFINITION_ENDPOINT as a, type JsonSchemaNullType as a0, isJsonSchemaNullType as a1, type JsonSchemaComplexType as a2, isJsonSchemaObject as a3, type JsonSchemaArray as a4, isJsonSchemaArray as a5, type JsonSchemaUint8Array as a6, type JsonSchemaEnum as a7, isJsonSchemaEnum as a8, type HttpMethod as b, type ArriProcedureBase as c, type ArriProcedure as d, type HandlerContext as e, type RpcPostHandlerContext as f, type ArriProcedureHandler as g, type ArriProcedurePostHandler as h, isHttpMethod as i, isRpc as j, defineRpc as k, createRpcDefinition as l, getRpcPath as m, getRpcParamName as n, getRpcParamDefinition as o, getRpcResponseName as p, type ArriRoute as q, registerRpc as r, defineRoute as s, defineMiddleware as t, type ExtractParams as u, type ArriRouteHandler as v, type RouteHandlerContext as w, type RoutePostHandlerContext as x, type ArriRoutePostHandler as y, registerRoute as z };

package/package.json

@@ -25,7 +25,7 @@
     "listhen": "^1.4.3",
     "pathe": "^1.1.1"
   },
-  "version": "0.0.15",
+  "version": "0.0.17",
   "repository": {
     "url": "https://github.com/modiimedia/arri"
   }