@uptime.app/contracts 3.0.54 → 4.0.0-rc.1

package/src/theme/theme.ts

@@ -1,68 +1,68 @@
-export interface ThemeTemplate {
-    /** the url of the background video */
-    backgroundVideoUrl?: string;
-    /** the url of the background image */
-    backgroundImageUrl?: string;
-    /** the font color that will be used when rendering text in the foreground */
-    fontColor: string;
-}
-
-export interface SegmentThemeTemplates {
-    overview: {
-        a: ThemeTemplate;
-        b: ThemeTemplate;
-    },
-    insightOne: {
-        // one template is for the title card
-        // the other one for insight content
-        a: ThemeTemplate;
-        b: ThemeTemplate;
-    },
-    insightTwo: {
-        a: ThemeTemplate;
-        b: ThemeTemplate;
-    },
-    insightThree: {
-        a: ThemeTemplate;
-        b: ThemeTemplate;
-    },
-    dark: {
-        overview: {
-            a: ThemeTemplate;
-            b: ThemeTemplate;
-        },
-        insightOne: {
-            a: ThemeTemplate;
-            b: ThemeTemplate;
-        },
-        insightTwo: {
-            a: ThemeTemplate;
-            b: ThemeTemplate;
-        },
-        insightThree: {
-            a: ThemeTemplate;
-            b: ThemeTemplate;
-        }
-    }
-}
-
-export interface Theme {
-    id: string;
-    name: string;
-    fontFamily: string;
-    templates: SegmentThemeTemplates;
-    mood: 'neutral' | 'sombre' | 'vibrant';
-    isCustom: boolean;
-    /* properties of the story and audio player */
-    player?: {
-        light: {
-            backgroundColor: string;
-        },
-        dark: {
-            backgroundColor: string;
-        }
-    }
-    updatedAt: string;
-    createdAt: string;
-    v: number;
-}
+export interface ThemeTemplate {
+    /** the url of the background video */
+    backgroundVideoUrl?: string;
+    /** the url of the background image */
+    backgroundImageUrl?: string;
+    /** the font color that will be used when rendering text in the foreground */
+    fontColor: string;
+}
+
+export interface SegmentThemeTemplates {
+    overview: {
+        a: ThemeTemplate;
+        b: ThemeTemplate;
+    },
+    insightOne: {
+        // one template is for the title card
+        // the other one for insight content
+        a: ThemeTemplate;
+        b: ThemeTemplate;
+    },
+    insightTwo: {
+        a: ThemeTemplate;
+        b: ThemeTemplate;
+    },
+    insightThree: {
+        a: ThemeTemplate;
+        b: ThemeTemplate;
+    },
+    dark: {
+        overview: {
+            a: ThemeTemplate;
+            b: ThemeTemplate;
+        },
+        insightOne: {
+            a: ThemeTemplate;
+            b: ThemeTemplate;
+        },
+        insightTwo: {
+            a: ThemeTemplate;
+            b: ThemeTemplate;
+        },
+        insightThree: {
+            a: ThemeTemplate;
+            b: ThemeTemplate;
+        }
+    }
+}
+
+export interface Theme {
+    id: string;
+    name: string;
+    fontFamily: string;
+    templates: SegmentThemeTemplates;
+    mood: 'neutral' | 'sombre' | 'vibrant';
+    isCustom: boolean;
+    /* properties of the story and audio player */
+    player?: {
+        light: {
+            backgroundColor: string;
+        },
+        dark: {
+            backgroundColor: string;
+        }
+    }
+    updatedAt: string;
+    createdAt: string;
+    v: number;
+}

package/src/topics/primary-topic-mapping.test.ts

@@ -0,0 +1,87 @@
+import {
+    TOPIC_TO_PRIMARY_TOPIC_FUZZY_MAPPING,
+    fuzzyMapTopicsToPrimaryTopics,
+    mapPrimaryTopicsToOldTopics,
+    OLD_TOPIC_TAGS,
+    VALID_PRIMARY_TOPIC_TAGS
+} from './primary-topic-mapping';
+
+describe('mapPrimaryTopicsToOldTopics', () => {
+    test('maps split primary topics back to their old topic', () => {
+        expect(mapPrimaryTopicsToOldTopics(['Politics, Law & Economics'])).toEqual(['Culture & Society']);
+        expect(mapPrimaryTopicsToOldTopics(['Communication'])).toEqual(['Personal Growth']);
+        expect(mapPrimaryTopicsToOldTopics(['AI & Technology'])).toEqual(['Technology & the Future']);
+    });
+
+    test('supports PrimaryTopic objects', () => {
+        expect(mapPrimaryTopicsToOldTopics([{ name: 'Career Success' }])).toEqual(['Career & Success']);
+    });
+
+    test('returns no matching topic for unknown topics', () => {
+        expect(mapPrimaryTopicsToOldTopics(['Unknown Topic'])).toEqual([]);
+    });
+
+    test('maps every valid primary topic tag to a known old topic tag', () => {
+        for (const primaryTopic of VALID_PRIMARY_TOPIC_TAGS) {
+            const oldTopic = mapPrimaryTopicsToOldTopics([primaryTopic])[0];
+            expect(oldTopic).toBeDefined();
+            expect(OLD_TOPIC_TAGS).toContain(oldTopic);
+        }
+    });
+    test('deduplicates old topics while preserving input order', () => {
+        expect(
+            mapPrimaryTopicsToOldTopics([
+                { name: 'Marketing' },
+                { name: 'Sales' },
+                { name: 'Biographies' },
+                { name: 'Marketing' },
+                { name: 'Unknown Topic' }
+            ])
+        ).toEqual(['Marketing & Sales', 'Biographies']);
+    });
+});
+
+describe('mapFuzzyTopicsToPrimaryTopics', () => {
+    test('maps broad fuzzy topics to multiple primary topics', () => {
+        expect(fuzzyMapTopicsToPrimaryTopics(['Health & Fitness'])).toEqual([
+            'Nutrition & Health',
+            'Fitness & Sports',
+            'Mental Health',
+            'Neurodiversity'
+        ]);
+    });
+
+    test('maps single fuzzy topics to their primary topic', () => {
+        expect(fuzzyMapTopicsToPrimaryTopics(['Biographies'])).toEqual(['Biographies']);
+    });
+
+    test('supports topic objects', () => {
+        expect(fuzzyMapTopicsToPrimaryTopics([{ name: 'Career & Success' }])).toEqual(['Career Success']);
+    });
+
+    test('returns an empty array for unknown topics', () => {
+        expect(fuzzyMapTopicsToPrimaryTopics(['Unknown Topic'])).toEqual([]);
+    });
+
+    test('deduplicates primary topics while preserving input and mapping order', () => {
+        expect(
+            fuzzyMapTopicsToPrimaryTopics([
+                { name: 'Marketing & Sales' },
+                { name: 'Business' },
+                { name: 'Marketing & Sales' },
+                { name: 'Unknown Topic' }
+            ])
+        ).toEqual(['Marketing', 'Sales', 'Business']);
+    });
+
+    test('maps every fuzzy topic tag to valid primary topic tags', () => {
+        for (const fuzzyTopic of OLD_TOPIC_TAGS) {
+            const primaryTopics = TOPIC_TO_PRIMARY_TOPIC_FUZZY_MAPPING[fuzzyTopic];
+
+            expect(primaryTopics.length).toBeGreaterThan(0);
+            for (const primaryTopic of primaryTopics) {
+                expect(VALID_PRIMARY_TOPIC_TAGS).toContain(primaryTopic);
+            }
+        }
+    });
+});

package/src/topics/primary-topic-mapping.ts

@@ -0,0 +1,136 @@
+import { PrimaryTopic } from './primary-topic';
+
+export const VALID_PRIMARY_TOPIC_TAGS = [
+    'Arts & Design',
+    'Biographies',
+    'Business',
+    'Career Success',
+    'Communication',
+    'Education & Studying',
+    'Entrepreneurship',
+    'Environment',
+    'Fitness & Sports',
+    'History',
+    'Home & Hobbies',
+    'Humanity & Societies',
+    'Identity & Equality',
+    'Investing',
+    'Leadership & Management',
+    'Marketing',
+    'Media & Entertainment',
+    'Mental Health',
+    'Mindfulness',
+    'Money & Finances',
+    'Neurodiversity',
+    'Nutrition & Health',
+    'Parenting & Family',
+    'Personal Growth',
+    'Politics, Law & Economics',
+    'Psychology & Philosophy',
+    'Relationships',
+    'Religion',
+    'Sales',
+    'Science',
+    'Sex',
+    'AI & Technology'
+] as const;
+
+export const OLD_TOPIC_TAGS = [
+    'Arts & Design',
+    'Biographies',
+    'Business',
+    'Culture & Society',
+    'Career & Success',
+    'Education',
+    'Health & Fitness',
+    'History',
+    'Leadership & Entrepreneurship',
+    'Lifestyle',
+    'Marketing & Sales',
+    'Mind & Philosophy',
+    'Money & Investing',
+    'Parenting & Relationships',
+    'Personal Growth',
+    'Religion & Spirituality',
+    'Science & the Environment',
+    'Technology & the Future'
+] as const;
+
+export type PrimaryTopicTag = (typeof VALID_PRIMARY_TOPIC_TAGS)[number];
+export type OldTopicTag = (typeof OLD_TOPIC_TAGS)[number];
+
+export const TOPIC_TO_PRIMARY_TOPIC_FUZZY_MAPPING: Record<OldTopicTag, PrimaryTopicTag[]> = {
+    'Arts & Design': ['Arts & Design', 'Media & Entertainment'],
+    'Biographies': ['Biographies'],
+    'Business': ['Business'],
+    'Culture & Society': ['Identity & Equality', 'Politics, Law & Economics', 'Humanity & Societies'],
+    'Career & Success': ['Career Success'],
+    'Education': ['Education & Studying'],
+    'Health & Fitness': ['Nutrition & Health', 'Fitness & Sports', 'Mental Health', 'Neurodiversity'],
+    'History': ['History'],
+    'Leadership & Entrepreneurship': ['Leadership & Management', 'Entrepreneurship'],
+    'Lifestyle': ['Home & Hobbies'],
+    'Marketing & Sales': ['Marketing', 'Sales'],
+    'Mind & Philosophy': ['Mindfulness', 'Psychology & Philosophy'],
+    'Money & Investing': ['Money & Finances', 'Investing'],
+    'Parenting & Relationships': ['Sex', 'Relationships', 'Parenting & Family'],
+    'Personal Growth': ['Personal Growth', 'Communication'],
+    'Religion & Spirituality': ['Religion'],
+    'Science & the Environment': ['Science', 'Environment'],
+    'Technology & the Future': ['AI & Technology']
+};
+
+const PRIMARY_TOPIC_TO_OLD_TOPIC_MAPPING = Object.entries(TOPIC_TO_PRIMARY_TOPIC_FUZZY_MAPPING).reduce(
+    (mapping, [oldTopic, primaryTopics]) => {
+        for (const primaryTopic of primaryTopics) {
+            mapping[primaryTopic] = oldTopic as OldTopicTag;
+        }
+
+        return mapping;
+    },
+    {} as Record<PrimaryTopicTag, OldTopicTag>
+);
+
+function topicNameOf(topic: { name: string } | string): string {
+    return typeof topic === 'string' ? topic : topic.name;
+}
+
+function addIfNotPresent<T>(items: T[], item: T): void {
+    if (items.indexOf(item) === -1) {
+        items.push(item);
+    }
+}
+
+function mapPrimaryTopicToOldTopic(primaryTopic: PrimaryTopic | string): OldTopicTag | undefined {
+    return PRIMARY_TOPIC_TO_OLD_TOPIC_MAPPING[topicNameOf(primaryTopic) as PrimaryTopicTag];
+}
+
+export function mapPrimaryTopicsToOldTopics(primaryTopics: Array<PrimaryTopic | string>): OldTopicTag[] {
+    const oldTopics: OldTopicTag[] = [];
+
+    for (const primaryTopic of primaryTopics) {
+        const oldTopic = mapPrimaryTopicToOldTopic(primaryTopic);
+
+        if (oldTopic !== undefined) {
+            addIfNotPresent(oldTopics, oldTopic);
+        }
+    }
+
+    return oldTopics;
+}
+
+function fuzzyMapTopicToPrimaryTopics(fuzzyTopic: { name: string } | string): PrimaryTopicTag[] {
+    return TOPIC_TO_PRIMARY_TOPIC_FUZZY_MAPPING[topicNameOf(fuzzyTopic) as OldTopicTag] ?? [];
+}
+
+export function fuzzyMapTopicsToPrimaryTopics(fuzzyTopics: Array<{ name: string } | string>): PrimaryTopicTag[] {
+    const primaryTopics: PrimaryTopicTag[] = [];
+
+    for (const fuzzyTopic of fuzzyTopics) {
+        for (const primaryTopic of fuzzyMapTopicToPrimaryTopics(fuzzyTopic)) {
+            addIfNotPresent(primaryTopics, primaryTopic);
+        }
+    }
+
+    return primaryTopics;
+}

package/src/topics/primary-topic.ts

@@ -0,0 +1,3 @@
+export interface PrimaryTopic {
+    name: string;
+}

package/src/translation/translation-events.ts

@@ -1,73 +1,73 @@
-import { SupportedLocale } from '../localisation/supported-locales';
-import { ObjectToTranslate, TextWithTranslation } from './translation';
-import { Text } from './translation';
-
-export interface TextTranslatedEvent {
-    id: string;
-    type: 'TextTranslated';
-    payload: {
-        reference: string;
-        fromLocale: string;
-        toLocale: string;
-        text: TextWithTranslation[];
-    };
-}
-
-export interface ObjectsTranslatedEvent {
-    id: string;
-    type: 'ObjectsTranslated';
-    payload: {
-        reference: string;
-        fromLocale: string;
-        toLocale: string;
-        translatedObjects: TranslatedObject[];
-    };
-}
-
-export interface TranslatedObject {
-    translatedObject: any;
-    reference: string;
-}
-
-/**
- * Translate JSON objects using Chat GPT
- */
-export interface TranslateObjectsCommand {
-    id: string;
-    type: 'TranslateObjects';
-    payload: TranslateObjectsCommandPayload;
-}
-
-export interface TranslateObjectsCommandPayload {
-    /**
-     * Identifier set by the creator of the command. It also shows up in the TextTranslated event and
-     * it has the same value as in the original command, so that interested services can match their command to the event.
-     */
-    reference: string;
-    fromLocale: SupportedLocale;
-    toLocale: SupportedLocale;
-    objectsToTranslate: ObjectToTranslate[];
-    /**
-     * Optional model to use for translation. If not provided, the default model will be used.
-     * It used to be a SupportedGptModel enum
-     */
-    chatGptModel?: string;
-}
-
-export interface TranslateTextCommand {
-    id: string;
-    type: 'TranslateText';
-    payload: TranslateTextCommandPayload
-}
-
-export interface TranslateTextCommandPayload {
-    /**
-     * Identifier set by the creator of the command. It also shows up in the TextTranslated event and
-     * it has the same value as in the original command, so that interested services can match their command to the event.
-     */
-    reference: string;
-    // TODO fromLocale and toLocale to use contracts' SupportedLocales
-    fromLocale: string;
-    toLocale: string;
-    text: Text[];
-}
+import { SupportedLocale } from '../localisation/supported-locales';
+import { ObjectToTranslate, TextWithTranslation } from './translation';
+import { Text } from './translation';
+
+export interface TextTranslatedEvent {
+    id: string;
+    type: 'TextTranslated';
+    payload: {
+        reference: string;
+        fromLocale: string;
+        toLocale: string;
+        text: TextWithTranslation[];
+    };
+}
+
+export interface ObjectsTranslatedEvent {
+    id: string;
+    type: 'ObjectsTranslated';
+    payload: {
+        reference: string;
+        fromLocale: string;
+        toLocale: string;
+        translatedObjects: TranslatedObject[];
+    };
+}
+
+export interface TranslatedObject {
+    translatedObject: any;
+    reference: string;
+}
+
+/**
+ * Translate JSON objects using Chat GPT
+ */
+export interface TranslateObjectsCommand {
+    id: string;
+    type: 'TranslateObjects';
+    payload: TranslateObjectsCommandPayload;
+}
+
+export interface TranslateObjectsCommandPayload {
+    /**
+     * Identifier set by the creator of the command. It also shows up in the TextTranslated event and
+     * it has the same value as in the original command, so that interested services can match their command to the event.
+     */
+    reference: string;
+    fromLocale: SupportedLocale;
+    toLocale: SupportedLocale;
+    objectsToTranslate: ObjectToTranslate[];
+    /**
+     * Optional model to use for translation. If not provided, the default model will be used.
+     * It used to be a SupportedGptModel enum
+     */
+    chatGptModel?: string;
+}
+
+export interface TranslateTextCommand {
+    id: string;
+    type: 'TranslateText';
+    payload: TranslateTextCommandPayload
+}
+
+export interface TranslateTextCommandPayload {
+    /**
+     * Identifier set by the creator of the command. It also shows up in the TextTranslated event and
+     * it has the same value as in the original command, so that interested services can match their command to the event.
+     */
+    reference: string;
+    // TODO fromLocale and toLocale to use contracts' SupportedLocales
+    fromLocale: string;
+    toLocale: string;
+    text: Text[];
+}

package/src/translation/translation.ts

@@ -1,25 +1,25 @@
-export interface Text {
-    /**
-     * Identifier set by the creator of the command. TextWithTranslation entities have the same
-     * references as in the original command, so that they can be easily matched by the receiving service.
-     */
-    reference: string;
-    content: string;
-}
-
-export interface ObjectToTranslate {
-    /**
-     * Stringified size must be lower than 7000 characters so that it can work with ChatGPT
-     */
-    objectToTranslate: any;
-    translationCacheKey: string;
-    /** refresh the cache item */
-    refreshCache?: boolean
-    reference: string;
-    /** additional text that will be added to the GPT prompt when requesting translation  */
-    promptAdditions?: string;
-}
-
-export interface TextWithTranslation extends Text {
-    translation: string;
-}
+export interface Text {
+    /**
+     * Identifier set by the creator of the command. TextWithTranslation entities have the same
+     * references as in the original command, so that they can be easily matched by the receiving service.
+     */
+    reference: string;
+    content: string;
+}
+
+export interface ObjectToTranslate {
+    /**
+     * Stringified size must be lower than 7000 characters so that it can work with ChatGPT
+     */
+    objectToTranslate: any;
+    translationCacheKey: string;
+    /** refresh the cache item */
+    refreshCache?: boolean
+    reference: string;
+    /** additional text that will be added to the GPT prompt when requesting translation  */
+    promptAdditions?: string;
+}
+
+export interface TextWithTranslation extends Text {
+    translation: string;
+}

package/src/trending/trending-events.ts

@@ -1,21 +1,21 @@
-import { TrendingHacks } from './trending-hacks';
-
-export interface TrendingHacksCreatedEvent {
-    id: string;
-    type: 'TrendingHacksCreated';
-    payload: TrendingHacks;
-}
-
-export interface TrendingHacksUpdatedEvent {
-    id: string;
-    type: 'TrendingHacksUpdated';
-    payload: TrendingHacks;
-}
-
-export interface TrendingHacksDeletedEvent {
-    id: string;
-    type: 'TrendingHacksDeleted';
-    payload: TrendingHacks;
-}
-
-export type TrendingHacksChangedEvent = TrendingHacksCreatedEvent | TrendingHacksUpdatedEvent | TrendingHacksDeletedEvent;
+import { TrendingHacks } from './trending-hacks';
+
+export interface TrendingHacksCreatedEvent {
+    id: string;
+    type: 'TrendingHacksCreated';
+    payload: TrendingHacks;
+}
+
+export interface TrendingHacksUpdatedEvent {
+    id: string;
+    type: 'TrendingHacksUpdated';
+    payload: TrendingHacks;
+}
+
+export interface TrendingHacksDeletedEvent {
+    id: string;
+    type: 'TrendingHacksDeleted';
+    payload: TrendingHacks;
+}
+
+export type TrendingHacksChangedEvent = TrendingHacksCreatedEvent | TrendingHacksUpdatedEvent | TrendingHacksDeletedEvent;

package/src/trending/trending-hacks.ts

@@ -1,8 +1,8 @@
-export interface TrendingHacks {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    date: string;
-    hackIds: string[];
-}
+export interface TrendingHacks {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    date: string;
+    hackIds: string[];
+}

package/src/user/cognito-user-authentication-log.ts

@@ -1,8 +1,8 @@
-export interface CognitoUserAuthenticationLog {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    cognitoUserId: string;
-    lastAuthenticatedAt: string;    
+export interface CognitoUserAuthenticationLog {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    cognitoUserId: string;
+    lastAuthenticatedAt: string;    
 }