@thepalaceproject/circulation-admin 1.19.0 → 1.20.0

package/dist/circulation-admin.js.LICENSE.txt

@@ -43,12 +43,40 @@ object-assign
 
 /*! http://mths.be/fromcodepoint v0.1.0 by @mathias */
 
-/*! https://mths.be/punycode v1.3.2 by @mathias */
+/*! https://mths.be/punycode v1.4.1 by @mathias */
 
 /*! ieee754. BSD-3-Clause License. Feross Aboukhadijeh <https://feross.org/opensource> */
 
 /*! safe-buffer. MIT License. Feross Aboukhadijeh <https://feross.org/opensource> */
 
+/**
+   * match-sorter-utils
+   *
+   * Copyright (c) TanStack
+   *
+   * This source code is licensed under the MIT license found in the
+   * LICENSE.md file in the root directory of this source tree.
+   *
+   * @license MIT
+   */
+
+/**
+ * @license React
+ * use-sync-external-store-shim.production.min.js
+ *
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+/**
+ * @name match-sorter
+ * @license MIT license.
+ * @copyright (c) 2099 Kent C. Dodds
+ * @author Kent C. Dodds <me@kentcdodds.com> (https://kentcdodds.com)
+ */
+
 /** @license React v0.19.1
  * scheduler.production.min.js
  *
@@ -122,4 +150,4 @@ object-assign
 
 //! momentjs.com
 
-//! version : 2.29.4
+//! version : 2.30.1

package/jest.config.js

@@ -2,5 +2,9 @@
 module.exports = {
   preset: "ts-jest",
   testEnvironment: "jsdom",
+  testEnvironmentOptions: {
+    customExportConditions: [""],
+  },
+  setupFiles: ["./jest.polyfills.js"],
   setupFilesAfterEnv: ["./tests/jest/jest-setup.ts"],
 };

package/jest.polyfills.js

@@ -0,0 +1,20 @@
+// jest.polyfills.js
+
+const globalThis = window;
+
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const { ReadableStream, TextDecoder, TextEncoder } = require("node:util");
+Object.defineProperties(globalThis, {
+  ReadableStream: { value: ReadableStream },
+  TextDecoder: { value: TextDecoder },
+  TextEncoder: { value: TextEncoder },
+});
+
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const { fetch, Request, Response, Headers } = require("fetch-ponyfill")();
+Object.defineProperties(globalThis, {
+  fetch: { value: fetch, writable: true },
+  Headers: { value: Headers },
+  Request: { value: Request },
+  Response: { value: Response, writable: true },
+});

package/package.json

@@ -36,6 +36,8 @@
   },
   "dependencies": {
     "@nypl/dgx-svg-icons": "0.3.4",
+    "@reduxjs/toolkit": "^2.2.5",
+    "@tanstack/react-query": "^4.36.1",
     "@thepalaceproject/web-opds-client": "^1.0.1",
     "bootstrap": "^3.3.6",
     "classnames": "^2.3.1",
@@ -56,7 +58,7 @@
     "react-dnd": "^14.0.5",
     "react-dnd-html5-backend": "^14.0.5",
     "react-dom": "^16.8.6",
-    "react-redux": "^7.1.0",
+    "react-redux": "^7.2.9",
     "react-router": "^3.2.0",
     "recharts": "^1.8.6",
     "redux": "^4.0.1",
@@ -67,8 +69,10 @@
     "url": "^0.11.0"
   },
   "devDependencies": {
+    "@tanstack/react-query-devtools": "^4.36.1",
     "@testing-library/jest-dom": "^5.16.5",
     "@testing-library/react": "^12.1.5",
+    "@testing-library/react-hooks": "^8.0.1",
     "@testing-library/user-event": "^14.4.3",
     "@types/jest": "^29.2.6",
     "@types/mocha": "^10.0.1",
@@ -77,7 +81,8 @@
     "@types/prop-types": "^15.7.3",
     "@types/react": "^16.14.6",
     "@types/react-dom": "^16.9.8",
-    "@types/react-redux": "^7.1.16",
+    "@types/react-redux": "^7.1.33",
+    "@types/react-router": "^3.0.28",
     "@types/recharts": "^1.8.28",
     "@types/redux-mock-store": "^1.0.3",
     "@typescript-eslint/eslint-plugin": "^5.46.0",
@@ -96,6 +101,8 @@
     "eslint-plugin-react": "^7.19.0",
     "eslint-plugin-react-hooks": "^4.0.0",
     "fetch-mock": "^7.3.1",
+    "fetch-mock-jest": "^1.5.1",
+    "fetch-ponyfill": "^7.1.0",
     "file-loader": "^6.2.0",
     "follow-redirects": "^1.15.6",
     "husky": "^4.3.0",
@@ -106,10 +113,11 @@
     "lint-staged": "^10.4.0",
     "mini-css-extract-plugin": "1.6.0",
     "mocha": "^10.2.0",
-    "msw": "^1.2.1",
+    "msw": "^2.3.0",
     "nightwatch": "^3.2.0",
     "prettier": "2.1.2",
     "react-axe": "^3.3.0",
+    "react-test-renderer": "^16.14.0",
     "redux-mock-store": "^1.5.4",
     "sass": "^1.64.2",
     "sass-lint": "^1.13.1",
@@ -141,5 +149,5 @@
     "*.{js,jsx,ts,tsx,css,md}": "prettier --write",
     "*.{js,css,md}": "prettier --write"
   },
-  "version": "1.19.0"
+  "version": "1.20.0"
 }

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

@@ -0,0 +1,60 @@
+import {
+  DEFAULT_BASE_ENDPOINT_URL,
+  getInventoryReportInfo,
+  requestInventoryReport,
+} from "../../../src/api/admin";
+import * as fetchMock from "fetch-mock-jest";
+
+const sampleInfoResponseData = { collections: [] };
+const sampleGenerateResponseData = { message: "some message" };
+
+const testAlternateBaseUrl = "/test/base/url";
+const libraryKey = "short-name";
+
+const testEndpoints = ({
+  title,
+  baseEndpointUrl: baseEndpointUrl = undefined,
+  expectedUrl = DEFAULT_BASE_ENDPOINT_URL,
+}) => {
+  describe(title, () => {
+    beforeEach(() => {
+      fetchMock
+        .get("*", { body: sampleInfoResponseData, status: 200 })
+        .post("*", { body: sampleGenerateResponseData, status: 202 });
+    });
+
+    afterEach(() => {
+      fetchMock.mockReset();
+    });
+
+    it("requests inventory report information", async () => {
+      const response = await getInventoryReportInfo({
+        library: libraryKey,
+        baseEndpointUrl,
+      });
+      expect(response).toStrictEqual(sampleInfoResponseData);
+      expect(fetchMock).toHaveBeenCalledWith(expectedUrl);
+    });
+
+    it("requests report generation via a post to the endpoint", async () => {
+      const response = await requestInventoryReport({
+        library: libraryKey,
+        baseEndpointUrl,
+      });
+      expect(response).toStrictEqual(sampleGenerateResponseData);
+      expect(fetchMock).toHaveBeenCalledWith(expectedUrl, { method: "POST" });
+    });
+  });
+};
+
+describe("Inventory report API", () => {
+  testEndpoints({
+    title: "default endpoints",
+    expectedUrl: `${DEFAULT_BASE_ENDPOINT_URL}/${libraryKey}`,
+  });
+  testEndpoints({
+    title: "alternative test endpoints",
+    baseEndpointUrl: testAlternateBaseUrl,
+    expectedUrl: `${testAlternateBaseUrl}/${libraryKey}`,
+  });
+});

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

@@ -1,9 +1,8 @@
 import * as React from "react";
 import { screen, waitFor } from "@testing-library/react";
 import userEvent from "@testing-library/user-event";
-
-import { rest } from "msw";
 import { setupServer } from "msw/node";
+import { http, HttpResponse } from "msw";
 import CustomLists from "../../../src/components/CustomLists";
 import renderWithContext from "../testUtils/renderWithContext";
 import buildStore from "../../../src/store";
@@ -15,8 +14,8 @@ describe("CustomLists", () => {
   Element.prototype.scrollTo = () => {};
 
   const server = setupServer(
-    rest.get("*/search", (req, res, ctx) => res(ctx.xml("<feed />"))),
-    rest.get("*", (req, res, ctx) => res(ctx.json({})))
+    http.get("*/search", () => HttpResponse.xml("<feed />")),
+    http.get("*", () => HttpResponse.json({}))
   );
 
   beforeAll(() => {
@@ -111,10 +110,10 @@ describe("CustomLists", () => {
     let searchParams = null;
 
     server.use(
-      rest.get("*/search", (req, res, ctx) => {
-        searchParams = req.url.searchParams;
-
-        res(ctx.xml("<feed />"));
+      http.get("*/search", ({ request }) => {
+        const url = new URL(request.url);
+        searchParams = url.searchParams;
+        return HttpResponse.xml("<feed />");
       })
     );
 
@@ -154,10 +153,10 @@ describe("CustomLists", () => {
     let searchParams = null;
 
     server.use(
-      rest.get("*/search", (req, res, ctx) => {
-        searchParams = req.url.searchParams;
-
-        res(ctx.xml("<feed />"));
+      http.get("*/search", ({ request }) => {
+        const url = new URL(request.url);
+        searchParams = url.searchParams;
+        return HttpResponse.xml("<feed />");
       })
     );