[INTERNAL] JSDoc: Make API private by default

.eslintrc.js

@@ -7,6 +7,9 @@ module.exports = {
         "ecmaVersion": 8
     },
     "extends": ["eslint:recommended", "google"],
+    "plugins": [
+        "jsdoc"
+    ],
     "rules": {
         "indent": [
             "error",
@@ -35,15 +38,32 @@ module.exports = {
         ],
         "comma-dangle": "off",
         "no-tabs": "off",
-        'valid-jsdoc': [
-            2,
-            {
-                requireParamDescription: false,
-                requireReturnDescription: false,
-                requireReturn: false,
-                prefer: {return: 'returns'},
+        "valid-jsdoc": 0,
+        "jsdoc/check-examples": 2,
+        "jsdoc/check-param-names": 2,
+        "jsdoc/check-tag-names": 2,
+        "jsdoc/check-types": 2,
+        "jsdoc/newline-after-description": 2,
+        "jsdoc/no-undefined-types": 0,
+        "jsdoc/require-description": 0,
+        "jsdoc/require-description-complete-sentence": 0,
+        "jsdoc/require-example": 0,
+        "jsdoc/require-hyphen-before-param-description": 0,
+        "jsdoc/require-param": 2,
+        "jsdoc/require-param-description": 0,
+        "jsdoc/require-param-name": 2,
+        "jsdoc/require-param-type": 2,
+        "jsdoc/require-returns": 0,
+        "jsdoc/require-returns-description": 0,
+        "jsdoc/require-returns-type": 2,
+        "jsdoc/valid-types": 0
+    },
+    "settings": {
+        "jsdoc": {
+            "tagNamePreference": {
+                "return": "returns"
             }
-        ],
+        }
     },
     "root": true
 };

index.js

@@ -1,4 +1,8 @@
-const ui5Server = {
+/**
+ * @module @ui5/server
+ * @public
+ */
+module.exports = {
 	server: require("./lib/server"),
 	sslUtil: require("./lib/sslUtil"),
 	middleware: {
@@ -11,5 +15,3 @@ const ui5Server = {
 		versionInfo: require("./lib/middleware/versionInfo"),
 	}
 };
-
-module.exports = ui5Server;

jsdoc.json

@@ -1,9 +1,9 @@
 {
     "tags": {
-        "allowUnknownTags": true
+        "allowUnknownTags": false
     },
     "source": {
-        "include": ["README.md"],
+        "include": ["README.md", "index.js"],
         "includePattern": ".+\\.js$",
         "excludePattern": "(node_modules(\\\\|/))"
     },
@@ -13,10 +13,48 @@
         "encoding": "utf8",
         "destination": "jsdocs/",
         "recurse": true,
-        "verbose": true
+        "verbose": true,
+        "access": "public"
     },
     "templates": {
         "cleverLinks": false,
-        "monospaceLinks": false
+        "monospaceLinks": false,
+        "default": {
+            "useLongnameInNav": true
+        }
+    },
+    "openGraph": {
+        "title": "UI5 Build and Development Tooling - API Reference",
+        "type": "website",
+        "image": "https://sap.github.io/ui5-tooling/docs/images/UI5_logo_wide.png",
+        "site_name": "UI5 Build and Development Tooling - API Reference",
+        "url": "https://sap.github.io/ui5-tooling/"
+    },
+    "docdash": {
+        "sectionOrder": [
+            "Modules",
+            "Namespaces",
+            "Classes",
+            "Externals",
+            "Events",
+            "Mixins",
+            "Tutorials",
+            "Interfaces"
+        ],
+        "meta": {
+            "title": "UI5 Build and Development Tooling - API Reference - UI5 Server",
+            "description": "UI5 Build and Development Tooling - API Reference - UI5 Server",
+            "keyword": "openui5 sapui5 ui5 build development tool api reference"
+        },
+        "search": true,
+        "wrap": true,
+        "menu": {
+            "GitHub": {
+                "href": "https://github.com/SAP/ui5-server",
+                "target": "_blank",
+                "class": "menu-item",
+                "id": "github_link"
+            }
+        }
     }
 }

lib/middleware/discovery.js

@@ -12,11 +12,11 @@ const urlPattern = /\/(app_pages|all_libs|all_tests)(?:[?#].*)?$/;
  * <li>/discovery/all_tests: list all tests</li>
  * </ul>
  *
- * @module server/middleware/discovery
+ * @module @ui5/server/middleware/discovery
  * @param {Object} resourceCollections Contains the resource reader or collection to access project related files
- * @param {AbstractReader} resourceCollections.source Resource reader or collection for the source project
- * @param {AbstractReader} resourceCollections.combo Resource collection which contains the workspace and the project dependencies
- * @returns {function} Returns a server middleware closure.
+ * @param {module:@ui5/fs.AbstractReader} resourceCollections.source Resource reader or collection for the source project
+ * @param {module:@ui5/fs.AbstractReader} resourceCollections.combo Resource collection which contains the workspace and the project dependencies
+ * @returns {Function} Returns a server middleware closure.
  */
 function createMiddleware({resourceCollections}) {
 	return function discoveryMiddleware(req, res, next) {

lib/middleware/nonReadRequests.js

@@ -4,8 +4,8 @@
  * Handles non read requests (POST, PUT, DELETE...) and returns an error 404,
  * because those operations aren't supported by the server.
  *
- * @module server/middleware/nonReadRequests
- * @returns {function} Returns a server middleware closure.
+ * @module @ui5/server/middleware/nonReadRequests
+ * @returns {Function} Returns a server middleware closure.
  */
 function createMiddleware() {
 	return function nonReadRequests(req, res, next) {

lib/middleware/serveIndex.js

@@ -10,8 +10,8 @@ const GB = KB * KB * KB;
 /**
  * Returns the mime type of the given resource
  *
- * @param {Resource} resource the resource
- * @returns {String} mime type
+ * @param {module:@ui5/fs.Resource} resource the resource
+ * @returns {string} mime type
  */
 function getMimeType(resource) {
 	if (rProperties.test(resource.getPath())) {
@@ -24,8 +24,8 @@ function getMimeType(resource) {
 /**
  * Converts the given bytes into a proper human readable size
  *
- * @param {Number} bytes bytes
- * @returns {String} human readable size
+ * @param {number} bytes bytes
+ * @returns {string} human readable size
  */
 function formatSize(bytes) {
 	let result;
@@ -45,7 +45,7 @@ function formatSize(bytes) {
  * Creates a resource info object which is used to create the HTML
  * content for the resource listing
  *
- * @param {Resource} resource the resource to convert
+ * @param {module:@ui5/fs.Resource} resource the resource to convert
  * @returns {Object} resource info object
  */
 function createResourceInfo(resource) {
@@ -69,7 +69,7 @@ function createResourceInfo(resource) {
 /**
  * Creates a resource info array from the given resource array
  *
- * @param {Resource[]} resources an array of resources
+ * @param {module:@ui5/fs.Resource[]} resources an array of resources
  * @returns {Object[]} sorted array of resource infos
  */
 function createResourceInfos(resources) {
@@ -90,9 +90,9 @@ function createResourceInfos(resources) {
 /**
  * Creates the HTML content for the resource listing
  *
- * @param {String} path the path
+ * @param {string} path the path
  * @param {Object[]} resourceInfos an array of resource infos
- * @returns {String} HTML content for the resource listing
+ * @returns {string} HTML content for the resource listing
  */
 function createContent(path, resourceInfos) {
 	return `<!DOCTYPE html>
@@ -131,10 +131,10 @@ function createContent(path, resourceInfos) {
 /**
  * Creates and returns the middleware to serve a resource index.
  *
- * @module server/middleware/serveIndex
+ * @module @ui5/server/middleware/serveIndex
  * @param {Object} resourceCollections Contains the resource reader or collection to access project related files
- * @param {AbstractReader} resourceCollections.combo Resource collection which contains the workspace and the project dependencies
- * @returns {function} Returns a server middleware closure.
+ * @param {module:@ui5/fs.AbstractReader} resourceCollections.combo Resource collection which contains the workspace and the project dependencies
+ * @returns {Function} Returns a server middleware closure.
  */
 function createMiddleware({resourceCollections}) {
 	return function serveIndex(req, res, next) {

lib/middleware/serveResources.js

@@ -17,10 +17,10 @@ function isFresh(req, res) {
 /**
  * Creates and returns the middleware to serve application resources.
  *
- * @module server/middleware/serveResources
+ * @module @ui5/server/middleware/serveResources
  * @param {Object} resourceCollections Contains the resource reader or collection to access project related files
- * @param {AbstractReader} resourceCollections.combo Resource collection which contains the workspace and the project dependencies
- * @returns {function} Returns a server middleware closure.
+ * @param {module:@ui5/fs.AbstractReader} resourceCollections.combo Resource collection which contains the workspace and the project dependencies
+ * @returns {Function} Returns a server middleware closure.
  */
 function createMiddleware({resourceCollections}) {
 	return function serveResources(req, res, next) {

lib/middleware/serveThemes.js

@@ -16,10 +16,10 @@ const themeRequest = /^(.*\/)library(?:(\.css)|(-RTL\.css)|(-parameters\.json))$
  *
  * The theme is built in realtime. If a less file was modified, the theme build is triggered to rebuild the theme.
  *
- * @module server/middleware/serveThemes
+ * @module @ui5/server/middleware/serveThemes
  * @param {Object} resourceCollections Contains the resource reader or collection to access project related files
- * @param {AbstractReader} resourceCollections.combo Resource collection which contains the workspace and the project dependencies
- * @returns {function} Returns a server middleware closure.
+ * @param {module:@ui5/fs.AbstractReader} resourceCollections.combo Resource collection which contains the workspace and the project dependencies
+ * @returns {Function} Returns a server middleware closure.
  */
 function createMiddleware({resourceCollections}) {
 	const builder = new themeBuilder.ThemeBuilder({

lib/middleware/versionInfo.js

@@ -3,10 +3,10 @@ const createVersionInfoProcessor = require("@ui5/builder").processors.versionInf
 /**
  * Creates and returns the middleware to create the version info as json object.
  *
- * @module server/middleware/versionInfo
+ * @module @ui5/server/middleware/versionInfo
  * @param {Object} resourceCollections Contains the resource reader or collection to access project related files
- * @param {AbstractReader} resourceCollections.dependencies Resource collection which contains the project dependencies
- * @returns {function} Returns a server middleware closure.
+ * @param {module:@ui5/fs.AbstractReader} resourceCollections.dependencies Resource collection which contains the project dependencies
+ * @returns {Function} Returns a server middleware closure.
  */
 function createMiddleware({resourceCollections, tree: project}) {
 	return function versionInfo(req, res, next) {