Extension developers: Updating to the 2.15.0+ types ⚠️

[worksofliam]

As mentioned in our Release Schedule, there are a lot of API changes. You will be required to update your imports to ensure your extension will continue working for the 3.0.0 release.

We aim to release 3.0.0 on April 5th 2025.

If you are using Code for IBM i 2.15.2, then look out for warnings in the console if you're using any of the deprecated functions.

---

Full list of deprecated functions/methods for 3.0.0

• Instance::onEvent
  • Replace with Instance::subscribe
• Instance::getConfig
  • Replace with IBMi#getConfig
• Instance::getContent
  • Replace with IBMi#getContent
• IBMi#aspInfo
  • Replace with IBMi#getAllIAsps
• IBMiContent#downloadMemberContent
  • Stop using the asp (first) parameter
• IBMiContent#uploadMemberContent
  • Stop using the asp (first) parameter

Additionally, here are the functions/methods being deprecated by 4.0.0:

• IBMiContent#runSQL
  • Replace with IBMi#runSQL
• IBMiContent#writeStreamfile
  • Replace with IBMiContent#writeStreamfileRaw
• IBMiContent#downloadStreamfile
  • Replace with IBMiContent#downloadStreamfileRaw
• IBMi#downloadDirectory
  • Replace with IBMiContent#downloadDirectory
• IBMi#uploadDirectory
  • Replace with IBMiContent#uploadDirectory
• IBMi#downloadFile
  • Replace with IBMiContent#downloadFile
• IBMi#uploadFiles
  • Replace with IBMiContent#uploadFiles

Example

Here is how I went about it for the database extension.

1. update the types package.

In your package.json, update vscode-ibmi-types to at least 2.15.0.

"devDependencies": {
  "@halcyontech/vscode-ibmi-types": "^2.15.0",
}

2. type check against your repo:

Use a variation of this command to type check against your extension after the types have been updated:

npx -p typescript tsc ./src/extension.ts --excludeDirectories '**/node_modules' --allowJs --noEmit --esModuleInterop -t es2019 --moduleResolution node --skipLibCheck

You can also place it in the package.json scripts property:

  "scripts": {
    "typings": "npx -p typescript tsc ./src/extension.ts --excludeDirectories '**/node_modules' --allowJs --noEmit --esModuleInterop -t es2019 --moduleResolution node --skipLibCheck"
  }

barry@Liams-MBP vscode-db2i % npm run typings

> [email protected] typings
> npx -p typescript tsc ./src/extension.ts --excludeDirectories '**/node_modules' --allowJs --noEmit --esModuleInterop -t es2019 --moduleResolution node --skipLibCheck

...

Found 7 errors in 5 files.

Errors  Files
     2  src/base.ts:2
     2  src/connection/syntaxChecker/index.ts:2
     1  src/database/schemas.ts:402
     1  src/views/jobManager/editJob/index.ts:3
     1  src/views/jobManager/editJob/systemTab.ts:132

3. fix the problems

Here are some of the changes made in the vscode-db2i repo:

---

---

---

4. cross reference the deprecated list to find use of any deprecated functions

Make sure to remove any usage of deprecated functions before 3.0.0, and even 4.0.0.

To make your life easier, use this typescript-eslint rule to have the linter find them.