dce-crosstypes 1.0.0

package/lib/Engagement/index.d.ts

@@ -0,0 +1,14 @@
+import ActivityEngagementData from './EngagementBundle/ActivityEngagementData';
+import ActivityEngagementDataType from './ActivityEngagementDataType';
+import ActivityId from './ActivityId';
+import AttendanceMethod from './AttendanceMethod';
+import AverageUserEngagement from './InferredEngagementSchedule/AverageUserEngagement';
+import EngagementBundle from './EngagementBundle';
+import EngagementPlatform from './EngagementBundle/EngagementPlatform';
+import EngagementSource from './EngagementBundle/EngagementSource';
+import InferredEngagementSchedule from './InferredEngagementSchedule';
+import ProgrammingLanguage from './ProgrammingLanguage';
+import ResponsePack from './ResponsePack';
+import ShareoutPostPollResult from './ShareoutPostPollResult';
+import UserEngagement from './EngagementBundle/UserEngagement';
+export { ActivityEngagementData, ActivityEngagementDataType, ActivityId, AttendanceMethod, AverageUserEngagement, EngagementBundle, EngagementPlatform, EngagementSource, InferredEngagementSchedule, ProgrammingLanguage, ResponsePack, ShareoutPostPollResult, UserEngagement, };

package/lib/Engagement/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProgrammingLanguage = exports.EngagementSource = exports.EngagementPlatform = exports.AttendanceMethod = exports.ActivityId = exports.ActivityEngagementDataType = void 0;
+const ActivityEngagementDataType_1 = __importDefault(require("./ActivityEngagementDataType"));
+exports.ActivityEngagementDataType = ActivityEngagementDataType_1.default;
+const ActivityId_1 = __importDefault(require("./ActivityId"));
+exports.ActivityId = ActivityId_1.default;
+const AttendanceMethod_1 = __importDefault(require("./AttendanceMethod"));
+exports.AttendanceMethod = AttendanceMethod_1.default;
+const EngagementPlatform_1 = __importDefault(require("./EngagementBundle/EngagementPlatform"));
+exports.EngagementPlatform = EngagementPlatform_1.default;
+const EngagementSource_1 = __importDefault(require("./EngagementBundle/EngagementSource"));
+exports.EngagementSource = EngagementSource_1.default;
+const ProgrammingLanguage_1 = __importDefault(require("./ProgrammingLanguage"));
+exports.ProgrammingLanguage = ProgrammingLanguage_1.default;
+//# sourceMappingURL=index.js.map

package/lib/Engagement/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/Engagement/index.ts"],"names":[],"mappings":";;;;;;AACA,8FAAsE;AAepE,qCAfK,oCAA0B,CAeL;AAd5B,8DAAsC;AAepC,qBAfK,oBAAU,CAeL;AAdZ,0EAAkD;AAehD,2BAfK,0BAAgB,CAeL;AAZlB,+FAAuE;AAerE,6BAfK,4BAAkB,CAeL;AAdpB,2FAAmE;AAejE,2BAfK,0BAAgB,CAeL;AAblB,gFAAwD;AAetD,8BAfK,6BAAmB,CAeL"}

package/lib/index.d.ts

@@ -0,0 +1,18 @@
+import ActivityId from './Engagement/ActivityId';
+import ActivityEngagementData from './Engagement/EngagementBundle/ActivityEngagementData';
+import ActivityEngagementDataType from './Engagement/ActivityEngagementDataType';
+import AverageUserEngagement from './Engagement/InferredEngagementSchedule/AverageUserEngagement';
+import AttendanceMethod from './Engagement/AttendanceMethod';
+import ComplianceBundle from './Compliance/ComplianceBundle';
+import CodeSnippet from './Engagement/CodeSnippet';
+import Drawing from './Engagement/Drawing';
+import EngagementBundle from './Engagement/EngagementBundle';
+import EngagementPlatform from './Engagement/EngagementBundle/EngagementPlatform';
+import EngagementSource from './Engagement/EngagementBundle/EngagementSource';
+import InferredEngagementSchedule from './Engagement/InferredEngagementSchedule';
+import InferredWeekSchedule from './Engagement/InferredEngagementSchedule/InferredWeekSchedule';
+import ProgrammingLanguage from './Engagement/ProgrammingLanguage';
+import ResponsePack from './Engagement/ResponsePack';
+import ShareoutPostPollResult from './Engagement/ShareoutPostPollResult';
+import UserEngagement from './Engagement/EngagementBundle/UserEngagement';
+export { ActivityId, ActivityEngagementData, ActivityEngagementDataType, AverageUserEngagement, AttendanceMethod, ComplianceBundle, CodeSnippet, Drawing, EngagementBundle, EngagementPlatform, EngagementSource, InferredEngagementSchedule, InferredWeekSchedule, ProgrammingLanguage, ResponsePack, ShareoutPostPollResult, UserEngagement, };

package/lib/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProgrammingLanguage = exports.EngagementSource = exports.EngagementPlatform = exports.AttendanceMethod = exports.ActivityEngagementDataType = exports.ActivityId = void 0;
+// import types
+const ActivityId_1 = __importDefault(require("./Engagement/ActivityId"));
+exports.ActivityId = ActivityId_1.default;
+const ActivityEngagementDataType_1 = __importDefault(require("./Engagement/ActivityEngagementDataType"));
+exports.ActivityEngagementDataType = ActivityEngagementDataType_1.default;
+const AttendanceMethod_1 = __importDefault(require("./Engagement/AttendanceMethod"));
+exports.AttendanceMethod = AttendanceMethod_1.default;
+const EngagementPlatform_1 = __importDefault(require("./Engagement/EngagementBundle/EngagementPlatform"));
+exports.EngagementPlatform = EngagementPlatform_1.default;
+const EngagementSource_1 = __importDefault(require("./Engagement/EngagementBundle/EngagementSource"));
+exports.EngagementSource = EngagementSource_1.default;
+const ProgrammingLanguage_1 = __importDefault(require("./Engagement/ProgrammingLanguage"));
+exports.ProgrammingLanguage = ProgrammingLanguage_1.default;
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,eAAe;AACf,yEAAiD;AAoB/C,qBApBK,oBAAU,CAoBL;AAlBZ,yGAAiF;AAoB/E,qCApBK,oCAA0B,CAoBL;AAlB5B,qFAA6D;AAoB3D,2BApBK,0BAAgB,CAoBL;AAflB,0GAAkF;AAoBhF,6BApBK,4BAAkB,CAoBL;AAnBpB,sGAA8E;AAoB5E,2BApBK,0BAAgB,CAoBL;AAjBlB,2FAAmE;AAoBjE,8BApBK,6BAAmB,CAoBL"}

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "dce-crosstypes",
+  "version": "1.0.0",
+  "description": "Types shared across Harvard EdTech projects",
+  "keywords": [
+    "DCE",
+    "Harvard",
+    "Types"
+  ],
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "homepage": "https://github.com/harvard-edtech/dce-crosstypes#readme",
+  "bugs": {
+    "url": "https://github.com/harvard-edtech/dce-crosstypes/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/harvard-edtech/dce-crosstypes.git"
+  },
+  "license": "MIT",
+  "author": "Gabe Abrams <gabeabrams@gmail.com>",
+  "type": "commonjs",
+  "scripts": {
+    "build": "tsc --project ./tsconfig.json",
+    "dev:sandbox": "npx tsx ./sandbox.ts"
+  },
+  "devDependencies": {
+    "@types/node": "^24.10.1",
+    "@typescript-eslint/eslint-plugin": "^5.59.9",
+    "@typescript-eslint/parser": "^5.59.9",
+    "eslint": "^8.42.0",
+    "typescript": "^5.8.2",
+    "zaccl": "^4.1.4"
+  }
+}

package/src/Compliance/ComplianceBundle.ts

@@ -0,0 +1,28 @@
+/**
+ * A compliance bundle that contains compliance records for every student in
+ * a course, organized by the start of each week (Monday).
+ *
+ * This bundle is used for federal compliance tracking to ensure that students
+ * are in compliance with federal requirements for financial aid.
+ * @author Allison Zhang
+ */
+type ComplianceBundle = {
+  /*----------------------------------------*/
+  /*               Identifiers              */
+  /*----------------------------------------*/
+  // Canvas course id
+  courseId: number,
+  /*----------------------------------------*/
+  /*            Compliance Records          */
+  /*----------------------------------------*/
+  // object that contains compliance records for each week
+  complianceByWeek: {
+    // The date of the monday that starts the week
+    [weekStart: string]: { // `${Month}/${Day}/${Year}` format
+      // Array of user ids who are in compliance for that week
+      userIds: number[],
+    };
+  },
+};
+
+export default ComplianceBundle;

package/src/Engagement/ActivityEngagementDataType.ts

@@ -0,0 +1,11 @@
+/**
+ * Types of Engagements/Shareouts
+ * @author Allison Zhang
+ */
+enum ActivityEngagementDataType {
+  Reply = 'Reply',
+  ShareoutPost = 'ShareoutPost',
+  Vote = 'Vote',
+}
+
+export default ActivityEngagementDataType;

package/src/Engagement/ActivityId.ts

@@ -0,0 +1,11 @@
+/**
+ * Available activity ids
+ * @author Gabe Abrams
+ */
+enum ActivityId {
+  PairUp = 'PairUp',
+  Respond = 'Respond',
+  Poll = 'Poll',
+}
+
+export default ActivityId;

package/src/Engagement/AttendanceMethod.ts

@@ -0,0 +1,18 @@
+/**
+ * Enum for the attendance method
+ * @author Gabe Abrams
+ */
+enum AttendanceMethod {
+  // Attended physically in-person
+  InPerson = 'in-person',
+  // Attended synchronously online (Zoom, for example)
+  Live = 'live',
+  // Watched a recorded version of the event after the fact
+  Async = 'async',
+  // Did not attend, but was excused and gets full credit
+  Excused = 'excused',
+  // Did not attend, was not excused
+  Absent = 'absent',
+}
+
+export default AttendanceMethod;

package/src/Engagement/CodeSnippet.ts

@@ -0,0 +1,15 @@
+// Import shared types
+import ProgrammingLanguage from './ProgrammingLanguage';
+
+/**
+ * Code snippet
+ * @author Gabe Abrams
+ */
+type CodeSnippet = {
+  // The code itself
+  code: string,
+  // The language the code is written in
+  language: ProgrammingLanguage,
+};
+
+export default CodeSnippet;

package/src/Engagement/Drawing.ts

@@ -0,0 +1,12 @@
+/**
+ * Drawing object
+ * @author Gabe Abrams
+ */
+type Drawing = {
+  // Serialized drawing
+  art: string,
+  // Aria description
+  description?: string,
+};
+
+export default Drawing;

package/src/Engagement/EngagementBundle/ActivityEngagementData.ts

@@ -0,0 +1,26 @@
+import ResponsePack from '../ResponsePack';
+import ActivityEngagementDataType from '../ActivityEngagementDataType';
+import ShareoutPostPollResult from '../ShareoutPostPollResult';
+
+/**
+ * Metadata for an activity engagement, per-student. It can either contain a
+ * response pack (for Shareout engagements) or a poll result
+ * (for Poll engagements).
+ * @author Allison Zhang
+ */
+type ActivityEngagementData = (
+  | {
+    // Type of activity engagement data
+    type: ActivityEngagementDataType,
+    // Response pack
+    responsePack?: ResponsePack,
+  }
+  | {
+    // Type of activity engagement data
+    type: ActivityEngagementDataType.Vote,
+    // Shareout Post of the post that the user voted on
+    pollResult: ShareoutPostPollResult,
+  }
+);
+
+export default ActivityEngagementData;

package/src/Engagement/EngagementBundle/EngagementPlatform.ts

@@ -0,0 +1,10 @@
+/**
+ * Platform of Engagements/Shareouts
+ * @author Allison Zhang
+ */
+enum EngagementPlatform {
+  IC = 'IC',
+  Gather = 'Gather',
+}
+
+export default EngagementPlatform;

package/src/Engagement/EngagementBundle/EngagementSource.ts

@@ -0,0 +1,16 @@
+/**
+ * Source of Engagements/Shareouts
+ * @author Allison Zhang
+ */
+enum EngagementSource {
+  // Engagement from IC activities (PairUp, Respond, Poll)
+  Activity = 'Activity',
+  // Engagement from Zoom Chat+
+  ZoomChatPlus = 'ZoomChatPlus',
+  // Attended physically in-person
+  InPerson = 'in-person',
+  // Attended synchronously online (Zoom, for example)
+  Live = 'live',
+}
+
+export default EngagementSource;

package/src/Engagement/EngagementBundle/UserEngagement.ts

@@ -0,0 +1,67 @@
+import ActivityId from '../ActivityId';
+import EngagementSource from './EngagementSource';
+import ActivityEngagementData from './ActivityEngagementData';
+import EngagementPlatform from './EngagementPlatform';
+
+/**
+ * An engagement record for a user for the Universal Attendance Component.
+ * Records by video.
+ * @author Allison Zhang
+ */
+type UserEngagement = (
+  // General data for all engagements
+  & {
+    // ms since epoch
+    timestamp: number,
+  }
+  // Source-dependent engagement data
+  & (
+    // IC-side engagement (video engagements)
+    | (
+      & {
+        // Platform
+        platform: EngagementPlatform.IC,
+        // video seconds that the engagement corresponds to (for video engagements)
+        videoSecs?: number,
+      }
+      // Activity engagement
+      & (
+        // Engagement from IC
+        | {
+          // Source of the engagement
+          source: EngagementSource.Activity,
+          // Type of activity (PairUp, Respond, Poll)
+          activityId: ActivityId,
+          // Activity engagement data
+          activityEngagementData: ActivityEngagementData,
+        }
+        // ZoomChat+ Engagement
+        | {
+          // Source of the engagement
+          source: EngagementSource.ZoomChatPlus,
+          // TODO: fill in with data when implemented
+        }
+      )
+    )
+    // Gather-side engagement (in-person or live)
+    | (
+      & {
+        // Platform
+        platform: EngagementPlatform.Gather,
+      }
+      & (
+        // In-person engagement
+        | {
+          source: EngagementSource.InPerson,
+          groupNum?: number,
+        }
+        // Live engagement
+        | {
+          source: EngagementSource.Live,
+        }
+      )
+    )
+  )
+);
+
+export default UserEngagement;

package/src/Engagement/EngagementBundle/index.ts

@@ -0,0 +1,27 @@
+import UserEngagement from './UserEngagement';
+
+/**
+ * An engagement bundle that contains engagement records for Universal
+ * Attendance Component.
+ * @author Allison Zhang
+ */
+type EngagementBundle = {
+  /*----------------------------------------*/
+  /*               Identifiers              */
+  /*----------------------------------------*/
+  // Canvas user id
+  userId: number,
+  // Canvas course id
+  courseId: number,
+  /*----------------------------------------*/
+  /*            Engagement Records          */
+  /*----------------------------------------*/
+  // object that contains engagement records for each week
+  engagementByWeek: {
+    // The date of the monday that starts the week
+    // `${Month}/${Day}/${Year}` format
+    [weekStart: string]: UserEngagement[],
+  },
+};
+
+export default EngagementBundle;

package/src/Engagement/InferredEngagementSchedule/AverageUserEngagement.ts

@@ -0,0 +1,22 @@
+import ActivityId from '../ActivityId';
+import EngagementSource from '../EngagementBundle/EngagementSource';
+import ActivityEngagementDataType from '../ActivityEngagementDataType';
+
+/**
+ * An engagement record for a user for the Universal Attendance Component.
+ * Records by video.
+ * @author Allison Zhang
+ */
+type AverageUserEngagement = {
+  // Activity source
+  [EngagementSource.Activity]?: {
+    [activityId in ActivityId]?: {
+      // average number of engagements
+      [engagementType in ActivityEngagementDataType]?: number
+    }
+  },
+  // TODO: determine what data to include when implemented
+  [EngagementSource.ZoomChatPlus]?: {},
+};
+
+export default AverageUserEngagement;

package/src/Engagement/InferredEngagementSchedule/InferredWeekSchedule.ts

@@ -0,0 +1,22 @@
+import AttendanceMethod from '../AttendanceMethod';
+import AverageUserEngagement from './AverageUserEngagement';
+
+/**
+ * Information that is contained in the inferred engagement schedule for a week.
+ * @author Allison Zhang
+ */
+type InferredWeekSchedule = {
+  // Average user engagement for the week (IC)
+  ic?: {
+    averageUserEngagement: AverageUserEngagement,
+  },
+  // Attendance method information for the week (Gather)
+  gather?: {
+    attendanceMethodMap: {
+      [AttendanceMethod.InPerson]?: boolean,
+      [AttendanceMethod.Live]?: boolean,
+    },
+  },
+};
+
+export default InferredWeekSchedule;

package/src/Engagement/InferredEngagementSchedule/index.ts

@@ -0,0 +1,25 @@
+// Import types
+import InferredWeekSchedule from './InferredWeekSchedule';
+
+/**
+ * A schedule with average user engagement for each week in the course. The
+ * schedule is generated based on the engagement data of the students in the
+ * course.
+ * @author Allison Zhang
+ */
+type InferredEngagementSchedule = {
+  /*----------------------------------------*/
+  /*               Identifiers              */
+  /*----------------------------------------*/
+  // Canvas course id
+  courseId: number,
+
+  // Object that contains scheduled weeks with metadata
+  // If the week is not present, then it is not considered to be part of the
+  // inferred schedule
+  scheduleByWeek: {
+    [week: string]: InferredWeekSchedule,
+  },
+};
+
+export default InferredEngagementSchedule;

package/src/Engagement/ProgrammingLanguage.ts

@@ -0,0 +1,24 @@
+/**
+ * Different types of programming languages
+ * @author Gabe Abrams
+ */
+enum ProgrammingLanguage {
+  // Generic code with no language (just monospace, not highlighted)
+  None = 'None',
+  // Python
+  Python = 'Python',
+  // Java
+  Java = 'Java',
+  // C++
+  CPP = 'CPP',
+  // JavaScript
+  JavaScript = 'JavaScript',
+  // TypeScript
+  TypeScript = 'TypeScript',
+  // HTML
+  HTML = 'HTML',
+  // CSS
+  CSS = 'CSS',
+}
+
+export default ProgrammingLanguage;

package/src/Engagement/ResponsePack.ts

@@ -0,0 +1,18 @@
+// Import shared types
+import Drawing from './Drawing';
+import CodeSnippet from './CodeSnippet';
+
+/**
+ * Type of a response (defines all types of media that can be included)
+ * @author Gabe Abrams
+ */
+type ResponsePack = {
+  // Text response
+  text?: string,
+  // Drawing:
+  drawing?: Drawing,
+  // Code snippet
+  codeSnippet?: CodeSnippet,
+};
+
+export default ResponsePack;

package/src/Engagement/ShareoutPostPollResult.ts

@@ -0,0 +1,32 @@
+// Import types
+import ZoomPollQuestionAndAnswerType from 'zaccl/lib/types/ZoomPollQuestionAndAnswerType';
+
+/**
+ * The submitted choices for a poll in a shareout post
+ * @author Yuen Ler Chow
+ */
+type ShareoutPostPollResult = {
+  // The question number
+  [questionNumber: string]: (
+    & {
+      // The question text
+      question: string,
+    }
+    & (
+      | {
+        // The poll is a single choice poll
+        pollType: ZoomPollQuestionAndAnswerType.SingleChoice,
+        // The selected choice, undefined if no choice was selected
+        selectedChoice: string | undefined,
+      }
+      | {
+        // The poll is a multiple choice poll
+        pollType: ZoomPollQuestionAndAnswerType.MultipleChoice,
+        // The selected choices
+        selectedChoices: string[],
+      }
+    )
+  )
+};
+
+export default ShareoutPostPollResult;

package/src/index.ts

@@ -0,0 +1,39 @@
+// import types
+import ActivityId from './Engagement/ActivityId';
+import ActivityEngagementData from './Engagement/EngagementBundle/ActivityEngagementData';
+import ActivityEngagementDataType from './Engagement/ActivityEngagementDataType';
+import AverageUserEngagement from './Engagement/InferredEngagementSchedule/AverageUserEngagement';
+import AttendanceMethod from './Engagement/AttendanceMethod';
+import ComplianceBundle from './Compliance/ComplianceBundle';
+import CodeSnippet from './Engagement/CodeSnippet';
+import Drawing from './Engagement/Drawing';
+import EngagementBundle from './Engagement/EngagementBundle';
+import EngagementPlatform from './Engagement/EngagementBundle/EngagementPlatform';
+import EngagementSource from './Engagement/EngagementBundle/EngagementSource';
+import InferredEngagementSchedule from './Engagement/InferredEngagementSchedule';
+import InferredWeekSchedule from './Engagement/InferredEngagementSchedule/InferredWeekSchedule';
+import ProgrammingLanguage from './Engagement/ProgrammingLanguage';
+import ResponsePack from './Engagement/ResponsePack';
+import ShareoutPostPollResult from './Engagement/ShareoutPostPollResult';
+import UserEngagement from './Engagement/EngagementBundle/UserEngagement';
+
+// export types
+export {
+  ActivityId,
+  ActivityEngagementData,
+  ActivityEngagementDataType,
+  AverageUserEngagement,
+  AttendanceMethod,
+  ComplianceBundle,
+  CodeSnippet,
+  Drawing,
+  EngagementBundle,
+  EngagementPlatform,
+  EngagementSource,
+  InferredEngagementSchedule,
+  InferredWeekSchedule,
+  ProgrammingLanguage,
+  ResponsePack,
+  ShareoutPostPollResult,
+  UserEngagement,
+};

package/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "esModuleInterop": true,
+    "noImplicitAny": true,
+    "noEmitOnError": true,
+    "removeComments": false,
+    "declaration": true,
+    "sourceMap": true,
+    "target": "es6",
+    "outDir": "./lib",
+    "rootDir": "./src"
+  },
+  "include": [
+    "./src"
+  ],
+  "ts-node": {
+    "files": true
+  }
+}