Merge branch 'master' into 15954_archive

.gitignore

@@ -104,6 +104,5 @@ dist
 .tern-port
 
 /lib
-examples
 
 *.iml

README.md

@@ -7,6 +7,14 @@ codio.v1.setDomain('codio.com') // codio.co.uk for UK domain, codio.com is defau
 
 Follow https://docs.codio.com/develop/develop/ide/tools/ghapi.html#api-integration-information to generate
 API keys.
+## Requirements
+- Nodejs
+- zstd
+
+## How to build
+- Run `yarn`
+- Run `yarn build`
+
 
 ## Authentication
 ```

examples/assessment/find.js

@@ -0,0 +1,12 @@
+const { codio, auth } = require('../auth.js')
+const { libraryId, libraryName } = require('../data.js')
+
+async function main() {
+    await auth    
+    const search = {"Assessment Type": "Advanced Code Test"}
+    const result = await codio.assessment.find(libraryId, search)
+    console.log(result)
+
+}
+
+main()

examples/assessment/fromCodioProject.js

@@ -0,0 +1,14 @@
+const { codio, auth } = require('../auth.js')
+const { libraryId, libraryName, projectPath } = require('../data.js')
+
+async function main() {
+
+    await auth
+
+    const result  = await codio.assessment.fromCodioProject(libraryId, projectPath)
+    // const result  = await codio.assessment.fromCodioProject(libraryName, projectPath)
+    console.log(result)
+
+}
+
+main()

examples/assessment/listLibraries.js

@@ -0,0 +1,10 @@
+const { codio, auth } = require('../auth.js')
+
+async function main() {
+    await auth    
+    const result = await codio.assessment.listLibraries()
+    console.log(result)
+
+}
+
+main()

examples/assignment/getSettings.js

@@ -0,0 +1,11 @@
+const { codio, auth } = require('../auth.js')
+const { assignmentId, courseId } = require('../data.js')
+
+async function main() {
+    await auth
+
+    const result = await codio.assignment.getSettings(courseId, assignmentId)
+    console.log(result)
+}
+
+main()

examples/assignment/publish.js

@@ -0,0 +1,14 @@
+const { codio, auth } = require('../auth.js')
+const { assignmentId, courseId, projectPath, stackVersionId } = require('../data.js')
+
+async function main() {
+    await auth
+
+    changelog = 'test'
+    data = {changelog: changelog, stack: `${stackVersionId}:latest`, withStackUpdate: true}
+
+    const result = await codio.assignment.publish(courseId, assignmentId, projectPath, data)
+
+}
+
+main()

examples/assignment/publishArchive.js

@@ -0,0 +1,13 @@
+const { codio, auth } = require('../auth.js')
+const { assignmentId, courseId, stackVersionId, archivePath } = require('../data.js')
+
+async function main() {
+    await auth         
+
+    changelog = 'changelog value'
+    data = {changelog: changelog, stack: `${stackVersionId}:latest`, withStackUpdate: true}
+
+    const result = await codio.assignment.publishArchive(courseId, assignmentId, archivePath, data)
+}
+
+main()

examples/assignment/reducePublish.js

@@ -0,0 +1,14 @@
+const { codio, auth } = require('../auth.js')
+const { assignmentId, courseId, stackVersionId, projectPath, yamlMapDir } = require('../data.js')
+
+async function main() {
+    await auth    
+
+    changelog = 'changelog value'
+    data = {changelog: changelog, stack: `${stackVersionId}:latest`, withStackUpdate: true}
+
+    const result = await codio.assignment.reducePublish(courseId, projectPath, yamlMapDir, data)
+
+}
+
+main()

examples/assignment/updateSettings.js

@@ -0,0 +1,29 @@
+const { codio, auth } = require('../auth.js')
+const { assignmentId, courseId } = require('../data.js')
+
+async function main() {
+    await auth
+
+    const result = await codio.assignment.updateSettings(courseId, assignmentId, {
+    enableResetAssignmentByStudent: true,
+    disableDownloadByStudent: true,
+    // visibilityOnDisabled: 'NO_ACCESS',
+    visibilityOnDisabled: 'READ_ONLY',
+    // visibilityOnCompleted: 'NO_ACCESS',
+    // visibilityOnCompleted: 'READ_ONLY',
+    visibilityOnCompleted: 'READ_ONLY_RESUBMIT',
+    // startTime: null,
+    startTime: new Date('2024-05-01T13:59:59+01:00'),
+    // endTime: null,
+    // endTime: new Date('2022-05-20T13:59:59+01:00'),
+    endTime: new Date('2025-07-31T13:59:59Z'),
+    // action: 'DISABLE',
+    // action: 'COMPLETE',
+    action: 'DISABLE_AND_COMPLETE'
+
+  })
+    console.log(result)
+
+}
+
+main()

examples/assignment/updateStudentTimeExtension.js

@@ -0,0 +1,15 @@
+const { codio, auth } = require('../auth.js')
+const { assignmentId, courseId, studentId } = require('../data.js')
+
+async function main() {
+    await auth
+
+    const result = await codio.assignment.updateStudentTimeExtension(courseId, assignmentId, studentId, {
+        extendedDeadline: 55,
+        extendedTimeLimit: '22'
+    })
+    console.log(result)
+
+}
+
+main()

examples/auth.js

@@ -0,0 +1,7 @@
+const library = require('../lib')
+const codio = library.default.v1
+
+codio.setDomain('codio.com') // codio.co.uk for UK domain
+const auth = codio.auth(`your client_id`, `your client_secret`)
+
+module.exports = { codio, auth }

examples/course/assignmentStudentsProgress.js

@@ -0,0 +1,12 @@
+const { codio, auth } = require('../auth.js')
+const { assignmentId, courseId } = require('../data.js')
+
+async function main() {
+    await auth
+
+    const result = await codio.course.assignmentStudentsProgress(courseId, assignmentId)
+    console.log(result)
+
+}
+
+main()

examples/course/createSourceExport.js

@@ -0,0 +1,11 @@
+const { codio, auth } = require('../auth.js')
+const { courseId } = require('../data.js')
+
+async function main() {
+    await auth
+
+    const result = await codio.course.createSourceExport(courseId)
+    console.log(result)
+}
+
+main()

examples/course/createWorkExport.js

@@ -0,0 +1,11 @@
+const { codio, auth } = require('../auth.js')
+const { courseId } = require('../data.js')
+
+async function main() {
+    await auth
+
+    const result = await codio.course.createWorkExport(courseId)
+    console.log(result)
+}
+
+main()

examples/course/downloadAssessmentData.js

@@ -0,0 +1,12 @@
+const { codio, auth } = require('../auth.js')
+const { assignmentId, courseId } = require('../data.js')
+
+async function main() {
+    await auth
+    const filePath = '/home/codio/workspace/assessmentData.csv'
+
+    const result = await codio.course.downloadAssessmentData(courseId, assignmentId, filePath)
+
+}
+
+main()

examples/course/downloadAssignmentCSV.js

@@ -0,0 +1,12 @@
+const { codio, auth } = require('../auth.js')
+const { assignmentId, courseId } = require('../data.js')
+
+async function main() {
+    await auth
+    const filePath = '/home/codio/workspace/assignment.csv'
+
+    const result = await codio.course.downloadAssignmentCSV(courseId, assignmentId, filePath)
+
+}
+
+main()

examples/course/downloadSourceExport.js

@@ -0,0 +1,12 @@
+const { codio, auth } = require('../auth.js')
+const { courseId } = require('../data.js')
+
+async function main() {
+    await auth
+    const filePath = '/home/codio/workspace/export_source.zip'
+
+    const result = await codio.course.downloadSourceExport(courseId, filePath)
+
+}
+
+main()

examples/course/downloadStudentAssignment.js

@@ -0,0 +1,12 @@
+const { codio, auth } = require('../auth.js')
+const { assignmentId, courseId, studentId } = require('../data.js')
+
+async function main() {
+    await auth
+    const filePath = '/home/codio/workspace/file.csv'
+
+    const result = await codio.course.downloadStudentAssignment(courseId, assignmentId, studentId, filePath)
+
+}
+
+main()

examples/course/downloadStudentCSV.js

@@ -0,0 +1,12 @@
+const { codio, auth } = require('../auth.js')
+const { courseId, studentId } = require('../data.js')
+
+async function main() {
+    await auth
+    const filePath = '/home/codio/workspace/student.csv'
+
+    const result = await codio.course.downloadStudentCSV(courseId, studentId, filePath)
+
+}
+
+main()

examples/course/downloadWorkExport.js

@@ -0,0 +1,12 @@
+const { codio, auth } = require('../auth.js')
+const { assignmentId, courseId, studentId } = require('../data.js')
+
+async function main() {
+    await auth
+    const filePath = '/home/codio/workspace/export_work.zip'
+
+    const result = await codio.course.downloadWorkExport(courseId, filePath)
+
+}
+
+main()

examples/course/exportAssessmentData.js

@@ -0,0 +1,11 @@
+const { codio, auth } = require('../auth.js')
+const { assignmentId, courseId } = require('../data.js')
+
+async function main() {
+    await auth
+
+    const result = await codio.course.exportAssessmentData(courseId, assignmentId)
+    console.log(result)
+}
+
+main()

examples/course/exportAssignmentCSV.js

@@ -0,0 +1,11 @@
+const { codio, auth } = require('../auth.js')
+const { assignmentId, courseId } = require('../data.js')
+
+async function main() {
+    await auth
+
+    const result = await codio.course.exportAssignmentCSV(courseId, assignmentId)
+    console.log(result)
+}
+
+main()

examples/course/exportStudentAssignment.js

@@ -0,0 +1,11 @@
+const { codio, auth } = require('../auth.js')
+const { assignmentId, courseId, studentId } = require('../data.js')
+
+async function main() {
+    await auth
+
+    const result = await codio.course.exportStudentAssignment(courseId, assignmentId, studentId)
+    console.log(result)
+}
+
+main()

examples/course/exportStudentCSV.js

@@ -0,0 +1,11 @@
+const { codio, auth } = require('../auth.js')
+const { courseId, studentId } = require('../data.js')
+
+async function main() {
+    await auth
+
+    const result = await codio.course.exportStudentCSV(courseId, studentId)
+    console.log(result)
+}
+
+main()

examples/course/findByName.js

@@ -0,0 +1,12 @@
+const { codio, auth } = require('../auth.js')
+const { courseName} = require('../data.js')
+
+async function main() {
+    await auth
+
+    const result = await codio.course.findByName(courseName, true)
+    console.log(result)
+
+}
+
+main()

examples/course/getSourceExportProgress.js

@@ -0,0 +1,12 @@
+const { codio, auth } = require('../auth.js')
+const { courseId } = require('../data.js')
+
+async function main() {
+    await auth
+    const taskId = 'your task id'
+
+    const result = await codio.course.getSourceExportProgress(courseId, taskId)
+    console.log(result)
+}
+
+main()

examples/course/getSourceExports.js

@@ -0,0 +1,11 @@
+const { codio, auth } = require('../auth.js')
+const { courseId } = require('../data.js')
+
+async function main() {
+    await auth
+
+    const result = await codio.course.getSourceExports(courseId)
+    console.log(result)
+}
+
+main()

examples/course/getStudents.js

@@ -0,0 +1,12 @@
+const { codio, auth } = require('../auth.js')
+const { courseId } = require('../data.js')
+
+async function main() {
+    await auth
+
+    const result = await codio.course.getStudents(courseId)
+    console.log(result)
+
+}
+
+main()

examples/course/getTeachers.js

@@ -0,0 +1,12 @@
+const { codio, auth } = require('../auth.js')
+const { courseId } = require('../data.js')
+
+async function main() {
+    await auth
+
+    const result = await codio.course.getTeachers(courseId)
+    console.log(result)
+
+}
+
+main()