@masterteam/task-schedule 0.0.1 → 0.0.3

package/README.md

@@ -1,134 +1,152 @@
-# `@masterteam/task-schedule`
-
-Syncfusion Gantt based task-schedule package with external model switching.
-
-## Public API
+# `@masterteam/task-schedule`
+
+Syncfusion Gantt based task-schedule package with external model switching.
+
+## Public API
+
+- `TaskSchedule` component (`mt-task-schedule`)
+- `TaskScheduleShell` component (`mt-task-schedule-shell`)
+- `TaskScheduleImportModal` component (`mt-task-schedule-import-modal`)
+- `TASK_SCHEDULE_DATA_ADAPTER` injection token
+- `TaskScheduleDataAdapter` interface
+- `TaskScheduleBackendAdapter` (default built-in adapter)
+- `TaskScheduleModelType`
+- `TaskScheduleContext`
+- `TASK_SCHEDULE_DEFAULT_PDF_FONT`
+
+## Inputs
 
-- `TaskSchedule` component (`mt-task-schedule`)
-- `TaskScheduleShell` component (`mt-task-schedule-shell`)
-- `TaskScheduleImportModal` component (`mt-task-schedule-import-modal`)
-- `TASK_SCHEDULE_DATA_ADAPTER` injection token
-- `TaskScheduleDataAdapter` interface
-- `TaskScheduleBackendAdapter` (default built-in adapter)
-- `TaskScheduleModelType`
-- `TaskScheduleContext`
-- `TASK_SCHEDULE_DEFAULT_PDF_FONT`
+- `context`: object with required `levelId` and `levelDataId` for fetch-based schedule reads
 
-## Inputs
+Main context fields:
 
-- `modelType`: `'default' | 'edit' | 'baseline' | 'criticalPath' | 'critical-path' | 'resources' | 'unscheduled' | 'phaseGate' | 'phase-gate' | 'custom'`
-- `context`: object with required `levelId` and `levelDataId` for runtime tree loading, plus optional `customViewId`, etc.
+- `modelType`: `'default' | 'edit' | 'baseline' | 'criticalPath' | 'critical-path' | 'resources' | 'unscheduled' | 'phaseGate' | 'custom'`
+- `langCode`: `'en' | 'ar' | null`
 - `dateFormat`: default `dd/MM/yyyy`
 - `height`: default `760px`
-- `langCode`: `'en' | 'ar' | null` (optional; auto-resolves from context/localStorage/document)
-- `pdfFontData`: optional base64 TTF string for PDF export font
-- `pdfRtlFontData`: optional base64 TTF string used in RTL/Arabic PDF export
-- `pdfFontSize`: optional PDF font size (default `11`)
-
-## Outputs
-
-- `toolbarAction`
-- `actionBegin`
-- `actionCompleted`
-- `loaded`
-- `loadError`
-
-`TaskScheduleDataAdapter` optional import methods:
-
-- `importTasks(context, file)`
-- `applyImportedTasks(context, payload)`
-- `setBaseline(context, payload?)`
-- `exportTasks(context)`
-
-## Usage
-
-```ts
-import { Component, signal } from '@angular/core';
-import {
-  TASK_SCHEDULE_DATA_ADAPTER,
-  TaskSchedule,
-  TaskScheduleDataAdapter,
-  TaskScheduleModelType,
-} from '@masterteam/task-schedule';
-
-@Component({
-  standalone: true,
-  imports: [TaskSchedule],
-  selector: 'app-task-schedule-host',
+- `pdfFonts`: optional `{ regular?: string; arabic?: string; size?: number }`
+
+## Outputs
+
+- `toolbarAction`
+- `actionBegin`
+- `actionCompleted`
+- `loaded`
+- `loadError`
+
+`TaskScheduleDataAdapter` optional import methods:
+
+- `importTasks(context, file)`
+- `applyImportedTasks(context, payload)`
+- `setBaseline(context, payload?)`
+- `exportTasks(context)`
+
+## Usage
+
+```ts
+import { Component, signal } from '@angular/core';
+import {
+  TASK_SCHEDULE_DATA_ADAPTER,
+  TaskSchedule,
+  TaskScheduleDataAdapter,
+  TaskScheduleModelType,
+} from '@masterteam/task-schedule';
+
+@Component({
+  standalone: true,
+  imports: [TaskSchedule],
+  selector: 'app-task-schedule-host',
   template: `
     <mt-task-schedule
-      [modelType]="modelType()"
-      [context]="{ levelId: 12, levelDataId: 18 }"
-      [langCode]="'en'"
+      [context]="{
+        levelId: 12,
+        modelType: modelType(),
+        levelDataId: 18,
+        langCode: 'en'
+      }"
     />
   `,
-  providers: [
-    {
-      provide: TASK_SCHEDULE_DATA_ADAPTER,
-      useExisting: TaskScheduleApiAdapterService,
-    },
-  ],
-})
-export class TaskScheduleHostComponent {
-  readonly modelType = signal<TaskScheduleModelType>('default');
-}
-```
-
+  providers: [
+    {
+      provide: TASK_SCHEDULE_DATA_ADAPTER,
+      useExisting: TaskScheduleApiAdapterService,
+    },
+  ],
+})
+export class TaskScheduleHostComponent {
+  readonly modelType = signal<TaskScheduleModelType>('default');
+}
+```
+
 The component uses `TaskScheduleBackendAdapter` by default.
 
 Backend routes used:
 
-- Runtime tree: `GET /api/levels/{levelId}/{levelDataId}/schedule/tree`
+- Mixed schedule reads (default/edit/critical/custom): `POST /api/levels/{levelId}/{levelDataId}/schedule/query`
+- Runtime baseline snapshot view: `GET /api/levels/{levelId}/{levelDataId}/schedule/baselines/latest`
+- Runtime unscheduled: `GET /api/levels/{levelId}/{levelDataId}/schedule/unscheduled`
+- Runtime resource mode: `GET /api/levels/{levelId}/{levelDataId}/schedule/by-resource`
 - Custom view config: `GET /api/schedulemanager/{levelId}/schedule/{customViewId}`
 - Team members (edit/resources mode): `GET /api/levels/{levelId}/TeamMember`
 
-Edit mutations require `levelId`:
+Phase-gate runtime reads are handled separately in the app-client phase-gate flow and are not part of this package migration.
 
-- `POST /api/tasks/{levelId}/create`
-- `PUT /api/tasks/{levelId}/update/{taskId}`
-- `DELETE /api/tasks/{levelId}/delete/{taskId}`
-- `PUT /api/tasks/{levelId}/bulkUpdate`
-- `PUT /api/tasks/{levelId}/updateParent/{taskId}`
-- `PUT /api/tasks/{levelId}/reorder`
-- `PUT /api/tasks/{levelId}/updatePlanningModuleProgress`
+Runtime mutations (when `levelDataId` exists):
+
+- `POST /api/levels/{levelId}/{levelDataId}/schedule`
+- `PUT /api/levels/{levelId}/{levelDataId}/schedule/{taskId}`
+- `DELETE /api/levels/{levelId}/{levelDataId}/schedule/{taskId}`
+- `PUT /api/levels/{levelId}/{levelDataId}/schedule/bulk-update`
+- `PUT /api/levels/{levelId}/{levelDataId}/schedule/reorder`
+- `PUT /api/levels/{levelId}/{levelDataId}/schedule/{taskId}/progress`
+- `POST /api/levels/{levelId}/{levelDataId}/schedule/baselines` (set baseline)
+- `GET /api/levels/{levelId}/{levelDataId}/schedule/mpp` (export)
+
+Plain schedule reads no longer use legacy `/api/tasks/...` read routes.
+Import modal keeps its current MPP preview/apply flow unless `endpoints.importTasks` / `endpoints.applyImportedTasks` are overridden.
 
 Context options for backend routing:
 
 - `apiBaseUrl`: optional base URL prefix
-- `schemaId`: optional legacy API schema id (used for old `/tasks/{schemaId}/{levelId}/...` routes)
+- `modelType`: selected schedule mode
+- `langCode`: optional language override
+- `dateFormat`: optional gantt date format
+- `height`: optional gantt height
 - `customViewId`: used in `custom` mode to load schedule-manager view columns
 - `resources`: optional static resource list override
-- `endpoints`: optional endpoint template overrides (`scheduleTree`, `scheduleViewById`, `teamMembers`, `createTask`, etc.)
-- `endpoints.setBaseline`: optional override for baseline endpoint (legacy default: `/api/levels/{schemaId}/{levelId}/tasks/setBaseline`)
-- `endpoints.exportTasks`: optional override for export endpoint (legacy default: `/api/tasks/levels/{levelId}/export`)
+- `endpoints`: optional endpoint template overrides (`scheduleTreePhaseGate`, `scheduleViewById`, `teamMembers`, `createTask`, etc.)
+- `endpoints.importTasks` / `endpoints.applyImportedTasks`: optional overrides for runtime/legacy MPP import flow
+- `endpoints.setBaseline`: optional override for baseline endpoint (runtime default: `/api/levels/{levelId}/{levelDataId}/schedule/baselines`)
+- `endpoints.exportTasks`: optional override for export endpoint (runtime default: `/api/levels/{levelId}/{levelDataId}/schedule/mpp`)
 - `requestHeaders`: optional additional headers
 - `pdfFonts`: optional `{ regular?: string; arabic?: string; size?: number }` base64 font config for PDF export
-
-When no PDF font is provided, package fallback uses embedded `TASK_SCHEDULE_DEFAULT_PDF_FONT`.
-
-## Import Modal
-
-Use `mt-task-schedule-import-modal` to import `.mpp`/`.xer` files and apply tasks (replace or append).  
-The modal is Tailwind-based and uses `@masterteam/components` (`mt-button`, `mt-entity-preview`).
-Imported rows support inline editing before apply (task name, planned/actual dates, assignee, progress) with per-row selection.
-
+
+When no PDF font is provided, package fallback uses embedded `TASK_SCHEDULE_DEFAULT_PDF_FONT`.
+
+## Import Modal
+
+Use `mt-task-schedule-import-modal` to import `.mpp`/`.xer` files and apply tasks (replace or append).  
+The modal is Tailwind-based and uses `@masterteam/components` (`mt-button`, `mt-entity-preview`).
+Imported rows support inline editing before apply (task name, planned/actual dates, assignee, progress) with per-row selection.
+
 ## Shell Component
 
 Use `mt-task-schedule-shell` as the package-level host that combines:
-
-- mode switcher
-- Set Baseline action (adapter `setBaseline`)
-- Import modal orchestration
-- Export tasks action (adapter `exportTasks`)
-
-Shell parity control inputs:
-
+
+- mode switcher
+- Set Baseline action (adapter `setBaseline`)
+- Import modal orchestration
+- Export tasks action (adapter `exportTasks`)
+
+Shell parity control fields also live on `context`:
+
+- `modeOptions`
 - `allowEditMode`
 - `allowImport`
 - `allowSetBaseline`
 - `hasTasks`
 - `baselinePending`
-
-Use one adapter service per selector/source if needed. The component does not use NGXS.
-
-See `PARITY_REPORT.md` for legacy-to-package migration coverage.
+
+Use one adapter service per selector/source if needed. The component does not use NGXS.
+
+See `PARITY_REPORT.md` for legacy-to-package migration coverage.