@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.
- package/Badge/PlaybillBadge.tsx +45 -0
- package/Badge/index.ts +4 -0
- package/Client/PlaybillClient.ts +78 -0
- package/Client/index.ts +5 -0
- package/Client/models.ts +64 -0
- package/Configuration/PlaybillProvider.tsx +38 -0
- package/Configuration/index.ts +4 -0
- package/Dialog/PlaybillDialog.tsx +83 -0
- package/Dialog/index.ts +4 -0
- package/Icons.tsx +14 -0
- package/Labels/PlaybillLabels.ts +46 -0
- package/Labels/defaultPlaybillLabels.ts +29 -0
- package/Labels/index.ts +6 -0
- package/Labels/resolveLabels.ts +20 -0
- package/Markdown/PlaybillLink.tsx +14 -0
- package/Markdown/PlaybillMarkdown.tsx +41 -0
- package/Markdown/assetUrl.ts +28 -0
- package/Markdown/index.ts +6 -0
- package/Markdown/safeLink.ts +25 -0
- package/Playbill.tsx +121 -0
- package/README.md +54 -2
- package/Release/ReleaseNoteView.tsx +79 -0
- package/Release/formatReleaseDate.ts +22 -0
- package/Release/index.ts +6 -0
- package/Release/sectionPresentation.ts +35 -0
- package/dist/cjs/Badge/PlaybillBadge.d.ts +10 -0
- package/dist/cjs/Badge/PlaybillBadge.d.ts.map +1 -0
- package/dist/cjs/Badge/PlaybillBadge.js +38 -0
- package/dist/cjs/Badge/PlaybillBadge.js.map +1 -0
- package/dist/cjs/Badge/index.d.ts +2 -0
- package/dist/cjs/Badge/index.d.ts.map +1 -0
- package/dist/cjs/Client/PlaybillClient.d.ts +13 -0
- package/dist/cjs/Client/PlaybillClient.d.ts.map +1 -0
- package/dist/cjs/Client/PlaybillClient.js +71 -0
- package/dist/cjs/Client/PlaybillClient.js.map +1 -0
- package/dist/cjs/Client/index.d.ts +3 -0
- package/dist/cjs/Client/index.d.ts.map +1 -0
- package/dist/cjs/Client/models.d.ts +27 -0
- package/dist/cjs/Client/models.d.ts.map +1 -0
- package/dist/cjs/Configuration/PlaybillProvider.d.ts +11 -0
- package/dist/cjs/Configuration/PlaybillProvider.d.ts.map +1 -0
- package/dist/cjs/Configuration/PlaybillProvider.js +30 -0
- package/dist/cjs/Configuration/PlaybillProvider.js.map +1 -0
- package/dist/cjs/Configuration/index.d.ts +2 -0
- package/dist/cjs/Configuration/index.d.ts.map +1 -0
- package/dist/cjs/Dialog/PlaybillDialog.d.ts +13 -0
- package/dist/cjs/Dialog/PlaybillDialog.d.ts.map +1 -0
- package/dist/cjs/Dialog/PlaybillDialog.js +79 -0
- package/dist/cjs/Dialog/PlaybillDialog.js.map +1 -0
- package/dist/cjs/Dialog/index.d.ts +2 -0
- package/dist/cjs/Dialog/index.d.ts.map +1 -0
- package/dist/cjs/Examples/AppShell.d.ts +5 -0
- package/dist/cjs/Examples/AppShell.d.ts.map +1 -0
- package/dist/cjs/Examples/LocalizedPlaybill.d.ts +2 -0
- package/dist/cjs/Examples/LocalizedPlaybill.d.ts.map +1 -0
- package/dist/cjs/Examples/OwnEndpoint.d.ts +2 -0
- package/dist/cjs/Examples/OwnEndpoint.d.ts.map +1 -0
- package/dist/cjs/Examples/OwnMarkdown.d.ts +2 -0
- package/dist/cjs/Examples/OwnMarkdown.d.ts.map +1 -0
- package/dist/cjs/Examples/OwnRelease.d.ts +2 -0
- package/dist/cjs/Examples/OwnRelease.d.ts.map +1 -0
- package/dist/cjs/Examples/OwnSurface.d.ts +2 -0
- package/dist/cjs/Examples/OwnSurface.d.ts.map +1 -0
- package/dist/cjs/Examples/ReleaseNotesPage.d.ts +2 -0
- package/dist/cjs/Examples/ReleaseNotesPage.d.ts.map +1 -0
- package/dist/cjs/Icons.d.ts +2 -0
- package/dist/cjs/Icons.d.ts.map +1 -0
- package/dist/cjs/Icons.js +36 -0
- package/dist/cjs/Icons.js.map +1 -0
- package/dist/cjs/Labels/PlaybillLabels.d.ts +22 -0
- package/dist/cjs/Labels/PlaybillLabels.d.ts.map +1 -0
- package/dist/cjs/Labels/defaultPlaybillLabels.d.ts +3 -0
- package/dist/cjs/Labels/defaultPlaybillLabels.d.ts.map +1 -0
- package/dist/cjs/Labels/defaultPlaybillLabels.js +30 -0
- package/dist/cjs/Labels/defaultPlaybillLabels.js.map +1 -0
- package/dist/cjs/Labels/index.d.ts +4 -0
- package/dist/cjs/Labels/index.d.ts.map +1 -0
- package/dist/cjs/Labels/resolveLabels.d.ts +4 -0
- package/dist/cjs/Labels/resolveLabels.d.ts.map +1 -0
- package/dist/cjs/Labels/resolveLabels.js +24 -0
- package/dist/cjs/Labels/resolveLabels.js.map +1 -0
- package/dist/cjs/Markdown/PlaybillLink.d.ts +5 -0
- package/dist/cjs/Markdown/PlaybillLink.d.ts.map +1 -0
- package/dist/cjs/Markdown/PlaybillLink.js +21 -0
- package/dist/cjs/Markdown/PlaybillLink.js.map +1 -0
- package/dist/cjs/Markdown/PlaybillMarkdown.d.ts +7 -0
- package/dist/cjs/Markdown/PlaybillMarkdown.d.ts.map +1 -0
- package/dist/cjs/Markdown/PlaybillMarkdown.js +34 -0
- package/dist/cjs/Markdown/PlaybillMarkdown.js.map +1 -0
- package/dist/cjs/Markdown/assetUrl.d.ts +2 -0
- package/dist/cjs/Markdown/assetUrl.d.ts.map +1 -0
- package/dist/cjs/Markdown/assetUrl.js +29 -0
- package/dist/cjs/Markdown/assetUrl.js.map +1 -0
- package/dist/cjs/Markdown/index.d.ts +4 -0
- package/dist/cjs/Markdown/index.d.ts.map +1 -0
- package/dist/cjs/Markdown/safeLink.d.ts +3 -0
- package/dist/cjs/Markdown/safeLink.d.ts.map +1 -0
- package/dist/cjs/Markdown/safeLink.js +30 -0
- package/dist/cjs/Markdown/safeLink.js.map +1 -0
- package/dist/cjs/Playbill.d.ts +15 -0
- package/dist/cjs/Playbill.d.ts.map +1 -0
- package/dist/cjs/Playbill.js +135 -0
- package/dist/cjs/Playbill.js.map +1 -0
- package/dist/cjs/Release/ReleaseNoteView.d.ts +16 -0
- package/dist/cjs/Release/ReleaseNoteView.d.ts.map +1 -0
- package/dist/cjs/Release/ReleaseNoteView.js +75 -0
- package/dist/cjs/Release/ReleaseNoteView.js.map +1 -0
- package/dist/cjs/Release/formatReleaseDate.d.ts +2 -0
- package/dist/cjs/Release/formatReleaseDate.d.ts.map +1 -0
- package/dist/cjs/Release/formatReleaseDate.js +26 -0
- package/dist/cjs/Release/formatReleaseDate.js.map +1 -0
- package/dist/cjs/Release/index.d.ts +4 -0
- package/dist/cjs/Release/index.d.ts.map +1 -0
- package/dist/cjs/Release/sectionPresentation.d.ts +7 -0
- package/dist/cjs/Release/sectionPresentation.d.ts.map +1 -0
- package/dist/cjs/Release/sectionPresentation.js +31 -0
- package/dist/cjs/Release/sectionPresentation.js.map +1 -0
- package/dist/cjs/index.d.ts +13 -0
- package/dist/cjs/index.d.ts.map +1 -0
- package/dist/cjs/index.js +46 -0
- package/dist/cjs/index.js.map +1 -0
- package/dist/cjs/package.json +3 -0
- package/dist/cjs/useLoaded.d.ts +7 -0
- package/dist/cjs/useLoaded.d.ts.map +1 -0
- package/dist/cjs/useLoaded.js +45 -0
- package/dist/cjs/useLoaded.js.map +1 -0
- package/dist/cjs/usePlaybill.d.ts +5 -0
- package/dist/cjs/usePlaybill.d.ts.map +1 -0
- package/dist/cjs/usePlaybill.js +18 -0
- package/dist/cjs/usePlaybill.js.map +1 -0
- package/dist/cjs/usePlaybillStatus.d.ts +8 -0
- package/dist/cjs/usePlaybillStatus.d.ts.map +1 -0
- package/dist/cjs/usePlaybillStatus.js +34 -0
- package/dist/cjs/usePlaybillStatus.js.map +1 -0
- package/dist/cjs/useReleases.d.ts +12 -0
- package/dist/cjs/useReleases.d.ts.map +1 -0
- package/dist/cjs/useReleases.js +58 -0
- package/dist/cjs/useReleases.js.map +1 -0
- package/dist/esm/Badge/PlaybillBadge.d.ts +10 -0
- package/dist/esm/Badge/PlaybillBadge.d.ts.map +1 -0
- package/dist/esm/Badge/PlaybillBadge.js +36 -0
- package/dist/esm/Badge/PlaybillBadge.js.map +1 -0
- package/dist/esm/Badge/index.d.ts +2 -0
- package/dist/esm/Badge/index.d.ts.map +1 -0
- package/dist/esm/Badge/index.js +2 -0
- package/dist/esm/Badge/index.js.map +1 -0
- package/dist/esm/Client/PlaybillClient.d.ts +13 -0
- package/dist/esm/Client/PlaybillClient.d.ts.map +1 -0
- package/dist/esm/Client/PlaybillClient.js +68 -0
- package/dist/esm/Client/PlaybillClient.js.map +1 -0
- package/dist/esm/Client/index.d.ts +3 -0
- package/dist/esm/Client/index.d.ts.map +1 -0
- package/dist/esm/Client/index.js +3 -0
- package/dist/esm/Client/index.js.map +1 -0
- package/dist/esm/Client/models.d.ts +27 -0
- package/dist/esm/Client/models.d.ts.map +1 -0
- package/dist/esm/Client/models.js +2 -0
- package/dist/esm/Client/models.js.map +1 -0
- package/dist/esm/Configuration/PlaybillProvider.d.ts +11 -0
- package/dist/esm/Configuration/PlaybillProvider.d.ts.map +1 -0
- package/dist/esm/Configuration/PlaybillProvider.js +27 -0
- package/dist/esm/Configuration/PlaybillProvider.js.map +1 -0
- package/dist/esm/Configuration/index.d.ts +2 -0
- package/dist/esm/Configuration/index.d.ts.map +1 -0
- package/dist/esm/Configuration/index.js +2 -0
- package/dist/esm/Configuration/index.js.map +1 -0
- package/dist/esm/Dialog/PlaybillDialog.d.ts +13 -0
- package/dist/esm/Dialog/PlaybillDialog.d.ts.map +1 -0
- package/dist/esm/Dialog/PlaybillDialog.js +77 -0
- package/dist/esm/Dialog/PlaybillDialog.js.map +1 -0
- package/dist/esm/Dialog/index.d.ts +2 -0
- package/dist/esm/Dialog/index.d.ts.map +1 -0
- package/dist/esm/Dialog/index.js +2 -0
- package/dist/esm/Dialog/index.js.map +1 -0
- package/dist/esm/Examples/AppShell.d.ts +5 -0
- package/dist/esm/Examples/AppShell.d.ts.map +1 -0
- package/dist/esm/Examples/AppShell.js +6 -0
- package/dist/esm/Examples/AppShell.js.map +1 -0
- package/dist/esm/Examples/LocalizedPlaybill.d.ts +2 -0
- package/dist/esm/Examples/LocalizedPlaybill.d.ts.map +1 -0
- package/dist/esm/Examples/LocalizedPlaybill.js +13 -0
- package/dist/esm/Examples/LocalizedPlaybill.js.map +1 -0
- package/dist/esm/Examples/OwnEndpoint.d.ts +2 -0
- package/dist/esm/Examples/OwnEndpoint.d.ts.map +1 -0
- package/dist/esm/Examples/OwnEndpoint.js +8 -0
- package/dist/esm/Examples/OwnEndpoint.js.map +1 -0
- package/dist/esm/Examples/OwnMarkdown.d.ts +2 -0
- package/dist/esm/Examples/OwnMarkdown.d.ts.map +1 -0
- package/dist/esm/Examples/OwnMarkdown.js +5 -0
- package/dist/esm/Examples/OwnMarkdown.js.map +1 -0
- package/dist/esm/Examples/OwnRelease.d.ts +2 -0
- package/dist/esm/Examples/OwnRelease.d.ts.map +1 -0
- package/dist/esm/Examples/OwnRelease.js +5 -0
- package/dist/esm/Examples/OwnRelease.js.map +1 -0
- package/dist/esm/Examples/OwnSurface.d.ts +2 -0
- package/dist/esm/Examples/OwnSurface.d.ts.map +1 -0
- package/dist/esm/Examples/OwnSurface.js +8 -0
- package/dist/esm/Examples/OwnSurface.js.map +1 -0
- package/dist/esm/Examples/ReleaseNotesPage.d.ts +2 -0
- package/dist/esm/Examples/ReleaseNotesPage.d.ts.map +1 -0
- package/dist/esm/Examples/ReleaseNotesPage.js +4 -0
- package/dist/esm/Examples/ReleaseNotesPage.js.map +1 -0
- package/dist/esm/Icons.d.ts +2 -0
- package/dist/esm/Icons.d.ts.map +1 -0
- package/dist/esm/Icons.js +34 -0
- package/dist/esm/Icons.js.map +1 -0
- package/dist/esm/Labels/PlaybillLabels.d.ts +22 -0
- package/dist/esm/Labels/PlaybillLabels.d.ts.map +1 -0
- package/dist/esm/Labels/PlaybillLabels.js +2 -0
- package/dist/esm/Labels/PlaybillLabels.js.map +1 -0
- package/dist/esm/Labels/defaultPlaybillLabels.d.ts +3 -0
- package/dist/esm/Labels/defaultPlaybillLabels.d.ts.map +1 -0
- package/dist/esm/Labels/defaultPlaybillLabels.js +28 -0
- package/dist/esm/Labels/defaultPlaybillLabels.js.map +1 -0
- package/dist/esm/Labels/index.d.ts +4 -0
- package/dist/esm/Labels/index.d.ts.map +1 -0
- package/dist/esm/Labels/index.js +4 -0
- package/dist/esm/Labels/index.js.map +1 -0
- package/dist/esm/Labels/resolveLabels.d.ts +4 -0
- package/dist/esm/Labels/resolveLabels.d.ts.map +1 -0
- package/dist/esm/Labels/resolveLabels.js +21 -0
- package/dist/esm/Labels/resolveLabels.js.map +1 -0
- package/dist/esm/Markdown/PlaybillLink.d.ts +5 -0
- package/dist/esm/Markdown/PlaybillLink.d.ts.map +1 -0
- package/dist/esm/Markdown/PlaybillLink.js +19 -0
- package/dist/esm/Markdown/PlaybillLink.js.map +1 -0
- package/dist/esm/Markdown/PlaybillMarkdown.d.ts +7 -0
- package/dist/esm/Markdown/PlaybillMarkdown.d.ts.map +1 -0
- package/dist/esm/Markdown/PlaybillMarkdown.js +32 -0
- package/dist/esm/Markdown/PlaybillMarkdown.js.map +1 -0
- package/dist/esm/Markdown/assetUrl.d.ts +2 -0
- package/dist/esm/Markdown/assetUrl.d.ts.map +1 -0
- package/dist/esm/Markdown/assetUrl.js +27 -0
- package/dist/esm/Markdown/assetUrl.js.map +1 -0
- package/dist/esm/Markdown/index.d.ts +4 -0
- package/dist/esm/Markdown/index.d.ts.map +1 -0
- package/dist/esm/Markdown/index.js +4 -0
- package/dist/esm/Markdown/index.js.map +1 -0
- package/dist/esm/Markdown/safeLink.d.ts +3 -0
- package/dist/esm/Markdown/safeLink.d.ts.map +1 -0
- package/dist/esm/Markdown/safeLink.js +27 -0
- package/dist/esm/Markdown/safeLink.js.map +1 -0
- package/dist/esm/Playbill.d.ts +15 -0
- package/dist/esm/Playbill.d.ts.map +1 -0
- package/dist/esm/Playbill.js +133 -0
- package/dist/esm/Playbill.js.map +1 -0
- package/dist/esm/Release/ReleaseNoteView.d.ts +16 -0
- package/dist/esm/Release/ReleaseNoteView.d.ts.map +1 -0
- package/dist/esm/Release/ReleaseNoteView.js +73 -0
- package/dist/esm/Release/ReleaseNoteView.js.map +1 -0
- package/dist/esm/Release/formatReleaseDate.d.ts +2 -0
- package/dist/esm/Release/formatReleaseDate.d.ts.map +1 -0
- package/dist/esm/Release/formatReleaseDate.js +24 -0
- package/dist/esm/Release/formatReleaseDate.js.map +1 -0
- package/dist/esm/Release/index.d.ts +4 -0
- package/dist/esm/Release/index.d.ts.map +1 -0
- package/dist/esm/Release/index.js +4 -0
- package/dist/esm/Release/index.js.map +1 -0
- package/dist/esm/Release/sectionPresentation.d.ts +7 -0
- package/dist/esm/Release/sectionPresentation.d.ts.map +1 -0
- package/dist/esm/Release/sectionPresentation.js +29 -0
- package/dist/esm/Release/sectionPresentation.js.map +1 -0
- package/dist/esm/index.d.ts +13 -0
- package/dist/esm/index.d.ts.map +1 -0
- package/dist/esm/index.js +18 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/package.json +3 -0
- package/dist/esm/useLoaded.d.ts +7 -0
- package/dist/esm/useLoaded.d.ts.map +1 -0
- package/dist/esm/useLoaded.js +43 -0
- package/dist/esm/useLoaded.js.map +1 -0
- package/dist/esm/usePlaybill.d.ts +5 -0
- package/dist/esm/usePlaybill.d.ts.map +1 -0
- package/dist/esm/usePlaybill.js +16 -0
- package/dist/esm/usePlaybill.js.map +1 -0
- package/dist/esm/usePlaybillStatus.d.ts +8 -0
- package/dist/esm/usePlaybillStatus.d.ts.map +1 -0
- package/dist/esm/usePlaybillStatus.js +32 -0
- package/dist/esm/usePlaybillStatus.js.map +1 -0
- package/dist/esm/useReleases.d.ts +12 -0
- package/dist/esm/useReleases.d.ts.map +1 -0
- package/dist/esm/useReleases.js +54 -0
- package/dist/esm/useReleases.js.map +1 -0
- package/index.ts +15 -0
- package/package.json +87 -4
- package/styles.css +298 -0
- package/useLoaded.ts +45 -0
- package/usePlaybill.ts +17 -0
- package/usePlaybillStatus.ts +48 -0
- package/useReleases.ts +59 -0
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var jsxRuntime = require('react/jsx-runtime');
|
|
4
|
+
var react = require('react');
|
|
5
|
+
var PlaybillProvider = require('./Configuration/PlaybillProvider.js');
|
|
6
|
+
var resolveLabels = require('./Labels/resolveLabels.js');
|
|
7
|
+
var PlaybillMarkdown = require('./Markdown/PlaybillMarkdown.js');
|
|
8
|
+
var formatReleaseDate = require('./Release/formatReleaseDate.js');
|
|
9
|
+
var ReleaseNoteView = require('./Release/ReleaseNoteView.js');
|
|
10
|
+
var usePlaybill = require('./usePlaybill.js');
|
|
11
|
+
var useReleases = require('./useReleases.js');
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* The release notes of the application as a page: the releases newest first on one side and the selected release on the
|
|
15
|
+
* other. It marks what the person has not seen with a tag, and records a release as seen when it is shown. Place it
|
|
16
|
+
* where the application has room for a page, inside Arc's context. It draws no heading of its own.
|
|
17
|
+
*/ const Playbill = ({ release: Release = ReleaseNoteView.ReleaseNoteView, markdown, labels, locale, selected, onSelect, markSeenWhenShown = true })=>{
|
|
18
|
+
const client = PlaybillProvider.usePlaybillClient();
|
|
19
|
+
const { releases, current, isLoading, error, unreadVersions, markSeen } = usePlaybill.usePlaybill();
|
|
20
|
+
const resolved = react.useMemo(()=>resolveLabels.resolveLabels(labels), [
|
|
21
|
+
labels
|
|
22
|
+
]);
|
|
23
|
+
const [picked, setPicked] = react.useState();
|
|
24
|
+
const version = selected ?? picked ?? releases[0]?.version;
|
|
25
|
+
const { data: note, isLoading: isLoadingNote, error: noteError } = useReleases.useRelease(version);
|
|
26
|
+
const isUnread = (candidate)=>candidate !== undefined && unreadVersions.includes(candidate);
|
|
27
|
+
const selectedIsUnread = isUnread(version);
|
|
28
|
+
react.useEffect(()=>{
|
|
29
|
+
if (markSeenWhenShown && note && selectedIsUnread) {
|
|
30
|
+
// Failing to remember it must not keep a person from reading on.
|
|
31
|
+
markSeen(note.version).catch(()=>undefined);
|
|
32
|
+
}
|
|
33
|
+
}, [
|
|
34
|
+
markSeenWhenShown,
|
|
35
|
+
note,
|
|
36
|
+
selectedIsUnread,
|
|
37
|
+
markSeen
|
|
38
|
+
]);
|
|
39
|
+
const select = (next)=>{
|
|
40
|
+
setPicked(next);
|
|
41
|
+
onSelect?.(next);
|
|
42
|
+
};
|
|
43
|
+
if (error || noteError) {
|
|
44
|
+
return /*#__PURE__*/ jsxRuntime.jsx("p", {
|
|
45
|
+
className: "playbill-status playbill-status--failed",
|
|
46
|
+
role: "alert",
|
|
47
|
+
children: resolved.failed
|
|
48
|
+
});
|
|
49
|
+
}
|
|
50
|
+
if (isLoading) {
|
|
51
|
+
return /*#__PURE__*/ jsxRuntime.jsx("p", {
|
|
52
|
+
className: "playbill-status",
|
|
53
|
+
role: "status",
|
|
54
|
+
children: resolved.loading
|
|
55
|
+
});
|
|
56
|
+
}
|
|
57
|
+
if (releases.length === 0) {
|
|
58
|
+
return /*#__PURE__*/ jsxRuntime.jsx("p", {
|
|
59
|
+
className: "playbill-status",
|
|
60
|
+
children: resolved.empty
|
|
61
|
+
});
|
|
62
|
+
}
|
|
63
|
+
return /*#__PURE__*/ jsxRuntime.jsxs("div", {
|
|
64
|
+
className: "playbill",
|
|
65
|
+
children: [
|
|
66
|
+
/*#__PURE__*/ jsxRuntime.jsx("nav", {
|
|
67
|
+
className: "playbill__list",
|
|
68
|
+
"aria-label": resolved.releases,
|
|
69
|
+
children: /*#__PURE__*/ jsxRuntime.jsx("ul", {
|
|
70
|
+
children: releases.map((summary)=>{
|
|
71
|
+
const date = formatReleaseDate.formatReleaseDate(summary.releasedAt, locale);
|
|
72
|
+
const isSelected = summary.version === version;
|
|
73
|
+
return /*#__PURE__*/ jsxRuntime.jsx("li", {
|
|
74
|
+
children: /*#__PURE__*/ jsxRuntime.jsxs("button", {
|
|
75
|
+
type: "button",
|
|
76
|
+
className: isSelected ? 'playbill-item playbill-item--selected' : 'playbill-item',
|
|
77
|
+
"aria-current": isSelected ? 'true' : undefined,
|
|
78
|
+
onClick: ()=>select(summary.version),
|
|
79
|
+
children: [
|
|
80
|
+
/*#__PURE__*/ jsxRuntime.jsxs("span", {
|
|
81
|
+
className: "playbill-item__heading",
|
|
82
|
+
children: [
|
|
83
|
+
/*#__PURE__*/ jsxRuntime.jsx("span", {
|
|
84
|
+
className: "playbill-item__version",
|
|
85
|
+
children: summary.version
|
|
86
|
+
}),
|
|
87
|
+
summary.version === current && /*#__PURE__*/ jsxRuntime.jsx("span", {
|
|
88
|
+
className: "playbill-tag playbill-tag--current",
|
|
89
|
+
children: resolved.current
|
|
90
|
+
}),
|
|
91
|
+
isUnread(summary.version) && /*#__PURE__*/ jsxRuntime.jsx("span", {
|
|
92
|
+
className: "playbill-tag playbill-tag--unread",
|
|
93
|
+
children: resolved.unread
|
|
94
|
+
})
|
|
95
|
+
]
|
|
96
|
+
}),
|
|
97
|
+
date && /*#__PURE__*/ jsxRuntime.jsx("span", {
|
|
98
|
+
className: "playbill-item__date",
|
|
99
|
+
children: date
|
|
100
|
+
}),
|
|
101
|
+
summary.summary && /*#__PURE__*/ jsxRuntime.jsx("span", {
|
|
102
|
+
className: "playbill-item__summary",
|
|
103
|
+
children: summary.summary
|
|
104
|
+
})
|
|
105
|
+
]
|
|
106
|
+
})
|
|
107
|
+
}, summary.version);
|
|
108
|
+
})
|
|
109
|
+
})
|
|
110
|
+
}),
|
|
111
|
+
/*#__PURE__*/ jsxRuntime.jsxs("div", {
|
|
112
|
+
className: "playbill__content",
|
|
113
|
+
children: [
|
|
114
|
+
isLoadingNote && /*#__PURE__*/ jsxRuntime.jsx("p", {
|
|
115
|
+
className: "playbill-status",
|
|
116
|
+
role: "status",
|
|
117
|
+
children: resolved.loading
|
|
118
|
+
}),
|
|
119
|
+
!isLoadingNote && note && /*#__PURE__*/ jsxRuntime.jsx(Release, {
|
|
120
|
+
release: note,
|
|
121
|
+
assetBase: client.assetBase(note.version),
|
|
122
|
+
labels: resolved,
|
|
123
|
+
markdown: markdown ?? PlaybillMarkdown.PlaybillMarkdown,
|
|
124
|
+
locale: locale,
|
|
125
|
+
isUnread: selectedIsUnread,
|
|
126
|
+
isCurrent: note.version === current
|
|
127
|
+
})
|
|
128
|
+
]
|
|
129
|
+
})
|
|
130
|
+
]
|
|
131
|
+
});
|
|
132
|
+
};
|
|
133
|
+
|
|
134
|
+
exports.Playbill = Playbill;
|
|
135
|
+
//# sourceMappingURL=Playbill.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Playbill.js","sources":["../../Playbill.tsx"],"sourcesContent":["// Copyright (c) Cratis. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for full license information.\n\nimport { ComponentType, useEffect, useMemo, useState } from 'react';\nimport { usePlaybillClient } from './Configuration/index.js';\nimport { PlaybillLabels, resolveLabels } from './Labels/index.js';\nimport { PlaybillMarkdown, PlaybillMarkdownProps } from './Markdown/index.js';\nimport { formatReleaseDate, ReleaseNoteView, ReleaseNoteViewProps } from './Release/index.js';\nimport { usePlaybill } from './usePlaybill.js';\nimport { useRelease } from './useReleases.js';\n\n/**\n * Props for {@link Playbill}.\n */\nexport interface PlaybillProps {\n /** Replaces how the selected release is drawn. */\n release?: ComponentType<ReleaseNoteViewProps>;\n /** Replaces the Markdown renderer the default release view uses, and that a custom one is given. */\n markdown?: ComponentType<PlaybillMarkdownProps>;\n /** The texts to replace; the rest stay English. */\n labels?: Partial<PlaybillLabels>;\n /** The locale to write the dates in; the browser's when not given. */\n locale?: string | string[];\n /** The version to show. Give it, with `onSelect`, to keep the selection in the address; by default the newest is selected. */\n selected?: string;\n /** Called when the person picks another release. */\n onSelect?: (version: string) => void;\n /** Records that the person has seen a release when it is shown. On by default; turn it off to leave what is unread to a dialog. */\n markSeenWhenShown?: boolean;\n}\n\n/**\n * The release notes of the application as a page: the releases newest first on one side and the selected release on the\n * other. It marks what the person has not seen with a tag, and records a release as seen when it is shown. Place it\n * where the application has room for a page, inside Arc's context. It draws no heading of its own.\n */\nexport const Playbill = ({\n release: Release = ReleaseNoteView,\n markdown,\n labels,\n locale,\n selected,\n onSelect,\n markSeenWhenShown = true\n}: PlaybillProps) => {\n const client = usePlaybillClient();\n const { releases, current, isLoading, error, unreadVersions, markSeen } = usePlaybill();\n const resolved = useMemo(() => resolveLabels(labels), [labels]);\n const [picked, setPicked] = useState<string>();\n const version = selected ?? picked ?? releases[0]?.version;\n const { data: note, isLoading: isLoadingNote, error: noteError } = useRelease(version);\n const isUnread = (candidate?: string) => candidate !== undefined && unreadVersions.includes(candidate);\n const selectedIsUnread = isUnread(version);\n\n useEffect(() => {\n if (markSeenWhenShown && note && selectedIsUnread) {\n // Failing to remember it must not keep a person from reading on.\n markSeen(note.version).catch(() => undefined);\n }\n }, [markSeenWhenShown, note, selectedIsUnread, markSeen]);\n\n const select = (next: string) => {\n setPicked(next);\n onSelect?.(next);\n };\n\n if (error || noteError) {\n return <p className='playbill-status playbill-status--failed' role='alert'>{resolved.failed}</p>;\n }\n\n if (isLoading) {\n return <p className='playbill-status' role='status'>{resolved.loading}</p>;\n }\n\n if (releases.length === 0) {\n return <p className='playbill-status'>{resolved.empty}</p>;\n }\n\n return (\n <div className='playbill'>\n <nav className='playbill__list' aria-label={resolved.releases}>\n <ul>\n {releases.map(summary => {\n const date = formatReleaseDate(summary.releasedAt, locale);\n const isSelected = summary.version === version;\n return (\n <li key={summary.version}>\n <button\n type='button'\n className={isSelected ? 'playbill-item playbill-item--selected' : 'playbill-item'}\n aria-current={isSelected ? 'true' : undefined}\n onClick={() => select(summary.version)}>\n <span className='playbill-item__heading'>\n <span className='playbill-item__version'>{summary.version}</span>\n {summary.version === current && <span className='playbill-tag playbill-tag--current'>{resolved.current}</span>}\n {isUnread(summary.version) && <span className='playbill-tag playbill-tag--unread'>{resolved.unread}</span>}\n </span>\n {date && <span className='playbill-item__date'>{date}</span>}\n {summary.summary && <span className='playbill-item__summary'>{summary.summary}</span>}\n </button>\n </li>\n );\n })}\n </ul>\n </nav>\n <div className='playbill__content'>\n {isLoadingNote && <p className='playbill-status' role='status'>{resolved.loading}</p>}\n {!isLoadingNote && note && (\n <Release\n release={note}\n assetBase={client.assetBase(note.version)}\n labels={resolved}\n markdown={markdown ?? PlaybillMarkdown}\n locale={locale}\n isUnread={selectedIsUnread}\n isCurrent={note.version === current} />\n )}\n </div>\n </div>\n );\n};\n"],"names":["Playbill","release","Release","ReleaseNoteView","markdown","labels","locale","selected","onSelect","markSeenWhenShown","client","usePlaybillClient","releases","current","isLoading","error","unreadVersions","markSeen","usePlaybill","resolved","useMemo","resolveLabels","picked","setPicked","useState","version","data","note","isLoadingNote","noteError","useRelease","isUnread","candidate","undefined","includes","selectedIsUnread","useEffect","catch","select","next","_jsx","p","className","role","failed","loading","length","empty","_jsxs","div","nav","aria-label","ul","map","summary","date","formatReleaseDate","releasedAt","isSelected","li","button","type","aria-current","onClick","span","unread","assetBase","PlaybillMarkdown","isCurrent"],"mappings":";;;;;;;;;;;;AA+BA;;;;UAKaA,QAAAA,GAAW,CAAC,EACrBC,OAAAA,EAASC,OAAAA,GAAUC,+BAAe,EAClCC,QAAQ,EACRC,MAAM,EACNC,MAAM,EACNC,QAAQ,EACRC,QAAQ,EACRC,iBAAAA,GAAoB,IAAI,EACZ,GAAA;AACZ,IAAA,MAAMC,MAAAA,GAASC,kCAAAA,EAAAA;AACf,IAAA,MAAM,EAAEC,QAAQ,EAAEC,OAAO,EAAEC,SAAS,EAAEC,KAAK,EAAEC,cAAc,EAAEC,QAAQ,EAAE,GAAGC,uBAAAA,EAAAA;AAC1E,IAAA,MAAMC,QAAAA,GAAWC,aAAAA,CAAQ,IAAMC,2BAAAA,CAAchB,MAAAA,CAAAA,EAAS;AAACA,QAAAA;AAAO,KAAA,CAAA;IAC9D,MAAM,CAACiB,MAAAA,EAAQC,SAAAA,CAAU,GAAGC,cAAAA,EAAAA;AAC5B,IAAA,MAAMC,UAAUlB,QAAAA,IAAYe,MAAAA,IAAUV,QAAQ,CAAC,EAAE,EAAEa,OAAAA;IACnD,MAAM,EAAEC,IAAAA,EAAMC,IAAI,EAAEb,SAAAA,EAAWc,aAAa,EAAEb,KAAAA,EAAOc,SAAS,EAAE,GAAGC,sBAAAA,CAAWL,OAAAA,CAAAA;AAC9E,IAAA,MAAMM,WAAW,CAACC,SAAAA,GAAuBA,cAAcC,SAAAA,IAAajB,cAAAA,CAAekB,QAAQ,CAACF,SAAAA,CAAAA;AAC5F,IAAA,MAAMG,mBAAmBJ,QAAAA,CAASN,OAAAA,CAAAA;IAElCW,eAAAA,CAAU,IAAA;QACN,IAAI3B,iBAAAA,IAAqBkB,QAAQQ,gBAAAA,EAAkB;;AAE/ClB,YAAAA,QAAAA,CAASU,IAAAA,CAAKF,OAAO,CAAA,CAAEY,KAAK,CAAC,IAAMJ,SAAAA,CAAAA;AACvC,QAAA;IACJ,CAAA,EAAG;AAACxB,QAAAA,iBAAAA;AAAmBkB,QAAAA,IAAAA;AAAMQ,QAAAA,gBAAAA;AAAkBlB,QAAAA;AAAS,KAAA,CAAA;AAExD,IAAA,MAAMqB,SAAS,CAACC,IAAAA,GAAAA;QACZhB,SAAAA,CAAUgB,IAAAA,CAAAA;QACV/B,QAAAA,GAAW+B,IAAAA,CAAAA;AACf,IAAA,CAAA;AAEA,IAAA,IAAIxB,SAASc,SAAAA,EAAW;AACpB,QAAA,qBAAOW,cAAA,CAACC,GAAAA,EAAAA;YAAEC,SAAAA,EAAU,yCAAA;YAA0CC,IAAAA,EAAK,OAAA;AAASxB,YAAAA,QAAAA,EAAAA,QAAAA,CAASyB;;AACzF,IAAA;AAEA,IAAA,IAAI9B,SAAAA,EAAW;AACX,QAAA,qBAAO0B,cAAA,CAACC,GAAAA,EAAAA;YAAEC,SAAAA,EAAU,iBAAA;YAAkBC,IAAAA,EAAK,QAAA;AAAUxB,YAAAA,QAAAA,EAAAA,QAAAA,CAAS0B;;AAClE,IAAA;IAEA,IAAIjC,QAAAA,CAASkC,MAAM,KAAK,CAAA,EAAG;AACvB,QAAA,qBAAON,cAAA,CAACC,GAAAA,EAAAA;YAAEC,SAAAA,EAAU,iBAAA;AAAmBvB,YAAAA,QAAAA,EAAAA,QAAAA,CAAS4B;;AACpD,IAAA;AAEA,IAAA,qBACIC,eAAA,CAACC,KAAAA,EAAAA;QAAIP,SAAAA,EAAU,UAAA;;0BACXF,cAAA,CAACU,KAAAA,EAAAA;gBAAIR,SAAAA,EAAU,gBAAA;AAAiBS,gBAAAA,YAAAA,EAAYhC,SAASP,QAAQ;AACzD,gBAAA,QAAA,gBAAA4B,cAAA,CAACY,IAAAA,EAAAA;8BACIxC,QAAAA,CAASyC,GAAG,CAACC,CAAAA,OAAAA,GAAAA;AACV,wBAAA,MAAMC,IAAAA,GAAOC,mCAAAA,CAAkBF,OAAAA,CAAQG,UAAU,EAAEnD,MAAAA,CAAAA;wBACnD,MAAMoD,UAAAA,GAAaJ,OAAAA,CAAQ7B,OAAO,KAAKA,OAAAA;AACvC,wBAAA,qBACIe,cAAA,CAACmB,IAAAA,EAAAA;AACG,4BAAA,QAAA,gBAAAX,eAAA,CAACY,QAAAA,EAAAA;gCACGC,IAAAA,EAAK,QAAA;AACLnB,gCAAAA,SAAAA,EAAWgB,aAAa,uCAAA,GAA0C,eAAA;AAClEI,gCAAAA,cAAAA,EAAcJ,aAAa,MAAA,GAASzB,SAAAA;gCACpC8B,OAAAA,EAAS,IAAMzB,MAAAA,CAAOgB,OAAAA,CAAQ7B,OAAO,CAAA;;kDACrCuB,eAAA,CAACgB,MAAAA,EAAAA;wCAAKtB,SAAAA,EAAU,wBAAA;;0DACZF,cAAA,CAACwB,MAAAA,EAAAA;gDAAKtB,SAAAA,EAAU,wBAAA;AAA0BY,gDAAAA,QAAAA,EAAAA,OAAAA,CAAQ7B;;4CACjD6B,OAAAA,CAAQ7B,OAAO,KAAKZ,OAAAA,kBAAW2B,cAAA,CAACwB,MAAAA,EAAAA;gDAAKtB,SAAAA,EAAU,oCAAA;AAAsCvB,gDAAAA,QAAAA,EAAAA,QAAAA,CAASN;;4CAC9FkB,QAAAA,CAASuB,OAAAA,CAAQ7B,OAAO,CAAA,kBAAKe,cAAA,CAACwB,MAAAA,EAAAA;gDAAKtB,SAAAA,EAAU,mCAAA;AAAqCvB,gDAAAA,QAAAA,EAAAA,QAAAA,CAAS8C;;;;AAE/FV,oCAAAA,IAAAA,kBAAQf,cAAA,CAACwB,MAAAA,EAAAA;wCAAKtB,SAAAA,EAAU,qBAAA;AAAuBa,wCAAAA,QAAAA,EAAAA;;oCAC/CD,OAAAA,CAAQA,OAAO,kBAAId,cAAA,CAACwB,MAAAA,EAAAA;wCAAKtB,SAAAA,EAAU,wBAAA;AAA0BY,wCAAAA,QAAAA,EAAAA,OAAAA,CAAQA;;;;AAZrEA,yBAAAA,EAAAA,OAAAA,CAAQ7B,OAAO,CAAA;AAgBhC,oBAAA,CAAA;;;0BAGRuB,eAAA,CAACC,KAAAA,EAAAA;gBAAIP,SAAAA,EAAU,mBAAA;;AACVd,oBAAAA,aAAAA,kBAAiBY,cAAA,CAACC,GAAAA,EAAAA;wBAAEC,SAAAA,EAAU,iBAAA;wBAAkBC,IAAAA,EAAK,QAAA;AAAUxB,wBAAAA,QAAAA,EAAAA,QAAAA,CAAS0B;;oBACxE,CAACjB,aAAAA,IAAiBD,sBACfa,cAAA,CAACtC,OAAAA,EAAAA;wBACGD,OAAAA,EAAS0B,IAAAA;AACTuC,wBAAAA,SAAAA,EAAWxD,MAAAA,CAAOwD,SAAS,CAACvC,IAAAA,CAAKF,OAAO,CAAA;wBACxCpB,MAAAA,EAAQc,QAAAA;AACRf,wBAAAA,QAAAA,EAAUA,QAAAA,IAAY+D,iCAAAA;wBACtB7D,MAAAA,EAAQA,MAAAA;wBACRyB,QAAAA,EAAUI,gBAAAA;wBACViC,SAAAA,EAAWzC,IAAAA,CAAKF,OAAO,KAAKZ;;;;;;AAKpD;;"}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { ComponentType } from 'react';
|
|
2
|
+
import { Release } from '../Client/index.js';
|
|
3
|
+
import { PlaybillLabels } from '../Labels/index.js';
|
|
4
|
+
import { PlaybillMarkdownProps } from '../Markdown/index.js';
|
|
5
|
+
export interface ReleaseNoteViewProps {
|
|
6
|
+
release: Release;
|
|
7
|
+
assetBase?: string;
|
|
8
|
+
labels: PlaybillLabels;
|
|
9
|
+
markdown?: ComponentType<PlaybillMarkdownProps>;
|
|
10
|
+
locale?: string | string[];
|
|
11
|
+
isUnread?: boolean;
|
|
12
|
+
isCurrent?: boolean;
|
|
13
|
+
headingLevel?: 2 | 3 | 4;
|
|
14
|
+
}
|
|
15
|
+
export declare const ReleaseNoteView: ({ release, assetBase, labels, markdown: Markdown, locale, isUnread, isCurrent, headingLevel }: ReleaseNoteViewProps) => import("react").JSX.Element;
|
|
16
|
+
//# sourceMappingURL=ReleaseNoteView.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ReleaseNoteView.d.ts","sourceRoot":"","sources":["../../../Release/ReleaseNoteView.tsx"],"names":[],"mappings":"AAGA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAoB,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAQ/E,MAAM,WAAW,oBAAoB;IAEjC,OAAO,EAAE,OAAO,CAAC;IAEjB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,MAAM,EAAE,cAAc,CAAC;IAEvB,QAAQ,CAAC,EAAE,aAAa,CAAC,qBAAqB,CAAC,CAAC;IAEhD,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAE3B,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB,YAAY,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;CAC5B;AAMD,eAAO,MAAM,eAAe,GAAI,+FAS7B,oBAAoB,gCAgCtB,CAAC"}
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var jsxRuntime = require('react/jsx-runtime');
|
|
4
|
+
var PlaybillMarkdown = require('../Markdown/PlaybillMarkdown.js');
|
|
5
|
+
var formatReleaseDate = require('./formatReleaseDate.js');
|
|
6
|
+
var sectionPresentation = require('./sectionPresentation.js');
|
|
7
|
+
|
|
8
|
+
// Copyright (c) Cratis. All rights reserved.
|
|
9
|
+
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
|
|
10
|
+
/**
|
|
11
|
+
* One release: its version and date, what its note says before the first section, and each section under its heading.
|
|
12
|
+
* It draws no frame of its own, so a page, a dialog or a product's own surface can hold it.
|
|
13
|
+
*/ const ReleaseNoteView = ({ release, assetBase, labels, markdown: Markdown = PlaybillMarkdown.PlaybillMarkdown, locale, isUnread = false, isCurrent = false, headingLevel = 2 })=>{
|
|
14
|
+
const Heading = `h${headingLevel}`;
|
|
15
|
+
const SectionHeading = `h${headingLevel + 1}`;
|
|
16
|
+
const date = formatReleaseDate.formatReleaseDate(release.releasedAt, locale);
|
|
17
|
+
return /*#__PURE__*/ jsxRuntime.jsxs("article", {
|
|
18
|
+
className: "playbill-release",
|
|
19
|
+
"data-version": release.version,
|
|
20
|
+
children: [
|
|
21
|
+
/*#__PURE__*/ jsxRuntime.jsxs("header", {
|
|
22
|
+
className: "playbill-release__header",
|
|
23
|
+
children: [
|
|
24
|
+
/*#__PURE__*/ jsxRuntime.jsx(Heading, {
|
|
25
|
+
className: "playbill-release__version",
|
|
26
|
+
children: release.version
|
|
27
|
+
}),
|
|
28
|
+
isCurrent && /*#__PURE__*/ jsxRuntime.jsx("span", {
|
|
29
|
+
className: "playbill-tag playbill-tag--current",
|
|
30
|
+
children: labels.current
|
|
31
|
+
}),
|
|
32
|
+
isUnread && /*#__PURE__*/ jsxRuntime.jsx("span", {
|
|
33
|
+
className: "playbill-tag playbill-tag--unread",
|
|
34
|
+
children: labels.unread
|
|
35
|
+
}),
|
|
36
|
+
date && /*#__PURE__*/ jsxRuntime.jsxs("time", {
|
|
37
|
+
className: "playbill-release__date",
|
|
38
|
+
dateTime: release.releasedAt ?? undefined,
|
|
39
|
+
children: [
|
|
40
|
+
labels.released,
|
|
41
|
+
" ",
|
|
42
|
+
date
|
|
43
|
+
]
|
|
44
|
+
})
|
|
45
|
+
]
|
|
46
|
+
}),
|
|
47
|
+
release.lead.trim() !== '' && /*#__PURE__*/ jsxRuntime.jsx("div", {
|
|
48
|
+
className: "playbill-release__lead",
|
|
49
|
+
children: /*#__PURE__*/ jsxRuntime.jsx(Markdown, {
|
|
50
|
+
source: release.lead,
|
|
51
|
+
assetBase: assetBase
|
|
52
|
+
})
|
|
53
|
+
}),
|
|
54
|
+
release.sections.map((section)=>{
|
|
55
|
+
const presentation = sectionPresentation.sectionPresentation(section.name, labels);
|
|
56
|
+
return /*#__PURE__*/ jsxRuntime.jsxs("section", {
|
|
57
|
+
className: `playbill-section playbill-section--${presentation.modifier}`,
|
|
58
|
+
children: [
|
|
59
|
+
/*#__PURE__*/ jsxRuntime.jsx(SectionHeading, {
|
|
60
|
+
className: "playbill-section__title",
|
|
61
|
+
children: presentation.title
|
|
62
|
+
}),
|
|
63
|
+
/*#__PURE__*/ jsxRuntime.jsx(Markdown, {
|
|
64
|
+
source: section.markdown,
|
|
65
|
+
assetBase: assetBase
|
|
66
|
+
})
|
|
67
|
+
]
|
|
68
|
+
}, section.name);
|
|
69
|
+
})
|
|
70
|
+
]
|
|
71
|
+
});
|
|
72
|
+
};
|
|
73
|
+
|
|
74
|
+
exports.ReleaseNoteView = ReleaseNoteView;
|
|
75
|
+
//# sourceMappingURL=ReleaseNoteView.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ReleaseNoteView.js","sources":["../../../Release/ReleaseNoteView.tsx"],"sourcesContent":["// Copyright (c) Cratis. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for full license information.\n\nimport { ComponentType } from 'react';\nimport { Release } from '../Client/index.js';\nimport { PlaybillLabels } from '../Labels/index.js';\nimport { PlaybillMarkdown, PlaybillMarkdownProps } from '../Markdown/index.js';\nimport { formatReleaseDate } from './formatReleaseDate.js';\nimport { sectionPresentation } from './sectionPresentation.js';\n\n/**\n * Props for {@link ReleaseNoteView}, and for the component given to the `release` slot of {@link Playbill} and\n * {@link PlaybillDialog}.\n */\nexport interface ReleaseNoteViewProps {\n /** The release to show. */\n release: Release;\n /** Where the files of the release are served from; given to the Markdown renderer so its images load. */\n assetBase?: string;\n /** The texts to show. */\n labels: PlaybillLabels;\n /** Renders the Markdown of the note; the `markdown` slot of {@link Playbill}. */\n markdown?: ComponentType<PlaybillMarkdownProps>;\n /** The locale to write the date in; the browser's when not given. */\n locale?: string | string[];\n /** Whether the person has not seen this release yet; it is marked with the `unread` text. */\n isUnread?: boolean;\n /** Whether this is the version the application is running; it is marked with the `current` text. */\n isCurrent?: boolean;\n /** The level of the heading of the version, so the release fits under the heading of the page or dialog around it. Defaults to 2. */\n headingLevel?: 2 | 3 | 4;\n}\n\n/**\n * One release: its version and date, what its note says before the first section, and each section under its heading.\n * It draws no frame of its own, so a page, a dialog or a product's own surface can hold it.\n */\nexport const ReleaseNoteView = ({\n release,\n assetBase,\n labels,\n markdown: Markdown = PlaybillMarkdown,\n locale,\n isUnread = false,\n isCurrent = false,\n headingLevel = 2\n}: ReleaseNoteViewProps) => {\n const Heading = `h${headingLevel}` as 'h2';\n const SectionHeading = `h${headingLevel + 1}` as 'h3';\n const date = formatReleaseDate(release.releasedAt, locale);\n return (\n <article className='playbill-release' data-version={release.version}>\n <header className='playbill-release__header'>\n <Heading className='playbill-release__version'>{release.version}</Heading>\n {isCurrent && <span className='playbill-tag playbill-tag--current'>{labels.current}</span>}\n {isUnread && <span className='playbill-tag playbill-tag--unread'>{labels.unread}</span>}\n {date && (\n <time className='playbill-release__date' dateTime={release.releasedAt ?? undefined}>\n {labels.released} {date}\n </time>\n )}\n </header>\n {release.lead.trim() !== '' && (\n <div className='playbill-release__lead'>\n <Markdown source={release.lead} assetBase={assetBase} />\n </div>\n )}\n {release.sections.map(section => {\n const presentation = sectionPresentation(section.name, labels);\n return (\n <section key={section.name} className={`playbill-section playbill-section--${presentation.modifier}`}>\n <SectionHeading className='playbill-section__title'>{presentation.title}</SectionHeading>\n <Markdown source={section.markdown} assetBase={assetBase} />\n </section>\n );\n })}\n </article>\n );\n};\n"],"names":["ReleaseNoteView","release","assetBase","labels","markdown","Markdown","PlaybillMarkdown","locale","isUnread","isCurrent","headingLevel","Heading","SectionHeading","date","formatReleaseDate","releasedAt","_jsxs","article","className","data-version","version","header","_jsx","span","current","unread","time","dateTime","undefined","released","lead","trim","div","source","sections","map","section","presentation","sectionPresentation","name","modifier","title"],"mappings":";;;;;;;AAAA;AACA;AAgCA;;;IAIO,MAAMA,eAAAA,GAAkB,CAAC,EAC5BC,OAAO,EACPC,SAAS,EACTC,MAAM,EACNC,QAAAA,EAAUC,WAAWC,iCAAgB,EACrCC,MAAM,EACNC,QAAAA,GAAW,KAAK,EAChBC,SAAAA,GAAY,KAAK,EACjBC,YAAAA,GAAe,CAAC,EACG,GAAA;AACnB,IAAA,MAAMC,OAAAA,GAAU,CAAC,CAAC,EAAED,YAAAA,CAAAA,CAAc;AAClC,IAAA,MAAME,cAAAA,GAAiB,CAAC,CAAC,EAAEF,eAAe,CAAA,CAAA,CAAG;AAC7C,IAAA,MAAMG,IAAAA,GAAOC,mCAAAA,CAAkBb,OAAAA,CAAQc,UAAU,EAAER,MAAAA,CAAAA;AACnD,IAAA,qBACIS,eAAA,CAACC,SAAAA,EAAAA;QAAQC,SAAAA,EAAU,kBAAA;AAAmBC,QAAAA,cAAAA,EAAclB,QAAQmB,OAAO;;0BAC/DJ,eAAA,CAACK,QAAAA,EAAAA;gBAAOH,SAAAA,EAAU,0BAAA;;kCACdI,cAAA,CAACX,OAAAA,EAAAA;wBAAQO,SAAAA,EAAU,2BAAA;AAA6BjB,wBAAAA,QAAAA,EAAAA,OAAAA,CAAQmB;;AACvDX,oBAAAA,SAAAA,kBAAaa,cAAA,CAACC,MAAAA,EAAAA;wBAAKL,SAAAA,EAAU,oCAAA;AAAsCf,wBAAAA,QAAAA,EAAAA,MAAAA,CAAOqB;;AAC1EhB,oBAAAA,QAAAA,kBAAYc,cAAA,CAACC,MAAAA,EAAAA;wBAAKL,SAAAA,EAAU,mCAAA;AAAqCf,wBAAAA,QAAAA,EAAAA,MAAAA,CAAOsB;;AACxEZ,oBAAAA,IAAAA,kBACGG,eAAA,CAACU,MAAAA,EAAAA;wBAAKR,SAAAA,EAAU,wBAAA;wBAAyBS,QAAAA,EAAU1B,OAAAA,CAAQc,UAAU,IAAIa,SAAAA;;AACpEzB,4BAAAA,MAAAA,CAAO0B,QAAQ;AAAC,4BAAA,GAAA;AAAEhB,4BAAAA;;;;;AAI9BZ,YAAAA,OAAAA,CAAQ6B,IAAI,CAACC,IAAI,EAAA,KAAO,oBACrBT,cAAA,CAACU,KAAAA,EAAAA;gBAAId,SAAAA,EAAU,wBAAA;AACX,gBAAA,QAAA,gBAAAI,cAAA,CAACjB,QAAAA,EAAAA;AAAS4B,oBAAAA,MAAAA,EAAQhC,QAAQ6B,IAAI;oBAAE5B,SAAAA,EAAWA;;;AAGlDD,YAAAA,OAAAA,CAAQiC,QAAQ,CAACC,GAAG,CAACC,CAAAA,OAAAA,GAAAA;AAClB,gBAAA,MAAMC,YAAAA,GAAeC,uCAAAA,CAAoBF,OAAAA,CAAQG,IAAI,EAAEpC,MAAAA,CAAAA;AACvD,gBAAA,qBACIa,eAAA,CAACoB,SAAAA,EAAAA;AAA2BlB,oBAAAA,SAAAA,EAAW,CAAC,mCAAmC,EAAEmB,YAAAA,CAAaG,QAAQ,CAAA,CAAE;;sCAChGlB,cAAA,CAACV,cAAAA,EAAAA;4BAAeM,SAAAA,EAAU,yBAAA;AAA2BmB,4BAAAA,QAAAA,EAAAA,YAAAA,CAAaI;;sCAClEnB,cAAA,CAACjB,QAAAA,EAAAA;AAAS4B,4BAAAA,MAAAA,EAAQG,QAAQhC,QAAQ;4BAAEF,SAAAA,EAAWA;;;AAFrCkC,iBAAAA,EAAAA,OAAAA,CAAQG,IAAI,CAAA;AAKlC,YAAA,CAAA;;;AAGZ;;"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"formatReleaseDate.d.ts","sourceRoot":"","sources":["../../../Release/formatReleaseDate.ts"],"names":[],"mappings":"AAUA,eAAO,MAAM,iBAAiB,GAAI,aAAa,MAAM,GAAG,IAAI,EAAE,SAAS,MAAM,GAAG,MAAM,EAAE,KAAG,MAW1F,CAAC"}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
// Copyright (c) Cratis. All rights reserved.
|
|
4
|
+
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
|
|
5
|
+
/**
|
|
6
|
+
* Formats the date a release was made. The date is the one in UTC, so every person reads the same day whatever time
|
|
7
|
+
* zone they are in.
|
|
8
|
+
* @param releasedAt The ISO date the release was made; absent when it was not recorded.
|
|
9
|
+
* @param locale The locale to write it in; the browser's when not given.
|
|
10
|
+
* @returns The date, or an empty string when there is none or it cannot be read.
|
|
11
|
+
*/ const formatReleaseDate = (releasedAt, locale)=>{
|
|
12
|
+
if (!releasedAt) {
|
|
13
|
+
return '';
|
|
14
|
+
}
|
|
15
|
+
const date = new Date(releasedAt);
|
|
16
|
+
if (Number.isNaN(date.getTime())) {
|
|
17
|
+
return '';
|
|
18
|
+
}
|
|
19
|
+
return new Intl.DateTimeFormat(locale, {
|
|
20
|
+
dateStyle: 'long',
|
|
21
|
+
timeZone: 'UTC'
|
|
22
|
+
}).format(date);
|
|
23
|
+
};
|
|
24
|
+
|
|
25
|
+
exports.formatReleaseDate = formatReleaseDate;
|
|
26
|
+
//# sourceMappingURL=formatReleaseDate.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"formatReleaseDate.js","sources":["../../../Release/formatReleaseDate.ts"],"sourcesContent":["// Copyright (c) Cratis. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for full license information.\n\n/**\n * Formats the date a release was made. The date is the one in UTC, so every person reads the same day whatever time\n * zone they are in.\n * @param releasedAt The ISO date the release was made; absent when it was not recorded.\n * @param locale The locale to write it in; the browser's when not given.\n * @returns The date, or an empty string when there is none or it cannot be read.\n */\nexport const formatReleaseDate = (releasedAt?: string | null, locale?: string | string[]): string => {\n if (!releasedAt) {\n return '';\n }\n\n const date = new Date(releasedAt);\n if (Number.isNaN(date.getTime())) {\n return '';\n }\n\n return new Intl.DateTimeFormat(locale, { dateStyle: 'long', timeZone: 'UTC' }).format(date);\n};\n"],"names":["formatReleaseDate","releasedAt","locale","date","Date","Number","isNaN","getTime","Intl","DateTimeFormat","dateStyle","timeZone","format"],"mappings":";;AAAA;AACA;AAEA;;;;;;AAMC,IACM,MAAMA,iBAAAA,GAAoB,CAACC,UAAAA,EAA4BC,MAAAA,GAAAA;AAC1D,IAAA,IAAI,CAACD,UAAAA,EAAY;QACb,OAAO,EAAA;AACX,IAAA;IAEA,MAAME,IAAAA,GAAO,IAAIC,IAAAA,CAAKH,UAAAA,CAAAA;AACtB,IAAA,IAAII,MAAAA,CAAOC,KAAK,CAACH,IAAAA,CAAKI,OAAO,EAAA,CAAA,EAAK;QAC9B,OAAO,EAAA;AACX,IAAA;AAEA,IAAA,OAAO,IAAIC,IAAAA,CAAKC,cAAc,CAACP,MAAAA,EAAQ;QAAEQ,SAAAA,EAAW,MAAA;QAAQC,QAAAA,EAAU;AAAM,KAAA,CAAA,CAAGC,MAAM,CAACT,IAAAA,CAAAA;AAC1F;;"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../Release/index.ts"],"names":[],"mappings":"AAGA,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,0BAA0B,CAAC"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { PlaybillLabels } from '../Labels/index.js';
|
|
2
|
+
export interface SectionPresentation {
|
|
3
|
+
title: string;
|
|
4
|
+
modifier: string;
|
|
5
|
+
}
|
|
6
|
+
export declare const sectionPresentation: (name: string, labels: PlaybillLabels) => SectionPresentation;
|
|
7
|
+
//# sourceMappingURL=sectionPresentation.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sectionPresentation.d.ts","sourceRoot":"","sources":["../../../Release/sectionPresentation.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAKpD,MAAM,WAAW,mBAAmB;IAEhC,KAAK,EAAE,MAAM,CAAC;IAEd,QAAQ,EAAE,MAAM,CAAC;CACpB;AAkBD,eAAO,MAAM,mBAAmB,GAAI,MAAM,MAAM,EAAE,QAAQ,cAAc,KAAG,mBAG1E,CAAC"}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
// Copyright (c) Cratis. All rights reserved.
|
|
4
|
+
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
|
|
5
|
+
const known = {
|
|
6
|
+
added: 'added',
|
|
7
|
+
changed: 'changed',
|
|
8
|
+
fixed: 'fixed',
|
|
9
|
+
removed: 'removed',
|
|
10
|
+
security: 'security',
|
|
11
|
+
deprecated: 'deprecated'
|
|
12
|
+
};
|
|
13
|
+
/**
|
|
14
|
+
* Works out how a section of a release note is drawn. The sections of a release note are the six the release notes of
|
|
15
|
+
* every Cratis repository use; a heading written any other way is shown as it was written.
|
|
16
|
+
* @param name The heading of the section.
|
|
17
|
+
* @param labels The texts to show.
|
|
18
|
+
* @returns The title and the style of the section.
|
|
19
|
+
*/ const sectionPresentation = (name, labels)=>{
|
|
20
|
+
const key = known[name.trim().toLowerCase()];
|
|
21
|
+
return key ? {
|
|
22
|
+
title: labels[key],
|
|
23
|
+
modifier: key
|
|
24
|
+
} : {
|
|
25
|
+
title: name,
|
|
26
|
+
modifier: 'other'
|
|
27
|
+
};
|
|
28
|
+
};
|
|
29
|
+
|
|
30
|
+
exports.sectionPresentation = sectionPresentation;
|
|
31
|
+
//# sourceMappingURL=sectionPresentation.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sectionPresentation.js","sources":["../../../Release/sectionPresentation.ts"],"sourcesContent":["// Copyright (c) Cratis. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for full license information.\n\nimport { PlaybillLabels } from '../Labels/index.js';\n\n/**\n * How a section of a release note is drawn.\n */\nexport interface SectionPresentation {\n /** The heading to show; the text the product gave for a known section, and the heading as written for any other. */\n title: string;\n /** The modifier of the `playbill-section` class, such as `added`; `other` for a heading that is not a known one. */\n modifier: string;\n}\n\nconst known: Record<string, keyof PlaybillLabels> = {\n added: 'added',\n changed: 'changed',\n fixed: 'fixed',\n removed: 'removed',\n security: 'security',\n deprecated: 'deprecated'\n};\n\n/**\n * Works out how a section of a release note is drawn. The sections of a release note are the six the release notes of\n * every Cratis repository use; a heading written any other way is shown as it was written.\n * @param name The heading of the section.\n * @param labels The texts to show.\n * @returns The title and the style of the section.\n */\nexport const sectionPresentation = (name: string, labels: PlaybillLabels): SectionPresentation => {\n const key = known[name.trim().toLowerCase()];\n return key ? { title: labels[key], modifier: key } : { title: name, modifier: 'other' };\n};\n"],"names":["known","added","changed","fixed","removed","security","deprecated","sectionPresentation","name","labels","key","trim","toLowerCase","title","modifier"],"mappings":";;AAAA;AACA;AAcA,MAAMA,KAAAA,GAA8C;IAChDC,KAAAA,EAAO,OAAA;IACPC,OAAAA,EAAS,SAAA;IACTC,KAAAA,EAAO,OAAA;IACPC,OAAAA,EAAS,SAAA;IACTC,QAAAA,EAAU,UAAA;IACVC,UAAAA,EAAY;AAChB,CAAA;AAEA;;;;;;AAMC,IACM,MAAMC,mBAAAA,GAAsB,CAACC,IAAAA,EAAcC,MAAAA,GAAAA;AAC9C,IAAA,MAAMC,MAAMV,KAAK,CAACQ,KAAKG,IAAI,EAAA,CAAGC,WAAW,EAAA,CAAG;AAC5C,IAAA,OAAOF,GAAAA,GAAM;QAAEG,KAAAA,EAAOJ,MAAM,CAACC,GAAAA,CAAI;QAAEI,QAAAA,EAAUJ;KAAI,GAAI;QAAEG,KAAAA,EAAOL,IAAAA;QAAMM,QAAAA,EAAU;AAAQ,KAAA;AAC1F;;"}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
export * from './Badge/index.js';
|
|
2
|
+
export * from './Client/index.js';
|
|
3
|
+
export * from './Configuration/index.js';
|
|
4
|
+
export * from './Dialog/index.js';
|
|
5
|
+
export * from './Icons.js';
|
|
6
|
+
export * from './Labels/index.js';
|
|
7
|
+
export * from './Markdown/index.js';
|
|
8
|
+
export * from './Playbill.js';
|
|
9
|
+
export * from './Release/index.js';
|
|
10
|
+
export * from './usePlaybill.js';
|
|
11
|
+
export * from './usePlaybillStatus.js';
|
|
12
|
+
export * from './useReleases.js';
|
|
13
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAGA,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,mBAAmB,CAAC;AAClC,cAAc,YAAY,CAAC;AAC3B,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,eAAe,CAAC;AAC9B,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,kBAAkB,CAAC"}
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var PlaybillBadge = require('./Badge/PlaybillBadge.js');
|
|
4
|
+
var PlaybillClient = require('./Client/PlaybillClient.js');
|
|
5
|
+
var PlaybillProvider = require('./Configuration/PlaybillProvider.js');
|
|
6
|
+
var PlaybillDialog = require('./Dialog/PlaybillDialog.js');
|
|
7
|
+
var Icons = require('./Icons.js');
|
|
8
|
+
var defaultPlaybillLabels = require('./Labels/defaultPlaybillLabels.js');
|
|
9
|
+
var resolveLabels = require('./Labels/resolveLabels.js');
|
|
10
|
+
var assetUrl = require('./Markdown/assetUrl.js');
|
|
11
|
+
var PlaybillMarkdown = require('./Markdown/PlaybillMarkdown.js');
|
|
12
|
+
var safeLink = require('./Markdown/safeLink.js');
|
|
13
|
+
var Playbill = require('./Playbill.js');
|
|
14
|
+
var formatReleaseDate = require('./Release/formatReleaseDate.js');
|
|
15
|
+
var ReleaseNoteView = require('./Release/ReleaseNoteView.js');
|
|
16
|
+
var sectionPresentation = require('./Release/sectionPresentation.js');
|
|
17
|
+
var usePlaybill = require('./usePlaybill.js');
|
|
18
|
+
var usePlaybillStatus = require('./usePlaybillStatus.js');
|
|
19
|
+
var useReleases = require('./useReleases.js');
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
exports.PlaybillBadge = PlaybillBadge.PlaybillBadge;
|
|
24
|
+
exports.PlaybillClient = PlaybillClient.PlaybillClient;
|
|
25
|
+
exports.defaultBasePath = PlaybillClient.defaultBasePath;
|
|
26
|
+
exports.PlaybillProvider = PlaybillProvider.PlaybillProvider;
|
|
27
|
+
exports.usePlaybillClient = PlaybillProvider.usePlaybillClient;
|
|
28
|
+
exports.PlaybillDialog = PlaybillDialog.PlaybillDialog;
|
|
29
|
+
exports.PlaybillIcon = Icons.PlaybillIcon;
|
|
30
|
+
exports.defaultPlaybillLabels = defaultPlaybillLabels.defaultPlaybillLabels;
|
|
31
|
+
exports.resolveLabels = resolveLabels.resolveLabels;
|
|
32
|
+
exports.withCount = resolveLabels.withCount;
|
|
33
|
+
exports.resolveAssetUrl = assetUrl.resolveAssetUrl;
|
|
34
|
+
exports.PlaybillMarkdown = PlaybillMarkdown.PlaybillMarkdown;
|
|
35
|
+
exports.isSafeLink = safeLink.isSafeLink;
|
|
36
|
+
exports.safeLinkOrEmpty = safeLink.safeLinkOrEmpty;
|
|
37
|
+
exports.Playbill = Playbill.Playbill;
|
|
38
|
+
exports.formatReleaseDate = formatReleaseDate.formatReleaseDate;
|
|
39
|
+
exports.ReleaseNoteView = ReleaseNoteView.ReleaseNoteView;
|
|
40
|
+
exports.sectionPresentation = sectionPresentation.sectionPresentation;
|
|
41
|
+
exports.usePlaybill = usePlaybill.usePlaybill;
|
|
42
|
+
exports.usePlaybillStatus = usePlaybillStatus.usePlaybillStatus;
|
|
43
|
+
exports.useRelease = useReleases.useRelease;
|
|
44
|
+
exports.useReleaseNotes = useReleases.useReleaseNotes;
|
|
45
|
+
exports.useReleases = useReleases.useReleases;
|
|
46
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"useLoaded.d.ts","sourceRoot":"","sources":["../../useLoaded.ts"],"names":[],"mappings":"AAQA,MAAM,WAAW,MAAM,CAAC,KAAK;IAEzB,IAAI,CAAC,EAAE,KAAK,CAAC;IAEb,SAAS,EAAE,OAAO,CAAC;IAEnB,KAAK,CAAC,EAAE,KAAK,CAAC;CACjB;AAQD,eAAO,MAAM,SAAS,GAAI,KAAK,EAAG,MAAM,CAAC,MAAM,EAAE,WAAW,KAAK,OAAO,CAAC,KAAK,CAAC,KAAG,MAAM,CAAC,KAAK,CAqB7F,CAAC"}
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var react = require('react');
|
|
4
|
+
|
|
5
|
+
// Copyright (c) Cratis. All rights reserved.
|
|
6
|
+
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
|
|
7
|
+
/**
|
|
8
|
+
* Reads something when the component is shown and again whenever the read changes, cancelling a read that is no longer
|
|
9
|
+
* wanted. The read must be stable between renders, for example made with `useCallback`.
|
|
10
|
+
* @param load Starts the read; gets a signal that is aborted when it is no longer wanted.
|
|
11
|
+
* @returns What was read, whether it is still being read, and why it failed.
|
|
12
|
+
*/ const useLoaded = (load)=>{
|
|
13
|
+
const [state, setState] = react.useState({
|
|
14
|
+
isLoading: true
|
|
15
|
+
});
|
|
16
|
+
react.useEffect(()=>{
|
|
17
|
+
const controller = new AbortController();
|
|
18
|
+
setState((previous)=>({
|
|
19
|
+
isLoading: true,
|
|
20
|
+
data: previous.data
|
|
21
|
+
}));
|
|
22
|
+
load(controller.signal).then((data)=>{
|
|
23
|
+
if (!controller.signal.aborted) {
|
|
24
|
+
setState({
|
|
25
|
+
isLoading: false,
|
|
26
|
+
data
|
|
27
|
+
});
|
|
28
|
+
}
|
|
29
|
+
}).catch((error)=>{
|
|
30
|
+
if (!controller.signal.aborted) {
|
|
31
|
+
setState({
|
|
32
|
+
isLoading: false,
|
|
33
|
+
error: error instanceof Error ? error : new Error(String(error))
|
|
34
|
+
});
|
|
35
|
+
}
|
|
36
|
+
});
|
|
37
|
+
return ()=>controller.abort();
|
|
38
|
+
}, [
|
|
39
|
+
load
|
|
40
|
+
]);
|
|
41
|
+
return state;
|
|
42
|
+
};
|
|
43
|
+
|
|
44
|
+
exports.useLoaded = useLoaded;
|
|
45
|
+
//# sourceMappingURL=useLoaded.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"useLoaded.js","sources":["../../useLoaded.ts"],"sourcesContent":["// Copyright (c) Cratis. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for full license information.\n\nimport { useEffect, useState } from 'react';\n\n/**\n * What {@link useLoaded} gives a component.\n */\nexport interface Loaded<TData> {\n /** What was read; absent until the first read has finished, and while the read is repeated for another input. */\n data?: TData;\n /** Whether a read is in progress. */\n isLoading: boolean;\n /** Why the last read failed; absent when it did not. */\n error?: Error;\n}\n\n/**\n * Reads something when the component is shown and again whenever the read changes, cancelling a read that is no longer\n * wanted. The read must be stable between renders, for example made with `useCallback`.\n * @param load Starts the read; gets a signal that is aborted when it is no longer wanted.\n * @returns What was read, whether it is still being read, and why it failed.\n */\nexport const useLoaded = <TData,>(load: (signal: AbortSignal) => Promise<TData>): Loaded<TData> => {\n const [state, setState] = useState<Loaded<TData>>({ isLoading: true });\n\n useEffect(() => {\n const controller = new AbortController();\n setState(previous => ({ isLoading: true, data: previous.data }));\n load(controller.signal)\n .then(data => {\n if (!controller.signal.aborted) {\n setState({ isLoading: false, data });\n }\n })\n .catch((error: unknown) => {\n if (!controller.signal.aborted) {\n setState({ isLoading: false, error: error instanceof Error ? error : new Error(String(error)) });\n }\n });\n return () => controller.abort();\n }, [load]);\n\n return state;\n};\n"],"names":["useLoaded","load","state","setState","useState","isLoading","useEffect","controller","AbortController","previous","data","signal","then","aborted","catch","error","Error","String","abort"],"mappings":";;;;AAAA;AACA;AAgBA;;;;;IAMO,MAAMA,SAAAA,GAAY,CAASC,IAAAA,GAAAA;AAC9B,IAAA,MAAM,CAACC,KAAAA,EAAOC,QAAAA,CAAS,GAAGC,cAAAA,CAAwB;QAAEC,SAAAA,EAAW;AAAK,KAAA,CAAA;IAEpEC,eAAAA,CAAU,IAAA;AACN,QAAA,MAAMC,aAAa,IAAIC,eAAAA,EAAAA;QACvBL,QAAAA,CAASM,CAAAA,YAAa;gBAAEJ,SAAAA,EAAW,IAAA;AAAMK,gBAAAA,IAAAA,EAAMD,SAASC;aAAK,CAAA,CAAA;AAC7DT,QAAAA,IAAAA,CAAKM,UAAAA,CAAWI,MAAM,CAAA,CACjBC,IAAI,CAACF,CAAAA,IAAAA,GAAAA;AACF,YAAA,IAAI,CAACH,UAAAA,CAAWI,MAAM,CAACE,OAAO,EAAE;gBAC5BV,QAAAA,CAAS;oBAAEE,SAAAA,EAAW,KAAA;AAAOK,oBAAAA;AAAK,iBAAA,CAAA;AACtC,YAAA;QACJ,CAAA,CAAA,CACCI,KAAK,CAAC,CAACC,KAAAA,GAAAA;AACJ,YAAA,IAAI,CAACR,UAAAA,CAAWI,MAAM,CAACE,OAAO,EAAE;gBAC5BV,QAAAA,CAAS;oBAAEE,SAAAA,EAAW,KAAA;AAAOU,oBAAAA,KAAAA,EAAOA,KAAAA,YAAiBC,KAAAA,GAAQD,KAAAA,GAAQ,IAAIC,MAAMC,MAAAA,CAAOF,KAAAA,CAAAA;AAAQ,iBAAA,CAAA;AAClG,YAAA;AACJ,QAAA,CAAA,CAAA;QACJ,OAAO,IAAMR,WAAWW,KAAK,EAAA;IACjC,CAAA,EAAG;AAACjB,QAAAA;AAAK,KAAA,CAAA;IAET,OAAOC,KAAAA;AACX;;"}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import { UsedReleases } from './useReleases.js';
|
|
2
|
+
import { UsedPlaybillStatus } from './usePlaybillStatus.js';
|
|
3
|
+
export type UsedPlaybill = UsedReleases & UsedPlaybillStatus;
|
|
4
|
+
export declare const usePlaybill: () => UsedPlaybill;
|
|
5
|
+
//# sourceMappingURL=usePlaybill.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"usePlaybill.d.ts","sourceRoot":"","sources":["../../usePlaybill.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAe,MAAM,kBAAkB,CAAC;AAC7D,OAAO,EAAE,kBAAkB,EAAqB,MAAM,wBAAwB,CAAC;AAK/E,MAAM,MAAM,YAAY,GAAG,YAAY,GAAG,kBAAkB,CAAC;AAO7D,eAAO,MAAM,WAAW,QAAO,YAA8D,CAAC"}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var useReleases = require('./useReleases.js');
|
|
4
|
+
var usePlaybillStatus = require('./usePlaybillStatus.js');
|
|
5
|
+
|
|
6
|
+
// Copyright (c) Cratis. All rights reserved.
|
|
7
|
+
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
|
|
8
|
+
/**
|
|
9
|
+
* Reads the release history and observes which releases the signed-in person has not been told about, so a product can
|
|
10
|
+
* draw its own surface instead of {@link Playbill}'s. Must be used inside Arc's context, like every generated query.
|
|
11
|
+
* @returns The releases, and what the person has seen.
|
|
12
|
+
*/ const usePlaybill = ()=>({
|
|
13
|
+
...useReleases.useReleases(),
|
|
14
|
+
...usePlaybillStatus.usePlaybillStatus()
|
|
15
|
+
});
|
|
16
|
+
|
|
17
|
+
exports.usePlaybill = usePlaybill;
|
|
18
|
+
//# sourceMappingURL=usePlaybill.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"usePlaybill.js","sources":["../../usePlaybill.ts"],"sourcesContent":["// Copyright (c) Cratis. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for full license information.\n\nimport { UsedReleases, useReleases } from './useReleases.js';\nimport { UsedPlaybillStatus, usePlaybillStatus } from './usePlaybillStatus.js';\n\n/**\n * What {@link usePlaybill} gives a component: the release history and what the person has seen of it.\n */\nexport type UsedPlaybill = UsedReleases & UsedPlaybillStatus;\n\n/**\n * Reads the release history and observes which releases the signed-in person has not been told about, so a product can\n * draw its own surface instead of {@link Playbill}'s. Must be used inside Arc's context, like every generated query.\n * @returns The releases, and what the person has seen.\n */\nexport const usePlaybill = (): UsedPlaybill => ({ ...useReleases(), ...usePlaybillStatus() });\n"],"names":["usePlaybill","useReleases","usePlaybillStatus"],"mappings":";;;;;AAAA;AACA;AAUA;;;;AAIC,IACM,MAAMA,WAAAA,GAAc,KAAqB;AAAE,QAAA,GAAGC,uBAAAA,EAAa;AAAE,QAAA,GAAGC,mCAAAA;AAAoB,KAAA;;"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
export interface UsedPlaybillStatus {
|
|
2
|
+
lastSeen?: string;
|
|
3
|
+
unread: number;
|
|
4
|
+
unreadVersions: string[];
|
|
5
|
+
markSeen(version: string): Promise<void>;
|
|
6
|
+
}
|
|
7
|
+
export declare const usePlaybillStatus: () => UsedPlaybillStatus;
|
|
8
|
+
//# sourceMappingURL=usePlaybillStatus.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"usePlaybillStatus.d.ts","sourceRoot":"","sources":["../../usePlaybillStatus.ts"],"names":[],"mappings":"AASA,MAAM,WAAW,kBAAkB;IAE/B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,MAAM,EAAE,MAAM,CAAC;IAEf,cAAc,EAAE,MAAM,EAAE,CAAC;IAOzB,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC5C;AAQD,eAAO,MAAM,iBAAiB,QAAO,kBAgBpC,CAAC"}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var showrunner_playbill = require('@cratis/showrunner.playbill');
|
|
4
|
+
var react = require('react');
|
|
5
|
+
|
|
6
|
+
// Copyright (c) Cratis. All rights reserved.
|
|
7
|
+
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
|
|
8
|
+
/**
|
|
9
|
+
* Observes which releases the signed-in person has not been told about, and lets a component record that they have.
|
|
10
|
+
* Must be used inside Arc's context, like every generated query. It needs the backend package
|
|
11
|
+
* `Cratis.Showrunner.Playbill`.
|
|
12
|
+
* @returns What the person has seen and how to record that they have seen more.
|
|
13
|
+
*/ const usePlaybillStatus = ()=>{
|
|
14
|
+
const [result] = showrunner_playbill.ForMe.use();
|
|
15
|
+
const [mark] = showrunner_playbill.MarkReleaseNotesSeen.use();
|
|
16
|
+
const status = result.data?.[0];
|
|
17
|
+
const markSeen = react.useCallback(async (version)=>{
|
|
18
|
+
mark.version = version;
|
|
19
|
+
await mark.execute();
|
|
20
|
+
}, [
|
|
21
|
+
mark
|
|
22
|
+
]);
|
|
23
|
+
return {
|
|
24
|
+
lastSeen: status?.lastSeen || undefined,
|
|
25
|
+
unread: status?.unread ?? 0,
|
|
26
|
+
unreadVersions: [
|
|
27
|
+
...status?.unreadVersions ?? []
|
|
28
|
+
],
|
|
29
|
+
markSeen
|
|
30
|
+
};
|
|
31
|
+
};
|
|
32
|
+
|
|
33
|
+
exports.usePlaybillStatus = usePlaybillStatus;
|
|
34
|
+
//# sourceMappingURL=usePlaybillStatus.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"usePlaybillStatus.js","sources":["../../usePlaybillStatus.ts"],"sourcesContent":["// Copyright (c) Cratis. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for full license information.\n\nimport { ForMe, MarkReleaseNotesSeen } from '@cratis/showrunner.playbill';\nimport { useCallback } from 'react';\n\n/**\n * What {@link usePlaybillStatus} gives a component.\n */\nexport interface UsedPlaybillStatus {\n /** The newest release the person has seen the notes of; absent when they have seen none. */\n lastSeen?: string;\n /** How many releases they have not seen the notes of. */\n unread: number;\n /** The versions of those releases, the newest first. */\n unreadVersions: string[];\n /**\n * Records that the person has seen the release notes up to a version, on every device. It only moves forward, and\n * marking a release they have seen already does nothing.\n * @param version The newest release the person has seen the notes of.\n * @returns Resolves when the command has been sent.\n */\n markSeen(version: string): Promise<void>;\n}\n\n/**\n * Observes which releases the signed-in person has not been told about, and lets a component record that they have.\n * Must be used inside Arc's context, like every generated query. It needs the backend package\n * `Cratis.Showrunner.Playbill`.\n * @returns What the person has seen and how to record that they have seen more.\n */\nexport const usePlaybillStatus = (): UsedPlaybillStatus => {\n const [result] = ForMe.use();\n const [mark] = MarkReleaseNotesSeen.use();\n const status = result.data?.[0];\n\n const markSeen = useCallback(async (version: string) => {\n mark.version = version;\n await mark.execute();\n }, [mark]);\n\n return {\n lastSeen: status?.lastSeen || undefined,\n unread: status?.unread ?? 0,\n unreadVersions: [...status?.unreadVersions ?? []],\n markSeen\n };\n};\n"],"names":["usePlaybillStatus","result","ForMe","use","mark","MarkReleaseNotesSeen","status","data","markSeen","useCallback","version","execute","lastSeen","undefined","unread","unreadVersions"],"mappings":";;;;;AAAA;AACA;AAwBA;;;;;UAMaA,iBAAAA,GAAoB,IAAA;AAC7B,IAAA,MAAM,CAACC,MAAAA,CAAO,GAAGC,yBAAAA,CAAMC,GAAG,EAAA;AAC1B,IAAA,MAAM,CAACC,IAAAA,CAAK,GAAGC,wCAAAA,CAAqBF,GAAG,EAAA;AACvC,IAAA,MAAMG,MAAAA,GAASL,MAAAA,CAAOM,IAAI,GAAG,CAAA,CAAE;IAE/B,MAAMC,QAAAA,GAAWC,kBAAY,OAAOC,OAAAA,GAAAA;AAChCN,QAAAA,IAAAA,CAAKM,OAAO,GAAGA,OAAAA;AACf,QAAA,MAAMN,KAAKO,OAAO,EAAA;IACtB,CAAA,EAAG;AAACP,QAAAA;AAAK,KAAA,CAAA;IAET,OAAO;AACHQ,QAAAA,QAAAA,EAAUN,QAAQM,QAAAA,IAAYC,SAAAA;AAC9BC,QAAAA,MAAAA,EAAQR,QAAQQ,MAAAA,IAAU,CAAA;QAC1BC,cAAAA,EAAgB;AAAIT,YAAAA,GAAAA,MAAAA,EAAQS,kBAAkB;AAAG,SAAA;AACjDP,QAAAA;AACJ,KAAA;AACJ;;"}
|