@kontent-ai/delivery-sdk 16.4.3 → 16.4.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.npmignore +15 -15
- package/LICENSE.md +9 -9
- package/dist/bundles/kontent-delivery.umd.js +5076 -4619
- package/dist/bundles/kontent-delivery.umd.js.map +1 -1
- package/dist/bundles/kontent-delivery.umd.min.js +1 -1
- package/dist/bundles/kontent-delivery.umd.min.js.map +1 -1
- package/dist/bundles/report.json +1 -1
- package/dist/bundles/report.min.json +1 -1
- package/dist/bundles/stats.json +7015 -5766
- package/dist/bundles/stats.min.json +11376 -10250
- package/dist/cjs/query/element/element-query.class.js +1 -1
- package/dist/cjs/query/element/element-query.class.js.map +1 -1
- package/dist/cjs/query/item/single-item-query.class.js +1 -1
- package/dist/cjs/query/item/single-item-query.class.js.map +1 -1
- package/dist/cjs/query/taxonomy/taxonomy-query.class.js +1 -1
- package/dist/cjs/query/taxonomy/taxonomy-query.class.js.map +1 -1
- package/dist/cjs/query/type/single-type-query.class.js +1 -1
- package/dist/cjs/query/type/single-type-query.class.js.map +1 -1
- package/dist/cjs/query/used-in/used-in-query.class.js +1 -1
- package/dist/cjs/query/used-in/used-in-query.class.js.map +1 -1
- package/dist/cjs/sdk-info.generated.js +1 -1
- package/dist/es6/query/element/element-query.class.js +1 -1
- package/dist/es6/query/element/element-query.class.js.map +1 -1
- package/dist/es6/query/item/single-item-query.class.js +1 -1
- package/dist/es6/query/item/single-item-query.class.js.map +1 -1
- package/dist/es6/query/taxonomy/taxonomy-query.class.js +1 -1
- package/dist/es6/query/taxonomy/taxonomy-query.class.js.map +1 -1
- package/dist/es6/query/type/single-type-query.class.js +1 -1
- package/dist/es6/query/type/single-type-query.class.js.map +1 -1
- package/dist/es6/query/used-in/used-in-query.class.js +1 -1
- package/dist/es6/query/used-in/used-in-query.class.js.map +1 -1
- package/dist/es6/sdk-info.generated.js +1 -1
- package/dist/esnext/query/element/element-query.class.js +1 -1
- package/dist/esnext/query/element/element-query.class.js.map +1 -1
- package/dist/esnext/query/item/single-item-query.class.js +1 -1
- package/dist/esnext/query/item/single-item-query.class.js.map +1 -1
- package/dist/esnext/query/taxonomy/taxonomy-query.class.js +1 -1
- package/dist/esnext/query/taxonomy/taxonomy-query.class.js.map +1 -1
- package/dist/esnext/query/type/single-type-query.class.js +1 -1
- package/dist/esnext/query/type/single-type-query.class.js.map +1 -1
- package/dist/esnext/query/used-in/used-in-query.class.js +1 -1
- package/dist/esnext/query/used-in/used-in-query.class.js.map +1 -1
- package/dist/esnext/sdk-info.generated.js +1 -1
- package/lib/client/delivery-client.factory.ts +9 -9
- package/lib/client/delivery-client.ts +163 -163
- package/lib/client/idelivery-client.interface.ts +110 -110
- package/lib/client/index.ts +3 -3
- package/lib/config/delivery-configs.ts +98 -98
- package/lib/config/index.ts +1 -1
- package/lib/contracts/contracts.ts +265 -265
- package/lib/contracts/index.ts +1 -1
- package/lib/elements/element-models.ts +89 -89
- package/lib/elements/element-resolver.ts +3 -3
- package/lib/elements/element-type.ts +16 -16
- package/lib/elements/elements.ts +70 -70
- package/lib/elements/index.ts +4 -4
- package/lib/images/image-url-transformation-builder.factory.ts +5 -5
- package/lib/images/image-url-transformation-builder.ts +181 -181
- package/lib/images/image.models.ts +4 -4
- package/lib/images/index.ts +3 -3
- package/lib/index.ts +12 -12
- package/lib/mappers/element.mapper.ts +504 -504
- package/lib/mappers/generic-element.mapper.ts +20 -20
- package/lib/mappers/index.ts +8 -8
- package/lib/mappers/item.mapper.ts +181 -181
- package/lib/mappers/language.mapper.ts +24 -24
- package/lib/mappers/sync.mapper.ts +32 -32
- package/lib/mappers/taxonomy.mapper.ts +77 -77
- package/lib/mappers/type.mapper.ts +76 -76
- package/lib/mappers/used-in.mapper.ts +20 -20
- package/lib/models/common/base-responses.ts +13 -13
- package/lib/models/common/common-models.ts +118 -118
- package/lib/models/common/filters.ts +280 -280
- package/lib/models/common/headers.ts +5 -5
- package/lib/models/common/index.ts +7 -7
- package/lib/models/common/pagination.class.ts +7 -7
- package/lib/models/common/parameters.ts +189 -189
- package/lib/models/common/sort-order.ts +1 -1
- package/lib/models/content-type-models.ts +42 -42
- package/lib/models/element-models.ts +51 -51
- package/lib/models/index.ts +9 -9
- package/lib/models/item-models.ts +192 -192
- package/lib/models/language-models.ts +17 -17
- package/lib/models/responses.ts +137 -137
- package/lib/models/sync-models.ts +18 -18
- package/lib/models/taxonomy-models.ts +25 -25
- package/lib/query/common/base-item-listing-query.class.ts +274 -274
- package/lib/query/common/base-listing-query.class.ts +95 -95
- package/lib/query/common/base-query.class.ts +148 -148
- package/lib/query/element/element-query.class.ts +47 -45
- package/lib/query/index.ts +13 -13
- package/lib/query/item/multiple-items-query.class.ts +183 -183
- package/lib/query/item/single-item-query.class.ts +106 -106
- package/lib/query/items-feed/items-feed-query.class.ts +191 -191
- package/lib/query/language/languages-query.class.ts +91 -91
- package/lib/query/sync/initialize-sync-query.class.ts +83 -83
- package/lib/query/sync/sync-changes-query.class.ts +56 -56
- package/lib/query/taxonomy/taxonomies-query.class.ts +82 -82
- package/lib/query/taxonomy/taxonomy-query.class.ts +50 -50
- package/lib/query/type/multiple-type-query.class.ts +95 -95
- package/lib/query/type/single-type-query.class.ts +45 -45
- package/lib/query/used-in/used-in-query.class.ts +128 -126
- package/lib/sdk-info.generated.ts +1 -1
- package/lib/services/base-delivery-query.service.ts +375 -375
- package/lib/services/delivery-query.service.ts +336 -336
- package/lib/services/index.ts +2 -2
- package/lib/services/mapping.service.ts +223 -223
- package/lib/utilities/codename.helper.ts +10 -10
- package/lib/utilities/delivery-url.helper.ts +11 -11
- package/lib/utilities/enum.helper.ts +38 -38
- package/lib/utilities/index.ts +3 -3
- package/package.json +96 -96
- package/readme.md +531 -531
|
@@ -1,98 +1,98 @@
|
|
|
1
|
-
import { IHeader, IHttpService, IRetryStrategyOptions } from '@kontent-ai/core-sdk';
|
|
2
|
-
|
|
3
|
-
import { ElementResolver } from '../elements';
|
|
4
|
-
import { IProxyUrlData, IQueryConfig, LinkedItemsReferenceHandler } from '../models';
|
|
5
|
-
|
|
6
|
-
export interface IDeliveryClientProxyConfig {
|
|
7
|
-
/**
|
|
8
|
-
* Base url used for preview reqeusts. Defaults to 'preview-deliver.kontent.ai'
|
|
9
|
-
*/
|
|
10
|
-
basePreviewUrl?: string;
|
|
11
|
-
|
|
12
|
-
/**
|
|
13
|
-
* Can be used to generate custom request urls.
|
|
14
|
-
* Useful when you have a proxy server and need to transform url to a specific format
|
|
15
|
-
* and setting 'baseUrl' is not sufficient.
|
|
16
|
-
*/
|
|
17
|
-
advancedProxyUrlResolver?: (data: IProxyUrlData) => string;
|
|
18
|
-
|
|
19
|
-
/**
|
|
20
|
-
* Base url used for all requests. Defaults to 'deliver.kontent.ai'
|
|
21
|
-
*/
|
|
22
|
-
baseUrl?: string;
|
|
23
|
-
}
|
|
24
|
-
|
|
25
|
-
export interface IDeliveryClientConfig {
|
|
26
|
-
/**
|
|
27
|
-
* EnvironmentId
|
|
28
|
-
*/
|
|
29
|
-
environmentId: string;
|
|
30
|
-
|
|
31
|
-
/**
|
|
32
|
-
* Preview API key
|
|
33
|
-
*/
|
|
34
|
-
previewApiKey?: string;
|
|
35
|
-
|
|
36
|
-
/**
|
|
37
|
-
* Secure API key
|
|
38
|
-
* Important: Use secured API only when running on Node.JS server, otherwise
|
|
39
|
-
* your key would be exposed in browsers
|
|
40
|
-
*/
|
|
41
|
-
secureApiKey?: string;
|
|
42
|
-
|
|
43
|
-
/**
|
|
44
|
-
* Resolver used for using custom models for custom elements.
|
|
45
|
-
*/
|
|
46
|
-
elementResolver?: ElementResolver;
|
|
47
|
-
|
|
48
|
-
/**
|
|
49
|
-
* Proxy configuration
|
|
50
|
-
*/
|
|
51
|
-
proxy?: IDeliveryClientProxyConfig;
|
|
52
|
-
|
|
53
|
-
/**
|
|
54
|
-
* Default language of content items
|
|
55
|
-
*/
|
|
56
|
-
defaultLanguage?: string;
|
|
57
|
-
|
|
58
|
-
/**
|
|
59
|
-
* Retry policy configuration
|
|
60
|
-
*/
|
|
61
|
-
retryStrategy?: IRetryStrategyOptions;
|
|
62
|
-
|
|
63
|
-
/**
|
|
64
|
-
* Can be used to inject custom Http service to perform requests
|
|
65
|
-
*/
|
|
66
|
-
httpService?: IHttpService<any>;
|
|
67
|
-
|
|
68
|
-
/**
|
|
69
|
-
* Extra headers added to each http request
|
|
70
|
-
*/
|
|
71
|
-
globalHeaders?: (queryConfig: IQueryConfig) => IHeader[];
|
|
72
|
-
|
|
73
|
-
/**
|
|
74
|
-
* Default query configuration. Can be overriden by individual queries.
|
|
75
|
-
*/
|
|
76
|
-
defaultQueryConfig?: IQueryConfig;
|
|
77
|
-
|
|
78
|
-
/**
|
|
79
|
-
* Indicates how linked item references are handled (can be used to disable refence mapping when you encounter an issue
|
|
80
|
-
* with circular refences)
|
|
81
|
-
*/
|
|
82
|
-
linkedItemsReferenceHandler?: LinkedItemsReferenceHandler;
|
|
83
|
-
|
|
84
|
-
/**
|
|
85
|
-
* Sets custom domain for assets
|
|
86
|
-
*/
|
|
87
|
-
assetsDomain?: string;
|
|
88
|
-
|
|
89
|
-
/**
|
|
90
|
-
* Codename of rendition preset to be applied by default to the base asset URL path.
|
|
91
|
-
*/
|
|
92
|
-
defaultRenditionPreset?: string;
|
|
93
|
-
|
|
94
|
-
/**
|
|
95
|
-
* Can be used to exclude archived items from all queries by default. Only applicable when preview API is used
|
|
96
|
-
*/
|
|
97
|
-
excludeArchivedItems?: boolean;
|
|
98
|
-
}
|
|
1
|
+
import { IHeader, IHttpService, IRetryStrategyOptions } from '@kontent-ai/core-sdk';
|
|
2
|
+
|
|
3
|
+
import { ElementResolver } from '../elements';
|
|
4
|
+
import { IProxyUrlData, IQueryConfig, LinkedItemsReferenceHandler } from '../models';
|
|
5
|
+
|
|
6
|
+
export interface IDeliveryClientProxyConfig {
|
|
7
|
+
/**
|
|
8
|
+
* Base url used for preview reqeusts. Defaults to 'preview-deliver.kontent.ai'
|
|
9
|
+
*/
|
|
10
|
+
basePreviewUrl?: string;
|
|
11
|
+
|
|
12
|
+
/**
|
|
13
|
+
* Can be used to generate custom request urls.
|
|
14
|
+
* Useful when you have a proxy server and need to transform url to a specific format
|
|
15
|
+
* and setting 'baseUrl' is not sufficient.
|
|
16
|
+
*/
|
|
17
|
+
advancedProxyUrlResolver?: (data: IProxyUrlData) => string;
|
|
18
|
+
|
|
19
|
+
/**
|
|
20
|
+
* Base url used for all requests. Defaults to 'deliver.kontent.ai'
|
|
21
|
+
*/
|
|
22
|
+
baseUrl?: string;
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
export interface IDeliveryClientConfig {
|
|
26
|
+
/**
|
|
27
|
+
* EnvironmentId
|
|
28
|
+
*/
|
|
29
|
+
environmentId: string;
|
|
30
|
+
|
|
31
|
+
/**
|
|
32
|
+
* Preview API key
|
|
33
|
+
*/
|
|
34
|
+
previewApiKey?: string;
|
|
35
|
+
|
|
36
|
+
/**
|
|
37
|
+
* Secure API key
|
|
38
|
+
* Important: Use secured API only when running on Node.JS server, otherwise
|
|
39
|
+
* your key would be exposed in browsers
|
|
40
|
+
*/
|
|
41
|
+
secureApiKey?: string;
|
|
42
|
+
|
|
43
|
+
/**
|
|
44
|
+
* Resolver used for using custom models for custom elements.
|
|
45
|
+
*/
|
|
46
|
+
elementResolver?: ElementResolver;
|
|
47
|
+
|
|
48
|
+
/**
|
|
49
|
+
* Proxy configuration
|
|
50
|
+
*/
|
|
51
|
+
proxy?: IDeliveryClientProxyConfig;
|
|
52
|
+
|
|
53
|
+
/**
|
|
54
|
+
* Default language of content items
|
|
55
|
+
*/
|
|
56
|
+
defaultLanguage?: string;
|
|
57
|
+
|
|
58
|
+
/**
|
|
59
|
+
* Retry policy configuration
|
|
60
|
+
*/
|
|
61
|
+
retryStrategy?: IRetryStrategyOptions;
|
|
62
|
+
|
|
63
|
+
/**
|
|
64
|
+
* Can be used to inject custom Http service to perform requests
|
|
65
|
+
*/
|
|
66
|
+
httpService?: IHttpService<any>;
|
|
67
|
+
|
|
68
|
+
/**
|
|
69
|
+
* Extra headers added to each http request
|
|
70
|
+
*/
|
|
71
|
+
globalHeaders?: (queryConfig: IQueryConfig) => IHeader[];
|
|
72
|
+
|
|
73
|
+
/**
|
|
74
|
+
* Default query configuration. Can be overriden by individual queries.
|
|
75
|
+
*/
|
|
76
|
+
defaultQueryConfig?: IQueryConfig;
|
|
77
|
+
|
|
78
|
+
/**
|
|
79
|
+
* Indicates how linked item references are handled (can be used to disable refence mapping when you encounter an issue
|
|
80
|
+
* with circular refences)
|
|
81
|
+
*/
|
|
82
|
+
linkedItemsReferenceHandler?: LinkedItemsReferenceHandler;
|
|
83
|
+
|
|
84
|
+
/**
|
|
85
|
+
* Sets custom domain for assets
|
|
86
|
+
*/
|
|
87
|
+
assetsDomain?: string;
|
|
88
|
+
|
|
89
|
+
/**
|
|
90
|
+
* Codename of rendition preset to be applied by default to the base asset URL path.
|
|
91
|
+
*/
|
|
92
|
+
defaultRenditionPreset?: string;
|
|
93
|
+
|
|
94
|
+
/**
|
|
95
|
+
* Can be used to exclude archived items from all queries by default. Only applicable when preview API is used
|
|
96
|
+
*/
|
|
97
|
+
excludeArchivedItems?: boolean;
|
|
98
|
+
}
|
package/lib/config/index.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export * from './delivery-configs';
|
|
1
|
+
export * from './delivery-configs';
|