@data-fair/catalog-data-fair 0.1.0

package/types/importConfig/.type/index.d.ts

@@ -0,0 +1,107 @@
+
+export const schemaExports: string[]
+
+// see https://github.com/bcherny/json-schema-to-typescript/issues/439 if some types are not exported
+/**
+ * La liste des colonnes à importer. Si ce champ est vide, toutes les colonnes seront importées.
+ */
+export type ColonnesDuJeuDeDonnees = {
+  key?: string;
+  label?: string;
+  type?: string;
+  [k: string]: unknown;
+}[];
+/**
+ * Importe seulement des lignes où la valeur du champ indiqué est égale à l'une des valeurs renseignées.<br>*Toutes les valeurs peuvent ne pas être affichées, écrivez pour rechercher un champ particulier.*
+ */
+export type Valeurs = string[];
+/**
+ * Importe seulement des lignes où la valeur du champ indiqué est différente des valeurs renseignées.<br>*Toutes les valeurs peuvent ne pas être affichées, écrivez pour rechercher un champ particulier.*
+ */
+export type ValeursAExclure = string[];
+/**
+ * Importe seulement des lignes où la valeur du champ indiqué est supérieur ou égale à la valeur renseignée. La valeur peut être un nombre, une chaîne de caractère (*ordre alphanumérique*), une date.<br>*Toutes les valeurs peuvent ne pas être affichées, écrivez pour rechercher un champ particulier.*
+ */
+export type ValeurMinimale = string;
+/**
+ * Importe seulement les lignes où la valeur du champ indiqué est inférieur à la valeur renseignée. La valeur peut être un nombre, une chaîne de caractère (*ordre alphanumérique*), une date.<br>*Toutes les valeurs peuvent ne pas être affichées, écrivez pour rechercher un champ particulier.*
+ */
+export type ValeurMaximale = string;
+/**
+ * Importe seulement les lignes où le champ (colonne) indiqué commence par une chaîne de caractères précise. La chaîne de caractères est sensible à la casse.<br>Seuls les champs (colonnes) ayant pour valeurs des chaînes de caractères sont acceptées.<br>*Toutes les valeurs peuvent ne pas être affichées, écrivez pour rechercher un champ particulier.*
+ */
+export type CommenceParLesCaracteres1 = string;
+/**
+ * This interface was referenced by `ConfigurationDeLImport`'s JSON-Schema
+ * via the `definition` "filters".
+ */
+export type FiltresPredefinis = (
+  | RestreindreADesValeursPrecises
+  | ExclureDesValeurs
+  | SuperieurAUneValeur
+  | InferieurAUneValeur
+  | CommenceParLesCaracteres
+)[];
+
+export type ConfigurationDeLImport = {
+  fields?: ColonnesDuJeuDeDonnees;
+  filters?: FiltresPredefinis;
+}
+export type RestreindreADesValeursPrecises = {
+  type: "in";
+  field: ColonneDeFiltre;
+  values: Valeurs;
+  [k: string]: unknown;
+}
+/**
+ * This interface was referenced by `ConfigurationDeLImport`'s JSON-Schema
+ * via the `definition` "filterField".
+ */
+export type ColonneDeFiltre = {
+  key?: string;
+  label?: string;
+  type?: string;
+  [k: string]: unknown;
+}
+export type ExclureDesValeurs = {
+  type: "nin";
+  field: ColonneDeFiltre;
+  values: ValeursAExclure;
+  [k: string]: unknown;
+}
+export type SuperieurAUneValeur = {
+  type: "gte";
+  field: ColonneDeFiltre;
+  value: ValeurMinimale;
+  [k: string]: unknown;
+}
+export type InferieurAUneValeur = {
+  type: "lte";
+  field: ColonneDeFiltre;
+  value: ValeurMaximale;
+  [k: string]: unknown;
+}
+export type CommenceParLesCaracteres = {
+  type: "starts";
+  field: ColonneDeFiltre1;
+  value: CommenceParLesCaracteres1;
+  [k: string]: unknown;
+}
+/**
+ * This interface was referenced by `ConfigurationDeLImport`'s JSON-Schema
+ * via the `definition` "filterFieldString".
+ */
+export type ColonneDeFiltre1 = {
+  key?: string;
+  label?: string;
+  type?: string;
+  [k: string]: unknown;
+}
+
+
+export declare function validate(data: any): data is ConfigurationDeLImport
+export declare function assertValid(data: any, options?: import('@data-fair/lib-validation').AssertValidOptions): asserts data is ConfigurationDeLImport
+export declare function returnValid(data: any, options?: import('@data-fair/lib-validation').AssertValidOptions): ConfigurationDeLImport
+      
+export declare const schema: any
+        

package/types/importConfig/.type/index.js

@@ -0,0 +1,273 @@
+/* eslint-disable */
+
+
+import validate from './validate.js'
+import { assertValid as assertValidGeneric } from '@data-fair/lib-validation'
+
+export const schemaExports = [
+  "types",
+  "validate",
+  "schema"
+]
+
+export { validate } from './validate.js'
+export function assertValid(data, options) {
+  assertValidGeneric(validate, data, options)
+}
+export function returnValid(data, options) {
+  assertValid(data, options)
+  return data
+}
+
+export const schema = {
+  "$id": "https://github.com/data-fair/catalog-data-fair/import-config",
+  "x-exports": [
+    "types",
+    "validate",
+    "schema"
+  ],
+  "title": "Configuration de l'import",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "fields": {
+      "type": "array",
+      "default": [],
+      "title": "Colonnes du jeu de données",
+      "description": "La liste des colonnes à importer. Si ce champ est vide, toutes les colonnes seront importées.",
+      "items": {
+        "type": "object",
+        "properties": {
+          "key": {
+            "type": "string"
+          },
+          "label": {
+            "type": "string"
+          },
+          "type": {
+            "type": "string"
+          }
+        }
+      },
+      "layout": {
+        "getItems": {
+          "url": "${context.catalogConfig.url}/data-fair/api/v1/datasets/${context.resourceId}/schema?calculated=false",
+          "itemTitle": "item.label",
+          "itemKey": "item.key"
+        }
+      }
+    },
+    "filters": {
+      "$ref": "#/$defs/filters"
+    }
+  },
+  "$defs": {
+    "filters": {
+      "title": "Filtres prédéfinis",
+      "type": "array",
+      "default": [],
+      "items": {
+        "type": "object",
+        "default": {
+          "type": "in"
+        },
+        "required": [
+          "type"
+        ],
+        "oneOf": [
+          {
+            "title": "Restreindre à des valeurs précises",
+            "required": [
+              "field",
+              "values",
+              "type"
+            ],
+            "properties": {
+              "type": {
+                "const": "in"
+              },
+              "field": {
+                "$ref": "#/$defs/filterField"
+              },
+              "values": {
+                "type": "array",
+                "title": "Valeurs",
+                "description": "Importe seulement des lignes où la valeur du champ indiqué est égale à l'une des valeurs renseignées.<br>*Toutes les valeurs peuvent ne pas être affichées, écrivez pour rechercher un champ particulier.*",
+                "items": {
+                  "type": "string"
+                },
+                "layout": {
+                  "getItems": {
+                    "url": "${context.catalogConfig.url}/data-fair/api/v1/datasets/${context.resourceId}/values/${parent.data.field.key}?q={q}&q_mode=complete&size=100&stringify=true"
+                  },
+                  "props": {
+                    "clearable": true
+                  }
+                },
+                "default": []
+              }
+            }
+          },
+          {
+            "title": "Exclure des valeurs",
+            "required": [
+              "field",
+              "values",
+              "type"
+            ],
+            "properties": {
+              "type": {
+                "const": "nin"
+              },
+              "field": {
+                "$ref": "#/$defs/filterField"
+              },
+              "values": {
+                "type": "array",
+                "title": "Valeurs à exclure",
+                "description": "Importe seulement des lignes où la valeur du champ indiqué est différente des valeurs renseignées.<br>*Toutes les valeurs peuvent ne pas être affichées, écrivez pour rechercher un champ particulier.*",
+                "items": {
+                  "type": "string"
+                },
+                "layout": {
+                  "getItems": {
+                    "url": "${context.catalogConfig.url}/data-fair/api/v1/datasets/${context.resourceId}/values/${parent.data.field.key}?q={q}&q_mode=complete&size=100&stringify=true"
+                  },
+                  "props": {
+                    "clearable": true
+                  }
+                },
+                "default": []
+              }
+            }
+          },
+          {
+            "title": "Supérieur à une valeur",
+            "required": [
+              "field",
+              "value",
+              "type"
+            ],
+            "properties": {
+              "type": {
+                "const": "gte"
+              },
+              "field": {
+                "$ref": "#/$defs/filterField"
+              },
+              "value": {
+                "type": "string",
+                "title": "Valeur minimale",
+                "description": "Importe seulement des lignes où la valeur du champ indiqué est supérieur ou égale à la valeur renseignée. La valeur peut être un nombre, une chaîne de caractère (*ordre alphanumérique*), une date.<br>*Toutes les valeurs peuvent ne pas être affichées, écrivez pour rechercher un champ particulier.*",
+                "layout": {
+                  "comp": "combobox",
+                  "getItems": {
+                    "url": "${context.catalogConfig.url}/data-fair/api/v1/datasets/${context.resourceId}/values/${parent.data.field.key}?q={q}&q_mode=complete&size=100&stringify=true&sort=asc"
+                  }
+                }
+              }
+            }
+          },
+          {
+            "title": "Inférieur à une valeur",
+            "required": [
+              "field",
+              "value",
+              "type"
+            ],
+            "properties": {
+              "type": {
+                "const": "lte"
+              },
+              "field": {
+                "$ref": "#/$defs/filterField"
+              },
+              "value": {
+                "type": "string",
+                "title": "Valeur maximale",
+                "description": "Importe seulement les lignes où la valeur du champ indiqué est inférieur à la valeur renseignée. La valeur peut être un nombre, une chaîne de caractère (*ordre alphanumérique*), une date.<br>*Toutes les valeurs peuvent ne pas être affichées, écrivez pour rechercher un champ particulier.*",
+                "layout": {
+                  "comp": "combobox",
+                  "getItems": {
+                    "url": "${context.catalogConfig.url}/data-fair/api/v1/datasets/${context.resourceId}/values/${parent.data.field.key}?q={q}&q_mode=complete&size=100&stringify=true&sort=asc"
+                  }
+                }
+              }
+            }
+          },
+          {
+            "title": "Commence par les caractères",
+            "required": [
+              "field",
+              "value",
+              "type"
+            ],
+            "properties": {
+              "type": {
+                "const": "starts"
+              },
+              "field": {
+                "$ref": "#/$defs/filterFieldString"
+              },
+              "value": {
+                "type": "string",
+                "description": "Importe seulement les lignes où le champ (colonne) indiqué commence par une chaîne de caractères précise. La chaîne de caractères est sensible à la casse.<br>Seuls les champs (colonnes) ayant pour valeurs des chaînes de caractères sont acceptées.<br>*Toutes les valeurs peuvent ne pas être affichées, écrivez pour rechercher un champ particulier.*",
+                "title": "Commence par les caractères",
+                "layout": {
+                  "comp": "combobox",
+                  "getItems": {
+                    "url": "${context.catalogConfig.url}/data-fair/api/v1/datasets/${context.resourceId}/values/${parent.data.field.key}?q={q}&q_mode=complete&size=100&stringify=true"
+                  }
+                }
+              }
+            }
+          }
+        ]
+      }
+    },
+    "filterField": {
+      "type": "object",
+      "title": "Colonne de filtre",
+      "properties": {
+        "key": {
+          "type": "string"
+        },
+        "label": {
+          "type": "string"
+        },
+        "type": {
+          "type": "string"
+        }
+      },
+      "layout": {
+        "getItems": {
+          "url": "${context.catalogConfig.url}/data-fair/api/v1/datasets/${context.resourceId}/schema?calculated=false",
+          "itemTitle": "item.label",
+          "itemKey": "item.key"
+        }
+      }
+    },
+    "filterFieldString": {
+      "type": "object",
+      "title": "Colonne de filtre",
+      "properties": {
+        "key": {
+          "type": "string"
+        },
+        "label": {
+          "type": "string"
+        },
+        "type": {
+          "type": "string"
+        }
+      },
+      "layout": {
+        "getItems": {
+          "url": "${context.catalogConfig.url}/data-fair/api/v1/datasets/${context.resourceId}/schema?calculated=false&type=string",
+          "itemTitle": "item.label",
+          "itemKey": "item.key"
+        }
+      }
+    }
+  }
+}