Take the community feedback survey now.

MartinOttosen
Dec 17, 2021
  79
(0 votes)

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

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]

APIs

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

Comments

Please login to comment.
Latest blogs
A day in the life of an Optimizely OMVP - Opticon London 2025

This installment of a day in the life of an Optimizely OMVP gives an in-depth coverage of my trip down to London to attend Opticon London 2025 held...

Graham Carr | Oct 2, 2025

Optimizely Web Experimentation Using Real-Time Segments: A Step-by-Step Guide

  Introduction Personalization has become de facto standard for any digital channel to improve the user's engagement KPI’s.  Personalization uses...

Ratish | Oct 1, 2025 |

Trigger DXP Warmup Locally to Catch Bugs & Performance Issues Early

Here’s our documentation on warmup in DXP : 🔗 https://docs.developers.optimizely.com/digital-experience-platform/docs/warming-up-sites What I didn...

dada | Sep 29, 2025

Creating Opal Tools for Stott Robots Handler

This summer, the Netcel Development team and I took part in Optimizely’s Opal Hackathon. The challenge from Optimizely was to extend Opal’s abiliti...

Mark Stott | Sep 28, 2025

Integrating Commerce Search v3 (Vertex AI) with Optimizely Configured Commerce

Introduction This blog provides a technical guide for integrating Commerce Search v3, which leverages Google Cloud's Vertex AI Search, into an...

Vaibhav | Sep 27, 2025

A day in the life of an Optimizely MVP - Opti Graph Extensions add-on v1.0.0 released

I am pleased to announce that the official v1.0.0 of the Opti Graph Extensions add-on has now been released and is generally available. Refer to my...

Graham Carr | Sep 25, 2025