@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,236 +1,236 @@
1
- import * as fs from "fs"
2
- import * as p from "path"
3
- import * as shell from "shelljs"
4
- import { cli } from "cli-ux"
5
- import * as targz from "targz"
6
- import Console from "../utils/console"
7
- import * as https from "https"
8
- import { InternalError } from "../utils/errors"
9
-
10
- // eslint-disable-next-line
11
- const fetch = require("node-fetch")
12
-
13
- export const decompress = (sourcePath: string, destinationPath: string) =>
14
- new Promise((resolve, reject) => {
15
- Console.debug("Decompressing " + sourcePath)
16
- targz.decompress(
17
- {
18
- src: sourcePath,
19
- dest: destinationPath,
20
- },
21
- function (err: string | Error | null) {
22
- if (err) {
23
- Console.error("Error when trying to decompress")
24
- reject(err)
25
- } else {
26
- Console.info("Decompression finished successfully")
27
- resolve(/* */ "")
28
- }
29
- }
30
- )
31
- })
32
-
33
- export const downloadEditor = async (
34
- version: string | undefined,
35
- destination: string
36
- ) => {
37
- Console.info("Downloading the LearnPack coding UI, this may take a minute...")
38
-
39
- if (!version) {
40
- const res = await fetch(
41
- "https://raw.githubusercontent.com/learnpack/ide/master/package.json"
42
- )
43
- const json = await res.json()
44
- version = json.version || "4.0.0"
45
-
46
- if (!version)
47
- throw InternalError(
48
- `Coding Editor version was not found on learnpack repository, check the config.editor.version property on learn.json`
49
- )
50
- }
51
-
52
- const [major, minor] = version.split(".")
53
- const versionPrefix = `${major}.${minor}`
54
-
55
- let tags
56
- try {
57
- const tagsRes = await fetch(
58
- "https://raw.githubusercontent.com/learnpack/ide/master/versions.json"
59
- )
60
- tags = await tagsRes.json()
61
-
62
- if (!Array.isArray(tags)) {
63
- throw new TypeError(`Invalid versions.json format`)
64
- }
65
- } catch (error) {
66
- Console.debug(
67
- "Error reading versions.json, defaulting to version 4.0.2",
68
- error
69
- )
70
- version = "4.0.2"
71
- tags = [`learnpack-${version}.tar.gz`]
72
- }
73
-
74
- let matchingTags
75
- try {
76
- if (tags.length === 0 || !tags)
77
- throw InternalError(`No found tags in versions.json ${tags}`)
78
-
79
- matchingTags = tags
80
- .filter(tag => tag.includes(`learnpack-${versionPrefix}`))
81
- .sort((a, b) => b.localeCompare(a, undefined, { numeric: true }))
82
-
83
- if (matchingTags.length === 0)
84
- throw InternalError(
85
- `No matching version found for prefix ${versionPrefix} in the versions.json`
86
- )
87
- } catch (error) {
88
- Console.debug("Error processing tags, defaulting to version 4.0.2", error)
89
- version = "4.0.2"
90
- matchingTags = [`learnpack-${version}.tar.gz`]
91
- }
92
-
93
- const latestVersion = matchingTags[0]
94
- .replace("learnpack-", "")
95
- .replace(".tar.gz", "")
96
-
97
- const versionNumber = parseInt(latestVersion.split(".")[0])
98
-
99
- let url = `https://github.com/learnpack/coding-ide/blob/${latestVersion}/dist`
100
-
101
- if (versionNumber > 2)
102
- url = `https://github.com/learnpack/ide/blob/master/bin/learnpack-${latestVersion}.tar.gz`
103
-
104
- const resp2 = await fetch(url, { method: "HEAD" })
105
- if (!resp2.ok)
106
- throw InternalError(
107
- `Coding Editor ${latestVersion} was not found on learnpack repository, check the config.editor.version property on learn.json`
108
- )
109
-
110
- url += versionNumber > 2 ? `?raw=true` : `/app.tar.gz?raw=true`
111
-
112
- return download(url, destination)
113
- }
114
-
115
- export const download = (url: string, dest: string) => {
116
- Console.debug("Downloading " + url)
117
- return new Promise((resolve, reject) => {
118
- const request = https.get(url, response => {
119
- if (response.statusCode === 200) {
120
- const file = fs.createWriteStream(dest, { flags: "wx" })
121
- file.on("finish", () => {
122
- resolve(true)
123
- })
124
- file.on("error", err => {
125
- file.close()
126
- if (err.name === "EEXIST") {
127
- Console.debug("File already exists")
128
- resolve("File already exists")
129
- } else {
130
- Console.debug("Error ", err.message)
131
- fs.unlink(dest, () => reject(err.message)) // Delete temp file
132
- }
133
- })
134
- response.pipe(file)
135
- } else if (response.statusCode === 302 || response.statusCode === 301) {
136
- // Console.debug("Servers redirected to "+response.headers.location)
137
- // Recursively follow redirects, only a 200 will resolve.
138
- if (response.headers.location) {
139
- download(response.headers.location, dest)
140
- .then(() => resolve(/* */ ""))
141
- .catch(error => {
142
- Console.error(error)
143
- reject(error)
144
- })
145
- }
146
- } else {
147
- Console.debug(
148
- `Server responded with ${response.statusCode}: ${response.statusMessage}`
149
- )
150
- reject(
151
- `Server responded with ${response.statusCode}: ${response.statusMessage}`
152
- )
153
- }
154
- })
155
-
156
- request.on("error", err => {
157
- reject(err.message)
158
- })
159
- })
160
- }
161
-
162
- export const clone = (repository = "", folder = "./") =>
163
- new Promise((resolve, reject) => {
164
- if (!repository) {
165
- reject("Missing repository url for this package")
166
- // return false
167
- }
168
-
169
- cli.action.start("Verifying GIT...")
170
- if (!shell.which("git")) {
171
- reject("Sorry, this script requires git")
172
- // return false
173
- }
174
-
175
- cli.action.stop()
176
-
177
- let fileName = p.basename(repository)
178
- if (!fileName) {
179
- reject("Invalid repository information on package: " + repository)
180
- // return false
181
- }
182
-
183
- fileName = fileName.split(".")[0]
184
- if (fs.existsSync("./" + fileName)) {
185
- reject(
186
- `Directory ${fileName} already exists; Did you download this package already?`
187
- )
188
- // return false
189
- }
190
-
191
- cli.action.start(`Cloning repository ${repository}...`)
192
- if (shell.exec(`git clone ${repository}`).code !== 0) {
193
- reject("Error: Installation failed")
194
- }
195
-
196
- cli.action.stop()
197
-
198
- cli.action.start("Cleaning installation...")
199
- if (shell.exec(`rm -R -f ${folder}${fileName}/.git`).code !== 0) {
200
- reject("Error: removing .git directory")
201
- }
202
-
203
- cli.action.stop()
204
-
205
- resolve("Done")
206
- })
207
-
208
- export const rmSync = function (path: string) {
209
- let files = []
210
- if (fs.existsSync(path)) {
211
- files = fs.readdirSync(path)
212
- for (const [, file] of files.entries()) {
213
- const curPath = path + "/" + file
214
- if (fs.lstatSync(curPath).isDirectory()) {
215
- // recurse
216
- rmSync(curPath)
217
- } else {
218
- // delete file
219
- fs.unlinkSync(curPath)
220
- }
221
- }
222
-
223
- fs.rmdirSync(path)
224
- }
225
- }
226
-
227
- export const checkIfDirectoryExists = (path: string) => {
228
- const fs = require("fs")
229
- if (fs.existsSync(path)) {
230
- return true
231
- }
232
-
233
- return false
234
- }
235
-
236
- export default { download, decompress, downloadEditor, clone, rmSync }
1
+ import * as fs from "fs"
2
+ import * as p from "path"
3
+ import * as shell from "shelljs"
4
+ import { cli } from "cli-ux"
5
+ import * as targz from "targz"
6
+ import Console from "../utils/console"
7
+ import * as https from "https"
8
+ import { InternalError } from "../utils/errors"
9
+
10
+ // eslint-disable-next-line
11
+ const fetch = require("node-fetch")
12
+
13
+ export const decompress = (sourcePath: string, destinationPath: string) =>
14
+ new Promise((resolve, reject) => {
15
+ Console.debug("Decompressing " + sourcePath)
16
+ targz.decompress(
17
+ {
18
+ src: sourcePath,
19
+ dest: destinationPath,
20
+ },
21
+ function (err: string | Error | null) {
22
+ if (err) {
23
+ Console.error("Error when trying to decompress")
24
+ reject(err)
25
+ } else {
26
+ Console.info("Decompression finished successfully")
27
+ resolve(/* */ "")
28
+ }
29
+ }
30
+ )
31
+ })
32
+
33
+ export const downloadEditor = async (
34
+ version: string | undefined,
35
+ destination: string
36
+ ) => {
37
+ Console.info("Downloading the LearnPack coding UI, this may take a minute...")
38
+
39
+ if (!version) {
40
+ const res = await fetch(
41
+ "https://raw.githubusercontent.com/learnpack/ide/master/package.json"
42
+ )
43
+ const json = await res.json()
44
+ version = json.version || "4.0.0"
45
+
46
+ if (!version)
47
+ throw InternalError(
48
+ `Coding Editor version was not found on learnpack repository, check the config.editor.version property on learn.json`
49
+ )
50
+ }
51
+
52
+ const [major, minor] = version.split(".")
53
+ const versionPrefix = `${major}.${minor}`
54
+
55
+ let tags
56
+ try {
57
+ const tagsRes = await fetch(
58
+ "https://raw.githubusercontent.com/learnpack/ide/master/versions.json"
59
+ )
60
+ tags = await tagsRes.json()
61
+
62
+ if (!Array.isArray(tags)) {
63
+ throw new TypeError(`Invalid versions.json format`)
64
+ }
65
+ } catch (error) {
66
+ Console.debug(
67
+ "Error reading versions.json, defaulting to version 4.0.2",
68
+ error
69
+ )
70
+ version = "4.0.2"
71
+ tags = [`learnpack-${version}.tar.gz`]
72
+ }
73
+
74
+ let matchingTags
75
+ try {
76
+ if (tags.length === 0 || !tags)
77
+ throw InternalError(`No found tags in versions.json ${tags}`)
78
+
79
+ matchingTags = tags
80
+ .filter(tag => tag.includes(`learnpack-${versionPrefix}`))
81
+ .sort((a, b) => b.localeCompare(a, undefined, { numeric: true }))
82
+
83
+ if (matchingTags.length === 0)
84
+ throw InternalError(
85
+ `No matching version found for prefix ${versionPrefix} in the versions.json`
86
+ )
87
+ } catch (error) {
88
+ Console.debug("Error processing tags, defaulting to version 4.0.2", error)
89
+ version = "4.0.2"
90
+ matchingTags = [`learnpack-${version}.tar.gz`]
91
+ }
92
+
93
+ const latestVersion = matchingTags[0]
94
+ .replace("learnpack-", "")
95
+ .replace(".tar.gz", "")
96
+
97
+ const versionNumber = parseInt(latestVersion.split(".")[0])
98
+
99
+ let url = `https://github.com/learnpack/coding-ide/blob/${latestVersion}/dist`
100
+
101
+ if (versionNumber > 2)
102
+ url = `https://github.com/learnpack/ide/blob/master/bin/learnpack-${latestVersion}.tar.gz`
103
+
104
+ const resp2 = await fetch(url, { method: "HEAD" })
105
+ if (!resp2.ok)
106
+ throw InternalError(
107
+ `Coding Editor ${latestVersion} was not found on learnpack repository, check the config.editor.version property on learn.json`
108
+ )
109
+
110
+ url += versionNumber > 2 ? `?raw=true` : `/app.tar.gz?raw=true`
111
+
112
+ return download(url, destination)
113
+ }
114
+
115
+ export const download = (url: string, dest: string) => {
116
+ Console.debug("Downloading " + url)
117
+ return new Promise((resolve, reject) => {
118
+ const request = https.get(url, response => {
119
+ if (response.statusCode === 200) {
120
+ const file = fs.createWriteStream(dest, { flags: "wx" })
121
+ file.on("finish", () => {
122
+ resolve(true)
123
+ })
124
+ file.on("error", err => {
125
+ file.close()
126
+ if (err.name === "EEXIST") {
127
+ Console.debug("File already exists")
128
+ resolve("File already exists")
129
+ } else {
130
+ Console.debug("Error ", err.message)
131
+ fs.unlink(dest, () => reject(err.message)) // Delete temp file
132
+ }
133
+ })
134
+ response.pipe(file)
135
+ } else if (response.statusCode === 302 || response.statusCode === 301) {
136
+ // Console.debug("Servers redirected to "+response.headers.location)
137
+ // Recursively follow redirects, only a 200 will resolve.
138
+ if (response.headers.location) {
139
+ download(response.headers.location, dest)
140
+ .then(() => resolve(/* */ ""))
141
+ .catch(error => {
142
+ Console.error(error)
143
+ reject(error)
144
+ })
145
+ }
146
+ } else {
147
+ Console.debug(
148
+ `Server responded with ${response.statusCode}: ${response.statusMessage}`
149
+ )
150
+ reject(
151
+ `Server responded with ${response.statusCode}: ${response.statusMessage}`
152
+ )
153
+ }
154
+ })
155
+
156
+ request.on("error", err => {
157
+ reject(err.message)
158
+ })
159
+ })
160
+ }
161
+
162
+ export const clone = (repository = "", folder = "./") =>
163
+ new Promise((resolve, reject) => {
164
+ if (!repository) {
165
+ reject("Missing repository url for this package")
166
+ // return false
167
+ }
168
+
169
+ cli.action.start("Verifying GIT...")
170
+ if (!shell.which("git")) {
171
+ reject("Sorry, this script requires git")
172
+ // return false
173
+ }
174
+
175
+ cli.action.stop()
176
+
177
+ let fileName = p.basename(repository)
178
+ if (!fileName) {
179
+ reject("Invalid repository information on package: " + repository)
180
+ // return false
181
+ }
182
+
183
+ fileName = fileName.split(".")[0]
184
+ if (fs.existsSync("./" + fileName)) {
185
+ reject(
186
+ `Directory ${fileName} already exists; Did you download this package already?`
187
+ )
188
+ // return false
189
+ }
190
+
191
+ cli.action.start(`Cloning repository ${repository}...`)
192
+ if (shell.exec(`git clone ${repository}`).code !== 0) {
193
+ reject("Error: Installation failed")
194
+ }
195
+
196
+ cli.action.stop()
197
+
198
+ cli.action.start("Cleaning installation...")
199
+ if (shell.exec(`rm -R -f ${folder}${fileName}/.git`).code !== 0) {
200
+ reject("Error: removing .git directory")
201
+ }
202
+
203
+ cli.action.stop()
204
+
205
+ resolve("Done")
206
+ })
207
+
208
+ export const rmSync = function (path: string) {
209
+ let files = []
210
+ if (fs.existsSync(path)) {
211
+ files = fs.readdirSync(path)
212
+ for (const [, file] of files.entries()) {
213
+ const curPath = path + "/" + file
214
+ if (fs.lstatSync(curPath).isDirectory()) {
215
+ // recurse
216
+ rmSync(curPath)
217
+ } else {
218
+ // delete file
219
+ fs.unlinkSync(curPath)
220
+ }
221
+ }
222
+
223
+ fs.rmdirSync(path)
224
+ }
225
+ }
226
+
227
+ export const checkIfDirectoryExists = (path: string) => {
228
+ const fs = require("fs")
229
+ if (fs.existsSync(path)) {
230
+ return true
231
+ }
232
+
233
+ return false
234
+ }
235
+
236
+ export default { download, decompress, downloadEditor, clone, rmSync }