@uptime.app/contracts 1.0.39 → 1.0.41-rc.0

package/src/enriched-hack/enriched-hack.ts

@@ -1,103 +1,103 @@
-import { HackAffiliate, HackContributor, HackExternalLink, HackSourceData, HackTopic, HackType } from '../hack/hack';
-import { KnowledgeSource } from '../knowledge-source/knowledge-source';
-import { Profile } from '../profile/profile';
-import { Theme } from '../theme/theme';
-import { HackWithVoice } from '../hack/hack-with-voice';
-import { ExtractedSubject } from '../hack/extracted-subject';
-import { SegmentType, SegmentAction, SegmentSpeech, SegmentSection, SegmentTextCard } from '../segment/segment';
-
-export interface EnrichedHack {
-    /** The hack id */
-    id: string;
-    /** The hack language e.g. 'fr' if it is French */
-    language: string;
-    /** The locale (language and region) of the hack e.g. fr-FR. Use @uptime.app/localisation-contracts */
-    locale: string;
-    /** The id of the hack in its original locale. */
-    baseLocaleHackId: string;
-    v: number;
-    hackVersion: number;
-    createdAt: string;
-    updatedAt: string;
-
-    /** introduced Oct 2023 **/
-    draftHackId: string;
-    draftHackVersion: number;
-
-    //@todo: Deprecate
-    source?: KnowledgeSource;
-    owner: string;
-    acl: string[];
-    theme: Theme;
-    title: string;
-    isHidden?: boolean;
-    editorialTags?: 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;
-    notifications?: EnrichedHackNotifications;
-    /* currently contains the inANutshell segment markdown */
-    description: string;
-    // ...
-
-    segments: HackWithVoice['segments']; // Use the 'HackWithVoice' type
-    affiliate?: HackAffiliate;
-    topics: HackTopic[];
-    contributors?: HackContributor[];
-    type: HackType;
-    sourceData?: HackSourceData;
-    externalLink?: HackExternalLink;
-    profile: EnrichHackProfile;
-
-    /** added April 2024 */
-    // TODO make it mandatory after a republish
-    subjects?: EnrichedHackSubjects;
-
-    // distribution
-    includeInEmailNotifications: boolean;
-    includeInPushNotifications: boolean;
-    includeInRecommendations: boolean;
-    includeInSearchResults: boolean;
-    includeInTrending: boolean;
-    includeInHackOfTheDay: boolean;
-    includeInWebsite: boolean;
-
-    /**
-     * Time saved in minutes by consuming the hack rather than the underlying knowledge source.
-     * calculated using the knowledge source page count / duration
-     * */
-    timeSaved?: number;
-    /**
-     * An estimation of the time saved in minutes when no reliable information is available on the knowledge source.
-     */
-    estimatedTimeSaved?: number;
-}
-
-export interface EnrichedHackNotifications {
-    aiGeneratedText?: string;
-    humanCuratedText?: string;
-}
-
-export interface EnrichedHackSubjects {
-    aiGenerated: ExtractedSubject[];
-    humanCurated?: ExtractedSubject[];
-}
-
-export interface EnrichedHackSegment {
-    id: string;
-    createdAt: string;
-    updatedAt: string;
-    title: string;
-    type: SegmentType;
-    keywords: string[];
-    actions: SegmentAction[];
-    speech: SegmentSpeech[];
-    sections: SegmentSection[];
-    storyMode?: {
-        cards: SegmentTextCard[];
-        speech: SegmentSpeech[];
-    },
-    textSummary?: string;
-}
-
-export type EnrichHackProfile = Profile | { deleted: boolean, uptimeOwned: boolean, avatarUrl: string };
+import { HackAffiliate, HackContributor, HackExternalLink, HackSourceData, HackTopic, HackType } from '../hack/hack';
+import { KnowledgeSource } from '../knowledge-source/knowledge-source';
+import { Profile } from '../profile/profile';
+import { Theme } from '../theme/theme';
+import { HackWithVoice } from '../hack/hack-with-voice';
+import { ExtractedSubject } from '../hack/extracted-subject';
+import { SegmentType, SegmentAction, SegmentSpeech, SegmentSection, SegmentTextCard } from '../segment/segment';
+
+export interface EnrichedHack {
+    /** The hack id */
+    id: string;
+    /** The hack language e.g. 'fr' if it is French */
+    language: string;
+    /** The locale (language and region) of the hack e.g. fr-FR. Use @uptime.app/localisation-contracts */
+    locale: string;
+    /** The id of the hack in its original locale. */
+    baseLocaleHackId: string;
+    v: number;
+    hackVersion: number;
+    createdAt: string;
+    updatedAt: string;
+
+    /** introduced Oct 2023 **/
+    draftHackId: string;
+    draftHackVersion: number;
+
+    //@todo: Deprecate
+    source?: KnowledgeSource;
+    owner: string;
+    acl: string[];
+    theme: Theme;
+    title: string;
+    isHidden?: boolean;
+    editorialTags?: 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;
+    notifications?: EnrichedHackNotifications;
+    /* currently contains the inANutshell segment markdown */
+    description: string;
+    // ...
+
+    segments: HackWithVoice['segments']; // Use the 'HackWithVoice' type
+    affiliate?: HackAffiliate;
+    topics: HackTopic[];
+    contributors?: HackContributor[];
+    type: HackType;
+    sourceData?: HackSourceData;
+    externalLink?: HackExternalLink;
+    profile: EnrichHackProfile;
+
+    /** added April 2024 */
+    // TODO make it mandatory after a republish
+    subjects?: EnrichedHackSubjects;
+
+    // distribution
+    includeInEmailNotifications: boolean;
+    includeInPushNotifications: boolean;
+    includeInRecommendations: boolean;
+    includeInSearchResults: boolean;
+    includeInTrending: boolean;
+    includeInHackOfTheDay: boolean;
+    includeInWebsite: boolean;
+
+    /**
+     * Time saved in minutes by consuming the hack rather than the underlying knowledge source.
+     * calculated using the knowledge source page count / duration
+     * */
+    timeSaved?: number;
+    /**
+     * An estimation of the time saved in minutes when no reliable information is available on the knowledge source.
+     */
+    estimatedTimeSaved?: number;
+}
+
+export interface EnrichedHackNotifications {
+    aiGeneratedText?: string;
+    humanCuratedText?: string;
+}
+
+export interface EnrichedHackSubjects {
+    aiGenerated: ExtractedSubject[];
+    humanCurated?: ExtractedSubject[];
+}
+
+export interface EnrichedHackSegment {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    title: string;
+    type: SegmentType;
+    keywords: string[];
+    actions: SegmentAction[];
+    speech: SegmentSpeech[];
+    sections: SegmentSection[];
+    storyMode?: {
+        cards: SegmentTextCard[];
+        speech: SegmentSpeech[];
+    },
+    textSummary?: string;
+}
+
+export type EnrichHackProfile = Profile | { deleted: boolean, uptimeOwned: boolean, avatarUrl: string };

package/src/entitlement/user-entitlements-commands.ts

@@ -1,33 +1,33 @@
-import { Entitlement, EntitlementName } from './user-entitlements';
-
-export interface IssueUserEntitlementCommand {
-    id: string;
-    type: 'IssueUserEntitlement',
-    payload: IssueUserEntitlementCommandPayload
-}
-
-export interface IssueUserEntitlementCommandPayload extends Entitlement {
-    id: string;
-    v: number;
-    userId: string;
-}
-
-export interface RemoveUserEntitlementCommand {
-    id: string;
-    type: 'RemoveUserEntitlement',
-    payload: RemoveUserEntitlementCommandPayload
-}
-
-export interface RemoveUserEntitlementCommandPayload {
-    issuer: string;
-    entitlement: EntitlementName | string;
-    userId: string;
-}
-
-export interface RefreshRevenueCatUserStatusCommand {
-    id: string;
-    type: 'RefreshRevenueCatUserStatus',
-    payload: {
-        userId: string;
-    };
-}
+import { Entitlement, EntitlementName } from './user-entitlements';
+
+export interface IssueUserEntitlementCommand {
+    id: string;
+    type: 'IssueUserEntitlement',
+    payload: IssueUserEntitlementCommandPayload
+}
+
+export interface IssueUserEntitlementCommandPayload extends Entitlement {
+    id: string;
+    v: number;
+    userId: string;
+}
+
+export interface RemoveUserEntitlementCommand {
+    id: string;
+    type: 'RemoveUserEntitlement',
+    payload: RemoveUserEntitlementCommandPayload
+}
+
+export interface RemoveUserEntitlementCommandPayload {
+    issuer: string;
+    entitlement: EntitlementName | string;
+    userId: string;
+}
+
+export interface RefreshRevenueCatUserStatusCommand {
+    id: string;
+    type: 'RefreshRevenueCatUserStatus',
+    payload: {
+        userId: string;
+    };
+}

package/src/entitlement/user-entitlements-events.ts

@@ -1,29 +1,29 @@
-import { UserEntitlements } from './user-entitlements';
-
-export interface UserEntitlementsCreatedEvent {
-    id: string;
-    type: 'UserEntitlementsCreated';
-    payload: UserEntitlements;
-}
-
-export interface UserEntitlementsUpdatedEvent {
-    id: string;
-    type: 'UserEntitlementsUpdated';
-    payload: UserEntitlements;
-}
-
-export interface UserEntitlementsDeletedEvent {
-    id: string;
-    type: 'UserEntitlementsDeleted';
-    payload: UserEntitlements;
-}
-
-export type UserEntitlementsChangedEvent = UserEntitlementsCreatedEvent | UserEntitlementsUpdatedEvent | UserEntitlementsDeletedEvent;
-
-export interface RevenueCatWebhookReceivedEvent {
-    id: string;
-    type: 'RevenueCatWebhookReceived',
-    payload: {
-        event: any;
-    };
-}
+import { UserEntitlements } from './user-entitlements';
+
+export interface UserEntitlementsCreatedEvent {
+    id: string;
+    type: 'UserEntitlementsCreated';
+    payload: UserEntitlements;
+}
+
+export interface UserEntitlementsUpdatedEvent {
+    id: string;
+    type: 'UserEntitlementsUpdated';
+    payload: UserEntitlements;
+}
+
+export interface UserEntitlementsDeletedEvent {
+    id: string;
+    type: 'UserEntitlementsDeleted';
+    payload: UserEntitlements;
+}
+
+export type UserEntitlementsChangedEvent = UserEntitlementsCreatedEvent | UserEntitlementsUpdatedEvent | UserEntitlementsDeletedEvent;
+
+export interface RevenueCatWebhookReceivedEvent {
+    id: string;
+    type: 'RevenueCatWebhookReceived',
+    payload: {
+        event: any;
+    };
+}

package/src/entitlement/user-entitlements.ts

@@ -1,18 +1,18 @@
-export type EntitlementName = 'premium' | 'trial';
-export type EntitlementIssuer = 'Uptime' | 'RevenueCat';
-
-export type Entitlement = {
-    entitlement: EntitlementName | string;
-    issuer: EntitlementIssuer | string;
-    expiresAt: string
-    issuedAt: string;
-};
-
-export interface UserEntitlements {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    userId: string;
-    entitlements: Entitlement[];
-}
+export type EntitlementName = 'premium' | 'trial';
+export type EntitlementIssuer = 'Uptime' | 'RevenueCat';
+
+export type Entitlement = {
+    entitlement: EntitlementName | string;
+    issuer: EntitlementIssuer | string;
+    expiresAt: string
+    issuedAt: string;
+};
+
+export interface UserEntitlements {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    userId: string;
+    entitlements: Entitlement[];
+}

package/src/hack/extracted-subject.ts

@@ -1,31 +1,31 @@
-export interface ExtractedSubject {
-    name: string;
-}
-
-export interface ExtractSubjectsCommandBody {
-    id: string;
-    v: number;
-    reference: string;
-    content: string;
-    contentType: string; // e.g. 'hack'
-}
-
-export interface ExtractSubjectsCommand {
-    id: string;
-    type: 'ExtractSubjectsCommand';
-    payload: ExtractSubjectsCommandBody;
-}
-
-export interface SubjectsExtracted {
-    id: string;
-    type: 'SubjectsExtracted',
-    payload: SubjectsExtractedBody
-}
-
-export interface SubjectsExtractedBody {
-    id: string,
-    v: number,
-    reference: string,
-    contentType: string;
-    subjects: ExtractedSubject[]
-}
+export interface ExtractedSubject {
+    name: string;
+}
+
+export interface ExtractSubjectsCommandBody {
+    id: string;
+    v: number;
+    reference: string;
+    content: string;
+    contentType: string; // e.g. 'hack'
+}
+
+export interface ExtractSubjectsCommand {
+    id: string;
+    type: 'ExtractSubjectsCommand';
+    payload: ExtractSubjectsCommandBody;
+}
+
+export interface SubjectsExtracted {
+    id: string;
+    type: 'SubjectsExtracted',
+    payload: SubjectsExtractedBody
+}
+
+export interface SubjectsExtractedBody {
+    id: string,
+    v: number,
+    reference: string,
+    contentType: string;
+    subjects: ExtractedSubject[]
+}

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

@@ -1,21 +1,21 @@
-/**
- * HackPublished events were introduce in March 2023 and have not been backfilled. Previously PendingHackDeleted events were used.
- */
-export interface HackPublishedEvent {
-    id: string;
-    type: 'HackPublished';
-    payload: {
-        /** set as the hack id */
-        id: string;
-        /** set as the hack version */
-        v: number;
-        draftHackId: string;
-        draftHackVersion: number;
-        hackId: string;
-        hackVersion: number;
-        baseLocaleHackId: string;
-        // added very shortly after the event was introduced so a handful of historic events may be missing this property
-        publishCompletedAt: string
-        publishStartedAt: string;
-    }
-}
+/**
+ * HackPublished events were introduce in March 2023 and have not been backfilled. Previously PendingHackDeleted events were used.
+ */
+export interface HackPublishedEvent {
+    id: string;
+    type: 'HackPublished';
+    payload: {
+        /** set as the hack id */
+        id: string;
+        /** set as the hack version */
+        v: number;
+        draftHackId: string;
+        draftHackVersion: number;
+        hackId: string;
+        hackVersion: number;
+        baseLocaleHackId: string;
+        // added very shortly after the event was introduced so a handful of historic events may be missing this property
+        publishCompletedAt: string
+        publishStartedAt: string;
+    }
+}

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