Global

Members

(constant) config

Config par défaut

Source:

(constant) errorDataOutputStream

un log spécifique pour les erreurs liées à des datas incohérentes

Source:

(constant) errorOutputStream

un log d'erreur actif en prod

Source:

(constant) fs

module log avec ses nos loggers maison

Source:
To Do:
  • utiliser https://www.npmjs.org/package/winston
  • utiliser https://nodejs.org/api/util.html#util_util_debuglog_section

(constant) glob

Pour appeler le cli avec une autre config que celle par défaut, passer par l'environnement :
env SESATHEQUE_CONF=xxx app/cli.js … pour utiliser la config _private/xxx.js

Source:

(constant) path

Configuration de l'application

Source:

perfOutputStream

un log pour mesure de performances

Source:

(constant) root

La racine du projet

Source:

Methods

addBodyParsers(rail)

Ajoute notre bodyParser après le middleware cookie

Parameters:
Name Type Description
rail
Source:

addCorsAndLog(rail)

Ajoute sur le rail les requetes en console (en dev), CORS, expires, access.log et perf.log

Parameters:
Name Type Description
rail Object

le rail express

Source:

app(optionsopt, afterBootCallbackopt) → {Promise.<Lassi>}

Démarre l'application Sesathèque

Parameters:
Name Type Attributes Description
options object <optional>
Properties
Name Type Attributes Default Description
settings object <optional>

Éventuelles surcharges des settings

noCheckLocalOnRemote boolean <optional>
false

Passer true pour ne pas vérifier la cohérence de notre configuration sur les sésathèques distantes (déclarées dans notre configuration)

afterBootCallback simpleCallback <optional>
Source:
Returns:
Type
Promise.<Lassi>

beforeBootsrap(lassi, mainComponent, allComponents)

Ajoute nos middlewares et listeners, après déclaration des composants mais avant bootstrap

Parameters:
Name Type Description
lassi Lassi

L’instance de lassi de cette application

mainComponent Lassi#Component

Le composant principal sur lequel sera lancé bootstrap() (après la fin de l'éxécution de cette fonction)

allComponents Array.<Lassi#Component>

La liste des composants en dépendances

Source:

boot(beforeBootstrapCb, optionsopt, afterBootCb)

Boot l'application

Parameters:
Name Type Attributes Description
beforeBootstrapCb beforeBootstrapCallback
options object <optional>

Options qui seront passées à lassi() (@link Lassi)

afterBootCb simpleCallback
Source:

cleanEc2(arbre)

Supprime les contenus ec2 dans l'arbre, retourne le nb d'ec2 virés

Parameters:
Name Type Description
arbre
Source:

filterOnBaseUrl(list) → {Array}

Retourne les éléments de list avec une baseUrl valide
(à laquelle on a éventuellement ajouté le slash de fin)

Parameters:
Name Type Description
list Array
Source:
Returns:

Liste dont tous les éléments ont une baseUrl valide

Type
Array

GET /api/baseId/:id()

Retourne la baseUrl d'une baseId de sesatheque
(connue par configuration ou déclarée ici par un client)

Source:

getNormalizedGraphe(ressource) → {Graphe}

Fonction getNormalizedGraphe de j3p (methodesmodele au 14/05/2020) dont on a juste modifié les lignes de log
Retourne un graphe normalisé (id en string, nn et snn aussi, fin en minuscule, nœuds fin ajoutés avec nn et snn toujours des id, jamais fin)
Retournera null en cas de pb. Attention, graphe peut être modifié également.

Parameters:
Name Type Description
ressource Ressource
Source:
Returns:

Le graphe (avec 1er elt vide) normalisé

Type
Graphe

isConfigured()

À partir le là on a la conf locale, on vérifie et normalise un peu (autant signaler une erreur dès le boot)

Source:

listMissing(done)

Rafraichit les datas de tous les arbres

Parameters:
Name Type Description
done errorCallback
Source:

POST /api/checkSesalab()

Valide la configuration d'un sesalab
Si tout est bon, retournera {success: true, baseId: 'laBaseId assignée au sesalab appelant'}
sinon un {success: false, errors: ['error 1', …]}

Source:

POST /api/checkSesatheque()

Valide la configuration d'une sésatheque (qui nous envoie ses sesatheques et sesalabs)

Source:

purgeEc2(oidopt, done)

Purge les ressources ec2 dans tous les arbres

Parameters:
Name Type Attributes Description
oid string <optional>
done errorCallback
Source:

refreshArbres(oidopt, done)

Rafraichit les datas de tous les arbres

Parameters:
Name Type Attributes Description
oid string <optional>
done errorCallback
Source:

restore(oidopt, done)

Restore une version depuis les archives

Parameters:
Name Type Attributes Description
oid string <optional>
done errorCallback
Source:

Type Definitions

beforeBootstrapCallback(L'instance, sesatheque, La)

Appelé après déclaration des composants mais avant bootstrap

Parameters:
Name Type Description
L'instance Lassi

lassi

sesatheque Component

Notre appli

La Array.<string>

liste des dépendances de notre appli

Source:

EntityPersonne

Entity pour un user

Source: