@uptime.app/contracts 1.0.37 → 1.0.38-rc.1

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

@@ -1,77 +1,77 @@
-/* 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;
-    /** Added in July 2024. This is the URL of the cover image that is free to use without any copyright. */
-    copyrightFreeCoverUrl?: 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;
+    /** Added in July 2024. This is the URL of the cover image that is free to use without any copyright. */
+    copyrightFreeCoverUrl?: 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/profile/profile-events.ts

@@ -1,41 +1,41 @@
-import { Profile } from './profile';
-import { TranslatedProfile } from './translated-profile';
-
-export interface ProfileCreatedEvent {
-    id: string;
-    type: 'ProfileCreated';
-    payload: Profile;
-}
-
-export interface ProfileUpdatedEvent {
-    id: string;
-    type: 'ProfileUpdated';
-    payload: Profile;
-}
-
-export interface ProfileDeletedEvent {
-    id: string;
-    type: 'ProfileDeleted';
-    payload: Profile;
-}
-
-export interface TranslatedProfileCreatedEvent {
-    id: string;
-    type: 'TranslatedProfileCreated';
-    payload: TranslatedProfile;
-}
-
-export interface TranslatedProfileUpdatedEvent {
-    id: string;
-    type: 'TranslatedProfileUpdated';
-    payload: TranslatedProfile;
-}
-
-export interface TranslatedProfileDeletedEvent {
-    id: string;
-    type: 'TranslatedProfileDeleted';
-    payload: TranslatedProfile;
-}
-
-export type ProfileChangedEvent = ProfileCreatedEvent | ProfileUpdatedEvent | ProfileDeletedEvent;
-export type TranslatedProfileChangedEvent = TranslatedProfileCreatedEvent | TranslatedProfileUpdatedEvent | TranslatedProfileDeletedEvent;
+import { Profile } from './profile';
+import { TranslatedProfile } from './translated-profile';
+
+export interface ProfileCreatedEvent {
+    id: string;
+    type: 'ProfileCreated';
+    payload: Profile;
+}
+
+export interface ProfileUpdatedEvent {
+    id: string;
+    type: 'ProfileUpdated';
+    payload: Profile;
+}
+
+export interface ProfileDeletedEvent {
+    id: string;
+    type: 'ProfileDeleted';
+    payload: Profile;
+}
+
+export interface TranslatedProfileCreatedEvent {
+    id: string;
+    type: 'TranslatedProfileCreated';
+    payload: TranslatedProfile;
+}
+
+export interface TranslatedProfileUpdatedEvent {
+    id: string;
+    type: 'TranslatedProfileUpdated';
+    payload: TranslatedProfile;
+}
+
+export interface TranslatedProfileDeletedEvent {
+    id: string;
+    type: 'TranslatedProfileDeleted';
+    payload: TranslatedProfile;
+}
+
+export type ProfileChangedEvent = ProfileCreatedEvent | ProfileUpdatedEvent | ProfileDeletedEvent;
+export type TranslatedProfileChangedEvent = TranslatedProfileCreatedEvent | TranslatedProfileUpdatedEvent | TranslatedProfileDeletedEvent;

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-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;
+}