Move API key from config to secrets

src/actions.ts

@@ -17,7 +17,7 @@ export function UpdateActions(self: ModuleInstance): void {
 				},
 			],
 			callback: async (event) => {
-				const response = await fetch(`https://api.captionkit.io/v2/signal?key=${self.config.key}`, {
+				const response = await fetch(`https://api.captionkit.io/v2/signal?key=${self.secrets.key}`, {
 					method: 'POST',
 					headers: {
 						'Content-Type': 'application/json',
@@ -44,7 +44,7 @@ export function UpdateActions(self: ModuleInstance): void {
 				},
 			],
 			callback: async (event) => {
-				const response = await fetch(`https://api.captionkit.io/v2/signal?key=${self.config.key}`, {
+				const response = await fetch(`https://api.captionkit.io/v2/signal?key=${self.secrets.key}`, {
 					method: 'POST',
 					headers: {
 						'Content-Type': 'application/json',

src/config.ts

@@ -1,6 +1,10 @@
 import { type SomeCompanionConfigField } from '@companion-module/base'
 
 export interface ModuleConfig {
+	key?: string // Only when upgrading from a version that had the key in config - will be moved to secrets
+}
+
+export interface ModuleSecrets {
 	key: string
 }
 
@@ -20,7 +24,7 @@ export function GetConfigFields(): SomeCompanionConfigField[] {
 			width: 12,
 		},
 		{
-			type: 'textinput',
+			type: 'secret-text',
 			id: 'key',
 			label: 'CaptionKit API Key',
 			width: 12,

src/main.ts

@@ -5,24 +5,26 @@ import {
 	type SomeCompanionConfigField,
 	type DropdownChoice,
 } 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'
 import { UpdatePresets } from './presets.js'
 import { getLanguagesFromAPI, LanguageType } from './languages.js'
 
-export class ModuleInstance extends InstanceBase<ModuleConfig> {
+export class ModuleInstance extends InstanceBase<ModuleConfig, ModuleSecrets> {
 	config!: ModuleConfig // Setup in init()
+	secrets!: ModuleSecrets // Setup in init()
 	inputLanguages: DropdownChoice[] = [] // Cached list of languages fetched from API, used for populating dropdowns in actions and presets
 
 	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)
 
@@ -41,8 +43,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,16 +1,31 @@
-import type { CompanionStaticUpgradeScript } from '@companion-module/base'
-import type { ModuleConfig } from './config.js'
+import type {
+	CompanionStaticUpgradeScript,
+	CompanionUpgradeContext,
+	CompanionStaticUpgradeResult,
+	CompanionStaticUpgradeProps,
+} from '@companion-module/base'
+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,
-	// 		updatedActions: [],
-	// 		updatedFeedbacks: [],
-	// 	}
-	// },
+	function (
+		context: CompanionUpgradeContext<ModuleConfig>,
+		_props: CompanionStaticUpgradeProps<ModuleConfig, ModuleSecrets>,
+	): CompanionStaticUpgradeResult<ModuleConfig, ModuleSecrets> {
+		return {
+			updatedConfig: {
+				// Key will be removed - moving to secrets
+			},
+			updatedSecrets: {
+				// Migrate existing API key from config to secrets
+				// Ensure it's a string, even if it was undefined
+				key: context.currentConfig.key?.toString() || '',
+			},
+			updatedActions: [],
+			updatedFeedbacks: [],
+		}
+	},
 ]