@uptime.app/contracts 2.0.16-rc.1 → 2.0.17

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 (142) hide show
  1. package/dist/cjs/enriched-hack/enriched-hack.d.ts +1 -0
  2. package/dist/cjs/enriched-hack/enriched-hack.d.ts.map +1 -1
  3. package/dist/cjs/hack/hack.d.ts +1 -0
  4. package/dist/cjs/hack/hack.d.ts.map +1 -1
  5. package/dist/cjs/pending-hack/pending-hack.d.ts +1 -0
  6. package/dist/cjs/pending-hack/pending-hack.d.ts.map +1 -1
  7. package/dist/cjs/text-to-speech/supported-voices.d.ts.map +1 -1
  8. package/dist/cjs/text-to-speech/supported-voices.js +8 -8
  9. package/dist/cjs/text-to-speech/supported-voices.js.map +1 -1
  10. package/dist/esm/enriched-hack/enriched-hack.d.ts +1 -0
  11. package/dist/esm/enriched-hack/enriched-hack.d.ts.map +1 -1
  12. package/dist/esm/hack/hack.d.ts +1 -0
  13. package/dist/esm/hack/hack.d.ts.map +1 -1
  14. package/dist/esm/pending-hack/pending-hack.d.ts +1 -0
  15. package/dist/esm/pending-hack/pending-hack.d.ts.map +1 -1
  16. package/dist/esm/text-to-speech/supported-voices.d.ts.map +1 -1
  17. package/dist/esm/text-to-speech/supported-voices.js +8 -8
  18. package/dist/esm/text-to-speech/supported-voices.js.map +1 -1
  19. package/package.json +2 -2
  20. package/src/access-control/collection-access-control.ts +28 -28
  21. package/src/access-control/hack-access-control.ts +29 -29
  22. package/src/access-control/profile-access-control.ts +27 -27
  23. package/src/app-hack/app-full-hack.ts +9 -9
  24. package/src/app-hack/app-hack-metadata.ts +60 -60
  25. package/src/app-hack/app-restricted-hack.ts +22 -22
  26. package/src/b2b-content-access/b2b-content-access.ts +57 -57
  27. package/src/b2b-organisation/b2b-carousel.ts +33 -33
  28. package/src/b2b-organisation/b2b-organisation-events.ts +21 -21
  29. package/src/b2b-organisation/b2b-organisation-invitation.ts +45 -45
  30. package/src/b2b-organisation/b2b-organisation-member-events.ts +21 -21
  31. package/src/b2b-organisation/b2b-organisation-member.ts +10 -10
  32. package/src/b2b-organisation/b2b-organisation.ts +32 -32
  33. package/src/brand/brand-events.ts +21 -21
  34. package/src/brand/brand.ts +26 -26
  35. package/src/catalogue/catalogue.ts +147 -147
  36. package/src/cms-hack/cms-searchable-hack.ts +44 -44
  37. package/src/collection/collection-events.ts +21 -21
  38. package/src/collection/collection.ts +57 -57
  39. package/src/collection/enriched-collection-events.ts +18 -18
  40. package/src/collection/enriched-collection.ts +64 -64
  41. package/src/creator/creator-events.ts +32 -32
  42. package/src/creator/creator.ts +7 -7
  43. package/src/distribution/collection-distribution.ts +17 -17
  44. package/src/distribution/distribution-events.ts +61 -61
  45. package/src/distribution/hack-distribution.ts +18 -18
  46. package/src/draft-hack/draft-hack-events.ts +21 -21
  47. package/src/draft-hack/draft-hack.ts +190 -190
  48. package/src/draft-hack-generation/draft-hack-generation-commands.ts +10 -10
  49. package/src/draft-hack-generation/draft-hack-generation-events.ts +52 -52
  50. package/src/draft-hack-generation/draft-hack-generation.ts +39 -39
  51. package/src/enriched-hack/enriched-hack-events.ts +21 -21
  52. package/src/enriched-hack/enriched-hack.ts +104 -103
  53. package/src/enrichment-asset/hack-enrichment-video-events.ts +55 -55
  54. package/src/enrichment-asset/hack-enrichment-video.ts +40 -40
  55. package/src/entitlement/user-entitlements-commands.ts +54 -54
  56. package/src/entitlement/user-entitlements-events.ts +29 -29
  57. package/src/entitlement/user-entitlements.ts +18 -18
  58. package/src/flashcard/flashcard-events.ts +85 -85
  59. package/src/flashcard/flashcard.ts +138 -138
  60. package/src/hack/extracted-subject.ts +31 -31
  61. package/src/hack/hack-events.ts +21 -21
  62. package/src/hack/hack-published.ts +21 -21
  63. package/src/hack/hack-with-voice-events.ts +20 -20
  64. package/src/hack/hack-with-voice.ts +33 -33
  65. package/src/hack/hack.ts +117 -116
  66. package/src/hack/publish-hack-command.ts +20 -20
  67. package/src/hack-metadata/hack-metadata-events.ts +21 -21
  68. package/src/hack-metadata/hack-metadata.ts +17 -17
  69. package/src/hack-of-the-day/hack-of-the-day-events.ts +21 -21
  70. package/src/hack-of-the-day/hack-of-the-day.ts +13 -13
  71. package/src/hack-statistics/hack-statistics-events.ts +21 -21
  72. package/src/hack-statistics/hack-statistics.ts +9 -9
  73. package/src/hackbot/hack-generation-commands.ts +42 -42
  74. package/src/hackbot/hack-generation-trigger-events.ts +21 -21
  75. package/src/hackbot/hack-generation-trigger.ts +54 -54
  76. package/src/history/history-events.ts +21 -21
  77. package/src/history/history.ts +46 -46
  78. package/src/index.ts +166 -166
  79. package/src/interest/interest-events.ts +21 -21
  80. package/src/interest/interest.ts +15 -15
  81. package/src/knowledge-source/knowledge-source-events.ts +21 -21
  82. package/src/knowledge-source/knowledge-source.ts +43 -43
  83. package/src/knowledge-source-parsing/knowledge-source-metadata.ts +51 -51
  84. package/src/knowledge-source-parsing/knowledge-source-parsing-commands.ts +41 -41
  85. package/src/knowledge-source-parsing/knowledge-source-parsing-events.ts +30 -30
  86. package/src/knowledge-source-parsing/podcast-metadata.ts +44 -44
  87. package/src/knowledge-source-parsing/podcast-parsing-events.ts +28 -28
  88. package/src/knowledge-source-parsing/user-hack-generation-options.ts +6 -6
  89. package/src/localisation/live-locales.ts +45 -45
  90. package/src/localisation/locale-language.ts +4 -4
  91. package/src/localisation/supported-languages.ts +11 -11
  92. package/src/localisation/supported-locales.ts +67 -67
  93. package/src/message-bus/Context.ts +7 -7
  94. package/src/moderation/hack-moderation-result-events.ts +18 -18
  95. package/src/moderation/hack-moderation-result.ts +27 -27
  96. package/src/partner/partner-events.ts +21 -21
  97. package/src/partner/partner.ts +7 -7
  98. package/src/pending-hack/pending-hack-events.ts +20 -20
  99. package/src/pending-hack/pending-hack-with-voice-events.ts +20 -20
  100. package/src/pending-hack/pending-hack-with-voice.ts +25 -25
  101. package/src/pending-hack/pending-hack.ts +78 -77
  102. package/src/preferences/preferences-events.ts +15 -15
  103. package/src/preferences/preferences.ts +35 -35
  104. package/src/profile/profile-events.ts +41 -41
  105. package/src/profile/profile.ts +29 -29
  106. package/src/profile/translated-profile.ts +13 -13
  107. package/src/referral/referral-events.ts +41 -41
  108. package/src/referral/referral.ts +76 -76
  109. package/src/saved/saved-collection-events.ts +19 -19
  110. package/src/saved/saved-collection.ts +8 -8
  111. package/src/segment/segment-commands.ts +75 -75
  112. package/src/segment/segment-events.ts +42 -42
  113. package/src/segment/segment-with-voice.ts +8 -8
  114. package/src/segment/segment.ts +82 -82
  115. package/src/skin/skin-events.ts +21 -21
  116. package/src/skin/skin.ts +6 -6
  117. package/src/spark/spark-board-read-model.ts +17 -17
  118. package/src/spark/spark-board.ts +12 -12
  119. package/src/spark/spark-events.ts +42 -42
  120. package/src/spark/spark.ts +80 -80
  121. package/src/text-to-speech/create-speech-commands.ts +22 -22
  122. package/src/text-to-speech/speech-created-events.ts +10 -10
  123. package/src/text-to-speech/supported-voices.ts +184 -183
  124. package/src/text-to-speech/text-segment.ts +29 -29
  125. package/src/theme/theme-events.ts +21 -21
  126. package/src/theme/theme.ts +68 -68
  127. package/src/translation/translation-events.ts +73 -73
  128. package/src/translation/translation.ts +25 -25
  129. package/src/trending/trending-events.ts +21 -21
  130. package/src/trending/trending-hacks.ts +8 -8
  131. package/src/user/get-user.ts +30 -30
  132. package/src/user/user-events.ts +26 -26
  133. package/src/user-context/user-context-events.ts +21 -21
  134. package/src/user-context/user-context.ts +15 -15
  135. package/src/user-notification-context/user-notification-context-events.ts +21 -21
  136. package/src/user-notification-context/user-notification-context.ts +9 -9
  137. package/src/user-statistics/user-statistics-events.ts +97 -97
  138. package/src/user-statistics/user-statistics.ts +82 -82
  139. package/src/video-cropping/video-cropping-events.ts +43 -43
  140. package/src/video-cropping/video-metadata.ts +12 -12
  141. package/tsconfig.cjs.json +7 -7
  142. package/tsconfig.npm.json +21 -21
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,80 +1,80 @@
1
- import { CardType, SegmentType } from '../segment/segment';
2
- import { Profile } 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
65
- | {
66
- deleted: boolean;
67
- uptimeOwned: boolean;
68
- avatarUrl: string;
69
- };
70
- segments: Pick<Hack['segments'],
71
- 'inANutshell'
72
- | 'favouriteQuote'
73
- | 'introduction'
74
- | 'insights'
75
- | 'conclusion'
76
- | 'overview'
77
- | 'hereAreTheInsights'
78
- | 'putInAction'>;
79
- acl: string[]
80
- };
1
+ import { CardType, SegmentType } from '../segment/segment';
2
+ import { Profile } 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
65
+ | {
66
+ deleted: boolean;
67
+ uptimeOwned: boolean;
68
+ avatarUrl: string;
69
+ };
70
+ segments: Pick<Hack['segments'],
71
+ 'inANutshell'
72
+ | 'favouriteQuote'
73
+ | 'introduction'
74
+ | 'insights'
75
+ | 'conclusion'
76
+ | 'overview'
77
+ | 'hereAreTheInsights'
78
+ | 'putInAction'>;
79
+ acl: string[]
80
+ };
@@ -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
+ }