From 926f4edddb6ebec8f3b982d4228a057de1082484 Mon Sep 17 00:00:00 2001 From: Johan Petersson Date: Mon, 5 Jul 2021 15:35:22 +0200 Subject: [PATCH] Publishes pre-release 1 --- README.md | 2 ++ src/@episerver/content-definitions/README.md | 4 ++-- .../content-definitions/package-lock.json | 4 ++-- src/@episerver/content-definitions/package.json | 7 ++++--- src/@episerver/content-delivery/README.md | 15 ++++++++++++--- src/@episerver/content-delivery/package-lock.json | 4 ++-- src/@episerver/content-delivery/package.json | 12 +++++++----- 7 files changed, 31 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 919157c..14f3b15 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,8 @@ This repository contains the source code for the Content Delivery SDKs and samples. +> Note the SDK is in preview. Please provide feedback and report issues. + Visit [Episerver World](https://world.episerver.com/documentation/developer-guides/content-delivery-api/) for full documentation of the REST APIs. ## Content Definitions diff --git a/src/@episerver/content-definitions/README.md b/src/@episerver/content-definitions/README.md index 3bc98ab..88e3f32 100644 --- a/src/@episerver/content-definitions/README.md +++ b/src/@episerver/content-definitions/README.md @@ -9,13 +9,13 @@ Please visit [Episerver World](https://world.episerver.com/) for full documentat Using npm: ```bash -$ npm install @episerver/content-definitions +$ npm install @episerver/content-definitions@latest --save-dev ```` using yarn: ```bash -$ yarn install @episerver/content-definitions +$ yarn install @episerver/content-definitions@latest --save-dev ```` ## Examples diff --git a/src/@episerver/content-definitions/package-lock.json b/src/@episerver/content-definitions/package-lock.json index d9d7d88..95d354f 100644 --- a/src/@episerver/content-definitions/package-lock.json +++ b/src/@episerver/content-definitions/package-lock.json @@ -1,11 +1,11 @@ { "name": "@episerver/content-definitions", - "version": "1.0.0", + "version": "1.0.0-pre.1", "lockfileVersion": 2, "requires": true, "packages": { "": { - "version": "1.0.0", + "version": "1.0.0-pre.1", "license": "Apache-2.0", "dependencies": { "commander": "^6.2.0", diff --git a/src/@episerver/content-definitions/package.json b/src/@episerver/content-definitions/package.json index 41a242e..cd8f738 100644 --- a/src/@episerver/content-definitions/package.json +++ b/src/@episerver/content-definitions/package.json @@ -1,11 +1,12 @@ { "name": "@episerver/content-definitions", - "version": "1.0.0", - "description": "Episerver tool for managing content definitions manifest files.", - "author": "Johan Petersson ", + "version": "1.0.0-pre.1", + "description": "CLI tool for managing content definitions manifest files.", + "author": "Johan Petersson ", "license": "Apache-2.0", "keywords": [ "episerver", + "optimizely", "manifest", "definitions" ], diff --git a/src/@episerver/content-delivery/README.md b/src/@episerver/content-delivery/README.md index 9144364..b0b1ef4 100644 --- a/src/@episerver/content-delivery/README.md +++ b/src/@episerver/content-delivery/README.md @@ -2,20 +2,29 @@ SDK for loading and resolving content from an Episerver application running the [Content Delivery API](https://world.episerver.com/documentation/developer-guides/content-delivery-api/). The SDK is written in TypeScript and includes types. -Please visit [Episerver World](https://world.episerver.com/) for full documentation of the APIs. +Please visit [Episerver World](https://world.episerver.com/) for full documentation of the APIs. + +> Note that this SDK requires you to use the flattened JSON format, see code example below how to configure the API to use this format. + +```cs +services.AddContentDeliveryApi(options => +{ + options.FlattenPropertyModel = true; +}); +``` ## Installing Using npm: ```bash -$ npm install @episerver/content-delivery +$ npm install @episerver/content-delivery@latest ```` using yarn: ```bash -$ yarn install @episerver/content-delivery +$ yarn install @episerver/content-delivery@latest ```` ## Examples diff --git a/src/@episerver/content-delivery/package-lock.json b/src/@episerver/content-delivery/package-lock.json index 81bf921..132255b 100644 --- a/src/@episerver/content-delivery/package-lock.json +++ b/src/@episerver/content-delivery/package-lock.json @@ -1,12 +1,12 @@ { "name": "@episerver/content-delivery", - "version": "1.0.0", + "version": "1.0.0-pre.1", "lockfileVersion": 2, "requires": true, "lockfilenpmVersion": 2, "packages": { "": { - "version": "1.0.0", + "version": "1.0.0-pre.1", "license": "Apache-2.0", "dependencies": { "cross-fetch": "^3.1.4" diff --git a/src/@episerver/content-delivery/package.json b/src/@episerver/content-delivery/package.json index 8501977..7d2da42 100644 --- a/src/@episerver/content-delivery/package.json +++ b/src/@episerver/content-delivery/package.json @@ -1,14 +1,16 @@ { "name": "@episerver/content-delivery", - "version": "1.0.0", - "description": "Episerver SDK for content delivery.", - "author": "Johan Petersson ", + "version": "1.0.0-pre.1", + "description": "SDK for the Episerver Content Delivery API.", + "author": "Johan Petersson ", "license": "Apache-2.0", "keywords": [ "episerver", + "optimizely", "content delivery", "headless", - "sdk" + "sdk", + "client" ], "homepage": "https://www.episerver.com", "repository": { @@ -21,7 +23,7 @@ "scripts": { "build": "npx tsc", "watch": "npx tsc --watch", - "test": "mocha --recursive --timeout 5000 --require ./test/fixture.mjs" + "test": "mocha --recursive --timeout 5000 --require ./test/fixture.mjs" }, "devDependencies": { "@types/chai": "^4.2.17",