https://github.com/usemarble/marble-ts
Typescript sdk for Marble
https://github.com/usemarble/marble-ts
cms marble sdk
Last synced: 3 months ago
JSON representation
Typescript sdk for Marble
- Host: GitHub
- URL: https://github.com/usemarble/marble-ts
- Owner: usemarble
- License: mit
- Created: 2026-01-08T10:03:43.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2026-03-30T02:15:32.000Z (3 months ago)
- Last Synced: 2026-03-30T05:27:21.758Z (3 months ago)
- Topics: cms, marble, sdk
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@usemarble/sdk
- Size: 297 KB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# @usemarble/sdk
Developer-friendly & type-safe Typescript SDK specifically catered to leverage _@usemarble/sdk_ API.
[](https://www.speakeasy.com/?utm_source=@usemarble/sdk&utm_campaign=typescript)
[](https://opensource.org/licenses/MIT)
## Summary
Marble API: A headless CMS API for managing and delivering content programmatically.
## Table of Contents
* [@usemarble/sdk](#usemarblesdk)
* [SDK Installation](#sdk-installation)
* [Requirements](#requirements)
* [SDK Example Usage](#sdk-example-usage)
* [Authentication](#authentication)
* [Available Resources and Operations](#available-resources-and-operations)
* [Standalone functions](#standalone-functions)
* [Pagination](#pagination)
* [Retries](#retries)
* [Error Handling](#error-handling)
* [Server Selection](#server-selection)
* [Custom HTTP Client](#custom-http-client)
* [Debugging](#debugging)
* [Development](#development)
* [Maturity](#maturity)
* [Contributions](#contributions)
## SDK Installation
The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.
### NPM
```bash
npm add @usemarble/sdk
```
### PNPM
```bash
pnpm add @usemarble/sdk
```
### Bun
```bash
bun add @usemarble/sdk
```
### Yarn
```bash
yarn add @usemarble/sdk
```
> [!NOTE]
> This package is published with CommonJS and ES Modules (ESM) support.
## Requirements
For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
## SDK Example Usage
### Example
```typescript
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();
```
## Authentication
### Per-Client Security Schemes
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:
```typescript
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 Resources and Operations
Available methods
### [Authors](docs/sdks/authors/README.md)
* [list](docs/sdks/authors/README.md#list) - List authors
* [create](docs/sdks/authors/README.md#create) - Create author
* [get](docs/sdks/authors/README.md#get) - Get author
* [update](docs/sdks/authors/README.md#update) - Update author
* [delete](docs/sdks/authors/README.md#delete) - Delete author
### [Categories](docs/sdks/categories/README.md)
* [list](docs/sdks/categories/README.md#list) - List categories
* [create](docs/sdks/categories/README.md#create) - Create category
* [get](docs/sdks/categories/README.md#get) - Get category
* [update](docs/sdks/categories/README.md#update) - Update category
* [delete](docs/sdks/categories/README.md#delete) - Delete category
### [Posts](docs/sdks/posts/README.md)
* [list](docs/sdks/posts/README.md#list) - List posts
* [create](docs/sdks/posts/README.md#create) - Create post
* [get](docs/sdks/posts/README.md#get) - Get post
* [update](docs/sdks/posts/README.md#update) - Update post
* [delete](docs/sdks/posts/README.md#delete) - Delete post
### [Tags](docs/sdks/tags/README.md)
* [list](docs/sdks/tags/README.md#list) - List tags
* [create](docs/sdks/tags/README.md#create) - Create tag
* [get](docs/sdks/tags/README.md#get) - Get tag
* [update](docs/sdks/tags/README.md#update) - Update tag
* [delete](docs/sdks/tags/README.md#delete) - Delete tag
## Standalone functions
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](./FUNCTIONS.md).
Available standalone functions
- [`authorsCreate`](docs/sdks/authors/README.md#create) - Create author
- [`authorsDelete`](docs/sdks/authors/README.md#delete) - Delete author
- [`authorsGet`](docs/sdks/authors/README.md#get) - Get author
- [`authorsList`](docs/sdks/authors/README.md#list) - List authors
- [`authorsUpdate`](docs/sdks/authors/README.md#update) - Update author
- [`categoriesCreate`](docs/sdks/categories/README.md#create) - Create category
- [`categoriesDelete`](docs/sdks/categories/README.md#delete) - Delete category
- [`categoriesGet`](docs/sdks/categories/README.md#get) - Get category
- [`categoriesList`](docs/sdks/categories/README.md#list) - List categories
- [`categoriesUpdate`](docs/sdks/categories/README.md#update) - Update category
- [`postsCreate`](docs/sdks/posts/README.md#create) - Create post
- [`postsDelete`](docs/sdks/posts/README.md#delete) - Delete post
- [`postsGet`](docs/sdks/posts/README.md#get) - Get post
- [`postsList`](docs/sdks/posts/README.md#list) - List posts
- [`postsUpdate`](docs/sdks/posts/README.md#update) - Update post
- [`tagsCreate`](docs/sdks/tags/README.md#create) - Create tag
- [`tagsDelete`](docs/sdks/tags/README.md#delete) - Delete tag
- [`tagsGet`](docs/sdks/tags/README.md#get) - Get tag
- [`tagsList`](docs/sdks/tags/README.md#list) - List tags
- [`tagsUpdate`](docs/sdks/tags/README.md#update) - Update tag
## Pagination
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`][for-await-of]
syntax.
[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
Here's an example of one such pagination call:
```typescript
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();
```
## Retries
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:
```typescript
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:
```typescript
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();
```
## Error Handling
[`MarbleError`](./src/models/errors/marbleerror.ts) 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](#error-classes). |
### Example
```typescript
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();
```
### Error Classes
**Primary errors:**
* [`MarbleError`](./src/models/errors/marbleerror.ts): The base class for HTTP error responses.
* [`ServerError`](./src/models/errors/servererror.ts): Server error. Status code `500`.
Less common errors (11)
**Network errors:**
* [`ConnectionError`](./src/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server.
* [`RequestTimeoutError`](./src/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal.
* [`RequestAbortedError`](./src/models/errors/httpclienterrors.ts): HTTP request was aborted by the client.
* [`InvalidRequestError`](./src/models/errors/httpclienterrors.ts): Any input used to create a request is invalid.
* [`UnexpectedClientError`](./src/models/errors/httpclienterrors.ts): Unrecognised or unexpected error.
**Inherit from [`MarbleError`](./src/models/errors/marbleerror.ts)**:
* [`ErrorT`](./src/models/errors/errort.ts): Status code `400`. Applicable to 13 of 20 methods.*
* [`ForbiddenError`](./src/models/errors/forbiddenerror.ts): Status code `403`. Applicable to 12 of 20 methods.*
* [`NotFoundError`](./src/models/errors/notfounderror.ts): Status code `404`. Applicable to 12 of 20 methods.*
* [`ConflictError`](./src/models/errors/conflicterror.ts): Status code `409`. Applicable to 8 of 20 methods.*
* [`PageNotFoundError`](./src/models/errors/pagenotfounderror.ts): Invalid query parameters or page number. Status code `400`. Applicable to 4 of 20 methods.*
* [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
\* Check [the method documentation](#available-resources-and-operations) to see if the error is applicable.
## Server Selection
### Override Server URL Per-Client
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:
```typescript
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();
```
## Custom HTTP Client
The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native
[Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/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:
- route requests through a proxy server using [undici](https://www.npmjs.com/package/undici)'s ProxyAgent
- use the `"beforeRequest"` hook to add a custom header and a timeout to requests
- use the `"requestError"` hook to log errors
```typescript
import { Marble } from "@usemarble/sdk";
import { ProxyAgent } from "undici";
import { HTTPClient } from "@usemarble/sdk/lib/http";
const dispatcher = new ProxyAgent("http://proxy.example.com:8080");
const httpClient = new HTTPClient({
// 'fetcher' takes a function that has the same signature as native 'fetch'.
fetcher: (input, init) =>
// 'dispatcher' is specific to undici and not part of the standard Fetch API.
fetch(input, { ...init, dispatcher } as RequestInit),
});
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 });
```
## Debugging
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.
```typescript
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.
# Development
## Maturity
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.
## Contributions
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.
### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=@usemarble/sdk&utm_campaign=typescript)