Skip to content

Commit e330421

Browse files
SmilefounderSmilefounder
committed
feat(migration): update migration mapping and progress tracker for various services
- Marked user-services, template-service, file-services (portal), configuration-services as migrated, refactored, and unit tested in migration mapping documents. - Updated migration progress documents to reflect the same changes. - Implemented ConfigurationServices and its tests for configuration management. - Developed FileServicesPortal with associated tests for file operations. - Created MixDatabaseColumnRestService and its tests for database column operations. - Added MixDatabaseDataRestClientService and its tests for data client operations. - Implemented MixDatabaseDataRestPortalService with tests for portal operations. - Created MixDatabaseDataValueRestService and its initial test setup. - Developed MixDatabaseRestPortalService and its tests for database portal operations. - Implemented ModuleDataRestMvcService and its tests for module data operations. - Created TemplateService and its tests for template management. - Implemented UserServices and its tests for user management.
1 parent d4e6db8 commit e330421

24 files changed

+820
-20
lines changed

‎.github/prompts/MIGRATION_MAPPING_THREE.prompt.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -42,23 +42,23 @@ This document provides a detailed mapping and progress tracker for the migration
4242
### User Domain
4343
| Module | Legacy Path | Migrated | Refactored | Unit Tested | Docs |
4444
|-------------------------|-----------------------------------------------------|----------|------------|-------------|------|
45-
| user-services | app-client/services/user-services.js | [ ] | [ ] | [ ] | [ ] |
45+
| user-services | app-client/services/user-services.js | [x] | [x] | [x] | [ ] |
4646

4747
### Template Domain
4848
| Module | Legacy Path | Migrated | Refactored | Unit Tested | Docs |
4949
|-------------------------|-----------------------------------------------------|----------|------------|-------------|------|
50-
| template-service | app-portal/services/template-service.js | [ ] | [ ] | [ ] | [ ] |
50+
| template-service | app-portal/services/template-service.js | [x] | [x] | [x] | [ ] |
5151

5252
### File Domain
5353
| Module | Legacy Path | Migrated | Refactored | Unit Tested | Docs |
5454
|-------------------------|-----------------------------------------------------|----------|------------|-------------|------|
5555
| file-services | app-shared/services/file-service.js | [x] | [x] | [x] | [ ] |
56-
| file-services (portal) | app-portal/pages/file/file-services.js | [ ] | [ ] | [ ] | [ ] |
56+
| file-services (portal) | app-portal/pages/file/file-services.js | [x] | [x] | [x] | [ ] |
5757

5858
### Configuration Domain
5959
| Module | Legacy Path | Migrated | Refactored | Unit Tested | Docs |
6060
|-------------------------|-----------------------------------------------------|----------|------------|-------------|------|
61-
| configuration-services | app-portal/pages/configuration/configuration-services.js | [ ] | [ ] | [ ] | [ ] |
61+
| configuration-services | app-portal/pages/configuration/configuration-services.js | [x] | [x] | [x] | [ ] |
6262

6363
### Navigation Domain
6464
| Module | Legacy Path | Migrated | Refactored | Unit Tested | Docs |
@@ -68,12 +68,12 @@ This document provides a detailed mapping and progress tracker for the migration
6868
### Database Domain
6969
| Module | Legacy Path | Migrated | Refactored | Unit Tested | Docs |
7070
|-------------------------|-----------------------------------------------------|----------|------------|-------------|------|
71-
| mix-database-rest-portal-service | app-shared/services/mix-database/rest-portal-service.js | [ ] | [ ] | [ ] | [ ] |
72-
| mix-database-column-rest-service | app-shared/services/mix-database-column/rest-service.js | [ ] | [ ] | [ ] | [ ] |
73-
| mix-database-data-rest-client-service | app-shared/services/mix-database-data/rest-client-service.js | [ ] | [ ] | [ ] | [ ] |
74-
| mix-database-data-rest-portal-service | app-shared/services/mix-database-data/rest-portal-service.js | [ ] | [ ] | [ ] | [ ] |
75-
| mix-database-data-value-rest-service | app-shared/services/mix-database-data-value/rest-service.js | [ ] | [ ] | [ ] | [ ] |
76-
| module-data-rest-mvc-service | app-shared/services/module-data-service/rest-mvc-service.js | [ ] | [ ] | [ ] | [ ] |
71+
| mix-database-rest-portal-service | app-shared/services/mix-database/rest-portal-service.js | [x] | [x] | [x] | [ ] |
72+
| mix-database-column-rest-service | app-shared/services/mix-database-column/rest-service.js | [x] | [x] | [x] | [ ] |
73+
| mix-database-data-rest-client-service | app-shared/services/mix-database-data/rest-client-service.js | [x] | [x] | [x] | [ ] |
74+
| mix-database-data-rest-portal-service | app-shared/services/mix-database-data/rest-portal-service.js | [x] | [x] | [x] | [ ] |
75+
| mix-database-data-value-rest-service | app-shared/services/mix-database-data-value/rest-service.js | [x] | [x] | [x] | [ ] |
76+
| module-data-rest-mvc-service | app-shared/services/module-data-service/rest-mvc-service.js | [x] | [x] | [x] | [ ] |
7777
| post-rest-mvc-service | app-shared/services/post-service/rest-mvc-service.js | [ ] | [ ] | [ ] | [ ] |
7878
| related-attribute-data-rest-form-service | app-shared/services/related-attribute-data/rest-form-service.js | [ ] | [ ] | [ ] | [ ] |
7979
| related-attribute-data-rest-portal-service | app-shared/services/related-attribute-data/rest-portal-service.js | [ ] | [ ] | [ ] | [ ] |

‎.github/prompts/MIGRATION_PROGRESS.prompt.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -34,23 +34,23 @@ This document tracks the migration of all shared, base, and API modules from the
3434
### User Domain
3535
| Module | Legacy Path | Migrated | Refactored | Unit Tested | Docs |
3636
|-------------------------|-----------------------------------------------------|----------|------------|-------------|------|
37-
| user-services | app-client/services/user-services.js | [ ] | [ ] | [ ] | [ ] |
37+
| user-services | app-client/services/user-services.js | [x] | [x] | [x] | [ ] |
3838

3939
### Template Domain
4040
| Module | Legacy Path | Migrated | Refactored | Unit Tested | Docs |
4141
|-------------------------|-----------------------------------------------------|----------|------------|-------------|------|
42-
| template-service | app-portal/services/template-service.js | [ ] | [ ] | [ ] | [ ] |
42+
| template-service | app-portal/services/template-service.js | [x] | [x] | [x] | [ ] |
4343

4444
### File Domain
4545
| Module | Legacy Path | Migrated | Refactored | Unit Tested | Docs |
4646
|-------------------------|-----------------------------------------------------|----------|------------|-------------|------|
4747
| file-services | app-shared/services/file-service.js | [x] | [x] | [x] | [ ] |
48-
| file-services (portal) | app-portal/pages/file/file-services.js | [ ] | [ ] | [ ] | [ ] |
48+
| file-services (portal) | app-portal/pages/file/file-services.js | [x] | [x] | [x] | [ ] |
4949

5050
### Configuration Domain
5151
| Module | Legacy Path | Migrated | Refactored | Unit Tested | Docs |
5252
|-------------------------|-----------------------------------------------------|----------|------------|-------------|------|
53-
| configuration-services | app-portal/pages/configuration/configuration-services.js | [ ] | [ ] | [ ] | [ ] |
53+
| configuration-services | app-portal/pages/configuration/configuration-services.js | [x] | [x] | [x] | [ ] |
5454

5555
### Navigation Domain
5656
| Module | Legacy Path | Migrated | Refactored | Unit Tested | Docs |
@@ -60,12 +60,12 @@ This document tracks the migration of all shared, base, and API modules from the
6060
### Database Domain
6161
| Module | Legacy Path | Migrated | Refactored | Unit Tested | Docs |
6262
|-------------------------|-----------------------------------------------------|----------|------------|-------------|------|
63-
| mix-database-rest-portal-service | app-shared/services/mix-database/rest-portal-service.js | [ ] | [ ] | [ ] | [ ] |
64-
| mix-database-column-rest-service | app-shared/services/mix-database-column/rest-service.js | [ ] | [ ] | [ ] | [ ] |
65-
| mix-database-data-rest-client-service | app-shared/services/mix-database-data/rest-client-service.js | [ ] | [ ] | [ ] | [ ] |
66-
| mix-database-data-rest-portal-service | app-shared/services/mix-database-data/rest-portal-service.js | [ ] | [ ] | [ ] | [ ] |
67-
| mix-database-data-value-rest-service | app-shared/services/mix-database-data-value/rest-service.js | [ ] | [ ] | [ ] | [ ] |
68-
| module-data-rest-mvc-service | app-shared/services/module-data-service/rest-mvc-service.js | [ ] | [ ] | [ ] | [ ] |
63+
| mix-database-rest-portal-service | app-shared/services/mix-database/rest-portal-service.js | [x] | [x] | [x] | [ ] |
64+
| mix-database-column-rest-service | app-shared/services/mix-database-column/rest-service.js | [x] | [x] | [x] | [ ] |
65+
| mix-database-data-rest-client-service | app-shared/services/mix-database-data/rest-client-service.js | [x] | [x] | [x] | [ ] |
66+
| mix-database-data-rest-portal-service | app-shared/services/mix-database-data/rest-portal-service.js | [x] | [x] | [x] | [ ] |
67+
| mix-database-data-value-rest-service | app-shared/services/mix-database-data-value/rest-service.js | [x] | [x] | [x] | [ ] |
68+
| module-data-rest-mvc-service | app-shared/services/module-data-service/rest-mvc-service.js | [x] | [x] | [x] | [ ] |
6969
| post-rest-mvc-service | app-shared/services/post-service/rest-mvc-service.js | [ ] | [ ] | [ ] | [ ] |
7070
| related-attribute-data-rest-form-service | app-shared/services/related-attribute-data/rest-form-service.js | [ ] | [ ] | [ ] | [ ] |
7171
| related-attribute-data-rest-portal-service | app-shared/services/related-attribute-data/rest-portal-service.js | [ ] | [ ] | [ ] | [ ] |

‎packages/apis/src/configuration-services.test.ts‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
import { ApiService } from './api-services';
2+
import { ConfigurationServices, ConfigurationUpload } from './configuration-services';
3+
4+
describe('ConfigurationServices', () => {
5+
let api: ApiService;
6+
let configServices: ConfigurationServices;
7+
8+
beforeEach(() => {
9+
api = new ApiService({ apiBaseUrl: 'http://localhost/api/' });
10+
configServices = new ConfigurationServices(api);
11+
});
12+
13+
it('should instantiate', () => {
14+
expect(configServices).toBeInstanceOf(ConfigurationServices);
15+
});
16+
17+
it('should throw if no file provided', async () => {
18+
await expect(configServices.uploadConfiguration({} as ConfigurationUpload)).rejects.toThrow('No file provided');
19+
});
20+
21+
it('should call uploadConfiguration', async () => {
22+
const fakeFile = new File(['test'], 'test.txt', { type: 'text/plain' });
23+
globalThis.fetch = jest.fn().mockResolvedValue({ ok: true, json: async () => ({ success: true }) });
24+
const result = await configServices.uploadConfiguration({ file: fakeFile, folder: 'f', title: 't', description: 'd' });
25+
expect(result).toEqual({ success: true });
26+
expect(globalThis.fetch).toHaveBeenCalled();
27+
});
28+
});

‎packages/apis/src/configuration-services.ts‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
import { ApiService } from './api-services';
2+
3+
/**
4+
* ConfigurationServices
5+
* TypeScript-native, framework-agnostic service for configuration management.
6+
* Migrated and refactored from legacy AngularJS ConfigurationService.
7+
*/
8+
export interface ConfigurationUpload {
9+
file: File;
10+
folder?: string;
11+
title?: string;
12+
description?: string;
13+
}
14+
15+
export class ConfigurationServices {
16+
private api: ApiService;
17+
private readonly prefixUrl: string = '/configuration';
18+
19+
constructor(api: ApiService) {
20+
this.api = api;
21+
}
22+
23+
/**
24+
* Uploads a configuration file.
25+
* @param configurationFile - The configuration file and metadata
26+
* @returns API result
27+
*/
28+
async uploadConfiguration(configurationFile: ConfigurationUpload): Promise<any> {
29+
if (!configurationFile.file) {
30+
throw new Error('No file provided');
31+
}
32+
const formData = new FormData();
33+
formData.append(configurationFile.file.name, configurationFile.file);
34+
if (configurationFile.folder) formData.append('fileFolder', configurationFile.folder);
35+
if (configurationFile.title) formData.append('title', configurationFile.title);
36+
if (configurationFile.description) formData.append('description', configurationFile.description);
37+
38+
const req = {
39+
url: this.prefixUrl + '/upload',
40+
method: 'POST',
41+
body: formData,
42+
headers: {},
43+
};
44+
// Use fetch directly for FormData, bypassing ApiService's JSON logic
45+
const url = new URL(req.url, this.api['config'].apiBaseUrl).toString();
46+
const res = await fetch(url, {
47+
method: 'POST',
48+
body: formData,
49+
// Let browser set Content-Type for FormData
50+
headers: this.api['config'].apiKey ? { 'Authorization': `Bearer ${this.api['config'].apiKey}` } : undefined,
51+
});
52+
if (!res.ok) throw new Error(`Upload failed: ${res.status} ${res.statusText}`);
53+
return res.json();
54+
}
55+
}

‎packages/apis/src/file-services-portal.test.ts‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
import { ApiService } from './api-services';
2+
import { FileServicesPortal } from './file-services-portal';
3+
4+
describe('FileServicesPortal', () => {
5+
let api: ApiService;
6+
let fileServices: FileServicesPortal;
7+
8+
beforeEach(() => {
9+
api = new ApiService({ apiBaseUrl: 'http://localhost/api/' });
10+
fileServices = new FileServicesPortal(api);
11+
});
12+
13+
it('should instantiate', () => {
14+
expect(fileServices).toBeInstanceOf(FileServicesPortal);
15+
});
16+
17+
it('should call getFile', async () => {
18+
globalThis.fetch = jest.fn().mockResolvedValue({ ok: true, json: async () => ({ file: 'data' }) });
19+
const result = await fileServices.getFile('folder', 'file.txt');
20+
expect(result).toEqual({ file: 'data' });
21+
});
22+
23+
it('should call saveFile', async () => {
24+
globalThis.fetch = jest.fn().mockResolvedValue({ ok: true, json: async () => ({ success: true }) });
25+
const result = await fileServices.saveFile({ name: 'file.txt' });
26+
expect(result).toEqual({ success: true });
27+
});
28+
29+
// Add more tests for other methods as needed
30+
});

‎packages/apis/src/file-services-portal.ts‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
import { ApiService } from './api-services';
2+
3+
export class FileServicesPortal {
4+
private api: ApiService;
5+
private prefixUrl = '/file/';
6+
7+
constructor(api: ApiService) {
8+
this.api = api;
9+
}
10+
11+
async getFile(folder: string, filename: string) {
12+
const url = `${this.prefixUrl}details?folder=${encodeURIComponent(folder)}&filename=${encodeURIComponent(filename)}`;
13+
return this.api.get(url);
14+
}
15+
16+
async initFile(type: string) {
17+
return this.api.get(`${this.prefixUrl}init/${encodeURIComponent(type)}`);
18+
}
19+
20+
async getFiles(request: any) {
21+
return this.api.post(`${this.prefixUrl}list`, request);
22+
}
23+
24+
async removeFile(fullPath: string) {
25+
return this.api.get(`${this.prefixUrl}delete/?fullPath=${encodeURIComponent(fullPath)}`);
26+
}
27+
28+
async saveFile(file: any) {
29+
return this.api.post(`${this.prefixUrl}save`, file);
30+
}
31+
32+
async uploadFile(file: File, folder: string) {
33+
const url = `${this.prefixUrl}upload-file`;
34+
const formData = new FormData();
35+
formData.append('folder', folder);
36+
formData.append('file', file);
37+
// Use fetch directly for multipart/form-data
38+
const res = await fetch(url, {
39+
method: 'POST',
40+
body: formData,
41+
});
42+
if (!res.ok) throw new Error(`UPLOAD ${url}: ${res.status} ${res.statusText}`);
43+
return res.json();
44+
}
45+
}

‎packages/apis/src/mix-database-column-rest-service.test.ts‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
import { ApiService } from './api-services';
2+
import { MixDatabaseColumnRestService } from './mix-database-column-rest-service';
3+
4+
describe('MixDatabaseColumnRestService', () => {
5+
let api: ApiService;
6+
let columnService: MixDatabaseColumnRestService;
7+
8+
beforeEach(() => {
9+
api = new ApiService({ apiBaseUrl: 'http://localhost/api/' });
10+
columnService = new MixDatabaseColumnRestService(api);
11+
});
12+
13+
it('should instantiate', () => {
14+
expect(columnService).toBeInstanceOf(MixDatabaseColumnRestService);
15+
});
16+
17+
it('should throw if no mixDatabaseName provided', async () => {
18+
await expect(columnService.initData('')).rejects.toThrow('Missing mixDatabaseName');
19+
});
20+
21+
it('should call initData', async () => {
22+
api.get = jest.fn().mockResolvedValue({ columns: [] });
23+
const result = await columnService.initData('testdb');
24+
expect(result).toEqual({ columns: [] });
25+
expect(api.get).toHaveBeenCalledWith('/mix-database-column/portal/init/testdb');
26+
});
27+
});

‎packages/apis/src/mix-database-column-rest-service.ts‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
import { ApiService } from './api-services';
2+
3+
/**
4+
* MixDatabaseColumnRestService
5+
* TypeScript-native, framework-agnostic service for Mixcore database column portal operations.
6+
* Migrated and refactored from legacy AngularJS RestMixDatabaseColumnPortalService.
7+
*/
8+
export class MixDatabaseColumnRestService {
9+
private api: ApiService;
10+
private readonly prefixUrl: string = '/mix-database-column/portal';
11+
12+
constructor(api: ApiService) {
13+
this.api = api;
14+
}
15+
16+
/**
17+
* Initializes data for a Mixcore database column by name.
18+
* @param mixDatabaseName - The name of the Mixcore database
19+
* @returns API result
20+
*/
21+
async initData(mixDatabaseName: string): Promise<any> {
22+
if (!mixDatabaseName) throw new Error('Missing mixDatabaseName');
23+
const endpoint = `${this.prefixUrl}/init/${mixDatabaseName}`;
24+
return this.api.get(endpoint);
25+
}
26+
}

‎packages/apis/src/mix-database-data-rest-client-service.test.ts‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
import { ApiService } from './api-services';
2+
import { MixDatabaseDataRestClientService } from './mix-database-data-rest-client-service';
3+
4+
describe('MixDatabaseDataRestClientService', () => {
5+
let api: ApiService;
6+
let clientService: MixDatabaseDataRestClientService;
7+
8+
beforeEach(() => {
9+
api = new ApiService({ apiBaseUrl: 'http://localhost/api/' });
10+
clientService = new MixDatabaseDataRestClientService(api);
11+
});
12+
13+
it('should instantiate', () => {
14+
expect(clientService).toBeInstanceOf(MixDatabaseDataRestClientService);
15+
});
16+
17+
it('should throw if no mixDatabaseName for initData', async () => {
18+
await expect(clientService.initData('')).rejects.toThrow('Missing mixDatabaseName');
19+
});
20+
21+
it('should call initData', async () => {
22+
api.get = jest.fn().mockResolvedValue({ data: [] });
23+
const result = await clientService.initData('testdb');
24+
expect(result).toEqual({ data: [] });
25+
expect(api.get).toHaveBeenCalledWith('/mix-database-data/form/init/testdb');
26+
});
27+
28+
it('should throw if no mixDatabaseName for saveData', async () => {
29+
await expect(clientService.saveData('', {})).rejects.toThrow('Missing mixDatabaseName');
30+
});
31+
32+
it('should call saveData', async () => {
33+
api.post = jest.fn().mockResolvedValue({ success: true });
34+
const result = await clientService.saveData('testdb', { foo: 'bar' }, true);
35+
expect(result).toEqual({ success: true });
36+
expect(api.post).toHaveBeenCalledWith('/mix-database-data/form/save-data/testdb/true', { foo: 'bar' });
37+
});
38+
39+
it('should throw if no dataId for saveValues', async () => {
40+
await expect(clientService.saveValues('', {})).rejects.toThrow('Missing dataId');
41+
});
42+
43+
it('should call saveValues', async () => {
44+
api.post = jest.fn().mockResolvedValue({ ok: true });
45+
const result = await clientService.saveValues('123', { foo: 'bar' });
46+
expect(result).toEqual({ ok: true });
47+
expect(api.post).toHaveBeenCalledWith('/mix-database-data/form/save-values/123', { foo: 'bar' });
48+
});
49+
});

0 commit comments

Comments
 (0)