@communecter/cocolight-api-client 1.0.149 → 1.0.151

package/types/costum/runtime-map.d.ts

@@ -0,0 +1,3 @@
+import type { Collection, CostumCollectionExt } from "./types.js";
+export type CostumRuntimeEntry = Pick<CostumCollectionExt, "schema" | "fields" | "presets" | "hidden">;
+export declare const COSTUM_RUNTIME: Record<string, Partial<Record<Collection, CostumRuntimeEntry>>>;

package/types/costum/runtime.d.ts

@@ -0,0 +1,99 @@
+import type { CostumExtensionModule, CostumExtensionField, KnownCostumSlug, Collection } from "./types.js";
+import type { BaseEntity } from "../api/BaseEntity.js";
+/**
+ * Contexte costum résolu, attaché à une instance d'entité via `config.costumCtx`.
+ * Porté tel quel par `BaseEntity._costumCtx` et consommé par les 3 couches de filtrage.
+ */
+export interface CostumRuntimeContext {
+    /** slug du costum (= clé envoyée en `costumSlug`, source du `source.key` côté backend). */
+    slug: string;
+    /** id de l'élément porteur du costum (collection `costumType`). */
+    costumId: string;
+    /** collection de l'élément porteur (organizations/projects/events…) → `costumType`. */
+    costumType: string;
+    /** collection de l'entité CRÉÉE sous ce scope (poi/organizations/…) — clé d'index du module. */
+    collection: Collection;
+    /** schéma AJV permissif {type:object, additionalProperties:true, properties:{…}} des champs costum. */
+    schema: {
+        type: "object";
+        additionalProperties: true;
+        properties: Record<string, unknown>;
+    };
+    /** champs costum (path/setType/arrayForm) — dispatch updateField à l'édition. */
+    fields: CostumExtensionField[];
+    /** valeurs par défaut costum (presetValue) — appliquées en data, surchargeables par l'appelant. */
+    presets: Record<string, unknown>;
+    /** champs masqués (onload hide) — non éditables. */
+    hidden: string[];
+}
+/** Type logique d'un champ costum, pour la génération de formulaire côté consommateur. */
+export type CostumFieldType = "string" | "number" | "boolean" | "date" | "array" | "object";
+/** Champ costum décrit pour un formulaire (dérivé du schéma lazy enrichi : type/enum/multiple). */
+export interface CostumFieldDescriptor {
+    name: string;
+    path: string;
+    type: CostumFieldType;
+    multiple: boolean;
+    /** Options de choix (select/multiselect). Absent si champ libre. */
+    enum?: (string | number)[];
+    /** Champ masqué (onload hide) — à exclure du formulaire. */
+    hidden: boolean;
+}
+/**
+ * Description NEUTRE d'un formulaire costum pour une collection — projection runtime des métadonnées
+ * (champs + type/enum/multiple, presets, hidden, add, createLabel). Le consommateur (ex. site-json)
+ * en dérive son propre format de form. AUCUN libellé humain n'existe dans la source (label = nom).
+ */
+export interface CostumFormDescriptor {
+    slug: string;
+    collection: Collection;
+    costumId: string;
+    costumType: string;
+    add: boolean;
+    createLabel: string | null;
+    presets: Record<string, unknown>;
+    /** Noms de champs MASQUÉS (legacy `dynForm hide`) — base ET costum (ex. type/tags/role pour tiers-lieu).
+     *  Le consommateur les exclut du formulaire (les champs costum portent aussi `hidden` par champ). */
+    hidden: string[];
+    fields: CostumFieldDescriptor[];
+}
+/**
+ * Scope costum : fabrique des entités liées à un costum. Réutilise le `user` (parent, deps, auth)
+ * et n'altère jamais l'état partagé — chaque entité reçoit son propre `_costumCtx`.
+ */
+export declare class CostumScope {
+    readonly slug: KnownCostumSlug;
+    private readonly user;
+    private readonly module;
+    private readonly costumId;
+    private readonly costumType;
+    constructor(user: BaseEntity, slug: KnownCostumSlug, module: CostumExtensionModule, costumId: string, costumType: string);
+    /** Construit le `CostumRuntimeContext` pour une collection donnée (null si le costum ne la couvre pas). */
+    contextFor(collection: Collection): CostumRuntimeContext | null;
+    /** Crée une entité de `collection` sous ce costum (presets appliqués, surchargeables par `data`). */
+    private create;
+    poi(data?: Record<string, unknown>): Promise<import("../index.js").Poi>;
+    organization(data?: Record<string, unknown>): Promise<import("../index.js").Organization>;
+    project(data?: Record<string, unknown>): Promise<import("../index.js").Project>;
+    event(data?: Record<string, unknown>): Promise<import("../index.js").Event>;
+    /**
+     * Décrit le FORMULAIRE costum d'une collection (null si non couverte) — projection NEUTRE des
+     * métadonnées runtime (champs typés + enum/multiple, presets, hidden, add, createLabel). Le module
+     * étant déjà chargé (scope obtenu via `me.costum(slug)`), c'est SYNCHRONE. Le consommateur (site-json)
+     * en dérive son format de form. NB : pas de libellé humain dans la source → label = nom du champ.
+     */
+    describeForm(collection: Collection): CostumFormDescriptor | null;
+}
+/**
+ * Dérive un `CostumRuntimeContext` SYNCHRONE depuis le `source.key` d'un élément CHARGÉ + sa collection
+ * (inc2). Permet aux entités revifiées hors scope (`fromServerData` des résultats `searchCostum`,
+ * `me.poi({id})`) de retrouver leurs champs costum (writable + dispatch) sans `me.costum(slug)`.
+ * Utilise la map bundlée `COSTUM_RUNTIME` (sync) + `COSTUM_META`. Renvoie null si le costum/collection est
+ * inconnu (costum hors registry → résolution live = inc2b).
+ */
+export declare function resolveCostumCtxFromSource(sourceKey: string | undefined | null, collection: Collection): CostumRuntimeContext | null;
+/**
+ * Résout un `CostumScope` pour un user connecté. Known-only (inc1) : charge le module généré
+ * (code-split via dynamic import) + le meta du registry. Slug inconnu => erreur explicite.
+ */
+export declare function resolveCostumScope(user: BaseEntity, slug: KnownCostumSlug): Promise<CostumScope>;

package/types/costum/schemas/CercleTravailleursSociauxLiberauxLaPlumeSociale.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/FabEn.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/LivingLabInnovationSocialeBraspanon.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/alfph.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/campagne.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/chtitube.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/circuitCourt.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/cmcasHauteBretagne.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/coFinancementTierslieux.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/coeurNumerique.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/communLundi.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/cressReunion.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/cressReunionNetwork.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/ctenat.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/cyberReunion.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/ekisphere.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/equipementsSportifs974.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/federationDesCae.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/formationGenerique.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/franceTierslieux.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/hinaura.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/hubmayotte.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/hubnouvellecaledonie.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/hubpolynesiefrancaise.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/hubreunion.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/hubterritoires.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/hubwallisetfutuna.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/hva.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/ibv2.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/institutBleu.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/journalInsoumisChambery.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/kpacite.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/laCompagnieDesTierslieux.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/laMaisonDesFaiseurs.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/laReunionPourUnNumeriqueInclusif.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/laSemaineDesTierslieux.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/labEnCommuns.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/lakou.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/lesCommunsDesTierslieux.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/mayottePourUnNumeriqueInclusif.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/meir.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/navigatorDesTierslieux.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/notragora.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/nouvellecaledoniePourUnNumeriqueInclusif.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/openAtlas.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/polynesieFrancaisePourUnNumeriqueInclusif.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/prdr.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/reseauTierslieux.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/rfflabs.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/ries.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/siteDuPactePourLaTransition.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/sportSanteBienetre.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/suppa.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/terramies.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/testeTplFormation.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/tierslieuxbelgique.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/tierslieuxorg1.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/transiter.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/vhelioPeiTour2025.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/schemas/wallisetfutunaPourUnNumeriqueInclusif.d.ts

@@ -0,0 +1,3 @@
+import type { CostumExtensionModule } from "../types.js";
+declare const mod: CostumExtensionModule;
+export default mod;

package/types/costum/symbol.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Canal interne (clé Symbol) transmettant l'ENVELOPPE costum d'une requête à `ApiClient.callEndpoint`
+ * SANS toucher la signature des méthodes générées ni polluer le wire (un Symbol est ignoré par
+ * `Object.keys`/AJV/`JSON.stringify` → invisible réseau, lisible par accès explicite seulement).
+ *
+ * Enveloppe = `{ properties, context, isUpdate? }` — UNIFIE l'injection costum (données + contexte) en UN point :
+ *  - `properties` : schéma des champs DATA costum (per-costum) → fusionnés dans le schéma compilé
+ *    (relâche `additionalProperties:false` pour les champs costum).
+ *  - `context`    : `{ costumSlug, costumId, costumType }` → injectés dans le PAYLOAD + acceptés par l'AJV.
+ *  - `isUpdate`   : UPDATE d'une entité costum routé vers `element/save` (pendant exact de l'ADD). En mode
+ *    UPDATE, `callEndpoint` compile un schéma PERMISSIF (uniquement `properties` envoyées + contexte + id +
+ *    collection, SANS les `required`/`default` du schéma de CRÉATION) avec une AJV `useDefaults:false`, car
+ *    on n'envoie que les champs MODIFIÉS et on ne doit pas réinjecter les défauts de création (parent, etc.).
+ *
+ * ⇒ le contrat (`endpoints-copie.json`) n'a plus à déclarer le contexte costum : `callEndpoint` l'ajoute
+ * automatiquement quand un costum est actif, pour n'importe quel endpoint save/add.
+ */
+export interface CostumRequestEnvelope {
+    properties: Record<string, unknown>;
+    context: Record<string, string>;
+    isUpdate?: boolean;
+    /** `$defs` du schéma combiné (tous les blocs) — nécessaires aux `$ref` des `properties` copiées en mode UPDATE. */
+    defs?: Record<string, unknown>;
+}
+export declare const COSTUM_REQUEST_ENVELOPE: unique symbol;