@c-rex/interfaces 0.1.6 → 0.1.8

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.
Files changed (4) hide show
  1. package/dist/index.d.mts +103 -58
  2. package/dist/index.d.ts +103 -58
  3. package/dist/index.js.map +1 -1
  4. package/package.json +1 -1
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 } 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,27 +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
- 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;
31
82
  pageInfo: DefaultPageInfo;
32
83
  }
84
+
33
85
  interface Filters {
34
86
  key: string;
35
87
  value: string;
36
88
  operator?: string;
37
89
  }
38
- interface LanguageAndCountries {
39
- country: string;
40
- lang: string;
41
- value: string;
42
- }
43
-
44
90
  interface logInfo {
45
91
  silent: boolean;
46
92
  minimumLevel: LogLevelType;
@@ -62,7 +108,7 @@ interface ConfigInterface {
62
108
  results: {
63
109
  resultViewStyle: ResultViewStyles;
64
110
  disabledResults: ResultTypes[];
65
- articlePageLayout: "BLOG" | "DOCUMENT";
111
+ articlePageLayout: articlePageLayoutType;
66
112
  filesEnabledToDownload?: FilesExtensions[];
67
113
  filesEnabledToOpen?: FilesExtensions[];
68
114
  resultsToHide?: ResultTypes[];
@@ -91,36 +137,31 @@ interface ConfigInterface {
91
137
  };
92
138
  }
93
139
 
94
- interface informationUnitsClass extends idShortID {
95
- labels: Labels[];
140
+ interface DirectoryNodes extends DefaultCrexDirectories {
141
+ childNodes: DefaultCrexDirectories[];
142
+ parents: idShortID[];
143
+ informationUnits: (idShortID & {
144
+ labels: Labels[];
145
+ })[];
146
+ }
147
+ interface DirectoryNodesResponse {
148
+ items: DirectoryNodes[];
149
+ pageInfo: DefaultPageInfo;
96
150
  }
97
- interface informationUnitsDirectories extends idShortID {
151
+
152
+ interface DocumentTypesItem extends idShortID {
98
153
  labels: Labels[];
99
- links: DefaultLinksRequest[];
100
- class: informationUnitsClass;
101
- childNodes?: informationUnitsClass[];
102
154
  }
103
- interface informationUnitsRenditions extends informationUnitsDirectories {
155
+ interface DocumentTypesResponse {
156
+ items: DocumentTypesItem[];
157
+ }
158
+
159
+ interface informationUnitsRenditions extends DefaultCrexDirectories {
104
160
  source: string;
105
161
  format: string;
106
162
  }
107
- interface informationUnitsItems extends idShortID {
108
- directories: informationUnitsDirectories[];
109
- identities: informationUnitsDirectories[];
110
- class: informationUnitsClass;
111
- labels: Labels[];
112
- titles: Labels[];
113
- versionOf: idShortID;
114
- packages: idShortID[];
115
- links: DefaultLinksRequest[];
116
- renditions: informationUnitsRenditions[];
117
- iirdsVersion: {
118
- value: string;
119
- };
120
- revision: string;
121
- score: number;
163
+ interface informationUnitsItems extends DefaultCrexObject {
122
164
  directoryNodes: DirectoryNodes[];
123
- languages: string[];
124
165
  }
125
166
  interface informationUnitsResponseItem {
126
167
  language: string;
@@ -141,10 +182,7 @@ interface informationUnitsResponseItem {
141
182
  }
142
183
  interface informationUnitsResponse {
143
184
  items: informationUnitsResponseItem[];
144
- pageInfo: DefaultPageInfo;
145
- }
146
- interface informationUnits {
147
- items: informationUnitsItems[];
185
+ tags: any;
148
186
  pageInfo: DefaultPageInfo;
149
187
  }
150
188
  interface AutocompleteSuggestion {
@@ -154,24 +192,6 @@ interface AutocompleteSuggestion {
154
192
  }[];
155
193
  }
156
194
 
157
- interface DirectoryNodes extends informationUnitsDirectories {
158
- childNodes: informationUnitsDirectories[];
159
- parents: idShortID[];
160
- informationUnits: (idShortID & {
161
- labels: Labels[];
162
- })[];
163
- }
164
- interface DirectoryNodesResponse {
165
- items: DirectoryNodes[];
166
- pageInfo: DefaultPageInfo;
167
- }
168
-
169
- interface DocumentTypesItem extends idShortID {
170
- labels: Labels[];
171
- links: DefaultLinksRequest[];
172
- score: number;
173
- }
174
-
175
195
  interface TreeOfContent {
176
196
  label: string;
177
197
  id: string;
@@ -187,4 +207,29 @@ interface SidebarAvailableVersionsInterface {
187
207
  link: string;
188
208
  }
189
209
 
190
- 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 };
210
+ interface TopicsResponseItem {
211
+ language: string;
212
+ title: string;
213
+ type: string;
214
+ shortId: string;
215
+ created: string;
216
+ localeType: string;
217
+ link: string;
218
+ disabled: boolean;
219
+ renditionUrl: string;
220
+ image: string | null;
221
+ description: string | null;
222
+ }
223
+ interface TopicsRequestItem extends DefaultCrexObject {
224
+ applicableForTypes?: {
225
+ labels: Labels[];
226
+ }[];
227
+ }
228
+
229
+ interface LanguageAndCountries {
230
+ country: string;
231
+ lang: string;
232
+ value: string;
233
+ }
234
+
235
+ export type { AutocompleteSuggestion, ClassInterface, ConfigInterface, DefaultCrexDirectories, DefaultCrexObject, DefaultCrexRenditions, DefaultPageInfo, DefaultRequest, DefaultResponse, DirectoryNodes, DirectoryNodesResponse, DocumentTypesItem, DocumentTypesResponse, Filters, Labels, LanguageAndCountries, Link, OIDCInterface, SidebarAvailableVersionsInterface, 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 } 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,27 +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
- 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;
31
82
  pageInfo: DefaultPageInfo;
32
83
  }
84
+
33
85
  interface Filters {
34
86
  key: string;
35
87
  value: string;
36
88
  operator?: string;
37
89
  }
38
- interface LanguageAndCountries {
39
- country: string;
40
- lang: string;
41
- value: string;
42
- }
43
-
44
90
  interface logInfo {
45
91
  silent: boolean;
46
92
  minimumLevel: LogLevelType;
@@ -62,7 +108,7 @@ interface ConfigInterface {
62
108
  results: {
63
109
  resultViewStyle: ResultViewStyles;
64
110
  disabledResults: ResultTypes[];
65
- articlePageLayout: "BLOG" | "DOCUMENT";
111
+ articlePageLayout: articlePageLayoutType;
66
112
  filesEnabledToDownload?: FilesExtensions[];
67
113
  filesEnabledToOpen?: FilesExtensions[];
68
114
  resultsToHide?: ResultTypes[];
@@ -91,36 +137,31 @@ interface ConfigInterface {
91
137
  };
92
138
  }
93
139
 
94
- interface informationUnitsClass extends idShortID {
95
- labels: Labels[];
140
+ interface DirectoryNodes extends DefaultCrexDirectories {
141
+ childNodes: DefaultCrexDirectories[];
142
+ parents: idShortID[];
143
+ informationUnits: (idShortID & {
144
+ labels: Labels[];
145
+ })[];
146
+ }
147
+ interface DirectoryNodesResponse {
148
+ items: DirectoryNodes[];
149
+ pageInfo: DefaultPageInfo;
96
150
  }
97
- interface informationUnitsDirectories extends idShortID {
151
+
152
+ interface DocumentTypesItem extends idShortID {
98
153
  labels: Labels[];
99
- links: DefaultLinksRequest[];
100
- class: informationUnitsClass;
101
- childNodes?: informationUnitsClass[];
102
154
  }
103
- interface informationUnitsRenditions extends informationUnitsDirectories {
155
+ interface DocumentTypesResponse {
156
+ items: DocumentTypesItem[];
157
+ }
158
+
159
+ interface informationUnitsRenditions extends DefaultCrexDirectories {
104
160
  source: string;
105
161
  format: string;
106
162
  }
107
- interface informationUnitsItems extends idShortID {
108
- directories: informationUnitsDirectories[];
109
- identities: informationUnitsDirectories[];
110
- class: informationUnitsClass;
111
- labels: Labels[];
112
- titles: Labels[];
113
- versionOf: idShortID;
114
- packages: idShortID[];
115
- links: DefaultLinksRequest[];
116
- renditions: informationUnitsRenditions[];
117
- iirdsVersion: {
118
- value: string;
119
- };
120
- revision: string;
121
- score: number;
163
+ interface informationUnitsItems extends DefaultCrexObject {
122
164
  directoryNodes: DirectoryNodes[];
123
- languages: string[];
124
165
  }
125
166
  interface informationUnitsResponseItem {
126
167
  language: string;
@@ -141,10 +182,7 @@ interface informationUnitsResponseItem {
141
182
  }
142
183
  interface informationUnitsResponse {
143
184
  items: informationUnitsResponseItem[];
144
- pageInfo: DefaultPageInfo;
145
- }
146
- interface informationUnits {
147
- items: informationUnitsItems[];
185
+ tags: any;
148
186
  pageInfo: DefaultPageInfo;
149
187
  }
150
188
  interface AutocompleteSuggestion {
@@ -154,24 +192,6 @@ interface AutocompleteSuggestion {
154
192
  }[];
155
193
  }
156
194
 
157
- interface DirectoryNodes extends informationUnitsDirectories {
158
- childNodes: informationUnitsDirectories[];
159
- parents: idShortID[];
160
- informationUnits: (idShortID & {
161
- labels: Labels[];
162
- })[];
163
- }
164
- interface DirectoryNodesResponse {
165
- items: DirectoryNodes[];
166
- pageInfo: DefaultPageInfo;
167
- }
168
-
169
- interface DocumentTypesItem extends idShortID {
170
- labels: Labels[];
171
- links: DefaultLinksRequest[];
172
- score: number;
173
- }
174
-
175
195
  interface TreeOfContent {
176
196
  label: string;
177
197
  id: string;
@@ -187,4 +207,29 @@ interface SidebarAvailableVersionsInterface {
187
207
  link: string;
188
208
  }
189
209
 
190
- 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 };
210
+ interface TopicsResponseItem {
211
+ language: string;
212
+ title: string;
213
+ type: string;
214
+ shortId: string;
215
+ created: string;
216
+ localeType: string;
217
+ link: string;
218
+ disabled: boolean;
219
+ renditionUrl: string;
220
+ image: string | null;
221
+ description: string | null;
222
+ }
223
+ interface TopicsRequestItem extends DefaultCrexObject {
224
+ applicableForTypes?: {
225
+ labels: Labels[];
226
+ }[];
227
+ }
228
+
229
+ interface LanguageAndCountries {
230
+ country: string;
231
+ lang: string;
232
+ value: string;
233
+ }
234
+
235
+ export type { AutocompleteSuggestion, ClassInterface, ConfigInterface, DefaultCrexDirectories, DefaultCrexObject, DefaultCrexRenditions, DefaultPageInfo, DefaultRequest, DefaultResponse, DirectoryNodes, DirectoryNodesResponse, DocumentTypesItem, DocumentTypesResponse, Filters, Labels, LanguageAndCountries, Link, OIDCInterface, SidebarAvailableVersionsInterface, 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'"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@c-rex/interfaces",
3
- "version": "0.1.6",
3
+ "version": "0.1.8",
4
4
  "main": "./dist/index.js",
5
5
  "types": "./dist/index.d.ts",
6
6
  "module": "./dist/index.mjs",