Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Datahub]: Api form formats output #861

Merged
merged 19 commits into from
May 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions apps/datahub-e2e/src/e2e/datasetDetailPage.cy.ts
Original file line number Diff line number Diff line change
Expand Up @@ -641,14 +641,16 @@ describe('api form', () => {
cy.get('@secondInput').clear()
cy.get('@secondInput').type('87')

cy.get('@apiForm').find('gn-ui-dropdown-selector').click()
cy.get('button[data-cy-value="csv"]').click()
// eslint-disable-next-line cypress/no-unnecessary-waiting
cy.wait(3000)
cmoinier marked this conversation as resolved.
Show resolved Hide resolved
cy.get('@apiForm').find('gn-ui-dropdown-selector').as('dropdown')
cy.get('@dropdown').eq(0).selectDropdownOption('geojson')

cy.get('@apiForm')
.find('gn-ui-copy-text-button')
.find('input')
.invoke('val')
.should('include', 'offset=87&limit=54&f=csv')
.should('include', 'offset=87&limit=54&f=geojson')

cy.get('@apiForm').children('div').first().find('button').first().click()

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
extraBtnClass="secondary min-w-full !w-40 !text-black"
[showTitle]="false"
class="text-black"
[choices]="formatsList"
[choices]="outputFormats"
(selectValue)="setFormat($event)"
[selected]="format$ | async"
></gn-ui-dropdown-selector>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,26 @@ const mockDatasetServiceDistribution: DatasetServiceDistribution = {
accessServiceProtocol: 'ogcFeatures',
}

jest.mock('@camptocamp/ogc-client', () => ({
OgcApiEndpoint: class {
constructor(private url) {}
get featureCollections() {
return Promise.resolve(['feature1'])
}
getCollectionInfo(collectionId) {
return Promise.resolve({
id: collectionId,
itemFormats: [
'application/geo+json',
'application/json',
'text/csv',
'application/json',
],
})
}
},
}))

describe('RecordApFormComponent', () => {
let component: RecordApiFormComponent
let fixture: ComponentFixture<RecordApiFormComponent>
Expand Down Expand Up @@ -87,4 +107,19 @@ describe('RecordApFormComponent', () => {
expect(component.format$.getValue()).toBe('json')
})
})

describe('#parseOutputFormats', () => {
beforeEach(() => {
const url = 'https://api.example.com/data?'
component.apiBaseUrl = url
})
it('should parse the returned formats', () => {
component.parseOutputFormats()
expect(component.outputFormats).toEqual([
{ value: 'csv', label: 'CSV' },
{ value: 'geojson', label: 'GEOJSON' },
{ value: 'json', label: 'JSON' },
])
})
})
})
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
import { ChangeDetectionStrategy, Component, Input } from '@angular/core'
import { OgcApiEndpoint } from '@camptocamp/ogc-client'
import { DatasetServiceDistribution } from '@geonetwork-ui/common/domain/model/record'
import { mimeTypeToFormat } from '@geonetwork-ui/util/shared'
import { BehaviorSubject, combineLatest, map } from 'rxjs'

const DEFAULT_PARAMS = {
Expand All @@ -16,16 +18,15 @@ const DEFAULT_PARAMS = {
export class RecordApiFormComponent {
@Input() set apiLink(value: DatasetServiceDistribution) {
this.apiBaseUrl = value ? value.url.href : undefined
this.outputFormats = [{ value: 'json', label: 'JSON' }]
this.parseOutputFormats()
this.resetUrl()
}
offset$ = new BehaviorSubject('')
limit$ = new BehaviorSubject('')
format$ = new BehaviorSubject('')
apiBaseUrl: string
formatsList = [
{ label: 'JSON', value: 'json' },
{ label: 'CSV', value: 'csv' },
]
outputFormats = [{ value: 'json', label: 'JSON' }]
apiQueryUrl$ = combineLatest([this.offset$, this.limit$, this.format$]).pipe(
map(([offset, limit, format]) => {
let outputUrl
Expand Down Expand Up @@ -70,4 +71,39 @@ export class RecordApiFormComponent {
this.limit$.next(DEFAULT_PARAMS.LIMIT)
this.format$.next(DEFAULT_PARAMS.FORMAT)
}

parseOutputFormats() {
const apiUrl =
this.apiBaseUrl.slice(-1) === '?'
? this.apiBaseUrl.slice(0, -1)
: this.apiBaseUrl
cmoinier marked this conversation as resolved.
Show resolved Hide resolved

this.getOutputFormats(apiUrl).then((outputFormats) => {
const formatsList = outputFormats.itemFormats.map((format) => {
const normalizedFormat = mimeTypeToFormat(format)
if (normalizedFormat) {
return {
label: normalizedFormat?.toUpperCase(),
value: normalizedFormat,
}
}
return null
})
this.outputFormats = this.outputFormats.concat(
formatsList.filter(Boolean)
)
this.outputFormats = this.outputFormats
.filter(
(format, index, self) =>
index === self.findIndex((t) => t.value === format.value)
)
.sort((a, b) => a.label.localeCompare(b.label))
})
}

async getOutputFormats(url) {
const endpoint = await new OgcApiEndpoint(url)
const firstCollection = (await endpoint.featureCollections)[0]
return endpoint.getCollectionInfo(firstCollection)
}
}
21 changes: 21 additions & 0 deletions libs/util/shared/src/lib/links/link-utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,27 @@ export const FORMATS = {
color: '#de630b',
mimeTypes: ['application/x-dxf', 'image/x-dxf'],
},
html: {
extensions: ['html', 'htm'],
priority: 12,
color: '#f2bb3a',
mimeTypes: ['text/html'],
},
fgb: {
cmoinier marked this conversation as resolved.
Show resolved Hide resolved
extensions: ['fgb', 'flatgeobuf'],
priority: 13,
color: '#f2bb3a',
mimeTypes: ['application/flatgeobuf'],
},
jsonfg: {
extensions: ['jsonfg', 'jsonfgc'],
priority: 14,
color: '#f2bb3a',
mimeTypes: [
'application/vnd.ogc.fg+json',
'application/vnd.ogc.fg+json;compatibility=geojson',
],
},
} as const

export type FileFormat = keyof typeof FORMATS
Expand Down
8 changes: 4 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
"@angular/router": "16.1.7",
"@bartholomej/ngx-translate-extract": "^8.0.2",
"@biesbjerg/ngx-translate-extract-marker": "^1.0.0",
"@camptocamp/ogc-client": "^1.1.0-RC.3",
"@camptocamp/ogc-client": "^1.1.0",
"@geospatial-sdk/geocoding": "^0.0.5-alpha.2",
"@ltd/j-toml": "~1.35.2",
"@messageformat/core": "^3.0.1",
Expand Down
Binary file modified support-services/docker-entrypoint-initdb.d/dump
Binary file not shown.
Loading