@communecter/cocolight-api-client 1.0.132 → 1.0.134

package/types/api/BaseEntity.d.ts

@@ -41,6 +41,9 @@ type ActionInput = {
 type FormInput = {
     id: string;
 } | Record<string, any>;
+type AnswerInput = {
+    id: string;
+} | Record<string, any>;
 type ApiClient = import("../ApiClient.js").default;
 type EndpointApi = import("./EndpointApi.js").default;
 type User = import("./User.js").User;
@@ -108,6 +111,7 @@ interface EntityTypeMap {
 type ReadableWithMeta = import("stream").Readable & {
     path?: string;
     mimeType?: string;
+    size?: number;
 };
 type UploadInput = File | Blob | Buffer | import("stream").Readable;
 type ValidatedUpload = File | Buffer | ReadableWithMeta;
@@ -527,6 +531,37 @@ export declare class BaseEntity<TServerData = any> {
      * @private
      */
     protected _validateFile(fileInput: UploadInput): Promise<ValidatedUpload>;
+    /**
+     * Prépare un fichier pour un upload multipart **sans restriction MIME**.
+     *
+     * Diffère de `_validateImage` / `_validateFile` (liste MIME blanche stricte) :
+     * accepte tout MIME et garantit la conversion `Buffer → annotated stream` en
+     * Node (le multipart encoder du package `form-data` ignore les Buffer bruts ;
+     * il a besoin de `path` + `mimeType` sur un Readable).
+     *
+     * Pensé pour les endpoints d'upload large-spectre (ex: coform où l'utilisateur
+     * peut uploader PNG, GIF, WebP, PDF, DOCX, XLSX, etc. — c'est le backend qui
+     * filtre selon la config du Form, pas le client).
+     *
+     * Compatible browser + Node :
+     *  - Browser `File`    → pass-through
+     *  - Browser `Blob`    → wrap en `File` (génère nom + extension via MIME)
+     *  - Node `Buffer`     → détecte MIME via `file-type`, convertit en `Readable`
+     *                        annoté (`path`, `mimeType`)
+     *  - Node `Readable`   → pass-through si annoté, sinon utilise `fallbackName`
+     *
+     * @param input - Fichier à uploader (Buffer/File/Blob/Readable)
+     * @param fallbackName - Nom à utiliser si l'input n'en porte pas. Défaut `upload-<ts>`.
+     * @returns `{ qqfile, qqfilename, qqtotalfilesize }` prêt pour multipart.
+     * @throws {ApiError} si le type de l'input n'est pas reconnu.
+     *
+     * @protected
+     */
+    protected _prepareUploadFile(input: UploadInput, fallbackName?: string): Promise<{
+        qqfile: ValidatedUpload;
+        qqfilename: string;
+        qqtotalfilesize: number;
+    }>;
     /**
      * Valide les entrées d'upload de fichiers.
      *
@@ -539,14 +574,17 @@ export declare class BaseEntity<TServerData = any> {
      */
     private _validateUploadInput;
     /**
-     * Transforme un Buffer en ReadableStream équivalent à fs.createReadStream
+     * Transforme un Buffer en ReadableStream équivalent à fs.createReadStream.
+     *
+     * Note : passé `protected` car réutilisé par `_prepareUploadFile()` (Answer).
+     *
      * @param buffer - Le buffer contenant les données binaires
      * @param [filename="file.bin"] - Nom de fichier (utilisé dans FormData)
      * @param [mimeType="application/octet-stream"] - Type MIME (utilisé dans FormData)
      * @returns - Readable doté de `path` et `mimeType`
-     * @private
+     * @protected
      */
-    private _createReadStreamFromBuffer;
+    protected _createReadStreamFromBuffer(buffer: Buffer, filename?: string, mimeType?: string): Promise<ReadableWithMeta>;
     /**
      * Transforme un Buffer en ReadableStream.
      *
@@ -1195,6 +1233,21 @@ export declare class BaseEntity<TServerData = any> {
      * const answers = await form.getAnswers();        // utilise le costumContext de l'org
      */
     form(formData?: FormInput): Promise<Form>;
+    /**
+     * Crée une instance d'Answer rattachée à l'entité courante.
+     *
+     * Méthode autorisée uniquement sur `Form` (la seule entité qui porte un
+     * `id` de formulaire pré-rempli pour les drafts). Les autres entités la
+     * bloquent via cet override par défaut qui throw.
+     *
+     * Pour fetch une Answer existante sans contexte Form, passer par
+     * `EntityRegistry.createEntityFromData` ou un endpoint adhoc.
+     *
+     * @param _answerData - `{ id: string }` (fetch) ou objet partiel (draft).
+     * @returns Une Answer.
+     * @throws {ApiError} 501 sur les entités non supportées.
+     */
+    answer(_answerData?: AnswerInput): Promise<Answer>;
     /**
      * 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/Form.d.ts

@@ -54,4 +54,28 @@ export declare class Form extends BaseEntity<FormItemNormalized> {
     getAnswers(data?: Partial<CoformAnswersSearchData>, options?: {
         restoredState?: PaginatorState;
     }): Promise<PaginatorPage<Answer>>;
+    /**
+     * {@inheritDoc BaseEntity#answer}
+     *
+     * Crée une instance d'Answer **rattachée à ce Form**.
+     *
+     * - Si `answerData.id` est fourni → fetch l'Answer existante (via `COFORM_ANSWERS_BY_ID`).
+     * - Sinon → crée un draft d'Answer avec `form: this.id` pré-rempli, prêt à
+     *   être complété puis sauvegardé.
+     *
+     * Le parent de l'Answer renvoyée est ce Form — la chaîne `org > form > answer`
+     * est donc préservée, ce qui permet (à terme) à l'Answer de remonter le
+     * costumContext via `this.parent.parent` si besoin.
+     *
+     * @example
+     * // Fetch d'une Answer existante
+     * const form = await org.form({ id: "6925e2b05dd63b02ca70d6d9" });
+     * const answer = await form.answer({ id: "6925869ad76aaf6c5a2b2f8a" });
+     *
+     * // Création d'un draft
+     * const draft = await form.answer();
+     * draft.data.answers = { "field1": "value1" };
+     * await draft.save();
+     */
+    answer(answerData?: Parameters<BaseEntity<FormItemNormalized>["answer"]>[0]): Promise<Answer>;
 }

package/types/api/Project.d.ts

@@ -149,11 +149,6 @@ export declare class Project extends BaseEntity<ProjectItemNormalized> {
      * Crée une instance de badge et la récupère si nécessaire.
      */
     badge(badgeData?: Parameters<BaseEntity<ProjectItemNormalized>["badge"]>[0]): Promise<import("./Badge.js").Badge>;
-    /**
-     * {@inheritDoc BaseEntity#news}
-     *
-     * Crée une instance de news et la récupère si nécessaire.
-     */
     /**
      * {@inheritDoc BaseEntity#form}
      *
@@ -162,6 +157,11 @@ export declare class Project extends BaseEntity<ProjectItemNormalized> {
      * `coformAnswersSearch` avec le bon costumContext.
      */
     form(formData?: Parameters<BaseEntity<ProjectItemNormalized>["form"]>[0]): Promise<import("./Form.js").Form>;
+    /**
+     * {@inheritDoc BaseEntity#news}
+     *
+     * 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>;
     /**
      * Vérifie qu'un milestoneId existe dans `serverData.oceco.milestones[]`.

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

@@ -55,6 +55,12 @@ export interface AnswerItemJson {
     project?: AnswerProjectRef;
     [key: string]: unknown;
 }
+/**
+ * Raisons de refus d'édition côté backend, calculées par `coformAnswersById`
+ * et présentes dans la réponse normalisée. Utilisé par les UI pour distinguer
+ * les modes readonly/edit et afficher des messages contextuels.
+ */
+export type AnswerEditDeniedReason = "not_logged_in" | "not_owner" | "form_inactive" | "form_closed";
 export interface AnswerItemNormalized {
     id: string;
     _id: ObjectID;
@@ -64,6 +70,7 @@ export interface AnswerItemNormalized {
     user?: string | User;
     links?: AnswerLinksBlock;
     draft?: boolean;
+    finished?: boolean;
     answers?: Record<string, unknown>;
     context?: ParentsMap | Record<string, Organization | Project>;
     form?: string;
@@ -74,6 +81,13 @@ export interface AnswerItemNormalized {
         date: Date;
     }>;
     project?: AnswerProjectRef;
+    /**
+     * L'utilisateur courant peut-il éditer cette réponse ? Calculé côté backend.
+     * Présent par défaut, ou enrichi avec le contexte si `formId` est fourni.
+     */
+    canEdit?: boolean;
+    /** Raison si `canEdit === false`. `null` si `canEdit === true`. */
+    editDeniedReason?: AnswerEditDeniedReason | null;
     [key: string]: unknown;
 }
 export {};