Merge pull request #55 from dynamiatools/copilot/organize-modules-and-extensions

refactor(sdk): reorganize src and test into per-module folders

Author: marioserrano09

platform/packages/sdk/package-lock.json

@@ -1,12 +1,12 @@
 import { HttpClient } from './http.js';
-import { MetadataApi } from './api/metadata.js';
-import { CrudResourceApi } from './api/crud.js';
-import { CrudServiceApi } from './api/crud-service.js';
-import { ActionsApi } from './api/actions.js';
-import { ReportsApi } from './api/reports.js';
-import { FilesApi } from './api/files.js';
-import { SaasApi } from './api/saas.js';
-import { ScheduleApi } from './api/schedule.js';
+import { MetadataApi } from './metadata/api.js';
+import { ActionsApi } from './metadata/actions.js';
+import { CrudResourceApi } from './cruds/crud-resource.js';
+import { CrudServiceApi } from './cruds/crud-service.js';
+import { ReportsApi } from './reports/api.js';
+import { FilesApi } from './files/api.js';
+import { SaasApi } from './saas/api.js';
+import { ScheduleApi } from './schedule/api.js';
 import type { DynamiaClientConfig } from './types.js';
 
 /**

platform/packages/sdk/src/api/index.ts

@@ -1,5 +1,5 @@
 import type { HttpClient } from '../http.js';
-import type { CrudListResult, CrudQueryParams, CrudRawResponse } from '../types.js';
+import type { CrudListResult, CrudQueryParams, CrudRawResponse } from './types.js';
 
 /**
  * CRUD operations for a single CrudPage resource (navigation-based endpoints).
@@ -76,4 +76,3 @@ function normaliseCrudResponse<T>(raw: CrudRawResponse<T> | CrudListResult<T>):
     totalPages: p?.pagesNumber ?? 1,
   };
 }
-

platform/packages/sdk/src/client.ts

@@ -40,4 +40,3 @@ export class CrudServiceApi<T = unknown> {
     return this.http.post<string | number>(`${this.basePath}/id`, params);
   }
 }
-

platform/packages/sdk/src/api/crud.ts …/packages/sdk/src/cruds/crud-resource.tsplatform/packages/sdk/src/api/crud.ts renamed to platform/packages/sdk/src/cruds/crud-resource.ts platform/packages/sdk/src/api/crud.ts renamed to platform/packages/sdk/src/cruds/crud-resource.ts

@@ -0,0 +1,8 @@
+export { CrudResourceApi } from './crud-resource.js';
+export { CrudServiceApi } from './crud-service.js';
+export type {
+  CrudPageable,
+  CrudRawResponse,
+  CrudListResult,
+  CrudQueryParams,
+} from './types.js';

…orm/packages/sdk/src/api/crud-service.ts …m/packages/sdk/src/cruds/crud-service.tsplatform/packages/sdk/src/api/crud-service.ts renamed to platform/packages/sdk/src/cruds/crud-service.ts platform/packages/sdk/src/api/crud-service.ts renamed to platform/packages/sdk/src/cruds/crud-service.ts

@@ -0,0 +1,71 @@
+// ─── CRUD types mirroring the Dynamia Platform Java model ───────────────────
+
+/**
+ * Maps to Java `DataPaginator` — serialized as the `pageable` field inside `ListResult`.
+ *
+ * Java source: `tools.dynamia.domain.query.DataPaginator`
+ *
+ * | Java field      | Java type | JSON key       |
+ * |-----------------|-----------|----------------|
+ * | `totalSize`     | `long`    | `totalSize`    |
+ * | `pageSize`      | `int`     | `pageSize`     |
+ * | `firstResult`   | `int`     | `firstResult`  |
+ * | `page`          | `int`     | `page`         |
+ * | `pagesNumber`   | `int`     | `pagesNumber`  |
+ */
+export interface CrudPageable {
+  /** Total number of records across all pages (`DataPaginator.totalSize` — Java `long`) */
+  totalSize: number;
+  /** Number of records per page (`DataPaginator.pageSize` — default 30) */
+  pageSize: number;
+  /** Zero-based offset of the first record on this page (`DataPaginator.firstResult`) */
+  firstResult: number;
+  /** Current 1-based page number (`DataPaginator.page`) */
+  page: number;
+  /** Total number of pages (`DataPaginator.pagesNumber`) */
+  pagesNumber: number;
+}
+
+/**
+ * Raw envelope returned by `RestNavigationContext.ListResult`.
+ *
+ * Java source: `tools.dynamia.web.navigation.RestNavigationContext.ListResult`
+ *
+ * | Java field  | Annotation                         | JSON key   |
+ * |-------------|------------------------------------|------------|
+ * | `data`      | —                                  | `data`     |
+ * | `pageable`  | `@JsonInclude(NON_NULL)` — nullable | `pageable` |
+ * | `response`  | —                                  | `response` |
+ *
+ * `pageable` is `null` when the result is not paginated (e.g. a flat list endpoint).
+ */
+export interface CrudRawResponse<T = unknown> {
+  /** The page records */
+  data: T[];
+  /**
+   * Pagination metadata. `null` when the response is not paginated
+   * (`@JsonInclude(JsonInclude.Include.NON_NULL)` in Java — field may be absent from JSON).
+   */
+  pageable: CrudPageable | null;
+  /** Status string, typically `"OK"` */
+  response: string;
+}
+
+/**
+ * Normalised result returned by all SDK `CrudResourceApi.findAll()` calls.
+ * The SDK maps `CrudRawResponse` → `CrudListResult` so consumers never deal with the raw envelope.
+ */
+export interface CrudListResult<T = unknown> {
+  /** The records for this page */
+  content: T[];
+  /** Total number of records across all pages (`DataPaginator.totalSize`) */
+  total: number;
+  /** Current 1-based page number (`DataPaginator.page`) */
+  page: number;
+  /** Number of records per page (`DataPaginator.pageSize`) */
+  pageSize: number;
+  /** Total number of pages (`DataPaginator.pagesNumber`) */
+  totalPages: number;
+}
+
+export type CrudQueryParams = Record<string, string | number | boolean | undefined | null>;

platform/packages/sdk/src/cruds/index.ts

@@ -27,4 +27,3 @@ export class FilesApi {
     return this.http.url(`/storage/${encodeURIComponent(file)}`, { uuid });
   }
 }
-

platform/packages/sdk/src/cruds/types.ts

@@ -0,0 +1 @@
+export { FilesApi } from './api.js';

platform/packages/sdk/src/api/files.ts platform/packages/sdk/src/files/api.tsplatform/packages/sdk/src/api/files.ts renamed to platform/packages/sdk/src/files/api.ts

@@ -4,9 +4,12 @@ export { DynamiaClient } from './client.js';
 // ── Error ────────────────────────────────────────────────────────────────────
 export { DynamiaApiError } from './errors.js';
 
-// ── Types ────────────────────────────────────────────────────────────────────
+// ── Core types ────────────────────────────────────────────────────────────────
+export type { DynamiaClientConfig } from './types.js';
+
+// ── Metadata module ──────────────────────────────────────────────────────────
+export { MetadataApi, ActionsApi } from './metadata/index.js';
 export type {
-  DynamiaClientConfig,
   // Application
   ApplicationMetadata,
   // Navigation
@@ -27,26 +30,30 @@ export type {
   ViewDescriptorMetadata,
   ViewDescriptor,
   ViewField,
-  // CRUD
+} from './metadata/index.js';
+
+// ── CRUD module ───────────────────────────────────────────────────────────────
+export { CrudResourceApi, CrudServiceApi } from './cruds/index.js';
+export type {
   CrudListResult,
   CrudQueryParams,
   CrudRawResponse,
   CrudPageable,
-  // Reports
+} from './cruds/index.js';
+
+// ── Reports module ────────────────────────────────────────────────────────────
+export { ReportsApi } from './reports/index.js';
+export type {
   ReportDTO,
   ReportFilter,
   ReportFilters,
-  // SaaS
-  AccountDTO,
-} from './types.js';
-
-// ── API classes (for advanced usage / extension) ─────────────────────────────
-export { MetadataApi } from './api/metadata.js';
-export { CrudResourceApi } from './api/crud.js';
-export { CrudServiceApi } from './api/crud-service.js';
-export { ActionsApi } from './api/actions.js';
-export { ReportsApi } from './api/reports.js';
-export { FilesApi } from './api/files.js';
-export { SaasApi } from './api/saas.js';
-export { ScheduleApi } from './api/schedule.js';
+} from './reports/index.js';
+
+// ── SaaS module ───────────────────────────────────────────────────────────────
+export { SaasApi } from './saas/index.js';
+export type { AccountDTO } from './saas/index.js';
+
+// ── API classes (files & schedule — core extensions) ─────────────────────────
+export { FilesApi } from './files/index.js';
+export { ScheduleApi } from './schedule/index.js';