@uptime.app/contracts 2.0.6 → 2.0.7-rc.0

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

@@ -1,21 +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;
+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

@@ -1,54 +1,54 @@
-import { SupportedDraftHackGenerationType } from '../knowledge-source-parsing/knowledge-source-parsing-commands';
-
-export interface HackGenerationTrigger {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    userId?: string;
-    reference?: 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
-    }
-
-    // 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',
-}
+import { SupportedDraftHackGenerationType } from '../knowledge-source-parsing/knowledge-source-parsing-commands';
+
+export interface HackGenerationTrigger {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    userId?: string;
+    reference?: 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
+    }
+
+    // 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/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;
+}

package/src/index.ts

@@ -1,166 +1,166 @@
-export * from './access-control/collection-access-control';
-export * from './access-control/hack-access-control';
-
-export * from './app-hack/app-full-hack';
-export * from './app-hack/app-hack-metadata';
-export * from './app-hack/app-restricted-hack';
-
-export * from './cms-hack/cms-searchable-hack';
-
-export * from './b2b-content-access/b2b-content-access';
-
-export * from './b2b-organisation/b2b-organisation';
-export * from './b2b-organisation/b2b-organisation-events';
-
-export * from './b2b-organisation/b2b-organisation-member';
-export * from './b2b-organisation/b2b-organisation-member-events';
-
-export * from './b2b-organisation/b2b-carousel';
-export * from './b2b-organisation/b2b-organisation-invitation';
-
-export * from './brand/brand';
-export * from './brand/brand-events';
-
-export * from './catalogue/catalogue';
-
-export * from './collection/collection';
-export * from './collection/collection-events';
-export * from './collection/enriched-collection';
-export * from './collection/enriched-collection-events';
-
-export * from './creator/creator';
-export * from './creator/creator-events';
-
-export * from './distribution/distribution-events';
-export * from './distribution/hack-distribution';
-export * from './distribution/collection-distribution';
-
-export * from './draft-hack/draft-hack';
-export * from './draft-hack/draft-hack-events';
-
-export * from './draft-hack-generation/draft-hack-generation';
-export * from './draft-hack-generation/draft-hack-generation-commands';
-export * from './draft-hack-generation/draft-hack-generation-events';
-
-export * from './enriched-hack/enriched-hack';
-export * from './enriched-hack/enriched-hack-events';
-
-export * from './enrichment-asset/hack-enrichment-video';
-export * from './enrichment-asset/hack-enrichment-video-events';
-
-export * from './entitlement/user-entitlements';
-export * from './entitlement/user-entitlements-events';
-export * from './entitlement/user-entitlements-commands';
-
-export * from './flashcard/flashcard';
-export * from './flashcard/flashcard-events';
-
-export * from './hack/extracted-subject';
-export * from './hack/hack-events';
-export * from './hack/hack-published';
-export * from './hack/hack-with-voice';
-export * from './hack/hack-with-voice-events';
-export * from './hack/hack';
-export * from './hack/publish-hack-command';
-
-export * from './hack-metadata/hack-metadata';
-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';
-
-export * from './history/history';
-export * from './history/history-events';
-
-export * from './interest/interest';
-export * from './interest/interest-events';
-
-export * from './knowledge-source/knowledge-source';
-export * from './knowledge-source/knowledge-source-events';
-
-export * from './knowledge-source-parsing/knowledge-source-metadata';
-export * from './knowledge-source-parsing/knowledge-source-parsing-commands';
-export * from './knowledge-source-parsing/knowledge-source-parsing-events';
-export * from './knowledge-source-parsing/podcast-metadata';
-export * from './knowledge-source-parsing/podcast-parsing-events';
-export * from './knowledge-source-parsing/user-hack-generation-options';
-
-export * from './localisation/live-locales';
-export * from './localisation/locale-language';
-export * from './localisation/supported-languages';
-export * from './localisation/supported-locales';
-
-export * from './moderation/hack-moderation-result';
-export * from './moderation/hack-moderation-result-events';
-
-export * from './partner/partner';
-export * from './partner/partner-events';
-
-export * from './pending-hack/pending-hack';
-export * from './pending-hack/pending-hack-events';
-export * from './pending-hack/pending-hack-with-voice';
-export * from './pending-hack/pending-hack-with-voice-events';
-
-export * from './preferences/preferences';
-export * from './preferences/preferences-events';
-
-export * from './profile/profile';
-export * from './profile/translated-profile';
-export * from './profile/profile-events';
-
-export * from './referral/referral';
-export * from './referral/referral-events';
-
-export * from './saved/saved-collection';
-export * from './saved/saved-collection-events';
-
-export * from './segment/segment-with-voice';
-export * from './segment/segment-commands';
-export * from './segment/segment';
-export * from './segment/segment-events';
-
-export * from './skin/skin';
-export * from './skin/skin-events';
-
-export * from './spark/spark-board-read-model';
-export * from './spark/spark-board';
-export * from './spark/spark-events';
-export * from './spark/spark';
-
-export * from './text-to-speech/create-speech-commands';
-export * from './text-to-speech/speech-created-events';
-export * from './text-to-speech/supported-voices';
-export * from './text-to-speech/text-segment';
-
-export * from './theme/theme';
-export * from './theme/theme-events';
-
-export * from './translation/translation-events';
-export * from './translation/translation';
-
-export * from './trending/trending-hacks';
-export * from './trending/trending-events';
-
-export * from './user/user-events';
-export * from './user/get-user';
-
-export * from './user-context/user-context';
-export * from './user-context/user-context-events';
-
-export * from './user-notification-context/user-notification-context';
-export * from './user-notification-context/user-notification-context-events';
-
-export * from './user-statistics/user-statistics';
-export * from './user-statistics/user-statistics-events';
-
-export * from './video-cropping/video-metadata';
-export * from './video-cropping/video-cropping-events';
-
-export * from './hack-statistics/hack-statistics';
-export * from './hack-statistics/hack-statistics-events';
-
+export * from './access-control/collection-access-control';
+export * from './access-control/hack-access-control';
+
+export * from './app-hack/app-full-hack';
+export * from './app-hack/app-hack-metadata';
+export * from './app-hack/app-restricted-hack';
+
+export * from './cms-hack/cms-searchable-hack';
+
+export * from './b2b-content-access/b2b-content-access';
+
+export * from './b2b-organisation/b2b-organisation';
+export * from './b2b-organisation/b2b-organisation-events';
+
+export * from './b2b-organisation/b2b-organisation-member';
+export * from './b2b-organisation/b2b-organisation-member-events';
+
+export * from './b2b-organisation/b2b-carousel';
+export * from './b2b-organisation/b2b-organisation-invitation';
+
+export * from './brand/brand';
+export * from './brand/brand-events';
+
+export * from './catalogue/catalogue';
+
+export * from './collection/collection';
+export * from './collection/collection-events';
+export * from './collection/enriched-collection';
+export * from './collection/enriched-collection-events';
+
+export * from './creator/creator';
+export * from './creator/creator-events';
+
+export * from './distribution/distribution-events';
+export * from './distribution/hack-distribution';
+export * from './distribution/collection-distribution';
+
+export * from './draft-hack/draft-hack';
+export * from './draft-hack/draft-hack-events';
+
+export * from './draft-hack-generation/draft-hack-generation';
+export * from './draft-hack-generation/draft-hack-generation-commands';
+export * from './draft-hack-generation/draft-hack-generation-events';
+
+export * from './enriched-hack/enriched-hack';
+export * from './enriched-hack/enriched-hack-events';
+
+export * from './enrichment-asset/hack-enrichment-video';
+export * from './enrichment-asset/hack-enrichment-video-events';
+
+export * from './entitlement/user-entitlements';
+export * from './entitlement/user-entitlements-events';
+export * from './entitlement/user-entitlements-commands';
+
+export * from './flashcard/flashcard';
+export * from './flashcard/flashcard-events';
+
+export * from './hack/extracted-subject';
+export * from './hack/hack-events';
+export * from './hack/hack-published';
+export * from './hack/hack-with-voice';
+export * from './hack/hack-with-voice-events';
+export * from './hack/hack';
+export * from './hack/publish-hack-command';
+
+export * from './hack-metadata/hack-metadata';
+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';
+
+export * from './history/history';
+export * from './history/history-events';
+
+export * from './interest/interest';
+export * from './interest/interest-events';
+
+export * from './knowledge-source/knowledge-source';
+export * from './knowledge-source/knowledge-source-events';
+
+export * from './knowledge-source-parsing/knowledge-source-metadata';
+export * from './knowledge-source-parsing/knowledge-source-parsing-commands';
+export * from './knowledge-source-parsing/knowledge-source-parsing-events';
+export * from './knowledge-source-parsing/podcast-metadata';
+export * from './knowledge-source-parsing/podcast-parsing-events';
+export * from './knowledge-source-parsing/user-hack-generation-options';
+
+export * from './localisation/live-locales';
+export * from './localisation/locale-language';
+export * from './localisation/supported-languages';
+export * from './localisation/supported-locales';
+
+export * from './moderation/hack-moderation-result';
+export * from './moderation/hack-moderation-result-events';
+
+export * from './partner/partner';
+export * from './partner/partner-events';
+
+export * from './pending-hack/pending-hack';
+export * from './pending-hack/pending-hack-events';
+export * from './pending-hack/pending-hack-with-voice';
+export * from './pending-hack/pending-hack-with-voice-events';
+
+export * from './preferences/preferences';
+export * from './preferences/preferences-events';
+
+export * from './profile/profile';
+export * from './profile/translated-profile';
+export * from './profile/profile-events';
+
+export * from './referral/referral';
+export * from './referral/referral-events';
+
+export * from './saved/saved-collection';
+export * from './saved/saved-collection-events';
+
+export * from './segment/segment-with-voice';
+export * from './segment/segment-commands';
+export * from './segment/segment';
+export * from './segment/segment-events';
+
+export * from './skin/skin';
+export * from './skin/skin-events';
+
+export * from './spark/spark-board-read-model';
+export * from './spark/spark-board';
+export * from './spark/spark-events';
+export * from './spark/spark';
+
+export * from './text-to-speech/create-speech-commands';
+export * from './text-to-speech/speech-created-events';
+export * from './text-to-speech/supported-voices';
+export * from './text-to-speech/text-segment';
+
+export * from './theme/theme';
+export * from './theme/theme-events';
+
+export * from './translation/translation-events';
+export * from './translation/translation';
+
+export * from './trending/trending-hacks';
+export * from './trending/trending-events';
+
+export * from './user/user-events';
+export * from './user/get-user';
+
+export * from './user-context/user-context';
+export * from './user-context/user-context-events';
+
+export * from './user-notification-context/user-notification-context';
+export * from './user-notification-context/user-notification-context-events';
+
+export * from './user-statistics/user-statistics';
+export * from './user-statistics/user-statistics-events';
+
+export * from './video-cropping/video-metadata';
+export * from './video-cropping/video-cropping-events';
+
+export * from './hack-statistics/hack-statistics';
+export * from './hack-statistics/hack-statistics-events';
+
 export * from './message-bus/Context';