Universal JavaScript SDK for Storyblok's API

This client is a thin wrapper for the Storyblok API's to use in Node.js and the browser.

🚀 Usage

Install

npm install storyblok-js-client # yarn add storyblok-js-client

How to use it

Using the Content Deliver API

// 1. Require the Storyblok client
const StoryblokClient = require("storyblok-js-client");

// 2. Initialize the client with the preview token
// from your space dashboard at https://app.storyblok.com
let Storyblok = new StoryblokClient({
  accessToken: <YOUR_SPACE_ACCESS_TOKEN>,
});

Using the Content Management API

// 1. Require the Storyblok client
const StoryblokClient = require("storyblok-js-client");
const spaceId = <YOUR_SPACE_ID>;

// 2. Initialize the client with the oauth token
// from the my account area at https://app.storyblok.com
let Storyblok = new StoryblokClient({
  oauthToken: <YOUR_OAUTH_TOKEN>,
});

Storyblok.post(`spaces/${spaceId}/stories`, {
  story: { name: "xy", slug: "xy" },
});
Storyblok.put(`spaces/${spaceId}/stories/1`, {
  story: { name: "xy", slug: "xy" },
});
Storyblok.delete(`spaces/${spaceId}/stories/1`, null);

Using the RichTextResolver separately

You can import and use the RichTextResolver directly:

// you should need to use the format when import
// es - when you are in EsModules environment (like React, Vue apps, for example)
// cjs - when you are in NodeJS environment
// standalone - when you are in Browser environment directly

import RichTextResolver from 'storyblok-js-client/dist/rich-text-resolver.es'
// const RichTextResolver = require('storyblok-js-client/dist/rich-text-resolver.cjs')

const resolver = new RichTextResolver()

const html = resolver.render(data)

Using from the Browser directly

This package has a standalone version that contains all dependencies and you can use it to import and use our package inside the browser.

<!-- This import makes the StoryblokClient class available globally -->
<script src="https://cdn.jsdelivr.net/npm/storyblok-js-client@5.0.0/dist/index.standalone.js"></script>

<!-- This import makes the RichTextResolver class available globally -->
<script src="https://cdn.jsdelivr.net/npm/storyblok-js-client@5.0.0/dist/rich-text-resolver.standalone.js"></script>

If you want a bundle with Babel (for non-es6 browsers):

<!-- This import makes the StoryblokClient class available globally -->
<script src="https://cdn.jsdelivr.net/npm/storyblok-js-client@5.0.0/dist/es5/index.standalone.js"></script>

<!-- This import makes the RichTextResolver class available globally -->
<script src="https://cdn.jsdelivr.net/npm/storyblok-js-client@5.0.0/dist/es5/rich-text-resolver.standalone.js"></script>

Note about use of Babel

This package doesn't use the Babel by default in the final bundle. So, if you want a Babel transpiled file, you need to set the es5/ prefix on import:

// for CommonJS environments (NodeJS)
const StoryblokClient = require('storyblok-js-client/dist/es5/index.cjs')

// for EsModules environments
import StoryblokClient from 'storyblok-js-client/dist/es5/index.es'

NEW BRANCHES AND VERSIONS

The old master branch containing version 4.x.y has been moved to the v4 branch. We’ve renamed the master branch to main and now it contains version 5.0.0. If you wish to continue using the non Typescript version with axios, please use version 4. You can install it by running npm install https://github.com/storyblok/storyblok-js-client.git#4.x.x.

BREAKING CHANGES - FROM VERSION 5

Added TypeScript - Version 5

We added TypeScript to our codebase, improving our code quality and assuring the correct implementation from the client's side. This change will probably break your code, because your Storyblok client's current implementation is possibly sending the wrong types to the source. All the types are declared under src/types. If you use an IDE to code, you'll be able to hover the problematic cause and see what is being expected from the type. Yet, you can keep using our version without TypeScript.

Axios removal - Version 5

We removed our dependency on axios in Version 5. If you want to continue using our SDK with axios, please use version 4. The proxy feature was also removed in this version.

Isomorphic fetch - Version 5

Since we removed Axios, and some developers may want to use the SDK under Node's environment, we added isomorphic-fetch to deal with fetch, AbortController and XMLHttpRequest. Node already deals with those features natively from Version 17. We'll keep using isomorphic-fetch until Node's most recent versions become more popular and more widely used. As part of our efforts to make the SDK more lightweight to web users, under the hood, the import of node-fetch is conditionally done depending on if the app is under the Node's environment or not.

Documentation

Assets structure compatibility

We added retro-compatibility when using resolve_assets: 1 parameter under V2. Now, if you are using our V2 client, you should receive the assets structure just the same as V1.

Documentation

Class `Storyblok`

Parameters

config Object
- accessToken String, The preview token you can find in your space dashboard at https://app.storyblok.com
- cache Object
  - type String, none or memory
- (responseInterceptor Function, optional - You can pass a function and return the result. For security reasons, Storyblok client will deal only with the response interceptor.)
- (region String, optional)
- (https Boolean, optional)
- (rateLimit Integer, optional, defaults to 3 for management api and 5 for cdn api)
- (timeout Integer, optional)
- (maxRetries Integer, optional, defaults to 5)
- (richTextSchema Object, optional - your custom schema for RichTextRenderer)
(endpoint String, optional)

Activating request cache

The Storyblok client comes with a caching mechanism. When initializing the Storyblok client you can define a cache provider for caching the requests in memory. To clear the cache you can call Storyblok.flushCache() or activate the automatic clear with clear: 'auto'.

let Storyblok = new StoryblokClient({
  accessToken: <YOUR_SPACE_ACCESS_TOKEN>,
  cache: {
    clear: "auto",
    type: "memory",
  },
});

Passing response interceptor

The Storyblok client lets you pass a function that serves as a response interceptor to it. Usage:

let Storyblok = new StoryblokClient({
  accessToken: <YOUR_SPACE_ACCESS_TOKEN>,
  cache: {
    clear: "auto",
    type: "memory",
  },
  responseInterceptor: (response) => {
    // one can handle status codes and more with the response
    if (response.status === 200) {
      // handle your status here
    }
    // ALWAYS return the response
    return response;
  },
});

Removing response interceptor

One can remove the reponseInterceptor at any time, by calling the function ejectInterceptor as shown below:

Storyblok.ejectInterceptor()

Method `Storyblok#get`

With this method you can get single or multiple items. The multiple items are paginated and you will receive 25 items per page by default. If you want to get all items at once use the getAll method.

Parameters

[return] Promise, Object response
path String, Path (can be cdn/stories, cdn/tags, cdn/datasources, cdn/links)
options Object, Options can be found in the API documentation.

Example

Storyblok.get('cdn/stories/home', {
	version: 'draft',
})
	.then((response) => {
		console.log(response)
	})
	.catch((error) => {
		console.log(error)
	})

Method `Storyblok#getAll`

With this method you can get all items at once.

Parameters

[return] Promise, Array of entities
path String, Path (can be cdn/stories, cdn/tags, cdn/datasources, cdn/links)
options Object, Options can be found in the API documentation.
entity String, Storyblok entity like stories, links or datasource. It's optional.

Example

Storyblok.getAll('cdn/stories', {
	version: 'draft',
})
	.then((stories) => {
		console.log(stories) // an array
	})
	.catch((error) => {
		console.log(error)
	})

Method `Storyblok#post` (only management api)

Parameters

[return] Promise, Object response
path String, Path (spaces/*, ... see more at https://www.storyblok.com/docs/management-api/authentication?utm_source=github.com&utm_medium=readme&utm_campaign=storyblok-js-client)
payload Object

Example

Storyblok
  .post('spaces/<YOUR_SPACE_ID>/stories', {
    story: {name 'xy', slug: 'xy'}
  })
  .then((response) => {
    console.log(response);
  })
  .catch((error) => {
    console.log(error);
  })

Method `Storyblok#put` (only management api)

Parameters

[return] Promise, Object response
path String, Path (spaces/*, ... see more at https://www.storyblok.com/docs/management-api/authentication?utm_source=github.com&utm_medium=readme&utm_campaign=storyblok-js-client)
payload Object

Example

Storyblok
  .put('spaces/<YOUR_SPACE_ID>/stories/1', {
    story: {name 'xy', slug: 'xy'}
  })
  .then((response) => {
    console.log(response);
  })
  .catch((error) => {
    console.log(error);
  })

Method `Storyblok#delete` (only management api)

Parameters

[return] Promise, Object response
path String, Path (spaces/*, ... see more at https://www.storyblok.com/docs/management-api/authentication)
payload Object

Example

Storyblok.delete('spaces/<YOUR_SPACE_ID>/stories/1', null)
	.then((response) => {
		console.log(response)
	})
	.catch((error) => {
		console.log(error)
	})

Method `Storyblok#flushCache`

Parameters

[return] Promise, Object returns the Storyblok client

Example

Storyblok.flushCache()

Method `Storyblok#setComponentResolver`

Parameters

callback Function, Render function to render components of the richtext field

Option 1: Use a switch case definition to render different components:

Storyblok.setComponentResolver((component, blok) => {
	switch (component) {
		case 'my-custom-component':
			return `<div class="my-component-class">${blok.text}</div>`
			break
		case 'my-header':
			return `<h1 class="my-class">${blok.title}</h1>`
			break
		default:
			return 'Resolver not defined'
	}
})

Option 2: Dynamically render a component (Example in Vue.js):

Storyblok.setComponentResolver((component, blok) => {
	return `<component :blok='${JSON.stringify(blok)}'
                     is="${component}"></component>`
})

Method `Storyblok#richTextResolver.render`

Parameters

[return] String, Rendered html of a richtext field
data Richtext object, An object with a content (an array of nodes) field.

Example

Storyblok.richTextResolver.render(blok.richtext)

Code examples

Filter by content type values and path

const StoryblokClient = require("storyblok-js-client");

let client = new StoryblokClient({
  accessToken: <YOUR_SPACE_ACCESS_TOKEN>,
});

// Filter by boolean value in content type
client
  .get("cdn/stories", {
    version: "draft",
    filter_query: {
      is_featured: {
        in: true,
      },
    },
  })
  .then((res) => {
    console.log(res.data.stories);
  });

// Get all news and author contents
client
  .get("cdn/stories", {
    version: "draft",
    filter_query: {
      component: {
        in: "news,author",
      },
    },
  })
  .then((res) => {
    console.log(res.data.stories);
  });

// Get all content from the news folder
client
  .get("cdn/stories", {
    version: "draft",
    starts_with: "news/",
  })
  .then((res) => {
    console.log(res.data.stories);
  });

Download all content from Storyblok

Following a code example using the storyblok-js-client to backup all content on your local filesystem inside a 'backup' folder.

const StoryblokClient = require("storyblok-js-client");
const fs = require("fs");

let client = new StoryblokClient({
  accessToken: <YOUR_SPACE_ACCESS_TOKEN>,
});

let lastPage = 1;
let getStories = (page) => {
  client
    .get("cdn/stories", {
      version: "draft",
      per_page: 25,
      page: page,
    })
    .then((res) => {
      let stories = res.data.stories;
      stories.forEach((story) => {
        fs.writeFile(
          "./backup/" + story.id + ".json",
          JSON.stringify(story),
          (err) => {
            if (err) throw err;

            console.log(story.full_slug + " backed up");
          }
        );
      });

      let total = res.total;
      lastPage = Math.ceil(res.total / res.perPage);

      if (page <= lastPage) {
        page++;
        getStories(page);
      }
    });
};

getStories(1);

Initialize with a proxy server

const proxy = {
  host: host,
  port: port,
  auth: {
    username: 'username',
    password: 'password'
  }
}

const storyblok = new StoryblokClient({
  ...
  https: false,
  proxy: proxy
})

Read more about proxy settings in axios documentation

How to define a custom schema for the RichTextRenderer

To define how to add some classes to specific html attributes rendered by the rich text renderer, you need your own schema definition. With this new schema, you can pass it as the richTextSchema option when instantiate the StoryblokClient class. You must follow the default schema to do this.

Below, you can check an example:

const StoryblokClient = require("storyblok-js-client");

// the default schema copied and updated
const MySchema = require("./my-schema");

let client = new StoryblokClient({
  accessToken: <YOUR_SPACE_ACCESS_TOKEN>,
  richTextSchema: MySchema,
});

client.richTextResolver.render(data);

If you just want to change the way a specific tag is rendered you can import the default schema and extend it. Following an example that will render headlines with classes:

Instead of <p>Normal headline</p><h3><span class="margin-bottom-fdsafdsada">Styled headline</span></h3> it will render <p>Normal headline</p><h3 class="margin-bottom-fdsafdsada">Styled headline</h3>.

const RichTextResolver = require('storyblok-js-client/dist/richTextResolver')
const MySchema = require('storyblok-js-client/dist/schema')

MySchema.nodes.heading = function (node) {
	let attrs = {}

	if (
		node.content &&
		node.content.length === 1 &&
		node.content[0].marks &&
		node.content[0].marks.length === 1 &&
		node.content[0].marks[0].type === 'styled'
	) {
		attrs = node.content[0].marks[0].attrs
		delete node.content[0].marks
	}

	return {
		tag: [
			{
				tag: `h${node.attrs.level}`,
				attrs: attrs,
			},
		],
	}
}

let rteResolver = new RichTextResolver(MySchema)
let rendered = rteResolver.render({
	content: [
		{
			content: [
				{
					text: 'Normal headline',
					type: 'text',
				},
			],
			type: 'paragraph',
		},
		{
			attrs: {
				level: 3,
			},
			content: [
				{
					marks: [
						{
							attrs: {
								class: 'margin-bottom-fdsafdsada',
							},
							type: 'styled',
						},
					],
					text: 'Styled headline',
					type: 'text',
				},
			],
			type: 'heading',
		},
	],
	type: 'doc',
})

console.log(rendered)

🔗 Related Links

Storyblok & Javascript on GitHub: Check all of our Javascript open source repos;
Technology Hub: We prepared technology hubs so that you can find selected beginner tutorials, videos, boilerplates, and even cheatsheets all in one place;
Storyblok CLI: A simple CLI for scaffolding Storyblok projects and fieldtypes.

ℹ️ More Resources

Support

Bugs or Feature Requests? Submit an issue;
Do you have questions about Storyblok or you need help? Join our Discord Community.

Contributing

Please see our contributing guidelines and our code of conduct. This project use semantic-release for generate new versions by using commit messages and we use the Angular Convention to naming the commits. Check this question about it in semantic-release FAQ.

bogdanconstantinescu/storyblok-js-client

Universal JavaScript SDK for Storyblok's API

🚀 Usage

Install

How to use it

Using the Content Deliver API

Using the Content Management API

Using the RichTextResolver separately

Using from the Browser directly

Note about use of Babel

NEW BRANCHES AND VERSIONS

BREAKING CHANGES - FROM VERSION 5

Added TypeScript - Version 5

Axios removal - Version 5

Isomorphic fetch - Version 5

Documentation

Assets structure compatibility

Documentation

Class Storyblok

Activating request cache

Passing response interceptor

Removing response interceptor

Method Storyblok#get

Method Storyblok#getAll

Method Storyblok#post (only management api)

Method Storyblok#put (only management api)

Method Storyblok#delete (only management api)

Method Storyblok#flushCache

Method Storyblok#setComponentResolver

Method Storyblok#richTextResolver.render

Code examples

Filter by content type values and path

Download all content from Storyblok

Initialize with a proxy server

How to define a custom schema for the RichTextRenderer

🔗 Related Links

ℹ️ More Resources

Support

Contributing

Class `Storyblok`

Method `Storyblok#get`

Method `Storyblok#getAll`

Method `Storyblok#post` (only management api)

Method `Storyblok#put` (only management api)

Method `Storyblok#delete` (only management api)

Method `Storyblok#flushCache`

Method `Storyblok#setComponentResolver`

Method `Storyblok#richTextResolver.render`