@thepalaceproject/circulation-admin 1.38.0 → 1.39.0

package/jest.config.js

@@ -4,6 +4,7 @@ module.exports = {
     "\\.(jpg|jpeg|png|gif|eot|otf|webp|svg|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$":
       "<rootDir>/tests/__mocks__/fileMock.js",
     "\\.(css|less)$": "<rootDir>/tests/__mocks__/styleMock.js",
+    "\\.md$": "<rootDir>/tests/__mocks__/fileMock.js",
   },
   preset: "ts-jest",
   testEnvironment: "jest-fixed-jsdom",

package/package.json

@@ -32,7 +32,8 @@
     "dev-server": "dotenv -c -- webpack serve --progress --hot --config webpack.dev-server.config",
     "dev-test-axe": "TEST_AXE=true npm run dev",
     "prod": "webpack --progress --config webpack.prod.config",
-    "build-docs": "typedoc --tsconfig tsconfig.json src"
+    "build-docs": "typedoc --tsconfig tsconfig.json src",
+    "sync-patron-blocking-docs": "node scripts/syncPatronBlockingDocs.js"
   },
   "dependencies": {
     "@nypl/dgx-svg-icons": "0.3.4",
@@ -113,6 +114,7 @@
     "jsdom": "^20.0.3",
     "json-loader": "^0.5.4",
     "lint-staged": "^10.4.0",
+    "marked": "^17.0.6",
     "mini-css-extract-plugin": "1.6.0",
     "mocha": "^10.2.0",
     "msw": "^2.7.3",
@@ -152,5 +154,5 @@
     "*.{js,jsx,ts,tsx,css,md}": "prettier --write",
     "*.{js,css,md}": "prettier --write"
   },
-  "version": "1.38.0"
+  "version": "1.39.0"
 }

package/scripts/syncPatronBlockingDocs.js

@@ -0,0 +1,43 @@
+#!/usr/bin/env node
+/* eslint-disable @typescript-eslint/no-var-requires */
+/**
+ * Reads ../circulation/docs/FUNCTIONS.md, converts it to HTML, and writes
+ * src/content/patronBlockingFunctionsHtml.ts — a TypeScript module that
+ * exports the HTML as a string constant.
+ *
+ * Run via:  npm run sync-patron-blocking-docs
+ */
+
+"use strict";
+
+const fs = require("fs");
+const path = require("path");
+const { marked } = require("marked");
+
+// ---------------------------------------------------------------------------
+// Main
+// ---------------------------------------------------------------------------
+const srcMd = path.resolve(__dirname, "../../circulation/docs/FUNCTIONS.md");
+const destTs = path.resolve(
+  __dirname,
+  "../src/content/patronBlockingFunctionsHtml.ts"
+);
+
+if (!fs.existsSync(srcMd)) {
+  console.error(`Source not found: ${srcMd}`);
+  process.exit(1);
+}
+
+const markdown = fs.readFileSync(srcMd, "utf8");
+const html = marked(markdown);
+
+const tsContent = `// AUTO-GENERATED — do not edit by hand.
+// Run \`npm run sync-patron-blocking-docs\` to regenerate from
+// circulation/docs/FUNCTIONS.md.
+const patronBlockingFunctionsHtml = ${JSON.stringify(html)};
+export default patronBlockingFunctionsHtml;
+`;
+
+fs.mkdirSync(path.dirname(destTs), { recursive: true });
+fs.writeFileSync(destTs, tsContent, "utf8");
+console.log(`Written: ${destTs}`);

package/tests/jest/api/patronBlockingRules.test.ts

@@ -1,5 +1,8 @@
 import * as fetchMock from "fetch-mock-jest";
-import { validatePatronBlockingRuleExpression } from "../../../src/api/patronBlockingRules";
+import {
+  validatePatronBlockingRuleExpression,
+  ValidationResult,
+} from "../../../src/api/patronBlockingRules";
 import { PatronBlockingRule } from "../../../src/interfaces";
 
 const VALIDATE_URL = "/admin/patron_auth_service_validate_patron_blocking_rule";
@@ -21,7 +24,24 @@ describe("validatePatronBlockingRuleExpression", () => {
       sampleRule,
       "test-token"
     );
-    expect(result).toBeNull();
+    expect(result.error).toBeNull();
+  });
+
+  it("returns available_fields from a 200 response with a body", async () => {
+    fetchMock.post(VALIDATE_URL, {
+      status: 200,
+      body: { available_fields: { fines: 0, patron_identifier: "X123" } },
+    });
+    const result: ValidationResult = await validatePatronBlockingRuleExpression(
+      42,
+      sampleRule,
+      "test-token"
+    );
+    expect(result.error).toBeNull();
+    expect(result.availableFields).toEqual({
+      fines: 0,
+      patron_identifier: "X123",
+    });
   });
 
   it("returns the detail string from a 400 response", async () => {
@@ -34,7 +54,8 @@ describe("validatePatronBlockingRuleExpression", () => {
       sampleRule,
       "test-token"
     );
-    expect(result).toBe("Unknown placeholder: {unknown_field}");
+    expect(result.error).toBe("Unknown placeholder: {unknown_field}");
+    expect(result.availableFields).toBeNull();
   });
 
   it("returns a fallback string when a 400 response body has no detail", async () => {
@@ -44,8 +65,9 @@ describe("validatePatronBlockingRuleExpression", () => {
       sampleRule,
       "test-token"
     );
-    expect(result).not.toBeNull();
-    expect(typeof result).toBe("string");
+    expect(result.error).not.toBeNull();
+    expect(typeof result.error).toBe("string");
+    expect(result.availableFields).toBeNull();
   });
 
   it("sends the correct URL, method, and CSRF header", async () => {
@@ -73,6 +95,6 @@ describe("validatePatronBlockingRuleExpression", () => {
       expect.objectContaining({ method: "POST" })
     );
     // Server would return an error detail in a real call; here it returns 200 (mocked)
-    expect(result).toBeNull();
+    expect(result.error).toBeNull();
   });
 });

package/tests/jest/components/CollectionImportButton.test.tsx

@@ -79,7 +79,56 @@ describe("CollectionImportButton", () => {
       screen.getByRole("button", { name: "Queue Import" })
     ).toBeInTheDocument();
     expect(screen.getByRole("checkbox")).toBeInTheDocument();
-    expect(screen.getByText("Force full re-import")).toBeInTheDocument();
+    expect(screen.getByLabelText("Force full re-import")).toBeInTheDocument();
+  });
+
+  it("shows compact summary by default; detailed docs are hidden", async () => {
+    const user = userEvent.setup();
+    renderButton();
+    await expandPanel(user);
+    expect(
+      screen.getByText(/queue import picks up new and changed items/i)
+    ).toBeInTheDocument();
+    expect(
+      screen.getByText(/schedules a background import job/i)
+    ).not.toBeVisible();
+    expect(
+      screen.getByText(/the import job re-processes every item/i)
+    ).not.toBeVisible();
+  });
+
+  it("clicking 'More details' reveals the detailed docs", async () => {
+    const user = userEvent.setup();
+    renderButton();
+    await expandPanel(user);
+
+    const details = screen.getByText("More details").closest("details");
+    expect(details).not.toHaveAttribute("open");
+
+    await user.click(screen.getByText("More details"));
+
+    expect(details).toHaveAttribute("open");
+    expect(
+      screen.getByText(/schedules a background import job/i)
+    ).toBeVisible();
+    expect(
+      screen.getByText(/the import job re-processes every item/i)
+    ).toBeVisible();
+  });
+
+  it("clicking 'More details' again hides the detailed docs", async () => {
+    const user = userEvent.setup();
+    renderButton();
+    await expandPanel(user);
+
+    await user.click(screen.getByText("More details"));
+    expect(
+      screen.getByText(/schedules a background import job/i)
+    ).toBeVisible();
+
+    await user.click(screen.getByText("More details"));
+    const details = screen.getByText("More details").closest("details");
+    expect(details).not.toHaveAttribute("open");
   });
 
   it("checkbox toggles force state", async () => {
@@ -94,6 +143,41 @@ describe("CollectionImportButton", () => {
     expect(checkbox).not.toBeChecked();
   });
 
+  it("button text changes to 'Queue Full Re-import' when force is checked", async () => {
+    const user = userEvent.setup();
+    renderButton();
+    await expandPanel(user);
+
+    expect(
+      screen.getByRole("button", { name: "Queue Import" })
+    ).toBeInTheDocument();
+
+    await user.click(screen.getByRole("checkbox"));
+
+    expect(
+      screen.getByRole("button", { name: "Queue Full Re-import" })
+    ).toBeInTheDocument();
+    expect(
+      screen.queryByRole("button", { name: "Queue Import" })
+    ).not.toBeInTheDocument();
+  });
+
+  it("button uses force class when force is checked", async () => {
+    const user = userEvent.setup();
+    renderButton();
+    await expandPanel(user);
+
+    const button = screen.getByRole("button", { name: "Queue Import" });
+    expect(button).not.toHaveClass("force");
+
+    await user.click(screen.getByRole("checkbox"));
+
+    const forceButton = screen.getByRole("button", {
+      name: "Queue Full Re-import",
+    });
+    expect(forceButton).toHaveClass("force");
+  });
+
   it("button triggers import with correct args (force=false)", async () => {
     const user = userEvent.setup();
     const { importCollection } = renderButton();
@@ -109,18 +193,39 @@ describe("CollectionImportButton", () => {
     await expandPanel(user);
     const checkbox = screen.getByRole("checkbox");
     await user.click(checkbox);
-    const button = screen.getByRole("button", { name: "Queue Import" });
+    const button = screen.getByRole("button", {
+      name: "Queue Full Re-import",
+    });
     await user.click(button);
     expect(importCollection).toHaveBeenCalledWith(42, true);
   });
 
-  it("shows success feedback with alert-success styling after import", async () => {
+  it("shows success feedback for regular import", async () => {
     const user = userEvent.setup();
     renderButton();
     await expandPanel(user);
     await user.click(screen.getByRole("button", { name: "Queue Import" }));
     await waitFor(() => {
-      const feedback = screen.getByText("Import task queued.");
+      const feedback = screen.getByText(
+        /import task queued\. new and updated items will appear/i
+      );
+      expect(feedback).toBeInTheDocument();
+      expect(feedback).toHaveClass("alert", "alert-success");
+    });
+  });
+
+  it("shows success feedback for force re-import", async () => {
+    const user = userEvent.setup();
+    renderButton();
+    await expandPanel(user);
+    await user.click(screen.getByRole("checkbox"));
+    await user.click(
+      screen.getByRole("button", { name: "Queue Full Re-import" })
+    );
+    await waitFor(() => {
+      const feedback = screen.getByText(
+        /full re-import task queued\. all items will be re-processed/i
+      );
       expect(feedback).toBeInTheDocument();
       expect(feedback).toHaveClass("alert", "alert-success");
     });
@@ -150,9 +255,13 @@ describe("CollectionImportButton", () => {
     await user.click(checkbox);
     expect(checkbox).toBeChecked();
 
-    await user.click(screen.getByRole("button", { name: "Queue Import" }));
+    await user.click(
+      screen.getByRole("button", { name: "Queue Full Re-import" })
+    );
     await waitFor(() => {
-      expect(screen.getByText("Import task queued.")).toBeInTheDocument();
+      expect(
+        screen.getByText(/full re-import task queued/i)
+      ).toBeInTheDocument();
     });
 
     const nextCollection: CollectionData = {
@@ -171,7 +280,9 @@ describe("CollectionImportButton", () => {
 
     await waitFor(() => {
       expect(screen.getByRole("checkbox")).not.toBeChecked();
-      expect(screen.queryByText("Import task queued.")).not.toBeInTheDocument();
+      expect(
+        screen.queryByText(/full re-import task queued/i)
+      ).not.toBeInTheDocument();
     });
   });
 
@@ -204,4 +315,31 @@ describe("CollectionImportButton", () => {
       ).toBeEnabled();
     });
   });
+
+  it("shows 'Queuing Full Re-import...' while importing with force", async () => {
+    const user = userEvent.setup();
+    let resolveImport: () => void;
+    const pendingImport = new Promise<void>((resolve) => {
+      resolveImport = resolve;
+    });
+    const mockImport = jest.fn().mockReturnValue(pendingImport);
+    renderButton({ importCollection: mockImport });
+    await expandPanel(user);
+
+    await user.click(screen.getByRole("checkbox"));
+    await user.click(
+      screen.getByRole("button", { name: "Queue Full Re-import" })
+    );
+
+    expect(
+      screen.getByRole("button", { name: "Queuing Full Re-import..." })
+    ).toBeDisabled();
+
+    resolveImport();
+    await waitFor(() => {
+      expect(
+        screen.getByRole("button", { name: "Queue Full Re-import" })
+      ).toBeEnabled();
+    });
+  });
 });

package/tests/jest/components/PatronAuthServiceEditForm.test.tsx

@@ -2,6 +2,7 @@ import * as React from "react";
 import { render, screen, waitFor } from "@testing-library/react";
 import userEvent from "@testing-library/user-event";
 import * as fetchMock from "fetch-mock-jest";
+import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
 import PatronAuthServiceEditForm from "../../../src/components/PatronAuthServiceEditForm";
 import {
   PatronAuthServicesData,
@@ -66,6 +67,16 @@ function buildSIP2Item(rules: PatronBlockingRule[] = []) {
   };
 }
 
+/** Renders with a fresh QueryClient so useAvailableFields (useQuery) works. */
+function renderForm(element: React.ReactElement) {
+  const queryClient = new QueryClient({
+    defaultOptions: { queries: { retry: false } },
+  });
+  return render(
+    <QueryClientProvider client={queryClient}>{element}</QueryClientProvider>
+  );
+}
+
 // Guard: any blur on the Rule Expression textarea calls validatePatronBlockingRuleExpression.
 // All describe blocks get a default 200 mock so tests that incidentally trigger blur
 // don't fail with "only absolute URLs are supported" from the fetch polyfill.
@@ -80,7 +91,9 @@ afterEach(() => {
 describe("PatronAuthServiceEditForm – capability gating", () => {
   it("shows PatronBlockingRulesEditor in expanded library settings for SIP2", async () => {
     const user = userEvent.setup();
-    render(<PatronAuthServiceEditForm {...baseProps} item={buildSIP2Item()} />);
+    renderForm(
+      <PatronAuthServiceEditForm {...baseProps} item={buildSIP2Item()} />
+    );
 
     await expandLibrariesPanel(user);
     const editButton = screen.getByRole("button", { name: /Edit/i });
@@ -99,7 +112,7 @@ describe("PatronAuthServiceEditForm – capability gating", () => {
       settings: { idp_url: "https://idp.example.com" },
       libraries: [{ short_name: LIBRARY_SHORT_NAME }],
     };
-    render(<PatronAuthServiceEditForm {...baseProps} item={item} />);
+    renderForm(<PatronAuthServiceEditForm {...baseProps} item={item} />);
     await expandLibrariesPanel(user);
 
     // For non-SIP2 with no library_settings, the Edit button should not render
@@ -119,7 +132,7 @@ describe("PatronAuthServiceEditForm – load / initial value", () => {
         message: "Card expired",
       },
     ];
-    render(
+    renderForm(
       <PatronAuthServiceEditForm
         {...baseProps}
         item={buildSIP2Item(existingRules)}
@@ -144,7 +157,7 @@ describe("PatronAuthServiceEditForm – load / initial value", () => {
 
   it("shows empty editor when library has no existing patron_blocking_rules", async () => {
     const user = userEvent.setup();
-    render(
+    renderForm(
       <PatronAuthServiceEditForm {...baseProps} item={buildSIP2Item([])} />
     );
 
@@ -160,7 +173,7 @@ describe("PatronAuthServiceEditForm – error display", () => {
   it("passes error prop down to PatronBlockingRulesEditor", async () => {
     const user = userEvent.setup();
     const error = { status: 400, response: "Validation failed", url: "" };
-    render(
+    renderForm(
       <PatronAuthServiceEditForm
         {...baseProps}
         item={buildSIP2Item([{ name: "", rule: "expr", message: null }])}
@@ -180,7 +193,9 @@ describe("PatronAuthServiceEditForm – error display", () => {
 describe("PatronAuthServiceEditForm – serialization", () => {
   it("includes patron_blocking_rules in the library state when editLibrary is called", async () => {
     const user = userEvent.setup();
-    render(<PatronAuthServiceEditForm {...baseProps} item={buildSIP2Item()} />);
+    renderForm(
+      <PatronAuthServiceEditForm {...baseProps} item={buildSIP2Item()} />
+    );
 
     await expandLibrariesPanel(user);
     const editButton = screen.getByRole("button", { name: /Edit/i });
@@ -215,7 +230,7 @@ describe("PatronAuthServiceEditForm – serialization", () => {
       settings: {},
       libraries: [],
     };
-    render(<PatronAuthServiceEditForm {...baseProps} item={item} />);
+    renderForm(<PatronAuthServiceEditForm {...baseProps} item={item} />);
 
     await expandLibrariesPanel(user);
     // Select the library from the dropdown
@@ -246,7 +261,9 @@ describe("PatronAuthServiceEditForm – serialization", () => {
 describe("PatronAuthServiceEditForm – save button gating", () => {
   it("disables the per-library Save button immediately when a new rule is added", async () => {
     const user = userEvent.setup();
-    render(<PatronAuthServiceEditForm {...baseProps} item={buildSIP2Item()} />);
+    renderForm(
+      <PatronAuthServiceEditForm {...baseProps} item={buildSIP2Item()} />
+    );
 
     await expandLibrariesPanel(user);
     await user.click(screen.getByRole("button", { name: /Edit/i }));
@@ -258,7 +275,9 @@ describe("PatronAuthServiceEditForm – save button gating", () => {
 
   it("re-enables the per-library Save button once validation succeeds", async () => {
     const user = userEvent.setup();
-    render(<PatronAuthServiceEditForm {...baseProps} item={buildSIP2Item()} />);
+    renderForm(
+      <PatronAuthServiceEditForm {...baseProps} item={buildSIP2Item()} />
+    );
 
     await expandLibrariesPanel(user);
     await user.click(screen.getByRole("button", { name: /Edit/i }));
@@ -280,7 +299,9 @@ describe("PatronAuthServiceEditForm – save button gating", () => {
       body: { detail: "Unknown placeholder" },
     });
 
-    render(<PatronAuthServiceEditForm {...baseProps} item={buildSIP2Item()} />);
+    renderForm(
+      <PatronAuthServiceEditForm {...baseProps} item={buildSIP2Item()} />
+    );
 
     await expandLibrariesPanel(user);
     await user.click(screen.getByRole("button", { name: /Edit/i }));
@@ -302,7 +323,7 @@ describe("PatronAuthServiceEditForm – save button gating", () => {
       settings: {},
       libraries: [],
     };
-    render(<PatronAuthServiceEditForm {...baseProps} item={item} />);
+    renderForm(<PatronAuthServiceEditForm {...baseProps} item={item} />);
 
     await expandLibrariesPanel(user);
     const select = screen.getByRole("combobox", { name: /Add Library/i });
@@ -324,7 +345,7 @@ describe("PatronAuthServiceEditForm – save button gating", () => {
       { name: "Rule A", rule: "expr_a" },
       { name: "Rule B", rule: "expr_b" },
     ];
-    render(
+    renderForm(
       <PatronAuthServiceEditForm
         {...baseProps}
         item={buildSIP2Item(existingRules)}
@@ -354,7 +375,7 @@ describe("PatronAuthServiceEditForm – save button gating", () => {
       { name: "Rule A", rule: "expr_a" },
       { name: "Rule A", rule: "expr_b" }, // starts as duplicate
     ];
-    render(
+    renderForm(
       <PatronAuthServiceEditForm
         {...baseProps}
         item={buildSIP2Item(existingRules)}
@@ -380,7 +401,7 @@ describe("PatronAuthServiceEditForm – save button gating", () => {
   it("re-blocks and then re-enables the Save button when an existing rule's expression is edited and re-validated", async () => {
     const user = userEvent.setup();
     const existingRules = [{ name: "Rule A", rule: "expr_a" }];
-    render(
+    renderForm(
       <PatronAuthServiceEditForm
         {...baseProps}
         item={buildSIP2Item(existingRules)}
@@ -411,7 +432,7 @@ describe("PatronAuthServiceEditForm – save button gating", () => {
 describe("PatronAuthServiceEditForm – csrfToken / serviceId wiring", () => {
   it("passes the csrfToken from additionalData to the validation API request", async () => {
     const user = userEvent.setup();
-    render(
+    renderForm(
       <PatronAuthServiceEditForm
         {...baseProps}
         item={buildSIP2Item()}
@@ -441,7 +462,9 @@ describe("PatronAuthServiceEditForm – csrfToken / serviceId wiring", () => {
   it("passes the item id as service_id in the validation API request body", async () => {
     const user = userEvent.setup();
     // item.id = 1 (from buildSIP2Item)
-    render(<PatronAuthServiceEditForm {...baseProps} item={buildSIP2Item()} />);
+    renderForm(
+      <PatronAuthServiceEditForm {...baseProps} item={buildSIP2Item()} />
+    );
 
     await expandLibrariesPanel(user);
     await user.click(screen.getByRole("button", { name: /Edit/i }));