A local-first personal finance app
Provide "api/category-groups-get" API endpoint (#2446)
Robert Dyer7db7b5c400b1
diff --git a/packages/api/methods.test.ts b/packages/api/methods.test.tsindex e68214d83d..ff8830010d 100644--- a/packages/api/methods.test.ts+++ b/packages/api/methods.test.ts@@ -58,11 +58,42 @@ describe('API CRUD operations', () => {await api.loadBudget(budgetName);});- // apis: createCategoryGroup, updateCategoryGroup, deleteCategoryGroup+ // apis: getCategoryGroups, createCategoryGroup, updateCategoryGroup, deleteCategoryGrouptest('CategoryGroups: successfully update category groups', async () => {const month = '2023-10';global.currentMonth = month;+ // get existing category groups+ const groups = await api.getCategoryGroups();+ expect(groups).toEqual(+ expect.arrayContaining([+ expect.objectContaining({+ hidden: 0,+ id: 'fc3825fd-b982-4b72-b768-5b30844cf832',+ is_income: 0,+ name: 'Usual Expenses',+ sort_order: 16384,+ tombstone: 0,+ }),+ expect.objectContaining({+ hidden: 0,+ id: 'a137772f-cf2f-4089-9432-822d2ddc1466',+ is_income: 0,+ name: 'Investments and Savings',+ sort_order: 32768,+ tombstone: 0,+ }),+ expect.objectContaining({+ hidden: 0,+ id: '2E1F5BDB-209B-43F9-AF2C-3CE28E380C00',+ is_income: 1,+ name: 'Income',+ sort_order: 32768,+ tombstone: 0,+ }),+ ]),+ );+// create our test category groupconst mainGroupId = await api.createCategoryGroup({name: 'test-group',diff --git a/packages/api/methods.ts b/packages/api/methods.tsindex 03acaf0f4f..cf8a6aa462 100644--- a/packages/api/methods.ts+++ b/packages/api/methods.ts@@ -121,6 +121,10 @@ export function deleteAccount(id) {return send('api/account-delete', { id });}+export function getCategoryGroups() {+ return send('api/category-groups-get');+}+export function createCategoryGroup(group) {return send('api/category-group-create', { group });}diff --git a/packages/loot-core/src/server/api.ts b/packages/loot-core/src/server/api.tsindex 2956ce61ae..13c731235a 100644--- a/packages/loot-core/src/server/api.ts+++ b/packages/loot-core/src/server/api.ts@@ -514,6 +514,11 @@ handlers['api/categories-get'] = async function ({: result.list.map(categoryModel.toExternal);};+handlers['api/category-groups-get'] = async function () {+ checkFileOpen();+ return handlers['get-category-groups']();+};+handlers['api/category-group-create'] = withMutation(async function ({group,}) {diff --git a/packages/loot-core/src/server/main.ts b/packages/loot-core/src/server/main.tsindex 64cd29938b..b5e3c0d49a 100644--- a/packages/loot-core/src/server/main.ts+++ b/packages/loot-core/src/server/main.ts@@ -361,6 +361,10 @@ handlers['category-delete'] = mutator(async function ({ id, transferId }) {});});+handlers['get-category-groups'] = async function () {+ return await db.getCategoriesGrouped();+};+handlers['category-group-create'] = mutator(async function ({name,isIncome,diff --git a/packages/loot-core/src/types/api-handlers.d.ts b/packages/loot-core/src/types/api-handlers.d.tsindex 7ad399073d..1f314fde6b 100644--- a/packages/loot-core/src/types/api-handlers.d.ts+++ b/packages/loot-core/src/types/api-handlers.d.ts@@ -109,6 +109,8 @@ export interface ApiHandlers {grouped;}) => Promise<Array<CategoryGroupEntity> | Array<CategoryEntity>>;+ 'api/category-groups-get': () => Promise<CategoryGroupEntity[]>;+'api/category-group-create': (arg: { group }) => Promise<string>;'api/category-group-update': (arg: { id; fields }) => Promise<unknown>;diff --git a/upcoming-release-notes/2446.md b/upcoming-release-notes/2446.mdnew file mode 100644index 0000000000..d37841b1cd--- /dev/null+++ b/upcoming-release-notes/2446.md@@ -0,0 +1,6 @@+---+category: Enhancements+authors: [psybers]+---++Provide "api/category-groups-get" API endpoint\ No newline at end of file