Files
jackwener__opencli/clis/spotify/utils.ts
jakevin 4fe9a73ebc refactor: migrate adapter imports to package exports (#795)
* refactor: migrate adapter imports to package exports

Replace all relative imports (../../src/registry.js, ../../browser/cdp.js, etc.)
with package exports (@jackwener/opencli/registry, @jackwener/opencli/errors, etc.)
across all 484 adapter files.

This decouples adapter import resolution from directory structure:
- User CLIs in ~/.opencli/clis/ resolve via node_modules symlink
- Internal adapters resolve via Node.js self-referencing
- No more shim files needed for import resolution

Changes:
- package.json: add sub-path exports for all public modules
- clis/**: replace relative imports with @jackwener/opencli/...
- discovery.ts: simplify ensureUserCliCompatShims to symlink-only
- registry-api.ts: export CommandArgs type
- Remove root-level shim directories (browser/, download/, pipeline/)
- Remove shim entries from tsconfig.json include and package.json files

* test: add regression tests for package exports

Prevents regressions like #788/#791 by:
1. Scanning all adapter files for forbidden relative imports
   (../../src/, ../../browser/, etc.) — fails if any remain
2. Verifying every package.json export maps to an existing source file

18 new test cases.

* fix: use junction on Windows + broaden test patterns

- discovery.ts: use 'junction' symlink type on Windows (no admin required)
- package-exports.test.ts: generalize forbidden patterns to catch any
  depth of ../ traversal (not just ../../ and ../../../)

* fix: update stale vi.mock/importActual paths in adapter tests

Test files still used old relative paths for vi.mock() and
vi.importActual() calls. Updated 5 test files to use package exports.
Also broadened regression test patterns to catch mock/importActual paths.

* fix: use rm instead of unlink for symlink cleanup, add warn on failure

Addresses review feedback from Astro-Han:
- rm() handles both symlinks and stale directories (unlink fails on dirs)
- Log a warning when symlink creation fails instead of silent catch

* docs: update import examples to use package exports

Update all documentation, contributing guides, and skills to use
@jackwener/opencli/registry instead of ../../src/registry.js.

Without this, users following the docs would write adapters with
broken imports since the old shim files are no longer created.
2026-04-05 16:02:17 +08:00

93 lines
2.9 KiB
TypeScript

import { CliError } from '@jackwener/opencli/errors';
export interface SpotifyCredentials {
clientId: string;
clientSecret: string;
}
export interface SpotifyTrackSummary {
track: string;
artist: string;
album: string;
uri: string;
}
const SPOTIFY_PLACEHOLDER_PATTERNS = [
/^your_spotify_client_id_here$/i,
/^your_spotify_client_secret_here$/i,
/^your_.+_here$/i,
];
export function parseDotEnv(content: string): Record<string, string> {
return Object.fromEntries(
content
.split(/\r?\n/)
.map(line => line.trim())
.filter(line => line && !line.startsWith('#') && line.includes('='))
.map(line => {
const index = line.indexOf('=');
return [line.slice(0, index).trim(), line.slice(index + 1).trim()] as [string, string];
}),
);
}
export function resolveSpotifyCredentials(
fileEnv: Record<string, string>,
processEnv: NodeJS.ProcessEnv = process.env,
): SpotifyCredentials {
return {
clientId: processEnv.SPOTIFY_CLIENT_ID || fileEnv.SPOTIFY_CLIENT_ID || '',
clientSecret: processEnv.SPOTIFY_CLIENT_SECRET || fileEnv.SPOTIFY_CLIENT_SECRET || '',
};
}
export function isPlaceholderCredential(value: string | null | undefined): boolean {
const normalized = value?.trim() || '';
if (!normalized) return false;
return SPOTIFY_PLACEHOLDER_PATTERNS.some(pattern => pattern.test(normalized));
}
export function hasConfiguredSpotifyCredentials(credentials: SpotifyCredentials): boolean {
return Boolean(credentials.clientId.trim()) &&
Boolean(credentials.clientSecret.trim()) &&
!isPlaceholderCredential(credentials.clientId) &&
!isPlaceholderCredential(credentials.clientSecret);
}
export function assertSpotifyCredentialsConfigured(credentials: SpotifyCredentials, envFile: string): void {
if (hasConfiguredSpotifyCredentials(credentials)) return;
throw new CliError(
'CONFIG',
`Missing Spotify credentials.\n\n` +
`1. Go to https://developer.spotify.com/dashboard and create an app\n` +
`2. Add ${'http://127.0.0.1:8888/callback'} as a Redirect URI\n` +
`3. Copy your Client ID and Client Secret\n` +
`4. Open the file: ${envFile}\n` +
`5. Fill in SPOTIFY_CLIENT_ID and SPOTIFY_CLIENT_SECRET, then save\n` +
`6. Run: opencli spotify auth`,
);
}
export function mapSpotifyTrackResults(data: any): SpotifyTrackSummary[] {
const items = data?.tracks?.items;
if (!Array.isArray(items)) return [];
return items.map((track: any) => ({
track: track?.name || '',
artist: Array.isArray(track?.artists) ? track.artists.map((artist: any) => artist.name).join(', ') : '',
album: track?.album?.name || '',
uri: track?.uri || '',
}));
}
export function getFirstSpotifyTrack(data: any): { uri: string; name: string; artist: string } | null {
const track = mapSpotifyTrackResults(data)[0];
if (!track) return null;
return {
uri: track.uri,
name: track.track,
artist: track.artist,
};
}