Skip to content

Conversation

HenriRabalais
Copy link
Collaborator

@HenriRabalais HenriRabalais commented Sep 8, 2025

This PR refactors the acknowledgements page to use a new, more robust and reusable API client and a suite of custom error classes. This change modernizes our data fetching approach by moving away from raw fetch requests and adopting a structured, type-safe methodology.

Key Changes

Introduced a new Core Library: Added a new directory at jslib/core containing:

  • Client.ts: A generic, extensible class for handling API requests (GET, POST, PUT). It includes robust error handling for network issues, HTTP response statuses (e.g., 404), and JSON parsing errors.
  • Query.ts: A class for building type-safe URL query strings, supporting various operators and parameters.
  • Added Custom Error Classes: A comprehensive set of custom error classes are now available at jslib/core/errors to provide more context for debugging API failures. This includes ApiNetworkError, ApiResponseError, JsonParseError, and more.

Introduced a Entities Library: Added a new directory at jslib/entities containing:

  • Acknowledgment entity and affiliated type and client
  • This will eventually house all LORIS entities, and contexts they provide, specific errors, hooks, components, etc.

Updated Acknowledgements Module

  • The acknowledgementsIndex.js file has been refactored to use the new AcknowledgementClient instead of a raw fetch call. This significantly cleans up the component's logic and separates concerns.
  • The AcknowledgementClient is a specialized client that extends the new generic Client.ts, providing an interface for interacting with the acknowledgements API.

Misc

  • Module and Path Configuration: Updated package.json, tsconfig.json, and webpack.config.ts to support the new libraries, including:
  • New dependencies: stream-browserify, pbkdf2, and transliteration.

@github-actions github-actions bot added Language: PHP PR or issue that update PHP code Language: Javascript PR or issue that update Javascript code Module: acknowledgements PR or issue related to acknowledgements module labels Sep 8, 2025
@@ -107,7 +107,7 @@ function array_find(array $array, callable $callback)
$factory->database(),
$factory->config(),
[
__DIR__ . "/../project/",
__DIR__ . "/../project/modules",
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

needed to get things to load...

@@ -157,6 +157,7 @@ const resolve: webpack.ResolveOptions = {
fallback: {
fs: false,
path: false,
stream: require.resolve("stream-browserify"),
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

npm compile was giving errors without this

@@ -17,17 +17,20 @@
"jstat": "^1.9.5",
"jszip": "^3.10.1",
"papaparse": "^5.3.0",
"pbkdf2": "^3.1.3",
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

npm compile was giving errors without these

@HenriRabalais HenriRabalais changed the title [jslib] Refactored Acknowledgements Client with Enhanced API Utilities [jslib] Refactored Acknowledgements with Enhanced HTTP Utilities Sep 9, 2025
export class Client<T> {
protected baseUrl: string;
protected subEndpoint?: string;
public getCustomMessage: (
Copy link
Collaborator Author

@HenriRabalais HenriRabalais Sep 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is to allow each Client concrete class to define it's own errors across all the error types, not sure if it's the best implementation, but it seems to work — maybe it just needs a better name. return type be something like Record<string, string>

@@ -491,7 +494,6 @@ window.addEventListener('load', () => {
document.getElementById('lorisworkspace')
).render(
<Index
dataURL={`${loris.BaseURL}/acknowledgements/?format=json`}
submitURL={`${loris.BaseURL}/acknowledgements/AcknowledgementsProcess`}
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can also replace this submission call in this PR to show the 'create' functionality.

@HenriRabalais
Copy link
Collaborator Author

@driusan @ridz1208 would love your thoughts on this! Hoping to extend this to more parts of loris after and add more entities. I'm also curious what you think of the directory structure I've started to build out, as it will likely get expanded. Should everything live in jslib? I'm thinking the top level components that currently live in jsx/ should also get moved into what ever the top level javascript directory is and live under a /components directory of sorts.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Language: Javascript PR or issue that update Javascript code Language: PHP PR or issue that update PHP code Module: acknowledgements PR or issue related to acknowledgements module
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants