fix: props type error.

chizukicn · Feb 26, 2023 · 753094d · 753094d
1 parent 5c16474
commit 753094d
Show file tree

Hide file tree

Showing 7 changed files with 39 additions and 25 deletions.
diff --git a/packages/core/src/router.ts b/packages/core/src/router.ts
@@ -3,6 +3,7 @@ import { createLogger } from "./logger";
 import type { FourzeRouteMeta, MetaInstance } from "./shared/meta";
 import { injectMeta } from "./shared/meta";
 import type {
+  DefaultData,
   FourzeApp, FourzeBaseRoute,
   FourzeHandle,
   FourzeMiddleware,
@@ -43,14 +44,14 @@ type FourzeRouteChain<Methods extends string = RequestMethod> = {
    * only once
    */
   [method in Methods]: {
-    <Result = unknown, Props extends ObjectProps = ObjectProps, Meta = FourzeRouteMeta>(
+    <Result = unknown, Props extends ObjectProps = DefaultData, Meta = FourzeRouteMeta>(
       options: Omit<FourzeRouteOptions<Props, Meta>, "path" | "method">,
       handle: FourzeHandle<Result, Props, Meta>
     ): FourzeRouteChain<Exclude<Methods, method>> & {
       route: FourzeRouter["route"]
     }
 
-    <Result = unknown, Props extends ObjectProps = ObjectProps, Meta = FourzeRouteMeta>(
+    <Result = unknown, Props extends ObjectProps = DefaultData, Meta = FourzeRouteMeta>(
       handle: FourzeHandle<Result, Props, Meta>
     ): FourzeRouteChain<Exclude<Methods, method>> & {
       route: FourzeRouter["route"]
@@ -68,15 +69,15 @@ export interface FourzeRouter
 
   route(path: string): FourzeRouteChain
 
-  route<Result = unknown, Props extends ObjectProps = ObjectProps, Meta = FourzeRouteMeta>(path: string, method: RequestMethod, options: FourzeRouteOptions<Props, Meta>, handle: FourzeHandle<Result, Props, Meta>): this
+  route<Result = unknown, Props extends ObjectProps = DefaultData, Meta = FourzeRouteMeta>(path: string, method: RequestMethod, options: FourzeRouteOptions<Props, Meta>, handle: FourzeHandle<Result, Props, Meta>): this
 
   route(path: string, method: RequestMethod, handle: FourzeHandle): this
 
-  route<Result = unknown, Props extends ObjectProps = ObjectProps, Meta = FourzeRouteMeta>(path: string, options: FourzeRouteOptions<Props, Meta>, handle: FourzeHandle<Result, Props, Meta>): this
+  route<Result = unknown, Props extends ObjectProps = DefaultData, Meta = FourzeRouteMeta>(path: string, options: FourzeRouteOptions<Props, Meta>, handle: FourzeHandle<Result, Props, Meta>): this
 
   route(path: string, handle: FourzeHandle): this
 
-  route<Result = unknown, Props extends ObjectProps = ObjectProps, Meta = FourzeRouteMeta>(route: FourzeBaseRoute<Result, Props, Meta>): this
+  route<Result = unknown, Props extends ObjectProps = DefaultData, Meta = FourzeRouteMeta>(route: FourzeBaseRoute<Result, Props, Meta>): this
 
   route(route: FourzeBaseRoute[]): this
 
@@ -191,7 +192,7 @@ export function defineRouter(
         } as FourzeRouteChain;
 
         for (const method of FOURZE_METHODS) {
-          chain[method] = (...args: [FourzeRouteOptions, FourzeHandle] | [FourzeHandle]) => {
+          chain[method] = (...args: [FourzeRouteOptions<Record<string, any>>, FourzeHandle] | [FourzeHandle]) => {
             const { handle, options } = overload({
               options: {
                 type: Object

diff --git a/packages/core/src/shared/interface.ts b/packages/core/src/shared/interface.ts
@@ -3,7 +3,7 @@ import type { MaybePromise, MaybeRegex } from "maybe-types";
 import { overload } from "../utils";
 import type { FourzeContextOptions, FourzeServiceContext } from "./context";
 import type { FourzeAppMeta, FourzeRouteMeta, MetaInstance } from "./meta";
-import type { ObjectProps, PropType } from "./props";
+import type { DefaultData, ObjectProps, PropType } from "./props";
 import type { FourzeRequest } from "./request";
 import type { FourzeResponse } from "./response";
 
@@ -12,7 +12,7 @@ const FOURZE_MIDDLEWARE_SYMBOL = Symbol("FOURZE_MIDDLEWARE_SYMBOL");
 export type FourzeNext<T = any> = () => MaybePromise<T>;
 
 export type FourzeHandle<
-  R = unknown, Props extends ObjectProps = ObjectProps, Meta = FourzeRouteMeta
+  R = unknown, Props extends ObjectProps = DefaultData, Meta = FourzeRouteMeta
 > = (
   request: FourzeRequest<Props, Meta>,
   response: FourzeResponse

diff --git a/packages/core/src/shared/props.ts b/packages/core/src/shared/props.ts
@@ -1,17 +1,21 @@
 import { isArray, isConstructor, isFunction, isPlainObject, isUndef } from "../utils";
 import { FourzeError } from "./error";
 
-export type DefaultData = Record<string, unknown>;
+export interface GlobalProps extends Record<string, any> {}
+
+export type DefaultData = Record<string, any>;
 
 export type PropIn = "body" | "query" | "path";
 
-export type ExtractPropTypes<
-  P extends Record<string, any>, In extends PropIn | "any" = "any", O = In extends PropIn ? Pick<P, InKeys<P, In>> : P
-> = {
+export declare type ExtractPropTypes<O> = {
   [K in keyof Pick<O, RequiredKeys<O>>]: InferPropType<O[K]>;
 } & {
   [K in keyof Pick<O, OptionalKeys<O>>]?: InferPropType<O[K]>;
-} & DefaultData;
+} & GlobalProps;
+
+export type ExtractPropTypesWithIn<
+  O, In extends PropIn
+> = ExtractPropTypes<Pick<O, InKeys<O, In>>>;
 
 export type ExtractDefaultPropTypes<P extends Record<string, any>> = {
   [K in keyof Pick<P, DefaultKeys<P>>]: InferPropType<P[K]>;
@@ -251,7 +255,7 @@ export function normalizeProps<T>(
 }
 
 export function withDefaults<
-  T = Record<string, any>, P extends ObjectProps<T> = ObjectProps <T>, D = ExtractPropTypes<P>, Defaults = ExtractDefaultPropTypes<P>
+  T = Record<string, any>, P extends ObjectProps<T> = ObjectProps<T>, D = ExtractPropTypes<P>, Defaults = ExtractDefaultPropTypes<P>
 >(props: Partial<Defaults> & Omit<D, keyof Defaults>, propsOptions: P, propIn?: PropIn): D {
   if (Array.isArray(propsOptions)) {
     return props as D;

diff --git a/packages/core/src/shared/request.ts b/packages/core/src/shared/request.ts
@@ -3,7 +3,7 @@ import qs from "query-string";
 import type { PolyfillHeaderInit } from "../polyfill";
 import { decodeFormData, flatHeaders, getHeaderValue } from "../polyfill";
 import { isString, isUint8Array, normalize } from "../utils";
-import type { ExtractPropTypes, ObjectProps } from "./props";
+import type { DefaultData, ExtractPropTypes, ExtractPropTypesWithIn, ObjectProps } from "./props";
 import { validateProps, withDefaults } from "./props";
 import type { FourzeRoute } from "./route";
 import type { FourzeRouteMeta } from "./meta";
@@ -35,7 +35,7 @@ export interface FourzeRequestOptions {
 }
 
 export interface FourzeRequest<
-  Props extends ObjectProps = ObjectProps, Meta = FourzeRouteMeta, Data = ExtractPropTypes<Props>, Query = ExtractPropTypes<Props, "query">, Body = ExtractPropTypes<Props, "body">, Params = ExtractPropTypes<Props, "path">
+  Props extends ObjectProps = DefaultData, Meta = FourzeRouteMeta, Data = ExtractPropTypes<Props>, Query = ExtractPropTypesWithIn<Props, "query">, Body = ExtractPropTypesWithIn<Props, "body">, Params = ExtractPropTypesWithIn<Props, "path">
 > extends IncomingMessage {
   url: string
   method: string

diff --git a/packages/core/src/shared/route.ts b/packages/core/src/shared/route.ts
@@ -1,5 +1,5 @@
 import { resolves } from "../utils";
-import type { ObjectProps } from "./props";
+import type { DefaultData, ObjectProps } from "./props";
 import type { RequestMethod } from "./request";
 import { FOURZE_METHODS } from "./request";
 import type { FourzeRouteMeta } from "./meta";
@@ -14,7 +14,7 @@ export interface FourzeRouteOptions<Props extends ObjectProps = ObjectProps, Met
 }
 
 export interface FourzeBaseRoute<
-  Result = unknown, Props extends ObjectProps = ObjectProps, Meta = FourzeRouteMeta
+  Result = unknown, Props extends ObjectProps = DefaultData, Meta = FourzeRouteMeta
 > {
   path: string
   method?: RequestMethod
@@ -24,7 +24,7 @@ export interface FourzeBaseRoute<
 }
 
 export interface FourzeRoute<
-  Result = unknown, Props extends ObjectProps = ObjectProps, Meta = FourzeRouteMeta
+  Result = unknown, Props extends ObjectProps = DefaultData, Meta = FourzeRouteMeta
 > extends FourzeBaseRoute<Result, Props, Meta> {
   readonly [FOURZE_ROUTE_SYMBOL]: true
   readonly props: Props
@@ -34,7 +34,7 @@ export interface FourzeRoute<
 export type FourzeRouteGenerator<This> = {
   [K in RequestMethod]: {
     <
-      Result = any, Props extends ObjectProps = ObjectProps, Meta = FourzeRouteMeta
+      Result = any, Props extends ObjectProps = DefaultData, Meta = FourzeRouteMeta
     >(
       path: string,
       options: FourzeRouteOptions<Props, Meta>,
@@ -53,14 +53,14 @@ const REQUEST_PATH_REGEX = new RegExp(
   "i"
 );
 
-export function defineRouteProps<Props extends ObjectProps = ObjectProps>(
+export function defineRouteProps<Props extends ObjectProps = DefaultData>(
   props: Props
 ) {
   return props;
 }
 
 export function defineRoute<
-  Result = unknown, Props extends ObjectProps = ObjectProps, Meta = FourzeRouteMeta
+  Result = unknown, Props extends ObjectProps = DefaultData, Meta = FourzeRouteMeta
 >(
   route: FourzeBaseRoute<Result, Props, Meta> & { base?: string }
 ): FourzeRoute<Result, Props, Meta> {

diff --git a/playgrounds/vite/src/fourze.d.ts b/playgrounds/vite/src/fourze.d.ts
@@ -0,0 +1,10 @@
+
+import "@fourze/core";
+declare module "@fourze/core"  {
+  interface FourzeRouteMeta{
+    title?: string
+  }
+  interface GlobalProps {
+    title?: string
+  }
+}
diff --git a/playgrounds/vite/src/mock/index.ts b/playgrounds/vite/src/mock/index.ts
@@ -161,13 +161,12 @@ export default defineRouter((router) => {
       props: {
         file: {
           type: PolyfillFile,
-          required: true,
-          in: "body"
+          required: true
         }
       }
     },
     async (req) => {
-      const file = req.body.file;
+      const file = req.data.file;
       if (!fs.existsSync(path.resolve(__dirname, ".tmp"))) {
         fs.mkdirSync(path.resolve(__dirname, ".tmp"));
       }