Skip to content

CHANGELOG.md

Latest commit

 

History

History
242 lines (193 loc) · 20.7 KB

CHANGELOG.md

File metadata and controls

242 lines (193 loc) · 20.7 KB
Raw

Change history for mod-graphql

1.15.1 (2026-04-15)

  • Bump validator from 13.15.15 to 13.15.23 fixing CVE-2025-12758. Fixes MODGQL-201.
  • Other dependency bumps for security reasons: jsonpath, underscore, yaml, js-yaml, lodash, @xmldom/xmldom, flatted, handlebars, picomatch, svgo.

1.15.0 (2025-09-19)

  • Make "electronicAccess" and "notes" fields optional in GraphQL schema. Fixes MODGQL-198.
  • Increment provided graphql interface version to v1.15. Part of MODGQL-199.

1.14.0 (2025-09-18)

  • Modify build/setup-for-build.sh script to use instance JSON Schema from mod-search (generated from RAML schemas) instead of from mod-inventory-storage. Fixes MODGQL-195. No changes to code, only to canonical configuration.
  • Searches against /search/instances have the query parameter expandAll=true added. Fixes MODGQL-196.

1.13.1 (2024-12-05)

  • Schema-configuration file format now correctly supports additional query parameters in subqueries. Fixes MODGQL-189.
  • Build-time schema configuration now correctly includes access to loan due-date. Fixes MODGQL-188.
  • Bump provided version of graphql interface to 1.4, representing the use of a configuration that can supply information about the loans associated with items. This allows new versions of the Z39.50 server configuration, which need this information, to depend on it.

1.13.0 (2024-11-27)

  • Dockerized version runs under Node 20. Fixes MODGQL-182.
  • Upgrade eslint-config-stripes dependency so avoid an ESLint version clash when building under NPM instead of Yarn.
  • Fix minor linting issues which become apparent under updated eslint-config-stripes.
  • Run directly under Node, no longer using Babel. Fixes MODGQL-144 and makes MODGQL-175 moot.
  • Replace apollo-server-express (^2.15.0) with @apollo/server (^4.11.2) and upgrade graphql. Fixes MODGQL-160.

1.12.2 (2024-10-16)

  • Upgrade express dependency for security.

1.12.1 (2024-02-27)

  • create-schemas.js allows for the possibility of RAML-and-schema repos having removed submodules since the version that was marked for us. Thanks to Michelle Suranofsky (@mis306lu) for spotting this and providing the fix. Fixes MODGQL-179.

1.12.0 (2023-10-11)

Full Changelog

  • Fix some ESLint errors (mostly just whitespace). Fixes MODGQL-171.
  • Dockerfile specifies to run on Node v18. Fixes MODGQL-172.

1.11.0 (2023-02-24)

Full Changelog

  • Upgrade to query-string ^7.1.2, mitigating DoS CVE-2022-38900. Fixes MODGQL-161.
  • When parsing JSON schemas, infer that arrays whose elements specify no type are of type object, so long as a $ref field is provided. This allows us to correctly handle the mod-search JSON schemas, which routinely omit array-element types. This functionality is provided by graphql interface 1.3. Fixes MODGQL-164.
  • A new, self-contained build directory is used for building the Docker container. This is now distinct from the tests directory used for running tests (as it always should have been) and from the schema-configuration file and hand-crafted mod-search RAML that are used in development of the create-schemas part of the software. Fixes MODGQL-158.
  • Generated type names now include a prefix representing the WSAPI path, disambiguating otherwise same-named types from different modules. This prevents same-named schemas with different contents from colliding. Fixes MODGQL-114.
  • The fix to type names enables mod-inventory-storage and mod-search to run together. Fixes MODGQL-165.
  • Extend tests to check that production schemas compile and merge (to avoid another MODGQL-165). Fixes MODGQL-166.
  • Allow create-schema overrides to specify array-typed virtual fields. Fixes MODGQL-168.
  • Rewrite Docker-build schema-configuration to properly support mod-search using its own instance schema. Fixes MODGQL-169.

1.10.2 (2022-06-25)

Full Changelog

  • Copy mod-inventory-storage JSON schemas for mod-search, instead of having mod-search's RAML link out to the adjacent mod-inventory-storage area. Avoids error "duplicate type name 'Tinstances' with different definitions" when starting up mod-graphql on both modules simultaneously. Fixes MODGQL-156.

1.10.1 (2022-06-25)

Full Changelog

  • Update version in ModuleDescriptor.json to match what's in package.json. (The problem arose because, unlike Stripes modules, the former is not generated from the latter, and I am in the habit of only changing the package for Stripes-module releases.) Thanks to David Crossley for finding this.

1.10.0 (2022-06-24)

Full Changelog

  • Update node.js version from 10 to 14. Fixes MODGQL-142.
  • Extensions to create-schema.js to help with handling OpenAPI-based modules. Fixes MODGQL-153.
  • Support searching in mod-search. Fixes MODGQL-152.
  • Numerous additions and improvements to documentation.
  • Upgrade many dependencies.

1.9.0 (2021-06-03)

Full Changelog

  • Dependency updates: json-ptr, underscore, xmldom; yarn.lock. Fixes MODGQL-138.

1.8.0 (2021-05-11)

Full Changelog

  • Enhance the default schema configuration to include a new virtual field temporaryLocation in mod-inventory-storage's holdingsrecord.json. (Needed to resolve ZF-43 for the Z39.50 server.)
  • The RAML type datetime is now mapped to the GraphQL type String. This is far from ideal, but it allows the SRS RAMLs to be loaded without getting into a mire of custom types. Fixes MODGQL-136.

1.7.0 (2021-05-04)

Full Changelog

  • Bump date-and-time from 0.5.0 to 0.14.2 fixing a regular expression denial of service (ReDoS) vulnerability. Fixes CVE-2020-26289, MODGQL-130.
  • Bump elliptic from 6.5.3 to 6.5.4 fixing a ECDH secp256k1 cryptographic vulnerability. Fixes CVE-2020-28498.
  • Add and document the resultcount logging category.
  • Various updates to documentation, including fixing links to standards documents that have gone away, documenting missing logging-categories, updating descriptions of internal structures, and updating sample invocations.
  • Support queries specifying how many records to fetch for subqueries: all link-fields mentioned in queries may optionally take a limit parameter, which defaults to 10 when not specified. Documentation and updates to tests. Fixes MODGQL-134.

1.6.0 (2021-02-23)

Full Changelog

  • Support the /admin/health endpoint. Fixes MODGQL-133.

1.5.0 (2021-02-22)

Full Changelog

  • Remove ui-users RAMLs from the schema configuration used by the Docker build process (tests/schemaconf.json) to work around the problem described in MODGQL-132. This is safe, since current applications of mod-graphql -- notably the FOLIO Z39.50 server -- use only inventory-storage.

1.4.0 (2020-02-01)

Full Changelog

1.3.1 (2020-11-25)

Full Changelog

  • No changes to the software. The item.json JSON Schema in mod-inventory-storage has been augmented with a definition of a materialType virtual field, which will be included in the Docker build for this release.

1.3.0 (2020-10-19)

Full Changelog

  • Add redundant copies of the mod-inventory-storage RAMLs, including the raml-utils submodule, in tests/mod-inventory-storage-ramls. This will make it much easier to run mod-graphql in a useful way from within Docker.
  • GraphQL schema generation emits a _dummy string field as a member of empty objects. Fixes MODGQL-118.
  • Correctly handle linking from array-valued fields (including doing nothing for an empty-array value). Fixes MODGQL-120.
  • Add src/merge area, showing how to merge an overlay JSON Schema to add link-fields to a schema that lacks them. Fixes MODGQL-119.
  • Include mod-users APIs in Docker container.
  • Add link fields for the holdings structure's illPolicy. Fixes ReShare issue PR-611.
  • Add new section to Example queries against mod-inventory-storage on Using curl against a local docker-containerised mod-graphql
  • Dockerization now gets RAMLs and JSON Schemas by pulling the required modules from git rather than using a redundant copy from this repository. Included as of v1.2.1.
  • The listen invocation no longer specifies a second argument of 0.0.0.0. For reasons I don't begin to understand, running in this way meant that, while Firefox, Telnet and curl could all access the service just fine, the FOLIO Z39.50 server (which is written in Perl using the LWP library for HTTP access) could not, mysteriously claiming the connection was refused. Removing the second argument fixes this: I have no idea why, I just stumbled over it after a fruitless day of random debugging.
  • Ensure that the server does not do cross-origin resource sharing (CORS), since doing so can in some circumstances collide with Okapi's handing of this. Thanks to Michal Kuklis for finding the solution. Fixes MODGQL-127.

1.2.0 (NOT RELEASED)

  • There was no 1.2.0 release as the version number was inadvertently advanced to v1.2.1 before that could be done.

1.1.0 (2018-10-25)

Full Changelog

  • In JSON Schemas, treat absence of properties the same as an empty set. Fixes MODGQL-89.
  • mod-graphql can now read, combine and translate all 22 of the mod-inventory-storage RAMLs with their schemas. Fixes MODGQL-88.
  • RAML conversion now fails when referenced trait files are absent. Fixes MODGQL-94.
  • RAML conversion now fails when referenced JSON Schema files are absent. Fixes MODGQL-95.
  • Reinstate src/autogen/test/run-tests.js: we still need this for yarn regen, which regenerates regression-test expectations. Undoes part of MODGQL-86.
  • Correctly interpret paths of sub-schemas relative to parents. Fixes MODGQL-96.
  • Add ignoreRamlWarnings option, so translation can continue after a RAML parse with no hard errors. Fixes MODGQL-97.
  • RAML-parsing failures are now reported by throwing an exception, not by exiting the whole process. Fixes MODGQL-99.
  • Support array-typed query parameters in RAML 1.0. Fixes MODGQL-98.
  • convertAPI no longer emits diagnostic output, but throws a richer exception containining diagnostics. Fixes MODGQL-100.
  • Check that RAML/JSON Schema conversion can handle all existing modules. Fixes MODGQL-93.
  • Support array-valued types in JSON Schemas. Fixes MODGQL-102.
  • Support array-typed array types (yes, really!). Fixes MODGQL-103.
  • Extend raml2graphql with a new -a api.yml option to parse all the RAMLs specified in the API file. Fixes MODGQL-101.
  • Add -d=DIRECTORY option to specify the path used, when -a is in effect, to find RAMLs named in the YAML API specification. Fixes MODGQL-106.
  • Add -s option to skip RAMLs from modules that aren't checked out. Fixes MODGQL-105.
  • Add -m=REGEXP option to limit RAMLs to those from matching modules when -a is in effect. Fixes MODGQL-104.
  • Avoid registering undefined comments. This is necessary because raml-1-parser helpfully adds an undefined version comment if a RAML doesn't specify a version. Fixes MODGQL-108.
  • Add ability to drive mod-graphql from an API file, and document this in the README. Fixes MODGQL-107.
  • parseSchemaMap supports RAML 1.0, enabling sub-schemas to be correctly located from RAML 1.0 files. Fixes MODGQL-109.
  • listAPIs now omits module-sections for which multiple is set true in the API file. This avoids conflicts with multiple modules having the same API trying to define the same endpoint. Fixes MODGQL-110.
  • mergeResources now reports the paths to both RAML files when two of them try to define the same resource. Fixes MODGQL-112.
  • Add RAML_EXCLUDE=regexp environment variable and -x regexp option to exclude from the API list modules that match the specified regexp. Fixes MODGQL-113.
  • No remaining duplicate resource-names now that MODGQL-110 is done, when MODGQL-113 facilities are used. Fixes MODGQL-111.
  • Break the RAML-merging code out of convertAPI.js into its own source-file mergeAPIs.js. Fixes MODGQL-116.
  • mergeTypes now reports which two RAML files are responsible for a type clash if one occurs. Fixes MODGQL-115.

1.0.0 (2018-10-12)

Full Changelog

  • Remove support for LEGACY_RESOLVERS. Fixes MODGQL-81.
  • Remove old yarn test2 code. That command still works, but now uses a mainstream test. Fixes MODGQL-86.

0.2.0 (2018-10-11)

First formal release.

  • The instances query now returns a structure of a records array and a totalCount. Fixes MODGQL-3.
  • URL-encode the CQL query in instances requests. Fixes MODGQL-8.
  • Set up ESLint. Fixes MODGQL-11.
  • Lint-clean the code. Fixes MODGQL-10.
  • Move source-code down into new src directory. Fixes MODGQL-13.
  • Fix regression: errors when instance records lack foreign keys. Fixes MODGQL-15.
  • Emit diagnostics for (e.g.) malformed CQL. Fixes MODGQL-6.
  • Support paging parameters in mod-graphql Instances search. Fixes MODGQL-16.
  • Return holdings statements, with their items, along with instance records. Fixes MODGQL-18.
  • Auto-generate GraphQL schemas from RAMLs and JSON Schemas. Fixes MODGQL-20.
  • Auto-generate GraphQL resolvers from RAMLs and JSON Schemas. Fixes MODGQL-23.
  • General work towards a useful test-suite. Fixes MODGQL-12.
  • Set up test-suite for GraphQL schema generation. Fixes MODGQL-22.
  • Abstract out common parts of tests. Fixes MODGQL-31.
  • Add tests for two-level and three-level fetching. Fixes MODGQL-24.
  • Document procedure for uninstalling a running module. Fixes MODGQL-5.
  • Use PROXY_OKAPI_URL environment variable for instructing the yakbak proxy server, rather than re-using OKAPI_URL which is used here as in other places such as the various Okapi CLIs. Prevents the yakbak HTTP server from being bypassed in tests, and so fixes MODGQL-35.
  • Add ability to use CQL and other variables in GraphQL for tests. Fixes MODGQL-32.
  • Modify yarn test code so it sets up necessary mod-inventory-storage RAMLs/JSON Schemas. Fixes MODGQL-33.
  • Get tests running within CI (by generating a good set of tapes). Fixes MODGQL-34.
  • Parameterise which RAML drives mod-graphql. Fixes MODGQL-29.
  • Handle RAML type-names with embedded hyphens. Fixes MODGQL-36.
  • Add schema logging-category for dumping the generated GraphQL schema. Fixes MODGQL-37.
  • Create single logger object, pass it down to wherever it's needed. Fixes MODGQL-38.
  • Support '@' symbol in field-names. Fixes MODGQL-39.
  • RAML/JSON-Schema translator can handle arrays with no items specification. Fixes MODGQL-40.
  • Discard endpoints that define no JSON response (but continue reject those that define a JSON response with no schema specified). Fixes MODGQL-41.
  • Correctly handle API paths that have parameters in the middle. Fixes MODGQL-44.
  • Correctly handle API paths that have multiple parameters. Fixes MODGQL-45
  • Skip over fields whose types are undefined. Fixes MODGQL-46.
  • Extend mod-graphql so that its test-suite, broken by mod-inventory-storage, works once more. Fixes MODGQL-43.
  • Document use of environment variables. Fixes MODGQL-48.
  • Use logger to emit gathered API instead of checking options. Fixes MODGQL-27.
  • Support RAML API body specifications with type application/vnd.api+json as well as application/json. Fixes MODGQL-49.
  • Improve titles of RAML-to-GraphQL test-cases. Fixes MODGQL-51.
  • Add raml logging-category for dumping the compiled RAML before analysing schemas. Fixes MODGQL-52.
  • When allowSchemaless option is in effect, simply ignore endpoints that have no schema. Fixes MODGQL-53.
  • Support RAML 1.0. Fixes MODGQL-50.
  • Recognise two ways absence of RAML 1.0 schema is indicated. Fixes MODGQL-54.
  • Spot and diagnose non-scalar JSON-Schema type. Related to MODGQL-55.
  • Square brackets in parameter names are mapped to underscores. Fixes MODGQL-56.
  • Omit leading baseURL from URLs gathered in API. Fixes MODGQL-57.
  • Propagate all query parameters from GraphQL queries to corresponding back-end queries. Fixes MODGQL-59.
  • Target mod-graphql on the RAML for mod-kb-ebsco. Fixes MODGQL-47.
  • Support new logging categories api.comments, api.resources, api.types. Fixes MODGQL-63.
  • Share GraphQL-schema types when the same JSON Schema is referenced in multiple places. Fixes MODGQL-64.
  • Omit constant leading path from generated type-names. Fixes MODGQL-66.
  • Repair test-suite failure due to running in higher-level directory. Fixes MODGQL-65.
  • Skeleton specified by folio:includedElement supports dot-separated paths such as holdingsRecords.0. Fixes MODGQL-68.
  • Add new document, Example queries against mod-inventory-storage. Fixes MODGQL-67.
  • Handle circular references in schemas, including use of util.inspect to serialise JSON Schemas. Fixes MODGQL-61.
  • Specify particular SHA1s for checkouts of modules whose RAMLs are used in yarn test (mod-inventory-storage and raml-util). Fixes MODGQL-69.
  • Upgrade tests to cope with the RAML 1.0 now used by mod-inventory-storage and raml-util. Fixes MODGQL-70.
  • Support "weak references" in JSON Schemas, specified as folio:$ref. Behaves the same as $ref in mod-graphql, but is ignored by RMB, circumventing its problem with cycles (RMB-265). Fixes MODGQL-71.
  • Ability to combine APIs of multiple RAMLs. Fixes MODGQL-30.
  • Add links from top-level README to other documentation. Fixes MODGQL-75.
  • Exercise multiple entry points to graph. Fixes MODGQL-25.
  • Support item query that returns holdings and instance. Fixes MODGQL-21.
  • Change to top-level API: the exported object is no longer a running app, but a function which will start and return such an app. Allows the paths to the to-be-converted. RAML files to be passed in. Fixes MODGQL-79.
  • Add new test-case 14, exercising the items API. Fixes MODGQL-76.
  • Add new test-case 15, exercising multiple RAMLs in a single API. Fixes MODGQL-73.
  • Remove default ramlPaths from app. Fixes MODGQL-80.
  • Add, use and document new ramlpath logging category. Fixes MODGQL-82.
  • Add and use configuredLogger utility rather than raw stripes-logger. Fixes MODGQL-83.
  • Recognise LOGCAT environment variable as well as LOGGING_CATEGORIES. Fixes MODGQL-84.
  • Document combining APIs of multiple RAMLs. Fixes MODGQL-74.
  • Rationalize mod-graphql documentation. Fixes MODGQL-77.
  • Add documentation on how to use GraphQL from Stripes. Fixes MODGQL-19.