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

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

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

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

@@ -5,7 +5,6 @@ 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 */
@@ -45,7 +44,6 @@ 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: FlashcardHack;
+    hack: Hack;
 
     /*
     A hack's ACL. The Hack model doesn't have an ACL, this is from the equivalent enriched hack.
@@ -136,26 +136,3 @@ 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,4 +1,3 @@
-import { PrimaryTopic } from '../topics/primary-topic';
 import { ExtractedSubject } from './extracted-subject';
 export interface Hack {
     /** The unique id of the hack. */
@@ -92,7 +91,6 @@ export interface Hack {
     };
     affiliate?: HackAffiliate;
     topics: HackTopic[];
-    primaryTopics: PrimaryTopic[];
     contributors?: HackContributor[];
     type: HackType;
     sourceData?: HackSourceData;

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

@@ -26,7 +26,6 @@ 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,27 +2554,22 @@
     },
     "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"
-        }
-    ],
-    "primaryTopics": [
-        {
-            "name": "Money & Investing"
-        }
-    ],
-    "type": "book",
-    "draftHackId": "3b24ef40-a60c-5767-93b5-f2c9dd94ceed",
+        {
+            "name": "Leadership & Entrepreneurship"
+        }
+    ],
+    "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,26 +2489,21 @@
     },
     "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"
-        }
-    ],
-    "primaryTopics": [
-        {
-            "name": "Money & Investing"
-        }
-    ],
-    "type": "book",
-    "updatedAt": "2023-07-21T07:02:16.240Z",
+        {
+            "name": "Leadership & Entrepreneurship"
+        }
+    ],
+    "type": "book",
+    "updatedAt": "2023-07-21T07:02:16.240Z",
     "v": 402
 }

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

@@ -73,26 +73,21 @@
     "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"
-        }
-    ],
-    "primaryTopics": [
-        {
-            "name": "Money & Investing"
-        }
-    ],
-    "type": "book",
-    "updatedAt": "2023-07-21T07:02:16.240Z",
+        {
+            "name": "Leadership & Entrepreneurship"
+        }
+    ],
+    "type": "book",
+    "updatedAt": "2023-07-21T07:02:16.240Z",
     "v": 402
 }

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

@@ -779,26 +779,21 @@
     },
     "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"
-        }
-    ],
-    "primaryTopics": [
-        {
-            "name": "Money & Investing"
-        }
-    ],
-    "type": "book",
-    "updatedAt": "2023-07-21T07:02:16.240Z",
+        {
+            "name": "Leadership & Entrepreneurship"
+        }
+    ],
+    "type": "book",
+    "updatedAt": "2023-07-21T07:02:16.240Z",
     "v": 402
 }

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

@@ -1,45 +1,43 @@
-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;
-}
+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;
+}

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

@@ -1,4 +1,5 @@
 import { SupportedDraftHackGenerationType } from '../knowledge-source-parsing/knowledge-source-parsing-commands';
+import { KnowledgeSourceLocation } from './knowledge-source-location';
 
 export interface HackGenerationTrigger {
     id: string;
@@ -8,12 +9,9 @@ export interface HackGenerationTrigger {
     userId?: string;
     reference?: string;
 
-    hackFromUrl?: {
-        knowledgeSourceUrl: string;
-    }
+    hackFromUrl?: KnowledgeSourceLocation
 
-    hackFromUrlWithMetadata?: {
-        knowledgeSourceUrl: string;
+    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
@@ -24,8 +22,8 @@ export interface HackGenerationTrigger {
         useB2CSegmentLimits: boolean; // if true, use the B2C segment length limits (e.g. 850+ characters for insight bodies)
     }
 
-    hackFromPodcastUrl?: {
-        knowledgeSourceUrl: string;
+    hackFromPodcastUrl?: KnowledgeSourceLocation & {
+        useB2CSegmentLimits?: boolean;
     }
 
     hackFromPodcastRSS?: {
@@ -33,8 +31,7 @@ export interface HackGenerationTrigger {
         episodeNumber: number;
     }
 
-    hackFromPodcastWithMetadata?: {
-        knowledgeSourceUrl: string;
+    hackFromPodcastWithMetadata?: KnowledgeSourceLocation & {
         podcastName: string;
         episodeName: string;
         episodeDescription: string;

package/src/hackbot/knowledge-source-location.ts

@@ -0,0 +1,5 @@
+export interface KnowledgeSourceLocation {
+    knowledgeSourceUrl: string;
+    knowledgeSourceBucket?: string;
+    knowledgeSourceKey?: string;
+}

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

@@ -30,6 +30,8 @@ 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;
     };
 }
 
@@ -44,4 +46,6 @@ export interface IdentityProviderClaims {
     given_name?: string;
     externalUserId?: string;
     countryCode?: string;
-}
+    teamName?: string;
+    isManager?: string
+}

package/src/index.ts

@@ -166,9 +166,6 @@ 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/knowledge-source-parsing/knowledge-source-metadata.ts

@@ -20,10 +20,12 @@ export interface KnowledgeSourceMetadata {
     
     // the original source of the knowledge source (e.g. URL, file path in hackbot-service s3, etc)
     url: string;
-    // the location where the original knowledge source file is stored
-    s3Path: string;
-    // the location where the parsed knowledge source content is stored
-    parsedContentS3Path: 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[]
     tablesS3Path?: string;
 }

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

@@ -1,41 +1,50 @@
-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;
-    };
-}
+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;
+    };
+}

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

@@ -21,8 +21,9 @@ export interface PodcastMetadata extends PodcastMetadataWithoutTranscript {
     createdAt: string;
     updatedAt: string;
     
-    transcript: string;
-    summary: string;
+    transcript: string;
+    transcriptS3Path?: string;
+    summary: string;
     vectorDbNamespace: string;
     purpose: string;
     hosts: PodcastConfirmedContributor[];

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

@@ -2,7 +2,6 @@
 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;
@@ -25,7 +24,6 @@ export interface PendingHack {
     copyrightFreeCoverUrl?: string;
     affiliate?: HackAffiliate;
     topics: HackTopic[];
-    primaryTopics: PrimaryTopic[];
     contributors: HackContributor[];
     type: HackType;
     sourceData?: HackSourceData;

package/src/spark/spark.ts

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

package/dist/cjs/topics/primary-topic-mapping.d.ts

@@ -1,7 +0,0 @@
-import { PrimaryTopic } from './primary-topic';
-export declare const VALID_PRIMARY_TOPIC_TAGS: string[];
-export declare const OLD_TOPIC_TAGS: string[];
-export type PrimaryTopicTag = (typeof VALID_PRIMARY_TOPIC_TAGS)[number];
-export type OldTopicTag = (typeof OLD_TOPIC_TAGS)[number];
-export declare function mapPrimaryTopicsToOldTopics(primaryTopics: Array<PrimaryTopic | string>): OldTopicTag[];
-//# sourceMappingURL=primary-topic-mapping.d.ts.map

package/dist/cjs/topics/primary-topic-mapping.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"primary-topic-mapping.d.ts","sourceRoot":"","sources":["../../../src/topics/primary-topic-mapping.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C,eAAO,MAAM,wBAAwB,UAiCpC,CAAC;AAEF,eAAO,MAAM,cAAc,UAmB1B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,wBAAwB,CAAC,CAAC,MAAM,CAAC,CAAC;AACxE,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC;AA0C1D,wBAAgB,2BAA2B,CAAC,aAAa,EAAE,KAAK,CAAC,YAAY,GAAG,MAAM,CAAC,GAAG,WAAW,EAAE,CAQtG"}