@kontent-ai/delivery-sdk 16.4.3 → 16.4.4
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 +5077 -4620
- 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 +7195 -5946
- package/dist/bundles/stats.min.json +11923 -10797
- package/dist/cjs/sdk-info.generated.js +1 -1
- package/dist/es6/sdk-info.generated.js +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 +45 -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 +126 -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,89 +1,89 @@
|
|
|
1
|
-
import { Contracts } from '../contracts';
|
|
2
|
-
import { IContentItemSystemAttributes } from '../models/item-models';
|
|
3
|
-
import { ElementType } from './element-type';
|
|
4
|
-
|
|
5
|
-
export namespace ElementModels {
|
|
6
|
-
export interface IElementWrapper {
|
|
7
|
-
element: string;
|
|
8
|
-
system: IContentItemSystemAttributes;
|
|
9
|
-
rawElement: Contracts.IElementContract;
|
|
10
|
-
}
|
|
11
|
-
|
|
12
|
-
export interface IElement<TValue> {
|
|
13
|
-
/**
|
|
14
|
-
* Name of the element
|
|
15
|
-
*/
|
|
16
|
-
name: string;
|
|
17
|
-
|
|
18
|
-
/**
|
|
19
|
-
* Element type
|
|
20
|
-
*/
|
|
21
|
-
type: ElementType;
|
|
22
|
-
|
|
23
|
-
/**
|
|
24
|
-
* Element value
|
|
25
|
-
*/
|
|
26
|
-
value: TValue;
|
|
27
|
-
}
|
|
28
|
-
|
|
29
|
-
export interface AssetModel {
|
|
30
|
-
/**
|
|
31
|
-
* Name of the asset
|
|
32
|
-
*/
|
|
33
|
-
name: string;
|
|
34
|
-
|
|
35
|
-
/**
|
|
36
|
-
* Type of the asset
|
|
37
|
-
*/
|
|
38
|
-
type: string;
|
|
39
|
-
|
|
40
|
-
/**
|
|
41
|
-
* Size of the asset
|
|
42
|
-
*/
|
|
43
|
-
size: number;
|
|
44
|
-
|
|
45
|
-
/**
|
|
46
|
-
* Description of the asset
|
|
47
|
-
*/
|
|
48
|
-
description: string | null;
|
|
49
|
-
|
|
50
|
-
/**
|
|
51
|
-
* Url of the asset
|
|
52
|
-
*/
|
|
53
|
-
url: string;
|
|
54
|
-
|
|
55
|
-
/**
|
|
56
|
-
* Width in pixels for image assets
|
|
57
|
-
*/
|
|
58
|
-
width: number | null;
|
|
59
|
-
|
|
60
|
-
/**
|
|
61
|
-
* Height in pixels for image assets
|
|
62
|
-
*/
|
|
63
|
-
height: number | null;
|
|
64
|
-
|
|
65
|
-
/**
|
|
66
|
-
* Dictionary with rendition preset codenames as keys and respective renditions as values.
|
|
67
|
-
*/
|
|
68
|
-
renditions: { [renditionPresetCodename: string]: Rendition } | null;
|
|
69
|
-
}
|
|
70
|
-
|
|
71
|
-
export interface Rendition {
|
|
72
|
-
rendition_id: string;
|
|
73
|
-
preset_id: string;
|
|
74
|
-
width: number;
|
|
75
|
-
height: number;
|
|
76
|
-
query: string;
|
|
77
|
-
url: string;
|
|
78
|
-
}
|
|
79
|
-
|
|
80
|
-
export interface MultipleChoiceOption<TOptionCodename extends string = string> {
|
|
81
|
-
name: string;
|
|
82
|
-
codename: TOptionCodename;
|
|
83
|
-
}
|
|
84
|
-
|
|
85
|
-
export interface TaxonomyTerm<TTaxonomyCodename extends string = string> {
|
|
86
|
-
name: string;
|
|
87
|
-
codename: TTaxonomyCodename;
|
|
88
|
-
}
|
|
89
|
-
}
|
|
1
|
+
import { Contracts } from '../contracts';
|
|
2
|
+
import { IContentItemSystemAttributes } from '../models/item-models';
|
|
3
|
+
import { ElementType } from './element-type';
|
|
4
|
+
|
|
5
|
+
export namespace ElementModels {
|
|
6
|
+
export interface IElementWrapper {
|
|
7
|
+
element: string;
|
|
8
|
+
system: IContentItemSystemAttributes;
|
|
9
|
+
rawElement: Contracts.IElementContract;
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
export interface IElement<TValue> {
|
|
13
|
+
/**
|
|
14
|
+
* Name of the element
|
|
15
|
+
*/
|
|
16
|
+
name: string;
|
|
17
|
+
|
|
18
|
+
/**
|
|
19
|
+
* Element type
|
|
20
|
+
*/
|
|
21
|
+
type: ElementType;
|
|
22
|
+
|
|
23
|
+
/**
|
|
24
|
+
* Element value
|
|
25
|
+
*/
|
|
26
|
+
value: TValue;
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
export interface AssetModel {
|
|
30
|
+
/**
|
|
31
|
+
* Name of the asset
|
|
32
|
+
*/
|
|
33
|
+
name: string;
|
|
34
|
+
|
|
35
|
+
/**
|
|
36
|
+
* Type of the asset
|
|
37
|
+
*/
|
|
38
|
+
type: string;
|
|
39
|
+
|
|
40
|
+
/**
|
|
41
|
+
* Size of the asset
|
|
42
|
+
*/
|
|
43
|
+
size: number;
|
|
44
|
+
|
|
45
|
+
/**
|
|
46
|
+
* Description of the asset
|
|
47
|
+
*/
|
|
48
|
+
description: string | null;
|
|
49
|
+
|
|
50
|
+
/**
|
|
51
|
+
* Url of the asset
|
|
52
|
+
*/
|
|
53
|
+
url: string;
|
|
54
|
+
|
|
55
|
+
/**
|
|
56
|
+
* Width in pixels for image assets
|
|
57
|
+
*/
|
|
58
|
+
width: number | null;
|
|
59
|
+
|
|
60
|
+
/**
|
|
61
|
+
* Height in pixels for image assets
|
|
62
|
+
*/
|
|
63
|
+
height: number | null;
|
|
64
|
+
|
|
65
|
+
/**
|
|
66
|
+
* Dictionary with rendition preset codenames as keys and respective renditions as values.
|
|
67
|
+
*/
|
|
68
|
+
renditions: { [renditionPresetCodename: string]: Rendition } | null;
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
export interface Rendition {
|
|
72
|
+
rendition_id: string;
|
|
73
|
+
preset_id: string;
|
|
74
|
+
width: number;
|
|
75
|
+
height: number;
|
|
76
|
+
query: string;
|
|
77
|
+
url: string;
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
export interface MultipleChoiceOption<TOptionCodename extends string = string> {
|
|
81
|
+
name: string;
|
|
82
|
+
codename: TOptionCodename;
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
export interface TaxonomyTerm<TTaxonomyCodename extends string = string> {
|
|
86
|
+
name: string;
|
|
87
|
+
codename: TTaxonomyCodename;
|
|
88
|
+
}
|
|
89
|
+
}
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
import { ElementModels } from './element-models';
|
|
2
|
-
|
|
3
|
-
export type ElementResolver = (element: ElementModels.IElementWrapper) => any;
|
|
1
|
+
import { ElementModels } from './element-models';
|
|
2
|
+
|
|
3
|
+
export type ElementResolver = (element: ElementModels.IElementWrapper) => any;
|
|
@@ -1,16 +1,16 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Represents codename of Kontent.ai element types
|
|
3
|
-
*/
|
|
4
|
-
export enum ElementType {
|
|
5
|
-
Text = 'text',
|
|
6
|
-
Number = 'number',
|
|
7
|
-
ModularContent = 'modular_content',
|
|
8
|
-
Asset = 'asset',
|
|
9
|
-
DateTime = 'date_time',
|
|
10
|
-
RichText = 'rich_text',
|
|
11
|
-
MultipleChoice = 'multiple_choice',
|
|
12
|
-
UrlSlug = 'url_slug',
|
|
13
|
-
Taxonomy = 'taxonomy',
|
|
14
|
-
Custom = 'custom',
|
|
15
|
-
Unknown = 'unknown'
|
|
16
|
-
}
|
|
1
|
+
/**
|
|
2
|
+
* Represents codename of Kontent.ai element types
|
|
3
|
+
*/
|
|
4
|
+
export enum ElementType {
|
|
5
|
+
Text = 'text',
|
|
6
|
+
Number = 'number',
|
|
7
|
+
ModularContent = 'modular_content',
|
|
8
|
+
Asset = 'asset',
|
|
9
|
+
DateTime = 'date_time',
|
|
10
|
+
RichText = 'rich_text',
|
|
11
|
+
MultipleChoice = 'multiple_choice',
|
|
12
|
+
UrlSlug = 'url_slug',
|
|
13
|
+
Taxonomy = 'taxonomy',
|
|
14
|
+
Custom = 'custom',
|
|
15
|
+
Unknown = 'unknown'
|
|
16
|
+
}
|
package/lib/elements/elements.ts
CHANGED
|
@@ -1,70 +1,70 @@
|
|
|
1
|
-
import { IContentItem, ILink, IRichTextImage } from '../models';
|
|
2
|
-
import { ElementModels } from './element-models';
|
|
3
|
-
|
|
4
|
-
export namespace Elements {
|
|
5
|
-
export type TextElement = ElementModels.IElement<string>;
|
|
6
|
-
|
|
7
|
-
export type LinkedItemsElement<TContentItem extends IContentItem = IContentItem> = ElementModels.IElement<
|
|
8
|
-
string[]
|
|
9
|
-
> & {
|
|
10
|
-
/**
|
|
11
|
-
* Linked items
|
|
12
|
-
*/
|
|
13
|
-
linkedItems: TContentItem[];
|
|
14
|
-
};
|
|
15
|
-
|
|
16
|
-
export type MultipleChoiceElement<TOptionCodenames extends string = string> = ElementModels.IElement<
|
|
17
|
-
ElementModels.MultipleChoiceOption<TOptionCodenames>[]
|
|
18
|
-
>;
|
|
19
|
-
|
|
20
|
-
export type DateTimeElement = ElementModels.IElement<string | null> & {
|
|
21
|
-
/**
|
|
22
|
-
* Display time zone
|
|
23
|
-
*/
|
|
24
|
-
displayTimeZone: string | null;
|
|
25
|
-
};
|
|
26
|
-
|
|
27
|
-
export type RichTextElement<TContentItem extends IContentItem = IContentItem> = ElementModels.IElement<string> & {
|
|
28
|
-
/**
|
|
29
|
-
* Links
|
|
30
|
-
*/
|
|
31
|
-
links: ILink[];
|
|
32
|
-
|
|
33
|
-
/**
|
|
34
|
-
* Images included within rich text element
|
|
35
|
-
*/
|
|
36
|
-
images: IRichTextImage[];
|
|
37
|
-
|
|
38
|
-
/**
|
|
39
|
-
* Array of linked item codenames
|
|
40
|
-
*/
|
|
41
|
-
linkedItemCodenames: string[];
|
|
42
|
-
|
|
43
|
-
/**
|
|
44
|
-
* Array of linked items retrieved from `modular_content` part of the response. Not all items might be here
|
|
45
|
-
* as it depends on the `depth` parameter of query.
|
|
46
|
-
* The `linkedItemsReferenceHandler` configuration can be used to disable mapping of linked items
|
|
47
|
-
*/
|
|
48
|
-
linkedItems: TContentItem[];
|
|
49
|
-
};
|
|
50
|
-
|
|
51
|
-
export type NumberElement = ElementModels.IElement<number | null>;
|
|
52
|
-
|
|
53
|
-
export type AssetsElement = ElementModels.IElement<ElementModels.AssetModel[]>;
|
|
54
|
-
|
|
55
|
-
export type UrlSlugElement = ElementModels.IElement<string>;
|
|
56
|
-
|
|
57
|
-
export type TaxonomyElement<
|
|
58
|
-
TaxonomyCodenames extends string = string,
|
|
59
|
-
TaxonomyGroupCodename extends string = string
|
|
60
|
-
> = ElementModels.IElement<ElementModels.TaxonomyTerm<TaxonomyCodenames>[]> & {
|
|
61
|
-
/**
|
|
62
|
-
* Taxonomy group
|
|
63
|
-
*/
|
|
64
|
-
taxonomyGroup: TaxonomyGroupCodename;
|
|
65
|
-
};
|
|
66
|
-
|
|
67
|
-
export type UnknownElement = ElementModels.IElement<any>;
|
|
68
|
-
|
|
69
|
-
export type CustomElement<TValue = string> = ElementModels.IElement<TValue>;
|
|
70
|
-
}
|
|
1
|
+
import { IContentItem, ILink, IRichTextImage } from '../models';
|
|
2
|
+
import { ElementModels } from './element-models';
|
|
3
|
+
|
|
4
|
+
export namespace Elements {
|
|
5
|
+
export type TextElement = ElementModels.IElement<string>;
|
|
6
|
+
|
|
7
|
+
export type LinkedItemsElement<TContentItem extends IContentItem = IContentItem> = ElementModels.IElement<
|
|
8
|
+
string[]
|
|
9
|
+
> & {
|
|
10
|
+
/**
|
|
11
|
+
* Linked items
|
|
12
|
+
*/
|
|
13
|
+
linkedItems: TContentItem[];
|
|
14
|
+
};
|
|
15
|
+
|
|
16
|
+
export type MultipleChoiceElement<TOptionCodenames extends string = string> = ElementModels.IElement<
|
|
17
|
+
ElementModels.MultipleChoiceOption<TOptionCodenames>[]
|
|
18
|
+
>;
|
|
19
|
+
|
|
20
|
+
export type DateTimeElement = ElementModels.IElement<string | null> & {
|
|
21
|
+
/**
|
|
22
|
+
* Display time zone
|
|
23
|
+
*/
|
|
24
|
+
displayTimeZone: string | null;
|
|
25
|
+
};
|
|
26
|
+
|
|
27
|
+
export type RichTextElement<TContentItem extends IContentItem = IContentItem> = ElementModels.IElement<string> & {
|
|
28
|
+
/**
|
|
29
|
+
* Links
|
|
30
|
+
*/
|
|
31
|
+
links: ILink[];
|
|
32
|
+
|
|
33
|
+
/**
|
|
34
|
+
* Images included within rich text element
|
|
35
|
+
*/
|
|
36
|
+
images: IRichTextImage[];
|
|
37
|
+
|
|
38
|
+
/**
|
|
39
|
+
* Array of linked item codenames
|
|
40
|
+
*/
|
|
41
|
+
linkedItemCodenames: string[];
|
|
42
|
+
|
|
43
|
+
/**
|
|
44
|
+
* Array of linked items retrieved from `modular_content` part of the response. Not all items might be here
|
|
45
|
+
* as it depends on the `depth` parameter of query.
|
|
46
|
+
* The `linkedItemsReferenceHandler` configuration can be used to disable mapping of linked items
|
|
47
|
+
*/
|
|
48
|
+
linkedItems: TContentItem[];
|
|
49
|
+
};
|
|
50
|
+
|
|
51
|
+
export type NumberElement = ElementModels.IElement<number | null>;
|
|
52
|
+
|
|
53
|
+
export type AssetsElement = ElementModels.IElement<ElementModels.AssetModel[]>;
|
|
54
|
+
|
|
55
|
+
export type UrlSlugElement = ElementModels.IElement<string>;
|
|
56
|
+
|
|
57
|
+
export type TaxonomyElement<
|
|
58
|
+
TaxonomyCodenames extends string = string,
|
|
59
|
+
TaxonomyGroupCodename extends string = string
|
|
60
|
+
> = ElementModels.IElement<ElementModels.TaxonomyTerm<TaxonomyCodenames>[]> & {
|
|
61
|
+
/**
|
|
62
|
+
* Taxonomy group
|
|
63
|
+
*/
|
|
64
|
+
taxonomyGroup: TaxonomyGroupCodename;
|
|
65
|
+
};
|
|
66
|
+
|
|
67
|
+
export type UnknownElement = ElementModels.IElement<any>;
|
|
68
|
+
|
|
69
|
+
export type CustomElement<TValue = string> = ElementModels.IElement<TValue>;
|
|
70
|
+
}
|
package/lib/elements/index.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export * from './element-models';
|
|
2
|
-
export * from './element-type';
|
|
3
|
-
export * from './elements';
|
|
4
|
-
export * from './element-resolver';
|
|
1
|
+
export * from './element-models';
|
|
2
|
+
export * from './element-type';
|
|
3
|
+
export * from './elements';
|
|
4
|
+
export * from './element-resolver';
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { ImageUrlTransformationBuilder } from './image-url-transformation-builder';
|
|
2
|
-
|
|
3
|
-
export function transformImageUrl(url: string): ImageUrlTransformationBuilder {
|
|
4
|
-
return new ImageUrlTransformationBuilder(url);
|
|
5
|
-
}
|
|
1
|
+
import { ImageUrlTransformationBuilder } from './image-url-transformation-builder';
|
|
2
|
+
|
|
3
|
+
export function transformImageUrl(url: string): ImageUrlTransformationBuilder {
|
|
4
|
+
return new ImageUrlTransformationBuilder(url);
|
|
5
|
+
}
|