@uptime.app/contracts 3.0.54 → 3.0.55

package/src/enriched-hack/enriched-hack-events.ts

@@ -1,21 +0,0 @@
-import { EnrichedHack } from './enriched-hack';
-
-export interface EnrichedHackCreatedEvent {
-    id: string;
-    type: 'EnrichedHackCreated';
-    payload: EnrichedHack;
-}
-
-export interface EnrichedHackUpdatedEvent {
-    id: string;
-    type: 'EnrichedHackUpdated';
-    payload: EnrichedHack;
-}
-
-export interface EnrichedHackDeletedEvent {
-    id: string;
-    type: 'EnrichedHackDeleted';
-    payload: EnrichedHack;
-}
-
-export type EnrichedHackChangedEvent = EnrichedHackCreatedEvent | EnrichedHackUpdatedEvent | EnrichedHackDeletedEvent;

package/src/enriched-hack/enriched-hack.ts

@@ -1,109 +0,0 @@
-import { HackAffiliate, HackContributor, HackExternalLink, HackSourceData, HackTopic, HackType } from '../hack/hack';
-import { KnowledgeSource } from '../knowledge-source/knowledge-source';
-import { Profile, ProfileMetadata } from '../profile/profile';
-import { Theme } from '../theme/theme';
-import { HackWithVoice } from '../hack/hack-with-voice';
-import { ExtractedSubject } from '../hack/extracted-subject';
-import { SegmentType, SegmentAction, SegmentSpeech, SegmentSection, SegmentTextCard } from '../segment/segment';
-
-export interface EnrichedHack {
-    /** The hack id */
-    id: string;
-    /** The hack language e.g. 'fr' if it is French */
-    language: string;
-    /** The locale (language and region) of the hack e.g. fr-FR. Use @uptime.app/localisation-contracts */
-    locale: string;
-    /** The id of the hack in its original locale. */
-    baseLocaleHackId: string;
-    v: number;
-    hackVersion: number;
-    createdAt: string;
-    updatedAt: string;
-
-    /** introduced Oct 2023 **/
-    draftHackId: string;
-    draftHackVersion: number;
-
-    //@todo: Deprecate
-    source?: KnowledgeSource;
-    owner: string;
-    tenant?: string;
-    acl: string[];
-    theme: Theme;
-    title: string;
-    isHidden?: boolean;
-    editorialTags?: string[];
-    coverUrl?: string;
-    /** Added in July 2024. This is the URL of the cover image that is free to use without any copyright. */
-    copyrightFreeCoverUrl?: string;
-    notifications?: EnrichedHackNotifications;
-    /* currently contains the inANutshell segment markdown */
-    description: string;
-    // ...
-
-    segments: HackWithVoice['segments']; // Use the 'HackWithVoice' type
-    affiliate?: HackAffiliate;
-    topics: HackTopic[];
-    contributors?: HackContributor[];
-    type: HackType;
-    sourceData?: HackSourceData;
-    externalLink?: HackExternalLink;
-    profile: EnrichHackProfile;
-
-    /** added April 2024 */
-    // TODO make it mandatory after a republish
-    subjects?: EnrichedHackSubjects;
-
-    // distribution
-    includeInEmailNotifications: boolean;
-    includeInPushNotifications: boolean;
-    includeInRecommendations: boolean;
-    includeInSearchResults: boolean;
-    includeInTrending: boolean;
-    includeInHackOfTheDay: boolean;
-    includeInWebsite: boolean;
-
-    /**
-     * Time saved in minutes by consuming the hack rather than the underlying knowledge source.
-     * calculated using the knowledge source page count / duration
-     * */
-    timeSaved?: number;
-    /**
-     * An estimation of the time saved in minutes when no reliable information is available on the knowledge source.
-     */
-    estimatedTimeSaved?: number;
-
-    /**
-     * Tenant display name, from the display name of its b2b-organisation, if any
-     */
-    tenantDisplayName?: string;
-}
-
-export interface EnrichedHackNotifications {
-    aiGeneratedText?: string;
-    humanCuratedText?: string;
-}
-
-export interface EnrichedHackSubjects {
-    aiGenerated: ExtractedSubject[];
-    humanCurated?: ExtractedSubject[];
-}
-
-export interface EnrichedHackSegment {
-    id: string;
-    createdAt: string;
-    updatedAt: string;
-    title: string;
-    type: SegmentType;
-    keywords: string[];
-    actions: SegmentAction[];
-    speech: SegmentSpeech[];
-    sections: SegmentSection[];
-    storyMode?: {
-        cards: SegmentTextCard[];
-        speech: SegmentSpeech[];
-    },
-    textSummary?: string;
-}
-
-export type EnrichHackProfile = Profile | ProfileMetadata;

package/src/enrichment-asset/hack-enrichment-video-events.ts

@@ -1,55 +0,0 @@
-import { HackEnrichmentVideo, PendingHackEnrichmentVideo } from './hack-enrichment-video';
-
-export interface HackEnrichmentVideoCreatedEvent {
-    id: string;
-    type: 'HackEnrichmentVideoCreated';
-    payload: HackEnrichmentVideo;
-}
-
-export interface HackEnrichmentVideoUpdatedEvent {
-    id: string;
-    type: 'HackEnrichmentVideoUpdated';
-    payload: HackEnrichmentVideo;
-}
-
-export interface HackEnrichmentVideoDeletedEvent {
-    id: string;
-    type: 'HackEnrichmentVideoDeleted';
-    payload: HackEnrichmentVideo;
-}
-
-export interface PendingHackEnrichmentVideoCreatedEvent {
-    id: string;
-    type: 'PendingHackEnrichmentVideoCreated';
-    payload: PendingHackEnrichmentVideo;
-}
-
-export interface PendingHackEnrichmentVideoUpdatedEvent {
-    id: string;
-    type: 'PendingHackEnrichmentVideoUpdated';
-    payload: PendingHackEnrichmentVideo;
-}
-
-export interface PendingHackEnrichmentVideoDeletedEvent {
-    id: string;
-    type: 'PendingHackEnrichmentVideoDeleted';
-    payload: PendingHackEnrichmentVideo;
-}
-
-export type HackEnrichmentVideoChangedEvent = HackEnrichmentVideoCreatedEvent | HackEnrichmentVideoUpdatedEvent | HackEnrichmentVideoDeletedEvent;
-export type PendingHackEnrichmentVideoChangedEvent = PendingHackEnrichmentVideoCreatedEvent | PendingHackEnrichmentVideoUpdatedEvent | PendingHackEnrichmentVideoDeletedEvent;
-
-export interface CreateHackEnrichmentVideoCommandBody {
-    // a command needs an id and a version so that it can be more easily replayed
-    // for this specific command, the id is the youTubeUrl and the version is a timestamp
-    id: string;
-    v: number;
-    youTubeUrl: string;
-    hackId: string;
-}
-
-export interface CreateHackEnrichmentVideoCommand {
-    id: string;
-    type: 'CreateHackEnrichmentVideoCommand';
-    payload: CreateHackEnrichmentVideoCommandBody;
-}

package/src/enrichment-asset/hack-enrichment-video.ts

@@ -1,40 +0,0 @@
-import { VideoMetadata } from '..';
-
-export interface HackEnrichmentVideo {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    youTubeUrl: string;
-    hackId: string;
-
-    youTubeVideoId: string;
-    startAtSeconds: number;
-    endAtSeconds: number;
-
-    s3Path: string;
-    videoMetadata: VideoMetadata;
-
-    // Set to true when the original hack still includes the URL of this video, and false when the URL is removed from the hack
-    referencedByHack: boolean;
-}
-
-export interface PendingHackEnrichmentVideo {
-    // not used as a key in the dynamo table
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-
-    // hash and range keys
-    youTubeUrl: string;
-    hackId: string;
-
-    hackEnrichmentVideoId: string;
-
-    status: PendingHackEnrichmentVideoStatus;
-    error?: string;
-}
-
-// on success, the pending entity is deleted
-export type PendingHackEnrichmentVideoStatus = 'processing' | 'failed';

package/src/entitlement/user-entitlements-commands.ts

@@ -1,54 +0,0 @@
-import { Entitlement, EntitlementName } from './user-entitlements';
-
-export interface IssueUserEntitlementCommand {
-    id: string;
-    type: 'IssueUserEntitlement',
-    payload: IssueUserEntitlementCommandPayload
-}
-
-export interface IssueUserEntitlementCommandPayload extends Entitlement {
-    id: string;
-    v: number;
-    userId: string;
-}
-
-export interface RemoveUserEntitlementCommand {
-    id: string;
-    type: 'RemoveUserEntitlement',
-    payload: RemoveUserEntitlementCommandPayload
-}
-
-export interface RemoveUserEntitlementCommandPayload {
-    issuer: string;
-    entitlement: EntitlementName | string;
-    userId: string;
-}
-
-export interface RefreshRevenueCatUserStatusCommand {
-    id: string;
-    type: 'RefreshRevenueCatUserStatus',
-    payload: {
-        userId: string;
-    };
-}
-
-/**
- * Ensure the user has the provided entitlements from the given issuer.
- * Will remove any existing entitlements from the issuer that are not specified in the command
- */
-export interface SetUserEntitlementsFromIssuerCommand {
-    id: string;
-    type: 'SetUserEntitlementsFromIssuer',
-    payload: {
-        id: string;
-        v: number,
-        issuer: string;
-        userId: string
-        entitlements: {
-            entitlement: EntitlementName | string;
-            /** leave a undefined to never expire */
-            expiresAt?: string
-            issuedAt: string;
-        }[]
-    }
-}

package/src/entitlement/user-entitlements-events.ts

@@ -1,29 +0,0 @@
-import { UserEntitlements } from './user-entitlements';
-
-export interface UserEntitlementsCreatedEvent {
-    id: string;
-    type: 'UserEntitlementsCreated';
-    payload: UserEntitlements;
-}
-
-export interface UserEntitlementsUpdatedEvent {
-    id: string;
-    type: 'UserEntitlementsUpdated';
-    payload: UserEntitlements;
-}
-
-export interface UserEntitlementsDeletedEvent {
-    id: string;
-    type: 'UserEntitlementsDeleted';
-    payload: UserEntitlements;
-}
-
-export type UserEntitlementsChangedEvent = UserEntitlementsCreatedEvent | UserEntitlementsUpdatedEvent | UserEntitlementsDeletedEvent;
-
-export interface RevenueCatWebhookReceivedEvent {
-    id: string;
-    type: 'RevenueCatWebhookReceived',
-    payload: {
-        event: any;
-    };
-}

package/src/entitlement/user-entitlements.ts

@@ -1,18 +0,0 @@
-export type EntitlementName = 'premium' | 'trial';
-export type EntitlementIssuer = 'Uptime' | 'RevenueCat';
-
-export type Entitlement = {
-    entitlement: EntitlementName | string;
-    issuer: EntitlementIssuer | string;
-    expiresAt: string
-    issuedAt: string;
-};
-
-export interface UserEntitlements {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    userId: string;
-    entitlements: Entitlement[];
-}

package/src/flashcard/flashcard-events.ts

@@ -1,85 +0,0 @@
-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 +0,0 @@
-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 +0,0 @@
-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 +0,0 @@
-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 +0,0 @@
-/**
- * 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 +0,0 @@
-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;

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

@@ -1,36 +0,0 @@
-import { Segment } from '../segment/segment';
-
-/**
- * HackWithVoice contains the Hack segments a a few basic Hack fields, it does not contain other Hack information.
- * This decision was made due to the complexity of editorialTags and updating them.
- */
-export interface HackWithVoice {
-    /** NOT the id of the hack. Use hackId. The id cannot be the hackId as otherwise id would be duplicated for each voice which would break message replay */
-    id: string;
-    /** The id of the hack */
-    hackId: string;
-    baseLocaleHackId: string;
-    /** The id of voice used to generate the audio */
-    voiceId: string;
-    /** True if this is the default voice */
-    isDefaultVoice: boolean;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-
-    /** introduced Aug 2025. Will be on all hacks republished since then **/
-    publishCompletedAt?: string;
-
-    segments: {
-        favouriteQuote: Segment;
-        inANutshell: Segment;
-        introduction: Segment;
-        insights: Segment[];
-        conclusion: Segment;
-        // composite segments
-        overview: Segment;
-        shareableOverview: Segment;
-        hereAreTheInsights: Segment;
-        putInAction?: Segment;
-    }
-}