@cratis/showrunner.playbill.react 0.0.0-stage → 2.19.0

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 (290) hide show
  1. package/Badge/PlaybillBadge.tsx +45 -0
  2. package/Badge/index.ts +4 -0
  3. package/Client/PlaybillClient.ts +78 -0
  4. package/Client/index.ts +5 -0
  5. package/Client/models.ts +64 -0
  6. package/Configuration/PlaybillProvider.tsx +38 -0
  7. package/Configuration/index.ts +4 -0
  8. package/Dialog/PlaybillDialog.tsx +83 -0
  9. package/Dialog/index.ts +4 -0
  10. package/Icons.tsx +14 -0
  11. package/Labels/PlaybillLabels.ts +46 -0
  12. package/Labels/defaultPlaybillLabels.ts +29 -0
  13. package/Labels/index.ts +6 -0
  14. package/Labels/resolveLabels.ts +20 -0
  15. package/Markdown/PlaybillLink.tsx +14 -0
  16. package/Markdown/PlaybillMarkdown.tsx +41 -0
  17. package/Markdown/assetUrl.ts +28 -0
  18. package/Markdown/index.ts +6 -0
  19. package/Markdown/safeLink.ts +25 -0
  20. package/Playbill.tsx +121 -0
  21. package/README.md +54 -2
  22. package/Release/ReleaseNoteView.tsx +79 -0
  23. package/Release/formatReleaseDate.ts +22 -0
  24. package/Release/index.ts +6 -0
  25. package/Release/sectionPresentation.ts +35 -0
  26. package/dist/cjs/Badge/PlaybillBadge.d.ts +10 -0
  27. package/dist/cjs/Badge/PlaybillBadge.d.ts.map +1 -0
  28. package/dist/cjs/Badge/PlaybillBadge.js +38 -0
  29. package/dist/cjs/Badge/PlaybillBadge.js.map +1 -0
  30. package/dist/cjs/Badge/index.d.ts +2 -0
  31. package/dist/cjs/Badge/index.d.ts.map +1 -0
  32. package/dist/cjs/Client/PlaybillClient.d.ts +13 -0
  33. package/dist/cjs/Client/PlaybillClient.d.ts.map +1 -0
  34. package/dist/cjs/Client/PlaybillClient.js +71 -0
  35. package/dist/cjs/Client/PlaybillClient.js.map +1 -0
  36. package/dist/cjs/Client/index.d.ts +3 -0
  37. package/dist/cjs/Client/index.d.ts.map +1 -0
  38. package/dist/cjs/Client/models.d.ts +27 -0
  39. package/dist/cjs/Client/models.d.ts.map +1 -0
  40. package/dist/cjs/Configuration/PlaybillProvider.d.ts +11 -0
  41. package/dist/cjs/Configuration/PlaybillProvider.d.ts.map +1 -0
  42. package/dist/cjs/Configuration/PlaybillProvider.js +30 -0
  43. package/dist/cjs/Configuration/PlaybillProvider.js.map +1 -0
  44. package/dist/cjs/Configuration/index.d.ts +2 -0
  45. package/dist/cjs/Configuration/index.d.ts.map +1 -0
  46. package/dist/cjs/Dialog/PlaybillDialog.d.ts +13 -0
  47. package/dist/cjs/Dialog/PlaybillDialog.d.ts.map +1 -0
  48. package/dist/cjs/Dialog/PlaybillDialog.js +79 -0
  49. package/dist/cjs/Dialog/PlaybillDialog.js.map +1 -0
  50. package/dist/cjs/Dialog/index.d.ts +2 -0
  51. package/dist/cjs/Dialog/index.d.ts.map +1 -0
  52. package/dist/cjs/Examples/AppShell.d.ts +5 -0
  53. package/dist/cjs/Examples/AppShell.d.ts.map +1 -0
  54. package/dist/cjs/Examples/LocalizedPlaybill.d.ts +2 -0
  55. package/dist/cjs/Examples/LocalizedPlaybill.d.ts.map +1 -0
  56. package/dist/cjs/Examples/OwnEndpoint.d.ts +2 -0
  57. package/dist/cjs/Examples/OwnEndpoint.d.ts.map +1 -0
  58. package/dist/cjs/Examples/OwnMarkdown.d.ts +2 -0
  59. package/dist/cjs/Examples/OwnMarkdown.d.ts.map +1 -0
  60. package/dist/cjs/Examples/OwnRelease.d.ts +2 -0
  61. package/dist/cjs/Examples/OwnRelease.d.ts.map +1 -0
  62. package/dist/cjs/Examples/OwnSurface.d.ts +2 -0
  63. package/dist/cjs/Examples/OwnSurface.d.ts.map +1 -0
  64. package/dist/cjs/Examples/ReleaseNotesPage.d.ts +2 -0
  65. package/dist/cjs/Examples/ReleaseNotesPage.d.ts.map +1 -0
  66. package/dist/cjs/Icons.d.ts +2 -0
  67. package/dist/cjs/Icons.d.ts.map +1 -0
  68. package/dist/cjs/Icons.js +36 -0
  69. package/dist/cjs/Icons.js.map +1 -0
  70. package/dist/cjs/Labels/PlaybillLabels.d.ts +22 -0
  71. package/dist/cjs/Labels/PlaybillLabels.d.ts.map +1 -0
  72. package/dist/cjs/Labels/defaultPlaybillLabels.d.ts +3 -0
  73. package/dist/cjs/Labels/defaultPlaybillLabels.d.ts.map +1 -0
  74. package/dist/cjs/Labels/defaultPlaybillLabels.js +30 -0
  75. package/dist/cjs/Labels/defaultPlaybillLabels.js.map +1 -0
  76. package/dist/cjs/Labels/index.d.ts +4 -0
  77. package/dist/cjs/Labels/index.d.ts.map +1 -0
  78. package/dist/cjs/Labels/resolveLabels.d.ts +4 -0
  79. package/dist/cjs/Labels/resolveLabels.d.ts.map +1 -0
  80. package/dist/cjs/Labels/resolveLabels.js +24 -0
  81. package/dist/cjs/Labels/resolveLabels.js.map +1 -0
  82. package/dist/cjs/Markdown/PlaybillLink.d.ts +5 -0
  83. package/dist/cjs/Markdown/PlaybillLink.d.ts.map +1 -0
  84. package/dist/cjs/Markdown/PlaybillLink.js +21 -0
  85. package/dist/cjs/Markdown/PlaybillLink.js.map +1 -0
  86. package/dist/cjs/Markdown/PlaybillMarkdown.d.ts +7 -0
  87. package/dist/cjs/Markdown/PlaybillMarkdown.d.ts.map +1 -0
  88. package/dist/cjs/Markdown/PlaybillMarkdown.js +34 -0
  89. package/dist/cjs/Markdown/PlaybillMarkdown.js.map +1 -0
  90. package/dist/cjs/Markdown/assetUrl.d.ts +2 -0
  91. package/dist/cjs/Markdown/assetUrl.d.ts.map +1 -0
  92. package/dist/cjs/Markdown/assetUrl.js +29 -0
  93. package/dist/cjs/Markdown/assetUrl.js.map +1 -0
  94. package/dist/cjs/Markdown/index.d.ts +4 -0
  95. package/dist/cjs/Markdown/index.d.ts.map +1 -0
  96. package/dist/cjs/Markdown/safeLink.d.ts +3 -0
  97. package/dist/cjs/Markdown/safeLink.d.ts.map +1 -0
  98. package/dist/cjs/Markdown/safeLink.js +30 -0
  99. package/dist/cjs/Markdown/safeLink.js.map +1 -0
  100. package/dist/cjs/Playbill.d.ts +15 -0
  101. package/dist/cjs/Playbill.d.ts.map +1 -0
  102. package/dist/cjs/Playbill.js +135 -0
  103. package/dist/cjs/Playbill.js.map +1 -0
  104. package/dist/cjs/Release/ReleaseNoteView.d.ts +16 -0
  105. package/dist/cjs/Release/ReleaseNoteView.d.ts.map +1 -0
  106. package/dist/cjs/Release/ReleaseNoteView.js +75 -0
  107. package/dist/cjs/Release/ReleaseNoteView.js.map +1 -0
  108. package/dist/cjs/Release/formatReleaseDate.d.ts +2 -0
  109. package/dist/cjs/Release/formatReleaseDate.d.ts.map +1 -0
  110. package/dist/cjs/Release/formatReleaseDate.js +26 -0
  111. package/dist/cjs/Release/formatReleaseDate.js.map +1 -0
  112. package/dist/cjs/Release/index.d.ts +4 -0
  113. package/dist/cjs/Release/index.d.ts.map +1 -0
  114. package/dist/cjs/Release/sectionPresentation.d.ts +7 -0
  115. package/dist/cjs/Release/sectionPresentation.d.ts.map +1 -0
  116. package/dist/cjs/Release/sectionPresentation.js +31 -0
  117. package/dist/cjs/Release/sectionPresentation.js.map +1 -0
  118. package/dist/cjs/index.d.ts +13 -0
  119. package/dist/cjs/index.d.ts.map +1 -0
  120. package/dist/cjs/index.js +46 -0
  121. package/dist/cjs/index.js.map +1 -0
  122. package/dist/cjs/package.json +3 -0
  123. package/dist/cjs/useLoaded.d.ts +7 -0
  124. package/dist/cjs/useLoaded.d.ts.map +1 -0
  125. package/dist/cjs/useLoaded.js +45 -0
  126. package/dist/cjs/useLoaded.js.map +1 -0
  127. package/dist/cjs/usePlaybill.d.ts +5 -0
  128. package/dist/cjs/usePlaybill.d.ts.map +1 -0
  129. package/dist/cjs/usePlaybill.js +18 -0
  130. package/dist/cjs/usePlaybill.js.map +1 -0
  131. package/dist/cjs/usePlaybillStatus.d.ts +8 -0
  132. package/dist/cjs/usePlaybillStatus.d.ts.map +1 -0
  133. package/dist/cjs/usePlaybillStatus.js +34 -0
  134. package/dist/cjs/usePlaybillStatus.js.map +1 -0
  135. package/dist/cjs/useReleases.d.ts +12 -0
  136. package/dist/cjs/useReleases.d.ts.map +1 -0
  137. package/dist/cjs/useReleases.js +58 -0
  138. package/dist/cjs/useReleases.js.map +1 -0
  139. package/dist/esm/Badge/PlaybillBadge.d.ts +10 -0
  140. package/dist/esm/Badge/PlaybillBadge.d.ts.map +1 -0
  141. package/dist/esm/Badge/PlaybillBadge.js +36 -0
  142. package/dist/esm/Badge/PlaybillBadge.js.map +1 -0
  143. package/dist/esm/Badge/index.d.ts +2 -0
  144. package/dist/esm/Badge/index.d.ts.map +1 -0
  145. package/dist/esm/Badge/index.js +2 -0
  146. package/dist/esm/Badge/index.js.map +1 -0
  147. package/dist/esm/Client/PlaybillClient.d.ts +13 -0
  148. package/dist/esm/Client/PlaybillClient.d.ts.map +1 -0
  149. package/dist/esm/Client/PlaybillClient.js +68 -0
  150. package/dist/esm/Client/PlaybillClient.js.map +1 -0
  151. package/dist/esm/Client/index.d.ts +3 -0
  152. package/dist/esm/Client/index.d.ts.map +1 -0
  153. package/dist/esm/Client/index.js +3 -0
  154. package/dist/esm/Client/index.js.map +1 -0
  155. package/dist/esm/Client/models.d.ts +27 -0
  156. package/dist/esm/Client/models.d.ts.map +1 -0
  157. package/dist/esm/Client/models.js +2 -0
  158. package/dist/esm/Client/models.js.map +1 -0
  159. package/dist/esm/Configuration/PlaybillProvider.d.ts +11 -0
  160. package/dist/esm/Configuration/PlaybillProvider.d.ts.map +1 -0
  161. package/dist/esm/Configuration/PlaybillProvider.js +27 -0
  162. package/dist/esm/Configuration/PlaybillProvider.js.map +1 -0
  163. package/dist/esm/Configuration/index.d.ts +2 -0
  164. package/dist/esm/Configuration/index.d.ts.map +1 -0
  165. package/dist/esm/Configuration/index.js +2 -0
  166. package/dist/esm/Configuration/index.js.map +1 -0
  167. package/dist/esm/Dialog/PlaybillDialog.d.ts +13 -0
  168. package/dist/esm/Dialog/PlaybillDialog.d.ts.map +1 -0
  169. package/dist/esm/Dialog/PlaybillDialog.js +77 -0
  170. package/dist/esm/Dialog/PlaybillDialog.js.map +1 -0
  171. package/dist/esm/Dialog/index.d.ts +2 -0
  172. package/dist/esm/Dialog/index.d.ts.map +1 -0
  173. package/dist/esm/Dialog/index.js +2 -0
  174. package/dist/esm/Dialog/index.js.map +1 -0
  175. package/dist/esm/Examples/AppShell.d.ts +5 -0
  176. package/dist/esm/Examples/AppShell.d.ts.map +1 -0
  177. package/dist/esm/Examples/AppShell.js +6 -0
  178. package/dist/esm/Examples/AppShell.js.map +1 -0
  179. package/dist/esm/Examples/LocalizedPlaybill.d.ts +2 -0
  180. package/dist/esm/Examples/LocalizedPlaybill.d.ts.map +1 -0
  181. package/dist/esm/Examples/LocalizedPlaybill.js +13 -0
  182. package/dist/esm/Examples/LocalizedPlaybill.js.map +1 -0
  183. package/dist/esm/Examples/OwnEndpoint.d.ts +2 -0
  184. package/dist/esm/Examples/OwnEndpoint.d.ts.map +1 -0
  185. package/dist/esm/Examples/OwnEndpoint.js +8 -0
  186. package/dist/esm/Examples/OwnEndpoint.js.map +1 -0
  187. package/dist/esm/Examples/OwnMarkdown.d.ts +2 -0
  188. package/dist/esm/Examples/OwnMarkdown.d.ts.map +1 -0
  189. package/dist/esm/Examples/OwnMarkdown.js +5 -0
  190. package/dist/esm/Examples/OwnMarkdown.js.map +1 -0
  191. package/dist/esm/Examples/OwnRelease.d.ts +2 -0
  192. package/dist/esm/Examples/OwnRelease.d.ts.map +1 -0
  193. package/dist/esm/Examples/OwnRelease.js +5 -0
  194. package/dist/esm/Examples/OwnRelease.js.map +1 -0
  195. package/dist/esm/Examples/OwnSurface.d.ts +2 -0
  196. package/dist/esm/Examples/OwnSurface.d.ts.map +1 -0
  197. package/dist/esm/Examples/OwnSurface.js +8 -0
  198. package/dist/esm/Examples/OwnSurface.js.map +1 -0
  199. package/dist/esm/Examples/ReleaseNotesPage.d.ts +2 -0
  200. package/dist/esm/Examples/ReleaseNotesPage.d.ts.map +1 -0
  201. package/dist/esm/Examples/ReleaseNotesPage.js +4 -0
  202. package/dist/esm/Examples/ReleaseNotesPage.js.map +1 -0
  203. package/dist/esm/Icons.d.ts +2 -0
  204. package/dist/esm/Icons.d.ts.map +1 -0
  205. package/dist/esm/Icons.js +34 -0
  206. package/dist/esm/Icons.js.map +1 -0
  207. package/dist/esm/Labels/PlaybillLabels.d.ts +22 -0
  208. package/dist/esm/Labels/PlaybillLabels.d.ts.map +1 -0
  209. package/dist/esm/Labels/PlaybillLabels.js +2 -0
  210. package/dist/esm/Labels/PlaybillLabels.js.map +1 -0
  211. package/dist/esm/Labels/defaultPlaybillLabels.d.ts +3 -0
  212. package/dist/esm/Labels/defaultPlaybillLabels.d.ts.map +1 -0
  213. package/dist/esm/Labels/defaultPlaybillLabels.js +28 -0
  214. package/dist/esm/Labels/defaultPlaybillLabels.js.map +1 -0
  215. package/dist/esm/Labels/index.d.ts +4 -0
  216. package/dist/esm/Labels/index.d.ts.map +1 -0
  217. package/dist/esm/Labels/index.js +4 -0
  218. package/dist/esm/Labels/index.js.map +1 -0
  219. package/dist/esm/Labels/resolveLabels.d.ts +4 -0
  220. package/dist/esm/Labels/resolveLabels.d.ts.map +1 -0
  221. package/dist/esm/Labels/resolveLabels.js +21 -0
  222. package/dist/esm/Labels/resolveLabels.js.map +1 -0
  223. package/dist/esm/Markdown/PlaybillLink.d.ts +5 -0
  224. package/dist/esm/Markdown/PlaybillLink.d.ts.map +1 -0
  225. package/dist/esm/Markdown/PlaybillLink.js +19 -0
  226. package/dist/esm/Markdown/PlaybillLink.js.map +1 -0
  227. package/dist/esm/Markdown/PlaybillMarkdown.d.ts +7 -0
  228. package/dist/esm/Markdown/PlaybillMarkdown.d.ts.map +1 -0
  229. package/dist/esm/Markdown/PlaybillMarkdown.js +32 -0
  230. package/dist/esm/Markdown/PlaybillMarkdown.js.map +1 -0
  231. package/dist/esm/Markdown/assetUrl.d.ts +2 -0
  232. package/dist/esm/Markdown/assetUrl.d.ts.map +1 -0
  233. package/dist/esm/Markdown/assetUrl.js +27 -0
  234. package/dist/esm/Markdown/assetUrl.js.map +1 -0
  235. package/dist/esm/Markdown/index.d.ts +4 -0
  236. package/dist/esm/Markdown/index.d.ts.map +1 -0
  237. package/dist/esm/Markdown/index.js +4 -0
  238. package/dist/esm/Markdown/index.js.map +1 -0
  239. package/dist/esm/Markdown/safeLink.d.ts +3 -0
  240. package/dist/esm/Markdown/safeLink.d.ts.map +1 -0
  241. package/dist/esm/Markdown/safeLink.js +27 -0
  242. package/dist/esm/Markdown/safeLink.js.map +1 -0
  243. package/dist/esm/Playbill.d.ts +15 -0
  244. package/dist/esm/Playbill.d.ts.map +1 -0
  245. package/dist/esm/Playbill.js +133 -0
  246. package/dist/esm/Playbill.js.map +1 -0
  247. package/dist/esm/Release/ReleaseNoteView.d.ts +16 -0
  248. package/dist/esm/Release/ReleaseNoteView.d.ts.map +1 -0
  249. package/dist/esm/Release/ReleaseNoteView.js +73 -0
  250. package/dist/esm/Release/ReleaseNoteView.js.map +1 -0
  251. package/dist/esm/Release/formatReleaseDate.d.ts +2 -0
  252. package/dist/esm/Release/formatReleaseDate.d.ts.map +1 -0
  253. package/dist/esm/Release/formatReleaseDate.js +24 -0
  254. package/dist/esm/Release/formatReleaseDate.js.map +1 -0
  255. package/dist/esm/Release/index.d.ts +4 -0
  256. package/dist/esm/Release/index.d.ts.map +1 -0
  257. package/dist/esm/Release/index.js +4 -0
  258. package/dist/esm/Release/index.js.map +1 -0
  259. package/dist/esm/Release/sectionPresentation.d.ts +7 -0
  260. package/dist/esm/Release/sectionPresentation.d.ts.map +1 -0
  261. package/dist/esm/Release/sectionPresentation.js +29 -0
  262. package/dist/esm/Release/sectionPresentation.js.map +1 -0
  263. package/dist/esm/index.d.ts +13 -0
  264. package/dist/esm/index.d.ts.map +1 -0
  265. package/dist/esm/index.js +18 -0
  266. package/dist/esm/index.js.map +1 -0
  267. package/dist/esm/package.json +3 -0
  268. package/dist/esm/useLoaded.d.ts +7 -0
  269. package/dist/esm/useLoaded.d.ts.map +1 -0
  270. package/dist/esm/useLoaded.js +43 -0
  271. package/dist/esm/useLoaded.js.map +1 -0
  272. package/dist/esm/usePlaybill.d.ts +5 -0
  273. package/dist/esm/usePlaybill.d.ts.map +1 -0
  274. package/dist/esm/usePlaybill.js +16 -0
  275. package/dist/esm/usePlaybill.js.map +1 -0
  276. package/dist/esm/usePlaybillStatus.d.ts +8 -0
  277. package/dist/esm/usePlaybillStatus.d.ts.map +1 -0
  278. package/dist/esm/usePlaybillStatus.js +32 -0
  279. package/dist/esm/usePlaybillStatus.js.map +1 -0
  280. package/dist/esm/useReleases.d.ts +12 -0
  281. package/dist/esm/useReleases.d.ts.map +1 -0
  282. package/dist/esm/useReleases.js +54 -0
  283. package/dist/esm/useReleases.js.map +1 -0
  284. package/index.ts +15 -0
  285. package/package.json +87 -4
  286. package/styles.css +298 -0
  287. package/useLoaded.ts +45 -0
  288. package/usePlaybill.ts +17 -0
  289. package/usePlaybillStatus.ts +48 -0
  290. package/useReleases.ts +59 -0
package/package.json CHANGED
@@ -1,6 +1,89 @@
1
1
  {
2
- "name": "@cratis/showrunner.playbill.react",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
2
+ "type": "module",
3
+ "name": "@cratis/showrunner.playbill.react",
4
+ "version": "2.19.0",
5
+ "description": "The Playbill release-notes experience for React — a releases page, a what is new dialog and an unread badge, drawn with Cratis Components, styled with the Cratis tokens and open to your own components, built on Cratis Arc.",
6
+ "keywords": [
7
+ "cratis",
8
+ "showrunner",
9
+ "playbill",
10
+ "release-notes",
11
+ "changelog",
12
+ "whats-new",
13
+ "arc",
14
+ "react",
15
+ "components"
16
+ ],
17
+ "homepage": "https://github.com/Cratis/Showrunner",
18
+ "author": "Cratis",
19
+ "license": "MIT",
20
+ "repository": {
21
+ "type": "git",
22
+ "url": "git+https://github.com/Cratis/Showrunner.git"
23
+ },
24
+ "publishConfig": {
25
+ "access": "public"
26
+ },
27
+ "files": [
28
+ "dist",
29
+ "styles.css",
30
+ "**/*.ts",
31
+ "**/*.tsx",
32
+ "!**/for_*/**",
33
+ "!**/given/**",
34
+ "!Examples/**",
35
+ "!**/*.tsbuildinfo"
36
+ ],
37
+ "main": "dist/cjs/index.js",
38
+ "module": "dist/esm/index.js",
39
+ "types": "dist/esm/index.d.ts",
40
+ "exports": {
41
+ "./package.json": "./package.json",
42
+ ".": {
43
+ "import": {
44
+ "types": "./dist/esm/index.d.ts",
45
+ "default": "./dist/esm/index.js"
46
+ },
47
+ "require": {
48
+ "types": "./dist/cjs/index.d.ts",
49
+ "default": "./dist/cjs/index.js"
50
+ }
51
+ },
52
+ "./styles": "./styles.css"
53
+ },
54
+ "scripts": {
55
+ "prepare": "yarn g:build",
56
+ "clean": "yarn g:clean",
57
+ "compile": "yarn g:compile",
58
+ "build": "yarn g:build",
59
+ "lint": "yarn g:lint",
60
+ "lint:ci": "yarn g:lint:ci",
61
+ "test": "yarn g:test",
62
+ "test:watch": "yarn g:test:watch",
63
+ "ci": "yarn g:ci",
64
+ "up": "yarn g:up"
65
+ },
66
+ "dependencies": {
67
+ "@cratis/showrunner.playbill": "2.19.0",
68
+ "react-markdown": "10.1.0"
69
+ },
70
+ "devDependencies": {
71
+ "@cratis/arc": "22.185.1",
72
+ "@cratis/arc.react": "22.185.1",
73
+ "@cratis/components": "4.38.0",
74
+ "@cratis/fundamentals": "7.34.0",
75
+ "react": "^19.3.1",
76
+ "react-dom": "^19.3.1",
77
+ "reflect-metadata": "0.2.2"
78
+ },
79
+ "peerDependencies": {
80
+ "@cratis/arc": "^22.185.1 || ^23.0.0",
81
+ "@cratis/arc.react": "^22.185.1 || ^23.0.0",
82
+ "@cratis/components": "^4.38.0",
83
+ "@cratis/fundamentals": "^7.34.0",
84
+ "react": "^19.0.0"
85
+ },
86
+ "sideEffects": [
87
+ "*.css"
88
+ ]
6
89
  }
package/styles.css ADDED
@@ -0,0 +1,298 @@
1
+ /* Copyright (c) Cratis. All rights reserved.
2
+ Licensed under the MIT license. See LICENSE file in the project root for full license information. */
3
+
4
+ /*
5
+ * The styles of the Playbill components. Import once, after the Cratis Components stylesheets:
6
+ * @import '@cratis/showrunner.playbill.react/styles';
7
+ *
8
+ * Every color comes from the --cratis-* tokens, so the Cratis Components theme and dark mode apply. To restyle Playbill
9
+ * without replacing a component, set any of these on an ancestor of it (the components fall back to the Cratis tokens):
10
+ * --playbill-accent the color of the current version, the selected release and the unread count
11
+ * --playbill-surface the background of the release list and the badge count's text
12
+ * --playbill-border the lines between releases and sections
13
+ * --playbill-text the text color
14
+ * --playbill-muted dates, summaries and secondary text
15
+ * --playbill-radius the corner radius of tags, items and the badge
16
+ * --playbill-added, --playbill-changed, --playbill-fixed, --playbill-removed, --playbill-security,
17
+ * --playbill-deprecated the marker color of each section
18
+ * Every element has a stable `playbill-*` class, so a product can also style a part directly.
19
+ */
20
+
21
+ .playbill,
22
+ .playbill-dialog,
23
+ .playbill-badge {
24
+ --playbill-accent-resolved: var(--playbill-accent, var(--cratis-primary-color, #3b82f6));
25
+ --playbill-border-resolved: var(--playbill-border, var(--cratis-surface-border, #d4d4d8));
26
+ --playbill-text-resolved: var(--playbill-text, var(--cratis-text-color, inherit));
27
+ --playbill-muted-resolved: var(--playbill-muted, var(--cratis-text-color-secondary, #6b7280));
28
+ --playbill-radius-resolved: var(--playbill-radius, 0.4rem);
29
+ }
30
+
31
+ .playbill-icon {
32
+ flex-shrink: 0;
33
+ }
34
+
35
+ /* The page: the list of releases on one side, the selected release on the other. */
36
+ .playbill {
37
+ display: grid;
38
+ grid-template-columns: minmax(14rem, 20rem) minmax(0, 1fr);
39
+ gap: 1.5rem;
40
+ color: var(--playbill-text-resolved);
41
+ }
42
+
43
+ @media (max-width: 48rem) {
44
+ .playbill {
45
+ grid-template-columns: minmax(0, 1fr);
46
+ }
47
+ }
48
+
49
+ .playbill__list ul {
50
+ display: flex;
51
+ flex-direction: column;
52
+ gap: 0.25rem;
53
+ margin: 0;
54
+ padding: 0;
55
+ list-style: none;
56
+ }
57
+
58
+ .playbill-item {
59
+ display: flex;
60
+ flex-direction: column;
61
+ gap: 0.2rem;
62
+ width: 100%;
63
+ padding: 0.6rem 0.75rem;
64
+ border: 1px solid transparent;
65
+ border-radius: var(--playbill-radius-resolved);
66
+ background: transparent;
67
+ color: var(--playbill-text-resolved);
68
+ font: inherit;
69
+ text-align: start;
70
+ cursor: pointer;
71
+ }
72
+
73
+ .playbill-item:hover {
74
+ background: var(--playbill-surface, var(--cratis-surface-hover, rgb(127 127 127 / 12%)));
75
+ }
76
+
77
+ .playbill-item:focus-visible {
78
+ outline: 2px solid var(--playbill-accent-resolved);
79
+ outline-offset: 2px;
80
+ }
81
+
82
+ .playbill-item--selected {
83
+ border-color: var(--playbill-accent-resolved);
84
+ background: color-mix(in srgb, var(--playbill-accent-resolved) 10%, transparent);
85
+ }
86
+
87
+ .playbill-item__heading {
88
+ display: flex;
89
+ align-items: center;
90
+ gap: 0.5rem;
91
+ }
92
+
93
+ .playbill-item__version {
94
+ font-weight: 600;
95
+ }
96
+
97
+ .playbill-item__date,
98
+ .playbill-item__summary {
99
+ color: var(--playbill-muted-resolved);
100
+ font-size: 0.875rem;
101
+ }
102
+
103
+ .playbill-item__summary {
104
+ display: -webkit-box;
105
+ -webkit-line-clamp: 2;
106
+ -webkit-box-orient: vertical;
107
+ overflow: hidden;
108
+ }
109
+
110
+ .playbill__content {
111
+ min-width: 0;
112
+ }
113
+
114
+ /* Tags: the current version and what has not been seen. */
115
+ .playbill-tag {
116
+ padding: 0.05rem 0.5rem;
117
+ border-radius: var(--playbill-radius-resolved);
118
+ font-size: 0.75rem;
119
+ font-weight: 600;
120
+ line-height: 1.4;
121
+ }
122
+
123
+ .playbill-tag--current {
124
+ border: 1px solid var(--playbill-border-resolved);
125
+ color: var(--playbill-muted-resolved);
126
+ }
127
+
128
+ .playbill-tag--unread {
129
+ background: var(--playbill-accent-resolved);
130
+ color: var(--playbill-accent-text, var(--cratis-primary-color-text, #fff));
131
+ }
132
+
133
+ /* A release: its header, its lead and its sections. */
134
+ .playbill-release {
135
+ display: flex;
136
+ flex-direction: column;
137
+ gap: 1rem;
138
+ color: var(--playbill-text-resolved);
139
+ }
140
+
141
+ .playbill-release + .playbill-release {
142
+ padding-top: 1.25rem;
143
+ border-top: 1px solid var(--playbill-border-resolved);
144
+ }
145
+
146
+ .playbill-release__header {
147
+ display: flex;
148
+ flex-wrap: wrap;
149
+ align-items: baseline;
150
+ gap: 0.5rem 0.75rem;
151
+ }
152
+
153
+ .playbill-release__version {
154
+ margin: 0;
155
+ font-size: 1.4rem;
156
+ }
157
+
158
+ .playbill-release__date {
159
+ color: var(--playbill-muted-resolved);
160
+ font-size: 0.875rem;
161
+ }
162
+
163
+ .playbill-release__lead {
164
+ font-size: 1.05rem;
165
+ }
166
+
167
+ .playbill-section {
168
+ --playbill-marker: var(--playbill-other, var(--cratis-text-color-secondary, #6b7280));
169
+ padding-inline-start: 0.9rem;
170
+ border-inline-start: 3px solid var(--playbill-marker);
171
+ }
172
+
173
+ .playbill-section--added {
174
+ --playbill-marker: var(--playbill-added, var(--cratis-green-500, #22c55e));
175
+ }
176
+
177
+ .playbill-section--changed {
178
+ --playbill-marker: var(--playbill-changed, var(--cratis-primary-color, #3b82f6));
179
+ }
180
+
181
+ .playbill-section--fixed {
182
+ --playbill-marker: var(--playbill-fixed, var(--cratis-orange-500, #f59e0b));
183
+ }
184
+
185
+ .playbill-section--removed {
186
+ --playbill-marker: var(--playbill-removed, var(--cratis-red-500, #ef4444));
187
+ }
188
+
189
+ .playbill-section--security {
190
+ --playbill-marker: var(--playbill-security, var(--cratis-red-500, #ef4444));
191
+ }
192
+
193
+ .playbill-section--deprecated {
194
+ --playbill-marker: var(--playbill-deprecated, var(--cratis-text-color-secondary, #6b7280));
195
+ }
196
+
197
+ .playbill-section__title {
198
+ margin: 0 0 0.35rem;
199
+ font-size: 1rem;
200
+ }
201
+
202
+ /* The markdown of a note. */
203
+ .playbill-markdown {
204
+ overflow-wrap: anywhere;
205
+ }
206
+
207
+ .playbill-markdown > :first-child {
208
+ margin-top: 0;
209
+ }
210
+
211
+ .playbill-markdown > :last-child {
212
+ margin-bottom: 0;
213
+ }
214
+
215
+ .playbill-markdown ul,
216
+ .playbill-markdown ol {
217
+ padding-inline-start: 1.25rem;
218
+ }
219
+
220
+ .playbill-markdown img {
221
+ max-width: 100%;
222
+ height: auto;
223
+ border: 1px solid var(--playbill-border-resolved);
224
+ border-radius: var(--playbill-radius-resolved);
225
+ }
226
+
227
+ .playbill-markdown a {
228
+ color: var(--playbill-accent-resolved);
229
+ }
230
+
231
+ .playbill-markdown code {
232
+ padding: 0.05rem 0.3rem;
233
+ border-radius: var(--playbill-radius-resolved);
234
+ background: var(--playbill-surface, var(--cratis-surface-hover, rgb(127 127 127 / 12%)));
235
+ font-size: 0.9em;
236
+ }
237
+
238
+ /* The dialog. */
239
+ .playbill-dialog {
240
+ display: flex;
241
+ flex-direction: column;
242
+ gap: 1.25rem;
243
+ color: var(--playbill-text-resolved);
244
+ }
245
+
246
+ .playbill-dialog__earlier {
247
+ margin: 0;
248
+ color: var(--playbill-muted-resolved);
249
+ font-size: 0.875rem;
250
+ }
251
+
252
+ .playbill-status {
253
+ margin: 0;
254
+ color: var(--playbill-muted-resolved);
255
+ }
256
+
257
+ .playbill-status--failed {
258
+ color: var(--cratis-red-500, #ef4444);
259
+ }
260
+
261
+ /* The badge. */
262
+ .playbill-badge {
263
+ position: relative;
264
+ display: inline-flex;
265
+ align-items: center;
266
+ justify-content: center;
267
+ padding: 0.4rem;
268
+ border: 0;
269
+ border-radius: var(--playbill-radius-resolved);
270
+ background: transparent;
271
+ color: var(--playbill-text-resolved);
272
+ font-size: 1.25rem;
273
+ cursor: pointer;
274
+ }
275
+
276
+ .playbill-badge:hover {
277
+ background: var(--playbill-surface, var(--cratis-surface-hover, rgb(127 127 127 / 12%)));
278
+ }
279
+
280
+ .playbill-badge:focus-visible {
281
+ outline: 2px solid var(--playbill-accent-resolved);
282
+ outline-offset: 2px;
283
+ }
284
+
285
+ .playbill-badge__count {
286
+ position: absolute;
287
+ top: -0.1rem;
288
+ inset-inline-end: -0.15rem;
289
+ min-width: 1.1rem;
290
+ padding: 0 0.3rem;
291
+ border-radius: 999px;
292
+ background: var(--playbill-accent-resolved);
293
+ color: var(--playbill-accent-text, var(--cratis-primary-color-text, #fff));
294
+ font-size: 0.7rem;
295
+ font-weight: 700;
296
+ line-height: 1.1rem;
297
+ text-align: center;
298
+ }
package/useLoaded.ts ADDED
@@ -0,0 +1,45 @@
1
+ // Copyright (c) Cratis. All rights reserved.
2
+ // Licensed under the MIT license. See LICENSE file in the project root for full license information.
3
+
4
+ import { useEffect, useState } from 'react';
5
+
6
+ /**
7
+ * What {@link useLoaded} gives a component.
8
+ */
9
+ export interface Loaded<TData> {
10
+ /** What was read; absent until the first read has finished, and while the read is repeated for another input. */
11
+ data?: TData;
12
+ /** Whether a read is in progress. */
13
+ isLoading: boolean;
14
+ /** Why the last read failed; absent when it did not. */
15
+ error?: Error;
16
+ }
17
+
18
+ /**
19
+ * Reads something when the component is shown and again whenever the read changes, cancelling a read that is no longer
20
+ * wanted. The read must be stable between renders, for example made with `useCallback`.
21
+ * @param load Starts the read; gets a signal that is aborted when it is no longer wanted.
22
+ * @returns What was read, whether it is still being read, and why it failed.
23
+ */
24
+ export const useLoaded = <TData,>(load: (signal: AbortSignal) => Promise<TData>): Loaded<TData> => {
25
+ const [state, setState] = useState<Loaded<TData>>({ isLoading: true });
26
+
27
+ useEffect(() => {
28
+ const controller = new AbortController();
29
+ setState(previous => ({ isLoading: true, data: previous.data }));
30
+ load(controller.signal)
31
+ .then(data => {
32
+ if (!controller.signal.aborted) {
33
+ setState({ isLoading: false, data });
34
+ }
35
+ })
36
+ .catch((error: unknown) => {
37
+ if (!controller.signal.aborted) {
38
+ setState({ isLoading: false, error: error instanceof Error ? error : new Error(String(error)) });
39
+ }
40
+ });
41
+ return () => controller.abort();
42
+ }, [load]);
43
+
44
+ return state;
45
+ };
package/usePlaybill.ts ADDED
@@ -0,0 +1,17 @@
1
+ // Copyright (c) Cratis. All rights reserved.
2
+ // Licensed under the MIT license. See LICENSE file in the project root for full license information.
3
+
4
+ import { UsedReleases, useReleases } from './useReleases.js';
5
+ import { UsedPlaybillStatus, usePlaybillStatus } from './usePlaybillStatus.js';
6
+
7
+ /**
8
+ * What {@link usePlaybill} gives a component: the release history and what the person has seen of it.
9
+ */
10
+ export type UsedPlaybill = UsedReleases & UsedPlaybillStatus;
11
+
12
+ /**
13
+ * Reads the release history and observes which releases the signed-in person has not been told about, so a product can
14
+ * draw its own surface instead of {@link Playbill}'s. Must be used inside Arc's context, like every generated query.
15
+ * @returns The releases, and what the person has seen.
16
+ */
17
+ export const usePlaybill = (): UsedPlaybill => ({ ...useReleases(), ...usePlaybillStatus() });
@@ -0,0 +1,48 @@
1
+ // Copyright (c) Cratis. All rights reserved.
2
+ // Licensed under the MIT license. See LICENSE file in the project root for full license information.
3
+
4
+ import { ForMe, MarkReleaseNotesSeen } from '@cratis/showrunner.playbill';
5
+ import { useCallback } from 'react';
6
+
7
+ /**
8
+ * What {@link usePlaybillStatus} gives a component.
9
+ */
10
+ export interface UsedPlaybillStatus {
11
+ /** The newest release the person has seen the notes of; absent when they have seen none. */
12
+ lastSeen?: string;
13
+ /** How many releases they have not seen the notes of. */
14
+ unread: number;
15
+ /** The versions of those releases, the newest first. */
16
+ unreadVersions: string[];
17
+ /**
18
+ * Records that the person has seen the release notes up to a version, on every device. It only moves forward, and
19
+ * marking a release they have seen already does nothing.
20
+ * @param version The newest release the person has seen the notes of.
21
+ * @returns Resolves when the command has been sent.
22
+ */
23
+ markSeen(version: string): Promise<void>;
24
+ }
25
+
26
+ /**
27
+ * Observes which releases the signed-in person has not been told about, and lets a component record that they have.
28
+ * Must be used inside Arc's context, like every generated query. It needs the backend package
29
+ * `Cratis.Showrunner.Playbill`.
30
+ * @returns What the person has seen and how to record that they have seen more.
31
+ */
32
+ export const usePlaybillStatus = (): UsedPlaybillStatus => {
33
+ const [result] = ForMe.use();
34
+ const [mark] = MarkReleaseNotesSeen.use();
35
+ const status = result.data?.[0];
36
+
37
+ const markSeen = useCallback(async (version: string) => {
38
+ mark.version = version;
39
+ await mark.execute();
40
+ }, [mark]);
41
+
42
+ return {
43
+ lastSeen: status?.lastSeen || undefined,
44
+ unread: status?.unread ?? 0,
45
+ unreadVersions: [...status?.unreadVersions ?? []],
46
+ markSeen
47
+ };
48
+ };
package/useReleases.ts ADDED
@@ -0,0 +1,59 @@
1
+ // Copyright (c) Cratis. All rights reserved.
2
+ // Licensed under the MIT license. See LICENSE file in the project root for full license information.
3
+
4
+ import { useCallback } from 'react';
5
+ import { Release, ReleaseSummary } from './Client/index.js';
6
+ import { usePlaybillClient } from './Configuration/index.js';
7
+ import { Loaded, useLoaded } from './useLoaded.js';
8
+
9
+ /**
10
+ * What {@link useReleases} gives a component.
11
+ */
12
+ export interface UsedReleases {
13
+ /** The releases, the newest first; empty until they are read. */
14
+ releases: ReleaseSummary[];
15
+ /** The version the application is running; absent when it is not known. */
16
+ current?: string;
17
+ /** Whether the releases are being read. */
18
+ isLoading: boolean;
19
+ /** Why they could not be read; absent when they could. */
20
+ error?: Error;
21
+ }
22
+
23
+ /**
24
+ * Reads the list of releases the application serves. Needs nothing but the endpoints `MapPlaybill` maps, so it works
25
+ * without Arc and for a person who has not signed in when the application allows anonymous callers.
26
+ * @returns The releases, whether they are being read and why they could not be.
27
+ */
28
+ export const useReleases = (): UsedReleases => {
29
+ const client = usePlaybillClient();
30
+ const load = useCallback((signal: AbortSignal) => client.list(undefined, signal), [client]);
31
+ const { data, isLoading, error } = useLoaded(load);
32
+ return { releases: data?.releases ?? [], current: data?.current ?? undefined, isLoading, error };
33
+ };
34
+
35
+ /**
36
+ * Reads one release with its note.
37
+ * @param version The version of the release; nothing is read while it is absent.
38
+ * @returns The release, whether it is being read and why it could not be.
39
+ */
40
+ export const useRelease = (version?: string): Loaded<Release> => {
41
+ const client = usePlaybillClient();
42
+ const load = useCallback((signal: AbortSignal) => version
43
+ ? client.get(version, signal)
44
+ : Promise.reject(new Error('No release was asked for.')), [client, version]);
45
+ const loaded = useLoaded(load);
46
+ return version ? loaded : { isLoading: false };
47
+ };
48
+
49
+ /**
50
+ * Reads several releases with their notes, in the order they are asked for.
51
+ * @param versions The versions of the releases.
52
+ * @returns The releases, whether they are being read and why they could not be.
53
+ */
54
+ export const useReleaseNotes = (versions: string[]): Loaded<Release[]> => {
55
+ const client = usePlaybillClient();
56
+ const key = versions.join('|');
57
+ const load = useCallback((signal: AbortSignal) => Promise.all(key === '' ? [] : key.split('|').map(version => client.get(version, signal))), [client, key]);
58
+ return useLoaded(load);
59
+ };