@c-rex/interfaces 0.1.7 → 0.1.9

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/dist/index.d.mts CHANGED
@@ -1,5 +1,50 @@
1
- import { LogLevelType, LogCategoriesType, ResultViewStyles, ResultTypes, FilesExtensions, WildCardType } from '@c-rex/types';
1
+ import { LogLevelType, LogCategoriesType, ResultViewStyles, ResultTypes, articlePageLayoutType, FilesExtensions, WildCardType, DocumentsType, articleInfoItemType } from '@c-rex/types';
2
2
 
3
+ interface DefaultCrexDirectories extends idShortID {
4
+ labels: Labels[];
5
+ links: Link[];
6
+ class: ClassInterface;
7
+ childNodes?: ClassInterface[];
8
+ }
9
+ interface DefaultCrexRenditions extends DefaultCrexDirectories {
10
+ source: string;
11
+ format: string;
12
+ }
13
+ interface DefaultCrexObject extends idShortID {
14
+ directories: DefaultCrexDirectories[];
15
+ identities: DefaultCrexDirectories[];
16
+ class: ClassInterface;
17
+ labels: Labels[];
18
+ titles: Labels[];
19
+ versionOf: idShortID;
20
+ packages: idShortID[];
21
+ links: Link[];
22
+ renditions: DefaultCrexRenditions[];
23
+ iirdsVersion: {
24
+ value: string;
25
+ };
26
+ revision: string;
27
+ created: string;
28
+ score: number;
29
+ languages: string[];
30
+ }
31
+ interface ClassInterface extends idShortID {
32
+ labels: Labels[];
33
+ }
34
+ interface Tags {
35
+ [key: string]: {
36
+ labels: string[];
37
+ items: {
38
+ hits: number;
39
+ total: number;
40
+ labels: {
41
+ language?: string;
42
+ value: string;
43
+ }[];
44
+ shortId?: string;
45
+ }[];
46
+ }[];
47
+ }
3
48
  interface DefaultPageInfo {
4
49
  pageNumber: number;
5
50
  pageSize: number;
@@ -20,41 +65,28 @@ interface Labels {
20
65
  language: string;
21
66
  value: string;
22
67
  }
23
- interface DefaultLinksRequest {
68
+ interface Link {
24
69
  rel: string;
25
70
  href: string;
26
71
  method: string;
27
72
  }
28
- interface DefaultRequest<T> {
29
- items: T[];
30
- tags?: {
31
- [key: string]: {
32
- labels: string[];
33
- items: {
34
- hits: number;
35
- total: number;
36
- labels: {
37
- language?: string;
38
- value: string;
39
- }[];
40
- shortId?: string;
41
- }[];
42
- };
43
- };
44
- links: DefaultLinksRequest[];
73
+ interface DefaultRequest<ItemsType> {
74
+ items: ItemsType[];
75
+ tags?: Tags;
76
+ links: Link[];
77
+ pageInfo: DefaultPageInfo;
78
+ }
79
+ interface DefaultResponse<ItemsType, TagsType> {
80
+ items: ItemsType[];
81
+ tags?: TagsType;
45
82
  pageInfo: DefaultPageInfo;
46
83
  }
84
+
47
85
  interface Filters {
48
86
  key: string;
49
87
  value: string;
50
88
  operator?: string;
51
89
  }
52
- interface LanguageAndCountries {
53
- country: string;
54
- lang: string;
55
- value: string;
56
- }
57
-
58
90
  interface logInfo {
59
91
  silent: boolean;
60
92
  minimumLevel: LogLevelType;
@@ -76,7 +108,7 @@ interface ConfigInterface {
76
108
  results: {
77
109
  resultViewStyle: ResultViewStyles;
78
110
  disabledResults: ResultTypes[];
79
- articlePageLayout: "BLOG" | "DOCUMENT";
111
+ articlePageLayout: articlePageLayoutType;
80
112
  filesEnabledToDownload?: FilesExtensions[];
81
113
  filesEnabledToOpen?: FilesExtensions[];
82
114
  resultsToHide?: ResultTypes[];
@@ -105,36 +137,31 @@ interface ConfigInterface {
105
137
  };
106
138
  }
107
139
 
108
- interface informationUnitsClass extends idShortID {
109
- labels: Labels[];
140
+ interface DirectoryNodes extends DefaultCrexDirectories {
141
+ childNodes: DefaultCrexDirectories[];
142
+ parents: idShortID[];
143
+ informationUnits: (idShortID & {
144
+ labels: Labels[];
145
+ })[];
110
146
  }
111
- interface informationUnitsDirectories extends idShortID {
147
+ interface DirectoryNodesResponse {
148
+ items: DirectoryNodes[];
149
+ pageInfo: DefaultPageInfo;
150
+ }
151
+
152
+ interface DocumentTypesItem extends idShortID {
112
153
  labels: Labels[];
113
- links: DefaultLinksRequest[];
114
- class: informationUnitsClass;
115
- childNodes?: informationUnitsClass[];
116
154
  }
117
- interface informationUnitsRenditions extends informationUnitsDirectories {
155
+ interface DocumentTypesResponse {
156
+ items: DocumentTypesItem[];
157
+ }
158
+
159
+ interface informationUnitsRenditions extends DefaultCrexDirectories {
118
160
  source: string;
119
161
  format: string;
120
162
  }
121
- interface informationUnitsItems extends idShortID {
122
- directories: informationUnitsDirectories[];
123
- identities: informationUnitsDirectories[];
124
- class: informationUnitsClass;
125
- labels: Labels[];
126
- titles: Labels[];
127
- versionOf: idShortID;
128
- packages: idShortID[];
129
- links: DefaultLinksRequest[];
130
- renditions: informationUnitsRenditions[];
131
- iirdsVersion: {
132
- value: string;
133
- };
134
- revision: string;
135
- score: number;
163
+ interface informationUnitsItems extends DefaultCrexObject {
136
164
  directoryNodes: DirectoryNodes[];
137
- languages: string[];
138
165
  }
139
166
  interface informationUnitsResponseItem {
140
167
  language: string;
@@ -144,24 +171,13 @@ interface informationUnitsResponseItem {
144
171
  localeType: string;
145
172
  link: string;
146
173
  disabled: boolean;
147
- filesToOpen: {
148
- format: string;
149
- link: string;
150
- }[];
151
- filesToDownload: {
152
- format: string;
153
- link: string;
154
- }[];
174
+ files: DocumentsType;
155
175
  }
156
176
  interface informationUnitsResponse {
157
177
  items: informationUnitsResponseItem[];
158
178
  tags: any;
159
179
  pageInfo: DefaultPageInfo;
160
180
  }
161
- interface informationUnits {
162
- items: informationUnitsItems[];
163
- pageInfo: DefaultPageInfo;
164
- }
165
181
  interface AutocompleteSuggestion {
166
182
  suggestions: {
167
183
  type: string;
@@ -169,24 +185,6 @@ interface AutocompleteSuggestion {
169
185
  }[];
170
186
  }
171
187
 
172
- interface DirectoryNodes extends informationUnitsDirectories {
173
- childNodes: informationUnitsDirectories[];
174
- parents: idShortID[];
175
- informationUnits: (idShortID & {
176
- labels: Labels[];
177
- })[];
178
- }
179
- interface DirectoryNodesResponse {
180
- items: DirectoryNodes[];
181
- pageInfo: DefaultPageInfo;
182
- }
183
-
184
- interface DocumentTypesItem extends idShortID {
185
- labels: Labels[];
186
- links: DefaultLinksRequest[];
187
- score: number;
188
- }
189
-
190
188
  interface TreeOfContent {
191
189
  label: string;
192
190
  id: string;
@@ -194,7 +192,7 @@ interface TreeOfContent {
194
192
  active: boolean;
195
193
  children: TreeOfContent[];
196
194
  }
197
- interface SidebarAvailableVersionsInterface {
195
+ interface AvailableVersionsInterface {
198
196
  shortId: string;
199
197
  active: boolean;
200
198
  lang: string;
@@ -202,4 +200,49 @@ interface SidebarAvailableVersionsInterface {
202
200
  link: string;
203
201
  }
204
202
 
205
- export type { AutocompleteSuggestion, ConfigInterface, DefaultLinksRequest, DefaultPageInfo, DefaultRequest, DirectoryNodes, DirectoryNodesResponse, DocumentTypesItem, Filters, Labels, LanguageAndCountries, OIDCInterface, SidebarAvailableVersionsInterface, TreeOfContent, idShortID, informationUnits, informationUnitsClass, informationUnitsDirectories, informationUnitsItems, informationUnitsRenditions, informationUnitsResponse, informationUnitsResponseItem, logInfo };
203
+ interface TopicsResponseItem {
204
+ language: string;
205
+ title: string;
206
+ type: string;
207
+ shortId: string;
208
+ created: string;
209
+ localeType: string;
210
+ link: string;
211
+ disabled: boolean;
212
+ renditionUrl: string;
213
+ image: string | null;
214
+ description: string | null;
215
+ }
216
+ interface TopicsRequestItem extends DefaultCrexObject {
217
+ applicableForTypes?: {
218
+ labels: Labels[];
219
+ }[];
220
+ }
221
+
222
+ interface LanguageAndCountries {
223
+ country: string;
224
+ lang: string;
225
+ value: string;
226
+ }
227
+
228
+ interface CollectionContext {
229
+ id: string;
230
+ informationUnitsItem: informationUnitsItems;
231
+ rootNode: DirectoryNodes;
232
+ }
233
+ interface CollectionResult {
234
+ metaTags: {
235
+ name: string;
236
+ content: string;
237
+ }[];
238
+ articleHtml: string;
239
+ document: informationUnitsItems;
240
+ article: informationUnitsItems;
241
+ attachments?: DocumentsType;
242
+ articleInfo?: articleInfoItemType[];
243
+ documentInfo?: articleInfoItemType[];
244
+ rootNode: DirectoryNodes;
245
+ availableVersions: informationUnitsResponseItem[];
246
+ }
247
+
248
+ export type { AutocompleteSuggestion, AvailableVersionsInterface, ClassInterface, CollectionContext, CollectionResult, ConfigInterface, DefaultCrexDirectories, DefaultCrexObject, DefaultCrexRenditions, DefaultPageInfo, DefaultRequest, DefaultResponse, DirectoryNodes, DirectoryNodesResponse, DocumentTypesItem, DocumentTypesResponse, Filters, Labels, LanguageAndCountries, Link, OIDCInterface, Tags, TopicsRequestItem, TopicsResponseItem, TreeOfContent, idShortID, informationUnitsItems, informationUnitsRenditions, informationUnitsResponse, informationUnitsResponseItem, logInfo };
package/dist/index.d.ts CHANGED
@@ -1,5 +1,50 @@
1
- import { LogLevelType, LogCategoriesType, ResultViewStyles, ResultTypes, FilesExtensions, WildCardType } from '@c-rex/types';
1
+ import { LogLevelType, LogCategoriesType, ResultViewStyles, ResultTypes, articlePageLayoutType, FilesExtensions, WildCardType, DocumentsType, articleInfoItemType } from '@c-rex/types';
2
2
 
3
+ interface DefaultCrexDirectories extends idShortID {
4
+ labels: Labels[];
5
+ links: Link[];
6
+ class: ClassInterface;
7
+ childNodes?: ClassInterface[];
8
+ }
9
+ interface DefaultCrexRenditions extends DefaultCrexDirectories {
10
+ source: string;
11
+ format: string;
12
+ }
13
+ interface DefaultCrexObject extends idShortID {
14
+ directories: DefaultCrexDirectories[];
15
+ identities: DefaultCrexDirectories[];
16
+ class: ClassInterface;
17
+ labels: Labels[];
18
+ titles: Labels[];
19
+ versionOf: idShortID;
20
+ packages: idShortID[];
21
+ links: Link[];
22
+ renditions: DefaultCrexRenditions[];
23
+ iirdsVersion: {
24
+ value: string;
25
+ };
26
+ revision: string;
27
+ created: string;
28
+ score: number;
29
+ languages: string[];
30
+ }
31
+ interface ClassInterface extends idShortID {
32
+ labels: Labels[];
33
+ }
34
+ interface Tags {
35
+ [key: string]: {
36
+ labels: string[];
37
+ items: {
38
+ hits: number;
39
+ total: number;
40
+ labels: {
41
+ language?: string;
42
+ value: string;
43
+ }[];
44
+ shortId?: string;
45
+ }[];
46
+ }[];
47
+ }
3
48
  interface DefaultPageInfo {
4
49
  pageNumber: number;
5
50
  pageSize: number;
@@ -20,41 +65,28 @@ interface Labels {
20
65
  language: string;
21
66
  value: string;
22
67
  }
23
- interface DefaultLinksRequest {
68
+ interface Link {
24
69
  rel: string;
25
70
  href: string;
26
71
  method: string;
27
72
  }
28
- interface DefaultRequest<T> {
29
- items: T[];
30
- tags?: {
31
- [key: string]: {
32
- labels: string[];
33
- items: {
34
- hits: number;
35
- total: number;
36
- labels: {
37
- language?: string;
38
- value: string;
39
- }[];
40
- shortId?: string;
41
- }[];
42
- };
43
- };
44
- links: DefaultLinksRequest[];
73
+ interface DefaultRequest<ItemsType> {
74
+ items: ItemsType[];
75
+ tags?: Tags;
76
+ links: Link[];
77
+ pageInfo: DefaultPageInfo;
78
+ }
79
+ interface DefaultResponse<ItemsType, TagsType> {
80
+ items: ItemsType[];
81
+ tags?: TagsType;
45
82
  pageInfo: DefaultPageInfo;
46
83
  }
84
+
47
85
  interface Filters {
48
86
  key: string;
49
87
  value: string;
50
88
  operator?: string;
51
89
  }
52
- interface LanguageAndCountries {
53
- country: string;
54
- lang: string;
55
- value: string;
56
- }
57
-
58
90
  interface logInfo {
59
91
  silent: boolean;
60
92
  minimumLevel: LogLevelType;
@@ -76,7 +108,7 @@ interface ConfigInterface {
76
108
  results: {
77
109
  resultViewStyle: ResultViewStyles;
78
110
  disabledResults: ResultTypes[];
79
- articlePageLayout: "BLOG" | "DOCUMENT";
111
+ articlePageLayout: articlePageLayoutType;
80
112
  filesEnabledToDownload?: FilesExtensions[];
81
113
  filesEnabledToOpen?: FilesExtensions[];
82
114
  resultsToHide?: ResultTypes[];
@@ -105,36 +137,31 @@ interface ConfigInterface {
105
137
  };
106
138
  }
107
139
 
108
- interface informationUnitsClass extends idShortID {
109
- labels: Labels[];
140
+ interface DirectoryNodes extends DefaultCrexDirectories {
141
+ childNodes: DefaultCrexDirectories[];
142
+ parents: idShortID[];
143
+ informationUnits: (idShortID & {
144
+ labels: Labels[];
145
+ })[];
110
146
  }
111
- interface informationUnitsDirectories extends idShortID {
147
+ interface DirectoryNodesResponse {
148
+ items: DirectoryNodes[];
149
+ pageInfo: DefaultPageInfo;
150
+ }
151
+
152
+ interface DocumentTypesItem extends idShortID {
112
153
  labels: Labels[];
113
- links: DefaultLinksRequest[];
114
- class: informationUnitsClass;
115
- childNodes?: informationUnitsClass[];
116
154
  }
117
- interface informationUnitsRenditions extends informationUnitsDirectories {
155
+ interface DocumentTypesResponse {
156
+ items: DocumentTypesItem[];
157
+ }
158
+
159
+ interface informationUnitsRenditions extends DefaultCrexDirectories {
118
160
  source: string;
119
161
  format: string;
120
162
  }
121
- interface informationUnitsItems extends idShortID {
122
- directories: informationUnitsDirectories[];
123
- identities: informationUnitsDirectories[];
124
- class: informationUnitsClass;
125
- labels: Labels[];
126
- titles: Labels[];
127
- versionOf: idShortID;
128
- packages: idShortID[];
129
- links: DefaultLinksRequest[];
130
- renditions: informationUnitsRenditions[];
131
- iirdsVersion: {
132
- value: string;
133
- };
134
- revision: string;
135
- score: number;
163
+ interface informationUnitsItems extends DefaultCrexObject {
136
164
  directoryNodes: DirectoryNodes[];
137
- languages: string[];
138
165
  }
139
166
  interface informationUnitsResponseItem {
140
167
  language: string;
@@ -144,24 +171,13 @@ interface informationUnitsResponseItem {
144
171
  localeType: string;
145
172
  link: string;
146
173
  disabled: boolean;
147
- filesToOpen: {
148
- format: string;
149
- link: string;
150
- }[];
151
- filesToDownload: {
152
- format: string;
153
- link: string;
154
- }[];
174
+ files: DocumentsType;
155
175
  }
156
176
  interface informationUnitsResponse {
157
177
  items: informationUnitsResponseItem[];
158
178
  tags: any;
159
179
  pageInfo: DefaultPageInfo;
160
180
  }
161
- interface informationUnits {
162
- items: informationUnitsItems[];
163
- pageInfo: DefaultPageInfo;
164
- }
165
181
  interface AutocompleteSuggestion {
166
182
  suggestions: {
167
183
  type: string;
@@ -169,24 +185,6 @@ interface AutocompleteSuggestion {
169
185
  }[];
170
186
  }
171
187
 
172
- interface DirectoryNodes extends informationUnitsDirectories {
173
- childNodes: informationUnitsDirectories[];
174
- parents: idShortID[];
175
- informationUnits: (idShortID & {
176
- labels: Labels[];
177
- })[];
178
- }
179
- interface DirectoryNodesResponse {
180
- items: DirectoryNodes[];
181
- pageInfo: DefaultPageInfo;
182
- }
183
-
184
- interface DocumentTypesItem extends idShortID {
185
- labels: Labels[];
186
- links: DefaultLinksRequest[];
187
- score: number;
188
- }
189
-
190
188
  interface TreeOfContent {
191
189
  label: string;
192
190
  id: string;
@@ -194,7 +192,7 @@ interface TreeOfContent {
194
192
  active: boolean;
195
193
  children: TreeOfContent[];
196
194
  }
197
- interface SidebarAvailableVersionsInterface {
195
+ interface AvailableVersionsInterface {
198
196
  shortId: string;
199
197
  active: boolean;
200
198
  lang: string;
@@ -202,4 +200,49 @@ interface SidebarAvailableVersionsInterface {
202
200
  link: string;
203
201
  }
204
202
 
205
- export type { AutocompleteSuggestion, ConfigInterface, DefaultLinksRequest, DefaultPageInfo, DefaultRequest, DirectoryNodes, DirectoryNodesResponse, DocumentTypesItem, Filters, Labels, LanguageAndCountries, OIDCInterface, SidebarAvailableVersionsInterface, TreeOfContent, idShortID, informationUnits, informationUnitsClass, informationUnitsDirectories, informationUnitsItems, informationUnitsRenditions, informationUnitsResponse, informationUnitsResponseItem, logInfo };
203
+ interface TopicsResponseItem {
204
+ language: string;
205
+ title: string;
206
+ type: string;
207
+ shortId: string;
208
+ created: string;
209
+ localeType: string;
210
+ link: string;
211
+ disabled: boolean;
212
+ renditionUrl: string;
213
+ image: string | null;
214
+ description: string | null;
215
+ }
216
+ interface TopicsRequestItem extends DefaultCrexObject {
217
+ applicableForTypes?: {
218
+ labels: Labels[];
219
+ }[];
220
+ }
221
+
222
+ interface LanguageAndCountries {
223
+ country: string;
224
+ lang: string;
225
+ value: string;
226
+ }
227
+
228
+ interface CollectionContext {
229
+ id: string;
230
+ informationUnitsItem: informationUnitsItems;
231
+ rootNode: DirectoryNodes;
232
+ }
233
+ interface CollectionResult {
234
+ metaTags: {
235
+ name: string;
236
+ content: string;
237
+ }[];
238
+ articleHtml: string;
239
+ document: informationUnitsItems;
240
+ article: informationUnitsItems;
241
+ attachments?: DocumentsType;
242
+ articleInfo?: articleInfoItemType[];
243
+ documentInfo?: articleInfoItemType[];
244
+ rootNode: DirectoryNodes;
245
+ availableVersions: informationUnitsResponseItem[];
246
+ }
247
+
248
+ export type { AutocompleteSuggestion, AvailableVersionsInterface, ClassInterface, CollectionContext, CollectionResult, ConfigInterface, DefaultCrexDirectories, DefaultCrexObject, DefaultCrexRenditions, DefaultPageInfo, DefaultRequest, DefaultResponse, DirectoryNodes, DirectoryNodesResponse, DocumentTypesItem, DocumentTypesResponse, Filters, Labels, LanguageAndCountries, Link, OIDCInterface, Tags, TopicsRequestItem, TopicsResponseItem, TreeOfContent, idShortID, informationUnitsItems, informationUnitsRenditions, informationUnitsResponse, informationUnitsResponseItem, logInfo };
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/index.ts"],"sourcesContent":["export * from './common'\nexport * from './config'\nexport * from './directoryNodes'\nexport * from './documentTypes'\nexport * from './informationUnits'\nexport * from './treeOfContent'"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
1
+ {"version":3,"sources":["../src/index.ts"],"sourcesContent":["export * from './common'\nexport * from './config'\nexport * from './directoryNodes'\nexport * from './documentTypes'\nexport * from './informationUnits'\nexport * from './treeOfContent'\nexport * from './topics'\nexport * from './languages'\nexport * from './collectors'"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@c-rex/interfaces",
3
- "version": "0.1.7",
3
+ "version": "0.1.9",
4
4
  "main": "./dist/index.js",
5
5
  "types": "./dist/index.d.ts",
6
6
  "module": "./dist/index.mjs",