@appsemble/types 0.32.3 → 0.33.1
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/README.md +3 -3
- package/package.json +1 -1
- package/training.d.ts +15 -4
package/README.md
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
#  Appsemble Types
|
|
2
2
|
|
|
3
3
|
> Reusable TypeScript types
|
|
4
4
|
|
|
5
5
|
[](https://www.npmjs.com/package/@appsemble/types)
|
|
6
|
-
[](https://gitlab.com/appsemble/appsemble/-/releases/0.33.1)
|
|
7
7
|
[](https://prettier.io)
|
|
8
8
|
|
|
9
9
|
## Table of Contents
|
|
@@ -26,5 +26,5 @@ not guaranteed.
|
|
|
26
26
|
|
|
27
27
|
## License
|
|
28
28
|
|
|
29
|
-
[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.
|
|
29
|
+
[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.33.1/LICENSE.md) ©
|
|
30
30
|
[Appsemble](https://appsemble.com)
|
package/package.json
CHANGED
package/training.d.ts
CHANGED
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
import { type ComponentType } from 'react';
|
|
2
2
|
export type TrainingStatus = 'available' | 'blocked' | 'completed' | 'in progress';
|
|
3
|
+
/**
|
|
4
|
+
* Training chapter after it's been processed. This gets used in the training tree itself.
|
|
5
|
+
*/
|
|
3
6
|
export interface TrainingChapter {
|
|
4
7
|
/**
|
|
5
8
|
* ID of the chapter.
|
|
@@ -14,14 +17,18 @@ export interface TrainingChapter {
|
|
|
14
17
|
*/
|
|
15
18
|
trainings: Training[];
|
|
16
19
|
/**
|
|
17
|
-
* The ID of the chapter that has to be completed before this one can be accessed.
|
|
20
|
+
* The ID of the chapter that has to be completed before this one can be accessed. Can also be an
|
|
21
|
+
* array if multiple chapters block this one.
|
|
18
22
|
*/
|
|
19
|
-
blockedBy?: string;
|
|
23
|
+
blockedBy?: string[] | string;
|
|
20
24
|
/**
|
|
21
25
|
* The status of the chapter
|
|
22
26
|
*/
|
|
23
27
|
status: TrainingStatus;
|
|
24
28
|
}
|
|
29
|
+
/**
|
|
30
|
+
* Properties of an individual training module.
|
|
31
|
+
*/
|
|
25
32
|
export interface Training {
|
|
26
33
|
/**
|
|
27
34
|
* Id of the training.
|
|
@@ -44,11 +51,15 @@ export interface Training {
|
|
|
44
51
|
*/
|
|
45
52
|
status: TrainingStatus;
|
|
46
53
|
}
|
|
54
|
+
/**
|
|
55
|
+
* Properties of a training chapter as defined in the project files.
|
|
56
|
+
*/
|
|
47
57
|
export interface TrainingChapterProperties {
|
|
48
58
|
/**
|
|
49
|
-
* The ID of the chapter that has to be completed before this one can be accessed.
|
|
59
|
+
* The ID of the chapter that has to be completed before this one can be accessed. Can also be an
|
|
60
|
+
* array if multiple chapters block this one.
|
|
50
61
|
*/
|
|
51
|
-
blockedBy: string;
|
|
62
|
+
blockedBy: string[] | string;
|
|
52
63
|
/**
|
|
53
64
|
* Title of the chapter
|
|
54
65
|
*/
|