@into-cps-association/libms 0.3.1

package/.env

@@ -0,0 +1,9 @@
+PORT='4001'
+MODE='local'
+LOCAL_PATH ='/home/prasad/git/prasadtalasila/DTaaS/files'
+GITLAB_GROUP ='dtaas'
+GITLAB_URL='https://gitlab.foo.com/api/graphql'
+TOKEN='glpat-xFagGa33EW7bWpsM5q-Z'
+LOG_LEVEL='debug'
+APOLLO_PATH='/lib'
+GRAPHQL_PLAYGROUND='true'

package/.eslintignore

@@ -0,0 +1,6 @@
+api/
+build/
+dist/
+node_modules/
+script/
+src/types.ts

package/.eslintrc

@@ -0,0 +1,53 @@
+{
+  "env": {
+    "jest": true,
+    "jest/globals": true,
+    "node": true
+  },
+  "extends": [
+    "eslint:recommended",
+    "airbnb-base",
+    "plugin:@typescript-eslint/recommended",
+    "prettier"
+  ],
+  "globals": {
+    "Atomics": "readonly",
+    "SharedArrayBuffer": "readonly"
+  },
+  "settings": {
+    "import/resolver": {
+      "node": {
+        "extensions": [".js"]
+      }
+    }
+  },
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "requireConfigFile": false,
+    "ecmaVersion": 2022,
+    "sourceType": "module" // Allows for the use of imports
+  },
+  "plugins": ["jest", "@typescript-eslint", "import"],
+  "rules": {
+    "import/no-extraneous-dependencies": ["error", { "devDependencies": true }],
+    "no-console": "error",
+    "import/first": "error",
+    "linebreak-style": 0, // disable linter linebreak rule, to allow for both unix and windows developement
+    "import/no-unresolved": "off", // Whatever IDE will pass an error if if the module is not found, so no reason for this..
+    "import/extensions": "off", // That includes the production build.. We use linter for code checking / clean code optimization..
+    "no-use-before-define": "off"
+  },
+  "root": true,
+
+  "overrides": [
+    {
+      "files": ["*.ts"],
+      "parser": "@typescript-eslint/parser",
+      "parserOptions": {
+        "requireConfigFile": false,
+        "project": ["./tsconfig.json"]
+      },
+      "plugins": ["@typescript-eslint"]
+    }
+  ]
+}

package/.madgerc

@@ -0,0 +1,18 @@
+{
+	"fontSize": "10px",
+  "tsconfig": "tsconfig.json",
+  "fileExtensions": ["ts", "tsx", "js", "jsx"],
+  "backgroundColor": "#FFFFFF",
+  "textColor": "#FFFFFF",
+  "nodeColor": "black",
+  "noDependencyColor": "green",
+  "cyclicNodeColor": "red",
+  "edgeColor": "green",
+	"graphVizOptions": {
+		"G": {
+			"rankdir": "TB",
+      "layout": "neato",
+      "splines": "curved"
+		}
+	}
+}

package/.prettierrc

@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all"
+}

package/API.md

@@ -0,0 +1,211 @@
+# Overview
+
+## GraphQL API Calls
+
+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"
+            }
+          ]
+        }
+      }
+    }
+  }
+}
+```
+
+## 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 examples below>>
+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"}]}}}}}
+```

package/DEVELOPER.md

@@ -0,0 +1,60 @@
+# Developer Instructions
+
+## :gear: Configure
+
+This microservice needs library assets and configuration
+file. Please see [README](./README.md) for this information.
+
+## :hammer_and_wrench: Developer Commands
+
+```bash
+yarn install    # Install dependencies for the microservice
+yarn syntax     # Analyze code for errors and style issues
+yarn graph      # Generate dependency graphs in the code
+yarn build      # Compile ES6 to ES5 and copy JS files to build/ directory
+yarn test:unit  # Run all tests
+yarn test:e2e   # Run end-to-end tests
+yarn test:int   # Run integration tests
+yarn test:all   # Run unit tests
+yarn start -h   # List of all the CLI commands
+yarn start      # Start the application
+yarn clean      # Deletes "build", "coverage", "dist" and other temp files
+```
+
+## :package: :ship: NPM package
+
+### Github Package Registry
+
+The Github actions workflow of
+[lib microservice](../../.github/workflows/lib-ms.yml) publishes the __libms__
+into [public packages](https://github.com/orgs/INTO-CPS-Association/packages).
+
+### Verdaccio - Local Package Registry
+
+Use the instructions in
+[publish npm package](../../docs/developer/npm-packages.md) for help
+with publishing __libms npm package__ in local computer.
+
+Application of the advice given on that page for __libms__ will require
+running the following commands.
+
+### Publish
+
+```bash
+yarn install
+yarn build #the dist/ directory is needed for publishing step
+yarn publish --no-git-tag-version #increments version and publishes to registry
+yarn publish #increments version, publishes to registry and adds a git tag
+```
+
+### Unpublish
+
+```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/LICENSE.md

@@ -0,0 +1,301 @@
+# License
+
+--- Start of Definition of INTO-CPS Association Public License ---
+
+/*
+
+* This file is part of the INTO-CPS Association.
+
+* Copyright (c) 2017-CurrentYear, INTO-CPS Association (ICA),
+* c/o Peter Gorm Larsen, Aarhus University, Department of Engineering,
+* Finlandsgade 22, 8200 Aarhus N, Denmark.
+
+* All rights reserved.
+
+* THIS PROGRAM IS PROVIDED UNDER THE TERMS OF GPL VERSION 3 LICENSE OR
+* THIS INTO-CPS ASSOCIATION PUBLIC LICENSE (ICAPL) VERSION 1.0.
+* ANY USE, REPRODUCTION OR DISTRIBUTION OF THIS PROGRAM CONSTITUTES
+* RECIPIENT'S ACCEPTANCE OF THE INTO-CPS ASSOCIATION PUBLIC LICENSE OR
+* THE GPL VERSION 3, ACCORDING TO RECIPIENTS CHOICE.
+
+* The INTO-CPS tool suite software and the INTO-CPS Association
+* Public License (ICAPL) are obtained from the INTO-CPS Association, either
+* from the above address, from the URLs: <http://www.into-cps.org> or
+* in the INTO-CPS tool suite distribution.
+* GNU version 3 is obtained from:
+* <http://www.gnu.org/copyleft/gpl.html>.
+
+* This program is distributed WITHOUT ANY WARRANTY; without
+* even the implied warranty of  MERCHANTABILITY or FITNESS
+* FOR A PARTICULAR PURPOSE, EXCEPT AS EXPRESSLY SET FORTH
+* IN THE BY RECIPIENT SELECTED SUBSIDIARY LICENSE CONDITIONS OF
+* THE INTO-CPS ASSOCIATION PUBLIC LICENSE.
+
+* See the full ICAPL conditions for more details.
+
+ */
+
+--- End of INTO-CPS Association Public License Header ---
+
+The ICAPL is a public license for the INTO-CPS tool
+suite with three modes/alternatives
+(GPL, ICA-Internal-EPL, ICA-External-EPL) for use and redistribution,
+in source and/or binary/object-code form:
+
+* GPL. Any party (member or non-member of the INTO-CPS Association) may use and
+  redistribute INTO-CPS tool suite under GPL version 3.
+
+* Silver Level members of the INTO-CPS Association may also use and redistribute
+  the INTO-CPS tool suite under ICA-Internal-EPL conditions.
+
+* Gold Level members of the INTO-CPS Association may also use and redistribute
+  The INTO-CPS tool suite under ICA-Internal-EPL or ICA-External-EPL conditions.
+
+Definitions of the INTO-CPS Association Public license modes:
+
+* GPL = GPL version 3.
+
+* ICA-Internal-EPL = These INTO-CPA Association Public
+  license conditions together with
+  Internally restricted EPL, i.e., EPL version 1.0 with the Additional Condition
+  that use and redistribution by a member of the INTO-CPS Association is only allowed
+  within the INTO-CPS Association member's own
+  organization (i.e., its own legal entity),
+  or for a member of the INTO-CPS Association
+  paying a membership fee corresponding to
+  the size of the organization including all its affiliates, use and redistribution
+  is allowed within/between its affiliates.
+
+* ICA-External-EPL = These INTO-CPA Association Public
+  license conditions together with
+  Externally restricted EPL, i.e., EPL version 1.0 with the Additional Condition
+  that use and redistribution by a member of the INTO-CPS Association, or by a Licensed
+  Third Party Distributor having a redistribution agreement with that member,
+  to parties external to the INTO-CPS Association
+  member’s own organization (i.e., its own
+  legal entity) is only allowed in binary/object-code form, except the case of
+  redistribution to other members the INTO-CPS Association to which source is also
+  allowed to be distributed.
+
+[This has the consequence that an external party who wishes to use
+the INTO-CPS Association in source form together with
+its own proprietary software in all
+cases must be a member of the INTO-CPS Association].
+
+In all cases of usage and redistribution by recipients, the following
+conditions also apply:
+
+a) Redistributions of source code must retain the above copyright notice,
+ all definitions, and conditions. It is sufficient if the ICAPL Header is
+ present in each source file, if the full ICAPL is available in a prominent
+ and easily located place in the redistribution.
+
+b) Redistributions in binary/object-code form must reproduce the above
+ copyright notice, all definitions, and conditions. It is sufficient if the
+ ICAPL Header and the location in the redistribution of the full ICAPL
+ are present in the documentation and/or other materials provided with the
+ redistribution, if the full ICAPL is available in a prominent and easily
+ located place in the redistribution.
+
+c) A recipient must clearly indicate its chosen usage mode of ICAPL,
+ in accompanying documentation and in a text file ICA-USAGE-MODE.txt,
+ provided with the distribution.
+
+d) Contributor(s) making a Contribution to the
+ INTO-CPS Association thereby also makes a
+ Transfer of Contribution Copyright. In return, upon the effective date of
+ the transfer, ICA grants the Contributor(s) a Contribution License of the
+ Contribution. ICA has the right to accept or refuse Contributions.
+
+Definitions:
+
+"Subsidiary license conditions" means:
+
+The additional license conditions depending on the by the recipient chosen
+mode of ICAPL, defined by GPL version 3.0 for GPL, and by EPL for
+ICA-Internal-EPL and ICA-External-EPL.
+
+"ICAPL" means:
+
+INTO-CPS Association Public License version 1.0, i.e., the license
+defined here (the text between
+"--- Start of Definition of INTO-CPS Association Public License ---" and
+"--- End of Definition of INTO-CPS Association
+Public License ---", or later versions thereof.
+
+"ICAPL Header" means:
+
+INTO-CPS Association Public License Header version 1.2, i.e., the
+text between "--- Start of Definition
+of INTO-CPS Association Public License ---" and
+"--- End of INTO-CPS Association Public License Header ---, or later versions thereof.
+
+"Contribution" means:
+
+a) in the case of the initial Contributor,
+ the initial code and documentation
+ distributed under ICAPL, and
+
+b) in the case of each subsequent Contributor:
+   i) changes to the INTO-CPS tool suite, and
+  ii) additions to the INTO-CPS tool suite;
+
+where such changes and/or additions
+to the INTO-CPS tool suite originate from and are
+distributed by that particular Contributor.
+A Contribution 'originates' from
+a Contributor if it was added to the INTO-CPS
+tool suite by such Contributor itself or
+anyone acting on such Contributor's behalf.
+
+For Contributors licensing the INTO-CPS tool suite under ICA-Internal-EPL or
+ICA-External-EPL conditions, the following conditions also hold:
+
+Contributions do not include additions to the distributed Program which: (i)
+are separate modules of software distributed
+in conjunction with the INTO-CPS tool suite
+under their own license agreement, (ii) are separate modules which are not
+derivative works of the INTO-CPS tool suite, and (iii) are separate modules of software
+distributed in conjunction with the INTO-CPS tool suite under their own license agreement
+where these separate modules are merged with (weaved together with) modules of
+The INTO-CPS tool suite to form new modules
+that are distributed as object code or source
+code under their own license agreement, as allowed under the Additional
+Condition of internal distribution according to ICA-Internal-EPL and/or
+Additional Condition for external distribution according to ICA-External-EPL.
+
+"Transfer of Contribution Copyright" means that the Contributors of a
+Contribution transfer the ownership and the copyright of the Contribution to
+the INTO-CPS Association, the INTO-CPS Association Copyright owner, for
+inclusion in the INTO-CPS tool suite.
+The transfer takes place upon the effective date
+when the Contribution is made available on the
+INTO-CPS Association web site under ICAPL, by
+such Contributors themselves or anyone acting on such Contributors' behalf.
+The transfer is free of charge. If the
+Contributors or the INTO-CPS Association so wish,
+an optional Copyright transfer agreement can be signed
+between the INTO-CPS Association and the Contributors.
+
+"Contribution License" means a license from the INTO-CPS
+Association to the Contributors of the Contribution, effective
+on the date of the Transfer of Contribution Copyright,
+where the INTO-CPS Association grants the Contributors a
+non-exclusive, world-wide, transferable, free of charge,
+perpetual license, including sublicensing rights, to use,
+have used, modify, have modified, reproduce and or have reproduced the
+contributed material, for business and other purposes, including but not
+limited to evaluation, development, testing, integration and merging with
+other software and distribution. The warranty and liability disclaimers of
+ICAPL apply to this license.
+
+"Contributor" means any person or entity that distributes (part of)
+the INTO-CPS tool chain.
+
+"The Program" means the Contributions distributed in accordance with ICAPL.
+
+"The INTO-CPS tool chain" means the Contributions
+distributed in accordance with ICAPL.
+
+"Recipient" means anyone who receives the INTO-CPS tool chain under ICAPL,
+including all Contributors.
+
+"Licensed Third Party Distributor" means a reseller/distributor having signed
+a redistribution/resale agreement in accordance with ICAPL and the INTO-CPS
+Association Bylaws, with a Gold Level organizational member which is not an
+Affiliate of the reseller/distributor, for distributing a product containing
+part(s) of the INTO-CPS tool suite. The Licensed Third Party Distributor shall
+only be allowed further redistribution to other resellers if the Gold Level
+member is granting such a right to it in the redistribution/resale agreement
+between the Gold Level member and the Licensed Third Party Distributor.
+
+"Affiliate" shall mean any legal entity, directly or indirectly, through one
+or more intermediaries, controlling or controlled by or under common control
+with any other legal entity, as the case may be. For purposes of this
+definition, the term "control" (including the terms "controlling,"
+"controlled by" and "under common control with") means the possession,
+direct or indirect, of the power to direct or cause the direction of the
+management and policies of a legal entity, whether through the ownership of
+voting securities, by contract or otherwise.
+
+NO WARRANTY
+
+EXCEPT AS EXPRESSLY SET FORTH IN THE BY RECIPIENT SELECTED SUBSIDIARY
+LICENSE CONDITIONS OF ICAPL, THE INTO-CPS ASSOCIATION IS PROVIDED ON AN "AS IS"
+BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR
+IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF
+TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR
+PURPOSE. Each Recipient is solely responsible for determining the
+appropriateness of using and distributing the
+INTO-CPS tool suite and assumes all risks
+associated with its exercise of rights under ICAPL , including but not
+limited to the risks and costs of program errors, compliance with applicable
+laws, damage to or loss of data, programs or equipment, and unavailability
+or interruption of operations.
+
+DISCLAIMER OF LIABILITY
+
+EXCEPT AS EXPRESSLY SET FORTH IN THE BY RECIPIENT SELECTED SUBSIDIARY
+LICENSE CONDITIONS OF ICAPL, NEITHER RECIPIENT NOR ANY CONTRIBUTORS
+SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION
+LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE INTO-CPS TOOL
+SUITE OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED
+OF THE POSSIBILITY OF SUCH DAMAGES.
+
+A Contributor licensing the INTO-CPS tool suite under ICA-Internal-EPL or
+ICA-External-EPL may choose to distribute (parts of) the INTO-CPS tool suite
+in object code form under its own license agreement, provided that:
+
+a) it complies with the terms and conditions of ICAPL; or for the case of
+redistribution of the INTO-CPS tool suite
+together with proprietary code it is a dual
+license where the INTO-CPS tool suite parts are distributed under ICAPL compatible
+conditions and the proprietary code is distributed under proprietary license
+conditions; and
+
+b) its license agreement:
+   i) effectively disclaims on behalf of all Contributors all warranties and
+conditions, express and implied, including warranties or conditions of title
+and non-infringement, and implied warranties or conditions of merchantability
+and fitness for a particular purpose;
+  ii) effectively excludes on behalf of all Contributors all liability for
+damages, including direct, indirect, special, incidental and consequential
+damages, such as lost profits;
+ iii) states that any provisions which differ
+ from ICAPL are offered by that
+Contributor alone and not by any other party; and
+  iv) states from where the source code
+  for the INTO-CPS tool suite is available, and
+informs licensees how to obtain it in a reasonable manner on or through a
+medium customarily used for software exchange.
+
+When the INTO-CPS tool suite is made available in source code form:
+
+ a) it must be made available under ICAPL; and
+
+ b) a copy of ICAPL must be included with each copy of the INTO-CPS tool suite.
+
+ c) a copy of the subsidiary license associated with the selected mode of
+ICAPL must be included with each copy of the INTO-CPS tool suite.
+
+Contributors may not remove or alter any copyright notices contained within
+The INTO-CPS tool suite.
+
+If there is a conflict between ICAPL and the subsidiary license conditions,
+ICAPL has priority.
+
+This Agreement is governed by the laws of Denmark. The place of jurisdiction
+for all disagreements related to this Agreement, is Aarhus, Denmark.
+
+The EPL 1.0 license definition has been obtained from:
+<http://www.eclipse.org/legal/epl-v10.html>.
+It is also reproduced in the INTO-CPS distribution.
+
+The GPL Version 3 license definition has been obtained from
+<http://www.gnu.org/copyleft/gpl.html>.
+It is also reproduced in the INTO-CPS distribution.
+
+--- End of Definition of INTO-CPS Association Public License ---