Add secrets framework to template

package.json

@@ -23,18 +23,18 @@
 		"yarn": "^4"
 	},
 	"dependencies": {
-		"@companion-module/base": "~1.12.1"
+		"@companion-module/base": "~1.13.5"
 	},
 	"devDependencies": {
 		"@companion-module/tools": "^2.4.2",
-		"@types/node": "^22.18.13",
-		"eslint": "^9.39.0",
+		"@types/node": "^22.19.1",
+		"eslint": "^9.39.1",
 		"husky": "^9.1.7",
-		"lint-staged": "^16.2.6",
-		"prettier": "^3.6.2",
-		"rimraf": "^6.1.0",
-		"typescript": "~5.8.3",
-		"typescript-eslint": "^8.46.2"
+		"lint-staged": "^16.2.7",
+		"prettier": "^3.7.3",
+		"rimraf": "^6.1.2",
+		"typescript": "~5.9.3",
+		"typescript-eslint": "^8.48.0"
 	},
 	"prettier": "@companion-module/tools/.prettierrc.json",
 	"lint-staged": {
@@ -45,5 +45,5 @@
 			"yarn lint:raw --fix"
 		]
 	},
-	"packageManager": "yarn@4.10.3"
+	"packageManager": "yarn@4.12.0"
 }

src/config.ts

@@ -5,6 +5,10 @@ export interface ModuleConfig {
 	port: number
 }
 
+// Define secret-text type config options here
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
+export interface ModuleSecrets {}
+
 export function GetConfigFields(): SomeCompanionConfigField[] {
 	return [
 		{

src/main.ts

@@ -1,19 +1,21 @@
 import { InstanceBase, runEntrypoint, InstanceStatus, SomeCompanionConfigField } from '@companion-module/base'
-import { GetConfigFields, type ModuleConfig } from './config.js'
+import { GetConfigFields, type ModuleConfig, type ModuleSecrets } from './config.js'
 import { UpdateVariableDefinitions } from './variables.js'
 import { UpgradeScripts } from './upgrades.js'
 import { UpdateActions } from './actions.js'
 import { UpdateFeedbacks } from './feedbacks.js'
 
-export class ModuleInstance extends InstanceBase<ModuleConfig> {
+export class ModuleInstance extends InstanceBase<ModuleConfig, ModuleSecrets> {
 	config!: ModuleConfig // Setup in init()
+	secrets!: ModuleSecrets
 
 	constructor(internal: unknown) {
 		super(internal)
 	}
 
-	async init(config: ModuleConfig): Promise<void> {
+	async init(config: ModuleConfig, _isFirstInit: boolean, secrets: ModuleSecrets): Promise<void> {
 		this.config = config
+		this.secrets = secrets
 
 		this.updateStatus(InstanceStatus.Ok)
 
@@ -26,8 +28,9 @@ export class ModuleInstance extends InstanceBase<ModuleConfig> {
 		this.log('debug', 'destroy')
 	}
 
-	async configUpdated(config: ModuleConfig): Promise<void> {
+	async configUpdated(config: ModuleConfig, secrets: ModuleSecrets): Promise<void> {
 		this.config = config
+		this.secrets = secrets
 	}
 
 	// Return config fields for web config

src/upgrades.ts

@@ -1,14 +1,15 @@
 import type { CompanionStaticUpgradeScript } from '@companion-module/base'
-import type { ModuleConfig } from './config.js'
+import type { ModuleConfig, ModuleSecrets } from './config.js'
 
-export const UpgradeScripts: CompanionStaticUpgradeScript<ModuleConfig>[] = [
+export const UpgradeScripts: CompanionStaticUpgradeScript<ModuleConfig, ModuleSecrets>[] = [
 	/*
 	 * Place your upgrade scripts here
 	 * Remember that once it has been added it cannot be removed!
 	 */
 	// function (context, props) {
 	// 	return {
 	// 		updatedConfig: null,
+	//		updatedSecrets: null,
 	// 		updatedActions: [],
 	// 		updatedFeedbacks: [],
 	// 	}