@sassoftware/viya-serverjs 0.3.0 → 0.5.0

package/.babelrc

@@ -1,6 +1,6 @@
-{
-    "presets": [
-        "@babel/preset-env"
-    ]
-    
-}
+{
+    "presets": [
+        "@babel/preset-env"
+    ]
+    
+}

package/.dockerignore

@@ -1,2 +1,2 @@
-node_modules
-
+node_modules
+

package/.env

@@ -1,28 +1,42 @@
-APPHOST=localhost
-APPENTRY=index.html
-APPLOC=./public
-# VIYA_SERVER=
-# VIYA_SERVER=none
-APPPORT=8080
-APPNAME=viyaapp
-AUTHFLOW=server
-CLIENTID=viyaapp
-CLIENTSECRET=jellico
-REDIRECT=
-# APPDIR=./appDir
-HTTPS=true
-
-
-USETOKEN=YES
-SHOWENV=YES
-
-APPENV_XYZ=AA
-APPENV_BAD=
-
-# APPENV_PUPID=NSHOST=https://sas-logon-app.viya.svc.cluster.local
-
-# NAMESPACE=viya
-
-
-
-
+APPHOST=localhost
+# APPENTRY=index.html
+APPLOC=./public
+# VIYA_SERVER=your viya server
+
+APPPORT=8080
+APPNAME=viyaapp
+AUTHFLOW=code
+CLIENTID=viyaapp
+CLIENTSECRET=jellico
+
+REDIRECT=
+# APPDIR=./appDir
+HTTPS=true
+
+
+# Most modern browsers do not accept self-signed certs from localhost
+# Options:
+
+# 1. provide signed certificates for localhost
+# 2. Use libraries like mkcert to create temporary trusted certs for localhost
+# 3. Use the app server as a proxy to the Viya server to avoid CORS issues.
+#    This requires that the app redirect all Viya API calls to the app server proxy endpoint
+#    Users of restaf can simply set the APPENV_PROXY env to TRUE to enable this behavior
+# 4. set USETOKEN to TRUE and use the token in the APPENV object to make the calls
+// either use the proper ssl/tsl certs or use the "proxy" method
+// to avoid CORS issues with self-signed certs
+// so run all apps thru the proxy and call Viya from there
+APPENV_PROXY=false
+
+
+# APPENV_PROXYSERVER=true
+# USETOKEN=true
+SHOWENV=true
+
+APPENV_XYZ=AA
+APPENV_BAD=
+
+
+
+
+

package/.env.server

@@ -1,30 +1,32 @@
-APPHOST=localhost
-APPENTRY=index.html
-APPLOC=./public
-VIYA_SERVER=
-APPENV_PROXYSERVER=https://localhost:8080/viyaapp/proxy
-APPPORT=8080
-APPNAME=viyaapp
-AUTHFLOW=server
-CLIENTID=viyaapp
-CLIENTSECRET=jellico
-REDIRECT=/new
-# APPDIR=./appDir
-# HTTPS=true
-USELOGON=YES
-
-
-USETOKEN=YES
-# SHOWENV=YES
-# APPENV=
-APPENV_XYZ=AA
-APPENV_BAD=
-
-
-
-# NAMESPACE=viya
-# TLS_CERT=./certs/tls.crt
-# TLS_KEY=./certs/tls.key
-
-
-
+APPHOST=localhost
+APPENTRY=index.html
+APPLOC=./public
+# viya-server set preset
+# VIYA_SERVER=
+APPENV_PROXYSERVER=https://localhost:8080/viyaapp/proxy
+
+APPPORT=8080
+APPNAME=viyaapp
+AUTHFLOW=server
+CLIENTID=viyaapp
+CLIENTSECRET=jellico
+REDIRECT=/new
+# APPDIR=./appDir
+# HTTPS=true
+USELOGON=YES
+
+
+USETOKEN=YES
+# SHOWENV=YES
+# APPENV=
+APPENV_XYZ=AA
+APPENV_BAD=
+
+
+
+# NAMESPACE=viya
+# TLS_CERT=./certs/tls.crt
+# TLS_KEY=./certs/tls.key
+
+
+

package/.eslintignore

@@ -1,4 +1,4 @@
-node_modules
-public
-env
+node_modules
+public
+env
 lib

package/.eslintrc.json

@@ -1,42 +1,42 @@
-{
-	"root": true,
-	"env": {
-		"browser": true,
-		"node": true,
-		"es6": true
-	},
-	"parser": "@babel/eslint-parser",
-	"extends": ["eslint:recommended", "prettier"],
-	"parserOptions": {
-		"requireConfigFile": false,
-		"babelOptions": {"configFile": "./.babelrc"},
-		"ecmaVersion": 6,
-		"sourceType": "module",
-		"ecmaFeatures": {
-			"jsx": true
-		}
-	},
-	"rules": {
-		"key-spacing": [
-			2,
-			{
-				"align": "colon"
-			}
-		],
-		"jsx-quotes": [2, "prefer-double"],
-		"no-console": 0,
-		"no-unused-vars": [
-			1,
-			{
-				"args": "none"
-			}
-		],
-		"no-debugger": 0,
-		"react/prop-types": 0,
-		"array-bracket-spacing": [2, "never"],
-		"space-in-parens": [2, "never"],
-		"space-before-function-paren": [2, "always"],
-		"semi": [2, "always"],
-		"no-prototype-builtins": 0
-	}
-}
+{
+	"root": true,
+	"env": {
+		"browser": true,
+		"node": true,
+		"es6": true
+	},
+	"parser": "@babel/eslint-parser",
+	"extends": ["eslint:recommended", "prettier"],
+	"parserOptions": {
+		"requireConfigFile": false,
+		"babelOptions": {"configFile": "./.babelrc"},
+		"ecmaVersion": 6,
+		"sourceType": "module",
+		"ecmaFeatures": {
+			"jsx": true
+		}
+	},
+	"rules": {
+		"key-spacing": [
+			2,
+			{
+				"align": "colon"
+			}
+		],
+		"jsx-quotes": [2, "prefer-double"],
+		"no-console": 0,
+		"no-unused-vars": [
+			1,
+			{
+				"args": "none"
+			}
+		],
+		"no-debugger": 0,
+		"react/prop-types": 0,
+		"array-bracket-spacing": [2, "never"],
+		"space-in-parens": [2, "never"],
+		"space-before-function-paren": [2, "always"],
+		"semi": [2, "always"],
+		"no-prototype-builtins": 0
+	}
+}

package/Dockerfile

@@ -1,44 +1,44 @@
-FROM node:12.16.1-alpine
-LABEL maintainer="deva.kumar@sas.com"
-WORKDIR /usr/src/app
-COPY . .
-# COPY package*.json ./
-RUN npm install
-# RUN npm run build
-
-# will auto change to localhost in non-docker environments
-ENV APPHOST=0.0.0.0
-ENV PORT=8080
-EXPOSE 8080
-ENV HTTPS=true
-# ENV APPSERVERLEVEL=v2
-#######################################################################
-# You can override these(but in container leave APPHOST as shown below)
-########################################################################
-
-# set this the same as EXPOSE here and override in env or as -p option in dockerrun
-# ENV APPPORT=8080
-
-ENV APPNAME=viyaapp
-# ENV AUTHFLOW=
-ENV CLIENTID=viyaapp
-ENV CLIENTSECRET=jellico
-ENV HAPIDEBUG=NO
-# ENV LOGLEVEL=info
-# ENV USETOKEN=YES
-
-#sample setup for creating a temporary cert and key
-ENV TLS_CREATE="C:US,ST:NC,L:Cary,O:SAS Institute,OU:STO,CN:localhost"
-
-# You can specify your own cet and key
-# ENV TLS_CRT=./tls/tls.crt
-# ENV TLS_KEY=./tls/tls.key
-
-# Samesite specification
-ENV SAMESITE=None,secure
-
-# If your Viya instance still has a unsigned certificate set this value prior to invoking the server
-# ENV NODE_TLS_REJECT_UNAUTHORIZED=0
-
-#####################################################################
-CMD ["npm", "run", "indocker"]
+FROM node:12.16.1-alpine
+LABEL maintainer="deva.kumar@sas.com"
+WORKDIR /usr/src/app
+COPY . .
+# COPY package*.json ./
+RUN npm install
+# RUN npm run build
+
+# will auto change to localhost in non-docker environments
+ENV APPHOST=0.0.0.0
+ENV PORT=8080
+EXPOSE 8080
+ENV HTTPS=true
+ENV VIYA_SERVER=
+# ENV APPSERVERLEVEL=v2
+#######################################################################
+# You can override these(but in container leave APPHOST as shown below)
+########################################################################
+
+# set this the same as EXPOSE here and override in env or as -p option in dockerrun
+# ENV APPPORT=8080
+
+ENV APPNAME=viyaapp
+ENV AUTHFLOW=server
+ENV CLIENTID=viyaapp
+ENV CLIENTSECRET=
+# ENV HAPIDEBUG=NO
+# ENV LOGLEVEL=info
+# ENV USETOKEN=YES
+
+# specify ssl/tls cert and key in a folder
+# example below
+ENV SSLCERT=c:/Users/kumar/.tls
+#sample setup for creating a temporary cert and key
+ENV TLS_CREATE="C:US,ST:NC,L:Cary,O:SAS Institute,OU:STO,CN:localhost"
+
+# Samesite specification
+ENV SAMESITE=None,secure
+
+# If your Viya instance still has a unsigned certificate set this value prior to invoking the server
+# ENV NODE_TLS_REJECT_UNAUTHORIZED=0
+
+#####################################################################
+CMD ["npm", "run", "indocker"]

package/README.md

@@ -1,99 +1,67 @@
-# `Application servers for use with SAS Viya`
-
-This package has two servers:
-
-1. viya-appserverjs - Use this for developing an app server for web applications(see packages/appjs)
-
-2. viya-apiserverjs - Use this to develop rest api servers(see packages/apijs)
-
-## Usage
-
-Specify it as a dependency in your package.json just as you do with other dependencies
-
-Use npx command to start the server
-
-```sh
-npx @sassoftware/viyaappserverjs
-```
-
-## `Basic configuration`
-
-1. Set the default settings in Dockerfile. This will ensure these are set when you build containers.
-2. The defaults can be overriden using environment variables.
-
-### `Sample env file`
-
-When running on a non-docker environment, you can use a .env
-
-```env
-VIYA_SERVER=<your viya server>
-APPHOST=localhost < can also be dns name of your server. ex: viyaiscool.unx.sas.com>
-APPPORT=5000   <any port of your choice>
-APPNAME=viyaapp
-
-CLIENTID=viyaapp
-CLIENTSECRET=secret
-```
-
-### `Sample Dockerfile`
-
-```env
-FROM node:12.16.1-alpine
-LABEL maintainer="your email"
-WORKDIR /usr/src/app
-COPY . .
-RUN npm install
-# RUN npm run build (if you have to build something)
-EXPOSE 8080
-ENV APPHOST=0.0.0.0
-
-AUTHFLOW=code
-
-# The following are defaults. Override them as needed
-# APPLOC - where the file specified in APPENTRY is
-# APPENTRY - the main entry of the application
-ENV APPLOC=./public
-ENV APPENTRY=index.html
-# if your app takes advantage of appenv.js to pass configuration to the web application 
-# ENV APPENV=appenv.js 
-
-# See notes below on running with SSL enabled
-ENV TLS_CREATE="C:US,ST:NC,L:Cary,O:yourcompany,OU:STO,CN:localhost"
-ENV SAMESITE=None,secure
-
-# It is better to set this before invoking the server
-ENV NODE_TLS_REJECT_UNAUTHORIZED=0
-
-# set this to YES if you want access to the authentication token in the app
-ENV USETOKEN=NO
-
-CMD ["npx", "@sassoftware/viya-appserverjs"]
-
-```
-
-### `Running with SSL enabled -- Recommended`
-
-This is the recommended setting. This will also make browsers like Chrome run with the SAMESITE settings set to Default - your users will thank you.
-
-Make sure you specify the VIYA_SERVER with a protocol of https.
-
-### `TLS certificates`
-
-- Option 1: Let server create a temporary unsigned certificate
-
-    ```env
-    ENV TLS_CREATE=C:US,ST:NC,L:Cary,O:YourCompany,OU:yourgroup,CN:localhost
-    ```
-
-- Option 2: Provide your own key and certificate key
-
-```env
-ENV TLS_KEY=../certs/self/key.pem
-ENV TLS_CERT=../certs/self/certificate.pem
-```
-
-- Option 3:  Provide key and certificate as a pfx file
-
-```env
-ENV TLS_PFX=../certs/sascert/sascert2.pfx
-```
+# `Application server for use with SAS Viya`
+
+viya-serverjs is a app server designed to support user written SAS Viya applications. The applications can be written using any framework.
+
+Key features:
+
+1. Handles authentication
+2. Extendable with additional end points
+
+## Usage
+
+Use npx command to start the server
+
+```sh
+npx @sassoftware/viya-serverjs
+```
+
+## `Basic configuration`
+
+Configure the server using a .env file
+
+### `Sample env file`
+
+>[Note] Sample values shown below. See Advanced section for other ways to configure the server
+
+```env
+
+# Base setup
+# With the configuration below the app server url will be
+# https://localhost:8080/viyaapp
+#
+APPHOST=localhost
+APPPORT=8080
+HTTPS=true
+APPNAME=viyaapp
+
+# Most modern browsers will reject self-signed certs from localhost
+# And SAS Viya might also refuse connection.
+# Supply your own SSL/TLS values in a folder. All files in this folder will be used.
+# Options:
+# 1. provide signed certificates for localhost
+# 2. Use libraries like mkcert to create temporary trusted certs for localhost
+# 3. For other options see the Advanced Section
+SSLCERT=./tls  
+
+# AUTHENTICATION
+VIYA_SERVER=<viya servrer url>
+
+# By default it uses authorization_code flow
+
+CLIENTID=<clientid>
+CLIENTSECRET=<clientSecret if present>
+AUTHFLOW=code|pkce
+
+##########################
+# Read the Advanced Section in the README before turning on these options
+#
+APPENV_PROXY=false
+USETOKEN=false
+
+APPENV_A=somevalue
+APPENV_B=somevalue
+
+```
+
+
+

package/cli.js

@@ -1,9 +1,9 @@
-#!/usr/bin/env node
-/*
-* Copyright © 2025, SAS Institute Inc., Cary, NC, USA.  All Rights Reserved.
-* SPDX-License-Identifier: Apache-2.0
-*/
-
-let core = require('./lib/index.js');
-console.log('Starting the cli for @sassoftware/viya-serverjs');
-core(null, true, 'app', null);
+#!/usr/bin/env node
+/*
+* Copyright © 2025, SAS Institute Inc., Cary, NC, USA.  All Rights Reserved.
+* SPDX-License-Identifier: Apache-2.0
+*/
+
+let core = require('./lib/index.js');
+console.log('Starting the cli for @sassoftware/viya-serverjs');
+core(null, true, 'app', null);

package/lib/config.js

@@ -1,19 +1,19 @@
-/*
- *  ------------------------------------------------------------------------------------
- *  * Copyright (c) SAS Institute Inc.
- *  *  Licensed under the Apache License, Version 2.0 (the "License");
- *  * you may not use this file except in compliance with the License.
- *  * You may obtain a copy of the License at
- *  *
- *  * http://www.apache.org/licenses/LICENSE-2.0
- *  *
- *  *  Unless required by applicable law or agreed to in writing, software
- *  * distributed under the License is distributed on an "AS IS" BASIS,
- *  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *  * See the License for the specific language governing permissions and
- *  limitations under the License.
- * ----------------------------------------------------------------------------------------
- *
+/*
+ *  ------------------------------------------------------------------------------------
+ *  * Copyright (c) SAS Institute Inc.
+ *  *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  * you may not use this file except in compliance with the License.
+ *  * You may obtain a copy of the License at
+ *  *
+ *  * http://www.apache.org/licenses/LICENSE-2.0
+ *  *
+ *  *  Unless required by applicable law or agreed to in writing, software
+ *  * distributed under the License is distributed on an "AS IS" BASIS,
+ *  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  * See the License for the specific language governing permissions and
+ *  limitations under the License.
+ * ----------------------------------------------------------------------------------------
+ *
  */
 
 'use strict';