framework

作者: contentstack

SDK 的 Axios HTTP 层 — contentstackHTTPClient、重试、并发、插件、OAuth 工具。

npx skills add https://github.com/contentstack/contentstack-management-javascript --skill framework

Framework – HTTP / config / transport – Contentstack Management JavaScript SDK

When to use

  • Changing lib/core/ request behavior: retries, base URL, interceptors, concurrency, OAuth helpers.
  • Debugging HTTP-level issues (429, timeouts, headers).

Instructions

The SDK isolates HTTP and cross-cutting behavior under lib/core/. Use this when changing requests, retries, auth headers, or queueing — not when only adjusting a single stack resource’s URL path.

Key modules

FileResponsibility
contentstackHTTPClient.jsBuilds axios instance: baseURL, paramsSerializer (qs + JSON query), interceptors, retry behavior, ConcurrencyQueue, logHandler, retryCondition (e.g. 429)
concurrency-queue.jsLimits parallel in-flight requests (maxRequests)
contentstackError.jsMaps axios errors to enriched Error objects (redacts tokens in logged config)
errorMessages.jsUser-facing error string helpers
oauthHandler.jsOAuth-related behavior used by contentstackClient
pkceStorage.jsPKCE storage for OAuth flows
Util.jsHost checks, user agent, plugin normalization

When to change this layer

  • New global header, auth scheme, or base URL rule → HTTP client / lib/contentstack.js bootstrap.
  • Retry policy, 429, timeout defaults → contentstackHTTPClient.js (and JSDoc on client() options).
  • Concurrency → concurrency-queue.js + options from client().

Tests

  • test/unit/ContentstackHTTPClient-test.js, concurrency-Queue-test.js, contentstackError-test.js, Util-test — extend when behavior changes.