@uptime.app/contracts 1.0.41-rc.8 → 1.0.41

package/src/localisation/supported-locales.ts

@@ -1,61 +1,61 @@
-export enum SupportedLocale {
-    /** English (United Kingdom) */
-    enGB = 'en-GB',
-    /** English (United States) */
-    enUS = 'en-US',
-    /** Portuguese (Brazil) */
-    ptBR = 'pt-BR',
-    /** Spanish (International) */
-    es = 'es',
-    /** French (France) */
-    frFR = 'fr-FR',
-    /** Italian */
-    itIT = 'it-IT',
-    /** Dutch */
-    nlNL = 'nl-NL',
-    /** German */
-    deDE = 'de-DE',
-    /** Polish */
-    plPL = 'pl-PL',
-    /** Swedish */
-    svSE = 'sv-SE',
-    /** Turkish */
-    trTR = 'tr-TR',
-    /** Canadian French */
-    frCA = 'fr-CA',
-    /** Traditional Chinese */
-    zhTW = 'zh-TW',
-    /** Simplified Chinese */
-    zhCN = 'zh-CN',
-    /** Norwegian */
-    nbNO = 'nb-NO',
-    /** Malaysian Malay */
-    msMY = 'ms-MY',
-    /** Modern Standard Arabic */
-    ar = 'ar',
-    /** Hebrew */
-    heIL = 'he-IL',
-    /** Japanese */
-    jaJP = 'ja-JP',
-    /** Bahasa Indonesian */
-    idID = 'id-ID',
-    /** Vietnamese */
-    viVN = 'vi-VN',
-    /** Russian */
-    ruRU = 'ru-RU',
-    /** Korean */
-    koKR = 'ko-KR',
-    /** Thai */
-    thTH = 'th-TH',
-    /** Hindi */
-    hiIN = 'hi-IN',
-}
-
-/**
- * All supported locale codes. Use allLiveLocaleCodes() instead when checking for locale codes supported by the app
- */
-export function allSupportedLocaleCodes(): string[] {
-    return Object.values(SupportedLocale);
-}
-
-export const DEFAULT_LOCALE = SupportedLocale.enUS;
+export enum SupportedLocale {
+    /** English (United Kingdom) */
+    enGB = 'en-GB',
+    /** English (United States) */
+    enUS = 'en-US',
+    /** Portuguese (Brazil) */
+    ptBR = 'pt-BR',
+    /** Spanish (International) */
+    es = 'es',
+    /** French (France) */
+    frFR = 'fr-FR',
+    /** Italian */
+    itIT = 'it-IT',
+    /** Dutch */
+    nlNL = 'nl-NL',
+    /** German */
+    deDE = 'de-DE',
+    /** Polish */
+    plPL = 'pl-PL',
+    /** Swedish */
+    svSE = 'sv-SE',
+    /** Turkish */
+    trTR = 'tr-TR',
+    /** Canadian French */
+    frCA = 'fr-CA',
+    /** Traditional Chinese */
+    zhTW = 'zh-TW',
+    /** Simplified Chinese */
+    zhCN = 'zh-CN',
+    /** Norwegian */
+    nbNO = 'nb-NO',
+    /** Malaysian Malay */
+    msMY = 'ms-MY',
+    /** Modern Standard Arabic */
+    ar = 'ar',
+    /** Hebrew */
+    heIL = 'he-IL',
+    /** Japanese */
+    jaJP = 'ja-JP',
+    /** Bahasa Indonesian */
+    idID = 'id-ID',
+    /** Vietnamese */
+    viVN = 'vi-VN',
+    /** Russian */
+    ruRU = 'ru-RU',
+    /** Korean */
+    koKR = 'ko-KR',
+    /** Thai */
+    thTH = 'th-TH',
+    /** Hindi */
+    hiIN = 'hi-IN',
+}
+
+/**
+ * All supported locale codes. Use allLiveLocaleCodes() instead when checking for locale codes supported by the app
+ */
+export function allSupportedLocaleCodes(): string[] {
+    return Object.values(SupportedLocale);
+}
+
+export const DEFAULT_LOCALE = SupportedLocale.enUS;

package/src/moderation/hack-moderation-result-events.ts

@@ -1,18 +1,18 @@
-import { HackModerationResult } from './hack-moderation-result';
-
-export interface HackModerationResultCreatedEvent {
-    id: string;
-    type: 'HackModerationResultCreated';
-    payload: HackModerationResult;
-}
-export interface HackModerationResultUpdatedEvent {
-    id: string;
-    type: 'HackModerationResultUpdated';
-    payload: HackModerationResult;
-}
-export interface HackModerationResultDeletedEvent {
-    id: string;
-    type: 'HackModerationResultDeleted';
-    payload: HackModerationResult;
-}
-export declare type HackModerationResultChangedEvent = HackModerationResultCreatedEvent | HackModerationResultUpdatedEvent | HackModerationResultDeletedEvent;
+import { HackModerationResult } from './hack-moderation-result';
+
+export interface HackModerationResultCreatedEvent {
+    id: string;
+    type: 'HackModerationResultCreated';
+    payload: HackModerationResult;
+}
+export interface HackModerationResultUpdatedEvent {
+    id: string;
+    type: 'HackModerationResultUpdated';
+    payload: HackModerationResult;
+}
+export interface HackModerationResultDeletedEvent {
+    id: string;
+    type: 'HackModerationResultDeleted';
+    payload: HackModerationResult;
+}
+export declare type HackModerationResultChangedEvent = HackModerationResultCreatedEvent | HackModerationResultUpdatedEvent | HackModerationResultDeletedEvent;

package/src/moderation/hack-moderation-result.ts

@@ -1,27 +1,27 @@
-export interface HackModerationResult {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    hackId: string;
-    hackVersion: number;
-    draftHackId: string;
-    draftHackVersion: number;
-    moderationLabels: ModerationLabel[];
-    moderationActions: ModerationAction[];
-}
-
-export interface ModerationLabel {
-    label: string;
-    content: string;
-}
-
-export enum ModerationAction {
-    Accept = 'accept',
-    PartialDistribution = 'partial_distribution',
-    NoDistribution = 'no_distribution',
-    Review = 'review',
-    Notify = 'notify',
-    Hide = 'hide',
-    Escalate = 'escalate'
-}
+export interface HackModerationResult {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    hackId: string;
+    hackVersion: number;
+    draftHackId: string;
+    draftHackVersion: number;
+    moderationLabels: ModerationLabel[];
+    moderationActions: ModerationAction[];
+}
+
+export interface ModerationLabel {
+    label: string;
+    content: string;
+}
+
+export enum ModerationAction {
+    Accept = 'accept',
+    PartialDistribution = 'partial_distribution',
+    NoDistribution = 'no_distribution',
+    Review = 'review',
+    Notify = 'notify',
+    Hide = 'hide',
+    Escalate = 'escalate'
+}

package/src/partner/partner-events.ts

@@ -1,21 +1,21 @@
-import { Partner } from './partner';
-
-export interface PartnerCreatedEvent {
-    id: string;
-    type: 'PartnerCreated';
-    payload: Partner;
-}
-
-export interface PartnerUpdatedEvent {
-    id: string;
-    type: 'PartnerUpdated';
-    payload: Partner;
-}
-
-export interface PartnerDeletedEvent {
-    id: string;
-    type: 'PartnerDeleted';
-    payload: Partner;
-}
-
-export type PartnerChangedEvent = PartnerCreatedEvent | PartnerUpdatedEvent | PartnerDeletedEvent;
+import { Partner } from './partner';
+
+export interface PartnerCreatedEvent {
+    id: string;
+    type: 'PartnerCreated';
+    payload: Partner;
+}
+
+export interface PartnerUpdatedEvent {
+    id: string;
+    type: 'PartnerUpdated';
+    payload: Partner;
+}
+
+export interface PartnerDeletedEvent {
+    id: string;
+    type: 'PartnerDeleted';
+    payload: Partner;
+}
+
+export type PartnerChangedEvent = PartnerCreatedEvent | PartnerUpdatedEvent | PartnerDeletedEvent;

package/src/partner/partner.ts

@@ -1,7 +1,7 @@
-export interface Partner {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    owner: string;
-}
+export interface Partner {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    owner: string;
+}

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

@@ -1,21 +1,21 @@
-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;
-}
-
+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 +1,21 @@
-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;
-}
-
+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 +1,25 @@
-/* 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;
-    }
-};
+/* 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,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;
+}