graphdb/lib/service/upload-service.js

Javascript client library supporting GraphDB and RDF4J REST API.

"use strict";

function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
function _callSuper(t, o, e) { return o = _getPrototypeOf(o), _possibleConstructorReturn(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], _getPrototypeOf(t).constructor) : o.apply(t, e)); }
function _possibleConstructorReturn(t, e) { if (e && ("object" == _typeof(e) || "function" == typeof e)) return e; if (void 0 !== e) throw new TypeError("Derived constructors may only return object or undefined"); return _assertThisInitialized(t); }
function _assertThisInitialized(e) { if (void 0 === e) throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); return e; }
function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
function _getPrototypeOf(t) { return _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf.bind() : function (t) { return t.__proto__ || Object.getPrototypeOf(t); }, _getPrototypeOf(t); }
function _inherits(t, e) { if ("function" != typeof e && null !== e) throw new TypeError("Super expression must either be null or a function"); t.prototype = Object.create(e && e.prototype, { constructor: { value: t, writable: !0, configurable: !0 } }), Object.defineProperty(t, "prototype", { writable: !1 }), e && _setPrototypeOf(t, e); }
function _setPrototypeOf(t, e) { return _setPrototypeOf = Object.setPrototypeOf ? Object.setPrototypeOf.bind() : function (t, e) { return t.__proto__ = e, t; }, _setPrototypeOf(t, e); }
var Service = require('./service');
var HttpRequestBuilder = require('../http/http-request-builder');
var ServiceRequest = require('./service-request');
var PATH_STATEMENTS = require('./service-paths').PATH_STATEMENTS;
var TermConverter = require('../model/term-converter');
var LoggingUtils = require('../logging/logging-utils');
var FileUtils = require('../util/file-utils');
var MediaType = require('../http/media-type');

/**
 * Service for uploading data streams.
 *
 * @author Mihail Radkov
 * @author Svilen Velikov
 */
var UploadService = /*#__PURE__*/function (_Service) {
  function UploadService() {
    _classCallCheck(this, UploadService);
    return _callSuper(this, UploadService, arguments);
  }
  _inherits(UploadService, _Service);
  return _createClass(UploadService, [{
    key: "upload",
    value:
    /**
     * Executes a POST request against the <code>/statements</code> endpoint. The
     * statements which have to be added are provided through a readable stream.
     * This method is useful for library client who wants to upload a big data set
     * into the repository.
     *
     * @param {ReadableStream} readStream
     * @param {string} contentType is one of RDF mime type formats,
     *                application/x-rdftransaction' for a transaction document or
     *                application/x-www-form-urlencoded
     * @param {NamedNode|string} [context] optional context to restrict the
     * operation. Will be encoded as N-Triple if it is not already one
     * @param {string} [baseURI] optional uri against which any relative URIs
     * found in the data would be resolved.
     *
     * @return {ServiceRequest} a service request that will be resolved when the
     * stream has been successfully consumed by the server
     */
    function upload(readStream, contentType, context, baseURI) {
      var _this = this;
      var requestBuilder = this.getUploadRequest(readStream, contentType, context, baseURI);
      return new ServiceRequest(requestBuilder, function () {
        return _this.httpRequestExecutor(requestBuilder).then(function (response) {
          _this.logger.debug(LoggingUtils.getLogPayload(response, {
            contentType: contentType,
            context: context,
            baseURI: baseURI
          }), 'Uploaded data stream');
        });
      });
    }

    /**
     * Executes a PUT request against the <code>/statements</code> endpoint. The
     * statements which have to be updated are provided through a readable stream.
     * This method is useful for overriding large set of statements that might be
     * provided as a readable stream e.g. reading from file.
     *
     * @param {ReadableStream} readStream
     * @param {string} contentType
     * @param {NamedNode|string} context restrict the operation. Will be encoded
     * as N-Triple if it is not already one
     * @param {string} [baseURI] optional uri against which any relative URIs
     * found in the data would be resolved.
     *
     * @return {ServiceRequest} a service request that will be resolved when the
     * stream has been successfully consumed by the server
     */
  }, {
    key: "overwrite",
    value: function overwrite(readStream, contentType, context, baseURI) {
      var _this2 = this;
      var requestBuilder = this.getOverwriteRequest(readStream, contentType, context, baseURI);
      return new ServiceRequest(requestBuilder, function () {
        return _this2.httpRequestExecutor(requestBuilder).then(function (response) {
          _this2.logger.debug(LoggingUtils.getLogPayload(response, {
            contentType: contentType,
            context: context,
            baseURI: baseURI
          }), 'Overwritten data stream');
        });
      });
    }

    /**
     * Uploads the file specified by the provided file path to the server.
     *
     * See {@link #upload}
     *
     * @param {string} filePath path to a file to be streamed to the server
     * @param {string} contentType MIME type of the file's content
     * @param {string|string[]} [context] restricts the operation to the given
     * context. Will be encoded as N-Triple if it is not already one
     * @param {string} [baseURI] used to resolve relative URIs in the data
     *
     * @return {ServiceRequest} a service request that will be resolved when the
     * file has been successfully consumed by the server
     */
  }, {
    key: "addFile",
    value: function addFile(filePath, contentType, context, baseURI) {
      var _this3 = this;
      var fileStream = FileUtils.getReadStream(filePath);
      var requestBuilder = this.getUploadRequest(fileStream, contentType, context, baseURI);
      return new ServiceRequest(requestBuilder, function () {
        return _this3.httpRequestExecutor(requestBuilder).then(function (response) {
          _this3.logger.debug(LoggingUtils.getLogPayload(response, {
            filePath: filePath,
            contentType: contentType,
            context: context,
            baseURI: baseURI
          }), 'Uploaded file');
        });
      });
    }

    /**
     * Uploads the file specified by the provided file path to the server
     * overwriting any data in the server's repository.
     *
     * The overwrite will be restricted if the context parameter is specified.
     *
     * See {@link #overwrite}
     *
     * @param {string} filePath path to a file to be streamed to the server
     * @param {string} contentType MIME type of the file's content
     * @param {string} [context] restricts the operation to the given context.
     * Will be encoded as N-Triple if it is not already one
     * @param {string} [baseURI] used to resolve relative URIs in the data
     *
     * @return {ServiceRequest} a service request that will be resolved when the
     * file has been successfully consumed by the server
     */
  }, {
    key: "putFile",
    value: function putFile(filePath, contentType, context, baseURI) {
      var _this4 = this;
      var fileStream = FileUtils.getReadStream(filePath);
      var requestBuilder = this.getOverwriteRequest(fileStream, contentType, context, baseURI);
      return new ServiceRequest(requestBuilder, function () {
        return _this4.httpRequestExecutor(requestBuilder).then(function (response) {
          _this4.logger.debug(LoggingUtils.getLogPayload(response, {
            filePath: filePath,
            contentType: contentType,
            context: context,
            baseURI: baseURI
          }), 'Overwritten data from file');
        });
      });
    }

    /**
     * Executes a POST request against the <code>/statements</code> endpoint. The
     * statements which have to be added are provided through a readable stream.
     * This method is useful for library client who wants to upload a big data set
     * into the repository.
     *
     * @private
     *
     * @param {ReadableStream} readStream
     * @param {string} contentType is one of RDF mime type formats,
     *                application/x-rdftransaction' for a transaction document or
     *                application/x-www-form-urlencoded
     * @param {NamedNode|string} [context] optional context to restrict the
     * operation. Will be encoded as N-Triple if it is not already one
     * @param {string} [baseURI] optional uri against which any relative URIs
     * found in the data would be resolved.
     *
     * @return {Promise<HttpResponse|Error>} a promise that will be resolved when
     * the stream has been successfully consumed by the server
     */
  }, {
    key: "getUploadRequest",
    value: function getUploadRequest(readStream, contentType, context, baseURI) {
      return HttpRequestBuilder.httpPut(PATH_STATEMENTS).setData(readStream).addContentTypeHeader(contentType).setResponseType(MediaType.TEXT_PLAIN).setParams({
        baseURI: baseURI,
        context: TermConverter.toNTripleValues(context)
      });
    }

    /**
     * Executes a PUT request against the <code>/statements</code> endpoint. The
     * statements which have to be updated are provided through a readable stream.
     * This method is useful for overriding large set of statements that might be
     * provided as a readable stream e.g. reading from file.
     *
     * @private
     *
     * @param {ReadableStream} readStream
     * @param {string} contentType
     * @param {NamedNode|string} context restrict the operation. Will be encoded
     * as N-Triple if it is not already one
     * @param {string} [baseURI] optional uri against which any relative URIs
     * found in the data would be resolved.
     *
     * @return {Promise<HttpResponse|Error>} a promise that will be resolved when
     * the stream has been successfully consumed by the server
     */
  }, {
    key: "getOverwriteRequest",
    value: function getOverwriteRequest(readStream, contentType, context, baseURI) {
      return HttpRequestBuilder.httpPut(PATH_STATEMENTS).setData(readStream).addContentTypeHeader(contentType).setResponseType('stream').setParams({
        baseURI: baseURI,
        context: TermConverter.toNTripleValues(context)
      });
    }

    /**
     * @inheritDoc
     */
  }, {
    key: "getServiceName",
    value: function getServiceName() {
      return 'UploadService';
    }
  }]);
}(Service);
module.exports = UploadService;