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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uptime.app/contracts",
-  "version": "3.0.54-rc.2",
+  "version": "4.0.0-rc.1",
   "license": "MIT",
   "types": "./dist/esm/index.d.ts",
   "main": "./dist/cjs/index.js",
@@ -13,5 +13,6 @@
   },
   "devDependencies": {
     "typescript": "^5.4.3"
-  }
+  },
+  "gitHead": "639218d25669661985f063d768e3d8e83b7f6371"
 }

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

@@ -51,6 +51,7 @@ export interface AppHackMetadata {
         };
     }
     topics: EnrichedHack['topics'];
+    primaryTopics: EnrichedHack['primaryTopics'];
     contributors?: EnrichedHack['contributors'];
     type: string;
     sourceData?: EnrichedHack['sourceData'];

package/src/cms-hack/cms-searchable-hack.ts

@@ -1,5 +1,6 @@
 import { EnrichedHackSubjects } from '../enriched-hack/enriched-hack';
 import { HackContributor, HackTopic, HackType } from '../hack/hack';
+import { PrimaryTopic } from '../topics/primary-topic';
 
 export interface CmsSearchableHack {
     /** id of the hack, even if the hack is currently in draft state */
@@ -32,6 +33,8 @@ export interface CmsSearchableHack {
     type?: HackType;
 
     topics: HackTopic[];
+    primaryTopics: PrimaryTopic[];
+
     keywords: string[];
     topicsExtracted: string[];
     keywordsExtracted: string[];

package/src/draft-hack/draft-hack.ts

@@ -1,4 +1,5 @@
 import { SupportedLocale } from '../localisation/supported-locales';
+import { PrimaryTopic } from '../topics/primary-topic';
 
 export interface DraftHack extends DraftHackContent {
     /** The unique id of the draft hack. */
@@ -58,6 +59,7 @@ export interface DraftHackContent {
      * @maxItems 50
      */
     topics?: DraftTopic[];
+    primaryTopics?: PrimaryTopic[];
     /**
      * @maxItems 10
      */

package/src/draft-hack-generation/draft-hack-generation-events.ts

@@ -14,17 +14,14 @@ export interface DraftHackGenerated {
 
         hackGenerationTriggerId: string;
 
-        // introduced 11/09/2024
-        researchNotes?: {
-            insight1: string;
-            insight2: string;
-            insight3: string;
-        };
-        transcriptSource?: {
-            s3Path: string;
-        };
-    }
-}
+        // introduced 11/09/2024
+        researchNotes?: {
+            insight1: string;
+            insight2: string;
+            insight3: string;
+        };
+    }
+}
 
 export interface DraftHackGenerationFailed {
     id: string;

package/src/enriched-hack/enriched-hack.ts

@@ -5,6 +5,7 @@ import { Theme } from '../theme/theme';
 import { HackWithVoice } from '../hack/hack-with-voice';
 import { ExtractedSubject } from '../hack/extracted-subject';
 import { SegmentType, SegmentAction, SegmentSpeech, SegmentSection, SegmentTextCard } from '../segment/segment';
+import { PrimaryTopic } from '../topics/primary-topic';
 
 export interface EnrichedHack {
     /** The hack id */
@@ -44,6 +45,7 @@ export interface EnrichedHack {
     segments: HackWithVoice['segments']; // Use the 'HackWithVoice' type
     affiliate?: HackAffiliate;
     topics: HackTopic[];
+    primaryTopics: PrimaryTopic[];
     contributors?: HackContributor[];
     type: HackType;
     sourceData?: HackSourceData;

package/src/flashcard/flashcard.ts

@@ -66,7 +66,7 @@ export interface Flashcard {
     /*
     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;
+    hack: FlashcardHack;
 
     /*
     A hack's ACL. The Hack model doesn't have an ACL, this is from the equivalent enriched hack.
@@ -136,3 +136,26 @@ export interface KeyPhrase {
     phrase: string;
     score: number;
 }
+
+export interface FlashcardHack extends Pick<Hack,
+'id'
+| 'title'
+| 'sourceId'
+| 'owner'
+| 'themeId'
+| 'isHidden'
+| 'editorialTags'
+| 'coverUrl'
+| 'segments'
+| 'type'
+| 'affiliate'
+| 'contributors'
+| 'createdAt'
+| 'updatedAt'
+| 'v'
+| 'sourceData'
+| 'baseLocaleHackId'
+| 'locale'
+| 'draftHackId'
+| 'draftHackVersion'> {
+}

package/src/hack/hack.ts

@@ -1,3 +1,4 @@
+import { PrimaryTopic } from '../topics/primary-topic';
 import { ExtractedSubject } from './extracted-subject';
 export interface Hack {
     /** The unique id of the hack. */
@@ -91,6 +92,8 @@ export interface Hack {
     };
     affiliate?: HackAffiliate;
     topics: HackTopic[];
+    /** Added April 2026. Aiming to replace topics. */
+    primaryTopics: PrimaryTopic[];
     contributors?: HackContributor[];
     type: HackType;
     sourceData?: HackSourceData;

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

@@ -26,6 +26,7 @@ export function mapToAppHackMetadata(hack: EnrichedHack): AppHackMetadata {
         description: hack.description,
         segments: toHackAppMetadataSegments(hack.segments),
         topics: hack.topics,
+        primaryTopics: hack.primaryTopics,
         contributors: hack.contributors,
         type: hack.type,
         sourceData: hack.sourceData,

package/src/hack-mapping/test-data/enriched-hack.json

@@ -2554,22 +2554,27 @@
     },
     "timeSaved": 499,
     "title": "Rich Dad Poor Dad",
-    "topics": [
-        {
-            "name": "Money & Investing"
-        },
-        {
-            "name": "Business"
+    "topics": [
+        {
+            "name": "Money & Investing"
+        },
+        {
+            "name": "Business"
         },
         {
             "name": "Career & Success"
         },
-        {
-            "name": "Leadership & Entrepreneurship"
-        }
-    ],
-    "type": "book",
-    "draftHackId": "3b24ef40-a60c-5767-93b5-f2c9dd94ceed",
+        {
+            "name": "Leadership & Entrepreneurship"
+        }
+    ],
+    "primaryTopics": [
+        {
+            "name": "Money & Investing"
+        }
+    ],
+    "type": "book",
+    "draftHackId": "3b24ef40-a60c-5767-93b5-f2c9dd94ceed",
     "draftHackVersion": 4,
     "updatedAt": "2023-07-21T07:02:16.240Z",
     "v": 402

package/src/hack-mapping/test-data/expected-app-full-hack.json

@@ -2489,21 +2489,26 @@
     },
     "timeSaved": 499,
     "title": "Rich Dad Poor Dad",
-    "topics": [
-        {
-            "name": "Money & Investing"
-        },
-        {
-            "name": "Business"
+    "topics": [
+        {
+            "name": "Money & Investing"
+        },
+        {
+            "name": "Business"
         },
         {
             "name": "Career & Success"
         },
-        {
-            "name": "Leadership & Entrepreneurship"
-        }
-    ],
-    "type": "book",
-    "updatedAt": "2023-07-21T07:02:16.240Z",
+        {
+            "name": "Leadership & Entrepreneurship"
+        }
+    ],
+    "primaryTopics": [
+        {
+            "name": "Money & Investing"
+        }
+    ],
+    "type": "book",
+    "updatedAt": "2023-07-21T07:02:16.240Z",
     "v": 402
 }

package/src/hack-mapping/test-data/expected-app-hack-metadata.json

@@ -73,21 +73,26 @@
     "themeId": "34",
     "timeSaved": 499,
     "title": "Rich Dad Poor Dad",
-    "topics": [
-        {
-            "name": "Money & Investing"
-        },
-        {
-            "name": "Business"
+    "topics": [
+        {
+            "name": "Money & Investing"
+        },
+        {
+            "name": "Business"
         },
         {
             "name": "Career & Success"
         },
-        {
-            "name": "Leadership & Entrepreneurship"
-        }
-    ],
-    "type": "book",
-    "updatedAt": "2023-07-21T07:02:16.240Z",
+        {
+            "name": "Leadership & Entrepreneurship"
+        }
+    ],
+    "primaryTopics": [
+        {
+            "name": "Money & Investing"
+        }
+    ],
+    "type": "book",
+    "updatedAt": "2023-07-21T07:02:16.240Z",
     "v": 402
 }

package/src/hack-mapping/test-data/expected-app-restricted-hack.json

@@ -779,21 +779,26 @@
     },
     "timeSaved": 499,
     "title": "Rich Dad Poor Dad",
-    "topics": [
-        {
-            "name": "Money & Investing"
-        },
-        {
-            "name": "Business"
+    "topics": [
+        {
+            "name": "Money & Investing"
+        },
+        {
+            "name": "Business"
         },
         {
             "name": "Career & Success"
         },
-        {
-            "name": "Leadership & Entrepreneurship"
-        }
-    ],
-    "type": "book",
-    "updatedAt": "2023-07-21T07:02:16.240Z",
+        {
+            "name": "Leadership & Entrepreneurship"
+        }
+    ],
+    "primaryTopics": [
+        {
+            "name": "Money & Investing"
+        }
+    ],
+    "type": "book",
+    "updatedAt": "2023-07-21T07:02:16.240Z",
     "v": 402
 }

package/src/hackbot/hack-generation-commands.ts

@@ -1,43 +1,45 @@
-import { KnowledgeSourceLocation } from './knowledge-source-location';
-
-export interface TriggerHackGenerationCommandPayload {
-    reference: string;
-    userId?: string;
-
-    hackFromUrl?: KnowledgeSourceLocation
-
-    hackFromUrlWithMetadata?: KnowledgeSourceLocation & {
-        typeOfHack: string; // in words e.g. "annual report", free text
-        toneOfVoice: string; // e.g. "professional", "casual", "enthusiastic", free text
-        insightsToEmphasise: string; // e.g. "key statistics", "quotes", "key facts", "keep it general", free text
-        takeawaysToEmphasise?: string; // e.g. "practical steps", "strategic advice", free text, for the "insights in action". If "shouldCreateTakeaways" is false, this will be omitted
-        shouldCreateTakeaways: boolean; // whether to create "insights in action"
-        title?: string;
-        contributors?: string;
-        useB2CSegmentLimits: boolean; // if true, use the B2C segment length limits (e.g. 850+ characters for insight bodies)
-    }
-
-    hackFromPodcastUrl?: KnowledgeSourceLocation & {
-        useB2CSegmentLimits?: boolean;
-    }
-
-    hackFromPodcastRSS?: {
-        rssUrl: string;
-        episodeNumber: number;
-    }
-
-    hackFromPodcastWithMetadata?: KnowledgeSourceLocation & {
-        podcastName: string;
-        episodeName: string;
-        episodeDescription: string;
-        episodeReleaseDate: string;
-        episodeImageUrl: string;
-        useB2CSegmentLimits: boolean;
-    }
-}
-
-export interface TriggerHackGenerationCommand {
-    id: string;
-    type: 'TriggerHackGeneration';
-    payload: TriggerHackGenerationCommandPayload;
-}
+export interface TriggerHackGenerationCommandPayload {
+    reference: string;
+    userId?: string;
+
+    hackFromUrl?: {
+        knowledgeSourceUrl: string;
+    }
+
+    hackFromUrlWithMetadata?: {
+        knowledgeSourceUrl: string;
+        typeOfHack: string; // in words e.g. "annual report", free text
+        toneOfVoice: string; // e.g. "professional", "casual", "enthusiastic", free text
+        insightsToEmphasise: string; // e.g. "key statistics", "quotes", "key facts", "keep it general", free text
+        takeawaysToEmphasise?: string; // e.g. "practical steps", "strategic advice", free text, for the "insights in action". If "shouldCreateTakeaways" is false, this will be omitted
+        shouldCreateTakeaways: boolean; // whether to create "insights in action"
+        title?: string;
+        contributors?: string;
+        useB2CSegmentLimits: boolean; // if true, use the B2C segment length limits (e.g. 850+ characters for insight bodies)
+    }
+
+    hackFromPodcastUrl?: {
+        knowledgeSourceUrl: string;
+    }
+
+    hackFromPodcastRSS?: {
+        rssUrl: string;
+        episodeNumber: number;
+    }
+
+    hackFromPodcastWithMetadata?: {
+        knowledgeSourceUrl: string;
+        podcastName: string;
+        episodeName: string;
+        episodeDescription: string;
+        episodeReleaseDate: string;
+        episodeImageUrl: string;
+        useB2CSegmentLimits: boolean;
+    }
+}
+
+export interface TriggerHackGenerationCommand {
+    id: string;
+    type: 'TriggerHackGeneration';
+    payload: TriggerHackGenerationCommandPayload;
+}

package/src/hackbot/hack-generation-trigger.ts

@@ -1,5 +1,4 @@
 import { SupportedDraftHackGenerationType } from '../knowledge-source-parsing/knowledge-source-parsing-commands';
-import { KnowledgeSourceLocation } from './knowledge-source-location';
 
 export interface HackGenerationTrigger {
     id: string;
@@ -9,9 +8,12 @@ export interface HackGenerationTrigger {
     userId?: string;
     reference?: string;
 
-    hackFromUrl?: KnowledgeSourceLocation
+    hackFromUrl?: {
+        knowledgeSourceUrl: string;
+    }
 
-    hackFromUrlWithMetadata?: KnowledgeSourceLocation & {
+    hackFromUrlWithMetadata?: {
+        knowledgeSourceUrl: string;
         typeOfHack: string; // in words e.g. "annual report", free text
         toneOfVoice: string; // e.g. "professional", "casual", "enthusiastic", free text
         insightsToEmphasise: string; // e.g. "key statistics", "quotes", "key facts", "keep it general", free text
@@ -22,8 +24,8 @@ export interface HackGenerationTrigger {
         useB2CSegmentLimits: boolean; // if true, use the B2C segment length limits (e.g. 850+ characters for insight bodies)
     }
 
-    hackFromPodcastUrl?: KnowledgeSourceLocation & {
-        useB2CSegmentLimits?: boolean;
+    hackFromPodcastUrl?: {
+        knowledgeSourceUrl: string;
     }
 
     hackFromPodcastRSS?: {
@@ -31,7 +33,8 @@ export interface HackGenerationTrigger {
         episodeNumber: number;
     }
 
-    hackFromPodcastWithMetadata?: KnowledgeSourceLocation & {
+    hackFromPodcastWithMetadata?: {
+        knowledgeSourceUrl: string;
         podcastName: string;
         episodeName: string;
         episodeDescription: string;

package/src/identity-provider/identity-provider.ts

@@ -30,8 +30,6 @@ export interface IdentityProviderConfig {
         'custom:ext_organisation_id'?: string;
         'custom:ext_user_id'?: string;
         'custom:country_code'?: string;
-        'custom:team_name'?: string;
-        'custom:is_manager'?: string;
     };
 }
 
@@ -46,6 +44,4 @@ export interface IdentityProviderClaims {
     given_name?: string;
     externalUserId?: string;
     countryCode?: string;
-    teamName?: string;
-    isManager?: string
-}
+}

package/src/index.ts

@@ -166,6 +166,9 @@ export * from './text-to-speech/text-segment';
 export * from './theme/theme';
 export * from './theme/theme-events';
 
+export * from './topics/primary-topic';
+export * from './topics/primary-topic-mapping';
+
 export * from './translation/translation-events';
 export * from './translation/translation';
 

package/src/interest/interest.ts

@@ -9,6 +9,7 @@ export interface UserInterests {
     id: string;
     userId: string;
     interests: Interest[];
+    primaryInterests: Interest[];
     createdAt: string;
     updatedAt: string;
     v: number;

package/src/knowledge-source-parsing/knowledge-source-metadata.ts

@@ -22,8 +22,6 @@ export interface KnowledgeSourceMetadata {
     url: string;
     // the location where the original knowledge source file is stored
     s3Path: string;
-    // the location where the transcript-only file is stored, when a transcript exists
-    transcriptS3Path?: string;
     // the location where the parsed knowledge source content is stored
     parsedContentS3Path: string;
     // path of parsed tables stored in s3, of type TableEntry[]

package/src/knowledge-source-parsing/knowledge-source-parsing-commands.ts

@@ -1,50 +1,41 @@
-import { KnowledgeSourceUserDefinedMetadata } from './knowledge-source-metadata';
-
-export enum SupportedDraftHackGenerationType {
-    Book = 'book',
-    Podcast = 'podcast',
-}
-
-export interface ParseKnowledgeSourceCommand {
-    id: string;
-    type: 'ParseKnowledgeSource';
-    payload: {
-        knowledgeSourceUrl: string;
-        knowledgeSourceBucket?: string;
-        knowledgeSourceKey?: string;
-        reference: string;
-        hackGenerationTriggerId?: string;
-        triggerDraftHackGeneration: boolean;
-        typeOfDraftHackToGenerate: SupportedDraftHackGenerationType;
-    };
-}
-
-export interface ParseKnowledgeSourceWithMetadataCommand {
-    id: string;
-    type: 'ParseKnowledgeSourceWithMetadata';
-    payload: {
-        knowledgeSourceUrl: string;
-        knowledgeSourceBucket?: string;
-        knowledgeSourceKey?: string;
-        reference: string;
-        hackGenerationTriggerId?: string;
-        triggerDraftHackGeneration: boolean;
-        typeOfDraftHackToGenerate: SupportedDraftHackGenerationType;
-        userDefinedMetadata: KnowledgeSourceUserDefinedMetadata;
-    };
-}
-
-export interface ParseKnowledgeSourceFromPodcastCommand {
-    id: string;
-    type: 'ParseKnowledgeSourceFromPodcast';
-    payload: {
-        podcastUrl: string;
-        podcastBucket?: string;
-        podcastKey?: string;
-        rssEpisodeNumber?: number;
-        reference: string;
-        hackGenerationTriggerId?: string;
-        triggerDraftHackGeneration: boolean;
-        typeOfDraftHackToGenerate: SupportedDraftHackGenerationType;
-    };
-}
+import { KnowledgeSourceUserDefinedMetadata } from './knowledge-source-metadata';
+
+export enum SupportedDraftHackGenerationType {
+    Book = 'book',
+    Podcast = 'podcast',
+}
+
+export interface ParseKnowledgeSourceCommand {
+    id: string;
+    type: 'ParseKnowledgeSource';
+    payload: {
+        knowledgeSourceUrl: string;
+        reference: string;
+        triggerDraftHackGeneration: boolean;
+        typeOfDraftHackToGenerate: SupportedDraftHackGenerationType;
+    };
+}
+
+export interface ParseKnowledgeSourceWithMetadataCommand {
+    id: string;
+    type: 'ParseKnowledgeSourceWithMetadata';
+    payload: {
+        knowledgeSourceUrl: string;
+        reference: string;
+        triggerDraftHackGeneration: boolean;
+        typeOfDraftHackToGenerate: SupportedDraftHackGenerationType;
+        userDefinedMetadata: KnowledgeSourceUserDefinedMetadata;
+    };
+}
+
+export interface ParseKnowledgeSourceFromPodcastCommand {
+    id: string;
+    type: 'ParseKnowledgeSourceFromPodcast';
+    payload: {
+        podcastUrl: string;
+        rssEpisodeNumber?: number;
+        reference: string;
+        triggerDraftHackGeneration: boolean;
+        typeOfDraftHackToGenerate: SupportedDraftHackGenerationType;
+    };
+}

package/src/knowledge-source-parsing/podcast-metadata.ts

@@ -22,7 +22,6 @@ export interface PodcastMetadata extends PodcastMetadataWithoutTranscript {
     updatedAt: string;
     
     transcript: string;
-    transcriptS3Path?: string;
     summary: string;
     vectorDbNamespace: string;
     purpose: string;

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

@@ -2,6 +2,7 @@
 import { ExtractedSubject } from '../hack/extracted-subject';
 import { HackAffiliate, HackContributor, HackType, HackSourceData, HackTopic, HackExternalLink } from '../hack/hack';
 import { Segment } from '../segment/segment';
+import { PrimaryTopic } from '../topics/primary-topic';
 
 export interface PendingHack {
     id: string;
@@ -24,6 +25,7 @@ export interface PendingHack {
     copyrightFreeCoverUrl?: string;
     affiliate?: HackAffiliate;
     topics: HackTopic[];
+    primaryTopics: PrimaryTopic[];
     contributors: HackContributor[];
     type: HackType;
     sourceData?: HackSourceData;

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

@@ -7,18 +7,10 @@ export interface SetMockResponseRequest<T = any> {
     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 InternalLambdaRequest<T = any> {
+    context: Context;
+    payload: T;
+}
 
 export interface DeleteMockResponseRequest {
     transactionId: string;

package/src/spark/spark.ts

@@ -51,7 +51,6 @@ export type SparkHack = Pick<Hack,
 | 'isHidden'
 | 'editorialTags'
 | 'coverUrl'
-| 'topics'
 | 'type'
 | 'affiliate'
 | 'contributors'