@uptime.app/contracts 1.0.39 → 1.0.41-rc.0

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

@@ -1,31 +1,31 @@
-export interface B2BInvitation {
-    id: string;
-    v: number;
-    updatedAt: string;
-    createdAt: string;
-    name: string;
-    lastName: string;
-    email: string;
-    code: string;
-    organisationId: string;
-}
-
-export interface B2BInvitationEventPayload {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    organisationId: string;
-}
-
-export interface B2BOrganisationInvitationCreatedEvent {
-    id: string;
-    type: 'B2BOrganisationInvitationCreated',
-    payload: B2BInvitationEventPayload;
-}
-
-export interface B2BOrganisationInvitationDeletedEvent {
-    id: string;
-    type: 'B2BOrganisationInvitationDeleted',
-    payload: B2BInvitationEventPayload;
-}
+export interface B2BInvitation {
+    id: string;
+    v: number;
+    updatedAt: string;
+    createdAt: string;
+    name: string;
+    lastName: string;
+    email: string;
+    code: string;
+    organisationId: string;
+}
+
+export interface B2BInvitationEventPayload {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    organisationId: string;
+}
+
+export interface B2BOrganisationInvitationCreatedEvent {
+    id: string;
+    type: 'B2BOrganisationInvitationCreated',
+    payload: B2BInvitationEventPayload;
+}
+
+export interface B2BOrganisationInvitationDeletedEvent {
+    id: string;
+    type: 'B2BOrganisationInvitationDeleted',
+    payload: B2BInvitationEventPayload;
+}

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,15 +1,15 @@
-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;
-    providesPremium?: boolean; // if the organisation provides premium we should issue the entitlements
-}
+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;
+    providesPremium?: boolean; // if the organisation provides premium we should issue the entitlements
+}

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/catalogue/catalogue.ts

@@ -1,118 +1,118 @@
-export interface Catalogue {
-    id: string; // unique, dynamo primary key. not necessarily a uuid. could be b2b:<id> or a simple string like public
-    owner: string; // used for permissions - who is allowed to edit this catalogue
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    name: string; // added December 2023 to make it easier to find catalogues in the UI
-    accessType: CatalogueAccessType; // added December 2023. 
-}
-
-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 Catalogue {
+    id: string; // unique, dynamo primary key. not necessarily a uuid. could be b2b:<id> or a simple string like public
+    owner: string; // used for permissions - who is allowed to edit this catalogue
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    name: string; // added December 2023 to make it easier to find catalogues in the UI
+    accessType: CatalogueAccessType; // added December 2023. 
+}
+
+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;

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;
+}