Skip to content

Commit 6df006e

Browse files
committed
feat: initial work, types methods
1 parent 97cba99 commit 6df006e

File tree

5 files changed

+83
-2
lines changed

5 files changed

+83
-2
lines changed

src/collections/domain/models/CollectionDatasetTemplate.ts

Whitespace-only changes.

src/collections/domain/repositories/ICollectionsRepository.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,4 +50,5 @@ export interface ICollectionsRepository {
5050
): Promise<FeaturedItem[]>
5151
deleteCollectionFeaturedItems(collectionIdOrAlias: number | string): Promise<void>
5252
deleteCollectionFeaturedItem(featuredItemId: number): Promise<void>
53+
getDatasetTemplates(collectionIdOrAlias: number | string): Promise<unknown>
5354
}

src/collections/infra/repositories/CollectionsRepository.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -446,4 +446,12 @@ export class CollectionsRepository extends ApiRepository implements ICollections
446446
throw error
447447
})
448448
}
449+
450+
public async getDatasetTemplates(collectionIdOrAlias: number | string): Promise<unknown> {
451+
return this.doGet(`/${this.collectionsResourceName}/${collectionIdOrAlias}/templates`, true)
452+
.then((response) => response.data.data)
453+
.catch((error) => {
454+
throw error
455+
})
456+
}
449457
}
Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
// TODO:ME - Adding custom terms makes the get dataset templates endpoint throw internal server error
2+
3+
export interface CollectionDatasetTemplatePayload {
4+
id: number
5+
name: string
6+
isDefault: boolean
7+
usageCount: number
8+
createTime: string
9+
createDate: string
10+
termsOfUseAndAccess: TermsOfUseAndAccess
11+
datasetFields: DatasetFields
12+
instructions: Instruction[]
13+
dataverseAlias: string
14+
}
15+
16+
export interface TermsOfUseAndAccess {
17+
id: number
18+
license: License
19+
// Below fields are going to be present if are added in "Restricted Files + Terms of Access"
20+
termsOfAccess?: string // This is terms of access for restricted files in the JSF UI
21+
dataAccessPlace?: string
22+
originalArchive?: string
23+
availabilityStatus?: string
24+
sizeOfCollection?: string
25+
studyCompletion?: string
26+
// Below fields are going to be present if custom terms are added in the JSF UI
27+
termsOfUse?: string
28+
confidentialityDeclaration?: string
29+
specialPermissions?: string
30+
restrictions?: string
31+
citationRequirements?: string
32+
depositorRequirements?: string
33+
conditions?: string
34+
disclaimer?: string
35+
}
36+
37+
export interface License {
38+
id: number
39+
name: string
40+
shortDescription: string
41+
uri: string
42+
iconUrl: string
43+
active: boolean
44+
isDefault: boolean
45+
sortOrder: number
46+
rightsIdentifier: string
47+
rightsIdentifierScheme: string
48+
schemeUri: string
49+
languageCode: string
50+
}
51+
52+
export interface DatasetFields {
53+
citation: Citation
54+
}
55+
56+
export interface Citation {
57+
displayName: string
58+
name: string
59+
fields: Field[]
60+
}
61+
62+
export interface Field {
63+
typeName: string
64+
multiple: boolean
65+
typeClass: string
66+
value: string
67+
}
68+
69+
export interface Instruction {
70+
instructionField: string
71+
instructionText: string
72+
}

test/environment/.env

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
POSTGRES_VERSION=17
22
DATAVERSE_DB_USER=dataverse
33
SOLR_VERSION=9.8.0
4-
DATAVERSE_IMAGE_REGISTRY=docker.io
5-
DATAVERSE_IMAGE_TAG=unstable
4+
DATAVERSE_IMAGE_REGISTRY=ghcr.io
5+
DATAVERSE_IMAGE_TAG=11703-return-isDefault-property-get-dataset-templates
66
DATAVERSE_BOOTSTRAP_TIMEOUT=5m

0 commit comments

Comments
 (0)