@uptime.app/contracts 2.0.7-rc.1 → 2.0.7

package/src/flashcard/flashcard-events.ts

@@ -1,85 +1,85 @@
-import { Flashcard } from './flashcard';
-
-export interface FlashcardCreatedEvent {
-    id: string;
-    type: 'FlashcardCreated';
-    payload: Flashcard;
-}
-
-export interface FlashcardUpdatedEvent {
-    id: string;
-    type: 'FlashcardUpdated';
-    payload: Flashcard;
-}
-
-export interface FlashcardDeletedEvent {
-    id: string;
-    type: 'FlashcardDeleted';
-    payload: Flashcard;
-}
-
-export type FlashcardChangedEvent = FlashcardCreatedEvent | FlashcardUpdatedEvent | FlashcardDeletedEvent;
-
-export interface FlashcardRestored {
-    // needs id and v so that it can be replayed
-    // id is flashcard id
-    id: string;
-    // v is timestamp
-    v: number;
-    userId: string;
-    cardId: string;
-}
-
-export interface FlashcardRestoredEvent {
-    id: string;
-    type: 'FlashcardRestored';
-    payload: FlashcardRestored;
-}
-
-export interface FlashcardPromoted {
-    // needs id and v so that it can be replayed
-    // id is flashcard id
-    id: string;
-    // v is timestamp
-    v: number;
-    userId: string;
-    cardId: string;
-}
-
-export interface FlashcardPromotedEvent {
-    id: string;
-    type: 'FlashcardPromoted';
-    payload: FlashcardPromoted;
-}
-
-export interface FlashcardDismissed {
-    // needs id and v so that it can be replayed
-    // id is flashcard id
-    id: string;
-    // v is timestamp
-    v: number;
-    userId: string;
-    cardId: string;
-}
-
-export interface FlashcardDismissedEvent {
-    id: string
-    type: 'FlashcardDismissed';
-    payload: FlashcardDismissed;
-}
-
-export interface FlashcardDemoted {
-    // needs id and v so that it can be replayed
-    // id is flashcard id
-    id: string;
-    // v is timestamp
-    v: number;
-    userId: string;
-    cardId: string;
-}
-
-export interface FlashcardDemotedEvent {
-    id: string;
-    type: 'FlashcardDemoted';
-    payload: FlashcardDemoted;
-}
+import { Flashcard } from './flashcard';
+
+export interface FlashcardCreatedEvent {
+    id: string;
+    type: 'FlashcardCreated';
+    payload: Flashcard;
+}
+
+export interface FlashcardUpdatedEvent {
+    id: string;
+    type: 'FlashcardUpdated';
+    payload: Flashcard;
+}
+
+export interface FlashcardDeletedEvent {
+    id: string;
+    type: 'FlashcardDeleted';
+    payload: Flashcard;
+}
+
+export type FlashcardChangedEvent = FlashcardCreatedEvent | FlashcardUpdatedEvent | FlashcardDeletedEvent;
+
+export interface FlashcardRestored {
+    // needs id and v so that it can be replayed
+    // id is flashcard id
+    id: string;
+    // v is timestamp
+    v: number;
+    userId: string;
+    cardId: string;
+}
+
+export interface FlashcardRestoredEvent {
+    id: string;
+    type: 'FlashcardRestored';
+    payload: FlashcardRestored;
+}
+
+export interface FlashcardPromoted {
+    // needs id and v so that it can be replayed
+    // id is flashcard id
+    id: string;
+    // v is timestamp
+    v: number;
+    userId: string;
+    cardId: string;
+}
+
+export interface FlashcardPromotedEvent {
+    id: string;
+    type: 'FlashcardPromoted';
+    payload: FlashcardPromoted;
+}
+
+export interface FlashcardDismissed {
+    // needs id and v so that it can be replayed
+    // id is flashcard id
+    id: string;
+    // v is timestamp
+    v: number;
+    userId: string;
+    cardId: string;
+}
+
+export interface FlashcardDismissedEvent {
+    id: string
+    type: 'FlashcardDismissed';
+    payload: FlashcardDismissed;
+}
+
+export interface FlashcardDemoted {
+    // needs id and v so that it can be replayed
+    // id is flashcard id
+    id: string;
+    // v is timestamp
+    v: number;
+    userId: string;
+    cardId: string;
+}
+
+export interface FlashcardDemotedEvent {
+    id: string;
+    type: 'FlashcardDemoted';
+    payload: FlashcardDemoted;
+}

package/src/flashcard/flashcard.ts

@@ -1,138 +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;
-}
+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/hack/extracted-subject.ts

@@ -1,31 +1,31 @@
-export interface ExtractedSubject {
-    name: string;
-}
-
-export interface ExtractSubjectsCommandBody {
-    id: string;
-    v: number;
-    reference: string;
-    content: string;
-    contentType: string; // e.g. 'hack'
-}
-
-export interface ExtractSubjectsCommand {
-    id: string;
-    type: 'ExtractSubjectsCommand';
-    payload: ExtractSubjectsCommandBody;
-}
-
-export interface SubjectsExtracted {
-    id: string;
-    type: 'SubjectsExtracted',
-    payload: SubjectsExtractedBody
-}
-
-export interface SubjectsExtractedBody {
-    id: string,
-    v: number,
-    reference: string,
-    contentType: string;
-    subjects: ExtractedSubject[]
-}
+export interface ExtractedSubject {
+    name: string;
+}
+
+export interface ExtractSubjectsCommandBody {
+    id: string;
+    v: number;
+    reference: string;
+    content: string;
+    contentType: string; // e.g. 'hack'
+}
+
+export interface ExtractSubjectsCommand {
+    id: string;
+    type: 'ExtractSubjectsCommand';
+    payload: ExtractSubjectsCommandBody;
+}
+
+export interface SubjectsExtracted {
+    id: string;
+    type: 'SubjectsExtracted',
+    payload: SubjectsExtractedBody
+}
+
+export interface SubjectsExtractedBody {
+    id: string,
+    v: number,
+    reference: string,
+    contentType: string;
+    subjects: ExtractedSubject[]
+}

package/src/hack/hack-events.ts

@@ -1,21 +1,21 @@
-import { Hack } from './hack';
-
-export interface HackCreatedEvent {
-    id: string;
-    type: 'HackCreated';
-    payload: Hack;
-}
-
-export interface HackUpdatedEvent {
-    id: string;
-    type: 'HackUpdated';
-    payload: Hack;
-}
-
-export interface HackDeletedEvent {
-    id: string;
-    type: 'HackDeleted';
-    payload: Hack;
-}
-
-export type HackChangedEvent = HackCreatedEvent | HackUpdatedEvent | HackDeletedEvent;
+import { Hack } from './hack';
+
+export interface HackCreatedEvent {
+    id: string;
+    type: 'HackCreated';
+    payload: Hack;
+}
+
+export interface HackUpdatedEvent {
+    id: string;
+    type: 'HackUpdated';
+    payload: Hack;
+}
+
+export interface HackDeletedEvent {
+    id: string;
+    type: 'HackDeleted';
+    payload: Hack;
+}
+
+export type HackChangedEvent = HackCreatedEvent | HackUpdatedEvent | HackDeletedEvent;

package/src/hack/hack-published.ts

@@ -1,21 +1,21 @@
-/**
- * HackPublished events were introduce in March 2023 and have not been backfilled. Previously PendingHackDeleted events were used.
- */
-export interface HackPublishedEvent {
-    id: string;
-    type: 'HackPublished';
-    payload: {
-        /** set as the hack id */
-        id: string;
-        /** set as the hack version */
-        v: number;
-        draftHackId: string;
-        draftHackVersion: number;
-        hackId: string;
-        hackVersion: number;
-        baseLocaleHackId: string;
-        // added very shortly after the event was introduced so a handful of historic events may be missing this property
-        publishCompletedAt: string
-        publishStartedAt: string;
-    }
-}
+/**
+ * HackPublished events were introduce in March 2023 and have not been backfilled. Previously PendingHackDeleted events were used.
+ */
+export interface HackPublishedEvent {
+    id: string;
+    type: 'HackPublished';
+    payload: {
+        /** set as the hack id */
+        id: string;
+        /** set as the hack version */
+        v: number;
+        draftHackId: string;
+        draftHackVersion: number;
+        hackId: string;
+        hackVersion: number;
+        baseLocaleHackId: string;
+        // added very shortly after the event was introduced so a handful of historic events may be missing this property
+        publishCompletedAt: string
+        publishStartedAt: string;
+    }
+}

package/src/hack/hack-with-voice-events.ts

@@ -1,21 +1,21 @@
-import { HackWithVoice } from './hack-with-voice';
-
-export interface HackWithVoiceCreatedEvent {
-    id: string;
-    type: 'HackWithVoiceCreated';
-    payload: HackWithVoice;
-}
-
-export interface HackWithVoiceUpdatedEvent {
-    id: string;
-    type: 'HackWithVoiceUpdated';
-    payload: HackWithVoice;
-}
-
-export interface HackWithVoiceDeletedEvent {
-    id: string;
-    type: 'HackWithVoiceDeleted';
-    payload: HackWithVoice;
-}
-
+import { HackWithVoice } from './hack-with-voice';
+
+export interface HackWithVoiceCreatedEvent {
+    id: string;
+    type: 'HackWithVoiceCreated';
+    payload: HackWithVoice;
+}
+
+export interface HackWithVoiceUpdatedEvent {
+    id: string;
+    type: 'HackWithVoiceUpdated';
+    payload: HackWithVoice;
+}
+
+export interface HackWithVoiceDeletedEvent {
+    id: string;
+    type: 'HackWithVoiceDeleted';
+    payload: HackWithVoice;
+}
+
 export type HackWithVoiceChangedEvent = HackWithVoiceCreatedEvent | HackWithVoiceUpdatedEvent | HackWithVoiceDeletedEvent;