@aj-shadow/z-abs-complayer-documentation-server 0.0.0-aj-beta.221

package/.gitattributes

@@ -0,0 +1,26 @@
+
+# Set the default behavior, in case people don't have core.autocrlf set.
+* text=auto
+
+# Explicitly declare text files you want to always be normalized and converted
+# to native line endings on checkout.
+*.json text
+*.js text
+*.jsx text
+*.txt text
+*.md text
+*.bld text
+*.tsk text
+*.css text
+*.html text
+
+
+# Declare files that will always have CRLF line endings on checkout.
+#*.sln text eol=crlf
+
+# Declare files that will always have LF line endings on checkout.
+#*.txt text eol=lf
+
+# Denote all files that are truly binary and should not be modified.
+*.png binary
+*.jpg binary

package/LICENSE.txt

@@ -0,0 +1,96 @@
+
+LICENSE AGREEMENT
+
+Effective: 1st of November 2020
+This License Agreement is between Licensee and Hagnell Konsulting AB (a company incorporated in Sweden with
+company registration number: 559476-0570) (“Hagnell Konsulting”) and governs the use by Licensee of ActorJs
+(as defined below).
+By installing the Software (as defined below), Licensee agrees to be bound by the terms of this License Agreement.
+
+DEFENITIONS
+ActorJs The test tool developed by Hagnell Konsulting, utilizing the Patent and the Software.
+Derivative Works Any work, whether in source or object code, which is based on the Software and which
+does not constitute a new and independent work pursuant to paragraph 2 of article 4 of
+the Swedish Act (1960:729) on Copyright in Literary and Artistic Works.
+Documentation The manuals and instruction materials furnished by Hagnell Konsulting in connection
+with ActorJs.
+Licensee The physical or legal person to which the License hereunder has been granted by
+Hagnell Konsulting.
+Patent The patent application for a system and method for testing of systems under test, patent
+application number:19218798.7 (European Patent Office).
+Software The software developed and owned by Hagnell Konsulting, identified as ActorJs.
+
+§ 1 - LICENSE
+Licensee is hereby granted a limited, non-exclusive and non-transferable license to use ActorJs (including any
+Derivative Works created by Licensee hereunder) (the “License”). The License is granted subject to the terms and
+conditions set forth below.
+The Software is licensed to Licensee on an open source basis. The License includes the right to create Derivative
+Works pursuant to sub-clause 3 below.
+ActorJs may be used only by Licensee himself/herself/itself, or (if, for instance, Licensee is a company), by the
+employees and consultants of Licensee.
+The License does not include any updates to the Software, or any support services. Notwithstanding the foregoing,
+should Hagnell Konsulting furnish any updates to Licensee, such updates shall be subject to the License granted hereunder.
+As regards the Documentation provided by Hagnell Konsulting, Licensee may use this Documentation for the purpose of
+ the License hereunder (only). Licensee shall not be entitled to distribute copies of the Documentation, or electronically
+ communicate the Documentation, to recipients who are not employees or consultants of Licensee.
+
+§ 2 - LICENSE RESTRICTIONS
+Licensee may not:
+i) Rent, lease, lend, sell, distribute, transfer or otherwise make available ActorJs (and/or a Derivative Work)
+(whether for value or otherwise) to third parties without Hagnell Konsulting´s written approval. Any such approval
+will be subject to the third party acknowledging in writing (vis-à-vis Hagnell Konsulting) that its use of ActorJs
+(and/or the Derivative Work) shall be subject to the terms and conditions of this Agreement.
+
+ii) Distribute copies of the Software (and/or a Derivate Work), or electronically communicate the Software
+(and/or a Derivative Work), to recipients who are not employees or consultants of Licensee.
+
+§ 3 – DERITATIVE WORKS
+Should Licensee, or (if applicable) any of its employees or consultants, create a Derivative Work, Licensee shall
+inform Hagnell Konsulting thereof in writing (an e-mail shall be sufficient). Licensee may use the Derivative Work to the
+same extent as it may use the Software hereunder, but Hagnell Konsulting shall be the sole and exclusive owner of any
+and all rights in the Derivative Work, including the copyright. At the request of Hagnell Konsulting, Licensee and
+Hagnell Konsulting shall formalize the rights transfer in a written contract, which shall, inter alia, confirm that all rights
+in the Derivative Work have been irrevocably transferred to Hagnell Konsulting, that Hagnell Konsulting is be entitled to
+exploit the Derivative Work without limitation in time or any other kind of limitation, that Hagnell Konsulting may transfer
+its rights to the Derivative Work to third parties and that the rights transfer from Licensee to Hagnell Konsulting shall be
+free of charge.
+
+§ 4 – IMPROVEMENTS TO THE PATENT
+Any improvement to the Patent, whether patentable or not, which Licensee, or (if applicable) any of its employees or
+consultants, may discover, create or develop or otherwise have at its disposal, directly or indirectly, without restraints
+as to the use thereof (“Improvements”), shall be disclosed promptly to Hagnell Konsulting and Hagnell Konsulting shall
+have the exclusive right of perpetual duration to use the Improvements as well as to grant the use thereof to other licensees
+in the whole world without compensation to Licensee, except that Licensee shall during the life of this Agreement have
+the non-exclusive right to use such Improvements including corresponding patents, if any, in accordance with the
+provisions of this Agreement. If Licensee decides not to apply for a patent relating to an Improvement made by
+Licensee or if Licensee no longer wishes to maintain such a patent or patent application then Hagnell Konsulting may in its
+sole discretion and at its own expense apply for such a patent or maintain such a patent or patent application (as the
+case may be).
+
+§ 5 - COPYRIGHT AND INTELLECTUAL PROPERTY RIGHTS
+The Software, the Patent and the Documentation are protected by copyright and patent laws and international
+copyright and patent treaties, as well other intellectual property laws and treaties. Any such intellectual property
+rights are owned and especially reserved by Hagnell Konsulting, without limitation. For the avoidance of doubt, no
+ownership rights are transferred to Licensee hereunder.
+“ActorJs” is a registered trademark of Hagnell Konsulting. This Agreement does not include a license to use the
+trademark “ActorJs”.
+
+§ 6 - LIMITITATION ON LIABILITY
+ActorJs is licensed to Licensee “as is”. Hagnell Konsulting gives no guarantees as regards the use, functionality
+or performance of ActorJs and assumes no liability (whatsoever) as regards any defaults in ActorJs or any possible
+infringements on third party statutory or contractual rights. Hagnell Konsulting expressly disclaims any and all warranties
+not expressly given in this Agreement, including any implied warranties of merchantability, satisfactory quality, fitness
+for a particular purpose, title and non-infringement. Thus, the entire risk arising out of any use of ActorJs hereunder
+remains with Licensee.
+The limitation of liability hereunder shall be to the maximum extent permitted by applicable law. Under no
+circumstances shall Hagnell Konsulting be liable for any cost of substitute products or services, for any indirect losses or
+for any consequential damages (including any loss of profits, interruptions or loss of business information).
+
+§ 7 - MISCELLANEOUS
+Licensee may not, either wholly or partly, assign or pledge its rights or obligations under this Agreement to any third
+party without the prior written consent of Hagnell Konsulting.
+
+§ 8 - DISPUTES
+This agreement shall be governed by Swedish law. Any dispute, controversy or claim arising out of or in connection
+with this contract, or the breach, termination or invalidity thereof, shall be settled by the general courts of Sweden,
+with the district court of Stockholm in the first instance. 

package/README.md

@@ -0,0 +1,5 @@
+# README #
+
+# ActorJs
+
+**Library used by @actorjs/actorjs**

package/npm-shrinkwrap.json

@@ -0,0 +1,13 @@
+{
+  "name": "@aj-shadow/z-abs-complayer-documentation-server",
+  "version": "0.0.0-aj-beta.221",
+  "lockfileVersion": 3,
+  "requires": true,
+  "packages": {
+    "": {
+      "name": "@aj-shadow/z-abs-complayer-documentation-server",
+      "version": "0.0.0-aj-beta.221",
+      "license": "SEE LICENSE IN LICENSE.txt"
+    }
+  }
+}

package/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@aj-shadow/z-abs-complayer-documentation-server",
+  "version": "0.0.0-aj-beta.221",
+  "release-step": "delivery",
+  "description": "Library used by @actorjs/actorjs",
+  "author": "ActorJs",
+  "license": "SEE LICENSE IN LICENSE.txt",
+  "repository": "https://gitlab.com/actorjs-shadow-delivery-public/z-abs-complayer-documentation-server.git",
+  "dependencies": {}
+}

package/project/server/_build/Server-CompLayer-Documentation-server.bld

@@ -0,0 +1,12 @@
+{
+  "layer": "Comp",
+  "part": "Documentation-server",
+  "source": {
+     "path": "./project/server",
+	 "filters": ["js"]
+  },
+  "dest": "./dist/Layers/z-abs-complayer-documentation-server/server",
+  "replaceCondition": "(LOG_ENGINE|LOG_ERROR|LOG_DEBUG)\\(.*\\);",
+  "replaceHandle": "\r\n  const logParametersText = match.substring(match.indexOf('(') + 1, match.lastIndexOf(')'));\r\n  const logParameters = logParametersText.split(',');\r\n  if('LOG_ENGINE' === parameters[0]) {\r\n    return `if(Logger.isLogEngine(${logParameters[0].trim()})) {Logger.engine(${logParameters}, __filename);}`;\r\n  }\r\n  else if('LOG_ERROR' === parameters[0]) {\r\n    return `if(Logger.isLogError(${logParameters[0].trim()})) {Logger.error(${logParameters}, __filename);}`;\r\n  }\r\n  else if('LOG_DEBUG' === parameters[0]) {\r\n    return `if(Logger.isLogDebug(${logParameters[0].trim()})) {Logger.debug(${logParameters}, __filename);}`;\r\n  }\r\n",
+  "dependencyNames": []
+}

package/project/server/_build/z-abs-complayer-documentation-server.prj

@@ -0,0 +1,12 @@
+{
+  "builds": [
+    {
+      "name": "Server:CompLayer/Documentation-server",
+      "type": "server",
+      "fileName": "Server-CompLayer-Documentation-server",
+      "requireName": "build-server-js",
+      "repo": "z-abs-complayer-documentation-server",
+      "repoPath": "."
+    }
+  ]
+}

package/project/server/path/actor-path-documentation.js

@@ -0,0 +1,90 @@
+
+'use strict';
+
+const ActorPath = require('z-abs-corelayer-server/server/path/actor-path');
+const Path = require('path');
+
+
+class ActorPathDocumentation {
+  constructor() {
+    this.actorDocumentationPathLocal = ActorPath.setPath(ActorPath.getActorPath(), `${Path.sep}..${Path.sep}Documentation`);
+    if(ActorPath.releaseStepDelivery) {
+      this.actorDocumentationPathGlobal = ActorPath.setPath(ActorPath.getActorPath(), `${Path.sep}node_modules${Path.sep}${ActorPath.organization}`);
+    }
+    else if(ActorPath.releaseStepCandidate) {
+      this.actorDocumentationPathGlobal = ActorPath.setPath(ActorPath.getActorPath(), `${Path.sep}node_modules`);
+    }
+    else {
+      this.actorDocumentationPathGlobal = ActorPath.setPath(ActorPath.getActorPath(), `${Path.sep}..${Path.sep}Documentation`);
+    }
+    this.actorDocumentationGlobalBin = ActorPath.setPath(this.actorDocumentationPathGlobal, `${Path.sep}actorjs-documentation-bin`);
+    this.actorDocumentationGlobalText = ActorPath.setPath(this.actorDocumentationPathGlobal, `${Path.sep}actorjs-documentation-text`);
+    
+    this.actorDocumentationLocalBin = ActorPath.setPath(this.actorDocumentationPathLocal, `${Path.sep}local-documentation-bin`);
+    this.actorDocumentationLocalText = ActorPath.setPath(this.actorDocumentationPathLocal, `${Path.sep}local-documentation-text`);
+  }
+  
+  getDocumentationLocalBin() {
+    return this.actorDocumentationLocalBin;
+  }
+  
+  getDocumentationLocalText() {
+    return this.actorDocumentationLocalText;
+  }
+  
+  getDocumentationReferences(repo) {
+    if(!repo) {
+      return `${this.actorDocumentationGlobalText}${Path.sep}Documentation${Path.sep}documentation-references.json`;
+    }
+    else {
+      return `${this.actorDocumentationLocalText}${Path.sep}Documentation${Path.sep}documentation-references.json`;
+    }
+  }
+  
+  getDocumentationGlobalFolder(documentGroup) {
+    return `${this.actorDocumentationGlobalText}${Path.sep}${documentGroup}`;
+  }
+  
+  getDocumentationLocalFolder(documentGroup) {
+    return `${this.actorDocumentationLocalText}${Path.sep}${documentGroup}`;
+  }
+  
+  getDocumentationNavigationFile(appName, documentGroup, repo) {
+    if(!repo) {
+      return `${this.getDocumentationGlobalFolder(documentGroup)}${Path.sep}Navigation-${documentGroup}-${appName}-global.txt`;
+    }
+    else {
+      return `${this.getDocumentationLocalFolder(documentGroup)}${Path.sep}Navigation-${documentGroup}-${appName}-${repo}.txt`;
+    }
+  }
+  
+  getDocumentationFilePathAndFile(documentGroup, documentName, repo) {
+    const formattedDocumentName = Path.normalize(documentName.replace(new RegExp('[/\\\\]', 'g'), Path.sep));
+    const pathSplit = formattedDocumentName.split(Path.sep);
+    const splitteredDocumentName = pathSplit[pathSplit.length - 1];
+    let splitteredPath = '';
+    if(1 !== pathSplit.length) {
+      pathSplit.splice(pathSplit.length - 1, 1);
+      splitteredPath = pathSplit.join(Path.sep);
+    }
+    if(!repo) {
+      return {
+        path: `${this.actorDocumentationGlobalText}${Path.sep}${documentGroup}${Path.sep}${splitteredPath}`,
+        file: `${this.actorDocumentationGlobalText}${Path.sep}${documentGroup}${Path.sep}${splitteredPath}${Path.sep}Document-global-${splitteredDocumentName}.txt`
+      };
+    }
+    else {
+      return {
+        path: `${this.actorDocumentationLocalText}${Path.sep}${documentGroup}${Path.sep}${splitteredPath}`,
+        file: `${this.actorDocumentationLocalText}${Path.sep}${documentGroup}${Path.sep}${splitteredPath}${Path.sep}Document-${repo}-${splitteredDocumentName}.txt`
+      };
+    }
+  }
+  
+  getDocumentationFile(documentGroup, documentName, repo) {
+    return this.getDocumentationFilePathAndFile(documentGroup, documentName, repo).file;
+  }
+}
+
+
+module.exports = new ActorPathDocumentation();

package/project/server/path/paths/actor-documentation-paths.js

@@ -0,0 +1,102 @@
+
+'use strict';
+
+const ActorPathDocumentation = require('../actor-path-documentation');
+const ActorPathCreator = require('z-abs-corelayer-server/server/path/actor-path-creator');
+const ActorPath = require('z-abs-corelayer-server/server/path/actor-path');
+const Fs = require('fs');
+const Path = require('path');
+
+
+class ActorDocumentationPaths {
+  constructor() {
+    this.folderPaths = [];
+    this.filePaths = [];
+    if(ActorPath.releaseStepDevelopment) {
+      this.folderPaths.push(ActorPathDocumentation.getDocumentationLocalBin());
+      this.folderPaths.push(ActorPathDocumentation.getDocumentationLocalText());
+      this.folderPaths.push(ActorPathDocumentation.getDocumentationLocalFolder('Documentation'));
+      
+      this.filePaths.push({
+        path: `${ActorPathDocumentation.getDocumentationLocalBin()}${Path.sep}.gitattributes`,
+        text: this._getGitAttributes()
+      });
+      this.filePaths.push({
+        path: `${ActorPathDocumentation.getDocumentationLocalBin()}${Path.sep}.gitignore`,
+        text: this._getGitIgnore()
+      });
+      this.filePaths.push({
+        path: `${ActorPathDocumentation.getDocumentationLocalText()}${Path.sep}.gitignore`,
+        text: this._getGitIgnore()
+      });
+      this.filePaths.push({
+        path: ActorPathDocumentation.getDocumentationReferences('repo'),
+        default: []
+      });
+      this.filePaths.push({
+        path: ActorPathDocumentation.getDocumentationNavigationFile('actorjs', 'Documentation', 'local'),
+        default: []
+      });
+    }
+  }
+  
+  verifyOrCreate(done) {
+    new ActorPathCreator(this.folderPaths, this.filePaths).verifyOrCreate(done);
+  }
+  
+  _getGitIgnore() {
+    return '';
+  }
+  
+  _getGitAttributes() {
+    return `
+# Set the default behavior, in case people don't have core.autocrlf set.
+* text=auto
+
+# Explicitly declare text files you want to always be normalized and converted
+# to native line endings on checkout.
+#*.c text
+#*.h text
+
+# Declare files that will always have CRLF line endings on checkout.
+#*.sln text eol=crlf
+
+# Declare files that will always have LF line endings on checkout.
+*.txt text eol=lf
+
+# Denote all files that are truly binary and should not be modified.
+*.png binary
+*.jpg binary
+*.gif binary
+*.bmp binary
+*.tif binary
+*.tiff binary
+*.psd binary
+*.mp4 binary
+*.mkv binary
+*.avi binary
+*.mov binary
+*.vob binary
+*.mp3 binary
+*.aac binary
+*.wav binary
+*.flac binary
+*.ogg binary
+*.mka binary
+*.wma binary
+*.pdf binary
+*.doc binary
+*.xla binary
+*.ppt binary
+*.docx binary
+*.odt binary
+*.zip binary
+*.rar binary
+*.7z binary
+*.tar binary
+*.iso binary
+`;
+  }
+}
+
+module.exports = ActorDocumentationPaths;

package/project/server/plugin-data/documentation/plugin_data_DocumentationAdd.js

@@ -0,0 +1,45 @@
+
+'use strict';
+
+const StackHelper = require('./stack-helper');
+const ActorPathDocumentation = require('../../path/actor-path-documentation');
+const PluginBaseMulti = require('z-abs-corelayer-server/server/plugin-base-multi');
+
+
+// TODO: synchronize access to the file
+class DocumentationAdd extends PluginBaseMulti {
+  constructor() {
+    super(PluginBaseMulti.ADD);
+  }
+  
+  onRequest(repo, documentGroup, documentName, documentData) {
+    const match = documentName ? documentName.match(/^\[\[stack\-[a-z-]+\]\]/) : null;
+    if(!match) {
+      this._save(ActorPathDocumentation.getDocumentationFilePathAndFile(documentGroup, documentName, repo), documentName, documentData);
+    }
+    else {
+      StackHelper.pathAndFile(match, (pathAndFile) => {
+        this._save(pathAndFile, documentName, documentData);
+      });
+    }
+  }
+  
+  _save(pathAndFile, documentName, documentData) {
+    if(null !== pathAndFile) {
+      this.asynchMkdirResponse(pathAndFile.path, (err) => {
+        if(!err) {
+          this.asynchWriteTextFileResponse(pathAndFile.file, documentData);
+        }
+        else {
+          this.responsePartError(`Could not create document path '${documentName}'.`);
+        }
+      }, true);
+    }
+    else {
+      this.responsePartError(`GetStacksObject not registered'.`);
+    }
+  }
+}
+
+
+module.exports = DocumentationAdd;

package/project/server/plugin-data/documentation/plugin_data_DocumentationGet.js

@@ -0,0 +1,147 @@
+
+'use strict';
+
+const StackHelper = require('./stack-helper');
+const ActorPathDocumentation = require('../../path/actor-path-documentation');
+const PluginBaseMulti = require('z-abs-corelayer-server/server/plugin-base-multi');
+const Fs = require('fs');
+
+
+class DocumentationGet extends PluginBaseMulti {
+  constructor() {
+    super(PluginBaseMulti.GET);
+  }
+  
+  onRequest(repo, appName, documentGroup, documentName, embed) {
+    if(!embed) {
+      this._getNavigationAndDocument(repo, appName, documentGroup, documentName);
+    }
+    else {
+      if(Array.isArray(documentName)) {
+        this._getDocuments(repo, documentGroup, documentName, DocumentationGet.NEW_EMBEDED_LINK);
+      }
+      else {
+        this._getDocument(ActorPathDocumentation.getDocumentationFile(documentGroup, documentName, repo), DocumentationGet.NEW_EMBEDED_LINK);
+      }
+    }
+  }
+  
+  _getDocument(document, notFoundText) {
+    const index1 = this.expectAsynchResponse();
+    const index2 = this.expectAsynchResponse();
+    Fs.readFile(document, 'utf8', (err, data) => {
+      if(err) {
+        this.asynchResponseSuccess(index1, notFoundText);
+        this.asynchResponseSuccess(index2, false);
+      }
+      else {
+        this.asynchResponseSuccess(index1, data);
+        this.asynchResponseSuccess(index2, true);
+      }
+    });
+  }
+  
+  _getDocuments(repo, documentGroup, documentNames, notFoundText) {
+    let pendings = documentNames.length;
+    if(0 === pendings) {
+      process.nextTick(this.expectAsynchResponseSuccess.bind(this));
+      return;
+    }
+    const index1 = this.expectAsynchResponse();
+    const index2 = this.expectAsynchResponse();
+    const index3 = this.expectAsynchResponse();
+    const receivedDcuments = [];
+    const documentNamesFound = [];
+    const documentsFound = [];
+    documentNames.forEach((documentName) => {
+      const currentDocumentName = documentName;
+      Fs.readFile(ActorPathDocumentation.getDocumentationFile(documentGroup, documentName, repo), 'utf8', (err, data) => {
+        documentNamesFound.push(currentDocumentName);
+        if(err) {
+          receivedDcuments.push(notFoundText);
+          documentsFound.push(false);
+        }
+        else {
+          receivedDcuments.push(data);
+          documentsFound.push(true);
+        }
+        if(0 === --pendings) {
+          this.asynchResponseSuccess(index1, receivedDcuments);
+          this.asynchResponseSuccess(index2, documentNamesFound);
+          this.asynchResponseSuccess(index3, documentsFound);
+        }
+      });
+    });  
+  }
+  
+  _getNavigationAndDocument(repo, appName, documentGroup, documentName) {
+    const index1 = this.expectAsynchResponse();
+    const match = documentName ? documentName.match(/^\[\[stack\-[a-z-]+\]\]/) : null;
+    Fs.readFile(ActorPathDocumentation.getDocumentationNavigationFile(appName, documentGroup, repo), (err, data) => {
+      if(err) {
+        this.asynchResponseError(`Could not get DocumentationNavigationGlobalFile. '${ActorPathDocumentation.getDocumentationNavigationFile(appName, documentGroup, repo)}'`, index1);
+      }
+      else {
+        const navigations = JSON.parse(data);
+        navigations.findIndex((navigation) => {
+          const refIndex = navigation.refs.findIndex((ref) => {
+            return ref.name === '[[stack]]';
+          });
+          if(-1 !== refIndex) {
+            this._getStackNavigation(navigation, () => {
+              if(documentName && match) {
+                StackHelper.file(match, (file) => {
+                  if(null !== file) {
+                    this._getDocument(file, DocumentationGet.NEW_STACK);
+                  }
+                  else {
+                    this.asynchResponseError(`GetStacksObject not registered'.`, index1);
+                  }
+               });
+              }
+            });
+            return true;
+          }
+          else {
+            return false;
+          }
+        });
+        if(!documentName) {
+          if(0 !== navigations.length && navigations[0].refs.length) {
+            this._getDocument(ActorPathDocumentation.getDocumentationFile(documentGroup, navigations[0].refs[0].link, repo), DocumentationGet.NEW_DOCUMENT);
+          }
+          else {
+            this.expectAsynchResponseSuccess(DocumentationGet.NEW_DOCUMENT);
+            this.expectAsynchResponseSuccess(false);
+          }
+        }
+        this.asynchResponseSuccess(index1, navigations);
+      }
+    });
+    if(documentName && !match) {
+      this._getDocument(ActorPathDocumentation.getDocumentationFile(documentGroup, documentName, repo), DocumentationGet.NEW_DOCUMENT);
+    }
+  }
+  
+  _getStackNavigation(navigation, done) {
+    this.expectAsynchResponseTemp();
+    navigation.refs = [];
+    StackHelper.getStacks((stacks) => {
+      stacks.forEach((value, key) => {
+        navigation.refs.push({
+          name: key,
+          link: `[[stack-${key}]]`
+        });
+      });
+      done();
+      this.unExpectAsynchResponseTemp();
+    });
+  }
+}
+
+DocumentationGet.NEW_DOCUMENT = '# **NEW DOCUMENT**\n## Please Edit: ***`TO BE DONE !!!`***\r\n';
+DocumentationGet.NEW_EMBEDED_LINK = '## **EMBEDED LINK NOT CREATED YET.**\r\n';
+DocumentationGet.NEW_STACK = '## **STACK DOCUMENTATION NOT CREATED YET**\n## Please Edit: ***`TO BE DONE !!!`***\r\n';
+
+
+module.exports = DocumentationGet;

package/project/server/plugin-data/documentation/plugin_data_DocumentationLocalNoteAdd.js

@@ -0,0 +1,27 @@
+
+'use strict';
+
+const ActorPathData = require('z-abs-corelayer-server/server/path/actor-path-data');
+const PluginBaseMulti = require('z-abs-corelayer-server/server/plugin-base-multi');
+
+
+class DocumentationLocalNoteAdd extends PluginBaseMulti {
+  constructor() {
+    super(PluginBaseMulti.ADD);
+  }
+  
+  onRequest(guid, path, document) {
+    let pathAndFile = ActorPathData.getDocumentationNoteLocalFileAndPath(guid, path);
+    this.asynchMkdirResponse(pathAndFile.path, (err) => {
+      if(!err) {
+        this.asynchWriteTextFileResponse(pathAndFile.file, document);
+      }
+      else {
+        this.responsePartError(`Could not create document path '${pathAndFile.file}'.`);
+      }
+    }, true);
+  }
+}
+
+
+module.exports = DocumentationLocalNoteAdd;

package/project/server/plugin-data/documentation/plugin_data_DocumentationLocalNoteDelete.js

@@ -0,0 +1,19 @@
+
+'use strict';
+
+const ActorPathData = require('z-abs-corelayer-server/server/path/actor-path-data');
+const PluginBaseMulti = require('z-abs-corelayer-server/server/plugin-base-multi');
+
+
+class DocumentationLocalNoteDelete extends PluginBaseMulti {
+  constructor() {
+    super(PluginBaseMulti.DELETE);
+  }
+  
+  onRequest(guid, path) {
+    this.asynchRmFileResponse(ActorPathData.getDocumentationNoteLocalFile(guid, path));
+  }
+}
+
+
+module.exports = DocumentationLocalNoteDelete;

package/project/server/plugin-data/documentation/plugin_data_DocumentationLocalNoteGet.js

@@ -0,0 +1,67 @@
+
+'use strict';
+
+const ActorPathData = require('z-abs-corelayer-server/server/path/actor-path-data');
+const PluginBaseMulti = require('z-abs-corelayer-server/server/plugin-base-multi');
+
+
+class DocumentationLocalNoteGet extends PluginBaseMulti {
+  constructor() {
+    super(PluginBaseMulti.GET);
+  }
+  
+  onRequest(guids, path) {
+    if(!Array.isArray(guids)) {
+      this.asynchReadTextFile(ActorPathData.getDocumentationNoteLocalFile(guids, path), (err, data) => {
+        if(!err) {
+          this.expectAsynchResponseSuccess({
+            document: data,
+            created: true,
+            guid: guids
+          });
+        }
+        else {
+          this.expectAsynchResponseSuccess({
+            document: DocumentationLocalNoteGet.NEW_NOTE,
+            created: false,
+            guid: guids
+          });
+        }
+      });
+    }
+    else {
+      let pendings = guids.length;
+      if(0 === pendings) {
+        process.nextTick(this.expectAsynchResponseSuccess.bind(this));
+        return;
+      }
+      const documents = [];
+      guids.forEach((guid) => {
+        this.asynchReadTextFile(ActorPathData.getDocumentationNoteLocalFile(guid, path), (err, data) => {
+          if(!err) {
+            documents.push({
+              document: data,
+              created: true,
+              guid: guid
+            });
+          }
+          else {
+            documents.push({
+              document: DocumentationLocalNoteGet.NEW_NOTE,
+              created: false,
+              guid: guid
+            });
+          }
+          if(0 === --pendings) {
+            this.expectAsynchResponseSuccess(documents);
+          }
+        });
+      });
+    }
+  }
+}
+
+DocumentationLocalNoteGet.NEW_NOTE = '# NEW LOCAL NOTE\n## Please Edit: ***`TO BE DONE !!!`***\r\n';
+
+
+module.exports = DocumentationLocalNoteGet;

package/project/server/plugin-data/documentation/plugin_data_DocumentationLocalNoteUpdate.js

@@ -0,0 +1,19 @@
+
+'use strict';
+
+const ActorPathData = require('z-abs-corelayer-server/server/path/actor-path-data');
+const PluginBaseMulti = require('z-abs-corelayer-server/server/plugin-base-multi');
+
+
+class DocumentationLocalNoteUpdate extends PluginBaseMulti {
+  constructor() {
+    super(PluginBaseMulti.UPDATE);
+  }
+  
+  onRequest(guid, path, document) {
+    this.asynchWriteTextFileResponse(ActorPathData.getDocumentationNoteLocalFile(guid, path), document);
+  }
+}
+
+
+module.exports = DocumentationLocalNoteUpdate;

package/project/server/plugin-data/documentation/plugin_data_DocumentationNavigationsUpdate.js

@@ -0,0 +1,25 @@
+
+'use strict';
+
+const ActorPathDocumentation = require('../../path/actor-path-documentation');
+const PluginBaseMulti = require('z-abs-corelayer-server/server/plugin-base-multi');
+const Fs = require('fs');
+
+
+class DocumentationNavigationsUpdate extends PluginBaseMulti {
+  constructor() {
+    super(PluginBaseMulti.UPDATE);
+  }
+  
+  onRequest(repo, appName, documentGroup, navigations) {
+    Fs.writeFile(ActorPathDocumentation.getDocumentationNavigationFile(appName, documentGroup, repo), JSON.stringify(navigations, null, 2), (err) => {
+      if(err) {
+        return this.responsePartError(`Could not update the Document Navigation File: ' ${ActorPathDocumentation.getDocumentationNavigationFile(appName, documentGroup, repo)} '.`);
+      }
+      return this.responsePartSuccess();
+    });
+  }
+}
+
+
+module.exports = DocumentationNavigationsUpdate;

package/project/server/plugin-data/documentation/plugin_data_DocumentationReferencesGet.js

@@ -0,0 +1,19 @@
+
+'use strict';
+
+const ActorPathDocumentation = require('../../path/actor-path-documentation');
+const PluginBaseMulti = require('z-abs-corelayer-server/server/plugin-base-multi');
+
+
+class DocumentationReferencesGet extends PluginBaseMulti {
+  constructor() {
+    super(PluginBaseMulti.GET);
+  }
+  
+  onRequest(repo) {
+    this.asynchReadFileResponse(ActorPathDocumentation.getDocumentationReferences(repo));
+  }
+}
+
+
+module.exports = DocumentationReferencesGet;

package/project/server/plugin-data/documentation/plugin_data_DocumentationUpdate.js

@@ -0,0 +1,33 @@
+
+'use strict';
+
+const StackHelper = require('./stack-helper');
+const ActorPathDocumentation = require('../../path/actor-path-documentation');
+const PluginBaseMulti = require('z-abs-corelayer-server/server/plugin-base-multi');
+
+
+class DocumentationUpdate extends PluginBaseMulti {
+  constructor() {
+    super(PluginBaseMulti.UPDATE);
+  }
+  
+  onRequest(repo, documentGroup, documentName, documentData) {
+    const match = documentName ? documentName.match(/^\[\[stack\-[a-z-]+\]\]/) : null;
+    if(!match) {
+      this.asynchWriteTextFileResponse(ActorPathDocumentation.getDocumentationFile(documentGroup, documentName, repo), documentData);
+    }
+    else {
+      StackHelper.file(match, (file) => {
+        if(null !== file) {
+          this.asynchWriteTextFileResponse(file, documentData);
+        }
+        else {
+          this.responsePartError(`GetStacksObject not registered'.`);
+        }
+      });
+    }
+  }
+}
+
+
+module.exports = DocumentationUpdate;

package/project/server/plugin-data/documentation/stack-helper.js

@@ -0,0 +1,70 @@
+
+'use strict';
+
+const StackComponentsFactory = require('z-abs-funclayer-stack-server/server/factory/stack-components-factory');
+const ActorPathData = require('z-abs-corelayer-server/server/path/actor-path-data');
+const ActorPathDist = require('z-abs-corelayer-server/server/path/actor-path-dist');
+const Path = require('path');
+
+
+class StackHelper {
+  static file(match, done) {
+    const key = match[0].substring('[[stack-'.length, match[0].length - 2);
+    const path = match.input.substring(match[0].length);
+    StackComponentsFactory.getStacks((stacks) => {
+      const distPath = stacks.get(key).path;
+      let basePath = '';
+      let index = distPath.indexOf(ActorPathDist.getActorDistStacksLocalPath());
+      if(-1 !== index) {
+        basePath = distPath.replace(ActorPathDist.getActorDistStacksLocalPath(), ActorPathData.getStacksLocalFolder());
+      }
+      else {
+        index = distPath.indexOf(ActorPathDist.getActorDistStacksGlobalPath());
+        if(-1 !== index) {
+          basePath = distPath.replace(ActorPathDist.getActorDistStacksGlobalPath(), ActorPathData.getStacksGlobalFolder());
+        }
+        else {
+          // TODO: handle error. 
+        }
+      }
+      if(0 === path.length) {
+        done(`${basePath}${Path.sep}documentation${Path.sep}${key}.md`);
+      }
+      else if(1 === path.length) {
+        if('/' === path[0]) {
+          done(`${basePath}${Path.sep}documentation${Path.sep}${key}.md`);
+        }
+        else {
+          done(`${basePath}${Path.sep}documentation${Path.sep}${key}${path}.md`);
+        }
+      }
+      else {
+        done(`${basePath}${Path.sep}documentation${path.replace(new RegExp('[/\\\\]', 'g'), Path.sep)}.md`);
+      }
+    });
+  }
+  
+  static pathAndFile(match, done) {
+    StackHelper.file(match, (file) => {
+      if(null !== file) {
+        const lastIndex = file.lastIndexOf(Path.sep);
+        done({
+          path: file.substring(0, lastIndex),
+          file: file
+        });
+      }
+      else {
+        done(null);
+      }
+    });
+  }
+  
+  static getStacks(done) {
+    StackComponentsFactory.getStacks((stacks) => {
+      done(stacks);
+    });
+  }
+}
+
+
+module.exports = StackHelper;

package/project/z-abs-complayer-documentation-server.tree

@@ -0,0 +1,21 @@
+7ca0ac1e-9ec1-4426-9280-80e60319b793;;z-abs-complayer-documentation-server;project_folder;.;[actorjs,js,jsx,htm]
+807d7044-db47-4e7e-8104-f32fabbdfd4b;7ca0ac1e-9ec1-4426-9280-80e60319b793;server;static_folder;./z-abs-complayer-documentation-server;[js,jsx,htm]
+b72bbd61-0c1b-4430-862a-461b451da8bc;807d7044-db47-4e7e-8104-f32fabbdfd4b;_build;static_folder;./z-abs-complayer-documentation-server/server;[bld]
+0a18d054-8d8e-4995-be27-e560565fa0ee;b72bbd61-0c1b-4430-862a-461b451da8bc;Server-CompLayer-Documentation-server.bld;file;./z-abs-complayer-documentation-server/server/_build;bld
+6cb6a90c-fee0-47e7-8fb5-61e6a23a9ffe;b72bbd61-0c1b-4430-862a-461b451da8bc;z-abs-complayer-documentation-server.prj;file;./z-abs-complayer-documentation-server/server/_build;prj
+6a27a104-b835-4c95-9c92-56ae98a312b4;807d7044-db47-4e7e-8104-f32fabbdfd4b;path;folder;./z-abs-complayer-documentation-server/server;[js,jsx,htm]
+5cb614d4-19b1-4be8-ba9f-045ac6fad1b1;6a27a104-b835-4c95-9c92-56ae98a312b4;paths;folder;./z-abs-complayer-documentation-server/server/path;[js]
+ce282e58-9337-4534-8a77-3578f6e6c41f;5cb614d4-19b1-4be8-ba9f-045ac6fad1b1;actor-documentation-paths.js;file;./z-abs-complayer-documentation-server/server/path/paths;js
+c330e0a1-c5d2-4fdf-bde9-30ff2348e9bc;6a27a104-b835-4c95-9c92-56ae98a312b4;actor-path-documentation.js;file;./z-abs-complayer-documentation-server/server/path;js
+bfb9c213-798e-4e32-ac4c-15055cee7d5b;807d7044-db47-4e7e-8104-f32fabbdfd4b;plugin-data;folder;./z-abs-complayer-documentation-server/server;[js,jsx,htm]
+c60049ec-7e59-4dce-b5b7-f99ce137d73b;bfb9c213-798e-4e32-ac4c-15055cee7d5b;documentation;folder;./z-abs-complayer-documentation-server/server/plugin-data;[js,jsx,htm]
+a0ae5d49-3fb9-4413-af67-46edcedfc002;c60049ec-7e59-4dce-b5b7-f99ce137d73b;plugin_data_DocumentationAdd.js;file;./z-abs-complayer-documentation-server/server/plugin-data/documentation;js
+1d7e387a-9826-4292-9c22-424542969c7c;c60049ec-7e59-4dce-b5b7-f99ce137d73b;plugin_data_DocumentationGet.js;file;./z-abs-complayer-documentation-server/server/plugin-data/documentation;js
+9ac3d9ed-c7bd-4755-8f4a-d5b34b062dd0;c60049ec-7e59-4dce-b5b7-f99ce137d73b;plugin_data_DocumentationLocalNoteAdd.js;file;./z-abs-complayer-documentation-server/server/plugin-data/documentation;js
+79938099-ddc1-45e0-8d80-639932282cdf;c60049ec-7e59-4dce-b5b7-f99ce137d73b;plugin_data_DocumentationLocalNoteDelete.js;file;./z-abs-complayer-documentation-server/server/plugin-data/documentation;js
+a5ea02cd-a145-4512-b2ff-1a169ade0808;c60049ec-7e59-4dce-b5b7-f99ce137d73b;plugin_data_DocumentationLocalNoteGet.js;file;./z-abs-complayer-documentation-server/server/plugin-data/documentation;js
+59bb477e-82f4-4182-bf9d-0d384e31be58;c60049ec-7e59-4dce-b5b7-f99ce137d73b;plugin_data_DocumentationLocalNoteUpdate.js;file;./z-abs-complayer-documentation-server/server/plugin-data/documentation;js
+ac33c7ab-0df7-40f1-a9be-bdae3917609a;c60049ec-7e59-4dce-b5b7-f99ce137d73b;plugin_data_DocumentationNavigationsUpdate.js;file;./z-abs-complayer-documentation-server/server/plugin-data/documentation;js
+3dbd6477-608f-4525-89e5-3e4717f4faa6;c60049ec-7e59-4dce-b5b7-f99ce137d73b;plugin_data_DocumentationReferencesGet.js;file;./z-abs-complayer-documentation-server/server/plugin-data/documentation;js
+7a41a188-a866-4a27-80bb-31951a1bd959;c60049ec-7e59-4dce-b5b7-f99ce137d73b;plugin_data_DocumentationUpdate.js;file;./z-abs-complayer-documentation-server/server/plugin-data/documentation;js
+2654effe-be7f-47f1-b817-031acd00de00;c60049ec-7e59-4dce-b5b7-f99ce137d73b;stack-helper.js;file;./z-abs-complayer-documentation-server/server/plugin-data/documentation;js