@inrupt/solid-client
Version:
Make your web apps work with Solid Pods.
91 lines (88 loc) • 3.71 kB
JavaScript
import { Parser, Writer, DataFactory } from 'n3';
import { getSourceUrl } from '../resource/resource.mjs';
// Copyright Inrupt Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal in
// the Software without restriction, including without limitation the rights to use,
// copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
// Software, and to permit persons to whom the Software is furnished to do so,
// subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
// PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
// SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
/**
* ```{note} This function is still experimental and subject to change, even
* in a non-major release.
* ```
* This returns a parser that transforms a JSON-LD string into a set of RDFJS quads.
*
* @returns A Parser object.
* @since 1.15.0
*/
const getTurtleParser = () => {
const onQuadCallbacks = [];
const onCompleteCallbacks = [];
const onErrorCallbacks = [];
return {
onQuad: (callback) => {
onQuadCallbacks.push(callback);
},
onError: (callback) => {
onErrorCallbacks.push(callback);
},
onComplete: (callback) => {
onCompleteCallbacks.push(callback);
},
parse: (source, resourceInfo) => {
getParser(getSourceUrl(resourceInfo)).parse(source, (error, quad) => {
if (error) {
onErrorCallbacks.forEach((callback) => callback(error));
}
else if (quad) {
onQuadCallbacks.forEach((callback) => callback(quad));
}
else {
onCompleteCallbacks.forEach((callback) => callback());
}
});
},
};
};
function getParser(baseIri) {
return new Parser({ format: "text/turtle", baseIRI: baseIri });
}
/**
* @param quads Triples that should be serialised to Turtle
* @internal Utility method for internal use; not part of the public API.
*/
async function triplesToTurtle(quads, options) {
const format = "text/turtle";
const writer = new Writer({ format, prefixes: options === null || options === void 0 ? void 0 : options.prefixes });
// Remove any potentially lingering references to Named Graphs in Quads;
// they'll be determined by the URL the Turtle will be sent to:
const triples = quads.map((quad) => DataFactory.quad(quad.subject, quad.predicate, quad.object, undefined));
writer.addQuads(triples);
const writePromise = new Promise((resolve, reject) => {
writer.end((error, result) => {
/* istanbul ignore if [n3.js doesn't actually pass an error nor a result, apparently: https://github.com/rdfjs/N3.js/blob/62682e48c02d8965b4d728cb5f2cbec6b5d1b1b8/src/N3Writer.js#L290] */
if (error) {
reject(error);
}
else {
resolve(result);
}
});
});
const rawTurtle = await writePromise;
return rawTurtle;
}
export { getTurtleParser, triplesToTurtle };