@sanity-labs/client-fake-for-test 0.9.1 → 0.11.0

package/README.md

@@ -80,7 +80,7 @@ More patterns — passing the fake to code typed against `SanityClient`, asserti
 | Config | `config()` | Returns `{ projectId, dataset, perspective, token?, useProjectHostname }` |
 | Config | `withConfig({ projectId?, dataset?, perspective?, accessControl?, token?, useProjectHostname? })` | Sibling handle into the same multi-dataset registry; `token` binds a registered identity (see the token→identity registry below), `accessControl` rebinds it inline — the two are mutually exclusive; `useProjectHostname: false` mints a global-hosted sibling |
 | Perspectives | `raw` / `published` / `drafts` / release stacks | Per-client default or per-`fetch` override; draft/version layering with `_originalId` projection |
-| HTTP | `request({ url? \| uri? })` | Present **only** when the handle has an acting identity (`accessControl`, or a bound `token`). Serves `/users/me` (host-aware: project-scoped record on the project host, `globalUser` on a global-hosted handle), the configured ACL path, and `/projects/<projectId>/users/<ids>` (project-user records with `id` + `sanityUserId`). Calling it without one throws a guidance error. |
+| HTTP | `request({ url? \| uri? })` | Present **only** when the handle has an acting identity (`accessControl`, or a bound `token`). Serves `/users/me` (host-aware: project-scoped record on the project host, `globalUser` on a global-hosted handle), the configured ACL path, `/projects/<projectId>` (the project's members: `{ id, isRobot?, roles? }` rows, one per distinct resolved project user), and `/projects/<projectId>/users/<ids>` (project-user records with `id` + `sanityUserId`). Calling it without one throws a guidance error. |
 
 #### Mutation return shapes
 
@@ -162,6 +162,8 @@ await client.withConfig({ useProjectHostname: false }).request({ uri: "/users/me
 await client.request({ uri: "/projects/alpha/users/pAlpha" }); // { id: "pAlpha", sanityUserId: "gSnorre", ... } (ProjectUserRecord)
 ```
 
+The project directory endpoint (`/projects/<projectId>`) returns each resolved project member's `id`, project-specific `roles`, and robot marker. Roles are served in canonical order, and duplicate-token agreement ignores role and property order. Registering two tokens with the same project user id is supported when their served member records agree; conflicting roles fail the request instead of making the result depend on registration order.
+
 Grant-filter and mutation-guard `identity()` stay bound to the **project-scoped** record, matching the lake. Identities without `globalUser` serve one record everywhere — the production robot-token shape.
 
 ### Test-only helpers (not on real `SanityClient`)

package/dist/index.cjs

@@ -64,6 +64,28 @@ function defaultAclPath(projectId, dataset) {
 function projectUserOf(identity, projectId) {
   return identity.usersByProject?.[projectId] ?? identity.user;
 }
+function consistentProjectRecords(args) {
+  const byId = /* @__PURE__ */ new Map();
+  for (const record of args.records) {
+    const existing = byId.get(record.id);
+    if (existing !== void 0 && JSON.stringify(existing) !== JSON.stringify(record))
+      throw fakeError(
+        `request(): two registered identities resolve to project user "${record.id}" in project "${args.projectId}" with different records. The project records cannot be served unambiguously \u2014 fix the identity registrations so duplicate ids carry identical records.`
+      );
+    byId.set(record.id, record);
+  }
+  return byId;
+}
+function canonicalProjectRoles(roles) {
+  return roles.map((role) => ({
+    name: role.name,
+    ...role.title !== void 0 ? { title: role.title } : {},
+    ...role.description !== void 0 ? { description: role.description } : {}
+  })).toSorted((left, right) => {
+    const leftKey = JSON.stringify(left), rightKey = JSON.stringify(right);
+    return leftKey < rightKey ? -1 : leftKey > rightKey ? 1 : 0;
+  });
+}
 function serveProjectUsers(args) {
   const { requestedIds, pathProjectId, identities } = args, toRecord = (identity) => {
     const projectUser = projectUserOf(identity, pathProjectId);
@@ -73,33 +95,38 @@ function serveProjectUsers(args) {
       displayName: projectUser.name ?? projectUser.id,
       ...projectUser.email !== void 0 ? { email: projectUser.email } : {}
     };
-  }, byId = /* @__PURE__ */ new Map();
-  for (const identity of identities) {
-    const resolvedId = projectUserOf(identity, pathProjectId).id, existing = byId.get(resolvedId);
-    if (existing !== void 0 && JSON.stringify(toRecord(existing)) !== JSON.stringify(toRecord(identity)))
-      throw fakeError(
-        `request(): two registered identities resolve to project user "${resolvedId}" in project "${pathProjectId}" with different records. The directory cannot answer unambiguously \u2014 fix the identity registrations so duplicate ids carry identical records.`
-      );
-    byId.set(resolvedId, identity);
-  }
-  const ids = requestedIds.split(","), [firstId] = ids;
+  }, byId = consistentProjectRecords({
+    projectId: pathProjectId,
+    records: identities.map(toRecord)
+  }), ids = requestedIds.split(","), [firstId] = ids;
   if (ids.length === 1 && firstId !== void 0) {
-    const identity = byId.get(firstId);
-    if (identity === void 0)
+    const record = byId.get(firstId);
+    if (record === void 0)
       throw Object.assign(
         fakeError(
           `request(): no registered identity resolves to project user "${firstId}" in project "${pathProjectId}". Register it via createTestClient({ identities }) or addIdentity().`
         ),
         { statusCode: 404 }
       );
-    return toRecord(identity);
+    return record;
   }
   return ids.flatMap((id) => {
-    const identity = byId.get(id);
-    return identity === void 0 ? [] : [toRecord(identity)];
+    const record = byId.get(id);
+    return record === void 0 ? [] : [record];
+  });
+}
+const PROJECT_USERS_PATH = /^\/projects\/([^/]+)\/users\/([^/]+)$/, PROJECT_PATH = /^\/projects\/([^/]+)$/;
+function serveProject(args) {
+  const records = args.identities.map((identity) => {
+    const projectUser = projectUserOf(identity, args.pathProjectId);
+    return {
+      id: projectUser.id,
+      ...projectUser.id.startsWith("p-") ? { isRobot: !0 } : {},
+      ...projectUser.roles !== void 0 ? { roles: canonicalProjectRoles(projectUser.roles) } : {}
+    };
   });
+  return { members: [...consistentProjectRecords({ projectId: args.pathProjectId, records }).values()] };
 }
-const PROJECT_USERS_PATH = /^\/projects\/([^/]+)\/users\/([^/]+)$/;
 function makeRequestImpl(ctx) {
   const { getAccess, projectId, dataset, useProjectHostname, listIdentities } = ctx;
   return async (opts) => {
@@ -115,8 +142,14 @@ function makeRequestImpl(ctx) {
         pathProjectId,
         identities: listIdentities()
       });
+    const project = path?.match(PROJECT_PATH), [, membersProjectId] = project ?? [];
+    if (membersProjectId !== void 0)
+      return serveProject({
+        pathProjectId: membersProjectId,
+        identities: listIdentities()
+      });
     throw fakeError(
-      `request(): no handler for path "${path}". With access control configured, the fake serves "/users/me", "${aclPath}", and "/projects/<projectId>/users/<ids>". For any other endpoint, register a stub (client.stub("request", fn)) or intercept the HTTP call with a tool like MSW.`
+      `request(): no handler for path "${path}". With access control configured, the fake serves "/users/me", "${aclPath}", "/projects/<projectId>" (members), and "/projects/<projectId>/users/<ids>". For any other endpoint, register a stub (client.stub("request", fn)) or intercept the HTTP call with a tool like MSW.`
     );
   };
 }
@@ -827,7 +860,7 @@ const ISSUES_URL = "https://github.com/sanity-labs/client-fake-for-test/issues",
   },
   request: {
     what: "generic HTTP request hook \u2014 only wired up when the handle has an acting identity",
-    workaround: "Create the client with `accessControl`, or bind a registered token (`identities` + `token` / `withConfig({ token })`), to enable request() (it serves /users/me, the ACL path, and /projects/<projectId>/users/<ids>). Or register a stub."
+    workaround: "Create the client with `accessControl`, or bind a registered token (`identities` + `token` / `withConfig({ token })`), to enable request() (it serves /users/me, the ACL path, /projects/<projectId>, and /projects/<projectId>/users/<ids>). Or register a stub."
   },
   dryRun: {
     what: "not a method \u2014 did you mean the `{ dryRun }` mutation option?",