Installation

To install the package, run the following command:

npm install @elevantiq/storyblok-deep-relations-resolver

# or with yarn

yarn add @elevantiq/storyblok-deep-relations-resolver

Usage

To use the package, simply import it into your project and use the resolve function to resolve the deep relations in your Storyblok API responses.

import {resolveRelationsDeep} from '@elevantiq/storyblok-deep-relations-resolver'

const storyblokApi = getStoryblokApi()

// format: <component>.<field>
export const deepRelations = [
    'articlesTeaser.articles',
    'article.author',
    'article.category',
    'primaryContactTeaser.contactPerson',
]

const {data: preResolveData} = await storyblokApi.get(`cdn/stories/${slug}`, sbParams)

const deepResolvedData = await resolveRelationsDeep(storyblokApi, preResolveData, deepRelations)

For more information on how to use the package, see the documentation.

Contributing

If you would like to contribute to the project, please follow these steps:

• Fork the repository
• Create a new branch for your changes
• Make your changes and commit them with clear commit messages
• Push your changes to your forked repository
• Submit a pull request

License

This project is licensed under the MIT License.

Reporting Bugs

If you find any bugs or issues with the package, please report them by creating a new issue on the GitHub issue tracker.

Contact

If you have any questions or feedback, feel free to contact us at our GitHub profile.