Developer-friendly & type-safe Typescript SDK specifically catered to leverage @usemarble/sdk API.
Marble API: A headless CMS API for managing and delivering content programmatically.
The SDK can be installed with either npm, pnpm, bun or yarn package managers.
npm add @usemarble/sdkpnpm add @usemarble/sdkbun add @usemarble/sdkyarn add @usemarble/sdkNote
This package is published with CommonJS and ES Modules (ESM) support.
For supported JavaScript runtimes, please consult RUNTIMES.md.
import { Marble } from "@usemarble/sdk";
const marble = new Marble({
apiKey: process.env["MARBLE_API_KEY"] ?? "",
});
async function run() {
const result = await marble.posts.list({
limit: 10,
page: 1,
categories: "tech,news",
excludeCategories: "changelog",
tags: "javascript,react",
excludeTags: "outdated",
query: "nextjs",
format: "html",
featured: "true",
});
for await (const page of result) {
console.log(page);
}
}
run();This SDK supports the following security scheme globally:
| Name | Type | Scheme | Environment Variable |
|---|---|---|---|
apiKey |
apiKey | API key | MARBLE_API_KEY |
To authenticate with the API the apiKey parameter must be set when initializing the SDK client instance. For example:
import { Marble } from "@usemarble/sdk";
const marble = new Marble({
apiKey: process.env["MARBLE_API_KEY"] ?? "",
});
async function run() {
const result = await marble.posts.list({
limit: 10,
page: 1,
categories: "tech,news",
excludeCategories: "changelog",
tags: "javascript,react",
excludeTags: "outdated",
query: "nextjs",
format: "html",
featured: "true",
});
for await (const page of result) {
console.log(page);
}
}
run();Available methods
All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.
To read more about standalone functions, check FUNCTIONS.md.
Available standalone functions
authorsGet- Get authorauthorsList- List authorscategoriesGet- Get categorycategoriesList- List categoriespostsGet- Get postpostsList- List poststagsGet- Get tagtagsList- List tags
Some of the endpoints in this SDK support pagination. To use pagination, you
make your SDK calls as usual, but the returned response object will also be an
async iterable that can be consumed using the for await...of
syntax.
Here's an example of one such pagination call:
import { Marble } from "@usemarble/sdk";
const marble = new Marble({
apiKey: process.env["MARBLE_API_KEY"] ?? "",
});
async function run() {
const result = await marble.posts.list({
limit: 10,
page: 1,
categories: "tech,news",
excludeCategories: "changelog",
tags: "javascript,react",
excludeTags: "outdated",
query: "nextjs",
format: "html",
featured: "true",
});
for await (const page of result) {
console.log(page);
}
}
run();Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
import { Marble } from "@usemarble/sdk";
const marble = new Marble({
apiKey: process.env["MARBLE_API_KEY"] ?? "",
});
async function run() {
const result = await marble.posts.list({
limit: 10,
page: 1,
categories: "tech,news",
excludeCategories: "changelog",
tags: "javascript,react",
excludeTags: "outdated",
query: "nextjs",
format: "html",
featured: "true",
}, {
retries: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
});
for await (const page of result) {
console.log(page);
}
}
run();If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
import { Marble } from "@usemarble/sdk";
const marble = new Marble({
retryConfig: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
apiKey: process.env["MARBLE_API_KEY"] ?? "",
});
async function run() {
const result = await marble.posts.list({
limit: 10,
page: 1,
categories: "tech,news",
excludeCategories: "changelog",
tags: "javascript,react",
excludeTags: "outdated",
query: "nextjs",
format: "html",
featured: "true",
});
for await (const page of result) {
console.log(page);
}
}
run();MarbleError is the base class for all HTTP error responses. It has the following properties:
| Property | Type | Description |
|---|---|---|
error.message |
string |
Error message |
error.statusCode |
number |
HTTP response status code eg 404 |
error.headers |
Headers |
HTTP response headers |
error.body |
string |
HTTP body. Can be empty string if no body is returned. |
error.rawResponse |
Response |
Raw HTTP response |
error.data$ |
Optional. Some errors may contain structured data. See Error Classes. |
import { Marble } from "@usemarble/sdk";
import * as errors from "@usemarble/sdk/models/errors";
const marble = new Marble({
apiKey: process.env["MARBLE_API_KEY"] ?? "",
});
async function run() {
try {
const result = await marble.posts.list({
limit: 10,
page: 1,
categories: "tech,news",
excludeCategories: "changelog",
tags: "javascript,react",
excludeTags: "outdated",
query: "nextjs",
format: "html",
featured: "true",
});
for await (const page of result) {
console.log(page);
}
} catch (error) {
// The base class for HTTP error responses
if (error instanceof errors.MarbleError) {
console.log(error.message);
console.log(error.statusCode);
console.log(error.body);
console.log(error.headers);
// Depending on the method different errors may be thrown
if (error instanceof errors.ErrorT) {
console.log(error.data$.error); // string
console.log(error.data$.details); // Detail[]
console.log(error.data$.message); // string
}
}
}
}
run();Primary errors:
MarbleError: The base class for HTTP error responses.ServerError: Server error. Status code500.
Less common errors (9)
Network errors:
ConnectionError: HTTP client was unable to make a request to a server.RequestTimeoutError: HTTP request timed out due to an AbortSignal signal.RequestAbortedError: HTTP request was aborted by the client.InvalidRequestError: Any input used to create a request is invalid.UnexpectedClientError: Unrecognised or unexpected error.
Inherit from MarbleError:
ErrorT: Invalid query parameters or page number. Status code400. Applicable to 4 of 8 methods.*PageNotFoundError: Invalid query parameters or page number. Status code400. Applicable to 4 of 8 methods.*NotFoundError: Status code404. Applicable to 4 of 8 methods.*ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. Seeerror.rawValuefor the raw value anderror.pretty()for a nicely formatted multi-line string.
* Check the method documentation to see if the error is applicable.
The default server can be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:
import { Marble } from "@usemarble/sdk";
const marble = new Marble({
serverURL: "https://api.marblecms.com",
apiKey: process.env["MARBLE_API_KEY"] ?? "",
});
async function run() {
const result = await marble.posts.list({
limit: 10,
page: 1,
categories: "tech,news",
excludeCategories: "changelog",
tags: "javascript,react",
excludeTags: "outdated",
query: "nextjs",
format: "html",
featured: "true",
});
for await (const page of result) {
console.log(page);
}
}
run();The TypeScript SDK makes API calls using an HTTPClient that wraps the native
Fetch API. This
client is a thin wrapper around fetch and provides the ability to attach hooks
around the request lifecycle that can be used to modify the request or handle
errors and response.
The HTTPClient constructor takes an optional fetcher argument that can be
used to integrate a third-party HTTP client or when writing tests to mock out
the HTTP client and feed in fixtures.
The following example shows how to use the "beforeRequest" hook to to add a
custom header and a timeout to requests and how to use the "requestError" hook
to log errors:
import { Marble } from "@usemarble/sdk";
import { HTTPClient } from "@usemarble/sdk/lib/http";
const httpClient = new HTTPClient({
// fetcher takes a function that has the same signature as native `fetch`.
fetcher: (request) => {
return fetch(request);
}
});
httpClient.addHook("beforeRequest", (request) => {
const nextRequest = new Request(request, {
signal: request.signal || AbortSignal.timeout(5000)
});
nextRequest.headers.set("x-custom-header", "custom value");
return nextRequest;
});
httpClient.addHook("requestError", (error, request) => {
console.group("Request Error");
console.log("Reason:", `${error}`);
console.log("Endpoint:", `${request.method} ${request.url}`);
console.groupEnd();
});
const sdk = new Marble({ httpClient: httpClient });You can setup your SDK to emit debug logs for SDK requests and responses.
You can pass a logger that matches console's interface as an SDK option.
Warning
Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
import { Marble } from "@usemarble/sdk";
const sdk = new Marble({ debugLogger: console });You can also enable a default debug logger by setting an environment variable MARBLE_DEBUG to true.
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.
![@github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=64&v=4){kind=small}
![@speakeasy-github[bot]](https://avatars.githubusercontent.com/in/308252?s=64&v=4){kind=small}
