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

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/hack-statistics/hack-statistics-events.ts

@@ -1,21 +1,21 @@
-import { HackStatistics } from './hack-statistics';
-
-export interface HackStatisticsCreatedEvent {
-    id: string;
-    type: 'HackStatisticsCreated';
-    payload: HackStatistics;
-}
-
-export interface HackStatisticsUpdatedEvent {
-    id: string;
-    type: 'HackStatisticsUpdated';
-    payload: HackStatistics;
-}
-
-export interface HackStatisticsDeletedEvent {
-    id: string;
-    type: 'HackStatisticsDeleted';
-    payload: HackStatistics;
-}
-
-export type HackStatisticsChangedEvent = HackStatisticsCreatedEvent | HackStatisticsUpdatedEvent | HackStatisticsDeletedEvent;
+import { HackStatistics } from './hack-statistics';
+
+export interface HackStatisticsCreatedEvent {
+    id: string;
+    type: 'HackStatisticsCreated';
+    payload: HackStatistics;
+}
+
+export interface HackStatisticsUpdatedEvent {
+    id: string;
+    type: 'HackStatisticsUpdated';
+    payload: HackStatistics;
+}
+
+export interface HackStatisticsDeletedEvent {
+    id: string;
+    type: 'HackStatisticsDeleted';
+    payload: HackStatistics;
+}
+
+export type HackStatisticsChangedEvent = HackStatisticsCreatedEvent | HackStatisticsUpdatedEvent | HackStatisticsDeletedEvent;

package/src/hack-statistics/hack-statistics.ts

@@ -1,10 +1,10 @@
-
-export interface HackStatistics {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    hackId: string;
-    popularityRank: number;
-    trendingRank: number;
+
+export interface HackStatistics {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    hackId: string;
+    popularityRank: number;
+    trendingRank: number;
 }

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

@@ -1,12 +1,13 @@
-import { KnowledgeSourceLocation } from './knowledge-source-location';
-
 export interface TriggerHackGenerationCommandPayload {
     reference: string;
     userId?: 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
@@ -17,8 +18,8 @@ export interface TriggerHackGenerationCommandPayload {
         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?: {
@@ -26,7 +27,8 @@ export interface TriggerHackGenerationCommandPayload {
         episodeNumber: number;
     }
 
-    hackFromPodcastWithMetadata?: KnowledgeSourceLocation & {
+    hackFromPodcastWithMetadata?: {
+        knowledgeSourceUrl: string;
         podcastName: string;
         episodeName: string;
         episodeDescription: string;

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,57 @@
-import { SupportedDraftHackGenerationType } from '../knowledge-source-parsing/knowledge-source-parsing-commands';
-import { KnowledgeSourceLocation } from './knowledge-source-location';
-
-export interface HackGenerationTrigger {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    userId?: string;
-    reference?: 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
-        shouldCreateTakeaways: boolean; // whether to create "insights in action"
-        takeawaysToEmphasise?: string; // e.g. "practical steps", "strategic advice", free text, for the "insights in action". If "shouldCreateTakeaways" is false, this will be omitted
-        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;
-    }
-
-    // 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
+        shouldCreateTakeaways: boolean; // whether to create "insights in action"
+        takeawaysToEmphasise?: string; // e.g. "practical steps", "strategic advice", free text, for the "insights in action". If "shouldCreateTakeaways" is false, this will be omitted
+        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;
+    }
+
+    // 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/identity-provider/domain-identity-provider-events.ts

@@ -1,21 +1,21 @@
-import { DomainIdentityProvider } from './domain-identity-provider';
-
-export interface DomainIdentityProviderCreatedEvent {
-    id: string;
-    type: 'DomainIdentityProviderCreated';
-    payload: DomainIdentityProvider;
-}
-
-export interface DomainIdentityProviderUpdatedEvent {
-    id: string;
-    type: 'DomainIdentityProviderUpdated';
-    payload: DomainIdentityProvider;
-}
-
-export interface DomainIdentityProviderDeletedEvent {
-    id: string;
-    type: 'DomainIdentityProviderDeleted';
-    payload: DomainIdentityProvider;
-}
-
+import { DomainIdentityProvider } from './domain-identity-provider';
+
+export interface DomainIdentityProviderCreatedEvent {
+    id: string;
+    type: 'DomainIdentityProviderCreated';
+    payload: DomainIdentityProvider;
+}
+
+export interface DomainIdentityProviderUpdatedEvent {
+    id: string;
+    type: 'DomainIdentityProviderUpdated';
+    payload: DomainIdentityProvider;
+}
+
+export interface DomainIdentityProviderDeletedEvent {
+    id: string;
+    type: 'DomainIdentityProviderDeleted';
+    payload: DomainIdentityProvider;
+}
+
 export type DomainIdentityProviderChangedEvent = DomainIdentityProviderCreatedEvent | DomainIdentityProviderUpdatedEvent | DomainIdentityProviderDeletedEvent;

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

@@ -1,11 +1,11 @@
-export interface DomainIdentityProvider {
-    id: string;
-    v: number;
-    updatedAt: string;
-    createdAt: string;
-    identityProviderId: string;
-    domain: string;
-    providerName: string;
-    /** Matching verifiedDomains should require to be authenticated via IdP or not */
-    enforceIdpAuth: boolean;
+export interface DomainIdentityProvider {
+    id: string;
+    v: number;
+    updatedAt: string;
+    createdAt: string;
+    identityProviderId: string;
+    domain: string;
+    providerName: string;
+    /** Matching verifiedDomains should require to be authenticated via IdP or not */
+    enforceIdpAuth: boolean;
 }

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

@@ -1,21 +1,21 @@
-import { IdentityProvider } from './identity-provider';
-
-export interface IdentityProviderCreatedEvent {
-    id: string;
-    type: 'IdentityProviderCreated';
-    payload: IdentityProvider;
-}
-
-export interface IdentityProviderUpdatedEvent {
-    id: string;
-    type: 'IdentityProviderUpdated';
-    payload: IdentityProvider;
-}
-
-export interface IdentityProviderDeletedEvent {
-    id: string;
-    type: 'IdentityProviderDeleted';
-    payload: IdentityProvider;
-}
-
+import { IdentityProvider } from './identity-provider';
+
+export interface IdentityProviderCreatedEvent {
+    id: string;
+    type: 'IdentityProviderCreated';
+    payload: IdentityProvider;
+}
+
+export interface IdentityProviderUpdatedEvent {
+    id: string;
+    type: 'IdentityProviderUpdated';
+    payload: IdentityProvider;
+}
+
+export interface IdentityProviderDeletedEvent {
+    id: string;
+    type: 'IdentityProviderDeleted';
+    payload: IdentityProvider;
+}
+
 export type IdentityProviderChangedEvent = IdentityProviderCreatedEvent | IdentityProviderUpdatedEvent | IdentityProviderDeletedEvent;