@rpcbase/api 0.148.0 → 0.150.0

package/dist/initApi.d.ts

@@ -1,10 +1,13 @@
 import { Application } from 'express';
 import { CorsOptions } from 'cors';
+import { ApiErrorMiddlewareOptions } from './errors';
 type RouteLoader = () => Promise<unknown>;
-export declare const initApi: ({ app, routes, cors: corsOptions, }: {
+export type InitApiOptions = {
     app: Application;
     routes: Record<string, RouteLoader>;
     cors?: CorsOptions;
-}) => Promise<void>;
+    errors?: ApiErrorMiddlewareOptions;
+};
+export declare const initApi: ({ app, routes, cors: corsOptions, errors, }: InitApiOptions) => Promise<void>;
 export {};
 //# sourceMappingURL=initApi.d.ts.map

package/dist/initApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"initApi.d.ts","sourceRoot":"","sources":["../src/initApi.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,WAAW,EAAwD,MAAM,SAAS,CAAA;AAChG,OAAa,EAAE,KAAK,WAAW,EAAE,MAAM,MAAM,CAAA;AAqB7C,KAAK,WAAW,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,CAAA;AAMzC,eAAO,MAAM,OAAO,GAAU,qCAI3B;IACD,GAAG,EAAE,WAAW,CAAA;IAChB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;IACnC,IAAI,CAAC,EAAE,WAAW,CAAA;CACnB,kBA6HA,CAAA"}
+{"version":3,"file":"initApi.d.ts","sourceRoot":"","sources":["../src/initApi.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,WAAW,EAAwD,MAAM,SAAS,CAAA;AAChG,OAAa,EAAE,KAAK,WAAW,EAAE,MAAM,MAAM,CAAA;AAE7C,OAAO,EAQL,KAAK,yBAAyB,EAC/B,MAAM,UAAU,CAAA;AA8BjB,KAAK,WAAW,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,CAAA;AAoBzC,MAAM,MAAM,cAAc,GAAG;IAC3B,GAAG,EAAE,WAAW,CAAA;IAChB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;IACnC,IAAI,CAAC,EAAE,WAAW,CAAA;IAClB,MAAM,CAAC,EAAE,yBAAyB,CAAA;CACnC,CAAA;AAGD,eAAO,MAAM,OAAO,GAAU,6CAK3B,cAAc,kBAkKhB,CAAA"}

package/dist/requestValidation.d.ts

@@ -0,0 +1,4 @@
+import { ApiRequestSchema, ApiRouteDefinition } from './types';
+export declare const getApiRoutePath: (route: string | ApiRouteDefinition) => string;
+export declare const parseApiRequest: <Output>(schema: ApiRequestSchema<Output>, input: unknown) => Output;
+//# sourceMappingURL=requestValidation.d.ts.map

package/dist/requestValidation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"requestValidation.d.ts","sourceRoot":"","sources":["../src/requestValidation.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAoBnE,eAAO,MAAM,eAAe,GAAI,OAAO,MAAM,GAAG,kBAAkB,KAAG,MAGpE,CAAA;AAED,eAAO,MAAM,eAAe,GAAI,MAAM,EAAE,QAAQ,gBAAgB,CAAC,MAAM,CAAC,EAAE,OAAO,OAAO,KAAG,MAS1F,CAAA"}

package/dist/types.d.ts

@@ -17,12 +17,39 @@ export type Ctx<TUser = RBSessionUser> = {
 export type Payload = unknown;
 export type Result = unknown;
 export type ApiHandler<P = Payload, R = Result, U = RBSessionUser> = (payload: P, ctx: Ctx<U>) => Promise<R>;
+export type ApiRequestValidationIssue = {
+    readonly message: string;
+    readonly path: readonly PropertyKey[];
+};
+export type ApiRequestSchema<Output = unknown> = {
+    safeParse: (input: unknown) => {
+        success: true;
+        data: Output;
+    } | {
+        success: false;
+        error: {
+            issues: readonly ApiRequestValidationIssue[];
+        };
+    };
+};
+export type ApiRouteDefinition<Schema extends ApiRequestSchema = ApiRequestSchema> = {
+    readonly requestSchema: Schema;
+} & ({
+    readonly ROUTE: string;
+} | {
+    readonly Route: string;
+});
+export type ApiRequestSchemaOutput<Schema extends ApiRequestSchema> = Schema extends ApiRequestSchema<infer Output> ? Output : never;
 export type Middleware<U = RBSessionUser> = (req: RpcRequest<U>, res: Response, next: NextFunction) => void;
+export type ApiMethod<U = RBSessionUser> = {
+    <Schema extends ApiRequestSchema, R = Result>(route: ApiRouteDefinition<Schema>, handler: ApiHandler<ApiRequestSchemaOutput<Schema>, R, U>): void;
+    <P = Payload, R = Result>(path: string, handler: ApiHandler<P, R, U>): void;
+};
 export type Api<U = RBSessionUser> = {
     use: (path: string, middleware: Middleware<U>) => void;
-    get: <P = Payload, R = Result>(path: string, handler: ApiHandler<P, R, U>) => void;
-    post: <P = Payload, R = Result>(path: string, handler: ApiHandler<P, R, U>) => void;
-    put: <P = Payload, R = Result>(path: string, handler: ApiHandler<P, R, U>) => void;
-    delete: <P = Payload, R = Result>(path: string, handler: ApiHandler<P, R, U>) => void;
+    get: ApiMethod<U>;
+    post: ApiMethod<U>;
+    put: ApiMethod<U>;
+    delete: ApiMethod<U>;
 };
 //# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAC9D,OAAO,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAA;AAG3D,eAAO,MAAM,SAAS,cAAc,CAAA;AAEpC,MAAM,WAAW,aAAa;CAAG;AAEjC,MAAM,MAAM,UAAU,CAAC,KAAK,GAAG,aAAa,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,WAAW,GAAG;IAC/E,IAAI,CAAC,EAAE,KAAK,CAAC;CACd,CAAC,CAAC,GAAG,IAAI,CAAA;AAEV,MAAM,MAAM,UAAU,CAAC,KAAK,GAAG,aAAa,IAAI,OAAO,GAAG;IACxD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;CAC5B,CAAA;AAED,MAAM,MAAM,GAAG,CAAC,KAAK,GAAG,aAAa,IAAI;IACvC,GAAG,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;IACvB,GAAG,EAAE,QAAQ,CAAC;CACf,CAAC;AAGF,MAAM,MAAM,OAAO,GAAG,OAAO,CAAA;AAC7B,MAAM,MAAM,MAAM,GAAG,OAAO,CAAA;AAE5B,MAAM,MAAM,UAAU,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,MAAM,EAAE,CAAC,GAAG,aAAa,IAAI,CAAC,OAAO,EAAE,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAAA;AAE5G,MAAM,MAAM,UAAU,CAAC,CAAC,GAAG,aAAa,IAAI,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,KAAK,IAAI,CAAC;AAG5G,MAAM,MAAM,GAAG,CAAC,CAAC,GAAG,aAAa,IAAI;IACnC,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;IACvD,GAAG,EAAE,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC;IACnF,IAAI,EAAE,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC;IACpF,GAAG,EAAE,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC;IACnF,MAAM,EAAE,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC;CACvF,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAC9D,OAAO,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAA;AAG3D,eAAO,MAAM,SAAS,cAAc,CAAA;AAEpC,MAAM,WAAW,aAAa;CAAG;AAEjC,MAAM,MAAM,UAAU,CAAC,KAAK,GAAG,aAAa,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,WAAW,GAAG;IAC/E,IAAI,CAAC,EAAE,KAAK,CAAC;CACd,CAAC,CAAC,GAAG,IAAI,CAAA;AAEV,MAAM,MAAM,UAAU,CAAC,KAAK,GAAG,aAAa,IAAI,OAAO,GAAG;IACxD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;CAC5B,CAAA;AAED,MAAM,MAAM,GAAG,CAAC,KAAK,GAAG,aAAa,IAAI;IACvC,GAAG,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;IACvB,GAAG,EAAE,QAAQ,CAAC;CACf,CAAC;AAGF,MAAM,MAAM,OAAO,GAAG,OAAO,CAAA;AAC7B,MAAM,MAAM,MAAM,GAAG,OAAO,CAAA;AAE5B,MAAM,MAAM,UAAU,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,MAAM,EAAE,CAAC,GAAG,aAAa,IAAI,CAAC,OAAO,EAAE,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAAA;AAE5G,MAAM,MAAM,yBAAyB,GAAG;IACtC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,IAAI,EAAE,SAAS,WAAW,EAAE,CAAA;CACtC,CAAA;AAED,MAAM,MAAM,gBAAgB,CAAC,MAAM,GAAG,OAAO,IAAI;IAC/C,SAAS,EAAE,CAAC,KAAK,EAAE,OAAO,KACtB;QAAE,OAAO,EAAE,IAAI,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAC/B;QAAE,OAAO,EAAE,KAAK,CAAC;QAAC,KAAK,EAAE;YAAE,MAAM,EAAE,SAAS,yBAAyB,EAAE,CAAA;SAAE,CAAA;KAAE,CAAA;CAChF,CAAA;AAED,MAAM,MAAM,kBAAkB,CAAC,MAAM,SAAS,gBAAgB,GAAG,gBAAgB,IAAI;IACnF,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAA;CAC/B,GAAG,CACA;IAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAC1B;IAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAC7B,CAAA;AAED,MAAM,MAAM,sBAAsB,CAAC,MAAM,SAAS,gBAAgB,IAChE,MAAM,SAAS,gBAAgB,CAAC,MAAM,MAAM,CAAC,GAAG,MAAM,GAAG,KAAK,CAAA;AAEhE,MAAM,MAAM,UAAU,CAAC,CAAC,GAAG,aAAa,IAAI,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,KAAK,IAAI,CAAC;AAG5G,MAAM,MAAM,SAAS,CAAC,CAAC,GAAG,aAAa,IAAI;IACzC,CAAC,MAAM,SAAS,gBAAgB,EAAE,CAAC,GAAG,MAAM,EAC1C,KAAK,EAAE,kBAAkB,CAAC,MAAM,CAAC,EACjC,OAAO,EAAE,UAAU,CAAC,sBAAsB,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GACxD,IAAI,CAAA;IACP,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI,CAAA;CAC5E,CAAA;AAGD,MAAM,MAAM,GAAG,CAAC,CAAC,GAAG,aAAa,IAAI;IACnC,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;IACvD,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;IAClB,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;IACnB,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;IAClB,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;CACtB,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rpcbase/api",
-  "version": "0.148.0",
+  "version": "0.150.0",
   "type": "module",
   "files": [
     "dist"