@kubb/plugin-faker 5.0.0-beta.84 → 5.0.0-beta.85

package/dist/index.d.ts

@@ -1,122 +1,81 @@
 import { t as __name } from "./rolldown-runtime-C0LytTxp.js";
-import { Exclude, Group, Include, Output, OutputOptions, Override, PluginFactoryOptions, Resolver, ast } from "kubb/kit";
+import { Exclude, Group, Include, Output, OutputOptions, Override, PluginFactoryOptions, Resolver, ResolverPatch, ast } from "kubb/kit";
 import { KubbReactNode } from "kubb/jsx";
 
-//#region ../../internals/shared/src/operation.d.ts
-/**
- * Resolver interface for building operation parameters.
- *
- * `ResolverTs` from `@kubb/plugin-ts` satisfies this interface and can be passed directly.
- */
-type OperationParamsResolver = {
-  /**
-   * Resolves the type name for an individual parameter.
-   *
-   * @example Individual path parameter name
-   * `resolver.resolveParamName(node, param) // → 'DeletePetPathPetId'`
-   */
-  resolveParamName(node: ast.OperationNode, param: ast.ParameterNode): string;
-  /**
-   * Resolves the request body type name.
-   *
-   * @example Request body type name
-   * `resolver.resolveDataName(node) // → 'CreatePetData'`
-   */
-  resolveDataName(node: ast.OperationNode): string;
-  /**
-   * Resolves the grouped path parameters type name.
-   * When the return value equals `resolveParamName`, no indexed access is emitted.
-   *
-   * @example Grouped path params type name
-   * `resolver.resolvePathParamsName(node, param) // → 'DeletePetPathParams'`
-   */
-  resolvePathParamsName(node: ast.OperationNode, param: ast.ParameterNode): string;
-  /**
-   * Resolves the grouped query parameters type name.
-   * When the return value equals `resolveParamName`, an inline struct type is emitted instead.
-   *
-   * @example Grouped query params type name
-   * `resolver.resolveQueryParamsName(node, param) // → 'FindPetsByStatusQueryParams'`
-   */
-  resolveQueryParamsName(node: ast.OperationNode, param: ast.ParameterNode): string;
-  /**
-   * Resolves the grouped header parameters type name.
-   * When the return value equals `resolveParamName`, an inline struct type is emitted instead.
-   *
-   * @example Grouped header params type name
-   * `resolver.resolveHeaderParamsName(node, param) // → 'DeletePetHeaderParams'`
-   */
-  resolveHeaderParamsName(node: ast.OperationNode, param: ast.ParameterNode): string;
-};
-//#endregion
 //#region src/types.d.ts
 /**
  * Resolver for Faker that provides naming methods for mock functions.
+ *
+ * The top-level `name` and `file` apply the plugin's `create` prefix. Composite
+ * operation naming is grouped into the `param` and `response` namespaces.
  */
-type ResolverFaker = Resolver & OperationParamsResolver & {
-  /**
-   * Resolves the faker function name for a schema.
-   *
-   * @example Resolving faker function names
-   * `resolver.resolveName('show pet by id') // -> 'showPetById'`
-   */
-  resolveName(this: ResolverFaker, name: string, type?: 'file' | 'function' | 'type' | 'const'): string;
-  /**
-   * Resolves the output file name for a faker module.
-   *
-   * @example Resolving faker file names
-   * `resolver.resolvePathName('show pet by id', 'file') // -> 'showPetById'`
-   */
-  resolvePathName(this: ResolverFaker, name: string, type?: 'file' | 'function' | 'type' | 'const'): string;
-  /**
-   * Resolves the faker function name for a request body.
-   *
-   * @example Resolving data function names
-   * `resolver.resolveDataName(node) // -> 'createPetsData'`
-   */
-  resolveDataName(this: ResolverFaker, node: ast.OperationNode): string;
-  /**
-   * Resolves the faker function name for a response by status code.
-   *
-   * @example Response status names
-   * `resolver.resolveResponseStatusName(node, 200) // -> 'listPetsStatus200'`
-   */
-  resolveResponseStatusName(this: ResolverFaker, node: ast.OperationNode, statusCode: ast.StatusCode): string;
+type ResolverFaker = Resolver & {
   /**
-   * Resolves the faker function name for the response union.
-   *
-   * @example Response union names
-   * `resolver.resolveResponseName(node) // -> 'listPetsResponse'`
+   * Naming for operation parameters, keyed by their location.
    */
-  resolveResponseName(this: ResolverFaker, node: ast.OperationNode): string;
-  /**
-   * Resolves the faker function name for the response collection.
-   *
-   * @example Responses collection names
-   * `resolver.resolveResponsesName(node) // -> 'listPetsResponses'`
-   */
-  resolveResponsesName(this: ResolverFaker, node: ast.OperationNode): string;
-  /**
-   * Resolves the faker function name for path parameters.
-   *
-   * @example Path parameters names
-   * `resolver.resolvePathParamsName(node, param) // -> 'showPetByIdPathPetId'`
-   */
-  resolvePathParamsName(this: ResolverFaker, node: ast.OperationNode, param: ast.ParameterNode): string;
-  /**
-   * Resolves the faker function name for query parameters.
-   *
-   * @example Query parameters names
-   * `resolver.resolveQueryParamsName(node, param) // -> 'listPetsQueryLimit'`
-   */
-  resolveQueryParamsName(this: ResolverFaker, node: ast.OperationNode, param: ast.ParameterNode): string;
+  param: {
+    /**
+     * Resolves the faker function name for an individual parameter.
+     *
+     * @example Individual parameter name
+     * `resolver.param.name(node, param) // -> 'showPetByIdPathPetId'`
+     */
+    name(node: ast.OperationNode, param: ast.ParameterNode): string;
+    /**
+     * Resolves the faker function name for an operation's grouped path parameters.
+     *
+     * @example Grouped path parameters name
+     * `resolver.param.path(node, param) // -> 'createShowPetByIdPath'`
+     */
+    path(node: ast.OperationNode, param: ast.ParameterNode): string;
+    /**
+     * Resolves the faker function name for an operation's grouped query parameters.
+     *
+     * @example Grouped query parameters name
+     * `resolver.param.query(node, param) // -> 'createListPetsQuery'`
+     */
+    query(node: ast.OperationNode, param: ast.ParameterNode): string;
+    /**
+     * Resolves the faker function name for an operation's grouped header parameters.
+     *
+     * @example Grouped header parameters name
+     * `resolver.param.headers(node, param) // -> 'createDeletePetHeaders'`
+     */
+    headers(node: ast.OperationNode, param: ast.ParameterNode): string;
+  };
   /**
-   * Resolves the faker function name for header parameters.
-   *
-   * @example Header parameters names
-   * `resolver.resolveHeaderParamsName(node, param) // -> 'deletePetHeaderApiKey'`
+   * Naming for operation request bodies and responses.
    */
-  resolveHeaderParamsName(this: ResolverFaker, node: ast.OperationNode, param: ast.ParameterNode): string;
+  response: {
+    /**
+     * Resolves the faker function name for a response by status code.
+     *
+     * @example Response status name
+     * `resolver.response.status(node, 200) // -> 'listPetsStatus200'`
+     */
+    status(node: ast.OperationNode, statusCode: ast.StatusCode): string;
+    /**
+     * Resolves the faker function name for a request body.
+     *
+     * @example Request body name
+     * `resolver.response.body(node) // -> 'createPetsBody'`
+     */
+    body(node: ast.OperationNode): string;
+    /**
+     * Resolves the faker function name for the response union.
+     *
+     * @example Response union name
+     * `resolver.response.response(node) // -> 'listPetsResponse'`
+     */
+    response(node: ast.OperationNode): string;
+    /**
+     * Resolves the faker function name for the response collection.
+     *
+     * @example Responses collection name
+     * `resolver.response.responses(node) // -> 'listPetsResponses'`
+     */
+    responses(node: ast.OperationNode): string;
+  };
 };
 /**
  * Where the generated mock factories are written and how they are exported, plus the optional
@@ -173,7 +132,7 @@ type Options = OutputOptions & {
    * Override the naming of generated factory helpers. Common use: append `Mock` or
    * `Factory` so helpers do not clash with imported types.
    */
-  resolver?: Partial<ResolverFaker> & ThisType<ResolverFaker>;
+  resolver?: ResolverPatch<ResolverFaker>;
   /**
    * Macros applied to schema and operation nodes before printing.
    */
@@ -342,7 +301,7 @@ declare const pluginFaker: (options?: Options | undefined) => import("kubb/kit")
  * ```ts
  * import { resolverFaker } from '@kubb/plugin-faker'
  *
- * resolverFaker.default('list pets', 'function') // 'createListPets'
+ * resolverFaker.name('list pets') // 'createListPets'
  * ```
  */
 declare const resolverFaker: ResolverFaker;