@sme.up/kokos-sdk-node 0.0.1

package/scripts/init.js

@@ -0,0 +1,95 @@
+#!/usr/bin/env node
+
+import path from "path";
+import fs from "fs";
+import url from "url";
+
+/**
+ * INITIALIZER SCRIPT
+ *
+ * syntax: npx @sme.up/kokos-template-node init [PROJECT_NAME]
+ *
+ * - create package.json
+ * - create tsconfig.json
+ * - create src/service/JS_00_01 example service
+ */
+
+// constant
+const __filename = url.fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+try {
+  // root path
+  const rootPath = process.cwd();
+
+  const projectName = process.argv[3];
+  if (!projectName) {
+    console.error(
+      "Error: project name not defined \nSyntax: npx @sme.up/kokos-template-node init [PROJECT_NAME]"
+    );
+    process.exit();
+  }
+
+  const projectPath = path.resolve(rootPath, projectName);
+
+  // create folder named as projecName
+  fs.mkdirSync(projectPath);
+
+  // read package.json, tsconfig.json, README.md
+  const packageJson = JSON.parse(
+    fs.readFileSync(path.resolve(__dirname, "../package.json"))
+  );
+  const tsconfigJson = JSON.parse(fs.readFileSync(
+    path.resolve(__dirname, "../tsconfig.json")
+  ));
+  const readme = fs.readFileSync(path.resolve(__dirname, "../README.md"));
+
+  // create package json
+  const projectPackageJson = {
+    name: projectName,
+    version: "0.0.1",
+    description: "Kokos Micro Executor Node.js",
+    type: "module",
+    scripts: {
+      build: "kokos build",
+      "build-image:restapi": "kokos build-image:restapi",
+      "dev:restapi": "kokos dev:restapi",
+      "start:restapi": "kokos start:restapi",
+    },
+    dependencies: {
+      "@sme.up/kokos-template-node": packageJson.version,
+    },
+  };
+  // create package.json
+  const packageJsonStream = fs.createWriteStream(
+    path.resolve(projectPath, "package.json")
+  );
+  packageJsonStream.write(JSON.stringify(projectPackageJson, null, "\t"));
+  packageJsonStream.end();
+  // create tsconfig.json
+  const tsconfigStream = fs.createWriteStream(
+    path.resolve(projectPath, "tsconfig.json")
+  );
+  tsconfigStream.write(JSON.stringify(tsconfigJson, null, "\t"));
+  tsconfigStream.end();
+  // create README.md file
+  const readmeStream = fs.createWriteStream(
+    path.resolve(projectPath, "README.md")
+  );
+  readmeStream.write(readme);
+  readmeStream.end();
+
+  // create src folder
+  const srcFolder = path.resolve(projectPath, "src");
+  fs.mkdirSync(srcFolder);
+  // create services folder
+  const serviceFolder = path.resolve(srcFolder, "services");
+  fs.mkdirSync(serviceFolder);
+  // load content from JS_00_01.txt
+  // Copy /init/JS_00_01.txt file to [ROOT]/src/services/JS_00_01.ts
+  const txtFile = path.resolve(__dirname, "../init/JS_00_01.txt");
+  const tsFile = path.resolve(serviceFolder, "JS_00_01.ts");
+  fs.copyFileSync(txtFile, tsFile);
+} catch (err) {
+  console.error(err);
+}

package/scripts/restapi/build-image-restapi.js

@@ -0,0 +1,60 @@
+#!/usr/bin/env node
+
+import { exec } from "child_process";
+import { getProjectRoot } from "../../lib/utils/path.js";
+import { readFile } from "fs/promises";
+import path from "path";
+import fs from "fs";
+
+/**
+ * BUILD IMAGE FOR REST API
+ */
+
+try {
+  // dockerfile path
+  const dockerfilePath = path.resolve(
+    `${getProjectRoot()}/node_modules/@sme.up/kokos-template-node/docker/restapi/Dockerfile`
+  );
+  const destinationDockerfilePath = `${getProjectRoot()}/Dockerfile`;
+
+  // copy dockerfile to project root
+  fs.copyFileSync(dockerfilePath, destinationDockerfilePath);
+
+  // load package json
+  const packageJson = JSON.parse(
+    await readFile(new URL(getProjectRoot() + "/package.json", import.meta.url))
+  );
+
+  // get image name based on project name
+  let imageName;
+  if (packageJson.name.includes("@")) {
+    imageName = packageJson.name.substring(packageJson.name.indexOf("/") + 1);
+  } else {
+    imageName = packageJson.name;
+  }
+
+  // start production mode
+  console.log(`Start build image for REST API: ${imageName}`);
+
+  // build project with typescript compiler
+  const dockerBuild = exec(`docker build -t ${imageName} .`);
+
+  // redirect docker build stdout to standard output
+  dockerBuild.stdout.pipe(process.stdout);
+  // redirect docker build stderr to standard output
+  dockerBuild.stderr.pipe(process.stderr);
+
+  if (dockerBuild.pid) {
+    console.log(
+      `Building image...\nPress CTRL+C to exit\nPID: ${dockerBuild.pid}`
+    );
+  }
+
+  dockerBuild.on("exit", function () {
+    // delete dockerfile from project root
+    fs.unlinkSync(destinationDockerfilePath);
+    console.log("Image build successfull");
+  });
+} catch (err) {
+  console.error(err);
+}

package/scripts/restapi/dev.js

@@ -0,0 +1,30 @@
+#!/usr/bin/env node
+
+import { exec } from "child_process";
+
+/**
+ * DEVELOPMENT MODE
+ */
+
+// set environment variables
+process.env.NODE_ENV = "development";
+
+// start nodemon
+const devServer = exec(
+  "NODE_ENV=development nodemon --watch src/**/* -e ts,js --exec node --experimental-specifier-resolution=node --loader ts-node/esm node_modules/@sme.up/kokos-template-node/lib/entrypoint/restapi/index.js"
+);
+
+// redirect docker build stdout to standard output
+devServer.stdout.pipe(process.stdout);
+// redirect docker build stderr to standard output
+devServer.stderr.pipe(process.stderr);
+
+if (!devServer.pid) {
+  console.log(
+    `Development mode active \nPress CTRL+C to exit\nPID: ${devServer.pid}`
+  );
+}
+
+devServer.on("exit", function () {
+  console.log("Development server terminated");
+});

package/scripts/restapi/start.js

@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+
+/**
+ * PRODUCTION MODE
+ */
+
+// start production mode
+console.log("Start production mode");
+
+// set environment variables
+process.env.NODE_ENV = "production";
+
+// start rest api entrypoint
+import("../../lib/entrypoint/restapi/index.js");

package/swagger/index.html

@@ -0,0 +1,61 @@
+<!-- HTML for static distribution bundle build -->
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8">
+    <title>Swagger UI</title>
+    <link rel="stylesheet" type="text/css" href="./swagger-ui.css" >
+    <link rel="icon" type="image/png" href="./favicon-32x32.png" sizes="32x32" />
+    <link rel="icon" type="image/png" href="./favicon-16x16.png" sizes="16x16" />
+    <style>
+      html
+      {
+        box-sizing: border-box;
+        overflow: -moz-scrollbars-vertical;
+        overflow-y: scroll;
+      }
+
+      *,
+      *:before,
+      *:after
+      {
+        box-sizing: inherit;
+      }
+
+      body
+      {
+        margin:0;
+        background: #fafafa;
+      }
+    </style>
+  </head>
+
+  <body>
+    <div id="swagger-ui"></div>
+
+    <script src="./swagger-ui-bundle.js"> </script>
+    <script src="./swagger-ui-standalone-preset.js"> </script>
+    <script>
+    window.onload = function() {
+    	var pathArray = window.location.pathname.split('/');
+
+      // Build a system
+      const ui = SwaggerUIBundle({
+        url: window.location.origin + "/" + pathArray[1] + "/openapi.yaml" ,
+        dom_id: '#swagger-ui',
+        deepLinking: true,
+        presets: [
+          SwaggerUIBundle.presets.apis,
+          SwaggerUIStandalonePreset
+        ],
+        plugins: [
+          SwaggerUIBundle.plugins.DownloadUrl
+        ],
+        layout: "StandaloneLayout"
+      })
+
+      window.ui = ui
+    }
+  </script>
+  </body>
+</html>

package/swagger/oauth2-redirect.html

@@ -0,0 +1,72 @@
+<!doctype html>
+<html lang="en-US">
+<title>Swagger UI: OAuth2 Redirect</title>
+<body>
+</body>
+</html>
+<script>
+    'use strict';
+    function run () {
+        var oauth2 = window.opener.swaggerUIRedirectOauth2;
+        var sentState = oauth2.state;
+        var redirectUrl = oauth2.redirectUrl;
+        var isValid, qp, arr;
+
+        if (/code|token|error/.test(window.location.hash)) {
+            qp = window.location.hash.substring(1);
+        } else {
+            qp = location.search.substring(1);
+        }
+
+        arr = qp.split("&")
+        arr.forEach(function (v,i,_arr) { _arr[i] = '"' + v.replace('=', '":"') + '"';})
+        qp = qp ? JSON.parse('{' + arr.join() + '}',
+                function (key, value) {
+                    return key === "" ? value : decodeURIComponent(value)
+                }
+        ) : {}
+
+        isValid = qp.state === sentState
+
+        if ((
+          oauth2.auth.schema.get("flow") === "accessCode"||
+          oauth2.auth.schema.get("flow") === "authorizationCode"
+        ) && !oauth2.auth.code) {
+            if (!isValid) {
+                oauth2.errCb({
+                    authId: oauth2.auth.name,
+                    source: "auth",
+                    level: "warning",
+                    message: "Authorization may be unsafe, passed state was changed in server Passed state wasn't returned from auth server"
+                });
+            }
+
+            if (qp.code) {
+                delete oauth2.state;
+                oauth2.auth.code = qp.code;
+                oauth2.callback({auth: oauth2.auth, redirectUrl: redirectUrl});
+            } else {
+                let oauthErrorMsg
+                if (qp.error) {
+                    oauthErrorMsg = "["+qp.error+"]: " +
+                        (qp.error_description ? qp.error_description+ ". " : "no accessCode received from the server. ") +
+                        (qp.error_uri ? "More info: "+qp.error_uri : "");
+                }
+
+                oauth2.errCb({
+                    authId: oauth2.auth.name,
+                    source: "auth",
+                    level: "error",
+                    message: oauthErrorMsg || "[Authorization failed]: no accessCode received from the server"
+                });
+            }
+        } else {
+            oauth2.callback({auth: oauth2.auth, token: qp, isValid: isValid, redirectUrl: redirectUrl});
+        }
+        window.close();
+    }
+
+    window.addEventListener('DOMContentLoaded', function () {
+      run();
+    });
+</script>

package/swagger/openapi.yaml

@@ -0,0 +1,130 @@
+---
+openapi: "3.0.0"
+info:
+  title: Kokos Micro Executor (Node) API
+  description: Api Docs
+  version: 2.0.0
+servers:
+  - url: /
+paths:
+  /api/v1/livez:
+    get:
+      tags:
+        - health
+      operationId: Livez
+      responses:
+        default:
+          description: no description
+        "200":
+          description: OK
+  /api/v1/readyz:
+    get:
+      tags:
+        - health
+      operationId: Readyz
+      responses:
+        default:
+          description: no description
+        "200":
+          description: OK
+  /api/v1/executeFun:
+    post:
+      tags:
+        - execution
+      operationId: ExecuteFun
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/executeFunPayload"
+      responses:
+        default:
+          description: SmeupDataStructure
+        "200":
+          description: OK
+components:
+  schemas:
+    executeFunPayload:
+      type: object
+      properties:
+        fun:
+          type: object
+          properties:
+            component:
+              type: string
+            service:
+              type: string
+            function:
+              type: string
+            obj1:
+              type: object
+              properties:
+                t:
+                  type: string
+                p:
+                  type: string
+                k:
+                  type: string
+            obj2:
+              type: object
+              properties:
+                t:
+                  type: string
+                p:
+                  type: string
+                k:
+                  type: string
+            obj3:
+              type: object
+              properties:
+                t:
+                  type: string
+                p:
+                  type: string
+                k:
+                  type: string
+            obj4:
+              type: object
+              properties:
+                t:
+                  type: string
+                p:
+                  type: string
+                k:
+                  type: string
+            obj5:
+              type: object
+              properties:
+                t:
+                  type: string
+                p:
+                  type: string
+                k:
+                  type: string
+            obj6:
+              type: object
+              properties:
+                t:
+                  type: string
+                p:
+                  type: string
+                k:
+                  type: string
+            P:
+              type: string
+            INPUT:
+              type: string
+        context:
+          type: object
+          properties:
+            user:
+              type: object
+              properties:
+                sessionId:
+                  type: string
+                username:
+                  type: string
+                environment:
+                  type: string
+                device:
+                  type: string