@communecter/cocolight-api-client 1.0.107 → 1.0.109

package/types/api/BaseEntity.d.ts

@@ -82,6 +82,29 @@ type ReadableWithMeta = import("stream").Readable & {
 };
 type UploadInput = File | Blob | Buffer | import("stream").Readable;
 type ValidatedUpload = File | Buffer | ReadableWithMeta;
+type PaginationCursor = {
+    searchType?: string[];
+    searchBy?: string;
+    countType?: string[];
+    ranges?: Record<string, {
+        indexMin: number;
+        indexMax: number;
+    }>;
+    indexMin?: number;
+    indexMax?: number;
+    indexStep?: number;
+    [key: string]: unknown;
+};
+/**
+ * État interne du paginateur, utilisé pour la restauration.
+ */
+export type PaginatorState = {
+    cursor: PaginationCursor | null;
+    count: number;
+    index: number;
+    history: PaginationCursor[];
+    sizes: number[];
+};
 export interface PaginatorPage<T> {
     count: {
         total: number;
@@ -93,6 +116,10 @@ export interface PaginatorPage<T> {
     hasPrev: boolean;
     next?: () => Promise<PaginatorPage<T>>;
     prev?: () => Promise<PaginatorPage<T>>;
+    _initialData?: Record<string, any>;
+    _state?: PaginatorState;
+    _entity?: BaseEntity<any>;
+    _methodName?: string;
 }
 /**
  * Type helper pour extraire les noms de méthodes depuis un Map as const
@@ -1059,42 +1086,54 @@ export declare class BaseEntity<TServerData = any> {
      * @param data - Paramètres (partiels) de recherche/pagination.
      * @returns - Les données de réponse.
      */
-    getOrganizations(data?: Partial<GetOrganizationsAdminData | GetOrganizationsNoAdminData>): Promise<PaginatorPage<Organization>>;
+    getOrganizations(data?: Partial<GetOrganizationsAdminData | GetOrganizationsNoAdminData>, options?: {
+        restoredState?: PaginatorState;
+    }): Promise<PaginatorPage<Organization>>;
     /**
      * Récupérer les projets d'une entitée : liste des projets de l'entité ou elle est "parent" ou "contributeur".
      * Constant : GET_PROJECTS_ADMIN | GET_PROJECTS_NO_ADMIN
      * @param data - Paramètres (partiels) de recherche/pagination.
      * @returns - Les données de réponse.
      */
-    getProjects(data?: Partial<GetProjectsAdminData | GetProjectsNoAdminData>): Promise<PaginatorPage<Project>>;
+    getProjects(data?: Partial<GetProjectsAdminData | GetProjectsNoAdminData>, options?: {
+        restoredState?: PaginatorState;
+    }): Promise<PaginatorPage<Project>>;
     /**
      * Récupérer les événements d'une entitée : liste des événements de l'entité ou elle est "organizer" ou "attendee".
      * Constant : GET_EVENTS
      * @param data - Paramètres (partiels) de recherche/pagination.
      * @returns - Les données de réponse.
      */
-    getEvents(data?: Partial<GetEventsData>): Promise<PaginatorPage<EventEntity>>;
+    getEvents(data?: Partial<GetEventsData>, options?: {
+        restoredState?: PaginatorState;
+    }): Promise<PaginatorPage<EventEntity>>;
     /**
      * Récupérer les POIs d'une entité : liste des POIs de l'entité ou elle est "parent".
      * Constant : GET_POIS_NO_ADMIN / GET_POIS_ADMIN
      * @param data - Paramètres (partiels) de recherche/pagination.
      * @returns - Les données de réponse.
      */
-    getPois(data?: Partial<GetPoisAdminData | GetPoisNoAdminData>): Promise<PaginatorPage<Poi>>;
+    getPois(data?: Partial<GetPoisAdminData | GetPoisNoAdminData>, options?: {
+        restoredState?: PaginatorState;
+    }): Promise<PaginatorPage<Poi>>;
     /**
      * Récupérer les abonnés d'une entité
      * Constant : GET_SUBSCRIBERS
      * @param data - Paramètres (partiels) de recherche/pagination.
      * @returns - Les données de réponse.
      */
-    getSubscribers(data?: Partial<GetSubscribersData>): Promise<PaginatorPage<User>>;
+    getSubscribers(data?: Partial<GetSubscribersData>, options?: {
+        restoredState?: PaginatorState;
+    }): Promise<PaginatorPage<User>>;
     /**
      * Liste des badges créés par l'entité
      * Constant : GET_BADGES
      * @param data - Paramètres (partiels) de recherche/pagination.
      * @returns - Les données de réponse.
      */
-    getBadgesIssuer(data?: Partial<GetBadgesData>): Promise<PaginatorPage<Badge>>;
+    getBadgesIssuer(data?: Partial<GetBadgesData>, options?: {
+        restoredState?: PaginatorState;
+    }): Promise<PaginatorPage<Badge>>;
     /**
      * Récupérer les actualités : Récupère la liste d'actualités selon plusieurs critères.
      * Constant : GET_NEWS
@@ -1237,10 +1276,14 @@ export declare class BaseEntity<TServerData = any> {
     /**
      * Vérifie si l'utilisateur est administrateur de l'entité.
      *
+     * @param options - Options de vérification.
+     * @param options.checkHierarchy - Si `true`, vérifie également si l'utilisateur est admin via la hiérarchie parent. Par défaut `false`.
      * @returns - `true` si l'utilisateur est administrateur, `false` sinon.
      * @throws {ApiError}
      */
-    isAdmin(): boolean;
+    isAdmin(options?: {
+        checkHierarchy?: boolean;
+    }): boolean;
     /**
      * Vérifie si l'utilisateur est soit l'auteur, soit administrateur de l'entité.
      *
@@ -1319,9 +1362,11 @@ export declare class BaseEntity<TServerData = any> {
     /**
      * Coeur de pagination stateless et réutilisable.
      */
-    _createPaginatorEngine<TData extends Record<string, any>, TOut>({ initialData, finalizer }: {
+    _createPaginatorEngine<TData extends Record<string, any>, TOut>({ initialData, finalizer, methodName, restoredState }: {
         initialData: Partial<TData>;
         finalizer: (data: TData) => Promise<FinalizerResult<TOut>>;
+        methodName: string;
+        restoredState?: PaginatorState;
     }): {
         next: () => Promise<PaginatorPage<TOut>>;
     };
@@ -1369,7 +1414,9 @@ export declare class BaseEntity<TServerData = any> {
      *   console.log(nextPage.pageNumber, nextPage.results.length);
      * }
      */
-    searchCostum(data?: Partial<GlobalAutocompleteCostumData>): Promise<PaginatorPage<any>>;
+    searchCostum(data?: Partial<GlobalAutocompleteCostumData>, options?: {
+        restoredState?: PaginatorState;
+    }): Promise<PaginatorPage<any>>;
     /**
      * @param data
      *        Paramètres de recherche (partiels — les valeurs manquantes sont complétées
@@ -1449,6 +1496,34 @@ export declare class BaseEntity<TServerData = any> {
      * @throws {Error}
      */
     costumEventRequestLoadContextTag(data?: Partial<Omit<CostumEventRequestLoadContextTagData, "pathParams">>): Promise<unknown>;
-    coformAnswersSearch(data?: Partial<CoformAnswersSearchData>): Promise<PaginatorPage<any>>;
+    coformAnswersSearch(data?: Partial<CoformAnswersSearchData>, options?: {
+        restoredState?: PaginatorState;
+    }): Promise<PaginatorPage<any>>;
+    /**
+     * ───────────────────────────────
+     * Pagination restoration methods
+     * ───────────────────────────────
+     */
+    /**
+     * Restaure une pagination depuis des données JSON sérialisées.
+     * Ne fait PAS d'appel API - utilise les results déjà présents.
+     * Les fonctions next() et prev() font des appels API quand appelées.
+     *
+     * @param paginationJson - Les données JSON sérialisées d'une pagination
+     * @param apiClientOrEntity - ApiClient ou entité parente pour la reconstruction des entités
+     * @returns Une page de pagination hydratée avec next() et prev() fonctionnels
+     *
+     * @example
+     * // Sérialiser une pagination
+     * const firstPage = await user.getPois();
+     * const json = JSON.stringify(firstPage);
+     *
+     * // Restaurer la pagination (sans appel API) - passer l'ApiClient
+     * const restored = BaseEntity.restorePaginationFromJSON(JSON.parse(json), api.getClientInstance());
+     *
+     * // next() fait un appel API pour récupérer la page suivante
+     * const secondPage = await restored.next?.();
+     */
+    static restorePaginationFromJSON<T>(paginationJson: any, apiClientOrEntity: ApiClient | BaseEntity<any>): PaginatorPage<T>;
 }
 export default BaseEntity;

package/types/api/Event.d.ts

@@ -1,4 +1,4 @@
-import { BaseEntity, PaginatorPage } from "./BaseEntity.js";
+import { BaseEntity, PaginatorPage, PaginatorState } from "./BaseEntity.js";
 import type { AddEventData, GetAttendeesAdminData, GetAttendeesNoAdminData } from "./EndpointApi.types.js";
 import type { User } from "./User.js";
 import type { EventTransforms } from "../types/transforms.js";
@@ -68,6 +68,7 @@ export declare class Event extends BaseEntity<EventItemNormalized> {
         isAdminPending?: boolean;
         isInviting?: boolean;
         roles?: any[];
+        restoredState?: PaginatorState;
     }): Promise<PaginatorPage<User>>;
     project(): Promise<never>;
     poi(): Promise<never>;

package/types/api/Organization.d.ts

@@ -1,5 +1,5 @@
 import { BaseEntity } from "./BaseEntity.js";
-import type { PaginatorPage } from "./BaseEntity.js";
+import type { PaginatorPage, PaginatorState } from "./BaseEntity.js";
 import type { AddOrganizationData, GetMembersAdminData, GetMembersNoAdminData } from "./EndpointApi.types.js";
 import type { OpeningHoursEntry } from "./serverDataType/common.js";
 import type { OrganizationItemNormalized } from "./serverDataType/Organization.js";
@@ -164,6 +164,7 @@ export declare class Organization extends BaseEntity<OrganizationItemNormalized>
         isAdminPending?: boolean;
         isInviting?: boolean;
         roles?: any[];
+        restoredState?: PaginatorState;
     }): Promise<PaginatorPage<User | Organization>>;
     /**
      * {@inheritDoc BaseEntity#getGallery}

package/types/api/Project.d.ts

@@ -1,5 +1,5 @@
 import { BaseEntity } from "./BaseEntity.js";
-import type { PaginatorPage } from "./BaseEntity.js";
+import type { PaginatorPage, PaginatorState } from "./BaseEntity.js";
 import type { AddProjectData, GetContributorsAdminData, GetContributorsNoAdminData } from "./EndpointApi.types.js";
 import type { Organization } from "./Organization.js";
 import type { User } from "./User.js";
@@ -97,6 +97,7 @@ export declare class Project extends BaseEntity<ProjectItemNormalized> {
         isAdminPending?: boolean;
         isInviting?: boolean;
         roles?: any[];
+        restoredState?: PaginatorState;
     }): Promise<PaginatorPage<User | Organization>>;
     /**
      * {@inheritDoc BaseEntity#getGallery}

package/types/api/User.d.ts

@@ -1,6 +1,6 @@
 import { BaseEntity } from "./BaseEntity.js";
 import type { Badge } from "./Badge.js";
-import type { PaginatorPage } from "./BaseEntity.js";
+import type { PaginatorPage, PaginatorState } from "./BaseEntity.js";
 import type { ChangePasswordData, DeleteAccountData, GetSubscriptionsAdminData, GetSubscriptionsData, GetOrganizationsNoAdminData, GetOrganizationsAdminData, GetFriendsAdminData } from "./EndpointApi.types.js";
 import type { Organization } from "./Organization.js";
 import type { EntityTypes } from "@/types/entities.js";
@@ -152,7 +152,9 @@ export declare class User extends BaseEntity<UserItemNormalized> {
      * Récupérer les organisations d'un utilisateur : Récupère la liste des organisations auxquelles l'utilisateur appartient.
      * Constant : GET_ORGANIZATIONS_ADMIN | GET_ORGANIZATIONS_NO_ADMIN
      */
-    getOrganizations(data?: Partial<GetOrganizationsAdminData | GetOrganizationsNoAdminData>): Promise<PaginatorPage<Organization>>;
+    getOrganizations(data?: Partial<GetOrganizationsAdminData | GetOrganizationsNoAdminData>, options?: {
+        restoredState?: PaginatorState;
+    }): Promise<PaginatorPage<Organization>>;
     /**
      * {@inheritDoc BaseEntity#getProjects}
      *
@@ -183,12 +185,16 @@ export declare class User extends BaseEntity<UserItemNormalized> {
      * question : qui peut voir la liste d'amis, seulement l'utilisateur connecté ? ou tous les utilisateurs connectés ?
      * actuellement, c'est tous les utilisateurs connectés
      */
-    getFriends(data?: Partial<GetFriendsAdminData>): Promise<PaginatorPage<User>>;
+    getFriends(data?: Partial<GetFriendsAdminData>, options?: {
+        restoredState?: PaginatorState;
+    }): Promise<PaginatorPage<User>>;
     /**
      * Récupérer les suivis
      * Constant : GET_SUBSCRIPTIONS / GET_SUBSCRIPTIONS_ADMIN
      */
-    getSubscriptions(data?: Partial<GetSubscriptionsAdminData | GetSubscriptionsData>): Promise<PaginatorPage<BaseEntity<any>>>;
+    getSubscriptions(data?: Partial<GetSubscriptionsAdminData | GetSubscriptionsData>, options?: {
+        restoredState?: PaginatorState;
+    }): Promise<PaginatorPage<BaseEntity<any>>>;
     /**
      * {@inheritDoc BaseEntity#getSubscribers}
      *

package/types/index.d.ts

@@ -1,3 +1,4 @@
+import { BaseEntity } from "./api/BaseEntity.js";
 import { fromEntityJSON } from "./api/EntityRegistry.js";
 import Api from "./Api.js";
 import ApiClient from "./ApiClient.js";
@@ -30,6 +31,7 @@ declare const cocolightApiClient: {
     };
     helper: {
         fromEntityJSON: typeof fromEntityJSON;
+        restorePaginationFromJSON: typeof BaseEntity.restorePaginationFromJSON;
     };
     OfflineClientManager: typeof OfflineClientManager;
 };
@@ -65,6 +67,6 @@ 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/common.js";
-export type { PaginatorPage } from "./api/BaseEntity.js";
+export type { PaginatorPage, PaginatorState } from "./api/BaseEntity.js";
 export type * from "./types/index.js";
 export type * from "./api/EndpointApi.types.js";