@jskit-ai/workspaces-web 0.2.8 → 0.2.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. package/fixtures/workspaces-components/index.html +2 -0
  2. package/fixtures/workspaces-components/main.js +90 -0
  3. package/fixtures/workspaces-components/vite.config.mjs +9 -0
  4. package/package.json +8 -8
  5. package/patterns/workspace-surfaces/example/src/composables/useWorkspaceNotFoundState.js +2 -2
  6. package/src/client/account-settings/accountSettingsInvitesRuntime.js +25 -7
  7. package/src/client/account-settings/useAccountSettingsInvitesSectionRuntime.js +11 -54
  8. package/src/client/browser.js +54 -0
  9. package/src/client/components/MembersAdminClientElement.vue +41 -111
  10. package/src/client/components/WorkspaceMembersClientElement.vue +17 -701
  11. package/src/client/components/WorkspaceSelector.vue +4 -18
  12. package/src/client/components/WorkspacesClientElement.vue +21 -392
  13. package/src/client/composables/useWorkspaceMembersActions.js +309 -0
  14. package/src/client/composables/useWorkspaceMembersPage.js +401 -0
  15. package/src/client/composables/useWorkspaceRouteContext.js +8 -3
  16. package/src/client/composables/useWorkspaceSurfaceId.js +15 -17
  17. package/src/client/composables/useWorkspacesLanding.js +386 -0
  18. package/src/client/lib/bootstrap.js +4 -9
  19. package/src/client/lib/lastWorkspace.js +7 -19
  20. package/src/client/lib/pendingInvites.js +53 -0
  21. package/src/client/lib/profileSurfaceMenuLinks.js +6 -5
  22. package/src/client/lib/surfaceAccessPolicy.js +18 -32
  23. package/src/client/lib/theme.js +8 -69
  24. package/src/client/lib/workspaceLinkResolver.js +9 -2
  25. package/src/client/lib/workspaceMembersPayloads.js +98 -0
  26. package/src/client/lib/workspaceSurfacePaths.js +3 -8
  27. package/src/client/providers/WorkspacesWebClientProvider.js +23 -22
  28. package/src/client/runtime/bootstrapPlacementRouteGuards.js +44 -41
  29. package/src/client/runtime/bootstrapPlacementRuntime.js +49 -76
  30. package/src/client/runtime/bootstrapPlacementRuntimeHelpers.js +6 -12
  31. package/src/client/support/realtimeWorkspace.js +6 -2
  32. package/src/client/support/runtimeNormalization.js +1 -8
  33. package/src/client/support/workspaceScopeSupport.js +10 -7
  34. package/src/client/types.js +168 -0
  35. package/test/bootstrapPlacementRuntime.test.js +25 -1
  36. package/test/pendingInvites.test.js +34 -0
  37. package/test/settingsPlacementContract.test.js +7 -3
  38. package/test/workspaceMembersPayloads.test.js +52 -0
  39. package/test/workspacesComponents.browser.test.js +285 -0
@@ -0,0 +1,52 @@
1
+ import assert from "node:assert/strict";
2
+ import test from "node:test";
3
+ import {
4
+ latestPage,
5
+ normalizeInvites,
6
+ normalizeMembers,
7
+ normalizeRoleCatalog
8
+ } from "../src/client/lib/workspaceMembersPayloads.js";
9
+
10
+ test("normalizeRoleCatalog reads a wrapped or bare catalog and labels each assignable role", () => {
11
+ const catalog = {
12
+ roles: [{ id: "Member", label: " Team member ", assignable: true }, { id: "owner", assignable: false }],
13
+ assignableRoleIds: ["member", " MEMBER ", "viewer"],
14
+ defaultInviteRole: " Member "
15
+ };
16
+
17
+ for (const payload of [catalog, { roleCatalog: catalog }]) {
18
+ const normalized = normalizeRoleCatalog(payload);
19
+ assert.deepEqual(normalized.roleOptions, [
20
+ { title: "Team member", value: "member" },
21
+ { title: "Viewer", value: "viewer" }
22
+ ]);
23
+ assert.equal(normalized.roleLabels.member, "Team member");
24
+ assert.equal(normalized.defaultInviteRole, "member");
25
+ }
26
+ });
27
+
28
+ test("normalizeRoleCatalog falls back to the roles marked assignable", () => {
29
+ const normalized = normalizeRoleCatalog({
30
+ roles: [{ id: "member", assignable: true }, { id: "owner", assignable: false }]
31
+ });
32
+
33
+ assert.deepEqual(normalized.roleOptions, [{ title: "Member", value: "member" }]);
34
+ assert.deepEqual(normalizeRoleCatalog(null).roleOptions, []);
35
+ });
36
+
37
+ test("members and invites keep only what the page shows, in normal form", () => {
38
+ assert.deepEqual(normalizeMembers([{ userId: 7, roleSid: " Admin ", email: " ADA@EXAMPLE.COM ", isOwner: 1 }]), [
39
+ { userId: "7", roleSid: "admin", status: "", displayName: "", email: "ada@example.com", isOwner: true }
40
+ ]);
41
+ assert.deepEqual(normalizeInvites([{ id: 9, email: "A@B.C", roleSid: "Member", expiresAt: "2099-01-01" }]), [
42
+ { id: "9", email: "a@b.c", roleSid: "member", status: "", expiresAt: "2099-01-01", invitedByUserId: null }
43
+ ]);
44
+ assert.deepEqual(normalizeMembers(null), []);
45
+ assert.deepEqual(normalizeInvites(null), []);
46
+ });
47
+
48
+ test("latestPage is the last page, or nothing", () => {
49
+ assert.equal(latestPage(["first", "last"]), "last");
50
+ assert.equal(latestPage([]), null);
51
+ assert.equal(latestPage(null), null);
52
+ });
@@ -0,0 +1,285 @@
1
+ import assert from "node:assert/strict";
2
+ import test from "node:test";
3
+ import { fileURLToPath } from "node:url";
4
+ import { chromium, expect } from "@playwright/test";
5
+ import { createChromiumLaunchOptions, startViteFixture, stopProcess } from "../../../tooling/testUtils/browserFixture.mjs";
6
+
7
+ const VIEWPORTS = [
8
+ { name: "phone", width: 390, height: 844 },
9
+ { name: "desktop", width: 1280, height: 900 }
10
+ ];
11
+
12
+ const WORKSPACES = [
13
+ { id: "1", slug: "home", name: "Home", roleSid: "owner" },
14
+ { id: "2", slug: "acme", name: "Acme", roleSid: "member" },
15
+ { id: "3", slug: "zen", name: "Zen Garden", roleSid: "member" }
16
+ ];
17
+
18
+ const INVITES = [
19
+ { id: "5", workspaceId: "4", workspaceSlug: "zen-two", workspaceName: "Zen Two", token: "zen-two-token", roleSid: "member" },
20
+ { id: "6", workspaceId: "8", workspaceSlug: "orbit", workspaceName: "Orbit", token: "orbit-token", roleSid: "admin", roleLabel: "Administrator" }
21
+ ];
22
+
23
+ function createDeferred() {
24
+ let resolve;
25
+ const promise = new Promise((done) => {
26
+ resolve = done;
27
+ });
28
+ return { promise, resolve };
29
+ }
30
+
31
+ // A request the fixture server holds: `arrived` settles when it comes in, `release` lets it answer.
32
+ function createGate() {
33
+ return { arrived: createDeferred(), release: createDeferred() };
34
+ }
35
+
36
+ async function arrival(gate, label) {
37
+ let timer;
38
+ const timeout = new Promise((_resolve, reject) => {
39
+ timer = setTimeout(() => reject(new Error(`No ${label} request arrived.`)), 15_000);
40
+ });
41
+ try {
42
+ await Promise.race([gate.arrived.promise, timeout]);
43
+ } finally {
44
+ clearTimeout(timer);
45
+ }
46
+ }
47
+
48
+ async function openPage(browser, baseURL, viewport) {
49
+ const page = await browser.newPage({ baseURL, viewport });
50
+ page.setDefaultTimeout(15_000);
51
+ page.setDefaultNavigationTimeout(60_000);
52
+ const errors = [];
53
+ page.on("pageerror", (error) => errors.push(error.message));
54
+ return { page, errors };
55
+ }
56
+
57
+ async function assertNoHorizontalScroll(page, label) {
58
+ assert.equal(
59
+ await page.evaluate(() => document.documentElement.scrollWidth - document.documentElement.clientWidth),
60
+ 0,
61
+ `${label}: no horizontal scroll`
62
+ );
63
+ }
64
+
65
+ function readListItems(list) {
66
+ return list.locator(".v-list-item").evaluateAll((items) => items.map((item) => [
67
+ item.querySelector(".v-list-item-title")?.textContent.trim() || "",
68
+ item.querySelector(".v-list-item-subtitle")?.textContent.trim() || "",
69
+ item.classList.contains("v-list-item--active")
70
+ ]));
71
+ }
72
+
73
+ async function checkWorkspaceSelector(page, viewport) {
74
+ const requests = [];
75
+ await page.route("**/api/**", async (route) => {
76
+ requests.push(`${route.request().method()} ${new URL(route.request().url()).pathname}`);
77
+ await route.fulfill({ status: 404, json: {} });
78
+ });
79
+ const selector = page.locator(".users-workspace-selector__activator");
80
+ const menu = page.locator(".v-menu .v-list");
81
+
82
+ await page.goto("/w/acme");
83
+ await page.getByText("Opened acme", { exact: true }).waitFor();
84
+ await expect(selector).toHaveText("Acme");
85
+ assert.ok((await selector.boundingBox()).height >= 48, `${viewport.name}: the selector is a 48px target`);
86
+ await assertNoHorizontalScroll(page, `${viewport.name} selector`);
87
+
88
+ await selector.click();
89
+ await expect(menu).toBeVisible();
90
+ await expect(menu.locator(".v-list-subheader")).toHaveText("Workspaces");
91
+ assert.deepEqual(await readListItems(menu), [
92
+ ["Home", "/home", false],
93
+ ["Acme", "/acme", true],
94
+ ["Zen Garden", "/zen", false]
95
+ ]);
96
+ await menu.getByText("Zen Garden", { exact: true }).click();
97
+ await page.waitForURL((url) => url.pathname === "/w/zen");
98
+ await page.getByText("Opened zen", { exact: true }).waitFor();
99
+ await expect(selector).toHaveText("Zen Garden");
100
+
101
+ // On the admin surface another workspace opens on the admin surface too.
102
+ await page.goto("/w/zen/admin");
103
+ await page.getByText("Admin of zen", { exact: true }).waitFor();
104
+ await expect(selector).toHaveText("Zen Garden");
105
+ await selector.click();
106
+ await expect(menu).toBeVisible();
107
+ assert.deepEqual(await readListItems(menu), [
108
+ ["Home", "/home", false],
109
+ ["Acme", "/acme", false],
110
+ ["Zen Garden", "/zen", true]
111
+ ]);
112
+ await menu.getByText("Home", { exact: true }).click();
113
+ await page.waitForURL((url) => url.pathname === "/w/home/admin");
114
+ await page.getByText("Admin of home", { exact: true }).waitFor();
115
+ await expect(selector).toHaveText("Home");
116
+
117
+ // A surface without a workspace has no selector.
118
+ await page.goto("/home");
119
+ await page.getByText("Home page", { exact: true }).waitFor();
120
+ await expect(selector).toHaveCount(0);
121
+ assert.deepEqual(requests, [], "the selector reads the placement context and fetches nothing");
122
+ }
123
+
124
+ async function checkInvitesSection(page, viewport) {
125
+ let pendingInvites = INVITES.map((invite) => ({ ...invite }));
126
+ let bootstrapGate = null;
127
+ let redeemGate = null;
128
+ const redeems = [];
129
+ const unexpected = [];
130
+ await page.route("**/api/**", async (route) => {
131
+ const request = route.request();
132
+ const path = new URL(request.url()).pathname;
133
+ if (request.method() === "GET" && path === "/api/session") {
134
+ await route.fulfill({ json: { csrfToken: "fixture-csrf" } });
135
+ return;
136
+ }
137
+ if (request.method() === "GET" && path === "/api/bootstrap") {
138
+ const gate = bootstrapGate;
139
+ if (gate) {
140
+ gate.arrived.resolve();
141
+ await gate.release.promise;
142
+ }
143
+ await route.fulfill({
144
+ json: {
145
+ session: { authenticated: true, userId: "7" },
146
+ tenancy: { mode: "workspaces", workspace: { allowSelfCreate: true } },
147
+ app: { features: { workspaceInvites: true } },
148
+ workspaces: WORKSPACES,
149
+ pendingInvites
150
+ }
151
+ });
152
+ return;
153
+ }
154
+ if (request.method() === "POST" && path === "/api/workspace/invitations/redeem") {
155
+ const body = request.postDataJSON();
156
+ redeems.push({ csrfToken: request.headers()["csrf-token"], type: body?.data?.type, attributes: body?.data?.attributes });
157
+ const gate = redeemGate;
158
+ if (gate) {
159
+ gate.arrived.resolve();
160
+ await gate.release.promise;
161
+ }
162
+ pendingInvites = pendingInvites.filter((invite) => invite.token !== body.data.attributes.token);
163
+ await route.fulfill({
164
+ contentType: "application/vnd.api+json",
165
+ json: { data: { type: "workspace-invitation-decisions", id: "1", attributes: { decision: body.data.attributes.decision } } }
166
+ });
167
+ return;
168
+ }
169
+ unexpected.push(`${request.method()} ${path}`);
170
+ await route.fulfill({ status: 404, json: {} });
171
+ });
172
+ const section = page.locator(".account-invites-section");
173
+ const rows = section.locator(".v-list-item");
174
+ const button = (workspaceName, label) => rows.filter({ hasText: workspaceName }).getByRole("button", { name: label, exact: true });
175
+ const progress = section.locator(".v-progress-linear");
176
+
177
+ // Loading.
178
+ bootstrapGate = createGate();
179
+ await page.goto("/account");
180
+ await arrival(bootstrapGate, "bootstrap");
181
+ await expect(section.getByText("Invitations", { exact: true })).toBeVisible();
182
+ await expect(section.locator(".v-skeleton-loader")).toBeVisible();
183
+ await expect(section.getByText("No pending invitations.", { exact: true })).toHaveCount(0);
184
+ bootstrapGate.release.resolve();
185
+ bootstrapGate = null;
186
+
187
+ // The list.
188
+ await expect(rows).toHaveCount(2);
189
+ await expect(section.locator(".v-skeleton-loader")).toHaveCount(0);
190
+ assert.deepEqual(await readListItems(section), [
191
+ ["Zen Two", "/zen-two • role: member", false],
192
+ ["Orbit", "/orbit • role: Administrator", false]
193
+ ]);
194
+ await assertNoHorizontalScroll(page, `${viewport.name} invitations`);
195
+ if (viewport.name === "phone") {
196
+ const heights = await section.locator(".v-btn").evaluateAll((buttons) => buttons.map((item) => item.getBoundingClientRect().height));
197
+ assert.ok(heights.length === 4 && heights.every((height) => height >= 48), `${viewport.name}: 48px targets, got ${heights}`);
198
+ }
199
+
200
+ // Refuse: busy while the server answers, the others wait, and the list refreshes after it.
201
+ redeemGate = createGate();
202
+ await button("Zen Two", "Refuse").click();
203
+ await arrival(redeemGate, "redeem");
204
+ await expect(button("Zen Two", "Refuse")).toHaveAttribute("aria-busy", "true");
205
+ await expect(button("Orbit", "Refuse")).toBeDisabled();
206
+ await expect(button("Orbit", "Join")).toBeDisabled();
207
+ await button("Zen Two", "Join").click();
208
+ await expect(button("Zen Two", "Join")).not.toHaveAttribute("aria-busy", "true");
209
+ bootstrapGate = createGate();
210
+ redeemGate.release.resolve();
211
+ redeemGate = null;
212
+ await arrival(bootstrapGate, "bootstrap");
213
+ await expect(rows).toHaveCount(1);
214
+ await expect(progress).toBeVisible();
215
+ await expect(button("Orbit", "Refuse")).toBeDisabled();
216
+ await expect(button("Orbit", "Join")).toBeDisabled();
217
+ bootstrapGate.release.resolve();
218
+ bootstrapGate = null;
219
+ await expect(progress).toHaveCount(0);
220
+ await expect(button("Orbit", "Join")).toBeEnabled();
221
+ await expect(button("Orbit", "Refuse")).toBeEnabled();
222
+
223
+ // Join: busy, refreshed, then the joined workspace opens.
224
+ redeemGate = createGate();
225
+ await button("Orbit", "Join").click();
226
+ await arrival(redeemGate, "redeem");
227
+ await expect(button("Orbit", "Join")).toHaveAttribute("aria-busy", "true");
228
+ bootstrapGate = createGate();
229
+ redeemGate.release.resolve();
230
+ redeemGate = null;
231
+ await arrival(bootstrapGate, "bootstrap");
232
+ await expect(rows).toHaveCount(0);
233
+ await expect(progress).toBeVisible();
234
+ await expect(section.getByText("No pending invitations.", { exact: true })).toBeVisible();
235
+ bootstrapGate.release.resolve();
236
+ bootstrapGate = null;
237
+ await page.waitForURL((url) => url.pathname === "/w/orbit");
238
+ await page.getByText("Opened orbit", { exact: true }).waitFor();
239
+ assert.deepEqual(await page.locator(".fixture-feedback li").allTextContents(), ["success: Invitation refused."]);
240
+
241
+ // Nothing pending.
242
+ await page.goto("/account");
243
+ await expect(section.getByText("No pending invitations.", { exact: true })).toBeVisible();
244
+ await expect(rows).toHaveCount(0);
245
+ await expect(section.locator(".v-skeleton-loader, .v-progress-linear")).toHaveCount(0);
246
+
247
+ assert.deepEqual(redeems, [
248
+ { csrfToken: "fixture-csrf", type: "workspace-invitation-decisions", attributes: { token: "zen-two-token", decision: "refuse" } },
249
+ { csrfToken: "fixture-csrf", type: "workspace-invitation-decisions", attributes: { token: "orbit-token", decision: "accept" } }
250
+ ]);
251
+ assert.deepEqual(unexpected, []);
252
+ }
253
+
254
+ test("The workspace selector and the account invitations work in a real browser", {
255
+ skip: process.env.JSKIT_WORKSPACES_WEB_COMPONENTS_BROWSER !== "1",
256
+ timeout: 240_000
257
+ }, async (t) => {
258
+ const runtime = await startViteFixture({ fixtureRoot: fileURLToPath(new URL("../fixtures/workspaces-components/", import.meta.url)) });
259
+ let browser;
260
+ try {
261
+ browser = await chromium.launch(createChromiumLaunchOptions());
262
+ for (const [name, check] of [
263
+ ["the selector lists the workspaces, marks the current one and opens the chosen one", checkWorkspaceSelector],
264
+ ["the invitations load, list, refuse and join through the redeem endpoint", checkInvitesSection]
265
+ ]) {
266
+ for (const viewport of VIEWPORTS) {
267
+ await t.test(`${viewport.name}: ${name}`, async () => {
268
+ const { page, errors } = await openPage(browser, runtime.baseURL, viewport);
269
+ try {
270
+ await check(page, viewport);
271
+ assert.deepEqual(errors, []);
272
+ } catch (error) {
273
+ console.error(await page.locator("body").innerText().catch(() => ""));
274
+ throw error;
275
+ } finally {
276
+ await page.close();
277
+ }
278
+ });
279
+ }
280
+ }
281
+ } finally {
282
+ if (browser) await browser.close();
283
+ await stopProcess(runtime);
284
+ }
285
+ });