@kentico/sourcebit-source-kontent NPM

sourcebit-source-kontent

A Kontent source plugin for Sourcebit

General

With this plugin, you can add Kontent as a data source for Sourcebit.

⚠ Disclaimer

This project/repository in a work in progress and is not ready for production use yet. The features and APIs might be (and probably will be) changed.

Installation

To install the plugin and add it to your project, run:

npm install @kentico/sourcebit-source-kontent --save

You don't need to run this command if you start Sourcebit using the interactive setup process, as the CLI will install the plugin for you and add it as a dependency to your project.

⚙️ Configuration

The plugin accepts the following configuration parameters. They can be supplied in any of the following ways:

In the options object of the plugin configuration block inside sourcebit.js, with the value of the Property column as a key;
As an environment variable named after the Env variable column, when running the sourcebit fetch command;
As part of a .env file, with the value of the Env variable column separated by the value with an equals sign (e.g. MY_VARIABLE=my-value);
As a CLI parameter, when running the sourcebit fetch command, using the value of the Parameter column as the name of the parameter (e.g. sourcebit fetch --my-parameter).

Property	Type	Visibility	Default value	Env variable	Parameter	Description
`projectId`	String	Public				The ID of the Kontent project.
`languageCodenames`	Array	Public				Array of language codenames

Example configuration

For more info see the example-npm folder which contains already configured @kentico\sourcebit-source-plugin and sourcebit-target-jekyll plugin.

sourcebit.js

module.exports = {
  plugins: [
    {
      module: require("@kentico/sourcebit-source-kontent"),
      options: {
        projectId: "00676a8d-358c-0084-f2f2-33ed466c480a",
        languageCodenames: ["en-US", "cs-CZ"]
      }
    }
  ]
};

Local development

For more info about local development/running of the source plugin see the example-local folder which contains already configured local sourcebit-source-plugin and sourcebit-target-jekyll plugin. For using local plugin run:

npx create-sourcebit --plugins=local-plugins.json

Interactive setup process

This plugin offers an interactive setup process via the npx create-sourcebit command. It asks users for their Kontent projectId and and language codenames.

📥 Input

N/A

📤 Output

This plugin adds normalized entries to the objects data bucket and normalized model objects to the models data bucket.

Limitations

There's a Sourcebit's limitation that the entry field for an asset can contain just one asset, therefore, only one asset per asset element is supported right now.
Entry's metadata createdAt contains last_modified value from Delivery API since Delivery API does not contain created at information.

Release new version

Change version in package.json to 1.2.3 and push a commit with the message Release 1.2.3, the npm-publish action will create a new tag v1.2.3 and publish the package to the npm registry.