@uptime.app/contracts 3.0.52 → 3.0.53-rc.0

package/src/b2b-organisation/b2b-organisation.ts

@@ -1,38 +1,38 @@
-export interface B2BOrganisation {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    name: string; //unique
-    owner: string; //unique
-    code?: string;
-    /** for now this will reference what to display in the home screen of the app for users that joined the organisation */
-    provider: string;
-    /** for organisations that might be different but have the same name to be displayed. Ex: HP Ireland & HP US ==> we want the displayName to be HP */
-    displayName: string;
-    /** the max amount of times the code to join an organisation can be used */
-    codeUsageLimit?: number;
-    /** the prefix to use for the url of the organisation */
-    urlPrefix?: string;
-    brandId?: string;
-    /** if the organisation provides members with the premium entitlement */
-    providesPremium?: boolean;
-    /** Introduced to allow simple creation of demo orgs for sales team. Is used in production but only for demo purposes */
-    isDemo?: boolean;
-    /** Is used in production but only for demo purposes */
-    demoLogoUrl?: string;
-    /** Any extra entitlements that are issued to members of this organisation. Not to be used provide premium - use providesPremium flag */
-    issuedEntitlements?: string[];
-    /** If the org members are not given free premium then override the standard RevenueCat offering presented to the user */
-    revenueCatOffering?: string;
-    /** Promo code to be applied when the user requests for the available stripe plans */
-    promoCode?: string;
-    /** Whether the public link can be use or not */
-    publicLinkDisabled?: boolean;
-    /** Whether the organisation can create content */
-    canCreateContent?: boolean;
-    /** Id of the Uptime LearnUpon portal the organisation's users have access to */
-    uptimeLearnUponPortalId?: string;
-    /** Whether reporting is enabled for this organisation. Added 3 Feb 2026 */
-    isReportingEnabled?: boolean;
-}
+export interface B2BOrganisation {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    name: string; //unique
+    owner: string; //unique
+    code?: string;
+    /** for now this will reference what to display in the home screen of the app for users that joined the organisation */
+    provider: string;
+    /** for organisations that might be different but have the same name to be displayed. Ex: HP Ireland & HP US ==> we want the displayName to be HP */
+    displayName: string;
+    /** the max amount of times the code to join an organisation can be used */
+    codeUsageLimit?: number;
+    /** the prefix to use for the url of the organisation */
+    urlPrefix?: string;
+    brandId?: string;
+    /** if the organisation provides members with the premium entitlement */
+    providesPremium?: boolean;
+    /** Introduced to allow simple creation of demo orgs for sales team. Is used in production but only for demo purposes */
+    isDemo?: boolean;
+    /** Is used in production but only for demo purposes */
+    demoLogoUrl?: string;
+    /** Any extra entitlements that are issued to members of this organisation. Not to be used provide premium - use providesPremium flag */
+    issuedEntitlements?: string[];
+    /** If the org members are not given free premium then override the standard RevenueCat offering presented to the user */
+    revenueCatOffering?: string;
+    /** Promo code to be applied when the user requests for the available stripe plans */
+    promoCode?: string;
+    /** Whether the public link can be use or not */
+    publicLinkDisabled?: boolean;
+    /** Whether the organisation can create content */
+    canCreateContent?: boolean;
+    /** Id of the Uptime LearnUpon portal the organisation's users have access to */
+    uptimeLearnUponPortalId?: string;
+    /** Whether reporting is enabled for this organisation. Added 3 Feb 2026 */
+    isReportingEnabled?: boolean;
+}

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,78 +1,78 @@
-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;
+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 +1,152 @@
-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;
+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 +1,47 @@
-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;
-}
+import { EnrichedHackSubjects } from '../enriched-hack/enriched-hack';
+import { HackContributor, HackTopic, HackType } from '../hack/hack';
+import { PrimaryTopic } from '../topics/primary-topic';
+
+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[];
+    primaryTopics: PrimaryTopic[];
+
+    keywords: string[];
+    topicsExtracted: string[];
+    keywordsExtracted: string[];
+    hackSubjects: EnrichedHackSubjects;
+
+    workflowStatus: 'unpublished' | 'published' | 'publishing';
+    isPublished: boolean;
+    hasUnpublishedChanges: boolean;
+    isHidden: boolean;
+}