feat: add userconfig to import-export

Author: krocheck

companion/lib/Data/ImportExport.js

@@ -377,6 +377,10 @@ class DataImportExport extends CoreBase {
 				exp.surfaceGroups = this.surfaces.exportAllGroups(false)
 			}
 
+			if (!config || !isFalsey(config.userconfig)) {
+				exp.userconfig = this.userconfig.getAll(false)
+			}
+
 			return exp
 		}
 
@@ -619,6 +623,7 @@ class DataImportExport extends CoreBase {
 				customVariables: 'custom_variables' in object,
 				surfaces: 'surfaces' in object,
 				triggers: 'triggers' in object,
+				userconfig: 'userconfig' in object,
 			}
 
 			for (const [instanceId, instance] of Object.entries(object.instances || {})) {
@@ -745,6 +750,11 @@ class DataImportExport extends CoreBase {
 				// Destroy old stuff
 				await this.#reset(undefined, !config || config.buttons)
 
+				// import userconfig
+				if (!config || config.userconfig) {
+					this.userconfig.setKeys(data.userconfig || {})
+				}
+
 				// import custom variables
 				if (!config || config.customVariables) {
 					this.instance.variable.custom.replaceDefinitions(data.custom_variables || {})

companion/lib/Data/UserConfig.js

@@ -280,6 +280,23 @@ class DataUserConfig extends CoreBase {
 		})
 	}
 
+	/**
+	 * Get the config settings
+	 * @param {boolean} [clone = false] - <code>true</code> if a clone is needed instead of a link
+	 * @returns {any} the config values
+	 * @access public
+	 */
+	getAll(clone = false) {
+		// @ts-ignore
+		let out = this.data
+
+		if (clone === true) {
+			out = cloneDeep(out)
+		}
+
+		return out
+	}
+
 	/**
 	 * Get a specific use config setting
 	 * @param {string} key

shared-lib/lib/Model/ExportModel.ts

@@ -1,4 +1,4 @@
-import type { UserConfigGridSize } from './UserConfigModel.js'
+import type { UserConfigGridSize, UserConfigModel } from './UserConfigModel.js'
 import type { ConnectionConfig } from './Connections.js'
 import type { CustomVariablesModel } from './CustomVariableModel.js'
 
@@ -16,6 +16,7 @@ export interface ExportFullv4 extends ExportBase<'full'> {
 	instances?: ExportInstancesv4
 	surfaces?: unknown
 	surfaceGroups?: unknown
+	userconfig?: UserConfigModel
 }
 
 export interface ExportPageModelv4 extends ExportBase<'page'> {

shared-lib/lib/Model/ImportExport.ts

@@ -16,7 +16,7 @@ export interface ClientExportSelection {
 	customVariables: boolean
 	connections: boolean
 	surfaces: boolean
-
+	userconfig: boolean
 	format: ExportFormat
 }
 
@@ -25,6 +25,7 @@ export interface ClientImportSelection {
 	customVariables: boolean
 	surfaces: boolean
 	triggers: boolean
+	userconfig: boolean
 }
 
 export interface ClientPageInfo {
@@ -43,6 +44,7 @@ export interface ClientImportObject {
 	customVariables: boolean
 	surfaces: boolean
 	triggers: boolean | Record<string, { name: string }>
+	userconfig: boolean
 	oldPageNumber?: number
 	page?: ClientPageInfo
 	pages?: Record<number, ClientPageInfo>

webui/src/ImportExport/Export.tsx

@@ -19,7 +19,7 @@ export const ExportWizardModal = forwardRef<ExportWizardModalRef, ExportWizardMo
 			surfaces: true,
 			triggers: true,
 			customVariables: true,
-			// userconfig: true,
+			userconfig: true,
 			format: ExportFormatDefault,
 		})
 
@@ -69,7 +69,7 @@ export const ExportWizardModal = forwardRef<ExportWizardModalRef, ExportWizardMo
 						surfaces: true,
 						triggers: true,
 						customVariables: true,
-						// userconfig: true,
+						userconfig: true,
 						format: ExportFormatDefault,
 					})
 
@@ -177,7 +177,7 @@ function ExportOptionsStep({ config, setValue }: ExportOptionsStepProps) {
 					<CLabel htmlFor="wizard_surfaces">Surfaces</CLabel>
 				</div>
 			</div>
-			{/* <div className="indent3">
+			<div className="indent3">
 				<div className="form-check form-check-inline mr-1">
 					<CInputCheckbox
 						id="wizard_userconfig"
@@ -186,7 +186,7 @@ function ExportOptionsStep({ config, setValue }: ExportOptionsStepProps) {
 					/>
 					<CLabel htmlFor="wizard_userconfig">Settings</CLabel>
 				</div>
-			</div> */}
+			</div>
 
 			<div className="indent3">
 				<div className="form-check form-check-inline mr-1">

webui/src/ImportExport/Import/Full.tsx

@@ -136,7 +136,7 @@ function FullImportTab({ snapshot }: FullImportTabProps) {
 		surfaces: true,
 		triggers: true,
 		customVariables: true,
-		// userconfig: true,
+		userconfig: true,
 	}))
 
 	const validConfigKeys = Object.entries(config).filter(([k, v]) => v && snapshotKeys.includes(k))
@@ -208,13 +208,13 @@ function FullImportTab({ snapshot }: FullImportTabProps) {
 
 			<InputCheckbox config={config} allowKeys={snapshotKeys} keyName="surfaces" setValue={setValue} label="Surfaces" />
 
-			{/* <InputCheckbox
+			<InputCheckbox
 				config={config}
 				allowKeys={snapshotKeys}
 				keyName="userconfig"
 				setValue={setValue}
 				label="Settings"
-			/> */}
+			/>
 
 			<CAlert color="info">
 				All the connections will be imported, as they are required to be able to import any actions and feedbacks.