@into-cps-association/libms 0.4.3 → 0.4.5

package/.env

@@ -0,0 +1,6 @@
+PORT='4001'
+MODE='local'
+LOCAL_PATH ='/home/dtaas/Documents/git/into-cps/DTaaS/files'
+LOG_LEVEL='debug'
+APOLLO_PATH='/lib'
+GRAPHQL_PLAYGROUND='true'

package/DEVELOPER.md

@@ -37,16 +37,47 @@ APOLLO_PATH='/lib'
 GRAPHQL_PLAYGROUND='true'
 ```
 
-## :package: :ship: NPM package
+## Service Endpoint
+
+The URL endpoint for this microservice is located at: `localhost:PORT/lib`
+
+The [API](./API.md) page shows sample queries and responses.
+
+## :package: :ship: Packages
+
+### Docker images
+
+The docker version of lib microservice is packaged with the DTaaS
+application release.
+Please see [publishing](../../docker/README.md) page
+for more information publishing docker images.
+
+### Default NPM Registry
+
+The default registry for npm packages is [npmjs](https://registry.npmjs.org).
+
+```bash
+sudo npm install -g @into-cps-association/libms
+```
+
+The steps for publishing the package to npmjs are listed in
+[npm packages](../../docs/developer/npm-packages.md) page.
 
-### Github Package Registry
+The libms is also published on this registry, usually per release
+of the DTaaS application. The package on npmjs is more stable
+than the package on github npm registry.
+
+### Github NPM Package Registry
 
 The Github actions workflow of
 [lib microservice](../../.github/workflows/lib-ms.yml) publishes the **libms**
 into
 [packages](https://github.com/orgs/INTO-CPS-Association/packages?repo_name=DTaaS).
 
-### Verdaccio - Local Package Registry
+A new libmspackage is published to github packages for each version
+of libms microservice.
+
+### Verdaccio - Local NPM Package Registry
 
 Use the instructions in
 [publish npm package](../../docs/developer/npm-packages.md) for help
@@ -69,9 +100,3 @@ yarn publish #increments version, publishes to registry and adds a git tag
 ```bash
 npm unpublish  --registry http://localhost:4873/ @into-cps-association/libms@0.2.0
 ```
-
-## Service Endpoint
-
-The URL endpoint for this microservice is located at: `localhost:PORT/lib`
-
-The [API](./API.md) page shows sample queries and responses.

package/HTTP.md

@@ -0,0 +1,12 @@
+# HTTP File Server
+
+Endpoint: `localhost:PORT/lib/files`
+
+This option needs to be enabled with `-H http.json` flag.
+If enabled, the 'localhost:PORT/lib/files' becomes available.
+The regular file upload and download options become available.
+Here are sample screenshots.
+
+![top-level](top-level.png)
+
+![inside](inside.png)

package/README.md

@@ -8,7 +8,23 @@ It has two features:
 
 ## :arrow_down: Install
 
-The package is available in Github
+### Default NPM Registry
+
+The default registry for npm packages is [npmjs](https://registry.npmjs.org).
+Install the package with the following commands
+
+```bash
+sudo npm install -g @into-cps-association/libms
+```
+
+The package on [npmjs](https://registry.npmjs.org) is published
+less frequently than the one on Github NPM Registry. But
+the package on npmjs is more stable version of libms and should
+be used for production purposes.
+
+### Github NPM Registry
+
+The package is also available in Github
 [packages registry](https://github.com/orgs/INTO-CPS-Association/packages).
 
 Set the registry and install the package with the following commands
@@ -40,10 +56,10 @@ GRAPHQL_PLAYGROUND='false' or 'true'
 
 The `LOCAL_PATH` variable is the absolute filepath to the
 location of the local directory which will be served to users
-by the Library microservice. This
-[sample configuration file](./config/.env.default) can be used.
+by the Library microservice.
 
 Replace the default values the appropriate values for your setup.
+Please save this config in a file.
 
 ## :rocket: Use
 
@@ -105,14 +121,276 @@ libms -H FILE-PATH
 libms --http FILE-PATH
 ```
 
-A sample configuration is [available](./config/http.json).
+<details>
+<summary>Please see this sample HTTP config file</summary>
+
+```json
+{
+  "name": "DTaaS Fileserver",
+  "auth": false,
+  "editor": "edward",
+  "packer": "zip",
+  "diff": true,
+  "zip": true,
+  "buffer": true,
+  "dirStorage": true,
+  "online": false,
+  "open": false,
+  "oneFilePanel": true,
+  "keysPanel": false,
+  "prefix": "/lib/files",
+  "confirmCopy": true,
+  "confirmMove": true,
+  "showConfig": false,
+  "showFileName": true,
+  "contact": false,
+  "configDialog": false,
+  "console": false,
+  "terminal": false,
+  "vim": false,
+  "columns": "name-size-date-owner-mode",
+  "export": false,
+  "import": false,
+  "dropbox": false,
+  "dropboxToken": "",
+  "log": true
+}
+```
+
+</details>
+
+## Application Programming Interface (API)
+
+The lib microservice application provides services at
+two end points:
+
+### HTTP protocol
+
+Endpoint: `localhost:PORT/lib/files`
+
+This option needs to be enabled with `-H http.json` flag.
+The regular file upload and download options become available.
+
+### GraphQL protocol
+
+Endpoint: `localhost:PORT/lib`
+
+<details>
+<summary>GraphQL API details</summary>
+The lib microservice takes two distinct GraphQL queries.
+
+#### Directory Listing
+
+This query receives directory path and provides list of files
+in that directory. A sample query and response are given here.
+
+``` graphql
+query {
+  listDirectory(path: "user1") {
+    repository {
+      tree {
+        blobs {
+          edges {
+            node {
+              name
+              type
+            }
+          }
+        }
+        trees {
+          edges {
+            node {
+              name
+              type
+            }
+          }
+        }
+      }
+    }
+  }
+}
+```
+
+``` graphql
+{
+  "data": {
+    "listDirectory": {
+      "repository": {
+        "tree": {
+          "blobs": {
+            "edges": []
+          },
+          "trees": {
+            "edges": [
+              {
+                "node": {
+                  "name": "common",
+                  "type": "tree"
+                }
+              },
+              {
+                "node": {
+                  "name": "data",
+                  "type": "tree"
+                }
+              },
+              {
+                "node": {
+                  "name": "digital twins",
+                  "type": "tree"
+                }
+              },
+              {
+                "node": {
+                  "name": "functions",
+                  "type": "tree"
+                }
+              },
+              {
+                "node": {
+                  "name": "models",
+                  "type": "tree"
+                }
+              },
+              {
+                "node": {
+                  "name": "tools",
+                  "type": "tree"
+                }
+              }
+            ]
+          }
+        }
+      }
+    }
+  }
+}
+```
+
+#### Fetch a File
+
+This query receives directory path and send the file contents to user in response.
+
+To check this query, create a file `files/user2/data/welcome.txt`
+with content of `hello world`.
+
+A sample query and response are given here.
+
+```graphql
+query {
+  readFile(path: "user2/data/sample.txt") {
+    repository {
+      blobs {
+        nodes {
+          name
+          rawBlob
+          rawTextBlob
+        }
+      }
+    }
+  }
+}
+```
+
+```graphql
+{
+  "data": {
+    "readFile": {
+      "repository": {
+        "blobs": {
+          "nodes": [
+            {
+              "name": "sample.txt",
+              "rawBlob": "hello world",
+              "rawTextBlob": "hello world"
+            }
+          ]
+        }
+      }
+    }
+  }
+}
+```
+
+### Direct HTTP API Calls in lieu of GraphQL API Calls
+
+The lib microservice also supports making API calls using HTTP POST requests.
+Simply send a POST request to the URL endpoint with the GraphQL query in
+the request body. Make sure to set the Content-Type header to
+"application/json".
+
+The easiest way to perform HTTP requests is to use
+[HTTPie](https://github.com/httpie/desktop/releases)
+desktop application.
+You can download the Ubuntu AppImage and run it. Select the following options:
+
+```txt
+Method: POST
+URL: localhost:4001
+Body: <<copy the json code from examples below>>
+Content Type: text/json
+```
+
+Here are examples of the HTTP requests and responses for the HTTP API calls.
+
+#### Directory listing
 
-### Accessible URLs
+<!-- markdownlint-disable MD013 -->
 
-The microservice is available at:
+```http
+POST /lib HTTP/1.1
+Host: localhost:4001
+Content-Type: application/json
+Content-Length: 388
 
-**GraphQL protocol**: 'localhost:PORT/lib'
-**HTTP protocol**: 'localhost:PORT/lib/files'
+{
+   "query":"query {\n  listDirectory(path: \"user1\") {\n    repository {\n      tree {\n        blobs {\n          edges {\n            node {\n              name\n              type\n            }\n          }\n        }\n        trees {\n          edges {\n            node {\n              name\n              type\n            }\n          }\n        }\n      }\n    }\n  }\n}"
+}
+```
+
+This HTTP POST request will generate the following HTTP response message.
+
+```http
+HTTP/1.1 200 OK
+Access-Control-Allow-Origin: *
+Connection: close
+Content-Length: 306
+Content-Type: application/json; charset=utf-8
+Date: Tue, 26 Sep 2023 20:26:49 GMT
+X-Powered-By: Express
+
+{"data":{"listDirectory":{"repository":{"tree":{"blobs":{"edges":[]},"trees":{"edges":[{"node":{"name":"data","type":"tree"}},{"node":{"name":"digital twins","type":"tree"}},{"node":{"name":"functions","type":"tree"}},{"node":{"name":"models","type":"tree"}},{"node":{"name":"tools","type":"tree"}}]}}}}}}
+```
+
+#### Fetch a file
+
+This query receives directory path and send the file contents to user in response.
+
+To check this query, create a file `files/user2/data/welcome.txt`
+with content of `hello world`.
+
+```http
+POST /lib HTTP/1.1
+Host: localhost:4001
+Content-Type: application/json
+Content-Length: 217
+
+{
+   "query":"query {\n  readFile(path: \"user2/data/welcome.txt\") {\n    repository {\n      blobs {\n        nodes {\n          name\n          rawBlob\n          rawTextBlob\n        }\n      }\n    }\n  }\n}"
+}
+```
+
+```http
+HTTP/1.1 200 OK
+Access-Control-Allow-Origin: *
+Connection: close
+Content-Length: 134
+Content-Type: application/json; charset=utf-8
+Date: Wed, 27 Sep 2023 09:17:18 GMT
+X-Powered-By: Express
+
+{"data":{"readFile":{"repository":{"blobs":{"nodes":[{"name":"welcome.txt","rawBlob":"hello world","rawTextBlob":"hello world"}]}}}}}
+```
 
-<!-- markdownlint-disable-next-line MD013 -->
-The [API](https://into-cps-association.github.io/DTaaS/development/user/servers/lib/LIB-MS.html) page shows sample queries and responses.
+<!-- markdownlint-enable MD013 -->
+</details>

package/config/.env.default

@@ -1,6 +1,6 @@
 PORT='4001'
 MODE='local'
-LOCAL_PATH ='/Users/<Username>/DTaaS/files'
+LOCAL_PATH ='/dtaas/libms/files'
 LOG_LEVEL='debug'
 APOLLO_PATH='/lib'
 GRAPHQL_PLAYGROUND='true'

package/coverage/clover.xml

@@ -0,0 +1,162 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<coverage generated="1717597601385" clover="3.2.0">
+  <project timestamp="1717597601385" name="All files">
+    <metrics statements="120" coveredstatements="89" conditionals="8" coveredconditionals="2" methods="23" coveredmethods="21" elements="151" coveredelements="112" complexity="0" loc="120" ncloc="120" packages="5" files="7" classes="7"/>
+    <package name="src">
+      <metrics statements="56" coveredstatements="38" conditionals="6" coveredconditionals="0" methods="7" coveredmethods="6"/>
+      <file name="bootstrap.ts" path="/home/dtaas/Documents/git/into-cps/DTaaS/servers/lib/src/bootstrap.ts">
+        <metrics statements="18" coveredstatements="0" conditionals="6" coveredconditionals="0" methods="1" coveredmethods="0"/>
+        <line num="1" count="0" type="stmt"/>
+        <line num="2" count="0" type="stmt"/>
+        <line num="3" count="0" type="stmt"/>
+        <line num="4" count="0" type="stmt"/>
+        <line num="5" count="0" type="stmt"/>
+        <line num="13" count="0" type="stmt"/>
+        <line num="14" count="0" type="stmt"/>
+        <line num="18" count="0" type="cond" truecount="0" falsecount="1"/>
+        <line num="20" count="0" type="stmt"/>
+        <line num="21" count="0" type="cond" truecount="0" falsecount="2"/>
+        <line num="22" count="0" type="stmt"/>
+        <line num="24" count="0" type="stmt"/>
+        <line num="28" count="0" type="stmt"/>
+        <line num="29" count="0" type="stmt"/>
+        <line num="30" count="0" type="stmt"/>
+        <line num="32" count="0" type="cond" truecount="0" falsecount="1"/>
+        <line num="33" count="0" type="stmt"/>
+        <line num="36" count="0" type="stmt"/>
+      </file>
+      <file name="types.ts" path="/home/dtaas/Documents/git/into-cps/DTaaS/servers/lib/src/types.ts">
+        <metrics statements="38" coveredstatements="38" conditionals="0" coveredconditionals="0" methods="6" coveredmethods="6"/>
+        <line num="1" count="3" type="stmt"/>
+        <line num="4" count="3" type="stmt"/>
+        <line num="6" count="3" type="stmt"/>
+        <line num="9" count="3" type="stmt"/>
+        <line num="13" count="3" type="stmt"/>
+        <line num="14" count="3" type="stmt"/>
+        <line num="15" count="3" type="stmt"/>
+        <line num="19" count="3" type="stmt"/>
+        <line num="20" count="3" type="stmt"/>
+        <line num="21" count="3" type="stmt"/>
+        <line num="25" count="3" type="stmt"/>
+        <line num="27" count="3" type="stmt"/>
+        <line num="30" count="3" type="stmt"/>
+        <line num="34" count="3" type="stmt"/>
+        <line num="35" count="3" type="stmt"/>
+        <line num="36" count="3" type="stmt"/>
+        <line num="40" count="3" type="stmt"/>
+        <line num="41" count="3" type="stmt"/>
+        <line num="42" count="3" type="stmt"/>
+        <line num="46" count="3" type="stmt"/>
+        <line num="48" count="3" type="stmt"/>
+        <line num="51" count="3" type="stmt"/>
+        <line num="55" count="3" type="stmt"/>
+        <line num="57" count="3" type="stmt"/>
+        <line num="60" count="3" type="stmt"/>
+        <line num="63" count="3" type="stmt"/>
+        <line num="66" count="3" type="stmt"/>
+        <line num="67" count="3" type="stmt"/>
+        <line num="68" count="3" type="stmt"/>
+        <line num="72" count="3" type="stmt"/>
+        <line num="74" count="3" type="stmt"/>
+        <line num="77" count="3" type="stmt"/>
+        <line num="80" count="3" type="stmt"/>
+        <line num="81" count="3" type="stmt"/>
+        <line num="82" count="3" type="stmt"/>
+        <line num="86" count="3" type="stmt"/>
+        <line num="88" count="3" type="stmt"/>
+        <line num="91" count="3" type="stmt"/>
+      </file>
+    </package>
+    <package name="src.cloudcmd">
+      <metrics statements="11" coveredstatements="0" conditionals="0" coveredconditionals="0" methods="1" coveredmethods="0"/>
+      <file name="cloudcmd.ts" path="/home/dtaas/Documents/git/into-cps/DTaaS/servers/lib/src/cloudcmd/cloudcmd.ts">
+        <metrics statements="11" coveredstatements="0" conditionals="0" coveredconditionals="0" methods="1" coveredmethods="0"/>
+        <line num="2" count="0" type="stmt"/>
+        <line num="3" count="0" type="stmt"/>
+        <line num="4" count="0" type="stmt"/>
+        <line num="6" count="0" type="stmt"/>
+        <line num="11" count="0" type="stmt"/>
+        <line num="12" count="0" type="stmt"/>
+        <line num="16" count="0" type="stmt"/>
+        <line num="18" count="0" type="stmt"/>
+        <line num="20" count="0" type="stmt"/>
+        <line num="23" count="0" type="stmt"/>
+        <line num="32" count="0" type="stmt"/>
+      </file>
+    </package>
+    <package name="src.files">
+      <metrics statements="5" coveredstatements="5" conditionals="0" coveredconditionals="0" methods="0" coveredmethods="0"/>
+      <file name="files.module.ts" path="/home/dtaas/Documents/git/into-cps/DTaaS/servers/lib/src/files/files.module.ts">
+        <metrics statements="5" coveredstatements="5" conditionals="0" coveredconditionals="0" methods="0" coveredmethods="0"/>
+        <line num="1" count="1" type="stmt"/>
+        <line num="2" count="1" type="stmt"/>
+        <line num="3" count="1" type="stmt"/>
+        <line num="4" count="1" type="stmt"/>
+        <line num="9" count="1" type="stmt"/>
+      </file>
+    </package>
+    <package name="src.files.resolvers">
+      <metrics statements="11" coveredstatements="11" conditionals="0" coveredconditionals="0" methods="5" coveredmethods="5"/>
+      <file name="files.resolver.ts" path="/home/dtaas/Documents/git/into-cps/DTaaS/servers/lib/src/files/resolvers/files.resolver.ts">
+        <metrics statements="11" coveredstatements="11" conditionals="0" coveredconditionals="0" methods="5" coveredmethods="5"/>
+        <line num="1" count="3" type="stmt"/>
+        <line num="3" count="3" type="stmt"/>
+        <line num="4" count="3" type="stmt"/>
+        <line num="7" count="3" type="stmt"/>
+        <line num="11" count="9" type="stmt"/>
+        <line num="14" count="2" type="stmt"/>
+        <line num="15" count="3" type="stmt"/>
+        <line num="16" count="4" type="stmt"/>
+        <line num="19" count="2" type="stmt"/>
+        <line num="20" count="3" type="stmt"/>
+        <line num="21" count="4" type="stmt"/>
+      </file>
+    </package>
+    <package name="src.files.services">
+      <metrics statements="37" coveredstatements="35" conditionals="2" coveredconditionals="2" methods="10" coveredmethods="10"/>
+      <file name="files-service.factory.ts" path="/home/dtaas/Documents/git/into-cps/DTaaS/servers/lib/src/files/services/files-service.factory.ts">
+        <metrics statements="10" coveredstatements="10" conditionals="1" coveredconditionals="1" methods="2" coveredmethods="2"/>
+        <line num="1" count="4" type="stmt"/>
+        <line num="2" count="4" type="stmt"/>
+        <line num="4" count="4" type="stmt"/>
+        <line num="7" count="4" type="stmt"/>
+        <line num="10" count="6" type="stmt"/>
+        <line num="11" count="6" type="stmt"/>
+        <line num="16" count="6" type="stmt"/>
+        <line num="17" count="6" type="cond" truecount="1" falsecount="0"/>
+        <line num="18" count="5" type="stmt"/>
+        <line num="20" count="1" type="stmt"/>
+      </file>
+      <file name="local-files.service.ts" path="/home/dtaas/Documents/git/into-cps/DTaaS/servers/lib/src/files/services/local-files.service.ts">
+        <metrics statements="27" coveredstatements="25" conditionals="1" coveredconditionals="1" methods="8" coveredmethods="8"/>
+        <line num="1" count="5" type="stmt"/>
+        <line num="2" count="5" type="stmt"/>
+        <line num="3" count="5" type="stmt"/>
+        <line num="4" count="5" type="stmt"/>
+        <line num="9" count="5" type="stmt"/>
+        <line num="11" count="9" type="stmt"/>
+        <line num="14" count="4" type="stmt"/>
+        <line num="15" count="4" type="stmt"/>
+        <line num="17" count="4" type="stmt"/>
+        <line num="19" count="4" type="stmt"/>
+        <line num="20" count="20" type="stmt"/>
+        <line num="23" count="4" type="stmt"/>
+        <line num="25" count="20" type="stmt"/>
+        <line num="28" count="20" type="stmt"/>
+        <line num="32" count="4" type="stmt"/>
+        <line num="36" count="4" type="stmt"/>
+        <line num="37" count="4" type="stmt"/>
+        <line num="39" count="4" type="stmt"/>
+        <line num="40" count="4" type="stmt"/>
+        <line num="44" count="4" type="stmt"/>
+        <line num="46" count="4" type="stmt"/>
+        <line num="48" count="0" type="stmt"/>
+        <line num="53" count="20" type="stmt"/>
+        <line num="54" count="20" type="cond" truecount="1" falsecount="0"/>
+        <line num="55" count="20" type="stmt"/>
+        <line num="57" count="0" type="stmt"/>
+        <line num="62" count="4" type="stmt"/>
+      </file>
+    </package>
+  </project>
+</coverage>