Add IsValidUrl type

src/core/query-string.t-test.ts

@@ -0,0 +1,70 @@
+import { Equal, Expect } from "./type-test";
+import {
+  HasExcessiveQuery,
+  HasMissingQuery,
+  IsValidQuery,
+  NonOptionalKeys,
+  ToQueryUnion,
+} from "./query-string";
+
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+type ToQueryUnionCase = [
+  Expect<Equal<ToQueryUnion<"a=1">, "a">>,
+  Expect<Equal<ToQueryUnion<"a=1&b=2">, "a" | "b">>,
+  Expect<Equal<ToQueryUnion<"a=1&b=2&a=3">, "a" | "b">>,
+];
+
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+type HasMissingQueryCase = [
+  Expect<Equal<HasMissingQuery<{ a: string }, "a">, false>>,
+  Expect<Equal<HasMissingQuery<{ a?: string }, "a">, false>>,
+  Expect<Equal<HasMissingQuery<{ a?: string }, "b">, false>>,
+  Expect<Equal<HasMissingQuery<{ a?: string }, never>, false>>,
+  Expect<Equal<HasMissingQuery<{ a: string }, "a" | "b">, false>>,
+  Expect<Equal<HasMissingQuery<{ a?: string }, "a" | "b">, false>>,
+  Expect<Equal<HasMissingQuery<{ a: string; b?: string }, "a">, false>>,
+  Expect<Equal<HasMissingQuery<{ a: string }, "b">, true>>,
+  Expect<Equal<HasMissingQuery<{ a: string; b: string }, "b">, true>>,
+  Expect<Equal<HasMissingQuery<{ a: string; b?: string }, "b">, true>>,
+];
+
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+type HasExcessiveQueryCase = [
+  Expect<Equal<HasExcessiveQuery<{ a: string }, "a">, false>>,
+  Expect<Equal<HasExcessiveQuery<{ a: string }, "b">, true>>,
+  Expect<Equal<HasExcessiveQuery<{ a: string }, "a" | "b">, true>>,
+  Expect<Equal<HasExcessiveQuery<{ a: string; b: string }, "a" | "b">, false>>,
+  Expect<Equal<HasExcessiveQuery<{ a: string; b?: string }, "a" | "b">, false>>,
+  Expect<
+    Equal<HasExcessiveQuery<{ a: string; b: string }, "a" | "b" | "c">, true>
+  >,
+];
+
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+type NonOptionalKeysCase = [
+  Expect<Equal<NonOptionalKeys<{ a: string }>, "a">>,
+  Expect<Equal<NonOptionalKeys<{ a?: string }>, never>>,
+  Expect<Equal<NonOptionalKeys<{ a: string; b?: string }>, "a">>,
+  Expect<Equal<NonOptionalKeys<{ a: string; b: string }>, "a" | "b">>,
+];
+
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+type IsValidQueryCase = [
+  Expect<Equal<IsValidQuery<{ a: string }, "a">, true>>,
+  Expect<Equal<IsValidQuery<{ a: string }, "b">, "E: maybe missing query: a">>,
+  Expect<
+    Equal<
+      IsValidQuery<{ a: string }, "a" | "b">,
+      "E: maybe excessive query: a" | "E: maybe excessive query: b"
+    >
+  >,
+  Expect<Equal<IsValidQuery<{ a: string; b?: string }, "a">, true>>,
+  Expect<Equal<IsValidQuery<{ a: string; b?: string }, "a" | "b">, true>>,
+  Expect<
+    Equal<
+      IsValidQuery<{ a: string; b: string }, "a">,
+      "E: maybe missing query: a" | "E: maybe missing query: b"
+    >
+  >,
+  Expect<Equal<IsValidQuery<{ a: string; b: string }, "a" | "b">, true>>,
+];

src/core/query-string.ts

@@ -38,3 +38,40 @@ export type SetProperty<T, K extends PropertyKey, V = true> = {
       ? T[P]
       : never;
 };
+
+export type ExtractQuery<URL extends string> =
+  URL extends `${string}?${infer Query}` ? Query : undefined;
+
+export type ToQueryUnion<Query extends string> =
+  Query extends `${infer Key}=${string}&${infer Rest}`
+    ? Key | ToQueryUnion<Rest>
+    : Query extends `${infer Key}=${string}`
+      ? Key
+      : `invalid query: ${Query}`;
+
+export type HasMissingQuery<
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  QueryDef extends Record<string, any>,
+  QueryKeys extends string,
+> = NonOptionalKeys<QueryDef> extends QueryKeys ? false : true;
+
+export type HasExcessiveQuery<
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  QueryDef extends Record<string, any>,
+  QueryKeys extends string,
+  // no union distribution
+> = [QueryKeys] extends [keyof QueryDef] ? false : true;
+
+export type NonOptionalKeys<T> = {
+  [K in keyof T]-?: undefined extends T[K] ? never : K;
+}[keyof T];
+
+export type IsValidQuery<
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  QueryDef extends Record<string, any>,
+  QueryKeys extends string,
+> = [HasMissingQuery<QueryDef, QueryKeys>] extends [true]
+  ? `E: maybe missing query: ${keyof QueryDef & string}`
+  : [HasExcessiveQuery<QueryDef, QueryKeys>] extends [true]
+    ? `E: maybe excessive query: ${QueryKeys}`
+    : true;

src/fetch/index.t-test.ts

@@ -220,6 +220,23 @@ const JSONT = JSON as JSONT;
         headers: { Cookie: "a=b" },
       });
     }
+    {
+      // @ts-expect-error 定義されているパラメータを指定していない場合はエラー
+      f(`/api/projects/projectA/workflow/packages/list?a=b`, {
+        headers: { Cookie: "a=b" },
+      });
+    }
+    {
+      // @ts-expect-error 定義されていないパラメータを指定した場合は型エラー
+      f(`/api/projects/projectA/workflow/packages/list?state=true&a=b`, {
+        headers: { Cookie: "a=b" },
+      });
+
+      // @ts-expect-error 順序は関係ない
+      f(`/api/projects/projectA/workflow/packages/list?a=b&state=true`, {
+        headers: { Cookie: "a=b" },
+      });
+    }
   })();
 }
 

src/fetch/index.ts

@@ -13,21 +13,34 @@ import {
   StatusCode,
   IsAllOptional,
   CaseInsensitive,
+  ExtractQuery,
+  IsValidQuery,
+  ToQueryUnion,
 } from "../core";
 import { UrlPrefixPattern, ToUrlParamPattern } from "../core";
 import { TypedString } from "../json";
 
+type IsValidUrl<
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  QueryDef extends Record<string, unknown> | undefined,
+  Url extends string,
+  Query extends string | undefined = ExtractQuery<Url>,
+  QueryKeys extends string = Query extends string ? ToQueryUnion<Query> : never,
+> = IsValidQuery<
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/ban-types
+  QueryDef extends Record<string, any> ? QueryDef : {},
+  QueryKeys
+>;
+
 export type RequestInitT<
   InputMethod extends CaseInsensitiveMethod,
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  Body extends Record<string, any> | string | undefined,
+  Body extends Record<string, unknown> | string | undefined,
   HeadersObj extends string | Record<string, string> | undefined,
 > = Omit<RequestInit, "method" | "body" | "headers"> &
   (InputMethod extends "get" | "GET"
     ? { method?: InputMethod }
     : { method: InputMethod }) &
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  (Body extends Record<string, any>
+  (Body extends Record<string, unknown>
     ? IsAllOptional<Body> extends true
       ? { body?: Body | TypedString<Body> }
       : { body: TypedString<Body> }
@@ -86,7 +99,7 @@ type FetchT<UrlPrefix extends UrlPrefixPattern, E extends ApiEndpoints> = <
     ? MergeApiResponseBodies<ApiP<E, CandidatePaths, M, "responses">>
     : Record<StatusCode, never>,
 >(
-  input: Input,
+  input: IsValidUrl<Query, Input> extends true ? Input : never,
   init: RequestInitT<
     InputMethod,
     ApiP<E, CandidatePaths, M, "body">,