@data-fair/catalog-data-fair 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,231 @@
1
+
2
+ export const schemaExports: string[]
3
+
4
+ // see https://github.com/bcherny/json-schema-to-typescript/issues/439 if some types are not exported
5
+ /**
6
+ * Désactivez cette capacité si la donnée contient par exemple des textes longs pour lesquels des filtres sur valeurs exactes ont peu de sens.
7
+ */
8
+ export type FiltrableSurValeurExacte = boolean;
9
+ /**
10
+ * Désactivez cette capacité si la donnée contient par exemple des textes longs pour lesquels trier ou grouper par valeur a peu de sens.
11
+ */
12
+ export type TriableEtGroupable = boolean;
13
+ /**
14
+ * Désactivez cette capacité dans le cas d'un code, une url, etc. N'importe quel contenu sur lequel la recherche de mots a peu de sens.
15
+ */
16
+ export type TexteAnalysePourRechercheTextuelle = boolean;
17
+ /**
18
+ * Désactivez cette capacité pour tout contenu qui n'est pas en langue française ou pour lequel la recherche de mots a peu de sens.
19
+ */
20
+ export type TexteAnalyseSpecifiquementPourLaLangueFrancaise = boolean;
21
+ /**
22
+ * Activez cette capacité si avez l'intention d'obtenir des statistiques sur les occurrences de mots (par exemple pour construire un nuage de mot).
23
+ */
24
+ export type StatistiquesDeMots = boolean;
25
+ /**
26
+ * Activez cette capacité si vous avez l'intention de filtrer ce contenu spécifiquement sur une suite de caractères (par exemple si un filtre sur mots entiers ou sur valeur exacte ne convient pas).
27
+ */
28
+ export type TexteFiltrableSurGroupeDeCaracteres = boolean;
29
+ /**
30
+ * Désactivez cette capacité si le contenu ne sera pas utilisé pour du tri ou bien si il ne contient pas de variations avec accents et majuscules.
31
+ */
32
+ export type TriAmelioreAvecCasseEtAccents = boolean;
33
+ /**
34
+ * Désactivez cette capacité si la donnée ne contient que des géométries basiques de points ou bien si requêter les géométries uniquement à partir de leurs centroïdes est suffisant pour vos besoins.
35
+ */
36
+ export type FormesGeometriquesComplexes = boolean;
37
+ /**
38
+ * Activez cette capacité pour précalculer des éléments utiles à la construction de tuiles vectorielles pour le rendu cartographique du jeu de données. Activez cette option si le jeu de données contient des données géogreaphiques denses à afficher en grande quantité. La contre-partie est une augmentation du temps d'indexation et du volume de données indexées.
39
+ */
40
+ export type TuilesVectoriellesPreparees = boolean;
41
+ /**
42
+ * Désactivez cette option si vous souhaitez que les pièces jointes soient simplement téléchargeables et que l'extraction de leur contenu textuel pour recherche de mots n'est pas pertinente.
43
+ */
44
+ export type ContenuDesPiecesJointesAnalysePourRechercheTextuelle = boolean;
45
+
46
+ export type DataFairCatalog = {
47
+ /**
48
+ * Nombre total de jeux de données
49
+ */
50
+ count: number;
51
+ results: DataFairDataset[];
52
+ }
53
+ /**
54
+ * This interface was referenced by `DataFairCatalog`'s JSON-Schema
55
+ * via the `definition` "DataFairDataset".
56
+ */
57
+ export type DataFairDataset = {
58
+ /**
59
+ * Globally unique identifier of the dataset
60
+ */
61
+ id: string;
62
+ /**
63
+ * Readonly field. The URL where this resource can be fetched
64
+ */
65
+ href?: string;
66
+ /**
67
+ * Readonly field. The URL where this resource can be viewed in the UI
68
+ */
69
+ page?: string;
70
+ /**
71
+ * Short title of the dataset
72
+ */
73
+ title: string;
74
+ /**
75
+ * Detailed description of the dataset
76
+ */
77
+ description?: string;
78
+ /**
79
+ * keywords
80
+ */
81
+ keywords?: string[];
82
+ /**
83
+ * update frequency
84
+ */
85
+ frequency?:
86
+ | ""
87
+ | "triennial"
88
+ | "biennial"
89
+ | "annual"
90
+ | "semiannual"
91
+ | "threeTimesAYear"
92
+ | "quarterly"
93
+ | "bimonthly"
94
+ | "monthly"
95
+ | "semimonthly"
96
+ | "biweekly"
97
+ | "threeTimesAMonth"
98
+ | "weekly"
99
+ | "semiweekly"
100
+ | "threeTimesAWeek"
101
+ | "daily"
102
+ | "continuous"
103
+ | "irregular";
104
+ file?: {
105
+ /**
106
+ * Size of the file on disk
107
+ */
108
+ size: number;
109
+ [k: string]: unknown;
110
+ };
111
+ originalFile?: {
112
+ /**
113
+ * Size of the file on disk
114
+ */
115
+ size: number;
116
+ [k: string]: unknown;
117
+ };
118
+ /**
119
+ * URL d'une image, illustration du jeu de données
120
+ */
121
+ image?: string;
122
+ /**
123
+ * JSON schema properties of the fields
124
+ */
125
+ schema?: {
126
+ key: string;
127
+ type?: string;
128
+ format?: string | null;
129
+ "x-originalName"?: string | null;
130
+ title?: string;
131
+ description?: string;
132
+ icon?: string;
133
+ "x-group"?: string;
134
+ /**
135
+ * @deprecated
136
+ */
137
+ "x-refersTo"?: string | null;
138
+ "x-concept"?: {
139
+ id?: string;
140
+ title?: string;
141
+ primary?: boolean;
142
+ [k: string]: unknown;
143
+ };
144
+ "x-calculated"?: boolean;
145
+ "x-capabilities"?: {
146
+ index?: FiltrableSurValeurExacte;
147
+ values?: TriableEtGroupable;
148
+ textStandard?: TexteAnalysePourRechercheTextuelle;
149
+ text?: TexteAnalyseSpecifiquementPourLaLangueFrancaise;
150
+ textAgg?: StatistiquesDeMots;
151
+ wildcard?: TexteFiltrableSurGroupeDeCaracteres;
152
+ insensitive?: TriAmelioreAvecCasseEtAccents;
153
+ geoShape?: FormesGeometriquesComplexes;
154
+ vtPrepare?: TuilesVectoriellesPreparees;
155
+ indexAttachment?: ContenuDesPiecesJointesAnalysePourRechercheTextuelle;
156
+ [k: string]: unknown;
157
+ };
158
+ "x-labels"?: {
159
+ /**
160
+ * This interface was referenced by `undefined`'s JSON-Schema definition
161
+ * via the `patternProperty` ".*".
162
+ */
163
+ [k: string]: string;
164
+ };
165
+ "x-labelsRestricted"?: boolean;
166
+ readOnly?: boolean;
167
+ "x-required"?: boolean;
168
+ minLength?: number;
169
+ maxLength?: number;
170
+ minimum?: number;
171
+ maximum?: number;
172
+ pattern?: string;
173
+ patternErrorMessage?: string;
174
+ "x-master"?: {
175
+ id?: string;
176
+ title?: string;
177
+ /**
178
+ * L'identifiant du service distant utilisé pour l'enrichissement
179
+ */
180
+ remoteService?: string;
181
+ /**
182
+ * L'identifiant de l'action du service distant à utiliser pour l'enrichissement
183
+ */
184
+ action?: string;
185
+ [k: string]: unknown;
186
+ };
187
+ "x-display"?: string;
188
+ /**
189
+ * This differs from JSON schema. It is not a restriction, just and observation of the values that are present in the dataset.
190
+ */
191
+ enum?: unknown[];
192
+ /**
193
+ * The number of distinct values for this field
194
+ */
195
+ "x-cardinality"?: number;
196
+ /**
197
+ * Transformation to apply to the field
198
+ */
199
+ "x-transform"?: {
200
+ expr?: string;
201
+ examples?: string[];
202
+ type?: string;
203
+ format?: string;
204
+ [k: string]: unknown;
205
+ };
206
+ [k: string]: unknown;
207
+ }[];
208
+ /**
209
+ * All storage space info of this dataset
210
+ */
211
+ storage?: {
212
+ size?: number;
213
+ [k: string]: unknown;
214
+ };
215
+ /**
216
+ * The number of rowns
217
+ */
218
+ count?: number;
219
+ license?: {
220
+ /**
221
+ * Short title for the license
222
+ */
223
+ title: string;
224
+ /**
225
+ * The URL where the license can be read
226
+ */
227
+ href: string;
228
+ };
229
+ [k: string]: unknown;
230
+ }
231
+
@@ -0,0 +1,7 @@
1
+ /* eslint-disable */
2
+
3
+
4
+
5
+ export const schemaExports = [
6
+ "types"
7
+ ]
@@ -0,0 +1 @@
1
+ export * from './.type/index.js'
@@ -0,0 +1,378 @@
1
+ {
2
+ "$id": "https://github.com/data-fair/catalog-data-fair/catlog-schemas",
3
+ "x-exports": [
4
+ "types"
5
+ ],
6
+ "title": "DataFair Catalog",
7
+ "type": "object",
8
+ "additionalProperties": false,
9
+ "required": [
10
+ "count",
11
+ "results"
12
+ ],
13
+ "properties": {
14
+ "count": {
15
+ "type": "number",
16
+ "description": "Nombre total de jeux de données"
17
+ },
18
+ "results": {
19
+ "type": "array",
20
+ "items": {
21
+ "$ref": "#/$defs/DataFairDataset"
22
+ }
23
+ }
24
+ },
25
+ "$defs": {
26
+ "DataFairDataset": {
27
+ "type": "object",
28
+ "required": [
29
+ "id",
30
+ "title"
31
+ ],
32
+ "properties": {
33
+ "id": {
34
+ "type": "string",
35
+ "description": "Globally unique identifier of the dataset"
36
+ },
37
+ "href": {
38
+ "type": "string",
39
+ "description": "Readonly field. The URL where this resource can be fetched"
40
+ },
41
+ "page": {
42
+ "type": "string",
43
+ "description": "Readonly field. The URL where this resource can be viewed in the UI"
44
+ },
45
+ "title": {
46
+ "type": "string",
47
+ "description": "Short title of the dataset"
48
+ },
49
+ "description": {
50
+ "type": "string",
51
+ "description": "Detailed description of the dataset"
52
+ },
53
+ "keywords": {
54
+ "type": "array",
55
+ "description": "keywords",
56
+ "items": {
57
+ "type": "string"
58
+ }
59
+ },
60
+ "frequency": {
61
+ "type": "string",
62
+ "description": "update frequency",
63
+ "enum": [
64
+ "",
65
+ "triennial",
66
+ "biennial",
67
+ "annual",
68
+ "semiannual",
69
+ "threeTimesAYear",
70
+ "quarterly",
71
+ "bimonthly",
72
+ "monthly",
73
+ "semimonthly",
74
+ "biweekly",
75
+ "threeTimesAMonth",
76
+ "weekly",
77
+ "semiweekly",
78
+ "threeTimesAWeek",
79
+ "daily",
80
+ "continuous",
81
+ "irregular"
82
+ ]
83
+ },
84
+ "file": {
85
+ "type": "object",
86
+ "required": [
87
+ "size"
88
+ ],
89
+ "properties": {
90
+ "size": {
91
+ "type": "number",
92
+ "description": "Size of the file on disk"
93
+ }
94
+ }
95
+ },
96
+ "originalFile": {
97
+ "type": "object",
98
+ "required": [
99
+ "size"
100
+ ],
101
+ "properties": {
102
+ "size": {
103
+ "type": "number",
104
+ "description": "Size of the file on disk"
105
+ }
106
+ }
107
+ },
108
+ "image": {
109
+ "type": "string",
110
+ "description": "URL d'une image, illustration du jeu de données"
111
+ },
112
+ "schema": {
113
+ "type": "array",
114
+ "description": "JSON schema properties of the fields",
115
+ "items": {
116
+ "type": "object",
117
+ "required": [
118
+ "key"
119
+ ],
120
+ "properties": {
121
+ "key": {
122
+ "type": "string",
123
+ "readOnly": true,
124
+ "x-display": "hidden"
125
+ },
126
+ "type": {
127
+ "type": "string"
128
+ },
129
+ "format": {
130
+ "type": [
131
+ "string",
132
+ "null"
133
+ ]
134
+ },
135
+ "x-originalName": {
136
+ "type": [
137
+ "string",
138
+ "null"
139
+ ]
140
+ },
141
+ "title": {
142
+ "type": "string"
143
+ },
144
+ "description": {
145
+ "type": "string"
146
+ },
147
+ "icon": {
148
+ "type": "string"
149
+ },
150
+ "x-group": {
151
+ "type": "string"
152
+ },
153
+ "x-refersTo": {
154
+ "deprecated": true,
155
+ "type": [
156
+ "string",
157
+ "null"
158
+ ]
159
+ },
160
+ "x-concept": {
161
+ "type": "object",
162
+ "properties": {
163
+ "id": {
164
+ "type": "string"
165
+ },
166
+ "title": {
167
+ "type": "string"
168
+ },
169
+ "primary": {
170
+ "type": "boolean"
171
+ }
172
+ }
173
+ },
174
+ "x-calculated": {
175
+ "type": "boolean"
176
+ },
177
+ "x-capabilities": {
178
+ "type": "object",
179
+ "properties": {
180
+ "index": {
181
+ "type": "boolean",
182
+ "default": true,
183
+ "x-display": "switch",
184
+ "title": "Filtrable sur valeur exacte",
185
+ "description": "Désactivez cette capacité si la donnée contient par exemple des textes longs pour lesquels des filtres sur valeurs exactes ont peu de sens."
186
+ },
187
+ "values": {
188
+ "type": "boolean",
189
+ "default": true,
190
+ "x-display": "switch",
191
+ "title": "Triable et groupable",
192
+ "description": "Désactivez cette capacité si la donnée contient par exemple des textes longs pour lesquels trier ou grouper par valeur a peu de sens."
193
+ },
194
+ "textStandard": {
195
+ "type": "boolean",
196
+ "default": true,
197
+ "x-display": "switch",
198
+ "title": "Texte analysé pour recherche textuelle",
199
+ "description": "Désactivez cette capacité dans le cas d'un code, une url, etc. N'importe quel contenu sur lequel la recherche de mots a peu de sens."
200
+ },
201
+ "text": {
202
+ "type": "boolean",
203
+ "default": true,
204
+ "x-display": "switch",
205
+ "title": "Texte analysé spécifiquement pour la langue française",
206
+ "description": "Désactivez cette capacité pour tout contenu qui n'est pas en langue française ou pour lequel la recherche de mots a peu de sens."
207
+ },
208
+ "textAgg": {
209
+ "type": "boolean",
210
+ "default": false,
211
+ "x-display": "switch",
212
+ "title": "Statistiques de mots",
213
+ "description": "Activez cette capacité si avez l'intention d'obtenir des statistiques sur les occurrences de mots (par exemple pour construire un nuage de mot)."
214
+ },
215
+ "wildcard": {
216
+ "type": "boolean",
217
+ "default": false,
218
+ "x-display": "switch",
219
+ "title": "Texte filtrable sur groupe de caractères",
220
+ "description": "Activez cette capacité si vous avez l'intention de filtrer ce contenu spécifiquement sur une suite de caractères (par exemple si un filtre sur mots entiers ou sur valeur exacte ne convient pas)."
221
+ },
222
+ "insensitive": {
223
+ "type": "boolean",
224
+ "default": true,
225
+ "x-display": "switch",
226
+ "title": "Tri amélioré avec casse et accents",
227
+ "description": "Désactivez cette capacité si le contenu ne sera pas utilisé pour du tri ou bien si il ne contient pas de variations avec accents et majuscules."
228
+ },
229
+ "geoShape": {
230
+ "type": "boolean",
231
+ "default": true,
232
+ "x-display": "switch",
233
+ "title": "Formes géométriques complexes",
234
+ "description": "Désactivez cette capacité si la donnée ne contient que des géométries basiques de points ou bien si requêter les géométries uniquement à partir de leurs centroïdes est suffisant pour vos besoins."
235
+ },
236
+ "vtPrepare": {
237
+ "type": "boolean",
238
+ "default": false,
239
+ "x-display": "switch",
240
+ "title": "Tuiles vectorielles préparées",
241
+ "description": "Activez cette capacité pour précalculer des éléments utiles à la construction de tuiles vectorielles pour le rendu cartographique du jeu de données. Activez cette option si le jeu de données contient des données géogreaphiques denses à afficher en grande quantité. La contre-partie est une augmentation du temps d'indexation et du volume de données indexées."
242
+ },
243
+ "indexAttachment": {
244
+ "type": "boolean",
245
+ "default": true,
246
+ "x-display": "switch",
247
+ "title": "Contenu des pièces jointes analysé pour recherche textuelle",
248
+ "description": "Désactivez cette option si vous souhaitez que les pièces jointes soient simplement téléchargeables et que l'extraction de leur contenu textuel pour recherche de mots n'est pas pertinente."
249
+ }
250
+ }
251
+ },
252
+ "x-labels": {
253
+ "type": "object",
254
+ "patternProperties": {
255
+ ".*": {
256
+ "type": "string"
257
+ }
258
+ }
259
+ },
260
+ "x-labelsRestricted": {
261
+ "type": "boolean"
262
+ },
263
+ "readOnly": {
264
+ "type": "boolean"
265
+ },
266
+ "x-required": {
267
+ "type": "boolean"
268
+ },
269
+ "minLength": {
270
+ "type": "integer"
271
+ },
272
+ "maxLength": {
273
+ "type": "integer"
274
+ },
275
+ "minimum": {
276
+ "type": "number"
277
+ },
278
+ "maximum": {
279
+ "type": "number"
280
+ },
281
+ "pattern": {
282
+ "type": "string",
283
+ "format": "regex"
284
+ },
285
+ "patternErrorMessage": {
286
+ "type": "string"
287
+ },
288
+ "x-master": {
289
+ "type": "object",
290
+ "properties": {
291
+ "id": {
292
+ "type": "string"
293
+ },
294
+ "title": {
295
+ "type": "string"
296
+ },
297
+ "remoteService": {
298
+ "type": "string",
299
+ "description": "L'identifiant du service distant utilisé pour l'enrichissement"
300
+ },
301
+ "action": {
302
+ "type": "string",
303
+ "description": "L'identifiant de l'action du service distant à utiliser pour l'enrichissement"
304
+ }
305
+ }
306
+ },
307
+ "x-display": {
308
+ "type": "string"
309
+ },
310
+ "enum": {
311
+ "type": "array",
312
+ "readOnly": true,
313
+ "description": "This differs from JSON schema. It is not a restriction, just and observation of the values that are present in the dataset."
314
+ },
315
+ "x-cardinality": {
316
+ "type": "integer",
317
+ "description": "The number of distinct values for this field",
318
+ "readOnly": true
319
+ },
320
+ "x-transform": {
321
+ "type": "object",
322
+ "description": "Transformation to apply to the field",
323
+ "properties": {
324
+ "expr": {
325
+ "type": "string"
326
+ },
327
+ "examples": {
328
+ "type": "array",
329
+ "items": {
330
+ "type": "string"
331
+ }
332
+ },
333
+ "type": {
334
+ "type": "string"
335
+ },
336
+ "format": {
337
+ "type": "string"
338
+ }
339
+ }
340
+ }
341
+ }
342
+ }
343
+ },
344
+ "storage": {
345
+ "type": "object",
346
+ "description": "All storage space info of this dataset",
347
+ "properties": {
348
+ "size": {
349
+ "type": "integer"
350
+ }
351
+ }
352
+ },
353
+ "count": {
354
+ "type": "number",
355
+ "description": "The number of rowns"
356
+ },
357
+ "license": {
358
+ "type": "object",
359
+ "additionalProperties": false,
360
+ "required": [
361
+ "title",
362
+ "href"
363
+ ],
364
+ "properties": {
365
+ "title": {
366
+ "type": "string",
367
+ "description": "Short title for the license"
368
+ },
369
+ "href": {
370
+ "type": "string",
371
+ "description": "The URL where the license can be read"
372
+ }
373
+ }
374
+ }
375
+ }
376
+ }
377
+ }
378
+ }