Updates documentation for new functional proter

.scalafmt.conf

@@ -1,4 +1,4 @@
-version = "3.0.5"
+version = "3.6.1"
 runner.dialect = scala3
 maxColumn = 100
 project.git = true
@@ -18,8 +18,8 @@ comments.wrap = trailing
 spaces.beforeContextBoundColon = false
 spaces.inImportCurlyBraces = true
 
-optIn.blankLineBeforeDocstring = true
+docstrings.forceBlankLineBefore = true
 includeCurlyBraceInSelectChains = false
-unindentTopLevelOperators = true
 
-spaces.beforeContextBoundColon = Always
+spaces.beforeContextBoundColon = Always
+rewrite.trailingCommas.style = keep

build.sbt

@@ -99,15 +99,17 @@ def proterModule(name: String): Project =
     .settings(libraryDependencies ++= Dependencies.testAll)
     .dependsOn(proter % "compile->compile;test->test")
 
+
 lazy val root = Project(id = "proter-root", base = file("."))
+  .enablePlugins(ScalaUnidocPlugin)
   .settings(commonSettings)
   .settings( 
     publishArtifact := false,
     ScalaUnidoc / siteSubdirName := "api",
-    addMappingsToSiteDir(ScalaUnidoc / packageDoc / mappings, ScalaUnidoc / siteSubdirName)
+    addMappingsToSiteDir(ScalaUnidoc / packageDoc / mappings, ScalaUnidoc / siteSubdirName),
   )
   .aggregate(aggregatedProjects: _*)
-  .enablePlugins(ScalaUnidocPlugin)
+
 
 lazy val proter = Project(id = "proter", base = file("proter"))
   .settings(commonSettings)

docs/config.toml

@@ -18,6 +18,11 @@ disableKinds = ["taxonomy", "taxonomyTerm"]
   weight = 1000
   url = "api/com/workflowfm/proter/"
 
+[[menu.main]]
+  name = "OpenAPI"
+  weight = 2000
+  url = "server-api/"
+
 [markup]
   [markup.goldmark]
     [markup.goldmark.renderer]
@@ -44,7 +49,7 @@ disableKinds = ["taxonomy", "taxonomyTerm"]
 [params]
 
   repo = "https://github.com/workflowfm/Proter"
-  version = "0.7.4"
+  version = "0.8"
 
   time_format_blog = "Monday, 02 January 2006"
   time_format_default = "2 January 2006"

docs/content/_index.md

@@ -1,7 +1,7 @@
 ---
 title: "Proter"
 author: ["Petros Papapanagiotou"]
-lastmod: 2021-03-28T10:17:36+00:00
+lastmod: 2022-08-02T23:05:36+00:00
 draft: false
 ---
 
@@ -16,7 +16,7 @@ A [discrete event simulator](https://en.wikipedia.org/wiki/Discrete-event_simula
 Proter is named after the first half of the Greek word *προτεραιότητα* (`pɾo.te.ɾeˈo.ti.ta`), meaning "priority".
 
 
-{{< button "docs/" "Read the Docs" >}}{{< button "api/com/workflowfm/proter/" "API Documentation" >}}{{< button "https://github.com/workflowfm/Proter" "Source" >}}
+{{< button "docs/" "Read the Docs" >}}{{< button "api/com/workflowfm/proter/" "API Documentation" >}}{{< button "https://github.com/workflowfm/Proter" "Source" >}}{{< button "server-api/" "Server OpenAPI" >}}
 
 
 <a id="authors"></a>
@@ -32,6 +32,8 @@ Proter is named after the first half of the Greek word *προτεραιότητ
 A big thank you to the following contributors in order of appearance:
 
 -   [Michal Baczun](https://github.com/MBaczun)
+-   [Martin Lewis](https://github.com/martin-lewis)
+
 
 
 ### Groups & Organizations
@@ -60,5 +62,5 @@ A big thank you to the following contributors in order of appearance:
 
 Distributed under the Apache 2.0 license. See [LICENSE](https://github.com/workflowfm/Proter/blob/master/LICENSE) for more information.
 
-Copyright &copy; 2019-2021 [The University of Edinburgh](https://www.ed.ac.uk/) and [contributors](#authors)
+Copyright &copy; 2019-2022 [The University of Edinburgh](https://www.ed.ac.uk/) and [contributors](#authors)
 

docs/static/css/workflowfm.css

@@ -1,3 +1,36 @@
 .nomargin {
     margin: 0;
 }
+
+code {
+    display: inline;
+}
+
+pre.chroma code {
+    display: block;
+}
+
+.tip_warning {
+    border-color: red;
+}
+
+strong {
+    font-weight: 900;
+}
+
+.icon_inline {
+    display: inline;
+}
+
+.icon_inline img.icon {
+    display: inline-block;
+    margin: 0;
+}
+
+.menu h3 {
+    padding-left: 5px;
+}
+.menu nav ul ul li {
+    padding-left: 8px;
+}
+

docs/static/server-api/absolute-path.js

@@ -0,0 +1,14 @@
+/*
+ * getAbsoluteFSPath
+ * @return {string} When run in NodeJS env, returns the absolute path to the current directory
+ *                  When run outside of NodeJS, will return an error message
+ */
+const getAbsoluteFSPath = function () {
+  // detect whether we are running in a browser or nodejs
+  if (typeof module !== "undefined" && module.exports) {
+    return require("path").resolve(__dirname)
+  }
+  throw new Error('getAbsoluteFSPath can only be called within a Nodejs environment');
+}
+
+module.exports = getAbsoluteFSPath

docs/static/server-api/index.css

@@ -0,0 +1,16 @@
+html {
+    box-sizing: border-box;
+    overflow: -moz-scrollbars-vertical;
+    overflow-y: scroll;
+}
+
+*,
+*:before,
+*:after {
+    box-sizing: inherit;
+}
+
+body {
+    margin: 0;
+    background: #fafafa;
+}

docs/static/server-api/index.html

@@ -0,0 +1,40 @@
+<!-- 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="stylesheet" type="text/css" href="index.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"> 
+ </head> 
+ <body> 
+  <div id="swagger-ui"></div> 
+  <script src="./swagger-ui-bundle.js" charset="UTF-8"> </script> 
+  <script src="./swagger-ui-standalone-preset.js" charset="UTF-8"> </script> 
+  <script src="./swagger-initializer.js" charset="UTF-8">
+window.onload = function() {
+   const ui = SwaggerUIBundle(
+{
+
+
+   url: 'https://raw.githubusercontent.com/workflowfm/proter/fp-docs/proter-server/docs/proter-server-api.yaml',
+
+
+   deepLinking: true,
+   layout: 'StandaloneLayout',
+   dom_id: '#swagger-ui',
+   presets: [
+     SwaggerUIBundle.presets.apis,
+     SwaggerUIStandalonePreset  
+   ],
+   plugins: [
+     SwaggerUIBundle.plugins.DownloadUrl
+   ]
+}
+    );
+   window.ui = ui;
+};
+        </script>  
+ </body>
+</html>

docs/static/server-api/index.js

@@ -0,0 +1,17 @@
+try {
+  module.exports.SwaggerUIBundle = require("./swagger-ui-bundle.js")
+  module.exports.SwaggerUIStandalonePreset = require("./swagger-ui-standalone-preset.js")
+} catch(e) {
+  // swallow the error if there's a problem loading the assets.
+  // allows this module to support providing the assets for browserish contexts,
+  // without exploding in a Node context.
+  //
+  // see https://github.com/swagger-api/swagger-ui/issues/3291#issuecomment-311195388
+  // for more information.
+}
+
+// `absolutePath` and `getAbsoluteFSPath` are both here because at one point,
+// we documented having one and actually implemented the other.
+// They were both retained so we don't break anyone's code.
+module.exports.absolutePath = require("./absolute-path.js")
+module.exports.getAbsoluteFSPath = require("./absolute-path.js")

docs/static/server-api/oauth2-redirect.html

@@ -0,0 +1,79 @@
+<!doctype html>
+<html lang="en-US">
+<head>
+    <title>Swagger UI: OAuth2 Redirect</title>
+</head>
+<body>
+<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.schema.get("flow") === "authorization_code"
+        ) && !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. The 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();
+    }
+
+    if (document.readyState !== 'loading') {
+        run();
+    } else {
+        document.addEventListener('DOMContentLoaded', function () {
+            run();
+        });
+    }
+</script>
+</body>
+</html>