Official Kentico Cloud SDKs

readme.md

Kentico Cloud

This repository contains TypeScript packages related to Kentico Cloud app development.

SDKs Overview

Delivery SDK

npm version Build Status npm Known Vulnerabilities GitHub license Gzip browser bundle

Delivery JavaScript/TypeScript SDK is an official client library used for retrieving content from Kentico Cloud. Both browser and Node.js integrations are supported.

Model generator for Delivery SDK

npm version Build Status npm

A utility for generating strongly-typed models based on Content Types in a Kentico Cloud project.

Bugs & new features

Create a new GitHub issue.

Developing packages

This github repository contains multiple packages (it is a monorepo) and is managed with the help of lerna. In order to start developing this library, you need to:

  • Clone this repository
  • Install lerna globally using npm i lerna -g
  • Prepare all packages by running npm run prepare script in the root repository. This script bootstraps all packages, builds them and bootstraps again so that symlinking local packages works correctly when local version of package is referenced instead of the one published on npm.

To publish this library you can use standard npm publish command after increasing package versions. Some packages in this repository (delivery, content management sdks) require you to also run npm run set-sdk-version script which takes the package name & version from package.json and creates a static file called sdk-info.generated.ts with sdk information which is used to identify sdk calls.

Packages will not let you publish new versions unless the version in package.json & sdk-info.generates.ts matches.

Feedback & Contribution

Feedback & Contributions are welcome. Feel free to start an issue and submit a pull request.

Analytics