equipped 5.0.0-alpha.7 → 5.0.0-alpha.8

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [5.0.0-alpha.8](https://github.com/kevinand11/equipped/compare/v5.0.0-alpha.7...v5.0.0-alpha.8) (2024-06-27)
+
+
+### Bug Fixes
+
+* apiDef key for api definition ([29608b9](https://github.com/kevinand11/equipped/commit/29608b98ff9c1e6eab1061fdc03deb95fed4b023))
+
 ## [5.0.0-alpha.7](https://github.com/kevinand11/equipped/compare/v5.0.0-alpha.6...v5.0.0-alpha.7) (2024-06-27)
 
 

package/lib/scripts/json-schema.d.ts

@@ -1,6 +1,7 @@
 import { Options } from 'ts-oas';
+import type { CompilerOptions } from 'typescript';
 import { RouteSchema } from '../server';
 export declare function generateJSONSchema(patterns: (string | RegExp)[], paths: string[], options?: {
-    tsConfigPath?: string | Record<string, unknown>;
+    tsConfig?: string | CompilerOptions;
     options?: Options;
 }): Record<string, RouteSchema>;

package/lib/scripts/json-schema.js

@@ -30,7 +30,7 @@ const server_1 = require("../server");
 const fileSchema = { type: 'string', format: 'binary' };
 const statusCodes = Object.entries(server_1.StatusCodes);
 function generateJSONSchema(patterns, paths, options) {
-    const tsProgram = (0, ts_oas_1.createProgram)(paths, options?.tsConfigPath);
+    const tsProgram = (0, ts_oas_1.createProgram)(paths, options?.tsConfig);
     const logger = instance_1.Instance.createLogger();
     const tsoas = new ts_oas_1.default(tsProgram, {
         ref: false,
@@ -42,7 +42,8 @@ function generateJSONSchema(patterns, paths, options) {
         .map(([name, { properties: def }]) => {
         try {
             const key = def?.key?.enum?.at(0) ?? name;
-            if (!def || !key || !def.method)
+            const isApiDef = def?.__apiDef?.type === 'boolean' && def?.__apiDef?.enum?.[0] === true;
+            if (!def || !isApiDef || !key || !def.method)
                 return [undefined, undefined];
             const response = def.responses.properties ?? def.responses.anyOf?.reduce((acc, cur) => {
                 if (cur.properties)
@@ -79,7 +80,7 @@ function generateJSONSchema(patterns, paths, options) {
                 body,
                 params: def.params,
                 querystring: def.query,
-                headers: def.headers,
+                headers: def.requestHeaders,
                 response,
                 operationId: key,
                 summary: name,

package/lib/server/impls/fastify.d.ts

@@ -9,7 +9,7 @@ export declare class FastifyServer extends Server<FastifyRequest, FastifyReply>
     protected onLoad(): Promise<void>;
     protected registerRoute(route: FullRoute): void;
     protected startServer(port: number): Promise<boolean>;
-    protected parse(req: FastifyRequest, res: FastifyReply): Promise<Request<import("../types").Api<any, string, import("../types").MethodTypes, any, Record<string, boolean>, Record<string, string>, Record<string, any>, Record<string, string | string[]>, import("../types").SupportedStatusCodes>>>;
+    protected parse(req: FastifyRequest, res: FastifyReply): Promise<Request<import("../types").Api<any, string, import("../types").MethodTypes, any, Record<string, boolean>, Record<string, string>, Record<string, any>, Record<string, string | string[]>, Record<string, string | string[]>, import("../types").SupportedStatusCodes>>>;
     makeController(cb: Defined<Route['handler']>): RouteHandlerMethod;
     makeMiddleware(cb: Defined<Route['middlewares']>[number]['cb']): preHandlerHookHandler<import("fastify").RawServerDefault, import("http").IncomingMessage, import("http").ServerResponse<import("http").IncomingMessage>, import("fastify").RouteGenericInterface, unknown, import("fastify").FastifySchema, import("fastify").FastifyTypeProviderDefault, import("fastify").FastifyBaseLogger>;
     makeErrorMiddleware(cb: Defined<Route['onError']>['cb']): (error: import("fastify").FastifyError, request: FastifyRequest, reply: FastifyReply) => void;

package/lib/server/middlewares/errorHandler.d.ts

@@ -1,4 +1,4 @@
 export declare const errorHandler: {
-    cb: import("../types").ErrorHandler<import("../types").Api<any, string, import("../types").MethodTypes, any, Record<string, boolean>, Record<string, string>, Record<string, any>, Record<string, string | string[]>, import("../types").SupportedStatusCodes>>;
+    cb: import("../types").ErrorHandler<import("../types").Api<any, string, import("../types").MethodTypes, any, Record<string, boolean>, Record<string, string>, Record<string, any>, Record<string, string | string[]>, Record<string, string | string[]>, import("../types").SupportedStatusCodes>>;
     onSetup?: import("../types").HandlerSetup;
 };

package/lib/server/middlewares/notFoundHandler.d.ts

@@ -1,4 +1,4 @@
 export declare const notFoundHandler: {
-    cb: import("../types").RouteMiddlewareHandler<import("../types").Api<any, string, import("../types").MethodTypes, any, Record<string, boolean>, Record<string, string>, Record<string, any>, Record<string, string | string[]>, import("../types").SupportedStatusCodes>>;
+    cb: import("../types").RouteMiddlewareHandler<import("../types").Api<any, string, import("../types").MethodTypes, any, Record<string, boolean>, Record<string, string>, Record<string, any>, Record<string, string | string[]>, Record<string, string | string[]>, import("../types").SupportedStatusCodes>>;
     onSetup?: import("../types").HandlerSetup;
 };

package/lib/server/middlewares/parseAuthUser.d.ts

@@ -1,4 +1,4 @@
 export declare const parseAuthUser: {
-    cb: import("../types").RouteMiddlewareHandler<import("../types").Api<any, string, import("../types").MethodTypes, any, Record<string, boolean>, Record<string, string>, Record<string, any>, Record<string, string | string[]>, import("../types").SupportedStatusCodes>>;
+    cb: import("../types").RouteMiddlewareHandler<import("../types").Api<any, string, import("../types").MethodTypes, any, Record<string, boolean>, Record<string, string>, Record<string, any>, Record<string, string | string[]>, Record<string, string | string[]>, import("../types").SupportedStatusCodes>>;
     onSetup?: import("../types").HandlerSetup;
 };

package/lib/server/middlewares/requireAuthUser.d.ts

@@ -1,4 +1,4 @@
 export declare const requireAuthUser: {
-    cb: import("../types").RouteMiddlewareHandler<import("../types").Api<any, string, import("../types").MethodTypes, any, Record<string, boolean>, Record<string, string>, Record<string, any>, Record<string, string | string[]>, import("../types").SupportedStatusCodes>>;
+    cb: import("../types").RouteMiddlewareHandler<import("../types").Api<any, string, import("../types").MethodTypes, any, Record<string, boolean>, Record<string, string>, Record<string, any>, Record<string, string | string[]>, Record<string, string | string[]>, import("../types").SupportedStatusCodes>>;
     onSetup?: import("../types").HandlerSetup;
 };

package/lib/server/middlewares/requireRefreshUser.d.ts

@@ -1,4 +1,4 @@
 export declare const requireRefreshUser: {
-    cb: import("../types").RouteMiddlewareHandler<import("../types").Api<any, string, import("../types").MethodTypes, any, Record<string, boolean>, Record<string, string>, Record<string, any>, Record<string, string | string[]>, import("../types").SupportedStatusCodes>>;
+    cb: import("../types").RouteMiddlewareHandler<import("../types").Api<any, string, import("../types").MethodTypes, any, Record<string, boolean>, Record<string, string>, Record<string, any>, Record<string, string | string[]>, Record<string, string | string[]>, import("../types").SupportedStatusCodes>>;
     onSetup?: import("../types").HandlerSetup;
 };

package/lib/server/routes.d.ts

@@ -7,5 +7,5 @@ export declare class Router extends ClassPropertiesWrapper<AddMethodImpls> {
     constructor(config?: GeneralConfig);
     add(...routes: Route[]): void;
     nest(...routers: Router[]): void;
-    get routes(): Route<import("./types").ApiDef<import("./types").Api<any, string, import("./types").MethodTypes, any, Record<string, boolean>, Record<string, string>, Record<string, any>, Record<string, string | string[]>, import("./types").SupportedStatusCodes>>>[];
+    get routes(): Route<import("./types").ApiDef<import("./types").Api<any, string, import("./types").MethodTypes, any, Record<string, boolean>, Record<string, string>, Record<string, any>, Record<string, string | string[]>, Record<string, string | string[]>, import("./types").SupportedStatusCodes>>>[];
 }

package/lib/server/types.d.ts

@@ -25,7 +25,7 @@ export type SupportedStatusCodes = Enum<typeof StatusCodes>;
 type GoodStatusCodes = 200;
 type ApiErrors = Record<Exclude<SupportedStatusCodes, GoodStatusCodes>, JSONValue<CustomError['serializedErrors']>>;
 type ApiResponse<T, StatusCode extends SupportedStatusCodes> = Record<StatusCode, JSONValue<T>> | Omit<ApiErrors, StatusCode>;
-export interface Api<Res = any, Key extends string = string, Method extends MethodTypes = MethodTypes, Body = any, Files extends Record<string, boolean> = Record<string, boolean>, Params extends Record<string, string> = Record<string, string>, Query extends Record<string, any> = Record<string, any>, Headers extends Record<string, string | string[]> = Record<string, string | string[]>, DefaultStatus extends SupportedStatusCodes = SupportedStatusCodes> {
+export interface Api<Res = any, Key extends string = string, Method extends MethodTypes = MethodTypes, Body = any, Files extends Record<string, boolean> = Record<string, boolean>, Params extends Record<string, string> = Record<string, string>, Query extends Record<string, any> = Record<string, any>, RequestHeaders extends Record<string, string | string[]> = Record<string, string | string[]>, ResponeHeaders extends Record<string, string | string[]> = Record<string, string | string[]>, DefaultStatus extends SupportedStatusCodes = SupportedStatusCodes> {
     key: Key;
     method: Method;
     response: Res;
@@ -33,7 +33,8 @@ export interface Api<Res = any, Key extends string = string, Method extends Meth
     files?: Files;
     params?: Params;
     query?: Query;
-    headers?: Headers;
+    requestHeaders?: RequestHeaders;
+    responseHeaders?: ResponeHeaders;
     defaultStatusCode?: DefaultStatus;
 }
 export interface ApiDef<T extends Api> {
@@ -43,8 +44,10 @@ export interface ApiDef<T extends Api> {
     params: Defined<T['params']>;
     query: Defined<T['query']>;
     files: Defined<T['files']>;
-    headers: Defined<T['headers']>;
+    requestHeaders: Defined<T['requestHeaders']>;
+    responseHeaders: Defined<T['responseHeaders']>;
     responses: ApiResponse<T['response'], GetDefaultStatusCode<T['defaultStatusCode']>>;
+    __apiDef: true;
 }
 type AnyApi<Method extends MethodTypes = MethodTypes> = Api<any, any, Method, any, any, any, any, any, any>;
 type Awaitable<T> = Promise<T> | T;
@@ -88,6 +91,6 @@ declare class MiddlewareHandler<Cb extends Function> {
     private constructor();
     static make<Cb extends Function>(cb: Cb, onSetup?: HandlerSetup): MiddlewareHandler<Cb>;
 }
-export declare const makeMiddleware: <Def extends Api = Api<any, string, MethodTypes, any, Record<string, boolean>, Record<string, string>, Record<string, any>, Record<string, string | string[]>, SupportedStatusCodes>>(cb: RouteMiddlewareHandler<Def>, onSetup?: HandlerSetup | undefined) => MiddlewareHandler<RouteMiddlewareHandler<Def>>;
-export declare const makeErrorMiddleware: <Def extends Api = Api<any, string, MethodTypes, any, Record<string, boolean>, Record<string, string>, Record<string, any>, Record<string, string | string[]>, SupportedStatusCodes>>(cb: ErrorHandler<Def>, onSetup?: HandlerSetup | undefined) => MiddlewareHandler<ErrorHandler<Def>>;
+export declare const makeMiddleware: <Def extends Api = Api<any, string, MethodTypes, any, Record<string, boolean>, Record<string, string>, Record<string, any>, Record<string, string | string[]>, Record<string, string | string[]>, SupportedStatusCodes>>(cb: RouteMiddlewareHandler<Def>, onSetup?: HandlerSetup | undefined) => MiddlewareHandler<RouteMiddlewareHandler<Def>>;
+export declare const makeErrorMiddleware: <Def extends Api = Api<any, string, MethodTypes, any, Record<string, boolean>, Record<string, string>, Record<string, any>, Record<string, string | string[]>, Record<string, string | string[]>, SupportedStatusCodes>>(cb: ErrorHandler<Def>, onSetup?: HandlerSetup | undefined) => MiddlewareHandler<ErrorHandler<Def>>;
 export {};

package/lib/types/index.d.ts

@@ -15,6 +15,6 @@ export type Paths<T, D = never> = T extends StopTypes ? '' : T extends readonly
 }[keyof T & string];
 export type JSONPrimitives = string | number | boolean | null;
 export type JSONValue<T> = T extends JSONPrimitives ? T : T extends Array<infer U> ? JSONValue<U>[] : T extends BaseEntity<infer _M, infer I> ? JSONValue<DeepOmit<T, I, '__ignoreInJSON'>> : T extends Function ? never : T extends object ? {
-    [K in keyof T & (number | string) as JSONValue<T[K]> extends never ? never : JSONValue<T[K]> extends undefined ? never : K]: JSONValue<T[K]>;
-} : T extends unknown ? unknown : undefined extends T ? JSONValue<Exclude<T, undefined>> | undefined : never;
+    [K in keyof T as JSONValue<T[K]> extends never ? never : JSONValue<T[K]> extends undefined ? never : K]: JSONValue<T[K]>;
+} : never;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "equipped",
-	"version": "5.0.0-alpha.7",
+	"version": "5.0.0-alpha.8",
 	"private": false,
 	"description": "",
 	"main": "lib/index.js",
@@ -80,7 +80,7 @@
 		"redis": "^4.6.14",
 		"socket.io": "4.7.5",
 		"supertest": "^7.0.0",
-		"ts-oas": "^0.4.2",
+		"ts-oas": "^0.4.4",
 		"valleyed": "4.3.0"
 	},
 	"repository": {