Package library microservice

docs/admin/client/CLIENT.md

@@ -143,3 +143,6 @@ Given that multiple services are running at different routes,
 a reverse proxy is needed to map the background services to external routes.
 You can use Apache, NGINX, Traefik or any other software to work
 as reverse proxy.
+
+The website screenshots and usage information is available in
+[user page](../../user/website/index.md).

docs/admin/servers/lib/LIB-MS.md

@@ -110,222 +110,5 @@ Users can access the library microservice at URL: `http://localhost:<PORT>/lib`.
 
 The URL endpoint for this microservice is located at: `localhost:PORT/lib`
 
-## GraphQL API Calls
-
-The lib microservice supports two GraphQL queries.
-
-### Directory Listing
-
-#### Query: List of Files
-
-To retrieve a list of files in a directory, use the following GraphQL query.
-Replace `path` with the desired directory path.
-
-```graphql
-query {
-  listDirectory(path: "user1") {
-    repository {
-      tree {
-        blobs {
-          edges {
-            node {
-              name
-              type
-            }
-          }
-        }
-        trees {
-          edges {
-            node {
-              name
-              type
-            }
-          }
-        }
-      }
-    }
-  }
-}
-```
-
-#### Response: List of Files
-
-This query returns the list of files and subdirectories in the specified directory.
-The response will include the name and type of each item.
-
-```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"
-                }
-              }
-            ]
-          }
-        }
-      }
-    }
-  }
-}
-```
-
-### Fetching a File
-
-#### Query: Get File Contents
-
-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`.
-
-```graphql
-query {
-  readFile(path: "user2/data/sample.txt") {
-    repository {
-      blobs {
-        nodes {
-          name
-          rawBlob
-          rawTextBlob
-        }
-      }
-    }
-  }
-}
-```
-
-#### Response: Get File Contents
-
-This query returns the name, raw binary blob, and raw text blob of
-the specified file. The `rawBlob` field contains the file contents
-in binary format, while the `rawTextBlob` field contains the file contents
-as plain text.
-
-```graphql
-{
-  "data": {
-    "readFile": {
-      "repository": {
-        "blobs": {
-          "nodes": [
-            {
-              "name": "sample.txt",
-              "rawBlob": "hello world",
-              "rawTextBlob": "hello world"
-            }
-          ]
-        }
-      }
-    }
-  }
-}
-```
-
-## HTTP 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 example>>
-Content Type: text/json
-```
-
-Here are examples of the HTTP requests and responses for the HTTP API calls.
-
-### Directory listing
-
-```http
-POST /lib HTTP/1.1
-Host: localhost:4001
-Content-Type: application/json
-Content-Length: 388
-{"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"}]}}}}}
-```
+The service API documentation is available on
+[user page](../../../user/servers/lib/LIB-MS.md).

docs/developer/npm-packages.md

@@ -0,0 +1,69 @@
+# Publish NPM packages
+
+The DTaaS software is developed as a monorepo with multiple npm packages.
+Since publishing to [npmjs](https://www.npmjs.com/) is
+irrevocable and public, developers are encouraged to setup their own private
+npm registry for local development.
+
+A private npm registry will help with local publish and unpublish steps.
+
+## Setup private npm registry
+
+We recommend using [verdaccio](https://verdaccio.org) for this task.
+The following commands help you create a working private npm registry
+for development.
+
+```bash
+docker run -d --name verdaccio -p 4873:4873 verdaccio/verdaccio
+npm adduser --registry http://localhost:4873 #create a user on the verdaccio registry
+npm set registry http://localhost:4873/
+yarn config set registry "http://localhost:4873"
+yarn login --registry "http://localhost:4873" #login with the credentials for yarn utility
+npm login #login with the credentials for npm utility
+```
+
+You can open `http://localhost:4873` in your browser, login with
+the user credentials to see the packages published.
+
+### Publish to private npm registry
+
+To publish a package to your local registry, do:
+
+```bash
+yarn install
+yarn build #the dist/ directory is needed for publishing step
+yarn publish --no-git-tag-version #increments version in package.json, publishes to registry
+yarn publish #increments version in package.json, publishes to registry and adds a git tag
+```
+
+The package version in package.json gets updated as well. You can
+open `http://localhost:4873` in your browser, login with the user credentials
+to see the packages published. Please see
+[verdaccio docs](https://verdaccio.org/docs/installation/#basic-usage)
+for more information.
+
+If there is a need to unpublish a package, ex: `@dtaas/[email protected]`, do:
+
+```bash
+npm unpublish  --registry http://localhost:4873/ @dtaas/[email protected]
+```
+
+To install / uninstall this utility for all users, do:
+
+```bash
+sudo npm install  --registry http://localhost:4873 -g @dtaas/runner
+sudo npm list -g # should list @dtaas/runner in the packages
+sudo npm remove --global @dtaas/runner
+```
+
+## :rocket: Use the packages
+
+The packages available in private npm registry can be used like
+the regular npm packages installed from [npmjs](https://www.npmjs.com/).
+
+For example, to use `@dtaas/[email protected]` package, do:
+
+```bash
+sudo npm install  --registry http://localhost:4873 -g @dtaas/runner
+runner # launch the digital twin runner
+```

mkdocs-github.yml

@@ -54,6 +54,7 @@ nav:
         - Client: developer/client/client.md
         - Library Microservice: developer/servers/lib/lib-ms.md
       - Testing: developer/testing/intro.md
+      - Publish NPM Packages: developer/npm-packages.md
   - Bugs: bugs.md
   - Thanks: thanks.md
   - License: LICENSE.md

mkdocs.yml

@@ -54,6 +54,7 @@ nav:
         - Client: developer/client/client.md
         - Library Microservice: developer/servers/lib/lib-ms.md
       - Testing: developer/testing/intro.md
+      - Publish NPM Packages: developer/npm-packages.md
   - Bugs: bugs.md
   - Thanks: thanks.md
   - License: LICENSE.md

servers/execution/runner/README.md

@@ -32,30 +32,16 @@ yarn start      # start the application
 yarn clean      # deletes directories "build", "coverage", and "dist"
 ```
 
-## :package: :ship: Publish Package
+## :package: :ship: NPM package
 
-### Setup private npm registry
+Use the instructions in
+[publish npm package](../../../docs/developer/npm-packages.md) for help
+with publishing **runner npm package**.
 
-This package need to be published to an npm registry. There after, the package
-can be installed as a system command. Since publishing to npmjs.org is
-irrevocable and public, developers are encouraged to setup their own private
-npm registry for local development. We recommend using
-[verdaccio](https://verdaccio.org) for this task. The following commands
-help you create a working private npm registry for development.
+Application of the advice given on that page for **runner** will require
+running the following commands.
 
-```bash
-docker run -d --name verdaccio -p 4873:4873 verdaccio/verdaccio
-npm adduser --registry http://localhost:4873 #create a user on the verdaccio registry
-npm set registry http://localhost:4873/
-yarn config set registry "http://localhost:4873"
-```
-
-You can open `http://localhost:4873` in your browser, login with
-the user credentials to see the packages published.
-
-### Publish to private registry
-
-To publish a package to your local registry, do:
+### Publish
 
 ```bash
 yarn install
@@ -64,26 +50,12 @@ yarn publish --no-git-tag-version #increments version in package.json, publishes
 yarn publish #increments version in package.json, publishes to registry and adds a git tag
 ```
 
-The package version in package.json gets updated as well. You can
-open `http://localhost:4873` in your browser, login with the user credentials
-to see the packages published. Please see
-[verdaccio docs](https://verdaccio.org/docs/installation/#basic-usage)
-for more information.
-
-If there is a need to unpublish a package, ex: `@dtaas/[email protected]`, do:
+### Unpublish
 
 ```bash
 npm unpublish  --registry http://localhost:4873/ @dtaas/[email protected]
 ```
 
-To install / uninstall this utility for all users, do:
-
-```bash
-sudo npm install  --registry http://localhost:4873 -g @dtaas/runner
-sudo npm list -g # should list @dtaas/runner in the packages
-sudo npm remove --global @dtaas/runner
-```
-
 ## :rocket: Access the service
 
 ```bash