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

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

@@ -1,21 +0,0 @@
-import { PendingHack } from './pending-hack';
-
-export interface PendingHackCreatedEvent {
-    id: string;
-    type: 'PendingHackCreated';
-    payload: PendingHack;
-}
-
-export interface PendingHackUpdatedEvent {
-    id: string;
-    type: 'PendingHackUpdated';
-    payload: PendingHack;
-}
-
-export interface PendingHackDeletedEvent {
-    id: string;
-    type: 'PendingHackDeleted';
-    payload: PendingHack;
-}
-
-export type PendingHackChangedEvent = PendingHackCreatedEvent | PendingHackUpdatedEvent | PendingHackDeletedEvent;

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

@@ -1,21 +0,0 @@
-import { PendingHackWithVoice } from './pending-hack-with-voice';
-
-export interface PendingHackWithVoiceCreatedEvent {
-    id: string;
-    type: 'PendingHackWithVoiceCreated';
-    payload: PendingHackWithVoice;
-}
-
-export interface PendingHackWithVoiceUpdatedEvent {
-    id: string;
-    type: 'PendingHackWithVoiceUpdated';
-    payload: PendingHackWithVoice;
-}
-
-export interface PendingHackWithVoiceDeletedEvent {
-    id: string;
-    type: 'PendingHackWithVoiceDeleted';
-    payload: PendingHackWithVoice;
-}
-
-export type PendingHackWithVoiceChangedEvent = PendingHackWithVoiceCreatedEvent | PendingHackWithVoiceUpdatedEvent | PendingHackWithVoiceDeletedEvent;

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

@@ -1,25 +0,0 @@
-/* eslint-disable @typescript-eslint/ban-types */
-import { Segment } from '../segment/segment';
-import { CompletePendingHack, PendingHack } from './pending-hack';
-
-export interface PendingHackWithVoice {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    voiceId: string;
-    isDefaultVoice: boolean;
-    hackId: string;
-    baseLocaleHackId: string;
-    segments: PendingHack['segments'];
-}
-
-export interface CompletePendingHackWithVoice extends PendingHackWithVoice {
-    segments: CompletePendingHack['segments'];
-}
-
-export type CompletePendingHackWithVoiceWithPutInAction = CompletePendingHackWithVoice & {
-    segments: {
-        putInAction: Segment;
-    }
-};

package/src/pending-hack/pending-hack.ts

@@ -1,78 +0,0 @@
-/* eslint-disable @typescript-eslint/ban-types */
-import { ExtractedSubject } from '../hack/extracted-subject';
-import { HackAffiliate, HackContributor, HackType, HackSourceData, HackTopic, HackExternalLink } from '../hack/hack';
-import { Segment } from '../segment/segment';
-
-export interface PendingHack {
-    id: string;
-    /** use @uptime.app/localisation-contracts */
-    locale: string;
-    baseLocaleHackId: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    owner?: string;
-    tenant?: string;
-    draftHackId: string;
-    draftHackVersion: number;
-    hackId: string;
-    sourceId?: string;
-    title: string;
-    themeId: 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;
-    affiliate?: HackAffiliate;
-    topics: HackTopic[];
-    contributors: HackContributor[];
-    type: HackType;
-    sourceData?: HackSourceData;
-    notifications?: {
-        aiGeneratedText?: string;
-        humanCuratedText?: string;
-    };
-    segments: {
-        favouriteQuote: Segment | {};
-        inANutshell: Segment | {};
-        introduction: Segment | {};
-        insights: [
-            (Segment | {}),
-            (Segment | {}),
-            (Segment | {})
-        ];
-        conclusion: Segment | {};
-        // composite segments
-        overview: Segment | {};
-        shareableOverview: Segment | {};
-        hereAreTheInsights: Segment | {};
-        putInAction?: Segment | {};
-    };
-    externalLink?: HackExternalLink;
-    subjects?: ExtractedSubject[];
-}
-
-export interface CompletePendingHack extends PendingHack {
-    segments: {
-        favouriteQuote: Segment;
-        inANutshell: Segment;
-        introduction: Segment;
-        insights: [
-            Segment,
-            Segment,
-            Segment
-        ];
-        conclusion: Segment;
-        // composite segments
-        overview: Segment;
-        shareableOverview: Segment;
-        hereAreTheInsights: Segment;
-        putInAction?: Segment;
-    };
-    subjects: ExtractedSubject[];
-}
-
-export type CompletePendingHackWithPutInAction = CompletePendingHack & {
-    segments: {
-        putInAction: Segment;
-    }
-};

package/src/preferences/preferences-events.ts

@@ -1,15 +0,0 @@
-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

@@ -1,35 +0,0 @@
-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/profile/profile-events.ts

@@ -1,41 +0,0 @@
-import { Profile } from './profile';
-import { TranslatedProfile } from './translated-profile';
-
-export interface ProfileCreatedEvent {
-    id: string;
-    type: 'ProfileCreated';
-    payload: Profile;
-}
-
-export interface ProfileUpdatedEvent {
-    id: string;
-    type: 'ProfileUpdated';
-    payload: Profile;
-}
-
-export interface ProfileDeletedEvent {
-    id: string;
-    type: 'ProfileDeleted';
-    payload: Profile;
-}
-
-export interface TranslatedProfileCreatedEvent {
-    id: string;
-    type: 'TranslatedProfileCreated';
-    payload: TranslatedProfile;
-}
-
-export interface TranslatedProfileUpdatedEvent {
-    id: string;
-    type: 'TranslatedProfileUpdated';
-    payload: TranslatedProfile;
-}
-
-export interface TranslatedProfileDeletedEvent {
-    id: string;
-    type: 'TranslatedProfileDeleted';
-    payload: TranslatedProfile;
-}
-
-export type ProfileChangedEvent = ProfileCreatedEvent | ProfileUpdatedEvent | ProfileDeletedEvent;
-export type TranslatedProfileChangedEvent = TranslatedProfileCreatedEvent | TranslatedProfileUpdatedEvent | TranslatedProfileDeletedEvent;

package/src/profile/profile.ts

@@ -1,36 +0,0 @@
-import { SupportedLocale } from '../localisation/supported-locales';
-
-export interface StoredProfile {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    avatarUrl: string;
-    name: string;
-    owner: string;
-    /** Added and backfilled in March 2025 */
-    tenant: string;
-    handle: string;
-    _sanitisedHandle?: string; // use to determinate uniqueness for a handle, despite the case of it
-    headerImageUrl?: string;
-    tags?: string[];
-    links?: ProfileLink[];
-    tagline?: string;
-    description?: string;
-    /** The locale (language and region) of the draft hack e.g. fr-FR. Mandatory property since 12/05/2023. */
-    locale: SupportedLocale;
-}
-
-export type Profile = Omit<StoredProfile, '_sanitisedHandle'>;
-
-export interface ProfileLink {
-    type: 'Other' | 'Twitter' | 'Facebook' | 'Youtube' | 'Medium' | 'Instagram' | 'Patreon' | 'TikTok' | 'LinkedIn' | 'LinkTree';
-    url: string;
-}
-
-export interface ProfileMetadata {
-    deleted: boolean;
-    uptimeOwned: boolean;
-    createdByFormerOrgMember?: boolean;
-    avatarUrl: string;
-}

package/src/profile/translated-profile.ts

@@ -1,13 +0,0 @@
-import { SupportedLocale } from '../localisation/supported-locales';
-
-export interface TranslatedProfile {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    profileId: string;
-    locale: SupportedLocale;
-    tagline?: string;
-    description?: string;
-    tags?: string[];
-}

package/src/referral/referral-events.ts

@@ -1,41 +0,0 @@
-import { ReferralCredit, ReferralLink } from './referral';
-
-export interface ReferralCreditCreatedEvent {
-    id: string;
-    type: 'ReferralCreditCreated';
-    payload: ReferralCredit;
-}
-
-export interface ReferralCreditUpdatedEvent {
-    id: string;
-    type: 'ReferralCreditUpdated';
-    payload: ReferralCredit;
-}
-
-export interface ReferralCreditDeletedEvent {
-    id: string;
-    type: 'ReferralCreditDeleted';
-    payload: ReferralCredit;
-}
-
-export type ReferralCreditChangedEvent = ReferralCreditCreatedEvent | ReferralCreditUpdatedEvent | ReferralCreditDeletedEvent;
-
-export interface ReferralLinkCreatedEvent {
-    id: string;
-    type: 'ReferralLinkCreated';
-    payload: ReferralLink;
-}
-
-export interface ReferralLinkUpdatedEvent {
-    id: string;
-    type: 'ReferralLinkUpdated';
-    payload: ReferralLink;
-}
-
-export interface ReferralLinkDeletedEvent {
-    id: string;
-    type: 'ReferralLinkDeleted';
-    payload: ReferralLink;
-}
-
-export type ReferralLinkChangedEvent = ReferralLinkCreatedEvent | ReferralLinkUpdatedEvent | ReferralLinkDeletedEvent;

package/src/referral/referral.ts

@@ -1,76 +0,0 @@
-export interface ReferredUserPurchase {
-    /** The price the referred user paid in their currency */
-    price: number;
-    /** The currency the referred user paid in */
-    currency: string;
-    /** The price they paid in United States Dollars (USD) */
-    priceInUSD: number;
-    /** The RevenueCat transaction ID */
-    transactionId: string;
-    /** The RevenueCat original transaction ID */
-    originalTransactionId: string;
-}
-
-export interface ReferralCredit {
-    /** The unique identifier of a referral credit */
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    /** The ID of the user who shared the referral link */
-    referrerUserId: string;
-    /** If the referrer is a creator, this contains their creator ID */
-    referrerCreatorId?: string;
-    /** If the referrer is a partner of Uptime, this contains their partner ID */
-    referrerPartnerId?: string;
-    /** The unique device ID of the user who shared the referral link */
-    referrerUniqueDeviceId?: string;
-    /** The purchase the referred user made (if applicable) */
-    referredUserPurchase?: ReferredUserPurchase;
-    /** The ID of the user who clicked on the referral link and triggered the referral */
-    referredUserId?: string;
-    /** The unique device ID of the user who clicked on the referral link and triggered the referral */
-    referredUserUniqueDeviceId?: string;
-    /** The ISO 8601 UTC timestamp of the successful referral event */
-    eventTimestamp: string;
-    /** The source of the successful referral event e.g. Branch */
-    eventSource: string;
-    /** The action that triggered the successful referral event e.g. a user sign-up  */
-    eventTrigger: string;
-}
-
-export interface ReferralLink {
-    /** The unique identifier of a referral link */
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    /** The ID of the user who will share the link and be credited if it is used */
-    referrerUserId: string;
-    /** The URL of the referral deep link */
-    url: string;
-    /** The source of the referral link e.g. Branch */
-    source: string;
-    /** The action that triggers a successful referral e.g. a user sign-up  */
-    trigger: string;
-}
-
-export enum ReferralEventSource {
-    Branch = 'branch',
-    RevenueCat = 'revenue-cat'
-}
-
-/* None of these events are mututally exlusive. For example, a single premium payment could 
- * yield both a 'trial-converted' and a 'paid-subscription' referral credit, and it's possible
- * they could be attributed to different referrers, so we need to track both.
- */
-export enum ReferralEventTrigger {
-    /** A new user clicks on a deep link, downloads the Uptime app and registers. */
-    SignUp = 'sign-up',
-    /** A user clicks on a deep link and starts a trial during that session. */
-    TrialStarted = 'trial-started',
-    /** A trial-started referred user converts to premium during their trial. */
-    TrialConverted = 'trial-converted',
-    /** A user clicks a on deep link and pays for premium during that session. */
-    PaidSubscription = 'paid-subscription'
-}

package/src/saved/saved-collection-events.ts

@@ -1,19 +0,0 @@
-import { SavedCollection } from './saved-collection';
-
-export interface SavedCollectionCreatedEvent {
-    id: string;
-    type: 'SavedCollectionCreated';
-    payload: SavedCollection;
-}
-
-export interface SavedCollectionUpdatedEvent {
-    id: string;
-    type: 'SavedCollectionUpdated';
-    payload: SavedCollection;
-}
-
-export interface SavedCollectionDeletedEvent {
-    id: string;
-    type: 'SavedCollectionDeleted';
-    payload: SavedCollection;
-}

package/src/saved/saved-collection.ts

@@ -1,8 +0,0 @@
-export interface SavedCollection {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    userId: string;
-    collectionId: string;
-}

package/src/segment/segment-commands.ts

@@ -1,75 +0,0 @@
-import { SupportedLocale } from '../localisation/supported-locales';
-import { SegmentType } from './segment';
-
-export interface StandaloneSegmentCard {
-    markdown: string;
-}
-
-export interface StandaloneSegmentAction {
-    title: string;
-    cards: StandaloneSegmentCard[];
-}
-
-export interface StandaloneSegmentSection {
-    heading?: string;
-    cards: StandaloneSegmentCard[];
-}
-
-export interface CommandSegment {
-    type: SegmentType;
-    // @deprecated use hackTitle, hackType and hackContributors
-    source?: {
-        id: string;
-        type: string;
-        contributors: {
-            name: string;
-        }[];
-        title: string;
-    };
-    hackCoverUrl?: string;
-    hackId: string;
-    hackTitle: string;
-    hackType: 'book' | 'course' | 'documentary' | 'podcast' | 'original';
-    hackContributors: {
-        name: string;
-    }[];
-    locale: SupportedLocale;
-}
-export interface StandaloneSegment extends CommandSegment {
-    title?: string;
-    keywords?: string[];
-    sections: StandaloneSegmentSection[];
-    actions?: StandaloneSegmentAction[];
-    textSummary?: string;
-}
-
-export interface CompositeSegment extends CommandSegment {
-    subSegments: StandaloneSegment[];
-}
-
-export interface CreateSegmentCommand {
-    id: string;
-    type: 'CreateSegment';
-    payload: (CompositeSegment | StandaloneSegment) & {
-        /** if no voice ids are specified then all voices are generated */
-        voiceIds?: string[];
-    }
-}
-
-export interface UpdateSegmentCommand {
-    id: string;
-    type: 'UpdateSegment';
-    payload: (CompositeSegment | StandaloneSegment) & {
-        segmentId: string;
-        /** if no voice ids are specified then all voices are generated */
-        voiceIds?: string[];
-    };
-}
-
-export interface DeleteSegmentCommand {
-    id: string;
-    type: 'DeleteSegment';
-    payload: {
-        segmentId: string;
-    };
-}

package/src/segment/segment-events.ts

@@ -1,42 +0,0 @@
-import { Segment } from './segment';
-import { SegmentWithVoice } from './segment-with-voice';
-
-export interface SegmentCreatedEvent {
-    id: string;
-    type: 'SegmentCreated';
-    payload: Segment;
-}
-
-export interface SegmentUpdatedEvent {
-    id: string;
-    type: 'SegmentUpdated';
-    payload: Segment;
-}
-
-export interface SegmentDeletedEvent {
-    id: string;
-    type: 'SegmentDeleted';
-    payload: Segment;
-}
-
-export type SegmentChangedEvent = SegmentCreatedEvent | SegmentUpdatedEvent | SegmentDeletedEvent;
-
-export interface SegmentWithVoiceCreatedEvent {
-    id: string;
-    type: 'SegmentWithVoiceCreated';
-    payload: SegmentWithVoice;
-}
-
-export interface SegmentWithVoiceUpdatedEvent {
-    id: string;
-    type: 'SegmentWithVoiceUpdated';
-    payload: SegmentWithVoice;
-}
-
-export interface SegmentWithVoiceDeletedEvent {
-    id: string;
-    type: 'SegmentWithVoiceDeleted';
-    payload: SegmentWithVoice;
-}
-
-export type SegmentWithVoiceChangedEvent = SegmentWithVoiceCreatedEvent | SegmentWithVoiceUpdatedEvent | SegmentWithVoiceDeletedEvent;

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

@@ -1,8 +0,0 @@
-import { Segment } from './segment';
-
-// a segment with audio in a single voice, because having all voices in one segment would make the entity very large
-// the only difference is that it includes a voiceIdAndLanguage field, which can be used as a range key to find the segment for a specific voice
-// segmentsWithVoice may point to default or non-default voices
-export interface SegmentWithVoice extends Segment {
-    voiceIdAndLanguage: string;
-}

package/src/segment/segment.ts

@@ -1,82 +0,0 @@
-export interface SegmentVoice {
-    id: string;
-    language: string;
-    name: string;
-    countryCode: string;
-    speechProvider: string;
-}
-
-export interface Segment {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    hackId: string;
-    type: SegmentType;
-    title: string;
-    sections: SegmentSection[];
-    keywords: string[];
-    actions: SegmentAction[];
-    speech: SegmentSpeech[];
-    textSummary?: string;
-    lastUpdatedFromPendingSegmentId?: string;
-    hackType: string;
-    /** use @uptime.app/text-to-speech-contracts */
-    locale: string;
-}
-
-export type SegmentType =
-    'overview' | 'favourite-quote' | 'in-a-nutshell' |
-    'introduction' | 'here-are-the-insights' |
-    'insight-one' | 'insight-two' | 'insight-three' |
-    'put-in-action' | 'conclusion' |
-    'shareable-overview' | 'download-app-to-see-more';
-
-export type CardType = 'hack-cover' | 'action';
-
-export interface SegmentAction {
-    title: string;
-    cards: SegmentTextCard[];
-}
-
-export interface SegmentTextCard {
-    id: string;
-    markdown: string;
-    segmentType: SegmentType;
-    cardType?: CardType;
-    isTitle?: boolean;
-    speech?: TextCardSpeech[];
-}
-
-export interface SegmentSection {
-    heading?: string;
-    cards: SegmentTextCard[];
-}
-
-export interface SegmentSpeech {
-    voice: SegmentVoice;
-    withHeading: {
-        url: string;
-        lengthSeconds: number;
-    };
-    withoutHeading: {
-        url: string;
-        lengthSeconds: number;
-    };
-}
-
-export interface TextCardSpeech {
-    voiceId: string;
-    withHeading: {
-        timestamps: {
-            startsAt: number;
-            endsAt: number;
-        };
-    };
-    withoutHeading: {
-        timestamps: {
-            startsAt: number;
-            endsAt: number;
-        };
-    };
-}

package/src/service-simulator/mock-request-response.ts

@@ -1,25 +0,0 @@
-import { Context } from '../message-bus/context';
-
-export interface SetMockResponseRequest<T = any> {
-    transactionId: string;
-    mockedResponse: T;
-    isErrorResponse?: boolean;
-    matchRequest?: T;
-}
-
-export interface InternalLambdaRequest<T = any> {
-    context: Context;
-    payload: T;
-    /**
-     * Optional fallback lambda to invoke when no mock exists for the current
-     * transactionId, or when matchRequest is present but does not match.
-     *
-     * Accepts any FunctionName value supported by AWS Lambda InvokeCommand,
-     * including a function name, full ARN, or partial ARN.
-     */
-    fallbackFunctionName?: string;
-}
-
-export interface DeleteMockResponseRequest {
-    transactionId: string;
-}