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

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,47 +1,44 @@
-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;
-}
+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 +1,21 @@
-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;
+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 +1,59 @@
-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;
-}
+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 +1,18 @@
-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;
+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;