@uptime.app/contracts 3.0.54-rc.2 → 3.0.54-rc.3

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;
-    }
-}

package/src/hack/hack.ts

@@ -1,127 +0,0 @@
-import { ExtractedSubject } from './extracted-subject';
-export interface Hack {
-    /** The unique id of the hack. */
-    id: string;
-    /** The locale (language and region) of the hack e.g. fr-FR. Use @uptime.app/localisation-contracts Mandatory property since 12/01/2023. */
-    locale: string;
-    /** The id of the hack in its original locale. Mandatory property since 12/01/2023. */
-    baseLocaleHackId: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    owner: string;
-    tenant?: string;
-    sourceId?: string;
-    title: string;
-    themeId: string;
-
-    /** introduced Aug 2025. Will be on all hacks republished since then **/
-    publishCompletedAt?: string;
-
-    /** introduced Oct 2023 **/
-    draftHackId: string;
-    draftHackVersion: number;
-
-    // TODO I'd remove it altogether, but it would be a breaking contract change. Thoughts?
-    isHidden?: boolean;
-
-    editorialTags?: string[];
-
-    /** Added in October 2025. Internal use only.
-     * It surfaces the "trending" tag from editorialTags if it exists.
-     * It's a number, 1 meaning true, because DynamoDB does not allow Boolean attributes in indexes.
-    */
-    _isTrending?: number;
-
-    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?: {
-        aiGeneratedText?: string
-        humanCuratedText?: string;
-    },
-    segments: {
-        favouriteQuote: {
-            id: string;
-            /** added 04/2023 */
-            v?: number;
-        };
-        inANutshell: {
-            id: string;
-            /** added 04/2023 */
-            v?: number;
-        };
-        introduction: {
-            id: string;
-            /** added 04/2023 */
-            v?: number;
-        };
-        insights: {
-            id: string
-            /** added 04/2023 */
-            v?: number;
-        }[];
-        conclusion: {
-            id: string;
-            /** added 04/2023 */
-            v?: number;
-        };
-
-        // composite segments
-        overview: {
-            id: string;
-            /** added 04/2023 */
-            v?: number;
-        };
-        shareableOverview: {
-            id: string;
-            /** added 04/2023 */
-            v?: number;
-        };
-        hereAreTheInsights: {
-            id: string;
-            /** added 04/2023 */
-            v?: number;
-        };
-        putInAction?: {
-            id: string;
-            /** added 04/2023 */
-            v?: number;
-        };
-    };
-    affiliate?: HackAffiliate;
-    topics: HackTopic[];
-    contributors?: HackContributor[];
-    type: HackType;
-    sourceData?: HackSourceData;
-    externalLink?: HackExternalLink;
-
-    /** added Mar 2024 */
-    // TODO make it mandatory after a republish
-    subjects?: ExtractedSubject[];
-}
-
-export interface HackContributor {
-    name: string;
-}
-
-export interface HackTopic {
-    name: string;
-}
-
-export interface HackAffiliate {
-    url: string;
-    name: string;
-}
-
-export type HackType = 'book' | 'course' | 'documentary' | 'podcast' | 'original';
-
-export interface HackSourceData {
-    episodeTitle?: string;
-    releaseDate?: string;
-}
-
-export interface HackExternalLink {
-    url: string;
-    type: 'Website' | 'Book' | 'Course' | 'Podcast' | 'Video' | 'Other';
-}

package/src/hack/publish-hack-command.ts

@@ -1,20 +0,0 @@
-export interface PublishHackCommandBody {
-    // a command needs an id and a version so that it can be more easily replayed
-    // for this specific PublishHack command, the id is the draftHackId and the version is the timestamp
-    id: string;
-    v: number;
-    draftHackId: string;
-    draftHackVersion: number;
-    hackId: string;
-    publishSource: PublishHackSource;
-    /** if no voice ids are specified then all voices are generated */
-    voiceIds?: string[];
-}
-
-export type PublishHackSource = 'web-app' | 'cms' | 'script' | 'translation';
-
-export interface PublishHackCommand {
-    id: string;
-    type: 'PublishHackCommand';
-    payload: PublishHackCommandBody;
-}

package/src/hack/republish-hack-command.ts

@@ -1,20 +0,0 @@
-import { PublishHackSource } from './publish-hack-command';
-
-/**
- * Republishes a hack. If the hack has never been published then the command will fail.
- * Will republish the current draft version and use the current hacks voices. Will not use new voices
- */
-export interface RepublishHackCommandBody {
-    id: string;
-    v: number;
-    hackId: string;
-    publishSource: PublishHackSource;
-    /** will skip the republished if the hack as been published since this date. ISO date format */
-    skipIfPublishedSince?: string;
-}
-
-export interface RepublishHackCommand {
-    id: string;
-    type: 'RepublishHack';
-    payload: RepublishHackCommandBody;
-}

package/src/hack-mapping/access-helper.ts

@@ -1,6 +0,0 @@
-export function hackIsInUptimeCatalogue({acl}: {acl: string[]}): boolean {
-    if (!acl) {
-        return false;
-    }
-    return acl.includes('catalogue:uptime');
-}

package/src/hack-mapping/app-full-hack.test.ts

@@ -1,13 +0,0 @@
-import { EnrichedHack } from '@uptime.app/contracts';
-import ENRICHED_HACK from './test-data/enriched-hack.json';
-import EXPECTED_APP_FULL_HACK from './test-data/expected-app-full-hack.json';
-import { mapToAppFullHack } from './app-full-hack';
-
-describe('converting an EnrichedHack to an AppFullHack', () => {
-
-    test('it returns the expected fields', () => {
-        const fullHackData = ENRICHED_HACK as any as EnrichedHack;
-        const fullHack = mapToAppFullHack(fullHackData);
-        expect(fullHack).toEqual(EXPECTED_APP_FULL_HACK);
-    });
-});

package/src/hack-mapping/app-full-hack.ts

@@ -1,14 +0,0 @@
-import { AppFullHack } from '../app-hack/app-full-hack';
-import { EnrichedHack } from '../enriched-hack/enriched-hack';
-import { mapToAppRestrictedHack } from './app-restricted-hack';
-import { removeUndefinedFields } from './remove-undefined-fields';
-
-export function mapToAppFullHack(hack: EnrichedHack): AppFullHack {
-    const appHack = mapToAppRestrictedHack(hack);
-    // allow access to all segments
-    const segments = removeUndefinedFields(hack.segments);
-    return removeUndefinedFields({
-        ...appHack,
-        segments
-    });
-}

package/src/hack-mapping/app-hack-metadata.test.ts

@@ -1,22 +0,0 @@
-import { EnrichedHack } from '@uptime.app/contracts';
-import ENRICHED_HACK from './test-data/enriched-hack.json';
-import EXPECTED_APP_HACK_METADATA from './test-data/expected-app-hack-metadata.json';
-import { mapToAppHackMetadata } from './app-hack-metadata';
-describe('converting an EnrichedHack to an AppHackMetadata', () => {
-
-    test('it returns the expected fields', () => {
-        const appHackMetadataData = ENRICHED_HACK as any as EnrichedHack;
-        const appHackMetadata = mapToAppHackMetadata(appHackMetadataData);
-        expect(appHackMetadata).toEqual(EXPECTED_APP_HACK_METADATA);
-    });
-
-    test('a hack not in the uptime catalogue has shareScope set to private', () => {
-        const appHackMetadata = mapToAppHackMetadata({...ENRICHED_HACK, acl: ['catalogue:not-uptime']} as EnrichedHack);
-        expect(appHackMetadata.shareScope).toBe('private');
-    });
-
-    test('a hack not included on the website has shareScope set to private', () => {
-        const appHackMetadata = mapToAppHackMetadata({...ENRICHED_HACK, includeInWebsite: false} as EnrichedHack);
-        expect(appHackMetadata.shareScope).toBe('private');
-    });
-});

package/src/hack-mapping/app-hack-metadata.ts

@@ -1,82 +0,0 @@
-import { removeUndefinedFields } from './remove-undefined-fields';
-import { hackIsInUptimeCatalogue } from './access-helper';
-import { EnrichedHack } from '../enriched-hack/enriched-hack';
-import { AppHackMetadata } from '../app-hack/app-hack-metadata';
-
-export function mapToAppHackMetadata(hack: EnrichedHack): AppHackMetadata {
-    // This function purposely picks the required fields from the EnrichedHack rather than deleting the unnecessary fields from EnrichedHack
-    // This ensures that if the EnrichedHack model is updated then those extra fields are not returned accidentally.
-    // This means that a service will not reflect any updated fields until it updates this module
-    return removeUndefinedFields({
-        id: hack.id,
-        title: hack.title,
-        owner: hack.owner,
-        v: hack.v,
-        hackVersion: hack.hackVersion,
-        createdAt: hack.createdAt,
-        updatedAt: hack.updatedAt,
-        baseLocaleHackId: hack.baseLocaleHackId,
-        language: hack.language,
-        locale: hack.locale,
-        acl: hack.acl,
-        themeId: hack.theme.id,
-        isHidden: hack.isHidden,
-        editorialTags: hack.editorialTags,
-        coverUrl: hack.coverUrl,
-        description: hack.description,
-        segments: toHackAppMetadataSegments(hack.segments),
-        topics: hack.topics,
-        contributors: hack.contributors,
-        type: hack.type,
-        sourceData: hack.sourceData,
-        // todo - should we pick the required fields from profile rather than the entire object?
-        profile: hack.profile,
-        timeSaved: hack.timeSaved,
-        estimatedTimeSaved: hack.estimatedTimeSaved,
-        shareScope: getShareScope(hack),
-        catalogues: aclToCatalogues(hack.acl),
-        tenantDisplayName: hack.tenantDisplayName
-    });
-}
-
-function toHackAppMetadataSegments(segments: EnrichedHack['segments']): AppHackMetadata['segments'] {
-    return removeUndefinedFields({
-        favouriteQuote: {
-            id: segments.favouriteQuote.id,
-        },
-        inANutshell: {
-            id: segments.inANutshell.id,
-        },
-        introduction: {
-            id: segments.introduction.id,
-        },
-        insights: segments.insights.map(insight => ({
-            id: insight.id,
-        })),
-        conclusion: {
-            id: segments.conclusion.id,
-        },
-        overview: {
-            id: segments.overview.id,
-        },
-        shareableOverview: {
-            id: segments.shareableOverview.id,
-        },
-        hereAreTheInsights: {
-            id: segments.hereAreTheInsights.id,
-        },
-        putInAction: segments.putInAction && {
-            id: segments.putInAction.id,
-        },
-    });
-}
-
-function getShareScope(hack: {acl: string[]; includeInWebsite: boolean}): 'public' | 'private' {
-    return (hack.includeInWebsite && hackIsInUptimeCatalogue(hack)) ? 'public' : 'private';
-}
-
-function aclToCatalogues(acl: string[]): string[] {
-    return acl
-        .filter(entry => entry.startsWith('catalogue:'))
-        .map(entry => entry.replace('catalogue:', ''));
-}