@uptime.app/contracts 3.0.36 → 3.0.37-rc.0

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

@@ -1,21 +1,21 @@
-import { KnowledgeSource } from './knowledge-source';
-
-export interface KnowledgeSourceCreatedEvent {
-    id: string;
-    type: 'KnowledgeSourceCreated';
-    payload: KnowledgeSource;
-}
-
-export interface KnowledgeSourceUpdatedEvent {
-    id: string;
-    type: 'KnowledgeSourceUpdated';
-    payload: KnowledgeSource;
-}
-
-export interface KnowledgeSourceDeletedEvent {
-    id: string;
-    type: 'KnowledgeSourceDeleted';
-    payload: KnowledgeSource;
-}
-
-export type KnowledgeSourceChangedEvent = KnowledgeSourceCreatedEvent | KnowledgeSourceUpdatedEvent | KnowledgeSourceDeletedEvent;
+import { KnowledgeSource } from './knowledge-source';
+
+export interface KnowledgeSourceCreatedEvent {
+    id: string;
+    type: 'KnowledgeSourceCreated';
+    payload: KnowledgeSource;
+}
+
+export interface KnowledgeSourceUpdatedEvent {
+    id: string;
+    type: 'KnowledgeSourceUpdated';
+    payload: KnowledgeSource;
+}
+
+export interface KnowledgeSourceDeletedEvent {
+    id: string;
+    type: 'KnowledgeSourceDeleted';
+    payload: KnowledgeSource;
+}
+
+export type KnowledgeSourceChangedEvent = KnowledgeSourceCreatedEvent | KnowledgeSourceUpdatedEvent | KnowledgeSourceDeletedEvent;

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

@@ -1,43 +1,43 @@
-export interface KnowledgeSource {
-    id: string;
-    /** @deprecated - use affiliate.url instead */
-    affiliateLink?: string;
-    // introduced Feb 2021. May be undefined in previous events
-    affiliate: Affiliate;
-    categories: Category[];
-    topics: Topic[];
-    coverUrl?: string;
-    createdAt: string;
-    description?: string;
-    contributors: Contributor[];
-    title: string;
-    type: KnowledgeSourceType;
-    updatedAt: string;
-    v: number;
-    metadata?: {
-        [key: string]: any;
-    };
-    /** Number of pages in the book. only set for books. May be undefined */
-    pageCount?: number;
-    /** Set for courses, documentaries and podcasts. May be undefined */
-    durationInMinutes?: number;
-}
-
-export type KnowledgeSourceType = 'book' | 'course' | 'documentary' | 'podcast';
-
-export interface Affiliate {
-    url?: string;
-    name?: string;
-}
-
-export interface Contributor {
-    name: string;
-}
-
-export interface Category {
-    name: string;
-}
-
-export interface Topic {
-    name: string;
-}
+export interface KnowledgeSource {
+    id: string;
+    /** @deprecated - use affiliate.url instead */
+    affiliateLink?: string;
+    // introduced Feb 2021. May be undefined in previous events
+    affiliate: Affiliate;
+    categories: Category[];
+    topics: Topic[];
+    coverUrl?: string;
+    createdAt: string;
+    description?: string;
+    contributors: Contributor[];
+    title: string;
+    type: KnowledgeSourceType;
+    updatedAt: string;
+    v: number;
+    metadata?: {
+        [key: string]: any;
+    };
+    /** Number of pages in the book. only set for books. May be undefined */
+    pageCount?: number;
+    /** Set for courses, documentaries and podcasts. May be undefined */
+    durationInMinutes?: number;
+}
+
+export type KnowledgeSourceType = 'book' | 'course' | 'documentary' | 'podcast';
+
+export interface Affiliate {
+    url?: string;
+    name?: string;
+}
+
+export interface Contributor {
+    name: string;
+}
+
+export interface Category {
+    name: string;
+}
+
+export interface Topic {
+    name: string;
+}

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

@@ -1,58 +1,58 @@
-export interface KnowledgeSourceMetadata {
-    // deterministic based on input URL
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-
-    title: string;
-    contributors: string;
-    type: string;
-
-    
-    // ai-generated metadata
-    about: string;
-    summary: string;
-    quotes: KnowledgeSourceQuote[];
-    
-    vectorDbNamespace: string;
-    vectorDbApproxWordsPerChunk: number;
-    
-    // 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;
-    // path of parsed tables stored in s3, of type TableEntry[]
-    tablesS3Path?: string;
-}
-
-export interface KnowledgeSourceQuote {
-    content: string;
-    authors: string;
-}
-
-export interface KnowledgeSourceUserDefinedMetadata {
-    title: string;
-    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;
-    useB2CSegmentLimits: boolean;
-}
-
-// used for parsed tables stored in s3 and referenced in tablesS3Path
-export interface TableEntry {
-    id: string;
-    content: string;
-    originalHtml: string;
-    title?: string;
-}
+export interface KnowledgeSourceMetadata {
+    // deterministic based on input URL
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+
+    title: string;
+    contributors: string;
+    type: string;
+
+    
+    // ai-generated metadata
+    about: string;
+    summary: string;
+    quotes: KnowledgeSourceQuote[];
+    
+    vectorDbNamespace: string;
+    vectorDbApproxWordsPerChunk: number;
+    
+    // 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;
+    // path of parsed tables stored in s3, of type TableEntry[]
+    tablesS3Path?: string;
+}
+
+export interface KnowledgeSourceQuote {
+    content: string;
+    authors: string;
+}
+
+export interface KnowledgeSourceUserDefinedMetadata {
+    title: string;
+    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;
+    useB2CSegmentLimits: boolean;
+}
+
+// used for parsed tables stored in s3 and referenced in tablesS3Path
+export interface TableEntry {
+    id: string;
+    content: string;
+    originalHtml: string;
+    title?: string;
+}

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

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

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

@@ -1,30 +1,30 @@
-import { SupportedDraftHackGenerationType } from './knowledge-source-parsing-commands';
-import { UserHackGenerationOptions } from './user-hack-generation-options';
-import { KnowledgeSourceUserDefinedMetadata } from './knowledge-source-metadata';
-
-export interface KnowledgeSourceParsed {
-    id: string;
-    type: 'KnowledgeSourceParsed';
-    payload: {
-        // the parsed knowledge source id
-        id: string;
-        // the version
-        v: number;
-        reference: string;
-        parsedKnowledgeSourceId: string;
-        hackGenerationTriggerId: string;
-        typeOfDraftHackToGenerate?: SupportedDraftHackGenerationType;
-        userHackGenerationOptions?: UserHackGenerationOptions;
-        userDefinedMetadata?: KnowledgeSourceUserDefinedMetadata;
-    }
-}
-
-export interface KnowledgeSourceParsingFailed {
-    id: string;
-    type: 'KnowledgeSourceParsingFailed';
-    payload: {
-        reference: string;
-        errorMessage: string;
-        hackGenerationTriggerId: string;
-    }
-}
+import { SupportedDraftHackGenerationType } from './knowledge-source-parsing-commands';
+import { UserHackGenerationOptions } from './user-hack-generation-options';
+import { KnowledgeSourceUserDefinedMetadata } from './knowledge-source-metadata';
+
+export interface KnowledgeSourceParsed {
+    id: string;
+    type: 'KnowledgeSourceParsed';
+    payload: {
+        // the parsed knowledge source id
+        id: string;
+        // the version
+        v: number;
+        reference: string;
+        parsedKnowledgeSourceId: string;
+        hackGenerationTriggerId: string;
+        typeOfDraftHackToGenerate?: SupportedDraftHackGenerationType;
+        userHackGenerationOptions?: UserHackGenerationOptions;
+        userDefinedMetadata?: KnowledgeSourceUserDefinedMetadata;
+    }
+}
+
+export interface KnowledgeSourceParsingFailed {
+    id: string;
+    type: 'KnowledgeSourceParsingFailed';
+    payload: {
+        reference: string;
+        errorMessage: string;
+        hackGenerationTriggerId: string;
+    }
+}

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

@@ -1,44 +1,44 @@
-export interface PodcastMetadataWithoutTranscript {
-    source: SupportedPodcastSource;
-    podcastName: string,
-    episodeName: string,
-    episodeDescription: string,
-    episodeReleaseDateIso: string,
-    episodeImageUrl: string,
-    episodeAudioUrl: string,
-    originalUrl: string,
-    podcastExternalId?: string,
-    episodeId?: string
-    episodeUrl?: string,
-    episodeDurationSeconds?: number,
-    podcastPublisher?: string,
-    podcastRss?: string,
-}
-
-export interface PodcastMetadata extends PodcastMetadataWithoutTranscript {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    
-    transcript: string;
-    summary: string;
-    vectorDbNamespace: string;
-    purpose: string;
-    hosts: PodcastConfirmedContributor[];
-    guests: PodcastConfirmedContributor[];
-}
-
-export interface PodcastConfirmedContributor {
-    nameInput: string;
-    confirmedName: string;
-    bio: string;
-}
-
-export enum SupportedPodcastSource {
-    ListenNotes = 'listennotes',
-    iTunes = 'itunes',
-    Spotify = 'spotify',
-    Rss = 'rss',
-    AudioWithMetadata = 'audio-with-metadata'
-}
+export interface PodcastMetadataWithoutTranscript {
+    source: SupportedPodcastSource;
+    podcastName: string,
+    episodeName: string,
+    episodeDescription: string,
+    episodeReleaseDateIso: string,
+    episodeImageUrl: string,
+    episodeAudioUrl: string,
+    originalUrl: string,
+    podcastExternalId?: string,
+    episodeId?: string
+    episodeUrl?: string,
+    episodeDurationSeconds?: number,
+    podcastPublisher?: string,
+    podcastRss?: string,
+}
+
+export interface PodcastMetadata extends PodcastMetadataWithoutTranscript {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    
+    transcript: string;
+    summary: string;
+    vectorDbNamespace: string;
+    purpose: string;
+    hosts: PodcastConfirmedContributor[];
+    guests: PodcastConfirmedContributor[];
+}
+
+export interface PodcastConfirmedContributor {
+    nameInput: string;
+    confirmedName: string;
+    bio: string;
+}
+
+export enum SupportedPodcastSource {
+    ListenNotes = 'listennotes',
+    iTunes = 'itunes',
+    Spotify = 'spotify',
+    Rss = 'rss',
+    AudioWithMetadata = 'audio-with-metadata'
+}

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

@@ -1,28 +1,28 @@
-import { SupportedDraftHackGenerationType } from './knowledge-source-parsing-commands';
-import { UserHackGenerationOptions } from './user-hack-generation-options';
-
-export interface PodcastParsed {
-    id: string;
-    type: 'PodcastParsed';
-    payload: {
-        // the parsed podcast id
-        id: string;
-        // the version
-        v: number;
-        reference: string;
-        hackGenerationTriggerId: string,
-        podcastId: string; // also the parsed podcast id
-        typeOfDraftHackToGenerate?: SupportedDraftHackGenerationType;
-        userHackGenerationOptions?: UserHackGenerationOptions;
-    }
-}
-
-export interface PodcastParsingFailed {
-    id: string;
-    type: 'PodcastParsingFailed';
-    payload: {
-        reference: string;
-        hackGenerationTriggerId: string,
-        errorMessage: string;
-    }
-}
+import { SupportedDraftHackGenerationType } from './knowledge-source-parsing-commands';
+import { UserHackGenerationOptions } from './user-hack-generation-options';
+
+export interface PodcastParsed {
+    id: string;
+    type: 'PodcastParsed';
+    payload: {
+        // the parsed podcast id
+        id: string;
+        // the version
+        v: number;
+        reference: string;
+        hackGenerationTriggerId: string,
+        podcastId: string; // also the parsed podcast id
+        typeOfDraftHackToGenerate?: SupportedDraftHackGenerationType;
+        userHackGenerationOptions?: UserHackGenerationOptions;
+    }
+}
+
+export interface PodcastParsingFailed {
+    id: string;
+    type: 'PodcastParsingFailed';
+    payload: {
+        reference: string;
+        hackGenerationTriggerId: string,
+        errorMessage: string;
+    }
+}

package/src/knowledge-source-parsing/user-hack-generation-options.ts

@@ -1,7 +1,7 @@
-export interface UserHackGenerationOptions {
-    toneOfVoice?: string;
-    takeawaysToEmphasise?: string;
-    hintsForInsights?: string;
-    createActionsForInsights: boolean;
-    useB2CSegmentLimits: boolean;
-}
+export interface UserHackGenerationOptions {
+    toneOfVoice?: string;
+    takeawaysToEmphasise?: string;
+    hintsForInsights?: string;
+    createActionsForInsights: boolean;
+    useB2CSegmentLimits: boolean;
+}

package/src/learn-upon/get-sqsso-url.ts

@@ -1,13 +1,13 @@
-import { Context } from '../message-bus/context';
-
-export interface InternalGetSQSSOUrlLambdaPayload {
-    userId: string;
-    uptimeLearnUponPortalId: string;
-    redirect: 'enrollment' | 'admin';
-    enrollmentId?: string;
-    context: Context;
-}
-
-export interface InternalGetSQSSOUrlLambdaResponse {
-    url: string;
-}
+import { Context } from '../message-bus/context';
+
+export interface InternalGetSQSSOUrlLambdaPayload {
+    userId: string;
+    uptimeLearnUponPortalId: string;
+    redirect: 'enrollment' | 'admin';
+    enrollmentId?: string;
+    context: Context;
+}
+
+export interface InternalGetSQSSOUrlLambdaResponse {
+    url: string;
+}

package/src/learn-upon/learn-upon-commands.ts

@@ -1,32 +1,32 @@
-import { SupportedLocale } from '../localisation/supported-locales';
-
-export interface SyncLearnUponUserCommandBody {
-    id: string;
-    v: number;
-    userId: string;
-    userType: 'learner' | 'instructor' | 'manager' | 'admin';
-    uptimeLearnUponPortalId: string;
-    organisationDisplayName?: string;
-    brandAppName?: {
-        [K in SupportedLocale]?: string
-    }
-}
-
-export interface SyncLearnUponUserCommand {
-    id: string;
-    type: 'SyncLearnUponUser';
-    payload: SyncLearnUponUserCommandBody;
-}
-
-export interface EnrollUserOnCourseCommandBody {
-    id: string;
-    v: number;
-    userId: string;
-    courseId: string;
-}
-
-export interface EnrollUserOnCourseCommand {
-    id: string;
-    type: 'EnrollUserOnCourse';
-    payload: EnrollUserOnCourseCommandBody;
-}
+import { SupportedLocale } from '../localisation/supported-locales';
+
+export interface SyncLearnUponUserCommandBody {
+    id: string;
+    v: number;
+    userId: string;
+    userType: 'learner' | 'instructor' | 'manager' | 'admin';
+    uptimeLearnUponPortalId: string;
+    organisationDisplayName?: string;
+    brandAppName?: {
+        [K in SupportedLocale]?: string
+    }
+}
+
+export interface SyncLearnUponUserCommand {
+    id: string;
+    type: 'SyncLearnUponUser';
+    payload: SyncLearnUponUserCommandBody;
+}
+
+export interface EnrollUserOnCourseCommandBody {
+    id: string;
+    v: number;
+    userId: string;
+    courseId: string;
+}
+
+export interface EnrollUserOnCourseCommand {
+    id: string;
+    type: 'EnrollUserOnCourse';
+    payload: EnrollUserOnCourseCommandBody;
+}