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

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

@@ -1,38 +1,38 @@
-import { B2BOrganisation } from '../b2b-organisation/b2b-organisation';
-import { SupportedLocale } from '../localisation/supported-locales';
-
-/**
- * An enriched model of B2BOrganisation containing data that can be consumed by a public (unauthenticated) endpoint
- */
-export interface EnrichedB2BOrganisation extends B2BOrganisation {
-    identityProviders: EnrichedB2BOrganisationIdentityProvider[];
-    skinId?: string;
-    brandWebAppDomain?: string;
-    brandAppName?: {
-        [K in SupportedLocale]?: string
-    };
-    ssoEnforcement?: SSOEnforcement;
-}
-
-export interface EnrichedB2BOrganisationIdentityProvider {
-    id?: string;
-    providerName: string;
-    verifiedDomains: string[];
-    /** Matching verifiedDomains should require to be authenticated via IdP or not */
-    enforceIdpAuth: boolean;
-}
-
-export enum SSOEnforcement {
-    /**
-     * Means that no identity provider is configured for the organisation
-     */
-    NONE = 'NONE',
-    /**
-     *  Means that it has at least 1 identity provider but not all identity providers have enforceIdpAuth set to true
-     */
-    OPTIONAL = 'OPTIONAL',
-    /**
-     * Means it has at least 1 identity provider and that all identity providers enforceIdpAuth
-     */
-    ENFORCED = 'ENFORCED'
+import { B2BOrganisation } from '../b2b-organisation/b2b-organisation';
+import { SupportedLocale } from '../localisation/supported-locales';
+
+/**
+ * An enriched model of B2BOrganisation containing data that can be consumed by a public (unauthenticated) endpoint
+ */
+export interface EnrichedB2BOrganisation extends B2BOrganisation {
+    identityProviders: EnrichedB2BOrganisationIdentityProvider[];
+    skinId?: string;
+    brandWebAppDomain?: string;
+    brandAppName?: {
+        [K in SupportedLocale]?: string
+    };
+    ssoEnforcement?: SSOEnforcement;
+}
+
+export interface EnrichedB2BOrganisationIdentityProvider {
+    id?: string;
+    providerName: string;
+    verifiedDomains: string[];
+    /** Matching verifiedDomains should require to be authenticated via IdP or not */
+    enforceIdpAuth: boolean;
+}
+
+export enum SSOEnforcement {
+    /**
+     * Means that no identity provider is configured for the organisation
+     */
+    NONE = 'NONE',
+    /**
+     *  Means that it has at least 1 identity provider but not all identity providers have enforceIdpAuth set to true
+     */
+    OPTIONAL = 'OPTIONAL',
+    /**
+     * Means it has at least 1 identity provider and that all identity providers enforceIdpAuth
+     */
+    ENFORCED = 'ENFORCED'
 }

package/src/enriched-hack/enriched-hack-events.ts

@@ -1,21 +1,21 @@
-import { EnrichedHack } from './enriched-hack';
-
-export interface EnrichedHackCreatedEvent {
-    id: string;
-    type: 'EnrichedHackCreated';
-    payload: EnrichedHack;
-}
-
-export interface EnrichedHackUpdatedEvent {
-    id: string;
-    type: 'EnrichedHackUpdated';
-    payload: EnrichedHack;
-}
-
-export interface EnrichedHackDeletedEvent {
-    id: string;
-    type: 'EnrichedHackDeleted';
-    payload: EnrichedHack;
-}
-
-export type EnrichedHackChangedEvent = EnrichedHackCreatedEvent | EnrichedHackUpdatedEvent | EnrichedHackDeletedEvent;
+import { EnrichedHack } from './enriched-hack';
+
+export interface EnrichedHackCreatedEvent {
+    id: string;
+    type: 'EnrichedHackCreated';
+    payload: EnrichedHack;
+}
+
+export interface EnrichedHackUpdatedEvent {
+    id: string;
+    type: 'EnrichedHackUpdated';
+    payload: EnrichedHack;
+}
+
+export interface EnrichedHackDeletedEvent {
+    id: string;
+    type: 'EnrichedHackDeleted';
+    payload: EnrichedHack;
+}
+
+export type EnrichedHackChangedEvent = EnrichedHackCreatedEvent | EnrichedHackUpdatedEvent | EnrichedHackDeletedEvent;

package/src/enriched-hack/enriched-hack.ts

@@ -1,109 +1,109 @@
-import { HackAffiliate, HackContributor, HackExternalLink, HackSourceData, HackTopic, HackType } from '../hack/hack';
-import { KnowledgeSource } from '../knowledge-source/knowledge-source';
-import { Profile, ProfileMetadata } from '../profile/profile';
-import { Theme } from '../theme/theme';
-import { HackWithVoice } from '../hack/hack-with-voice';
-import { ExtractedSubject } from '../hack/extracted-subject';
-import { SegmentType, SegmentAction, SegmentSpeech, SegmentSection, SegmentTextCard } from '../segment/segment';
-
-export interface EnrichedHack {
-    /** The hack id */
-    id: string;
-    /** The hack language e.g. 'fr' if it is French */
-    language: string;
-    /** The locale (language and region) of the hack e.g. fr-FR. Use @uptime.app/localisation-contracts */
-    locale: string;
-    /** The id of the hack in its original locale. */
-    baseLocaleHackId: string;
-    v: number;
-    hackVersion: number;
-    createdAt: string;
-    updatedAt: string;
-
-    /** introduced Oct 2023 **/
-    draftHackId: string;
-    draftHackVersion: number;
-
-    //@todo: Deprecate
-    source?: KnowledgeSource;
-    owner: string;
-    tenant?: string;
-    acl: string[];
-    theme: Theme;
-    title: string;
-    isHidden?: boolean;
-    editorialTags?: string[];
-    coverUrl?: string;
-    /** Added in July 2024. This is the URL of the cover image that is free to use without any copyright. */
-    copyrightFreeCoverUrl?: string;
-    notifications?: EnrichedHackNotifications;
-    /* currently contains the inANutshell segment markdown */
-    description: string;
-    // ...
-
-    segments: HackWithVoice['segments']; // Use the 'HackWithVoice' type
-    affiliate?: HackAffiliate;
-    topics: HackTopic[];
-    contributors?: HackContributor[];
-    type: HackType;
-    sourceData?: HackSourceData;
-    externalLink?: HackExternalLink;
-    profile: EnrichHackProfile;
-
-    /** added April 2024 */
-    // TODO make it mandatory after a republish
-    subjects?: EnrichedHackSubjects;
-
-    // distribution
-    includeInEmailNotifications: boolean;
-    includeInPushNotifications: boolean;
-    includeInRecommendations: boolean;
-    includeInSearchResults: boolean;
-    includeInTrending: boolean;
-    includeInHackOfTheDay: boolean;
-    includeInWebsite: boolean;
-
-    /**
-     * Time saved in minutes by consuming the hack rather than the underlying knowledge source.
-     * calculated using the knowledge source page count / duration
-     * */
-    timeSaved?: number;
-    /**
-     * An estimation of the time saved in minutes when no reliable information is available on the knowledge source.
-     */
-    estimatedTimeSaved?: number;
-
-    /**
-     * Tenant display name, from the display name of its b2b-organisation, if any
-     */
-    tenantDisplayName?: string;
-}
-
-export interface EnrichedHackNotifications {
-    aiGeneratedText?: string;
-    humanCuratedText?: string;
-}
-
-export interface EnrichedHackSubjects {
-    aiGenerated: ExtractedSubject[];
-    humanCurated?: ExtractedSubject[];
-}
-
-export interface EnrichedHackSegment {
-    id: string;
-    createdAt: string;
-    updatedAt: string;
-    title: string;
-    type: SegmentType;
-    keywords: string[];
-    actions: SegmentAction[];
-    speech: SegmentSpeech[];
-    sections: SegmentSection[];
-    storyMode?: {
-        cards: SegmentTextCard[];
-        speech: SegmentSpeech[];
-    },
-    textSummary?: string;
-}
-
-export type EnrichHackProfile = Profile | ProfileMetadata;
+import { HackAffiliate, HackContributor, HackExternalLink, HackSourceData, HackTopic, HackType } from '../hack/hack';
+import { KnowledgeSource } from '../knowledge-source/knowledge-source';
+import { Profile, ProfileMetadata } from '../profile/profile';
+import { Theme } from '../theme/theme';
+import { HackWithVoice } from '../hack/hack-with-voice';
+import { ExtractedSubject } from '../hack/extracted-subject';
+import { SegmentType, SegmentAction, SegmentSpeech, SegmentSection, SegmentTextCard } from '../segment/segment';
+
+export interface EnrichedHack {
+    /** The hack id */
+    id: string;
+    /** The hack language e.g. 'fr' if it is French */
+    language: string;
+    /** The locale (language and region) of the hack e.g. fr-FR. Use @uptime.app/localisation-contracts */
+    locale: string;
+    /** The id of the hack in its original locale. */
+    baseLocaleHackId: string;
+    v: number;
+    hackVersion: number;
+    createdAt: string;
+    updatedAt: string;
+
+    /** introduced Oct 2023 **/
+    draftHackId: string;
+    draftHackVersion: number;
+
+    //@todo: Deprecate
+    source?: KnowledgeSource;
+    owner: string;
+    tenant?: string;
+    acl: string[];
+    theme: Theme;
+    title: string;
+    isHidden?: boolean;
+    editorialTags?: string[];
+    coverUrl?: string;
+    /** Added in July 2024. This is the URL of the cover image that is free to use without any copyright. */
+    copyrightFreeCoverUrl?: string;
+    notifications?: EnrichedHackNotifications;
+    /* currently contains the inANutshell segment markdown */
+    description: string;
+    // ...
+
+    segments: HackWithVoice['segments']; // Use the 'HackWithVoice' type
+    affiliate?: HackAffiliate;
+    topics: HackTopic[];
+    contributors?: HackContributor[];
+    type: HackType;
+    sourceData?: HackSourceData;
+    externalLink?: HackExternalLink;
+    profile: EnrichHackProfile;
+
+    /** added April 2024 */
+    // TODO make it mandatory after a republish
+    subjects?: EnrichedHackSubjects;
+
+    // distribution
+    includeInEmailNotifications: boolean;
+    includeInPushNotifications: boolean;
+    includeInRecommendations: boolean;
+    includeInSearchResults: boolean;
+    includeInTrending: boolean;
+    includeInHackOfTheDay: boolean;
+    includeInWebsite: boolean;
+
+    /**
+     * Time saved in minutes by consuming the hack rather than the underlying knowledge source.
+     * calculated using the knowledge source page count / duration
+     * */
+    timeSaved?: number;
+    /**
+     * An estimation of the time saved in minutes when no reliable information is available on the knowledge source.
+     */
+    estimatedTimeSaved?: number;
+
+    /**
+     * Tenant display name, from the display name of its b2b-organisation, if any
+     */
+    tenantDisplayName?: string;
+}
+
+export interface EnrichedHackNotifications {
+    aiGeneratedText?: string;
+    humanCuratedText?: string;
+}
+
+export interface EnrichedHackSubjects {
+    aiGenerated: ExtractedSubject[];
+    humanCurated?: ExtractedSubject[];
+}
+
+export interface EnrichedHackSegment {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    title: string;
+    type: SegmentType;
+    keywords: string[];
+    actions: SegmentAction[];
+    speech: SegmentSpeech[];
+    sections: SegmentSection[];
+    storyMode?: {
+        cards: SegmentTextCard[];
+        speech: SegmentSpeech[];
+    },
+    textSummary?: string;
+}
+
+export type EnrichHackProfile = Profile | ProfileMetadata;

package/src/enrichment-asset/hack-enrichment-video-events.ts

@@ -1,55 +1,55 @@
-import { HackEnrichmentVideo, PendingHackEnrichmentVideo } from './hack-enrichment-video';
-
-export interface HackEnrichmentVideoCreatedEvent {
-    id: string;
-    type: 'HackEnrichmentVideoCreated';
-    payload: HackEnrichmentVideo;
-}
-
-export interface HackEnrichmentVideoUpdatedEvent {
-    id: string;
-    type: 'HackEnrichmentVideoUpdated';
-    payload: HackEnrichmentVideo;
-}
-
-export interface HackEnrichmentVideoDeletedEvent {
-    id: string;
-    type: 'HackEnrichmentVideoDeleted';
-    payload: HackEnrichmentVideo;
-}
-
-export interface PendingHackEnrichmentVideoCreatedEvent {
-    id: string;
-    type: 'PendingHackEnrichmentVideoCreated';
-    payload: PendingHackEnrichmentVideo;
-}
-
-export interface PendingHackEnrichmentVideoUpdatedEvent {
-    id: string;
-    type: 'PendingHackEnrichmentVideoUpdated';
-    payload: PendingHackEnrichmentVideo;
-}
-
-export interface PendingHackEnrichmentVideoDeletedEvent {
-    id: string;
-    type: 'PendingHackEnrichmentVideoDeleted';
-    payload: PendingHackEnrichmentVideo;
-}
-
-export type HackEnrichmentVideoChangedEvent = HackEnrichmentVideoCreatedEvent | HackEnrichmentVideoUpdatedEvent | HackEnrichmentVideoDeletedEvent;
-export type PendingHackEnrichmentVideoChangedEvent = PendingHackEnrichmentVideoCreatedEvent | PendingHackEnrichmentVideoUpdatedEvent | PendingHackEnrichmentVideoDeletedEvent;
-
-export interface CreateHackEnrichmentVideoCommandBody {
-    // a command needs an id and a version so that it can be more easily replayed
-    // for this specific command, the id is the youTubeUrl and the version is a timestamp
-    id: string;
-    v: number;
-    youTubeUrl: string;
-    hackId: string;
-}
-
-export interface CreateHackEnrichmentVideoCommand {
-    id: string;
-    type: 'CreateHackEnrichmentVideoCommand';
-    payload: CreateHackEnrichmentVideoCommandBody;
-}
+import { HackEnrichmentVideo, PendingHackEnrichmentVideo } from './hack-enrichment-video';
+
+export interface HackEnrichmentVideoCreatedEvent {
+    id: string;
+    type: 'HackEnrichmentVideoCreated';
+    payload: HackEnrichmentVideo;
+}
+
+export interface HackEnrichmentVideoUpdatedEvent {
+    id: string;
+    type: 'HackEnrichmentVideoUpdated';
+    payload: HackEnrichmentVideo;
+}
+
+export interface HackEnrichmentVideoDeletedEvent {
+    id: string;
+    type: 'HackEnrichmentVideoDeleted';
+    payload: HackEnrichmentVideo;
+}
+
+export interface PendingHackEnrichmentVideoCreatedEvent {
+    id: string;
+    type: 'PendingHackEnrichmentVideoCreated';
+    payload: PendingHackEnrichmentVideo;
+}
+
+export interface PendingHackEnrichmentVideoUpdatedEvent {
+    id: string;
+    type: 'PendingHackEnrichmentVideoUpdated';
+    payload: PendingHackEnrichmentVideo;
+}
+
+export interface PendingHackEnrichmentVideoDeletedEvent {
+    id: string;
+    type: 'PendingHackEnrichmentVideoDeleted';
+    payload: PendingHackEnrichmentVideo;
+}
+
+export type HackEnrichmentVideoChangedEvent = HackEnrichmentVideoCreatedEvent | HackEnrichmentVideoUpdatedEvent | HackEnrichmentVideoDeletedEvent;
+export type PendingHackEnrichmentVideoChangedEvent = PendingHackEnrichmentVideoCreatedEvent | PendingHackEnrichmentVideoUpdatedEvent | PendingHackEnrichmentVideoDeletedEvent;
+
+export interface CreateHackEnrichmentVideoCommandBody {
+    // a command needs an id and a version so that it can be more easily replayed
+    // for this specific command, the id is the youTubeUrl and the version is a timestamp
+    id: string;
+    v: number;
+    youTubeUrl: string;
+    hackId: string;
+}
+
+export interface CreateHackEnrichmentVideoCommand {
+    id: string;
+    type: 'CreateHackEnrichmentVideoCommand';
+    payload: CreateHackEnrichmentVideoCommandBody;
+}

package/src/enrichment-asset/hack-enrichment-video.ts

@@ -1,40 +1,40 @@
-import { VideoMetadata } from '..';
-
-export interface HackEnrichmentVideo {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    youTubeUrl: string;
-    hackId: string;
-
-    youTubeVideoId: string;
-    startAtSeconds: number;
-    endAtSeconds: number;
-
-    s3Path: string;
-    videoMetadata: VideoMetadata;
-
-    // Set to true when the original hack still includes the URL of this video, and false when the URL is removed from the hack
-    referencedByHack: boolean;
-}
-
-export interface PendingHackEnrichmentVideo {
-    // not used as a key in the dynamo table
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-
-    // hash and range keys
-    youTubeUrl: string;
-    hackId: string;
-
-    hackEnrichmentVideoId: string;
-
-    status: PendingHackEnrichmentVideoStatus;
-    error?: string;
-}
-
-// on success, the pending entity is deleted
-export type PendingHackEnrichmentVideoStatus = 'processing' | 'failed';
+import { VideoMetadata } from '..';
+
+export interface HackEnrichmentVideo {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    youTubeUrl: string;
+    hackId: string;
+
+    youTubeVideoId: string;
+    startAtSeconds: number;
+    endAtSeconds: number;
+
+    s3Path: string;
+    videoMetadata: VideoMetadata;
+
+    // Set to true when the original hack still includes the URL of this video, and false when the URL is removed from the hack
+    referencedByHack: boolean;
+}
+
+export interface PendingHackEnrichmentVideo {
+    // not used as a key in the dynamo table
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+
+    // hash and range keys
+    youTubeUrl: string;
+    hackId: string;
+
+    hackEnrichmentVideoId: string;
+
+    status: PendingHackEnrichmentVideoStatus;
+    error?: string;
+}
+
+// on success, the pending entity is deleted
+export type PendingHackEnrichmentVideoStatus = 'processing' | 'failed';

package/src/entitlement/user-entitlements-commands.ts

@@ -1,54 +1,54 @@
-import { Entitlement, EntitlementName } from './user-entitlements';
-
-export interface IssueUserEntitlementCommand {
-    id: string;
-    type: 'IssueUserEntitlement',
-    payload: IssueUserEntitlementCommandPayload
-}
-
-export interface IssueUserEntitlementCommandPayload extends Entitlement {
-    id: string;
-    v: number;
-    userId: string;
-}
-
-export interface RemoveUserEntitlementCommand {
-    id: string;
-    type: 'RemoveUserEntitlement',
-    payload: RemoveUserEntitlementCommandPayload
-}
-
-export interface RemoveUserEntitlementCommandPayload {
-    issuer: string;
-    entitlement: EntitlementName | string;
-    userId: string;
-}
-
-export interface RefreshRevenueCatUserStatusCommand {
-    id: string;
-    type: 'RefreshRevenueCatUserStatus',
-    payload: {
-        userId: string;
-    };
-}
-
-/**
- * Ensure the user has the provided entitlements from the given issuer.
- * Will remove any existing entitlements from the issuer that are not specified in the command
- */
-export interface SetUserEntitlementsFromIssuerCommand {
-    id: string;
-    type: 'SetUserEntitlementsFromIssuer',
-    payload: {
-        id: string;
-        v: number,
-        issuer: string;
-        userId: string
-        entitlements: {
-            entitlement: EntitlementName | string;
-            /** leave a undefined to never expire */
-            expiresAt?: string
-            issuedAt: string;
-        }[]
-    }
-}
+import { Entitlement, EntitlementName } from './user-entitlements';
+
+export interface IssueUserEntitlementCommand {
+    id: string;
+    type: 'IssueUserEntitlement',
+    payload: IssueUserEntitlementCommandPayload
+}
+
+export interface IssueUserEntitlementCommandPayload extends Entitlement {
+    id: string;
+    v: number;
+    userId: string;
+}
+
+export interface RemoveUserEntitlementCommand {
+    id: string;
+    type: 'RemoveUserEntitlement',
+    payload: RemoveUserEntitlementCommandPayload
+}
+
+export interface RemoveUserEntitlementCommandPayload {
+    issuer: string;
+    entitlement: EntitlementName | string;
+    userId: string;
+}
+
+export interface RefreshRevenueCatUserStatusCommand {
+    id: string;
+    type: 'RefreshRevenueCatUserStatus',
+    payload: {
+        userId: string;
+    };
+}
+
+/**
+ * Ensure the user has the provided entitlements from the given issuer.
+ * Will remove any existing entitlements from the issuer that are not specified in the command
+ */
+export interface SetUserEntitlementsFromIssuerCommand {
+    id: string;
+    type: 'SetUserEntitlementsFromIssuer',
+    payload: {
+        id: string;
+        v: number,
+        issuer: string;
+        userId: string
+        entitlements: {
+            entitlement: EntitlementName | string;
+            /** leave a undefined to never expire */
+            expiresAt?: string
+            issuedAt: string;
+        }[]
+    }
+}