@uptime.app/contracts 1.0.39 → 1.0.41-rc.0

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-events.ts

@@ -1,42 +1,42 @@
-import { Segment } from './segment';
-import { SegmentWithVoice } from './segment-with-voice';
-
-export interface SegmentCreatedEvent {
-    id: string;
-    type: 'SegmentCreated';
-    payload: Segment;
-}
-
-export interface SegmentUpdatedEvent {
-    id: string;
-    type: 'SegmentUpdated';
-    payload: Segment;
-}
-
-export interface SegmentDeletedEvent {
-    id: string;
-    type: 'SegmentDeleted';
-    payload: Segment;
-}
-
-export type SegmentChangedEvent = SegmentCreatedEvent | SegmentUpdatedEvent | SegmentDeletedEvent;
-
-export interface SegmentWithVoiceCreatedEvent {
-    id: string;
-    type: 'SegmentWithVoiceCreated';
-    payload: SegmentWithVoice;
-}
-
-export interface SegmentWithVoiceUpdatedEvent {
-    id: string;
-    type: 'SegmentWithVoiceUpdated';
-    payload: SegmentWithVoice;
-}
-
-export interface SegmentWithVoiceDeletedEvent {
-    id: string;
-    type: 'SegmentWithVoiceDeleted';
-    payload: SegmentWithVoice;
-}
-
-export type SegmentWithVoiceChangedEvent = SegmentWithVoiceCreatedEvent | SegmentWithVoiceUpdatedEvent | SegmentWithVoiceDeletedEvent;
+import { Segment } from './segment';
+import { SegmentWithVoice } from './segment-with-voice';
+
+export interface SegmentCreatedEvent {
+    id: string;
+    type: 'SegmentCreated';
+    payload: Segment;
+}
+
+export interface SegmentUpdatedEvent {
+    id: string;
+    type: 'SegmentUpdated';
+    payload: Segment;
+}
+
+export interface SegmentDeletedEvent {
+    id: string;
+    type: 'SegmentDeleted';
+    payload: Segment;
+}
+
+export type SegmentChangedEvent = SegmentCreatedEvent | SegmentUpdatedEvent | SegmentDeletedEvent;
+
+export interface SegmentWithVoiceCreatedEvent {
+    id: string;
+    type: 'SegmentWithVoiceCreated';
+    payload: SegmentWithVoice;
+}
+
+export interface SegmentWithVoiceUpdatedEvent {
+    id: string;
+    type: 'SegmentWithVoiceUpdated';
+    payload: SegmentWithVoice;
+}
+
+export interface SegmentWithVoiceDeletedEvent {
+    id: string;
+    type: 'SegmentWithVoiceDeleted';
+    payload: SegmentWithVoice;
+}
+
+export type SegmentWithVoiceChangedEvent = SegmentWithVoiceCreatedEvent | SegmentWithVoiceUpdatedEvent | SegmentWithVoiceDeletedEvent;

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

@@ -1,21 +1,21 @@
-import { Skin } from './skin';
-
-export interface SkinCreatedEvent {
-    id: string;
-    type: 'SkinCreated';
-    payload: Skin;
-}
-
-export interface SkinUpdatedEvent {
-    id: string;
-    type: 'SkinUpdated';
-    payload: Skin;
-}
-
-export interface SkinDeletedEvent {
-    id: string;
-    type: 'SkinDeleted';
-    payload: Skin;
-}
-
-export type SkinChangedEvent = SkinCreatedEvent | SkinUpdatedEvent | SkinDeletedEvent;
+import { Skin } from './skin';
+
+export interface SkinCreatedEvent {
+    id: string;
+    type: 'SkinCreated';
+    payload: Skin;
+}
+
+export interface SkinUpdatedEvent {
+    id: string;
+    type: 'SkinUpdated';
+    payload: Skin;
+}
+
+export interface SkinDeletedEvent {
+    id: string;
+    type: 'SkinDeleted';
+    payload: Skin;
+}
+
+export type SkinChangedEvent = SkinCreatedEvent | SkinUpdatedEvent | SkinDeletedEvent;

package/src/skin/skin.ts

@@ -1,7 +1,7 @@
-
-export interface Skin {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
+
+export interface Skin {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
 }

package/src/spark/spark-board-read-model.ts

@@ -0,0 +1,17 @@
+import { Spark } from './spark';
+import { SparkBoardType } from './spark-board';
+
+export interface SparkBoardReadModel {
+    // the spark board id
+    id: string;
+    // the version of the read model
+    v: number;
+    updatedAt: string;
+    createdAt: string;
+    sparkBoardVersion: number;
+    userId: string;
+    boardName: string;
+    boardType?: SparkBoardType;
+    sparkCount: number;
+    firstSparks: Spark[];
+}

package/src/spark/spark-board.ts

@@ -0,0 +1,12 @@
+export interface SparkBoard {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    userId: string;
+    boardName: string;
+    boardType?: SparkBoardType;
+    isPublic: boolean;
+}
+
+export type SparkBoardType = 'default';

package/src/spark/spark-events.ts

@@ -0,0 +1,42 @@
+import { Spark } from './spark';
+import { SparkBoard } from './spark-board';
+
+export interface SparkCreatedEvent {
+    id: string;
+    type: 'SparkCreated';
+    payload: Spark;
+}
+
+export interface SparkUpdatedEvent {
+    id: string;
+    type: 'SparkUpdated';
+    payload: Spark;
+}
+
+export interface SparkDeletedEvent {
+    id: string;
+    type: 'SparkDeleted';
+    payload: Spark;
+}
+
+export type SparkChangedEvent = SparkCreatedEvent | SparkUpdatedEvent | SparkDeletedEvent;
+
+export interface SparkBoardCreatedEvent {
+    id: string;
+    type: 'SparkBoardCreated';
+    payload: SparkBoard;
+}
+
+export interface SparkBoardUpdatedEvent {
+    id: string;
+    type: 'SparkBoardUpdated';
+    payload: SparkBoard;
+}
+
+export interface SparkBoardDeletedEvent {
+    id: string;
+    type: 'SparkBoardDeleted';
+    payload: SparkBoard;
+}
+
+export type SparkBoardChangedEvent = SparkBoardCreatedEvent | SparkBoardUpdatedEvent | SparkBoardDeletedEvent;

package/src/spark/spark.ts

@@ -0,0 +1,80 @@
+import { CardType, SegmentType } from '../segment/segment';
+import { Profile } from '../profile/profile';
+import { SupportedLocale } from '../localisation/supported-locales';
+import { ThemeTemplate } from '../theme/theme';
+import { Hack } from '../hack/hack';
+
+export interface Spark {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    userId: string;
+    hackId: string;
+    segmentId: string;
+    card: SparkedCard;
+    boardId: string;
+    theme: {
+        fontFamily: string;
+        light: ThemeTemplate;
+        dark: ThemeTemplate;
+        player?: {
+            light: {
+                backgroundColor: string;
+            },
+            dark: {
+                backgroundColor: string;
+            }
+        }
+    };
+    note?: string;
+    hack: SparkHack;
+    baseLocaleHackId: string;
+    locale: SupportedLocale;
+    language: string;
+}
+
+export interface SparkedCard {
+    id: string;
+    markdown: string;
+    segmentType: SegmentType;
+    isTitle?: boolean;
+    cardType?: CardType;
+}
+
+// matches Profile of EnrichedHack interface
+export type SparkHack = Pick<Hack,
+'id'
+| 'title'
+| 'owner'
+| 'themeId'
+| 'isHidden'
+| 'editorialTags'
+| 'coverUrl'
+| 'topics'
+| 'type'
+| 'affiliate'
+| 'contributors'
+| 'createdAt'
+| 'updatedAt'
+| 'v'
+| 'sourceData'
+| 'subjects' >
+& {
+    profile: Profile
+    | {
+        deleted: boolean;
+        uptimeOwned: boolean;
+        avatarUrl: string;
+    };
+    segments: Pick<Hack['segments'],
+    'inANutshell'
+    | 'favouriteQuote'
+    | 'introduction'
+    | 'insights'
+    | 'conclusion'
+    | 'overview'
+    | 'hereAreTheInsights'
+    | 'putInAction'>;
+    acl: string[]
+};

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,10 +1,10 @@
-import { TextSegmentWithSpeech } from './text-segment';
-
-export interface SpeechFromTextCreatedEvent {
-    id: string;
-    type: 'SpeechFromTextCreated';
-    payload: {
-        locale: string;
-        textSegments: TextSegmentWithSpeech[];
-    };
-}
+import { TextSegmentWithSpeech } from './text-segment';
+
+export interface SpeechFromTextCreatedEvent {
+    id: string;
+    type: 'SpeechFromTextCreated';
+    payload: {
+        locale: string;
+        textSegments: TextSegmentWithSpeech[];
+    };
+}