@outbuild-company/schedule-core 1.19.1 → 1.20.1

package/README.md

@@ -88,6 +88,41 @@ The library accepts backend-shaped schedule data, normalizes it internally and
 returns a ready instance. A successful mutation updates core state and returns
 the complete `ChangeSet`; a rejected mutation leaves state untouched.
 
+## Data Date (P6) schedule defaults and readiness
+
+`core.dataDates.getDefaultSettings()` returns a fresh, detached settings value on every call. The Outbuild defaults are:
+
+```ts
+{
+  dataDate: null,
+  outOfSequencePolicy: 'retained_logic',
+  dependencyReference: 'correlative_id',
+  useExpectedFinishDates: true,
+  startToStartLagBasis: 'early_start',
+  relationshipLagCalendar: 'predecessor',
+  totalFloatMethod: 'finish_float',
+  criticalActivityMethod: 'total_float',
+  criticalFloatThresholdHours: 0,
+  makeOpenEndedActivitiesCritical: false,
+  externalRelationshipPolicy: 'SD_Both',
+  calculateFloatBasedOn: 'each_project',
+  setDataDateAndPlannedStartToForecastStart: false,
+  projectMustFinishBy: null,
+  projectForecastStart: null,
+  multipleFloatPaths: {
+    enabled: false,
+    limitEnabled: false,
+    maximum: 10,
+    useTotalFloat: true,
+    endingActivityId: null
+  }
+}
+```
+
+`core.dataDates.getScheduleReadiness(patch?)` evaluates a patch without changing settings, project state, activities, links, revision, dirty state, or history. It checks P6 capability, imported external relationships, patch validity, effective Forecast Start, and Data Date before reporting readiness.
+
+A blocked result carries the blocker code, the number of blocking activities, a bounded sample of their ids and the fields each one lacks. `schedule()` throws `DataDateCapabilityError` with the same blocker code for blocked results. The full surface is listed in `docs/api/reference.md` (Data Date section).
+
 ## One engine, two public entry points
 
 | Consumer | Entry point |