@remit/ui 0.0.203 → 0.0.204
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/package.json
CHANGED
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
import type { Meta, StoryObj } from "@storybook/react";
|
|
2
|
+
import { Folder } from "lucide-react";
|
|
3
|
+
import { cn } from "../lib/cn.js";
|
|
4
|
+
import {
|
|
5
|
+
FolderSyncBadge,
|
|
6
|
+
type FolderSyncState,
|
|
7
|
+
folderSyncAriaLabel,
|
|
8
|
+
isFolderSyncNavigable,
|
|
9
|
+
} from "./folder-sync-state.js";
|
|
10
|
+
|
|
11
|
+
const meta: Meta<typeof FolderSyncBadge> = {
|
|
12
|
+
title: "Design System/Mail/FolderSyncState",
|
|
13
|
+
tags: ["proposed"],
|
|
14
|
+
component: FolderSyncBadge,
|
|
15
|
+
parameters: { layout: "centered" },
|
|
16
|
+
};
|
|
17
|
+
export default meta;
|
|
18
|
+
|
|
19
|
+
type Story = StoryObj<typeof FolderSyncBadge>;
|
|
20
|
+
|
|
21
|
+
function FolderRowPreview({
|
|
22
|
+
label,
|
|
23
|
+
state,
|
|
24
|
+
}: {
|
|
25
|
+
label: string;
|
|
26
|
+
state: FolderSyncState;
|
|
27
|
+
}) {
|
|
28
|
+
const navigable = isFolderSyncNavigable(state);
|
|
29
|
+
return (
|
|
30
|
+
<ul className="w-[320px] list-none overflow-hidden rounded-lg border border-line bg-surface font-sans">
|
|
31
|
+
<li
|
|
32
|
+
aria-label={folderSyncAriaLabel(label, state)}
|
|
33
|
+
className={cn(
|
|
34
|
+
"flex min-h-11 items-center gap-2 px-3 py-2.5",
|
|
35
|
+
!navigable && "opacity-60",
|
|
36
|
+
)}
|
|
37
|
+
>
|
|
38
|
+
<Folder className="size-4 shrink-0 text-fg-subtle" aria-hidden="true" />
|
|
39
|
+
<span className="min-w-0 flex-1 truncate text-sm text-fg">{label}</span>
|
|
40
|
+
<FolderSyncBadge state={state} />
|
|
41
|
+
</li>
|
|
42
|
+
</ul>
|
|
43
|
+
);
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
export const Healthy: Story = {
|
|
47
|
+
name: "Healthy",
|
|
48
|
+
render: () => (
|
|
49
|
+
<FolderRowPreview label="Receipts" state={{ kind: "healthy" }} />
|
|
50
|
+
),
|
|
51
|
+
};
|
|
52
|
+
|
|
53
|
+
export const Creating: Story = {
|
|
54
|
+
name: "Creating",
|
|
55
|
+
render: () => (
|
|
56
|
+
<FolderRowPreview label="Receipts" state={{ kind: "creating" }} />
|
|
57
|
+
),
|
|
58
|
+
};
|
|
59
|
+
|
|
60
|
+
export const Renaming: Story = {
|
|
61
|
+
name: "Renaming",
|
|
62
|
+
render: () => (
|
|
63
|
+
<FolderRowPreview
|
|
64
|
+
label="Receipts"
|
|
65
|
+
state={{ kind: "renaming", target: "Q3 Receipts" }}
|
|
66
|
+
/>
|
|
67
|
+
),
|
|
68
|
+
};
|
|
69
|
+
|
|
70
|
+
export const Deleting: Story = {
|
|
71
|
+
name: "Deleting",
|
|
72
|
+
render: () => (
|
|
73
|
+
<FolderRowPreview label="Receipts" state={{ kind: "deleting" }} />
|
|
74
|
+
),
|
|
75
|
+
};
|
|
76
|
+
|
|
77
|
+
export const RenameFailed: Story = {
|
|
78
|
+
name: "Rename failed",
|
|
79
|
+
render: () => (
|
|
80
|
+
<FolderRowPreview
|
|
81
|
+
label="Receipts"
|
|
82
|
+
state={{ kind: "rename-failed", target: "Q3 Receipts" }}
|
|
83
|
+
/>
|
|
84
|
+
),
|
|
85
|
+
};
|
|
86
|
+
|
|
87
|
+
export const DeleteFailed: Story = {
|
|
88
|
+
name: "Delete failed",
|
|
89
|
+
render: () => (
|
|
90
|
+
<FolderRowPreview label="Receipts" state={{ kind: "delete-failed" }} />
|
|
91
|
+
),
|
|
92
|
+
};
|
|
@@ -0,0 +1,204 @@
|
|
|
1
|
+
import assert from "node:assert/strict";
|
|
2
|
+
import { describe, it } from "node:test";
|
|
3
|
+
import { createElement } from "react";
|
|
4
|
+
import { renderToString } from "react-dom/server";
|
|
5
|
+
import {
|
|
6
|
+
FolderSyncBadge,
|
|
7
|
+
type FolderSyncState,
|
|
8
|
+
folderSyncAriaLabel,
|
|
9
|
+
folderSyncState,
|
|
10
|
+
isFolderSyncNavigable,
|
|
11
|
+
} from "./folder-sync-state.js";
|
|
12
|
+
|
|
13
|
+
const render = (state: FolderSyncState) =>
|
|
14
|
+
renderToString(createElement(FolderSyncBadge, { state }));
|
|
15
|
+
|
|
16
|
+
describe("folderSyncState", () => {
|
|
17
|
+
it("reads a synced mailbox as healthy", () => {
|
|
18
|
+
assert.deepEqual(
|
|
19
|
+
folderSyncState({ syncStatus: "synced", hierarchyDelimiter: "/" }),
|
|
20
|
+
{ kind: "healthy" },
|
|
21
|
+
);
|
|
22
|
+
});
|
|
23
|
+
|
|
24
|
+
it("reads synced with a pendingPath as healthy — unreachable by invariant (D3)", () => {
|
|
25
|
+
assert.deepEqual(
|
|
26
|
+
folderSyncState({
|
|
27
|
+
syncStatus: "synced",
|
|
28
|
+
pendingPath: "Receipts",
|
|
29
|
+
hierarchyDelimiter: "/",
|
|
30
|
+
}),
|
|
31
|
+
{ kind: "healthy" },
|
|
32
|
+
);
|
|
33
|
+
});
|
|
34
|
+
|
|
35
|
+
it("reads a pending mailbox with no pendingPath as creating", () => {
|
|
36
|
+
assert.deepEqual(
|
|
37
|
+
folderSyncState({ syncStatus: "pending", hierarchyDelimiter: "/" }),
|
|
38
|
+
{ kind: "creating" },
|
|
39
|
+
);
|
|
40
|
+
});
|
|
41
|
+
|
|
42
|
+
it("reads a pending mailbox with a pendingPath as renaming, to the leaf segment", () => {
|
|
43
|
+
assert.deepEqual(
|
|
44
|
+
folderSyncState({
|
|
45
|
+
syncStatus: "pending",
|
|
46
|
+
pendingPath: "Archive/Q3 Receipts",
|
|
47
|
+
hierarchyDelimiter: "/",
|
|
48
|
+
}),
|
|
49
|
+
{ kind: "renaming", target: "Q3 Receipts" },
|
|
50
|
+
);
|
|
51
|
+
});
|
|
52
|
+
|
|
53
|
+
it("reads the leaf by the mailbox's own delimiter, not a hardcoded slash", () => {
|
|
54
|
+
assert.deepEqual(
|
|
55
|
+
folderSyncState({
|
|
56
|
+
syncStatus: "pending",
|
|
57
|
+
pendingPath: "INBOX.Archive.Q3 Receipts",
|
|
58
|
+
hierarchyDelimiter: ".",
|
|
59
|
+
}),
|
|
60
|
+
{ kind: "renaming", target: "Q3 Receipts" },
|
|
61
|
+
);
|
|
62
|
+
});
|
|
63
|
+
|
|
64
|
+
it("still reads as renaming when pendingPath equals the current fullPath — the derivation does not second-guess the server", () => {
|
|
65
|
+
assert.deepEqual(
|
|
66
|
+
folderSyncState({
|
|
67
|
+
syncStatus: "pending",
|
|
68
|
+
pendingPath: "Receipts",
|
|
69
|
+
hierarchyDelimiter: "/",
|
|
70
|
+
}),
|
|
71
|
+
{ kind: "renaming", target: "Receipts" },
|
|
72
|
+
);
|
|
73
|
+
});
|
|
74
|
+
|
|
75
|
+
it("reads a deleting mailbox as deleting", () => {
|
|
76
|
+
assert.deepEqual(
|
|
77
|
+
folderSyncState({ syncStatus: "deleting", hierarchyDelimiter: "/" }),
|
|
78
|
+
{ kind: "deleting" },
|
|
79
|
+
);
|
|
80
|
+
});
|
|
81
|
+
|
|
82
|
+
it("reads a failed mailbox with a pendingPath as rename-failed, to the leaf segment", () => {
|
|
83
|
+
assert.deepEqual(
|
|
84
|
+
folderSyncState({
|
|
85
|
+
syncStatus: "failed",
|
|
86
|
+
pendingPath: "Archive/Q3 Receipts",
|
|
87
|
+
hierarchyDelimiter: "/",
|
|
88
|
+
}),
|
|
89
|
+
{ kind: "rename-failed", target: "Q3 Receipts" },
|
|
90
|
+
);
|
|
91
|
+
});
|
|
92
|
+
|
|
93
|
+
it("reads a failed mailbox with no pendingPath as delete-failed", () => {
|
|
94
|
+
assert.deepEqual(
|
|
95
|
+
folderSyncState({ syncStatus: "failed", hierarchyDelimiter: "/" }),
|
|
96
|
+
{ kind: "delete-failed" },
|
|
97
|
+
);
|
|
98
|
+
});
|
|
99
|
+
});
|
|
100
|
+
|
|
101
|
+
describe("folderSyncAriaLabel", () => {
|
|
102
|
+
it("reads as the plain name for healthy", () => {
|
|
103
|
+
assert.equal(
|
|
104
|
+
folderSyncAriaLabel("Receipts", { kind: "healthy" }),
|
|
105
|
+
"Receipts",
|
|
106
|
+
);
|
|
107
|
+
});
|
|
108
|
+
|
|
109
|
+
it("names the folder and the state for creating", () => {
|
|
110
|
+
assert.equal(
|
|
111
|
+
folderSyncAriaLabel("Receipts", { kind: "creating" }),
|
|
112
|
+
"Receipts — creating",
|
|
113
|
+
);
|
|
114
|
+
});
|
|
115
|
+
|
|
116
|
+
it("names the folder, the state and the target for renaming", () => {
|
|
117
|
+
assert.equal(
|
|
118
|
+
folderSyncAriaLabel("Receipts", {
|
|
119
|
+
kind: "renaming",
|
|
120
|
+
target: "Q3 Receipts",
|
|
121
|
+
}),
|
|
122
|
+
"Receipts — renaming to Q3 Receipts",
|
|
123
|
+
);
|
|
124
|
+
});
|
|
125
|
+
|
|
126
|
+
it("names the folder and the state for deleting", () => {
|
|
127
|
+
assert.equal(
|
|
128
|
+
folderSyncAriaLabel("Receipts", { kind: "deleting" }),
|
|
129
|
+
"Receipts — deleting",
|
|
130
|
+
);
|
|
131
|
+
});
|
|
132
|
+
|
|
133
|
+
it("names the folder and the state for rename-failed", () => {
|
|
134
|
+
assert.equal(
|
|
135
|
+
folderSyncAriaLabel("Receipts", {
|
|
136
|
+
kind: "rename-failed",
|
|
137
|
+
target: "Q3 Receipts",
|
|
138
|
+
}),
|
|
139
|
+
"Receipts — rename failed",
|
|
140
|
+
);
|
|
141
|
+
});
|
|
142
|
+
|
|
143
|
+
it("names the folder and the state for delete-failed", () => {
|
|
144
|
+
assert.equal(
|
|
145
|
+
folderSyncAriaLabel("Receipts", { kind: "delete-failed" }),
|
|
146
|
+
"Receipts — delete failed",
|
|
147
|
+
);
|
|
148
|
+
});
|
|
149
|
+
});
|
|
150
|
+
|
|
151
|
+
describe("isFolderSyncNavigable", () => {
|
|
152
|
+
it("is navigable for healthy, renaming, rename-failed and delete-failed", () => {
|
|
153
|
+
assert.equal(isFolderSyncNavigable({ kind: "healthy" }), true);
|
|
154
|
+
assert.equal(
|
|
155
|
+
isFolderSyncNavigable({ kind: "renaming", target: "Q3 Receipts" }),
|
|
156
|
+
true,
|
|
157
|
+
);
|
|
158
|
+
assert.equal(
|
|
159
|
+
isFolderSyncNavigable({
|
|
160
|
+
kind: "rename-failed",
|
|
161
|
+
target: "Q3 Receipts",
|
|
162
|
+
}),
|
|
163
|
+
true,
|
|
164
|
+
);
|
|
165
|
+
assert.equal(isFolderSyncNavigable({ kind: "delete-failed" }), true);
|
|
166
|
+
});
|
|
167
|
+
|
|
168
|
+
it("is not navigable for creating or deleting", () => {
|
|
169
|
+
assert.equal(isFolderSyncNavigable({ kind: "creating" }), false);
|
|
170
|
+
assert.equal(isFolderSyncNavigable({ kind: "deleting" }), false);
|
|
171
|
+
});
|
|
172
|
+
});
|
|
173
|
+
|
|
174
|
+
describe("FolderSyncBadge", () => {
|
|
175
|
+
it("renders nothing for healthy", () => {
|
|
176
|
+
assert.equal(render({ kind: "healthy" }), "");
|
|
177
|
+
});
|
|
178
|
+
|
|
179
|
+
it("renders the creating copy", () => {
|
|
180
|
+
assert.match(render({ kind: "creating" }), /Creating…/);
|
|
181
|
+
});
|
|
182
|
+
|
|
183
|
+
it("renders the renaming copy with typographic quotes around the target", () => {
|
|
184
|
+
assert.match(
|
|
185
|
+
render({ kind: "renaming", target: "Q3 Receipts" }),
|
|
186
|
+
/Renaming to “Q3 Receipts”…/,
|
|
187
|
+
);
|
|
188
|
+
});
|
|
189
|
+
|
|
190
|
+
it("renders the deleting copy", () => {
|
|
191
|
+
assert.match(render({ kind: "deleting" }), /Deleting…/);
|
|
192
|
+
});
|
|
193
|
+
|
|
194
|
+
it("renders the rename-failed copy", () => {
|
|
195
|
+
assert.match(
|
|
196
|
+
render({ kind: "rename-failed", target: "Q3 Receipts" }),
|
|
197
|
+
/Rename failed/,
|
|
198
|
+
);
|
|
199
|
+
});
|
|
200
|
+
|
|
201
|
+
it("renders the delete-failed copy", () => {
|
|
202
|
+
assert.match(render({ kind: "delete-failed" }), /Delete failed/);
|
|
203
|
+
});
|
|
204
|
+
});
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
import { folderLeaf } from "../lib/folder-tree.js";
|
|
2
|
+
import { Badge } from "./badge.js";
|
|
3
|
+
|
|
4
|
+
export type FolderSyncState =
|
|
5
|
+
| { kind: "healthy" }
|
|
6
|
+
| { kind: "creating" }
|
|
7
|
+
| { kind: "renaming"; target: string }
|
|
8
|
+
| { kind: "deleting" }
|
|
9
|
+
| { kind: "rename-failed"; target: string }
|
|
10
|
+
| { kind: "delete-failed" };
|
|
11
|
+
|
|
12
|
+
export interface FolderSyncMailbox {
|
|
13
|
+
syncStatus: string;
|
|
14
|
+
pendingPath?: string;
|
|
15
|
+
hierarchyDelimiter: string;
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
export function folderSyncState(mailbox: FolderSyncMailbox): FolderSyncState {
|
|
19
|
+
if (mailbox.syncStatus === "pending") {
|
|
20
|
+
return mailbox.pendingPath
|
|
21
|
+
? {
|
|
22
|
+
kind: "renaming",
|
|
23
|
+
target: folderLeaf(mailbox.pendingPath, mailbox.hierarchyDelimiter),
|
|
24
|
+
}
|
|
25
|
+
: { kind: "creating" };
|
|
26
|
+
}
|
|
27
|
+
if (mailbox.syncStatus === "deleting") return { kind: "deleting" };
|
|
28
|
+
if (mailbox.syncStatus === "failed") {
|
|
29
|
+
return mailbox.pendingPath
|
|
30
|
+
? {
|
|
31
|
+
kind: "rename-failed",
|
|
32
|
+
target: folderLeaf(mailbox.pendingPath, mailbox.hierarchyDelimiter),
|
|
33
|
+
}
|
|
34
|
+
: { kind: "delete-failed" };
|
|
35
|
+
}
|
|
36
|
+
return { kind: "healthy" };
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
export function folderSyncAriaLabel(
|
|
40
|
+
folderName: string,
|
|
41
|
+
state: FolderSyncState,
|
|
42
|
+
): string {
|
|
43
|
+
switch (state.kind) {
|
|
44
|
+
case "healthy":
|
|
45
|
+
return folderName;
|
|
46
|
+
case "creating":
|
|
47
|
+
return `${folderName} — creating`;
|
|
48
|
+
case "renaming":
|
|
49
|
+
return `${folderName} — renaming to ${state.target}`;
|
|
50
|
+
case "deleting":
|
|
51
|
+
return `${folderName} — deleting`;
|
|
52
|
+
case "rename-failed":
|
|
53
|
+
return `${folderName} — rename failed`;
|
|
54
|
+
case "delete-failed":
|
|
55
|
+
return `${folderName} — delete failed`;
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
export function isFolderSyncNavigable(state: FolderSyncState): boolean {
|
|
60
|
+
return (
|
|
61
|
+
state.kind === "healthy" ||
|
|
62
|
+
state.kind === "renaming" ||
|
|
63
|
+
state.kind === "rename-failed" ||
|
|
64
|
+
state.kind === "delete-failed"
|
|
65
|
+
);
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
export interface FolderSyncBadgeProps {
|
|
69
|
+
state: FolderSyncState;
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
export function FolderSyncBadge({ state }: FolderSyncBadgeProps) {
|
|
73
|
+
switch (state.kind) {
|
|
74
|
+
case "healthy":
|
|
75
|
+
return null;
|
|
76
|
+
case "creating":
|
|
77
|
+
return <Badge tone="neutral">Creating…</Badge>;
|
|
78
|
+
case "renaming":
|
|
79
|
+
return <Badge tone="neutral">{`Renaming to “${state.target}”…`}</Badge>;
|
|
80
|
+
case "deleting":
|
|
81
|
+
return <Badge tone="neutral">Deleting…</Badge>;
|
|
82
|
+
case "rename-failed":
|
|
83
|
+
return <Badge tone="danger">Rename failed</Badge>;
|
|
84
|
+
case "delete-failed":
|
|
85
|
+
return <Badge tone="danger">Delete failed</Badge>;
|
|
86
|
+
}
|
|
87
|
+
}
|
package/src/index.ts
CHANGED
|
@@ -481,6 +481,15 @@ export {
|
|
|
481
481
|
FolderRow,
|
|
482
482
|
type FolderRowProps,
|
|
483
483
|
} from "./components/folder-row.js";
|
|
484
|
+
export {
|
|
485
|
+
FolderSyncBadge,
|
|
486
|
+
type FolderSyncBadgeProps,
|
|
487
|
+
type FolderSyncMailbox,
|
|
488
|
+
type FolderSyncState,
|
|
489
|
+
folderSyncAriaLabel,
|
|
490
|
+
folderSyncState,
|
|
491
|
+
isFolderSyncNavigable,
|
|
492
|
+
} from "./components/folder-sync-state.js";
|
|
484
493
|
export {
|
|
485
494
|
type FolderTreeNode,
|
|
486
495
|
FolderTreePicker,
|