@manuscripts/style-guide 3.2.3 → 3.3.0

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 (14) hide show
  1. package/dist/cjs/components/Message.js +35 -0
  2. package/dist/cjs/index.js +2 -6
  3. package/dist/es/components/Message.js +28 -0
  4. package/dist/es/index.js +1 -1
  5. package/dist/types/components/Message.d.ts +9 -0
  6. package/dist/types/index.d.ts +1 -1
  7. package/dist/types/lib/menus.d.ts +1 -0
  8. package/package.json +2 -2
  9. package/dist/cjs/lib/__tests__/errors-decoder.test.js +0 -38
  10. package/dist/cjs/lib/errors-decoder.js +0 -300
  11. package/dist/es/lib/__tests__/errors-decoder.test.js +0 -33
  12. package/dist/es/lib/errors-decoder.js +0 -298
  13. package/dist/types/lib/__tests__/errors-decoder.test.d.ts +0 -16
  14. package/dist/types/lib/errors-decoder.d.ts +0 -22
package/dist/cjs/components/Message.js ADDED
@@ -0,0 +1,35 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.Message = void 0;
7
+ const react_1 = __importDefault(require("react"));
8
+ const styled_components_1 = __importDefault(require("styled-components"));
9
+ const Text = styled_components_1.default.p `
10
+ font: ${(props) => props.theme.font.weight.normal}
11
+ ${(props) => props.theme.font.size.normal} /
12
+ ${(props) => props.theme.font.lineHeight.normal}
13
+ ${(props) => props.theme.font.family.sans};
14
+
15
+ box-sizing: border-box;
16
+ color: ${(props) => props.theme.colors.text.secondary};
17
+ margin: 0;
18
+ `;
19
+ const MessageWrapper = styled_components_1.default.div `
20
+ display: flex;
21
+ align-items: center;
22
+ gap: ${(props) => props.theme.grid.unit * 2 + 'px'};
23
+ padding: ${(props) => props.theme.grid.unit * 4 + 'px'};
24
+ &.centered {
25
+ text-align: center;
26
+ position: absolute;
27
+ top: 50%;
28
+ left: 50%;
29
+ transform: translate(-50%);
30
+ }
31
+ `;
32
+ const Message = ({ isCentered, icon: Icon, children, }) => (react_1.default.createElement(MessageWrapper, { className: isCentered ? 'centered' : '' },
33
+ Icon && react_1.default.createElement(Icon, null),
34
+ react_1.default.createElement(Text, null, children)));
35
+ exports.Message = Message;
package/dist/cjs/index.js CHANGED
@@ -28,12 +28,10 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
28
28
  var __exportStar = (this && this.__exportStar) || function(m, exports) {
29
29
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
30
30
  };
31
- var __importDefault = (this && this.__importDefault) || function (mod) {
32
- return (mod && mod.__esModule) ? mod : { "default": mod };
33
- };
34
31
  Object.defineProperty(exports, "__esModule", { value: true });
35
- exports.errorsDecoder = exports.useDeepCompareCallback = exports.useDeepCompareMemo = exports.ToggleIcon = exports.ToggleHeader = void 0;
32
+ exports.useDeepCompareCallback = exports.useDeepCompareMemo = exports.ToggleIcon = exports.ToggleHeader = void 0;
36
33
  __exportStar(require("./components/AlertMessage"), exports);
34
+ __exportStar(require("./components/Message"), exports);
37
35
  __exportStar(require("./components/Button"), exports);
38
36
  __exportStar(require("./components/ContextMenu"), exports);
39
37
  __exportStar(require("./components/RadioButton"), exports);
@@ -80,5 +78,3 @@ Object.defineProperty(exports, "useDeepCompareCallback", { enumerable: true, get
80
78
  __exportStar(require("./lib/capabilities"), exports);
81
79
  __exportStar(require("./lib/files"), exports);
82
80
  __exportStar(require("./lib/menus"), exports);
83
- var errors_decoder_1 = require("./lib/errors-decoder");
84
- Object.defineProperty(exports, "errorsDecoder", { enumerable: true, get: function () { return __importDefault(errors_decoder_1).default; } });
package/dist/es/components/Message.js ADDED
@@ -0,0 +1,28 @@
1
+ import React from 'react';
2
+ import styled from 'styled-components';
3
+ const Text = styled.p `
4
+ font: ${(props) => props.theme.font.weight.normal}
5
+ ${(props) => props.theme.font.size.normal} /
6
+ ${(props) => props.theme.font.lineHeight.normal}
7
+ ${(props) => props.theme.font.family.sans};
8
+
9
+ box-sizing: border-box;
10
+ color: ${(props) => props.theme.colors.text.secondary};
11
+ margin: 0;
12
+ `;
13
+ const MessageWrapper = styled.div `
14
+ display: flex;
15
+ align-items: center;
16
+ gap: ${(props) => props.theme.grid.unit * 2 + 'px'};
17
+ padding: ${(props) => props.theme.grid.unit * 4 + 'px'};
18
+ &.centered {
19
+ text-align: center;
20
+ position: absolute;
21
+ top: 50%;
22
+ left: 50%;
23
+ transform: translate(-50%);
24
+ }
25
+ `;
26
+ export const Message = ({ isCentered, icon: Icon, children, }) => (React.createElement(MessageWrapper, { className: isCentered ? 'centered' : '' },
27
+ Icon && React.createElement(Icon, null),
28
+ React.createElement(Text, null, children)));
package/dist/es/index.js CHANGED
@@ -14,6 +14,7 @@
14
14
  * limitations under the License.
15
15
  */
16
16
  export * from './components/AlertMessage';
17
+ export * from './components/Message';
17
18
  export * from './components/Button';
18
19
  export * from './components/ContextMenu';
19
20
  export * from './components/RadioButton';
@@ -56,4 +57,3 @@ export { useDeepCompareMemo, useDeepCompareCallback, } from './hooks/use-deep-co
56
57
  export * from './lib/capabilities';
57
58
  export * from './lib/files';
58
59
  export * from './lib/menus';
59
- export { default as errorsDecoder } from './lib/errors-decoder';
package/dist/types/components/Message.d.ts ADDED
@@ -0,0 +1,9 @@
1
+ import React from 'react';
2
+ import { IconProps } from './icons/types';
3
+ type MessageProps = {
4
+ isCentered?: boolean;
5
+ icon?: React.ComponentType<IconProps>;
6
+ children: string;
7
+ };
8
+ export declare const Message: React.FC<MessageProps>;
9
+ export {};
package/dist/types/index.d.ts CHANGED
@@ -15,6 +15,7 @@
15
15
  */
16
16
  export { Theme } from './theme';
17
17
  export * from './components/AlertMessage';
18
+ export * from './components/Message';
18
19
  export * from './components/Button';
19
20
  export * from './components/ContextMenu';
20
21
  export * from './components/RadioButton';
@@ -57,4 +58,3 @@ export { useDeepCompareMemo, useDeepCompareCallback, } from './hooks/use-deep-co
57
58
  export * from './lib/capabilities';
58
59
  export * from './lib/files';
59
60
  export * from './lib/menus';
60
- export { default as errorsDecoder } from './lib/errors-decoder';
package/dist/types/lib/menus.d.ts CHANGED
@@ -32,6 +32,7 @@ export interface MenuSpec {
32
32
  isEnabled: boolean;
33
33
  run?: () => void;
34
34
  submenu?: (MenuSpec | MenuSeparator)[];
35
+ isHidden?: boolean;
35
36
  }
36
37
  export interface Menu extends MenuSpec {
37
38
  isOpen: boolean;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@manuscripts/style-guide",
3
3
  "description": "Shared components for Manuscripts applications",
4
- "version": "3.2.3",
4
+ "version": "3.3.0",
5
5
  "repository": "github:Atypon-OpenSource/manuscripts-style-guide",
6
6
  "license": "Apache-2.0",
7
7
  "main": "dist/cjs",
@@ -25,7 +25,7 @@
25
25
  "prettier": "prettier --write \"{src,stories}/**/*.{ts,tsx}\"",
26
26
  "preversion": "npm-run-all --parallel lint typecheck test",
27
27
  "storybook": "storybook dev -p 6006",
28
- "test": "jest",
28
+ "test": "jest --passWithNoTests",
29
29
  "typecheck": "tsc --noEmit",
30
30
  "version": "pnpm build",
31
31
  "prepare": "husky install"
package/dist/cjs/lib/__tests__/errors-decoder.test.js DELETED
@@ -1,38 +0,0 @@
1
- "use strict";
2
- /*!
3
- * © 2019 Atypon Systems LLC
4
- *
5
- * Licensed under the Apache License, Version 2.0 (the "License");
6
- * you may not use this file except in compliance with the License.
7
- * You may obtain a copy of the License at
8
- *
9
- * http://www.apache.org/licenses/LICENSE-2.0
10
- *
11
- * Unless required by applicable law or agreed to in writing, software
12
- * distributed under the License is distributed on an "AS IS" BASIS,
13
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
- * See the License for the specific language governing permissions and
15
- * limitations under the License.
16
- */
17
- var __importDefault = (this && this.__importDefault) || function (mod) {
18
- return (mod && mod.__esModule) ? mod : { "default": mod };
19
- };
20
- Object.defineProperty(exports, "__esModule", { value: true });
21
- const errors_decoder_1 = __importDefault(require("../errors-decoder"));
22
- describe('decodedError', () => {
23
- it('should decode error as', () => {
24
- const decoded = (0, errors_decoder_1.default)('NOTES_NOT_UPDATED');
25
- expect(decoded).toEqual({
26
- title: 'Production Notes cannot be updated',
27
- description: 'There was an internal error while updating the Production notes.',
28
- type: 'System',
29
- });
30
- });
31
- it('should decode unknown error as', () => {
32
- const decoded = (0, errors_decoder_1.default)('UNKNOWN_FAKE_ERROR');
33
- expect(decoded).toEqual({
34
- title: 'Unknown',
35
- description: '',
36
- });
37
- });
38
- });
package/dist/cjs/lib/errors-decoder.js DELETED
@@ -1,300 +0,0 @@
1
- "use strict";
2
- /*!
3
- * © 2020 Atypon Systems LLC
4
- *
5
- * Licensed under the Apache License, Version 2.0 (the "License");
6
- * you may not use this file except in compliance with the License.
7
- * You may obtain a copy of the License at
8
- *
9
- * http://www.apache.org/licenses/LICENSE-2.0
10
- *
11
- * Unless required by applicable law or agreed to in writing, software
12
- * distributed under the License is distributed on an "AS IS" BASIS,
13
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
- * See the License for the specific language governing permissions and
15
- * limitations under the License.
16
- */
17
- Object.defineProperty(exports, "__esModule", { value: true });
18
- const errorsExplanations = {
19
- ANY_ERR_AUTHORIZATION: {
20
- title: 'Authorization issue',
21
- description: "It seems you don't have access to this resource. If you think you should have access, please contact the support team.",
22
- type: 'System',
23
- },
24
- PREVIEW_HTML_GENERATION_FAILED: {
25
- title: 'Failure in auto-generation of HTML preview',
26
- description: 'The HTML preview could not be generated due to an internal error.',
27
- type: 'System',
28
- },
29
- PREVIEW_PDF_GENERATION_FAILED: {
30
- title: 'Failure in auto-generation of PDF preview',
31
- description: 'The PDF preview could not be generated due to an internal error.',
32
- type: 'System',
33
- },
34
- PREVIEW_PDF_TEMPLATE_MISSING: {
35
- title: 'Failure in auto-generation of PDF preview',
36
- description: 'The PDF preview could not be generated due to an internal error.',
37
- type: 'System',
38
- },
39
- PREVIEW_EPUB_GENERATION_FAILED: {
40
- title: 'Failure in auto-generation of ePub preview',
41
- description: 'The ePub preview could not be generated due to an internal error.',
42
- type: 'System',
43
- },
44
- PREVIEW_SERVICE_UNAVAILABLE: {
45
- title: 'The preview service is unavailable',
46
- description: 'The preview could not be generated due to an internal error.',
47
- type: 'System',
48
- },
49
- MANUSCRIPT_CONTENT_PARSING_FAILED: {
50
- title: 'Quality report cannot be generated',
51
- description: 'There is a problem generating the Quality report.',
52
- type: 'System',
53
- },
54
- QR_PROFILE_NOT_FOUND: {
55
- title: 'Quality service configuration error',
56
- description: 'The Quallity service is not cofigured correctly.',
57
- type: 'System',
58
- },
59
- QR_SERVICE_UNAVAILABLE: {
60
- title: 'Quality service unavailable',
61
- description: 'The Quallity service is not available at the moment.',
62
- type: 'System',
63
- },
64
- MANUSCRIPT_ARCHIVE_FETCH_FAILED: {
65
- title: 'Content cannot be loaded',
66
- description: 'There was an error trying to load the content.',
67
- type: 'System',
68
- },
69
- EDT_QAREPORT_INVALID: {
70
- title: 'Invalid Quality report',
71
- description: 'The quality report could not be loaded.',
72
- type: 'System',
73
- },
74
- TSK_FAILED: {
75
- title: 'Internal error',
76
- description: 'An internal error occured while the system was processing the submission.',
77
- type: 'System',
78
- },
79
- TSK_MYTASKS_NOT_LOADED: {
80
- title: 'Task list cannot be loaded',
81
- description: 'There was an internal error while loading the list of your tasks.',
82
- type: 'System',
83
- },
84
- TSK_TASKSQUEUE_NOT_LOADED: {
85
- title: 'Task list cannot be loaded',
86
- description: 'There was an internal error while loading the list of open tasks to pick up from.',
87
- type: 'System',
88
- },
89
- TSK_ASSIGN_FAILED: {
90
- title: 'Task not assigned',
91
- description: 'There was an internal error while assigning the task to your task list.',
92
- type: 'System',
93
- },
94
- NOTES_FETCH_FAILED: {
95
- title: 'Production Notes cannot be loaded',
96
- description: 'There was an internal error while loading the Production notes.',
97
- type: 'System',
98
- },
99
- NOTES_NOT_UPDATED: {
100
- title: 'Production Notes cannot be updated',
101
- description: 'There was an internal error while updating the Production notes.',
102
- type: 'System',
103
- },
104
- FHC_DOWNLOAD_FILE_NOT_EXISTS: {
105
- title: 'File does not exist',
106
- description: 'The file you have tried to download does not exist. Please contact tne support team.',
107
- type: 'System',
108
- },
109
- FHC_DOWNLOAD_FILE_NAME_NOT_EXISTS: {
110
- title: 'Filename cannot be found',
111
- description: '',
112
- type: 'System',
113
- },
114
- FHC_FILES_NOT_APPEARING: {
115
- title: 'Error loading the files',
116
- description: 'There was an internal error while fetching the list of files for the article.',
117
- type: 'System',
118
- },
119
- FHC_UPLOAD_FAIL: {
120
- title: 'Upload of the file failed',
121
- description: 'There was an internal error while uploading the file.',
122
- type: 'System',
123
- },
124
- WFM_AVAILABLE_TRANSITIONS_NOT_LOADED: {
125
- title: 'Workflow steps not loaded',
126
- description: 'There was an internal error while loading the possible workflow next steps.',
127
- type: 'System',
128
- },
129
- WFM_TRANSITION_FAIL: {
130
- title: 'Workflow not advanced to next step',
131
- description: 'There was an internal error while advancing to the next step of the workflow.',
132
- type: 'System',
133
- },
134
- SBM_RESCHEDULE_FAILED: {
135
- title: 'Rescheduling the article failed',
136
- description: 'There was an internal error while attempting to reschedule the due date of the article.',
137
- type: 'System',
138
- },
139
- MANUSCRIPTS_API_INTERNAL_ERROR: {
140
- title: 'Internal error',
141
- description: 'There was an internal error in the system.',
142
- type: 'System',
143
- },
144
- DBR_ERR_INTERNAL: {
145
- title: 'Internal error',
146
- description: 'There was an internal error in the system.',
147
- type: 'System',
148
- },
149
- CI_CONSUME_NEW_PACKAGE_EXCEPTION: {
150
- title: 'The package is not loaded',
151
- description: 'There was an internal error while reading the source package.',
152
- type: 'System',
153
- },
154
- CI_VALIDATE_PACKAGE_EXCEPTION: {
155
- title: 'Invalid package',
156
- description: 'The content in the package sent from Peer Review system or other external source was invalid.',
157
- type: 'System',
158
- },
159
- CI_READY_FOR_CONVERSION_CHECK_EXCEPTION: {
160
- title: 'Package validation failed',
161
- description: 'There was an internal error while checking whether the package is ready to be converted to JATS XML.',
162
- type: 'System',
163
- },
164
- CI_FAIL_SERVICE_UNAVAILABLE: {
165
- title: 'Completeness & Usability check failure',
166
- description: 'The Completeness & Usability check failed because the service was not available at the time.',
167
- type: 'System',
168
- },
169
- CI_STRUCTURING_FAILED: {
170
- title: 'Automated structuring failed',
171
- description: 'The automated structuring of the document has failed.',
172
- type: 'System',
173
- },
174
- CI_UPLOAD_TO_EDITOR_EXCEPTION: {
175
- title: 'Failed to load the article to the editor',
176
- description: 'There was an internal exception while trying to load the article to the editor.',
177
- type: 'System',
178
- },
179
- CP_ASSIGN_TO_CS_FOR_IMAGE_PREP: {
180
- title: 'Workflow manager error',
181
- description: 'There was an internal error while trying to assign the task for image preparation.',
182
- type: 'System',
183
- },
184
- CP_ASSIGN_TO_CE_QUEUE_EXCEPTION: {
185
- title: 'Workflow manager error',
186
- description: 'There was an internal error while assigning the task to the Copy Editors queue.',
187
- type: 'System',
188
- },
189
- P_ASSIGN_TO_AUTHOR_EXCEPTION: {
190
- title: 'Workflow manager error',
191
- description: 'There was an internal error while assigning the task to the Author.',
192
- type: 'System',
193
- },
194
- PUB_FAIL_PACKAGE: {
195
- title: 'Packaging the content failed',
196
- description: 'There was an internal error while packaging the content for publication.',
197
- type: 'System',
198
- },
199
- PUB_FAIL_DELIVERY: {
200
- title: 'The package was not delivered for publication',
201
- description: 'The package could not be delivered for publication.',
202
- type: 'System',
203
- },
204
- CI_CONVERT_TO_JATS_EXCEPTION: {
205
- title: 'Failed to convert the article to JATS XML',
206
- description: 'There was an internal exception while trying to convert the article to JATS XML.',
207
- type: 'System',
208
- },
209
- CI_FAIL_JATS_CONVERSION: {
210
- title: 'Failure on conversion to JATS XML',
211
- description: '',
212
- type: 'Workflow',
213
- },
214
- CI_INVALID_PACKAGE: {
215
- title: 'Invalid package',
216
- description: 'The input package is of invalid format. Please contact the source where the submitted article comes from.',
217
- type: 'Workflow',
218
- },
219
- CI_IMAGES_EXTRACTED: {
220
- title: 'Images extracted',
221
- description: 'There are images extracted from the Word document file. Please check the quality of these images.',
222
- type: 'Workflow',
223
- },
224
- CP_IMAGES_INCOMPLETE: {
225
- title: 'Missing images',
226
- description: 'Some images of the article are either missing, incomplete or corrupted.',
227
- type: 'Workflow',
228
- },
229
- CP_IMAGES_UNSUPPORTED_FORMAT: {
230
- title: 'Images of unsupported format',
231
- description: 'There are images in the document of unsupported format.',
232
- type: 'Workflow',
233
- },
234
- CP_FIGURES_MULTIPLE_IMAGES: {
235
- title: 'Figures with multiple images',
236
- description: 'There are figures in the docment containing multiple images.',
237
- type: 'Workflow',
238
- },
239
- CP_FILES_MERGED: {
240
- title: 'Package files were merged',
241
- description: 'Submission files were merged automatically before conversion. In case of errors please check the merged main manuscript to check the correct files were merged.',
242
- type: 'Workflow',
243
- },
244
- FC_FAIL_QA_CHECKLIST: {
245
- title: 'Quality report checks outstanding',
246
- description: 'The Quality report still contains outstanding critical checks that have to be resolved in order to proceed.',
247
- type: 'Workflow',
248
- },
249
- CI_NO_DOCUMENT: {
250
- title: 'There is no document file',
251
- description: 'The package does not contain any main manuscript file.',
252
- type: 'Workflow',
253
- },
254
- CI_ADDITIONAL_WORD_FILES: {
255
- title: 'Multiple word files',
256
- description: 'The package contains multiple word files. Please have the content of the package adjusted.',
257
- type: 'Workflow',
258
- },
259
- CI_XML_AMENDMENT_FAILED: {
260
- title: 'External file references error',
261
- description: 'The XML document could not be amended with the external file references.',
262
- type: 'Workflow',
263
- },
264
- CI_IMAGES_NOT_MATCHED: {
265
- title: 'Images not found',
266
- description: 'The package does not contain all the images refenenced in the document. Please have the content of the package adjusted.',
267
- type: 'Workflow',
268
- },
269
- CI_METADATA_MISSING: {
270
- title: 'Metadata missing',
271
- description: 'Not all the required metadata could be foundin the content of the package. Please have the content of the package adjusted.',
272
- type: 'Workflow',
273
- },
274
- CI_INVALID_DTD: {
275
- title: 'Invalid DTD',
276
- description: 'The DTD file is invalid. Please have the content of the package adjusted.',
277
- type: 'Workflow',
278
- },
279
- CI_INVALID_FORMAT: {
280
- title: 'Invalid Word file',
281
- description: 'The format or version of the Word file is not correct or supported. Please have the content of the package adjusted.',
282
- type: 'Workflow',
283
- },
284
- CI_UNSUPPORTED_FORMAT: {
285
- title: 'Unsupported file format',
286
- description: 'The package contains a main document file that is not of the word document formats (DOCX/DOC) supported.',
287
- type: 'Workflow',
288
- },
289
- CI_UNSUPPORTED_SECTION: {
290
- title: 'Unsupported section',
291
- description: 'The package contains a file with a graphical abstract section.',
292
- type: 'Workflow',
293
- },
294
- CI_PREPROCESSING_FAILED: {
295
- title: 'Main manuscript processing failed',
296
- description: 'Processing the package files and setting the main manuscript has failed.',
297
- type: 'Workflow',
298
- },
299
- };
300
- exports.default = (code) => errorsExplanations[code] || { title: 'Unknown', description: '' };
package/dist/es/lib/__tests__/errors-decoder.test.js DELETED
@@ -1,33 +0,0 @@
1
- /*!
2
- * © 2019 Atypon Systems LLC
3
- *
4
- * Licensed under the Apache License, Version 2.0 (the "License");
5
- * you may not use this file except in compliance with the License.
6
- * You may obtain a copy of the License at
7
- *
8
- * http://www.apache.org/licenses/LICENSE-2.0
9
- *
10
- * Unless required by applicable law or agreed to in writing, software
11
- * distributed under the License is distributed on an "AS IS" BASIS,
12
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
- * See the License for the specific language governing permissions and
14
- * limitations under the License.
15
- */
16
- import decodeError from '../errors-decoder';
17
- describe('decodedError', () => {
18
- it('should decode error as', () => {
19
- const decoded = decodeError('NOTES_NOT_UPDATED');
20
- expect(decoded).toEqual({
21
- title: 'Production Notes cannot be updated',
22
- description: 'There was an internal error while updating the Production notes.',
23
- type: 'System',
24
- });
25
- });
26
- it('should decode unknown error as', () => {
27
- const decoded = decodeError('UNKNOWN_FAKE_ERROR');
28
- expect(decoded).toEqual({
29
- title: 'Unknown',
30
- description: '',
31
- });
32
- });
33
- });
package/dist/es/lib/errors-decoder.js DELETED
@@ -1,298 +0,0 @@
1
- /*!
2
- * © 2020 Atypon Systems LLC
3
- *
4
- * Licensed under the Apache License, Version 2.0 (the "License");
5
- * you may not use this file except in compliance with the License.
6
- * You may obtain a copy of the License at
7
- *
8
- * http://www.apache.org/licenses/LICENSE-2.0
9
- *
10
- * Unless required by applicable law or agreed to in writing, software
11
- * distributed under the License is distributed on an "AS IS" BASIS,
12
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
- * See the License for the specific language governing permissions and
14
- * limitations under the License.
15
- */
16
- const errorsExplanations = {
17
- ANY_ERR_AUTHORIZATION: {
18
- title: 'Authorization issue',
19
- description: "It seems you don't have access to this resource. If you think you should have access, please contact the support team.",
20
- type: 'System',
21
- },
22
- PREVIEW_HTML_GENERATION_FAILED: {
23
- title: 'Failure in auto-generation of HTML preview',
24
- description: 'The HTML preview could not be generated due to an internal error.',
25
- type: 'System',
26
- },
27
- PREVIEW_PDF_GENERATION_FAILED: {
28
- title: 'Failure in auto-generation of PDF preview',
29
- description: 'The PDF preview could not be generated due to an internal error.',
30
- type: 'System',
31
- },
32
- PREVIEW_PDF_TEMPLATE_MISSING: {
33
- title: 'Failure in auto-generation of PDF preview',
34
- description: 'The PDF preview could not be generated due to an internal error.',
35
- type: 'System',
36
- },
37
- PREVIEW_EPUB_GENERATION_FAILED: {
38
- title: 'Failure in auto-generation of ePub preview',
39
- description: 'The ePub preview could not be generated due to an internal error.',
40
- type: 'System',
41
- },
42
- PREVIEW_SERVICE_UNAVAILABLE: {
43
- title: 'The preview service is unavailable',
44
- description: 'The preview could not be generated due to an internal error.',
45
- type: 'System',
46
- },
47
- MANUSCRIPT_CONTENT_PARSING_FAILED: {
48
- title: 'Quality report cannot be generated',
49
- description: 'There is a problem generating the Quality report.',
50
- type: 'System',
51
- },
52
- QR_PROFILE_NOT_FOUND: {
53
- title: 'Quality service configuration error',
54
- description: 'The Quallity service is not cofigured correctly.',
55
- type: 'System',
56
- },
57
- QR_SERVICE_UNAVAILABLE: {
58
- title: 'Quality service unavailable',
59
- description: 'The Quallity service is not available at the moment.',
60
- type: 'System',
61
- },
62
- MANUSCRIPT_ARCHIVE_FETCH_FAILED: {
63
- title: 'Content cannot be loaded',
64
- description: 'There was an error trying to load the content.',
65
- type: 'System',
66
- },
67
- EDT_QAREPORT_INVALID: {
68
- title: 'Invalid Quality report',
69
- description: 'The quality report could not be loaded.',
70
- type: 'System',
71
- },
72
- TSK_FAILED: {
73
- title: 'Internal error',
74
- description: 'An internal error occured while the system was processing the submission.',
75
- type: 'System',
76
- },
77
- TSK_MYTASKS_NOT_LOADED: {
78
- title: 'Task list cannot be loaded',
79
- description: 'There was an internal error while loading the list of your tasks.',
80
- type: 'System',
81
- },
82
- TSK_TASKSQUEUE_NOT_LOADED: {
83
- title: 'Task list cannot be loaded',
84
- description: 'There was an internal error while loading the list of open tasks to pick up from.',
85
- type: 'System',
86
- },
87
- TSK_ASSIGN_FAILED: {
88
- title: 'Task not assigned',
89
- description: 'There was an internal error while assigning the task to your task list.',
90
- type: 'System',
91
- },
92
- NOTES_FETCH_FAILED: {
93
- title: 'Production Notes cannot be loaded',
94
- description: 'There was an internal error while loading the Production notes.',
95
- type: 'System',
96
- },
97
- NOTES_NOT_UPDATED: {
98
- title: 'Production Notes cannot be updated',
99
- description: 'There was an internal error while updating the Production notes.',
100
- type: 'System',
101
- },
102
- FHC_DOWNLOAD_FILE_NOT_EXISTS: {
103
- title: 'File does not exist',
104
- description: 'The file you have tried to download does not exist. Please contact tne support team.',
105
- type: 'System',
106
- },
107
- FHC_DOWNLOAD_FILE_NAME_NOT_EXISTS: {
108
- title: 'Filename cannot be found',
109
- description: '',
110
- type: 'System',
111
- },
112
- FHC_FILES_NOT_APPEARING: {
113
- title: 'Error loading the files',
114
- description: 'There was an internal error while fetching the list of files for the article.',
115
- type: 'System',
116
- },
117
- FHC_UPLOAD_FAIL: {
118
- title: 'Upload of the file failed',
119
- description: 'There was an internal error while uploading the file.',
120
- type: 'System',
121
- },
122
- WFM_AVAILABLE_TRANSITIONS_NOT_LOADED: {
123
- title: 'Workflow steps not loaded',
124
- description: 'There was an internal error while loading the possible workflow next steps.',
125
- type: 'System',
126
- },
127
- WFM_TRANSITION_FAIL: {
128
- title: 'Workflow not advanced to next step',
129
- description: 'There was an internal error while advancing to the next step of the workflow.',
130
- type: 'System',
131
- },
132
- SBM_RESCHEDULE_FAILED: {
133
- title: 'Rescheduling the article failed',
134
- description: 'There was an internal error while attempting to reschedule the due date of the article.',
135
- type: 'System',
136
- },
137
- MANUSCRIPTS_API_INTERNAL_ERROR: {
138
- title: 'Internal error',
139
- description: 'There was an internal error in the system.',
140
- type: 'System',
141
- },
142
- DBR_ERR_INTERNAL: {
143
- title: 'Internal error',
144
- description: 'There was an internal error in the system.',
145
- type: 'System',
146
- },
147
- CI_CONSUME_NEW_PACKAGE_EXCEPTION: {
148
- title: 'The package is not loaded',
149
- description: 'There was an internal error while reading the source package.',
150
- type: 'System',
151
- },
152
- CI_VALIDATE_PACKAGE_EXCEPTION: {
153
- title: 'Invalid package',
154
- description: 'The content in the package sent from Peer Review system or other external source was invalid.',
155
- type: 'System',
156
- },
157
- CI_READY_FOR_CONVERSION_CHECK_EXCEPTION: {
158
- title: 'Package validation failed',
159
- description: 'There was an internal error while checking whether the package is ready to be converted to JATS XML.',
160
- type: 'System',
161
- },
162
- CI_FAIL_SERVICE_UNAVAILABLE: {
163
- title: 'Completeness & Usability check failure',
164
- description: 'The Completeness & Usability check failed because the service was not available at the time.',
165
- type: 'System',
166
- },
167
- CI_STRUCTURING_FAILED: {
168
- title: 'Automated structuring failed',
169
- description: 'The automated structuring of the document has failed.',
170
- type: 'System',
171
- },
172
- CI_UPLOAD_TO_EDITOR_EXCEPTION: {
173
- title: 'Failed to load the article to the editor',
174
- description: 'There was an internal exception while trying to load the article to the editor.',
175
- type: 'System',
176
- },
177
- CP_ASSIGN_TO_CS_FOR_IMAGE_PREP: {
178
- title: 'Workflow manager error',
179
- description: 'There was an internal error while trying to assign the task for image preparation.',
180
- type: 'System',
181
- },
182
- CP_ASSIGN_TO_CE_QUEUE_EXCEPTION: {
183
- title: 'Workflow manager error',
184
- description: 'There was an internal error while assigning the task to the Copy Editors queue.',
185
- type: 'System',
186
- },
187
- P_ASSIGN_TO_AUTHOR_EXCEPTION: {
188
- title: 'Workflow manager error',
189
- description: 'There was an internal error while assigning the task to the Author.',
190
- type: 'System',
191
- },
192
- PUB_FAIL_PACKAGE: {
193
- title: 'Packaging the content failed',
194
- description: 'There was an internal error while packaging the content for publication.',
195
- type: 'System',
196
- },
197
- PUB_FAIL_DELIVERY: {
198
- title: 'The package was not delivered for publication',
199
- description: 'The package could not be delivered for publication.',
200
- type: 'System',
201
- },
202
- CI_CONVERT_TO_JATS_EXCEPTION: {
203
- title: 'Failed to convert the article to JATS XML',
204
- description: 'There was an internal exception while trying to convert the article to JATS XML.',
205
- type: 'System',
206
- },
207
- CI_FAIL_JATS_CONVERSION: {
208
- title: 'Failure on conversion to JATS XML',
209
- description: '',
210
- type: 'Workflow',
211
- },
212
- CI_INVALID_PACKAGE: {
213
- title: 'Invalid package',
214
- description: 'The input package is of invalid format. Please contact the source where the submitted article comes from.',
215
- type: 'Workflow',
216
- },
217
- CI_IMAGES_EXTRACTED: {
218
- title: 'Images extracted',
219
- description: 'There are images extracted from the Word document file. Please check the quality of these images.',
220
- type: 'Workflow',
221
- },
222
- CP_IMAGES_INCOMPLETE: {
223
- title: 'Missing images',
224
- description: 'Some images of the article are either missing, incomplete or corrupted.',
225
- type: 'Workflow',
226
- },
227
- CP_IMAGES_UNSUPPORTED_FORMAT: {
228
- title: 'Images of unsupported format',
229
- description: 'There are images in the document of unsupported format.',
230
- type: 'Workflow',
231
- },
232
- CP_FIGURES_MULTIPLE_IMAGES: {
233
- title: 'Figures with multiple images',
234
- description: 'There are figures in the docment containing multiple images.',
235
- type: 'Workflow',
236
- },
237
- CP_FILES_MERGED: {
238
- title: 'Package files were merged',
239
- description: 'Submission files were merged automatically before conversion. In case of errors please check the merged main manuscript to check the correct files were merged.',
240
- type: 'Workflow',
241
- },
242
- FC_FAIL_QA_CHECKLIST: {
243
- title: 'Quality report checks outstanding',
244
- description: 'The Quality report still contains outstanding critical checks that have to be resolved in order to proceed.',
245
- type: 'Workflow',
246
- },
247
- CI_NO_DOCUMENT: {
248
- title: 'There is no document file',
249
- description: 'The package does not contain any main manuscript file.',
250
- type: 'Workflow',
251
- },
252
- CI_ADDITIONAL_WORD_FILES: {
253
- title: 'Multiple word files',
254
- description: 'The package contains multiple word files. Please have the content of the package adjusted.',
255
- type: 'Workflow',
256
- },
257
- CI_XML_AMENDMENT_FAILED: {
258
- title: 'External file references error',
259
- description: 'The XML document could not be amended with the external file references.',
260
- type: 'Workflow',
261
- },
262
- CI_IMAGES_NOT_MATCHED: {
263
- title: 'Images not found',
264
- description: 'The package does not contain all the images refenenced in the document. Please have the content of the package adjusted.',
265
- type: 'Workflow',
266
- },
267
- CI_METADATA_MISSING: {
268
- title: 'Metadata missing',
269
- description: 'Not all the required metadata could be foundin the content of the package. Please have the content of the package adjusted.',
270
- type: 'Workflow',
271
- },
272
- CI_INVALID_DTD: {
273
- title: 'Invalid DTD',
274
- description: 'The DTD file is invalid. Please have the content of the package adjusted.',
275
- type: 'Workflow',
276
- },
277
- CI_INVALID_FORMAT: {
278
- title: 'Invalid Word file',
279
- description: 'The format or version of the Word file is not correct or supported. Please have the content of the package adjusted.',
280
- type: 'Workflow',
281
- },
282
- CI_UNSUPPORTED_FORMAT: {
283
- title: 'Unsupported file format',
284
- description: 'The package contains a main document file that is not of the word document formats (DOCX/DOC) supported.',
285
- type: 'Workflow',
286
- },
287
- CI_UNSUPPORTED_SECTION: {
288
- title: 'Unsupported section',
289
- description: 'The package contains a file with a graphical abstract section.',
290
- type: 'Workflow',
291
- },
292
- CI_PREPROCESSING_FAILED: {
293
- title: 'Main manuscript processing failed',
294
- description: 'Processing the package files and setting the main manuscript has failed.',
295
- type: 'Workflow',
296
- },
297
- };
298
- export default (code) => errorsExplanations[code] || { title: 'Unknown', description: '' };
package/dist/types/lib/__tests__/errors-decoder.test.d.ts DELETED
@@ -1,16 +0,0 @@
1
- /*!
2
- * © 2019 Atypon Systems LLC
3
- *
4
- * Licensed under the Apache License, Version 2.0 (the "License");
5
- * you may not use this file except in compliance with the License.
6
- * You may obtain a copy of the License at
7
- *
8
- * http://www.apache.org/licenses/LICENSE-2.0
9
- *
10
- * Unless required by applicable law or agreed to in writing, software
11
- * distributed under the License is distributed on an "AS IS" BASIS,
12
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
- * See the License for the specific language governing permissions and
14
- * limitations under the License.
15
- */
16
- export {};
package/dist/types/lib/errors-decoder.d.ts DELETED
@@ -1,22 +0,0 @@
1
- /*!
2
- * © 2020 Atypon Systems LLC
3
- *
4
- * Licensed under the Apache License, Version 2.0 (the "License");
5
- * you may not use this file except in compliance with the License.
6
- * You may obtain a copy of the License at
7
- *
8
- * http://www.apache.org/licenses/LICENSE-2.0
9
- *
10
- * Unless required by applicable law or agreed to in writing, software
11
- * distributed under the License is distributed on an "AS IS" BASIS,
12
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
- * See the License for the specific language governing permissions and
14
- * limitations under the License.
15
- */
16
- interface errorDescription {
17
- title: string;
18
- description: string;
19
- type?: 'System' | 'Workflow';
20
- }
21
- declare const _default: (code: string) => errorDescription;
22
- export default _default;