Skip to content

Commit 264eb25

Browse files
committed
feat: upgraded kontent-delivery sdk
BREAKING CHANGE: Vue context name changed from deliveryClient to nuxtDeliveryClient Closes #50
1 parent ee3c9f7 commit 264eb25

File tree

11 files changed

+149
-193
lines changed

11 files changed

+149
-193
lines changed

README.md

Lines changed: 9 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,6 @@ The module makes it easy to do delivery client api calls via the [Kentico konten
1414

1515
```
1616
npm i kentico-kontent-nuxt-module --save
17-
npm i rxjs --save (because this is a peer dependency of the Kentico Kontent Delivery SDK)
18-
1917
```
2018

2119
- Add `kentico-kontent-nuxt-module` to `modules` section of `nuxt.config.js`
@@ -43,11 +41,11 @@ npm i rxjs --save (because this is a peer dependency of the Kentico Kontent Deli
4341
> 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.
4442
4543

46-
- $deliveryClient is now globally available.
44+
- $nuxtDeliveryClient is now globally available.
4745

4846
```javascript
4947

50-
this.$deliveryClient.items()
48+
this.$nuxtDeliveryClient.items()
5149
.type('page')
5250
.toPromise()
5351
.then(response => console.log('DeliveryClient Response', response));
@@ -80,7 +78,7 @@ When using a static generated deployment you may need to use the [items-feed](ht
8078

8179
```javascript
8280

83-
this.$deliveryClient.itemsFeedAll()
81+
this.$nuxtDeliveryClient.itemsFeedAll()
8482
.toPromise()
8583
.then(response => console.log('DeliveryClient Response', response));
8684

@@ -91,9 +89,9 @@ API calls can be "cached" (they will be stored in memory) client side via the "v
9189

9290
```javascript
9391

94-
const query = this.$deliveryClient.items().type('page');
92+
const query = this.$nuxtDeliveryClient.items().type('page');
9593
const cacheSeconds = 30;
96-
this.$deliveryClient.viaCache(query, cacheSeconds)
94+
this.$nuxtDeliveryClient.viaCache(query, cacheSeconds)
9795
.then(response => console.log('DeliveryClient Response', response));
9896

9997
```
@@ -117,23 +115,9 @@ If you need to customize the Kentico Kontent Delivery SDK by registering interce
117115

118116
### plugins/kenticokontentNuxtModule.js
119117

120-
> Version >7.x.x
121-
122118
``` javascript
123-
export default function ({ store, $deliveryClient }) {
124-
$deliveryclient.deliveryClient.config.globalHeaders = (queryConfig) => {
125-
let headers = [];
126-
headers.push({header: 'Authorization', value: 'bearer ' + store.state.token });
127-
return headers;
128-
}
129-
}
130-
```
131-
132-
> Version <7.0.0
133-
134-
``` javascript
135-
export default function ({ store, $deliveryClient }) {
136-
$deliveryClient.config.globalHeaders = (queryConfig) => {
119+
export default function ({ store, $nuxtDeliveryClient }) {
120+
$nuxtDeliveryClient.deliveryClient.config.globalHeaders = (queryConfig) => {
137121
let headers = [];
138122
headers.push({header: 'Authorization', value: 'bearer ' + store.state.token });
139123
return headers;
@@ -147,33 +131,6 @@ Type resolvers can also be registered by using a nuxt plugin:
147131

148132
### plugins/kenticokontentNuxtModule.js
149133

150-
> Version >7.x.x
151-
152-
``` javascript
153-
import { TypeResolver, ContentItem } from '@kentico/kontent-delivery';
154-
155-
class Page extends ContentItem {
156-
constructor() {
157-
super({
158-
richTextResolver: (item, context) => {
159-
// todo: implement
160-
},
161-
urlSlugResolver: (link, context) => {
162-
// todo: implement
163-
}
164-
});
165-
}
166-
}
167-
168-
export default function ({ store, app, $deliveryClient }) {
169-
$deliveryClient.deliveryClient.config.typeResolvers = [
170-
new TypeResolver('page', () => new Page())
171-
]
172-
}
173-
```
174-
175-
> Version <7.0.0
176-
177134
``` javascript
178135
import { TypeResolver, ContentItem } from '@kentico/kontent-delivery';
179136

@@ -190,8 +147,8 @@ class Page extends ContentItem {
190147
}
191148
}
192149

193-
export default function ({ store, app, $deliveryClient }) {
194-
$deliveryClient.config.typeResolvers = [
150+
export default function ({ store, app, $nuxtDeliveryClient }) {
151+
$nuxtDeliveryClient.deliveryClient.config.typeResolvers = [
195152
new TypeResolver('page', () => new Page())
196153
]
197154
}

package-lock.json

Lines changed: 50 additions & 49 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
"test": "yarn lint && jest"
3838
},
3939
"dependencies": {
40-
"@kentico/kontent-delivery": "^10.4.1",
40+
"@kentico/kontent-delivery": "^11.0.0",
4141
"chalk": "^4.1.0"
4242
},
4343
"devDependencies": {

src/index.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import { IDeliveryClientConfig } from '@kentico/kontent-delivery'
55
import defu from 'defu'
66
import { logger } from './utilties/logger'
77
import chalk from 'chalk'
8-
import { NuxtDeliveryClient } from './runtime/NuxtDeliveryClient'
8+
import { NuxtDeliveryClient } from './runtime/nuxt-delivery-client'
99

1010
type Exclude<T, U> = T extends U ? never : T
1111

@@ -47,21 +47,21 @@ const deliveryClientModule: Module<IDeliveryClientConfig> = function (moduleOpti
4747

4848
declare module '@nuxt/types' {
4949
interface Context {
50-
$deliveryclient: NuxtDeliveryClient
50+
$nuxtDeliveryClient: NuxtDeliveryClient
5151
}
5252

5353
interface NuxtAppOptions {
54-
$deliveryclient: NuxtDeliveryClient
54+
$nuxtDeliveryClient: NuxtDeliveryClient
5555
}
5656

5757
interface Configuration {
58-
deliveryclient?: IDeliveryClientConfig
58+
nuxtDeliveryClient?: IDeliveryClientConfig
5959
}
6060
}
6161

6262
declare module 'vue/types/vue' {
6363
interface Vue {
64-
$deliveryclient: NuxtDeliveryClient;
64+
$nuxtDeliveryClient: NuxtDeliveryClient;
6565
}
6666
}
6767

src/runtime/INuxtDeliveryClient.ts

Lines changed: 0 additions & 5 deletions
This file was deleted.

0 commit comments

Comments
 (0)