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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uptime.app/contracts",
-  "version": "1.0.21-rc.0",
+  "version": "1.0.21",
   "license": "MIT",
   "types": "./dist/esm/index.d.ts",
   "main": "./dist/cjs/index.js",
@@ -13,5 +13,5 @@
   "devDependencies": {
     "typescript": "^5.4.3"
   },
-  "gitHead": "55bfc2d05305037e38cfab493f73589fd2ec6197"
+  "gitHead": "b0c07ab261e2cb647123b285a9380cf36dd6a2ad"
 }

package/src/access-control/collection-access-control.ts

@@ -1,28 +1,28 @@
-export interface CollectionAccessControl {
-    id: string;
-    collectionId: string; // PK
-    v: number;
-    acl: string[]
-    createdAt: string;
-    updatedAt: string;
-}
-
-export interface CollectionAccessControlCreatedEvent {
-    id: string;
-    type: 'CollectionAccessControlCreated';
-    payload: CollectionAccessControl;
-}
-
-export interface CollectionAccessControlUpdatedEvent {
-    id: string;
-    type: 'CollectionAccessControlUpdated';
-    payload: CollectionAccessControl;
-}
-
-export interface CollectionAccessControlDeletedEvent {
-    id: string;
-    type: 'CollectionAccessControlDeleted';
-    payload: CollectionAccessControl;
-}
-
-export type CollectionAccessControlChangedEvent = CollectionAccessControlCreatedEvent | CollectionAccessControlUpdatedEvent | CollectionAccessControlDeletedEvent;
+export interface CollectionAccessControl {
+    id: string;
+    collectionId: string; // PK
+    v: number;
+    acl: string[]
+    createdAt: string;
+    updatedAt: string;
+}
+
+export interface CollectionAccessControlCreatedEvent {
+    id: string;
+    type: 'CollectionAccessControlCreated';
+    payload: CollectionAccessControl;
+}
+
+export interface CollectionAccessControlUpdatedEvent {
+    id: string;
+    type: 'CollectionAccessControlUpdated';
+    payload: CollectionAccessControl;
+}
+
+export interface CollectionAccessControlDeletedEvent {
+    id: string;
+    type: 'CollectionAccessControlDeleted';
+    payload: CollectionAccessControl;
+}
+
+export type CollectionAccessControlChangedEvent = CollectionAccessControlCreatedEvent | CollectionAccessControlUpdatedEvent | CollectionAccessControlDeletedEvent;

package/src/access-control/hack-access-control.ts

@@ -1,29 +1,29 @@
-export interface HackAccessControl {
-    id: string;
-    hackId: string; // PK
-    // do I need baseLocaleHackId ? don't think I do
-    v: number;
-    acl: string[]
-    createdAt: string;
-    updatedAt: string;
-}
-
-export interface HackAccessControlCreatedEvent {
-    id: string;
-    type: 'HackAccessControlCreated';
-    payload: HackAccessControl;
-}
-
-export interface HackAccessControlUpdatedEvent {
-    id: string;
-    type: 'HackAccessControlUpdated';
-    payload: HackAccessControl;
-}
-
-export interface HackAccessControlDeletedEvent {
-    id: string;
-    type: 'HackAccessControlDeleted';
-    payload: HackAccessControl;
-}
-
-export type HackAccessControlChangedEvent = HackAccessControlCreatedEvent | HackAccessControlUpdatedEvent | HackAccessControlDeletedEvent;
+export interface HackAccessControl {
+    id: string;
+    hackId: string; // PK
+    // do I need baseLocaleHackId ? don't think I do
+    v: number;
+    acl: string[]
+    createdAt: string;
+    updatedAt: string;
+}
+
+export interface HackAccessControlCreatedEvent {
+    id: string;
+    type: 'HackAccessControlCreated';
+    payload: HackAccessControl;
+}
+
+export interface HackAccessControlUpdatedEvent {
+    id: string;
+    type: 'HackAccessControlUpdated';
+    payload: HackAccessControl;
+}
+
+export interface HackAccessControlDeletedEvent {
+    id: string;
+    type: 'HackAccessControlDeleted';
+    payload: HackAccessControl;
+}
+
+export type HackAccessControlChangedEvent = HackAccessControlCreatedEvent | HackAccessControlUpdatedEvent | HackAccessControlDeletedEvent;

package/src/app-hack/app-full-hack.ts

@@ -1,9 +1,9 @@
-import { AppRestrictedHack } from './app-restricted-hack';
-import { EnrichedHack } from '../enriched-hack/enriched-hack';
-
-/**
- * Includes all of a hack's content that premium users are allowed to access. Free users should not have access to this object.
- */
-export interface AppFullHack extends AppRestrictedHack {
-    segments: EnrichedHack['segments'];
-}
+import { AppRestrictedHack } from './app-restricted-hack';
+import { EnrichedHack } from '../enriched-hack/enriched-hack';
+
+/**
+ * Includes all of a hack's content that premium users are allowed to access. Free users should not have access to this object.
+ */
+export interface AppFullHack extends AppRestrictedHack {
+    segments: EnrichedHack['segments'];
+}

package/src/app-hack/app-hack-metadata.ts

@@ -1,56 +1,56 @@
-import { EnrichedHack } from '../enriched-hack/enriched-hack';
-
-export interface AppHackMetadata {
-    id: string;
-    language: string;
-    locale: string;
-    baseLocaleHackId: string;
-    v: number;
-    hackVersion: number;
-    createdAt: string;
-    updatedAt: string;
-    owner: string;
-    acl: string[];
-    themeId: string;
-    title: string;
-    isHidden?: boolean;
-    editorialTags?: string[];
-    coverUrl?: string;
-    description: string;
-    /** 'public' or 'private' introduced Mar 2024 */
-    shareScope: string;
-    segments: {
-        favouriteQuote: {
-            id: string;
-        };
-        inANutshell: {
-            id: string;
-        };
-        introduction: {
-            id: string;
-        };
-        insights: {id: string}[];
-        conclusion: {
-            id: string;
-        };
-        overview: {
-            id: string;
-        };
-        shareableOverview: {
-            id: string;
-        };
-        hereAreTheInsights: {
-            id: string;
-        };
-        putInAction?: {
-            id: string;
-        };
-    }
-    topics: EnrichedHack['topics'];
-    contributors?: EnrichedHack['contributors'];
-    type: string;
-    sourceData?: EnrichedHack['sourceData'];
-    profile: EnrichedHack['profile'];
-    timeSaved?: number;
-    estimatedTimeSaved?: number;
-}
+import { EnrichedHack } from '../enriched-hack/enriched-hack';
+
+export interface AppHackMetadata {
+    id: string;
+    language: string;
+    locale: string;
+    baseLocaleHackId: string;
+    v: number;
+    hackVersion: number;
+    createdAt: string;
+    updatedAt: string;
+    owner: string;
+    acl: string[];
+    themeId: string;
+    title: string;
+    isHidden?: boolean;
+    editorialTags?: string[];
+    coverUrl?: string;
+    description: string;
+    /** 'public' or 'private' introduced Mar 2024 */
+    shareScope: string;
+    segments: {
+        favouriteQuote: {
+            id: string;
+        };
+        inANutshell: {
+            id: string;
+        };
+        introduction: {
+            id: string;
+        };
+        insights: {id: string}[];
+        conclusion: {
+            id: string;
+        };
+        overview: {
+            id: string;
+        };
+        shareableOverview: {
+            id: string;
+        };
+        hereAreTheInsights: {
+            id: string;
+        };
+        putInAction?: {
+            id: string;
+        };
+    }
+    topics: EnrichedHack['topics'];
+    contributors?: EnrichedHack['contributors'];
+    type: string;
+    sourceData?: EnrichedHack['sourceData'];
+    profile: EnrichedHack['profile'];
+    timeSaved?: number;
+    estimatedTimeSaved?: number;
+}

package/src/app-hack/app-restricted-hack.ts

@@ -1,22 +1,22 @@
-import { EnrichedHack } from '../enriched-hack/enriched-hack';
-import { AppHackMetadata } from './app-hack-metadata';
-
-/**
- * Includes all of a hack's content the free users are allowed to access.
- */
-export interface AppRestrictedHack extends AppHackMetadata {
-    segments: AppHackMetadata['segments'] & {
-        // only allow access to the shareableOverview and overview segment
-        overview: EnrichedHack['segments']['overview'];
-        shareableOverview: EnrichedHack['segments']['shareableOverview'];
-    }
-    theme: EnrichedHack['theme'];
-    affiliate?: {
-        url: string;
-        name: string;
-    };
-    externalLink?: {
-        url: string;
-        type: 'Website' | 'Book' | 'Course' | 'Podcast' | 'Video' | 'Other';
-    };
-}
+import { EnrichedHack } from '../enriched-hack/enriched-hack';
+import { AppHackMetadata } from './app-hack-metadata';
+
+/**
+ * Includes all of a hack's content the free users are allowed to access.
+ */
+export interface AppRestrictedHack extends AppHackMetadata {
+    segments: AppHackMetadata['segments'] & {
+        // only allow access to the shareableOverview and overview segment
+        overview: EnrichedHack['segments']['overview'];
+        shareableOverview: EnrichedHack['segments']['shareableOverview'];
+    }
+    theme: EnrichedHack['theme'];
+    affiliate?: {
+        url: string;
+        name: string;
+    };
+    externalLink?: {
+        url: string;
+        type: 'Website' | 'Book' | 'Course' | 'Podcast' | 'Video' | 'Other';
+    };
+}

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,9 +1,9 @@
-
-export interface Brand {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    name: string;
-    skinId?: string;
+
+export interface Brand {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    name: string;
+    skinId?: 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;
+}