dce-crosstypes 1.0.1 → 1.0.3

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

@@ -27,9 +27,14 @@ type UserEngagement = ({
 } & ({
     source: EngagementSource.InPerson;
     groupNum?: number;
+    ihid: string;
 } | {
     source: EngagementSource.Live;
+    groupNum: undefined;
+    ihid: string;
 } | {
     source: EngagementSource.Excused;
+    groupNum: undefined;
+    ihid: undefined;
 }))));
 export default UserEngagement;

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

@@ -1,19 +1,23 @@
 import AttendanceMethod from './AttendanceMethod';
 import AverageUserEngagement from './AverageUserEngagement';
 import AverageWatchAnalytics from './AverageWatchAnalytics';
+import WeekScheduleStatus from './WeekScheduleStatus';
 /**
  * Information that is contained in the inferred engagement schedule for a week.
  * @author Allison Zhang
  */
 type InferredWeekSchedule = {
-    ic?: {
-        averageUserEngagement: AverageUserEngagement;
-        averageWatchAnalytics: AverageWatchAnalytics;
-    };
-    gather?: {
-        attendanceMethodMap: {
-            [AttendanceMethod.InPerson]?: boolean;
-            [AttendanceMethod.Live]?: boolean;
+    attendanceMethodMap: {
+        [AttendanceMethod.InPerson]?: {
+            status: WeekScheduleStatus.Yes;
+        };
+        [AttendanceMethod.Live]?: {
+            status: WeekScheduleStatus;
+        };
+        [AttendanceMethod.Async]?: {
+            status: WeekScheduleStatus.Yes;
+            averageUserEngagement: AverageUserEngagement;
+            averageWatchAnalytics: AverageWatchAnalytics;
         };
     };
 };

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

@@ -0,0 +1,9 @@
+/**
+ * Enum for the week schedule status
+ * @author Allison Zhang
+ */
+declare enum WeekScheduleStatus {
+    Yes = "Yes",
+    Maybe = "Maybe"
+}
+export default WeekScheduleStatus;

package/lib/Engagement/InferredEngagementSchedule/WeekScheduleStatus.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Enum for the week schedule status
+ * @author Allison Zhang
+ */
+var WeekScheduleStatus;
+(function (WeekScheduleStatus) {
+    WeekScheduleStatus["Yes"] = "Yes";
+    WeekScheduleStatus["Maybe"] = "Maybe";
+})(WeekScheduleStatus || (WeekScheduleStatus = {}));
+exports.default = WeekScheduleStatus;
+//# sourceMappingURL=WeekScheduleStatus.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"WeekScheduleStatus.js","sourceRoot":"","sources":["../../../src/Engagement/InferredEngagementSchedule/WeekScheduleStatus.ts"],"names":[],"mappings":";;AAAA;;;GAGG;AACH,IAAK,kBAGJ;AAHD,WAAK,kBAAkB;IACrB,iCAAW,CAAA;IACX,qCAAe,CAAA;AACjB,CAAC,EAHI,kBAAkB,KAAlB,kBAAkB,QAGtB;AAED,kBAAe,kBAAkB,CAAC"}

package/lib/index.d.ts

@@ -15,4 +15,5 @@ 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, };
+import WeekScheduleStatus from './Engagement/InferredEngagementSchedule/WeekScheduleStatus';
+export { ActivityId, ActivityEngagementData, ActivityEngagementDataType, AverageUserEngagement, AttendanceMethod, ComplianceBundle, CodeSnippet, Drawing, EngagementBundle, EngagementPlatform, EngagementSource, InferredEngagementSchedule, InferredWeekSchedule, ProgrammingLanguage, ResponsePack, ShareoutPostPollResult, UserEngagement, WeekScheduleStatus, };

package/lib/index.js

@@ -3,7 +3,7 @@ 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;
+exports.WeekScheduleStatus = 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;
@@ -17,4 +17,6 @@ const EngagementSource_1 = __importDefault(require("./Engagement/EngagementBundl
 exports.EngagementSource = EngagementSource_1.default;
 const ProgrammingLanguage_1 = __importDefault(require("./Engagement/ProgrammingLanguage"));
 exports.ProgrammingLanguage = ProgrammingLanguage_1.default;
+const WeekScheduleStatus_1 = __importDefault(require("./Engagement/InferredEngagementSchedule/WeekScheduleStatus"));
+exports.WeekScheduleStatus = WeekScheduleStatus_1.default;
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +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"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,eAAe;AACf,yEAAiD;AAqB/C,qBArBK,oBAAU,CAqBL;AAnBZ,yGAAiF;AAqB/E,qCArBK,oCAA0B,CAqBL;AAnB5B,qFAA6D;AAqB3D,2BArBK,0BAAgB,CAqBL;AAhBlB,0GAAkF;AAqBhF,6BArBK,4BAAkB,CAqBL;AApBpB,sGAA8E;AAqB5E,2BArBK,0BAAgB,CAqBL;AAlBlB,2FAAmE;AAqBjE,8BArBK,6BAAmB,CAqBL;AAjBrB,oHAA4F;AAqB1F,6BArBK,4BAAkB,CAqBL"}

package/package.json

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

package/src/Engagement/EngagementBundle/UserEngagement.ts

@@ -1,3 +1,4 @@
+// Import types
 import ActivityId from '../ActivityId';
 import EngagementSource from './EngagementSource';
 import ActivityEngagementData from './ActivityEngagementData';
@@ -61,15 +62,26 @@ type UserEngagement = (
         // In-person engagement
         | {
           source: EngagementSource.InPerson,
+          // Group number for the in-person engagement
           groupNum?: number,
+          // IHID for the in-person engagement
+          ihid: string,
         }
         // Live engagement
         | {
           source: EngagementSource.Live,
+          // Group number for the live engagement (always undefined)
+          groupNum: undefined,
+          // IHID for the live engagement
+          ihid: string,
         }
         // Excused engagement
         | {
           source: EngagementSource.Excused,
+          // Group number for the excused engagement (always undefined)
+          groupNum: undefined,
+          // IHID for the excused engagement (always undefined)
+          ihid: undefined,
         }
       )
     )

package/src/Engagement/InferredEngagementSchedule/InferredWeekSchedule.ts

@@ -1,24 +1,28 @@
 import AttendanceMethod from './AttendanceMethod';
 import AverageUserEngagement from './AverageUserEngagement';
 import AverageWatchAnalytics from './AverageWatchAnalytics';
+import WeekScheduleStatus from './WeekScheduleStatus';
 
 /**
  * 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?: {
-    // 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?: {
-    attendanceMethodMap: {
-      [AttendanceMethod.InPerson]?: boolean,
-      [AttendanceMethod.Live]?: boolean,
+  // Inferred schedule by attendance method
+  attendanceMethodMap: {
+    [AttendanceMethod.InPerson]?: {
+      status: WeekScheduleStatus.Yes,
+    },
+    [AttendanceMethod.Live]?: {
+      status: WeekScheduleStatus,
+    },
+    [AttendanceMethod.Async]?: {
+      // Schedule status
+      status: WeekScheduleStatus.Yes,
+      // Average user engagement for each activity and engagement type
+      averageUserEngagement: AverageUserEngagement,
+      // Average watch analytics for each activity and engagement type
+      averageWatchAnalytics: AverageWatchAnalytics,
     },
   },
 };

package/src/Engagement/InferredEngagementSchedule/WeekScheduleStatus.ts

@@ -0,0 +1,10 @@
+/**
+ * Enum for the week schedule status
+ * @author Allison Zhang
+ */
+enum WeekScheduleStatus {
+  Yes = 'Yes',
+  Maybe = 'Maybe',
+}
+
+export default WeekScheduleStatus;

package/src/index.ts

@@ -16,6 +16,7 @@ import ProgrammingLanguage from './Engagement/ProgrammingLanguage';
 import ResponsePack from './Engagement/ResponsePack';
 import ShareoutPostPollResult from './Engagement/ShareoutPostPollResult';
 import UserEngagement from './Engagement/EngagementBundle/UserEngagement';
+import WeekScheduleStatus from './Engagement/InferredEngagementSchedule/WeekScheduleStatus';
 
 // export types
 export {
@@ -36,4 +37,5 @@ export {
   ResponsePack,
   ShareoutPostPollResult,
   UserEngagement,
+  WeekScheduleStatus,
 };