@outbuild-company/schedule-core 1.9.0 → 1.9.2

package/README.md

@@ -1,85 +1,32 @@
-# @outbuild/schedule-core
+# @outbuild-company/schedule-core
 
-UI-agnostic schedule engine. Owns activities, links, calendars, autoscheduler and critical path. Designed to back DHTMLX (or any other UI) without leaking visual concerns.
+UI-agnostic schedule engine for activities, links, calendars, autoscheduling
+and critical-path calculation.
 
-**Status**: alpha — consumed in production by Outbuild's `react_client` behind the `SCHEDULE_CORE` feature flag, via the public entry (`core.dispatch(...)` and friends). The API surface is `src/index.ts` and nothing else.
-
-Extracted from the `pp2_node` monorepo (`packages/schedule-core`) on 2026-06-05 as a clean snapshot (no history carried over).
-
-## Consuming from react_client (yarn link)
-
-The app consumes this repo's `src/` directly — no build step in the dev loop. Vite transpiles the TypeScript on the fly and watches the linked sources (cross-repo HMR works).
+## Install
 
 ```bash
-# once per machine
-cd ~/Developer/schedule-core && yarn link
-cd <pp2_node>/react_client && yarn link "@outbuild/schedule-core"
+npm install @outbuild-company/schedule-core
 ```
 
-The link is wiped by `yarn install --force` or deleting `node_modules` — `react_client`'s pre-dev/start/build guard (`scripts/check-schedule-core-link.mjs`) fails fast with these instructions when that happens.
-
-### Coordinated changes (core + bridge)
-
-A change that touches both this repo and the react_client bridge is two commits:
-
-1. Commit (and push) here first.
-2. Commit the bridge side in `pp2_node` referencing the core commit.
+The package exposes a single public entry point:
 
-Locally nothing else is needed — the link always reflects your working tree.
-
-### Persistence boundary
-
-This package owns the schedule domain, derived calculations and the persisted
-checkpoint used by `hasUnsavedChanges()` / `getModifiedActivities()`. It does
-not issue HTTP requests or build ProPlanner's private save DTO.
-
-The consuming bridge in `pp2_node-schedule-core` owns the reverse translation:
-
-```text
-ScheduleCore
-  → scheduleActions.getActivities() / getLinks()
-  → convertCoreActivityToActivity / convertCoreLinkToActivityRelation
-  → POST activitys/updateAllScheduleData
+```ts
+import { ScheduleCore } from '@outbuild-company/schedule-core';
 ```
 
-The save reads all live activities and links from ScheduleCore, not from
-DHTMLX. DHTMLX contributes only transient visual progress flags. The bridge
-also injects `sectorId` and `ganttId`; authenticated company ownership,
-timestamps and related entities remain server concerns.
-
-`PersistableActivity` is therefore a dirty-check snapshot, not a network DTO.
-End-to-end save/reload compatibility must be certified in the consuming bridge
-and server repository.
-
-_added: 2026-07-31T20:27:29Z_
+Schedule Core owns domain state and mutations. Consumers send commands through
+`ScheduleCore.dispatch()` and translate the returned changes at their own UI
+and persistence boundaries.
 
-## Build
+## Development
 
-```
+```bash
+npm ci
+npm run typecheck
+npm test
 npm run build
 ```
 
-Outputs:
-- `dist/index.js` — ESM
-- `dist/index.cjs` — CJS
-- `dist/index.d.ts` / `dist/index.d.cts` — types
-- `dist/cdn/schedule-core.global.js` — IIFE for `<script>` tag (global `ScheduleCore`)
-
-`dist/` is the future published contract (registry or git dependency, pending when the `SCHEDULE_CORE` flag nears 100%); today no consumer reads it.
-
-Known debt: the DTS build (and `npm run typecheck`) is red from the in-flight `ActivitySnapshot` snake_case→camelCase refactor. ESM/CJS/IIFE build green.
-
-## Test
-
-```
-npm run test
-```
-
-Self-contained vitest suite (fixtures live under `src/testing/projects/`). 6 known failing parity/date-math tests at import time, pre-existing from the monorepo branch.
-
-## Docs
-
-- `API.md` — public API reference: every export of `src/index.ts` with signatures and usage examples.
-- `CLAUDE.md` — agent guide: identity, invariants, engineering rules.
-- `CURSOR.md` — operational guide: where each doc goes, `core.dispatch` flow, timestamp convention.
-- `SMELLS.md` / `TODO.md` — living logs (see CURSOR.md for their contracts).
+The build produces ESM, CommonJS, type declarations and a browser IIFE under
+`dist/`.