Skip to content

Technical/fix tanstack types #74

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vitrivdolkom wants to merge 3 commits into
base: release/apicraft/1.12.0
Choose a base branch
from
Open

Technical/fix tanstack types #74

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c356aa9
release/1.12.0 🚀 fix class baseUrl, response regexp
Jun 24, 2026
a7dc79e
release/1.12.0 🚀 add class tanstack fixed types
Jun 27, 2026
ce70128
technical/fix-tanstack-types 🚀 fixes
Jun 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/apicraft/apicraft.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ const apicraftConfig = apicraft([
{
input: 'example-apiV1.yaml',
output: 'generated/axios-class-runtime',
instance: { name: 'axios', runtimeInstancePath: './src/instance' },
instance: { name: 'axios' },
baseUrl: '/api',
nameBy: 'path',
groupBy: 'class',
Expand Down
18 changes: 16 additions & 2 deletions packages/apicraft/bin/plugins/axios/class/plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import {
getImportRuntimeInstance,
getImportRuntimeResponseType,
getImportTypes,
getRequestErrorTypeName,
getRequestInfo,
getRequestParamsType,
getRequestReturnType,
Expand Down Expand Up @@ -50,7 +51,7 @@ export const classHandler: AxiosPlugin['Handler'] = ({ plugin }) => {

const requestResponseTypeName = `${capitalize(request.id)}Response`;
if (requestInfo.hasSuccessResponse) typeImportNames.add(requestResponseTypeName);
const requestErrorTypeName = `${capitalize(request.id)}Error`;
const requestErrorTypeName = getRequestErrorTypeName(request.id);
if (requestInfo.hasErrorResponse) typeImportNames.add(requestErrorTypeName);

const requestParamsTypeName = `${capitalize(requestName)}RequestParams`;
Expand Down Expand Up @@ -191,7 +192,20 @@ export const classHandler: AxiosPlugin['Handler'] = ({ plugin }) => {
ts.factory.createIdentifier('create')
),
undefined,
!plugin.config.runtimeInstancePath ? [ts.factory.createIdentifier('config')] : []
plugin.config.baseUrl
? [
ts.factory.createObjectLiteralExpression(
[
ts.factory.createPropertyAssignment(
ts.factory.createIdentifier('baseURL'),
ts.factory.createStringLiteral(plugin.config.baseUrl)
),
ts.factory.createSpreadAssignment(ts.factory.createIdentifier('config'))
],
false
)
]
: [ts.factory.createIdentifier('config')]
)
)
)
Expand Down
3 changes: 2 additions & 1 deletion packages/apicraft/bin/plugins/axios/composed/plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import {
getImportInstance,
getImportRuntimeResponseType,
getImportTypes,
getRequestErrorTypeName,
getRequestFilePath,
getRequestInfo,
getRequestParamsType,
Expand Down Expand Up @@ -49,7 +50,7 @@ export const composedHandler: AxiosPlugin['Handler'] = ({ plugin }) => {
const requestParamsTypeName = `${capitalize(requestName)}RequestParams`;
const requestDataTypeName = `${capitalize(request.id)}Data`;
const requestResponseTypeName = `${capitalize(request.id)}Response`;
const requestErrorTypeName = `${capitalize(request.id)}Error`;
const requestErrorTypeName = getRequestErrorTypeName(request.id);

const requestFolderPath = nodePath.dirname(
`${plugin.config.generateOutput}/${requestFilePath}`
Expand Down
3 changes: 2 additions & 1 deletion packages/apicraft/bin/plugins/axios/standalone/plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import {
getImportInstance,
getImportRuntimeResponseType,
getImportTypes,
getRequestErrorTypeName,
getRequestInfo,
getRequestParamsType,
getRequestReturnType,
Expand Down Expand Up @@ -51,7 +52,7 @@ export const standaloneHandler: AxiosPlugin['Handler'] = ({ plugin }) => {

const requestResponseTypeName = `${capitalize(request.id)}Response`;
if (requestInfo.hasSuccessResponse) typeImportNames.add(requestResponseTypeName);
const requestErrorTypeName = `${capitalize(request.id)}Error`;
const requestErrorTypeName = getRequestErrorTypeName(request.id);
if (requestInfo.hasErrorResponse) typeImportNames.add(requestErrorTypeName);

const requestParamsTypeName = `${capitalize(requestName)}RequestParams`;
Expand Down
18 changes: 16 additions & 2 deletions packages/apicraft/bin/plugins/fetches/class/plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import {
getImportRuntimeInstance,
getImportRuntimeResponseType,
getImportTypes,
getRequestErrorTypeName,
getRequestInfo,
getRequestParamsType,
getRequestReturnType,
Expand Down Expand Up @@ -49,7 +50,7 @@ export const classHandler: FetchesPlugin['Handler'] = ({ plugin }) => {

const requestResponseTypeName = `${capitalize(request.id)}Response`;
if (requestInfo.hasSuccessResponse) typeImportNames.add(requestResponseTypeName);
const requestErrorTypeName = `${capitalize(request.id)}Error`;
const requestErrorTypeName = getRequestErrorTypeName(request.id);
if (requestInfo.hasErrorResponse) typeImportNames.add(requestErrorTypeName);

const requestParamsTypeName = `${capitalize(requestName)}RequestParams`;
Expand Down Expand Up @@ -190,7 +191,20 @@ export const classHandler: FetchesPlugin['Handler'] = ({ plugin }) => {
ts.factory.createIdentifier('create')
),
undefined,
!plugin.config.runtimeInstancePath ? [ts.factory.createIdentifier('config')] : []
plugin.config.baseUrl
? [
ts.factory.createObjectLiteralExpression(
[
ts.factory.createPropertyAssignment(
ts.factory.createIdentifier('baseURL'),
ts.factory.createStringLiteral(plugin.config.baseUrl)
),
ts.factory.createSpreadAssignment(ts.factory.createIdentifier('config'))
],
false
)
]
: [ts.factory.createIdentifier('config')]
)
)
)
Expand Down
3 changes: 2 additions & 1 deletion packages/apicraft/bin/plugins/fetches/composed/plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import {
getImportInstance,
getImportRuntimeResponseType,
getImportTypes,
getRequestErrorTypeName,
getRequestFilePath,
getRequestInfo,
getRequestParamsType,
Expand Down Expand Up @@ -49,7 +50,7 @@ export const composedHandler: FetchesPlugin['Handler'] = ({ plugin }) => {
const requestParamsTypeName = `${capitalize(requestName)}RequestParams`;
const requestDataTypeName = `${capitalize(request.id)}Data`;
const requestResponseTypeName = `${capitalize(request.id)}Response`;
const requestErrorTypeName = `${capitalize(request.id)}Error`;
const requestErrorTypeName = getRequestErrorTypeName(request.id);

const requestFolderPath = nodePath.dirname(
`${plugin.config.generateOutput}/${requestFilePath}`
Expand Down
3 changes: 2 additions & 1 deletion packages/apicraft/bin/plugins/fetches/standalone/plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import {
getImportInstance,
getImportRuntimeResponseType,
getImportTypes,
getRequestErrorTypeName,
getRequestInfo,
getRequestParamsType,
getRequestReturnType,
Expand Down Expand Up @@ -51,7 +52,7 @@ export const standaloneHandler: FetchesPlugin['Handler'] = ({ plugin }) => {

const requestResponseTypeName = `${capitalize(request.id)}Response`;
if (requestInfo.hasSuccessResponse) typeImportNames.add(requestResponseTypeName);
const requestErrorTypeName = `${capitalize(request.id)}Error`;
const requestErrorTypeName = getRequestErrorTypeName(request.id);
if (requestInfo.hasErrorResponse) typeImportNames.add(requestErrorTypeName);

const requestParamsTypeName = `${capitalize(requestName)}RequestParams`;
Expand Down
3 changes: 3 additions & 0 deletions packages/apicraft/bin/plugins/helpers/getRequestErrorTypeName.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import { capitalize } from './capitalize';

export const getRequestErrorTypeName = (requestId: string) => `${capitalize(requestId)}Error`;

@vitrivdolkom vitrivdolkom Jun 29, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

миллион раз нужно получить нейминг для типа ошибка, вынес в функцию

4 changes: 2 additions & 2 deletions packages/apicraft/bin/plugins/helpers/getRequestResponseInfo.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,14 @@ export const getRequestResponseInfo = (request: IR.OperationObject) => {

if (
Object.entries(responses).some(
([code, response]) => /2\d{2}/.test(code) && !isUnknownSchema(response?.schema)
([code, response]) => /^2.*$/.test(code) && !isUnknownSchema(response?.schema)
)
) {
result.hasSuccessResponse = true;
}
if (
Object.entries(responses).some(
([code, response]) => /[45].*/.test(code) && !isUnknownSchema(response?.schema)
([code, response]) => /^[45].*$/.test(code) && !isUnknownSchema(response?.schema)

@vitrivdolkom vitrivdolkom Jun 29, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

это фикс что errors неверно определялось на узб коллекторе. В общем регулярки не верные были

)
) {
result.hasErrorResponse = true;
Expand Down
1 change: 1 addition & 0 deletions packages/apicraft/bin/plugins/helpers/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ export * from './buildRequestParamsPath';
export * from './capitalize';
export * from './getRelativePath';
export * from './getRequestCallGenericResponse';
export * from './getRequestErrorTypeName';
export * from './getRequestFilePath';
export * from './getRequestInfo';
export * from './getRequestParamsType';
Expand Down
18 changes: 15 additions & 3 deletions packages/apicraft/bin/plugins/ofetch/class/plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import {
getImportRuntimeInstance,
getImportRuntimeResponseType,
getImportTypes,
getRequestErrorTypeName,
getRequestInfo,
getRequestParamsType,
getRequestReturnType,
Expand Down Expand Up @@ -51,7 +52,7 @@ export const classHandler: OFetchPlugin['Handler'] = ({ plugin }) => {

const requestResponseTypeName = `${capitalize(request.id)}Response`;
if (requestInfo.hasSuccessResponse) typeImportNames.add(requestResponseTypeName);
const requestErrorTypeName = `${capitalize(request.id)}Error`;
const requestErrorTypeName = getRequestErrorTypeName(request.id);
if (requestInfo.hasErrorResponse) typeImportNames.add(requestErrorTypeName);

const requestParamsTypeName = `${capitalize(requestName)}RequestParams`;
Expand Down Expand Up @@ -174,15 +175,26 @@ export const classHandler: OFetchPlugin['Handler'] = ({ plugin }) => {
ts.factory.createIdentifier('create')
),
undefined,
!plugin.config.runtimeInstancePath
plugin.config.baseUrl

@vitrivdolkom vitrivdolkom Jun 29, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

для классов добавил прокидывание baseUrl

? [
ts.factory.createObjectLiteralExpression(
[
ts.factory.createPropertyAssignment(
ts.factory.createIdentifier('baseURL'),
ts.factory.createStringLiteral(plugin.config.baseUrl)
),
ts.factory.createSpreadAssignment(ts.factory.createIdentifier('config'))
],
false
)
]
: [
ts.factory.createBinaryExpression(
ts.factory.createIdentifier('config'),
ts.factory.createToken(ts.SyntaxKind.QuestionQuestionToken),
ts.factory.createObjectLiteralExpression([], false)
)
]
: []
)
)
)
Expand Down
3 changes: 2 additions & 1 deletion packages/apicraft/bin/plugins/ofetch/composed/plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import {
getImportInstance,
getImportRuntimeResponseType,
getImportTypes,
getRequestErrorTypeName,
getRequestFilePath,
getRequestInfo,
getRequestParamsType,
Expand Down Expand Up @@ -49,7 +50,7 @@ export const composedHandler: OFetchPlugin['Handler'] = ({ plugin }) => {
const requestParamsTypeName = `${capitalize(requestName)}RequestParams`;
const requestDataTypeName = `${capitalize(request.id)}Data`;
const requestResponseTypeName = `${capitalize(request.id)}Response`;
const requestErrorTypeName = `${capitalize(request.id)}Error`;
const requestErrorTypeName = getRequestErrorTypeName(request.id);

const requestFolderPath = nodePath.dirname(
`${plugin.config.generateOutput}/${requestFilePath}`
Expand Down
3 changes: 2 additions & 1 deletion packages/apicraft/bin/plugins/ofetch/standalone/plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import {
getImportInstance,
getImportRuntimeResponseType,
getImportTypes,
getRequestErrorTypeName,
getRequestInfo,
getRequestParamsType,
getRequestReturnType,
Expand Down Expand Up @@ -51,7 +52,7 @@ export const standaloneHandler: OFetchPlugin['Handler'] = ({ plugin }) => {

const requestResponseTypeName = `${capitalize(request.id)}Response`;
if (requestInfo.hasSuccessResponse) typeImportNames.add(requestResponseTypeName);
const requestErrorTypeName = `${capitalize(request.id)}Error`;
const requestErrorTypeName = getRequestErrorTypeName(request.id);
if (requestInfo.hasErrorResponse) typeImportNames.add(requestErrorTypeName);

const requestParamsTypeName = `${capitalize(requestName)}RequestParams`;
Expand Down
86 changes: 64 additions & 22 deletions packages/apicraft/bin/plugins/tanstack/class/plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,57 +1,68 @@
import type ts from 'typescript';

import nodePath from 'node:path';

import {
capitalize,
generateRequestName,
getApicraftTypeImport,
getImportInstance
getImportInstance,
getImportTypes,
getRequestErrorTypeName,
getRequestInfo
} from '@/bin/plugins/helpers';

import type { TanstackPlugin } from '../types';

import { getMutationHook, getQueryHook, getSuspenseQueryHook, getTanstackImport } from '../helpers';
import {
getHookDataType,
getMutationHook,
getQueryHook,
getSuspenseQueryHook,
getTanstackImport,
getTanstackTypeImport
} from '../helpers';

const DEFAULT_REQUEST_ERROR_TYPE_NAME = 'DefaultError';

export const classHandler: TanstackPlugin['Handler'] = ({ plugin }) => {
const hooksFile = plugin.createFile({
id: 'hooks',
path: `${plugin.output}/hooks`
});

const imports: ts.ImportDeclaration[] = [
// import { useQuery, useMutation, queryOptions, useSuspenseQuery } from '@tanstack/react-query';
getTanstackImport(['useQuery', 'useMutation', 'queryOptions', 'useSuspenseQuery']),
// import type { TanstackQuerySettings, TanstackMutationSettings, TanstackSuspenseQuerySettings } from '@siberiacancode/apicraft';
getApicraftTypeImport([
'TanstackQuerySettings',
'TanstackMutationSettings',
'TanstackSuspenseQuerySettings'
]),
// import { instance } from '../../instance.gen';
getImportInstance({
output: plugin.output,
folderPath: plugin.config.generateOutput,
generateOutput: plugin.config.generateOutput
})
];

const hooks: ts.VariableStatement[] = [];
const hooks: ts.Statement[] = [];
const requestErrorTypeNames: string[] = [];
let hasDefaultError = false;

plugin.forEach('operation', (event) => {
const request = event.operation;
const requestName = generateRequestName(request, plugin.config.nameBy);
const requestInfo = getRequestInfo(request);

let requestErrorTypeName = DEFAULT_REQUEST_ERROR_TYPE_NAME;
if (requestInfo.hasErrorResponse) {
requestErrorTypeName = getRequestErrorTypeName(request.id);
requestErrorTypeNames.push(requestErrorTypeName);
} else {
hasDefaultError = true;
}

hooks.push(getHookDataType({ requestName, plugin }));
hooks.push(
...getQueryHook({
hookName: `use${capitalize(requestName)}Query`,
optionsFunctionName: `${requestName}QueryOptions`,
requestErrorTypeName,
plugin,
request,
requestInfo,
requestName
})
);
hooks.push(
...getMutationHook({
hookName: `use${capitalize(requestName)}Mutation`,
requestErrorTypeName,
plugin,
requestName
})
Expand All @@ -60,13 +71,44 @@ export const classHandler: TanstackPlugin['Handler'] = ({ plugin }) => {
...getSuspenseQueryHook({
hookName: `use${capitalize(requestName)}SuspenseQuery`,
optionsFunctionName: `${requestName}SuspenseQueryOptions`,
requestErrorTypeName,
plugin,
request,
requestInfo,
requestName
})
);
});

const hooksFilePath = nodePath.normalize(`${plugin.output}/hooks`);
const hooksFolderPath = nodePath.dirname(`${plugin.config.generateOutput}/${hooksFilePath}`);
const imports: ts.ImportDeclaration[] = [
// import type { UseSuspenseQueryOptions, UseQueryOptions, UseMutationOptions, DefaultError } from '@tanstack/react-query';
getTanstackTypeImport([
...['UseSuspenseQueryOptions', 'UseQueryOptions', 'UseMutationOptions'],
...(hasDefaultError ? [DEFAULT_REQUEST_ERROR_TYPE_NAME] : [])
]),
// import type { UnwrapPromise } from '@siberiacancode/apicraft';
getApicraftTypeImport(['UnwrapPromise']),
// import { useQuery, useMutation, queryOptions, useSuspenseQuery } from '@tanstack/react-query';
getTanstackImport(['useQuery', 'useMutation', 'queryOptions', 'useSuspenseQuery']),
// import type { Type } from 'generated/types.gen';
...(requestErrorTypeNames.length
? [
getImportTypes({
folderPath: hooksFolderPath,
generateOutput: plugin.config.generateOutput,
typeNames: requestErrorTypeNames
})
]
: []),
// import { instance } from '../../instance.gen';
getImportInstance({
output: plugin.output,
folderPath: plugin.config.generateOutput,
generateOutput: plugin.config.generateOutput
})
];

hooksFile.add(...imports);
hooksFile.add(...hooks);
};
Loading