@uptime.app/contracts 1.0.13-rc.0 → 1.0.13-user-context.1

package/src/brand/brand-events.ts

@@ -1,21 +1,21 @@
-import { Brand } from './brand';
-
-export interface BrandCreatedEvent {
-    id: string;
-    type: 'BrandCreated';
-    payload: Brand;
-}
-
-export interface BrandUpdatedEvent {
-    id: string;
-    type: 'BrandUpdated';
-    payload: Brand;
-}
-
-export interface BrandDeletedEvent {
-    id: string;
-    type: 'BrandDeleted';
-    payload: Brand;
-}
-
-export type BrandChangedEvent = BrandCreatedEvent | BrandUpdatedEvent | BrandDeletedEvent;
+import { Brand } from './brand';
+
+export interface BrandCreatedEvent {
+    id: string;
+    type: 'BrandCreated';
+    payload: Brand;
+}
+
+export interface BrandUpdatedEvent {
+    id: string;
+    type: 'BrandUpdated';
+    payload: Brand;
+}
+
+export interface BrandDeletedEvent {
+    id: string;
+    type: 'BrandDeleted';
+    payload: Brand;
+}
+
+export type BrandChangedEvent = BrandCreatedEvent | BrandUpdatedEvent | BrandDeletedEvent;

package/src/brand/brand.ts

@@ -1,9 +1,9 @@
-
-export interface Brand {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    name: string;
-    skinId?: string;
+
+export interface Brand {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    name: string;
+    skinId?: string;
 }

package/src/distribution/collection-distribution.ts

@@ -1,17 +1,17 @@
-export interface CollectionDistribution extends CollectionDistributionProperties  {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    collectionId: string;
-    baseLocaleCollectionId: string;
-}
-
-export interface CollectionDistributionProperties {
-    includeInEmailNotifications: boolean;
-    includeInPushNotifications: boolean;
-    includeInRecommendations: boolean;
-    includeInSearchResults: boolean;
-    includeInWebsite: boolean;
-    isHidden: boolean;
-}
+export interface CollectionDistribution extends CollectionDistributionProperties  {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    collectionId: string;
+    baseLocaleCollectionId: string;
+}
+
+export interface CollectionDistributionProperties {
+    includeInEmailNotifications: boolean;
+    includeInPushNotifications: boolean;
+    includeInRecommendations: boolean;
+    includeInSearchResults: boolean;
+    includeInWebsite: boolean;
+    isHidden: boolean;
+}

package/src/distribution/distribution-events.ts

@@ -1,61 +1,61 @@
-import { HackDistribution } from './hack-distribution';
-import { CollectionDistribution } from './collection-distribution';
-
-export interface HackDistributionCreatedEvent {
-    id: string;
-    type: 'HackDistributionCreated';
-    payload: HackDistribution;
-}
-
-export interface HackDistributionUpdatedEvent {
-    id: string;
-    type: 'HackDistributionUpdated';
-    payload: HackDistribution;
-}
-
-export interface HackDistributionDeletedEvent {
-    id: string;
-    type: 'HackDistributionDeleted';
-    payload: HackDistribution;
-}
-
-export interface CollectionDistributionCreatedEvent {
-    id: string;
-    type: 'CollectionDistributionCreated';
-    payload: CollectionDistribution;
-}
-
-export interface CollectionDistributionUpdatedEvent {
-    id: string;
-    type: 'CollectionDistributionUpdated';
-    payload: CollectionDistribution;
-}
-
-export interface CollectionDistributionDeletedEvent {
-    id: string;
-    type: 'CollectionDistributionDeleted';
-    payload: CollectionDistribution;
-}
-
-export type HackDistributionChangedEvent = HackDistributionCreatedEvent | HackDistributionUpdatedEvent | HackDistributionDeletedEvent;
-export type CollectionDistributionChangedEvent = CollectionDistributionCreatedEvent | CollectionDistributionUpdatedEvent | CollectionDistributionDeletedEvent;
-
-export interface CheckPrivateHackDistributionEvent {
-    id: string;
-    type: 'CheckPrivateHackDistribution'
-    payload: {
-        id: string;
-        v: number;
-        hackId: string;
-    }
-}
-
-export interface CheckPrivateCollectionDistributionEvent {
-    id: string;
-    type: 'CheckPrivateCollectionDistribution'
-    payload: {
-        id: string;
-        v: number;
-        collectionId: string;
-    }
-}
+import { HackDistribution } from './hack-distribution';
+import { CollectionDistribution } from './collection-distribution';
+
+export interface HackDistributionCreatedEvent {
+    id: string;
+    type: 'HackDistributionCreated';
+    payload: HackDistribution;
+}
+
+export interface HackDistributionUpdatedEvent {
+    id: string;
+    type: 'HackDistributionUpdated';
+    payload: HackDistribution;
+}
+
+export interface HackDistributionDeletedEvent {
+    id: string;
+    type: 'HackDistributionDeleted';
+    payload: HackDistribution;
+}
+
+export interface CollectionDistributionCreatedEvent {
+    id: string;
+    type: 'CollectionDistributionCreated';
+    payload: CollectionDistribution;
+}
+
+export interface CollectionDistributionUpdatedEvent {
+    id: string;
+    type: 'CollectionDistributionUpdated';
+    payload: CollectionDistribution;
+}
+
+export interface CollectionDistributionDeletedEvent {
+    id: string;
+    type: 'CollectionDistributionDeleted';
+    payload: CollectionDistribution;
+}
+
+export type HackDistributionChangedEvent = HackDistributionCreatedEvent | HackDistributionUpdatedEvent | HackDistributionDeletedEvent;
+export type CollectionDistributionChangedEvent = CollectionDistributionCreatedEvent | CollectionDistributionUpdatedEvent | CollectionDistributionDeletedEvent;
+
+export interface CheckPrivateHackDistributionEvent {
+    id: string;
+    type: 'CheckPrivateHackDistribution'
+    payload: {
+        id: string;
+        v: number;
+        hackId: string;
+    }
+}
+
+export interface CheckPrivateCollectionDistributionEvent {
+    id: string;
+    type: 'CheckPrivateCollectionDistribution'
+    payload: {
+        id: string;
+        v: number;
+        collectionId: string;
+    }
+}

package/src/distribution/hack-distribution.ts

@@ -1,19 +1,19 @@
-export interface HackDistribution extends HackDistributionProperties  {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    hackId: string;
-    baseLocaleHackId: string; // added 09/03/23 to allow syncing across hacks with the same baseLocaleHackId
-}
-
-export interface HackDistributionProperties {
-    includeInEmailNotifications: boolean;
-    includeInPushNotifications: boolean;
-    includeInRecommendations: boolean;
-    includeInSearchResults: boolean;
-    includeInTrending: boolean;
-    includeInHackOfTheDay: boolean;
-    includeInWebsite: boolean;
-    isHidden: boolean; // added 17/11/22, to replace Hack property with the same name
+export interface HackDistribution extends HackDistributionProperties  {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    hackId: string;
+    baseLocaleHackId: string; // added 09/03/23 to allow syncing across hacks with the same baseLocaleHackId
+}
+
+export interface HackDistributionProperties {
+    includeInEmailNotifications: boolean;
+    includeInPushNotifications: boolean;
+    includeInRecommendations: boolean;
+    includeInSearchResults: boolean;
+    includeInTrending: boolean;
+    includeInHackOfTheDay: boolean;
+    includeInWebsite: boolean;
+    isHidden: boolean; // added 17/11/22, to replace Hack property with the same name
 }

package/src/draft-hack/draft-hack-events.ts

@@ -1,21 +1,21 @@
-import { DraftHack } from './draft-hack';
-
-export interface DraftHackCreatedEvent {
-    id: string;
-    type: 'DraftHackCreated';
-    payload: DraftHack;
-}
-
-export interface DraftHackUpdatedEvent {
-    id: string;
-    type: 'DraftHackUpdated';
-    payload: DraftHack;
-}
-
-export interface DraftHackDeletedEvent {
-    id: string;
-    type: 'DraftHackDeleted';
-    payload: DraftHack;
-}
-
-export type DraftHackChangedEvent = DraftHackCreatedEvent | DraftHackUpdatedEvent | DraftHackDeletedEvent;
+import { DraftHack } from './draft-hack';
+
+export interface DraftHackCreatedEvent {
+    id: string;
+    type: 'DraftHackCreated';
+    payload: DraftHack;
+}
+
+export interface DraftHackUpdatedEvent {
+    id: string;
+    type: 'DraftHackUpdated';
+    payload: DraftHack;
+}
+
+export interface DraftHackDeletedEvent {
+    id: string;
+    type: 'DraftHackDeleted';
+    payload: DraftHack;
+}
+
+export type DraftHackChangedEvent = DraftHackCreatedEvent | DraftHackUpdatedEvent | DraftHackDeletedEvent;

package/src/draft-hack/draft-hack.ts

@@ -1,184 +1,184 @@
-import { SupportedLocale } from '../localisation/supported-locales';
-
-export interface DraftHack extends DraftHackContent {
-    /** The unique id of the draft hack. */
-    id: string;
-    /** The locale (language and region) of the draft hack e.g. fr-FR. Mandatory property since 12/01/2023. */
-    locale: SupportedLocale;
-    /** @deprecated Temporarily added in 12/01/2023. Should not be used under any circumstance as only a handful of drafts will contain this property */
-    baseLocaleDraftHackId?: string;
-    /** The id of the hack. Mandatory property since Dec 2022. */
-    hackId: string;
-    /** The id of the hack in its original locale. Mandatory property since 01/02/2023. */
-    baseLocaleHackId: string;
-
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    publishedAt?: string;
-    publishedVersion?: number;
-    owner?: string;
-    /** workflowStatus was added in May 2022 as we move toward UGC. Older drafts have not been backfilled */
-    workflowStatus?: DraftHackWorkflowStatus;
-    /** added in Nov 2022. Set to true whenever content changes are made to the draft */
-    hasUnpublishedChanges?: boolean;
-    /** added in March 2023. Must be set whenever content changes are made to the draft */
-    contentUpdatedAt?: string;
-    /** added in late April 2023. Only set on translations. Set to the value of contentUpdatedAt of the base locale draft that was translated. Can be used to determine if the translated draft is out of sync with the original draft */
-    baseLocaleContentUpdatedAt?: string;
-}
-
-export interface DraftHackContent {
-    /**
-     * @maxLength 150
-     */
-    title: string;
-    /**
-     * @maxLength 50
-     */
-    sourceId?: string;
-    /**
-     * @maxLength 50
-     */
-    themeId?: string;
-    segments: DraftHackSegments;
-    /**
-     * @maxLength 1000
-     */
-    coverUrl?: string;
-    notifications?: DraftHackNotifications;
-    affiliate?: DraftAffiliate;
-    /**
-     * @maxItems 50
-     */
-    topics?: DraftTopic[];
-    /**
-     * @maxItems 10
-     */
-    contributors?: DraftContributor[];
-    sourceData?: DraftSourceData;
-    /** For creators only. We will tackle this validation once profiles are introduce*/
-    externalLink?: DraftHackExternalLink;
-    /** For recording purpose for now, we will use this value further in the future */
-    contentRating?: DraftHackRating;
-    /**
-     * @maxItems 50
-     * @items.maxLength 150
-     */
-    tags?: string[];
-    type?: DraftHackType;
-    isCopyrightFree?: boolean;
-}
-
-export interface DraftHackNotifications {
-    /**
-     * @maxLength 1000
-     */
-    aiGeneratedText?: string;
-    /**
-     * @maxLength 1000
-     */
-    humanCuratedText?: string;
-}
-
-export interface DraftHackSegments {
-    favouriteQuote?: DraftHackSegment;
-    inANutshell?: DraftHackSegment;
-    introduction?: DraftHackSegment;
-    /**
-     * @maxItems 10
-     */
-    insights?: DraftHackInsightSegment[];
-    conclusion?: DraftHackSegment;
-}
-
-export interface DraftHackCard {
-    /**
-     * @maxLength 2000
-     */
-    markdown: string;
-}
-
-export interface DraftHackSegment {
-    /**
-     * @maxItems 50
-     * @items.maxLength 150
-     */
-    keywords: string[];
-    paragraphCards: DraftHackCard[][];
-    /**
-     * @maxLength 1000
-     */
-    textSummary?: string;
-}
-
-export interface DraftHackInsightSegment extends DraftHackSegment {
-    /**
-     * @maxLength 150
-     */
-    title?: string;
-    /**
-     * @maxItems 50
-     */
-    actions: DraftHackAction[];
-}
-
-export interface DraftHackAction {
-    /**
-     * @maxLength 150
-     */
-    title: string;
-    /**
-     * @maxLength 1000
-     */
-    markdown: string
-}
-
-export interface DraftContributor {
-    /**
-     * @maxLength 150
-     */
-    name: string;
-}
-
-export interface DraftTopic {
-    /**
-     * @maxLength 150
-     */
-    name: string;
-}
-
-export interface DraftAffiliate {
-    /**
-     * @maxLength 1000
-     */
-    url?: string;
-    /**
-     * @maxLength 150
-     */
-    name?: string;
-}
-
-export interface DraftSourceData {
-    /**
-     * @maxLength 150
-     */
-    episodeTitle?: string;
-    /**
-     * @maxLength 50
-     */
-    releaseDate?: string;
-}
-
-export interface DraftHackExternalLink {
-    /**
-     * @maxLength 1000
-     */
-    url: string;
-    type: 'Website' | 'Book' | 'Course' | 'Podcast' | 'Video' | 'Other';
-}
-
-// this status is currently used to present the draft in different columns in the airtable used by the content team
-export type DraftHackWorkflowStatus = 'publishing' | 'published';
-export type DraftHackType = 'book' | 'course' | 'documentary' | 'podcast' | 'original';
-export type DraftHackRating = 'mature' | 'appropriate';
+import { SupportedLocale } from '../localisation/supported-locales';
+
+export interface DraftHack extends DraftHackContent {
+    /** The unique id of the draft hack. */
+    id: string;
+    /** The locale (language and region) of the draft hack e.g. fr-FR. Mandatory property since 12/01/2023. */
+    locale: SupportedLocale;
+    /** @deprecated Temporarily added in 12/01/2023. Should not be used under any circumstance as only a handful of drafts will contain this property */
+    baseLocaleDraftHackId?: string;
+    /** The id of the hack. Mandatory property since Dec 2022. */
+    hackId: string;
+    /** The id of the hack in its original locale. Mandatory property since 01/02/2023. */
+    baseLocaleHackId: string;
+
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    publishedAt?: string;
+    publishedVersion?: number;
+    owner?: string;
+    /** workflowStatus was added in May 2022 as we move toward UGC. Older drafts have not been backfilled */
+    workflowStatus?: DraftHackWorkflowStatus;
+    /** added in Nov 2022. Set to true whenever content changes are made to the draft */
+    hasUnpublishedChanges?: boolean;
+    /** added in March 2023. Must be set whenever content changes are made to the draft */
+    contentUpdatedAt?: string;
+    /** added in late April 2023. Only set on translations. Set to the value of contentUpdatedAt of the base locale draft that was translated. Can be used to determine if the translated draft is out of sync with the original draft */
+    baseLocaleContentUpdatedAt?: string;
+}
+
+export interface DraftHackContent {
+    /**
+     * @maxLength 150
+     */
+    title: string;
+    /**
+     * @maxLength 50
+     */
+    sourceId?: string;
+    /**
+     * @maxLength 50
+     */
+    themeId?: string;
+    segments: DraftHackSegments;
+    /**
+     * @maxLength 1000
+     */
+    coverUrl?: string;
+    notifications?: DraftHackNotifications;
+    affiliate?: DraftAffiliate;
+    /**
+     * @maxItems 50
+     */
+    topics?: DraftTopic[];
+    /**
+     * @maxItems 10
+     */
+    contributors?: DraftContributor[];
+    sourceData?: DraftSourceData;
+    /** For creators only. We will tackle this validation once profiles are introduce*/
+    externalLink?: DraftHackExternalLink;
+    /** For recording purpose for now, we will use this value further in the future */
+    contentRating?: DraftHackRating;
+    /**
+     * @maxItems 50
+     * @items.maxLength 150
+     */
+    tags?: string[];
+    type?: DraftHackType;
+    isCopyrightFree?: boolean;
+}
+
+export interface DraftHackNotifications {
+    /**
+     * @maxLength 1000
+     */
+    aiGeneratedText?: string;
+    /**
+     * @maxLength 1000
+     */
+    humanCuratedText?: string;
+}
+
+export interface DraftHackSegments {
+    favouriteQuote?: DraftHackSegment;
+    inANutshell?: DraftHackSegment;
+    introduction?: DraftHackSegment;
+    /**
+     * @maxItems 10
+     */
+    insights?: DraftHackInsightSegment[];
+    conclusion?: DraftHackSegment;
+}
+
+export interface DraftHackCard {
+    /**
+     * @maxLength 2000
+     */
+    markdown: string;
+}
+
+export interface DraftHackSegment {
+    /**
+     * @maxItems 50
+     * @items.maxLength 150
+     */
+    keywords: string[];
+    paragraphCards: DraftHackCard[][];
+    /**
+     * @maxLength 1000
+     */
+    textSummary?: string;
+}
+
+export interface DraftHackInsightSegment extends DraftHackSegment {
+    /**
+     * @maxLength 150
+     */
+    title?: string;
+    /**
+     * @maxItems 50
+     */
+    actions: DraftHackAction[];
+}
+
+export interface DraftHackAction {
+    /**
+     * @maxLength 150
+     */
+    title: string;
+    /**
+     * @maxLength 1000
+     */
+    markdown: string
+}
+
+export interface DraftContributor {
+    /**
+     * @maxLength 150
+     */
+    name: string;
+}
+
+export interface DraftTopic {
+    /**
+     * @maxLength 150
+     */
+    name: string;
+}
+
+export interface DraftAffiliate {
+    /**
+     * @maxLength 1000
+     */
+    url?: string;
+    /**
+     * @maxLength 150
+     */
+    name?: string;
+}
+
+export interface DraftSourceData {
+    /**
+     * @maxLength 150
+     */
+    episodeTitle?: string;
+    /**
+     * @maxLength 50
+     */
+    releaseDate?: string;
+}
+
+export interface DraftHackExternalLink {
+    /**
+     * @maxLength 1000
+     */
+    url: string;
+    type: 'Website' | 'Book' | 'Course' | 'Podcast' | 'Video' | 'Other';
+}
+
+// this status is currently used to present the draft in different columns in the airtable used by the content team
+export type DraftHackWorkflowStatus = 'publishing' | 'published';
+export type DraftHackType = 'book' | 'course' | 'documentary' | 'podcast' | 'original';
+export type DraftHackRating = 'mature' | 'appropriate';