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

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

@@ -1,44 +1,44 @@
-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';
+
+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,57 +1,57 @@
-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;
-
-    /**
-     * @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;
+
+    /**
+     * @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;

package/src/collection/enriched-collection.ts

@@ -1,61 +1,61 @@
-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;
-    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;
+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;
+    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 +1,21 @@
-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;
-}
-
+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 +1,25 @@
-
-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;
-}
+
+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 +1,21 @@
-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;
+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,33 +1,33 @@
-
-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;
-    completedModuleCount: number;
-    startedAt?: string;
-    completedAt?: string;
-    lastInteractedAt?: string;
-    enrollmentUpdatedAt?: string;
-    unenrolled?: boolean;
-}
+
+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;
+    completedModuleCount: number;
+    startedAt?: string;
+    completedAt?: string;
+    lastInteractedAt?: string;
+    enrollmentUpdatedAt?: string;
+    unenrolled?: boolean;
+}