Merge branch 'master' into dependabot/npm_and_yarn/y18n-4.0.3

Author: Domitnator

README.md

@@ -3,7 +3,7 @@
 [![NPM](https://nodei.co/npm/kentico-kontent-nuxt-module.png?mini=true)](https://npmjs.org/package/kentico-kontent-nuxt-module)
 
 # kentico-kontent-nuxt-module
-Add Kentico Kontent super power to your nuxt app
+Add Kentico Kontent super power to your nuxt app :fire:
 
 ## Features
 
@@ -20,7 +20,7 @@ npm i rxjs --save (because this is a peer dependency of the Kentico Kontent Deli
 
 - Add `kentico-kontent-nuxt-module` to `modules` section of `nuxt.config.js`
 
-```js
+```json
   /*
   ** Nuxt.js modules
   */
@@ -40,6 +40,9 @@ npm i rxjs --save (because this is a peer dependency of the Kentico Kontent Deli
     enableSecuredMode: true
   },
 ```
+> Note: See [the client configuration section](https://github.com/Kentico/kontent-delivery-sdk-js/blob/master/DOCS.md#client-configuration) of the Kentico Kontent Delivery SDK for all available configuration options.
+
+
 - $deliveryClient is now globally available.
 
 ```javascript
@@ -53,6 +56,25 @@ npm i rxjs --save (because this is a peer dependency of the Kentico Kontent Deli
 ### Note:
 By default Nuxt can only work with promises. Therefor you always use the "toPromise" method provided by the Kentico Kontent Delivery SDK! RxJs operator's are not supported at the moment.
 
+# Typescript
+
+Since version 7 the kentico-kontent-nuxt-module has typescript support! 
+
+Add the types to your "types" array in tsconfig.json after the @nuxt/types (Nuxt 2.9.0+) or @nuxt/vue-app entry
+
+```json
+
+ {
+  "compilerOptions": {
+    "types": [
+      "@nuxt/types",
+      "kentico-kontent-nuxt-module"
+    ]
+  }
+}
+
+```
+
 ## Generating
 When using a static generated deployment you may need to use the [items-feed](https://docs.kontent.ai/reference/api-changelog#a-delivery-api-limitation) endpoint when generating your site (because the items endpoint has a rate limitation).
 
@@ -68,6 +90,7 @@ When using a static generated deployment you may need to use the [items-feed](ht
 API calls can be "cached" (they will be stored in memory) client side via the "viaCache" method.
 
 ```javascript
+
  const query =  this.$deliveryClient.items().type('page');
  const cacheSeconds = 30;
  this.$deliveryClient.viaCache(query, cacheSeconds)
@@ -80,7 +103,7 @@ API calls can be "cached" (they will be stored in memory) client side via the "v
 If you need to customize the Kentico Kontent Delivery SDK by registering interceptors and changing global config, you have to create a nuxt plugin.
 
 ### nuxt.config.js
-```
+``` json
 {
   modules: [
     'kentico-kontent-nuxt-module',
@@ -93,7 +116,22 @@ If you need to customize the Kentico Kontent Delivery SDK by registering interce
 ```
 
 ### plugins/kenticokontentNuxtModule.js
+
+> Version >7.x.x
+
+``` javascript
+export default function ({ store, $deliveryClient }) {
+    $deliveryclient.deliveryClient.config.globalHeaders = (queryConfig) => {
+        let headers = [];
+        headers.push({header: 'Authorization', value: 'bearer ' + store.state.token });
+        return headers;
+      }
+  }
 ```
+
+> Version <7.0.0
+
+``` javascript
 export default function ({ store, $deliveryClient }) {
     $deliveryClient.config.globalHeaders = (queryConfig) => {
         let headers = [];
@@ -108,7 +146,35 @@ export default function ({ store, $deliveryClient }) {
 Type resolvers can also be registered by using a nuxt plugin:
 
 ### plugins/kenticokontentNuxtModule.js
+
+> Version >7.x.x
+
+``` javascript
+import { TypeResolver, ContentItem } from '@kentico/kontent-delivery';
+
+class Page extends ContentItem {
+    constructor() {
+        super({
+            richTextResolver: (item, context) => {
+                // todo: implement
+            },
+            urlSlugResolver: (link, context) => {
+                // todo: implement
+            }
+        });
+    }
+}
+
+export default function ({ store, app, $deliveryClient }) {
+    $deliveryClient.deliveryClient.config.typeResolvers = [
+        new TypeResolver('page', () => new Page())
+    ]
+}
 ```
+
+> Version <7.0.0
+
+``` javascript
 import { TypeResolver, ContentItem } from '@kentico/kontent-delivery';
 
 class Page extends ContentItem {

src/index.ts

@@ -1,7 +1,7 @@
 import Vue from 'vue'
 import { resolve } from 'path'
 import { Module, Plugin  } from '@nuxt/types'
-import { ContentItem, DeliveryClient, IDeliveryClientConfig, MultipleItemQuery } from '@kentico/kontent-delivery'
+import { IDeliveryClientConfig } from '@kentico/kontent-delivery'
 import defu from 'defu'
 import { logger } from './utilties/logger'
 import chalk from 'chalk'
@@ -21,16 +21,14 @@ export interface ModuleOptions extends RequireOne<IDeliveryClientConfig, 'projec
 const deliveryClientModule: Module<IDeliveryClientConfig> = function (moduleOptions) {
   const options = defu<ModuleOptions, IDeliveryClientConfig>(this.options.kenticokontent, moduleOptions)
 
-  console.log("Module is initializing...")
-
   if (!options.projectId) {
     logger.error(`You need to provide ${chalk.yellow('projectId')} to set up Kentico Kontent. See 👉 https://github.com/Domitnator/kentico-kontent-nuxt-module for more info.`)
     return
   }
 
   const runtimeDir = resolve(__dirname, 'runtime')
   this.nuxt.options.alias['~deliveryclientruntime'] = runtimeDir
-  this.nuxt.options.build.transpile.push(runtimeDir, 'kentico-kontent-nuxt-module-ts')
+  this.nuxt.options.build.transpile.push(runtimeDir, 'kentico-kontent-nuxt-module')
 
   // Add configuration plugin
   this.addPlugin({
@@ -42,32 +40,34 @@ const deliveryClientModule: Module<IDeliveryClientConfig> = function (moduleOpti
   // Add plugin
   this.addPlugin({
     src: resolve(__dirname, './runtime/plugin.template.js'),
-    fileName: 'deliveryclient/kentico-kontent-nuxt-module-ts.js',
+    fileName: 'deliveryclient/kentico-kontent-nuxt-module.js',
     options
   })
 }
 
 declare module '@nuxt/types' {
   interface Context {
-    $deliveryclient: NuxtDeliveryClient;
+    $deliveryclient: NuxtDeliveryClient
   }
 
   interface NuxtAppOptions {
-    $deliveryclient: NuxtDeliveryClient;
+    $deliveryclient: NuxtDeliveryClient
   }
 
   interface Configuration {
-    deliveryclient?: IDeliveryClientConfig;
+    deliveryclient?: IDeliveryClientConfig
   }
 }
 
 declare module 'vue/types/vue' {
   interface Vue {
-    $deliveryclient: NuxtDeliveryClient
+    $deliveryclient: NuxtDeliveryClient;
   }
 }
 
-const meta = require('../package.json')
+export { NuxtDeliveryClient }
+
+export default deliveryClientModule
 
-export { NuxtDeliveryClient, deliveryClientModule as default, meta };
+export const meta = require('../package.json')
 

src/runtime/plugin.template.ts

@@ -1,12 +1,11 @@
 import { Plugin } from '@nuxt/types'
-import { DeliveryClient, ContentItem, MultipleItemQuery } from "@kentico/kontent-delivery"
 import { NuxtDeliveryClient } from '~deliveryclientruntime/NuxtDeliveryClient'
-// import CacheService from "~deliveryclientruntime/cacheService"
 
 // Default configuration
 let config = {
   kenticokontent: {
-    projectId: ''
+    projectId: '',
+    globalQueryConfig: {}
   }
 }
 
@@ -40,11 +39,27 @@ declare module 'vuex/types/index' {
 }
 
 const deliveryClientPlugin: Plugin = (context, inject) => {
-  console.log('Initializing plugin')
-  console.log('configuration:', config)
+ var kcSourceHeader = { header: 'X-KC-SOURCE', value: 'kentico-kontent-nuxt-module' };
 
+  if(config.kenticokontent.globalQueryConfig){
+    config.kenticokontent.globalQueryConfig = Object.assign({}, config.kenticokontent.globalQueryConfig, {
+        customHeaders: [
+          kcSourceHeader
+        ]
+    });
+  }
+  else{
+    config.kenticokontent = Object.assign({}, config.kenticokontent, {
+      globalQueryConfig: {
+        customHeaders: [
+          kcSourceHeader
+        ]
+      }
+    });
+  }
+
   const deliveryClient = new NuxtDeliveryClient(config.kenticokontent);
-  
+
   inject('deliveryclient', deliveryClient)
 }