@uptime.app/contracts 1.0.41-rc.0 → 1.0.41-rc.2

package/dist/esm/preferences/preferences.d.ts

@@ -0,0 +1,34 @@
+export type Preferences = PreferencesItem & UpdatablePreferences;
+interface PreferencesItem {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    userId: string;
+}
+export interface UpdatablePreferences {
+    'flashcards.showFlashcardsFromInsights': boolean;
+    'flashcards.showFlashcardsFromInsights.datePreferenceUpdated': string;
+    'notifications.backdrop.email': boolean;
+    'notifications.backdrop.push': boolean;
+    'notifications.challenges.email': boolean;
+    'notifications.challenges.push': boolean;
+    'notifications.generalReminders.email': boolean;
+    'notifications.generalReminders.push': boolean;
+    'notifications.getBackToUptime.email': boolean;
+    'notifications.getBackToUptime.push': boolean;
+    'notifications.getBackToUptime.timeToReceive': string;
+    'notifications.flashcards.newToday.email': boolean;
+    'notifications.flashcards.newToday.push': boolean;
+    'notifications.recommendedContent.email': boolean;
+    'notifications.recommendedContent.push': boolean;
+    'notifications.research.email': boolean;
+    'notifications.research.push': boolean;
+    'notifications.savedHacks.email': boolean;
+    'notifications.savedHacks.push': boolean;
+    'notifications.uptimeNews.email': boolean;
+    'notifications.uptimeNews.push': boolean;
+    'timezone': string;
+}
+export {};
+//# sourceMappingURL=preferences.d.ts.map

package/dist/esm/preferences/preferences.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"preferences.d.ts","sourceRoot":"","sources":["../../../src/preferences/preferences.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,WAAW,GAAG,eAAe,GAAG,oBAAoB,CAAC;AAEjE,UAAU,eAAe;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,EAAE,MAAM,CAAC;IACV,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,oBAAoB;IACjC,uCAAuC,EAAE,OAAO,CAAC;IAEjD,6DAA6D,EAAE,MAAM,CAAC;IACtE,8BAA8B,EAAE,OAAO,CAAC;IACxC,6BAA6B,EAAE,OAAO,CAAC;IACvC,gCAAgC,EAAE,OAAO,CAAC;IAC1C,+BAA+B,EAAE,OAAO,CAAC;IACzC,sCAAsC,EAAE,OAAO,CAAC;IAChD,qCAAqC,EAAE,OAAO,CAAC;IAC/C,qCAAqC,EAAE,OAAO,CAAC;IAC/C,oCAAoC,EAAE,OAAO,CAAC;IAC9C,6CAA6C,EAAE,MAAM,CAAC;IACtD,yCAAyC,EAAE,OAAO,CAAC;IACnD,wCAAwC,EAAE,OAAO,CAAC;IAClD,wCAAwC,EAAE,OAAO,CAAC;IAClD,uCAAuC,EAAE,OAAO,CAAC;IACjD,8BAA8B,EAAE,OAAO,CAAC;IACxC,6BAA6B,EAAE,OAAO,CAAC;IACvC,gCAAgC,EAAE,OAAO,CAAC;IAC1C,+BAA+B,EAAE,OAAO,CAAC;IACzC,gCAAgC,EAAE,OAAO,CAAC;IAC1C,+BAA+B,EAAE,OAAO,CAAC;IACzC,UAAU,EAAE,MAAM,CAAC;CACtB"}

package/dist/esm/preferences/preferences.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=preferences.js.map

package/dist/esm/preferences/preferences.js.map

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

package/dist/esm/user-statistics/user-statistics-events.d.ts

@@ -0,0 +1,82 @@
+import { DailyInsightCompleted, StreakRepair, UserHackStatistics, UserInsightStreak, ViewedHack } from './user-statistics';
+export interface DailyInsightCompletedCreatedEvent {
+    id: string;
+    type: 'DailyInsightCompletedCreated';
+    payload: DailyInsightCompleted;
+}
+export interface DailyInsightCompletedUpdatedEvent {
+    id: string;
+    type: 'DailyInsightCompletedUpdated';
+    payload: DailyInsightCompleted;
+}
+export interface DailyInsightCompletedDeletedEvent {
+    id: string;
+    type: 'DailyInsightCompletedDeleted';
+    payload: DailyInsightCompleted;
+}
+export interface StreakRepairCreatedEvent {
+    id: string;
+    type: 'StreakRepairCreated';
+    payload: StreakRepair;
+}
+export interface StreakRepairUpdatedEvent {
+    id: string;
+    type: 'StreakRepairUpdated';
+    payload: StreakRepair;
+}
+export interface StreakRepairDeletedEvent {
+    id: string;
+    type: 'StreakRepairDeleted';
+    payload: StreakRepair;
+}
+export interface UserHackStatisticsCreatedEvent {
+    id: string;
+    type: 'UserHackStatisticsCreated';
+    payload: UserHackStatistics;
+}
+export interface UserHackStatisticsUpdatedEvent {
+    id: string;
+    type: 'UserHackStatisticsUpdated';
+    payload: UserHackStatistics;
+}
+export interface UserHackStatisticsDeletedEvent {
+    id: string;
+    type: 'UserHackStatisticsDeleted';
+    payload: UserHackStatistics;
+}
+export interface UserInsightStreakCreatedEvent {
+    id: string;
+    type: 'UserInsightStreakCreated';
+    payload: UserInsightStreak;
+}
+export interface UserInsightStreakUpdatedEvent {
+    id: string;
+    type: 'UserInsightStreakUpdated';
+    payload: UserInsightStreak;
+}
+export interface UserInsightStreakDeletedEvent {
+    id: string;
+    type: 'UserInsightStreakDeleted';
+    payload: UserInsightStreak;
+}
+export interface ViewedHackCreatedEvent {
+    id: string;
+    type: 'ViewedHackCreated';
+    payload: ViewedHack;
+}
+export interface ViewedHackUpdatedEvent {
+    id: string;
+    type: 'ViewedHackUpdated';
+    payload: ViewedHack;
+}
+export interface ViewedHackDeletedEvent {
+    id: string;
+    type: 'ViewedHackDeleted';
+    payload: ViewedHack;
+}
+export type DailyInsightCompletedChangedEvent = DailyInsightCompletedCreatedEvent | DailyInsightCompletedUpdatedEvent | DailyInsightCompletedDeletedEvent;
+export type StreakRepairChangedEvent = StreakRepairCreatedEvent | StreakRepairUpdatedEvent | StreakRepairDeletedEvent;
+export type UserHackStatisticsChangedEvent = UserHackStatisticsCreatedEvent | UserHackStatisticsUpdatedEvent | UserHackStatisticsDeletedEvent;
+export type UserInsightStreakChangedEvent = UserInsightStreakCreatedEvent | UserInsightStreakUpdatedEvent | UserInsightStreakDeletedEvent;
+export type ViewedHackChangedEvent = ViewedHackCreatedEvent | ViewedHackUpdatedEvent | ViewedHackDeletedEvent;
+//# sourceMappingURL=user-statistics-events.d.ts.map

package/dist/esm/user-statistics/user-statistics-events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-statistics-events.d.ts","sourceRoot":"","sources":["../../../src/user-statistics/user-statistics-events.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,YAAY,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAE3H,MAAM,WAAW,iCAAiC;IAC9C,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,8BAA8B,CAAC;IACrC,OAAO,EAAE,qBAAqB,CAAC;CAClC;AAED,MAAM,WAAW,iCAAiC;IAC9C,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,8BAA8B,CAAC;IACrC,OAAO,EAAE,qBAAqB,CAAC;CAClC;AAED,MAAM,WAAW,iCAAiC;IAC9C,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,8BAA8B,CAAC;IACrC,OAAO,EAAE,qBAAqB,CAAC;CAClC;AAED,MAAM,WAAW,wBAAwB;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,qBAAqB,CAAC;IAC5B,OAAO,EAAE,YAAY,CAAC;CACzB;AAED,MAAM,WAAW,wBAAwB;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,qBAAqB,CAAC;IAC5B,OAAO,EAAE,YAAY,CAAC;CACzB;AAED,MAAM,WAAW,wBAAwB;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,qBAAqB,CAAC;IAC5B,OAAO,EAAE,YAAY,CAAC;CACzB;AAED,MAAM,WAAW,8BAA8B;IAC3C,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,2BAA2B,CAAC;IAClC,OAAO,EAAE,kBAAkB,CAAC;CAC/B;AAED,MAAM,WAAW,8BAA8B;IAC3C,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,2BAA2B,CAAC;IAClC,OAAO,EAAE,kBAAkB,CAAC;CAC/B;AAED,MAAM,WAAW,8BAA8B;IAC3C,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,2BAA2B,CAAC;IAClC,OAAO,EAAE,kBAAkB,CAAC;CAC/B;AAED,MAAM,WAAW,6BAA6B;IAC1C,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,0BAA0B,CAAC;IACjC,OAAO,EAAE,iBAAiB,CAAC;CAC9B;AAED,MAAM,WAAW,6BAA6B;IAC1C,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,0BAA0B,CAAC;IACjC,OAAO,EAAE,iBAAiB,CAAC;CAC9B;AAED,MAAM,WAAW,6BAA6B;IAC1C,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,0BAA0B,CAAC;IACjC,OAAO,EAAE,iBAAiB,CAAC;CAC9B;AAED,MAAM,WAAW,sBAAsB;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,mBAAmB,CAAC;IAC1B,OAAO,EAAE,UAAU,CAAC;CACvB;AAED,MAAM,WAAW,sBAAsB;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,mBAAmB,CAAC;IAC1B,OAAO,EAAE,UAAU,CAAC;CACvB;AAED,MAAM,WAAW,sBAAsB;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,mBAAmB,CAAC;IAC1B,OAAO,EAAE,UAAU,CAAC;CACvB;AAED,MAAM,MAAM,iCAAiC,GAAG,iCAAiC,GAAG,iCAAiC,GAAG,iCAAiC,CAAC;AAC1J,MAAM,MAAM,wBAAwB,GAAG,wBAAwB,GAAG,wBAAwB,GAAG,wBAAwB,CAAC;AACtH,MAAM,MAAM,8BAA8B,GAAG,8BAA8B,GAAG,8BAA8B,GAAG,8BAA8B,CAAC;AAC9I,MAAM,MAAM,6BAA6B,GAAG,6BAA6B,GAAG,6BAA6B,GAAG,6BAA6B,CAAC;AAC1I,MAAM,MAAM,sBAAsB,GAAG,sBAAsB,GAAG,sBAAsB,GAAG,sBAAsB,CAAC"}

package/dist/esm/user-statistics/user-statistics-events.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=user-statistics-events.js.map

package/dist/esm/user-statistics/user-statistics-events.js.map

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

package/dist/esm/user-statistics/user-statistics.d.ts

@@ -0,0 +1,75 @@
+export interface ViewedHack {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    userId: string;
+    hackId: string;
+    isHackCompleted: boolean;
+    insightsCompletedCount: number;
+    /** added Aug 2023 */
+    percentageComplete: number;
+    /** added Aug 2023 */
+    lastViewedAt: string;
+    hackProgress: {
+        id: string;
+        version: number;
+        createdAt: string;
+    };
+}
+export interface UserInsightStreak {
+    userId: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    id: string;
+    longestStreak: {
+        length: number;
+    };
+    latestStreak: {
+        latestDayCompleted: string;
+        length: number;
+    };
+    previousStreak: {
+        length: number;
+    };
+    latestDaysCompleted: string[];
+    repairs?: {
+        usedThisMonthCount: number;
+    };
+}
+export interface UserHackStatistics {
+    userId: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    id: string;
+    insightsCompletedCount: number;
+    hacksCompletedCount: number;
+    /** Time saved in minutes. Added Aug 2023 */
+    totalTimeSaved: number;
+    perTopic?: PerTopicStatistics[];
+}
+export interface PerTopicStatistics {
+    name: string;
+    insightsCompletedCount: number;
+}
+export interface StreakRepair {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    userId: string;
+    repairDate_streakType: string;
+    repairDate: string;
+    streakType: string;
+}
+export interface DailyInsightCompleted {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    userId: string;
+    dateInsightCompleted: string;
+}
+//# sourceMappingURL=user-statistics.d.ts.map

package/dist/esm/user-statistics/user-statistics.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-statistics.d.ts","sourceRoot":"","sources":["../../../src/user-statistics/user-statistics.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,UAAU;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,EAAE,MAAM,CAAC;IACV,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,eAAe,EAAE,OAAO,CAAC;IACzB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,qBAAqB;IACrB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,qBAAqB;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE;QACV,EAAE,EAAE,MAAM,CAAC;QACX,OAAO,EAAE,MAAM,CAAC;QAChB,SAAS,EAAE,MAAM,CAAC;KACrB,CAAA;CACJ;AAED,MAAM,WAAW,iBAAiB;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,CAAC,EAAE,MAAM,CAAC;IACV,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAElB,EAAE,EAAE,MAAM,CAAC;IACX,aAAa,EAAE;QACX,MAAM,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,YAAY,EAAE;QAEV,kBAAkB,EAAE,MAAM,CAAC;QAC3B,MAAM,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,cAAc,EAAE;QACZ,MAAM,EAAE,MAAM,CAAC;KAClB,CAAC;IAEF,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAC9B,OAAO,CAAC,EAAE;QACN,kBAAkB,EAAE,MAAM,CAAC;KAC9B,CAAA;CACJ;AAED,MAAM,WAAW,kBAAkB;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,CAAC,EAAE,MAAM,CAAC;IACV,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAElB,EAAE,EAAE,MAAM,CAAC;IACX,sBAAsB,EAAE,MAAM,CAAC;IAC/B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,4CAA4C;IAC5C,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,kBAAkB,EAAE,CAAA;CAClC;AAED,MAAM,WAAW,kBAAkB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,sBAAsB,EAAE,MAAM,CAAC;CAClC;AAED,MAAM,WAAW,YAAY;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,EAAE,MAAM,CAAC;IACV,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,qBAAqB,EAAG,MAAM,CAAC;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,qBAAqB;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,EAAE,MAAM,CAAC;IACV,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,oBAAoB,EAAE,MAAM,CAAC;CAChC"}

package/dist/esm/user-statistics/user-statistics.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=user-statistics.js.map

package/dist/esm/user-statistics/user-statistics.js.map

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uptime.app/contracts",
-  "version": "1.0.41-rc.0",
+  "version": "1.0.41-rc.2",
   "license": "MIT",
   "types": "./dist/esm/index.d.ts",
   "main": "./dist/cjs/index.js",
@@ -13,5 +13,5 @@
   "devDependencies": {
     "typescript": "^5.4.3"
   },
-  "gitHead": "207fe26cc01e83b3178cf64071d8c63557953ebe"
+  "gitHead": "9992f107fa131979b5260e810387f79a824d1cf0"
 }

package/src/history/history-events.ts

@@ -0,0 +1,21 @@
+import { HackProgress } from './history';
+
+export interface HackProgressCreatedEvent {
+    id: string;
+    type: 'HackProgressCreated';
+    payload: HackProgress;
+}
+
+export interface HackProgressUpdatedEvent {
+    id: string;
+    type: 'HackProgressUpdated';
+    payload: HackProgress;
+}
+
+export interface HackProgressDeletedEvent {
+    id: string;
+    type: 'HackProgressDeleted';
+    payload: HackProgress;
+}
+
+export type HackProgressChangedEvent = HackProgressCreatedEvent | HackProgressUpdatedEvent | HackProgressDeletedEvent;

package/src/history/history.ts

@@ -0,0 +1,46 @@
+export interface ResumeStoryPlayer {
+    /** the format the user chose to consume the hack */
+    format: 'story';
+    /** where to resume from in the segment's array of cards */
+    fromCardIndex: number;
+}
+
+export interface ResumeAudioPlayer {
+    /** the format the user chose to consume the hack */
+    format: 'audio';
+    /** the timestamp in seconds that the audio player should resume from */
+    audioPlayerFromTimestamp: number;
+    /** where to resume from in the segment's array of cards */
+    fromCardIndex?: number;
+}
+
+export interface ResumeTextReader {
+    /** the format the user chose to consume the hack */
+    format: 'text';
+    /** the timestamp in seconds that the audio player should resume from
+     *  if the user had audio playing in the background while reading */
+    audioPlayerFromTimestamp?: number;
+    /** where to resume from in the segment's array of cards */
+    fromCardIndex?: number;
+}
+
+export interface HackProgressDTO {
+    /** the hack the user has been viewing */
+    hackId: string;
+    /** the segment to resume from */
+    segmentId: string;
+    /** the ISO 8601 date and time when the user last viewed the hack   */
+    lastViewedAt: string;
+    /** used to render the hack progress bar on the client */
+    percentageComplete: number;
+    /** the format the hack will be resumed in */
+    resume: ResumeStoryPlayer | ResumeAudioPlayer | ResumeTextReader;
+}
+
+export interface HackProgress extends HackProgressDTO {
+    id: string
+    createdAt: string;
+    updatedAt: string;
+    v: number;
+    userId: string;
+}

package/src/index.ts

@@ -60,6 +60,9 @@ export * from './hack-metadata/hack-metadata-events';
 export * from './hack-of-the-day/hack-of-the-day';
 export * from './hack-of-the-day/hack-of-the-day-events';
 
+export * from './history/history';
+export * from './history/history-events';
+
 export * from './knowledge-source/knowledge-source';
 export * from './knowledge-source/knowledge-source-events';
 
@@ -79,6 +82,9 @@ export * from './pending-hack/pending-hack-events';
 export * from './pending-hack/pending-hack-with-voice';
 export * from './pending-hack/pending-hack-with-voice-events';
 
+export * from './preferences/preferences';
+export * from './preferences/preferences-events';
+
 export * from './profile/profile';
 export * from './profile/translated-profile';
 export * from './profile/profile-events';
@@ -123,3 +129,6 @@ export * from './user-context/user-context-events';
 
 export * from './user-notification-context/user-notification-context';
 export * from './user-notification-context/user-notification-context-events';
+
+export * from './user-statistics/user-statistics';
+export * from './user-statistics/user-statistics-events';

package/src/preferences/preferences-events.ts

@@ -0,0 +1,15 @@
+import { Preferences } from './preferences';
+
+export interface UserPreferencesCreatedEvent {
+    id: string;
+    type: 'UserPreferencesCreated';
+    payload: Preferences;
+}
+
+export interface UserPreferencesUpdatedEvent {
+    id: string;
+    type: 'UserPreferencesUpdated';
+    payload: Preferences;
+}
+ 
+export type UserPreferencesChangedEvent = UserPreferencesCreatedEvent | UserPreferencesUpdatedEvent;

package/src/preferences/preferences.ts

@@ -0,0 +1,35 @@
+export type Preferences = PreferencesItem & UpdatablePreferences;
+
+interface PreferencesItem {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    userId: string;
+}
+
+export interface UpdatablePreferences {
+    'flashcards.showFlashcardsFromInsights': boolean;
+    // ISO date, UTC. Required to figure out if to generate flashcards from insights in the flashcard-service: ViewedHack event times are compared against it.
+    'flashcards.showFlashcardsFromInsights.datePreferenceUpdated': string;
+    'notifications.backdrop.email': boolean;
+    'notifications.backdrop.push': boolean;
+    'notifications.challenges.email': boolean;
+    'notifications.challenges.push': boolean;
+    'notifications.generalReminders.email': boolean;
+    'notifications.generalReminders.push': boolean;
+    'notifications.getBackToUptime.email': boolean;
+    'notifications.getBackToUptime.push': boolean;
+    'notifications.getBackToUptime.timeToReceive': string;
+    'notifications.flashcards.newToday.email': boolean;
+    'notifications.flashcards.newToday.push': boolean;
+    'notifications.recommendedContent.email': boolean;
+    'notifications.recommendedContent.push': boolean;
+    'notifications.research.email': boolean;
+    'notifications.research.push': boolean;
+    'notifications.savedHacks.email': boolean;
+    'notifications.savedHacks.push': boolean;
+    'notifications.uptimeNews.email': boolean;
+    'notifications.uptimeNews.push': boolean;
+    'timezone': string;
+}

package/src/user-statistics/user-statistics-events.ts

@@ -0,0 +1,97 @@
+import { DailyInsightCompleted, StreakRepair, UserHackStatistics, UserInsightStreak, ViewedHack } from './user-statistics';
+
+export interface DailyInsightCompletedCreatedEvent {
+    id: string;
+    type: 'DailyInsightCompletedCreated';
+    payload: DailyInsightCompleted;
+}
+
+export interface DailyInsightCompletedUpdatedEvent {
+    id: string;
+    type: 'DailyInsightCompletedUpdated';
+    payload: DailyInsightCompleted;
+}
+
+export interface DailyInsightCompletedDeletedEvent {
+    id: string;
+    type: 'DailyInsightCompletedDeleted';
+    payload: DailyInsightCompleted;
+}
+
+export interface StreakRepairCreatedEvent {
+    id: string;
+    type: 'StreakRepairCreated';
+    payload: StreakRepair;
+}
+
+export interface StreakRepairUpdatedEvent {
+    id: string;
+    type: 'StreakRepairUpdated';
+    payload: StreakRepair;
+}
+
+export interface StreakRepairDeletedEvent {
+    id: string;
+    type: 'StreakRepairDeleted';
+    payload: StreakRepair;
+}
+
+export interface UserHackStatisticsCreatedEvent {
+    id: string;
+    type: 'UserHackStatisticsCreated';
+    payload: UserHackStatistics;
+}
+
+export interface UserHackStatisticsUpdatedEvent {
+    id: string;
+    type: 'UserHackStatisticsUpdated';
+    payload: UserHackStatistics;
+}
+
+export interface UserHackStatisticsDeletedEvent {
+    id: string;
+    type: 'UserHackStatisticsDeleted';
+    payload: UserHackStatistics;
+}
+
+export interface UserInsightStreakCreatedEvent {
+    id: string;
+    type: 'UserInsightStreakCreated';
+    payload: UserInsightStreak;
+}
+
+export interface UserInsightStreakUpdatedEvent {
+    id: string;
+    type: 'UserInsightStreakUpdated';
+    payload: UserInsightStreak;
+}
+
+export interface UserInsightStreakDeletedEvent {
+    id: string;
+    type: 'UserInsightStreakDeleted';
+    payload: UserInsightStreak;
+}
+
+export interface ViewedHackCreatedEvent {
+    id: string;
+    type: 'ViewedHackCreated';
+    payload: ViewedHack;
+}
+
+export interface ViewedHackUpdatedEvent {
+    id: string;
+    type: 'ViewedHackUpdated';
+    payload: ViewedHack;
+}
+
+export interface ViewedHackDeletedEvent {
+    id: string;
+    type: 'ViewedHackDeleted';
+    payload: ViewedHack;
+}
+
+export type DailyInsightCompletedChangedEvent = DailyInsightCompletedCreatedEvent | DailyInsightCompletedUpdatedEvent | DailyInsightCompletedDeletedEvent;
+export type StreakRepairChangedEvent = StreakRepairCreatedEvent | StreakRepairUpdatedEvent | StreakRepairDeletedEvent;
+export type UserHackStatisticsChangedEvent = UserHackStatisticsCreatedEvent | UserHackStatisticsUpdatedEvent | UserHackStatisticsDeletedEvent;
+export type UserInsightStreakChangedEvent = UserInsightStreakCreatedEvent | UserInsightStreakUpdatedEvent | UserInsightStreakDeletedEvent;
+export type ViewedHackChangedEvent = ViewedHackCreatedEvent | ViewedHackUpdatedEvent | ViewedHackDeletedEvent;

package/src/user-statistics/user-statistics.ts

@@ -0,0 +1,83 @@
+export interface ViewedHack {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    userId: string;
+    hackId: string;
+    isHackCompleted: boolean;
+    insightsCompletedCount: number;
+    /** added Aug 2023 */
+    percentageComplete: number;
+    /** added Aug 2023 */
+    lastViewedAt: string;
+    hackProgress: {
+        id: string;
+        version: number;
+        createdAt: string;
+    }
+}
+
+export interface UserInsightStreak {
+    userId: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+
+    id: string; // deterministic from userId
+    longestStreak: {
+        length: number;
+    },
+    latestStreak: {
+        // date with format YYYY-MM-DD
+        latestDayCompleted: string;
+        length: number;
+    },
+    previousStreak: {
+        length: number;
+    },
+    // 30 dates with format YYYY-MM-DD
+    latestDaysCompleted: string[];
+    repairs?: {
+        usedThisMonthCount: number;
+    }
+}
+
+export interface UserHackStatistics {
+    userId: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+
+    id: string; // deterministic from userId
+    insightsCompletedCount: number;
+    hacksCompletedCount: number;
+    /** Time saved in minutes. Added Aug 2023 */
+    totalTimeSaved: number;
+    perTopic?: PerTopicStatistics[]
+}
+
+export interface PerTopicStatistics {
+    name: string;
+    insightsCompletedCount: number;
+}
+
+export interface StreakRepair {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    userId: string;
+    repairDate_streakType : string;
+    repairDate: string;
+    streakType: string;
+}
+
+export interface DailyInsightCompleted {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    userId: string;
+    dateInsightCompleted: string;
+}