@uptime.app/contracts 1.0.68 → 1.0.70-rc.0

package/src/hack/hack-with-voice.ts

@@ -1,33 +1,33 @@
-import { Segment } from '../segment/segment';
-
-/**
- * HackWithVoice contains the Hack segments a a few basic Hack fields, it does not contain other Hack information.
- * This decision was made due to the complexity of editorialTags and updating them.
- */
-export interface HackWithVoice {
-    /** NOT the id of the hack. Use hackId. The id cannot be the hackId as otherwise id would be duplicated for each voice which would break message replay */
-    id: string;
-    /** The id of the hack */
-    hackId: string;
-    baseLocaleHackId: string;
-    /** The id of voice used to generate the audio */
-    voiceId: string;
-    /** True if this is the default voice */
-    isDefaultVoice: boolean;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-
-    segments: {
-        favouriteQuote: Segment;
-        inANutshell: Segment;
-        introduction: Segment;
-        insights: Segment[];
-        conclusion: Segment;
-        // composite segments
-        overview: Segment;
-        shareableOverview: Segment;
-        hereAreTheInsights: Segment;
-        putInAction?: Segment;
-    }
-}
+import { Segment } from '../segment/segment';
+
+/**
+ * HackWithVoice contains the Hack segments a a few basic Hack fields, it does not contain other Hack information.
+ * This decision was made due to the complexity of editorialTags and updating them.
+ */
+export interface HackWithVoice {
+    /** NOT the id of the hack. Use hackId. The id cannot be the hackId as otherwise id would be duplicated for each voice which would break message replay */
+    id: string;
+    /** The id of the hack */
+    hackId: string;
+    baseLocaleHackId: string;
+    /** The id of voice used to generate the audio */
+    voiceId: string;
+    /** True if this is the default voice */
+    isDefaultVoice: boolean;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+
+    segments: {
+        favouriteQuote: Segment;
+        inANutshell: Segment;
+        introduction: Segment;
+        insights: Segment[];
+        conclusion: Segment;
+        // composite segments
+        overview: Segment;
+        shareableOverview: Segment;
+        hereAreTheInsights: Segment;
+        putInAction?: Segment;
+    }
+}

package/src/hack/hack.ts

@@ -1,116 +1,116 @@
-import { ExtractedSubject } from './extracted-subject';
-export interface Hack {
-    /** The unique id of the hack. */
-    id: string;
-    /** The locale (language and region) of the hack e.g. fr-FR. Use @uptime.app/localisation-contracts Mandatory property since 12/01/2023. */
-    locale: string;
-    /** The id of the hack in its original locale. Mandatory property since 12/01/2023. */
-    baseLocaleHackId: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    owner: string;
-    sourceId?: string;
-    title: string;
-    themeId: string;
-
-    /** introduced Oct 2023 **/
-    draftHackId: string;
-    draftHackVersion: number;
-
-    // TODO I'd remove it altogether, but it would be a breaking contract change. Thoughts?
-    isHidden?: boolean;
-
-    editorialTags?: 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;
-    notifications?: {
-        aiGeneratedText?: string
-        humanCuratedText?: string;
-    },
-    segments: {
-        favouriteQuote: {
-            id: string;
-            /** added 04/2023 */
-            v?: number;
-        };
-        inANutshell: {
-            id: string;
-            /** added 04/2023 */
-            v?: number;
-        };
-        introduction: {
-            id: string;
-            /** added 04/2023 */
-            v?: number;
-        };
-        insights: {
-            id: string
-            /** added 04/2023 */
-            v?: number;
-        }[];
-        conclusion: {
-            id: string;
-            /** added 04/2023 */
-            v?: number;
-        };
-
-        // composite segments
-        overview: {
-            id: string;
-            /** added 04/2023 */
-            v?: number;
-        };
-        shareableOverview: {
-            id: string;
-            /** added 04/2023 */
-            v?: number;
-        };
-        hereAreTheInsights: {
-            id: string;
-            /** added 04/2023 */
-            v?: number;
-        };
-        putInAction?: {
-            id: string;
-            /** added 04/2023 */
-            v?: number;
-        };
-    };
-    affiliate?: HackAffiliate;
-    topics: HackTopic[];
-    contributors?: HackContributor[];
-    type: HackType;
-    sourceData?: HackSourceData;
-    externalLink?: HackExternalLink;
-
-    /** added Mar 2024 */
-    // TODO make it mandatory after a republish
-    subjects?: ExtractedSubject[];
-}
-
-export interface HackContributor {
-    name: string;
-}
-
-export interface HackTopic {
-    name: string;
-}
-
-export interface HackAffiliate {
-    url: string;
-    name: string;
-}
-
-export type HackType = 'book' | 'course' | 'documentary' | 'podcast' | 'original';
-
-export interface HackSourceData {
-    episodeTitle?: string;
-    releaseDate?: string;
-}
-
-export interface HackExternalLink {
-    url: string;
-    type: 'Website' | 'Book' | 'Course' | 'Podcast' | 'Video' | 'Other';
-}
+import { ExtractedSubject } from './extracted-subject';
+export interface Hack {
+    /** The unique id of the hack. */
+    id: string;
+    /** The locale (language and region) of the hack e.g. fr-FR. Use @uptime.app/localisation-contracts Mandatory property since 12/01/2023. */
+    locale: string;
+    /** The id of the hack in its original locale. Mandatory property since 12/01/2023. */
+    baseLocaleHackId: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    owner: string;
+    sourceId?: string;
+    title: string;
+    themeId: string;
+
+    /** introduced Oct 2023 **/
+    draftHackId: string;
+    draftHackVersion: number;
+
+    // TODO I'd remove it altogether, but it would be a breaking contract change. Thoughts?
+    isHidden?: boolean;
+
+    editorialTags?: 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;
+    notifications?: {
+        aiGeneratedText?: string
+        humanCuratedText?: string;
+    },
+    segments: {
+        favouriteQuote: {
+            id: string;
+            /** added 04/2023 */
+            v?: number;
+        };
+        inANutshell: {
+            id: string;
+            /** added 04/2023 */
+            v?: number;
+        };
+        introduction: {
+            id: string;
+            /** added 04/2023 */
+            v?: number;
+        };
+        insights: {
+            id: string
+            /** added 04/2023 */
+            v?: number;
+        }[];
+        conclusion: {
+            id: string;
+            /** added 04/2023 */
+            v?: number;
+        };
+
+        // composite segments
+        overview: {
+            id: string;
+            /** added 04/2023 */
+            v?: number;
+        };
+        shareableOverview: {
+            id: string;
+            /** added 04/2023 */
+            v?: number;
+        };
+        hereAreTheInsights: {
+            id: string;
+            /** added 04/2023 */
+            v?: number;
+        };
+        putInAction?: {
+            id: string;
+            /** added 04/2023 */
+            v?: number;
+        };
+    };
+    affiliate?: HackAffiliate;
+    topics: HackTopic[];
+    contributors?: HackContributor[];
+    type: HackType;
+    sourceData?: HackSourceData;
+    externalLink?: HackExternalLink;
+
+    /** added Mar 2024 */
+    // TODO make it mandatory after a republish
+    subjects?: ExtractedSubject[];
+}
+
+export interface HackContributor {
+    name: string;
+}
+
+export interface HackTopic {
+    name: string;
+}
+
+export interface HackAffiliate {
+    url: string;
+    name: string;
+}
+
+export type HackType = 'book' | 'course' | 'documentary' | 'podcast' | 'original';
+
+export interface HackSourceData {
+    episodeTitle?: string;
+    releaseDate?: string;
+}
+
+export interface HackExternalLink {
+    url: string;
+    type: 'Website' | 'Book' | 'Course' | 'Podcast' | 'Video' | 'Other';
+}

package/src/hack/publish-hack-command.ts

@@ -1,18 +1,20 @@
-export interface PublishHackCommandBody {
-    // a command needs an id and a version so that it can be more easily replayed
-    // for this specific PublishHack command, the id is the draftHackId and the version is the timestamp
-    id: string;
-    v: number;
-    draftHackId: string;
-    draftHackVersion: number;
-    hackId: string;
-    publishSource: PublishHackSource;
-}
-
-export type PublishHackSource = 'web-app' | 'cms' | 'script' | 'translation';
-
-export interface PublishHackCommand {
-    id: string;
-    type: 'PublishHackCommand';
-    payload: PublishHackCommandBody;
-}
+export interface PublishHackCommandBody {
+    // a command needs an id and a version so that it can be more easily replayed
+    // for this specific PublishHack command, the id is the draftHackId and the version is the timestamp
+    id: string;
+    v: number;
+    draftHackId: string;
+    draftHackVersion: number;
+    hackId: string;
+    publishSource: PublishHackSource;
+    /** if no voice ids are specified then all voices are generated */
+    voiceIds?: string[];
+}
+
+export type PublishHackSource = 'web-app' | 'cms' | 'script' | 'translation';
+
+export interface PublishHackCommand {
+    id: string;
+    type: 'PublishHackCommand';
+    payload: PublishHackCommandBody;
+}

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

@@ -1,21 +1,21 @@
-import { HackMetadata } from './hack-metadata';
-
-export interface HackMetadataCreatedEvent {
-    id: string;
-    type: 'HackMetadataCreated';
-    payload: HackMetadata;
-}
-
-export interface HackMetadataUpdatedEvent {
-    id: string;
-    type: 'HackMetadataUpdated';
-    payload: HackMetadata;
-}
-
-export interface HackMetadataDeletedEvent {
-    id: string;
-    type: 'HackMetadataDeleted';
-    payload: HackMetadata;
-}
-
-export type HackMetadataChangedEvent = HackMetadataCreatedEvent | HackMetadataUpdatedEvent | HackMetadataDeletedEvent;
+import { HackMetadata } from './hack-metadata';
+
+export interface HackMetadataCreatedEvent {
+    id: string;
+    type: 'HackMetadataCreated';
+    payload: HackMetadata;
+}
+
+export interface HackMetadataUpdatedEvent {
+    id: string;
+    type: 'HackMetadataUpdated';
+    payload: HackMetadata;
+}
+
+export interface HackMetadataDeletedEvent {
+    id: string;
+    type: 'HackMetadataDeleted';
+    payload: HackMetadata;
+}
+
+export type HackMetadataChangedEvent = HackMetadataCreatedEvent | HackMetadataUpdatedEvent | HackMetadataDeletedEvent;

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

@@ -1,17 +1,17 @@
-import { ExtractedSubject } from '../hack/extracted-subject';
-
-export interface HackMetadata {
-    // hackId
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-
-    hackId: string;
-    baseLocaleHackId: string;
-    draftHackId: string;
-    subjects: {
-        aiGenerated?: ExtractedSubject[],
-        humanCurated?: ExtractedSubject[]
-    }
-}
+import { ExtractedSubject } from '../hack/extracted-subject';
+
+export interface HackMetadata {
+    // hackId
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+
+    hackId: string;
+    baseLocaleHackId: string;
+    draftHackId: string;
+    subjects: {
+        aiGenerated?: ExtractedSubject[],
+        humanCurated?: ExtractedSubject[]
+    }
+}

package/src/hack-of-the-day/hack-of-the-day-events.ts

@@ -1,21 +1,21 @@
-import { HackOfTheDay } from './hack-of-the-day';
-
-export interface HackOfTheDayCreatedEvent {
-    id: string;
-    type: 'HackOfTheDayCreated';
-    payload: HackOfTheDay;
-}
-
-export interface HackOfTheDayUpdatedEvent {
-    id: string;
-    type: 'HackOfTheDayUpdated';
-    payload: HackOfTheDay;
-}
-
-export interface HackOfTheDayDeletedEvent {
-    id: string;
-    type: 'HackOfTheDayDeleted';
-    payload: HackOfTheDay;
-}
-
-export type HackOfTheDayChangedEvent = HackOfTheDayCreatedEvent | HackOfTheDayUpdatedEvent | HackOfTheDayDeletedEvent;
+import { HackOfTheDay } from './hack-of-the-day';
+
+export interface HackOfTheDayCreatedEvent {
+    id: string;
+    type: 'HackOfTheDayCreated';
+    payload: HackOfTheDay;
+}
+
+export interface HackOfTheDayUpdatedEvent {
+    id: string;
+    type: 'HackOfTheDayUpdated';
+    payload: HackOfTheDay;
+}
+
+export interface HackOfTheDayDeletedEvent {
+    id: string;
+    type: 'HackOfTheDayDeleted';
+    payload: HackOfTheDay;
+}
+
+export type HackOfTheDayChangedEvent = HackOfTheDayCreatedEvent | HackOfTheDayUpdatedEvent | HackOfTheDayDeletedEvent;

package/src/hack-of-the-day/hack-of-the-day.ts

@@ -1,13 +1,13 @@
-export const HackOfTheDayDateFormat = 'YYYY-MM-DD';
-
-export interface HackOfTheDay {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    hackId: string;
-    date: string;
-    selectedBy?: string;
-    locale: string;
-    baseLocaleHackId: string;
-}
+export const HackOfTheDayDateFormat = 'YYYY-MM-DD';
+
+export interface HackOfTheDay {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    hackId: string;
+    date: string;
+    selectedBy?: string;
+    locale: string;
+    baseLocaleHackId: string;
+}

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

@@ -0,0 +1,21 @@
+import { HackGenerationTrigger } from './hack-generation-trigger'
+
+export interface HackGenerationTriggerCreatedEvent {
+    id: string;
+    type: 'HackGenerationTriggerCreated';
+    payload: HackGenerationTrigger;
+}
+
+export interface HackGenerationTriggerUpdatedEvent {
+    id: string;
+    type: 'HackGenerationTriggerUpdated';
+    payload: HackGenerationTrigger;
+}
+
+export interface HackGenerationTriggerDeletedEvent {
+    id: string;
+    type: 'HackGenerationTriggerDeleted';
+    payload: HackGenerationTrigger;
+}
+
+export type HackGenerationTriggerChangedEvent = HackGenerationTriggerCreatedEvent | HackGenerationTriggerUpdatedEvent | HackGenerationTriggerDeletedEvent;

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

@@ -0,0 +1,12 @@
+export interface HackGenerationTrigger {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    userId: string;
+
+    knowledgeSourceUrl: string;
+    typeOfHack: string; // in words e.g. "anual report", free text
+    toneOfVoice: string; // e.g. "professional", "casual", "enthusiastic", free text
+    takeawaysToEmphasise?: string; // e.g. "practical steps", "strategic advice", free text,
+}

package/src/history/history-events.ts

@@ -1,21 +1,21 @@
-import { HackProgress } from './history';
-
-export interface HackProgressCreatedEvent {
-    id: string;
-    type: 'HackProgressCreated';
-    payload: HackProgress;
-}
-
-export interface HackProgressUpdatedEvent {
-    id: string;
-    type: 'HackProgressUpdated';
-    payload: HackProgress;
-}
-
-export interface HackProgressDeletedEvent {
-    id: string;
-    type: 'HackProgressDeleted';
-    payload: HackProgress;
-}
-
-export type HackProgressChangedEvent = HackProgressCreatedEvent | HackProgressUpdatedEvent | HackProgressDeletedEvent;
+import { HackProgress } from './history';
+
+export interface HackProgressCreatedEvent {
+    id: string;
+    type: 'HackProgressCreated';
+    payload: HackProgress;
+}
+
+export interface HackProgressUpdatedEvent {
+    id: string;
+    type: 'HackProgressUpdated';
+    payload: HackProgress;
+}
+
+export interface HackProgressDeletedEvent {
+    id: string;
+    type: 'HackProgressDeleted';
+    payload: HackProgress;
+}
+
+export type HackProgressChangedEvent = HackProgressCreatedEvent | HackProgressUpdatedEvent | HackProgressDeletedEvent;

package/src/history/history.ts

@@ -1,46 +1,46 @@
-export interface ResumeStoryPlayer {
-    /** the format the user chose to consume the hack */
-    format: 'story';
-    /** where to resume from in the segment's array of cards */
-    fromCardIndex: number;
-}
-
-export interface ResumeAudioPlayer {
-    /** the format the user chose to consume the hack */
-    format: 'audio';
-    /** the timestamp in seconds that the audio player should resume from */
-    audioPlayerFromTimestamp: number;
-    /** where to resume from in the segment's array of cards */
-    fromCardIndex?: number;
-}
-
-export interface ResumeTextReader {
-    /** the format the user chose to consume the hack */
-    format: 'text';
-    /** the timestamp in seconds that the audio player should resume from
-     *  if the user had audio playing in the background while reading */
-    audioPlayerFromTimestamp?: number;
-    /** where to resume from in the segment's array of cards */
-    fromCardIndex?: number;
-}
-
-export interface HackProgressDTO {
-    /** the hack the user has been viewing */
-    hackId: string;
-    /** the segment to resume from */
-    segmentId: string;
-    /** the ISO 8601 date and time when the user last viewed the hack   */
-    lastViewedAt: string;
-    /** used to render the hack progress bar on the client */
-    percentageComplete: number;
-    /** the format the hack will be resumed in */
-    resume: ResumeStoryPlayer | ResumeAudioPlayer | ResumeTextReader;
-}
-
-export interface HackProgress extends HackProgressDTO {
-    id: string
-    createdAt: string;
-    updatedAt: string;
-    v: number;
-    userId: string;
-}
+export interface ResumeStoryPlayer {
+    /** the format the user chose to consume the hack */
+    format: 'story';
+    /** where to resume from in the segment's array of cards */
+    fromCardIndex: number;
+}
+
+export interface ResumeAudioPlayer {
+    /** the format the user chose to consume the hack */
+    format: 'audio';
+    /** the timestamp in seconds that the audio player should resume from */
+    audioPlayerFromTimestamp: number;
+    /** where to resume from in the segment's array of cards */
+    fromCardIndex?: number;
+}
+
+export interface ResumeTextReader {
+    /** the format the user chose to consume the hack */
+    format: 'text';
+    /** the timestamp in seconds that the audio player should resume from
+     *  if the user had audio playing in the background while reading */
+    audioPlayerFromTimestamp?: number;
+    /** where to resume from in the segment's array of cards */
+    fromCardIndex?: number;
+}
+
+export interface HackProgressDTO {
+    /** the hack the user has been viewing */
+    hackId: string;
+    /** the segment to resume from */
+    segmentId: string;
+    /** the ISO 8601 date and time when the user last viewed the hack   */
+    lastViewedAt: string;
+    /** used to render the hack progress bar on the client */
+    percentageComplete: number;
+    /** the format the hack will be resumed in */
+    resume: ResumeStoryPlayer | ResumeAudioPlayer | ResumeTextReader;
+}
+
+export interface HackProgress extends HackProgressDTO {
+    id: string
+    createdAt: string;
+    updatedAt: string;
+    v: number;
+    userId: string;
+}