-
Notifications
You must be signed in to change notification settings - Fork 305
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(taxonomy): added metadata taxonomy field support (#3710)
* feat(taxonomy): added metadata taxonomy field support * feat(taxonomy): fixed missing const * feat(taxonomy): removed comments * test: add test for metadata taxonomy fetcher * feat(taxonomy): upgraded package * feat(taxonomy): fixed query string name * feat(taxonomy): removed only * feat(taxonomy): added test wrapper --------- Co-authored-by: jnaskreski <[email protected]>
- Loading branch information
1 parent
e735c4c
commit 3a0c27e
Showing
9 changed files
with
196 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
96 changes: 96 additions & 0 deletions
96
src/elements/content-sidebar/__tests__/metadataTaxonomyFetcher.test.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,96 @@ | ||
import type { PaginationQueryInput } from '@box/metadata-editor'; | ||
import { metadataTaxonomyFetcher } from '../fetchers/metadataTaxonomyFetcher'; | ||
import type API from '../../../api'; | ||
|
||
describe('metadataTaxonomyFetcher', () => { | ||
let apiMock: jest.Mocked<API>; | ||
const fileId = '12345'; | ||
const scope = 'global'; | ||
const templateKey = 'template_123'; | ||
const fieldKey = 'field_abc'; | ||
const level = 1; | ||
const options: PaginationQueryInput = { marker: 'marker_1' }; | ||
|
||
beforeEach(() => { | ||
apiMock = { | ||
getMetadataAPI: jest.fn().mockReturnValue({ | ||
getMetadataOptions: jest.fn(), | ||
}), | ||
}; | ||
}); | ||
|
||
test('should fetch metadata options and return formatted data', async () => { | ||
const mockMetadataOptions = { | ||
entries: [ | ||
{ id: 'opt1', display_name: 'Option 1' }, | ||
{ id: 'opt2', display_name: 'Option 2' }, | ||
], | ||
}; | ||
|
||
apiMock.getMetadataAPI(false).getMetadataOptions.mockResolvedValue(mockMetadataOptions); | ||
|
||
const result = await metadataTaxonomyFetcher(apiMock, fileId, scope, templateKey, fieldKey, level, options); | ||
|
||
const expectedResult = { | ||
options: [ | ||
{ value: 'opt1', displayValue: 'Option 1' }, | ||
{ value: 'opt2', displayValue: 'Option 2' }, | ||
], | ||
marker: 'marker_1', | ||
}; | ||
|
||
expect(apiMock.getMetadataAPI).toHaveBeenCalledWith(false); | ||
expect(apiMock.getMetadataAPI(false).getMetadataOptions).toHaveBeenCalledWith( | ||
fileId, | ||
scope, | ||
templateKey, | ||
fieldKey, | ||
level, | ||
options, | ||
); | ||
expect(result).toEqual(expectedResult); | ||
}); | ||
|
||
test('should handle empty entries array', async () => { | ||
const mockMetadataOptions = { | ||
entries: [], | ||
}; | ||
|
||
apiMock.getMetadataAPI(false).getMetadataOptions.mockResolvedValue(mockMetadataOptions); | ||
|
||
const result = await metadataTaxonomyFetcher(apiMock, fileId, scope, templateKey, fieldKey, level, options); | ||
|
||
const expectedResult = { | ||
options: [], | ||
marker: 'marker_1', | ||
}; | ||
|
||
expect(result).toEqual(expectedResult); | ||
}); | ||
|
||
test('should set marker to null if not provided in options', async () => { | ||
const mockMetadataOptions = { | ||
entries: [{ id: 'opt1', display_name: 'Option 1' }], | ||
}; | ||
|
||
apiMock.getMetadataAPI(false).getMetadataOptions.mockResolvedValue(mockMetadataOptions); | ||
|
||
const result = await metadataTaxonomyFetcher(apiMock, fileId, scope, templateKey, fieldKey, level, {}); | ||
|
||
const expectedResult = { | ||
options: [{ value: 'opt1', displayValue: 'Option 1' }], | ||
marker: null, | ||
}; | ||
|
||
expect(result).toEqual(expectedResult); | ||
}); | ||
|
||
test('should throw an error if getMetadataOptions fails', async () => { | ||
const error = new Error('API Error'); | ||
apiMock.getMetadataAPI(false).getMetadataOptions.mockRejectedValue(error); | ||
|
||
await expect( | ||
metadataTaxonomyFetcher(apiMock, fileId, scope, templateKey, fieldKey, level, options), | ||
).rejects.toThrow('API Error'); | ||
}); | ||
}); |
26 changes: 26 additions & 0 deletions
26
src/elements/content-sidebar/fetchers/metadataTaxonomyFetcher.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
import type { PaginationQueryInput } from '@box/metadata-editor'; | ||
import type API from '../../../api'; | ||
import type { MetadataOptionEntry } from '../../../common/types/metadata'; | ||
|
||
export const metadataTaxonomyFetcher = async ( | ||
api: API, | ||
fileId: string, | ||
scope: string, | ||
templateKey: string, | ||
fieldKey: string, | ||
level: number, | ||
options: PaginationQueryInput, | ||
) => { | ||
const metadataOptions = await api | ||
.getMetadataAPI(false) | ||
.getMetadataOptions(fileId, scope, templateKey, fieldKey, level, options); | ||
const { marker = null } = options; | ||
|
||
return { | ||
options: metadataOptions.entries.map((metadataOption: MetadataOptionEntry) => ({ | ||
value: metadataOption.id, | ||
displayValue: metadataOption.display_name, | ||
})), | ||
marker, | ||
}; | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters