@uptime.app/contracts 1.0.4 → 1.0.5-rc.2

package/src/localisation/live-locales.ts

@@ -1,33 +1,33 @@
-import { DEFAULT_LOCALE, SupportedLocale } from './supported-locales';
-
-/**
- * All locale codes that are live and in use in the app
- */
-export function allLiveLocaleCodes(): SupportedLocale[] {
-    return [
-        SupportedLocale.enGB,
-        SupportedLocale.enUS,
-        SupportedLocale.ptBR,
-        SupportedLocale.es,
-        SupportedLocale.frFR,
-        SupportedLocale.itIT,
-        SupportedLocale.nlNL,
-        SupportedLocale.deDE,
-        SupportedLocale.frCA,
-        SupportedLocale.plPL,
-        SupportedLocale.svSE,
-        SupportedLocale.trTR
-    ];
-}
-
-export function localeCodeIsLive(localeCode: string) {
-    return allLiveLocaleCodes().includes(localeCode as SupportedLocale);
-}
-
-export function liveLocaleFrom(localeCode?: string): SupportedLocale {
-    const locale = allLiveLocaleCodes().find(liveLocale => liveLocale  == localeCode);
-    if (!locale) {
-        return DEFAULT_LOCALE;
-    }
-    return locale;
+import { DEFAULT_LOCALE, SupportedLocale } from './supported-locales';
+
+/**
+ * All locale codes that are live and in use in the app
+ */
+export function allLiveLocaleCodes(): SupportedLocale[] {
+    return [
+        SupportedLocale.enGB,
+        SupportedLocale.enUS,
+        SupportedLocale.ptBR,
+        SupportedLocale.es,
+        SupportedLocale.frFR,
+        SupportedLocale.itIT,
+        SupportedLocale.nlNL,
+        SupportedLocale.deDE,
+        SupportedLocale.frCA,
+        SupportedLocale.plPL,
+        SupportedLocale.svSE,
+        SupportedLocale.trTR
+    ];
+}
+
+export function localeCodeIsLive(localeCode: string) {
+    return allLiveLocaleCodes().includes(localeCode as SupportedLocale);
+}
+
+export function liveLocaleFrom(localeCode?: string): SupportedLocale {
+    const locale = allLiveLocaleCodes().find(liveLocale => liveLocale  == localeCode);
+    if (!locale) {
+        return DEFAULT_LOCALE;
+    }
+    return locale;
 }

package/src/localisation/locale-language.ts

@@ -1,4 +1,4 @@
-export function languageOf(locale: string): string {
-    if (!locale) return ''; // temp: defend against an undefined locale
-    return locale.split('-')[0];
-}
+export function languageOf(locale: string): string {
+    if (!locale) return ''; // temp: defend against an undefined locale
+    return locale.split('-')[0];
+}

package/src/localisation/supported-languages.ts

@@ -1,11 +1,11 @@
-import { allSupportedLocaleCodes } from './supported-locales';
-
-export function allSupportedLanguageCodes(): string[] {
-    const languageCodes = allSupportedLocaleCodes().map(locale => locale.split('-')[0]);
-    const uniqueLanguageCodes = [...new Set(languageCodes)];
-
-    return uniqueLanguageCodes;
-}
-
-export const ENGLISH_LANGUAGE = 'en';
-export const DEFAULT_LANGUAGE = ENGLISH_LANGUAGE;
+import { allSupportedLocaleCodes } from './supported-locales';
+
+export function allSupportedLanguageCodes(): string[] {
+    const languageCodes = allSupportedLocaleCodes().map(locale => locale.split('-')[0]);
+    const uniqueLanguageCodes = [...new Set(languageCodes)];
+
+    return uniqueLanguageCodes;
+}
+
+export const ENGLISH_LANGUAGE = 'en';
+export const DEFAULT_LANGUAGE = ENGLISH_LANGUAGE;

package/src/localisation/supported-locales.ts

@@ -1,42 +1,42 @@
-export enum SupportedLocale {
-    /** English (United Kingdom) */
-    enGB = 'en-GB',
-    /** English (United States) */
-    enUS = 'en-US',
-    /** Portuguese (Brazil) */
-    ptBR = 'pt-BR',
-    /** Spanish (International) */
-    es = 'es',
-    /** French (France) */
-    frFR = 'fr-FR',
-    /** Italian */
-    itIT = 'it-IT',
-    /** Dutch */
-    nlNL = 'nl-NL',
-    /** German */
-    deDE = 'de-DE',
-    /** Polish */
-    plPL = 'pl-PL',
-    /** Swedish */
-    svSE = 'sv-SE',
-    /** Turkish */
-    trTR = 'tr-TR',
-    /** Canadian French */
-    frCA = 'fr-CA',
-    /** Traditional Chinese */
-    zhTW = 'zh-TW',
-    /** Simplified Chinese */
-    zhCN = 'zh-CN',
-    /** Malaysian Malay */
-    msMY = 'ms-MY'
-
-}
-
-/**
- * All supported locale codes. Use allLiveLocaleCodes() instead when checking for locale codes supported by the app
- */
-export function allSupportedLocaleCodes(): string[] {
-    return Object.values(SupportedLocale);
-}
-
-export const DEFAULT_LOCALE = SupportedLocale.enUS;
+export enum SupportedLocale {
+    /** English (United Kingdom) */
+    enGB = 'en-GB',
+    /** English (United States) */
+    enUS = 'en-US',
+    /** Portuguese (Brazil) */
+    ptBR = 'pt-BR',
+    /** Spanish (International) */
+    es = 'es',
+    /** French (France) */
+    frFR = 'fr-FR',
+    /** Italian */
+    itIT = 'it-IT',
+    /** Dutch */
+    nlNL = 'nl-NL',
+    /** German */
+    deDE = 'de-DE',
+    /** Polish */
+    plPL = 'pl-PL',
+    /** Swedish */
+    svSE = 'sv-SE',
+    /** Turkish */
+    trTR = 'tr-TR',
+    /** Canadian French */
+    frCA = 'fr-CA',
+    /** Traditional Chinese */
+    zhTW = 'zh-TW',
+    /** Simplified Chinese */
+    zhCN = 'zh-CN',
+    /** Malaysian Malay */
+    msMY = 'ms-MY'
+
+}
+
+/**
+ * All supported locale codes. Use allLiveLocaleCodes() instead when checking for locale codes supported by the app
+ */
+export function allSupportedLocaleCodes(): string[] {
+    return Object.values(SupportedLocale);
+}
+
+export const DEFAULT_LOCALE = SupportedLocale.enUS;

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