soundcloud-api-ts 1.11.1 → 1.12.0

package/dist/index.js

@@ -1,257 +1,269 @@
 'use strict';
 
-var chunkGTSVJU3P_js = require('./chunk-GTSVJU3P.js');
+var chunkD7AF372V_js = require('./chunk-D7AF372V.js');
 var chunkMLVA534Z_js = require('./chunk-MLVA534Z.js');
 
 
 
+Object.defineProperty(exports, "IMPLEMENTED_OPERATIONS", {
+  enumerable: true,
+  get: function () { return chunkD7AF372V_js.IMPLEMENTED_OPERATIONS; }
+});
+Object.defineProperty(exports, "InFlightDeduper", {
+  enumerable: true,
+  get: function () { return chunkD7AF372V_js.InFlightDeduper; }
+});
+Object.defineProperty(exports, "RawClient", {
+  enumerable: true,
+  get: function () { return chunkD7AF372V_js.RawClient; }
+});
 Object.defineProperty(exports, "SoundCloudClient", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.SoundCloudClient; }
+  get: function () { return chunkD7AF372V_js.SoundCloudClient; }
 });
 Object.defineProperty(exports, "createPlaylist", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.createPlaylist; }
+  get: function () { return chunkD7AF372V_js.createPlaylist; }
 });
 Object.defineProperty(exports, "createTrackComment", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.createTrackComment; }
+  get: function () { return chunkD7AF372V_js.createTrackComment; }
 });
 Object.defineProperty(exports, "deletePlaylist", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.deletePlaylist; }
+  get: function () { return chunkD7AF372V_js.deletePlaylist; }
 });
 Object.defineProperty(exports, "deleteTrack", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.deleteTrack; }
+  get: function () { return chunkD7AF372V_js.deleteTrack; }
 });
 Object.defineProperty(exports, "fetchAll", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.fetchAll; }
+  get: function () { return chunkD7AF372V_js.fetchAll; }
 });
 Object.defineProperty(exports, "followUser", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.followUser; }
+  get: function () { return chunkD7AF372V_js.followUser; }
 });
 Object.defineProperty(exports, "generateCodeChallenge", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.generateCodeChallenge; }
+  get: function () { return chunkD7AF372V_js.generateCodeChallenge; }
 });
 Object.defineProperty(exports, "generateCodeVerifier", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.generateCodeVerifier; }
+  get: function () { return chunkD7AF372V_js.generateCodeVerifier; }
 });
 Object.defineProperty(exports, "getAuthorizationUrl", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.getAuthorizationUrl; }
+  get: function () { return chunkD7AF372V_js.getAuthorizationUrl; }
 });
 Object.defineProperty(exports, "getClientToken", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.getClientToken; }
+  get: function () { return chunkD7AF372V_js.getClientToken; }
 });
 Object.defineProperty(exports, "getFollowers", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.getFollowers; }
+  get: function () { return chunkD7AF372V_js.getFollowers; }
 });
 Object.defineProperty(exports, "getFollowings", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.getFollowings; }
+  get: function () { return chunkD7AF372V_js.getFollowings; }
 });
 Object.defineProperty(exports, "getMe", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.getMe; }
+  get: function () { return chunkD7AF372V_js.getMe; }
 });
 Object.defineProperty(exports, "getMeActivities", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.getMeActivities; }
+  get: function () { return chunkD7AF372V_js.getMeActivities; }
 });
 Object.defineProperty(exports, "getMeActivitiesOwn", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.getMeActivitiesOwn; }
+  get: function () { return chunkD7AF372V_js.getMeActivitiesOwn; }
 });
 Object.defineProperty(exports, "getMeActivitiesTracks", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.getMeActivitiesTracks; }
+  get: function () { return chunkD7AF372V_js.getMeActivitiesTracks; }
 });
 Object.defineProperty(exports, "getMeFollowers", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.getMeFollowers; }
+  get: function () { return chunkD7AF372V_js.getMeFollowers; }
 });
 Object.defineProperty(exports, "getMeFollowings", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.getMeFollowings; }
+  get: function () { return chunkD7AF372V_js.getMeFollowings; }
 });
 Object.defineProperty(exports, "getMeFollowingsTracks", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.getMeFollowingsTracks; }
+  get: function () { return chunkD7AF372V_js.getMeFollowingsTracks; }
 });
 Object.defineProperty(exports, "getMeLikesPlaylists", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.getMeLikesPlaylists; }
+  get: function () { return chunkD7AF372V_js.getMeLikesPlaylists; }
 });
 Object.defineProperty(exports, "getMeLikesTracks", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.getMeLikesTracks; }
+  get: function () { return chunkD7AF372V_js.getMeLikesTracks; }
 });
 Object.defineProperty(exports, "getMePlaylists", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.getMePlaylists; }
+  get: function () { return chunkD7AF372V_js.getMePlaylists; }
 });
 Object.defineProperty(exports, "getMeTracks", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.getMeTracks; }
+  get: function () { return chunkD7AF372V_js.getMeTracks; }
 });
 Object.defineProperty(exports, "getPlaylist", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.getPlaylist; }
+  get: function () { return chunkD7AF372V_js.getPlaylist; }
 });
 Object.defineProperty(exports, "getPlaylistReposts", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.getPlaylistReposts; }
+  get: function () { return chunkD7AF372V_js.getPlaylistReposts; }
 });
 Object.defineProperty(exports, "getPlaylistTracks", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.getPlaylistTracks; }
+  get: function () { return chunkD7AF372V_js.getPlaylistTracks; }
 });
 Object.defineProperty(exports, "getRelatedTracks", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.getRelatedTracks; }
+  get: function () { return chunkD7AF372V_js.getRelatedTracks; }
 });
 Object.defineProperty(exports, "getSoundCloudWidgetUrl", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.getSoundCloudWidgetUrl; }
+  get: function () { return chunkD7AF372V_js.getSoundCloudWidgetUrl; }
 });
 Object.defineProperty(exports, "getTrack", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.getTrack; }
+  get: function () { return chunkD7AF372V_js.getTrack; }
 });
 Object.defineProperty(exports, "getTrackComments", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.getTrackComments; }
+  get: function () { return chunkD7AF372V_js.getTrackComments; }
 });
 Object.defineProperty(exports, "getTrackLikes", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.getTrackLikes; }
+  get: function () { return chunkD7AF372V_js.getTrackLikes; }
 });
 Object.defineProperty(exports, "getTrackReposts", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.getTrackReposts; }
+  get: function () { return chunkD7AF372V_js.getTrackReposts; }
 });
 Object.defineProperty(exports, "getTrackStreams", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.getTrackStreams; }
+  get: function () { return chunkD7AF372V_js.getTrackStreams; }
 });
 Object.defineProperty(exports, "getUser", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.getUser; }
+  get: function () { return chunkD7AF372V_js.getUser; }
 });
 Object.defineProperty(exports, "getUserLikesPlaylists", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.getUserLikesPlaylists; }
+  get: function () { return chunkD7AF372V_js.getUserLikesPlaylists; }
 });
 Object.defineProperty(exports, "getUserLikesTracks", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.getUserLikesTracks; }
+  get: function () { return chunkD7AF372V_js.getUserLikesTracks; }
 });
 Object.defineProperty(exports, "getUserPlaylists", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.getUserPlaylists; }
+  get: function () { return chunkD7AF372V_js.getUserPlaylists; }
 });
 Object.defineProperty(exports, "getUserToken", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.getUserToken; }
+  get: function () { return chunkD7AF372V_js.getUserToken; }
 });
 Object.defineProperty(exports, "getUserTracks", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.getUserTracks; }
+  get: function () { return chunkD7AF372V_js.getUserTracks; }
 });
 Object.defineProperty(exports, "getUserWebProfiles", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.getUserWebProfiles; }
+  get: function () { return chunkD7AF372V_js.getUserWebProfiles; }
 });
 Object.defineProperty(exports, "likePlaylist", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.likePlaylist; }
+  get: function () { return chunkD7AF372V_js.likePlaylist; }
 });
 Object.defineProperty(exports, "likeTrack", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.likeTrack; }
+  get: function () { return chunkD7AF372V_js.likeTrack; }
 });
 Object.defineProperty(exports, "paginate", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.paginate; }
+  get: function () { return chunkD7AF372V_js.paginate; }
 });
 Object.defineProperty(exports, "paginateItems", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.paginateItems; }
+  get: function () { return chunkD7AF372V_js.paginateItems; }
 });
 Object.defineProperty(exports, "refreshUserToken", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.refreshUserToken; }
+  get: function () { return chunkD7AF372V_js.refreshUserToken; }
 });
 Object.defineProperty(exports, "repostPlaylist", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.repostPlaylist; }
+  get: function () { return chunkD7AF372V_js.repostPlaylist; }
 });
 Object.defineProperty(exports, "repostTrack", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.repostTrack; }
+  get: function () { return chunkD7AF372V_js.repostTrack; }
 });
 Object.defineProperty(exports, "resolveUrl", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.resolveUrl; }
+  get: function () { return chunkD7AF372V_js.resolveUrl; }
 });
 Object.defineProperty(exports, "scFetch", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.scFetch; }
+  get: function () { return chunkD7AF372V_js.scFetch; }
 });
 Object.defineProperty(exports, "scFetchUrl", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.scFetchUrl; }
+  get: function () { return chunkD7AF372V_js.scFetchUrl; }
 });
 Object.defineProperty(exports, "searchPlaylists", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.searchPlaylists; }
+  get: function () { return chunkD7AF372V_js.searchPlaylists; }
 });
 Object.defineProperty(exports, "searchTracks", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.searchTracks; }
+  get: function () { return chunkD7AF372V_js.searchTracks; }
 });
 Object.defineProperty(exports, "searchUsers", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.searchUsers; }
+  get: function () { return chunkD7AF372V_js.searchUsers; }
 });
 Object.defineProperty(exports, "signOut", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.signOut; }
+  get: function () { return chunkD7AF372V_js.signOut; }
 });
 Object.defineProperty(exports, "unfollowUser", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.unfollowUser; }
+  get: function () { return chunkD7AF372V_js.unfollowUser; }
 });
 Object.defineProperty(exports, "unlikePlaylist", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.unlikePlaylist; }
+  get: function () { return chunkD7AF372V_js.unlikePlaylist; }
 });
 Object.defineProperty(exports, "unlikeTrack", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.unlikeTrack; }
+  get: function () { return chunkD7AF372V_js.unlikeTrack; }
 });
 Object.defineProperty(exports, "unrepostPlaylist", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.unrepostPlaylist; }
+  get: function () { return chunkD7AF372V_js.unrepostPlaylist; }
 });
 Object.defineProperty(exports, "unrepostTrack", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.unrepostTrack; }
+  get: function () { return chunkD7AF372V_js.unrepostTrack; }
 });
 Object.defineProperty(exports, "updatePlaylist", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.updatePlaylist; }
+  get: function () { return chunkD7AF372V_js.updatePlaylist; }
 });
 Object.defineProperty(exports, "updateTrack", {
   enumerable: true,
-  get: function () { return chunkGTSVJU3P_js.updateTrack; }
+  get: function () { return chunkD7AF372V_js.updateTrack; }
 });
 Object.defineProperty(exports, "SoundCloudError", {
   enumerable: true,

package/dist/index.mjs

@@ -1,4 +1,4 @@
-export { SoundCloudClient, createPlaylist, createTrackComment, deletePlaylist, deleteTrack, fetchAll, followUser, generateCodeChallenge, generateCodeVerifier, getAuthorizationUrl, getClientToken, getFollowers, getFollowings, getMe, getMeActivities, getMeActivitiesOwn, getMeActivitiesTracks, getMeFollowers, getMeFollowings, getMeFollowingsTracks, getMeLikesPlaylists, getMeLikesTracks, getMePlaylists, getMeTracks, getPlaylist, getPlaylistReposts, getPlaylistTracks, getRelatedTracks, getSoundCloudWidgetUrl, getTrack, getTrackComments, getTrackLikes, getTrackReposts, getTrackStreams, getUser, getUserLikesPlaylists, getUserLikesTracks, getUserPlaylists, getUserToken, getUserTracks, getUserWebProfiles, likePlaylist, likeTrack, paginate, paginateItems, refreshUserToken, repostPlaylist, repostTrack, resolveUrl, scFetch, scFetchUrl, searchPlaylists, searchTracks, searchUsers, signOut, unfollowUser, unlikePlaylist, unlikeTrack, unrepostPlaylist, unrepostTrack, updatePlaylist, updateTrack } from './chunk-DGZEPXIQ.mjs';
+export { IMPLEMENTED_OPERATIONS, InFlightDeduper, RawClient, SoundCloudClient, createPlaylist, createTrackComment, deletePlaylist, deleteTrack, fetchAll, followUser, generateCodeChallenge, generateCodeVerifier, getAuthorizationUrl, getClientToken, getFollowers, getFollowings, getMe, getMeActivities, getMeActivitiesOwn, getMeActivitiesTracks, getMeFollowers, getMeFollowings, getMeFollowingsTracks, getMeLikesPlaylists, getMeLikesTracks, getMePlaylists, getMeTracks, getPlaylist, getPlaylistReposts, getPlaylistTracks, getRelatedTracks, getSoundCloudWidgetUrl, getTrack, getTrackComments, getTrackLikes, getTrackReposts, getTrackStreams, getUser, getUserLikesPlaylists, getUserLikesTracks, getUserPlaylists, getUserToken, getUserTracks, getUserWebProfiles, likePlaylist, likeTrack, paginate, paginateItems, refreshUserToken, repostPlaylist, repostTrack, resolveUrl, scFetch, scFetchUrl, searchPlaylists, searchTracks, searchUsers, signOut, unfollowUser, unlikePlaylist, unlikeTrack, unrepostPlaylist, unrepostTrack, updatePlaylist, updateTrack } from './chunk-JLRQJWU5.mjs';
 export { SoundCloudError } from './chunk-QYYEWUIJ.mjs';
 //# sourceMappingURL=index.mjs.map
 //# sourceMappingURL=index.mjs.map

package/llms.txt

@@ -200,6 +200,51 @@ const sc = new SoundCloudClient({
 
 `SCRequestTelemetry`: `{ method, path, durationMs, status, retryCount, error? }` — fires after every request including pagination and retries.
 
+## Raw API
+```ts
+// Call any endpoint — path templating, returns { data, status, headers }
+const res = await sc.raw.get('/tracks/{id}', { id: 123456 });
+await sc.raw.post('/tracks/{id}/comments', { id: 123456, body: { body: 'great track' } });
+await sc.raw.request({ method: 'DELETE', path: '/tracks/{id}', query: { id: 123456 } });
+```
+`RawResponse<T>`: `{ data: T, status: number, headers: Record<string, string> }` — does not throw on non-2xx.
+
+## In-Flight Deduplication & Cache
+```ts
+const sc = new SoundCloudClient({
+  clientId: '...', clientSecret: '...',
+  dedupe: true,       // default: true — concurrent identical GETs share one promise
+  cache: myCache,     // optional: SoundCloudCache interface (get/set/delete)
+  cacheTtlMs: 60000,  // default: 60s per cached GET response
+});
+```
+`SoundCloudCache`: `{ get<T>(key): T|undefined; set<T>(key, value, {ttlMs}): void; delete(key): void }`
+
+## Fetch Injection & Runtime Portability
+```ts
+const sc = new SoundCloudClient({
+  clientId: '...', clientSecret: '...',
+  fetch: customFetch,            // custom fetch implementation
+  AbortController: customAbort,  // custom AbortController
+});
+```
+No Node-only APIs. Works in Cloudflare Workers, Bun, Deno, Edge runtimes.
+
+## Retry Hook
+```ts
+const sc = new SoundCloudClient({
+  clientId: '...', clientSecret: '...',
+  onRetry: (info) => console.warn(`retry #${info.attempt} — ${info.reason} delay=${info.delayMs}ms`),
+});
+```
+`RetryInfo`: `{ attempt, delayMs, reason, status?, url }` — fires on every retry. 429 `Retry-After` header honored (capped 60s).
+
+## OpenAPI Tooling
+```bash
+pnpm openapi:sync      # fetch SoundCloud OpenAPI spec → tools/openapi.json + openapi-operations.json
+pnpm openapi:coverage  # compare spec operations to IMPLEMENTED_OPERATIONS in src/client/registry.ts
+```
+
 ## Full Documentation
 
 https://twin-paws.github.io/soundcloud-api-ts/

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "soundcloud-api-ts",
-  "version": "1.11.1",
+  "version": "1.12.0",
   "description": "TypeScript-first SoundCloud API client for accessing tracks, users, playlists, and search endpoints. Zero dependencies, native fetch, full OAuth 2.1 + PKCE support.",
   "bin": {
     "sc-cli": "./dist/cli.js",
@@ -34,7 +34,9 @@
     "test": "vitest run",
     "test:watch": "vitest",
     "test:coverage": "vitest run --coverage",
-    "docs": "typedoc"
+    "docs": "typedoc",
+    "openapi:sync": "npx tsx tools/openapi-sync.ts",
+    "openapi:coverage": "node -e \"const { IMPLEMENTED_OPERATIONS } = require('./dist/index.cjs'); const ops = require('./tools/openapi-operations.json'); const total = ops.length; const covered = ops.filter(o => IMPLEMENTED_OPERATIONS.includes(o.operationId)).length; console.log('Coverage: ' + covered + '/' + total + ' operations (' + Math.round(covered/total*100) + '%)');\" 2>/dev/null || echo 'Run pnpm build and pnpm openapi:sync first'"
   },
   "repository": {
     "type": "git",