storyblok-management-api-wrapper v2.6.0

Storyblok Management API Wrapper

library for working with Storyblok management API. Uses axios to make Storyblok management API calls. Based on the official storyblok/storyblok-js-client

Install

npm install --save storyblok-management-api-wrapper

Usage

// 1. require the StoryblokApiClient
const StoryblokApiClient = require("storyblok-management-api-wrapper")

// 2. initialize the client with spaceId and apiKey
const spaceId = 123456
const apiKey = asdfklasjdfaksjfdaksjdfasjk
const apiClient = new StoryblokApiClient({ spaceId, apiKey })

Classes

StoryblokApiClient

instance of Storyblok API interface

Kind: global class

• StoryblokApiClient
  • new StoryblokApiClient(config)
  • .countAssets() ⇒ number
  • .countStories() ⇒ number
  • .createAssetFolder(name) ⇒ Object
  • .createComponent(definition) ⇒ Object
  • .createStory(storyData) ⇒ Object
  • .createImageAsset(filePath, compression, dimLimit) ⇒ string
  • .deleteAsset(assetId) ⇒ number
  • .deleteAssetFolder(assetFolderId) ⇒ number
  • .deleteComponent(componentId) ⇒ number
  • .deleteExistingAssets() ⇒ Array.<number>
  • .deleteExistingComponents() ⇒ Array.<number>
  • .deleteExistingStories()
  • .deleteStory(storyId) ⇒ number
  • .getComponent(componentId) ⇒ Object
  • .getExistingAssets() ⇒ Array.<Object>
  • .getExistingAssetFolders() ⇒ Array.<Object>
  • .getExistingComponents() ⇒ Array.<Object>
  • .getExistingStories() ⇒ Array.<Object>
  • .getSpace() ⇒ Object
  • .getStory(storyId) ⇒ Object
  • .publishExistingStories() ⇒ Array.<number>
  • .publishStory(storyId) ⇒ number
  • .reorderStory(storyId, afterId) ⇒ Object
  • .signAsset(filename) ⇒ Object
  • .uploadAsset(buffer, signedRequest) ⇒ string

new StoryblokApiClient(config)

initialize an instance

Example

// 1. require the StoryblokApiClient
const StoryblokApiClient = require("storyblok-management-api-wrapper")

// 2. initialize the client with spaceId and apiKey
const spaceId = 123456
const apiKey = asdfklasjdfaksjfdaksjdfasjk
const apiClient = new StoryblokApiClient({ spaceId, apiKey })

storyblokApiClient.countAssets() ⇒ number

get total number of existing assets

Kind: instance method of StoryblokApiClient Returns: number - get a count of existing assets

storyblokApiClient.countStories() ⇒ number

get total number of existing stories

Storyblok API's space info does not account 'folders' as stories, so "this.getSpace({ spaceId }).then(space => space.stories_count)" does not work for the purpose of this function must be manually retrieved

Kind: instance method of StoryblokApiClient Returns: number - get a count of existing stories

storyblokApiClient.createAssetFolder(name) ⇒ Object

create an asset folder

Kind: instance method of StoryblokApiClient Returns: Object - asset folder information

storyblokApiClient.createComponent(definition) ⇒ Object

create a component

Kind: instance method of StoryblokApiClient Returns: Object - details of component that was created

storyblokApiClient.createStory(storyData) ⇒ Object

create a content story

Kind: instance method of StoryblokApiClient Returns: Object - details of story that was created

storyblokApiClient.createImageAsset(filePath, compression, dimLimit) ⇒ string

create an asset from image compression and resize using the sharp.js library

Kind: instance method of StoryblokApiClient Returns: string - public url to access the asset

storyblokApiClient.deleteAsset(assetId) ⇒ number

delete a specific asset

Kind: instance method of StoryblokApiClient Returns: number - assetId is returned on success

storyblokApiClient.deleteAssetFolder(assetFolderId) ⇒ number

delete a specific asset folder

Kind: instance method of StoryblokApiClient Returns: number - assetFolderId is returned on success

storyblokApiClient.deleteComponent(componentId) ⇒ number

delete a specific component

Kind: instance method of StoryblokApiClient Returns: number - componentId is returned on success

storyblokApiClient.deleteExistingAssets() ⇒ Array.<number>

delete all existing assets

Kind: instance method of StoryblokApiClient Returns: Array.<number> - array of asset id's that were removed

storyblokApiClient.deleteExistingComponents() ⇒ Array.<number>

delete all existing components

Kind: instance method of StoryblokApiClient Returns: Array.<number> - array of component id's that were removed

storyblokApiClient.deleteExistingStories()

delete all existing stories

Kind: instance method of StoryblokApiClient

storyblokApiClient.deleteStory(storyId) ⇒ number

delete a specific story

Kind: instance method of StoryblokApiClient Returns: number - id of story that was removed

storyblokApiClient.getComponent(componentId) ⇒ Object

get a specific component

Kind: instance method of StoryblokApiClient Returns: Object - component definition

storyblokApiClient.getExistingAssets() ⇒ Array.<Object>

list all existing assets

Kind: instance method of StoryblokApiClient Returns: Array.<Object> - full list of existing assets

storyblokApiClient.getExistingAssetFolders() ⇒ Array.<Object>

list all existing asset folders

Kind: instance method of StoryblokApiClient Returns: Array.<Object> - List of asset folder details

storyblokApiClient.getExistingComponents() ⇒ Array.<Object>

list all existing components (it is assumed that the working space has at most 1000 existing components)

Kind: instance method of StoryblokApiClient Returns: Array.<Object> - List of component definitions

storyblokApiClient.getExistingStories() ⇒ Array.<Object>

list all existing stories

Kind: instance method of StoryblokApiClient Returns: Array.<Object> - full list of existing content stories

storyblokApiClient.getSpace() ⇒ Object

get information on the working space

Kind: instance method of StoryblokApiClient Returns: Object - space information

storyblokApiClient.getStory(storyId) ⇒ Object

get a specific story

Kind: instance method of StoryblokApiClient Returns: Object - details of content story

storyblokApiClient.publishExistingStories() ⇒ Array.<number>

publish existing stories

Kind: instance method of StoryblokApiClient Returns: Array.<number> - list of published story id's

storyblokApiClient.publishStory(storyId) ⇒ number

publish a specific story

Kind: instance method of StoryblokApiClient Returns: number - published story id

storyblokApiClient.reorderStory(storyId, afterId) ⇒ Object

modify a story's sequential order

Kind: instance method of StoryblokApiClient Returns: Object - details of the moved story

storyblokApiClient.signAsset(filename) ⇒ Object

register a file as a Storyblok asset the physical file still has to be uploaded

Kind: instance method of StoryblokApiClient Returns: Object - asset signing info

storyblokApiClient.uploadAsset(buffer, signedRequest) ⇒ string

physically upload an asset after it is registered with 'signAsset()' method

Kind: instance method of StoryblokApiClient Returns: string - Url to access the asset

apiErrorHandler(error, fnName)

API error handler

Kind: global function

bufferImage(filePath, compression, dimLimit) ⇒ Promise.<Buffer>

Using 'sharp' library to generate data buffer image compression is applied accordingly

Kind: global function Returns: Promise.<Buffer> - buffered image data

compressImage(image, compression) ⇒ Object

takes a sharp.js image object and compress as specified

Kind: global function Returns: Object - processed sharp.js image object

resizeImage(image, dimLimit) ⇒ Object

takes a sharp.js image object and resize as specified

Kind: global function Returns: Object - processed sharp.js image object