@learnpack/learnpack 5.0.275 → 5.0.277

package/src/managers/telemetry.ts

@@ -1,188 +1,188 @@
-import { IFile } from "../models/file"
-import { ISocket } from "../models/socket"
-const packageInfo = require("../../package.json")
-import Console from "../utils/console"
-
-const fs = require("fs")
-
-function createUUID(): string {
-  return (
-    Math.random().toString(36).slice(2, 10) +
-    Math.random().toString(36).slice(2, 10)
-  )
-}
-
-function stringToBase64(input: string): string {
-  return Buffer.from(input).toString("base64")
-}
-
-type TCompilationAttempt = {
-  source_code: string
-  stdout: string
-  exit_code: number
-  starting_at: number
-  ending_at: number
-}
-
-type TTestAttempt = {
-  source_code: string
-  stdout: string
-  exit_code: number
-  starting_at: number
-  ending_at: number
-}
-
-type TAIInteraction = {
-  student_message: string
-  source_code: string
-  ai_response: string
-  starting_at: number
-  ending_at: number
-}
-
-type TQuizSelection = {
-  question: string
-  answer: string
-  isCorrect: boolean
-}
-
-type TQuizSubmission = {
-  quiz_hash: string
-  selections: TQuizSelection[]
-  submitted_at: number
-}
-
-export type TStep = {
-  slug: string
-  position: number
-  files: IFile[]
-  is_testeable: boolean
-  opened_at?: number // The time when the step was opened
-  completed_at?: number // If the step has tests, the time when all the tests passed, else, the time when the user opens the next step
-  compilations: TCompilationAttempt[] // Everytime the user tries to compile the code
-  tests: TTestAttempt[] // Everytime the user tries to run the tests
-  ai_interactions: TAIInteraction[] // Everytime the user interacts with the AI
-  quiz_submissions: TQuizSubmission[] // Everytime the user submits a quiz
-}
-
-type TWorkoutSession = {
-  started_at: number
-  ended_at?: number
-}
-
-type TStudent = {
-  token: string
-  user_id: string
-  email: string
-}
-
-export interface ITelemetryJSONSchema {
-  telemetry_id?: string
-  version: string
-  user_id?: number | string
-  slug: string
-  agent?: string
-  tutorial_started_at: number
-  last_interaction_at: number
-  steps: Array<TStep> // The steps should be the same as the exercise
-  workout_session: TWorkoutSession[] // It start when the user starts Learnpack, if the last_interaction_at is available, it automatically fills with that
-  // number and start another session
-}
-
-export type TStepEvent =
-  | "compile"
-  | "test"
-  | "ai_interaction"
-  | "open_step"
-  | "quiz_submission"
-
-export type TTelemetryUrls = {
-  streaming?: string
-  batch?: string
-}
-
-type TUser = {
-  token: string
-  id: string
-  email: string
-}
-
-interface ITelemetryManagerCLI {
-  configPath: string | null
-  socket: ISocket | null
-  version: string
-  start: (path: string, socket: ISocket) => void
-  registerStepEvent: (
-    stepPosition: number,
-    event: TStepEvent,
-    data: any
-  ) => void
-  save: (telemetry: ITelemetryJSONSchema) => void
-  retrieve: () => Promise<ITelemetryJSONSchema | null>
-}
-
-const TelemetryManager: ITelemetryManagerCLI = {
-  version: packageInfo.version,
-  socket: null,
-
-  configPath: "",
-
-  start: function (path, socket) {
-    this.configPath = path
-    this.socket = socket
-  },
-
-  registerStepEvent: function (stepPosition, event, data) {
-    Console.debug(`Registering Telemetry Event ${event}`)
-
-    this.socket?.emit(
-      "telemetry_event",
-      "ready",
-      [`Registering telemetry event ${event}`],
-      [],
-      [],
-      {
-        stepPosition,
-        event,
-        data,
-      }
-    )
-  },
-  retrieve: function () {
-    return new Promise((resolve, reject) => {
-      fs.readFile(
-        `${this.configPath}/telemetry.json`,
-        "utf8",
-        (err: any, data: any) => {
-          if (err) {
-            if (err.code === "ENOENT") {
-              // File does not exist, resolve with undefined
-              resolve(null)
-            } else {
-              reject(err)
-            }
-          } else {
-            try {
-              resolve(JSON.parse(data))
-            } catch {
-              resolve(null)
-            }
-          }
-        }
-      )
-    })
-  },
-
-  save: function (telemetry: ITelemetryJSONSchema) {
-    fs.writeFile(
-      `${this.configPath}/telemetry.json`,
-      JSON.stringify(telemetry),
-      (err: any) => {
-        if (err) 
-throw err
-      }
-    )
-  },
-}
-
-export default TelemetryManager
+import { IFile } from "../models/file"
+import { ISocket } from "../models/socket"
+const packageInfo = require("../../package.json")
+import Console from "../utils/console"
+
+const fs = require("fs")
+
+function createUUID(): string {
+  return (
+    Math.random().toString(36).slice(2, 10) +
+    Math.random().toString(36).slice(2, 10)
+  )
+}
+
+function stringToBase64(input: string): string {
+  return Buffer.from(input).toString("base64")
+}
+
+type TCompilationAttempt = {
+  source_code: string
+  stdout: string
+  exit_code: number
+  starting_at: number
+  ending_at: number
+}
+
+type TTestAttempt = {
+  source_code: string
+  stdout: string
+  exit_code: number
+  starting_at: number
+  ending_at: number
+}
+
+type TAIInteraction = {
+  student_message: string
+  source_code: string
+  ai_response: string
+  starting_at: number
+  ending_at: number
+}
+
+type TQuizSelection = {
+  question: string
+  answer: string
+  isCorrect: boolean
+}
+
+type TQuizSubmission = {
+  quiz_hash: string
+  selections: TQuizSelection[]
+  submitted_at: number
+}
+
+export type TStep = {
+  slug: string
+  position: number
+  files: IFile[]
+  is_testeable: boolean
+  opened_at?: number // The time when the step was opened
+  completed_at?: number // If the step has tests, the time when all the tests passed, else, the time when the user opens the next step
+  compilations: TCompilationAttempt[] // Everytime the user tries to compile the code
+  tests: TTestAttempt[] // Everytime the user tries to run the tests
+  ai_interactions: TAIInteraction[] // Everytime the user interacts with the AI
+  quiz_submissions: TQuizSubmission[] // Everytime the user submits a quiz
+}
+
+type TWorkoutSession = {
+  started_at: number
+  ended_at?: number
+}
+
+type TStudent = {
+  token: string
+  user_id: string
+  email: string
+}
+
+export interface ITelemetryJSONSchema {
+  telemetry_id?: string
+  version: string
+  user_id?: number | string
+  slug: string
+  agent?: string
+  tutorial_started_at: number
+  last_interaction_at: number
+  steps: Array<TStep> // The steps should be the same as the exercise
+  workout_session: TWorkoutSession[] // It start when the user starts Learnpack, if the last_interaction_at is available, it automatically fills with that
+  // number and start another session
+}
+
+export type TStepEvent =
+  | "compile"
+  | "test"
+  | "ai_interaction"
+  | "open_step"
+  | "quiz_submission"
+
+export type TTelemetryUrls = {
+  streaming?: string
+  batch?: string
+}
+
+type TUser = {
+  token: string
+  id: string
+  email: string
+}
+
+interface ITelemetryManagerCLI {
+  configPath: string | null
+  socket: ISocket | null
+  version: string
+  start: (path: string, socket: ISocket) => void
+  registerStepEvent: (
+    stepPosition: number,
+    event: TStepEvent,
+    data: any
+  ) => void
+  save: (telemetry: ITelemetryJSONSchema) => void
+  retrieve: () => Promise<ITelemetryJSONSchema | null>
+}
+
+const TelemetryManager: ITelemetryManagerCLI = {
+  version: packageInfo.version,
+  socket: null,
+
+  configPath: "",
+
+  start: function (path, socket) {
+    this.configPath = path
+    this.socket = socket
+  },
+
+  registerStepEvent: function (stepPosition, event, data) {
+    Console.debug(`Registering Telemetry Event ${event}`)
+
+    this.socket?.emit(
+      "telemetry_event",
+      "ready",
+      [`Registering telemetry event ${event}`],
+      [],
+      [],
+      {
+        stepPosition,
+        event,
+        data,
+      }
+    )
+  },
+  retrieve: function () {
+    return new Promise((resolve, reject) => {
+      fs.readFile(
+        `${this.configPath}/telemetry.json`,
+        "utf8",
+        (err: any, data: any) => {
+          if (err) {
+            if (err.code === "ENOENT") {
+              // File does not exist, resolve with undefined
+              resolve(null)
+            } else {
+              reject(err)
+            }
+          } else {
+            try {
+              resolve(JSON.parse(data))
+            } catch {
+              resolve(null)
+            }
+          }
+        }
+      )
+    })
+  },
+
+  save: function (telemetry: ITelemetryJSONSchema) {
+    fs.writeFile(
+      `${this.configPath}/telemetry.json`,
+      JSON.stringify(telemetry),
+      (err: any) => {
+        if (err) 
+throw err
+      }
+    )
+  },
+}
+
+export default TelemetryManager

package/src/models/action.ts

@@ -1,13 +1,13 @@
-export type TAction =
-  | "test"
-  | "log"
-  | "reload"
-  | "ready"
-  | "clean"
-  | "ask"
-  | "file_change"
-  | "dialog"
-  | "session-refreshed"
-  | "telemetry_event"
-
-export type ICallback = (...agrs: any[]) => any
+export type TAction =
+  | "test"
+  | "log"
+  | "reload"
+  | "ready"
+  | "clean"
+  | "ask"
+  | "file_change"
+  | "dialog"
+  | "session-refreshed"
+  | "telemetry_event"
+
+export type ICallback = (...agrs: any[]) => any

package/src/models/config-manager.ts

@@ -1,28 +1,28 @@
-import { TSidebar } from "../utils/sidebarGenerator"
-import { IConfigObj, TGrading } from "./config"
-import { IExercise } from "./exercise-obj"
-
-export interface IConfigManagerAttributes {
-  grading: TGrading
-  disableGrading: boolean
-  version: string
-  mode?: string
-}
-
-export interface IConfigManager {
-  validLanguages?: any
-  get: () => IConfigObj
-  clean: () => void
-  getExercise: (slug: string | undefined) => IExercise
-  startExercise: (slug: string) => IExercise
-  reset: (slug: string) => void
-  createExercise: (slug: string, content: string, language: string) => boolean
-  deleteExercise: (slug: string) => boolean
-  buildIndex: () => boolean | void
-  watchIndex: (onChange: (...args: Array<any>) => void) => void
-  save: () => void
-  getSidebar: () => TSidebar
-  // checkAndFixSidebar: () => void
-  noCurrentExercise: () => void
-  getAllExercises: () => IExercise[]
-}
+import { TSidebar } from "../utils/sidebarGenerator"
+import { IConfigObj, TGrading } from "./config"
+import { IExercise } from "./exercise-obj"
+
+export interface IConfigManagerAttributes {
+  grading: TGrading
+  disableGrading: boolean
+  version: string
+  mode?: string
+}
+
+export interface IConfigManager {
+  validLanguages?: any
+  get: () => IConfigObj
+  clean: () => void
+  getExercise: (slug: string | undefined) => IExercise
+  startExercise: (slug: string) => IExercise
+  reset: (slug: string) => void
+  createExercise: (slug: string, content: string, language: string) => boolean
+  deleteExercise: (slug: string) => boolean
+  buildIndex: () => boolean | void
+  watchIndex: (onChange: (...args: Array<any>) => void) => void
+  save: () => void
+  getSidebar: () => TSidebar
+  // checkAndFixSidebar: () => void
+  noCurrentExercise: () => void
+  getAllExercises: () => IExercise[]
+}

package/src/models/config.ts

@@ -1,106 +1,106 @@
-import { IExercise } from "./exercise-obj"
-import { TTelemetryUrls } from "../managers/telemetry"
-
-export type TGrading = "isolated" | "incremental" | "no-grading"
-
-export type TMode = "preview" | "extension"
-
-export type TConfigAction = "test" | "build" | "tutorial" | "reset" | "generate"
-
-export type TConfigObjAttributes = "config" | "exercises" | "grading"
-
-export type TCompiler =
-  | "webpack"
-  | "vanillajs"
-  | "react"
-  | "html"
-  | "node"
-  | "python"
-  | "css"
-
-export interface IConfigPath {
-  base: string
-}
-
-export interface IEditor {
-  mode?: TMode
-  version?: string
-  agent?: TAgent
-  hideTerminal?: boolean
-}
-
-export interface TEntries {
-  python3?: string
-  html?: string
-  node?: string
-  react?: string
-  java?: string
-}
-
-export interface IConfig {
-  os: string
-  port?: string
-  repository?: string
-  description?: string
-  slug?: string
-  dirPath: string
-  preview?: string // Picture thumbnail
-  entries: TEntries
-  grading: TGrading
-  configPath: string
-  translations: Array<string>
-  outputPath?: string
-  editor: IEditor
-  language: string
-  title: string
-  duration: number
-  difficulty?: string
-  exercisesPath: string
-  disableGrading: boolean // TODO: Deprecate
-  actions: Array<string> // TODO: Deprecate
-  autoPlay: boolean
-  projectType?: string
-  // TODO: nameExerciseValidation
-  contact?: string
-  disabledActions?: Array<TConfigAction>
-  compiler: TCompiler
-  compilers: Array<TCompiler>
-  publicPath: string
-  publicUrl?: string
-  bugsLink?: string
-  videoSolutions?: boolean
-  skills: Array<string>
-  telemetry?: TTelemetryUrls
-  variables?: TVariables
-  suggestions: TSuggestions
-  warnings: TWarnings
-  runHook: (...agrs: Array<any>) => void
-  testingFinishedCallback: (arg: any | undefined) => void
-}
-export type TAgent = "os" | "vscode" | null
-
-export type TSuggestions = {
-  agent: TAgent
-}
-
-type TWarnings = {
-  agent?: string
-  extension?: string
-}
-
-type TVariable = {
-  type: "command" | "string"
-  source: string
-}
-type TVariables = {
-  [key: string]: TVariable | string
-}
-
-export interface IConfigObj {
-  session?: number
-  currentExercise?: any
-  config?: IConfig
-  exercises?: Array<IExercise>
-  confPath?: IConfigPath
-  address?: string // Maybe
-}
+import { IExercise } from "./exercise-obj"
+import { TTelemetryUrls } from "../managers/telemetry"
+
+export type TGrading = "isolated" | "incremental" | "no-grading"
+
+export type TMode = "preview" | "extension"
+
+export type TConfigAction = "test" | "build" | "tutorial" | "reset" | "generate"
+
+export type TConfigObjAttributes = "config" | "exercises" | "grading"
+
+export type TCompiler =
+  | "webpack"
+  | "vanillajs"
+  | "react"
+  | "html"
+  | "node"
+  | "python"
+  | "css"
+
+export interface IConfigPath {
+  base: string
+}
+
+export interface IEditor {
+  mode?: TMode
+  version?: string
+  agent?: TAgent
+  hideTerminal?: boolean
+}
+
+export interface TEntries {
+  python3?: string
+  html?: string
+  node?: string
+  react?: string
+  java?: string
+}
+
+export interface IConfig {
+  os: string
+  port?: string
+  repository?: string
+  description?: string
+  slug?: string
+  dirPath: string
+  preview?: string // Picture thumbnail
+  entries: TEntries
+  grading: TGrading
+  configPath: string
+  translations: Array<string>
+  outputPath?: string
+  editor: IEditor
+  language: string
+  title: string
+  duration: number
+  difficulty?: string
+  exercisesPath: string
+  disableGrading: boolean // TODO: Deprecate
+  actions: Array<string> // TODO: Deprecate
+  autoPlay: boolean
+  projectType?: string
+  // TODO: nameExerciseValidation
+  contact?: string
+  disabledActions?: Array<TConfigAction>
+  compiler: TCompiler
+  compilers: Array<TCompiler>
+  publicPath: string
+  publicUrl?: string
+  bugsLink?: string
+  videoSolutions?: boolean
+  skills: Array<string>
+  telemetry?: TTelemetryUrls
+  variables?: TVariables
+  suggestions: TSuggestions
+  warnings: TWarnings
+  runHook: (...agrs: Array<any>) => void
+  testingFinishedCallback: (arg: any | undefined) => void
+}
+export type TAgent = "os" | "vscode" | null
+
+export type TSuggestions = {
+  agent: TAgent
+}
+
+type TWarnings = {
+  agent?: string
+  extension?: string
+}
+
+type TVariable = {
+  type: "command" | "string"
+  source: string
+}
+type TVariables = {
+  [key: string]: TVariable | string
+}
+
+export interface IConfigObj {
+  session?: number
+  currentExercise?: any
+  config?: IConfig
+  exercises?: Array<IExercise>
+  confPath?: IConfigPath
+  address?: string // Maybe
+}