@communecter/cocolight-api-client 1.0.126 → 1.0.128

package/src/index.ts

@@ -75,6 +75,7 @@ export type { News } from "./api/News.js";
 export type { Comment } from "./api/Comment.js";
 export type { Answer } from "./api/Answer.js";
 export type { Form } from "./api/Form.js";
+export type { Action } from "./api/Action.js";
 
 // Types ServerData (données normalisées reçues du serveur)
 export type * from "./api/serverDataType/User.js";
@@ -94,6 +95,8 @@ export type * from "./api/serverDataType/News.js";
 export type * from "./api/serverDataType/Comment.js";
 export type * from "./api/serverDataType/Answer.js";
 export type * from "./api/serverDataType/Form.js";
+export { ACTION_STATUSES } from "./api/serverDataType/Action.js";
+export type * from "./api/serverDataType/Action.js";
 export type * from "./api/serverDataType/common.js";
 export type * from "./api/serverDataType/Country.js";
 export type * from "./api/serverDataType/Zone.js";

package/src/types/entities.ts

@@ -1,5 +1,6 @@
 // types/entities.ts - Types partagés pour éviter les dépendances circulaires
 
+import type { Action } from "../api/Action.js";
 import type { Answer } from "../api/Answer.js";
 import type { Badge } from "../api/Badge.js";
 import type { Classified } from "../api/Classified.js";
@@ -15,7 +16,7 @@ import type { User } from "../api/User.js";
 /**
  * Union type for all possible entity types
  */
-export type EntityTypes = User | Organization | Project | Event | Poi | Badge | News | Comment | Answer | Form | Classified;
+export type EntityTypes = User | Organization | Project | Event | Poi | Badge | News | Comment | Answer | Form | Classified | Action;
 
 /**
  * Type union représentant les entités pouvant être retournées par une recherche.
@@ -35,7 +36,7 @@ export type EntityData =
 /**
  * Types de collection possibles
  */
-export type CollectionType = "citoyens" | "organizations" | "projects" | "events" | "poi" | "news" | "badges" | "comments" | "answers" | "forms" | "classifieds";
+export type CollectionType = "citoyens" | "organizations" | "projects" | "events" | "poi" | "news" | "badges" | "comments" | "answers" | "forms" | "classifieds" | "actions";
 
 /**
  * Types pour les références entre entités

package/types/api/Action.d.ts

@@ -0,0 +1,27 @@
+import { BaseEntity } from "./BaseEntity.js";
+import type { CostumProjectActionRequestNewData } from "./EndpointApi.types.js";
+import type { ActionItemNormalized } from "./serverDataType/Action.js";
+/**
+ * Entité Action — tâche/jalon attaché à un Project.
+ *
+ * Toujours liée à un Project parent (parentType="projects" est const côté backend).
+ * S'instancie via `project.action(...)` plutôt que directement.
+ *
+ * Endpoints utilisés :
+ * - `get()` : hérité (GET_ELEMENTS_ABOUT via `/co2/element/about/type/actions/id/{id}`)
+ * - `_add()` : COSTUM_PROJECT_ACTION_REQUEST_NEW (parentId/parentType injectés depuis le parent)
+ */
+export declare class Action extends BaseEntity<ActionItemNormalized> {
+    static entityType: string;
+    static entityTag: string;
+    static SCHEMA_CONSTANTS: string[];
+    static ADD_BLOCKS: Map<"COSTUM_PROJECT_ACTION_REQUEST_NEW", "addAction">;
+    defaultFields: Record<string, any>;
+    removeFields: string[];
+    _add: (payload: Record<string, any>) => Promise<void>;
+    /**
+     * Crée une nouvelle action via /costum/project/action/request/new.
+     * Méthode de bas niveau — utiliser `save()` après modification du draft à la place.
+     */
+    addAction(data?: Partial<CostumProjectActionRequestNewData>): Promise<unknown>;
+}

package/types/api/BaseEntity.d.ts

@@ -35,6 +35,9 @@ type BadgeInput = {
 type NewsInput = {
     id: string;
 } | Record<string, any>;
+type ActionInput = {
+    id: string;
+} | Record<string, any>;
 type ApiClient = import("../ApiClient.js").default;
 type EndpointApi = import("./EndpointApi.js").default;
 type User = import("./User.js").User;
@@ -48,7 +51,8 @@ type Comment = import("./Comment.js").Comment;
 type Answer = import("./Answer.js").Answer;
 type Form = import("./Form.js").Form;
 type Classified = import("./Classified.js").Classified;
-type AnyEntity = User | Organization | Project | Poi | EventEntity | Badge | News | Comment | Answer | Form | Classified;
+type Action = import("./Action.js").Action;
+type AnyEntity = User | Organization | Project | Poi | EventEntity | Badge | News | Comment | Answer | Form | Classified | Action;
 type ParentLike = BaseEntity<any> & {
     apiClient: ApiClient;
     userContext?: User | null;
@@ -70,6 +74,7 @@ interface Deps {
     Answer?: any;
     Form?: any;
     Classified?: any;
+    Action?: any;
 }
 interface BaseEntityConfig {
     entityTag?: string;
@@ -86,6 +91,7 @@ interface EntityTypeMap {
     answers: Answer;
     forms: Form;
     classifieds: Classified;
+    actions: Action;
 }
 type ReadableWithMeta = import("stream").Readable & {
     path?: string;
@@ -174,7 +180,7 @@ interface LinkMeta {
 }
 type BaseEntityCtor = typeof BaseEntity & {
     entityTag: string;
-    entityType: "citoyens" | "organizations" | "projects" | "events" | "poi" | "badges" | "news" | "comments" | "answers" | "forms" | "classifieds";
+    entityType: "citoyens" | "organizations" | "projects" | "events" | "poi" | "badges" | "news" | "comments" | "answers" | "forms" | "classifieds" | "actions";
     SCHEMA_CONSTANTS: string | string[];
 };
 interface FilterValueExistsOnly {
@@ -215,7 +221,7 @@ interface FinalizerResult<TOut> {
         total: number;
     } & Record<string, any>;
 }
-export type EntityType = "citoyens" | "organizations" | "projects" | "events" | "poi" | "badges" | "news" | "comments" | "answers" | "forms" | "classifieds";
+export type EntityType = "citoyens" | "organizations" | "projects" | "events" | "poi" | "badges" | "news" | "comments" | "answers" | "forms" | "classifieds" | "actions";
 /**
  * Classe de base pour toutes les entités métiers : utilisateurs, projets, organisations, etc.
  * Fournit un système de brouillon (draft), transformation, appel API sécurisé,
@@ -300,7 +306,7 @@ export declare class BaseEntity<TServerData = any> {
     /** @returns Indique si cette entité représente l'utilisateur connecté */
     get isMe(): boolean;
     /** @returns Type de l'entité (ex: 'citoyens') */
-    getEntityType(): "citoyens" | "organizations" | "projects" | "events" | "poi" | "badges" | "news" | "comments" | "answers" | "forms" | "classifieds";
+    getEntityType(): "citoyens" | "organizations" | "projects" | "events" | "poi" | "badges" | "news" | "comments" | "answers" | "forms" | "classifieds" | "actions";
     /**
      * Indique si le draft contient des modifications par rapport aux données initiales.
      * @returns {boolean}
@@ -1124,6 +1130,17 @@ export declare class BaseEntity<TServerData = any> {
      * @throws {Error} Si une erreur se produit lors de la création de la news.
      */
     news(newsData?: NewsInput): Promise<News>;
+    /**
+     * Crée une instance d'Action et la récupère si nécessaire.
+     *
+     * Par défaut une action ne peut être créée que depuis un Project — les autres
+     * entités lèvent une erreur. Override sur Project pour activer le comportement.
+     *
+     * @param actionData - Les données pour initialiser l'action.
+     * @returns Une promesse qui résout l'objet Action créé.
+     * @throws {ApiError} Sur les entités non supportées.
+     */
+    action(_actionData?: ActionInput): Promise<Action>;
     /**
      * Récupérer les organisations d'une entitée : la liste des organisations dont l'entité est membre ou admin valide.
      * Constant : GET_ORGANIZATIONS_ADMIN | GET_ORGANIZATIONS_NO_ADMIN

package/types/api/EndpointApi.types.d.ts

@@ -399,7 +399,7 @@ export interface GetElementsAboutData {
         /**
          * Type d'entité
          */
-        type: "citoyens" | "projects" | "organizations" | "events" | "poi" | "badges" | "answers" | "classifieds" | "forms";
+        type: "citoyens" | "projects" | "organizations" | "events" | "poi" | "badges" | "answers" | "classifieds" | "forms" | "actions";
         /**
          * ID de l'utilisateur ou de l'entité
          */
@@ -4834,9 +4834,9 @@ export interface UpdatePathValueData {
     /**
      * Valeur à mettre à jour (peut être un objet, un tableau, une chaîne, etc.)
      */
-    value: {
+    value: string | number | boolean | {
         [k: string]: unknown;
-    };
+    } | unknown[] | null;
     [k: string]: unknown;
 }
 export interface DeleteDocumentByContextData {
@@ -5043,9 +5043,9 @@ export interface CostumProjectActionRequestNewData {
      */
     name: string;
     /**
-     * Statut de l'action
+     * Statut de l'action. Sert aussi de trigger côté backend : 'done' ajoute startDate/endDate auto, 'tracking' active le mode tracking, 'discuter'/'next'/'totest' ajoutent un tag.
      */
-    status: string;
+    status: "todo" | "done" | "tracking" | "discuter" | "next" | "totest" | "disabled" | "closed";
     /**
      * ID du projet parent
      */
@@ -5055,18 +5055,74 @@ export interface CostumProjectActionRequestNewData {
      */
     parentType: "projects";
     /**
-     * Montant financé
+     * Montant financé (default: 1)
      */
-    credits: number;
+    credits?: number;
     /**
      * Jalon associé à l'action
      */
-    milestone: {
+    milestone?: {
         /**
          * ID du jalon associé
          */
         milestoneId: string;
+        /**
+         * Date de début du jalon (ISO 8601, convertie en MongoDate UTC côté backend)
+         */
+        startDate?: string;
+        /**
+         * Date de fin du jalon (ISO 8601, convertie en MongoDate UTC côté backend)
+         */
+        endDate?: string;
     };
+    /**
+     * Date et heure de début (ISO 8601 avec offset)
+     */
+    startDate?: string;
+    /**
+     * Date et heure de fin (ISO 8601 avec offset)
+     */
+    endDate?: string;
+    /**
+     * Temps passé en minutes (utilisé pour calculer endDate quand status=done)
+     */
+    timeSpent?: number;
+    /**
+     * Nombre minimum de contributeurs
+     */
+    min?: number;
+    /**
+     * Nombre maximum de contributeurs (doit être >= min côté backend)
+     */
+    max?: number;
+    /**
+     * Niveau d'importance de l'action
+     */
+    importance?: string;
+    /**
+     * ID de la room parente. Si absent, auto-créée par Room::getOrCreateActionRoom côté backend
+     */
+    idParentRoom?: string;
+    /**
+     * Si true, ajoute l'auteur courant comme contributor admin. ATTENTION : écrasé si 'mentions' est aussi fourni.
+     */
+    is_contributor?: boolean;
+    /**
+     * userId à assigner comme contributor admin. ATTENTION : écrasé si 'mentions' est aussi fourni.
+     */
+    assign?: string;
+    /**
+     * URLs externes associées à l'action (tableau de strings, ou "" pour vider). Passthrough côté backend.
+     */
+    urls?: string[] | "";
+    /**
+     * Liste des contributeurs assignés à l'action par username. Résolu côté backend en links.contributors.{userId}. ATTENTION : ÉCRASE 'assign' et 'is_contributor' si fournis ensemble.
+     */
+    mentions?: string[];
+    /**
+     * Liste des tags associés à l'action. BUG CONNU BACKEND : les tags sont dupliqués dans la réponse (array_merge avec soi-même côté PHP).
+     */
+    tags?: string[];
     [k: string]: unknown;
 }
 export interface LinkDiscourseAccountData {

package/types/api/EntityRegistry.d.ts

@@ -1,5 +1,5 @@
 import type { CollectionType } from "../types/entities.js";
-export type EntityTag = "User" | "Organization" | "Project" | "Event" | "Poi" | "Badge" | "News" | "Comment" | "Answer" | "Form" | "Classified";
+export type EntityTag = "User" | "Organization" | "Project" | "Event" | "Poi" | "Badge" | "News" | "Comment" | "Answer" | "Form" | "Classified" | "Action";
 export type CollectionKey = CollectionType;
 type BaseEntity = import("./BaseEntity.js").BaseEntity<any>;
 type ApiClient = import("../ApiClient.js").default;

package/types/api/Project.d.ts

@@ -1,4 +1,5 @@
 import { BaseEntity } from "./BaseEntity.js";
+import type { Action } from "./Action.js";
 import type { PaginatorPage, PaginatorState } from "./BaseEntity.js";
 import type { AddProjectData, GetContributorsAdminData, GetContributorsNoAdminData } from "./EndpointApi.types.js";
 import type { Organization } from "./Organization.js";
@@ -135,6 +136,12 @@ export declare class Project extends BaseEntity<ProjectItemNormalized> {
      * Crée une instance de news et la récupère si nécessaire.
      */
     news(newsData?: Parameters<BaseEntity<ProjectItemNormalized>["news"]>[0]): Promise<import("./News.js").News>;
+    /**
+     * {@inheritDoc BaseEntity#action}
+     *
+     * Crée une instance d'Action liée à ce projet et la récupère si nécessaire.
+     */
+    action(actionData?: Parameters<BaseEntity<ProjectItemNormalized>["action"]>[0]): Promise<Action>;
     /**
      * ───────────────────────────────
      *  Lien utilisateur ↔ projet

package/types/api/User.d.ts

@@ -46,6 +46,7 @@ export declare class User extends BaseEntity<UserItemNormalized> {
         Comment: typeof import("./Comment.js").Comment;
         Answer: typeof import("./Answer.js").Answer;
         Classified?: typeof import("./Classified.js").Classified;
+        Action?: typeof import("./Action.js").Action;
     });
     get slug(): any;
     get isMe(): boolean;

package/types/api/serverDataType/Action.d.ts

@@ -0,0 +1,150 @@
+import type { IdObject, LinkContributorsRef, ParentsMap, DateValue } from "./common.js";
+import type EJSONType from "../../EJSONType.js";
+type ObjectIDCtor = typeof EJSONType["ObjectID"];
+type ObjectID = InstanceType<ObjectIDCtor>;
+/**
+ * Statuts supportés par une action (cf. COSTUM_PROJECT_ACTION_REQUEST_NEW).
+ */
+export declare const ACTION_STATUSES: readonly ["todo", "done", "tracking", "discuter", "next", "totest", "disabled", "closed"];
+export type ActionStatus = (typeof ACTION_STATUSES)[number];
+export interface ActionLinksBlock {
+    contributors?: Record<string, LinkContributorsRef>;
+    [k: string]: unknown;
+}
+export interface ActionMilestoneRef {
+    milestoneId: string;
+    startDate?: DateValue;
+    endDate?: DateValue;
+}
+export interface ActionCounts {
+    contributors?: number;
+    [k: string]: unknown;
+}
+/**
+ * Historique des changements de statut (alimenté par /set_status côté backend).
+ * `update` est un MongoDate (DateValue côté Json, Date côté Normalized).
+ */
+export interface ActionUpdateStatusEntryJson {
+    status: ActionStatus;
+    author: string;
+    update: DateValue;
+}
+export interface ActionUpdateStatusEntryNormalized {
+    status: ActionStatus;
+    author: string;
+    update: Date;
+}
+/**
+ * Sous-tâche d'une action. Stockée dans `tasks[]`.
+ */
+export interface ActionTaskJson {
+    taskId?: string;
+    task?: string;
+    checked?: boolean;
+    userId?: string;
+    contributors?: Record<string, unknown>;
+    timeSpent?: number;
+    createdAt?: DateValue;
+    checkedAt?: DateValue;
+    [key: string]: unknown;
+}
+export interface ActionTaskNormalized {
+    taskId?: string;
+    task?: string;
+    checked?: boolean;
+    userId?: string;
+    contributors?: Record<string, unknown>;
+    timeSpent?: number;
+    createdAt?: Date;
+    checkedAt?: Date;
+    [key: string]: unknown;
+}
+/**
+ * Bloc media : galerie d'images + fichiers attachés (par IDs de documents).
+ */
+export interface ActionMedia {
+    type?: string;
+    countImages?: number;
+    images?: string[];
+    files?: string[];
+    [k: string]: unknown;
+}
+export interface ActionMediaFile {
+    files?: string[];
+    [k: string]: unknown;
+}
+export interface ActionItemJson {
+    _id: IdObject;
+    collection: "actions";
+    name: string;
+    description?: string;
+    status?: ActionStatus;
+    created?: DateValue;
+    updated?: DateValue;
+    modified?: DateValue;
+    startDate?: DateValue;
+    endDate?: DateValue;
+    parentId: string;
+    parentType: string;
+    parent?: ParentsMap;
+    tags?: string[];
+    links?: ActionLinksBlock;
+    creator?: string;
+    idUserAuthor?: string;
+    credits?: string;
+    idParentRoom?: string;
+    milestone?: ActionMilestoneRef;
+    importance?: string;
+    counts?: ActionCounts;
+    url?: string;
+    min?: number;
+    max?: number;
+    timeSpent?: number;
+    tracking?: boolean;
+    updateStatus?: ActionUpdateStatusEntryJson[];
+    rc?: unknown[];
+    tasks?: ActionTaskJson[];
+    media?: ActionMedia;
+    mediaFile?: ActionMediaFile;
+    [key: string]: unknown;
+}
+export interface ActionItemNormalized {
+    id: string;
+    _id: ObjectID;
+    collection: "actions";
+    name: string;
+    description?: string;
+    status?: ActionStatus;
+    created?: Date;
+    updated?: Date;
+    modified?: Date;
+    startDate?: Date;
+    endDate?: Date;
+    parentId: string;
+    parentType: string;
+    parent?: ParentsMap;
+    tags?: string[];
+    links?: ActionLinksBlock;
+    creator?: string;
+    idUserAuthor?: string;
+    credits?: number;
+    idParentRoom?: string;
+    milestone?: Omit<ActionMilestoneRef, "startDate" | "endDate"> & {
+        startDate?: Date;
+        endDate?: Date;
+    };
+    importance?: string;
+    counts?: ActionCounts;
+    url?: string;
+    min?: number;
+    max?: number;
+    timeSpent?: number;
+    tracking?: boolean;
+    updateStatus?: ActionUpdateStatusEntryNormalized[];
+    rc?: unknown[];
+    tasks?: ActionTaskNormalized[];
+    media?: ActionMedia;
+    mediaFile?: ActionMediaFile;
+    [key: string]: unknown;
+}
+export {};