edouardr/kenticoclouddeliverytypescriptsdk

Kentico Cloud Delivery TypeScript SDK

Kentico Cloud Delivery JavaScript / TypeScript SDK

A client library for retrieving content from Kentico Cloud that supports JavaScript and TypeScript.

TypeScript	JavaScript
Documentation	Documentation
Quick start	Quick start
Sample apps
JavaScript app	Angular 4 app
API documentation
Get items (Observable)	Get items (Observable)
Get items (Promise)	Get items (Promise)
Creating models	Creating models
Model generator	Model generator
Initialize client	Initialize client
Query parameters	Query parameters
Filtering	Filtering
Sorting	Sorting
Localization	Localization
Property binding / Model decorators	Property binding
Preview mode	Preview mode
URL slugs	URL slugs
Rich text resolver	Rich text resolver
Strongly typed nested property	N/A
Get types	Get types
Get taxonomies	Get taxonomies
Errors
Handling errors	Handling errors
Debugging
Request data	Request data
Getting URL	Getting URL

Node.js support

Visit this wiki page to see how you can use this SDK in Node.js environment.

Quick start

npm i kentico-cloud-delivery-typescript-sdk --save

TypeScript (ES6)

import { ContentItem, Fields } from 'kentico-cloud-delivery-typescript-sdk';

/**
Each content type needs to have model class
*/
export class Movie extends ContentItem {
  public title: Fields.TextField;
}

/**
* Type resolvers make sure instance of proper class is created for your content types
*/
let typeResolvers: TypeResolver[] = [
    new TypeResolver('movie', () => new Movie()),
  ];

/**
 * Create new instance of Delivery Client
 */
var deliveryClient = new DeliveryClient(
  new DeliveryClientConfig('projectId', typeResolvers)
  );

/**
* Get data from Cloud
*/
deliveryClient.items<Movie>()
  .type('movie')
  .get()
  .subscribe(response => {
    console.log(response);
    // you can access strongly types properties
    console.log(response.items[0].title.text);
  });

JavaScript (CommonJS)

var KenticoCloud = require('kentico-cloud-delivery-typescript-sdk');

/**
Each content type needs to have model class
*/
class Movie extends KenticoCloud.ContentItem {
    constructor() {
        super();
    }
}

/**
* Type resolvers make sure instance of proper class is created for your content types
*/
var typeResolvers = [
    new KenticoCloud.TypeResolver('movie', () => new Movie()),
];

/**
 * Delivery client configuration object
 */
var config = new KenticoCloud.DeliveryClientConfig(projectId, typeResolvers);

/**
 * Create new instance of Delivery Client
 */
var deliveryClient = new KenticoCloud.DeliveryClient(config);

/**
 * Fetch all items of 'movie' type and given parameters from Kentico Cloud
 */
deliveryClient.items()
    .type('movie')
    .get()
    .subscribe(response => console.log(response));

Scripts

• Use npm test to run all tests.
• Use npm run dev-test to run developer tests created in dev-test folder. Use this for your testing purposes.
• Use npm run nodejs-test runs Node.js application and checks if response was successful
• Use npm run build to generate definitions & dist from the contents of lib folder.
• Use npm run coveralls to push coverage data directly to https://coveralls.io. Can be executed only after runningnpm test.

Feedback & Contribution

Feedback & Contributions are welcomed. Feel free to take/start an issue & submit PR.