Schéma du socket Wasm de parseur d’Aggrega
Référence générée. Ne pas modifier à la main — régénérer à partir du JSON Schema publié.
Identifiant du schéma : https://aggrega.ai/schemas/wasm-parse-v1beta1.schema.json
Les formes de transmission qu’un socket de plugin de parseur consomme (ParseInput) et émet (ParseOutput). Un parseur est un transformateur sans état et sans effets de bord qui transforme une représentation textuelle étrangère en un arbre JSON structuré canonique, de sorte que tout consommateur dans n’importe quel langage peut lire l’arbre sans embarquer son propre parseur du langage. Un parseur déclare les formats qu’il prend en charge en tant que capacités parse:
L’une des formes suivantes
ParseInputParseOutput
Définitions
ParseInput
Le payload que reçoit un invité parseur : le nom du format qui sélectionne la manière de lire les octets, les octets source à analyser et un document d’options opaque facultatif que le consommateur fournit pour un comportement propre au parseur.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
format | string | oui | Le nom du format source à analyser, correspondant à l’une des capacités parse: |
bytes | string | oui | Les octets source à analyser. Chaque kit les porte dans son propre type de champ — bruts lorsque ce type est un type d’octets, encodés en base64 lorsqu’il s’agit d’une chaîne que le parseur décode pour les retrouver — et l’encodeur généré convertit entre le champ et la forme sous laquelle le format de transmission porte les octets. Le parseur lit les octets retrouvés dans le format nommé. |
options | any | non | Un document d’options opaque que le consommateur fournit pour un comportement propre au parseur. L’hôte le transmet sans l’interpréter ; le parseur lit la forme, quelle qu’elle soit, qu’il documente. Absent lorsque le consommateur ne fournit aucune option. |
Les propriétés supplémentaires ne sont pas autorisées.
ParseOutput
Le payload que renvoie un invité parseur : l’arbre structuré canonique de la source analysée, ainsi que les éventuels diagnostics soulevés par l’analyse et les éventuelles plages de source qui relient les nœuds de l’arbre aux octets d’origine.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
tree | any | oui | La vue structurée canonique de la source analysée, sous forme de document JSON. Ici, « document JSON » désigne la forme de la valeur que produit un parseur — ce qui est la substance même de l’analyse — et non l’encodage dans lequel la valeur voyage : l’arbre est un document JSON quel que soit le format de transmission sur lequel ce socket le porte. Le niveau supérieur peut être un objet, un tableau ou un scalaire, selon la forme propre du document analysé (un fichier JSON, par exemple, peut être analysé en n’importe lequel de ces éléments). L’hôte transmet l’arbre de manière opaque, en le portant tel quel sans interpréter son contenu. |
diagnostics | Diagnostic[] | non | Diagnostics soulevés par l’analyse — par exemple une erreur de syntaxe ou un avertissement. Absent lorsque l’analyse n’en a produit aucun. |
spans | NodeSpan[] | non | Plages de source qui relient les nœuds de l’arbre à leur position dans les octets d’origine, de sorte qu’un consommateur peut faire correspondre un constat sur un nœud de l’arbre à un emplacement dans la source. Absent lorsque le parseur ne signale aucune plage. |
error | string | non | Un message d’échec défini lorsque l’invité s’est exécuté mais n’a pas pu terminer l’opération ; absent en cas de succès. Il est distinct des éventuels diagnostics que porte la sortie : les diagnostics signalent des problèmes trouvés pendant une exécution qui a malgré tout produit un résultat, tandis que error signale que l’opération elle-même ne s’est pas terminée. L’hôte présente une erreur présente comme une invocation de plugin échouée. |
Les propriétés supplémentaires ne sont pas autorisées.
NodeSpan
Une plage de source pour un nœud de l’arbre : un JSON Pointer RFC 6901 qui adresse le nœud dans l’arbre, associé à la plage qui le localise dans les octets d’origine.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
pointer | string | oui | Un JSON Pointer RFC 6901 dans l’arbre, qui adresse le nœud que cette plage localise. |
span | SourceSpan | oui | La plage qui localise le nœud adressé dans les octets d’origine. |
Les propriétés supplémentaires ne sont pas autorisées.
SourceSpan
Une plage des octets de la source d’origine : les décalages en octets sont l’emplacement principal et exact, et les numéros de ligne et de colonne les accompagnent pour des diagnostics lisibles par un humain.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
start_offset | integer | oui | Le décalage en octets du premier octet de la plage dans la source d’origine, à partir de zéro. |
end_offset | integer | oui | Le décalage en octets situé un octet après le dernier octet de la plage dans la source d’origine, de sorte que end_offset moins start_offset est la longueur de la plage en octets. |
start_line | integer | oui | Le numéro de ligne du début de la plage, à partir de un, pour des diagnostics lisibles par un humain. |
start_column | integer | oui | Le numéro de colonne du début de la plage, à partir de un, pour des diagnostics lisibles par un humain. |
end_line | integer | oui | Le numéro de ligne de la fin de la plage, à partir de un, pour des diagnostics lisibles par un humain. |
end_column | integer | oui | Le numéro de colonne de la fin de la plage, à partir de un, pour des diagnostics lisibles par un humain. |
Les propriétés supplémentaires ne sont pas autorisées.
ParseSourceResponse
La réponse de la fonction hôte parse-source : en cas de succès, l’arbre structuré canonique que le parseur résolu a produit, en cas d’échec, un message d’erreur. Exactement l’un des deux champs est renseigné. L’échec est transmis dans la bande plutôt que par un trap, de sorte qu’un invité consommateur reporte une absence de parseur ou un échec d’analyse dans ses propres diagnostics comme un échec déterministe. Il s’agit de l’enveloppe que reçoit un socket consommateur lorsqu’il demande à l’hôte d’exécuter un producteur via l’hôte ; le payload de la requête est un ParseInput.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
tree | any | non | L’arbre structuré canonique que le parseur résolu a produit en cas de succès, sous forme de document JSON porté tel quel ; absent en cas d’échec. Comme pour l’arbre propre de la sortie d’analyse, « document JSON » désigne la forme de la valeur plutôt que l’encodage dans lequel elle voyage. |
error | string | non | Le message d’échec en cas d’échec, nommant le format et la raison ; absent en cas de succès. |
hostfunc_error_code | string (enum) | non | L’identité de l’échec reconnaissable par une machine en cas d’échec, tirée du catalogue fermé des codes d’erreur des fonctions hôtes, définie à côté du message d’erreur lisible par un humain ; absente en cas de succès. Ce catalogue est un vocabulaire fixe qui nomme les manières dont une fonction hôte peut échouer, et c’est un vocabulaire différent des conditions d’arrêt que le compilateur enregistre, dont un invité signale les identifiants sur une sortie de socket sous condition_code et condition_short_code — le nom de la clé indique auquel des deux appartient une valeur, de sorte que les deux ne sont jamais lus comme un seul ensemble. Un invité se ramifie sur ce code sans analyser le message, en tolérant un code absent (hôte plus ancien) ou un code non reconnu (hôte plus récent) par repli sur le message. Valeurs autorisées : "fetch_request_unreadable", "fetch_input_unavailable", "fetch_failed", "request_unreadable", "request_undecodable", "source_root_unavailable", "source_read_failed", "unknown_selection_op", "source_escape", "producer_consumption_reentry", "no_source_parser", "no_parser_for_format", "parse_failed" |
Les propriétés supplémentaires ne sont pas autorisées.