@uptime.app/contracts 2.0.0-beta.1 → 2.0.0-beta.2

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

@@ -17,8 +17,7 @@ export interface DraftHack extends DraftHackContent {
     updatedAt: string;
     publishedAt?: string;
     publishedVersion?: number;
-    owner: string;
-    tenant: string;
+    owner?: string;
     /** workflowStatus was added in May 2022 as we move toward UGC. Older drafts have not been backfilled */
     workflowStatus?: DraftHackWorkflowStatus;
     /** added in Nov 2022. Set to true whenever content changes are made to the draft */

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

@@ -12,6 +12,8 @@ export interface DraftHackGenerated {
         draftHackId: string;
         draftHackContent: GeneratedDraftHackContent;
 
+        hackGenerationTriggerId: string;
+
         // introduced 11/09/2024
         researchNotes?: {
             insight1: string;
@@ -26,6 +28,7 @@ export interface DraftHackGenerationFailed {
     type: 'DraftHackGenerationFailed';
     payload: {
         reference: string;
+        hackGenerationTriggerId: string;
         errorMessage: string;
     }
 }

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

@@ -27,8 +27,6 @@ export interface EnrichedHack {
     //@todo: Deprecate
     source?: KnowledgeSource;
     owner: string;
-    /** Added in Feb 2022. @todo make required after replay */
-    tenant: string;
     acl: string[];
     theme: Theme;
     title: string;

package/src/hack/hack.ts

@@ -10,8 +10,6 @@ export interface Hack {
     createdAt: string;
     updatedAt: string;
     owner: string;
-    /** Added in Feb 2022. @todo make required after replay */
-    tenant: string;
     sourceId?: string;
     title: string;
     themeId: string;

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

@@ -0,0 +1,42 @@
+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". When null, don't generate "insights in action"
+        title?: string;
+        contributors?: string;
+    }
+
+    hackFromPodcastUrl?: {
+        knowledgeSourceUrl: string;
+    }
+
+    hackFromPodcastRSS?: {
+        rssUrl: string;
+        episodeNumber: number;
+    }
+
+    hackFromPodcastWithMetadata?: {
+        knowledgeSourceUrl: string;
+        podcastName: string;
+        episodeName: string;
+        episodeDescription: string;
+        episodeReleaseDate: string;
+        episodeImageUrl: string
+    }
+}
+
+export interface TriggerHackGenerationCommand {
+    id: string;
+    type: 'TriggerHackGeneration';
+    payload: TriggerHackGenerationCommandPayload;
+}

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

@@ -5,7 +5,8 @@ export interface HackGenerationTrigger {
     v: number;
     createdAt: string;
     updatedAt: string;
-    userId: string;
+    userId?: string;
+    reference?: string;
 
     hackFromUrl?: {
         knowledgeSourceUrl: string;
@@ -41,4 +42,13 @@ export interface HackGenerationTrigger {
 
     // computed based on 'type of hack'
     typeOfDraftHackToGenerate: SupportedDraftHackGenerationType;
+    generationStatus: HackGenerationStatus;
+}
+
+export enum HackGenerationStatus {
+    ParsingKnowledgeSource = 'ParsingKnowledgeSource', // when the trigger is created
+    KnowledgeSourceParsingFailed = 'KnowledgeSourceParsingFailed',
+    GeneratingHack = 'GeneratingHack', // just after the knowledge source has been parsed
+    HackGenerationFinished = 'HackGenerationFinished',
+    HackGenerationFailed = 'HackGenerationFailed',
 }

package/src/index.ts

@@ -69,6 +69,7 @@ export * from './hack-metadata/hack-metadata-events';
 export * from './hack-of-the-day/hack-of-the-day';
 export * from './hack-of-the-day/hack-of-the-day-events';
 
+export * from './hackbot/hack-generation-commands';
 export * from './hackbot/hack-generation-trigger';
 export * from './hackbot/hack-generation-trigger-events';
 

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

@@ -29,3 +29,12 @@ export interface KnowledgeSourceUserDefinedMetadata {
     contributors: string;
     type: string;
 }
+
+// created for gpt3-playground to be able to parse the metadata from hack generations triggered via slack
+export interface SlackDefinedMetadata {
+    title: string;
+    contributors: string;
+    type: string;
+    hintsForInsights: string;
+    createActionsForInsights: boolean;
+}

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

@@ -12,6 +12,7 @@ export interface KnowledgeSourceParsed {
         v: number;
         reference: string;
         parsedKnowledgeSourceId: string;
+        hackGenerationTriggerId: string;
         typeOfDraftHackToGenerate?: SupportedDraftHackGenerationType;
         userHackGenerationOptions?: UserHackGenerationOptions;
         userDefinedMetadata?: KnowledgeSourceUserDefinedMetadata;
@@ -24,5 +25,6 @@ export interface KnowledgeSourceParsingFailed {
     payload: {
         reference: string;
         errorMessage: string;
+        hackGenerationTriggerId: string;
     }
 }

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

@@ -10,6 +10,7 @@ export interface PodcastParsed {
         // the version
         v: number;
         reference: string;
+        hackGenerationTriggerId: string,
         podcastId: string; // also the parsed podcast id
         typeOfDraftHackToGenerate?: SupportedDraftHackGenerationType;
         userHackGenerationOptions?: UserHackGenerationOptions;
@@ -21,6 +22,7 @@ export interface PodcastParsingFailed {
     type: 'PodcastParsingFailed';
     payload: {
         reference: string;
+        hackGenerationTriggerId: string,
         errorMessage: string;
     }
 }

package/src/partner/partner.ts

@@ -4,6 +4,4 @@ export interface Partner {
     createdAt: string;
     updatedAt: string;
     owner: string;
-    /** Added in Feb 2022. @todo make required after replay */
-    tenant: string;
 }

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

@@ -11,8 +11,7 @@ export interface PendingHack {
     v: number;
     createdAt: string;
     updatedAt: string;
-    owner: string;
-    tenant: string;
+    owner?: string;
     draftHackId: string;
     draftHackVersion: number;
     hackId: string;

package/src/profile/profile.ts

@@ -8,8 +8,6 @@ export interface StoredProfile {
     avatarUrl: string;
     name: string;
     owner: string;
-    /** Added in Feb 2022. @todo make required after replay */
-    tenant: string;
     handle: string;
     _sanitisedHandle?: string; // use to determinate uniqueness for a handle, despite the case of it
     headerImageUrl?: string;

package/src/spark/spark.ts

@@ -47,7 +47,6 @@ export type SparkHack = Pick<Hack,
 'id'
 | 'title'
 | 'owner'
-| 'tenant'
 | 'themeId'
 | 'isHidden'
 | 'editorialTags'

package/src/user-context/user-context.ts

@@ -10,7 +10,6 @@ export interface UserContext {
     organisationIds: string[];
     roles: string[];
     acl: string[];
-    permissions: string[];
     partnerId?: string;
     brandId?: string;
     skinId?: string;