Skip to content

feat: add Plugin Error types #205

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
dylankilkenny merged 1 commit into from
Sep 30, 2025
Merged

feat: add Plugin Error types #205

Show file tree
Hide file tree
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
45 changes: 45 additions & 0 deletions custom-models/plugin-api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,3 +193,48 @@ type TransactionWaitOptions = {
interval?: number;
timeout?: number;
};

/**
* JSON-safe type for plugin returns and error details.
*/
export type Json = null | boolean | number | string | Json[] | { [k: string]: Json };

/**
* Error shape normalized by the runtime.
*/
export interface PluginErrorShape {
message: string;
code?: string;
status?: number;
details?: Json;
}

/**
* Minimal error class for plugin authors; SDK will mirror this.
* @property message - The error message.
* @property code - The error code.
* @property status - The HTTP status code.
* @property details - The error details.
*/
export class PluginError extends Error implements PluginErrorShape {
code?: string;
status?: number;
details?: Json;
constructor(message: string, opts?: { code?: string; status?: number; details?: Json }) {
super(message);
this.name = 'PluginError';
this.code = opts?.code;
this.status = opts?.status;
this.details = opts?.details;
}
}

/**
* Convenience helper.
* @param message - The error message.
* @param opts - The error options.
* @returns The error object.
*/
export function pluginError(message: string, opts?: { code?: string; status?: number; details?: Json }): PluginError {
return new PluginError(message, opts);
}
45 changes: 45 additions & 0 deletions src/models/plugin-api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,3 +194,48 @@ type TransactionWaitOptions = {
interval?: number;
timeout?: number;
};

/**
* JSON-safe type for plugin returns and error details.
*/
export type Json = null | boolean | number | string | Json[] | { [k: string]: Json };

/**
* Error shape normalized by the runtime.
*/
export interface PluginErrorShape {
message: string;
code?: string;
status?: number;
details?: Json;
}

/**
* Minimal error class for plugin authors; SDK will mirror this.
* @property message - The error message.
* @property code - The error code.
* @property status - The HTTP status code.
* @property details - The error details.
*/
export class PluginError extends Error implements PluginErrorShape {
code?: string;
status?: number;
details?: Json;
constructor(message: string, opts?: { code?: string; status?: number; details?: Json }) {
super(message);
this.name = 'PluginError';
this.code = opts?.code;
this.status = opts?.status;
this.details = opts?.details;
}
}

/**
* Convenience helper.
* @param message - The error message.
* @param opts - The error options.
* @returns The error object.
*/
export function pluginError(message: string, opts?: { code?: string; status?: number; details?: Json }): PluginError {
return new PluginError(message, opts);
}