@c-rex/interfaces 0.1.7 → 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 +102 -72
  2. package/dist/index.d.ts +102 -72
  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,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[];
45
77
  pageInfo: DefaultPageInfo;
46
78
  }
79
+ interface DefaultResponse<ItemsType, TagsType> {
80
+ items: ItemsType[];
81
+ tags?: TagsType;
82
+ pageInfo: DefaultPageInfo;
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;
@@ -158,10 +185,6 @@ interface informationUnitsResponse {
158
185
  tags: any;
159
186
  pageInfo: DefaultPageInfo;
160
187
  }
161
- interface informationUnits {
162
- items: informationUnitsItems[];
163
- pageInfo: DefaultPageInfo;
164
- }
165
188
  interface AutocompleteSuggestion {
166
189
  suggestions: {
167
190
  type: string;
@@ -169,24 +192,6 @@ interface AutocompleteSuggestion {
169
192
  }[];
170
193
  }
171
194
 
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
195
  interface TreeOfContent {
191
196
  label: string;
192
197
  id: string;
@@ -202,4 +207,29 @@ interface SidebarAvailableVersionsInterface {
202
207
  link: string;
203
208
  }
204
209
 
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 };
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,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[];
45
77
  pageInfo: DefaultPageInfo;
46
78
  }
79
+ interface DefaultResponse<ItemsType, TagsType> {
80
+ items: ItemsType[];
81
+ tags?: TagsType;
82
+ pageInfo: DefaultPageInfo;
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;
@@ -158,10 +185,6 @@ interface informationUnitsResponse {
158
185
  tags: any;
159
186
  pageInfo: DefaultPageInfo;
160
187
  }
161
- interface informationUnits {
162
- items: informationUnitsItems[];
163
- pageInfo: DefaultPageInfo;
164
- }
165
188
  interface AutocompleteSuggestion {
166
189
  suggestions: {
167
190
  type: string;
@@ -169,24 +192,6 @@ interface AutocompleteSuggestion {
169
192
  }[];
170
193
  }
171
194
 
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
195
  interface TreeOfContent {
191
196
  label: string;
192
197
  id: string;
@@ -202,4 +207,29 @@ interface SidebarAvailableVersionsInterface {
202
207
  link: string;
203
208
  }
204
209
 
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 };
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.7",
3
+ "version": "0.1.8",
4
4
  "main": "./dist/index.js",
5
5
  "types": "./dist/index.d.ts",
6
6
  "module": "./dist/index.mjs",