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

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

@@ -1,21 +0,0 @@
-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 +0,0 @@
-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 +0,0 @@
-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 +0,0 @@
-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 +0,0 @@
-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 +0,0 @@
-
-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,43 +0,0 @@
-import { KnowledgeSourceLocation } from './knowledge-source-location';
-
-export interface TriggerHackGenerationCommandPayload {
-    reference: string;
-    userId?: 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
-        takeawaysToEmphasise?: string; // e.g. "practical steps", "strategic advice", free text, for the "insights in action". If "shouldCreateTakeaways" is false, this will be omitted
-        shouldCreateTakeaways: boolean; // whether to create "insights in action"
-        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;
-    }
-}
-
-export interface TriggerHackGenerationCommand {
-    id: string;
-    type: 'TriggerHackGeneration';
-    payload: TriggerHackGenerationCommandPayload;
-}

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

@@ -1,21 +0,0 @@
-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 +0,0 @@
-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',
-}

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

@@ -1,5 +0,0 @@
-export interface KnowledgeSourceLocation {
-    knowledgeSourceUrl: string;
-    knowledgeSourceBucket?: string;
-    knowledgeSourceKey?: string;
-}

package/src/history/history-events.ts

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

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

@@ -1,51 +0,0 @@
-export interface IdentityProvider {
-    id: string;
-    v: number;
-    updatedAt: string;
-    createdAt: string;
-    verifiedDomains: string[];
-    /** Matching verifiedDomains should require to be authenticated via IdP or not */
-    enforceIdpAuth: boolean;
-    providerName: string;
-    config: IdentityProviderConfig;
-}
-
-export interface IdentityProviderConfig {
-    /** Whether IdP-initiated SSO is allowed */
-    idpInit: boolean;
-    idpSignout: boolean;
-    encryptedResponses: boolean;
-    requestSigningAlgorithm: string;
-    /** Optional raw metadata XML string */
-    metadataXml?: string;
-    /** Optional URL to fetch metadata from */
-    metadataUrl?: string;
-    attributeMapping?: {
-        email: string;
-        given_name?: string;
-        family_name?: string;
-        'custom:employee_id'?: string;
-        'custom:job_title'?: string;
-        'custom:user_department'?: string;
-        'custom:ext_organisation_id'?: string;
-        'custom:ext_user_id'?: string;
-        'custom:country_code'?: string;
-        'custom:team_name'?: string;
-        'custom:is_manager'?: string;
-    };
-}
-
-// Needs to be updated when new attributeMappings are added. This needs to be updated on the user-service after
-export interface IdentityProviderClaims {
-    employeeId?: string;
-    jobTitle?: string;
-    department?: string;
-    externalOrganisationId?: string;
-    email?: string;
-    family_name?: string;
-    given_name?: string;
-    externalUserId?: string;
-    countryCode?: string;
-    teamName?: string;
-    isManager?: string
-}

package/src/index.ts

@@ -1,220 +0,0 @@
-export * from './access-control/collection-access-control';
-export * from './access-control/hack-access-control';
-export * from './access-control/profile-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-organisation-group';
-export * from './b2b-organisation/b2b-organisation-group-events';
-export * from './b2b-organisation/b2b-organisation-group-membership';
-export * from './b2b-organisation/b2b-organisation-group-membership-events';
-
-export * from './b2b-organisation/b2b-carousel';
-export * from './b2b-organisation/b2b-organisation-invitation';
-
-export * from './b2b-organisation/b2b-org-idp-mapping';
-
-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 './enriched-b2b-organisation/enriched-b2b-organisation';
-export * from './enriched-b2b-organisation/enriched-b2b-organisation-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/republish-hack-command';
-
-export * from './hack-metadata/hack-metadata';
-export * from './hack-metadata/hack-metadata-events';
-
-export * from './hack-mapping/app-full-hack';
-export * from './hack-mapping/app-hack-metadata';
-export * from './hack-mapping/app-restricted-hack';
-
-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 './service-simulator/mock-request-response';
-
-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-analysis/hack-categories-extracted';
-export * from './text-analysis/hack-categories-extracted-events';
-export * from './text-analysis/hack-entities-extracted';
-export * from './text-analysis/hack-entities-extracted-events';
-export * from './text-analysis/hack-keywords-extracted';
-export * from './text-analysis/hack-keywords-extracted-events';
-export * from './text-analysis/hack-topics-extracted';
-export * from './text-analysis/hack-topics-extracted-events';
-
-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/cognito-user-authentication-log';
-export * from './user-acl/user-acl-utils';
-
-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';
-
-export * from './identity-provider/identity-provider';
-export * from './identity-provider/identity-provider-events';
-export * from './identity-provider/domain-identity-provider';
-export * from './identity-provider/domain-identity-provider-events';
-
-export * from './learn-upon/learn-upon-portal';
-export * from './learn-upon/learn-upon-portal-events';
-export * from './learn-upon/learn-upon-user-mapping';
-export * from './learn-upon/learn-upon-user-mapping-events';
-export * from './learn-upon/learn-upon-webhook-types';
-export * from './learn-upon/learn-upon-webhook-events';
-export * from './learn-upon/learn-upon-commands';
-export * from './learn-upon/get-sqsso-url';
-export * from './learn-upon/unenroll';
-export * from './learn-upon/learn-upon-course-enrollment';
-export * from './learn-upon/learn-upon-course-enrollment-events';
-export * from './learn-upon/learn-upon-course';
-export * from './learn-upon/learn-upon-course-events';
-
-export * from './course/course';
-export * from './course/course-events';
-
-export * from './course-enrollment/course-enrollment';
-export * from './course-enrollment/course-enrollment-events';

package/src/interest/interest-events.ts

@@ -1,21 +0,0 @@
-import { UserInterests } from './interest';
-
-export interface UserInterestsCreatedEvent {
-    id: string;
-    type: 'UserInterestsCreated';
-    payload: UserInterests;
-}
-
-export interface UserInterestsUpdatedEvent {
-    id: string;
-    type: 'UserInterestsUpdated';
-    payload: UserInterests;
-}
-
-export interface UserInterestsDeletedEvent {
-    id: string;
-    type: 'UserInterestsDeleted';
-    payload: UserInterests;
-}
-
-export type UserInterestsChangedEvent = UserInterestsCreatedEvent | UserInterestsUpdatedEvent | UserInterestsUpdatedEvent;

package/src/interest/interest.ts

@@ -1,15 +0,0 @@
-export interface Interest {
-    /** the name of the thing they are interested in e.g. Health & Fitness */
-    name: string;
-    /** the type of the thing they are interested in e.g. a topic or a category */
-    type: string;
-}
-
-export interface UserInterests {
-    id: string;
-    userId: string;
-    interests: Interest[];
-    createdAt: string;
-    updatedAt: string;
-    v: number;
-}