A local-first personal finance app
Add api.setPreference(id, value) for setting synced preferences (#8893)
Alexander Lopez4befce86cca5
diff --git a/packages/api/methods.test.ts b/packages/api/methods.test.tsindex 6f99cd56c8..3aa5929764 100644--- a/packages/api/methods.test.ts+++ b/packages/api/methods.test.ts@@ -1243,3 +1243,66 @@ test('Preferences: successfully read synced preferences', async () => {hideFraction: 'true',});});++describe('API preferences: setPreference', () => {+ beforeEach(async () => {+ await api.loadBudget(budgetName);+ });++ // apis: setPreference+ test('successfully sets a single preference', async () => {+ await api.setPreference('numberFormat', '1,234.5');++ const preferences = await api.getPreferences();+ expect(preferences.numberFormat).toBe('1,234.5');+ });++ // apis: setPreference+ test('can set multiple preferences', async () => {+ await api.setPreference('numberFormat', '1,234.5');+ await api.setPreference('hideFraction', 'true');+ await api.setPreference('defaultCurrencyCode', 'USD');++ const preferences = await api.getPreferences();+ expect(preferences).toMatchObject({+ numberFormat: '1,234.5',+ hideFraction: 'true',+ defaultCurrencyCode: 'USD',+ });+ });++ // apis: setPreference+ test('can set feature flag preferences', async () => {+ await api.setPreference('flags.newSidebarUI', 'true');++ const preferences = await api.getPreferences();+ expect(preferences['flags.newSidebarUI']).toBe('true');+ });++ // apis: setPreference+ test('can set account-specific preferences', async () => {+ const accountId = 'test-account-123';+ await api.setPreference(+ `show-account-${accountId}-net-worth-chart`,+ 'false',+ );++ const preferences = await api.getPreferences();+ expect(preferences[`show-account-${accountId}-net-worth-chart`]).toBe(+ 'false',+ );+ });++ // apis: setPreference+ test('can set CSV import preferences', async () => {+ await api.setPreference(+ `csv-mappings-${budgetName}`,+ 'col1:name,col2:amount',+ );++ const preferences = await api.getPreferences();+ expect(preferences[`csv-mappings-${budgetName}`]).toBe(+ 'col1:name,col2:amount',+ );+ });+});diff --git a/packages/api/methods.ts b/packages/api/methods.tsindex f5bcf354be..86be6597c0 100644--- a/packages/api/methods.ts+++ b/packages/api/methods.ts@@ -448,3 +448,10 @@ export function getServerVersion() {export function getPreferences(): Promise<SyncedPrefs> {return send('preferences/get');}++export function setPreference<T extends keyof SyncedPrefs>(+ id: T,+ value: SyncedPrefs[T] | undefined,+): Promise<void> {+ return send('preferences/save', { id, value });+}diff --git a/packages/docs/docs/api/reference.md b/packages/docs/docs/api/reference.mdindex a116a296b2..5c71c1d127 100644--- a/packages/docs/docs/api/reference.md+++ b/packages/docs/docs/api/reference.md@@ -108,7 +108,8 @@ import APIList from './APIList';"batchBudgetUpdates","runQuery","getIDByName",-"getPreferences"+"getPreferences",+"setPreference"]} />## Types of Methods@@ -904,3 +905,9 @@ return error or the current server versions.<Method name="getPreferences" args={[]} returns="Promise<SyncedPrefs>" />Returns the budget's synced preferences — settings that sync across devices, such as the number format (`numberFormat`, `hideFraction`), currency (`defaultCurrencyCode`, `currencySymbolPosition`, `currencySpaceBetweenAmountAndSymbol`), date format (`dateFormat`), and first day of the week (`firstDayOfWeekIdx`). All values are strings (or `undefined` if the preference has never been set). The `SyncedPrefs` type is exported from `@actual-app/api/models`.++#### `setPreference`++<Method name="setPreference" args={[{ name: 'id', type: 'keyof SyncedPrefs' }, { name: 'value', type: 'string | undefined' }]} returns="Promise<void>" />++Sets a single synced preference. The `id` must be a valid SyncedPrefs key.diff --git a/upcoming-release-notes/add-api-setpreference.md b/upcoming-release-notes/add-api-setpreference.mdnew file mode 100644index 0000000000..67310f4031--- /dev/null+++ b/upcoming-release-notes/add-api-setpreference.md@@ -0,0 +1,6 @@+---+category: Enhancements+authors: [Alex-J-Lopez]+---++The api can now set synced preferences, (eg. csv colum mappings for specific accounts)