canopycms 0.2.0 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +199 -41
- package/dist/api/branch.d.ts +2 -2
- package/dist/cli/cli.js +0 -18
- package/dist/cli/generate-ai-content.js +0 -6
- package/dist/cli/init.js +0 -6
- package/dist/editor/BranchManager.d.ts +2 -0
- package/dist/editor/BranchManager.js +3 -3
- package/dist/editor/Editor.js +253 -128
- package/dist/editor/EntryNavigator.d.ts +44 -9
- package/dist/editor/EntryNavigator.js +275 -103
- package/dist/editor/branch-lock.d.ts +42 -0
- package/dist/editor/branch-lock.js +79 -0
- package/dist/editor/branch-status.d.ts +0 -6
- package/dist/editor/branch-status.js +0 -10
- package/dist/editor/components/BranchNotAvailableNotice.d.ts +11 -0
- package/dist/editor/components/BranchNotAvailableNotice.js +10 -0
- package/dist/editor/components/BranchPill.d.ts +3 -18
- package/dist/editor/components/BranchPill.js +7 -10
- package/dist/editor/components/EditorHeader.d.ts +24 -52
- package/dist/editor/components/EditorHeader.js +151 -71
- package/dist/editor/components/EditorRail.d.ts +8 -8
- package/dist/editor/components/EditorRail.js +7 -5
- package/dist/editor/components/EntryBreadcrumb.d.ts +5 -1
- package/dist/editor/components/EntryBreadcrumb.js +3 -3
- package/dist/editor/components/EntryHeader.d.ts +60 -0
- package/dist/editor/components/EntryHeader.js +45 -0
- package/dist/editor/components/EntrySaveButton.d.ts +24 -0
- package/dist/editor/components/EntrySaveButton.js +101 -0
- package/dist/editor/components/NoEditPermissionNotice.d.ts +1 -1
- package/dist/editor/components/NoEditPermissionNotice.js +1 -1
- package/dist/editor/components/RetryToastMessage.d.ts +3 -1
- package/dist/editor/components/RetryToastMessage.js +8 -4
- package/dist/editor/components/SaveAllButton.d.ts +25 -0
- package/dist/editor/components/SaveAllButton.js +81 -0
- package/dist/editor/components/UnsavedMark.d.ts +1 -1
- package/dist/editor/components/UnsavedMark.js +1 -1
- package/dist/editor/components/index.d.ts +1 -1
- package/dist/editor/components/index.js +1 -1
- package/dist/editor/copy.d.ts +0 -1
- package/dist/editor/copy.js +0 -1
- package/dist/editor/editor-utils.d.ts +2 -2
- package/dist/editor/editor-utils.js +2 -2
- package/dist/editor/entry-search.d.ts +10 -16
- package/dist/editor/entry-search.js +4 -24
- package/dist/editor/hooks/useBranchManager.d.ts +7 -3
- package/dist/editor/hooks/useBranchManager.js +13 -9
- package/dist/editor/hooks/useEntryManager.d.ts +3 -0
- package/dist/editor/hooks/useEntryManager.js +10 -3
- package/dist/editor/shell/ActivityRail.d.ts +4 -0
- package/dist/editor/shell/ActivityRail.js +13 -4
- package/dist/editor/shell/EditorShell.d.ts +6 -7
- package/dist/editor/shell/EditorShell.js +9 -13
- package/dist/editor/shell/PaneLayout.d.ts +1 -0
- package/dist/editor/shell/PaneLayout.js +23 -5
- package/dist/editor/shell/SidePanelHost.d.ts +11 -4
- package/dist/editor/shell/SidePanelHost.js +95 -7
- package/dist/editor/shell/TopBar.d.ts +4 -4
- package/dist/editor/shell/TopBar.js +6 -3
- package/dist/editor/utils/focus-return.d.ts +10 -2
- package/dist/editor/utils/focus-return.js +40 -6
- package/dist/operating-mode/client-safe-strategy.d.ts +1 -6
- package/dist/operating-mode/client-safe-strategy.js +1 -10
- package/dist/operating-mode/types.d.ts +0 -3
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
- package/dist/editor/components/BranchLockBanner.d.ts +0 -23
- package/dist/editor/components/BranchLockBanner.js +0 -66
- package/dist/editor/components/QuickOpenPalette.d.ts +0 -28
- package/dist/editor/components/QuickOpenPalette.js +0 -71
- package/dist/editor/components/SaveSplitButton.d.ts +0 -31
- package/dist/editor/components/SaveSplitButton.js +0 -121
package/CHANGELOG.md
CHANGED
|
@@ -5,9 +5,9 @@ packages release together, at one version.
|
|
|
5
5
|
|
|
6
6
|
## This build
|
|
7
7
|
|
|
8
|
-
Version `0.
|
|
8
|
+
Version `0.3.0`, built from [`18d436f`](https://github.com/safeinsights/canopycms/tree/18d436fe91546aabb30da8efa1397046b65681dc).
|
|
9
9
|
|
|
10
|
-
Its entries are [0.
|
|
10
|
+
Its entries are [0.3.0](#030), under **Released**.
|
|
11
11
|
|
|
12
12
|
If you upgraded from a build on another branch, compare the `<!-- changeset: … -->` slugs in your previous build's `CHANGELOG.md` (`npm pack canopycms@<old>` fetches it) with this one's: entries whose slug your old file lacks are new to you.
|
|
13
13
|
|
|
@@ -24,7 +24,7 @@ Each entry has up to three parts:
|
|
|
24
24
|
`node_modules/canopycms/CHANGELOG.md`, assembled for that build: its **This build** section lists
|
|
25
25
|
what is new since the previous int on the same branch, or on a stable release links its entries, and its links point at the commit the build
|
|
26
26
|
came from. The copy in the repository holds released history and the entries from before changesets;
|
|
27
|
-
every entry written since is a file in [`.changeset/`](https://github.com/safeinsights/canopycms/blob/
|
|
27
|
+
every entry written since is a file in [`.changeset/`](https://github.com/safeinsights/canopycms/blob/18d436fe91546aabb30da8efa1397046b65681dc/.changeset/README.md) until a stable release
|
|
28
28
|
moves it here.
|
|
29
29
|
|
|
30
30
|
**Find your starting point.** From a stable pin, start at the first version under **Released**
|
|
@@ -62,6 +62,164 @@ entries under **Released**.
|
|
|
62
62
|
|
|
63
63
|
## Released
|
|
64
64
|
|
|
65
|
+
### 0.3.0
|
|
66
|
+
|
|
67
|
+
#### The branch bar's tooltips open beside their controls
|
|
68
|
+
|
|
69
|
+
<!-- changeset: bar-tooltips-beside-controls -->
|
|
70
|
+
|
|
71
|
+
_First in 0.3.0._
|
|
72
|
+
|
|
73
|
+
**What changed.** The tooltips on the bar's unsaved count, Save all and the branch-actions caret
|
|
74
|
+
no longer open a fixed distance below the bar, where a bar wrapped to several rows put them over
|
|
75
|
+
the entry's Save and breadcrumb, and a one-row bar over the preview toolbar. The unsaved count's
|
|
76
|
+
and the caret's open at their control. Save all's opens to its left, in the bar's free middle,
|
|
77
|
+
and below it when the left edge has no room. The unsaved count's tooltip now reads "Show unsaved
|
|
78
|
+
entries in the content panel".
|
|
79
|
+
|
|
80
|
+
#### The top bar becomes the branch bar — **behaviour change**
|
|
81
|
+
|
|
82
|
+
<!-- changeset: branch-bar-layout -->
|
|
83
|
+
|
|
84
|
+
_First in 0.3.0._
|
|
85
|
+
|
|
86
|
+
**What changed.** The branch pill moves to the start of the top bar, and its menu opens from
|
|
87
|
+
there. The actions on the branch sit at the bar's other end: the warning that drafts could not
|
|
88
|
+
be stored on this device, then Save all, then Submit for review or Withdraw from review. Below
|
|
89
|
+
the `md` breakpoint, on a branch you can edit, Save all and the review action share one split
|
|
90
|
+
button: Save all is the button, and its caret holds Submit or Withdraw. A branch with no review
|
|
91
|
+
action draws no caret. The confirm dialog returns focus to the review action, and focus follows
|
|
92
|
+
that action when a submit or withdraw moves it between the caret and a button of its own.
|
|
93
|
+
|
|
94
|
+
#### The branch bar states a locked branch's status, replacing the lock banner — **behaviour change**
|
|
95
|
+
|
|
96
|
+
<!-- changeset: branch-bar-status -->
|
|
97
|
+
|
|
98
|
+
_First in 0.3.0._
|
|
99
|
+
|
|
100
|
+
**What changed.** The banner under the top bar is gone. A branch's lasting state now shows
|
|
101
|
+
once, beside the branch pill, at every width: "Loading branch…", "Protected · read-only", "In
|
|
102
|
+
review · read-only", "Approved · read-only", "Archived · read-only", "Details unavailable ·
|
|
103
|
+
read-only" when branch details failed to load, "Not available · read-only" when the branch list
|
|
104
|
+
has no such branch for you, or "Protected" for a protected branch that still takes edits. Screen
|
|
105
|
+
readers hear the status with its reason when a lock arrives. The pill no longer carries a status
|
|
106
|
+
badge, and on a phone it shows the branch name, truncated, with the full name heading its menu.
|
|
107
|
+
The bar offers the way forward: New branch…, which opens Branches on its new-branch form, on the
|
|
108
|
+
protected base branch; Withdraw from review on a branch in review; Refresh branch when details
|
|
109
|
+
failed to load; and Switch branch… otherwise. Below the `md` breakpoint a locked branch has no
|
|
110
|
+
Save all: its way forward leads, with Submit or Withdraw in its caret unless Withdraw is that way.
|
|
111
|
+
Someone who may not withdraw gets Switch branch…, with the blocked Withdraw and its reason in the
|
|
112
|
+
caret.
|
|
113
|
+
|
|
114
|
+
#### The content panel lists unsaved entries under a Changed filter, replacing the pill's list — **behaviour change**
|
|
115
|
+
|
|
116
|
+
<!-- changeset: changed-filter -->
|
|
117
|
+
|
|
118
|
+
_First in 0.3.0._
|
|
119
|
+
|
|
120
|
+
**What changed.** The branch pill's menu no longer lists the unsaved entries. It keeps Switch
|
|
121
|
+
branch…, Refresh branch and Discard all changes. The unsaved count leaves the pill, and Save all
|
|
122
|
+
no longer carries it: "N unsaved" beside the branch's status opens the content panel filtered to
|
|
123
|
+
Changed, with any search cleared, in the overlay on a narrow window. The panel's All / Changed
|
|
124
|
+
choice lists only entries with unsaved changes, under the collections that hold them, and
|
|
125
|
+
combines with the search field. Enter opens the first one. Changed says when nothing is unsaved,
|
|
126
|
+
when no unsaved entry matches the search, when some entries are still being listed, and when the
|
|
127
|
+
entry list failed to load; an unsaved entry outside the content tree is offered beneath it.
|
|
128
|
+
Finding an entry with Mod+P, or switching branch, goes back to All. The entry menu gains "Show
|
|
129
|
+
in content panel": it opens the panel on All, with the search cleared, and focuses the entry's
|
|
130
|
+
row.
|
|
131
|
+
|
|
132
|
+
#### Save moves into a header over the open entry, and Save all becomes its own button — **behaviour change**
|
|
133
|
+
|
|
134
|
+
<!-- changeset: entry-header-save -->
|
|
135
|
+
|
|
136
|
+
_First in 0.3.0._
|
|
137
|
+
|
|
138
|
+
**What changed.** A header above the preview and form holds the open entry's breadcrumb, entry
|
|
139
|
+
menu, unsaved dot, "Read-only" chip and Save. It stays in view while the preview is maximized,
|
|
140
|
+
and with no entry open Save stays there, blocked, saying to open one; while entries load, the
|
|
141
|
+
crumb is a placeholder. "Save all" leaves Save's
|
|
142
|
+
menu for a button of its own in the top bar, showing the unsaved count and then its progress,
|
|
143
|
+
and waits while any entry is saving. Save waits while Save all runs, and says why. The warning
|
|
144
|
+
that drafts could not be stored on this device now shows whenever anything on the branch is
|
|
145
|
+
unsaved, not only the open entry.
|
|
146
|
+
|
|
147
|
+
#### EntryNavigator's `revealCollection` prop is replaced by `reveal` — **breaking (EntryNavigator props)**
|
|
148
|
+
|
|
149
|
+
<!-- changeset: entry-navigator-props -->
|
|
150
|
+
|
|
151
|
+
_First in 0.3.0._
|
|
152
|
+
|
|
153
|
+
**What changed.** `EntryNavigatorProps` loses `revealCollection` and gains `reveal`, a
|
|
154
|
+
`ContentPanelReveal` (a new export of `canopycms/client`). `EntryNavItem` gains an optional
|
|
155
|
+
`route`. The other additions are all optional: `onChangedOnlyChange`, `changedOnly`,
|
|
156
|
+
`unsavedCount`, `unsavedEntries`, `entryListFailed`, `branchNotAvailable`, `onSwitchBranch`,
|
|
157
|
+
`onFilterEnter`, `onFilterEscape`, `onRowMenuOpen`, `filterRef` and `filterShortcut`. No prop
|
|
158
|
+
became required, and the editor's own use of the navigator needs no change. Only code that
|
|
159
|
+
renders `EntryNavigator` directly is affected.
|
|
160
|
+
|
|
161
|
+
**To adopt.** Where you pass `revealCollection={{ path, seq }}`, pass
|
|
162
|
+
`reveal={{ kind: 'collection', path, seq }}` instead. `reveal` also takes
|
|
163
|
+
`{ kind: 'entry', path, seq }` for an entry's row and `{ kind: 'changed', seq }` to clear the
|
|
164
|
+
query for the Changed filter. `onRevealed` is unchanged. A `reveal` of kind `collection` or
|
|
165
|
+
`entry` calls `onChangedOnlyChange(false)`, so a controlled `changedOnly` returns to All.
|
|
166
|
+
|
|
167
|
+
#### A branch you can't open says so everywhere, and locked drafts say why they wait
|
|
168
|
+
|
|
169
|
+
<!-- changeset: no-access-branch-and-locked-drafts -->
|
|
170
|
+
|
|
171
|
+
_First in 0.3.0._
|
|
172
|
+
|
|
173
|
+
**What changed.** On a branch the branch list doesn't include for you ("Not available ·
|
|
174
|
+
read-only" in the bar), once its content fails to load, the content panel and the form pane say
|
|
175
|
+
"You don't have access to this branch, or it no longer exists." and offer Switch branch…, which
|
|
176
|
+
opens Branches; the preview pane says the same. They used to read "No content" and "Select an
|
|
177
|
+
item to start editing." No failed load is toasted on that branch. On any other branch, a failed
|
|
178
|
+
content load keeps its "Could not load content" toast with Retry, now in plain words, with any
|
|
179
|
+
diagnostic behind a "Details" disclosure. On a locked branch, the bar's "N unsaved" tooltip says
|
|
180
|
+
the edits are in this browser and what lets them be saved: "Withdraw to save them." in review or
|
|
181
|
+
approved, for someone who may withdraw; a pointer to "Refresh branch" when details failed to
|
|
182
|
+
load; and, on a protected or archived branch, that they can only be discarded.
|
|
183
|
+
|
|
184
|
+
#### One search: Mod+P opens the content panel's "Find entries" field, and the quick-open dialog is gone — **behaviour change**
|
|
185
|
+
|
|
186
|
+
<!-- changeset: one-entry-search -->
|
|
187
|
+
|
|
188
|
+
_First in 0.3.0._
|
|
189
|
+
|
|
190
|
+
**What changed.** Finding an entry has one place, the content panel's field, now called "Find
|
|
191
|
+
entries" and showing its shortcut (⌘P on macOS, Ctrl+P elsewhere). Mod+P focuses it from
|
|
192
|
+
anywhere, a form field included; pressed in the field, it selects the text. With the docked panel
|
|
193
|
+
closed, Mod+P opens it only until Enter opens the first match, Escape is pressed in the empty
|
|
194
|
+
field, or focus moves elsewhere; opening a row's menu or pressing Content keeps it open. That
|
|
195
|
+
Enter moves focus to the opened entry's first field. The quick-open dialog, the panel's
|
|
196
|
+
magnifier button and the rail's Open entry button are removed; the Content button's tooltip names
|
|
197
|
+
the shortcut. Each tree row's second line now shows the entry's route after its type, as in
|
|
198
|
+
"Landing page · /contact" (the type alone when the entry has no page), in full on hover or focus
|
|
199
|
+
when it is cut off.
|
|
200
|
+
|
|
201
|
+
##### Added in 0.3.0
|
|
202
|
+
|
|
203
|
+
<!-- changeset: one-entry-search-focus-polish -->
|
|
204
|
+
|
|
205
|
+
**What changed.** The form pane, when it takes focus after Enter opens an entry with no fields, draws the
|
|
206
|
+
editor's focus ring inside its edges, above the form's sticky header. On keyboard focus, a tree
|
|
207
|
+
row's cut-off line shows in full after a short delay, below the row (above it when
|
|
208
|
+
there is no room), never over the row's title, and Escape hides it. The field's shortcut hint takes
|
|
209
|
+
the placeholder's colour, and its clear buttons read "Clear search".
|
|
210
|
+
|
|
211
|
+
#### The rail drops its Branches button and moves the layout toggle up — **behaviour change**
|
|
212
|
+
|
|
213
|
+
<!-- changeset: rail-polish -->
|
|
214
|
+
|
|
215
|
+
_First in 0.3.0._
|
|
216
|
+
|
|
217
|
+
**What changed.** The activity rail now runs Content, Comments and Media, then a divider, then the
|
|
218
|
+
layout toggle; Settings and Account stay at the bottom. Arrow keys move across the divider without
|
|
219
|
+
stopping on it. Content shows an unsaved dot while its panel is closed, and its name says how many
|
|
220
|
+
entries are unsaved ("Content, 3 unsaved"). The Branches button is gone: the branch pill's Switch
|
|
221
|
+
branch… opens the Branches drawer.
|
|
222
|
+
|
|
65
223
|
### 0.2.0
|
|
66
224
|
|
|
67
225
|
#### Removing a file from the media library hides it, and an admin can restore it — **breaking (assets.delete, AssetStore) / behaviour change; template first**
|
|
@@ -272,7 +430,7 @@ URL.
|
|
|
272
430
|
2. For a branch preview: wrap views with `withCanopyPreview` in a `'use client'` module, add
|
|
273
431
|
`app/preview/[[...path]]/page.server.tsx`, set `editor.previewPrefix: '/preview'`, and serve that
|
|
274
432
|
route with `frame-ancestors 'self'`, not `X-Frame-Options: DENY` (see
|
|
275
|
-
[Live Preview](https://github.com/safeinsights/canopycms/blob/
|
|
433
|
+
[Live Preview](https://github.com/safeinsights/canopycms/blob/18d436fe91546aabb30da8efa1397046b65681dc/README.md#live-preview)).
|
|
276
434
|
3. A test reading view content from the route's server HTML must load the page in a browser.
|
|
277
435
|
Server output rendered during a preview request carries the signed-in asset prefix; keep it out
|
|
278
436
|
of cross-request caches (`unstable_cache`, module memos).
|
|
@@ -287,7 +445,7 @@ kept site styles ahead of Mantine's in the preview.
|
|
|
287
445
|
server components. A string path marks the form's spelling (`'a.0.b'` marks `a[0].b`), and an empty
|
|
288
446
|
path marks nothing. The editor counts and logs marks naming no field. `createEntrySchemaRegistry`
|
|
289
447
|
refuses a field name that is empty, all digits or contains `.`, `[` or `]`. See
|
|
290
|
-
[Live Preview](https://github.com/safeinsights/canopycms/blob/
|
|
448
|
+
[Live Preview](https://github.com/safeinsights/canopycms/blob/18d436fe91546aabb30da8efa1397046b65681dc/README.md#live-preview).
|
|
291
449
|
|
|
292
450
|
**To adopt.** Fix each path that stops compiling; the error lists valid ones. Rewrite computed paths
|
|
293
451
|
as literal segments, or type that component's prop as plain `FieldProps`. Pass `fieldProps` as
|
|
@@ -369,7 +527,7 @@ or a failed render) renders as its plain text, with no URL; any other form of th
|
|
|
369
527
|
fields are nested or renamed, pass the AI config's `seo` the same object you pass
|
|
370
528
|
`createNextCanopyContext({ seo })`, so the sitemap and AI content read the flag from the same
|
|
371
529
|
place. A field that links to a hidden section by plain URL needs a field transform; the README
|
|
372
|
-
shows [the recipe](https://github.com/safeinsights/canopycms/blob/
|
|
530
|
+
shows [the recipe](https://github.com/safeinsights/canopycms/blob/18d436fe91546aabb30da8efa1397046b65681dc/README.md#ai-content-configuration).
|
|
373
531
|
|
|
374
532
|
**Now deletable.** An `exclude.where` that re-read the `noindex` flag by hand.
|
|
375
533
|
|
|
@@ -391,7 +549,7 @@ A `markdown` field with `renderAs: 'mdx'` is checked as MDX, and `mdxAllow` narr
|
|
|
391
549
|
field or site-wide. New: field options `renderAs`, `mdxAllow`; config key `mdxAllow`; type
|
|
392
550
|
`MdxAllowlist`. (int.110) A component prop allowance can be `'string'` (or
|
|
393
551
|
`{ type: 'string', maxLength }`): a quoted value only, never bare or `{…}`. See
|
|
394
|
-
[MDX content cannot run code](https://github.com/safeinsights/canopycms/blob/
|
|
552
|
+
[MDX content cannot run code](https://github.com/safeinsights/canopycms/blob/18d436fe91546aabb30da8efa1397046b65681dc/README.md#mdx-content-cannot-run-code).
|
|
395
553
|
|
|
396
554
|
**To adopt.** Set `renderAs: 'mdx'` on each `markdown` field your site compiles as MDX, and
|
|
397
555
|
`mdxAllow` to what your renderer takes. Set `executable: true` only on a field whose editors you
|
|
@@ -528,7 +686,7 @@ a format check.
|
|
|
528
686
|
|
|
529
687
|
- (int.93) Submit commits gain an `Edited-by: Name (id)` trailer; PR bodies gain a section that
|
|
530
688
|
re-submits replace, keeping human text. Options: `gitEditedByTrailers`, `gitCoAuthoredByTrailers`
|
|
531
|
-
([reference](https://github.com/safeinsights/canopycms/blob/
|
|
689
|
+
([reference](https://github.com/safeinsights/canopycms/blob/18d436fe91546aabb30da8efa1397046b65681dc/README.md#definecanopyconfig-options)).
|
|
532
690
|
- (int.110) Submit-commit trailers name every user who saved since the last submit commit, and
|
|
533
691
|
the PR-body section every user who edited the branch, not only the submitter; settings commits
|
|
534
692
|
(permissions, groups) carry the acting user's trailer.
|
|
@@ -552,7 +710,7 @@ saves only push the branch, and no failing PR task lands in System health.
|
|
|
552
710
|
that entry type goes unavailable: the editor says so, and its entries answer 503 with
|
|
553
711
|
`code: 'SCHEMA_UNAVAILABLE'`. Builds, static deploys and `generate-ai-content` still fail. The
|
|
554
712
|
worker holds the base branch for up to 30 minutes while that lasts; see
|
|
555
|
-
[New schemas wait for the editor deploy](https://github.com/safeinsights/canopycms/blob/
|
|
713
|
+
[New schemas wait for the editor deploy](https://github.com/safeinsights/canopycms/blob/18d436fe91546aabb30da8efa1397046b65681dc/docs/deploying-to-aws.md#new-schemas-wait-for-the-editor-deploy).
|
|
556
714
|
Public types gain optional `unavailable` on `EntryTypeConfig` and `FlatSchemaItem`, optional
|
|
557
715
|
`ApiResponse.code`, and a required `SchemaResolutionResult.issues`.
|
|
558
716
|
|
|
@@ -590,7 +748,7 @@ hang until the drain heartbeat lets termination continue. Its in-flight task is
|
|
|
590
748
|
new stack needs no steps.
|
|
591
749
|
|
|
592
750
|
**What changed.** (int.109) Detailed in
|
|
593
|
-
[The worker instance](https://github.com/safeinsights/canopycms/blob/
|
|
751
|
+
[The worker instance](https://github.com/safeinsights/canopycms/blob/18d436fe91546aabb30da8efa1397046b65681dc/docs/deploying-to-aws.md#the-worker-instance): IMDSv2 with a hop limit of 1; the
|
|
594
752
|
bundle is one file whose sha256 user data checks, readable as that one object; a file-system policy
|
|
595
753
|
refusing clients without TLS or IAM, replacing the worker's
|
|
596
754
|
`AmazonElasticFileSystemClientReadWriteAccess`; an encrypted gp3 root volume; a boot-time upgrade to
|
|
@@ -644,10 +802,10 @@ failure and exits non-zero on `selfStopped`, with a code outside `RestartPrevent
|
|
|
644
802
|
with its hash, as `worker/dist/index.js` and `index.js.sha256`. The default, `'asset'`, is
|
|
645
803
|
unchanged.
|
|
646
804
|
- `CanopyCmsService` alarms when the worker logs no git sync for 30 minutes. See
|
|
647
|
-
[Worker-down alarm](https://github.com/safeinsights/canopycms/blob/
|
|
805
|
+
[Worker-down alarm](https://github.com/safeinsights/canopycms/blob/18d436fe91546aabb30da8efa1397046b65681dc/docs/deploying-to-aws.md#worker-down-alarm).
|
|
648
806
|
|
|
649
807
|
**To adopt.** Optional. For parameter-only change sets, see
|
|
650
|
-
[Rolling the worker from CI](https://github.com/safeinsights/canopycms/blob/
|
|
808
|
+
[Rolling the worker from CI](https://github.com/safeinsights/canopycms/blob/18d436fe91546aabb30da8efa1397046b65681dc/docs/deploying-to-aws.md#rolling-the-worker-from-ci). For the alarm, pass
|
|
651
809
|
`alarmTopic`.
|
|
652
810
|
|
|
653
811
|
**Now deletable.** A manual `cdk deploy` after each canopycms bump whose only purpose is moving the
|
|
@@ -658,7 +816,7 @@ worker, and a hand-built alarm on the worker log group.
|
|
|
658
816
|
**What changed.** (int.112) The boot's `dnf upgrade` could be OOM-killed on every retry. A 1 GiB
|
|
659
817
|
swap file now goes on first; an upgrade that still fails starts the worker unpatched and notifies
|
|
660
818
|
`alarmTopic` if set; a retried step names itself when it gives up. See
|
|
661
|
-
[The worker instance](https://github.com/safeinsights/canopycms/blob/
|
|
819
|
+
[The worker instance](https://github.com/safeinsights/canopycms/blob/18d436fe91546aabb30da8efa1397046b65681dc/docs/deploying-to-aws.md#the-worker-instance).
|
|
662
820
|
|
|
663
821
|
**To adopt.** Deploy, which replaces the worker instance. The bundle needs none of this, so it is
|
|
664
822
|
not Template first and the worker contract stays at 1.
|
|
@@ -724,7 +882,7 @@ and operations may reuse GitHub fetches under 30 seconds old.
|
|
|
724
882
|
|
|
725
883
|
**To adopt.** Nothing. Seeding `remote.git` stages a copy of the repository beside the gateway's
|
|
726
884
|
mirror, so the root volume needs room for two
|
|
727
|
-
([details](https://github.com/safeinsights/canopycms/blob/
|
|
885
|
+
([details](https://github.com/safeinsights/canopycms/blob/18d436fe91546aabb30da8efa1397046b65681dc/docs/deploying-to-aws.md#the-worker-instance)).
|
|
728
886
|
|
|
729
887
|
#### The worker follows a rebased or deleted GitHub branch
|
|
730
888
|
|
|
@@ -746,7 +904,7 @@ changes the template too (the fallback bundle's key and hash), so only the contr
|
|
|
746
904
|
bundle-only roll is safe.
|
|
747
905
|
|
|
748
906
|
**To adopt.** Parameter mode: gate bundle-only rolls on the contract
|
|
749
|
-
([recipe](https://github.com/safeinsights/canopycms/blob/
|
|
907
|
+
([recipe](https://github.com/safeinsights/canopycms/blob/18d436fe91546aabb30da8efa1397046b65681dc/docs/deploying-to-aws.md#rolling-the-worker-from-ci)). The gate refuses a stack without the
|
|
750
908
|
`WorkerContract` output, so `cdk deploy` the template once, which adds it. A hand-installed unit
|
|
751
909
|
copies its `Environment=CANOPYCMS_WORKER_CONTRACT=` line from `worker/canopy-worker.service`.
|
|
752
910
|
|
|
@@ -763,8 +921,8 @@ units from the bundle's contract: 2 gets the split, an older bundle the single u
|
|
|
763
921
|
template, then roll the bundle; on an older template it stops with `template too old for this
|
|
764
922
|
bundle`. Inspect EFS only through `sudo /opt/canopy-worker/canopy-inspect <command>`, never from a root shell. A hand install
|
|
765
923
|
takes `worker/`'s three units and `gateway.env.example`
|
|
766
|
-
([steps](https://github.com/safeinsights/canopycms/blob/
|
|
767
|
-
[checklist](https://github.com/safeinsights/canopycms/blob/
|
|
924
|
+
([steps](https://github.com/safeinsights/canopycms/blob/18d436fe91546aabb30da8efa1397046b65681dc/docs/deploying-to-aws.md#installing-the-units-by-hand)). After the first deploy, run the
|
|
925
|
+
[checklist](https://github.com/safeinsights/canopycms/blob/18d436fe91546aabb30da8efa1397046b65681dc/docs/deploying-to-aws.md#first-deploy-checklist).
|
|
768
926
|
|
|
769
927
|
#### `canopycms-cdk`: `CanopyCmsService.attachTo`, and editor response headers — **behaviour change if you frame the CMS**
|
|
770
928
|
|
|
@@ -775,7 +933,7 @@ response headers policy. `CanopyCmsDistribution` sends the same headers: `frame-
|
|
|
775
933
|
`X-Frame-Options: SAMEORIGIN`, `nosniff`, HSTS and `X-Robots-Tag: noindex`. Unless your app sends
|
|
776
934
|
its own framing headers, no other origin can frame the editor or any page the CMS domain serves. Every such page is
|
|
777
935
|
marked `noindex`. The editor's default preview is same-origin and unaffected. See
|
|
778
|
-
[Serving the editor from a distribution you already own](https://github.com/safeinsights/canopycms/blob/
|
|
936
|
+
[Serving the editor from a distribution you already own](https://github.com/safeinsights/canopycms/blob/18d436fe91546aabb30da8efa1397046b65681dc/docs/deploying-to-aws.md#serving-the-editor-from-a-distribution-you-already-own).
|
|
779
937
|
|
|
780
938
|
**To adopt.** If you wired the Function URL into your own distribution by hand, delete those
|
|
781
939
|
behaviors and call `attachTo`, passing your CMS build's `assetPrefix` as `editorAssetPrefix` and a
|
|
@@ -951,7 +1109,7 @@ one the exclusions leave out. A throw or any other return is logged and treated
|
|
|
951
1109
|
**To adopt.** If your site's routes, sitemap or bylines decide that some entries have no page,
|
|
952
1110
|
apply the same rule here, for example `referenceLink: (target, { body }) =>
|
|
953
1111
|
!body?.trim() ? false : undefined` in `defineAIContentConfig` from `canopycms/ai`. See
|
|
954
|
-
[AI Content Configuration](https://github.com/safeinsights/canopycms/blob/
|
|
1112
|
+
[AI Content Configuration](https://github.com/safeinsights/canopycms/blob/18d436fe91546aabb30da8efa1397046b65681dc/README.md#ai-content-configuration).
|
|
955
1113
|
|
|
956
1114
|
**Now deletable.** A `fieldTransforms` entry that re-renders a reference field only to drop or
|
|
957
1115
|
change its link.
|
|
@@ -1026,7 +1184,7 @@ _First in int.115._
|
|
|
1026
1184
|
entry the base branch also changed, the "updated on the base branch" notice and the branch's
|
|
1027
1185
|
conflict count now stay until the branch merges, so a reviewer still sees which entries replaced a
|
|
1028
1186
|
base change. They used to clear on the next sync, about five minutes later. README's new [Drafts
|
|
1029
|
-
and Unpublishing](https://github.com/safeinsights/canopycms/blob/
|
|
1187
|
+
and Unpublishing](https://github.com/safeinsights/canopycms/blob/18d436fe91546aabb30da8efa1397046b65681dc/README.md#drafts-and-unpublishing) section covers long-lived branches and
|
|
1030
1188
|
unpublishing.
|
|
1031
1189
|
|
|
1032
1190
|
#### The editor calls the content drawer "All content"
|
|
@@ -1338,7 +1496,7 @@ editor carries an unsaved draft of a stamped entry onto its stamped version.
|
|
|
1338
1496
|
The flag is refused off a top-level `datetime`, on `list: true`, and with `required: true`.
|
|
1339
1497
|
|
|
1340
1498
|
**To adopt.** Add `stampOnPublish: true` to the date field your site sorts or labels by, such as
|
|
1341
|
-
`{ name: 'publishedAt', type: 'datetime', stampOnPublish: true }`. See [Stamping a publication date](https://github.com/safeinsights/canopycms/blob/
|
|
1499
|
+
`{ name: 'publishedAt', type: 'datetime', stampOnPublish: true }`. See [Stamping a publication date](https://github.com/safeinsights/canopycms/blob/18d436fe91546aabb30da8efa1397046b65681dc/README.md#stamping-a-publication-date).
|
|
1342
1500
|
|
|
1343
1501
|
**Now deletable.** A build step or hook that writes a missing publication date into new entries.
|
|
1344
1502
|
|
|
@@ -1385,7 +1543,7 @@ preview/form divider is now keyboard-resizable within the same 15–85% the spli
|
|
|
1385
1543
|
stored at, and `react-split-pane` is no longer a dependency.
|
|
1386
1544
|
`EditorPanes`, `EditorPanesProps`, the `PaneLayout` type and the `SPLIT_PERCENT_*` and `DEFAULT_*_SPLIT_PERCENT` constants are
|
|
1387
1545
|
no longer exported from `canopycms/client`. See
|
|
1388
|
-
[Your root layout](https://github.com/safeinsights/canopycms/blob/
|
|
1546
|
+
[Your root layout](https://github.com/safeinsights/canopycms/blob/18d436fe91546aabb30da8efa1397046b65681dc/README.md#editor-customization).
|
|
1389
1547
|
|
|
1390
1548
|
**To adopt.** Nothing, unless you import `EditorPanes` or those constants: render `CanopyEditor`
|
|
1391
1549
|
instead, which lays out its own panes. Hiding your site chrome on the editor route is now
|
|
@@ -1496,7 +1654,7 @@ never ended. `canopycms-auth-clerk` skips it while the editor is mounted, and ex
|
|
|
1496
1654
|
**To adopt.** Nothing for the editor, if your edit page uses `useClerkAuthConfig()` or
|
|
1497
1655
|
`ClerkSignIn`. If your CMS build renders `<SignIn>`, `UserButton` or `OrganizationSwitcher` on your
|
|
1498
1656
|
own pages, mount the hook as in
|
|
1499
|
-
[Clerk components on your own pages](https://github.com/safeinsights/canopycms/blob/
|
|
1657
|
+
[Clerk components on your own pages](https://github.com/safeinsights/canopycms/blob/18d436fe91546aabb30da8efa1397046b65681dc/packages/canopycms-auth-clerk/README.md#clerk-components-on-your-own-pages).
|
|
1500
1658
|
Your own Server Actions in the CMS build still 403 behind OAC.
|
|
1501
1659
|
|
|
1502
1660
|
**Now deletable.** Any local patch of `window.__internal_onBeforeSetActive` (or 6.x's
|
|
@@ -1537,12 +1695,12 @@ fast naming the ARN, the field and the keys present, never a value.
|
|
|
1537
1695
|
**To adopt.** Nothing, unless one of those secrets holds a JSON document: then set the matching
|
|
1538
1696
|
prop. The scaffolded stack fills them from the repository _variables_
|
|
1539
1697
|
`CANOPY_GITHUB_TOKEN_SECRET_JSON_FIELD` and `CLERK_SECRET_KEY_SECRET_JSON_FIELD`
|
|
1540
|
-
([why the prefix](https://github.com/safeinsights/canopycms/blob/
|
|
1698
|
+
([why the prefix](https://github.com/safeinsights/canopycms/blob/18d436fe91546aabb30da8efa1397046b65681dc/docs/deploying-to-aws.md#repository-secrets-and-variables)); a stack scaffolded earlier
|
|
1541
1699
|
adds the props to `infrastructure/bin/app.ts` and `infrastructure/lib/cms-stack.ts` and the two `env`
|
|
1542
1700
|
lines to `.github/workflows/deploy-cms.yml`, or re-runs the generator and diffs. `cdk synth` refuses a `…JsonField` prop without its `…SecretArn`, and an ARN carrying the ECS `:KEY::` suffix
|
|
1543
1701
|
(also in `secretsArns`). Don't use CDK's `secretValueFromJson`: it resolves the plaintext into the deployed
|
|
1544
1702
|
resource's configuration, readable by anyone who can describe it. Only `CLERK_SECRET_KEY` goes through Secrets Manager; `CLERK_JWT_KEY` and the publishable
|
|
1545
|
-
key are public material ([Security Model](https://github.com/safeinsights/canopycms/blob/
|
|
1703
|
+
key are public material ([Security Model](https://github.com/safeinsights/canopycms/blob/18d436fe91546aabb30da8efa1397046b65681dc/docs/deploying-to-aws.md#security-model)).
|
|
1546
1704
|
|
|
1547
1705
|
**Now deletable.** A wrapper that fetches the secret, parses it and re-exports one field into the
|
|
1548
1706
|
worker's environment, such as a `jq` step in user data or a wrapper entrypoint around
|
|
@@ -1554,7 +1712,7 @@ worker's environment, such as a `jq` step in user data or a wrapper entrypoint a
|
|
|
1554
1712
|
`githubToken` is not deprecated and stays the documented default; `canopycms` neither depends on
|
|
1555
1713
|
nor imports `@octokit/auth-app`. Register one App per site, not one shared across repositories:
|
|
1556
1714
|
anyone holding an App's key can mint a token for any of its installations
|
|
1557
|
-
([why](https://github.com/safeinsights/canopycms/blob/
|
|
1715
|
+
([why](https://github.com/safeinsights/canopycms/blob/18d436fe91546aabb30da8efa1397046b65681dc/ARCHITECTURE.md#why-one-github-app-per-site-not-one-shared-across-an-organisation)).
|
|
1558
1716
|
|
|
1559
1717
|
**To adopt with `canopycms-cdk`** (existing stacks need no edit). `CanopyCmsServiceProps` takes
|
|
1560
1718
|
`githubAppId`, `githubAppInstallationId`, `githubAppPrivateKeySecretArn` and
|
|
@@ -1567,7 +1725,7 @@ anyone holding an App's key can mint a token for any of its installations
|
|
|
1567
1725
|
`verify` checks an existing installation's permissions: run it, since an App missing a
|
|
1568
1726
|
permission only shows up later, as `sync-failed`. `create` needs an interactive terminal and
|
|
1569
1727
|
never edits an existing JSON secret (create one and point the JSON-field prop at it)
|
|
1570
|
-
([details](https://github.com/safeinsights/canopycms/blob/
|
|
1728
|
+
([details](https://github.com/safeinsights/canopycms/blob/18d436fe91546aabb30da8efa1397046b65681dc/docs/deploying-to-aws.md#register-it-with-canopycms-init-github-app)).
|
|
1571
1729
|
2. Set the three props and **remove `githubTokenSecretArn`** (with its JSON field). A partial set
|
|
1572
1730
|
of the three is refused at synth, and so is an App alongside a token.
|
|
1573
1731
|
3. In the generated workflow, store them as `CANOPY_GITHUB_APP_ID`,
|
|
@@ -1578,7 +1736,7 @@ anyone holding an App's key can mint a token for any of its installations
|
|
|
1578
1736
|
|
|
1579
1737
|
The private key is ARN-only; passing the key itself is refused at synth. Its ARN joins the worker's
|
|
1580
1738
|
IAM policy automatically, so you need not add it to `secretsArns`. See
|
|
1581
|
-
[Authenticating as a GitHub App](https://github.com/safeinsights/canopycms/blob/
|
|
1739
|
+
[Authenticating as a GitHub App](https://github.com/safeinsights/canopycms/blob/18d436fe91546aabb30da8efa1397046b65681dc/docs/deploying-to-aws.md#authenticating-as-a-github-app).
|
|
1582
1740
|
|
|
1583
1741
|
```bash
|
|
1584
1742
|
canopycms init-github-app create -- \
|
|
@@ -1626,7 +1784,7 @@ downloads the `.pem` from the App's settings page.
|
|
|
1626
1784
|
|
|
1627
1785
|
**What changed.** The worker re-reads a Secrets Manager secret (the GitHub token or the Clerk secret
|
|
1628
1786
|
key) when the operation using it fails. Timings, costs and the store-before-revoke order are in
|
|
1629
|
-
[Rotating a secret](https://github.com/safeinsights/canopycms/blob/
|
|
1787
|
+
[Rotating a secret](https://github.com/safeinsights/canopycms/blob/18d436fe91546aabb30da8efa1397046b65681dc/docs/deploying-to-aws.md#rotating-a-secret).
|
|
1630
1788
|
|
|
1631
1789
|
**To adopt.** Nothing for credentials from `*_SECRET_ARN`, which is every scaffolded deployment. A
|
|
1632
1790
|
GitHub App private key is still read only at boot: store the new key, replace the instance, and
|
|
@@ -1680,12 +1838,12 @@ also check the bucket policy for its grant.
|
|
|
1680
1838
|
5. `withCanopy()` adds sharp's libvips to Next's file tracing (not for a static export) and, on
|
|
1681
1839
|
Next 16 and later, sets `turbopack: {}` when your config has neither `turbopack` nor your own
|
|
1682
1840
|
`webpack` and it can read your Next version. A webpack build still fails its image transforms
|
|
1683
|
-
([Dual Build Support](https://github.com/safeinsights/canopycms/blob/
|
|
1841
|
+
([Dual Build Support](https://github.com/safeinsights/canopycms/blob/18d436fe91546aabb30da8efa1397046b65681dc/docs/deploying-to-aws.md#dual-build-support)).
|
|
1684
1842
|
|
|
1685
1843
|
**Breaking:** a stack setting `platform` on `fromImageAsset` without `architecture` gets an arm64
|
|
1686
1844
|
function while `platform` still decides the image, so `Platform.LINUX_AMD64` builds an image the
|
|
1687
1845
|
function cannot run. A stack setting neither moves to arm64 with a matching image, built under QEMU
|
|
1688
|
-
on an x86 host ([Where the image is built](https://github.com/safeinsights/canopycms/blob/
|
|
1846
|
+
on an x86 host ([Where the image is built](https://github.com/safeinsights/canopycms/blob/18d436fe91546aabb30da8efa1397046b65681dc/docs/deploying-to-aws.md#where-the-image-is-built)).
|
|
1689
1847
|
|
|
1690
1848
|
**To adopt.**
|
|
1691
1849
|
|
|
@@ -1714,7 +1872,7 @@ reason; `platform` on `fromImageAsset`; and, with `withCanopy()`, a hand-written
|
|
|
1714
1872
|
|
|
1715
1873
|
**What changed.** `media.uploadUrl` (s3 adapter; an absolute http(s) URL or a site-relative path)
|
|
1716
1874
|
replaces the `url` that `beginUpload()` returns, leaving the presign's `fields` untouched, so
|
|
1717
|
-
uploads can be same-origin. See [Media Configuration](https://github.com/safeinsights/canopycms/blob/
|
|
1875
|
+
uploads can be same-origin. See [Media Configuration](https://github.com/safeinsights/canopycms/blob/18d436fe91546aabb30da8efa1397046b65681dc/README.md#media-configuration) for the
|
|
1718
1876
|
CloudFront behavior it expects.
|
|
1719
1877
|
|
|
1720
1878
|
**To adopt.** Optional. Set it from an environment variable: a site-relative value works only where
|
|
@@ -1739,7 +1897,7 @@ needs `lazyPublicTransforms: true`) let you pass a deterministically named role,
|
|
|
1739
1897
|
bucket's stack computes `arn:aws:iam::<account>:role/<name>` from literals instead of a
|
|
1740
1898
|
`Fn::GetStackOutput` reference only the CDK CLI resolves. The constructs re-attach
|
|
1741
1899
|
`AWSLambdaBasicExecutionRole` (and the VPC policy) that `lambda.Function` drops from a role you
|
|
1742
|
-
pass. See [Cross-account asset bucket](https://github.com/safeinsights/canopycms/blob/
|
|
1900
|
+
pass. See [Cross-account asset bucket](https://github.com/safeinsights/canopycms/blob/18d436fe91546aabb30da8efa1397046b65681dc/docs/deploying-to-aws.md#cross-account-asset-bucket).
|
|
1743
1901
|
|
|
1744
1902
|
**To adopt.** Optional:
|
|
1745
1903
|
|
|
@@ -1849,7 +2007,7 @@ public JWKS PEM, used only to verify signatures.
|
|
|
1849
2007
|
to variables (Settings → Secrets and variables → Actions → Variables); `bin/app.ts` refuses the
|
|
1850
2008
|
deploy at synth while it is unset. Check that `bin/app.ts` passes `CLERK_SECRET_KEY` as
|
|
1851
2009
|
`clerkSecretKeySecretArn` (read by the worker), never in the Lambda's `environment`, unless you keep
|
|
1852
|
-
`clerkMiddleware` ([Security Model](https://github.com/safeinsights/canopycms/blob/
|
|
2010
|
+
`clerkMiddleware` ([Security Model](https://github.com/safeinsights/canopycms/blob/18d436fe91546aabb30da8efa1397046b65681dc/docs/deploying-to-aws.md#security-model)).
|
|
1853
2011
|
|
|
1854
2012
|
#### `readByUrlPath` answers only where `listEntries` publishes — **breaking (routing)**
|
|
1855
2013
|
|
|
@@ -1948,7 +2106,7 @@ basePath: process.env.NEXT_PUBLIC_BASE_PATH,
|
|
|
1948
2106
|
Then pass `baseUrl` to `assetUrl` only if Next serves `/assets` (local adapter, `next dev`, S3 with
|
|
1949
2107
|
no distribution): `assetUrl(image, { width: 960, baseUrl: BASE_PATH })`. Assets on CloudFront via
|
|
1950
2108
|
`AssetSupport` stay at the distribution root; pass no `baseUrl` (mount table under "Where `/assets`
|
|
1951
|
-
is mounted" in [Media Configuration](https://github.com/safeinsights/canopycms/blob/
|
|
2109
|
+
is mounted" in [Media Configuration](https://github.com/safeinsights/canopycms/blob/18d436fe91546aabb30da8efa1397046b65681dc/README.md#media-configuration)). Two traps:
|
|
1952
2110
|
|
|
1953
2111
|
- Don't pass a deployment `basePath` to `contentStaticParams({ basePath })`; that option filters by
|
|
1954
2112
|
a nested route prefix and emits zero params, building green.
|
|
@@ -2107,7 +2265,7 @@ Under `exactOptionalPropertyTypes: true`, omit keys instead of assigning `undefi
|
|
|
2107
2265
|
`withTrailingSlash` and `isAbsoluteUrl` from `canopycms/server`; `defineSeoFieldGroup()` from
|
|
2108
2266
|
`canopycms`; `generateContentSitemap` and `entryToMetadata` from `canopycms-next`, bound on
|
|
2109
2267
|
`createNextCanopyContext`'s result. See
|
|
2110
|
-
[Sitemap and SEO Metadata](https://github.com/safeinsights/canopycms/blob/
|
|
2268
|
+
[Sitemap and SEO Metadata](https://github.com/safeinsights/canopycms/blob/18d436fe91546aabb30da8efa1397046b65681dc/README.md#sitemap-and-seo-metadata). Every routable entry type is in
|
|
2111
2269
|
the sitemap unless `exclude`d or `noindex`; one `noindex` predicate drives both robots metadata and
|
|
2112
2270
|
sitemap exclusion. `trailingSlash` is never inferred. `lastModified` defaults to `updatedAt`, a
|
|
2113
2271
|
filesystem mtime. An empty SEO field counts as unset. `siteUrl` must be absolute, colliding URLs are
|
|
@@ -2164,7 +2322,7 @@ underscore-prefixed files are skipped.
|
|
|
2164
2322
|
|
|
2165
2323
|
**What changed.** New scaffolds write `defaultBranchAccess: 'deny'` and
|
|
2166
2324
|
`defaultPathAccess: { read: 'allow' }`
|
|
2167
|
-
([Public read on server deployments](https://github.com/safeinsights/canopycms/blob/
|
|
2325
|
+
([Public read on server deployments](https://github.com/safeinsights/canopycms/blob/18d436fe91546aabb30da8efa1397046b65681dc/README.md#public-read-on-server-deployments)).
|
|
2168
2326
|
|
|
2169
2327
|
**To adopt.** An older scaffold's `defaultBranchAccess: 'allow'` is wider than recommended;
|
|
2170
2328
|
consider `'deny'`. If you deleted `defaultPathAccess: { read: 'allow' }`, anonymous visitors get no content until you
|
|
@@ -2217,7 +2375,7 @@ re-checked an entry's type (a `switch` on `meta.entryType` can merge them into o
|
|
|
2217
2375
|
**What changed.** `BlockComponentRegistry<Blocks>` (types only, from `canopycms`; `BlockValueOf<Blocks, 'hero'>`
|
|
2218
2376
|
gives one template's value type) requires exactly
|
|
2219
2377
|
one component per block template name when written as an object literal. See
|
|
2220
|
-
[Block Component Registries](https://github.com/safeinsights/canopycms/blob/
|
|
2378
|
+
[Block Component Registries](https://github.com/safeinsights/canopycms/blob/18d436fe91546aabb30da8efa1397046b65681dc/README.md#block-component-registries) and
|
|
2221
2379
|
`apps/example1/app/components/PostView.tsx`.
|
|
2222
2380
|
|
|
2223
2381
|
```ts
|
|
@@ -2239,7 +2397,7 @@ templates against the schema.
|
|
|
2239
2397
|
|
|
2240
2398
|
**What changed.** Spreading a `const` field array into several schemas, and nesting
|
|
2241
2399
|
`defineInlineFieldGroup()` inside a block template, are documented
|
|
2242
|
-
([Reusable Field Fragments](https://github.com/safeinsights/canopycms/blob/
|
|
2400
|
+
([Reusable Field Fragments](https://github.com/safeinsights/canopycms/blob/18d436fe91546aabb30da8efa1397046b65681dc/README.md#reusable-field-fragments)); `defineFieldFragment()` is an
|
|
2243
2401
|
identity helper for them.
|
|
2244
2402
|
|
|
2245
2403
|
```ts
|
|
@@ -2258,7 +2416,7 @@ field by composing from the same `const` field object.
|
|
|
2258
2416
|
A block template holding a `reference` field is a shared block; `read()`/`readByUrlPath()` resolve
|
|
2259
2417
|
it, and listings do with
|
|
2260
2418
|
[`resolveReferences`](#listings-resolve-references-and-a-resolved-reference-carries-urlpath-and-optionally-its-body-16--breaking-type-level)
|
|
2261
|
-
(0.0.64). See [Shared / Referenced Blocks](https://github.com/safeinsights/canopycms/blob/
|
|
2419
|
+
(0.0.64). See [Shared / Referenced Blocks](https://github.com/safeinsights/canopycms/blob/18d436fe91546aabb30da8efa1397046b65681dc/README.md#shared--referenced-blocks).
|
|
2262
2420
|
|
|
2263
2421
|
**Now deletable.** A second `read()` in page code to unwrap a shared block's reference.
|
|
2264
2422
|
|
|
@@ -2280,7 +2438,7 @@ Not retro-documented, apart from these:
|
|
|
2280
2438
|
|
|
2281
2439
|
#### The registry is keyed by entry-type name (0.0.42)
|
|
2282
2440
|
|
|
2283
|
-
**What changed.** `createEntrySchemaRegistry` keys are the entry-type names that `.collection.json` files name in `entry.schema`, and `EntryTypesFromRegistry` derives the typed entry-type map from them. Schema-variable keys (`{ postSchema }`) still work but derive nothing; [README's registry convention](https://github.com/safeinsights/canopycms/blob/
|
|
2441
|
+
**What changed.** `createEntrySchemaRegistry` keys are the entry-type names that `.collection.json` files name in `entry.schema`, and `EntryTypesFromRegistry` derives the typed entry-type map from them. Schema-variable keys (`{ postSchema }`) still work but derive nothing; [README's registry convention](https://github.com/safeinsights/canopycms/blob/18d436fe91546aabb30da8efa1397046b65681dc/README.md#convention-why-key-the-registry-by-entry-type-name) says when to keep them.
|
|
2284
2442
|
|
|
2285
2443
|
**To adopt.**
|
|
2286
2444
|
|
package/dist/api/branch.d.ts
CHANGED
|
@@ -11,7 +11,7 @@ import type { UserProfile } from '../auth/types.js';
|
|
|
11
11
|
* symmetric: the editor client now defaults every missing flag fail-closed
|
|
12
12
|
* (`?? true`), so a NEW client talking to an OLD server that omits these
|
|
13
13
|
* fields degrades to fully locked -- read-only, Submit hidden, and (see
|
|
14
|
-
*
|
|
14
|
+
* `branchLockState`'s `branchDataUnavailable`) a "could not be loaded" status --
|
|
15
15
|
* rather than silently behaving as if nothing changed. That is by design:
|
|
16
16
|
* wire compatibility here means "doesn't break", not "behaves the same".
|
|
17
17
|
*/
|
|
@@ -22,7 +22,7 @@ export interface BranchListItem extends BranchMetadata {
|
|
|
22
22
|
* True when content writes are rejected -- base-branch read-only OR a status
|
|
23
23
|
* lock (submitted/approved/archived). The editor renders its locked state off
|
|
24
24
|
* this instead of re-deriving the status rule client-side; `readOnly` still
|
|
25
|
-
* distinguishes WHICH lock applies, for
|
|
25
|
+
* distinguishes WHICH lock applies, for the status copy.
|
|
26
26
|
*/
|
|
27
27
|
writeBlocked?: boolean;
|
|
28
28
|
/**
|
package/dist/cli/cli.js
CHANGED
|
@@ -1938,9 +1938,6 @@ var init_init = __esm({
|
|
|
1938
1938
|
supportsBranching() {
|
|
1939
1939
|
return true;
|
|
1940
1940
|
}
|
|
1941
|
-
supportsStatusBadge() {
|
|
1942
|
-
return true;
|
|
1943
|
-
}
|
|
1944
1941
|
supportsComments() {
|
|
1945
1942
|
return true;
|
|
1946
1943
|
}
|
|
@@ -1967,9 +1964,6 @@ var init_init = __esm({
|
|
|
1967
1964
|
supportsBranching() {
|
|
1968
1965
|
return true;
|
|
1969
1966
|
}
|
|
1970
|
-
supportsStatusBadge() {
|
|
1971
|
-
return true;
|
|
1972
|
-
}
|
|
1973
1967
|
supportsComments() {
|
|
1974
1968
|
return true;
|
|
1975
1969
|
}
|
|
@@ -8401,9 +8395,6 @@ var init_generate_ai_content = __esm({
|
|
|
8401
8395
|
supportsBranching() {
|
|
8402
8396
|
return true;
|
|
8403
8397
|
}
|
|
8404
|
-
supportsStatusBadge() {
|
|
8405
|
-
return true;
|
|
8406
|
-
}
|
|
8407
8398
|
supportsComments() {
|
|
8408
8399
|
return true;
|
|
8409
8400
|
}
|
|
@@ -8430,9 +8421,6 @@ var init_generate_ai_content = __esm({
|
|
|
8430
8421
|
supportsBranching() {
|
|
8431
8422
|
return true;
|
|
8432
8423
|
}
|
|
8433
|
-
supportsStatusBadge() {
|
|
8434
|
-
return true;
|
|
8435
|
-
}
|
|
8436
8424
|
supportsComments() {
|
|
8437
8425
|
return true;
|
|
8438
8426
|
}
|
|
@@ -15556,9 +15544,6 @@ var init_client_safe_strategy2 = __esm({
|
|
|
15556
15544
|
supportsBranching() {
|
|
15557
15545
|
return true;
|
|
15558
15546
|
}
|
|
15559
|
-
supportsStatusBadge() {
|
|
15560
|
-
return true;
|
|
15561
|
-
}
|
|
15562
15547
|
supportsComments() {
|
|
15563
15548
|
return true;
|
|
15564
15549
|
}
|
|
@@ -15585,9 +15570,6 @@ var init_client_safe_strategy2 = __esm({
|
|
|
15585
15570
|
supportsBranching() {
|
|
15586
15571
|
return true;
|
|
15587
15572
|
}
|
|
15588
|
-
supportsStatusBadge() {
|
|
15589
|
-
return true;
|
|
15590
|
-
}
|
|
15591
15573
|
supportsComments() {
|
|
15592
15574
|
return true;
|
|
15593
15575
|
}
|
|
@@ -1025,9 +1025,6 @@ var init_client_safe_strategy = __esm({
|
|
|
1025
1025
|
supportsBranching() {
|
|
1026
1026
|
return true;
|
|
1027
1027
|
}
|
|
1028
|
-
supportsStatusBadge() {
|
|
1029
|
-
return true;
|
|
1030
|
-
}
|
|
1031
1028
|
supportsComments() {
|
|
1032
1029
|
return true;
|
|
1033
1030
|
}
|
|
@@ -1054,9 +1051,6 @@ var init_client_safe_strategy = __esm({
|
|
|
1054
1051
|
supportsBranching() {
|
|
1055
1052
|
return true;
|
|
1056
1053
|
}
|
|
1057
|
-
supportsStatusBadge() {
|
|
1058
|
-
return true;
|
|
1059
|
-
}
|
|
1060
1054
|
supportsComments() {
|
|
1061
1055
|
return true;
|
|
1062
1056
|
}
|
package/dist/cli/init.js
CHANGED
|
@@ -1512,9 +1512,6 @@ var ProdClientSafeStrategy = class {
|
|
|
1512
1512
|
supportsBranching() {
|
|
1513
1513
|
return true;
|
|
1514
1514
|
}
|
|
1515
|
-
supportsStatusBadge() {
|
|
1516
|
-
return true;
|
|
1517
|
-
}
|
|
1518
1515
|
supportsComments() {
|
|
1519
1516
|
return true;
|
|
1520
1517
|
}
|
|
@@ -1541,9 +1538,6 @@ var DevClientSafeStrategy = class {
|
|
|
1541
1538
|
supportsBranching() {
|
|
1542
1539
|
return true;
|
|
1543
1540
|
}
|
|
1544
|
-
supportsStatusBadge() {
|
|
1545
|
-
return true;
|
|
1546
|
-
}
|
|
1547
1541
|
supportsComments() {
|
|
1548
1542
|
return true;
|
|
1549
1543
|
}
|
|
@@ -70,6 +70,8 @@ export interface BranchManagerProps {
|
|
|
70
70
|
currentBranchName?: string;
|
|
71
71
|
/** Why the open branch's Submit or Withdraw must wait, such as a Save all still writing it. */
|
|
72
72
|
currentWorkflowBlockedReason?: string;
|
|
73
|
+
/** Opens on the new-branch form, its name field focused, as New branch… in the branch bar asks. */
|
|
74
|
+
startCreating?: boolean;
|
|
73
75
|
onSelect?: (name: string) => void;
|
|
74
76
|
/** Awaited before the spinner starts, so a confirmation it shows never reads as a hung create. `false` abandons the create. */
|
|
75
77
|
onBeforeCreate?: () => Promise<boolean>;
|