@uptime.app/contracts 1.0.37 → 1.0.38-rc.0

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

@@ -1,21 +1,21 @@
-import { B2BOrganisation } from './b2b-organisation';
-
-export interface B2BOrganisationCreatedEvent {
-    id: string;
-    type: 'B2BOrganisationCreated';
-    payload: B2BOrganisation;
-}
-
-export interface B2BOrganisationUpdatedEvent {
-    id: string;
-    type: 'B2BOrganisationUpdated';
-    payload: B2BOrganisation;
-}
-
-export interface B2BOrganisationDeletedEvent {
-    id: string;
-    type: 'B2BOrganisationDeleted';
-    payload: B2BOrganisation;
-}
-
-export type B2BOrganisationChangedEvent = B2BOrganisationCreatedEvent | B2BOrganisationUpdatedEvent | B2BOrganisationDeletedEvent;
+import { B2BOrganisation } from './b2b-organisation';
+
+export interface B2BOrganisationCreatedEvent {
+    id: string;
+    type: 'B2BOrganisationCreated';
+    payload: B2BOrganisation;
+}
+
+export interface B2BOrganisationUpdatedEvent {
+    id: string;
+    type: 'B2BOrganisationUpdated';
+    payload: B2BOrganisation;
+}
+
+export interface B2BOrganisationDeletedEvent {
+    id: string;
+    type: 'B2BOrganisationDeleted';
+    payload: B2BOrganisation;
+}
+
+export type B2BOrganisationChangedEvent = B2BOrganisationCreatedEvent | B2BOrganisationUpdatedEvent | B2BOrganisationDeletedEvent;

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

@@ -1,21 +1,21 @@
-import { B2BOrganisationMember } from './b2b-organisation-member';
-
-export interface B2BOrganisationMemberCreatedEvent {
-    id: string;
-    type: 'B2BOrganisationMemberCreated';
-    payload: B2BOrganisationMember;
-}
-
-export interface B2BOrganisationMemberUpdatedEvent {
-    id: string;
-    type: 'B2BOrganisationMemberUpdated';
-    payload: B2BOrganisationMember;
-}
-
-export interface B2BOrganisationMemberDeletedEvent {
-    id: string;
-    type: 'B2BOrganisationMemberDeleted';
-    payload: B2BOrganisationMember;
-}
-
-export type B2BOrganisationMemberChangedEvent = B2BOrganisationMemberCreatedEvent | B2BOrganisationMemberUpdatedEvent | B2BOrganisationMemberDeletedEvent;
+import { B2BOrganisationMember } from './b2b-organisation-member';
+
+export interface B2BOrganisationMemberCreatedEvent {
+    id: string;
+    type: 'B2BOrganisationMemberCreated';
+    payload: B2BOrganisationMember;
+}
+
+export interface B2BOrganisationMemberUpdatedEvent {
+    id: string;
+    type: 'B2BOrganisationMemberUpdated';
+    payload: B2BOrganisationMember;
+}
+
+export interface B2BOrganisationMemberDeletedEvent {
+    id: string;
+    type: 'B2BOrganisationMemberDeleted';
+    payload: B2BOrganisationMember;
+}
+
+export type B2BOrganisationMemberChangedEvent = B2BOrganisationMemberCreatedEvent | B2BOrganisationMemberUpdatedEvent | B2BOrganisationMemberDeletedEvent;

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

@@ -1,9 +1,9 @@
-export interface B2BOrganisationMember {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    userId: string;
-    organisationId: string;
-    invitationId?: string;
+export interface B2BOrganisationMember {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    userId: string;
+    organisationId: string;
+    invitationId?: string;
 }

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

@@ -1,14 +1,14 @@
-export interface B2BOrganisation {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    name: string; //unique
-    owner: string; //unique
-    code?: string;
-    provider: string; // for now this will reference what to display in the home screen of the app for users that joined the organisation
-    displayName: 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
-    codeUsageLimit?: number; // the max amount of times the code to join an organisation can be use
-    urlPrefix?: string; // the prefix to use for the url of the organisation
-    brandId?: string;
-}
+export interface B2BOrganisation {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    name: string; //unique
+    owner: string; //unique
+    code?: string;
+    provider: string; // for now this will reference what to display in the home screen of the app for users that joined the organisation
+    displayName: 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
+    codeUsageLimit?: number; // the max amount of times the code to join an organisation can be use
+    urlPrefix?: string; // the prefix to use for the url of the organisation
+    brandId?: string;
+}

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,20 +1,20 @@
-import { SupportedLocale } from '../localisation/supported-locales';
-
-export interface Brand {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    name: string;
-    skinId?: string;
-    webAppDomain?: string;
-    appName?: {
-        [K in SupportedLocale]?: string
-    };
-    welcomeHacks?: WelcomeHack[];
-}
-
-// 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;
+    webAppDomain?: string;
+    appName?: {
+        [K in SupportedLocale]?: string
+    };
+    welcomeHacks?: WelcomeHack[];
+}
+
+// In case we need to add more properties to the BrandHack interface, we can do so here.
+export interface WelcomeHack {
+    hackId: string;
 }

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,58 +1,58 @@
-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[];
-    // concept we are exploring: https://d0.awsstatic.com/whitepapers/Multi_Tenant_SaaS_Storage_Strategies.pdf
-    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[];
+    // concept we are exploring: https://d0.awsstatic.com/whitepapers/Multi_Tenant_SaaS_Storage_Strategies.pdf
+    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,64 +1,64 @@
-import { AppHackMetadata } from '../app-hack/app-hack-metadata';
-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 interface DeletedProfile {
-    deleted: boolean;
-    uptimeOwned: boolean;
-    avatarUrl: string;
-}
-
-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 { 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 interface DeletedProfile {
+    deleted: boolean;
+    uptimeOwned: boolean;
+    avatarUrl: string;
+}
+
+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/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;
+}