1
0
mirror of https://github.com/sasjs/adapter.git synced 2026-01-03 18:50:05 +00:00

Compare commits

..

19 Commits

Author SHA1 Message Date
dependabot[bot]
b67971c801 build(deps-dev): bump express from 4.17.3 to 4.22.0
Bumps [express](https://github.com/expressjs/express) from 4.17.3 to 4.22.0.
- [Release notes](https://github.com/expressjs/express/releases)
- [Changelog](https://github.com/expressjs/express/blob/4.22.0/History.md)
- [Commits](https://github.com/expressjs/express/compare/4.17.3...4.22.0)

---
updated-dependencies:
- dependency-name: express
  dependency-version: 4.22.0
  dependency-type: direct:development
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-12-15 12:07:22 +00:00
Allan Bowe
9252e7e384 Merge pull request #866 from sasjs/housekeeping_20251212
fix(build): pipeline node version upgrade and hardened security
2025-12-15 12:06:04 +00:00
mulahasanovic
bbf0eed443 chore(cypress): update config 2025-12-15 11:49:53 +01:00
mulahasanovic
677c0a5046 chore(build): update search and replace command for cypress env 2025-12-15 11:29:55 +01:00
mulahasanovic
ff927caf73 chore(deps): bump cypress 2025-12-15 11:20:22 +01:00
mulahasanovic
e23aa4426c chore(build): update test server port 2025-12-12 17:54:00 +01:00
mulahasanovic
8064a843e8 fix(build): install cypress binary and cache only in relevant pipeline 2025-12-12 17:31:57 +01:00
M
d45b528846 chore: ci fix, package-lock regen 2025-12-12 17:27:29 +01:00
mulahasanovic
cd64ebc518 fix(build): add cypress binary to the cache 2025-12-12 17:11:58 +01:00
Trevor Moody
8246722ae8 fix(deps): take newly available @sasjs/utils 3.5.6 2025-12-12 14:18:04 +00:00
Trevor Moody
0f8a3f4b53 fix(build): node version unified across all pipelines 2025-12-12 13:59:06 +00:00
Trevor Moody
ca9ffdbc17 fix(build): pipeline node version upgrade and hardened security 2025-12-12 13:16:32 +00:00
Allan Bowe
03b7592521 Merge pull request #865 from sasjs/viyaCreateFileAndPatch
Viya create file and patch
2025-11-25 09:02:48 +00:00
Trevor Moody
ba64ed1f20 fix: defensively coded for potential empty 'name' properties in the viya types response 2025-11-25 07:39:00 +00:00
Trevor Moody
480510b980 build: (server-tests) use jq to safely modify json 2025-11-23 06:29:52 +00:00
Trevor Moody
8c7767a36d fix: (build) command syntax 2025-11-22 22:19:34 +00:00
Trevor Moody
f335be344e build: adjusted search/replace regex/value to allow for json lines without trailing commas 2025-11-22 22:11:55 +00:00
Trevor Moody
680f5a4872 chore: (sasjs-tests) prevent redundant rendering of vertical scroll bar 2025-11-22 17:58:00 +00:00
Trevor Moody
c42a20a8ee feat: (viya) apply properties to newly created files 2025-11-22 17:56:50 +00:00
17 changed files with 819 additions and 531 deletions

1
.gitattributes vendored Normal file
View File

@@ -0,0 +1 @@
* text=auto eol=lf

View File

@@ -12,7 +12,7 @@ jobs:
strategy:
matrix:
node-version: [lts/hydrogen]
node-version: [lts/iron]
steps:
- uses: actions/checkout@v2
@@ -21,7 +21,7 @@ jobs:
with:
node-version: ${{ matrix.node-version }}
# 2. Restore npm cache manually
# 2. Restore npm cache manually
- name: Restore npm cache
uses: actions/cache@v3
id: npm-cache

View File

@@ -11,7 +11,7 @@ jobs:
strategy:
matrix:
node-version: [lts/hydrogen]
node-version: [lts/iron]
steps:
- name: Checkout
@@ -20,9 +20,10 @@ jobs:
- name: Setup Node
uses: actions/setup-node@v2
with:
node-version: ${{ matrix.node-version }}
node-version:
${{ matrix.node-version }}
# 2. Restore npm cache manually
# 2. Restore npm cache manually
- name: Restore npm cache
uses: actions/cache@v3
id: npm-cache
@@ -50,4 +51,3 @@ jobs:
publish_branch: gh-pages
publish_dir: ./docs
cname: adapter.sasjs.io

View File

@@ -14,7 +14,7 @@ jobs:
strategy:
matrix:
node-version: [lts/hydrogen]
node-version: [lts/iron]
steps:
- uses: actions/checkout@v2
@@ -23,7 +23,7 @@ jobs:
with:
node-version: ${{ matrix.node-version }}
# 2. Restore npm cache manually
# 2. Restore npm cache manually
- name: Restore npm cache
uses: actions/cache@v3
id: npm-cache
@@ -42,6 +42,9 @@ jobs:
- name: Build Project
run: npm run build
- name: Clean up ready for publishing
run: npm run publishInit
- name: Semantic Release
uses: cycjimmy/semantic-release-action@v3
env:

View File

@@ -1,107 +1,120 @@
# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
name: SASjs Build and Server Tests
on:
pull_request:
jobs:
test:
runs-on: ubuntu-22.04
strategy:
matrix:
node-version: [lts/hydrogen]
steps:
- uses: actions/checkout@v2
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v2
with:
node-version: ${{ matrix.node-version }}
# 2. Restore npm cache manually
- name: Restore npm cache
uses: actions/cache@v3
id: npm-cache
with:
path: ~/.npm
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
restore-keys: |
${{ runner.os }}-node-
- name: Install Dependencies
run: npm ci
- name: Install Rimraf
run: npm i rimraf
- name: Build Package
run: npm run package:lib
env:
CI: true
- name: Write VPN Files
run: |
echo "$CA_CRT" > .github/vpn/ca.crt
echo "$USER_CRT" > .github/vpn/user.crt
echo "$USER_KEY" > .github/vpn/user.key
echo "$TLS_KEY" > .github/vpn/tls.key
shell: bash
env:
CA_CRT: ${{ secrets.CA_CRT}}
USER_CRT: ${{ secrets.USER_CRT }}
USER_KEY: ${{ secrets.USER_KEY }}
TLS_KEY: ${{ secrets.TLS_KEY }}
- name: Chmod VPN files
run: |
chmod 600 .github/vpn/ca.crt .github/vpn/user.crt .github/vpn/user.key .github/vpn/tls.key
- name: Install Open VPN
run: |
sudo apt install apt-transport-https
sudo wget https://swupdate.openvpn.net/repos/openvpn-repo-pkg-key.pub
sudo apt-key add openvpn-repo-pkg-key.pub
sudo wget -O /etc/apt/sources.list.d/openvpn3.list https://swupdate.openvpn.net/community/openvpn3/repos/openvpn3-jammy.list
sudo apt update
sudo apt install openvpn3=17~betaUb22042+jammy
- name: Start Open VPN 3
run: openvpn3 session-start --config .github/vpn/config.ovpn
- name: install pm2
run: npm i -g pm2
- name: Fetch SASJS server
run: curl ${{ secrets.SASJS_SERVER_URL }}/SASjsApi/info
- name: Deploy sasjs-tests
run: |
npm install -g replace-in-files-cli
cd sasjs-tests
replace-in-files --regex='"@sasjs/adapter".*' --replacement='"@sasjs/adapter":"latest",' ./package.json
npm i
replace-in-files --regex='"serverUrl".*' --replacement='"serverUrl":"${{ secrets.SASJS_SERVER_URL }}",' ./public/config.json
replace-in-files --regex='"userName".*' --replacement='"userName":"${{ secrets.SASJS_USERNAME }}",' ./public/config.json
replace-in-files --regex='"serverType".*' --replacement='"serverType":"SASJS",' ./public/config.json
replace-in-files --regex='"password".*' --replacement='"password":"${{ secrets.SASJS_PASSWORD }}",' ./public/config.json
cat ./public/config.json
npm run update:adapter
pm2 start --name sasjs-test npm -- start
- name: Sleep for 10 seconds
run: sleep 10s
shell: bash
- name: Run cypress on sasjs
run: |
replace-in-files --regex='"sasjsTestsUrl".*' --replacement='"sasjsTestsUrl":"http://localhost:3000",' ./cypress.json
replace-in-files --regex='"username".*' --replacement='"username":"${{ secrets.SASJS_USERNAME }}",' ./cypress.json
replace-in-files --regex='"password".*' --replacement='"password":"${{ secrets.SASJS_PASSWORD }}",' ./cypress.json
cat ./cypress.json
echo "SASJS_USERNAME=${{ secrets.SASJS_USERNAME }}"
sh ./sasjs-tests/sasjs-cypress-run.sh ${{ secrets.MATRIX_TOKEN }} https://github.com/${{github.repository}}/actions/runs/${{github.run_id}}
# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
name: SASjs Build and Server Tests
on:
pull_request:
jobs:
test:
runs-on: ubuntu-22.04
strategy:
matrix:
node-version: [lts/iron]
steps:
- uses: actions/checkout@v2
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v2
with:
node-version: ${{ matrix.node-version }}
# 2. Restore npm cache manually
- name: Restore npm cache
uses: actions/cache@v3
id: npm-cache
with:
path: |
~/.npm
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
restore-keys: |
${{ runner.os }}-node-
- name: Cache Cypress binary
uses: actions/cache@v3
with:
path: ~/.cache/Cypress
key: cypress-${{ runner.os }}-${{ hashFiles('**/package-lock.json') }}
restore-keys: |
cypress-${{ runner.os }}-
- name: Install Dependencies
run: npm ci
- name: Install Cypress binary
run: npx cypress install
- name: Install Rimraf
run: npm i rimraf
- name: Build Package
run: npm run package:lib
env:
CI: true
- name: Write VPN Files
run: |
echo "$CA_CRT" > .github/vpn/ca.crt
echo "$USER_CRT" > .github/vpn/user.crt
echo "$USER_KEY" > .github/vpn/user.key
echo "$TLS_KEY" > .github/vpn/tls.key
shell: bash
env:
CA_CRT: ${{ secrets.CA_CRT}}
USER_CRT: ${{ secrets.USER_CRT }}
USER_KEY: ${{ secrets.USER_KEY }}
TLS_KEY: ${{ secrets.TLS_KEY }}
- name: Chmod VPN files
run: |
chmod 600 .github/vpn/ca.crt .github/vpn/user.crt .github/vpn/user.key .github/vpn/tls.key
- name: Install Open VPN
run: |
sudo apt install apt-transport-https
sudo wget https://swupdate.openvpn.net/repos/openvpn-repo-pkg-key.pub
sudo apt-key add openvpn-repo-pkg-key.pub
sudo wget -O /etc/apt/sources.list.d/openvpn3.list https://swupdate.openvpn.net/community/openvpn3/repos/openvpn3-jammy.list
sudo apt update
sudo apt install openvpn3=17~betaUb22042+jammy
- name: Start Open VPN 3
run: openvpn3 session-start --config .github/vpn/config.ovpn
- name: install pm2
run: npm i -g pm2
- name: Fetch SASJS server
run: curl ${{ secrets.SASJS_SERVER_URL }}/SASjsApi/info
- name: Deploy sasjs-tests
run: |
sudo apt install jq
cd sasjs-tests
jq '.dependencies."@sasjs/adapter" |= "latest"' ./package.json > ./package.temp && mv ./package.temp ./package.json
npm i
jq '.sasJsConfig.serverUrl |= "${{ secrets.SASJS_SERVER_URL }}"' ./public/config.json > ./public/config.temp && mv ./public/config.temp ./public/config.json
jq '.sasJsConfig.serverType |= "SASJS"' ./public/config.json > ./public/config.temp && mv ./public/config.temp ./public/config.json
jq '.userName |= "${{ secrets.SASJS_USERNAME }}"' ./public/config.json > ./public/config.temp && mv ./public/config.temp ./public/config.json
jq '.password |= "${{ secrets.SASJS_PASSWORD }}"' ./public/config.json > ./public/config.temp && mv ./public/config.temp ./public/config.json
cat ./public/config.json
npm run update:adapter
pm2 start --name sasjs-test npm -- start
- name: Sleep for 10 seconds
run: sleep 10s
shell: bash
- name: Run cypress on sasjs
run: |
sed -i "s|sasjsTestsUrl: '.*'|sasjsTestsUrl: 'http://localhost:5173'|g" ./cypress.config.js
sed -i "s|username: '.*'|username: '${{ secrets.SASJS_USERNAME }}'|g" ./cypress.config.js
sed -i "s|password: '.*'|password: '${{ secrets.SASJS_PASSWORD }}'|g" ./cypress.config.js
cat ./cypress.config.js
echo "SASJS_USERNAME=${{ secrets.SASJS_USERNAME }}"
sh ./sasjs-tests/sasjs-cypress-run.sh ${{ secrets.MATRIX_TOKEN }} https://github.com/${{github.repository}}/actions/runs/${{github.run_id}}

1
.npmrc Normal file
View File

@@ -0,0 +1 @@
ignore-scripts=true

18
cypress.config.js Normal file
View File

@@ -0,0 +1,18 @@
const { defineConfig } = require('cypress')
module.exports = defineConfig({
e2e: {
includeShadowDom: true,
chromeWebSecurity: false,
defaultCommandTimeout: 20000,
specPattern: 'cypress/integration/**/*.ts',
supportFile: 'cypress/support/index.js'
},
env: {
sasjsTestsUrl: 'http://localhost:5173',
username: '',
password: '',
screenshotOnRunFailure: false,
testingFinishTimeout: 600000
}
})

View File

@@ -1,11 +0,0 @@
{
"chromeWebSecurity": false,
"defaultCommandTimeout": 20000,
"env": {
"sasjsTestsUrl": "",
"username": "",
"password": "",
"screenshotOnRunFailure": false,
"testingFinishTimeout": 600000
}
}

866
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -4,17 +4,14 @@
"homepage": "https://adapter.sasjs.io",
"scripts": {
"nodeVersionMessage": "echo \u001b[33m make sure you are running node lts version \u001b[0m",
"preinstall": "npm run nodeVersionMessage",
"prebuild": "npm run nodeVersionMessage",
"build": "npx rimraf build && npx rimraf node && mkdir node && copyfiles -u 1 \"./src/**/*\" ./node && webpack && npx rimraf build/src && npx rimraf node",
"build": "npm run nodeVersionMessage && npx rimraf build && npx rimraf node && mkdir node && copyfiles -u 1 \"./src/**/*\" ./node && webpack && npx rimraf build/src && npx rimraf node",
"package:lib": "npm run build && copyfiles ./package.json build && cd build && npm version \"5.0.0\" && npm pack",
"publish:lib": "npm run build && cd build && npm publish",
"lint:fix": "npx prettier --loglevel silent --write \"src/**/*.{ts,tsx,js,jsx,html,css,sass,less,json,yml,md,graphql}\" && npx prettier --loglevel silent --write \"sasjs-tests/src/**/*.{ts,tsx,js,jsx,html,css,sass,less,json,yml,md,graphql}\" && npx prettier --loglevel silent --write \"cypress/**/*.{ts,tsx,js,jsx,html,css,sass,less,json,yml,md,graphql}\"",
"lint": "npx prettier --check \"src/**/*.{ts,tsx,js,jsx,html,css,sass,less,json,yml,md,graphql}\" && npx prettier --check \"sasjs-tests/src/**/*.{ts,tsx,js,jsx,html,css,sass,less,json,yml,md,graphql}\" && npx prettier --check \"cypress/**/*.{ts,tsx,js,jsx,html,css,sass,less,json,yml,md,graphql}\"",
"lint:silent": "npx prettier --loglevel silent --check \"src/**/*.{ts,tsx,js,jsx,html,css,sass,less,json,yml,md,graphql}\" && npx prettier --loglevel silent --check \"sasjs-tests/src/**/*.{ts,tsx,js,jsx,html,css,sass,less,json,yml,md,graphql}\" && npx prettier --loglevel silent --check \"cypress/**/*.{ts,tsx,js,jsx,html,css,sass,less,json,yml,md,graphql}\"",
"test": "jest --silent --coverage",
"prepublishOnly": "cp -r ./build/* . && rm -rf ./build",
"postpublish": "git clean -fd",
"publishInit": "cp -r ./build/* . && rm -rf ./build",
"semantic-release": "semantic-release",
"typedoc": "node createTSDocs",
"prepare": "git rev-parse --git-dir && git config core.hooksPath ./.git-hooks && git config core.autocrlf false || true",
@@ -54,9 +51,9 @@
"copyfiles": "2.4.1",
"cors": "^2.8.5",
"cp": "0.2.0",
"cypress": "7.7.0",
"cypress": "^15.7.1",
"dotenv": "16.0.0",
"express": "4.17.3",
"express": "4.22.0",
"jest": "29.7.0",
"jest-environment-jsdom": "^29.7.0",
"jest-extended": "4.0.2",
@@ -79,7 +76,7 @@
},
"main": "index.js",
"dependencies": {
"@sasjs/utils": "3.5.2",
"@sasjs/utils": "3.5.6",
"axios": "1.12.2",
"axios-cookiejar-support": "5.0.5",
"form-data": "4.0.4",

View File

@@ -1,39 +1,39 @@
* {
box-sizing: border-box;
margin: 0;
padding: 0;
}
body {
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen,
Ubuntu, Cantarell, sans-serif;
line-height: 1.6;
color: #333;
background: #f5f5f5;
}
.app__error {
max-width: 800px;
margin: 50px auto;
padding: 30px;
background: white;
border-radius: 8px;
box-shadow: 0 2px 10px rgba(0, 0, 0, 0.1);
h1 {
color: #e74c3c;
margin-bottom: 15px;
}
p {
margin-bottom: 15px;
}
pre {
background: #2c3e50;
color: #ecf0f1;
padding: 15px;
border-radius: 4px;
overflow-x: auto;
}
}
* {
box-sizing: border-box;
margin: 0;
padding: 0;
}
body {
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen,
Ubuntu, Cantarell, sans-serif;
line-height: 1.6;
color: #333;
background: #f5f5f5;
}
.app__error {
max-width: 800px;
margin: 50px auto;
padding: 30px;
background: white;
border-radius: 8px;
box-shadow: 0 2px 10px rgba(0, 0, 0, 0.1);
h1 {
color: #e74c3c;
margin-bottom: 15px;
}
p {
margin-bottom: 15px;
}
pre {
background: #2c3e50;
color: #ecf0f1;
padding: 15px;
border-radius: 4px;
overflow-x: auto;
}
}

View File

@@ -443,6 +443,7 @@
"resolved": "https://registry.npmjs.org/axios/-/axios-1.12.2.tgz",
"integrity": "sha512-vMJzPewAlRyOgxV2dU0Cuz2O8zzzx9VYtbJOaBgXFeLc4IV/Eg50n4LowmehOOR61S8ZMpc2K5Sa7g6A4jfkUw==",
"license": "MIT",
"peer": true,
"dependencies": {
"follow-redirects": "^1.15.6",
"form-data": "^4.0.4",
@@ -1228,6 +1229,7 @@
"resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.3.tgz",
"integrity": "sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q==",
"dev": true,
"peer": true,
"engines": {
"node": ">=12"
},
@@ -1395,6 +1397,7 @@
"resolved": "https://registry.npmjs.org/tough-cookie/-/tough-cookie-4.1.3.tgz",
"integrity": "sha512-aX/y5pVRkfRnfmuX+OdbSdXvPe6ieKX/G2s7e98f4poJHnqH3281gDPm/metm6E/WRamfx7WC4HUqkWHfQHprw==",
"license": "BSD-3-Clause",
"peer": true,
"dependencies": {
"psl": "^1.1.33",
"punycode": "^2.1.1",
@@ -1826,6 +1829,7 @@
"version": "1.12.2",
"resolved": "https://registry.npmjs.org/axios/-/axios-1.12.2.tgz",
"integrity": "sha512-vMJzPewAlRyOgxV2dU0Cuz2O8zzzx9VYtbJOaBgXFeLc4IV/Eg50n4LowmehOOR61S8ZMpc2K5Sa7g6A4jfkUw==",
"peer": true,
"requires": {
"follow-redirects": "^1.15.6",
"form-data": "^4.0.4",
@@ -2251,7 +2255,8 @@
"version": "4.0.3",
"resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.3.tgz",
"integrity": "sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q==",
"dev": true
"dev": true,
"peer": true
},
"postcss": {
"version": "8.5.6",
@@ -2358,6 +2363,7 @@
"version": "4.1.3",
"resolved": "https://registry.npmjs.org/tough-cookie/-/tough-cookie-4.1.3.tgz",
"integrity": "sha512-aX/y5pVRkfRnfmuX+OdbSdXvPe6ieKX/G2s7e98f4poJHnqH3281gDPm/metm6E/WRamfx7WC4HUqkWHfQHprw==",
"peer": true,
"requires": {
"psl": "^1.1.33",
"punycode": "^2.1.1",

View File

@@ -22,7 +22,6 @@ import { sendArrTests, sendObjTests } from './testSuites/RequestData'
import { fileUploadTests } from './testSuites/FileUpload'
import { computeTests } from './testSuites/Compute'
import { sasjsRequestTests } from './testSuites/SasjsRequests'
import { viyaFileTests } from './testSuites/ViyaFile'
async function init() {
const appContainer = document.getElementById('app')
@@ -104,10 +103,9 @@ function showTests(
fileUploadTests(adapter)
]
// Add certain tests for SASVIYA only
// Add compute tests for SASVIYA only
if (adapter.getSasjsConfig().serverType === 'SASVIYA') {
testSuites.push(computeTests(adapter, appLoc))
testSuites.push(viyaFileTests(adapter, appLoc))
}
container.innerHTML = ''

View File

@@ -1,31 +0,0 @@
import SASjs from '@sasjs/adapter'
import type { TestSuite } from '../types'
export const viyaFileTests = (adapter: SASjs, appLoc: string): TestSuite => ({
name: 'SAS Viya File Tests',
tests: [
{
title: 'Create html file',
description: 'Should create an html file with appropriate properties',
test: async () => {
const fileContentBuffer = Buffer.from(
`<html>` +
` <head><title>Test</title></head>` +
` <body><p>This is a test</p></body>` +
`</html>`
)
// generate a timestamp string formatted as YYYYmmDDTHHMMSS_999
const timeMark = new Date()
.toISOString()
.replace(/(\/|:|\s|-|Z)/g, '')
.replace(/\./g, '_')
const filename = `viya_createFile_test_${timeMark}.html`
return adapter.createFile(filename, fileContentBuffer, appLoc)
},
assertion: () => {
//A test that returns a boolean
return true // dummy
}
}
]
})

View File

@@ -1,12 +1,5 @@
import { defineConfig } from 'vite'
import { nodePolyfills } from 'vite-plugin-node-polyfills'
export default defineConfig({
plugins: [
nodePolyfills({
include: ['buffer']
})
],
build: {
assetsInlineLimit: 0,
assetsDir: ''

View File

@@ -35,7 +35,7 @@ interface JobExecutionResult {
log?: string
error?: object
}
/* Viya /types/types?limit=999999 response structure */
interface IViyaTypesResponse {
accept: string
count: number
@@ -47,6 +47,7 @@ interface IViyaTypesResponse {
version: number
}
/* Item element within the Viya types response */
interface IViyaTypesItem {
description?: string
extensions?: string[]
@@ -56,7 +57,7 @@ interface IViyaTypesItem {
mappedTypes?: string[]
mediaType?: string
mediaTypes?: string[]
name: string
name?: string | undefined
pluralLabel?: string
properties?: IViyaTypesProperties
resourceUri?: string
@@ -85,7 +86,7 @@ type IViyaTypesProperties = Record<string, string>
* create and patch a new file.
*/
interface IViyaTypesExtensionInfo {
typeDefName: string
typeDefName: string | undefined
properties: IViyaTypesProperties | undefined
}
@@ -114,9 +115,9 @@ export class SASViyaApiClient {
this.requestClient
)
private folderMap = new Map<string, Job[]>()
private fileExtensionMap = new Map<string, IViyaTypesExtensionInfo>()
private boolExtensionMap = false // has the fileExtensionMap been populated yet?
private boolExtensionMap = false // required in case the map has zero entries
// after an attempt to populate it.
/**
* A helper method used to call appendRequest method of RequestClient
@@ -481,29 +482,20 @@ export class SASViyaApiClient {
if (!parentFolderUri && parentFolderPath) {
parentFolderUri = await this.getFolderUri(parentFolderPath, accessToken)
}
const headers = {
Accept: 'application/vnd.sas.file+json',
'Content-Disposition': `filename="${fileName}";`
}
const patchHeaders = {
Accept: 'application/json',
'If-Match': '*'
}
const formData = new NodeFormData()
formData.append('file', contentBuffer, fileName)
/** Query Viya for file metadata based on extension type.
* Without providing certain properties, some versions of Viya will not
* serve files as intended. Avoid this issue by applying the properties
* that Viya has registered for a file extension.
*/
/** Query Viya for file metadata based on extension type. */
// typeDefName - Viya should automatically determine this and additional
// properties at runtime if not provided in the file creation request.
// typeDefName - Viya accepts this property during the file creation
let typeDefName: string | undefined = undefined
// Viya update 2025.09 resulted in a change to this automatic behaviour.
// We patch the new file to replicate the behaviour.
// Additional properties are supplied by a patch.
let filePatch:
| {
name: string
@@ -532,8 +524,14 @@ export class SASViyaApiClient {
.forEach((e) => {
e.extensions?.forEach((ext) => {
this.fileExtensionMap.set(ext, {
// "name:" is the typeDefName value required for file creation.
typeDefName: e.name,
// `name` becomes the typeDefName value at file creation time.
// `name` is ignored here if it is not populated in the map, or
// has a blank/empty value.
typeDefName: e.name
? e.name.trim().length
? e.name.trim()
: undefined
: undefined,
properties: e.properties
})
})
@@ -542,14 +540,18 @@ export class SASViyaApiClient {
this.boolExtensionMap = true
}
// Query the map for the current file extension
const fileExtInfo = this.fileExtensionMap.get(fileExtension)
if (fileExtInfo) {
// If the extension was found in the map, record the typeDefName and
// create a patch if a properties object was returned.
typeDefName = fileExtInfo.typeDefName
if (fileExtInfo.properties)
filePatch = { name: fileName, properties: fileExtInfo.properties }
}
}
// Create the file
const createFileResponse = await this.requestClient.post<File>(
`/files/files?parentFolderUri=${parentFolderUri}&typeDefName=${
typeDefName ?? 'file'
@@ -560,9 +562,13 @@ export class SASViyaApiClient {
headers
)
try {
// If a patch was created...
if (filePatch) {
// If a patch was created...
if (filePatch) {
try {
const patchHeaders = {
Accept: 'application/json',
'If-Match': '*'
}
// Get the URI of the newly created file
const fileUri = createFileResponse.result.links.filter(
(e) => e.method == 'PATCH' && e.rel == 'patch'
@@ -573,15 +579,14 @@ export class SASViyaApiClient {
`${fileUri}`,
filePatch,
accessToken,
'application/json',
patchHeaders
)
).result
} catch (e: any) {
throw new Error(`Error patching file ${fileName}.\n${e.message}`)
}
return createFileResponse.result
} catch (e: any) {
throw new Error(`Error patching file ${fileName}.\n${e.message}`)
}
return createFileResponse.result
}
/**

View File

@@ -272,13 +272,12 @@ export class RequestClient implements HttpClient {
public async patch<T>(
url: string,
data: any,
accessToken: string | undefined,
contentType = 'application/json',
data: any = {},
accessToken?: string,
overrideHeaders: { [key: string]: string | number } = {}
): Promise<{ result: T; etag: string }> {
const headers = {
...this.getHeaders(accessToken, contentType),
...this.getHeaders(accessToken, 'application/json'),
...overrideHeaders
}