dce-crosstypes 1.0.0 → 1.0.1

package/README

@@ -0,0 +1,31 @@
+# dce-crosstypes
+A collection of shared types across apps that a component or feature uses. Shared
+types are organized by specific projects/features rather than entire apps.
+
+## Adding New Types
+When adding new shared types to this library, add them under a folder that is named
+after the intended feature. For example, for a project that is called `Engagement`:
+
+```
+/src/Engagement/{your-type-here}.ts
+```
+
+Usual EdTech typing rules apply, with types that contain subtypes being bundled in the
+same folder (e.g. `/src/Engagement/{your-main-type}/{your-subtype}.ts`)
+
+After adding all of your types, be sure to import and export in the `index.ts`
+file in `src`.
+
+## Quickstart
+
+1. Install `dce-crosstypes` into your project:
+
+```bash
+npm install dce-crosstypes --save
+```
+
+2. Import `dce-crosstypes` components into your file:
+
+```js
+import { ComplianceBundle } from 'dce-crosstypes';
+```

package/lib/Engagement/EngagementBundle/EngagementSource.d.ts

@@ -5,7 +5,9 @@
 declare enum EngagementSource {
     Activity = "Activity",
     ZoomChatPlus = "ZoomChatPlus",
+    WatchVideo = "WatchVideo",
     InPerson = "in-person",
-    Live = "live"
+    Live = "live",
+    Excused = "excused"
 }
 export default EngagementSource;

package/lib/Engagement/EngagementBundle/EngagementSource.js

@@ -6,14 +6,24 @@ Object.defineProperty(exports, "__esModule", { value: true });
  */
 var EngagementSource;
 (function (EngagementSource) {
+    /*----------------------------------------*/
+    /*             IC Sources                 */
+    /*----------------------------------------*/
     // Engagement from IC activities (PairUp, Respond, Poll)
     EngagementSource["Activity"] = "Activity";
     // Engagement from Zoom Chat+
     EngagementSource["ZoomChatPlus"] = "ZoomChatPlus";
+    // Video watching
+    EngagementSource["WatchVideo"] = "WatchVideo";
+    /*----------------------------------------*/
+    /*             Gather Sources             */
+    /*----------------------------------------*/
     // Attended physically in-person
     EngagementSource["InPerson"] = "in-person";
     // Attended synchronously online (Zoom, for example)
     EngagementSource["Live"] = "live";
+    // Did not attend, but was excused and gets full credit
+    EngagementSource["Excused"] = "excused";
 })(EngagementSource || (EngagementSource = {}));
 exports.default = EngagementSource;
 //# sourceMappingURL=EngagementSource.js.map

package/lib/Engagement/EngagementBundle/EngagementSource.js.map

@@ -1 +1 @@
-{"version":3,"file":"EngagementSource.js","sourceRoot":"","sources":["../../../src/Engagement/EngagementBundle/EngagementSource.ts"],"names":[],"mappings":";;AAAA;;;GAGG;AACH,IAAK,gBASJ;AATD,WAAK,gBAAgB;IACnB,wDAAwD;IACxD,yCAAqB,CAAA;IACrB,6BAA6B;IAC7B,iDAA6B,CAAA;IAC7B,gCAAgC;IAChC,0CAAsB,CAAA;IACtB,oDAAoD;IACpD,iCAAa,CAAA;AACf,CAAC,EATI,gBAAgB,KAAhB,gBAAgB,QASpB;AAED,kBAAe,gBAAgB,CAAC"}
+{"version":3,"file":"EngagementSource.js","sourceRoot":"","sources":["../../../src/Engagement/EngagementBundle/EngagementSource.ts"],"names":[],"mappings":";;AAAA;;;GAGG;AACH,IAAK,gBAoBJ;AApBD,WAAK,gBAAgB;IACnB,4CAA4C;IAC5C,4CAA4C;IAC5C,4CAA4C;IAC5C,wDAAwD;IACxD,yCAAqB,CAAA;IACrB,6BAA6B;IAC7B,iDAA6B,CAAA;IAC7B,iBAAiB;IACjB,6CAAyB,CAAA;IAEzB,4CAA4C;IAC5C,4CAA4C;IAC5C,4CAA4C;IAC5C,gCAAgC;IAChC,0CAAsB,CAAA;IACtB,oDAAoD;IACpD,iCAAa,CAAA;IACb,uDAAuD;IACvD,uCAAmB,CAAA;AACrB,CAAC,EApBI,gBAAgB,KAAhB,gBAAgB,QAoBpB;AAED,kBAAe,gBAAgB,CAAC"}

package/lib/Engagement/EngagementBundle/SimpleWatchTraceAnalytics.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Analytics for a single student's watch trace for a specific video
+ * @author Allison Zhang
+ */
+type SimpleWatchTraceAnalytics = {
+    videoSecsWatchedTotal: number;
+    uniqueVideoSecsWatchedTotal: number;
+    videoDurationSecs: number;
+    percentWatched: number;
+    videoSecsRewatchedTotal: number;
+    timeSpentTotal: number;
+    avgMultiplier: number;
+};
+export default SimpleWatchTraceAnalytics;

package/lib/Engagement/EngagementBundle/SimpleWatchTraceAnalytics.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=SimpleWatchTraceAnalytics.js.map

package/lib/Engagement/EngagementBundle/SimpleWatchTraceAnalytics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SimpleWatchTraceAnalytics.js","sourceRoot":"","sources":["../../../src/Engagement/EngagementBundle/SimpleWatchTraceAnalytics.ts"],"names":[],"mappings":""}

package/lib/Engagement/EngagementBundle/UserEngagement.d.ts

@@ -2,6 +2,7 @@ import ActivityId from '../ActivityId';
 import EngagementSource from './EngagementSource';
 import ActivityEngagementData from './ActivityEngagementData';
 import EngagementPlatform from './EngagementPlatform';
+import SimpleWatchTraceAnalytics from './SimpleWatchTraceAnalytics';
 /**
  * An engagement record for a user for the Universal Attendance Component.
  * Records by video.
@@ -13,6 +14,9 @@ type UserEngagement = ({
     platform: EngagementPlatform.IC;
     videoSecs?: number;
 } & ({
+    source: EngagementSource.WatchVideo;
+    watchTraceAnalytics: SimpleWatchTraceAnalytics;
+} | {
     source: EngagementSource.Activity;
     activityId: ActivityId;
     activityEngagementData: ActivityEngagementData;
@@ -25,5 +29,7 @@ type UserEngagement = ({
     groupNum?: number;
 } | {
     source: EngagementSource.Live;
+} | {
+    source: EngagementSource.Excused;
 }))));
 export default UserEngagement;

package/lib/Engagement/EngagementBundle/index.d.ts

@@ -10,5 +10,6 @@ type EngagementBundle = {
     engagementByWeek: {
         [weekStart: string]: UserEngagement[];
     };
+    undatedEngagements: UserEngagement[];
 };
 export default EngagementBundle;

package/lib/Engagement/InferredEngagementSchedule/AttendanceMethod.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Enum for the attendance method
+ * @author Gabe Abrams
+ */
+declare enum AttendanceMethod {
+    InPerson = "in-person",
+    Live = "live",
+    Async = "async",
+    Excused = "excused",
+    Absent = "absent"
+}
+export default AttendanceMethod;

package/lib/Engagement/InferredEngagementSchedule/AttendanceMethod.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Enum for the attendance method
+ * @author Gabe Abrams
+ */
+var AttendanceMethod;
+(function (AttendanceMethod) {
+    // Attended physically in-person
+    AttendanceMethod["InPerson"] = "in-person";
+    // Attended synchronously online (Zoom, for example)
+    AttendanceMethod["Live"] = "live";
+    // Watched a recorded version of the event after the fact
+    AttendanceMethod["Async"] = "async";
+    // Did not attend, but was excused and gets full credit
+    AttendanceMethod["Excused"] = "excused";
+    // Did not attend, was not excused
+    AttendanceMethod["Absent"] = "absent";
+})(AttendanceMethod || (AttendanceMethod = {}));
+exports.default = AttendanceMethod;
+//# sourceMappingURL=AttendanceMethod.js.map

package/lib/Engagement/InferredEngagementSchedule/AttendanceMethod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AttendanceMethod.js","sourceRoot":"","sources":["../../../src/Engagement/InferredEngagementSchedule/AttendanceMethod.ts"],"names":[],"mappings":";;AAAA;;;GAGG;AACH,IAAK,gBAWJ;AAXD,WAAK,gBAAgB;IACnB,gCAAgC;IAChC,0CAAsB,CAAA;IACtB,oDAAoD;IACpD,iCAAa,CAAA;IACb,yDAAyD;IACzD,mCAAe,CAAA;IACf,uDAAuD;IACvD,uCAAmB,CAAA;IACnB,kCAAkC;IAClC,qCAAiB,CAAA;AACnB,CAAC,EAXI,gBAAgB,KAAhB,gBAAgB,QAWpB;AAED,kBAAe,gBAAgB,CAAC"}

package/lib/Engagement/InferredEngagementSchedule/AverageUserEngagement.d.ts

@@ -2,14 +2,23 @@ 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.
+ * Average user engagement for each activity and engagement type.
  * @author Allison Zhang
  */
 type AverageUserEngagement = {
-    [EngagementSource.Activity]?: {
-        [activityId in ActivityId]?: {
-            [engagementType in ActivityEngagementDataType]?: number;
+    [EngagementSource.Activity]: {
+        [ActivityId.Respond]: {
+            [ActivityEngagementDataType.ShareoutPost]: number;
+            [ActivityEngagementDataType.Reply]: number;
+            [ActivityEngagementDataType.Vote]?: undefined;
+        };
+        [ActivityId.PairUp]: {
+            [ActivityEngagementDataType.ShareoutPost]: number;
+            [ActivityEngagementDataType.Reply]: number;
+            [ActivityEngagementDataType.Vote]?: undefined;
+        };
+        [ActivityId.Poll]: {
+            [engagementType in ActivityEngagementDataType]: number;
         };
     };
     [EngagementSource.ZoomChatPlus]?: {};

package/lib/Engagement/InferredEngagementSchedule/AverageUserEngagement.js

@@ -3,5 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const ActivityId_1 = __importDefault(require("../ActivityId"));
 const EngagementSource_1 = __importDefault(require("../EngagementBundle/EngagementSource"));
+const ActivityEngagementDataType_1 = __importDefault(require("../ActivityEngagementDataType"));
 //# sourceMappingURL=AverageUserEngagement.js.map

package/lib/Engagement/InferredEngagementSchedule/AverageUserEngagement.js.map

@@ -1 +1 @@
-{"version":3,"file":"AverageUserEngagement.js","sourceRoot":"","sources":["../../../src/Engagement/InferredEngagementSchedule/AverageUserEngagement.ts"],"names":[],"mappings":";;;;;AACA,4FAAoE"}
+{"version":3,"file":"AverageUserEngagement.js","sourceRoot":"","sources":["../../../src/Engagement/InferredEngagementSchedule/AverageUserEngagement.ts"],"names":[],"mappings":";;;;;AAAA,+DAAuC;AACvC,4FAAoE;AACpE,+FAAuE"}

package/lib/Engagement/InferredEngagementSchedule/AverageWatchAnalytics.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Average watch analytics for each activity and engagement type.
+ * @author Allison Zhang
+ */
+type AverageWatchAnalytics = {
+    avgVideoSecsWatchedTotal: number;
+    avgUniqueVideoSecsWatchedTotal: number;
+    avgVideoDurationSecs: number;
+    avgPercentWatched: number;
+    avgVideoSecsRewatchedTotal: number;
+    avgTimeSpentTotal: number;
+    avgMultiplier: number;
+};
+export default AverageWatchAnalytics;

package/lib/Engagement/InferredEngagementSchedule/AverageWatchAnalytics.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=AverageWatchAnalytics.js.map

package/lib/Engagement/InferredEngagementSchedule/AverageWatchAnalytics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AverageWatchAnalytics.js","sourceRoot":"","sources":["../../../src/Engagement/InferredEngagementSchedule/AverageWatchAnalytics.ts"],"names":[],"mappings":""}

package/lib/Engagement/InferredEngagementSchedule/InferredWeekSchedule.d.ts

@@ -1,5 +1,6 @@
-import AttendanceMethod from '../AttendanceMethod';
+import AttendanceMethod from './AttendanceMethod';
 import AverageUserEngagement from './AverageUserEngagement';
+import AverageWatchAnalytics from './AverageWatchAnalytics';
 /**
  * Information that is contained in the inferred engagement schedule for a week.
  * @author Allison Zhang
@@ -7,6 +8,7 @@ import AverageUserEngagement from './AverageUserEngagement';
 type InferredWeekSchedule = {
     ic?: {
         averageUserEngagement: AverageUserEngagement;
+        averageWatchAnalytics: AverageWatchAnalytics;
     };
     gather?: {
         attendanceMethodMap: {

package/lib/Engagement/InferredEngagementSchedule/InferredWeekSchedule.js

@@ -3,5 +3,5 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const AttendanceMethod_1 = __importDefault(require("../AttendanceMethod"));
+const AttendanceMethod_1 = __importDefault(require("./AttendanceMethod"));
 //# sourceMappingURL=InferredWeekSchedule.js.map

package/lib/Engagement/InferredEngagementSchedule/InferredWeekSchedule.js.map

@@ -1 +1 @@
-{"version":3,"file":"InferredWeekSchedule.js","sourceRoot":"","sources":["../../../src/Engagement/InferredEngagementSchedule/InferredWeekSchedule.ts"],"names":[],"mappings":";;;;;AAAA,2EAAmD"}
+{"version":3,"file":"InferredWeekSchedule.js","sourceRoot":"","sources":["../../../src/Engagement/InferredEngagementSchedule/InferredWeekSchedule.ts"],"names":[],"mappings":";;;;;AAAA,0EAAkD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dce-crosstypes",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Types shared across Harvard EdTech projects",
   "keywords": [
     "DCE",

package/src/Engagement/EngagementBundle/EngagementSource.ts

@@ -3,14 +3,25 @@
  * @author Allison Zhang
  */
 enum EngagementSource {
+  /*----------------------------------------*/
+  /*             IC Sources                 */
+  /*----------------------------------------*/
   // Engagement from IC activities (PairUp, Respond, Poll)
   Activity = 'Activity',
   // Engagement from Zoom Chat+
   ZoomChatPlus = 'ZoomChatPlus',
+  // Video watching
+  WatchVideo = 'WatchVideo',
+
+  /*----------------------------------------*/
+  /*             Gather Sources             */
+  /*----------------------------------------*/
   // Attended physically in-person
   InPerson = 'in-person',
   // Attended synchronously online (Zoom, for example)
   Live = 'live',
+  // Did not attend, but was excused and gets full credit
+  Excused = 'excused',
 }
 
 export default EngagementSource;

package/src/Engagement/EngagementBundle/SimpleWatchTraceAnalytics.ts

@@ -0,0 +1,22 @@
+/**
+ * Analytics for a single student's watch trace for a specific video
+ * @author Allison Zhang
+ */
+type SimpleWatchTraceAnalytics = {
+  // Total duration of the video watched in seconds
+  videoSecsWatchedTotal: number,
+  // Total duration of the video watched in seconds (only counts unique seconds)
+  uniqueVideoSecsWatchedTotal: number,
+  // Total duration of the video in seconds
+  videoDurationSecs: number,
+  // Percentage of video watched (0-100)
+  percentWatched: number,
+  // Total number of secs rewatched
+  videoSecsRewatchedTotal: number,
+  // Total amount of time spent on the video
+  timeSpentTotal: number,
+  // Average Multiplier
+  avgMultiplier: number,
+};
+
+export default SimpleWatchTraceAnalytics;

package/src/Engagement/EngagementBundle/UserEngagement.ts

@@ -2,6 +2,7 @@ import ActivityId from '../ActivityId';
 import EngagementSource from './EngagementSource';
 import ActivityEngagementData from './ActivityEngagementData';
 import EngagementPlatform from './EngagementPlatform';
+import SimpleWatchTraceAnalytics from './SimpleWatchTraceAnalytics';
 
 /**
  * An engagement record for a user for the Universal Attendance Component.
@@ -26,6 +27,13 @@ type UserEngagement = (
       }
       // Activity engagement
       & (
+        // Watch trace engagement from IC
+        | {
+          // Source of the engagement
+          source: EngagementSource.WatchVideo,
+          // Watch trace analytics for the engagement
+          watchTraceAnalytics: SimpleWatchTraceAnalytics,
+        }
         // Engagement from IC
         | {
           // Source of the engagement
@@ -59,6 +67,10 @@ type UserEngagement = (
         | {
           source: EngagementSource.Live,
         }
+        // Excused engagement
+        | {
+          source: EngagementSource.Excused,
+        }
       )
     )
   )

package/src/Engagement/EngagementBundle/index.ts

@@ -22,6 +22,8 @@ type EngagementBundle = {
     // `${Month}/${Day}/${Year}` format
     [weekStart: string]: UserEngagement[],
   },
+  // undated engagement records that do not have a date associated with them
+  undatedEngagements: UserEngagement[],
 };
 
 export default EngagementBundle;

package/src/Engagement/InferredEngagementSchedule/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/InferredEngagementSchedule/AverageUserEngagement.ts

@@ -3,16 +3,24 @@ import EngagementSource from '../EngagementBundle/EngagementSource';
 import ActivityEngagementDataType from '../ActivityEngagementDataType';
 
 /**
- * An engagement record for a user for the Universal Attendance Component.
- * Records by video.
+ * Average user engagement for each activity and engagement type.
  * @author Allison Zhang
  */
 type AverageUserEngagement = {
   // Activity source
-  [EngagementSource.Activity]?: {
-    [activityId in ActivityId]?: {
-      // average number of engagements
-      [engagementType in ActivityEngagementDataType]?: number
+  [EngagementSource.Activity]: {
+    [ActivityId.Respond]: {
+      [ActivityEngagementDataType.ShareoutPost]: number,
+      [ActivityEngagementDataType.Reply]: number,
+      [ActivityEngagementDataType.Vote]?: undefined,
+    },
+    [ActivityId.PairUp]: {
+      [ActivityEngagementDataType.ShareoutPost]: number,
+      [ActivityEngagementDataType.Reply]: number,
+      [ActivityEngagementDataType.Vote]?: undefined,
+    },
+    [ActivityId.Poll]: {
+      [engagementType in ActivityEngagementDataType]: number
     }
   },
   // TODO: determine what data to include when implemented

package/src/Engagement/InferredEngagementSchedule/AverageWatchAnalytics.ts

@@ -0,0 +1,22 @@
+/**
+ * Average watch analytics for each activity and engagement type.
+ * @author Allison Zhang
+ */
+type AverageWatchAnalytics = {
+  // Average duration of video watched in seconds
+  avgVideoSecsWatchedTotal: number,
+  // Average duration of video watched in seconds (only counts unique)
+  avgUniqueVideoSecsWatchedTotal: number,
+  // Average duration of video in seconds
+  avgVideoDurationSecs: number,
+  // Average percentage of video watched (0-100)
+  avgPercentWatched: number,
+  // Average number of secs rewatched
+  avgVideoSecsRewatchedTotal: number,
+  // Average amount of time spent on video
+  avgTimeSpentTotal: number,
+  // Average effective playback multiplier (realtime secs / video secs watched)
+  avgMultiplier: number,
+};
+
+export default AverageWatchAnalytics;

package/src/Engagement/InferredEngagementSchedule/InferredWeekSchedule.ts

@@ -1,5 +1,6 @@
-import AttendanceMethod from '../AttendanceMethod';
+import AttendanceMethod from './AttendanceMethod';
 import AverageUserEngagement from './AverageUserEngagement';
+import AverageWatchAnalytics from './AverageWatchAnalytics';
 
 /**
  * Information that is contained in the inferred engagement schedule for a week.
@@ -8,7 +9,10 @@ import AverageUserEngagement from './AverageUserEngagement';
 type InferredWeekSchedule = {
   // Average user engagement for the week (IC)
   ic?: {
+    // Average user engagement for each activity and engagement type
     averageUserEngagement: AverageUserEngagement,
+    // Average watch analytics for each activity and engagement type
+    averageWatchAnalytics: AverageWatchAnalytics,
   },
   // Attendance method information for the week (Gather)
   gather?: {