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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uptime.app/contracts",
-  "version": "1.0.3",
+  "version": "1.0.4-rc.0",
   "license": "MIT",
   "types": "./dist/esm/index.d.ts",
   "main": "./dist/cjs/index.js",
@@ -13,5 +13,5 @@
   "devDependencies": {
     "typescript": "^5.4.3"
   },
-  "gitHead": "0250cf2a99f7c8e575521b81defbf7e6b962ae99"
+  "gitHead": "5795a8e46d9e27099f3ac7c7a63883348eec5a01"
 }

package/src/hack/extracted-subject.ts

@@ -1,5 +1,5 @@
-
-// defined in @uptime.app/subject-extraction-service but trying to avoid too many dependencies
-export interface ExtractedSubject {
-    name: string;
+
+// defined in @uptime.app/subject-extraction-service but trying to avoid too many dependencies
+export interface ExtractedSubject {
+    name: string;
 }

package/src/hack/hack-events.ts

@@ -1,21 +1,21 @@
-import { Hack } from './hack';
-
-export interface HackCreatedEvent {
-    id: string;
-    type: 'HackCreated';
-    payload: Hack;
-}
-
-export interface HackUpdatedEvent {
-    id: string;
-    type: 'HackUpdated';
-    payload: Hack;
-}
-
-export interface HackDeletedEvent {
-    id: string;
-    type: 'HackDeleted';
-    payload: Hack;
-}
-
-export type HackChangedEvent = HackCreatedEvent | HackUpdatedEvent | HackDeletedEvent;
+import { Hack } from './hack';
+
+export interface HackCreatedEvent {
+    id: string;
+    type: 'HackCreated';
+    payload: Hack;
+}
+
+export interface HackUpdatedEvent {
+    id: string;
+    type: 'HackUpdated';
+    payload: Hack;
+}
+
+export interface HackDeletedEvent {
+    id: string;
+    type: 'HackDeleted';
+    payload: Hack;
+}
+
+export type HackChangedEvent = HackCreatedEvent | HackUpdatedEvent | HackDeletedEvent;

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

@@ -1,21 +1,21 @@
-import { HackWithVoice } from './hack-with-voice';
-
-export interface HackWithVoiceCreatedEvent {
-    id: string;
-    type: 'HackWithVoiceCreated';
-    payload: HackWithVoice;
-}
-
-export interface HackWithVoiceUpdatedEvent {
-    id: string;
-    type: 'HackWithVoiceUpdated';
-    payload: HackWithVoice;
-}
-
-export interface HackWithVoiceDeletedEvent {
-    id: string;
-    type: 'HackWithVoiceDeleted';
-    payload: HackWithVoice;
-}
-
+import { HackWithVoice } from './hack-with-voice';
+
+export interface HackWithVoiceCreatedEvent {
+    id: string;
+    type: 'HackWithVoiceCreated';
+    payload: HackWithVoice;
+}
+
+export interface HackWithVoiceUpdatedEvent {
+    id: string;
+    type: 'HackWithVoiceUpdated';
+    payload: HackWithVoice;
+}
+
+export interface HackWithVoiceDeletedEvent {
+    id: string;
+    type: 'HackWithVoiceDeleted';
+    payload: HackWithVoice;
+}
+
 export type HackWithVoiceChangedEvent = HackWithVoiceCreatedEvent | HackWithVoiceUpdatedEvent | HackWithVoiceDeletedEvent;

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

@@ -1,33 +1,33 @@
-import { Segment } from '../segment/segment';
-
-/**
- * HackWithVoice contains the Hack segments a a few basic Hack fields, it does not contain other Hack information.
- * This decision was made due to the complexity of editorialTags and updating them.
- */
-export interface HackWithVoice {
-    /** NOT the id of the hack. Use hackId. The id cannot be the hackId as otherwise id would be duplicated for each voice which would break message replay */
-    id: string;
-    /** The id of the hack */
-    hackId: string;
-    baseLocaleHackId: string;
-    /** The id of voice used to generate the audio */
-    voiceId: string;
-    /** True if this is the default voice */
-    isDefaultVoice: boolean;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-
-    segments: {
-        favouriteQuote: Segment;
-        inANutshell: Segment;
-        introduction: Segment;
-        insights: Segment[];
-        conclusion: Segment;
-        // composite segments
-        overview: Segment;
-        shareableOverview: Segment;
-        hereAreTheInsights: Segment;
-        putInAction?: Segment;
-    }
-}
+import { Segment } from '../segment/segment';
+
+/**
+ * HackWithVoice contains the Hack segments a a few basic Hack fields, it does not contain other Hack information.
+ * This decision was made due to the complexity of editorialTags and updating them.
+ */
+export interface HackWithVoice {
+    /** NOT the id of the hack. Use hackId. The id cannot be the hackId as otherwise id would be duplicated for each voice which would break message replay */
+    id: string;
+    /** The id of the hack */
+    hackId: string;
+    baseLocaleHackId: string;
+    /** The id of voice used to generate the audio */
+    voiceId: string;
+    /** True if this is the default voice */
+    isDefaultVoice: boolean;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+
+    segments: {
+        favouriteQuote: Segment;
+        inANutshell: Segment;
+        introduction: Segment;
+        insights: Segment[];
+        conclusion: Segment;
+        // composite segments
+        overview: Segment;
+        shareableOverview: Segment;
+        hereAreTheInsights: Segment;
+        putInAction?: Segment;
+    }
+}

package/src/hack/hack.ts

@@ -1,114 +1,114 @@
-import { ExtractedSubject } from './extracted-subject';
-export interface Hack {
-    /** The unique id of the hack. */
-    id: string;
-    /** The locale (language and region) of the hack e.g. fr-FR. Use @uptime.app/localisation-contracts Mandatory property since 12/01/2023. */
-    locale: string;
-    /** The id of the hack in its original locale. Mandatory property since 12/01/2023. */
-    baseLocaleHackId: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    owner: string;
-    sourceId?: string;
-    title: string;
-    themeId: string;
-
-    /** introduced Oct 2023 **/
-    draftHackId: string;
-    draftHackVersion: number;
-
-    // TODO I'd remove it altogether, but it would be a breaking contract change. Thoughts?
-    isHidden?: boolean;
-
-    editorialTags?: string[];
-    coverUrl?: string;
-    notifications?: {
-        aiGeneratedText?: string
-        humanCuratedText?: string;
-    },
-    segments: {
-        favouriteQuote: {
-            id: string;
-            /** added 04/2023 */
-            v?: number;
-        };
-        inANutshell: {
-            id: string;
-            /** added 04/2023 */
-            v?: number;
-        };
-        introduction: {
-            id: string;
-            /** added 04/2023 */
-            v?: number;
-        };
-        insights: {
-            id: string
-            /** added 04/2023 */
-            v?: number;
-        }[];
-        conclusion: {
-            id: string;
-            /** added 04/2023 */
-            v?: number;
-        };
-
-        // composite segments
-        overview: {
-            id: string;
-            /** added 04/2023 */
-            v?: number;
-        };
-        shareableOverview: {
-            id: string;
-            /** added 04/2023 */
-            v?: number;
-        };
-        hereAreTheInsights: {
-            id: string;
-            /** added 04/2023 */
-            v?: number;
-        };
-        putInAction?: {
-            id: string;
-            /** added 04/2023 */
-            v?: number;
-        };
-    };
-    affiliate?: HackAffiliate;
-    topics: HackTopic[];
-    contributors?: HackContributor[];
-    type: HackType;
-    sourceData?: HackSourceData;
-    externalLink?: HackExternalLink;
-
-    /** added Mar 2024 */
-    // TODO make it mandatory after a republish
-    subjects?: ExtractedSubject[];
-}
-
-export interface HackContributor {
-    name: string;
-}
-
-export interface HackTopic {
-    name: string;
-}
-
-export interface HackAffiliate {
-    url: string;
-    name: string;
-}
-
-export declare type HackType = 'book' | 'course' | 'documentary' | 'podcast' | 'original';
-
-export interface HackSourceData {
-    episodeTitle?: string;
-    releaseDate?: string;
-}
-
-export interface HackExternalLink {
-    url: string;
-    type: 'Website' | 'Book' | 'Course' | 'Podcast' | 'Video' | 'Other';
-}
+import { ExtractedSubject } from './extracted-subject';
+export interface Hack {
+    /** The unique id of the hack. */
+    id: string;
+    /** The locale (language and region) of the hack e.g. fr-FR. Use @uptime.app/localisation-contracts Mandatory property since 12/01/2023. */
+    locale: string;
+    /** The id of the hack in its original locale. Mandatory property since 12/01/2023. */
+    baseLocaleHackId: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    owner: string;
+    sourceId?: string;
+    title: string;
+    themeId: string;
+
+    /** introduced Oct 2023 **/
+    draftHackId: string;
+    draftHackVersion: number;
+
+    // TODO I'd remove it altogether, but it would be a breaking contract change. Thoughts?
+    isHidden?: boolean;
+
+    editorialTags?: string[];
+    coverUrl?: string;
+    notifications?: {
+        aiGeneratedText?: string
+        humanCuratedText?: string;
+    },
+    segments: {
+        favouriteQuote: {
+            id: string;
+            /** added 04/2023 */
+            v?: number;
+        };
+        inANutshell: {
+            id: string;
+            /** added 04/2023 */
+            v?: number;
+        };
+        introduction: {
+            id: string;
+            /** added 04/2023 */
+            v?: number;
+        };
+        insights: {
+            id: string
+            /** added 04/2023 */
+            v?: number;
+        }[];
+        conclusion: {
+            id: string;
+            /** added 04/2023 */
+            v?: number;
+        };
+
+        // composite segments
+        overview: {
+            id: string;
+            /** added 04/2023 */
+            v?: number;
+        };
+        shareableOverview: {
+            id: string;
+            /** added 04/2023 */
+            v?: number;
+        };
+        hereAreTheInsights: {
+            id: string;
+            /** added 04/2023 */
+            v?: number;
+        };
+        putInAction?: {
+            id: string;
+            /** added 04/2023 */
+            v?: number;
+        };
+    };
+    affiliate?: HackAffiliate;
+    topics: HackTopic[];
+    contributors?: HackContributor[];
+    type: HackType;
+    sourceData?: HackSourceData;
+    externalLink?: HackExternalLink;
+
+    /** added Mar 2024 */
+    // TODO make it mandatory after a republish
+    subjects?: ExtractedSubject[];
+}
+
+export interface HackContributor {
+    name: string;
+}
+
+export interface HackTopic {
+    name: string;
+}
+
+export interface HackAffiliate {
+    url: string;
+    name: string;
+}
+
+export declare type HackType = 'book' | 'course' | 'documentary' | 'podcast' | 'original';
+
+export interface HackSourceData {
+    episodeTitle?: string;
+    releaseDate?: string;
+}
+
+export interface HackExternalLink {
+    url: string;
+    type: 'Website' | 'Book' | 'Course' | 'Podcast' | 'Video' | 'Other';
+}

package/src/hack-metadata/hack-metadata.ts

@@ -0,0 +1,17 @@
+import { ExtractedSubject } from '../hack/extracted-subject';
+
+export interface HackMetadata {
+    // hackId
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+
+    hackId: string;
+    baseLocaleHackId: string;
+    draftHackId: string;
+    subjects: {
+        aiGenerated?: ExtractedSubject[],
+        humanCurated?: ExtractedSubject[]
+    }
+}

package/src/index.ts

@@ -1,23 +1,23 @@
-export * from './hack/extracted-subject';
-export * from './hack/hack';
-export * from './hack/hack-with-voice';
-export * from './hack/hack-events';
-export * from './hack/hack-with-voice-events';
-
-export * from './localisation/live-locales';
-export * from './localisation/locale-language';
-export * from './localisation/supported-languages';
-export * from './localisation/supported-locales';
-
-export * from './pending-hack/pending-hack';
-export * from './pending-hack/pending-hack-events';
-export * from './pending-hack/pending-hack-with-voice';
-export * from './pending-hack/pending-hack-with-voice-events';
-
-export * from './segment/segment-with-voice';
-export * from './segment/segment-commands';
-export * from './segment/segment';
-
-export * from './text-to-speech/create-speech-commands';
-export * from './text-to-speech/speech-created-events';
-export * from './text-to-speech/text-segment';
+export * from './hack/extracted-subject';
+export * from './hack/hack';
+export * from './hack/hack-with-voice';
+export * from './hack/hack-events';
+export * from './hack/hack-with-voice-events';
+
+export * from './localisation/live-locales';
+export * from './localisation/locale-language';
+export * from './localisation/supported-languages';
+export * from './localisation/supported-locales';
+
+export * from './pending-hack/pending-hack';
+export * from './pending-hack/pending-hack-events';
+export * from './pending-hack/pending-hack-with-voice';
+export * from './pending-hack/pending-hack-with-voice-events';
+
+export * from './segment/segment-with-voice';
+export * from './segment/segment-commands';
+export * from './segment/segment';
+
+export * from './text-to-speech/create-speech-commands';
+export * from './text-to-speech/speech-created-events';
+export * from './text-to-speech/text-segment';

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;