@uptime.app/contracts 3.0.54-rc.2 → 3.0.54-rc.3

package/src/brand/brand.ts

@@ -1,78 +0,0 @@
-import { SupportedLocale } from '../localisation/supported-locales';
-
-export interface Brand {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    name: string;
-    skinId?: string;
-    /** must unique across all brands */
-    webAppDomain?: string;
-    appName?: {
-        [K in SupportedLocale]?: string
-    };
-    welcomeHacks?: WelcomeHack[];
-    hasCustomTab?: boolean;
-    customTabLongName?: {
-        [K in SupportedLocale]?: string
-    };
-    customTabShortName?: {
-        [K in SupportedLocale]?: string
-    };
-    /** added Jan 2026 and backfilled */
-    defaultTab: 'discover' | 'custom';
-    /** added Feb 2026 and backfilled */
-    customTabCarousels: BrandCustomTabCarousel[];
-    /** added Feb 2026. Max 5 links. */
-    links?: BrandLink[];
-}
-
-export type BrandCustomTabCarousel =
-    | 'recommended-b2b-hacks'
-    | 'featured-course-enrollments'
-    | 'organisation-scoped-featured-collections'
-    | 'organisation-scoped-featured-hacks'
-    | 'new-hacks-in-your-network'
-    | 'featured-resources'
-    | 'recommended-b2b-collections'
-    | 'available-courses-in-catalog'
-    | 'whole-org-hacks'
-    | 'whole-org-collections';
-
-export interface BrandLink {
-    imageUrl?: string;
-    title: {
-        [K in SupportedLocale]?: string
-    };
-    description: {
-        [K in SupportedLocale]?: string
-    };
-    destination: BrandLinkDestination;
-    cta: BrandLinkCta;
-}
-
-export type BrandLinkCta =
-    | 'view'
-    | 'open'
-    | 'launch'
-    | 'get-started'
-    | 'start-now'
-    | 'gain-access'
-    | 'learn-more'
-    | 'find-out-more'
-    | 'watch-video'
-    | 'read'
-    | 'explore-here'
-    | 'get-support';
-
-export type BrandLinkDestination = {
-    type: 'external' | 'internal' | 'hack' | 'collection' | 'course';
-    /** Can be a URL or an ID depending on the type */
-    target: string;
-};
-
-// In case we need to add more properties to the BrandHack interface, we can do so here.
-export interface WelcomeHack {
-    hackId: string;
-}

package/src/catalogue/catalogue.ts

@@ -1,152 +0,0 @@
-export interface Catalogue {
-    id: string;
-    /** used for permissions - who is allowed to edit this catalogue */
-    owner: string;
-    /** Added and backfilled Jan 2026 */
-    tenant: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    /** added December 2023 to make it easier to find catalogues in the UI */
-    name: string;
-    /** Added and backfilled December 2023 */
-    accessType: CatalogueAccessType;
-}
-
-export type CatalogueAccessType = 'include' | 'exclude';
-
-export interface CatalogueCreatedEvent {
-    id: string;
-    type: 'CatalogueCreated';
-    payload: Catalogue;
-}
-
-export interface CatalogueUpdatedEvent {
-    id: string;
-    type: 'CatalogueUpdated';
-    payload: Catalogue;
-}
-
-export interface CatalogueDeletedEvent {
-    id: string;
-    type: 'CatalogueDeleted';
-    payload: Catalogue;
-}
-
-export type CatalogueChangedEvent = CatalogueCreatedEvent | CatalogueUpdatedEvent | CatalogueDeletedEvent;
-
-export interface CatalogueHackEntry {
-    id: string; // not really used but there for store reasons
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    catalogueId: string; // the catalogue name
-    baseLocaleHackId: string; // use baseLocaleHackId as all translations should be in the same catalogue
-}
-
-export interface CatalogueHackEntryCreatedEvent {
-    id: string;
-    type: 'CatalogueHackEntryCreated';
-    payload: CatalogueHackEntry;
-}
-
-export interface CatalogueHackEntryUpdatedEvent {
-    id: string;
-    type: 'CatalogueHackEntryUpdated';
-    payload: CatalogueHackEntry;
-}
-
-export interface CatalogueHackEntryDeletedEvent {
-    id: string;
-    type: 'CatalogueHackEntryDeleted';
-    payload: CatalogueHackEntry;
-}
-
-export type CatalogueHackEntryChangedEvent = CatalogueHackEntryCreatedEvent | CatalogueHackEntryUpdatedEvent | CatalogueHackEntryDeletedEvent;
-
-export interface CatalogueCollectionEntry {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    catalogueId: string;
-    baseLocaleCollectionId: string;
-}
-
-export interface CatalogueCollectionEntryCreatedEvent {
-    id: string;
-    type: 'CatalogueCollectionEntryCreated';
-    payload: CatalogueCollectionEntry;
-}
-
-export interface CatalogueCollectionEntryUpdatedEvent {
-    id: string;
-    type: 'CatalogueCollectionEntryUpdated';
-    payload: CatalogueCollectionEntry;
-}
-
-export interface CatalogueCollectionEntryDeletedEvent {
-    id: string;
-    type: 'CatalogueCollectionEntryDeleted';
-    payload: CatalogueCollectionEntry;
-}
-
-export type CatalogueCollectionEntryChangedEvent = CatalogueCollectionEntryCreatedEvent | CatalogueCollectionEntryUpdatedEvent | CatalogueCollectionEntryDeletedEvent;
-
-export interface CatalogueB2BOrgEntry {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    catalogueId: string;
-    b2bOrgId: string;
-}
-
-export interface CatalogueB2BOrgEntryCreatedEvent {
-    id: string;
-    type: 'CatalogueB2BOrgEntryCreated';
-    payload: CatalogueB2BOrgEntry;
-}
-
-export interface CatalogueB2BOrgEntryUpdatedEvent {
-    id: string;
-    type: 'CatalogueB2BOrgEntryUpdated';
-    payload: CatalogueB2BOrgEntry;
-}
-
-export interface CatalogueB2BOrgEntryDeletedEvent {
-    id: string;
-    type: 'CatalogueB2BOrgEntryDeleted';
-    payload: CatalogueB2BOrgEntry;
-}
-
-export type CatalogueB2BOrgEntryChangedEvent = CatalogueB2BOrgEntryCreatedEvent | CatalogueB2BOrgEntryUpdatedEvent | CatalogueB2BOrgEntryDeletedEvent;
-
-export interface CatalogueProfileEntry {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    catalogueId: string;
-    profileId: string;
-}
-
-export interface CatalogueProfileEntryCreatedEvent {
-    id: string;
-    type: 'CatalogueProfileEntryCreated';
-    payload: CatalogueProfileEntry;
-}
-
-export interface CatalogueProfileEntryUpdatedEvent {
-    id: string;
-    type: 'CatalogueProfileEntryUpdated';
-    payload: CatalogueProfileEntry;
-}
-
-export interface CatalogueProfileEntryDeletedEvent {
-    id: string;
-    type: 'CatalogueProfileEntryDeleted';
-    payload: CatalogueProfileEntry;
-}
-
-export type CatalogueProfileEntryChangedEvent = CatalogueProfileEntryCreatedEvent | CatalogueProfileEntryUpdatedEvent | CatalogueProfileEntryDeletedEvent;

package/src/cms-hack/cms-searchable-hack.ts

@@ -1,44 +0,0 @@
-import { EnrichedHackSubjects } from '../enriched-hack/enriched-hack';
-import { HackContributor, HackTopic, HackType } from '../hack/hack';
-
-export interface CmsSearchableHack {
-    /** id of the hack, even if the hack is currently in draft state */
-    id: string;
-    title: string;
-    draftHackId: string;
-    hackId: string;
-    baseLocaleHackId: string;
-    locale: string;
-    language: string;
-    /** when the draft was created */
-    createdAt: string;
-    updatedAt: string;
-    publishedAt?: string;
-    owner: string;
-    // will be empty on draft
-    acl: string[];
-
-    description: string
-
-    sourceId?: string;
-    themeId?: string;
-    coverUrl?: string;
-
-    editorialTags: string[];
-
-    copyrightFreeCoverUrl?: string;
-
-    contributors: HackContributor[];
-    type?: HackType;
-
-    topics: HackTopic[];
-    keywords: string[];
-    topicsExtracted: string[];
-    keywordsExtracted: string[];
-    hackSubjects: EnrichedHackSubjects;
-
-    workflowStatus: 'unpublished' | 'published' | 'publishing';
-    isPublished: boolean;
-    hasUnpublishedChanges: boolean;
-    isHidden: boolean;
-}

package/src/collection/collection-events.ts

@@ -1,21 +0,0 @@
-import { Collection } from './collection';
-
-export interface CollectionCreatedEvent {
-    id: string;
-    type: 'CollectionCreated';
-    payload: Collection;
-}
-
-export interface CollectionUpdatedEvent {
-    id: string;
-    type: 'CollectionUpdated';
-    payload: Collection;
-}
-
-export interface CollectionDeletedEvent {
-    id: string;
-    type: 'CollectionDeleted';
-    payload: Collection;
-}
-
-export type CollectionChangedEvent = CollectionCreatedEvent | CollectionUpdatedEvent | CollectionDeletedEvent;

package/src/collection/collection.ts

@@ -1,59 +0,0 @@
-export interface Collection {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-
-    title: string;
-    /** added 21/02/2023 use @uptime.app/localisation-contracts SupportedLocale */
-    locale: string;
-    /** added 21/02/2023 */
-    baseLocaleCollectionId: string;
-    /** added May 2023. Only set on collections that are translations */
-    baseLocaleCollectionVersion?: number;
-    subtitle?: string;
-    iconUrl?: string;
-    coverUrl?: string;
-    backgroundColor?: string;
-    description: string;
-    isPublished: boolean;
-    visibility?: CollectionVisibility;
-    tags?: string[];
-    rank?: number;
-    notificationMessage?: string;
-    type: CollectionType;
-    backdrop?: BackdropMetadata;
-
-    /** Added on June 2022. Not all messages on the archive will have this property. */
-    collectionHacks: CollectionHack[];
-    owner: string;
-    /** Added and backfilled December 2025 */
-    tenant: string;
-
-    /**
-     * @deprecated you should use new 'collectionHacks' property
-     */
-    hackIds: string[];
-}
-
-export type CollectionType = 'collection' | 'backdrop';
-
-export interface CollectionVisibility {
-    /* ISO date */
-    startDate: string;
-    /* ISO date */
-    endDate: string;
-}
-
-export interface CollectionHack {
-    hackId: string;
-    /**
-     * @maxLength 300
-     */
-    blurb?: string;
-}
-
-export interface BackdropMetadata {
-    /* e.g. "2022-02-09T10:00:00" */
-    backdropDate: string;
-}

package/src/collection/enriched-collection-events.ts

@@ -1,18 +0,0 @@
-import { EnrichedCollection } from './enriched-collection';
-
-export interface EnrichedCollectionCreatedEvent {
-    id: string;
-    type: 'EnrichedCollectionCreated';
-    payload: EnrichedCollection;
-}
-export interface EnrichedCollectionUpdatedEvent {
-    id: string;
-    type: 'EnrichedCollectionUpdated';
-    payload: EnrichedCollection;
-}
-export interface EnrichedCollectionDeletedEvent {
-    id: string;
-    type: 'EnrichedCollectionDeleted';
-    payload: EnrichedCollection;
-}
-export type EnrichedCollectionChangedEvent = EnrichedCollectionCreatedEvent | EnrichedCollectionUpdatedEvent | EnrichedCollectionDeletedEvent;

package/src/collection/enriched-collection.ts

@@ -1,65 +0,0 @@
-import { AppHackMetadata } from '../app-hack/app-hack-metadata';
-import { ProfileMetadata } from '../profile/profile';
-import { BackdropMetadata } from './collection';
-
-export interface EnrichedCollection {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    locale: string,
-    language: string;
-    baseLocaleCollectionId: string;
-    title: string;
-    subtitle?: string;
-    coverUrl?: string;
-    iconUrl?: string;
-    backgroundColor?: string;
-    description: string;
-    tags: string[];
-    rank?: number;
-    acl: string[];
-    catalogues: string[];
-    isPublished: boolean;
-    owner: string;
-    /** Added and backfilled December 2025 */
-    tenant: string;
-    /** Added March 2026, required because 'tenant' is also required */
-    tenantDisplayName: string;
-    hacks: EnrichCollectionHack[];
-    backdrop?: BackdropMetadata;
-    isBackdrop: boolean;
-    profile: EnrichCollectionProfile;
-    notificationMessage?: string;
-    includeInEmailNotifications: boolean;
-    includeInPushNotifications: boolean;
-    includeInRecommendations: boolean;
-    includeInSearchResults: boolean;
-    includeInWebsite: boolean;
-    isHidden: boolean;
-    visibility?: Visibility;
-}
-
-export interface EnrichCollectionHack {
-    blurb?: string;
-    hack: AppHackMetadata;
-}
-
-export interface ExistingProfile {
-    id: string;
-    name: string;
-    avatarUrl: string;
-    handle: string;
-}
-
-export type DeletedProfile = ProfileMetadata;
-
-export interface Visibility {
-    /* ISO date */
-    startDate: string;
-    /* ISO date */
-    endDate: string;
-}
-
-// matches pattern found in the hack enrichment service where the EnrichedHackProfile may be an actual Profile or it may have been deleted
-export type EnrichCollectionProfile = ExistingProfile | DeletedProfile;

package/src/course/course-events.ts

@@ -1,21 +0,0 @@
-import { Course } from './course';
-
-export interface CourseCreatedEvent {
-    id: string;
-    type: 'CourseCreated';
-    payload: Course;
-}
-
-export interface CourseUpdatedEvent {
-    id: string;
-    type: 'CourseUpdated';
-    payload: Course;
-}
-
-export interface CourseDeletedEvent {
-    id: string;
-    type: 'CourseDeleted';
-    payload: Course;
-}
-
-export type CourseChangedEvent = CourseCreatedEvent | CourseUpdatedEvent | CourseDeletedEvent;

package/src/course/course.ts

@@ -1,25 +0,0 @@
-
-export interface Course {
-    id: string;
-    uptimeLearnUponPortalId: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    title: string;
-    coverUrl?: string;
-    moduleCount: number;
-    isCertified: boolean;
-    isCataloged: boolean;
-    dueDate?: string;
-    accessExpiresAt?: string;
-    publishedAt?: string;
-    status: 'published' | 'draft' | 'archived' | 'under_revision' | 'deleted';
-    shortDescription?: string;
-    descriptionText?: string;
-    descriptionHtml?: string;
-    objectivesText?: string;
-    objectivesHtml?: string;
-    difficulty: 'not_applicable' | 'basic' | 'intermediate' | 'advanced';
-    length?: number;
-    lengthUnit?: string;
-}

package/src/course-enrollment/course-enrollment-events.ts

@@ -1,21 +0,0 @@
-import { CourseEnrollment } from './course-enrollment';
-
-export interface CourseEnrollmentCreatedEvent {
-    id: string;
-    type: 'CourseEnrollmentCreated';
-    payload: CourseEnrollment;
-}
-
-export interface CourseEnrollmentUpdatedEvent {
-    id: string;
-    type: 'CourseEnrollmentUpdated';
-    payload: CourseEnrollment;
-}
-
-export interface CourseEnrollmentDeletedEvent {
-    id: string;
-    type: 'CourseEnrollmentDeleted';
-    payload: CourseEnrollment;
-}
-
-export type CourseEnrollmentChangedEvent = CourseEnrollmentCreatedEvent | CourseEnrollmentUpdatedEvent | CourseEnrollmentDeletedEvent;

package/src/course-enrollment/course-enrollment.ts

@@ -1,36 +0,0 @@
-
-export interface CourseEnrollment {
-    /** maps to LearnUponWebhookCourseEnrollment.id */
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    /** maps to Course.title */
-    courseTitle: string;
-    /** maps to Course.coverUrl */
-    courseCoverUrl?: string;
-    /** uptime user id */
-    userId: string;
-    /** maps to Course.id */
-    courseId: string;
-    dueDate?: string;
-    accessExpiresAt?: string;
-    /** maps to Course.moduleCount */
-    moduleCount: number;
-    /** maps to Course.isCertified */
-    isCertified: boolean;
-    /** LearnUponWebhookCourseEnrollment.eventCreated */
-    enrolledAt: string;
-    /** maps to LearnUponWebhookCourseCompletion.enrollmentStatus && LearnUponWebhookModuleCompletions*/
-    status: 'not_started' | 'in_progress' | 'completed' | 'passed' | 'failed' | 'pending_review';
-    percentageComplete: number;
-    percentageScore?: number;
-    completedModuleCount: number;
-    startedAt?: string;
-    completedAt?: string;
-    lastInteractedAt?: string;
-    enrollmentUpdatedAt?: string;
-    unenrolled?: boolean;
-    organisationId: string;
-    courseShortDescription?: string;
-}

package/src/creator/creator-events.ts

@@ -1,32 +0,0 @@
-import { Creator } from './creator';
-
-export interface CreatorCreatedEvent {
-    id: string;
-    type: 'CreatorCreated',
-    payload: Creator;
-}
-
-
-export interface CreatorUpdatedEvent {
-    id: string;
-    type: 'CreatorUpdated',
-    payload: Creator;
-}
-
-export interface CreatorDeletedEvent {
-    id: string;
-    type: 'CreatorDeleted',
-    payload: Creator;
-}
-
-export type CreatorChangedEvent = CreatorCreatedEvent | CreatorUpdatedEvent | CreatorDeletedEvent;
-
-export interface BecomeACreatorCommandPayload {
-    userId: string;
-}
-
-export interface BecomeACreatorCommand {
-    id: string;
-    type: 'BecomeACreator',
-    payload: BecomeACreatorCommandPayload;
-}

package/src/creator/creator.ts

@@ -1,7 +0,0 @@
-export interface Creator {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    owner: string;
-}

package/src/distribution/collection-distribution.ts

@@ -1,17 +0,0 @@
-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 +0,0 @@
-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 +0,0 @@
-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
-}