Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 | 18x 18x 18x 18x 18x 1x 90x 18x 1x 18x 49x 46x 4x 18x 59x 9x 1x 1x 7x 1x 7x 6x | import { type } from 'arktype';
import { mapKeys, omit, orEmptyObj2 } from '../utils.js';
import {
FilepathTemplate,
HTTPRequest,
ID,
MIMEType,
NamespacedMetadataID,
ProtocolID,
SingleEntryRecord,
TemplatedString,
URLString
} from './common.js';
import { Metadata, namespacedMetadataId } from './metadata.js';
import { Image, Observation } from './observations.js';
import { AnalyzedImage, AnalyzedObservation } from './results.js';
export const ExportsFilepathTemplateObservation = FilepathTemplate(
type({
observation: AnalyzedObservation.omit('images'),
image: AnalyzedImage.omit('exportedAs')
// TODO deprecate these, put them in the image object only
}).and(AnalyzedImage.pick('sequence', 'numberInObservation'))
);
export const ExportsFilepathTemplateMetadataFile = FilepathTemplate(
type({
observation: ['undefined', '|', AnalyzedObservation.omit('images')],
image: ['undefined', '|', AnalyzedImage.omit('exportedAs')],
session: ['undefined', '|', { id: 'string' }],
metadata: Metadata,
metadataKey: ['string', '@', 'ID de la métadonnée, sans namespace'],
size: ['number', '@', 'Taille du fichier en octets'],
filename: 'string',
contentType: MIMEType,
id: [
'string',
'@',
'Référence du fichier, correspondant à la valeur de la métadonnée de type "file"'
]
})
);
export const ANALYSIS_JSON_ZIP_FILEPATH = 'analysis.json';
export const ProtocolRegistry = type({
protocols: type({
id: ProtocolID,
url: URLString.describe('URL où télécharger le protocole')
}).array()
});
const ItemsImportSpec = type
.or(
ID.describe('Clé de métadonnée à importer, sans le namespace'),
SingleEntryRecord(ID, ID).describe('Import avec renommage. ')
)
.pipe((spec) =>
typeof spec === 'string'
? { source: spec, target: spec }
: { source: spec.value, target: spec.key }
)
.array()
.describe(
"Clés (sans le namespace) de métadonnées à hériter du protocole spécifié dans 'from'. List de simples clés, ou d'objet avec une seule paire, de la forme { cible: source } où source est la clé dans le protocole duquel on importe, et cible est la clé que l'on donne à cette métadonnée dans le protocole courant (les deux sont sans namespace). Astuce: en YAML, quand on décrit une liste, les {} autour des objets sont optionnels. Par exemple: metadata: [a, b: b_source, c] ou - a↵ - b: b_source↵ - c importera la métadonnée 'a', la métadonnée 'b_source' renommée en 'b', et la métadonnée 'c' du protocole spécifié dans 'from'."
)
.default(() => []);
export const ProtocolImport = type({
from: ProtocolID.describe('ID du protocole duquel importer'),
sessionMetadata: ItemsImportSpec,
metadata: ItemsImportSpec
}).narrow(({ sessionMetadata, metadata }, ctx) =>
sessionMetadata.length + metadata.length > 0
? true
: ctx.reject('Un import ne peut pas être vide')
);
export const Protocol = type({
id: ProtocolID,
dirty: type('boolean')
.describe('Si le protocole a été modifié depuis sa dernière exportation')
.default(false),
importedMetadata: type({
sessionwide: [
'boolean',
'@',
"True si la métadonnée s'importe en tant que sessionMetadata plutôt que metadata classique"
],
source: NamespacedMetadataID.describe(
"ID de la métadonnée dans le protocole d'où elle est importée, avec namespace"
),
target: NamespacedMetadataID.describe(
'ID de la métadonnée dans le protocole courant, avec namespace'
)
})
.array()
.describe("Toutes les métadonnées importées depuis d'autres protocoles")
.default(() => []),
metadata: NamespacedMetadataID.array().describe(
"Toutes les métadonnées du protocole (qu'elles soient associées aux sessions ou aux observations/images)"
),
sessionMetadata: NamespacedMetadataID.array()
.describe('Métadonnées associées à la session entière')
.default(() => []),
name: ['string', '@', 'Nom du protocole'],
description: ['string', '@', 'Description du protocole'],
'learnMore?': URLString.describe(
"Lien vers un site où l'on peut se renseigner sur ce protocole. Cela peut aussi être simplement un lien de téléchargement direct de ce fichier"
),
'version?': ['number', '@', 'Version actuelle du protocole'],
updates: type
.enumerated('automatic', 'manual')
.describe('Mode de mise à jour du protocole')
.default('manual'),
'source?': HTTPRequest.describe(
`Requête ou URL devant mener à un fichier JSON contenant la version la plus récente du protocole. Permet de proposer des mises à jour.
Si le champ "version" n'existe pas (que ce soit dans le protocole local ou distant), aucune mise à jour ne sera proposée.`
),
authors: type({
'email?': ['string.email', '@', 'Adresse email'],
name: ['string', '@', 'Prénom Nom']
})
.array()
.describe("Les auteurices ayant participé à l'élaboration du protocole"),
'metadataOrder?': type(NamespacedMetadataID.array()).describe(
"L'ordre dans lequel les métadonnées doivent être présentées dans l'interface utilisateur. Les métadonnées non listées ici seront affichées après toutes celles listées ici"
),
'observations?': {
'defaultLabel?': TemplatedString(
type({
images: Image.array(),
observation: Observation
})
).describe(
"Label par défaut pour les observations. Template Handlebars, recevant une liste des images de l'observation à crééer (clé images) et l'observation elle-même (clé observation)"
)
},
'crop?': type({
padding: type(/^\d+(%|px)$/)
.describe(
"Pixels de marge à rajouter autour de la boîte englobante au moment d'exporter les images recadrées. Nombre suivi de 'px' pour un nombre de pixels fixe, ou de '%' pour un pourcentage des dimensions de chaque image."
)
.default('0px')
}).describe('Configuration de la partie recadrage'),
exports: type({
images: type({
cropped: ExportsFilepathTemplateObservation.describe('Chemins des images recadrées'),
original: ExportsFilepathTemplateObservation.describe('Chemins des images originales'),
'mtime?': [
'string',
'@',
'Métadonnée à utiliser pour la date de modification des fichiers exportés'
]
}).describe(
`Chemins où sauvegarder les images. Vous pouvez utiliser {{observation.metadata.identifiant.value}} pour insérer la valeur d'une métadonnée, {{image.filename}} pour le nom de fichier, {{observation.label}} pour le label (nom) de l'observation, et {{sequence}} pour un numéro d'image, commençant à 1. {{observation.metadata.identifiant.valueLabel}} peut être pratique pour obtenir le label associé au choix d'une métadonnée de type 'enum'. Enfin, il est possible de faire {{suffix image.filename "_exemple"}} pour ajouter "_exemple" à la fin d'un nom de fichier, mais avant son extension (par exemple: {{suffix image.filename "_cropped"}} donnera "IMG_1245_cropped.JPEG" si l'image avait pour nom de fichier "IMG_12345.JPEG"); Vous pouvez faire {{extension image.filename}} pour avoir l'extension d'un fichier, et {{fallback image.metadata.exemple "(Inconnnu)"}} pour utiliser "(Inconnu)" si image.metadata.example n'existe pas. Ce sont enfait des templates Handlebars, en savoir plus: https://handlebarsjs.com/guide/`
),
metadata: {
json: type(`"${ANALYSIS_JSON_ZIP_FILEPATH}"`)
.describe(
"Chemin du fichier JSON complet. Il n'est pas possible de le modifier, car CIGALE doit connaître son emplacement dans un .zip pour pouvoir importer des analyses."
)
.default(ANALYSIS_JSON_ZIP_FILEPATH),
csv: type.string
.describe("Chemin du fichier CSV contenant les résultats de l'analyse")
.pipe((path) => path.replaceAll('\\', '/')),
files: ExportsFilepathTemplateMetadataFile.describe(
'Chemins où sauvegarder les fichiers pour les métadonnées de type "file". Même syntaxe que pour les images, mais avec en plus {{metadata}} pour accéder à la métadonnée elle-même, {{metadataKey}} pour accéder à la clé de la métadonnée (sans namespace), {{filename}} pour le nom du fichier, {{contentType}} pour son type MIME, {{id}} pour sa référence (cette référence est ce qui est stocké dans la valeur de la métadonnée de type "file", et peut être utilisée pour faire le lien entre les fichiers et les métadonnées), et {{size}} pour sa taille en octets.'
).default(
'{{ metadataKey }}-files/{{ stem filename }}-{{ id }}.{{ extension filename }}'
)
}
})
.describe("La structure du fichier .zip d'export pour ce protocole.")
.optional()
});
export const ExportedProtocol = Protocol.omit(
'metadata',
'sessionMetadata',
'metadataOrder',
'dirty',
'importedMetadata'
)
.in.and({
imports: ProtocolImport.array().default(() => []),
'metadataOrder?': ID.array().describe(
"L'ordre dans lequel les métadonnées doivent être présentées dans l'interface utilisateur. Les métadonnées non listées ici seront affichées après toutes celles listées ici"
),
metadata: type.Record(
ID,
Metadata.in.omit('id').describe('Métadonnées associées aux observations/imagess')
),
'sessionMetadata?': type.Record(
ID,
Metadata.in.omit('id').describe('Métadonnées associées à la session entière')
)
})
.pipe((protocol) => ({
...omit(protocol, 'imports'),
...orEmptyObj2('metadataOrder', protocol.metadataOrder, (order) =>
order.map((key) => namespacedMetadataId(protocol.id, key))
),
importedMetadata: protocol.imports.flatMap(({ from, metadata, sessionMetadata }) => [
...metadata.map(({ source, target }) => ({
sessionwide: false,
source: namespacedMetadataId(from, source),
target: namespacedMetadataId(protocol.id, target)
})),
...sessionMetadata.map(({ source, target }) => ({
sessionwide: true,
source: namespacedMetadataId(from, source),
target: namespacedMetadataId(protocol.id, target)
}))
]),
metadata: mapKeys(protocol.metadata, (key) => namespacedMetadataId(protocol.id, key)),
sessionMetadata: mapKeys(protocol.sessionMetadata ?? {}, (key) =>
namespacedMetadataId(protocol.id, key)
)
}));
/**
* @typedef {typeof ExportedProtocol.inferOut} ExportedProtocol
*/
/**
* Returns whether the given metadata ID is in the given protocol
* (either directly a metadata of the protocol, or the source/target of an imported metadata)
* @param {Pick<typeof Protocol.infer, "metadata" | "importedMetadata">} protocol
* @param {NamespacedMetadataID} metadataId
*
*/
export function isMetadataInProtocol(protocol, metadataId) {
return [
...protocol.metadata,
...protocol.importedMetadata.flatMap(({ source, target }) => [source, target])
].includes(metadataId);
}
if (import.meta.vitest) {
const { test, expect, describe } = import.meta.vitest;
describe('isMetadataInProtocol', () => {
/** @type {Pick<typeof Protocol.infer, "metadata" | "importedMetadata">} */
const protocol = {
metadata: ['proto__color', 'proto__size'],
importedMetadata: [
{ sessionwide: false, source: 'other__shape', target: 'proto__shape' }
]
};
test('returns true for a direct metadata', () => {
expect(isMetadataInProtocol(protocol, 'proto__color')).toBe(true);
expect(isMetadataInProtocol(protocol, 'proto__size')).toBe(true);
});
test('returns true for the source of an imported metadata', () => {
expect(isMetadataInProtocol(protocol, 'other__shape')).toBe(true);
});
test('returns true for the target of an imported metadata', () => {
expect(isMetadataInProtocol(protocol, 'proto__shape')).toBe(true);
});
test('returns false for an unrelated metadata', () => {
expect(isMetadataInProtocol(protocol, 'proto__weight')).toBe(false);
expect(isMetadataInProtocol(protocol, 'other__color')).toBe(false);
});
test('returns false with empty protocol', () => {
expect(isMetadataInProtocol({ metadata: [], importedMetadata: [] }, 'any__id')).toBe(
false
);
});
});
}
|