@kubb/plugin-client 0.0.0-canary-20241104172400

package/dist/components.d.cts

@@ -0,0 +1,40 @@
+import { Operation } from '@kubb/oas';
+import { OperationSchemas } from '@kubb/plugin-oas';
+import { FunctionParams } from '@kubb/react';
+import { KubbNode } from '@kubb/react/types';
+import { P as PluginClient } from './types-DXab6SYO.cjs';
+import '@kubb/core';
+
+type Props = {
+    /**
+     * Name of the function
+     */
+    name: string;
+    isExportable?: boolean;
+    isIndexable?: boolean;
+    baseURL: string | undefined;
+    dataReturnType: PluginClient['resolvedOptions']['dataReturnType'];
+    paramsType: PluginClient['resolvedOptions']['pathParamsType'];
+    pathParamsType: PluginClient['resolvedOptions']['pathParamsType'];
+    parser: PluginClient['resolvedOptions']['parser'] | undefined;
+    typeSchemas: OperationSchemas;
+    zodSchemas: OperationSchemas | undefined;
+    operation: Operation;
+};
+type GetParamsProps = {
+    paramsType: PluginClient['resolvedOptions']['paramsType'];
+    pathParamsType: PluginClient['resolvedOptions']['pathParamsType'];
+    typeSchemas: OperationSchemas;
+};
+declare function Client({ name, isExportable, isIndexable, typeSchemas, baseURL, dataReturnType, parser, zodSchemas, paramsType, pathParamsType, operation, }: Props): KubbNode;
+declare namespace Client {
+    var getParams: ({ paramsType, pathParamsType, typeSchemas }: GetParamsProps) => FunctionParams;
+}
+
+type OperationsProps = {
+    name: string;
+    operations: Array<Operation>;
+};
+declare function Operations({ name, operations }: OperationsProps): JSX.Element;
+
+export { Client, Operations };

package/dist/components.d.ts

@@ -0,0 +1,40 @@
+import { Operation } from '@kubb/oas';
+import { OperationSchemas } from '@kubb/plugin-oas';
+import { FunctionParams } from '@kubb/react';
+import { KubbNode } from '@kubb/react/types';
+import { P as PluginClient } from './types-DXab6SYO.js';
+import '@kubb/core';
+
+type Props = {
+    /**
+     * Name of the function
+     */
+    name: string;
+    isExportable?: boolean;
+    isIndexable?: boolean;
+    baseURL: string | undefined;
+    dataReturnType: PluginClient['resolvedOptions']['dataReturnType'];
+    paramsType: PluginClient['resolvedOptions']['pathParamsType'];
+    pathParamsType: PluginClient['resolvedOptions']['pathParamsType'];
+    parser: PluginClient['resolvedOptions']['parser'] | undefined;
+    typeSchemas: OperationSchemas;
+    zodSchemas: OperationSchemas | undefined;
+    operation: Operation;
+};
+type GetParamsProps = {
+    paramsType: PluginClient['resolvedOptions']['paramsType'];
+    pathParamsType: PluginClient['resolvedOptions']['pathParamsType'];
+    typeSchemas: OperationSchemas;
+};
+declare function Client({ name, isExportable, isIndexable, typeSchemas, baseURL, dataReturnType, parser, zodSchemas, paramsType, pathParamsType, operation, }: Props): KubbNode;
+declare namespace Client {
+    var getParams: ({ paramsType, pathParamsType, typeSchemas }: GetParamsProps) => FunctionParams;
+}
+
+type OperationsProps = {
+    name: string;
+    operations: Array<Operation>;
+};
+declare function Operations({ name, operations }: OperationsProps): JSX.Element;
+
+export { Client, Operations };

package/dist/components.js

@@ -0,0 +1,3 @@
+export { Client, Operations } from './chunk-PHUXTZZT.js';
+//# sourceMappingURL=components.js.map
+//# sourceMappingURL=components.js.map

package/dist/components.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"components.js"}

package/dist/generators.cjs

@@ -0,0 +1,21 @@
+'use strict';
+
+var chunkIIY26RTZ_cjs = require('./chunk-IIY26RTZ.cjs');
+require('./chunk-UBMTYBLG.cjs');
+
+
+
+Object.defineProperty(exports, "clientGenerator", {
+  enumerable: true,
+  get: function () { return chunkIIY26RTZ_cjs.clientGenerator; }
+});
+Object.defineProperty(exports, "groupedClientGenerator", {
+  enumerable: true,
+  get: function () { return chunkIIY26RTZ_cjs.groupedClientGenerator; }
+});
+Object.defineProperty(exports, "operationsGenerator", {
+  enumerable: true,
+  get: function () { return chunkIIY26RTZ_cjs.operationsGenerator; }
+});
+//# sourceMappingURL=generators.cjs.map
+//# sourceMappingURL=generators.cjs.map

package/dist/generators.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"generators.cjs"}

package/dist/generators.d.cts

@@ -0,0 +1,11 @@
+import * as _kubb_plugin_oas from '@kubb/plugin-oas';
+import { P as PluginClient } from './types-DXab6SYO.cjs';
+import '@kubb/core';
+
+declare const clientGenerator: _kubb_plugin_oas.Generator<PluginClient>;
+
+declare const operationsGenerator: _kubb_plugin_oas.Generator<PluginClient>;
+
+declare const groupedClientGenerator: _kubb_plugin_oas.Generator<PluginClient>;
+
+export { clientGenerator, groupedClientGenerator, operationsGenerator };

package/dist/generators.d.ts

@@ -0,0 +1,11 @@
+import * as _kubb_plugin_oas from '@kubb/plugin-oas';
+import { P as PluginClient } from './types-DXab6SYO.js';
+import '@kubb/core';
+
+declare const clientGenerator: _kubb_plugin_oas.Generator<PluginClient>;
+
+declare const operationsGenerator: _kubb_plugin_oas.Generator<PluginClient>;
+
+declare const groupedClientGenerator: _kubb_plugin_oas.Generator<PluginClient>;
+
+export { clientGenerator, groupedClientGenerator, operationsGenerator };

package/dist/generators.js

@@ -0,0 +1,4 @@
+export { clientGenerator, groupedClientGenerator, operationsGenerator } from './chunk-I2NEG5CE.js';
+import './chunk-PHUXTZZT.js';
+//# sourceMappingURL=generators.js.map
+//# sourceMappingURL=generators.js.map

package/dist/generators.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"generators.js"}

package/dist/index.cjs

@@ -0,0 +1,17 @@
+'use strict';
+
+var chunkIIY26RTZ_cjs = require('./chunk-IIY26RTZ.cjs');
+require('./chunk-UBMTYBLG.cjs');
+
+
+
+Object.defineProperty(exports, "pluginClient", {
+  enumerable: true,
+  get: function () { return chunkIIY26RTZ_cjs.pluginClient; }
+});
+Object.defineProperty(exports, "pluginClientName", {
+  enumerable: true,
+  get: function () { return chunkIIY26RTZ_cjs.pluginClientName; }
+});
+//# sourceMappingURL=index.cjs.map
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.cjs"}

package/dist/index.d.cts

@@ -0,0 +1,8 @@
+import * as _kubb_core from '@kubb/core';
+import { O as Options, P as PluginClient } from './types-DXab6SYO.cjs';
+import '@kubb/plugin-oas';
+
+declare const pluginClientName = "plugin-client";
+declare const pluginClient: (options?: Options | undefined) => _kubb_core.UserPluginWithLifeCycle<PluginClient>;
+
+export { PluginClient, pluginClient, pluginClientName };

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+import * as _kubb_core from '@kubb/core';
+import { O as Options, P as PluginClient } from './types-DXab6SYO.js';
+import '@kubb/plugin-oas';
+
+declare const pluginClientName = "plugin-client";
+declare const pluginClient: (options?: Options | undefined) => _kubb_core.UserPluginWithLifeCycle<PluginClient>;
+
+export { PluginClient, pluginClient, pluginClientName };

package/dist/index.js

@@ -0,0 +1,4 @@
+export { pluginClient, pluginClientName } from './chunk-I2NEG5CE.js';
+import './chunk-PHUXTZZT.js';
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.js"}

package/dist/types-DXab6SYO.d.cts

@@ -0,0 +1,92 @@
+import { PluginFactoryOptions, Output, Group, ResolveNameParams } from '@kubb/core';
+import { ResolvePathOptions, Exclude, Include, Override, Generator } from '@kubb/plugin-oas';
+
+type Options = {
+    /**
+     * Specify the export location for the files and define the behavior of the output
+     * @default { path: 'clients', barrelType: 'named' }
+     */
+    output?: Output;
+    /**
+     * Group the clients based on the provided name.
+     */
+    group?: Group;
+    /**
+     * Array containing exclude parameters to exclude/skip tags/operations/methods/paths.
+     */
+    exclude?: Array<Exclude>;
+    /**
+     * Array containing include parameters to include tags/operations/methods/paths.
+     */
+    include?: Array<Include>;
+    /**
+     * Array containing override parameters to override `options` based on tags/operations/methods/paths.
+     */
+    override?: Array<Override<ResolvedOptions>>;
+    /**
+     * Create `operations.ts` file with all operations grouped by methods.
+     * @default false
+     */
+    operations?: boolean;
+    /**
+     * Path to the client import path that will be used to do the API calls.
+     * It will be used as `import client from '${client.importPath}'`.
+     * It allows both relative and absolute path but be aware that we will not change the path.
+     * @default '@kubb/plugin-client/client'
+     */
+    importPath?: string;
+    /**
+     * Allows you to set a custom base url for all generated calls.
+     */
+    baseURL?: string;
+    /**
+     * ReturnType that will be used when calling the client.
+     * - 'data' will return ResponseConfig[data].
+     * - 'full' will return ResponseConfig.
+     * @default 'data'
+     */
+    dataReturnType?: 'data' | 'full';
+    /**
+     * How to pass your params
+     * - 'object' will return the params and pathParams as an object.
+     * - 'inline' will return the params as comma separated params.
+     * @default 'inline'
+     */
+    paramsType?: 'object' | 'inline';
+    /**
+     * How to pass your pathParams.
+     * - 'object' will return the pathParams as an object.
+     * - 'inline' will return the pathParams as comma separated params.
+     * @default 'inline'
+     */
+    pathParamsType?: 'object' | 'inline';
+    /**
+     * Which parser can be used before returning the data
+     * - 'zod'  will use `@kubb/plugin-zod` to parse the data.
+     * @default 'client'
+     */
+    parser?: 'client' | 'zod';
+    transformers?: {
+        /**
+         * Customize the names based on the type that is provided by the plugin.
+         */
+        name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string;
+    };
+    /**
+     * Define some generators next to the client generators
+     */
+    generators?: Array<Generator<PluginClient>>;
+};
+type ResolvedOptions = {
+    output: Output;
+    group?: Options['group'];
+    baseURL: string | undefined;
+    parser: NonNullable<Options['parser']>;
+    importPath: NonNullable<Options['importPath']>;
+    dataReturnType: NonNullable<Options['dataReturnType']>;
+    pathParamsType: NonNullable<Options['pathParamsType']>;
+    paramsType: NonNullable<Options['paramsType']>;
+};
+type PluginClient = PluginFactoryOptions<'plugin-client', Options, ResolvedOptions, never, ResolvePathOptions>;
+
+export type { Options as O, PluginClient as P };

package/dist/types-DXab6SYO.d.ts

@@ -0,0 +1,92 @@
+import { PluginFactoryOptions, Output, Group, ResolveNameParams } from '@kubb/core';
+import { ResolvePathOptions, Exclude, Include, Override, Generator } from '@kubb/plugin-oas';
+
+type Options = {
+    /**
+     * Specify the export location for the files and define the behavior of the output
+     * @default { path: 'clients', barrelType: 'named' }
+     */
+    output?: Output;
+    /**
+     * Group the clients based on the provided name.
+     */
+    group?: Group;
+    /**
+     * Array containing exclude parameters to exclude/skip tags/operations/methods/paths.
+     */
+    exclude?: Array<Exclude>;
+    /**
+     * Array containing include parameters to include tags/operations/methods/paths.
+     */
+    include?: Array<Include>;
+    /**
+     * Array containing override parameters to override `options` based on tags/operations/methods/paths.
+     */
+    override?: Array<Override<ResolvedOptions>>;
+    /**
+     * Create `operations.ts` file with all operations grouped by methods.
+     * @default false
+     */
+    operations?: boolean;
+    /**
+     * Path to the client import path that will be used to do the API calls.
+     * It will be used as `import client from '${client.importPath}'`.
+     * It allows both relative and absolute path but be aware that we will not change the path.
+     * @default '@kubb/plugin-client/client'
+     */
+    importPath?: string;
+    /**
+     * Allows you to set a custom base url for all generated calls.
+     */
+    baseURL?: string;
+    /**
+     * ReturnType that will be used when calling the client.
+     * - 'data' will return ResponseConfig[data].
+     * - 'full' will return ResponseConfig.
+     * @default 'data'
+     */
+    dataReturnType?: 'data' | 'full';
+    /**
+     * How to pass your params
+     * - 'object' will return the params and pathParams as an object.
+     * - 'inline' will return the params as comma separated params.
+     * @default 'inline'
+     */
+    paramsType?: 'object' | 'inline';
+    /**
+     * How to pass your pathParams.
+     * - 'object' will return the pathParams as an object.
+     * - 'inline' will return the pathParams as comma separated params.
+     * @default 'inline'
+     */
+    pathParamsType?: 'object' | 'inline';
+    /**
+     * Which parser can be used before returning the data
+     * - 'zod'  will use `@kubb/plugin-zod` to parse the data.
+     * @default 'client'
+     */
+    parser?: 'client' | 'zod';
+    transformers?: {
+        /**
+         * Customize the names based on the type that is provided by the plugin.
+         */
+        name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string;
+    };
+    /**
+     * Define some generators next to the client generators
+     */
+    generators?: Array<Generator<PluginClient>>;
+};
+type ResolvedOptions = {
+    output: Output;
+    group?: Options['group'];
+    baseURL: string | undefined;
+    parser: NonNullable<Options['parser']>;
+    importPath: NonNullable<Options['importPath']>;
+    dataReturnType: NonNullable<Options['dataReturnType']>;
+    pathParamsType: NonNullable<Options['pathParamsType']>;
+    paramsType: NonNullable<Options['paramsType']>;
+};
+type PluginClient = PluginFactoryOptions<'plugin-client', Options, ResolvedOptions, never, ResolvePathOptions>;
+
+export type { Options as O, PluginClient as P };

package/package.json

@@ -0,0 +1,117 @@
+{
+  "name": "@kubb/plugin-client",
+  "version": "0.0.0-canary-20241104172400",
+  "description": "Generator plugin-client",
+  "keywords": [
+    "typescript",
+    "plugins",
+    "kubb",
+    "codegen",
+    "swagger",
+    "openapi",
+    "axios"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/kubb-labs/kubb.git",
+    "directory": "packages/plugin-client"
+  },
+  "license": "MIT",
+  "author": "Stijn Van Hulle <stijn@stijnvanhulle.be",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs",
+      "default": "./dist/index.cjs"
+    },
+    "./generators": {
+      "import": "./dist/generators.js",
+      "require": "./dist/generators.cjs",
+      "default": "./dist/generators.cjs"
+    },
+    "./components": {
+      "import": "./dist/components.js",
+      "require": "./dist/components.cjs",
+      "default": "./dist/components.cjs"
+    },
+    "./client": {
+      "import": "./dist/client.js",
+      "require": "./dist/client.cjs",
+      "default": "./dist/client.cjs"
+    },
+    "./ts-client": {
+      "import": "./client.ts",
+      "require": "./client.ts",
+      "default": "./client.ts"
+    },
+    "./package.json": "./package.json",
+    "./*": "./*"
+  },
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "./dist/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "components": [
+        "./dist/components.d.ts"
+      ],
+      "generators": [
+        "./dist/generators.d.ts"
+      ]
+    }
+  },
+  "files": [
+    "src",
+    "dist",
+    "client.ts",
+    "*.d.ts",
+    "*.d.cts",
+    "!/**/**.test.**",
+    "!/**/__tests__/**"
+  ],
+  "dependencies": {
+    "@kubb/core": "0.0.0-canary-20241104172400",
+    "@kubb/fs": "0.0.0-canary-20241104172400",
+    "@kubb/oas": "0.0.0-canary-20241104172400",
+    "@kubb/plugin-oas": "0.0.0-canary-20241104172400",
+    "@kubb/plugin-ts": "0.0.0-canary-20241104172400",
+    "@kubb/plugin-zod": "0.0.0-canary-20241104172400",
+    "@kubb/react": "0.0.0-canary-20241104172400"
+  },
+  "devDependencies": {
+    "axios": "^1.7.7",
+    "tsup": "^8.3.5",
+    "typescript": "^5.6.3",
+    "@kubb/config-ts": "0.0.0-canary-20241104172400",
+    "@kubb/config-tsup": "0.0.0-canary-20241104172400"
+  },
+  "peerDependencies": {
+    "axios": "^1.7.2",
+    "@kubb/react": "0.0.0-canary-20241104172400"
+  },
+  "peerDependenciesMeta": {
+    "axios": {
+      "optional": true
+    }
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "tsup",
+    "clean": "npx rimraf ./dist",
+    "lint": "bun biome lint .",
+    "lint:fix": "bun biome lint --apply-unsafe .",
+    "release": "pnpm publish --no-git-check",
+    "release:canary": "bash ../../.github/canary.sh && node ../../scripts/build.js canary && pnpm publish --no-git-check",
+    "start": "tsup --watch",
+    "test": "vitest --passWithNoTests",
+    "typecheck": "tsc -p ./tsconfig.json --noEmit --emitDeclarationOnly false"
+  }
+}