@learnpack/learnpack 5.0.275 → 5.0.277

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 (95) hide show
  1. package/README.md +409 -409
  2. package/lib/commands/audit.js +15 -15
  3. package/lib/commands/breakToken.js +19 -19
  4. package/lib/commands/clean.js +3 -3
  5. package/lib/commands/init.js +41 -41
  6. package/lib/commands/logout.js +3 -3
  7. package/lib/commands/publish.js +5 -10
  8. package/lib/commands/serve.js +55 -2
  9. package/lib/creatorDist/assets/index-BfLyIQVh.js +10343 -10224
  10. package/lib/managers/config/index.js +77 -77
  11. package/lib/utils/api.d.ts +1 -1
  12. package/lib/utils/api.js +12 -9
  13. package/lib/utils/creatorUtilities.js +14 -14
  14. package/lib/utils/export/epub.d.ts +2 -0
  15. package/lib/utils/export/epub.js +298 -0
  16. package/lib/utils/export/index.d.ts +3 -0
  17. package/lib/utils/export/index.js +7 -0
  18. package/lib/utils/export/scorm.d.ts +2 -0
  19. package/lib/utils/export/scorm.js +84 -0
  20. package/lib/utils/export/shared.d.ts +4 -0
  21. package/lib/utils/export/shared.js +61 -0
  22. package/lib/utils/export/types.d.ts +15 -0
  23. package/lib/utils/export/types.js +2 -0
  24. package/package.json +2 -1
  25. package/src/commands/audit.ts +487 -487
  26. package/src/commands/breakToken.ts +67 -67
  27. package/src/commands/clean.ts +30 -30
  28. package/src/commands/init.ts +650 -650
  29. package/src/commands/logout.ts +38 -38
  30. package/src/commands/publish.ts +20 -25
  31. package/src/commands/serve.ts +69 -4
  32. package/src/commands/start.ts +333 -333
  33. package/src/commands/translate.ts +123 -123
  34. package/src/creator/README.md +54 -54
  35. package/src/creator/eslint.config.js +7 -7
  36. package/src/creator/src/components/syllabus/ContentIndex.tsx +312 -312
  37. package/src/creator/src/i18n.ts +28 -28
  38. package/src/creator/src/index.css +217 -217
  39. package/src/creator/src/locales/en.json +126 -126
  40. package/src/creator/src/locales/es.json +126 -126
  41. package/src/creator/src/utils/configTypes.ts +122 -122
  42. package/src/creator/src/utils/constants.ts +13 -13
  43. package/src/creator/src/utils/creatorUtils.ts +46 -46
  44. package/src/creator/src/utils/eventBus.ts +2 -2
  45. package/src/creator/src/utils/lib.ts +468 -468
  46. package/src/creator/src/utils/socket.ts +61 -61
  47. package/src/creator/src/utils/store.ts +222 -222
  48. package/src/creator/src/vite-env.d.ts +1 -1
  49. package/src/creator/vite.config.ts +13 -13
  50. package/src/creatorDist/assets/index-BfLyIQVh.js +10343 -10224
  51. package/src/managers/config/defaults.ts +49 -49
  52. package/src/managers/config/exercise.ts +364 -364
  53. package/src/managers/config/index.ts +775 -775
  54. package/src/managers/file.ts +236 -236
  55. package/src/managers/server/routes.ts +554 -554
  56. package/src/managers/session.ts +182 -182
  57. package/src/managers/telemetry.ts +188 -188
  58. package/src/models/action.ts +13 -13
  59. package/src/models/config-manager.ts +28 -28
  60. package/src/models/config.ts +106 -106
  61. package/src/models/creator.ts +47 -47
  62. package/src/models/exercise-obj.ts +30 -30
  63. package/src/models/session.ts +39 -39
  64. package/src/models/socket.ts +61 -61
  65. package/src/models/status.ts +16 -16
  66. package/src/ui/_app/app.css +1 -1
  67. package/src/ui/_app/app.js +400 -397
  68. package/src/ui/app.tar.gz +0 -0
  69. package/src/utils/BaseCommand.ts +56 -56
  70. package/src/utils/api.ts +53 -39
  71. package/src/utils/audit.ts +392 -392
  72. package/src/utils/checkNotInstalled.ts +267 -267
  73. package/src/utils/configBuilder.ts +82 -82
  74. package/src/utils/convertCreds.js +34 -34
  75. package/src/utils/creatorUtilities.ts +504 -504
  76. package/src/utils/export/README.md +178 -0
  77. package/src/utils/export/epub.ts +400 -0
  78. package/src/utils/export/index.ts +3 -0
  79. package/src/utils/export/scorm.ts +121 -0
  80. package/src/utils/export/shared.ts +61 -0
  81. package/src/utils/export/types.ts +17 -0
  82. package/src/utils/incrementVersion.js +74 -74
  83. package/src/utils/misc.ts +58 -58
  84. package/src/utils/rigoActions.ts +500 -500
  85. package/src/utils/sidebarGenerator.ts +195 -195
  86. package/src/utils/templates/epub/epub.css +133 -0
  87. package/src/utils/templates/isolated/exercises/01-hello-world/README.es.md +26 -26
  88. package/src/utils/templates/isolated/exercises/01-hello-world/README.md +26 -26
  89. package/src/utils/templates/scorm/adlcp_rootv1p2.xsd +110 -0
  90. package/src/utils/templates/scorm/config/api.js +175 -0
  91. package/src/utils/templates/scorm/config/index.html +210 -0
  92. package/src/utils/templates/scorm/ims_xml.xsd +1 -0
  93. package/src/utils/templates/scorm/imscp_rootv1p1p2.xsd +345 -0
  94. package/src/utils/templates/scorm/imsmanifest.xml +38 -0
  95. package/src/utils/templates/scorm/imsmd_rootv1p2p1.xsd +573 -0
@@ -1,123 +1,123 @@
1
- import SessionCommand from "../utils/SessionCommand"
2
- import * as fs from "fs"
3
- import * as path from "path"
4
- import * as prompts from "prompts"
5
- import { translateExercise } from "../utils/rigoActions"
6
- import SessionManager from "../managers/session"
7
- import Console from "../utils/console"
8
- import { saveTranslatedReadme } from "../utils/creatorUtilities"
9
-
10
- // This function list the names of the exercise directories inside the ./exercises folder, if the exercises folder doesn't exist, it will look for the ./.learn/exercises folder
11
- const listExercises = async () => {
12
- const exercisesDir = path.join(process.cwd(), "exercises")
13
- const learnExercisesDir = path.join(process.cwd(), ".learn", "exercises")
14
-
15
- const exercises = fs.readdirSync(exercisesDir).filter(file => {
16
- return fs.statSync(path.join(exercisesDir, file)).isDirectory()
17
- })
18
-
19
- if (exercises.length > 0) {
20
- return exercises
21
- }
22
-
23
- return fs.readdirSync(learnExercisesDir).filter(file => {
24
- return fs.statSync(path.join(learnExercisesDir, file)).isDirectory()
25
- })
26
- }
27
-
28
- const getReadmeForExercise = async (exercise: string) => {
29
- const readmePath = path.join(
30
- process.cwd(),
31
- "exercises",
32
- exercise,
33
- "README.md"
34
- )
35
- return fs.readFileSync(readmePath, "utf8")
36
- }
37
-
38
- export default class BuildCommand extends SessionCommand {
39
- static description =
40
- "List all the lessons, the user is able of select many of them to translate to the given languages"
41
-
42
- async init() {
43
- const { flags } = this.parse(BuildCommand)
44
- await this.initSession(flags)
45
- }
46
-
47
- async run() {
48
- const { flags } = this.parse(BuildCommand)
49
-
50
- const exercises = await listExercises()
51
-
52
- const exercisesToTranslate = await prompts([
53
- {
54
- type: "multiselect",
55
- name: "exercises",
56
- message: "Select the exercises to translate",
57
- choices: exercises.map(exercise => ({
58
- title: exercise,
59
- value: exercise,
60
- })),
61
- },
62
- {
63
- type: "text",
64
- name: "output_language",
65
- message:
66
- "Write the languages to translate to comma separated. Example: English, Spanish, French",
67
- initial: "Spanish",
68
- },
69
- ])
70
-
71
- const configObject = this.configManager?.get()
72
-
73
- if (configObject) {
74
- // build exerises
75
- Console.debug("Building exercises")
76
- this.configManager?.buildIndex()
77
- }
78
-
79
- let sessionPayload = await SessionManager.getPayload()
80
- if (!sessionPayload || !sessionPayload.rigobot) {
81
- Console.error("You must be logged in to upload a LearnPack package")
82
- try {
83
- sessionPayload = await SessionManager.login()
84
- } catch (error) {
85
- Console.error("Error trying to authenticate")
86
- Console.error((error as TypeError).message || (error as string))
87
- }
88
- }
89
-
90
- const rigoToken = sessionPayload.rigobot.key
91
-
92
- await Promise.all(
93
- exercisesToTranslate.exercises.map(async (exercise: string) => {
94
- await Promise.all(
95
- exercisesToTranslate.output_language
96
- .split(",")
97
- .map(async (language: string) => {
98
- const readme = await getReadmeForExercise(exercise)
99
- const response = await translateExercise(
100
- rigoToken,
101
- {
102
- text_to_translate: readme,
103
- output_language: language,
104
- },
105
- `${process.env.HOST}/webhooks/translate-exercise`
106
- )
107
-
108
- await saveTranslatedReadme(
109
- exercise,
110
- response.parsed.output_language_code,
111
- response.parsed.translation
112
- )
113
- Console.success(
114
- `Translated ${exercise} to ${language} successfully`
115
- )
116
- })
117
- )
118
- })
119
- )
120
-
121
- this.exit(0)
122
- }
123
- }
1
+ import SessionCommand from "../utils/SessionCommand"
2
+ import * as fs from "fs"
3
+ import * as path from "path"
4
+ import * as prompts from "prompts"
5
+ import { translateExercise } from "../utils/rigoActions"
6
+ import SessionManager from "../managers/session"
7
+ import Console from "../utils/console"
8
+ import { saveTranslatedReadme } from "../utils/creatorUtilities"
9
+
10
+ // This function list the names of the exercise directories inside the ./exercises folder, if the exercises folder doesn't exist, it will look for the ./.learn/exercises folder
11
+ const listExercises = async () => {
12
+ const exercisesDir = path.join(process.cwd(), "exercises")
13
+ const learnExercisesDir = path.join(process.cwd(), ".learn", "exercises")
14
+
15
+ const exercises = fs.readdirSync(exercisesDir).filter(file => {
16
+ return fs.statSync(path.join(exercisesDir, file)).isDirectory()
17
+ })
18
+
19
+ if (exercises.length > 0) {
20
+ return exercises
21
+ }
22
+
23
+ return fs.readdirSync(learnExercisesDir).filter(file => {
24
+ return fs.statSync(path.join(learnExercisesDir, file)).isDirectory()
25
+ })
26
+ }
27
+
28
+ const getReadmeForExercise = async (exercise: string) => {
29
+ const readmePath = path.join(
30
+ process.cwd(),
31
+ "exercises",
32
+ exercise,
33
+ "README.md"
34
+ )
35
+ return fs.readFileSync(readmePath, "utf8")
36
+ }
37
+
38
+ export default class BuildCommand extends SessionCommand {
39
+ static description =
40
+ "List all the lessons, the user is able of select many of them to translate to the given languages"
41
+
42
+ async init() {
43
+ const { flags } = this.parse(BuildCommand)
44
+ await this.initSession(flags)
45
+ }
46
+
47
+ async run() {
48
+ const { flags } = this.parse(BuildCommand)
49
+
50
+ const exercises = await listExercises()
51
+
52
+ const exercisesToTranslate = await prompts([
53
+ {
54
+ type: "multiselect",
55
+ name: "exercises",
56
+ message: "Select the exercises to translate",
57
+ choices: exercises.map(exercise => ({
58
+ title: exercise,
59
+ value: exercise,
60
+ })),
61
+ },
62
+ {
63
+ type: "text",
64
+ name: "output_language",
65
+ message:
66
+ "Write the languages to translate to comma separated. Example: English, Spanish, French",
67
+ initial: "Spanish",
68
+ },
69
+ ])
70
+
71
+ const configObject = this.configManager?.get()
72
+
73
+ if (configObject) {
74
+ // build exerises
75
+ Console.debug("Building exercises")
76
+ this.configManager?.buildIndex()
77
+ }
78
+
79
+ let sessionPayload = await SessionManager.getPayload()
80
+ if (!sessionPayload || !sessionPayload.rigobot) {
81
+ Console.error("You must be logged in to upload a LearnPack package")
82
+ try {
83
+ sessionPayload = await SessionManager.login()
84
+ } catch (error) {
85
+ Console.error("Error trying to authenticate")
86
+ Console.error((error as TypeError).message || (error as string))
87
+ }
88
+ }
89
+
90
+ const rigoToken = sessionPayload.rigobot.key
91
+
92
+ await Promise.all(
93
+ exercisesToTranslate.exercises.map(async (exercise: string) => {
94
+ await Promise.all(
95
+ exercisesToTranslate.output_language
96
+ .split(",")
97
+ .map(async (language: string) => {
98
+ const readme = await getReadmeForExercise(exercise)
99
+ const response = await translateExercise(
100
+ rigoToken,
101
+ {
102
+ text_to_translate: readme,
103
+ output_language: language,
104
+ },
105
+ `${process.env.HOST}/webhooks/translate-exercise`
106
+ )
107
+
108
+ await saveTranslatedReadme(
109
+ exercise,
110
+ response.parsed.output_language_code,
111
+ response.parsed.translation
112
+ )
113
+ Console.success(
114
+ `Translated ${exercise} to ${language} successfully`
115
+ )
116
+ })
117
+ )
118
+ })
119
+ )
120
+
121
+ this.exit(0)
122
+ }
123
+ }
@@ -1,54 +1,54 @@
1
- # React + TypeScript + Vite
2
-
3
- This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
4
-
5
- Currently, two official plugins are available:
6
-
7
- - [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
8
- - [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
9
-
10
- ## Expanding the ESLint configuration
11
-
12
- If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
13
-
14
- ```js
15
- export default tseslint.config({
16
- extends: [
17
- // Remove ...tseslint.configs.recommended and replace with this
18
- ...tseslint.configs.recommendedTypeChecked,
19
- // Alternatively, use this for stricter rules
20
- ...tseslint.configs.strictTypeChecked,
21
- // Optionally, add this for stylistic rules
22
- ...tseslint.configs.stylisticTypeChecked,
23
- ],
24
- languageOptions: {
25
- // other options...
26
- parserOptions: {
27
- project: ["./tsconfig.node.json", "./tsconfig.app.json"],
28
- tsconfigRootDir: import.meta.dirname,
29
- },
30
- },
31
- })
32
- ```
33
-
34
- You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
35
-
36
- ```js
37
- // eslint.config.js
38
- import reactX from "eslint-plugin-react-x"
39
- import reactDom from "eslint-plugin-react-dom"
40
-
41
- export default tseslint.config({
42
- plugins: {
43
- // Add the react-x and react-dom plugins
44
- "react-x": reactX,
45
- "react-dom": reactDom,
46
- },
47
- rules: {
48
- // other rules...
49
- // Enable its recommended typescript rules
50
- ...reactX.configs["recommended-typescript"].rules,
51
- ...reactDom.configs.recommended.rules,
52
- },
53
- })
54
- ```
1
+ # React + TypeScript + Vite
2
+
3
+ This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
4
+
5
+ Currently, two official plugins are available:
6
+
7
+ - [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
8
+ - [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
9
+
10
+ ## Expanding the ESLint configuration
11
+
12
+ If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
13
+
14
+ ```js
15
+ export default tseslint.config({
16
+ extends: [
17
+ // Remove ...tseslint.configs.recommended and replace with this
18
+ ...tseslint.configs.recommendedTypeChecked,
19
+ // Alternatively, use this for stricter rules
20
+ ...tseslint.configs.strictTypeChecked,
21
+ // Optionally, add this for stylistic rules
22
+ ...tseslint.configs.stylisticTypeChecked,
23
+ ],
24
+ languageOptions: {
25
+ // other options...
26
+ parserOptions: {
27
+ project: ["./tsconfig.node.json", "./tsconfig.app.json"],
28
+ tsconfigRootDir: import.meta.dirname,
29
+ },
30
+ },
31
+ })
32
+ ```
33
+
34
+ You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
35
+
36
+ ```js
37
+ // eslint.config.js
38
+ import reactX from "eslint-plugin-react-x"
39
+ import reactDom from "eslint-plugin-react-dom"
40
+
41
+ export default tseslint.config({
42
+ plugins: {
43
+ // Add the react-x and react-dom plugins
44
+ "react-x": reactX,
45
+ "react-dom": reactDom,
46
+ },
47
+ rules: {
48
+ // other rules...
49
+ // Enable its recommended typescript rules
50
+ ...reactX.configs["recommended-typescript"].rules,
51
+ ...reactDom.configs.recommended.rules,
52
+ },
53
+ })
54
+ ```
@@ -1,11 +1,11 @@
1
- import js from "@eslint/js"
2
- import globals from "globals"
3
- import reactHooks from "eslint-plugin-react-hooks"
4
- import reactRefresh from "eslint-plugin-react-refresh"
5
- import tseslint from "typescript-eslint"
1
+ import js from "@eslint/js";
2
+ import globals from "globals";
3
+ import reactHooks from "eslint-plugin-react-hooks";
4
+ import reactRefresh from "eslint-plugin-react-refresh";
5
+ import tseslint from "typescript-eslint";
6
6
 
7
7
  export default tseslint.config(
8
- { ignores: ["dist"] },
8
+ { ignores: ["dist", "src/utils/templates", "templates"] },
9
9
  {
10
10
  extends: [js.configs.recommended, ...tseslint.configs.recommended],
11
11
  files: ["**/*.{ts,tsx}"],
@@ -25,4 +25,4 @@ export default tseslint.config(
25
25
  ],
26
26
  },
27
27
  }
28
- )
28
+ );