@sanity-labs/client-fake-for-test 0.9.0 → 0.10.0

package/dist/index.d.cts

@@ -108,7 +108,8 @@ export declare interface CreateTestClientOptions {
   /**
    * Opt-in access-control simulation. When set, the client exposes
    * `request({ url })` that serves `/users/me` (host-aware), the
-   * configured ACL path, and `/projects/<projectId>/users/<ids>`,
+   * configured ACL path, `/projects/<projectId>` (members), and
+   * `/projects/<projectId>/users/<ids>`,
    * AND every mutation is gated through the supplied `grants`
    * — writes that the grants don't permit throw a `WriteAccessDeniedError`
    * shaped like Sanity's 403. Lets tests demonstrate the full
@@ -166,6 +167,8 @@ export declare interface CreateTestClientOptions {
    * tests stay green.
    */
   perspective?: Perspective;
+  /** Prefix composed with request tags and used alone for untagged requests. */
+  requestTagPrefix?: string;
   /**
    * Which API host the root handle models: the project host (default
    * `true`) or the global host (`false`) — same flag as the real
@@ -592,6 +595,12 @@ export declare type PatchOp =
 
 export declare type Perspective = "raw" | "published" | "drafts" | string[];
 
+/** One row of the `/projects/<projectId>` members response. */
+export declare interface ProjectMemberRecord {
+  id: string;
+  isRobot?: boolean;
+}
+
 /**
  * A row served by the project-users directory endpoint
  * (`/projects/<projectId>/users/<id>`), mirroring Sanity's project user
@@ -873,6 +882,7 @@ export declare interface TestClient {
     projectId: string;
     dataset: string;
     perspective: Perspective;
+    requestTagPrefix?: string;
     token?: string;
     useProjectHostname: boolean;
   };
@@ -887,6 +897,8 @@ export declare interface TestClient {
       projectId: string;
       dataset: string;
       perspective: Perspective;
+      /** Prefix composed with request tags and used alone for untagged requests. */
+      requestTagPrefix: string;
       /**
        * Model the global API host (`false`) instead of the project host
        * (default `true`). A global-hosted sibling's `/users/me` serves the

package/dist/index.d.ts

@@ -108,7 +108,8 @@ export declare interface CreateTestClientOptions {
   /**
    * Opt-in access-control simulation. When set, the client exposes
    * `request({ url })` that serves `/users/me` (host-aware), the
-   * configured ACL path, and `/projects/<projectId>/users/<ids>`,
+   * configured ACL path, `/projects/<projectId>` (members), and
+   * `/projects/<projectId>/users/<ids>`,
    * AND every mutation is gated through the supplied `grants`
    * — writes that the grants don't permit throw a `WriteAccessDeniedError`
    * shaped like Sanity's 403. Lets tests demonstrate the full
@@ -166,6 +167,8 @@ export declare interface CreateTestClientOptions {
    * tests stay green.
    */
   perspective?: Perspective;
+  /** Prefix composed with request tags and used alone for untagged requests. */
+  requestTagPrefix?: string;
   /**
    * Which API host the root handle models: the project host (default
    * `true`) or the global host (`false`) — same flag as the real
@@ -592,6 +595,12 @@ export declare type PatchOp =
 
 export declare type Perspective = "raw" | "published" | "drafts" | string[];
 
+/** One row of the `/projects/<projectId>` members response. */
+export declare interface ProjectMemberRecord {
+  id: string;
+  isRobot?: boolean;
+}
+
 /**
  * A row served by the project-users directory endpoint
  * (`/projects/<projectId>/users/<id>`), mirroring Sanity's project user
@@ -873,6 +882,7 @@ export declare interface TestClient {
     projectId: string;
     dataset: string;
     perspective: Perspective;
+    requestTagPrefix?: string;
     token?: string;
     useProjectHostname: boolean;
   };
@@ -887,6 +897,8 @@ export declare interface TestClient {
       projectId: string;
       dataset: string;
       perspective: Perspective;
+      /** Prefix composed with request tags and used alone for untagged requests. */
+      requestTagPrefix: string;
       /**
        * Model the global API host (`false`) instead of the project host
        * (default `true`). A global-hosted sibling's `/users/me` serves the

package/dist/index.js

@@ -97,7 +97,18 @@ function serveProjectUsers(args) {
     return identity === void 0 ? [] : [toRecord(identity)];
   });
 }
-const PROJECT_USERS_PATH = /^\/projects\/([^/]+)\/users\/([^/]+)$/;
+const PROJECT_USERS_PATH = /^\/projects\/([^/]+)\/users\/([^/]+)$/, PROJECT_PATH = /^\/projects\/([^/]+)$/;
+function serveProject(args) {
+  const ids = /* @__PURE__ */ new Set();
+  for (const identity of args.identities)
+    ids.add(projectUserOf(identity, args.pathProjectId).id);
+  return {
+    members: [...ids].map((id) => ({
+      id,
+      ...id.startsWith("p-") ? { isRobot: !0 } : {}
+    }))
+  };
+}
 function makeRequestImpl(ctx) {
   const { getAccess, projectId, dataset, useProjectHostname, listIdentities } = ctx;
   return async (opts) => {
@@ -113,8 +124,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.`
     );
   };
 }
@@ -825,7 +842,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?",
@@ -1014,6 +1031,7 @@ function createTestClient(options = {}) {
     dataset: defaultDataset,
     accessControl: options.accessControl,
     perspective: options.perspective ?? "raw",
+    requestTagPrefix: options.requestTagPrefix,
     mutationGuard: options.mutationGuard,
     token: options.token,
     useProjectHostname: options.useProjectHostname ?? !0
@@ -1076,6 +1094,7 @@ function makeHandle(handleArgs) {
     dataset,
     accessControl,
     perspective,
+    requestTagPrefix,
     mutationGuard,
     token,
     useProjectHostname
@@ -1099,14 +1118,15 @@ function makeHandle(handleArgs) {
     let s = registry.get(key);
     return s === void 0 && (s = createTestStore(), registry.set(key, s)), s;
   })(), concurrentEditKey = (id) => registryKey(projectId, dataset) + " " + id, record = (transactionId, mutations, tag) => {
+    const effectiveTag = effectiveRequestTag(tag);
     backend.log.push({
       transactionId,
       projectId,
       dataset,
       mutations,
-      ...tag !== void 0 ? { tag } : {}
+      ...effectiveTag !== void 0 ? { tag: effectiveTag } : {}
     });
-  }, writeResult = (documents, results, transactionId, opts) => formatMutationResult(
+  }, effectiveRequestTag = (tag) => requestTagPrefix === void 0 ? tag : tag ? `${requestTagPrefix}.${tag}` : requestTagPrefix, writeResult = (documents, results, transactionId, opts) => formatMutationResult(
     documents,
     results,
     transactionId,
@@ -1422,6 +1442,7 @@ function makeHandle(handleArgs) {
       projectId,
       dataset,
       perspective,
+      ...requestTagPrefix !== void 0 ? { requestTagPrefix } : {},
       ...token !== void 0 ? { token } : {},
       useProjectHostname
     }),
@@ -1434,6 +1455,7 @@ function makeHandle(handleArgs) {
         dataset: config.dataset ?? dataset,
         accessControl: rebinds ? config.accessControl : accessControl,
         perspective: config.perspective ?? perspective,
+        requestTagPrefix: config.requestTagPrefix ?? requestTagPrefix,
         mutationGuard,
         token: rebinds ? config.token : token,
         useProjectHostname: config.useProjectHostname ?? useProjectHostname
@@ -1471,7 +1493,7 @@ function makeHandle(handleArgs) {
   return wrapWithGuards(client, {
     getStub: (name) => backend.stubs.get(name),
     onCall: (method, args) => {
-      const rec = { method, args, projectId, dataset }, tag = tagFromArgs(method, args);
+      const rec = { method, args, projectId, dataset }, tag = OPTIONS_ARG_POSITION[method] === void 0 ? void 0 : effectiveRequestTag(tagFromArgs(method, args));
       return tag !== void 0 && (rec.tag = tag), backend.calls.push(rec), (outcome) => {
         "error" in outcome ? rec.error = outcome.error : rec.result = outcome.result;
       };