@comunica/actor-rdf-parse-jsonld

Comunica JSON-LD RDF Parse Actor

An RDF Parse actor that handles JSON-LD.

This module is part of the Comunica framework, and should only be used by developers that want to build their own query engine.

Click here if you just want to query with Comunica.

Install

$ yarn add @comunica/actor-rdf-parse-jsonld

Configure

After installing, this package can be added to your engine's configuration as follows:

{
  "@context": [
    ...
    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-rdf-parse-jsonld/^4.0.0/components/context.jsonld"
  ],
  "actors": [
    ...
    {
      "@id": "urn:comunica:default:rdf-parse/actors#jsonld",
      "@type": "ActorRdfParseJsonLd",
      "priorityScale": 0.9,
      "mediatorHttp": { "@id": "urn:comunica:default:http/mediators#main" }
    }
  ]
}

Config Parameters

• priorityScale: An optional priority for this parser, used for content negotiation, defaults to 1.
• mediatorHttp: A mediator over the HTTP bus, for fetching remote JSON-LD contexts.

Passing custom options

If you want to pass custom options to the JSON-LD parser, you can use the '@comunica/actor-rdf-parse-jsonld:parserOptions' context entry to provide parser options as a hash.

Using a custom document loader

If you want to override how the JSON-LD parser loads external contexts, you can pass a custom document loader via the '@comunica/actor-rdf-parse-jsonld:documentLoader' context entry. This document loader must implement the IDocumentLoader interface.

Enabling stricter parsing mode

Via the '@comunica/actor-rdf-parse-jsonld:strictValues' context entry, you can set the JSON-LD parser to run in a more strict mode. This corresponds to the strictValues option in JSON-LD Streaming Parser.

Changelog

v4.0.1 - 2024-10-15

BREAKING CHANGES

The following breaking changes will only impact users of Node.js < 18 and users that develop custom components or engines with Comunica.

• Remove backwards-compat for Node.js < 18
  • Remove cross-fetch and abort-controller polyfill as unnecessary
  • Update fetch-sparql-endpoint to version 5
  • Remove Node 14 backwards-compat in stats writer
• API changes
  • Refactor Actor.test to not rely on Promise rejections
    • All Actor.test methods must be changed to use passTest or failTest instead of promise rejections, for better performance.
  • Use variable.canBeUndef in metadata instead of canContainUndefs
  • Remove Actor.initialize and .deinitalize
  • Rename noCache CLI argument to invalidateCache
  • Remove hash collisions flag from hash buses
  • Return 32-bit numbers in hash bus based on specific variables
  • Allow inserts and deletes to execute in a single request
• Renamed or changed actors
  • Split expression functions into separate actors on dedicated bus
  • Split aggregators into separate actors on dedicated bus
  • Refactor HTTP fetch and retry logic
    • Retries of failed requests has been improved
    • The User-Agent header has been improved
    • A better approach to detect if Comunica is in a browser environment, compatible with Node.js, Deno, and Bun.
  • Remove SHA1 hash quads actor in favor of Murmur3
  • Remove SHA1 hash actor in favor of Murmur3
  • Abstract actor-rdf-join-minus-hash-undef into actor-rdf-join-minus-hash
• Move utilities
  • Add utils-query-operation and utils-iterator
    • These new packages contain helper functions that previously existed in bus-query-operation and bus-rdf-join.
  • Rename util packages to 'util-' scope
    • data-factory -> utils-data-factory
    • bindings-factory -> utils-bindings-factory
    • jest -> utils-jest
    • metadata -> utils-metadata
  • Move ActorRdfJoin.hashNonClashing to bindingsToCompactString
  • Delegate all join hashing to hash bus
  • Move bindings index from optional join to utils package

Added

• Add default Accept-Encoding header with Brotli
• Add undef support to inner hash join actor
• Forward side data from test to run in actors
• Allow plugging in custom DataFactory through context, Closes #358

Changed

• Remove unneeded false default values on CLI boolean args
• Improve fragment selector shape handling
  • Make doesShapeAcceptOperation recurse into operations
  • Add dedicated wildcard operation type to FragmentSelectorShape
• Improve performance
  • Bump asyncjoin with hash join performance improvement
  • Only consider overlapping vars when testing undef in join actors
• Improve type inference in IActionContext, Closes #933
• Emit planning time from stats writer
• Make stats writer measure time from actual query start
• Improve error reporting when mediators fail

Fixed

• Fix union not setting canContainUndefs to true if child vars differ

<a name="v3.3.0"></a>