@detergent-software/atk 9.6.1-dev.9 → 9.6.2-dev.1
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/CHANGELOG.md +112 -0
- package/README.md +8 -8
- package/build/commands/_app.d.ts +29 -0
- package/build/commands/_app.d.ts.map +1 -1
- package/build/commands/_app.js +62 -21
- package/build/commands/_app.js.map +1 -1
- package/build/commands/browse.d.ts +5 -2
- package/build/commands/browse.d.ts.map +1 -1
- package/build/commands/browse.js +17 -13
- package/build/commands/browse.js.map +1 -1
- package/build/commands/list.d.ts +5 -2
- package/build/commands/list.d.ts.map +1 -1
- package/build/commands/list.js +18 -13
- package/build/commands/list.js.map +1 -1
- package/build/commands/upgrade.d.ts +5 -2
- package/build/commands/upgrade.d.ts.map +1 -1
- package/build/commands/upgrade.js +2 -4
- package/build/commands/upgrade.js.map +1 -1
- package/build/components/BrowseList.d.ts.map +1 -1
- package/build/components/BrowseList.js +25 -33
- package/build/components/BrowseList.js.map +1 -1
- package/build/components/BundleDetail.d.ts.map +1 -1
- package/build/components/BundleDetail.js +3 -3
- package/build/components/BundleDetail.js.map +1 -1
- package/build/components/CutDetail.d.ts +14 -0
- package/build/components/CutDetail.d.ts.map +1 -0
- package/build/components/CutDetail.js +14 -0
- package/build/components/CutDetail.js.map +1 -0
- package/build/components/FilterBar.d.ts +17 -0
- package/build/components/FilterBar.d.ts.map +1 -1
- package/build/components/FilterBar.js +54 -6
- package/build/components/FilterBar.js.map +1 -1
- package/build/components/Header.d.ts +3 -1
- package/build/components/Header.d.ts.map +1 -1
- package/build/components/Header.js +4 -1
- package/build/components/Header.js.map +1 -1
- package/build/components/HelpBar.d.ts +1 -1
- package/build/components/HelpBar.js +1 -1
- package/build/components/ListBrowseList.d.ts.map +1 -1
- package/build/components/ListBrowseList.js +17 -25
- package/build/components/ListBrowseList.js.map +1 -1
- package/build/components/MeasuredBox.d.ts +20 -0
- package/build/components/MeasuredBox.d.ts.map +1 -0
- package/build/components/MeasuredBox.js +14 -0
- package/build/components/MeasuredBox.js.map +1 -0
- package/build/hooks/useListState.d.ts.map +1 -1
- package/build/hooks/useListState.js +17 -15
- package/build/hooks/useListState.js.map +1 -1
- package/build/hooks/useMeasuredRows.d.ts +10 -0
- package/build/hooks/useMeasuredRows.d.ts.map +1 -0
- package/build/hooks/useMeasuredRows.js +23 -0
- package/build/hooks/useMeasuredRows.js.map +1 -0
- package/build/hooks/useRenderOnResize.d.ts +11 -0
- package/build/hooks/useRenderOnResize.d.ts.map +1 -0
- package/build/hooks/useRenderOnResize.js +35 -0
- package/build/hooks/useRenderOnResize.js.map +1 -0
- package/build/hooks/useShell.d.ts +23 -0
- package/build/hooks/useShell.d.ts.map +1 -0
- package/build/hooks/useShell.js +28 -0
- package/build/hooks/useShell.js.map +1 -0
- package/build/lib/atk-api/index.d.ts +2 -2
- package/build/lib/atk-api/index.d.ts.map +1 -1
- package/build/lib/atk-api/index.js +1 -1
- package/build/lib/atk-api/index.js.map +1 -1
- package/build/lib/atk-api/web-routes.d.ts +36 -9
- package/build/lib/atk-api/web-routes.d.ts.map +1 -1
- package/build/lib/atk-api/web-routes.js +59 -10
- package/build/lib/atk-api/web-routes.js.map +1 -1
- package/build/lib/ink-stdout.d.ts +32 -0
- package/build/lib/ink-stdout.d.ts.map +1 -0
- package/build/lib/ink-stdout.js +79 -0
- package/build/lib/ink-stdout.js.map +1 -0
- package/build/lib/list-window.d.ts +43 -0
- package/build/lib/list-window.d.ts.map +1 -0
- package/build/lib/list-window.js +58 -0
- package/build/lib/list-window.js.map +1 -0
- package/build/lib/pastel/read-custom-app.d.ts +11 -1
- package/build/lib/pastel/read-custom-app.d.ts.map +1 -1
- package/build/lib/pastel/read-custom-app.js +2 -1
- package/build/lib/pastel/read-custom-app.js.map +1 -1
- package/build/lib/pastel/render-command.d.ts.map +1 -1
- package/build/lib/pastel/render-command.js +4 -3
- package/build/lib/pastel/render-command.js.map +1 -1
- package/build/lib/screen-rows.d.ts +15 -0
- package/build/lib/screen-rows.d.ts.map +1 -0
- package/build/lib/screen-rows.js +17 -0
- package/build/lib/screen-rows.js.map +1 -0
- package/build/lib/update-check.d.ts +25 -19
- package/build/lib/update-check.d.ts.map +1 -1
- package/build/lib/update-check.js +50 -61
- package/build/lib/update-check.js.map +1 -1
- package/build/lib/web-app.d.ts +8 -2
- package/build/lib/web-app.d.ts.map +1 -1
- package/build/lib/web-app.js +10 -2
- package/build/lib/web-app.js.map +1 -1
- package/package.json +3 -3
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ink-stdout.js","sourceRoot":"","sources":["../../src/lib/ink-stdout.ts"],"names":[],"mappings":"AAUA;;;GAGG;AACH,MAAM,CAAC,MAAM,UAAU,GAAe,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC;AAE3D,uGAAuG;AACvG,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAAc;IAC5C,aAAa;IACb,KAAK;IACL,IAAI;IACJ,MAAM;IACN,iBAAiB;IACjB,qBAAqB;IACrB,gBAAgB;CACjB,CAAC,CAAC;AAIH;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,YAAY,CAC1B,MAAS,EACT,KAAmB,EACnB,QAA8B,UAAU;IAExC,MAAM,IAAI,GAAG,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,KAAK,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,IAAI,KAAK,CAAC,OAAO,EAAE,IAAI,MAAM,CAAC,IAAI,CAAC;IAC/F,IAAI,cAAc,GAAG,MAAM,CAAC,OAAO,CAAC;IAEpC,0DAA0D;IAC1D,MAAM,KAAK,GAAG,IAAI,OAAO,EAAsB,CAAC;IAChD,MAAM,IAAI,GAAG,CAAC,QAAkB,EAAY,EAAE;QAC5C,IAAI,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAChC,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,KAAK,GAAG,UAAyB,GAAG,IAAe;gBACjD,IAAI,CAAC,IAAI,EAAE;oBAAE,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAC1C,CAAC,CAAC;YACF,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QAC7B,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;IAEF,qHAAqH;IACrH,wGAAwG;IACxG,MAAM,OAAO,GAAG,IAAI,OAAO,EAAmB,CAAC;IAC/C,MAAM,IAAI,GAAM,IAAI,KAAK,CAAC,MAAM,EAAE;QAChC,GAAG,CAAC,MAAM,EAAE,QAAQ;YAClB,IAAI,QAAQ,KAAK,MAAM;gBAAE,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;gBAC3B,IAAI,CAAC,IAAI,EAAE;oBAAE,cAAc,GAAG,MAAM,CAAC,OAAO,CAAC;gBAC7C,OAAO,cAAc,CAAC;YACxB,CAAC;YACD,MAAM,KAAK,GAAY,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;YAC7D,IAAI,OAAO,KAAK,KAAK,UAAU,IAAI,QAAQ,KAAK,aAAa;gBAAE,OAAO,KAAK,CAAC;YAC5E,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;gBACxB,MAAM,aAAa,GAAG,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBACrD,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,GAAG,IAAe,EAAW,EAAE;oBACjD,IAAI,aAAa,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,UAAU,EAAE,CAAC;wBAC3E,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAa,CAAC,CAAC;oBACtC,CAAC;oBACD,MAAM,MAAM,GAAY,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;oBAC3D,OAAO,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC;gBAC3C,CAAC,CAAC,CAAC;YACL,CAAC;YACD,OAAO,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC5B,CAAC;KACF,CAAC,CAAC;IACH,OAAO,IAAI,CAAC;AACd,CAAC"}
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Which rows `atk browse` and `atk list` draw: the viewport holds the column header, the "▲ N more above" line when
|
|
3
|
+
* the window starts past the first row, the rows (an expanded row takes its detail's lines too), and the "▼ N more
|
|
4
|
+
* below" line when rows remain after the last one drawn.
|
|
5
|
+
*/
|
|
6
|
+
export interface ListWindow {
|
|
7
|
+
/** The rows hidden after the window */
|
|
8
|
+
below: number;
|
|
9
|
+
/** The expanded row's detail lines that fit; fewer than its whole detail when the rest is cut */
|
|
10
|
+
detailLines: number;
|
|
11
|
+
/** The rows drawn, in order */
|
|
12
|
+
indexes: number[];
|
|
13
|
+
/** The first row drawn, which is also the count of rows hidden before it */
|
|
14
|
+
start: number;
|
|
15
|
+
}
|
|
16
|
+
/** A list's rows, its cursor, its expanded row and the lines it has, for {@link fitListWindow}. */
|
|
17
|
+
export interface ListWindowInput {
|
|
18
|
+
/** The number of rows in the list */
|
|
19
|
+
count: number;
|
|
20
|
+
/** The cursor's row */
|
|
21
|
+
cursorIndex: number;
|
|
22
|
+
/** The expanded row, or null */
|
|
23
|
+
expandedIndex: null | number;
|
|
24
|
+
/** The expanded row's detail lines, below the row itself */
|
|
25
|
+
expandedLines: number;
|
|
26
|
+
/** The state's first row, for a collapsed list */
|
|
27
|
+
scrollOffset: number;
|
|
28
|
+
/** The lines the list has, the column header included */
|
|
29
|
+
viewportHeight: number;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* The rows that fit from the state's `scrollOffset`, as the lists always drew them, unless that leaves out the
|
|
33
|
+
* cursor's row: then the window starts later, until the cursor's row fits with all of its detail, or at the cursor's
|
|
34
|
+
* row with its detail cut to the lines left. The cursor's row is always drawn.
|
|
35
|
+
*/
|
|
36
|
+
export declare function fitListWindow(input: ListWindowInput): ListWindow;
|
|
37
|
+
/**
|
|
38
|
+
* The first row of the collapsed window {@link fitListWindow} draws: what a list's state keeps as its `scrollOffset`
|
|
39
|
+
* after the cursor moves or the list changes, so the next window starts where this one was drawn. A window that
|
|
40
|
+
* reaches the last row starts as early as it still can, so a shorter list or a taller viewport leaves no blank lines.
|
|
41
|
+
*/
|
|
42
|
+
export declare function scrollToCursor(input: Omit<ListWindowInput, 'expandedIndex' | 'expandedLines'>): number;
|
|
43
|
+
//# sourceMappingURL=list-window.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"list-window.d.ts","sourceRoot":"","sources":["../../src/lib/list-window.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,UAAU;IACzB,uCAAuC;IACvC,KAAK,EAAE,MAAM,CAAC;IACd,iGAAiG;IACjG,WAAW,EAAE,MAAM,CAAC;IACpB,+BAA+B;IAC/B,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,4EAA4E;IAC5E,KAAK,EAAE,MAAM,CAAC;CACf;AAED,mGAAmG;AACnG,MAAM,WAAW,eAAe;IAC9B,qCAAqC;IACrC,KAAK,EAAE,MAAM,CAAC;IACd,uBAAuB;IACvB,WAAW,EAAE,MAAM,CAAC;IACpB,gCAAgC;IAChC,aAAa,EAAE,IAAI,GAAG,MAAM,CAAC;IAC7B,4DAA4D;IAC5D,aAAa,EAAE,MAAM,CAAC;IACtB,kDAAkD;IAClD,YAAY,EAAE,MAAM,CAAC;IACrB,yDAAyD;IACzD,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,eAAe,GAAG,UAAU,CAehE;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,IAAI,CAAC,eAAe,EAAE,eAAe,GAAG,eAAe,CAAC,GAAG,MAAM,CAKtG"}
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The rows that fit from the state's `scrollOffset`, as the lists always drew them, unless that leaves out the
|
|
3
|
+
* cursor's row: then the window starts later, until the cursor's row fits with all of its detail, or at the cursor's
|
|
4
|
+
* row with its detail cut to the lines left. The cursor's row is always drawn.
|
|
5
|
+
*/
|
|
6
|
+
export function fitListWindow(input) {
|
|
7
|
+
const { count, cursorIndex, expandedIndex, expandedLines, scrollOffset } = input;
|
|
8
|
+
if (count === 0)
|
|
9
|
+
return { below: 0, detailLines: 0, indexes: [], start: 0 };
|
|
10
|
+
const cursor = Math.min(Math.max(0, cursorIndex), count - 1);
|
|
11
|
+
const first = Math.min(scrollOffset, cursor);
|
|
12
|
+
for (let start = first; start <= cursor; start++) {
|
|
13
|
+
const window = fitFrom(input, start);
|
|
14
|
+
if (window.indexes.includes(cursor))
|
|
15
|
+
return window;
|
|
16
|
+
}
|
|
17
|
+
// Not even the cursor's row alone, with all of its detail: draw it first and cut the detail
|
|
18
|
+
const room = rowsRoom(input.viewportHeight, cursor, cursor, count);
|
|
19
|
+
const detailLines = cursor === expandedIndex ? Math.max(0, Math.min(expandedLines, room - 1)) : 0;
|
|
20
|
+
return { below: count - cursor - 1, detailLines, indexes: [cursor], start: cursor };
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* The first row of the collapsed window {@link fitListWindow} draws: what a list's state keeps as its `scrollOffset`
|
|
24
|
+
* after the cursor moves or the list changes, so the next window starts where this one was drawn. A window that
|
|
25
|
+
* reaches the last row starts as early as it still can, so a shorter list or a taller viewport leaves no blank lines.
|
|
26
|
+
*/
|
|
27
|
+
export function scrollToCursor(input) {
|
|
28
|
+
const collapsed = { ...input, expandedIndex: null, expandedLines: 0 };
|
|
29
|
+
let { start } = fitListWindow(collapsed);
|
|
30
|
+
while (start > 0 && fitFrom(collapsed, start - 1).below === 0)
|
|
31
|
+
start--;
|
|
32
|
+
return start;
|
|
33
|
+
}
|
|
34
|
+
/** The rows that fit from `start`, each whole, stopping at the first that doesn't. */
|
|
35
|
+
function fitFrom({ count, expandedIndex, expandedLines, viewportHeight }, start) {
|
|
36
|
+
const indexes = [];
|
|
37
|
+
let used = 0;
|
|
38
|
+
let detailLines = 0;
|
|
39
|
+
for (let i = start; i < count; i++) {
|
|
40
|
+
const detail = i === expandedIndex ? expandedLines : 0;
|
|
41
|
+
if (used + 1 + detail > rowsRoom(viewportHeight, start, i, count))
|
|
42
|
+
break;
|
|
43
|
+
indexes.push(i);
|
|
44
|
+
used += 1 + detail;
|
|
45
|
+
if (detail > 0)
|
|
46
|
+
detailLines = detail;
|
|
47
|
+
}
|
|
48
|
+
const last = indexes.at(-1) ?? start - 1;
|
|
49
|
+
return { below: count - last - 1, detailLines, indexes, start };
|
|
50
|
+
}
|
|
51
|
+
/**
|
|
52
|
+
* The lines left for rows in a window from `start` whose last row is `last`: the viewport less the column header,
|
|
53
|
+
* the "▲" line when `start` is past the first row, and the "▼" line when rows remain after `last`.
|
|
54
|
+
*/
|
|
55
|
+
function rowsRoom(viewportHeight, start, last, count) {
|
|
56
|
+
return viewportHeight - 1 - (start > 0 ? 1 : 0) - (last < count - 1 ? 1 : 0);
|
|
57
|
+
}
|
|
58
|
+
//# sourceMappingURL=list-window.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"list-window.js","sourceRoot":"","sources":["../../src/lib/list-window.ts"],"names":[],"mappings":"AAgCA;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,KAAsB;IAClD,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,aAAa,EAAE,aAAa,EAAE,YAAY,EAAE,GAAG,KAAK,CAAC;IACjF,IAAI,KAAK,KAAK,CAAC;QAAE,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;IAE5E,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,WAAW,CAAC,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC;IAC7D,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;IAC7C,KAAK,IAAI,KAAK,GAAG,KAAK,EAAE,KAAK,IAAI,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC;QACjD,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QACrC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;YAAE,OAAO,MAAM,CAAC;IACrD,CAAC;IAED,4FAA4F;IAC5F,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,cAAc,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IACnE,MAAM,WAAW,GAAG,MAAM,KAAK,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAClG,OAAO,EAAE,KAAK,EAAE,KAAK,GAAG,MAAM,GAAG,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;AACtF,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAC,KAA+D;IAC5F,MAAM,SAAS,GAAoB,EAAE,GAAG,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,EAAE,CAAC;IACvF,IAAI,EAAE,KAAK,EAAE,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC;IACzC,OAAO,KAAK,GAAG,CAAC,IAAI,OAAO,CAAC,SAAS,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC;QAAE,KAAK,EAAE,CAAC;IACvE,OAAO,KAAK,CAAC;AACf,CAAC;AAED,sFAAsF;AACtF,SAAS,OAAO,CAAC,EAAE,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,cAAc,EAAmB,EAAE,KAAa;IACtG,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,IAAI,IAAI,GAAG,CAAC,CAAC;IACb,IAAI,WAAW,GAAG,CAAC,CAAC;IACpB,KAAK,IAAI,CAAC,GAAG,KAAK,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC;QACnC,MAAM,MAAM,GAAG,CAAC,KAAK,aAAa,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;QACvD,IAAI,IAAI,GAAG,CAAC,GAAG,MAAM,GAAG,QAAQ,CAAC,cAAc,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,CAAC;YAAE,MAAM;QACzE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAChB,IAAI,IAAI,CAAC,GAAG,MAAM,CAAC;QACnB,IAAI,MAAM,GAAG,CAAC;YAAE,WAAW,GAAG,MAAM,CAAC;IACvC,CAAC;IACD,MAAM,IAAI,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC;IACzC,OAAO,EAAE,KAAK,EAAE,KAAK,GAAG,IAAI,GAAG,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;AAClE,CAAC;AAED;;;GAGG;AACH,SAAS,QAAQ,CAAC,cAAsB,EAAE,KAAa,EAAE,IAAY,EAAE,KAAa;IAClF,OAAO,cAAc,GAAG,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC/E,CAAC"}
|
|
@@ -1,4 +1,14 @@
|
|
|
1
|
+
import { type RenderOptions } from 'ink';
|
|
1
2
|
import { type ComponentType } from 'react';
|
|
2
3
|
import { type AppProps } from './types.js';
|
|
3
|
-
|
|
4
|
+
/** Work the app finishes before the first frame of one run of `Component` with its parsed `options`. */
|
|
5
|
+
export type AppBeforeRender = (Component: AppProps['Component'], options: Record<string, unknown>) => Promise<void>;
|
|
6
|
+
/** Ink's render options for one run of `Component` with its parsed `options`. */
|
|
7
|
+
export type AppRenderOptions = (Component: AppProps['Component'], options: Record<string, unknown>) => RenderOptions;
|
|
8
|
+
export type CustomApp = {
|
|
9
|
+
App: ComponentType<AppProps>;
|
|
10
|
+
beforeRender: AppBeforeRender | undefined;
|
|
11
|
+
renderOptions: AppRenderOptions | undefined;
|
|
12
|
+
};
|
|
13
|
+
export default function readCustomApp(directory: string): Promise<CustomApp | undefined>;
|
|
4
14
|
//# sourceMappingURL=read-custom-app.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"read-custom-app.d.ts","sourceRoot":"","sources":["../../../src/lib/pastel/read-custom-app.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"read-custom-app.d.ts","sourceRoot":"","sources":["../../../src/lib/pastel/read-custom-app.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,KAAK,CAAC;AAIzC,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,OAAO,CAAC;AAE3C,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C,wGAAwG;AACxG,MAAM,MAAM,eAAe,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAEpH,iFAAiF;AACjF,MAAM,MAAM,gBAAgB,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,aAAa,CAAC;AAErH,MAAM,MAAM,SAAS,GAAG;IACtB,GAAG,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAC;IAC7B,YAAY,EAAE,eAAe,GAAG,SAAS,CAAC;IAC1C,aAAa,EAAE,gBAAgB,GAAG,SAAS,CAAC;CAC7C,CAAC;AAQF,wBAA8B,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC,CAkB7F"}
|
|
@@ -6,6 +6,7 @@ var __rewriteRelativeImportExtension = (this && this.__rewriteRelativeImportExte
|
|
|
6
6
|
}
|
|
7
7
|
return path;
|
|
8
8
|
};
|
|
9
|
+
import {} from 'ink';
|
|
9
10
|
import fs from 'node:fs/promises';
|
|
10
11
|
import path from 'node:path';
|
|
11
12
|
import { pathToFileURL } from 'node:url';
|
|
@@ -21,7 +22,7 @@ export default async function readCustomApp(directory) {
|
|
|
21
22
|
const filePath = path.join(directory, file);
|
|
22
23
|
const fileUrl = pathToFileURL(filePath);
|
|
23
24
|
const m = (await import(__rewriteRelativeImportExtension(fileUrl.href)));
|
|
24
|
-
customApp = m.default;
|
|
25
|
+
customApp = { App: m.default, beforeRender: m.beforeRender, renderOptions: m.renderOptions };
|
|
25
26
|
break;
|
|
26
27
|
}
|
|
27
28
|
return customApp;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"read-custom-app.js","sourceRoot":"","sources":["../../../src/lib/pastel/read-custom-app.ts"],"names":[],"mappings":";;;;;;;;AAAA,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAClC,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAsB,MAAM,OAAO,CAAC;AAE3C,OAAO,EAAiB,MAAM,YAAY,CAAC;
|
|
1
|
+
{"version":3,"file":"read-custom-app.js","sourceRoot":"","sources":["../../../src/lib/pastel/read-custom-app.ts"],"names":[],"mappings":";;;;;;;;AAAA,OAAO,EAAsB,MAAM,KAAK,CAAC;AACzC,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAClC,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAsB,MAAM,OAAO,CAAC;AAE3C,OAAO,EAAiB,MAAM,YAAY,CAAC;AAoB3C,MAAM,CAAC,OAAO,CAAC,KAAK,UAAU,aAAa,CAAC,SAAiB;IAC3D,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAC1C,IAAI,SAAgC,CAAC;IAErC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACpC,SAAS;QACX,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;QAC5C,MAAM,OAAO,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;QACxC,MAAM,CAAC,GAAG,CAAC,MAAM,MAAM,kCAAC,OAAO,CAAC,IAAI,EAAC,CAAe,CAAC;QAErD,SAAS,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,YAAY,EAAE,aAAa,EAAE,CAAC,CAAC,aAAa,EAAE,CAAC;QAC7F,MAAM;IACR,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"render-command.d.ts","sourceRoot":"","sources":["../../../src/lib/pastel/render-command.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,OAAO,IAAI,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAK7D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAK1D;;;;GAIG;AACH,wBAA8B,aAAa,CACzC,gBAAgB,EAAE,gBAAgB,EAClC,MAAM,EAAE,cAAc,EACtB,EAAE,iBAAiB,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE;IAAE,iBAAiB,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,OAAO,EAAE,CAAC;IAAC,QAAQ,EAAE,OAAO,CAAA;CAAE,
|
|
1
|
+
{"version":3,"file":"render-command.d.ts","sourceRoot":"","sources":["../../../src/lib/pastel/render-command.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,OAAO,IAAI,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAK7D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAK1D;;;;GAIG;AACH,wBAA8B,aAAa,CACzC,gBAAgB,EAAE,gBAAgB,EAClC,MAAM,EAAE,cAAc,EACtB,EAAE,iBAAiB,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE;IAAE,iBAAiB,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,OAAO,EAAE,CAAC;IAAC,QAAQ,EAAE,OAAO,CAAA;CAAE,iBA+C3G"}
|
|
@@ -36,14 +36,15 @@ export default async function renderCommand(commanderCommand, module, { commands
|
|
|
36
36
|
rejectInput(commanderCommand, result.error);
|
|
37
37
|
}
|
|
38
38
|
}
|
|
39
|
-
const
|
|
40
|
-
|
|
39
|
+
const customApp = await readCustomApp(commandsDirectory);
|
|
40
|
+
await customApp?.beforeRender?.(Component, parsedOptions);
|
|
41
|
+
render(React.createElement(customApp?.App ?? App, {
|
|
41
42
|
commandProps: {
|
|
42
43
|
args: arguments_,
|
|
43
44
|
options: parsedOptions,
|
|
44
45
|
},
|
|
45
46
|
Component,
|
|
46
|
-
}));
|
|
47
|
+
}), customApp?.renderOptions?.(Component, parsedOptions));
|
|
47
48
|
}
|
|
48
49
|
/**
|
|
49
50
|
* Options or arguments the command's schema rejects are a usage error, reported through commander like its own
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"render-command.js","sourceRoot":"","sources":["../../../src/lib/pastel/render-command.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAoC,MAAM,WAAW,CAAC;AAC7D,OAAO,EAAE,MAAM,EAAE,MAAM,KAAK,CAAC;AAC7B,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAIpD,OAAO,GAAG,MAAM,WAAW,CAAC;AAC5B,OAAO,aAAa,MAAM,sBAAsB,CAAC;AAEjD;;;;GAIG;AACH,MAAM,CAAC,OAAO,CAAC,KAAK,UAAU,aAAa,CACzC,gBAAkC,EAClC,MAAsB,EACtB,EAAE,iBAAiB,EAAE,KAAK,EAAE,QAAQ,EAAsE;IAE1G,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC;IAEjC,4DAA4D;IAC5D,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,GAAG,gBAAgB,CAAC,IAAI,EAAE,kEAAkE,CAAC,CAAC;IAChH,CAAC;IAED,MAAM,OAAO,GAAG,KAAK,CAAC,GAAG,EAA6B,CAAC;IACvD,IAAI,aAAa,GAA4B,EAAE,CAAC;IAEhD,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnB,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAEjD,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACnB,aAAa,GAAG,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC;QACpC,CAAC;aAAM,CAAC;YACN,WAAW,CAAC,gBAAgB,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;QAC9C,CAAC;IACH,CAAC;IAED,IAAI,UAAU,GAAc,EAAE,CAAC;IAE/B,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;QAChB,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QAEtE,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACnB,UAAU,GAAG,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC;QACjC,CAAC;aAAM,CAAC;YACN,WAAW,CAAC,gBAAgB,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;QAC9C,CAAC;IACH,CAAC;IAED,MAAM,
|
|
1
|
+
{"version":3,"file":"render-command.js","sourceRoot":"","sources":["../../../src/lib/pastel/render-command.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAoC,MAAM,WAAW,CAAC;AAC7D,OAAO,EAAE,MAAM,EAAE,MAAM,KAAK,CAAC;AAC7B,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAIpD,OAAO,GAAG,MAAM,WAAW,CAAC;AAC5B,OAAO,aAAa,MAAM,sBAAsB,CAAC;AAEjD;;;;GAIG;AACH,MAAM,CAAC,OAAO,CAAC,KAAK,UAAU,aAAa,CACzC,gBAAkC,EAClC,MAAsB,EACtB,EAAE,iBAAiB,EAAE,KAAK,EAAE,QAAQ,EAAsE;IAE1G,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC;IAEjC,4DAA4D;IAC5D,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,GAAG,gBAAgB,CAAC,IAAI,EAAE,kEAAkE,CAAC,CAAC;IAChH,CAAC;IAED,MAAM,OAAO,GAAG,KAAK,CAAC,GAAG,EAA6B,CAAC;IACvD,IAAI,aAAa,GAA4B,EAAE,CAAC;IAEhD,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnB,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAEjD,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACnB,aAAa,GAAG,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC;QACpC,CAAC;aAAM,CAAC;YACN,WAAW,CAAC,gBAAgB,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;QAC9C,CAAC;IACH,CAAC;IAED,IAAI,UAAU,GAAc,EAAE,CAAC;IAE/B,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;QAChB,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QAEtE,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACnB,UAAU,GAAG,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC;QACjC,CAAC;aAAM,CAAC;YACN,WAAW,CAAC,gBAAgB,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;QAC9C,CAAC;IACH,CAAC;IAED,MAAM,SAAS,GAAG,MAAM,aAAa,CAAC,iBAAiB,CAAC,CAAC;IACzD,MAAM,SAAS,EAAE,YAAY,EAAE,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;IAE1D,MAAM,CACJ,KAAK,CAAC,aAAa,CAAC,SAAS,EAAE,GAAG,IAAI,GAAG,EAAE;QACzC,YAAY,EAAE;YACZ,IAAI,EAAE,UAAU;YAChB,OAAO,EAAE,aAAa;SACvB;QACD,SAAS;KACV,CAAC,EACF,SAAS,EAAE,aAAa,EAAE,CAAC,SAAS,EAAE,aAAa,CAAC,CACrD,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,SAAS,WAAW,CAAC,gBAAkC,EAAE,KAAyC;IAChG,MAAM,EAAE,OAAO,EAAE,GAAG,YAAY,CAAC,KAAK,EAAE,EAAE,kBAAkB,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,eAAe,EAAE,EAAE,EAAE,CAAC,CAAC;IACpG,gBAAgB,CAAC,KAAK,CAAC,UAAU,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,qBAAqB,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC;AAC5F,CAAC"}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The rows `browse` and `list` draw besides their list's viewport: the filter bar (4), the list's border (2) and the
|
|
3
|
+
* help or action bar (3). The column header and the scroll markers are inside the viewport.
|
|
4
|
+
*/
|
|
5
|
+
export declare const SCREEN_CHROME_ROWS = 9;
|
|
6
|
+
/** The fewest rows a list's viewport gets: its column header, "▲ more above", one row and "▼ more below". */
|
|
7
|
+
export declare const MIN_VIEWPORT_ROWS = 4;
|
|
8
|
+
/**
|
|
9
|
+
* The rows left for a full-screen list's viewport on a terminal `terminalRows` tall, once `otherRows` (the App
|
|
10
|
+
* shell's and the screen's own warnings) are drawn. The frame stays one row short of the terminal: once a frame is as
|
|
11
|
+
* tall as the terminal, Ink clears the whole terminal on every render, which flickers and leaves lines behind
|
|
12
|
+
* (ATK-961). A terminal too short for {@link MIN_VIEWPORT_ROWS} gets the minimum anyway, and its frame overflows.
|
|
13
|
+
*/
|
|
14
|
+
export declare function viewportRows(terminalRows: number, otherRows: number): number;
|
|
15
|
+
//# sourceMappingURL=screen-rows.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"screen-rows.d.ts","sourceRoot":"","sources":["../../src/lib/screen-rows.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,eAAO,MAAM,kBAAkB,IAAI,CAAC;AAEpC,6GAA6G;AAC7G,eAAO,MAAM,iBAAiB,IAAI,CAAC;AAEnC;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAE5E"}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The rows `browse` and `list` draw besides their list's viewport: the filter bar (4), the list's border (2) and the
|
|
3
|
+
* help or action bar (3). The column header and the scroll markers are inside the viewport.
|
|
4
|
+
*/
|
|
5
|
+
export const SCREEN_CHROME_ROWS = 9;
|
|
6
|
+
/** The fewest rows a list's viewport gets: its column header, "▲ more above", one row and "▼ more below". */
|
|
7
|
+
export const MIN_VIEWPORT_ROWS = 4;
|
|
8
|
+
/**
|
|
9
|
+
* The rows left for a full-screen list's viewport on a terminal `terminalRows` tall, once `otherRows` (the App
|
|
10
|
+
* shell's and the screen's own warnings) are drawn. The frame stays one row short of the terminal: once a frame is as
|
|
11
|
+
* tall as the terminal, Ink clears the whole terminal on every render, which flickers and leaves lines behind
|
|
12
|
+
* (ATK-961). A terminal too short for {@link MIN_VIEWPORT_ROWS} gets the minimum anyway, and its frame overflows.
|
|
13
|
+
*/
|
|
14
|
+
export function viewportRows(terminalRows, otherRows) {
|
|
15
|
+
return Math.max(MIN_VIEWPORT_ROWS, terminalRows - 1 - otherRows - SCREEN_CHROME_ROWS);
|
|
16
|
+
}
|
|
17
|
+
//# sourceMappingURL=screen-rows.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"screen-rows.js","sourceRoot":"","sources":["../../src/lib/screen-rows.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC;AAEpC,6GAA6G;AAC7G,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC;AAEnC;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAAC,YAAoB,EAAE,SAAiB;IAClE,OAAO,IAAI,CAAC,GAAG,CAAC,iBAAiB,EAAE,YAAY,GAAG,CAAC,GAAG,SAAS,GAAG,kBAAkB,CAAC,CAAC;AACxF,CAAC"}
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
export declare const NPM_DIST_TAGS_URL = "https://registry.npmjs.org/-/package/@detergent-software%2fatk/dist-tags";
|
|
3
3
|
/** How long the cached dist-tags stand before the check asks npm again; not the registry's `cacheTtlMinutes`. */
|
|
4
4
|
export declare const UPDATE_CHECK_INTERVAL_MS: number;
|
|
5
|
-
/** The
|
|
5
|
+
/** The background refresh of a missing or stale cache makes one attempt and gives up after this long, so it barely delays exit. */
|
|
6
6
|
export declare const BACKGROUND_REFRESH_TIMEOUT_MS = 1500;
|
|
7
7
|
/** `atk doctor`'s npm read, made on every run, is one attempt that gives up after this long, as its `/health` probe does. */
|
|
8
8
|
export declare const VERSION_STATUS_TIMEOUT_MS = 5000;
|
|
@@ -36,14 +36,18 @@ export interface VersionStatus {
|
|
|
36
36
|
}
|
|
37
37
|
type BannerListener = () => void;
|
|
38
38
|
/**
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
|
|
39
|
+
* The newer version of @detergent-software/atk the cached npm dist-tags name, or null. It reads the cache of any age
|
|
40
|
+
* and never asks npm before it answers, so a run decides its update banner or notice at once. A missing cache, or one
|
|
41
|
+
* older than {@link UPDATE_CHECK_INTERVAL_MS}, starts one background fetch (no retries,
|
|
42
|
+
* {@link BACKGROUND_REFRESH_TIMEOUT_MS}) that only rewrites the cache, for the next run. Null, reading nothing, when
|
|
43
|
+
* {@link updateCheckSwitch} names a switch. Never throws.
|
|
44
|
+
*/
|
|
45
|
+
export declare function cachedUpdateInfo(): Promise<null | UpdateInfo>;
|
|
46
|
+
/**
|
|
47
|
+
* The TTY update banner for this run: what {@link loadUpdateBanner} found, or null once {@link hideUpdateBanner} ran.
|
|
48
|
+
* A stable snapshot for `useSyncExternalStore`.
|
|
45
49
|
*/
|
|
46
|
-
export declare function
|
|
50
|
+
export declare function getUpdateBanner(): null | UpdateInfo;
|
|
47
51
|
/**
|
|
48
52
|
* This CLI's version and its channel's version on npm, whether or not that is newer. npm is asked
|
|
49
53
|
* every time, never the cache first, since a cache under a day old can miss a version tagged a moment
|
|
@@ -55,21 +59,23 @@ export declare function getUpdateInfo(): Promise<null | UpdateInfo>;
|
|
|
55
59
|
*/
|
|
56
60
|
export declare function getVersionStatus(): Promise<VersionStatus>;
|
|
57
61
|
/**
|
|
58
|
-
* Hide the TTY update banner for the rest of the run.
|
|
59
|
-
*
|
|
62
|
+
* Hide the TTY update banner for the rest of the run. The banner names a version newer than the one this process
|
|
63
|
+
* loaded, so `atk upgrade` (before its first frame) and `atk doctor --fix` (after its upgrade) hide it: it would
|
|
60
64
|
* tell the user to run the command that just ran (ATK-877).
|
|
61
65
|
*/
|
|
62
66
|
export declare function hideUpdateBanner(): void;
|
|
63
67
|
/** Whether {@link hideUpdateBanner} ran in this process (a stable snapshot for `useSyncExternalStore`). */
|
|
64
68
|
export declare function isUpdateBannerHidden(): boolean;
|
|
65
69
|
/**
|
|
66
|
-
* The update
|
|
67
|
-
*
|
|
68
|
-
*
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
*
|
|
70
|
+
* The TTY update banner for this run, from {@link cachedUpdateInfo}. The App shell awaits it before its first frame,
|
|
71
|
+
* so the banner is in that frame and never arrives later: a print-once output already taller than the terminal would
|
|
72
|
+
* be written again, its top a second time (ATK-966). Never throws.
|
|
73
|
+
*/
|
|
74
|
+
export declare function loadUpdateBanner(read?: () => Promise<null | UpdateInfo>): Promise<void>;
|
|
75
|
+
/**
|
|
76
|
+
* The update check for JSON mode, which shows no banner. `cli.tsx` runs it before the command so the payload can
|
|
77
|
+
* carry the result: when {@link cachedUpdateInfo} names a newer version it records an `update-available` notice.
|
|
78
|
+
* Never throws.
|
|
73
79
|
*/
|
|
74
80
|
export declare function noteCachedUpdate(): Promise<void>;
|
|
75
81
|
/**
|
|
@@ -79,9 +85,9 @@ export declare function noteCachedUpdate(): Promise<void>;
|
|
|
79
85
|
* npm couldn't be read, or offline. For `atk upgrade`; doesn't throw.
|
|
80
86
|
*/
|
|
81
87
|
export declare function readDistTagsFresh(): Promise<DistTags | null>;
|
|
82
|
-
/**
|
|
88
|
+
/** Forget the run's banner and show it again once loaded. Intended for tests. */
|
|
83
89
|
export declare function resetUpdateBanner(): void;
|
|
84
|
-
/** Subscribe to {@link hideUpdateBanner}; returns the unsubscribe function. */
|
|
90
|
+
/** Subscribe to {@link loadUpdateBanner} and {@link hideUpdateBanner}; returns the unsubscribe function. */
|
|
85
91
|
export declare function subscribeUpdateBanner(listener: BannerListener): () => void;
|
|
86
92
|
/**
|
|
87
93
|
* The switch that turns the update check off, or null when it runs. An
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"update-check.d.ts","sourceRoot":"","sources":["../../src/lib/update-check.ts"],"names":[],"mappings":"AAWA,qFAAqF;AACrF,eAAO,MAAM,iBAAiB,6EAA6E,CAAC;AAG5G,iHAAiH;AACjH,eAAO,MAAM,wBAAwB,QAAsB,CAAC;AAE5D,
|
|
1
|
+
{"version":3,"file":"update-check.d.ts","sourceRoot":"","sources":["../../src/lib/update-check.ts"],"names":[],"mappings":"AAWA,qFAAqF;AACrF,eAAO,MAAM,iBAAiB,6EAA6E,CAAC;AAG5G,iHAAiH;AACjH,eAAO,MAAM,wBAAwB,QAAsB,CAAC;AAE5D,mIAAmI;AACnI,eAAO,MAAM,6BAA6B,OAAQ,CAAC;AAEnD,6HAA6H;AAC7H,eAAO,MAAM,yBAAyB,OAAQ,CAAC;AAE/C,MAAM,WAAW,QAAQ;IACvB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,qBAAqB,GAAG,cAAc,GAAG,IAAI,CAAC;AAE9E,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,KAAK,GAAG,QAAQ,CAAC;IAC1B,cAAc,EAAE,MAAM,CAAC;IACvB,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,qEAAqE;AACrE,MAAM,WAAW,aAAa;IAC5B,sIAAsI;IACtI,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,KAAK,GAAG,QAAQ,CAAC;IAC1B,cAAc,EAAE,MAAM,CAAC;IACvB,0EAA0E;IAC1E,UAAU,CAAC,EAAE,OAAO,CAAC,iBAAiB,EAAE,IAAI,CAAC,CAAC;IAC9C,yFAAyF;IACzF,OAAO,EAAE,OAAO,CAAC;IACjB,uFAAuF;IACvF,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,KAAK,cAAc,GAAG,MAAM,IAAI,CAAC;AAUjC;;;;;;GAMG;AACH,wBAAsB,gBAAgB,IAAI,OAAO,CAAC,IAAI,GAAG,UAAU,CAAC,CAgCnE;AAED;;;GAGG;AACH,wBAAgB,eAAe,IAAI,IAAI,GAAG,UAAU,CAEnD;AAED;;;;;;;;GAQG;AACH,wBAAsB,gBAAgB,IAAI,OAAO,CAAC,aAAa,CAAC,CA4B/D;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,IAAI,IAAI,CAQvC;AAED,2GAA2G;AAC3G,wBAAgB,oBAAoB,IAAI,OAAO,CAE9C;AAED;;;;GAIG;AACH,wBAAsB,gBAAgB,CAAC,IAAI,GAAE,MAAM,OAAO,CAAC,IAAI,GAAG,UAAU,CAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,CAK/G;AAED;;;;GAIG;AACH,wBAAsB,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC,CAStD;AAED;;;;;GAKG;AACH,wBAAsB,iBAAiB,IAAI,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,CAWlE;AAED,iFAAiF;AACjF,wBAAgB,iBAAiB,IAAI,IAAI,CASxC;AAED,4GAA4G;AAC5G,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,cAAc,GAAG,MAAM,IAAI,CAK1E;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE;IAAE,YAAY,CAAC,EAAE,OAAO,CAAA;CAAE,EAClC,GAAG,GAAE,MAAM,CAAC,UAAwB,GACnC,IAAI,GAAG,iBAAiB,CAK1B"}
|
|
@@ -12,21 +12,21 @@ export const NPM_DIST_TAGS_URL = 'https://registry.npmjs.org/-/package/@detergen
|
|
|
12
12
|
const NPM_CACHE_FILE = 'npm-version.json';
|
|
13
13
|
/** How long the cached dist-tags stand before the check asks npm again; not the registry's `cacheTtlMinutes`. */
|
|
14
14
|
export const UPDATE_CHECK_INTERVAL_MS = 24 * 60 * 60 * 1000;
|
|
15
|
-
/** The
|
|
15
|
+
/** The background refresh of a missing or stale cache makes one attempt and gives up after this long, so it barely delays exit. */
|
|
16
16
|
export const BACKGROUND_REFRESH_TIMEOUT_MS = 1_500;
|
|
17
17
|
/** `atk doctor`'s npm read, made on every run, is one attempt that gives up after this long, as its `/health` probe does. */
|
|
18
18
|
export const VERSION_STATUS_TIMEOUT_MS = 5_000;
|
|
19
|
+
let bannerInfo = null;
|
|
19
20
|
let bannerHidden = false;
|
|
20
21
|
const bannerListeners = new Set();
|
|
21
22
|
/**
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
* network call.
|
|
23
|
+
* The newer version of @detergent-software/atk the cached npm dist-tags name, or null. It reads the cache of any age
|
|
24
|
+
* and never asks npm before it answers, so a run decides its update banner or notice at once. A missing cache, or one
|
|
25
|
+
* older than {@link UPDATE_CHECK_INTERVAL_MS}, starts one background fetch (no retries,
|
|
26
|
+
* {@link BACKGROUND_REFRESH_TIMEOUT_MS}) that only rewrites the cache, for the next run. Null, reading nothing, when
|
|
27
|
+
* {@link updateCheckSwitch} names a switch. Never throws.
|
|
28
28
|
*/
|
|
29
|
-
export async function
|
|
29
|
+
export async function cachedUpdateInfo() {
|
|
30
30
|
try {
|
|
31
31
|
const config = await loadConfig();
|
|
32
32
|
if (updateCheckSwitch(config)) {
|
|
@@ -36,32 +36,33 @@ export async function getUpdateInfo() {
|
|
|
36
36
|
const cacheDir = getCacheDir(config);
|
|
37
37
|
const cachePath = join(cacheDir, NPM_CACHE_FILE);
|
|
38
38
|
const cached = await readNpmCache(cachePath);
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
}
|
|
45
|
-
await writeNpmCache(cachePath, cacheDir, tags);
|
|
39
|
+
if (!cached || cached.ageMs > UPDATE_CHECK_INTERVAL_MS) {
|
|
40
|
+
void fetchDistTags(BACKGROUND_REFRESH_TIMEOUT_MS).then(async (tags) => {
|
|
41
|
+
if (tags) {
|
|
42
|
+
await writeNpmCache(cachePath, cacheDir, tags);
|
|
43
|
+
}
|
|
44
|
+
});
|
|
46
45
|
}
|
|
47
|
-
const latestVersion = tags[channel];
|
|
46
|
+
const latestVersion = cached?.tags[channel];
|
|
48
47
|
if (!latestVersion || !semverValid(CLI_VERSION) || !semverValid(latestVersion)) {
|
|
49
48
|
return null;
|
|
50
49
|
}
|
|
51
50
|
if (!semverGt(latestVersion, CLI_VERSION)) {
|
|
52
51
|
return null;
|
|
53
52
|
}
|
|
54
|
-
return {
|
|
55
|
-
channel,
|
|
56
|
-
currentVersion: CLI_VERSION,
|
|
57
|
-
latestVersion,
|
|
58
|
-
upgradeCommand: UPGRADE_COMMAND,
|
|
59
|
-
};
|
|
53
|
+
return { channel, currentVersion: CLI_VERSION, latestVersion, upgradeCommand: UPGRADE_COMMAND };
|
|
60
54
|
}
|
|
61
55
|
catch {
|
|
62
56
|
return null;
|
|
63
57
|
}
|
|
64
58
|
}
|
|
59
|
+
/**
|
|
60
|
+
* The TTY update banner for this run: what {@link loadUpdateBanner} found, or null once {@link hideUpdateBanner} ran.
|
|
61
|
+
* A stable snapshot for `useSyncExternalStore`.
|
|
62
|
+
*/
|
|
63
|
+
export function getUpdateBanner() {
|
|
64
|
+
return bannerHidden ? null : bannerInfo;
|
|
65
|
+
}
|
|
65
66
|
/**
|
|
66
67
|
* This CLI's version and its channel's version on npm, whether or not that is newer. npm is asked
|
|
67
68
|
* every time, never the cache first, since a cache under a day old can miss a version tagged a moment
|
|
@@ -100,8 +101,8 @@ export async function getVersionStatus() {
|
|
|
100
101
|
}
|
|
101
102
|
}
|
|
102
103
|
/**
|
|
103
|
-
* Hide the TTY update banner for the rest of the run.
|
|
104
|
-
*
|
|
104
|
+
* Hide the TTY update banner for the rest of the run. The banner names a version newer than the one this process
|
|
105
|
+
* loaded, so `atk upgrade` (before its first frame) and `atk doctor --fix` (after its upgrade) hide it: it would
|
|
105
106
|
* tell the user to run the command that just ran (ATK-877).
|
|
106
107
|
*/
|
|
107
108
|
export function hideUpdateBanner() {
|
|
@@ -118,42 +119,29 @@ export function isUpdateBannerHidden() {
|
|
|
118
119
|
return bannerHidden;
|
|
119
120
|
}
|
|
120
121
|
/**
|
|
121
|
-
* The update
|
|
122
|
-
*
|
|
123
|
-
*
|
|
124
|
-
* notice, with no network call on the way. A missing or stale cache starts one
|
|
125
|
-
* background fetch (no retries, {@link BACKGROUND_REFRESH_TIMEOUT_MS}) that
|
|
126
|
-
* only rewrites the cache, for the next run. Does nothing when
|
|
127
|
-
* {@link updateCheckSwitch} names a switch. Never throws.
|
|
122
|
+
* The TTY update banner for this run, from {@link cachedUpdateInfo}. The App shell awaits it before its first frame,
|
|
123
|
+
* so the banner is in that frame and never arrives later: a print-once output already taller than the terminal would
|
|
124
|
+
* be written again, its top a second time (ATK-966). Never throws.
|
|
128
125
|
*/
|
|
129
|
-
export async function
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
return;
|
|
134
|
-
}
|
|
135
|
-
const channel = isPreRelease() ? 'dev' : 'latest';
|
|
136
|
-
const cacheDir = getCacheDir(config);
|
|
137
|
-
const cachePath = join(cacheDir, NPM_CACHE_FILE);
|
|
138
|
-
const cached = await readNpmCache(cachePath);
|
|
139
|
-
const version = cached?.tags[channel];
|
|
140
|
-
if (version && semverValid(CLI_VERSION) && semverValid(version) && semverGt(version, CLI_VERSION)) {
|
|
141
|
-
addNotice({
|
|
142
|
-
command: UPGRADE_COMMAND,
|
|
143
|
-
kind: 'update-available',
|
|
144
|
-
text: `ATK ${version} is available (this is ${CLI_VERSION}). Run \`${UPGRADE_COMMAND}\` to update.`,
|
|
145
|
-
});
|
|
146
|
-
}
|
|
147
|
-
if (!cached || cached.ageMs > UPDATE_CHECK_INTERVAL_MS) {
|
|
148
|
-
void fetchDistTags(BACKGROUND_REFRESH_TIMEOUT_MS).then(async (tags) => {
|
|
149
|
-
if (tags) {
|
|
150
|
-
await writeNpmCache(cachePath, cacheDir, tags);
|
|
151
|
-
}
|
|
152
|
-
});
|
|
153
|
-
}
|
|
126
|
+
export async function loadUpdateBanner(read = cachedUpdateInfo) {
|
|
127
|
+
bannerInfo = await read().catch(() => null);
|
|
128
|
+
for (const listener of bannerListeners) {
|
|
129
|
+
listener();
|
|
154
130
|
}
|
|
155
|
-
|
|
156
|
-
|
|
131
|
+
}
|
|
132
|
+
/**
|
|
133
|
+
* The update check for JSON mode, which shows no banner. `cli.tsx` runs it before the command so the payload can
|
|
134
|
+
* carry the result: when {@link cachedUpdateInfo} names a newer version it records an `update-available` notice.
|
|
135
|
+
* Never throws.
|
|
136
|
+
*/
|
|
137
|
+
export async function noteCachedUpdate() {
|
|
138
|
+
const info = await cachedUpdateInfo();
|
|
139
|
+
if (info) {
|
|
140
|
+
addNotice({
|
|
141
|
+
command: info.upgradeCommand,
|
|
142
|
+
kind: 'update-available',
|
|
143
|
+
text: `ATK ${info.latestVersion} is available (this is ${info.currentVersion}). Run \`${info.upgradeCommand}\` to update.`,
|
|
144
|
+
});
|
|
157
145
|
}
|
|
158
146
|
}
|
|
159
147
|
/**
|
|
@@ -175,17 +163,18 @@ export async function readDistTagsFresh() {
|
|
|
175
163
|
}
|
|
176
164
|
return tags;
|
|
177
165
|
}
|
|
178
|
-
/**
|
|
166
|
+
/** Forget the run's banner and show it again once loaded. Intended for tests. */
|
|
179
167
|
export function resetUpdateBanner() {
|
|
180
|
-
if (!bannerHidden) {
|
|
168
|
+
if (!bannerHidden && !bannerInfo) {
|
|
181
169
|
return;
|
|
182
170
|
}
|
|
183
171
|
bannerHidden = false;
|
|
172
|
+
bannerInfo = null;
|
|
184
173
|
for (const listener of bannerListeners) {
|
|
185
174
|
listener();
|
|
186
175
|
}
|
|
187
176
|
}
|
|
188
|
-
/** Subscribe to {@link hideUpdateBanner}; returns the unsubscribe function. */
|
|
177
|
+
/** Subscribe to {@link loadUpdateBanner} and {@link hideUpdateBanner}; returns the unsubscribe function. */
|
|
189
178
|
export function subscribeUpdateBanner(listener) {
|
|
190
179
|
bannerListeners.add(listener);
|
|
191
180
|
return () => {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"update-check.js","sourceRoot":"","sources":["../../src/lib/update-check.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AACpE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,EAAE,IAAI,QAAQ,EAAE,KAAK,IAAI,WAAW,EAAE,MAAM,QAAQ,CAAC;AAE9D,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,YAAY,EAAE,oBAAoB,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAE3G,qFAAqF;AACrF,MAAM,CAAC,MAAM,iBAAiB,GAAG,0EAA0E,CAAC;AAC5G,MAAM,cAAc,GAAG,kBAAkB,CAAC;AAE1C,iHAAiH;AACjH,MAAM,CAAC,MAAM,wBAAwB,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAE5D,
|
|
1
|
+
{"version":3,"file":"update-check.js","sourceRoot":"","sources":["../../src/lib/update-check.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AACpE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,EAAE,IAAI,QAAQ,EAAE,KAAK,IAAI,WAAW,EAAE,MAAM,QAAQ,CAAC;AAE9D,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,YAAY,EAAE,oBAAoB,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAE3G,qFAAqF;AACrF,MAAM,CAAC,MAAM,iBAAiB,GAAG,0EAA0E,CAAC;AAC5G,MAAM,cAAc,GAAG,kBAAkB,CAAC;AAE1C,iHAAiH;AACjH,MAAM,CAAC,MAAM,wBAAwB,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAE5D,mIAAmI;AACnI,MAAM,CAAC,MAAM,6BAA6B,GAAG,KAAK,CAAC;AAEnD,6HAA6H;AAC7H,MAAM,CAAC,MAAM,yBAAyB,GAAG,KAAK,CAAC;AAwC/C,IAAI,UAAU,GAAsB,IAAI,CAAC;AACzC,IAAI,YAAY,GAAG,KAAK,CAAC;AACzB,MAAM,eAAe,GAAG,IAAI,GAAG,EAAkB,CAAC;AAElD;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB;IACpC,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,EAAE,CAAC;QAClC,IAAI,iBAAiB,CAAC,MAAM,CAAC,EAAE,CAAC;YAC9B,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,OAAO,GAAqB,YAAY,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC;QACpE,MAAM,QAAQ,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC;QACrC,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;QAEjD,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,SAAS,CAAC,CAAC;QAC7C,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,KAAK,GAAG,wBAAwB,EAAE,CAAC;YACvD,KAAK,aAAa,CAAC,6BAA6B,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;gBACpE,IAAI,IAAI,EAAE,CAAC;oBACT,MAAM,aAAa,CAAC,SAAS,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;gBACjD,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC;QAED,MAAM,aAAa,GAAG,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAC5C,IAAI,CAAC,aAAa,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,EAAE,CAAC;YAC/E,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,WAAW,CAAC,EAAE,CAAC;YAC1C,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,aAAa,EAAE,cAAc,EAAE,eAAe,EAAE,CAAC;IAClG,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,eAAe;IAC7B,OAAO,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC;AAC1C,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB;IACpC,MAAM,cAAc,GAAG,gBAAgB,EAAE,CAAC;IAC1C,MAAM,OAAO,GAAG,SAAS,CAAC,cAAc,CAAC,CAAC;IAC1C,MAAM,MAAM,GAAkB,EAAE,OAAO,EAAE,cAAc,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IACzE,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,EAAE,CAAC;QAClC,MAAM,UAAU,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC;QAC7C,IAAI,UAAU,IAAI,UAAU,KAAK,IAAI,EAAE,CAAC;YACtC,OAAO,EAAE,GAAG,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;QACnD,CAAC;QAED,MAAM,QAAQ,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC;QACrC,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;QACjD,MAAM,IAAI,GAAG,MAAM,aAAa,CAAC,yBAAyB,CAAC,CAAC;QAC5D,IAAI,IAAI,EAAE,CAAC;YACT,MAAM,aAAa,CAAC,SAAS,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;YAC/C,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;YACpC,OAAO,aAAa,CAAC,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;QAC/D,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,SAAS,CAAC,CAAC;QAC7C,MAAM,aAAa,GAAG,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAC5C,OAAO,MAAM,IAAI,aAAa;YAC5B,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,WAAW,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,aAAa,EAAE;YACrF,CAAC,CAAC,MAAM,CAAC;IACb,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,MAAM,CAAC;IAChB,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,gBAAgB;IAC9B,IAAI,YAAY,EAAE,CAAC;QACjB,OAAO;IACT,CAAC;IACD,YAAY,GAAG,IAAI,CAAC;IACpB,KAAK,MAAM,QAAQ,IAAI,eAAe,EAAE,CAAC;QACvC,QAAQ,EAAE,CAAC;IACb,CAAC;AACH,CAAC;AAED,2GAA2G;AAC3G,MAAM,UAAU,oBAAoB;IAClC,OAAO,YAAY,CAAC;AACtB,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,OAAyC,gBAAgB;IAC9F,UAAU,GAAG,MAAM,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;IAC5C,KAAK,MAAM,QAAQ,IAAI,eAAe,EAAE,CAAC;QACvC,QAAQ,EAAE,CAAC;IACb,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB;IACpC,MAAM,IAAI,GAAG,MAAM,gBAAgB,EAAE,CAAC;IACtC,IAAI,IAAI,EAAE,CAAC;QACT,SAAS,CAAC;YACR,OAAO,EAAE,IAAI,CAAC,cAAc;YAC5B,IAAI,EAAE,kBAAkB;YACxB,IAAI,EAAE,OAAO,IAAI,CAAC,aAAa,0BAA0B,IAAI,CAAC,cAAc,YAAY,IAAI,CAAC,cAAc,eAAe;SAC3H,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB;IACrC,MAAM,IAAI,GAAG,MAAM,aAAa,EAAE,CAAC;IACnC,IAAI,IAAI,EAAE,CAAC;QACT,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,WAAW,CAAC,MAAM,UAAU,EAAE,CAAC,CAAC;YACjD,MAAM,aAAa,CAAC,IAAI,CAAC,QAAQ,EAAE,cAAc,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;QACtE,CAAC;QAAC,MAAM,CAAC;YACP,gFAAgF;QAClF,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,iFAAiF;AACjF,MAAM,UAAU,iBAAiB;IAC/B,IAAI,CAAC,YAAY,IAAI,CAAC,UAAU,EAAE,CAAC;QACjC,OAAO;IACT,CAAC;IACD,YAAY,GAAG,KAAK,CAAC;IACrB,UAAU,GAAG,IAAI,CAAC;IAClB,KAAK,MAAM,QAAQ,IAAI,eAAe,EAAE,CAAC;QACvC,QAAQ,EAAE,CAAC;IACb,CAAC;AACH,CAAC;AAED,4GAA4G;AAC5G,MAAM,UAAU,qBAAqB,CAAC,QAAwB;IAC5D,eAAe,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC9B,OAAO,GAAG,EAAE;QACV,eAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACnC,CAAC,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAC/B,MAAkC,EAClC,MAAyB,OAAO,CAAC,GAAG;IAEpC,IAAI,MAAM,CAAC,YAAY,KAAK,KAAK;QAAE,OAAO,cAAc,CAAC;IACzD,IAAI,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;QAAE,OAAO,qBAAqB,CAAC;IACtE,IAAI,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAAE,OAAO,IAAI,CAAC;IACpC,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;GAIG;AACH,KAAK,UAAU,aAAa,CAAC,WAA6B,OAAO;IAC/D,IAAI,SAAS,EAAE,EAAE,CAAC;QAChB,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,CAAC;QACH,MAAM,IAAI,GAAgB,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,kBAAkB,EAAE,EAAE,CAAC;QACtE,MAAM,QAAQ,GACZ,QAAQ,KAAK,OAAO;YAClB,CAAC,CAAC,MAAM,cAAc,CAAC,iBAAiB,EAAE,IAAI,CAAC;YAC/C,CAAC,CAAC,MAAM,UAAU,CAAC,KAAK,CAAC,iBAAiB,EAAE;gBACxC,GAAG,IAAI;gBACP,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC;aACtC,CAAC,CAAC;QAET,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;QAC7D,OAAO,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;IAC/C,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED,4FAA4F;AAC5F,SAAS,gBAAgB;IACvB,IAAI,CAAC;QACH,OAAO,oBAAoB,EAAE,CAAC;IAChC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,WAAW,CAAC;IACrB,CAAC;AACH,CAAC;AAED,SAAS,OAAO,CAAC,KAAyB;IACxC,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,EAAE,IAAI,KAAK,KAAK,GAAG,IAAI,KAAK,CAAC,WAAW,EAAE,KAAK,OAAO,CAAC;AACjG,CAAC;AAED,6FAA6F;AAC7F,SAAS,YAAY,CAAC,IAAa;IACjC,MAAM,IAAI,GAAa,EAAE,CAAC;IAC1B,IAAI,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QACrC,KAAK,MAAM,OAAO,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAU,EAAE,CAAC;YACjD,MAAM,KAAK,GAAY,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;YAClD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gBAC9B,IAAI,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC;YACxB,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;GAGG;AACH,KAAK,UAAU,YAAY,CAAC,SAAiB;IAC3C,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,CAAC;QACvC,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;QAC1E,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,QAAQ,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC;IACxD,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED,wFAAwF;AACxF,KAAK,UAAU,aAAa,CAAC,SAAiB,EAAE,QAAgB,EAAE,IAAc;IAC9E,IAAI,CAAC;QACH,MAAM,IAAI,GAAiB,EAAE,GAAG,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;QAE9D,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC1B,MAAM,KAAK,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC7C,CAAC;QACD,MAAM,SAAS,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAAC,MAAM,CAAC;QACP,uDAAuD;IACzD,CAAC;AACH,CAAC"}
|
package/build/lib/web-app.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Links into the ATK web app, which the CLI shows next to assets and bundles
|
|
3
|
-
* (`info`, `browse`, `list`, `search`),
|
|
4
|
-
* (`setup`, `doctor`).
|
|
3
|
+
* (`info`, `browse`, `list`, `search`), to the getting-started videos
|
|
4
|
+
* (`setup`, `doctor`), and to the claude.ai plugins page (`info`).
|
|
5
5
|
*
|
|
6
6
|
* The URL scheme is the web app's own: `webRoutes` from the shared API client,
|
|
7
7
|
* so every link the CLI prints is one the web can parse. Entity identity is in
|
|
@@ -33,6 +33,12 @@ export declare function buildAssetWebUrl(asset: {
|
|
|
33
33
|
* at the latest version otherwise.
|
|
34
34
|
*/
|
|
35
35
|
export declare function buildBundleWebUrl(name: string, org?: string, version?: string): string;
|
|
36
|
+
/**
|
|
37
|
+
* Build the web app URL of the page that tells chat users how to add the claude.ai plugins
|
|
38
|
+
* marketplace (`/claude-plugins/`). The marketplace's GitHub repo is private, so the CLI
|
|
39
|
+
* links here instead (ATK-750).
|
|
40
|
+
*/
|
|
41
|
+
export declare function buildClaudePluginsWebUrl(): string;
|
|
36
42
|
/**
|
|
37
43
|
* Build a web app URL for one of the getting-started pages the CLI names:
|
|
38
44
|
* `basics` (the first series) or `troubleshoot` (its atk doctor chapter).
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"web-app.d.ts","sourceRoot":"","sources":["../../src/lib/web-app.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAEH,OAAO,EAAuB,mBAAmB,EAAyB,MAAM,oBAAoB,CAAC;AAErG,4GAA4G;AAC5G,eAAO,MAAM,eAAe,qCAAqC,CAAC;AAElE,uFAAuF;AACvF,eAAO,MAAM,eAAe,gBAAgB,CAAC;AAE7C;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAE7G;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAEtF;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,MAAM,OAAO,mBAAmB,GAAG,MAAM,CAExF;AAED;;;;GAIG;AACH,wBAAgB,SAAS,IAAI,MAAM,CAIlC"}
|
|
1
|
+
{"version":3,"file":"web-app.d.ts","sourceRoot":"","sources":["../../src/lib/web-app.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAEH,OAAO,EAAuB,mBAAmB,EAAyB,MAAM,oBAAoB,CAAC;AAErG,4GAA4G;AAC5G,eAAO,MAAM,eAAe,qCAAqC,CAAC;AAElE,uFAAuF;AACvF,eAAO,MAAM,eAAe,gBAAgB,CAAC;AAE7C;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAE7G;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAEtF;AAED;;;;GAIG;AACH,wBAAgB,wBAAwB,IAAI,MAAM,CAEjD;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,MAAM,OAAO,mBAAmB,GAAG,MAAM,CAExF;AAED;;;;GAIG;AACH,wBAAgB,SAAS,IAAI,MAAM,CAIlC"}
|