@uptime.app/contracts 1.0.41-rc.1 → 1.0.41-rc.3

package/src/flashcard/flashcard.ts

@@ -0,0 +1,138 @@
+import { CardType, Hack, SegmentType, SupportedLocale, Theme } from '../index';
+
+export interface Flashcard {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    userId: string;
+    hackId: string;
+    segmentId: string;
+    themeId: string;
+
+    // also shows up in the "card", but easier to create GSI from top level property
+    cardId: string;
+    card: FlashedTextCard;
+
+    /*
+    A flashcard can have multiple reasons for its existence
+    when all reasons go away (when spark is deleted and hack is made unavailable), the Flashcard is deleted
+    */
+    reasonCreated: FlashcardCreationReason[];
+
+    /*
+    true when the user dismisses it
+    */
+    isDismissed: boolean;
+
+    /*
+    Flashcards from sparks are considered more important than flashcards from consumed content and should be displayed first
+    */
+    relevanceScore: number;
+
+    /*
+    Flashcards start at level 0 and are promoted to level 1+, or demoted back to level 0
+    */
+    level: number;
+
+    /*
+    After a flashcard is demoted, flash cycle count increases
+    */
+    flashCycle: number;
+
+    /*
+    How many times a user has seen this flashcard
+    */
+    timesFlashed: number;
+
+    memorisationConfidence?: FlashcardMemorisationConfidence;
+
+    /*
+    ISO date in UTC which indicates when to flash this card to the user next.
+    When flashcard is dismissed, "nextDateToFlash" becomes "never"
+    */
+    nextDateToFlash: string;
+
+    /*
+    Indicates whether the referenced hack is "available" (not hidden or deleted)
+    */
+    hackIsAvailable: boolean;
+
+    /*
+    Indicates whether the user has memorised the flashcard. It's considered memorised when its level >= 8
+     */
+    isMemorised: boolean;
+
+    /*
+    A hack with an enriched theme, so that the flashcard can be displayed when the hack becomes unavailable. This structure is consistent with Sparks.
+    */
+    hack: Hack;
+
+    /*
+    A hack's ACL. The Hack model doesn't have an ACL, this is from the equivalent enriched hack.
+    */
+    hackAcl: string[];
+
+    /*
+    A snapshot of the hack theme at the time the flashcard was created. This is consistent with Sparks also having a snapshot of the theme.
+    */
+    theme: Theme;
+
+    /*
+    The hackId for the hack in its base locale. Consistent with the Spark model.
+    */
+    baseLocaleHackId: string;
+
+    /*
+    The locale of the hack at the time this flashcard was created. Consistent with the Spark model.
+    */
+    locale: SupportedLocale;
+
+    /*
+    The language of the hack at the time this flashcard was created. Consistent with the Spark model.
+    */
+    language: string;
+}
+
+export interface FlashedTextCard {
+    id: string;
+    markdown: string;
+    segmentType: SegmentType;
+    isTitle?: boolean;
+    cardType?: CardType;
+    keyPhrases: KeyPhrase[];
+}
+
+export type FlashcardCreationReason = FlashcardCreationSparkReason | FlashcardCreationInsightConsumedReason;
+
+export interface FlashcardCreationSparkReason {
+    type: FlashcardCreationReasonType.SparkCreated;
+    sparkId: string;
+    // ISO date
+    dateSparkCreated: string;
+}
+
+export interface FlashcardCreationInsightConsumedReason {
+    type: FlashcardCreationReasonType.InsightConsumed;
+    // this helps figure out if the insight was already turned into a flashcard. Using the cardId is insufficient because the cardId can change if the markdown of the hack changes.
+    // supported insight numbers: 1, 2, 3
+    insightNumber: number;
+    // ISO date
+    dateHackLastViewed: string;
+}
+
+export enum FlashcardCreationReasonType {
+    SparkCreated = 'SparkCreated',
+    InsightConsumed = 'InsightConsumed'
+}
+
+export enum FlashcardMemorisationConfidence {
+    Green = 'Green',
+    Amber = 'Amber',
+    Red = 'Red'
+}
+
+export interface KeyPhrase {
+    phrase: string;
+    score: number;
+}

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

@@ -46,6 +46,9 @@ export * from './entitlement/user-entitlements';
 export * from './entitlement/user-entitlements-events';
 export * from './entitlement/user-entitlements-commands';
 
+export * from './flashcard/flashcard';
+export * from './flashcard/flashcard-events';
+
 export * from './hack/extracted-subject';
 export * from './hack/hack-events';
 export * from './hack/hack-published';
@@ -60,6 +63,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';
 
@@ -126,3 +132,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/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,82 @@
+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;
+    id: string; // deterministic from userId
+    createdAt: string;
+    updatedAt: string;
+    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;
+}