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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (167) hide show
  1. package/package.json +2 -2
  2. package/src/access-control/collection-access-control.ts +28 -28
  3. package/src/access-control/hack-access-control.ts +32 -32
  4. package/src/access-control/profile-access-control.ts +27 -27
  5. package/src/app-hack/app-full-hack.ts +9 -9
  6. package/src/app-hack/app-hack-metadata.ts +61 -61
  7. package/src/app-hack/app-restricted-hack.ts +22 -22
  8. package/src/b2b-content-access/b2b-content-access.ts +57 -57
  9. package/src/b2b-organisation/b2b-carousel.ts +33 -33
  10. package/src/b2b-organisation/b2b-org-idp-mapping.ts +27 -27
  11. package/src/b2b-organisation/b2b-organisation-events.ts +21 -21
  12. package/src/b2b-organisation/b2b-organisation-group-events.ts +21 -21
  13. package/src/b2b-organisation/b2b-organisation-group-membership-events.ts +21 -21
  14. package/src/b2b-organisation/b2b-organisation-group-membership.ts +10 -10
  15. package/src/b2b-organisation/b2b-organisation-group.ts +16 -16
  16. package/src/b2b-organisation/b2b-organisation-invitation.ts +45 -45
  17. package/src/b2b-organisation/b2b-organisation-member-events.ts +21 -21
  18. package/src/b2b-organisation/b2b-organisation-member.ts +19 -19
  19. package/src/b2b-organisation/b2b-organisation.ts +35 -35
  20. package/src/brand/brand-events.ts +21 -21
  21. package/src/brand/brand.ts +29 -29
  22. package/src/catalogue/catalogue.ts +152 -152
  23. package/src/cms-hack/cms-searchable-hack.ts +44 -44
  24. package/src/collection/collection-events.ts +21 -21
  25. package/src/collection/collection.ts +59 -59
  26. package/src/collection/enriched-collection-events.ts +18 -18
  27. package/src/collection/enriched-collection.ts +63 -63
  28. package/src/course/course-events.ts +20 -20
  29. package/src/course/course.ts +25 -25
  30. package/src/course-enrollment/course-enrollment-events.ts +21 -21
  31. package/src/course-enrollment/course-enrollment.ts +36 -36
  32. package/src/creator/creator-events.ts +32 -32
  33. package/src/creator/creator.ts +7 -7
  34. package/src/distribution/collection-distribution.ts +17 -17
  35. package/src/distribution/distribution-events.ts +61 -61
  36. package/src/distribution/hack-distribution.ts +18 -18
  37. package/src/draft-hack/draft-hack-events.ts +21 -21
  38. package/src/draft-hack/draft-hack.ts +190 -190
  39. package/src/draft-hack-generation/draft-hack-generation-commands.ts +10 -10
  40. package/src/draft-hack-generation/draft-hack-generation-events.ts +52 -52
  41. package/src/draft-hack-generation/draft-hack-generation.ts +39 -39
  42. package/src/enriched-b2b-organisation/enriched-b2b-organisation-events.ts +21 -21
  43. package/src/enriched-b2b-organisation/enriched-b2b-organisation.ts +37 -37
  44. package/src/enriched-hack/enriched-hack-events.ts +21 -21
  45. package/src/enriched-hack/enriched-hack.ts +109 -109
  46. package/src/enrichment-asset/hack-enrichment-video-events.ts +55 -55
  47. package/src/enrichment-asset/hack-enrichment-video.ts +40 -40
  48. package/src/entitlement/user-entitlements-commands.ts +54 -54
  49. package/src/entitlement/user-entitlements-events.ts +29 -29
  50. package/src/entitlement/user-entitlements.ts +18 -18
  51. package/src/flashcard/flashcard-events.ts +85 -85
  52. package/src/flashcard/flashcard.ts +138 -138
  53. package/src/hack/extracted-subject.ts +31 -31
  54. package/src/hack/hack-events.ts +21 -21
  55. package/src/hack/hack-published.ts +21 -21
  56. package/src/hack/hack-with-voice-events.ts +20 -20
  57. package/src/hack/hack-with-voice.ts +36 -36
  58. package/src/hack/hack.ts +127 -127
  59. package/src/hack/publish-hack-command.ts +20 -20
  60. package/src/hack/republish-hack-command.ts +20 -20
  61. package/src/hack-mapping/access-helper.ts +6 -6
  62. package/src/hack-mapping/app-full-hack.test.ts +12 -12
  63. package/src/hack-mapping/app-full-hack.ts +14 -14
  64. package/src/hack-mapping/app-hack-metadata.test.ts +22 -22
  65. package/src/hack-mapping/app-hack-metadata.ts +82 -82
  66. package/src/hack-mapping/app-restricted-hack.test.ts +11 -11
  67. package/src/hack-mapping/app-restricted-hack.ts +21 -21
  68. package/src/hack-mapping/remove-undefined-fields.ts +9 -9
  69. package/src/hack-mapping/test-data/enriched-hack.json +2576 -2576
  70. package/src/hack-mapping/test-data/expected-app-full-hack.json +2509 -2509
  71. package/src/hack-mapping/test-data/expected-app-hack-metadata.json +93 -93
  72. package/src/hack-mapping/test-data/expected-app-restricted-hack.json +799 -799
  73. package/src/hack-metadata/hack-metadata-events.ts +21 -21
  74. package/src/hack-metadata/hack-metadata.ts +17 -17
  75. package/src/hack-of-the-day/hack-of-the-day-events.ts +21 -21
  76. package/src/hack-of-the-day/hack-of-the-day.ts +13 -13
  77. package/src/hack-statistics/hack-statistics-events.ts +21 -21
  78. package/src/hack-statistics/hack-statistics.ts +9 -9
  79. package/src/hackbot/hack-generation-commands.ts +44 -44
  80. package/src/hackbot/hack-generation-trigger-events.ts +21 -21
  81. package/src/hackbot/hack-generation-trigger.ts +57 -57
  82. package/src/history/history-events.ts +21 -21
  83. package/src/history/history.ts +46 -46
  84. package/src/identity-provider/domain-identity-provider-events.ts +20 -20
  85. package/src/identity-provider/domain-identity-provider.ts +10 -10
  86. package/src/identity-provider/identity-provider-events.ts +20 -20
  87. package/src/identity-provider/identity-provider.ts +46 -46
  88. package/src/index.ts +210 -210
  89. package/src/interest/interest-events.ts +21 -21
  90. package/src/interest/interest.ts +15 -15
  91. package/src/knowledge-source/knowledge-source-events.ts +21 -21
  92. package/src/knowledge-source/knowledge-source.ts +43 -43
  93. package/src/knowledge-source-parsing/knowledge-source-metadata.ts +58 -58
  94. package/src/knowledge-source-parsing/knowledge-source-parsing-commands.ts +41 -41
  95. package/src/knowledge-source-parsing/knowledge-source-parsing-events.ts +30 -30
  96. package/src/knowledge-source-parsing/podcast-metadata.ts +44 -44
  97. package/src/knowledge-source-parsing/podcast-parsing-events.ts +28 -28
  98. package/src/knowledge-source-parsing/user-hack-generation-options.ts +7 -7
  99. package/src/learn-upon/get-sqsso-url.ts +13 -13
  100. package/src/learn-upon/learn-upon-commands.ts +32 -32
  101. package/src/learn-upon/learn-upon-course-enrollment-events.ts +21 -21
  102. package/src/learn-upon/learn-upon-course-enrollment.ts +62 -62
  103. package/src/learn-upon/learn-upon-course-events.ts +21 -21
  104. package/src/learn-upon/learn-upon-course.ts +108 -108
  105. package/src/learn-upon/learn-upon-portal-events.ts +20 -20
  106. package/src/learn-upon/learn-upon-portal.ts +12 -12
  107. package/src/learn-upon/learn-upon-user-mapping-events.ts +18 -18
  108. package/src/learn-upon/learn-upon-user-mapping.ts +9 -9
  109. package/src/learn-upon/learn-upon-webhook-events.ts +80 -80
  110. package/src/learn-upon/learn-upon-webhook-types.ts +346 -346
  111. package/src/learn-upon/unenroll.ts +6 -6
  112. package/src/localisation/live-locales.ts +45 -45
  113. package/src/localisation/locale-language.ts +4 -4
  114. package/src/localisation/supported-languages.ts +11 -11
  115. package/src/localisation/supported-locales.ts +67 -67
  116. package/src/message-bus/context.ts +7 -7
  117. package/src/moderation/hack-moderation-result-events.ts +18 -18
  118. package/src/moderation/hack-moderation-result.ts +27 -27
  119. package/src/partner/partner-events.ts +21 -21
  120. package/src/partner/partner.ts +7 -7
  121. package/src/pending-hack/pending-hack-events.ts +20 -20
  122. package/src/pending-hack/pending-hack-with-voice-events.ts +20 -20
  123. package/src/pending-hack/pending-hack-with-voice.ts +25 -25
  124. package/src/pending-hack/pending-hack.ts +78 -78
  125. package/src/preferences/preferences-events.ts +15 -15
  126. package/src/preferences/preferences.ts +35 -35
  127. package/src/profile/profile-events.ts +41 -41
  128. package/src/profile/profile.ts +36 -36
  129. package/src/profile/translated-profile.ts +13 -13
  130. package/src/referral/referral-events.ts +41 -41
  131. package/src/referral/referral.ts +76 -76
  132. package/src/saved/saved-collection-events.ts +19 -19
  133. package/src/saved/saved-collection.ts +8 -8
  134. package/src/segment/segment-commands.ts +75 -75
  135. package/src/segment/segment-events.ts +42 -42
  136. package/src/segment/segment-with-voice.ts +8 -8
  137. package/src/segment/segment.ts +82 -82
  138. package/src/service-simulator/mock-request-response.ts +17 -17
  139. package/src/skin/skin-events.ts +21 -21
  140. package/src/skin/skin.ts +6 -6
  141. package/src/spark/spark-board-read-model.ts +17 -17
  142. package/src/spark/spark-board.ts +12 -12
  143. package/src/spark/spark-events.ts +42 -42
  144. package/src/spark/spark.ts +75 -75
  145. package/src/text-to-speech/create-speech-commands.ts +22 -22
  146. package/src/text-to-speech/speech-created-events.ts +10 -10
  147. package/src/text-to-speech/supported-voices.ts +222 -222
  148. package/src/text-to-speech/text-segment.ts +29 -29
  149. package/src/theme/theme-events.ts +21 -21
  150. package/src/theme/theme.ts +68 -68
  151. package/src/translation/translation-events.ts +73 -73
  152. package/src/translation/translation.ts +25 -25
  153. package/src/trending/trending-events.ts +21 -21
  154. package/src/trending/trending-hacks.ts +8 -8
  155. package/src/user/cognito-user-authentication-log.ts +7 -7
  156. package/src/user/get-user.ts +63 -63
  157. package/src/user/user-events.ts +39 -39
  158. package/src/user-context/user-context-events.ts +21 -21
  159. package/src/user-context/user-context.ts +15 -15
  160. package/src/user-notification-context/user-notification-context-events.ts +21 -21
  161. package/src/user-notification-context/user-notification-context.ts +9 -9
  162. package/src/user-statistics/user-statistics-events.ts +97 -97
  163. package/src/user-statistics/user-statistics.ts +82 -82
  164. package/src/video-cropping/video-cropping-events.ts +43 -43
  165. package/src/video-cropping/video-metadata.ts +12 -12
  166. package/tsconfig.cjs.json +7 -7
  167. package/tsconfig.npm.json +22 -22
@@ -1,21 +1,21 @@
1
- import { Skin } from './skin';
2
-
3
- export interface SkinCreatedEvent {
4
- id: string;
5
- type: 'SkinCreated';
6
- payload: Skin;
7
- }
8
-
9
- export interface SkinUpdatedEvent {
10
- id: string;
11
- type: 'SkinUpdated';
12
- payload: Skin;
13
- }
14
-
15
- export interface SkinDeletedEvent {
16
- id: string;
17
- type: 'SkinDeleted';
18
- payload: Skin;
19
- }
20
-
21
- export type SkinChangedEvent = SkinCreatedEvent | SkinUpdatedEvent | SkinDeletedEvent;
1
+ import { Skin } from './skin';
2
+
3
+ export interface SkinCreatedEvent {
4
+ id: string;
5
+ type: 'SkinCreated';
6
+ payload: Skin;
7
+ }
8
+
9
+ export interface SkinUpdatedEvent {
10
+ id: string;
11
+ type: 'SkinUpdated';
12
+ payload: Skin;
13
+ }
14
+
15
+ export interface SkinDeletedEvent {
16
+ id: string;
17
+ type: 'SkinDeleted';
18
+ payload: Skin;
19
+ }
20
+
21
+ export type SkinChangedEvent = SkinCreatedEvent | SkinUpdatedEvent | SkinDeletedEvent;
package/src/skin/skin.ts CHANGED
@@ -1,7 +1,7 @@
1
-
2
- export interface Skin {
3
- id: string;
4
- v: number;
5
- createdAt: string;
6
- updatedAt: string;
1
+
2
+ export interface Skin {
3
+ id: string;
4
+ v: number;
5
+ createdAt: string;
6
+ updatedAt: string;
7
7
  }
@@ -1,17 +1,17 @@
1
- import { Spark } from './spark';
2
- import { SparkBoardType } from './spark-board';
3
-
4
- export interface SparkBoardReadModel {
5
- // the spark board id
6
- id: string;
7
- // the version of the read model
8
- v: number;
9
- updatedAt: string;
10
- createdAt: string;
11
- sparkBoardVersion: number;
12
- userId: string;
13
- boardName: string;
14
- boardType?: SparkBoardType;
15
- sparkCount: number;
16
- firstSparks: Spark[];
17
- }
1
+ import { Spark } from './spark';
2
+ import { SparkBoardType } from './spark-board';
3
+
4
+ export interface SparkBoardReadModel {
5
+ // the spark board id
6
+ id: string;
7
+ // the version of the read model
8
+ v: number;
9
+ updatedAt: string;
10
+ createdAt: string;
11
+ sparkBoardVersion: number;
12
+ userId: string;
13
+ boardName: string;
14
+ boardType?: SparkBoardType;
15
+ sparkCount: number;
16
+ firstSparks: Spark[];
17
+ }
@@ -1,12 +1,12 @@
1
- export interface SparkBoard {
2
- id: string;
3
- v: number;
4
- createdAt: string;
5
- updatedAt: string;
6
- userId: string;
7
- boardName: string;
8
- boardType?: SparkBoardType;
9
- isPublic: boolean;
10
- }
11
-
12
- export type SparkBoardType = 'default';
1
+ export interface SparkBoard {
2
+ id: string;
3
+ v: number;
4
+ createdAt: string;
5
+ updatedAt: string;
6
+ userId: string;
7
+ boardName: string;
8
+ boardType?: SparkBoardType;
9
+ isPublic: boolean;
10
+ }
11
+
12
+ export type SparkBoardType = 'default';
@@ -1,42 +1,42 @@
1
- import { Spark } from './spark';
2
- import { SparkBoard } from './spark-board';
3
-
4
- export interface SparkCreatedEvent {
5
- id: string;
6
- type: 'SparkCreated';
7
- payload: Spark;
8
- }
9
-
10
- export interface SparkUpdatedEvent {
11
- id: string;
12
- type: 'SparkUpdated';
13
- payload: Spark;
14
- }
15
-
16
- export interface SparkDeletedEvent {
17
- id: string;
18
- type: 'SparkDeleted';
19
- payload: Spark;
20
- }
21
-
22
- export type SparkChangedEvent = SparkCreatedEvent | SparkUpdatedEvent | SparkDeletedEvent;
23
-
24
- export interface SparkBoardCreatedEvent {
25
- id: string;
26
- type: 'SparkBoardCreated';
27
- payload: SparkBoard;
28
- }
29
-
30
- export interface SparkBoardUpdatedEvent {
31
- id: string;
32
- type: 'SparkBoardUpdated';
33
- payload: SparkBoard;
34
- }
35
-
36
- export interface SparkBoardDeletedEvent {
37
- id: string;
38
- type: 'SparkBoardDeleted';
39
- payload: SparkBoard;
40
- }
41
-
42
- export type SparkBoardChangedEvent = SparkBoardCreatedEvent | SparkBoardUpdatedEvent | SparkBoardDeletedEvent;
1
+ import { Spark } from './spark';
2
+ import { SparkBoard } from './spark-board';
3
+
4
+ export interface SparkCreatedEvent {
5
+ id: string;
6
+ type: 'SparkCreated';
7
+ payload: Spark;
8
+ }
9
+
10
+ export interface SparkUpdatedEvent {
11
+ id: string;
12
+ type: 'SparkUpdated';
13
+ payload: Spark;
14
+ }
15
+
16
+ export interface SparkDeletedEvent {
17
+ id: string;
18
+ type: 'SparkDeleted';
19
+ payload: Spark;
20
+ }
21
+
22
+ export type SparkChangedEvent = SparkCreatedEvent | SparkUpdatedEvent | SparkDeletedEvent;
23
+
24
+ export interface SparkBoardCreatedEvent {
25
+ id: string;
26
+ type: 'SparkBoardCreated';
27
+ payload: SparkBoard;
28
+ }
29
+
30
+ export interface SparkBoardUpdatedEvent {
31
+ id: string;
32
+ type: 'SparkBoardUpdated';
33
+ payload: SparkBoard;
34
+ }
35
+
36
+ export interface SparkBoardDeletedEvent {
37
+ id: string;
38
+ type: 'SparkBoardDeleted';
39
+ payload: SparkBoard;
40
+ }
41
+
42
+ export type SparkBoardChangedEvent = SparkBoardCreatedEvent | SparkBoardUpdatedEvent | SparkBoardDeletedEvent;
@@ -1,75 +1,75 @@
1
- import { CardType, SegmentType } from '../segment/segment';
2
- import { Profile, ProfileMetadata } from '../profile/profile';
3
- import { SupportedLocale } from '../localisation/supported-locales';
4
- import { ThemeTemplate } from '../theme/theme';
5
- import { Hack } from '../hack/hack';
6
-
7
- export interface Spark {
8
- id: string;
9
- v: number;
10
- createdAt: string;
11
- updatedAt: string;
12
- userId: string;
13
- hackId: string;
14
- segmentId: string;
15
- card: SparkedCard;
16
- boardId: string;
17
- theme: {
18
- fontFamily: string;
19
- light: ThemeTemplate;
20
- dark: ThemeTemplate;
21
- player?: {
22
- light: {
23
- backgroundColor: string;
24
- },
25
- dark: {
26
- backgroundColor: string;
27
- }
28
- }
29
- };
30
- note?: string;
31
- hack: SparkHack;
32
- baseLocaleHackId: string;
33
- locale: SupportedLocale;
34
- language: string;
35
- }
36
-
37
- export interface SparkedCard {
38
- id: string;
39
- markdown: string;
40
- segmentType: SegmentType;
41
- isTitle?: boolean;
42
- cardType?: CardType;
43
- }
44
-
45
- // matches Profile of EnrichedHack interface
46
- export type SparkHack = Pick<Hack,
47
- 'id'
48
- | 'title'
49
- | 'owner'
50
- | 'themeId'
51
- | 'isHidden'
52
- | 'editorialTags'
53
- | 'coverUrl'
54
- | 'topics'
55
- | 'type'
56
- | 'affiliate'
57
- | 'contributors'
58
- | 'createdAt'
59
- | 'updatedAt'
60
- | 'v'
61
- | 'sourceData'
62
- | 'subjects' >
63
- & {
64
- profile: Profile | ProfileMetadata;
65
- segments: Pick<Hack['segments'],
66
- 'inANutshell'
67
- | 'favouriteQuote'
68
- | 'introduction'
69
- | 'insights'
70
- | 'conclusion'
71
- | 'overview'
72
- | 'hereAreTheInsights'
73
- | 'putInAction'>;
74
- acl: string[]
75
- };
1
+ import { CardType, SegmentType } from '../segment/segment';
2
+ import { Profile, ProfileMetadata } from '../profile/profile';
3
+ import { SupportedLocale } from '../localisation/supported-locales';
4
+ import { ThemeTemplate } from '../theme/theme';
5
+ import { Hack } from '../hack/hack';
6
+
7
+ export interface Spark {
8
+ id: string;
9
+ v: number;
10
+ createdAt: string;
11
+ updatedAt: string;
12
+ userId: string;
13
+ hackId: string;
14
+ segmentId: string;
15
+ card: SparkedCard;
16
+ boardId: string;
17
+ theme: {
18
+ fontFamily: string;
19
+ light: ThemeTemplate;
20
+ dark: ThemeTemplate;
21
+ player?: {
22
+ light: {
23
+ backgroundColor: string;
24
+ },
25
+ dark: {
26
+ backgroundColor: string;
27
+ }
28
+ }
29
+ };
30
+ note?: string;
31
+ hack: SparkHack;
32
+ baseLocaleHackId: string;
33
+ locale: SupportedLocale;
34
+ language: string;
35
+ }
36
+
37
+ export interface SparkedCard {
38
+ id: string;
39
+ markdown: string;
40
+ segmentType: SegmentType;
41
+ isTitle?: boolean;
42
+ cardType?: CardType;
43
+ }
44
+
45
+ // matches Profile of EnrichedHack interface
46
+ export type SparkHack = Pick<Hack,
47
+ 'id'
48
+ | 'title'
49
+ | 'owner'
50
+ | 'themeId'
51
+ | 'isHidden'
52
+ | 'editorialTags'
53
+ | 'coverUrl'
54
+ | 'topics'
55
+ | 'type'
56
+ | 'affiliate'
57
+ | 'contributors'
58
+ | 'createdAt'
59
+ | 'updatedAt'
60
+ | 'v'
61
+ | 'sourceData'
62
+ | 'subjects' >
63
+ & {
64
+ profile: Profile | ProfileMetadata;
65
+ segments: Pick<Hack['segments'],
66
+ 'inANutshell'
67
+ | 'favouriteQuote'
68
+ | 'introduction'
69
+ | 'insights'
70
+ | 'conclusion'
71
+ | 'overview'
72
+ | 'hereAreTheInsights'
73
+ | 'putInAction'>;
74
+ acl: string[]
75
+ };
@@ -1,22 +1,22 @@
1
- import { TextSegment, Voice } from './text-segment';
2
-
3
- export interface CreateSpeechFromTextCommand {
4
- id: string;
5
- type: 'CreateSpeechFromText';
6
- payload: {
7
- locale: string;
8
- textSegments: TextSegment[];
9
- /** voices to generate. If omitted then all voices for the given locale will be generated */
10
- voiceIds?: string[]
11
- };
12
- }
13
-
14
- export interface CreateSpeechWithVoiceCommand {
15
- id: string;
16
- type: 'CreateSpeechWithVoice';
17
- payload: {
18
- locale: string;
19
- textSegments: TextSegment[];
20
- voice: Voice;
21
- };
22
- }
1
+ import { TextSegment, Voice } from './text-segment';
2
+
3
+ export interface CreateSpeechFromTextCommand {
4
+ id: string;
5
+ type: 'CreateSpeechFromText';
6
+ payload: {
7
+ locale: string;
8
+ textSegments: TextSegment[];
9
+ /** voices to generate. If omitted then all voices for the given locale will be generated */
10
+ voiceIds?: string[]
11
+ };
12
+ }
13
+
14
+ export interface CreateSpeechWithVoiceCommand {
15
+ id: string;
16
+ type: 'CreateSpeechWithVoice';
17
+ payload: {
18
+ locale: string;
19
+ textSegments: TextSegment[];
20
+ voice: Voice;
21
+ };
22
+ }
@@ -1,10 +1,10 @@
1
- import { TextSegmentWithSpeech } from './text-segment';
2
-
3
- export interface SpeechFromTextCreatedEvent {
4
- id: string;
5
- type: 'SpeechFromTextCreated';
6
- payload: {
7
- locale: string;
8
- textSegments: TextSegmentWithSpeech[];
9
- };
10
- }
1
+ import { TextSegmentWithSpeech } from './text-segment';
2
+
3
+ export interface SpeechFromTextCreatedEvent {
4
+ id: string;
5
+ type: 'SpeechFromTextCreated';
6
+ payload: {
7
+ locale: string;
8
+ textSegments: TextSegmentWithSpeech[];
9
+ };
10
+ }