@uptime.app/contracts 1.0.13-rc.0 → 1.0.13

package/src/profile/profile.ts

@@ -1,27 +1,27 @@
-import { SupportedLocale } from '../localisation/supported-locales';
-
-export interface StoredProfile {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    avatarUrl: string;
-    name: string;
-    owner: string;
-    handle: string;
-    _sanitisedHandle?: string; // use to determinate uniqueness for a handle, despite the case of it
-    headerImageUrl?: string;
-    tags?: string[];
-    links?: ProfileLink[];
-    tagline: string;
-    description?: string;
-    /** The locale (language and region) of the draft hack e.g. fr-FR. Mandatory property since 12/05/2023. */
-    locale: SupportedLocale;
-}
-
-export type Profile = Omit<StoredProfile, '_sanitisedHandle'>;
-
-export interface ProfileLink {
-    type: 'Other' | 'Twitter' | 'Facebook' | 'Youtube' | 'Medium' | 'Instagram' | 'Patreon' | 'TikTok' | 'LinkedIn' | 'LinkTree';
-    url: string;
-}
+import { SupportedLocale } from '../localisation/supported-locales';
+
+export interface StoredProfile {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    avatarUrl: string;
+    name: string;
+    owner: string;
+    handle: string;
+    _sanitisedHandle?: string; // use to determinate uniqueness for a handle, despite the case of it
+    headerImageUrl?: string;
+    tags?: string[];
+    links?: ProfileLink[];
+    tagline: string;
+    description?: string;
+    /** The locale (language and region) of the draft hack e.g. fr-FR. Mandatory property since 12/05/2023. */
+    locale: SupportedLocale;
+}
+
+export type Profile = Omit<StoredProfile, '_sanitisedHandle'>;
+
+export interface ProfileLink {
+    type: 'Other' | 'Twitter' | 'Facebook' | 'Youtube' | 'Medium' | 'Instagram' | 'Patreon' | 'TikTok' | 'LinkedIn' | 'LinkTree';
+    url: string;
+}

package/src/profile/translated-profile.ts

@@ -1,13 +1,13 @@
-import { SupportedLocale } from '../localisation/supported-locales';
-
-export interface TranslatedProfile {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    profileId: string;
-    locale: SupportedLocale;
-    tagline: string;
-    description?: string;
-    tags?: string[];
-}
+import { SupportedLocale } from '../localisation/supported-locales';
+
+export interface TranslatedProfile {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    profileId: string;
+    locale: SupportedLocale;
+    tagline: string;
+    description?: string;
+    tags?: string[];
+}

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/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/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[];
+    };
+}

package/src/text-to-speech/text-segment.ts

@@ -1,29 +1,29 @@
-export interface TextSegment {
-    parentId: string;
-    textSegmentId: string;
-    content: string;
-}
-
-export interface TextSegmentWithSpeech extends TextSegment {
-    speech: Speech[];
-    /* The speech-friendly version of the "content" field. Trimmed, enrichment links removed, words replaced based on custom dictionary, etc. */
-    spokenContent: string;
-}
-
-export interface Speech {
-    voice: Voice;
-    url: string;
-}
-
-export interface Voice {
-    id: string;
-    language: string;
-    name: string;
-    countryCode: string;
-    /** use SupportedSpeechProvider */
-    speechProvider: string;
-}
-
-export enum SupportedSpeechProvider {
-    MicrosoftAzure = 'microsoft-azure'
-}
+export interface TextSegment {
+    parentId: string;
+    textSegmentId: string;
+    content: string;
+}
+
+export interface TextSegmentWithSpeech extends TextSegment {
+    speech: Speech[];
+    /* The speech-friendly version of the "content" field. Trimmed, enrichment links removed, words replaced based on custom dictionary, etc. */
+    spokenContent: string;
+}
+
+export interface Speech {
+    voice: Voice;
+    url: string;
+}
+
+export interface Voice {
+    id: string;
+    language: string;
+    name: string;
+    countryCode: string;
+    /** use SupportedSpeechProvider */
+    speechProvider: string;
+}
+
+export enum SupportedSpeechProvider {
+    MicrosoftAzure = 'microsoft-azure'
+}

package/src/theme/theme-events.ts

@@ -1,21 +1,21 @@
-import { Theme } from './theme';
-
-export interface ThemeCreatedEvent {
-    id: string;
-    type: 'ThemeCreated';
-    payload: Theme;
-}
-
-export interface ThemeUpdatedEvent {
-    id: string;
-    type: 'ThemeUpdated';
-    payload: Theme;
-}
-
-export interface ThemeDeletedEvent {
-    id: string;
-    type: 'ThemeDeleted';
-    payload: Theme;
-}
-
-export type ThemeChangedEvent = ThemeCreatedEvent | ThemeUpdatedEvent | ThemeDeletedEvent;
+import { Theme } from './theme';
+
+export interface ThemeCreatedEvent {
+    id: string;
+    type: 'ThemeCreated';
+    payload: Theme;
+}
+
+export interface ThemeUpdatedEvent {
+    id: string;
+    type: 'ThemeUpdated';
+    payload: Theme;
+}
+
+export interface ThemeDeletedEvent {
+    id: string;
+    type: 'ThemeDeleted';
+    payload: Theme;
+}
+
+export type ThemeChangedEvent = ThemeCreatedEvent | ThemeUpdatedEvent | ThemeDeletedEvent;