Add LdpRequest constructor() with docstring

dmitrizagidulin · dmitrizagidulin · commit 0c5dc4b05ab5 · 2018-10-04T20:29:26.000-04:00
diff --git a/lib/api/ldp/api.js b/lib/api/ldp/api.js
@@ -56,7 +56,7 @@ class LdpApi {
   async middleware (req, res, next) {
     try {
       // parse target, operation, (optionally) body, preferences, store authn
-      const request = await LdpRequest.from({req, host: this.host})
+      const request = LdpRequest.from({req, host: this.host})
 
       // check that operation is permitted (throws error if not)
       const permissions = await this.acl.allow(request)
diff --git a/lib/api/ldp/ldp-request.js b/lib/api/ldp/ldp-request.js
@@ -3,6 +3,32 @@
 const HttpError = require('standard-http-error')
 
 class LdpRequest {
+  /**
+   * @param options {object}
+   *
+   * @param options.host {SolidHost} Host / config object
+   *
+   * @param options.target {URL} Parsed full request url
+   *
+   * @param options.req {HttpRequest} Save the Express req object, useful
+   *   to access headers/preferences, writeStream for body, etc.
+   *
+   * @param [options.authn=null] {object} Authentication object, contains WebID
+   *   string, as well as any bearer credentials/tokens. Needed for
+   *   authenticated fetch (of remote group ACLs, of Copy resources, etc).
+   *   Null if request is not authenticated.
+   *
+   * @param [options.parsedBody] {?} Request body, parsed when appropriate
+   *   (when content-type is parse-able)
+   */
+  constructor (options) {
+    this.host = options.host
+    this.target = options.target
+    this.req = options.req
+    this.authn = options.authn
+    this.parsedBody = options.parsedBody
+  }
+
   static from ({req, host}) {
     let request
 
@@ -74,7 +100,8 @@ class LdpRequest {
          * Deletes resource or container
          *
          * Throws:
-         * - 404 error if resource does not exist
+         * - 404 error if resource or container does not exist
+         * - 409 Conflict error if deleting a non-empty container
          */
         request = LdpDeleteRequest.from({req, host})
         break
@@ -95,7 +122,8 @@ class LdpRequest {
          *   private resources.
          *
          * Throws:
-         * - 400 Source header required error if Source: header is missing
+         * - 400 'Source header required' error if Source: header is missing
+         * - 404 if source resource is not found
          */
         request = LdpCopyRequest.from({req, host})
         break
