All files / lib/schemas protocols.js

85.9% Statements 195/227
90.9% Branches 10/11
100% Functions 6/6
85.9% Lines 195/227

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 2371x 1x 1x 1x 1x 1x   1x 1x 1x   1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x   1x 1x 1x 1x 1x 1x 1x 1x 2x 2x 2x 1x 1x 1x 1x 1x 1x 1x 4x 4x 1x 1x 1x 1x 1x 1x 1x 1x 4x 4x 1x 1x   1x 24x 24x   1x 1x 1x 1x 1x 8x 8x                                   8x 8x               1x   1x 1x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x     1x 1x 6x 6x 12x 6x 6x 1x   1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x   1x 1x 1x 1x 1x 1x 1x               1x  
import { type } from 'arktype';
import Handlebars from 'handlebars';
import { safeJSONStringify, splitFilenameOnExtension } from '../utils.js';
import { HTTPRequest, ID, ModelInput, References, URLString } from './common.js';
import { Metadata, namespacedMetadataId } from './metadata.js';
import { Image, Observation } from './observations.js';
 
/**
 * @import { Analysis } from './results';
 */
 
export const ModelDetectionOutputShape = type(['"cx"', '@', 'Coordonée X du point central'])
	.or(type(['"cy"', '@', 'Coordonée Y du point central']))
	.or(type(['"sy"', '@', 'Coordonée Y du point supérieur gauche']))
	.or(type(['"sx"', '@', 'Coordonée X du point supérieur gauche']))
	.or(type(['"ex"', '@', 'Coordonée X du point inférieur droit']))
	.or(type(['"ey"', '@', 'Coordonée Y du point inférieur droit']))
	.or(type(['"w"', '@', 'Largeur de la boîte englobante']))
	.or(type(['"h"', '@', 'Hauteur de la boîte englobante']))
	.or(type(['"score"', '@', 'Score de confiance de cette boîte, entre 0 et 1']))
	.or(type(['"_"', '@', 'Autre valeur (ignorée par CIGALE)']))
	.array();
 
const HANDLEBARS_HELPERS = {
	suffix: {
		documentation: "Ajoute un suffixe à un nom de fichier, avant l'extension",
		/**
		 * @param {string} subject
		 * @param {string} suffix
		 */
		implementation: (subject, suffix) => {
			const [stem, ext] = splitFilenameOnExtension(subject);
			return `${stem}${suffix}.${ext}`;
		}
	},
	extension: {
		documentation: 'Récupère l’extension d’un nom de fichier',
		/**
		 * @param {string} subject
		 */
		implementation: (subject) => {
			return splitFilenameOnExtension(subject)[1];
		}
	},
	fallback: {
		documentation: 'Fournit une valeur de repli si la première est indéfinie',
		/**
		 * @param {string} subject
		 * @param {string} fallback
		 */
		implementation: (subject, fallback) => {
			return subject ?? fallback;
		}
	}
};
 
for (const [name, { implementation }] of Object.entries(HANDLEBARS_HELPERS)) {
	Handlebars.registerHelper(name, implementation);
}
 
/**
 * @template {import('arktype').Type} T
 * @param {T} Input
 */
export const TemplatedString = (Input) =>
	type.string
		.pipe((t) => {
			try {
				return {
					source: t,
					template: Handlebars.compile(t, {
						noEscape: true,
						assumeObjects: true,
						knownHelpersOnly: true,
						knownHelpers: {
							suffix: true,
							extension: true,
							fallback: true
						}
					})
				};
			} catch (e) {
				throw new Error(`Invalid template ${safeJSONStringify(t)}: ${e}`);
			}
		})
		.pipe(({ source, template }) => ({
			/** @param {typeof Input.inferIn} data  */
			render(data) {
				data = Input.assert(data);
 
				return template(data);
			},
			toJSON: () => source
		}));
 
export const FilepathTemplate = type.string
	.pipe((t) => {
		try {
			return {
				source: t,
				template: Handlebars.compile(t, {
					noEscape: true,
					assumeObjects: true,
					knownHelpersOnly: true,
					knownHelpers: {
						suffix: true,
						extension: true,
						fallback: true
					}
				})
			};
		} catch (e) {
			throw new Error(`Invalid template ${safeJSONStringify(t)}: ${e}`);
		}
	})
	.pipe(({ source, template }) => ({
		/** @param {{ observation: Omit<typeof Analysis.inferIn['observations'][number], 'images'>, image: typeof Analysis.inferIn['observations'][number]['images'][number], sequence: number }} data */
		render(data) {
			return template(data).replaceAll('\\', '/');
		},
		toJSON: () => source
	}));
 
export const Protocol = type({
	id: ID.describe(
		'Identifiant unique pour le protocole. On conseille de mettre une partie qui vous identifie dans cet identifiant, car il doit être globalement unique. Par exemple, mon-organisation.mon-protocole'
	),
	metadata: References,
	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'],
	'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(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"
	),
	'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({
		metadata: [ID, '@', 'Métadonnée associée à la boîte englobante'],
		'confirmationMetadata?': [
			ID,
			'@',
			'Métadonnée associée au fait que la boîte englobante a été (humainement) confirmée'
		],
		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'),
		'infer?': type({
			'name?': [
				'string',
				'@',
				"Nom du réseau à afficher dans l'interface. Particulièrement utile si il y a plusieurs réseaux"
			],
			model: HTTPRequest.describe(
				'Lien vers le modèle de détection utilisé pour inférer les boîtes englobantes. Au format ONNX (.onnx) seulement, pour le moment.'
			),
			input: ModelInput.describe("Configuration de l'entrée du modèle"),
			output: type({
				'name?': [
					'string',
					'@',
					"Nom de l'output du modèle à utiliser. output0 par défaut"
				],
				normalized: [
					'boolean',
					'@',
					"Si les coordonnées des boîtes englobantes sont normalisées par rapport aux dimensions de l'image"
				],
				shape: ModelDetectionOutputShape.describe(
					"Forme de sortie de chaque boîte englobante. Nécéssite obligatoirement d'avoir 'score'; 2 parmi 'cx', 'sx', 'ex', 'w'; et 2 parmi 'cy', 'sy', 'ey', 'h'. Si les boîtes contiennent d'autre valeurs, bien les mentionner avec '_', même quand c'est à la fin de la liste: cela permet de savoir quand on passe à la boîte suivante. Par exemple, [cx, cy, w, h, score, _] correspond à un modèle YOLO11 COCO"
				)
			}).describe(
				'Forme de la sortie du modèle de classification. Par exemple, shape: [cx, cy, w, h, score, _] et normalized: true correspond à un modèle YOLO11 COCO'
			)
		})
			.array()
			.describe("Configuration de l'inférence des boîtes englobantes")
	}).describe('Configuration de la partie recadrage'),
	exports: type({
		images: type({
			cropped: FilepathTemplate.describe('Chemins des images recadrées'),
			original: FilepathTemplate.describe('Chemins des images originales')
		}).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.string
				.describe("Chemin du fichier JSON contenant les résultats de l'analyse")
				.pipe((path) => path.replaceAll('\\', '/')),
			csv: type.string
				.describe("Chemin du fichier CSV contenant les résultats de l'analyse")
				.pipe((path) => path.replaceAll('\\', '/'))
		}
	})
		.describe("La structure du fichier .zip d'export pour ce protocole.")
		.optional()
});
 
export const ExportedProtocol = Protocol.omit('metadata')
	.in.and({
		metadata: {
			'[string]': Metadata.omit('id').describe('Métadonnée du protocole')
		}
	})
	.pipe((protocol) => ({
		...protocol,
		metadata: Object.fromEntries(
			Object.entries(protocol.metadata).map(([id, metadata]) => [
				namespacedMetadataId(protocol.id, id),
				metadata
			])
		)
	}));