@jskit-ai/workspaces-web 0.2.33 → 0.2.35

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 CHANGED
@@ -2,6 +2,8 @@
2
2
 
3
3
  ## Unreleased
4
4
 
5
+ - Inviting, revoking an invite, changing a member's role and removing a member reload only the invites or the members, not the workspace's role catalogue too: the catalogue is configuration that does not change with them, and each members response already carries it. `useWorkspaceMembersActions` no longer takes `workspaceRolesView`.
6
+ - The members screen loads its members and pending-invites lists 20 at a time, with a Load more button under each list while it has more. A refetch, such as a realtime change, reads every loaded page again. The members admin status adds `hasMoreMembers`, `isLoadingMoreMembers`, `hasMoreInvites` and `isLoadingMoreInvites`, and its actions add `loadMoreMembers` and `loadMoreInvites`. `useWorkspaceMembersPage` no longer passes the role catalog view to `useWorkspaceMembersActions`.
5
7
  - The members screen's invite-role and member-role fields are http-web's `SelectField`, bound to `loading` while the workspace's role catalog loads, so a stored role id never shows as text before its label; the members admin status says `isLoadingRoles`.
6
8
  - The invite form's email and role fields have no margin under them, since each keeps its supporting-text line (`@jskit-ai/material-web` no longer sets `hideDetails: "auto"`).
7
9
  - The workspace-surfaces pattern's pending-invitations cue links to the account settings' invitations section at its own address, `/account/invites`, as users-web's routed sections have it, instead of `/account?section=invites`.
package/locales/en.json CHANGED
@@ -63,6 +63,7 @@
63
63
  "inviteCaption": "Role: {role} • expires {expires}",
64
64
  "revoke": "Revoke",
65
65
  "noPendingInvites": "No pending invites.",
66
+ "loadMore": "Load more",
66
67
  "linkSent": "Invite sent. The link remains available here.",
67
68
  "linkDeliveryFailed": "Email delivery failed. Copy this link to share the invite.",
68
69
  "linkReady": "Copy this link to share the invite."
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jskit-ai/workspaces-web",
3
- "version": "0.2.33",
3
+ "version": "0.2.35",
4
4
  "type": "module",
5
5
  "scripts": {
6
6
  "test": "jskit test"
@@ -16,15 +16,15 @@
16
16
  "./locales/en.json": "./locales/en.json"
17
17
  },
18
18
  "dependencies": {
19
- "@jskit-ai/users-core": "0.2.24",
20
- "@jskit-ai/workspaces-core": "0.2.24"
19
+ "@jskit-ai/users-core": "0.2.26",
20
+ "@jskit-ai/workspaces-core": "0.2.26"
21
21
  },
22
22
  "peerDependencies": {
23
- "@jskit-ai/auth-web": "0.2.24",
24
- "@jskit-ai/http-web": "0.2.27",
23
+ "@jskit-ai/auth-web": "0.2.25",
24
+ "@jskit-ai/http-web": "0.2.28",
25
25
  "@jskit-ai/kernel": "0.2.18",
26
- "@jskit-ai/shell-web": "0.2.22",
27
- "@jskit-ai/users-web": "0.2.33",
26
+ "@jskit-ai/shell-web": "0.2.23",
27
+ "@jskit-ai/users-web": "0.2.35",
28
28
  "@tanstack/vue-query": "^5.90.5",
29
29
  "vue": "^3.5.13",
30
30
  "vue-router": "^5.0.4",
@@ -152,6 +152,11 @@
152
152
  </template>
153
153
  </v-list-item>
154
154
  </v-list>
155
+ <div v-if="hasMoreMembers" class="d-flex justify-center mb-3">
156
+ <v-btn variant="text" :loading="isLoadingMoreMembers" @click="actions.loadMoreMembers()">
157
+ {{ t("jskit.workspaces.membersAdmin.loadMore") }}
158
+ </v-btn>
159
+ </div>
155
160
 
156
161
  <v-divider class="mb-3" />
157
162
 
@@ -179,6 +184,11 @@
179
184
  </v-list-item>
180
185
  <p v-if="inviteRows.length < 1" class="text-body-medium on-surface-variant mb-0">{{ t("jskit.workspaces.membersAdmin.noPendingInvites") }}</p>
181
186
  </v-list>
187
+ <div v-if="hasMoreInvites" class="d-flex justify-center mt-3">
188
+ <v-btn variant="text" :loading="isLoadingMoreInvites" @click="actions.loadMoreInvites()">
189
+ {{ t("jskit.workspaces.membersAdmin.loadMore") }}
190
+ </v-btn>
191
+ </div>
182
192
  </template>
183
193
  </template>
184
194
  </v-card-text>
@@ -267,6 +277,10 @@ const membersListLoaded = computed(() => status.value.hasLoadedMembersList);
267
277
  const membersListRefreshing = computed(() => status.value.isRefreshingMembersList);
268
278
  const inviteListLoaded = computed(() => status.value.hasLoadedInviteList);
269
279
  const inviteListRefreshing = computed(() => status.value.isRefreshingInviteList);
280
+ const hasMoreMembers = computed(() => status.value.hasMoreMembers);
281
+ const isLoadingMoreMembers = computed(() => status.value.isLoadingMoreMembers);
282
+ const hasMoreInvites = computed(() => status.value.hasMoreInvites);
283
+ const isLoadingMoreInvites = computed(() => status.value.isLoadingMoreInvites);
270
284
 
271
285
  const showWorkspaceInviteLoadingSkeleton = computed(
272
286
  () => canInviteMembers.value && !workspaceInvitePolicyLoaded.value
@@ -24,7 +24,6 @@ const OWNERSHIP_WORKSPACE = ROUTE_VISIBILITY_WORKSPACE;
24
24
  * @param {import("vue").Ref<boolean>} options.canInviteMembers
25
25
  * @param {import("vue").Ref<boolean>} options.canManageMembers
26
26
  * @param {import("vue").Ref<boolean>} options.canRevokeInvites
27
- * @param {{ refresh: () => Promise<unknown> }} options.workspaceRolesView
28
27
  * @param {{ reload: () => Promise<unknown> }} options.workspaceMembersList
29
28
  * @param {{ reload: () => Promise<unknown> }} options.workspaceInvitesList
30
29
  */
@@ -35,7 +34,6 @@ function useWorkspaceMembersActions({
35
34
  canInviteMembers,
36
35
  canManageMembers,
37
36
  canRevokeInvites,
38
- workspaceRolesView,
39
37
  workspaceMembersList,
40
38
  workspaceInvitesList
41
39
  }) {
@@ -166,10 +164,7 @@ function useWorkspaceMembersActions({
166
164
  createdInviteUrl.value = String(result?.inviteUrl || "").trim();
167
165
  createdInviteDeliveryStatus.value = String(delivery.status || "").trim().toLowerCase();
168
166
  forms.invite.email = "";
169
- await Promise.all([
170
- workspaceInvitesList.reload(),
171
- workspaceRolesView.refresh()
172
- ]);
167
+ await workspaceInvitesList.reload();
173
168
  if (createdInviteDeliveryStatus.value === "sent") {
174
169
  inviteFeedback.success(t("jskit.workspaces.members.inviteSent"));
175
170
  } else if (createdInviteDeliveryStatus.value === "failed") {
@@ -217,10 +212,7 @@ function useWorkspaceMembersActions({
217
212
  await revokeInviteCommand.run({
218
213
  inviteId
219
214
  });
220
- await Promise.all([
221
- workspaceInvitesList.reload(),
222
- workspaceRolesView.refresh()
223
- ]);
215
+ await workspaceInvitesList.reload();
224
216
  teamFeedback.success(t("jskit.workspaces.members.inviteRevoked"));
225
217
  } catch (error) {
226
218
  teamFeedback.error(error, t("jskit.workspaces.members.revokeInviteFailed"));
@@ -246,10 +238,7 @@ function useWorkspaceMembersActions({
246
238
  memberUserId,
247
239
  roleSid
248
240
  });
249
- await Promise.all([
250
- workspaceMembersList.reload(),
251
- workspaceRolesView.refresh()
252
- ]);
241
+ await workspaceMembersList.reload();
253
242
  membersFeedback.success(t("jskit.workspaces.members.roleUpdated"));
254
243
  } catch (error) {
255
244
  membersFeedback.error(error, t("jskit.workspaces.members.updateRoleFailed"));
@@ -273,10 +262,7 @@ function useWorkspaceMembersActions({
273
262
  await memberRemoveCommand.run({
274
263
  memberUserId
275
264
  });
276
- await Promise.all([
277
- workspaceMembersList.reload(),
278
- workspaceRolesView.refresh()
279
- ]);
265
+ await workspaceMembersList.reload();
280
266
  membersFeedback.success(t("jskit.workspaces.members.removed"));
281
267
  } catch (error) {
282
268
  membersFeedback.error(error, t("jskit.workspaces.members.removeFailed"));
@@ -207,7 +207,6 @@ function useWorkspaceMembersPage() {
207
207
  canInviteMembers,
208
208
  canManageMembers,
209
209
  canRevokeInvites,
210
- workspaceRolesView,
211
210
  workspaceMembersList,
212
211
  workspaceInvitesList
213
212
  });
@@ -238,7 +237,11 @@ function useWorkspaceMembersPage() {
238
237
  hasLoadedInviteList: !canViewMembers.value || !workspaceInvitesList.isInitialLoading,
239
238
  isRefreshingWorkspaceSettings: canInviteMembers.value && Boolean(workspaceSettingsView.isRefetching),
240
239
  isRefreshingMembersList: canViewMembers.value && Boolean(workspaceMembersList.isRefetching),
241
- isRefreshingInviteList: canViewMembers.value && Boolean(workspaceInvitesList.isRefetching)
240
+ isRefreshingInviteList: canViewMembers.value && Boolean(workspaceInvitesList.isRefetching),
241
+ hasMoreMembers: canViewMembers.value && Boolean(workspaceMembersList.hasMore),
242
+ isLoadingMoreMembers: Boolean(workspaceMembersList.isLoadingMore),
243
+ hasMoreInvites: canViewMembers.value && Boolean(workspaceInvitesList.hasMore),
244
+ isLoadingMoreInvites: Boolean(workspaceInvitesList.isLoadingMore)
242
245
  };
243
246
  });
244
247
 
@@ -391,7 +394,16 @@ function useWorkspaceMembersPage() {
391
394
  revokeInviteId,
392
395
  removeMemberUserId,
393
396
  status,
394
- actions,
397
+ // The lists read a page at a time: the person loads the next page of members or invites when there is one.
398
+ actions: Object.freeze({
399
+ submitInvite: actions.submitInvite,
400
+ copyCreatedInviteLink: actions.copyCreatedInviteLink,
401
+ submitRevokeInvite: actions.submitRevokeInvite,
402
+ submitMemberRoleUpdate: actions.submitMemberRoleUpdate,
403
+ submitRemoveMember: actions.submitRemoveMember,
404
+ loadMoreMembers: workspaceMembersList.loadMore,
405
+ loadMoreInvites: workspaceInvitesList.loadMore
406
+ }),
395
407
  loadError,
396
408
  canRetryLoad,
397
409
  isRetryingLoad,
@@ -154,6 +154,10 @@
154
154
  * @property {boolean} isRefreshingWorkspaceSettings
155
155
  * @property {boolean} isRefreshingMembersList
156
156
  * @property {boolean} isRefreshingInviteList
157
+ * @property {boolean} hasMoreMembers
158
+ * @property {boolean} isLoadingMoreMembers
159
+ * @property {boolean} hasMoreInvites
160
+ * @property {boolean} isLoadingMoreInvites
157
161
  */
158
162
 
159
163
  /**
@@ -164,6 +168,8 @@
164
168
  * @property {(inviteId: string) => Promise<void>} submitRevokeInvite
165
169
  * @property {(member: WorkspaceMember, roleSid: string) => Promise<void>} submitMemberRoleUpdate
166
170
  * @property {(member: WorkspaceMember) => Promise<void>} submitRemoveMember
171
+ * @property {() => Promise<unknown>} loadMoreMembers
172
+ * @property {() => Promise<unknown>} loadMoreInvites
167
173
  */
168
174
 
169
175
  export {};
@@ -112,3 +112,86 @@ test("Members displays configured labels but sends and reloads role IDs", {
112
112
  await browser.close();
113
113
  }
114
114
  });
115
+
116
+ test("Members and pending invites load a page at a time, and a refetch keeps every page loaded", {
117
+ skip: process.env.JSKIT_WORKSPACE_ROLE_LABELS_BROWSER !== "1",
118
+ timeout: 120_000
119
+ }, async (t) => {
120
+ const { vite: runtime, browser } = await openFixture(t);
121
+ let page;
122
+ try {
123
+ page = await browser.newPage({ baseURL: runtime.baseURL });
124
+ page.setDefaultTimeout(15_000);
125
+ page.setDefaultNavigationTimeout(60_000);
126
+ const errors = [];
127
+ page.on("pageerror", (error) => errors.push(error.message));
128
+ const catalog = createWorkspaceRoleCatalog({ roleCatalog: {
129
+ workspace: { defaultInviteRole: "member" },
130
+ roles: { owner: { assignable: false, permissions: ["*"] }, member: { assignable: true, permissions: [] } }
131
+ } });
132
+ const workspace = { id: "7", slug: "example", name: "Example", ownerUserId: "9", avatarUrl: "" };
133
+ const member = (userId, displayName) => ({
134
+ userId, displayName, email: `${displayName.toLowerCase()}@example.com`, roleSid: userId === "9" ? "owner" : "member", status: "active", isOwner: userId === "9"
135
+ });
136
+ const invite = (id, email) => ({ id, email, roleSid: "member", status: "pending", expiresAt: "2099-01-01T00:00:00.000Z", invitedByUserId: "9" });
137
+ // Each list's pages by the cursor that asks for them: the first page has none.
138
+ const pages = {
139
+ members: { "": { members: [member("11", "Amy"), member("12", "Bob")], nextCursor: "members-2" }, "members-2": { members: [member("9", "Zed")], nextCursor: null } },
140
+ invites: { "": { invites: [invite("10", "first@example.com")], nextCursor: "invites-2" }, "invites-2": { invites: [invite("13", "second@example.com")], nextCursor: null } }
141
+ };
142
+ const reads = [];
143
+ await page.route("**/api/**", async (route) => {
144
+ const url = new URL(route.request().url());
145
+ if (url.pathname === "/api/session") {
146
+ await route.fulfill({ json: { csrfToken: "fixture-csrf" } });
147
+ return;
148
+ }
149
+ let type;
150
+ let attributes;
151
+ if (url.pathname.endsWith("/roles")) {
152
+ type = "workspace-role-catalogs";
153
+ attributes = catalog;
154
+ } else if (url.pathname.endsWith("/settings")) {
155
+ type = "workspace-settings";
156
+ attributes = { workspace, roleCatalog: catalog, settings: { invitesEnabled: true, invitesAvailable: true } };
157
+ } else {
158
+ const list = url.pathname.endsWith("/invites") ? "invites" : "members";
159
+ reads.push({ list, cursor: url.searchParams.get("page[cursor]") ?? "", limit: url.searchParams.get("page[limit]") });
160
+ type = `workspace-${list}`;
161
+ attributes = { workspace, roleCatalog: catalog, ...pages[list][url.searchParams.get("page[cursor]") ?? ""] };
162
+ }
163
+ await route.fulfill({ contentType: "application/vnd.api+json", json: { data: { type, id: "7", attributes } } });
164
+ });
165
+ await page.goto("/w/example/admin/members");
166
+ await page.getByText("Bob", { exact: true }).waitFor();
167
+ await page.getByText("first@example.com", { exact: true }).waitFor();
168
+ assert.equal(await page.getByText("Zed", { exact: true }).count(), 0);
169
+ assert.equal(await page.getByText("second@example.com", { exact: true }).count(), 0);
170
+ assert.deepEqual(reads.map(({ list, cursor, limit }) => `${list}:${cursor}:${limit}`).sort(), ["invites::20", "members::20"]);
171
+
172
+ const loadMore = page.getByRole("button", { name: "Load more", exact: true });
173
+ await expect(loadMore).toHaveCount(2);
174
+ await loadMore.first().click();
175
+ await page.getByText("Zed", { exact: true }).waitFor();
176
+ await expect(loadMore).toHaveCount(1);
177
+ await loadMore.click();
178
+ await page.getByText("second@example.com", { exact: true }).waitFor();
179
+ await expect(loadMore).toHaveCount(0);
180
+ assert.deepEqual(reads.slice(2).map(({ list, cursor }) => `${list}:${cursor}`), ["members:members-2", "invites:invites-2"]);
181
+
182
+ // A refetch, as a realtime change makes, reads each loaded page again from the first, so none is dropped.
183
+ reads.length = 0;
184
+ await page.evaluate(() => window.dispatchEvent(new Event("visibilitychange")));
185
+ await expect.poll(() => reads.length).toBe(4);
186
+ assert.deepEqual(reads.map(({ list, cursor }) => `${list}:${cursor}`).sort(), ["invites:", "invites:invites-2", "members:", "members:members-2"]);
187
+ for (const text of ["Amy", "Bob", "Zed", "first@example.com", "second@example.com"]) {
188
+ await expect(page.getByText(text, { exact: true })).toHaveCount(1);
189
+ }
190
+ assert.deepEqual(errors, []);
191
+ } catch (error) {
192
+ console.error(await page?.locator("body").innerText());
193
+ throw error;
194
+ } finally {
195
+ await browser.close();
196
+ }
197
+ });
@@ -0,0 +1,50 @@
1
+ import assert from "node:assert/strict";
2
+ import { registerHooks } from "node:module";
3
+ import test from "node:test";
4
+
5
+ // The commands and feedback stand in for http-web's, so the test sees which reads each action makes afterwards.
6
+ const commandUrl = import.meta.resolve("@jskit-ai/http-web/client/composables/useCommand");
7
+ const feedbackUrl = import.meta.resolve("@jskit-ai/http-web/client/composables/useUiFeedback");
8
+ const hooks = registerHooks({
9
+ load(url, context, nextLoad) {
10
+ if (url === commandUrl) {
11
+ return {
12
+ format: "module",
13
+ shortCircuit: true,
14
+ source: "export const useCommand = () => ({ isRunning: false, async run() { return { inviteUrl: '', inviteDelivery: { status: 'sent' } }; } });"
15
+ };
16
+ }
17
+ if (url === feedbackUrl) {
18
+ return {
19
+ format: "module",
20
+ shortCircuit: true,
21
+ source: "export const useUiFeedback = () => ({ clear() {}, success() {}, error(error) { throw error; } });"
22
+ };
23
+ }
24
+ return nextLoad(url, context);
25
+ }
26
+ });
27
+ const { useWorkspaceMembersActions } = await import("../src/client/composables/useWorkspaceMembersActions.js");
28
+ hooks.deregister();
29
+
30
+ test("member and invite actions reload the list they changed, never the static role catalogue", async () => {
31
+ const reads = [];
32
+ const { actions } = useWorkspaceMembersActions({
33
+ forms: { invite: { email: "guest@example.test", roleSid: "member" } },
34
+ workspaceMembersApiPath: { value: "/api/w/team/members" },
35
+ workspaceInvitesApiPath: { value: "/api/w/team/invites" },
36
+ canInviteMembers: { value: true },
37
+ canManageMembers: { value: true },
38
+ canRevokeInvites: { value: true },
39
+ workspaceRolesView: { async refresh() { reads.push("roles"); } },
40
+ workspaceMembersList: { async reload() { reads.push("members"); } },
41
+ workspaceInvitesList: { async reload() { reads.push("invites"); } }
42
+ });
43
+
44
+ await actions.submitInvite();
45
+ await actions.submitRevokeInvite("5");
46
+ await actions.submitMemberRoleUpdate({ userId: "9" }, "admin");
47
+ await actions.submitRemoveMember({ userId: "9" });
48
+
49
+ assert.deepEqual(reads, ["invites", "invites", "members", "members"]);
50
+ });