这是indexloc提供的服务，不要输入任何密码
Skip to content

refactor: remove selectors from client plugins #2880

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

Merged
merged 2 commits into from
Oct 29, 2025
Merged

refactor: remove selectors from client plugins #2880

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5942324
refactor: remove selectors from client plugins
mrlubos Oct 29, 2025
74a37d3
test: fix snapshots
mrlubos Oct 29, 2025
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
25 changes: 3 additions & 22 deletions packages/custom-client/src/plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import type { Selector } from '@hey-api/codegen-core';
import {
type Client,
clientDefaultConfig,
Expand All @@ -8,25 +7,9 @@ import {
definePluginConfig,
} from '@hey-api/openapi-ts';

type SelectorType = 'client';
export type IApi = any;

export type IApi = {
/**
* @param type Selector type.
* @param value Depends on `type`:
* - `client`: never
* @returns Selector array
*/
selector: (type: SelectorType, value?: string) => Selector;
};

export class Api implements IApi {
constructor(public meta: Pick<Config, 'name'>) {}

selector(...args: ReadonlyArray<string | undefined>): Selector {
return [this.meta.name, ...(args as Selector)];
}
}
export class Api implements IApi {}

export type Config = Client.Config & {
/**
Expand All @@ -39,9 +22,7 @@ export type CustomClientPlugin = DefinePlugin<Config, Config, IApi>;

export const defaultConfig: CustomClientPlugin['Config'] = {
...clientDefaultMeta,
api: new Api({
name: '@hey-api/custom-client',
}),
api: new Api(),
config: {
...clientDefaultConfig,
bundle: false,
Expand Down
25 changes: 3 additions & 22 deletions ...-ts-tests/main/test/__snapshots__/3.1.x/clients/my-client/base-url-false/client/plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import type { Selector } from '@hey-api/codegen-core';
import {
type Client,
clientDefaultConfig,
Expand All @@ -8,25 +7,9 @@ import {
definePluginConfig,
} from '@hey-api/openapi-ts';

type SelectorType = 'client';
export type IApi = any;

export type IApi = {
/**
* @param type Selector type.
* @param value Depends on `type`:
* - `client`: never
* @returns Selector array
*/
selector: (type: SelectorType, value?: string) => Selector;
};

export class Api implements IApi {
constructor(public meta: Pick<Config, 'name'>) {}

selector(...args: ReadonlyArray<string | undefined>): Selector {
return [this.meta.name, ...(args as Selector)];
}
}
export class Api implements IApi {}

export type Config = Client.Config & {
/**
Expand All @@ -39,9 +22,7 @@ export type MyClientPlugin = DefinePlugin<Config, Config, IApi>;

export const defaultConfig: MyClientPlugin['Config'] = {
...clientDefaultMeta,
api: new Api({
name: __filename,
}),
api: new Api(),
config: clientDefaultConfig,
handler: clientPluginHandler,
name: __filename,
Expand Down
25 changes: 3 additions & 22 deletions ...ts-tests/main/test/__snapshots__/3.1.x/clients/my-client/base-url-number/client/plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import type { Selector } from '@hey-api/codegen-core';
import {
type Client,
clientDefaultConfig,
Expand All @@ -8,25 +7,9 @@ import {
definePluginConfig,
} from '@hey-api/openapi-ts';

type SelectorType = 'client';
export type IApi = any;

export type IApi = {
/**
* @param type Selector type.
* @param value Depends on `type`:
* - `client`: never
* @returns Selector array
*/
selector: (type: SelectorType, value?: string) => Selector;
};

export class Api implements IApi {
constructor(public meta: Pick<Config, 'name'>) {}

selector(...args: ReadonlyArray<string | undefined>): Selector {
return [this.meta.name, ...(args as Selector)];
}
}
export class Api implements IApi {}

export type Config = Client.Config & {
/**
Expand All @@ -39,9 +22,7 @@ export type MyClientPlugin = DefinePlugin<Config, Config, IApi>;

export const defaultConfig: MyClientPlugin['Config'] = {
...clientDefaultMeta,
api: new Api({
name: __filename,
}),
api: new Api(),
config: clientDefaultConfig,
handler: clientPluginHandler,
name: __filename,
Expand Down
25 changes: 3 additions & 22 deletions ...ts-tests/main/test/__snapshots__/3.1.x/clients/my-client/base-url-strict/client/plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import type { Selector } from '@hey-api/codegen-core';
import {
type Client,
clientDefaultConfig,
Expand All @@ -8,25 +7,9 @@ import {
definePluginConfig,
} from '@hey-api/openapi-ts';

type SelectorType = 'client';
export type IApi = any;

export type IApi = {
/**
* @param type Selector type.
* @param value Depends on `type`:
* - `client`: never
* @returns Selector array
*/
selector: (type: SelectorType, value?: string) => Selector;
};

export class Api implements IApi {
constructor(public meta: Pick<Config, 'name'>) {}

selector(...args: ReadonlyArray<string | undefined>): Selector {
return [this.meta.name, ...(args as Selector)];
}
}
export class Api implements IApi {}

export type Config = Client.Config & {
/**
Expand All @@ -39,9 +22,7 @@ export type MyClientPlugin = DefinePlugin<Config, Config, IApi>;

export const defaultConfig: MyClientPlugin['Config'] = {
...clientDefaultMeta,
api: new Api({
name: __filename,
}),
api: new Api(),
config: clientDefaultConfig,
handler: clientPluginHandler,
name: __filename,
Expand Down
25 changes: 3 additions & 22 deletions ...ts-tests/main/test/__snapshots__/3.1.x/clients/my-client/base-url-string/client/plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import type { Selector } from '@hey-api/codegen-core';
import {
type Client,
clientDefaultConfig,
Expand All @@ -8,25 +7,9 @@ import {
definePluginConfig,
} from '@hey-api/openapi-ts';

type SelectorType = 'client';
export type IApi = any;

export type IApi = {
/**
* @param type Selector type.
* @param value Depends on `type`:
* - `client`: never
* @returns Selector array
*/
selector: (type: SelectorType, value?: string) => Selector;
};

export class Api implements IApi {
constructor(public meta: Pick<Config, 'name'>) {}

selector(...args: ReadonlyArray<string | undefined>): Selector {
return [this.meta.name, ...(args as Selector)];
}
}
export class Api implements IApi {}

export type Config = Client.Config & {
/**
Expand All @@ -39,9 +22,7 @@ export type MyClientPlugin = DefinePlugin<Config, Config, IApi>;

export const defaultConfig: MyClientPlugin['Config'] = {
...clientDefaultMeta,
api: new Api({
name: __filename,
}),
api: new Api(),
config: clientDefaultConfig,
handler: clientPluginHandler,
name: __filename,
Expand Down
25 changes: 3 additions & 22 deletions .../openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/my-client/bundle/client/plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import type { Selector } from '@hey-api/codegen-core';
import {
type Client,
clientDefaultConfig,
Expand All @@ -8,25 +7,9 @@ import {
definePluginConfig,
} from '@hey-api/openapi-ts';

type SelectorType = 'client';
export type IApi = any;

export type IApi = {
/**
* @param type Selector type.
* @param value Depends on `type`:
* - `client`: never
* @returns Selector array
*/
selector: (type: SelectorType, value?: string) => Selector;
};

export class Api implements IApi {
constructor(public meta: Pick<Config, 'name'>) {}

selector(...args: ReadonlyArray<string | undefined>): Selector {
return [this.meta.name, ...(args as Selector)];
}
}
export class Api implements IApi {}

export type Config = Client.Config & {
/**
Expand All @@ -39,9 +22,7 @@ export type MyClientPlugin = DefinePlugin<Config, Config, IApi>;

export const defaultConfig: MyClientPlugin['Config'] = {
...clientDefaultMeta,
api: new Api({
name: __filename,
}),
api: new Api(),
config: clientDefaultConfig,
handler: clientPluginHandler,
name: __filename,
Expand Down
25 changes: 3 additions & 22 deletions ...openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/my-client/default/client/plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import type { Selector } from '@hey-api/codegen-core';
import {
type Client,
clientDefaultConfig,
Expand All @@ -8,25 +7,9 @@ import {
definePluginConfig,
} from '@hey-api/openapi-ts';

type SelectorType = 'client';
export type IApi = any;

export type IApi = {
/**
* @param type Selector type.
* @param value Depends on `type`:
* - `client`: never
* @returns Selector array
*/
selector: (type: SelectorType, value?: string) => Selector;
};

export class Api implements IApi {
constructor(public meta: Pick<Config, 'name'>) {}

selector(...args: ReadonlyArray<string | undefined>): Selector {
return [this.meta.name, ...(args as Selector)];
}
}
export class Api implements IApi {}

export type Config = Client.Config & {
/**
Expand All @@ -39,9 +22,7 @@ export type MyClientPlugin = DefinePlugin<Config, Config, IApi>;

export const defaultConfig: MyClientPlugin['Config'] = {
...clientDefaultMeta,
api: new Api({
name: __filename,
}),
api: new Api(),
config: clientDefaultConfig,
handler: clientPluginHandler,
name: __filename,
Expand Down
25 changes: 3 additions & 22 deletions ...ests/main/test/__snapshots__/3.1.x/clients/my-client/sdk-client-optional/client/plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import type { Selector } from '@hey-api/codegen-core';
import {
type Client,
clientDefaultConfig,
Expand All @@ -8,25 +7,9 @@ import {
definePluginConfig,
} from '@hey-api/openapi-ts';

type SelectorType = 'client';
export type IApi = any;

export type IApi = {
/**
* @param type Selector type.
* @param value Depends on `type`:
* - `client`: never
* @returns Selector array
*/
selector: (type: SelectorType, value?: string) => Selector;
};

export class Api implements IApi {
constructor(public meta: Pick<Config, 'name'>) {}

selector(...args: ReadonlyArray<string | undefined>): Selector {
return [this.meta.name, ...(args as Selector)];
}
}
export class Api implements IApi {}

export type Config = Client.Config & {
/**
Expand All @@ -39,9 +22,7 @@ export type MyClientPlugin = DefinePlugin<Config, Config, IApi>;

export const defaultConfig: MyClientPlugin['Config'] = {
...clientDefaultMeta,
api: new Api({
name: __filename,
}),
api: new Api(),
config: clientDefaultConfig,
handler: clientPluginHandler,
name: __filename,
Expand Down
25 changes: 3 additions & 22 deletions ...ests/main/test/__snapshots__/3.1.x/clients/my-client/sdk-client-required/client/plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import type { Selector } from '@hey-api/codegen-core';
import {
type Client,
clientDefaultConfig,
Expand All @@ -8,25 +7,9 @@ import {
definePluginConfig,
} from '@hey-api/openapi-ts';

type SelectorType = 'client';
export type IApi = any;

export type IApi = {
/**
* @param type Selector type.
* @param value Depends on `type`:
* - `client`: never
* @returns Selector array
*/
selector: (type: SelectorType, value?: string) => Selector;
};

export class Api implements IApi {
constructor(public meta: Pick<Config, 'name'>) {}

selector(...args: ReadonlyArray<string | undefined>): Selector {
return [this.meta.name, ...(args as Selector)];
}
}
export class Api implements IApi {}

export type Config = Client.Config & {
/**
Expand All @@ -39,9 +22,7 @@ export type MyClientPlugin = DefinePlugin<Config, Config, IApi>;

export const defaultConfig: MyClientPlugin['Config'] = {
...clientDefaultMeta,
api: new Api({
name: __filename,
}),
api: new Api(),
config: clientDefaultConfig,
handler: clientPluginHandler,
name: __filename,
Expand Down
Loading
Loading