Skip to content

fix: update PluginApiClient URL construction for project context #1

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
pikann merged 1 commit into from
May 18, 2026
Merged

fix: update PluginApiClient URL construction for project context #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 8 additions & 6 deletions src/api-client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,13 @@ export interface PluginApiClientOptions {

/**
* PluginApiClient provides typed methods for common Paca API calls.
* Plugin route calls are automatically prefixed with
* `/plugins/{pluginId}/projects/{projectId}/`.
* Plugin route calls are prefixed with `/plugins/{pluginId}/`.
* Use the `projectId` property to include project context in paths when needed:
* `pluginGet(id, \`/projects/${api.projectId}/my-resource\`)`
*/
export class PluginApiClient {
private readonly baseUrl: string;
private readonly projectId: string;
public readonly projectId: string;
private readonly _fetch: PluginApiClientOptions["fetch"];

constructor(opts: PluginApiClientOptions) {
Expand Down Expand Up @@ -96,8 +97,9 @@ export class PluginApiClient {

/**
* Call a GET route registered by this plugin.
* The URL is built as:
* `{baseUrl}/plugins/{pluginId}/projects/{projectId}/{path}`
* The URL is built as `{baseUrl}/plugins/{pluginId}{path}`.
* For project-scoped routes, include the project prefix in `path`:
* `pluginGet(id, \`/projects/${api.projectId}/resource\`)`
*/
async pluginGet<T>(pluginId: string, path: string): Promise<T> {
return this._get<T>(this._pluginUrl(pluginId, path));
Expand Down Expand Up @@ -140,7 +142,7 @@ export class PluginApiClient {

private _pluginUrl(pluginId: string, path: string): string {
const p = path.startsWith("/") ? path : `/${path}`;
return `${this.baseUrl}/plugins/${pluginId}/projects/${this.projectId}${p}`;
return `${this.baseUrl}/plugins/${pluginId}${p}`;
}

private async _get<T>(url: string): Promise<T> {
Expand Down
Loading