@capytale/activity.js
TypeScript icon, indicating that this package has built-in type declarations

3.0.1 • Public • Published

@capytale/activity.js

Collection de modules pour faciliter l'interfaçage d'un player avec Capytale. Rien n'est 'bundlé'. Le consommateur du package doit le faire.

Liste des modules principaux (qui sont en fait des collections de modules sans index) :

  • api/http : encapsulation de fetch
  • api/csrf : gestion du csrf token et aussi du header spécifique pour FS API
  • api/rest : encapsulation de l'API REST de Drupal
  • api/fs : encapsulation de FS API
  • api/me : encapsulation de l'API qui permet d'obtenir les infos sur l'utilisateur Capytale connecté
  • entity : encapsulation de la notion d'entity Drupal
    • entity/fieldTypes : les types de champ (typescript)
    • entity/fieldDefinition : permet définitir le type d'un champ
    • entity/fieldImplementation : implémente le comportement des différents types de champ
    • entity/node
    • entity/user
  • activity/activityBunch : gére le chargement des paires ActivityNode / StudentAssignment en fournissant les variantes de entity/node adaptées au type d'activité rencontrée selon que le contenu est en DB ou en FS mais aussi selon que le bundle de l'activité est activity, console_activity ou notebook_activity
    • activity/activityBunch/base/nodes : expose les différentes variantes de entity/node
  • activity/activitySession : gére le chargement d'un ActivityBunch ainsi que les données de l'utilisateur courant et éventuellement du propriétaire
  • activity/archiver : fourni une énumération des contenus à inclure lors de la création d'un export d'une activité
  • backend/capytale : C'est le point d'entrée qui expose les autres modules

exemple

// Demander le support de l'activité universelle.
import "@capytale/activity.js/activity/activityBunch/uni";
import type { ActivityBunch } from "@capytale/activity.js/activity/activityBunch/uni";
import type { ActivitySession } from "@capytale/activity.js/activity/activitySession";

// Importer le loader de session.
import load from "@capytale/activity.js/backend/capytale/activitySession";

(async () => {
    const session: ActivitySession  = await load(17);
    const bunch = session.activityBunch;
    bunch.title.value = 'mon titre';
    await bunch.save()
    console.log('sauvegardé');
})();

Readme

Keywords

none

Package Sidebar

Install

npm i @capytale/activity.js

Weekly Downloads

43

Version

3.0.1

License

none

Unpacked Size

525 kB

Total Files

463

Last publish

Collaborators

  • capytale-bot
  • tjaisson
  • chardetm
  • casatir