Skip to content

refactor(consts): extract hard-coded strings into constants #226

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
ryoppippi merged 3 commits into from
Dec 13, 2025
Merged

refactor(consts): extract hard-coded strings into constants #226

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
acb31a2
refactor(consts): extract USER_AGENT string into constant
ryoppippi Dec 12, 2025
d26be85
refactor(rpc-client): use DEFAULT_BASE_URL constant
ryoppippi Dec 12, 2025
930aa61
revert(test): keep hard-coded values in requestBuilder tests
ryoppippi Dec 12, 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
5 changes: 5 additions & 0 deletions src/consts.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
/**
* Package name used as User-Agent header
*/
export const USER_AGENT = 'stackone-ai-node';

/**
* Default base URL for StackOne API
*/
Expand Down
3 changes: 2 additions & 1 deletion src/requestBuilder.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { USER_AGENT } from './consts';
import {
type ExecuteOptions,
type HttpBodyType,
Expand Down Expand Up @@ -57,7 +58,7 @@ export class RequestBuilder {
*/
prepareHeaders(): Record<string, string> {
return {
'User-Agent': 'stackone-ai-node',
'User-Agent': USER_AGENT,
...this.headers,
};
}
Expand Down
5 changes: 3 additions & 2 deletions src/rpc-client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { DEFAULT_BASE_URL, USER_AGENT } from './consts';
import { STACKONE_HEADER_KEYS } from './headers';
import {
type RpcActionRequest,
Expand Down Expand Up @@ -25,7 +26,7 @@ export class RpcClient {

constructor(config: RpcClientConfig) {
const validatedConfig = rpcClientConfigSchema.parse(config);
this.baseUrl = validatedConfig.serverURL || 'https://api.stackone.com';
this.baseUrl = validatedConfig.serverURL || DEFAULT_BASE_URL;
const username = validatedConfig.security.username;
const password = validatedConfig.security.password || '';
this.authHeader = `Basic ${Buffer.from(`${username}:${password}`).toString('base64')}`;
Expand Down Expand Up @@ -68,7 +69,7 @@ export class RpcClient {
const httpHeaders = {
'Content-Type': 'application/json',
Authorization: this.authHeader,
'User-Agent': 'stackone-ai-node',
'User-Agent': USER_AGENT,
...forwardedHeaders,
} satisfies Record<string, string>;

Expand Down
4 changes: 2 additions & 2 deletions src/utils/errors.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Type aliases for common types
import { USER_AGENT } from '../consts';

/**
* Base exception for StackOne errors
Expand Down Expand Up @@ -73,7 +73,7 @@ export class StackOneAPIError extends StackOneError {
// Add request headers information (for debugging)
errorMessage += '\n\nRequest Headers:';
errorMessage += '\n- Authorization: [REDACTED]';
errorMessage += '\n- User-Agent: stackone-ai-node';
errorMessage += `\n- User-Agent: ${USER_AGENT}`;

// Add request body information if available
if (this.requestBody) {
Expand Down
Loading