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

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 (232) hide show
  1. package/dist/cjs/b2b-organisation/b2b-organisation-group-membership.d.ts +6 -0
  2. package/dist/cjs/b2b-organisation/b2b-organisation-group-membership.d.ts.map +1 -1
  3. package/dist/cjs/b2b-organisation/b2b-organisation-group-membership.js +6 -0
  4. package/dist/cjs/b2b-organisation/b2b-organisation-group-membership.js.map +1 -1
  5. package/dist/cjs/cms-hack/cms-searchable-hack.d.ts +0 -2
  6. package/dist/cjs/cms-hack/cms-searchable-hack.d.ts.map +1 -1
  7. package/dist/cjs/draft-hack/draft-hack.d.ts +0 -2
  8. package/dist/cjs/draft-hack/draft-hack.d.ts.map +1 -1
  9. package/dist/cjs/enriched-hack/enriched-hack.d.ts +0 -2
  10. package/dist/cjs/enriched-hack/enriched-hack.d.ts.map +1 -1
  11. package/dist/cjs/hack/hack.d.ts +0 -2
  12. package/dist/cjs/hack/hack.d.ts.map +1 -1
  13. package/dist/cjs/index.d.ts +0 -2
  14. package/dist/cjs/index.d.ts.map +1 -1
  15. package/dist/cjs/index.js +0 -2
  16. package/dist/cjs/index.js.map +1 -1
  17. package/dist/cjs/pending-hack/pending-hack.d.ts +0 -2
  18. package/dist/cjs/pending-hack/pending-hack.d.ts.map +1 -1
  19. package/dist/esm/b2b-organisation/b2b-organisation-group-membership.d.ts +6 -0
  20. package/dist/esm/b2b-organisation/b2b-organisation-group-membership.d.ts.map +1 -1
  21. package/dist/esm/b2b-organisation/b2b-organisation-group-membership.js +5 -1
  22. package/dist/esm/b2b-organisation/b2b-organisation-group-membership.js.map +1 -1
  23. package/dist/esm/cms-hack/cms-searchable-hack.d.ts +0 -2
  24. package/dist/esm/cms-hack/cms-searchable-hack.d.ts.map +1 -1
  25. package/dist/esm/draft-hack/draft-hack.d.ts +0 -2
  26. package/dist/esm/draft-hack/draft-hack.d.ts.map +1 -1
  27. package/dist/esm/enriched-hack/enriched-hack.d.ts +0 -2
  28. package/dist/esm/enriched-hack/enriched-hack.d.ts.map +1 -1
  29. package/dist/esm/hack/hack.d.ts +0 -2
  30. package/dist/esm/hack/hack.d.ts.map +1 -1
  31. package/dist/esm/index.d.ts +0 -2
  32. package/dist/esm/index.d.ts.map +1 -1
  33. package/dist/esm/index.js +0 -2
  34. package/dist/esm/index.js.map +1 -1
  35. package/dist/esm/pending-hack/pending-hack.d.ts +0 -2
  36. package/dist/esm/pending-hack/pending-hack.d.ts.map +1 -1
  37. package/package.json +2 -2
  38. package/src/access-control/collection-access-control.ts +28 -28
  39. package/src/access-control/hack-access-control.ts +32 -32
  40. package/src/access-control/profile-access-control.ts +27 -27
  41. package/src/app-hack/app-full-hack.ts +9 -9
  42. package/src/app-hack/app-hack-metadata.ts +61 -61
  43. package/src/app-hack/app-restricted-hack.ts +22 -22
  44. package/src/b2b-content-access/b2b-content-access.ts +57 -57
  45. package/src/b2b-organisation/b2b-carousel.ts +33 -33
  46. package/src/b2b-organisation/b2b-org-idp-mapping.ts +27 -27
  47. package/src/b2b-organisation/b2b-organisation-events.ts +21 -21
  48. package/src/b2b-organisation/b2b-organisation-group-events.ts +21 -21
  49. package/src/b2b-organisation/b2b-organisation-group-membership-events.ts +21 -21
  50. package/src/b2b-organisation/b2b-organisation-group-membership.ts +17 -10
  51. package/src/b2b-organisation/b2b-organisation-group.ts +65 -65
  52. package/src/b2b-organisation/b2b-organisation-invitation.ts +45 -45
  53. package/src/b2b-organisation/b2b-organisation-member-events.ts +21 -21
  54. package/src/b2b-organisation/b2b-organisation-member.ts +19 -19
  55. package/src/b2b-organisation/b2b-organisation.ts +38 -38
  56. package/src/brand/brand-events.ts +21 -21
  57. package/src/brand/brand.ts +77 -77
  58. package/src/catalogue/catalogue.ts +152 -152
  59. package/src/cms-hack/cms-searchable-hack.ts +44 -47
  60. package/src/collection/collection-events.ts +21 -21
  61. package/src/collection/collection.ts +59 -59
  62. package/src/collection/enriched-collection-events.ts +18 -18
  63. package/src/collection/enriched-collection.ts +65 -65
  64. package/src/course/course-events.ts +20 -20
  65. package/src/course/course.ts +25 -25
  66. package/src/course-enrollment/course-enrollment-events.ts +21 -21
  67. package/src/course-enrollment/course-enrollment.ts +36 -36
  68. package/src/creator/creator-events.ts +32 -32
  69. package/src/creator/creator.ts +7 -7
  70. package/src/distribution/collection-distribution.ts +17 -17
  71. package/src/distribution/distribution-events.ts +61 -61
  72. package/src/distribution/hack-distribution.ts +18 -18
  73. package/src/draft-hack/draft-hack-events.ts +21 -21
  74. package/src/draft-hack/draft-hack.ts +190 -192
  75. package/src/draft-hack-generation/draft-hack-generation-commands.ts +10 -10
  76. package/src/draft-hack-generation/draft-hack-generation-events.ts +52 -52
  77. package/src/draft-hack-generation/draft-hack-generation.ts +39 -39
  78. package/src/enriched-b2b-organisation/enriched-b2b-organisation-events.ts +21 -21
  79. package/src/enriched-b2b-organisation/enriched-b2b-organisation.ts +37 -37
  80. package/src/enriched-hack/enriched-hack-events.ts +21 -21
  81. package/src/enriched-hack/enriched-hack.ts +109 -111
  82. package/src/enrichment-asset/hack-enrichment-video-events.ts +55 -55
  83. package/src/enrichment-asset/hack-enrichment-video.ts +40 -40
  84. package/src/entitlement/user-entitlements-commands.ts +54 -54
  85. package/src/entitlement/user-entitlements-events.ts +29 -29
  86. package/src/entitlement/user-entitlements.ts +18 -18
  87. package/src/flashcard/flashcard-events.ts +85 -85
  88. package/src/flashcard/flashcard.ts +138 -138
  89. package/src/hack/extracted-subject.ts +31 -31
  90. package/src/hack/hack-events.ts +21 -21
  91. package/src/hack/hack-published.ts +21 -21
  92. package/src/hack/hack-with-voice-events.ts +20 -20
  93. package/src/hack/hack-with-voice.ts +36 -36
  94. package/src/hack/hack.ts +127 -129
  95. package/src/hack/publish-hack-command.ts +20 -20
  96. package/src/hack/republish-hack-command.ts +20 -20
  97. package/src/hack-mapping/access-helper.ts +6 -6
  98. package/src/hack-mapping/app-full-hack.test.ts +13 -13
  99. package/src/hack-mapping/app-full-hack.ts +14 -14
  100. package/src/hack-mapping/app-hack-metadata.test.ts +22 -22
  101. package/src/hack-mapping/app-hack-metadata.ts +82 -82
  102. package/src/hack-mapping/app-restricted-hack.test.ts +12 -12
  103. package/src/hack-mapping/app-restricted-hack.ts +21 -21
  104. package/src/hack-mapping/remove-undefined-fields.ts +9 -9
  105. package/src/hack-mapping/test-data/enriched-hack.json +2576 -2576
  106. package/src/hack-mapping/test-data/expected-app-full-hack.json +2509 -2509
  107. package/src/hack-mapping/test-data/expected-app-hack-metadata.json +93 -93
  108. package/src/hack-mapping/test-data/expected-app-restricted-hack.json +799 -799
  109. package/src/hack-metadata/hack-metadata-events.ts +21 -21
  110. package/src/hack-metadata/hack-metadata.ts +17 -17
  111. package/src/hack-of-the-day/hack-of-the-day-events.ts +21 -21
  112. package/src/hack-of-the-day/hack-of-the-day.ts +13 -13
  113. package/src/hack-statistics/hack-statistics-events.ts +21 -21
  114. package/src/hack-statistics/hack-statistics.ts +9 -9
  115. package/src/hackbot/hack-generation-commands.ts +45 -45
  116. package/src/hackbot/hack-generation-trigger-events.ts +21 -21
  117. package/src/hackbot/hack-generation-trigger.ts +57 -57
  118. package/src/history/history-events.ts +21 -21
  119. package/src/history/history.ts +46 -46
  120. package/src/identity-provider/domain-identity-provider-events.ts +20 -20
  121. package/src/identity-provider/domain-identity-provider.ts +10 -10
  122. package/src/identity-provider/identity-provider-events.ts +20 -20
  123. package/src/identity-provider/identity-provider.ts +46 -46
  124. package/src/index.ts +220 -223
  125. package/src/interest/interest-events.ts +21 -21
  126. package/src/interest/interest.ts +15 -15
  127. package/src/knowledge-source/knowledge-source-events.ts +21 -21
  128. package/src/knowledge-source/knowledge-source.ts +43 -43
  129. package/src/knowledge-source-parsing/knowledge-source-metadata.ts +58 -58
  130. package/src/knowledge-source-parsing/knowledge-source-parsing-commands.ts +41 -41
  131. package/src/knowledge-source-parsing/knowledge-source-parsing-events.ts +30 -30
  132. package/src/knowledge-source-parsing/podcast-metadata.ts +44 -44
  133. package/src/knowledge-source-parsing/podcast-parsing-events.ts +28 -28
  134. package/src/knowledge-source-parsing/user-hack-generation-options.ts +7 -7
  135. package/src/learn-upon/get-sqsso-url.ts +13 -13
  136. package/src/learn-upon/learn-upon-commands.ts +33 -33
  137. package/src/learn-upon/learn-upon-course-enrollment-events.ts +21 -21
  138. package/src/learn-upon/learn-upon-course-enrollment.ts +62 -62
  139. package/src/learn-upon/learn-upon-course-events.ts +21 -21
  140. package/src/learn-upon/learn-upon-course.ts +108 -108
  141. package/src/learn-upon/learn-upon-portal-events.ts +20 -20
  142. package/src/learn-upon/learn-upon-portal.ts +12 -12
  143. package/src/learn-upon/learn-upon-user-mapping-events.ts +18 -18
  144. package/src/learn-upon/learn-upon-user-mapping.ts +9 -9
  145. package/src/learn-upon/learn-upon-webhook-events.ts +80 -80
  146. package/src/learn-upon/learn-upon-webhook-types.ts +346 -346
  147. package/src/learn-upon/unenroll.ts +6 -6
  148. package/src/localisation/live-locales.ts +45 -45
  149. package/src/localisation/locale-language.ts +4 -4
  150. package/src/localisation/supported-languages.ts +11 -11
  151. package/src/localisation/supported-locales.ts +67 -67
  152. package/src/message-bus/context.ts +7 -7
  153. package/src/moderation/hack-moderation-result-events.ts +18 -18
  154. package/src/moderation/hack-moderation-result.ts +27 -27
  155. package/src/partner/partner-events.ts +21 -21
  156. package/src/partner/partner.ts +7 -7
  157. package/src/pending-hack/pending-hack-events.ts +20 -20
  158. package/src/pending-hack/pending-hack-with-voice-events.ts +20 -20
  159. package/src/pending-hack/pending-hack-with-voice.ts +25 -25
  160. package/src/pending-hack/pending-hack.ts +78 -80
  161. package/src/preferences/preferences-events.ts +15 -15
  162. package/src/preferences/preferences.ts +35 -35
  163. package/src/profile/profile-events.ts +41 -41
  164. package/src/profile/profile.ts +36 -36
  165. package/src/profile/translated-profile.ts +13 -13
  166. package/src/referral/referral-events.ts +41 -41
  167. package/src/referral/referral.ts +76 -76
  168. package/src/saved/saved-collection-events.ts +19 -19
  169. package/src/saved/saved-collection.ts +8 -8
  170. package/src/segment/segment-commands.ts +75 -75
  171. package/src/segment/segment-events.ts +42 -42
  172. package/src/segment/segment-with-voice.ts +8 -8
  173. package/src/segment/segment.ts +82 -82
  174. package/src/service-simulator/mock-request-response.ts +17 -17
  175. package/src/skin/skin-events.ts +21 -21
  176. package/src/skin/skin.ts +6 -6
  177. package/src/spark/spark-board-read-model.ts +17 -17
  178. package/src/spark/spark-board.ts +12 -12
  179. package/src/spark/spark-events.ts +42 -42
  180. package/src/spark/spark.ts +75 -75
  181. package/src/text-analysis/hack-categories-extracted-events.ts +24 -24
  182. package/src/text-analysis/hack-categories-extracted.ts +31 -31
  183. package/src/text-analysis/hack-entities-extracted-events.ts +24 -24
  184. package/src/text-analysis/hack-entities-extracted.ts +38 -38
  185. package/src/text-analysis/hack-keywords-extracted-events.ts +24 -24
  186. package/src/text-analysis/hack-keywords-extracted.ts +23 -23
  187. package/src/text-analysis/hack-topics-extracted-events.ts +24 -24
  188. package/src/text-analysis/hack-topics-extracted.ts +31 -31
  189. package/src/text-to-speech/create-speech-commands.ts +22 -22
  190. package/src/text-to-speech/speech-created-events.ts +10 -10
  191. package/src/text-to-speech/supported-voices.ts +222 -222
  192. package/src/text-to-speech/text-segment.ts +29 -29
  193. package/src/theme/theme-events.ts +21 -21
  194. package/src/theme/theme.ts +68 -68
  195. package/src/translation/translation-events.ts +73 -73
  196. package/src/translation/translation.ts +25 -25
  197. package/src/trending/trending-events.ts +21 -21
  198. package/src/trending/trending-hacks.ts +8 -8
  199. package/src/user/cognito-user-authentication-log.ts +7 -7
  200. package/src/user/get-user.ts +63 -63
  201. package/src/user/user-events.ts +39 -39
  202. package/src/user-acl/user-acl-utils.test.ts +273 -273
  203. package/src/user-acl/user-acl-utils.ts +176 -176
  204. package/src/user-context/user-context-events.ts +21 -21
  205. package/src/user-context/user-context.ts +15 -15
  206. package/src/user-notification-context/user-notification-context-events.ts +21 -21
  207. package/src/user-notification-context/user-notification-context.ts +9 -9
  208. package/src/user-statistics/user-statistics-events.ts +97 -97
  209. package/src/user-statistics/user-statistics.ts +82 -82
  210. package/src/video-cropping/video-cropping-events.ts +43 -43
  211. package/src/video-cropping/video-metadata.ts +12 -12
  212. package/tsconfig.cjs.json +7 -7
  213. package/tsconfig.npm.json +22 -22
  214. package/dist/cjs/topics/primary-topic-mapping.d.ts +0 -7
  215. package/dist/cjs/topics/primary-topic-mapping.d.ts.map +0 -1
  216. package/dist/cjs/topics/primary-topic-mapping.js +0 -98
  217. package/dist/cjs/topics/primary-topic-mapping.js.map +0 -1
  218. package/dist/cjs/topics/primary-topic.d.ts +0 -4
  219. package/dist/cjs/topics/primary-topic.d.ts.map +0 -1
  220. package/dist/cjs/topics/primary-topic.js +0 -3
  221. package/dist/cjs/topics/primary-topic.js.map +0 -1
  222. package/dist/esm/topics/primary-topic-mapping.d.ts +0 -7
  223. package/dist/esm/topics/primary-topic-mapping.d.ts.map +0 -1
  224. package/dist/esm/topics/primary-topic-mapping.js +0 -94
  225. package/dist/esm/topics/primary-topic-mapping.js.map +0 -1
  226. package/dist/esm/topics/primary-topic.d.ts +0 -4
  227. package/dist/esm/topics/primary-topic.d.ts.map +0 -1
  228. package/dist/esm/topics/primary-topic.js +0 -2
  229. package/dist/esm/topics/primary-topic.js.map +0 -1
  230. package/src/topics/primary-topic-mapping.test.ts +0 -36
  231. package/src/topics/primary-topic-mapping.ts +0 -110
  232. package/src/topics/primary-topic.ts +0 -3
@@ -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,24 +1,24 @@
1
- import { HackCategoriesExtracted } from './hack-categories-extracted';
2
-
3
- export interface HackCategoriesExtractedCreatedEvent {
4
- id: string;
5
- type: 'HackCategoriesExtractedCreated';
6
- payload: HackCategoriesExtracted;
7
- }
8
-
9
- export interface HackCategoriesExtractedUpdatedEvent {
10
- id: string;
11
- type: 'HackCategoriesExtractedUpdated';
12
- payload: HackCategoriesExtracted;
13
- }
14
-
15
- export interface HackCategoriesExtractedDeletedEvent {
16
- id: string;
17
- type: 'HackCategoriesExtractedDeleted';
18
- payload: HackCategoriesExtracted;
19
- }
20
-
21
- export type HackCategoriesExtractedChangedEvent =
22
- | HackCategoriesExtractedCreatedEvent
23
- | HackCategoriesExtractedUpdatedEvent
24
- | HackCategoriesExtractedDeletedEvent;
1
+ import { HackCategoriesExtracted } from './hack-categories-extracted';
2
+
3
+ export interface HackCategoriesExtractedCreatedEvent {
4
+ id: string;
5
+ type: 'HackCategoriesExtractedCreated';
6
+ payload: HackCategoriesExtracted;
7
+ }
8
+
9
+ export interface HackCategoriesExtractedUpdatedEvent {
10
+ id: string;
11
+ type: 'HackCategoriesExtractedUpdated';
12
+ payload: HackCategoriesExtracted;
13
+ }
14
+
15
+ export interface HackCategoriesExtractedDeletedEvent {
16
+ id: string;
17
+ type: 'HackCategoriesExtractedDeleted';
18
+ payload: HackCategoriesExtracted;
19
+ }
20
+
21
+ export type HackCategoriesExtractedChangedEvent =
22
+ | HackCategoriesExtractedCreatedEvent
23
+ | HackCategoriesExtractedUpdatedEvent
24
+ | HackCategoriesExtractedDeletedEvent;
@@ -1,31 +1,31 @@
1
- // https://www.textrazor.com/docs/rest#ScoredCategory
2
- export interface CategoryExtracted {
3
- categoryId: string;
4
- classifierId: string;
5
- label: string;
6
- score: number;
7
- }
8
-
9
- export interface SegmentCategoriesExtracted {
10
- hash: number;
11
- categories: CategoryExtracted[]
12
- }
13
-
14
- export interface HackCategoriesExtracted {
15
- id: string;
16
- v: number;
17
- createdAt: string;
18
- updatedAt: string;
19
- hackId: string;
20
- hackVersion: number;
21
- segments: {
22
- favouriteQuote: SegmentCategoriesExtracted;
23
- inANutshell: SegmentCategoriesExtracted;
24
- introduction: SegmentCategoriesExtracted;
25
- insights: SegmentCategoriesExtracted[];
26
- conclusion: SegmentCategoriesExtracted;
27
- overview: SegmentCategoriesExtracted;
28
- hereAreTheInsights: SegmentCategoriesExtracted;
29
- putInAction?: SegmentCategoriesExtracted;
30
- }
31
- }
1
+ // https://www.textrazor.com/docs/rest#ScoredCategory
2
+ export interface CategoryExtracted {
3
+ categoryId: string;
4
+ classifierId: string;
5
+ label: string;
6
+ score: number;
7
+ }
8
+
9
+ export interface SegmentCategoriesExtracted {
10
+ hash: number;
11
+ categories: CategoryExtracted[]
12
+ }
13
+
14
+ export interface HackCategoriesExtracted {
15
+ id: string;
16
+ v: number;
17
+ createdAt: string;
18
+ updatedAt: string;
19
+ hackId: string;
20
+ hackVersion: number;
21
+ segments: {
22
+ favouriteQuote: SegmentCategoriesExtracted;
23
+ inANutshell: SegmentCategoriesExtracted;
24
+ introduction: SegmentCategoriesExtracted;
25
+ insights: SegmentCategoriesExtracted[];
26
+ conclusion: SegmentCategoriesExtracted;
27
+ overview: SegmentCategoriesExtracted;
28
+ hereAreTheInsights: SegmentCategoriesExtracted;
29
+ putInAction?: SegmentCategoriesExtracted;
30
+ }
31
+ }
@@ -1,24 +1,24 @@
1
- import { HackEntitiesExtracted } from './hack-entities-extracted';
2
-
3
- export interface HackEntitiesExtractedCreatedEvent {
4
- id: string;
5
- type: 'HackEntitiesExtractedCreated';
6
- payload: HackEntitiesExtracted;
7
- }
8
-
9
- export interface HackEntitiesExtractedUpdatedEvent {
10
- id: string;
11
- type: 'HackEntitiesExtractedUpdated';
12
- payload: HackEntitiesExtracted;
13
- }
14
-
15
- export interface HackEntitiesExtractedDeletedEvent {
16
- id: string;
17
- type: 'HackEntitiesExtractedDeleted';
18
- payload: HackEntitiesExtracted;
19
- }
20
-
21
- export type HackEntitiesExtractedChangedEvent =
22
- | HackEntitiesExtractedCreatedEvent
23
- | HackEntitiesExtractedUpdatedEvent
24
- | HackEntitiesExtractedDeletedEvent;
1
+ import { HackEntitiesExtracted } from './hack-entities-extracted';
2
+
3
+ export interface HackEntitiesExtractedCreatedEvent {
4
+ id: string;
5
+ type: 'HackEntitiesExtractedCreated';
6
+ payload: HackEntitiesExtracted;
7
+ }
8
+
9
+ export interface HackEntitiesExtractedUpdatedEvent {
10
+ id: string;
11
+ type: 'HackEntitiesExtractedUpdated';
12
+ payload: HackEntitiesExtracted;
13
+ }
14
+
15
+ export interface HackEntitiesExtractedDeletedEvent {
16
+ id: string;
17
+ type: 'HackEntitiesExtractedDeleted';
18
+ payload: HackEntitiesExtracted;
19
+ }
20
+
21
+ export type HackEntitiesExtractedChangedEvent =
22
+ | HackEntitiesExtractedCreatedEvent
23
+ | HackEntitiesExtractedUpdatedEvent
24
+ | HackEntitiesExtractedDeletedEvent;
@@ -1,38 +1,38 @@
1
- // https://www.textrazor.com/docs/rest#Entity
2
- export interface EntityExtracted {
3
- entityId?: string;
4
- type: string[];
5
- confidenceScore: number;
6
- relevanceScore: number;
7
- wikidataId?: string;
8
- wikiLink?: string;
9
- matchedText: string;
10
- matchingTokens: string[];
11
- // not included in their docs but we get these back
12
- startingPos: number;
13
- endingPos: number;
14
- }
15
-
16
- export interface SegmentEntitiesExtracted {
17
- hash: number;
18
- entities: EntityExtracted[]
19
- }
20
-
21
- export interface HackEntitiesExtracted {
22
- id: string;
23
- v: number;
24
- createdAt: string;
25
- updatedAt: string;
26
- hackId: string;
27
- hackVersion: number;
28
- segments: {
29
- favouriteQuote: SegmentEntitiesExtracted;
30
- inANutshell: SegmentEntitiesExtracted;
31
- introduction: SegmentEntitiesExtracted;
32
- insights: SegmentEntitiesExtracted[];
33
- conclusion: SegmentEntitiesExtracted;
34
- overview: SegmentEntitiesExtracted;
35
- hereAreTheInsights: SegmentEntitiesExtracted;
36
- putInAction?: SegmentEntitiesExtracted;
37
- }
38
- }
1
+ // https://www.textrazor.com/docs/rest#Entity
2
+ export interface EntityExtracted {
3
+ entityId?: string;
4
+ type: string[];
5
+ confidenceScore: number;
6
+ relevanceScore: number;
7
+ wikidataId?: string;
8
+ wikiLink?: string;
9
+ matchedText: string;
10
+ matchingTokens: string[];
11
+ // not included in their docs but we get these back
12
+ startingPos: number;
13
+ endingPos: number;
14
+ }
15
+
16
+ export interface SegmentEntitiesExtracted {
17
+ hash: number;
18
+ entities: EntityExtracted[]
19
+ }
20
+
21
+ export interface HackEntitiesExtracted {
22
+ id: string;
23
+ v: number;
24
+ createdAt: string;
25
+ updatedAt: string;
26
+ hackId: string;
27
+ hackVersion: number;
28
+ segments: {
29
+ favouriteQuote: SegmentEntitiesExtracted;
30
+ inANutshell: SegmentEntitiesExtracted;
31
+ introduction: SegmentEntitiesExtracted;
32
+ insights: SegmentEntitiesExtracted[];
33
+ conclusion: SegmentEntitiesExtracted;
34
+ overview: SegmentEntitiesExtracted;
35
+ hereAreTheInsights: SegmentEntitiesExtracted;
36
+ putInAction?: SegmentEntitiesExtracted;
37
+ }
38
+ }
@@ -1,24 +1,24 @@
1
- import { HackKeywordsExtracted } from './hack-keywords-extracted';
2
-
3
- export interface HackKeywordsExtractedCreatedEvent {
4
- id: string;
5
- type: 'HackKeywordsExtractedCreated';
6
- payload: HackKeywordsExtracted;
7
- }
8
-
9
- export interface HackKeywordsExtractedUpdatedEvent {
10
- id: string;
11
- type: 'HackKeywordsExtractedUpdated';
12
- payload: HackKeywordsExtracted;
13
- }
14
-
15
- export interface HackKeywordsExtractedDeletedEvent {
16
- id: string;
17
- type: 'HackKeywordsExtractedDeleted';
18
- payload: HackKeywordsExtracted;
19
- }
20
-
21
- export type HackKeywordsExtractedChangedEvent =
22
- | HackKeywordsExtractedCreatedEvent
23
- | HackKeywordsExtractedUpdatedEvent
24
- | HackKeywordsExtractedDeletedEvent;
1
+ import { HackKeywordsExtracted } from './hack-keywords-extracted';
2
+
3
+ export interface HackKeywordsExtractedCreatedEvent {
4
+ id: string;
5
+ type: 'HackKeywordsExtractedCreated';
6
+ payload: HackKeywordsExtracted;
7
+ }
8
+
9
+ export interface HackKeywordsExtractedUpdatedEvent {
10
+ id: string;
11
+ type: 'HackKeywordsExtractedUpdated';
12
+ payload: HackKeywordsExtracted;
13
+ }
14
+
15
+ export interface HackKeywordsExtractedDeletedEvent {
16
+ id: string;
17
+ type: 'HackKeywordsExtractedDeleted';
18
+ payload: HackKeywordsExtracted;
19
+ }
20
+
21
+ export type HackKeywordsExtractedChangedEvent =
22
+ | HackKeywordsExtractedCreatedEvent
23
+ | HackKeywordsExtractedUpdatedEvent
24
+ | HackKeywordsExtractedDeletedEvent;