@object-ui/plugin-gantt 17.5.0 → 17.6.0

package/CHANGELOG.md

@@ -1,5 +1,223 @@
 # @object-ui/plugin-gantt
 
+## 17.6.0
+
+### Patch Changes
+
+- 5edc0c5: `object-gantt` / `object-map` / `object-calendar` no longer drop a sort entry that omits `order`.
+  
+  The three blocks each inlined a byte-identical private copy of the `sort` →
+  `$orderby` conversion. That copy required BOTH `field` and `order` on an array
+  entry and silently skipped any entry missing one, so a stored view sorting by
+  `[{ field: 'amount' }]` reached the wire with no ordering at all — the authored
+  sort key was lost, not applied. The same copy already treated the STRING
+  spelling `"amount"` as ascending, so this was an inconsistency between two
+  spellings of one thing rather than deliberate strictness.
+  
+  All three now import the shared `convertSortToQueryParams` sink from
+  `@object-ui/core` (introduced by objectstack#7137, already used by
+  `object-timeline` and `record:line_items`), and the private copies are gone —
+  the sink is the repo's only definition. Two behavior changes come with it, both
+  of which make the blocks more faithful to what is already declared rather than
+  more tolerant:
+  
+  - An array entry that omits `order` now orders ASCENDING instead of vanishing.
+    That is what `QueryParams.$orderby`'s own member shape
+    (`{ field: string; order?: 'asc' | 'desc' }`) says, and what
+    `@object-ui/data-objectstack`'s `serializeOrderBy` already did with a missing
+    direction.
+  - When nothing orderable was authored, the query now carries no `$orderby` at
+    all instead of an empty object. `{}` is truthy and meant "no ordering" only by
+    accident of the adapter's serializer.
+  
+  Reachability, so the size of this is not overstated: `SortConfig.order` and
+  `ElementDataSourceSort.order` are REQUIRED in objectui's own types, so a typed
+  caller could never author the dropped shape. The affected surface is untyped
+  stored view metadata (`ElementSavedView` is a loose record by design) — which is
+  exactly where an order-less entry can arrive today.
+- 6098ecd: plugin-gantt README: the `onTaskUpdate` drag example no longer writes blank dates on a progress drag.
+  
+  `GanttViewProps.onTaskUpdate`'s second parameter is
+  `Partial< Pick< GanttTask, 'title' | 'start' | 'end' | 'progress' > >`
+  (`src/GanttView.tsx:345`), so the destructured `start` / `end` are
+  `Date | undefined`. The README's "Drag-and-drop rescheduling" example destructured
+  them and passed both straight to `save(...)`, under a comment asserting they are
+  always real `Date` objects. Both layers of that assertion were wrong.
+  
+  The runtime half is the one that mattered. `onTaskUpdate` is the single exit for
+  every edit path, and the progress grip commits changes with **no** dates at all —
+  `commitTaskUpdates([{ task, changes: { progress: cur.value } }])`
+  (`src/GanttView.tsx:1335`), forwarded verbatim by `onTaskUpdate(task, changes)`
+  (`:1091`). A host that copied the example therefore called
+  `save(task.id, { start: undefined, end: undefined })` on every progress drag,
+  blanking the record's start and end dates. Drag is documented as opt-in via
+  `onTaskUpdate` alone and progress drag needs no extra switch, so the path was
+  reachable by default rather than a corner configuration.
+  
+  The example now guards with `if (!start || !end) return;` and its comment states
+  the real shape — that only the keys an edit touched are present, and that the
+  progress grip sends just `{ progress }`. Documentation only; no renderer behavior
+  changed.
+- bb3fab6: Docs only: `packages/plugin-gantt/README.md` no longer teaches two identifiers the
+  package does not export, nor a task shape it does not produce (objectui#5012).
+  Each README import was judged against the entry module's real export surface
+  (35 names, read from the build product's `dist/index.d.ts`), and every corrected
+  snippet was type-checked against that same build product:
+  
+  - **`ganttComponents`** — taught as a components map to iterate over for "manual
+    registration" (`Object.entries(ganttComponents).forEach(...)`). It does not
+    exist anywhere in the package, so the snippet was `Object.entries(undefined)`:
+    a `TypeError` on the first line a reader copied. Registration is *only* the
+    side effect of importing the entry point, which runs the two
+    `ComponentRegistry.register(...)` calls in `src/index.tsx`. The section is
+    replaced by what actually happens: the schema types those calls claim
+    (`object-gantt` → `plugin-gantt:object-gantt`, `gantt` → `view:gantt`, both
+    with a bare-`type` fallback), the package's real export surface, and — for the
+    use case the old snippet was reaching for — registering the exported
+    `ObjectGanttRenderer` under a key of your own.
+  
+  - **`GanttSchema`** — taught as the component schema type in the TypeScript
+    section. Pure fiction: zero hits in this package and in `@object-ui/types`
+    (a plain grep appears to find it only as a substring of `ObjectGanttSchema`;
+    under a word boundary it has no hits at all). The authored type does exist
+    under its real name, so the example is rewritten around it rather than
+    dropped: `ObjectGanttSchema` from `@object-ui/types`, which is
+    **record-driven** — `type: 'object-gantt'` plus an object name and the fields
+    to read. It never carried the `tasks` array the old snippet assigned to it.
+    No export was added to make the old name true.
+  
+  - **`GanttTask`** — the one real name of the three, and the reason the section
+    still failed to compile. The documented shape had drifted from the exported
+    type on three counts: the label field is `title`, not `name`; `start`/`end`
+    are `Date` objects, not ISO strings; and `color` is a CSS color, not a
+    Tailwind class. Both the "Task Structure" reference block and the typed
+    example now match the exported declaration, and the reference block is pinned
+    against it in both assignment directions so a future drift fails a check
+    instead of compiling as an unrelated local interface.
+  
+  No code, types or runtime behaviour change — the diff is one README and this
+  changeset. The correction reaches npm with the package's next publish, which is
+  why it declares a patch: `README.md` is in the package's published `files`.
+- 449ffe8: Fix the `GanttViewMode` JSDoc to name all five granularities (objectui#5132).
+  
+  The comment above `export type GanttViewMode` said "one column per day, week,
+  month, or quarter" while the type itself, `VIEW_MODES`, `NOMINAL_DAYS`
+  (`year: 365.25`), the column builder, the toolbar and the header-band logic
+  have honored a fifth member, `'year'`, all along — `'year'` was fully live,
+  just undocumented. Doc-only change, no behavior difference.
+- Updated dependencies [88085e3]
+- Updated dependencies [69251bf]
+- Updated dependencies [57e668f]
+- Updated dependencies [516663d]
+- Updated dependencies [41ac1b7]
+- Updated dependencies [1eaf0a1]
+- Updated dependencies [7c297e3]
+- Updated dependencies [a09bc33]
+- Updated dependencies [460c4d0]
+- Updated dependencies [0ae27f7]
+- Updated dependencies [2533ec5]
+- Updated dependencies [78c0f9a]
+- Updated dependencies [bbe8b86]
+- Updated dependencies [8477be5]
+- Updated dependencies [279fb13]
+- Updated dependencies [2e82ab2]
+- Updated dependencies [ad07b65]
+- Updated dependencies [41f498b]
+- Updated dependencies [ef0d150]
+- Updated dependencies [f34226e]
+- Updated dependencies [564b605]
+- Updated dependencies [e1d4251]
+- Updated dependencies [40d3a33]
+- Updated dependencies [8b9dc62]
+- Updated dependencies [1184192]
+- Updated dependencies [a2a9747]
+- Updated dependencies [65e88e6]
+- Updated dependencies [a1609a6]
+- Updated dependencies [53f23bc]
+- Updated dependencies [c4533dc]
+- Updated dependencies [be60815]
+- Updated dependencies [37f6844]
+- Updated dependencies [93de4f6]
+- Updated dependencies [2b50261]
+- Updated dependencies [384f30d]
+- Updated dependencies [ac600e5]
+- Updated dependencies [97fba31]
+- Updated dependencies [232f61a]
+- Updated dependencies [d374caf]
+- Updated dependencies [5673576]
+- Updated dependencies [c1ef923]
+- Updated dependencies [911ceaa]
+- Updated dependencies [98eab36]
+- Updated dependencies [af5e292]
+- Updated dependencies [3fbbea1]
+- Updated dependencies [0bffb18]
+- Updated dependencies [800f455]
+- Updated dependencies [5458414]
+- Updated dependencies [3241559]
+- Updated dependencies [7f96b10]
+- Updated dependencies [167ec42]
+- Updated dependencies [616a2a5]
+- Updated dependencies [6c68b13]
+- Updated dependencies [0046d8f]
+- Updated dependencies [f1d4748]
+- Updated dependencies [bea374e]
+- Updated dependencies [b1119ec]
+- Updated dependencies [5607092]
+- Updated dependencies [9f23d2b]
+- Updated dependencies [578e025]
+- Updated dependencies [af025ee]
+- Updated dependencies [d109a4d]
+- Updated dependencies [598c89a]
+- Updated dependencies [4a0bd17]
+- Updated dependencies [b8b9af4]
+- Updated dependencies [31676be]
+- Updated dependencies [8c0d52e]
+- Updated dependencies [aff10e2]
+- Updated dependencies [70a774b]
+- Updated dependencies [7dd93c0]
+- Updated dependencies [229b17e]
+- Updated dependencies [9ce096f]
+- Updated dependencies [e05db88]
+- Updated dependencies [7458a41]
+- Updated dependencies [ad13d63]
+- Updated dependencies [5ffcc14]
+- Updated dependencies [d971e51]
+- Updated dependencies [97abb24]
+- Updated dependencies [deb157a]
+- Updated dependencies [9c60144]
+- Updated dependencies [e7747f1]
+- Updated dependencies [d2ce342]
+- Updated dependencies [9695da7]
+- Updated dependencies [ac2f332]
+- Updated dependencies [a777058]
+- Updated dependencies [75444e3]
+- Updated dependencies [58b8346]
+- Updated dependencies [2d0bd16]
+- Updated dependencies [a9e17b4]
+- Updated dependencies [b8ce7dc]
+- Updated dependencies [dad51e5]
+- Updated dependencies [1c9c342]
+- Updated dependencies [787c738]
+- Updated dependencies [8396656]
+- Updated dependencies [dbbd38a]
+- Updated dependencies [8871c14]
+- Updated dependencies [93fe362]
+- Updated dependencies [dfc6975]
+- Updated dependencies [3cf4de0]
+- Updated dependencies [c9dc811]
+- Updated dependencies [144ef9b]
+- Updated dependencies [138ab04]
+- Updated dependencies [a0b9e91]
+- Updated dependencies [99bd015]
+- Updated dependencies [21e4585]
+  - @object-ui/types@17.6.0
+  - @object-ui/fields@17.6.0
+  - @object-ui/i18n@17.6.0
+  - @object-ui/react@17.6.0
+  - @object-ui/plugin-detail@17.6.0
+  - @object-ui/components@17.6.0
+  - @object-ui/core@17.6.0
+
 ## 17.5.0
 
 ### Patch Changes