@uptime.app/contracts 1.0.3 → 1.0.4-rc.0

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

@@ -1,21 +1,21 @@
-import { PendingHack } from './pending-hack';
-
-export interface PendingHackCreatedEvent {
-    id: string;
-    type: 'PendingHackCreated';
-    payload: PendingHack;
-}
-
-export interface PendingHackUpdatedEvent {
-    id: string;
-    type: 'PendingHackUpdated';
-    payload: PendingHack;
-}
-
-export interface PendingHackDeletedEvent {
-    id: string;
-    type: 'PendingHackDeleted';
-    payload: PendingHack;
-}
-
+import { PendingHack } from './pending-hack';
+
+export interface PendingHackCreatedEvent {
+    id: string;
+    type: 'PendingHackCreated';
+    payload: PendingHack;
+}
+
+export interface PendingHackUpdatedEvent {
+    id: string;
+    type: 'PendingHackUpdated';
+    payload: PendingHack;
+}
+
+export interface PendingHackDeletedEvent {
+    id: string;
+    type: 'PendingHackDeleted';
+    payload: PendingHack;
+}
+
 export type PendingHackChangedEvent = PendingHackCreatedEvent | PendingHackUpdatedEvent | PendingHackDeletedEvent;

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

@@ -1,21 +1,21 @@
-import { PendingHackWithVoice } from './pending-hack-with-voice';
-
-export interface PendingHackWithVoiceCreatedEvent {
-    id: string;
-    type: 'PendingHackWithVoiceCreated';
-    payload: PendingHackWithVoice;
-}
-
-export interface PendingHackWithVoiceUpdatedEvent {
-    id: string;
-    type: 'PendingHackWithVoiceUpdated';
-    payload: PendingHackWithVoice;
-}
-
-export interface PendingHackWithVoiceDeletedEvent {
-    id: string;
-    type: 'PendingHackWithVoiceDeleted';
-    payload: PendingHackWithVoice;
-}
-
+import { PendingHackWithVoice } from './pending-hack-with-voice';
+
+export interface PendingHackWithVoiceCreatedEvent {
+    id: string;
+    type: 'PendingHackWithVoiceCreated';
+    payload: PendingHackWithVoice;
+}
+
+export interface PendingHackWithVoiceUpdatedEvent {
+    id: string;
+    type: 'PendingHackWithVoiceUpdated';
+    payload: PendingHackWithVoice;
+}
+
+export interface PendingHackWithVoiceDeletedEvent {
+    id: string;
+    type: 'PendingHackWithVoiceDeleted';
+    payload: PendingHackWithVoice;
+}
+
 export type PendingHackWithVoiceChangedEvent = PendingHackWithVoiceCreatedEvent | PendingHackWithVoiceUpdatedEvent | PendingHackWithVoiceDeletedEvent;

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

@@ -1,25 +1,25 @@
-/* eslint-disable @typescript-eslint/ban-types */
-import { Segment } from '../segment/segment';
-import { CompletePendingHack, PendingHack } from './pending-hack';
-
-export interface PendingHackWithVoice {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    voiceId: string;
-    isDefaultVoice: boolean;
-    hackId: string;
-    baseLocaleHackId: string;
-    segments: PendingHack['segments'];
-}
-
-export interface CompletePendingHackWithVoice extends PendingHackWithVoice {
-    segments: CompletePendingHack['segments'];
-}
-
-export type CompletePendingHackWithVoiceWithPutInAction = CompletePendingHackWithVoice & {
-    segments: {
-        putInAction: Segment;
-    }
-};
+/* eslint-disable @typescript-eslint/ban-types */
+import { Segment } from '../segment/segment';
+import { CompletePendingHack, PendingHack } from './pending-hack';
+
+export interface PendingHackWithVoice {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    voiceId: string;
+    isDefaultVoice: boolean;
+    hackId: string;
+    baseLocaleHackId: string;
+    segments: PendingHack['segments'];
+}
+
+export interface CompletePendingHackWithVoice extends PendingHackWithVoice {
+    segments: CompletePendingHack['segments'];
+}
+
+export type CompletePendingHackWithVoiceWithPutInAction = CompletePendingHackWithVoice & {
+    segments: {
+        putInAction: Segment;
+    }
+};

package/src/pending-hack/pending-hack.ts

@@ -1,75 +1,75 @@
-/* eslint-disable @typescript-eslint/ban-types */
-import { ExtractedSubject } from '../hack/extracted-subject';
-import { HackAffiliate, HackContributor, HackType, HackSourceData, HackTopic, HackExternalLink } from '../hack/hack';
-import { Segment } from '../segment/segment';
-
-export interface PendingHack {
-    id: string;
-    /** use @uptime.app/localisation-contracts */
-    locale: string;
-    baseLocaleHackId: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    owner?: string;
-    draftHackId: string;
-    draftHackVersion: number;
-    hackId: string;
-    sourceId?: string;
-    title: string;
-    themeId: string;
-    coverUrl?: string;
-    affiliate?: HackAffiliate;
-    topics: HackTopic[];
-    contributors: HackContributor[];
-    type: HackType;
-    sourceData?: HackSourceData;
-    notifications?: {
-        aiGeneratedText?: string;
-        humanCuratedText?: string;
-    };
-    segments: {
-        favouriteQuote: Segment | {};
-        inANutshell: Segment | {};
-        introduction: Segment | {};
-        insights: [
-            (Segment | {}),
-            (Segment | {}),
-            (Segment | {})
-        ];
-        conclusion: Segment | {};
-        // composite segments
-        overview: Segment | {};
-        shareableOverview: Segment | {};
-        hereAreTheInsights: Segment | {};
-        putInAction?: Segment | {};
-    };
-    externalLink?: HackExternalLink;
-    subjects?: ExtractedSubject[];
-}
-
-export interface CompletePendingHack extends PendingHack {
-    segments: {
-        favouriteQuote: Segment;
-        inANutshell: Segment;
-        introduction: Segment;
-        insights: [
-            Segment,
-            Segment,
-            Segment
-        ];
-        conclusion: Segment;
-        // composite segments
-        overview: Segment;
-        shareableOverview: Segment;
-        hereAreTheInsights: Segment;
-        putInAction?: Segment;
-    };
-    subjects: ExtractedSubject[];
-}
-
-export type CompletePendingHackWithPutInAction = CompletePendingHack & {
-    segments: {
-        putInAction: Segment;
-    }
-};
+/* eslint-disable @typescript-eslint/ban-types */
+import { ExtractedSubject } from '../hack/extracted-subject';
+import { HackAffiliate, HackContributor, HackType, HackSourceData, HackTopic, HackExternalLink } from '../hack/hack';
+import { Segment } from '../segment/segment';
+
+export interface PendingHack {
+    id: string;
+    /** use @uptime.app/localisation-contracts */
+    locale: string;
+    baseLocaleHackId: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    owner?: string;
+    draftHackId: string;
+    draftHackVersion: number;
+    hackId: string;
+    sourceId?: string;
+    title: string;
+    themeId: string;
+    coverUrl?: string;
+    affiliate?: HackAffiliate;
+    topics: HackTopic[];
+    contributors: HackContributor[];
+    type: HackType;
+    sourceData?: HackSourceData;
+    notifications?: {
+        aiGeneratedText?: string;
+        humanCuratedText?: string;
+    };
+    segments: {
+        favouriteQuote: Segment | {};
+        inANutshell: Segment | {};
+        introduction: Segment | {};
+        insights: [
+            (Segment | {}),
+            (Segment | {}),
+            (Segment | {})
+        ];
+        conclusion: Segment | {};
+        // composite segments
+        overview: Segment | {};
+        shareableOverview: Segment | {};
+        hereAreTheInsights: Segment | {};
+        putInAction?: Segment | {};
+    };
+    externalLink?: HackExternalLink;
+    subjects?: ExtractedSubject[];
+}
+
+export interface CompletePendingHack extends PendingHack {
+    segments: {
+        favouriteQuote: Segment;
+        inANutshell: Segment;
+        introduction: Segment;
+        insights: [
+            Segment,
+            Segment,
+            Segment
+        ];
+        conclusion: Segment;
+        // composite segments
+        overview: Segment;
+        shareableOverview: Segment;
+        hereAreTheInsights: Segment;
+        putInAction?: Segment;
+    };
+    subjects: ExtractedSubject[];
+}
+
+export type CompletePendingHackWithPutInAction = CompletePendingHack & {
+    segments: {
+        putInAction: Segment;
+    }
+};

package/src/segment/segment-commands.ts

@@ -1,70 +1,70 @@
-import { SupportedLocale } from '../localisation/supported-locales';
-import { SegmentType } from './segment';
-
-export interface StandaloneSegmentCard {
-    markdown: string;
-}
-
-export interface StandaloneSegmentAction {
-    title: string;
-    cards: StandaloneSegmentCard[];
-}
-
-export interface StandaloneSegmentSection {
-    heading?: string;
-    cards: StandaloneSegmentCard[];
-}
-
-export interface CommandSegment {
-    type: SegmentType;
-    // @deprecated use hackTitle, hackType and hackContributors
-    source?: {
-        id: string;
-        type: string;
-        contributors: {
-            name: string;
-        }[];
-        title: string;
-    };
-    hackCoverUrl?: string;
-    hackId: string;
-    hackTitle: string;
-    hackType: 'book' | 'course' | 'documentary' | 'podcast' | 'original';
-    hackContributors: {
-        name: string;
-    }[];
-    locale: SupportedLocale;
-}
-export interface StandaloneSegment extends CommandSegment {
-    title?: string;
-    keywords?: string[];
-    sections: StandaloneSegmentSection[];
-    actions?: StandaloneSegmentAction[];
-    textSummary?: string;
-}
-
-export interface CompositeSegment extends CommandSegment {
-    subSegments: StandaloneSegment[];
-}
-
-export interface CreateSegmentCommand {
-    id: string;
-    type: 'CreateSegment';
-    payload: (CompositeSegment | StandaloneSegment);
-}
-
-export interface UpdateSegmentCommand {
-    id: string;
-    type: 'UpdateSegment';
-    payload: (CompositeSegment | StandaloneSegment) & {
-        segmentId: string;
-    };
-}
-
-export interface DeleteSegmentCommand {
-    id: string;
-    type: 'DeleteSegment';
-    payload: {
-        segmentId: string;
-    };
-}
+import { SupportedLocale } from '../localisation/supported-locales';
+import { SegmentType } from './segment';
+
+export interface StandaloneSegmentCard {
+    markdown: string;
+}
+
+export interface StandaloneSegmentAction {
+    title: string;
+    cards: StandaloneSegmentCard[];
+}
+
+export interface StandaloneSegmentSection {
+    heading?: string;
+    cards: StandaloneSegmentCard[];
+}
+
+export interface CommandSegment {
+    type: SegmentType;
+    // @deprecated use hackTitle, hackType and hackContributors
+    source?: {
+        id: string;
+        type: string;
+        contributors: {
+            name: string;
+        }[];
+        title: string;
+    };
+    hackCoverUrl?: string;
+    hackId: string;
+    hackTitle: string;
+    hackType: 'book' | 'course' | 'documentary' | 'podcast' | 'original';
+    hackContributors: {
+        name: string;
+    }[];
+    locale: SupportedLocale;
+}
+export interface StandaloneSegment extends CommandSegment {
+    title?: string;
+    keywords?: string[];
+    sections: StandaloneSegmentSection[];
+    actions?: StandaloneSegmentAction[];
+    textSummary?: string;
+}
+
+export interface CompositeSegment extends CommandSegment {
+    subSegments: StandaloneSegment[];
+}
+
+export interface CreateSegmentCommand {
+    id: string;
+    type: 'CreateSegment';
+    payload: (CompositeSegment | StandaloneSegment);
+}
+
+export interface UpdateSegmentCommand {
+    id: string;
+    type: 'UpdateSegment';
+    payload: (CompositeSegment | StandaloneSegment) & {
+        segmentId: string;
+    };
+}
+
+export interface DeleteSegmentCommand {
+    id: string;
+    type: 'DeleteSegment';
+    payload: {
+        segmentId: string;
+    };
+}

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

@@ -1,8 +1,8 @@
-import { Segment } from './segment';
-
-// a segment with audio in a single voice, because having all voices in one segment would make the entity very large
-// the only difference is that it includes a voiceIdAndLanguage field, which can be used as a range key to find the segment for a specific voice
-// segmentsWithVoice may point to default or non-default voices
-export interface SegmentWithVoice extends Segment {
-    voiceIdAndLanguage: string;
-}
+import { Segment } from './segment';
+
+// a segment with audio in a single voice, because having all voices in one segment would make the entity very large
+// the only difference is that it includes a voiceIdAndLanguage field, which can be used as a range key to find the segment for a specific voice
+// segmentsWithVoice may point to default or non-default voices
+export interface SegmentWithVoice extends Segment {
+    voiceIdAndLanguage: string;
+}

package/src/segment/segment.ts

@@ -1,82 +1,82 @@
-export interface SegmentVoice {
-    id: string;
-    language: string;
-    name: string;
-    countryCode: string;
-    speechProvider: string;
-}
-
-export interface Segment {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    hackId: string;
-    type: SegmentType;
-    title: string;
-    sections: SegmentSection[];
-    keywords: string[];
-    actions: SegmentAction[];
-    speech: SegmentSpeech[];
-    textSummary?: string;
-    lastUpdatedFromPendingSegmentId?: string;
-    hackType: string;
-    /** use @uptime.app/text-to-speech-contracts */
-    locale: string;
-}
-
-export type SegmentType =
-    'overview' | 'favourite-quote' | 'in-a-nutshell' |
-    'introduction' | 'here-are-the-insights' |
-    'insight-one' | 'insight-two' | 'insight-three' |
-    'put-in-action' | 'conclusion' |
-    'shareable-overview' | 'download-app-to-see-more';
-
-export type CardType = 'hack-cover' | 'action';
-
-export interface SegmentAction {
-    title: string;
-    cards: SegmentTextCard[];
-}
-
-export interface SegmentTextCard {
-    id: string;
-    markdown: string;
-    segmentType: SegmentType;
-    cardType?: CardType;
-    isTitle?: boolean;
-    speech?: TextCardSpeech[];
-}
-
-export interface SegmentSection {
-    heading?: string;
-    cards: SegmentTextCard[];
-}
-
-export interface SegmentSpeech {
-    voice: SegmentVoice;
-    withHeading: {
-        url: string;
-        lengthSeconds: number;
-    };
-    withoutHeading: {
-        url: string;
-        lengthSeconds: number;
-    };
-}
-
-export interface TextCardSpeech {
-    voiceId: string;
-    withHeading: {
-        timestamps: {
-            startsAt: number;
-            endsAt: number;
-        };
-    };
-    withoutHeading: {
-        timestamps: {
-            startsAt: number;
-            endsAt: number;
-        };
-    };
-}
+export interface SegmentVoice {
+    id: string;
+    language: string;
+    name: string;
+    countryCode: string;
+    speechProvider: string;
+}
+
+export interface Segment {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    hackId: string;
+    type: SegmentType;
+    title: string;
+    sections: SegmentSection[];
+    keywords: string[];
+    actions: SegmentAction[];
+    speech: SegmentSpeech[];
+    textSummary?: string;
+    lastUpdatedFromPendingSegmentId?: string;
+    hackType: string;
+    /** use @uptime.app/text-to-speech-contracts */
+    locale: string;
+}
+
+export type SegmentType =
+    'overview' | 'favourite-quote' | 'in-a-nutshell' |
+    'introduction' | 'here-are-the-insights' |
+    'insight-one' | 'insight-two' | 'insight-three' |
+    'put-in-action' | 'conclusion' |
+    'shareable-overview' | 'download-app-to-see-more';
+
+export type CardType = 'hack-cover' | 'action';
+
+export interface SegmentAction {
+    title: string;
+    cards: SegmentTextCard[];
+}
+
+export interface SegmentTextCard {
+    id: string;
+    markdown: string;
+    segmentType: SegmentType;
+    cardType?: CardType;
+    isTitle?: boolean;
+    speech?: TextCardSpeech[];
+}
+
+export interface SegmentSection {
+    heading?: string;
+    cards: SegmentTextCard[];
+}
+
+export interface SegmentSpeech {
+    voice: SegmentVoice;
+    withHeading: {
+        url: string;
+        lengthSeconds: number;
+    };
+    withoutHeading: {
+        url: string;
+        lengthSeconds: number;
+    };
+}
+
+export interface TextCardSpeech {
+    voiceId: string;
+    withHeading: {
+        timestamps: {
+            startsAt: number;
+            endsAt: number;
+        };
+    };
+    withoutHeading: {
+        timestamps: {
+            startsAt: number;
+            endsAt: number;
+        };
+    };
+}

package/src/text-to-speech/create-speech-commands.ts

@@ -1,20 +1,20 @@
-import { TextSegment, Voice } from './text-segment';
-
-export interface CreateSpeechFromTextCommand {
-    id: string;
-    type: 'CreateSpeechFromText';
-    payload: {
-        locale: string;
-        textSegments: TextSegment[];
-    };
-}
-
-export interface CreateSpeechWithVoiceCommand {
-    id: string;
-    type: 'CreateSpeechWithVoice';
-    payload: {
-        locale: string;
-        textSegments: TextSegment[];
-        voice: Voice;
-    };
-}
+import { TextSegment, Voice } from './text-segment';
+
+export interface CreateSpeechFromTextCommand {
+    id: string;
+    type: 'CreateSpeechFromText';
+    payload: {
+        locale: string;
+        textSegments: TextSegment[];
+    };
+}
+
+export interface CreateSpeechWithVoiceCommand {
+    id: string;
+    type: 'CreateSpeechWithVoice';
+    payload: {
+        locale: string;
+        textSegments: TextSegment[];
+        voice: Voice;
+    };
+}

package/src/text-to-speech/speech-created-events.ts

@@ -1,11 +1,11 @@
-import { TextSegmentWithSpeech } from './text-segment';
-import { SupportedLocale } from '../localisation/supported-locales';
-
-export interface SpeechFromTextCreatedEvent {
-    id: string;
-    type: 'SpeechFromTextCreated';
-    payload: {
-        locale: SupportedLocale;
-        textSegments: TextSegmentWithSpeech[];
-    };
-}
+import { TextSegmentWithSpeech } from './text-segment';
+import { SupportedLocale } from '../localisation/supported-locales';
+
+export interface SpeechFromTextCreatedEvent {
+    id: string;
+    type: 'SpeechFromTextCreated';
+    payload: {
+        locale: SupportedLocale;
+        textSegments: TextSegmentWithSpeech[];
+    };
+}