fix: improved Viya createFile to apply related properties

package-lock.json

@@ -12010,21 +12010,18 @@
       }
     },
     "node_modules/pbkdf2": {
-      "version": "3.1.5",
+      "version": "3.1.2",
-      "resolved": "https://registry.npmjs.org/pbkdf2/-/pbkdf2-3.1.5.tgz",
-      "integrity": "sha512-Q3CG/cYvCO1ye4QKkuH7EXxs3VC/rI1/trd+qX2+PolbaKG0H+bgcZzrTt96mMyRtejk+JMCiLUn3y29W8qmFQ==",
       "dev": true,
       "license": "MIT",
       "dependencies": {
-        "create-hash": "^1.2.0",
+        "create-hash": "^1.1.2",
-        "create-hmac": "^1.1.7",
+        "create-hmac": "^1.1.4",
-        "ripemd160": "^2.0.3",
+        "ripemd160": "^2.0.1",
-        "safe-buffer": "^5.2.1",
+        "safe-buffer": "^5.0.1",
-        "sha.js": "^2.4.12",
+        "sha.js": "^2.4.8"
-        "to-buffer": "^1.2.1"
       },
       "engines": {
-        "node": ">= 0.10"
+        "node": ">=0.12"
       }
     },
     "node_modules/pem": {
@@ -12783,75 +12780,14 @@
       }
     },
     "node_modules/ripemd160": {
-      "version": "2.0.3",
+      "version": "2.0.2",
-      "resolved": "https://registry.npmjs.org/ripemd160/-/ripemd160-2.0.3.tgz",
-      "integrity": "sha512-5Di9UC0+8h1L6ZD2d7awM7E/T4uA1fJRlx6zk/NvdCCVEoAnFqvHmCuNeIKoCeIixBX/q8uM+6ycDvF8woqosA==",
       "dev": true,
       "license": "MIT",
       "dependencies": {
-        "hash-base": "^3.1.2",
+        "hash-base": "^3.0.0",
-        "inherits": "^2.0.4"
+        "inherits": "^2.0.1"
-      },
-      "engines": {
-        "node": ">= 0.8"
       }
     },
-    "node_modules/ripemd160/node_modules/hash-base": {
-      "version": "3.1.2",
-      "resolved": "https://registry.npmjs.org/hash-base/-/hash-base-3.1.2.tgz",
-      "integrity": "sha512-Bb33KbowVTIj5s7Ked1OsqHUeCpz//tPwR+E2zJgJKo9Z5XolZ9b6bdUgjmYlwnWhoOQKoTd1TYToZGn5mAYOg==",
-      "dev": true,
-      "license": "MIT",
-      "dependencies": {
-        "inherits": "^2.0.4",
-        "readable-stream": "^2.3.8",
-        "safe-buffer": "^5.2.1",
-        "to-buffer": "^1.2.1"
-      },
-      "engines": {
-        "node": ">= 0.8"
-      }
-    },
-    "node_modules/ripemd160/node_modules/readable-stream": {
-      "version": "2.3.8",
-      "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-2.3.8.tgz",
-      "integrity": "sha512-8p0AUk4XODgIewSi0l8Epjs+EVnWiK7NoDIEGU0HhE7+ZyY8D1IMY7odu5lRrFXGg71L15KG8QrPmum45RTtdA==",
-      "dev": true,
-      "license": "MIT",
-      "dependencies": {
-        "core-util-is": "~1.0.0",
-        "inherits": "~2.0.3",
-        "isarray": "~1.0.0",
-        "process-nextick-args": "~2.0.0",
-        "safe-buffer": "~5.1.1",
-        "string_decoder": "~1.1.1",
-        "util-deprecate": "~1.0.1"
-      }
-    },
-    "node_modules/ripemd160/node_modules/readable-stream/node_modules/safe-buffer": {
-      "version": "5.1.2",
-      "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz",
-      "integrity": "sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==",
-      "dev": true,
-      "license": "MIT"
-    },
-    "node_modules/ripemd160/node_modules/string_decoder": {
-      "version": "1.1.1",
-      "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz",
-      "integrity": "sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==",
-      "dev": true,
-      "license": "MIT",
-      "dependencies": {
-        "safe-buffer": "~5.1.0"
-      }
-    },
-    "node_modules/ripemd160/node_modules/string_decoder/node_modules/safe-buffer": {
-      "version": "5.1.2",
-      "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz",
-      "integrity": "sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==",
-      "dev": true,
-      "license": "MIT"
-    },
     "node_modules/run-parallel": {
       "version": "1.2.0",
       "dev": true,
@@ -13172,24 +13108,15 @@
       "license": "ISC"
     },
     "node_modules/sha.js": {
-      "version": "2.4.12",
+      "version": "2.4.11",
-      "resolved": "https://registry.npmjs.org/sha.js/-/sha.js-2.4.12.tgz",
-      "integrity": "sha512-8LzC5+bvI45BjpfXU8V5fdU2mfeKiQe1D1gIMn7XUlF3OTUrpdJpPPH4EMAnF0DsHHdSZqCdSss5qCmJKuiO3w==",
       "dev": true,
       "license": "(MIT AND BSD-3-Clause)",
       "dependencies": {
-        "inherits": "^2.0.4",
+        "inherits": "^2.0.1",
-        "safe-buffer": "^5.2.1",
+        "safe-buffer": "^5.0.1"
-        "to-buffer": "^1.2.0"
       },
       "bin": {
         "sha.js": "bin.js"
-      },
-      "engines": {
-        "node": ">= 0.10"
-      },
-      "funding": {
-        "url": "https://github.com/sponsors/ljharb"
       }
     },
     "node_modules/shallow-clone": {
@@ -13938,28 +13865,6 @@
       "dev": true,
       "license": "BSD-3-Clause"
     },
-    "node_modules/to-buffer": {
-      "version": "1.2.2",
-      "resolved": "https://registry.npmjs.org/to-buffer/-/to-buffer-1.2.2.tgz",
-      "integrity": "sha512-db0E3UJjcFhpDhAF4tLo03oli3pwl3dbnzXOUIlRKrp+ldk/VUxzpWYZENsw2SZiuBjHAk7DfB0VU7NKdpb6sw==",
-      "dev": true,
-      "license": "MIT",
-      "dependencies": {
-        "isarray": "^2.0.5",
-        "safe-buffer": "^5.2.1",
-        "typed-array-buffer": "^1.0.3"
-      },
-      "engines": {
-        "node": ">= 0.4"
-      }
-    },
-    "node_modules/to-buffer/node_modules/isarray": {
-      "version": "2.0.5",
-      "resolved": "https://registry.npmjs.org/isarray/-/isarray-2.0.5.tgz",
-      "integrity": "sha512-xHjhDr3cNBK0BzdUJSPXZntQUx/mwMS5Rw4A7lPJ90XGAO6ISP/ePDNuo0vhqOZU+UD5JoodwCAAoZQd3FeAKw==",
-      "dev": true,
-      "license": "MIT"
-    },
     "node_modules/to-regex-range": {
       "version": "5.0.1",
       "dev": true,
@@ -14334,21 +14239,6 @@
         "node": ">= 0.6"
       }
     },
-    "node_modules/typed-array-buffer": {
-      "version": "1.0.3",
-      "resolved": "https://registry.npmjs.org/typed-array-buffer/-/typed-array-buffer-1.0.3.tgz",
-      "integrity": "sha512-nAYYwfY3qnzX30IkA6AQZjVbtK6duGontcQm1WSG1MD94YLqK0515GNApXkoxKOWMusVssAHWLh9SeaoefYFGw==",
-      "dev": true,
-      "license": "MIT",
-      "dependencies": {
-        "call-bound": "^1.0.3",
-        "es-errors": "^1.3.0",
-        "is-typed-array": "^1.1.14"
-      },
-      "engines": {
-        "node": ">= 0.4"
-      }
-    },
     "node_modules/typedoc": {
       "version": "0.23.24",
       "dev": true,

src/SASViyaApiClient.ts

@@ -36,6 +36,63 @@ interface JobExecutionResult {
   error?: object
 }
 
+interface IViyaTypesResponse {
+  accept: string
+  count: number
+  items: IViyaTypesItem[]
+  limit: number
+  links: IViyaTypesLink[]
+  name: string
+  start: number
+  version: number
+}
+
+interface IViyaTypesItem {
+  description?: string
+  extensions?: string[]
+  iconUri?: string
+  label: string
+  links: IViyaTypesLink[]
+  mappedTypes?: string[]
+  mediaType?: string
+  mediaTypes?: string[]
+  name: string
+  pluralLabel?: string
+  properties?: IViyaTypesProperties
+  resourceUri?: string
+  serviceRootUri?: string
+  tags?: string[]
+  version: number
+}
+
+/**
+ * Generic structure for a link
+ * in the links array of a Viya
+ * types/types api response
+ */
+interface IViyaTypesLink {
+  [key: string]: string
+}
+
+/**
+ * Generic structure for a type's
+ * 'properties' object from the Viya
+ * types/types api response
+ */
+interface IViyaTypesProperties {
+  [key: string]: string
+}
+
+/**
+ * Arbitrary interface for storing
+ * sufficient additional detail to
+ * create and patch a new file.
+ */
+interface IViyaTypesExtensionInfo {
+  typeDefName: string
+  properties: IViyaTypesProperties | undefined
+}
+
 /**
  * A client for interfacing with the SAS Viya REST API.
  *
@@ -62,6 +119,9 @@ export class SASViyaApiClient {
   )
   private folderMap = new Map<string, Job[]>()
 
+  private fileExtensionMap = new Map<string, IViyaTypesExtensionInfo>()
+  private boolExtensionMap = false // has the fileExtensionMap been populated yet?
+
   /**
    * A helper method used to call appendRequest method of RequestClient
    * @param response - response from sasjs request
@@ -434,14 +494,89 @@ export class SASViyaApiClient {
     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.
+     */
+
+    // typeDefName - Viya should automatically determine this and additional
+    // properties at runtime if not provided in the file creation request.
+    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.
+    let filePatch:
+      | {
+          name: string
+          properties: IViyaTypesProperties | undefined
+        }
+      | undefined = undefined
+
+    // The patching process requires properties related to the file-extension
+    const fileExtension: string | undefined = fileName
+      .split('.')
+      .pop()
+      ?.toLowerCase()
+
+    if (fileExtension) {
+      if (!this.boolExtensionMap) {
+        // Populate the file extension map
+        // 1. Get Viya's response to this api call
+        const typesQueryUrl = `/types/types?limit=999999`
+        const response = (
+          await this.requestClient.get(typesQueryUrl, accessToken)
+        ).result as IViyaTypesResponse
+        // 2. Filter the returned items that have file extensions into a map
+        //    using forEach as an item may relate to multiple file extensions.
+        response.items
+          .filter((e) => e.extensions)
+          .forEach((e) => {
+            e.extensions?.forEach((ext) => {
+              this.fileExtensionMap.set(ext, {
+                typeDefName: e.name, // "name:" is the typeDefName value required for file creation.
+                properties: e.properties
+              })
+            })
+          })
+        // 3. Toggle the flag to avoid repeating this step
+        this.boolExtensionMap = true
+      }
+
+      const fileExtInfo = this.fileExtensionMap.get(fileExtension)
+      if (fileExtInfo) {
+        typeDefName = fileExtInfo.typeDefName
+        if (fileExtInfo.properties)
+          filePatch = { name: fileName, properties: fileExtInfo.properties }
+      }
+    }
+
     return (
-      await this.requestClient.post<File>(
+      await this.requestClient
-        `/files/files?parentFolderUri=${parentFolderUri}&typeDefName=file#rawUpload`,
+        .post<File>(
-        formData,
+          `/files/files?parentFolderUri=${parentFolderUri}&typeDefName=${
-        accessToken,
+            typeDefName ?? 'file'
-        'multipart/form-data; boundary=' + (formData as any)._boundary,
+          }#rawUpload`,
-        headers
+          formData,
-      )
+          accessToken,
+          'multipart/form-data; boundary=' + (formData as any)._boundary,
+          headers
+        )
+        .then(async (res) => {
+          // If a patch was created...
+          if (filePatch) {
+            // Get the URI of the newly created file
+            const fileUri = res.result.links.filter(
+              (e) => e.method == 'PATCH' && e.rel == 'patch'
+            )[0].uri
+            // and apply the patch
+            return await this.requestClient.patch<File>(
+              `${fileUri}`,
+              filePatch,
+              accessToken
+            )
+          }
+          return res
+        })
     ).result
   }