Published on:Dec 17, 2021
Views: 2247
Number of votes: 2
Average rating:

JS SDK and Optimizely jamstack

With CMS 12 we introduced long awaited support for .Net 5 not just because it’s faster or adds cross platform support but because .NET Core is the future of .NET. Incidentally, a faster and cross platform CMS is also good news for folks whose interests runs more along the lines of JavaScript, APIs and Markup. The latest CMS 12 addition exposes new capabilities through REST APIs and with it the JS SDK which is now officially released.


The JS SDK has a few pieces to it:

  1. A Node.js CLI for managing your content definitions [GitHub] [npm]
    npx content-definitions push manifest.json
  2. A typescript client for fetching content from the CMS [GitHub] [npm]
    getContent('...', { select: ['heading', 'body'] })
      .then((content) => {
        // Content was successfully loaded
  3. A decoupled Vue.js sample site running on Node.js and CMS 12 [GitHub]


This is not an exhaustive list of APIs, but a good starting point for many decoupled content applications:

  1. Content Delivery API [package], [spec], [docs]
  2. Content Definitions API [package], [spec], [docs]
  3. Content Management API [package], [spec], [docs]

Btw check out this useful list of .NET packages and status with respect to .NET 5.

How to get started

The simplest way to get acquainted with the SDK is to clone the repository and setup the sample site. The sample site is based on CMS 12 and uses the new Content Definitions API and a simple in-process OIDC server based on OpenIddict meaning no need for an external identity provider to get things going, but makes it easy to transition to Azure AD or some other OIDC capable provider once you near production.

The decoupled sample site demonstrates how you can build completely decoupled applications without breaking preview or on-page-edit. Note, at the time of writing on-page-edit is not working in updated chrome browsers, but we expect to have a solution for that soon, which should work with the approach used in this sample.

Dec 17, 2021

Please login to comment.