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

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

@@ -1,21 +1,21 @@
-import { HackMetadata } from './hack-metadata';
-
-export interface HackMetadataCreatedEvent {
-    id: string;
-    type: 'HackMetadataCreated';
-    payload: HackMetadata;
-}
-
-export interface HackMetadataUpdatedEvent {
-    id: string;
-    type: 'HackMetadataUpdated';
-    payload: HackMetadata;
-}
-
-export interface HackMetadataDeletedEvent {
-    id: string;
-    type: 'HackMetadataDeleted';
-    payload: HackMetadata;
-}
-
-export type HackMetadataChangedEvent = HackMetadataCreatedEvent | HackMetadataUpdatedEvent | HackMetadataDeletedEvent;
+import { HackMetadata } from './hack-metadata';
+
+export interface HackMetadataCreatedEvent {
+    id: string;
+    type: 'HackMetadataCreated';
+    payload: HackMetadata;
+}
+
+export interface HackMetadataUpdatedEvent {
+    id: string;
+    type: 'HackMetadataUpdated';
+    payload: HackMetadata;
+}
+
+export interface HackMetadataDeletedEvent {
+    id: string;
+    type: 'HackMetadataDeleted';
+    payload: HackMetadata;
+}
+
+export type HackMetadataChangedEvent = HackMetadataCreatedEvent | HackMetadataUpdatedEvent | HackMetadataDeletedEvent;

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

@@ -1,17 +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[]
-    }
-}
+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,84 +1,84 @@
-export * from './access-control/collection-access-control';
-export * from './access-control/hack-access-control';
-
-export * from './app-hack/app-full-hack';
-export * from './app-hack/app-hack-metadata';
-export * from './app-hack/app-restricted-hack';
-
-export * from './b2b-organisation/b2b-organisation';
-export * from './b2b-organisation/b2b-organisation-events';
-
-export * from './b2b-organisation/b2b-organisation-member';
-export * from './b2b-organisation/b2b-organisation-member-events';
-
-export * from './brand/brand';
-export * from './brand/brand-events';
-
-export * from './collection/collection';
-export * from './collection/collection-events';
-export * from './collection/enriched-collection';
-export * from './collection/enriched-collection-events';
-
-export * from './distribution/distribution-events';
-export * from './distribution/hack-distribution';
-export * from './distribution/collection-distribution';
-
-export * from './draft-hack/draft-hack';
-export * from './draft-hack/draft-hack-events';
-
-export * from './draft-hack-generation/draft-hack-generation';
-export * from './draft-hack-generation/draft-hack-generation-events';
-
-export * from './enriched-hack/enriched-hack';
-export * from './enriched-hack/enriched-hack-events';
-
-export * from './entitlement/user-entitlements';
-export * from './entitlement/user-entitlements-events';
-
-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 './hack-metadata/hack-metadata';
-export * from './hack-metadata/hack-metadata-events';
-
-export * from './knowledge-source/knowledge-source';
-export * from './knowledge-source/knowledge-source-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 './profile/profile';
-export * from './profile/translated-profile';
-export * from './profile/profile-events';
-
-export * from './segment/segment-with-voice';
-export * from './segment/segment-commands';
-export * from './segment/segment';
-export * from './segment/segment-events';
-
-export * from './skin/skin';
-export * from './skin/skin-events';
-
-export * from './text-to-speech/create-speech-commands';
-export * from './text-to-speech/speech-created-events';
-export * from './text-to-speech/supported-voices';
-export * from './text-to-speech/text-segment';
-
-export * from './theme/theme';
-export * from './theme/theme-events';
-
-export * from './trending/trending-hacks';
-export * from './trending/trending-events';
-
-export * from './user-context/user-context';
-export * from './user-context/user-context-events';
+export * from './access-control/collection-access-control';
+export * from './access-control/hack-access-control';
+
+export * from './app-hack/app-full-hack';
+export * from './app-hack/app-hack-metadata';
+export * from './app-hack/app-restricted-hack';
+
+export * from './b2b-organisation/b2b-organisation';
+export * from './b2b-organisation/b2b-organisation-events';
+
+export * from './b2b-organisation/b2b-organisation-member';
+export * from './b2b-organisation/b2b-organisation-member-events';
+
+export * from './brand/brand';
+export * from './brand/brand-events';
+
+export * from './collection/collection';
+export * from './collection/collection-events';
+export * from './collection/enriched-collection';
+export * from './collection/enriched-collection-events';
+
+export * from './distribution/distribution-events';
+export * from './distribution/hack-distribution';
+export * from './distribution/collection-distribution';
+
+export * from './draft-hack/draft-hack';
+export * from './draft-hack/draft-hack-events';
+
+export * from './draft-hack-generation/draft-hack-generation';
+export * from './draft-hack-generation/draft-hack-generation-events';
+
+export * from './enriched-hack/enriched-hack';
+export * from './enriched-hack/enriched-hack-events';
+
+export * from './entitlement/user-entitlements';
+export * from './entitlement/user-entitlements-events';
+
+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 './hack-metadata/hack-metadata';
+export * from './hack-metadata/hack-metadata-events';
+
+export * from './knowledge-source/knowledge-source';
+export * from './knowledge-source/knowledge-source-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 './profile/profile';
+export * from './profile/translated-profile';
+export * from './profile/profile-events';
+
+export * from './segment/segment-with-voice';
+export * from './segment/segment-commands';
+export * from './segment/segment';
+export * from './segment/segment-events';
+
+export * from './skin/skin';
+export * from './skin/skin-events';
+
+export * from './text-to-speech/create-speech-commands';
+export * from './text-to-speech/speech-created-events';
+export * from './text-to-speech/supported-voices';
+export * from './text-to-speech/text-segment';
+
+export * from './theme/theme';
+export * from './theme/theme-events';
+
+export * from './trending/trending-hacks';
+export * from './trending/trending-events';
+
+export * from './user-context/user-context';
+export * from './user-context/user-context-events';

package/src/knowledge-source/knowledge-source-events.ts

@@ -1,21 +1,21 @@
-import { KnowledgeSource } from './knowledge-source';
-
-export interface KnowledgeSourceCreatedEvent {
-    id: string;
-    type: 'KnowledgeSourceCreated';
-    payload: KnowledgeSource;
-}
-
-export interface KnowledgeSourceUpdatedEvent {
-    id: string;
-    type: 'KnowledgeSourceUpdated';
-    payload: KnowledgeSource;
-}
-
-export interface KnowledgeSourceDeletedEvent {
-    id: string;
-    type: 'KnowledgeSourceDeleted';
-    payload: KnowledgeSource;
-}
-
-export type KnowledgeSourceChangedEvent = KnowledgeSourceCreatedEvent | KnowledgeSourceUpdatedEvent | KnowledgeSourceDeletedEvent;
+import { KnowledgeSource } from './knowledge-source';
+
+export interface KnowledgeSourceCreatedEvent {
+    id: string;
+    type: 'KnowledgeSourceCreated';
+    payload: KnowledgeSource;
+}
+
+export interface KnowledgeSourceUpdatedEvent {
+    id: string;
+    type: 'KnowledgeSourceUpdated';
+    payload: KnowledgeSource;
+}
+
+export interface KnowledgeSourceDeletedEvent {
+    id: string;
+    type: 'KnowledgeSourceDeleted';
+    payload: KnowledgeSource;
+}
+
+export type KnowledgeSourceChangedEvent = KnowledgeSourceCreatedEvent | KnowledgeSourceUpdatedEvent | KnowledgeSourceDeletedEvent;

package/src/knowledge-source/knowledge-source.ts

@@ -1,43 +1,43 @@
-export interface KnowledgeSource {
-    id: string;
-    /** @deprecated - use affiliate.url instead */
-    affiliateLink?: string;
-    // introduced Feb 2021. May be undefined in previous events
-    affiliate: Affiliate;
-    categories: Category[];
-    topics: Topic[];
-    coverUrl?: string;
-    createdAt: string;
-    description?: string;
-    contributors: Contributor[];
-    title: string;
-    type: KnowledgeSourceType;
-    updatedAt: string;
-    v: number;
-    metadata?: {
-        [key: string]: any;
-    };
-    /** Number of pages in the book. only set for books. May be undefined */
-    pageCount?: number;
-    /** Set for courses, documentaries and podcasts. May be undefined */
-    durationInMinutes?: number;
-}
-
-export type KnowledgeSourceType = 'book' | 'course' | 'documentary' | 'podcast';
-
-export interface Affiliate {
-    url?: string;
-    name?: string;
-}
-
-export interface Contributor {
-    name: string;
-}
-
-export interface Category {
-    name: string;
-}
-
-export interface Topic {
-    name: string;
-}
+export interface KnowledgeSource {
+    id: string;
+    /** @deprecated - use affiliate.url instead */
+    affiliateLink?: string;
+    // introduced Feb 2021. May be undefined in previous events
+    affiliate: Affiliate;
+    categories: Category[];
+    topics: Topic[];
+    coverUrl?: string;
+    createdAt: string;
+    description?: string;
+    contributors: Contributor[];
+    title: string;
+    type: KnowledgeSourceType;
+    updatedAt: string;
+    v: number;
+    metadata?: {
+        [key: string]: any;
+    };
+    /** Number of pages in the book. only set for books. May be undefined */
+    pageCount?: number;
+    /** Set for courses, documentaries and podcasts. May be undefined */
+    durationInMinutes?: number;
+}
+
+export type KnowledgeSourceType = 'book' | 'course' | 'documentary' | 'podcast';
+
+export interface Affiliate {
+    url?: string;
+    name?: string;
+}
+
+export interface Contributor {
+    name: string;
+}
+
+export interface Category {
+    name: string;
+}
+
+export interface Topic {
+    name: string;
+}

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