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

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

@@ -1,77 +1,77 @@
-/* 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;
-    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;
-    }
-};
+/* 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;
+    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 +1,15 @@
-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;
+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 +1,35 @@
-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;
-}
+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 +1,41 @@
-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;
+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,28 +1,28 @@
-import { SupportedLocale } from '../localisation/supported-locales';
-
-export interface StoredProfile {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    avatarUrl: string;
-    name: string;
-    owner: string;
-    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;
-}
+import { SupportedLocale } from '../localisation/supported-locales';
+
+export interface StoredProfile {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    avatarUrl: string;
+    name: string;
+    owner: string;
+    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;
+}

package/src/profile/translated-profile.ts

@@ -1,13 +1,13 @@
-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[];
-}
+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 +1,41 @@
-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;
+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 +1,76 @@
-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'
-}
+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'
+}