@uptime.app/contracts 3.0.36 → 3.0.37-rc.0

package/src/theme/theme.ts

@@ -1,68 +1,68 @@
-export interface ThemeTemplate {
-    /** the url of the background video */
-    backgroundVideoUrl?: string;
-    /** the url of the background image */
-    backgroundImageUrl?: string;
-    /** the font color that will be used when rendering text in the foreground */
-    fontColor: string;
-}
-
-export interface SegmentThemeTemplates {
-    overview: {
-        a: ThemeTemplate;
-        b: ThemeTemplate;
-    },
-    insightOne: {
-        // one template is for the title card
-        // the other one for insight content
-        a: ThemeTemplate;
-        b: ThemeTemplate;
-    },
-    insightTwo: {
-        a: ThemeTemplate;
-        b: ThemeTemplate;
-    },
-    insightThree: {
-        a: ThemeTemplate;
-        b: ThemeTemplate;
-    },
-    dark: {
-        overview: {
-            a: ThemeTemplate;
-            b: ThemeTemplate;
-        },
-        insightOne: {
-            a: ThemeTemplate;
-            b: ThemeTemplate;
-        },
-        insightTwo: {
-            a: ThemeTemplate;
-            b: ThemeTemplate;
-        },
-        insightThree: {
-            a: ThemeTemplate;
-            b: ThemeTemplate;
-        }
-    }
-}
-
-export interface Theme {
-    id: string;
-    name: string;
-    fontFamily: string;
-    templates: SegmentThemeTemplates;
-    mood: 'neutral' | 'sombre' | 'vibrant';
-    isCustom: boolean;
-    /* properties of the story and audio player */
-    player?: {
-        light: {
-            backgroundColor: string;
-        },
-        dark: {
-            backgroundColor: string;
-        }
-    }
-    updatedAt: string;
-    createdAt: string;
-    v: number;
-}
+export interface ThemeTemplate {
+    /** the url of the background video */
+    backgroundVideoUrl?: string;
+    /** the url of the background image */
+    backgroundImageUrl?: string;
+    /** the font color that will be used when rendering text in the foreground */
+    fontColor: string;
+}
+
+export interface SegmentThemeTemplates {
+    overview: {
+        a: ThemeTemplate;
+        b: ThemeTemplate;
+    },
+    insightOne: {
+        // one template is for the title card
+        // the other one for insight content
+        a: ThemeTemplate;
+        b: ThemeTemplate;
+    },
+    insightTwo: {
+        a: ThemeTemplate;
+        b: ThemeTemplate;
+    },
+    insightThree: {
+        a: ThemeTemplate;
+        b: ThemeTemplate;
+    },
+    dark: {
+        overview: {
+            a: ThemeTemplate;
+            b: ThemeTemplate;
+        },
+        insightOne: {
+            a: ThemeTemplate;
+            b: ThemeTemplate;
+        },
+        insightTwo: {
+            a: ThemeTemplate;
+            b: ThemeTemplate;
+        },
+        insightThree: {
+            a: ThemeTemplate;
+            b: ThemeTemplate;
+        }
+    }
+}
+
+export interface Theme {
+    id: string;
+    name: string;
+    fontFamily: string;
+    templates: SegmentThemeTemplates;
+    mood: 'neutral' | 'sombre' | 'vibrant';
+    isCustom: boolean;
+    /* properties of the story and audio player */
+    player?: {
+        light: {
+            backgroundColor: string;
+        },
+        dark: {
+            backgroundColor: string;
+        }
+    }
+    updatedAt: string;
+    createdAt: string;
+    v: number;
+}

package/src/translation/translation-events.ts

@@ -1,73 +1,73 @@
-import { SupportedLocale } from '../localisation/supported-locales';
-import { ObjectToTranslate, TextWithTranslation } from './translation';
-import { Text } from './translation';
-
-export interface TextTranslatedEvent {
-    id: string;
-    type: 'TextTranslated';
-    payload: {
-        reference: string;
-        fromLocale: string;
-        toLocale: string;
-        text: TextWithTranslation[];
-    };
-}
-
-export interface ObjectsTranslatedEvent {
-    id: string;
-    type: 'ObjectsTranslated';
-    payload: {
-        reference: string;
-        fromLocale: string;
-        toLocale: string;
-        translatedObjects: TranslatedObject[];
-    };
-}
-
-export interface TranslatedObject {
-    translatedObject: any;
-    reference: string;
-}
-
-/**
- * Translate JSON objects using Chat GPT
- */
-export interface TranslateObjectsCommand {
-    id: string;
-    type: 'TranslateObjects';
-    payload: TranslateObjectsCommandPayload;
-}
-
-export interface TranslateObjectsCommandPayload {
-    /**
-     * Identifier set by the creator of the command. It also shows up in the TextTranslated event and
-     * it has the same value as in the original command, so that interested services can match their command to the event.
-     */
-    reference: string;
-    fromLocale: SupportedLocale;
-    toLocale: SupportedLocale;
-    objectsToTranslate: ObjectToTranslate[];
-    /**
-     * Optional model to use for translation. If not provided, the default model will be used.
-     * It used to be a SupportedGptModel enum
-     */
-    chatGptModel?: string;
-}
-
-export interface TranslateTextCommand {
-    id: string;
-    type: 'TranslateText';
-    payload: TranslateTextCommandPayload
-}
-
-export interface TranslateTextCommandPayload {
-    /**
-     * Identifier set by the creator of the command. It also shows up in the TextTranslated event and
-     * it has the same value as in the original command, so that interested services can match their command to the event.
-     */
-    reference: string;
-    // TODO fromLocale and toLocale to use contracts' SupportedLocales
-    fromLocale: string;
-    toLocale: string;
-    text: Text[];
-}
+import { SupportedLocale } from '../localisation/supported-locales';
+import { ObjectToTranslate, TextWithTranslation } from './translation';
+import { Text } from './translation';
+
+export interface TextTranslatedEvent {
+    id: string;
+    type: 'TextTranslated';
+    payload: {
+        reference: string;
+        fromLocale: string;
+        toLocale: string;
+        text: TextWithTranslation[];
+    };
+}
+
+export interface ObjectsTranslatedEvent {
+    id: string;
+    type: 'ObjectsTranslated';
+    payload: {
+        reference: string;
+        fromLocale: string;
+        toLocale: string;
+        translatedObjects: TranslatedObject[];
+    };
+}
+
+export interface TranslatedObject {
+    translatedObject: any;
+    reference: string;
+}
+
+/**
+ * Translate JSON objects using Chat GPT
+ */
+export interface TranslateObjectsCommand {
+    id: string;
+    type: 'TranslateObjects';
+    payload: TranslateObjectsCommandPayload;
+}
+
+export interface TranslateObjectsCommandPayload {
+    /**
+     * Identifier set by the creator of the command. It also shows up in the TextTranslated event and
+     * it has the same value as in the original command, so that interested services can match their command to the event.
+     */
+    reference: string;
+    fromLocale: SupportedLocale;
+    toLocale: SupportedLocale;
+    objectsToTranslate: ObjectToTranslate[];
+    /**
+     * Optional model to use for translation. If not provided, the default model will be used.
+     * It used to be a SupportedGptModel enum
+     */
+    chatGptModel?: string;
+}
+
+export interface TranslateTextCommand {
+    id: string;
+    type: 'TranslateText';
+    payload: TranslateTextCommandPayload
+}
+
+export interface TranslateTextCommandPayload {
+    /**
+     * Identifier set by the creator of the command. It also shows up in the TextTranslated event and
+     * it has the same value as in the original command, so that interested services can match their command to the event.
+     */
+    reference: string;
+    // TODO fromLocale and toLocale to use contracts' SupportedLocales
+    fromLocale: string;
+    toLocale: string;
+    text: Text[];
+}

package/src/translation/translation.ts

@@ -1,25 +1,25 @@
-export interface Text {
-    /**
-     * Identifier set by the creator of the command. TextWithTranslation entities have the same
-     * references as in the original command, so that they can be easily matched by the receiving service.
-     */
-    reference: string;
-    content: string;
-}
-
-export interface ObjectToTranslate {
-    /**
-     * Stringified size must be lower than 7000 characters so that it can work with ChatGPT
-     */
-    objectToTranslate: any;
-    translationCacheKey: string;
-    /** refresh the cache item */
-    refreshCache?: boolean
-    reference: string;
-    /** additional text that will be added to the GPT prompt when requesting translation  */
-    promptAdditions?: string;
-}
-
-export interface TextWithTranslation extends Text {
-    translation: string;
-}
+export interface Text {
+    /**
+     * Identifier set by the creator of the command. TextWithTranslation entities have the same
+     * references as in the original command, so that they can be easily matched by the receiving service.
+     */
+    reference: string;
+    content: string;
+}
+
+export interface ObjectToTranslate {
+    /**
+     * Stringified size must be lower than 7000 characters so that it can work with ChatGPT
+     */
+    objectToTranslate: any;
+    translationCacheKey: string;
+    /** refresh the cache item */
+    refreshCache?: boolean
+    reference: string;
+    /** additional text that will be added to the GPT prompt when requesting translation  */
+    promptAdditions?: string;
+}
+
+export interface TextWithTranslation extends Text {
+    translation: string;
+}

package/src/trending/trending-events.ts

@@ -1,21 +1,21 @@
-import { TrendingHacks } from './trending-hacks';
-
-export interface TrendingHacksCreatedEvent {
-    id: string;
-    type: 'TrendingHacksCreated';
-    payload: TrendingHacks;
-}
-
-export interface TrendingHacksUpdatedEvent {
-    id: string;
-    type: 'TrendingHacksUpdated';
-    payload: TrendingHacks;
-}
-
-export interface TrendingHacksDeletedEvent {
-    id: string;
-    type: 'TrendingHacksDeleted';
-    payload: TrendingHacks;
-}
-
-export type TrendingHacksChangedEvent = TrendingHacksCreatedEvent | TrendingHacksUpdatedEvent | TrendingHacksDeletedEvent;
+import { TrendingHacks } from './trending-hacks';
+
+export interface TrendingHacksCreatedEvent {
+    id: string;
+    type: 'TrendingHacksCreated';
+    payload: TrendingHacks;
+}
+
+export interface TrendingHacksUpdatedEvent {
+    id: string;
+    type: 'TrendingHacksUpdated';
+    payload: TrendingHacks;
+}
+
+export interface TrendingHacksDeletedEvent {
+    id: string;
+    type: 'TrendingHacksDeleted';
+    payload: TrendingHacks;
+}
+
+export type TrendingHacksChangedEvent = TrendingHacksCreatedEvent | TrendingHacksUpdatedEvent | TrendingHacksDeletedEvent;

package/src/trending/trending-hacks.ts

@@ -1,8 +1,8 @@
-export interface TrendingHacks {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    date: string;
-    hackIds: string[];
-}
+export interface TrendingHacks {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    date: string;
+    hackIds: string[];
+}

package/src/user/cognito-user-authentication-log.ts

@@ -1,8 +1,8 @@
-export interface CognitoUserAuthenticationLog {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    cognitoUserId: string;
-    lastAuthenticatedAt: string;    
+export interface CognitoUserAuthenticationLog {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    cognitoUserId: string;
+    lastAuthenticatedAt: string;    
 }

package/src/user/get-user.ts

@@ -1,63 +1,63 @@
-import { Entitlement } from '../entitlement/user-entitlements';
-import { IdentityProviderClaims } from '../identity-provider/identity-provider';
-import { Context } from '../message-bus/context';
-
-export interface InternalGetUserLambdaPayload {
-    userId: string;
-    context: Context;
-}
-
-export interface UserResponse {
-    id: string;
-    createdAt: string;
-    email?: string;
-    firstName: string;
-    phoneNumber?: string;
-    isAnonymous: boolean;
-    status: UserStatus;
-    entitlements: Entitlement[];
-    organisations: string[];
-    memberships: UserResponseMembership[];
-    isCreator: boolean;
-    isPartner: boolean;
-    isInfluencer: boolean;
-    webAppDomain: string;
-    skinId: string;
-    brandId?: string;
-    /** id of the identity provider if the user has ever signed in via SSO */
-    identityProviderId?: string;
-    identityProviderClaims?: IdentityProviderClaims;
-    locale?: string;
-}
-
-export enum UserStatus {
-    /**
-     * User has not yet been created.
-     * Requires the frontend to post data to create the user
-     * */
-    NEEDS_CREATING = 'NEEDS_CREATING',
-    /**
-     * User is being created.
-     * Frontend has sent the required data and the backend is asynchronously processing.
-     * Poll and wait for ACTIVE
-     * */
-    CREATION_IN_PROGRESS = 'CREATION_IN_PROGRESS',
-    /**
-     * User has been created and should be part of an organisation but the membership has not been processed yet.
-     * Poll and wait for ACTIVE
-     * */
-    PENDING_ORGANISATION_MEMBERSHIP = 'PENDING_ORGANISATION_MEMBERSHIP',
-    /**
-     * User has been created and should have been issued entitlements but they have not been issued yet.
-     * Poll and wait for ACTIVE
-     * */
-    PENDING_ENTITLEMENTS = 'PENDING_ENTITLEMENTS',
-    /** All user data is up to date */
-    ACTIVE = 'ACTIVE',
-}
-
-export interface UserResponseMembership {
-    organisationId: string;
-    role: string;
-    tenant: string;
-}
+import { Entitlement } from '../entitlement/user-entitlements';
+import { IdentityProviderClaims } from '../identity-provider/identity-provider';
+import { Context } from '../message-bus/context';
+
+export interface InternalGetUserLambdaPayload {
+    userId: string;
+    context: Context;
+}
+
+export interface UserResponse {
+    id: string;
+    createdAt: string;
+    email?: string;
+    firstName: string;
+    phoneNumber?: string;
+    isAnonymous: boolean;
+    status: UserStatus;
+    entitlements: Entitlement[];
+    organisations: string[];
+    memberships: UserResponseMembership[];
+    isCreator: boolean;
+    isPartner: boolean;
+    isInfluencer: boolean;
+    webAppDomain: string;
+    skinId: string;
+    brandId?: string;
+    /** id of the identity provider if the user has ever signed in via SSO */
+    identityProviderId?: string;
+    identityProviderClaims?: IdentityProviderClaims;
+    locale?: string;
+}
+
+export enum UserStatus {
+    /**
+     * User has not yet been created.
+     * Requires the frontend to post data to create the user
+     * */
+    NEEDS_CREATING = 'NEEDS_CREATING',
+    /**
+     * User is being created.
+     * Frontend has sent the required data and the backend is asynchronously processing.
+     * Poll and wait for ACTIVE
+     * */
+    CREATION_IN_PROGRESS = 'CREATION_IN_PROGRESS',
+    /**
+     * User has been created and should be part of an organisation but the membership has not been processed yet.
+     * Poll and wait for ACTIVE
+     * */
+    PENDING_ORGANISATION_MEMBERSHIP = 'PENDING_ORGANISATION_MEMBERSHIP',
+    /**
+     * User has been created and should have been issued entitlements but they have not been issued yet.
+     * Poll and wait for ACTIVE
+     * */
+    PENDING_ENTITLEMENTS = 'PENDING_ENTITLEMENTS',
+    /** All user data is up to date */
+    ACTIVE = 'ACTIVE',
+}
+
+export interface UserResponseMembership {
+    organisationId: string;
+    role: string;
+    tenant: string;
+}

package/src/user/user-events.ts

@@ -1,39 +1,39 @@
-export interface IdentityProviderWhitelistedFields {
-    countryCode?: string;
-    department?: string;
-}
-
-export interface UserEventPayload {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    /** id of the identity provider if the user has ever signed in via SSO */
-    identityProviderId?: string;
-    identityProviderClaims?: IdentityProviderWhitelistedFields;
-    /** only on DeletedEvents. There are a handful of Deleted events in staging without this field */
-    deletedAt?: string;
-    reasonForLeavingUptime?: string;
-    /** added May 2025 */
-    isCmsUser?: boolean;
-    /** added in August 2025 */
-    locale?: string;
-}
-
-export interface UserCreatedEvent {
-    id: string;
-    type: 'UserCreated';
-    payload: UserEventPayload;
-}
-
-export interface UserUpdatedEvent {
-    id: string;
-    type: 'UserUpdated';
-    payload: UserEventPayload;
-}
-
-export interface UserDeletedEvent {
-    id: string;
-    type: 'UserDeleted';
-    payload: UserEventPayload;
-}
+export interface IdentityProviderWhitelistedFields {
+    countryCode?: string;
+    department?: string;
+}
+
+export interface UserEventPayload {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    /** id of the identity provider if the user has ever signed in via SSO */
+    identityProviderId?: string;
+    identityProviderClaims?: IdentityProviderWhitelistedFields;
+    /** only on DeletedEvents. There are a handful of Deleted events in staging without this field */
+    deletedAt?: string;
+    reasonForLeavingUptime?: string;
+    /** added May 2025 */
+    isCmsUser?: boolean;
+    /** added in August 2025 */
+    locale?: string;
+}
+
+export interface UserCreatedEvent {
+    id: string;
+    type: 'UserCreated';
+    payload: UserEventPayload;
+}
+
+export interface UserUpdatedEvent {
+    id: string;
+    type: 'UserUpdated';
+    payload: UserEventPayload;
+}
+
+export interface UserDeletedEvent {
+    id: string;
+    type: 'UserDeleted';
+    payload: UserEventPayload;
+}

package/src/user-context/user-context-events.ts

@@ -1,21 +1,21 @@
-import { UserContext } from './user-context';
-
-export interface UserContextCreatedEvent {
-    id: string;
-    type: 'UserContextCreated';
-    payload: UserContext;
-}
-
-export interface UserContextUpdatedEvent {
-    id: string;
-    type: 'UserContextUpdated';
-    payload: UserContext;
-}
-
-export interface UserContextDeletedEvent {
-    id: string;
-    type: 'UserContextDeleted';
-    payload: UserContext;
-}
-
-export type UserContextChangedEvent = UserContextCreatedEvent | UserContextUpdatedEvent | UserContextDeletedEvent;
+import { UserContext } from './user-context';
+
+export interface UserContextCreatedEvent {
+    id: string;
+    type: 'UserContextCreated';
+    payload: UserContext;
+}
+
+export interface UserContextUpdatedEvent {
+    id: string;
+    type: 'UserContextUpdated';
+    payload: UserContext;
+}
+
+export interface UserContextDeletedEvent {
+    id: string;
+    type: 'UserContextDeleted';
+    payload: UserContext;
+}
+
+export type UserContextChangedEvent = UserContextCreatedEvent | UserContextUpdatedEvent | UserContextDeletedEvent;