@kizunajs/fetch 2.0.0-beta.12 → 2.0.0-beta.14

package/dist/index.d.cts

@@ -1,166 +1,57 @@
+import * as _$kizunajs from "kizunajs";
+import { ApiDefinition } from "kizunajs";
 import { z } from "zod";
-import { AUTO_GUARD_BRAND, AUTO_RESPONSES_BRAND, ExtractPathParams, HasPathParams, Method, ProblemDetails, RequestContextHeaderInputs, RouteDefinition, RoutePath, Routes, StreamMessageOf, StreamResponseDefinition, ValidationError, ValidationError as ValidationError$1, ValidationErrorFor, isProblemDetails, isValidationError } from "kizunajs";
+import { GeneratedFileOptions } from "kizunajs/generator";
 
-//#region src/client.d.ts
-type ResponseUnion<R extends RouteDefinition> = { [S in keyof R['responses']]: {
-  status: S extends number ? S : never;
-  body: R['responses'][S] extends z.ZodType ? z.infer<R['responses'][S]> : R['responses'][S] extends StreamResponseDefinition ? AsyncIterable<StreamMessageOf<R['responses'][S]>> : R['responses'][S] extends {
-    body: z.ZodType;
-  } ? z.infer<R['responses'][S]['body']> : never;
-  headers: R['responses'][S] extends {
-    headers: z.ZodType;
-  } ? z.infer<R['responses'][S]['headers']> : Record<string, string>;
-} }[keyof R['responses']];
-/**
- * The type a caller passes for a body, query, or headers argument, the schema's
- * input type.
- */
-type ClientPayload<T extends z.ZodType> = z.input<T>;
-/**
- * Path params are typed from the route's `pathParams` schema output when one is declared,
- * mirroring the server-side `HandlerArgs`. This makes refinements like `.brand()` flow to
- * the caller. Falls back to the path template (`:param` → `string`).
- */
-type ClientParams<R extends RouteDefinition> = R extends {
-  pathParams: z.ZodType;
-} ? z.output<R['pathParams']> : ExtractPathParams<R['path']>;
-/**
- * True when the arg can be omitted: its input accepts `{}` or `undefined`.
- */
-type IsOmittable<Payload> = {} extends Payload ? true : [undefined] extends [Payload] ? true : false;
-/**
- * Everything a caller passes for one route: `params`, `body`, `query`, `headers`,
- * and `fetchOptions`. Each key is present only when the route declares it, and
- * optional when its input accepts `{}` or `undefined`.
- */
-type ClientArgs<R extends RouteDefinition> = (HasPathParams<R['path']> extends true ? {
-  params: ClientParams<R>;
-} : {}) & (R extends {
-  body: z.ZodType;
-} ? (ClientPayload<R['body']> extends void ? {} : {
-  body: ClientPayload<R['body']>;
-}) : {}) & (R extends {
-  query: z.ZodType;
-} ? IsOmittable<ClientPayload<R['query']>> extends true ? {
-  query?: ClientPayload<R['query']>;
-} : {
-  query: ClientPayload<R['query']>;
-} : {}) & (R extends {
-  headers: z.ZodType;
-} ? IsOmittable<ClientPayload<R['headers']>> extends true ? {
-  headers?: ClientPayload<R['headers']>;
-} : {
-  headers: ClientPayload<R['headers']>;
-} : {
-  headers?: Record<string, string>;
-}) & {
-  fetchOptions?: RequestInit;
-};
-type ValidationErrorResult<Codes extends string> = {
-  status: 400;
-  body: [Codes] extends [never] ? ValidationError$1 : ValidationErrorFor<Codes>;
-  headers: Record<string, string>;
-};
-type HasValidation<R extends RouteDefinition> = R extends {
-  body: z.ZodType;
-} ? true : R extends {
-  query: z.ZodType;
-} ? true : false;
-/**
- * The statuses the api's auth map put on a guarded route. A declared `403`
- * sits alongside, as a declared `400` does beside the validation error.
- */
-type AutoStatuses<R extends RouteDefinition> = Extract<typeof AUTO_RESPONSES_BRAND extends keyof R ? NonNullable<R[typeof AUTO_RESPONSES_BRAND]> : never, number>;
-/**
- * The api's `guardSchema`, or plain Problem Details when it declares none.
- */
-type AutoBody<R extends RouteDefinition> = typeof AUTO_GUARD_BRAND extends keyof R ? NonNullable<R[typeof AUTO_GUARD_BRAND]> : ProblemDetails;
-type AutoErrorResult<R extends RouteDefinition> = { [Status in AutoStatuses<R>]: {
-  status: Status;
-  body: AutoBody<R>;
-  headers: Record<string, string>;
-} }[AutoStatuses<R>];
-/**
- * Every response one route can produce, as a union discriminated on `status`.
- * Routes with a `body` or `query` schema also carry the automatic `400`, and
- * guarded routes the `401` and `403`.
- */
-type ClientResponse<R extends RouteDefinition, Codes extends string = never> = (HasValidation<R> extends true ? ResponseUnion<R> | ValidationErrorResult<Codes> : ResponseUnion<R>) | AutoErrorResult<R>;
-type ClientFn<R extends RouteDefinition, Codes extends string> = {} extends ClientArgs<R> ? (args?: ClientArgs<R>) => Promise<ClientResponse<R, Codes>> : (args: ClientArgs<R>) => Promise<ClientResponse<R, Codes>>;
-type Client<T extends Routes, Codes extends string = never> = { [K in keyof T]: T[K] extends RouteDefinition ? ClientFn<T[K], Codes> : T[K] extends Routes ? Client<T[K], Codes> : never };
-type UnionToIntersection<Union> = (Union extends unknown ? (distributed: Union) => void : never) extends ((intersected: infer Intersection) => void) ? Intersection : never;
-/**
- * Every header input the api's request context declares, flattened. Set
- * once on the client under `requestContext` and sent with every request.
- */
-type ContextHeaderInputs<Declarations> = string extends keyof Declarations ? {} : [keyof Declarations] extends [never] ? {} : UnionToIntersection<{ [Name in keyof Declarations]: RequestContextHeaderInputs<Declarations[Name]> }[keyof Declarations]> extends infer Merged ? { [Key in keyof Merged]: Merged[Key] } : never;
-/**
- * The request `onRequest` is handed, on its way out. Setting a header on
- * `headers` sets it on the request that is sent.
- */
-interface OutgoingRequest {
-  url: string;
-  method: string;
-  headers: Headers;
-  route: RouteDefinition;
+//#region src/generator.d.ts
+/**
+ * What a generated client is called, and what its header says.
+ */
+interface FetchClientOptions {
+  /**
+   * Name of the generated namespace holding every model and every route's
+   * `Params`, `Query`, `Body`, `Headers` and `Result`.
+   *
+   * @default 'API'
+   */
+  namespace?: string;
+  /**
+   * Command the file's header tells a reader to run.
+   *
+   * @default 'kizuna generate'
+   */
+  regenerateCommand?: string;
+  /**
+   * Path to the api this was generated from, relative to the generated
+   * file. Named in the header so tooling can tell when the client has fallen
+   * behind, and so a reader knows where the API is declared.
+   */
+  source?: string;
 }
-interface ClientConfig {
-  baseUrl: string;
-  baseHeaders?: Record<string, string>;
-  credentials?: RequestCredentials;
-  fetch?: typeof fetch;
-  onRequest?: (request: OutgoingRequest) => void | Promise<void>;
-}
-/**
- * Registry-global: what a client method was built from. Anything wrapping a
- * client reads the route here rather than being handed the api a second time.
- */
-/**
- * One method on a generated client: the call itself, carrying the method it
- * sends and whether that response streams. A wrapper reads those off the client
- * rather than being handed the routes a second time.
- */
-type ClientMethod<Method extends string, Streams extends boolean, Args, Result> = ({} extends Args ? (args?: Args) => Promise<Result> : (args: Args) => Promise<Result>) & {
-  readonly [CLIENT_ROUTE]?: {
-    readonly method: Method;
-    readonly streams: Streams;
-  };
-};
-declare const CLIENT_ROUTE: unique symbol;
-/**
- * The route a client method answers, or `undefined` for anything that is not
- * one.
- */
-declare const routeOf: (value: unknown) => RouteDefinition | undefined;
-/**
- * What a generated client knows about one response: nothing for a body it
- * parses as JSON, the media type for one it streams.
- */
-type GeneratedResponse = Record<string, never> | {
-  stream: {
-    contentType?: string;
-  };
-};
-/**
- * One route in a generated client's table: how to reach it, and enough about
- * each response to read the body.
- */
-interface GeneratedRoute {
-  method: Method;
-  path: RoutePath;
-  contentType?: string;
-  responses: Record<number, GeneratedResponse>;
-}
-/**
- * The route table a generated client carries, nested the way the client is.
- */
-interface GeneratedRoutes {
-  [key: string]: GeneratedRoutes | GeneratedRoute;
-}
-/**
- * Builds the client tree a generated client exposes. The generated file owns the
- * types; this owns the requests.
- */
-declare const createGeneratedClient: (routes: GeneratedRoutes, config: ClientConfig) => Record<string, unknown>;
+declare const generateFetchClient: (contract: ApiDefinition, options?: FetchClientOptions) => string;
+//#endregion
+//#region src/client-target.d.ts
+declare const FetchClientOptionsSchema: z.ZodObject<{
+  namespace: z.ZodOptional<z.ZodString>;
+  regenerateCommand: z.ZodOptional<z.ZodString>;
+  source: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * Where a generated TypeScript client is written.
+ */
+type FetchClientTargetOptions = z.input<typeof FetchClientOptionsSchema> & GeneratedFileOptions;
+/**
+ * A TypeScript client for `kizuna.config.ts`.
+ *
+ * @example
+ * fetchClient({
+ *     output: './packages/api-client/src/generated.ts',
+ * });
+ */
+declare const fetchClient: (options: {
+  namespace?: string | undefined;
+  regenerateCommand?: string | undefined;
+  source?: string | undefined;
+} & GeneratedFileOptions) => _$kizunajs.GeneratedFile;
 //#endregion
-export { CLIENT_ROUTE, Client, ClientArgs, ClientConfig, ClientMethod, ClientResponse, ContextHeaderInputs, GeneratedResponse, GeneratedRoute, GeneratedRoutes, OutgoingRequest, type ValidationError, createGeneratedClient, isProblemDetails, isValidationError, routeOf };
+export { type FetchClientOptions, type FetchClientTargetOptions, fetchClient, generateFetchClient };

package/dist/index.d.mts

@@ -1,166 +1,57 @@
-import { AUTO_GUARD_BRAND, AUTO_RESPONSES_BRAND, ExtractPathParams, HasPathParams, Method, ProblemDetails, RequestContextHeaderInputs, RouteDefinition, RoutePath, Routes, StreamMessageOf, StreamResponseDefinition, ValidationError, ValidationError as ValidationError$1, ValidationErrorFor, isProblemDetails, isValidationError } from "kizunajs";
+import { GeneratedFileOptions } from "kizunajs/generator";
 import { z } from "zod";
+import * as _$kizunajs from "kizunajs";
+import { ApiDefinition } from "kizunajs";
 
-//#region src/client.d.ts
-type ResponseUnion<R extends RouteDefinition> = { [S in keyof R['responses']]: {
-  status: S extends number ? S : never;
-  body: R['responses'][S] extends z.ZodType ? z.infer<R['responses'][S]> : R['responses'][S] extends StreamResponseDefinition ? AsyncIterable<StreamMessageOf<R['responses'][S]>> : R['responses'][S] extends {
-    body: z.ZodType;
-  } ? z.infer<R['responses'][S]['body']> : never;
-  headers: R['responses'][S] extends {
-    headers: z.ZodType;
-  } ? z.infer<R['responses'][S]['headers']> : Record<string, string>;
-} }[keyof R['responses']];
-/**
- * The type a caller passes for a body, query, or headers argument, the schema's
- * input type.
- */
-type ClientPayload<T extends z.ZodType> = z.input<T>;
-/**
- * Path params are typed from the route's `pathParams` schema output when one is declared,
- * mirroring the server-side `HandlerArgs`. This makes refinements like `.brand()` flow to
- * the caller. Falls back to the path template (`:param` → `string`).
- */
-type ClientParams<R extends RouteDefinition> = R extends {
-  pathParams: z.ZodType;
-} ? z.output<R['pathParams']> : ExtractPathParams<R['path']>;
-/**
- * True when the arg can be omitted: its input accepts `{}` or `undefined`.
- */
-type IsOmittable<Payload> = {} extends Payload ? true : [undefined] extends [Payload] ? true : false;
-/**
- * Everything a caller passes for one route: `params`, `body`, `query`, `headers`,
- * and `fetchOptions`. Each key is present only when the route declares it, and
- * optional when its input accepts `{}` or `undefined`.
- */
-type ClientArgs<R extends RouteDefinition> = (HasPathParams<R['path']> extends true ? {
-  params: ClientParams<R>;
-} : {}) & (R extends {
-  body: z.ZodType;
-} ? (ClientPayload<R['body']> extends void ? {} : {
-  body: ClientPayload<R['body']>;
-}) : {}) & (R extends {
-  query: z.ZodType;
-} ? IsOmittable<ClientPayload<R['query']>> extends true ? {
-  query?: ClientPayload<R['query']>;
-} : {
-  query: ClientPayload<R['query']>;
-} : {}) & (R extends {
-  headers: z.ZodType;
-} ? IsOmittable<ClientPayload<R['headers']>> extends true ? {
-  headers?: ClientPayload<R['headers']>;
-} : {
-  headers: ClientPayload<R['headers']>;
-} : {
-  headers?: Record<string, string>;
-}) & {
-  fetchOptions?: RequestInit;
-};
-type ValidationErrorResult<Codes extends string> = {
-  status: 400;
-  body: [Codes] extends [never] ? ValidationError$1 : ValidationErrorFor<Codes>;
-  headers: Record<string, string>;
-};
-type HasValidation<R extends RouteDefinition> = R extends {
-  body: z.ZodType;
-} ? true : R extends {
-  query: z.ZodType;
-} ? true : false;
-/**
- * The statuses the api's auth map put on a guarded route. A declared `403`
- * sits alongside, as a declared `400` does beside the validation error.
- */
-type AutoStatuses<R extends RouteDefinition> = Extract<typeof AUTO_RESPONSES_BRAND extends keyof R ? NonNullable<R[typeof AUTO_RESPONSES_BRAND]> : never, number>;
-/**
- * The api's `guardSchema`, or plain Problem Details when it declares none.
- */
-type AutoBody<R extends RouteDefinition> = typeof AUTO_GUARD_BRAND extends keyof R ? NonNullable<R[typeof AUTO_GUARD_BRAND]> : ProblemDetails;
-type AutoErrorResult<R extends RouteDefinition> = { [Status in AutoStatuses<R>]: {
-  status: Status;
-  body: AutoBody<R>;
-  headers: Record<string, string>;
-} }[AutoStatuses<R>];
-/**
- * Every response one route can produce, as a union discriminated on `status`.
- * Routes with a `body` or `query` schema also carry the automatic `400`, and
- * guarded routes the `401` and `403`.
- */
-type ClientResponse<R extends RouteDefinition, Codes extends string = never> = (HasValidation<R> extends true ? ResponseUnion<R> | ValidationErrorResult<Codes> : ResponseUnion<R>) | AutoErrorResult<R>;
-type ClientFn<R extends RouteDefinition, Codes extends string> = {} extends ClientArgs<R> ? (args?: ClientArgs<R>) => Promise<ClientResponse<R, Codes>> : (args: ClientArgs<R>) => Promise<ClientResponse<R, Codes>>;
-type Client<T extends Routes, Codes extends string = never> = { [K in keyof T]: T[K] extends RouteDefinition ? ClientFn<T[K], Codes> : T[K] extends Routes ? Client<T[K], Codes> : never };
-type UnionToIntersection<Union> = (Union extends unknown ? (distributed: Union) => void : never) extends ((intersected: infer Intersection) => void) ? Intersection : never;
-/**
- * Every header input the api's request context declares, flattened. Set
- * once on the client under `requestContext` and sent with every request.
- */
-type ContextHeaderInputs<Declarations> = string extends keyof Declarations ? {} : [keyof Declarations] extends [never] ? {} : UnionToIntersection<{ [Name in keyof Declarations]: RequestContextHeaderInputs<Declarations[Name]> }[keyof Declarations]> extends infer Merged ? { [Key in keyof Merged]: Merged[Key] } : never;
-/**
- * The request `onRequest` is handed, on its way out. Setting a header on
- * `headers` sets it on the request that is sent.
- */
-interface OutgoingRequest {
-  url: string;
-  method: string;
-  headers: Headers;
-  route: RouteDefinition;
+//#region src/generator.d.ts
+/**
+ * What a generated client is called, and what its header says.
+ */
+interface FetchClientOptions {
+  /**
+   * Name of the generated namespace holding every model and every route's
+   * `Params`, `Query`, `Body`, `Headers` and `Result`.
+   *
+   * @default 'API'
+   */
+  namespace?: string;
+  /**
+   * Command the file's header tells a reader to run.
+   *
+   * @default 'kizuna generate'
+   */
+  regenerateCommand?: string;
+  /**
+   * Path to the api this was generated from, relative to the generated
+   * file. Named in the header so tooling can tell when the client has fallen
+   * behind, and so a reader knows where the API is declared.
+   */
+  source?: string;
 }
-interface ClientConfig {
-  baseUrl: string;
-  baseHeaders?: Record<string, string>;
-  credentials?: RequestCredentials;
-  fetch?: typeof fetch;
-  onRequest?: (request: OutgoingRequest) => void | Promise<void>;
-}
-/**
- * Registry-global: what a client method was built from. Anything wrapping a
- * client reads the route here rather than being handed the api a second time.
- */
-/**
- * One method on a generated client: the call itself, carrying the method it
- * sends and whether that response streams. A wrapper reads those off the client
- * rather than being handed the routes a second time.
- */
-type ClientMethod<Method extends string, Streams extends boolean, Args, Result> = ({} extends Args ? (args?: Args) => Promise<Result> : (args: Args) => Promise<Result>) & {
-  readonly [CLIENT_ROUTE]?: {
-    readonly method: Method;
-    readonly streams: Streams;
-  };
-};
-declare const CLIENT_ROUTE: unique symbol;
-/**
- * The route a client method answers, or `undefined` for anything that is not
- * one.
- */
-declare const routeOf: (value: unknown) => RouteDefinition | undefined;
-/**
- * What a generated client knows about one response: nothing for a body it
- * parses as JSON, the media type for one it streams.
- */
-type GeneratedResponse = Record<string, never> | {
-  stream: {
-    contentType?: string;
-  };
-};
-/**
- * One route in a generated client's table: how to reach it, and enough about
- * each response to read the body.
- */
-interface GeneratedRoute {
-  method: Method;
-  path: RoutePath;
-  contentType?: string;
-  responses: Record<number, GeneratedResponse>;
-}
-/**
- * The route table a generated client carries, nested the way the client is.
- */
-interface GeneratedRoutes {
-  [key: string]: GeneratedRoutes | GeneratedRoute;
-}
-/**
- * Builds the client tree a generated client exposes. The generated file owns the
- * types; this owns the requests.
- */
-declare const createGeneratedClient: (routes: GeneratedRoutes, config: ClientConfig) => Record<string, unknown>;
+declare const generateFetchClient: (contract: ApiDefinition, options?: FetchClientOptions) => string;
+//#endregion
+//#region src/client-target.d.ts
+declare const FetchClientOptionsSchema: z.ZodObject<{
+  namespace: z.ZodOptional<z.ZodString>;
+  regenerateCommand: z.ZodOptional<z.ZodString>;
+  source: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * Where a generated TypeScript client is written.
+ */
+type FetchClientTargetOptions = z.input<typeof FetchClientOptionsSchema> & GeneratedFileOptions;
+/**
+ * A TypeScript client for `kizuna.config.ts`.
+ *
+ * @example
+ * fetchClient({
+ *     output: './packages/api-client/src/generated.ts',
+ * });
+ */
+declare const fetchClient: (options: {
+  namespace?: string | undefined;
+  regenerateCommand?: string | undefined;
+  source?: string | undefined;
+} & GeneratedFileOptions) => _$kizunajs.GeneratedFile;
 //#endregion
-export { CLIENT_ROUTE, Client, ClientArgs, ClientConfig, ClientMethod, ClientResponse, ContextHeaderInputs, GeneratedResponse, GeneratedRoute, GeneratedRoutes, OutgoingRequest, type ValidationError, createGeneratedClient, isProblemDetails, isValidationError, routeOf };
+export { type FetchClientOptions, type FetchClientTargetOptions, fetchClient, generateFetchClient };