@wasto/sdk 1.0.3

package/src/types/iot.types.ts

@@ -0,0 +1,31 @@
+export interface CreateIotDeviceRequest {
+  name: string;
+  deviceId: string;
+  assetId?: string;
+  clientCert: string;
+  clientKey: string;
+  enabled?: boolean;
+}
+
+export interface UpdateIotDeviceRequest {
+  name?: string;
+  deviceId?: string;
+  assetId?: string;
+  clientCert?: string;
+  clientKey?: string;
+  enabled?: boolean;
+}
+
+export interface IotWebhookPayloadRequest {
+  deviceId: string;
+  eventType: 'position' | 'consumption' | 'alert';
+  latitude?: number;
+  longitude?: number;
+  value?: number;
+  unit?: string;
+  periodStart?: string;
+  periodEnd?: string;
+  title?: string;
+  description?: string;
+  metadata?: Record<string, unknown>;
+}

package/src/types/maintenance.types.ts

@@ -0,0 +1,44 @@
+export interface CreateMaintenanceTypeRequest {
+  name: string;
+  description?: string;
+  downtimeHours: number;
+  recommendedFrequency?: number;
+  estimatedCost?: number;
+  instructions?: string;
+  isActive?: boolean;
+}
+
+export interface UpdateMaintenanceTypeRequest {
+  name?: string;
+  description?: string;
+  downtimeHours?: number;
+  recommendedFrequency?: number;
+  estimatedCost?: number;
+  instructions?: string;
+  isActive?: boolean;
+}
+
+export interface MaintenanceProgramItemRequest {
+  maintenanceTypeId: string;
+  frequencyDays: number;
+  order?: number;
+}
+
+export interface CreateMaintenanceProgramRequest {
+  name: string;
+  description?: string;
+  items: MaintenanceProgramItemRequest[];
+  isActive?: boolean;
+}
+
+export interface UpdateMaintenanceProgramRequest {
+  name?: string;
+  description?: string;
+  items?: MaintenanceProgramItemRequest[];
+  isActive?: boolean;
+}
+
+export interface AssignProgramRequest {
+  programId: string;
+  startDate: string;
+}

package/src/types/mapso.types.ts

@@ -0,0 +1,146 @@
+import type {
+  MapEventStatus,
+  MapEventType,
+  MapPoiCategory,
+  MapPoiStatus,
+  MapZoneType,
+} from '../enums';
+
+export interface CreateMapEventRequest {
+  title: string;
+  description?: string;
+  type?: MapEventType;
+  status?: MapEventStatus;
+  startDate?: string;
+  endDate?: string;
+  centerLatitude?: number;
+  centerLongitude?: number;
+  defaultZoom?: number;
+  perimeterGeoJson?: Record<string, unknown> | null;
+  cityId?: string;
+  cityGroupId?: string;
+}
+
+export interface UpdateMapEventRequest {
+  title?: string;
+  description?: string;
+  type?: MapEventType;
+  status?: MapEventStatus;
+  startDate?: string | null;
+  endDate?: string | null;
+  centerLatitude?: number | null;
+  centerLongitude?: number | null;
+  defaultZoom?: number | null;
+  perimeterGeoJson?: Record<string, unknown> | null;
+  cityId?: string | null;
+  cityGroupId?: string | null;
+}
+
+export interface CreateMapPoiRequest {
+  name: string;
+  description?: string;
+  category: MapPoiCategory;
+  status?: MapPoiStatus;
+  latitude: number;
+  longitude: number;
+  openingHours?: string;
+  tags?: string[];
+  sortOrder?: number;
+  dateFrom?: string;
+  dateTo?: string;
+  streetIds?: string[];
+}
+
+export interface UpdateMapPoiRequest {
+  name?: string;
+  description?: string;
+  category?: MapPoiCategory;
+  status?: MapPoiStatus;
+  latitude?: number;
+  longitude?: number;
+  openingHours?: string | null;
+  tags?: string[];
+  sortOrder?: number;
+  dateFrom?: string | null;
+  dateTo?: string | null;
+  streetIds?: string[];
+}
+
+export interface CreateMapZoneRequest {
+  name: string;
+  type: MapZoneType;
+  geoJson: Record<string, unknown>;
+  color?: string;
+  description?: string;
+  dateFrom?: string;
+  dateTo?: string;
+  streetIds?: string[];
+}
+
+export interface UpdateMapZoneRequest {
+  name?: string;
+  type?: MapZoneType;
+  geoJson?: Record<string, unknown>;
+  color?: string;
+  description?: string;
+  dateFrom?: string | null;
+  dateTo?: string | null;
+  streetIds?: string[];
+}
+
+export interface MapZoneSummary {
+  id: string;
+  mapEventId: string;
+  name: string;
+  type: MapZoneType;
+  geoJson: Record<string, unknown>;
+  color?: string | null;
+  description?: string | null;
+  dateFrom?: string | null;
+  dateTo?: string | null;
+  streets?: Array<{ street: { id: string; name: string } }>;
+  createdAt: string;
+  updatedAt: string;
+}
+
+export interface MapPoiSummary {
+  id: string;
+  mapEventId: string;
+  name: string;
+  description?: string | null;
+  category: MapPoiCategory;
+  status: MapPoiStatus;
+  latitude: number;
+  longitude: number;
+  openingHours?: string | null;
+  tags: string[];
+  dateFrom?: string | null;
+  dateTo?: string | null;
+  streets?: Array<{ street: { id: string; name: string } }>;
+  sortOrder: number;
+  createdAt: string;
+  updatedAt: string;
+}
+
+export interface MapEventSummary {
+  id: string;
+  title: string;
+  description?: string | null;
+  type: MapEventType;
+  status: MapEventStatus;
+  startDate?: string | null;
+  endDate?: string | null;
+  centerLatitude?: number | null;
+  centerLongitude?: number | null;
+  defaultZoom?: number | null;
+  perimeterGeoJson?: Record<string, unknown> | null;
+  cityId?: string | null;
+  cityGroupId?: string | null;
+  city?: { id: string; name: string } | null;
+  cityGroup?: { id: string; name: string } | null;
+  pois?: MapPoiSummary[];
+  zones?: MapZoneSummary[];
+  _count?: { pois: number; zones?: number };
+  createdAt: string;
+  updatedAt: string;
+}

package/src/types/notifications.types.ts

@@ -0,0 +1,68 @@
+import type { RecipientGroupType } from '../enums';
+
+export interface CreateNotificationRequest {
+  title: string;
+  body: string;
+  data?: Record<string, unknown>;
+  recipientGroupId: string;
+  scheduledAt?: string;
+  /** Envoyer une notification push (défaut: true) */
+  sendPush?: boolean;
+  /** Afficher en modale dans l'app (défaut: false) */
+  showAsModal?: boolean;
+  /** Média CMS affiché dans la modale */
+  imageMediaId?: string | null;
+}
+
+export interface UpdateNotificationRequest {
+  title?: string;
+  body?: string;
+  data?: Record<string, unknown>;
+  recipientGroupId?: string;
+  scheduledAt?: string;
+  sendPush?: boolean;
+  showAsModal?: boolean;
+  imageMediaId?: string | null;
+}
+
+export interface CreateRecipientGroupRequest {
+  name: string;
+  description?: string;
+  type: RecipientGroupType;
+  /** Requis pour CITY_GROUP (tout le groupement) */
+  cityGroupId?: string;
+  /** Requis non vide pour CITY */
+  cityIds?: string[];
+  /** Requis non vide pour ZONE (lieux de collecte) */
+  wasteCollectionPlaceIds?: string[];
+  /** @deprecated Prefer cityIds */
+  cityId?: string;
+  /** @deprecated Prefer wasteCollectionPlaceIds */
+  wasteCollectionPlaceId?: string;
+  /** @deprecated Legacy operational zone targeting */
+  operationalZoneId?: string;
+}
+
+export interface UpdateRecipientGroupRequest {
+  name?: string;
+  description?: string;
+  type?: RecipientGroupType;
+  cityGroupId?: string;
+  cityIds?: string[];
+  wasteCollectionPlaceIds?: string[];
+  /** @deprecated Prefer cityIds */
+  cityId?: string;
+  /** @deprecated Prefer wasteCollectionPlaceIds */
+  wasteCollectionPlaceId?: string;
+  /** @deprecated Legacy operational zone targeting */
+  operationalZoneId?: string;
+}
+
+/** Annonce modale active pour l'app mobile */
+export interface PublicAnnouncement {
+  id: string;
+  title: string;
+  body: string;
+  imageUrl?: string | null;
+  sentAt?: string | null;
+}

package/src/types/onboarding.types.ts

@@ -0,0 +1,117 @@
+import type { CityGroupType } from '../enums';
+import type { DashboardAppSlug } from '../dashboard-apps';
+import { FREE_SELF_SERVE_DASHBOARD_APP_SLUGS } from '../dashboard-apps';
+
+/**
+ * Contrats API onboarding self-serve (compte gratuit → collectivité → mode restreint → PWA light).
+ * Routes : `POST /onboarding/bootstrap-city-group`, `POST /onboarding/request-join`,
+ * `GET /onboarding/search-city-groups`, `GET /onboarding/search-sinoe`,
+ * `POST /onboarding/bootstrap-pwa-light`, `POST /onboarding/sync-restricted-access`.
+ */
+
+/** Étapes du parcours post-inscription (console). */
+export type OnboardingStepId =
+  | 'account'
+  | 'collectivite'
+  | 'restricted'
+  | 'pwa_light'
+  | 'done';
+
+export type BootstrapCityGroupRequest = {
+  /** Nom du groupement (ex. « CA du Pays de … »). */
+  name: string;
+  type?: CityGroupType;
+  /** Code / SIREN optionnels pour dédoublonnage. */
+  code?: string | null;
+  siren?: string | null;
+  /** Première commune rattachée (minimale). */
+  city?: {
+    name: string;
+    country?: string;
+    codeInsee?: string | null;
+  };
+};
+
+export type BootstrapCityGroupResponse = {
+  cityGroupId: string;
+  cityId?: string | null;
+  /** Apps activées (= preset free / restreint). */
+  enabledDashboardAppSlugs: DashboardAppSlug[];
+  /** Membership créateur : GESTIONNAIRE + authorizations. */
+  membershipId: string;
+  /** Prochaine étape console recommandée. */
+  nextStep: OnboardingStepId;
+};
+
+export type OnboardingCityGroupSearchHit = {
+  id: string;
+  name: string;
+  type: CityGroupType;
+  code?: string | null;
+  siren?: string | null;
+  citiesCount: number;
+};
+
+/**
+ * Hit ADEME / SINOE (Data Fair flux collecte) pour le sélecteur onboarding.
+ * `codeActeur` = `c_acteur` SINOE (pas un SIREN légal) — stocké en `CityGroup.code` au create.
+ */
+export type OnboardingSinoeSearchHit = {
+  id: string;
+  name: string;
+  codeActeur: string;
+  departement?: string | null;
+  codeDepartement?: string | null;
+  region?: string | null;
+  population?: number | null;
+  year: number;
+  typologie?: string | null;
+  /** CityGroup Wasto déjà présent (match code/siren = codeActeur). */
+  existingCityGroup?: OnboardingCityGroupSearchHit | null;
+};
+
+export type RequestJoinCityGroupRequest = {
+  cityGroupId: string;
+};
+
+export type RequestJoinCityGroupResponse = {
+  membershipId: string;
+  cityGroupId: string;
+  /** MVP : false — en attente d’acceptation par un gestionnaire. */
+  isAccepted: boolean;
+  nextStep: OnboardingStepId;
+  /** TODO produit : workflow d’approbation / notification gestionnaire. */
+  note?: string;
+};
+
+export type PwaLightBootstrapRequest = {
+  cityGroupId: string;
+  /** Slug public PWA (unique). */
+  slug: string;
+  name?: string;
+  /** Publier immédiatement (`pwaPublished`). Défaut true. */
+  publish?: boolean;
+};
+
+export type PwaLightBootstrapResponse = {
+  cmsAppId: string;
+  slug: string;
+  /** Écrans light : tri + calendrier (hors carte / défis sur free). */
+  screens: ReadonlyArray<'tri' | 'calendrier' | 'carte' | 'defis'>;
+  previewPath: string;
+  pwaPublished: boolean;
+};
+
+export type SyncRestrictedAccessRequest = {
+  cityGroupId: string;
+};
+
+export type SyncRestrictedAccessResponse = {
+  cityGroupId: string;
+  enabledDashboardAppSlugs: DashboardAppSlug[];
+  membershipAuthorizations: string[];
+};
+
+/** Preset appliqué au bootstrap self-serve. */
+export const ONBOARDING_RESTRICTED_APP_SLUGS: readonly DashboardAppSlug[] =
+  FREE_SELF_SERVE_DASHBOARD_APP_SLUGS;

package/src/types/operational-zones.types.ts

@@ -0,0 +1,70 @@
+import type { OperationalZoneStatus, OperationalZoneType } from '../enums';
+
+export interface OperationalZoneStreetLink {
+  street: {
+    id: string;
+    name: string;
+    latitude?: number | null;
+    longitude?: number | null;
+  };
+}
+
+export interface OperationalZone {
+  id: string;
+  name: string;
+  type: OperationalZoneType;
+  status: OperationalZoneStatus;
+  geoJson: Record<string, unknown>;
+  color?: string | null;
+  description?: string | null;
+  dateFrom?: string | null;
+  dateTo?: string | null;
+  cityId: string;
+  city?: { id: string; name: string };
+  wasteCollectionPlaceId?: string | null;
+  wasteCollectionPlace?: { id: string; name: string; reference?: string | null } | null;
+  wasteTypeId?: string | null;
+  wasteType?: { id: string; name: string; color?: string | null } | null;
+  syncCalendarException?: boolean;
+  collectionExceptionId?: string | null;
+  collectionException?: {
+    id: string;
+    name: string;
+    dateFrom: string;
+    dateTo: string;
+  } | null;
+  streets?: OperationalZoneStreetLink[];
+  createdAt?: string;
+  updatedAt?: string;
+}
+
+export interface CreateOperationalZoneRequest {
+  name: string;
+  type: OperationalZoneType;
+  status?: OperationalZoneStatus;
+  geoJson: Record<string, unknown>;
+  color?: string;
+  description?: string;
+  dateFrom?: string;
+  dateTo?: string;
+  cityId: string;
+  streetIds?: string[];
+  wasteCollectionPlaceId?: string;
+  wasteTypeId?: string;
+  syncCalendarException?: boolean;
+}
+
+export interface UpdateOperationalZoneRequest {
+  name?: string;
+  type?: OperationalZoneType;
+  status?: OperationalZoneStatus;
+  geoJson?: Record<string, unknown>;
+  color?: string;
+  description?: string;
+  dateFrom?: string | null;
+  dateTo?: string | null;
+  streetIds?: string[];
+  wasteCollectionPlaceId?: string | null;
+  wasteTypeId?: string | null;
+  syncCalendarException?: boolean;
+}

package/src/types/pagination.types.ts

@@ -0,0 +1,33 @@
+export const DEFAULT_PAGE = 1;
+export const DEFAULT_PAGE_SIZE = 20;
+export const MAX_PAGE_SIZE = 100;
+
+export interface PaginationQuery {
+  page?: number;
+  pageSize?: number;
+}
+
+export interface PaginationMeta {
+  page: number;
+  pageSize: number;
+  total: number;
+  totalPages: number;
+}
+
+export interface PaginatedResponse<T> {
+  data: T[];
+  meta: PaginationMeta;
+}
+
+export function buildPaginationMeta(
+  page: number,
+  pageSize: number,
+  total: number,
+): PaginationMeta {
+  return {
+    page,
+    pageSize,
+    total,
+    totalPages: Math.ceil(total / pageSize) || 1,
+  };
+}

package/src/types/providers.types.ts

@@ -0,0 +1,29 @@
+import type { ProviderType } from '../enums';
+
+export interface CreateProviderRequest {
+  name: string;
+  description?: string;
+  type?: ProviderType;
+  email?: string;
+  phone?: string;
+  address?: string;
+  siret?: string;
+  siren?: string;
+  website?: string;
+  cityGroupIds?: string[];
+  cityIds?: string[];
+}
+
+export interface UpdateProviderRequest {
+  name?: string;
+  description?: string;
+  type?: ProviderType;
+  email?: string;
+  phone?: string;
+  address?: string;
+  siret?: string;
+  siren?: string;
+  website?: string;
+  cityGroupIds?: string[];
+  cityIds?: string[];
+}

package/src/types/quiz-questions.types.ts

@@ -0,0 +1,59 @@
+export type QuizQuestionKind = 'waste_bin' | 'ab_image' | 'mcq';
+
+export type QuizAbImageChoice = {
+  id: string;
+  imageUrl: string;
+  label?: string;
+};
+
+export type QuizAbImageOptions = {
+  choices: [QuizAbImageChoice, QuizAbImageChoice];
+  correctChoiceId: string;
+};
+
+export type QuizMcqChoice = {
+  id: string;
+  text: string;
+};
+
+export type QuizMcqOptions = {
+  choices: QuizMcqChoice[];
+  correctChoiceId: string;
+};
+
+export type QuizQuestionOptions = QuizAbImageOptions | QuizMcqOptions;
+
+/** Détail référentiel lié à une explication (WasteTypeDetail). */
+export type QuizExplanationDetail = {
+  id: string;
+  material: string;
+  description?: string | null;
+  instructions?: string | null;
+  imageUrl?: string | null;
+  wasteType?: { id: string; name: string } | null;
+};
+
+export interface CreateQuizQuestionRequest {
+  /** @deprecated Ignored — city is taken from `serie.challenge.cityId`. */
+  cityId?: string;
+  /** Required for `waste_bin`; optional for `ab_image`. */
+  wasteTypeId?: string;
+  materialId?: string;
+  material: string;
+  question: string;
+  imageUrl?: string;
+  imageBase64?: string;
+  /** Required for `waste_bin`; optional for `ab_image`. */
+  correctWasteTypeId?: string;
+  /** Required: question belongs to a series (city = that series' challenge city). */
+  serieId: string;
+  order?: number;
+  /** Defaults to `waste_bin` (legacy). */
+  kind?: QuizQuestionKind;
+  /** Typed payload for non-waste_bin kinds. */
+  options?: QuizQuestionOptions;
+  /** Free-text explanation shown after answering (takes priority over detail). */
+  explanationText?: string | null;
+  /** Link to a référentiel WasteTypeDetail for explanation. */
+  explanationDetailId?: string | null;
+}

package/src/types/recycling-points.types.ts

@@ -0,0 +1,47 @@
+import type { HoursInputMode, OpeningHours } from '../opening-hours/types';
+
+export interface CreateRecyclingPointRequest {
+  cityId: string;
+  name: string;
+  type: string;
+  acceptedWasteTypes: string[];
+  latitude?: number;
+  longitude?: number;
+  /** @deprecated Prefer longitude (alias X = longitude). */
+  coordinateX?: number;
+  /** @deprecated Prefer latitude (alias Y = latitude). */
+  coordinateY?: number;
+  address?: string;
+  hours?: string;
+  phone?: string;
+  details?: RecyclingPointDetails;
+}
+
+export type { HoursInputMode };
+
+export type RecyclingPointDetails = {
+  address?: string;
+  hours?: string;
+  phone?: string;
+  hoursMode?: HoursInputMode;
+  openingHours?: OpeningHours;
+  [key: string]: unknown;
+};
+
+export interface RecyclingPoint {
+  id: string;
+  cityId?: string | null;
+  name: string;
+  type: string;
+  acceptedWasteTypes: string[];
+  latitude?: number | null;
+  longitude?: number | null;
+  /** @deprecated Prefer longitude. */
+  coordinateX?: number | null;
+  /** @deprecated Prefer latitude. */
+  coordinateY?: number | null;
+  address?: string | null;
+  hours?: string | null;
+  phone?: string | null;
+  details?: RecyclingPointDetails | null;
+}

package/src/types/roi.types.ts

@@ -0,0 +1,60 @@
+import type { TerritoryActionStatus, TerritoryActionType } from '../enums'
+
+export type { TerritoryActionStatus, TerritoryActionType }
+
+export interface UpsertTerritoryEconomicsRequest {
+  cityId?: string
+  cityGroupId?: string
+  fiscalYear?: number
+  annualTonnageOmr: number
+  errorRatePercent: number
+  costPerBadTonne?: number
+  tgapEurPerTonne?: number
+  householdCount?: number | null
+  population?: number | null
+  wastoAnnualCostEur?: number
+  citeoSupportGainEur?: number
+  notes?: string | null
+  /** Si true, fige la baseline (avant) sur les valeurs courantes. */
+  lockBaseline?: boolean
+  annualBilanConfirmed?: boolean
+  dataSource?: 'MANUAL' | 'SINOE' | 'IMPORT'
+}
+
+export interface ImportTerritoryYearRequest {
+  fiscalYear: number
+  annualTonnageOmr: number
+  errorRatePercent?: number
+  costPerBadTonne?: number
+  citeoSupportGainEur?: number
+  population?: number | null
+  householdCount?: number | null
+  notes?: string | null
+}
+
+export interface ImportTerritoryHistoryRequest {
+  cityGroupId: string
+  years: ImportTerritoryYearRequest[]
+  /** Si true, marque dataSource=SINOE. */
+  fromSinoe?: boolean
+}
+
+export interface CreateTerritoryActionRequest {
+  name: string
+  description?: string
+  type?: TerritoryActionType
+  status?: TerritoryActionStatus
+  zoneLabel?: string
+  startDate?: string
+  endDate?: string
+  budgetCapexEur?: number
+  budgetOpexEur?: number
+  expectedErrorReductionPercent?: number
+  measuredErrorReductionPercent?: number | null
+  challengeId?: string | null
+  surveyId?: string | null
+  order?: number
+}
+
+export interface UpdateTerritoryActionRequest
+  extends Partial<CreateTerritoryActionRequest> {}