@kubb/plugin-solid-query 3.10.10 → 3.10.11

package/dist/types-Cx6RgBxP.d.cts

@@ -0,0 +1,114 @@
+import { Output, Group, PluginFactoryOptions, ResolveNameParams } from '@kubb/core';
+import { Oas, contentType, Operation, HttpMethod } from '@kubb/oas';
+import { PluginClient } from '@kubb/plugin-client';
+import { Exclude, Include, Override, ResolvePathOptions, OperationSchemas, Generator } from '@kubb/plugin-oas';
+
+type TransformerProps = {
+    operation: Operation;
+    schemas: OperationSchemas;
+    casing: 'camelcase' | undefined;
+};
+type Transformer = (props: TransformerProps) => unknown[];
+/**
+ * Customize the queryKey
+ */
+type QueryKey = Transformer;
+type Query = {
+    /**
+     * Define which HttpMethods can be used for queries
+     * @default ['get']
+     */
+    methods: Array<HttpMethod>;
+    /**
+     * Path to the useQuery that will be used to do the useQuery functionality.
+     * It will be used as `import { useQuery } from '${importPath}'`.
+     * It allows both relative and absolute path.
+     * the path will be applied as is, so relative path should be based on the file being generated.
+     * @default '@tanstack/svelte-query'
+     */
+    importPath?: string;
+};
+type Options = {
+    /**
+     * Specify the export location for the files and define the behavior of the output
+     * @default { path: 'hooks', barrelType: 'named' }
+     */
+    output?: Output<Oas>;
+    /**
+     * Define which contentType should be used.
+     * By default, the first JSON valid mediaType will be used
+     */
+    contentType?: contentType;
+    /**
+     * Group the @tanstack/query hooks based on the provided name.
+     */
+    group?: Group;
+    client?: Pick<PluginClient['options'], 'dataReturnType' | 'importPath' | 'baseURL'>;
+    /**
+     * 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>>;
+    /**
+     * How to style your params, by default no casing is applied
+     * - 'camelcase' will use camelcase for the params names
+     */
+    paramsCasing?: 'camelcase';
+    /**
+     * 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?: PluginClient['options']['pathParamsType'];
+    queryKey?: QueryKey;
+    /**
+     * Override some useQuery behaviours.
+     */
+    query?: Partial<Query> | false;
+    /**
+     * Which parser should be used before returning the data to `@tanstack/query`.
+     * `'zod'` will use `@kubb/plugin-zod` to parse the data.
+     */
+    parser?: PluginClient['options']['parser'];
+    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 solid-query generators
+     */
+    generators?: Array<Generator<PluginSolidQuery>>;
+};
+type ResolvedOptions = {
+    output: Output<Oas>;
+    group: Options['group'];
+    client: Required<Omit<NonNullable<PluginSolidQuery['options']['client']>, 'baseURL'>> & {
+        baseURL?: string;
+    };
+    parser: Required<NonNullable<Options['parser']>>;
+    paramsCasing: Options['paramsCasing'];
+    paramsType: NonNullable<Options['paramsType']>;
+    pathParamsType: NonNullable<Options['pathParamsType']>;
+    queryKey: QueryKey | undefined;
+    query: NonNullable<Required<Query>> | false;
+};
+type PluginSolidQuery = PluginFactoryOptions<'plugin-solid-query', Options, ResolvedOptions, never, ResolvePathOptions>;
+
+export type { Options as O, PluginSolidQuery as P, Transformer as T };

package/dist/types-Cx6RgBxP.d.ts

@@ -0,0 +1,114 @@
+import { Output, Group, PluginFactoryOptions, ResolveNameParams } from '@kubb/core';
+import { Oas, contentType, Operation, HttpMethod } from '@kubb/oas';
+import { PluginClient } from '@kubb/plugin-client';
+import { Exclude, Include, Override, ResolvePathOptions, OperationSchemas, Generator } from '@kubb/plugin-oas';
+
+type TransformerProps = {
+    operation: Operation;
+    schemas: OperationSchemas;
+    casing: 'camelcase' | undefined;
+};
+type Transformer = (props: TransformerProps) => unknown[];
+/**
+ * Customize the queryKey
+ */
+type QueryKey = Transformer;
+type Query = {
+    /**
+     * Define which HttpMethods can be used for queries
+     * @default ['get']
+     */
+    methods: Array<HttpMethod>;
+    /**
+     * Path to the useQuery that will be used to do the useQuery functionality.
+     * It will be used as `import { useQuery } from '${importPath}'`.
+     * It allows both relative and absolute path.
+     * the path will be applied as is, so relative path should be based on the file being generated.
+     * @default '@tanstack/svelte-query'
+     */
+    importPath?: string;
+};
+type Options = {
+    /**
+     * Specify the export location for the files and define the behavior of the output
+     * @default { path: 'hooks', barrelType: 'named' }
+     */
+    output?: Output<Oas>;
+    /**
+     * Define which contentType should be used.
+     * By default, the first JSON valid mediaType will be used
+     */
+    contentType?: contentType;
+    /**
+     * Group the @tanstack/query hooks based on the provided name.
+     */
+    group?: Group;
+    client?: Pick<PluginClient['options'], 'dataReturnType' | 'importPath' | 'baseURL'>;
+    /**
+     * 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>>;
+    /**
+     * How to style your params, by default no casing is applied
+     * - 'camelcase' will use camelcase for the params names
+     */
+    paramsCasing?: 'camelcase';
+    /**
+     * 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?: PluginClient['options']['pathParamsType'];
+    queryKey?: QueryKey;
+    /**
+     * Override some useQuery behaviours.
+     */
+    query?: Partial<Query> | false;
+    /**
+     * Which parser should be used before returning the data to `@tanstack/query`.
+     * `'zod'` will use `@kubb/plugin-zod` to parse the data.
+     */
+    parser?: PluginClient['options']['parser'];
+    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 solid-query generators
+     */
+    generators?: Array<Generator<PluginSolidQuery>>;
+};
+type ResolvedOptions = {
+    output: Output<Oas>;
+    group: Options['group'];
+    client: Required<Omit<NonNullable<PluginSolidQuery['options']['client']>, 'baseURL'>> & {
+        baseURL?: string;
+    };
+    parser: Required<NonNullable<Options['parser']>>;
+    paramsCasing: Options['paramsCasing'];
+    paramsType: NonNullable<Options['paramsType']>;
+    pathParamsType: NonNullable<Options['pathParamsType']>;
+    queryKey: QueryKey | undefined;
+    query: NonNullable<Required<Query>> | false;
+};
+type PluginSolidQuery = PluginFactoryOptions<'plugin-solid-query', Options, ResolvedOptions, never, ResolvePathOptions>;
+
+export type { Options as O, PluginSolidQuery as P, Transformer as T };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/plugin-solid-query",
-  "version": "3.10.10",
+  "version": "3.10.11",
   "description": "Generator solid-query hooks",
   "keywords": [
     "faker",
@@ -62,21 +62,22 @@
     "!/**/__tests__/**"
   ],
   "dependencies": {
-    "remeda": "^2.21.3",
-    "@kubb/core": "3.10.10",
-    "@kubb/oas": "3.10.10",
-    "@kubb/plugin-oas": "3.10.10",
-    "@kubb/plugin-ts": "3.10.10",
-    "@kubb/plugin-zod": "3.10.10",
-    "@kubb/react": "3.10.10"
+    "remeda": "^2.21.4",
+    "@kubb/core": "3.10.11",
+    "@kubb/oas": "3.10.11",
+    "@kubb/plugin-client": "3.10.11",
+    "@kubb/plugin-oas": "3.10.11",
+    "@kubb/plugin-ts": "3.10.11",
+    "@kubb/plugin-zod": "3.10.11",
+    "@kubb/react": "3.10.11"
   },
   "devDependencies": {
     "@types/react": "^18.3.21",
     "react": "^18.3.1",
     "tsup": "^8.4.0",
     "typescript": "^5.8.3",
-    "@kubb/config-ts": "3.10.10",
-    "@kubb/config-tsup": "3.10.10"
+    "@kubb/config-ts": "3.10.11",
+    "@kubb/config-tsup": "3.10.11"
   },
   "peerDependencies": {
     "@kubb/react": "^3.0.0"

package/src/types.ts

@@ -1,9 +1,8 @@
 import type { Group, Output, PluginFactoryOptions, ResolveNameParams } from '@kubb/core'
 
-import type { HttpMethod, Oas, Operation, contentType } from '@kubb/oas'
+import type { contentType, HttpMethod, Oas, Operation } from '@kubb/oas'
 import type { PluginClient } from '@kubb/plugin-client'
 import type { Exclude, Generator, Include, OperationSchemas, Override, ResolvePathOptions } from '@kubb/plugin-oas'
-import type { PluginReactQuery } from '@kubb/plugin-react-query'
 
 type TransformerProps = {
   operation: Operation
@@ -107,7 +106,7 @@ export type Options = {
 type ResolvedOptions = {
   output: Output<Oas>
   group: Options['group']
-  client: Required<Omit<NonNullable<PluginReactQuery['options']['client']>, 'baseURL'>> & { baseURL?: string }
+  client: Required<Omit<NonNullable<PluginSolidQuery['options']['client']>, 'baseURL'>> & { baseURL?: string }
   parser: Required<NonNullable<Options['parser']>>
   paramsCasing: Options['paramsCasing']
   paramsType: NonNullable<Options['paramsType']>