canopycms 0.3.1 → 0.3.2

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 CHANGED
@@ -5,9 +5,9 @@ packages release together, at one version.
5
5
 
6
6
  ## This build
7
7
 
8
- Version `0.3.1`, built from [`2924058`](https://github.com/safeinsights/canopycms/tree/2924058c932bb84bb07466ecaab6562d46c8825c).
8
+ Version `0.3.2`, built from [`cb2de67`](https://github.com/safeinsights/canopycms/tree/cb2de67d9d4750e462d2cbb636433dfb0ba2d34d).
9
9
 
10
- Its entries are [0.3.1](#031), under **Released**.
10
+ Its entries are [0.3.2](#032), 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/2924058c932bb84bb07466ecaab6562d46c8825c/.changeset/README.md) until a stable release
27
+ every entry written since is a file in [`.changeset/`](https://github.com/safeinsights/canopycms/blob/cb2de67d9d4750e462d2cbb636433dfb0ba2d34d/.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,17 @@ entries under **Released**.
62
62
 
63
63
  ## Released
64
64
 
65
+ ### 0.3.2
66
+
67
+ #### The content panel's header lines up with the entry header
68
+
69
+ <!-- changeset: shell-header-heights -->
70
+
71
+ _First in 0.3.2._
72
+
73
+ **What changed.** The content panel's header and the entry header beside it now share one fixed
74
+ height, so their bottom borders line up whatever the height of the controls inside each.
75
+
65
76
  ### 0.3.1
66
77
 
67
78
  #### The branch list shows exactly the branches you can open
@@ -444,7 +455,7 @@ URL.
444
455
  2. For a branch preview: wrap views with `withCanopyPreview` in a `'use client'` module, add
445
456
  `app/preview/[[...path]]/page.server.tsx`, set `editor.previewPrefix: '/preview'`, and serve that
446
457
  route with `frame-ancestors 'self'`, not `X-Frame-Options: DENY` (see
447
- [Live Preview](https://github.com/safeinsights/canopycms/blob/2924058c932bb84bb07466ecaab6562d46c8825c/README.md#live-preview)).
458
+ [Live Preview](https://github.com/safeinsights/canopycms/blob/cb2de67d9d4750e462d2cbb636433dfb0ba2d34d/README.md#live-preview)).
448
459
  3. A test reading view content from the route's server HTML must load the page in a browser.
449
460
  Server output rendered during a preview request carries the signed-in asset prefix; keep it out
450
461
  of cross-request caches (`unstable_cache`, module memos).
@@ -459,7 +470,7 @@ kept site styles ahead of Mantine's in the preview.
459
470
  server components. A string path marks the form's spelling (`'a.0.b'` marks `a[0].b`), and an empty
460
471
  path marks nothing. The editor counts and logs marks naming no field. `createEntrySchemaRegistry`
461
472
  refuses a field name that is empty, all digits or contains `.`, `[` or `]`. See
462
- [Live Preview](https://github.com/safeinsights/canopycms/blob/2924058c932bb84bb07466ecaab6562d46c8825c/README.md#live-preview).
473
+ [Live Preview](https://github.com/safeinsights/canopycms/blob/cb2de67d9d4750e462d2cbb636433dfb0ba2d34d/README.md#live-preview).
463
474
 
464
475
  **To adopt.** Fix each path that stops compiling; the error lists valid ones. Rewrite computed paths
465
476
  as literal segments, or type that component's prop as plain `FieldProps`. Pass `fieldProps` as
@@ -541,7 +552,7 @@ or a failed render) renders as its plain text, with no URL; any other form of th
541
552
  fields are nested or renamed, pass the AI config's `seo` the same object you pass
542
553
  `createNextCanopyContext({ seo })`, so the sitemap and AI content read the flag from the same
543
554
  place. A field that links to a hidden section by plain URL needs a field transform; the README
544
- shows [the recipe](https://github.com/safeinsights/canopycms/blob/2924058c932bb84bb07466ecaab6562d46c8825c/README.md#ai-content-configuration).
555
+ shows [the recipe](https://github.com/safeinsights/canopycms/blob/cb2de67d9d4750e462d2cbb636433dfb0ba2d34d/README.md#ai-content-configuration).
545
556
 
546
557
  **Now deletable.** An `exclude.where` that re-read the `noindex` flag by hand.
547
558
 
@@ -563,7 +574,7 @@ A `markdown` field with `renderAs: 'mdx'` is checked as MDX, and `mdxAllow` narr
563
574
  field or site-wide. New: field options `renderAs`, `mdxAllow`; config key `mdxAllow`; type
564
575
  `MdxAllowlist`. (int.110) A component prop allowance can be `'string'` (or
565
576
  `{ type: 'string', maxLength }`): a quoted value only, never bare or `{…}`. See
566
- [MDX content cannot run code](https://github.com/safeinsights/canopycms/blob/2924058c932bb84bb07466ecaab6562d46c8825c/README.md#mdx-content-cannot-run-code).
577
+ [MDX content cannot run code](https://github.com/safeinsights/canopycms/blob/cb2de67d9d4750e462d2cbb636433dfb0ba2d34d/README.md#mdx-content-cannot-run-code).
567
578
 
568
579
  **To adopt.** Set `renderAs: 'mdx'` on each `markdown` field your site compiles as MDX, and
569
580
  `mdxAllow` to what your renderer takes. Set `executable: true` only on a field whose editors you
@@ -700,7 +711,7 @@ a format check.
700
711
 
701
712
  - (int.93) Submit commits gain an `Edited-by: Name (id)` trailer; PR bodies gain a section that
702
713
  re-submits replace, keeping human text. Options: `gitEditedByTrailers`, `gitCoAuthoredByTrailers`
703
- ([reference](https://github.com/safeinsights/canopycms/blob/2924058c932bb84bb07466ecaab6562d46c8825c/README.md#definecanopyconfig-options)).
714
+ ([reference](https://github.com/safeinsights/canopycms/blob/cb2de67d9d4750e462d2cbb636433dfb0ba2d34d/README.md#definecanopyconfig-options)).
704
715
  - (int.110) Submit-commit trailers name every user who saved since the last submit commit, and
705
716
  the PR-body section every user who edited the branch, not only the submitter; settings commits
706
717
  (permissions, groups) carry the acting user's trailer.
@@ -724,7 +735,7 @@ saves only push the branch, and no failing PR task lands in System health.
724
735
  that entry type goes unavailable: the editor says so, and its entries answer 503 with
725
736
  `code: 'SCHEMA_UNAVAILABLE'`. Builds, static deploys and `generate-ai-content` still fail. The
726
737
  worker holds the base branch for up to 30 minutes while that lasts; see
727
- [New schemas wait for the editor deploy](https://github.com/safeinsights/canopycms/blob/2924058c932bb84bb07466ecaab6562d46c8825c/docs/deploying-to-aws.md#new-schemas-wait-for-the-editor-deploy).
738
+ [New schemas wait for the editor deploy](https://github.com/safeinsights/canopycms/blob/cb2de67d9d4750e462d2cbb636433dfb0ba2d34d/docs/deploying-to-aws.md#new-schemas-wait-for-the-editor-deploy).
728
739
  Public types gain optional `unavailable` on `EntryTypeConfig` and `FlatSchemaItem`, optional
729
740
  `ApiResponse.code`, and a required `SchemaResolutionResult.issues`.
730
741
 
@@ -762,7 +773,7 @@ hang until the drain heartbeat lets termination continue. Its in-flight task is
762
773
  new stack needs no steps.
763
774
 
764
775
  **What changed.** (int.109) Detailed in
765
- [The worker instance](https://github.com/safeinsights/canopycms/blob/2924058c932bb84bb07466ecaab6562d46c8825c/docs/deploying-to-aws.md#the-worker-instance): IMDSv2 with a hop limit of 1; the
776
+ [The worker instance](https://github.com/safeinsights/canopycms/blob/cb2de67d9d4750e462d2cbb636433dfb0ba2d34d/docs/deploying-to-aws.md#the-worker-instance): IMDSv2 with a hop limit of 1; the
766
777
  bundle is one file whose sha256 user data checks, readable as that one object; a file-system policy
767
778
  refusing clients without TLS or IAM, replacing the worker's
768
779
  `AmazonElasticFileSystemClientReadWriteAccess`; an encrypted gp3 root volume; a boot-time upgrade to
@@ -816,10 +827,10 @@ failure and exits non-zero on `selfStopped`, with a code outside `RestartPrevent
816
827
  with its hash, as `worker/dist/index.js` and `index.js.sha256`. The default, `'asset'`, is
817
828
  unchanged.
818
829
  - `CanopyCmsService` alarms when the worker logs no git sync for 30 minutes. See
819
- [Worker-down alarm](https://github.com/safeinsights/canopycms/blob/2924058c932bb84bb07466ecaab6562d46c8825c/docs/deploying-to-aws.md#worker-down-alarm).
830
+ [Worker-down alarm](https://github.com/safeinsights/canopycms/blob/cb2de67d9d4750e462d2cbb636433dfb0ba2d34d/docs/deploying-to-aws.md#worker-down-alarm).
820
831
 
821
832
  **To adopt.** Optional. For parameter-only change sets, see
822
- [Rolling the worker from CI](https://github.com/safeinsights/canopycms/blob/2924058c932bb84bb07466ecaab6562d46c8825c/docs/deploying-to-aws.md#rolling-the-worker-from-ci). For the alarm, pass
833
+ [Rolling the worker from CI](https://github.com/safeinsights/canopycms/blob/cb2de67d9d4750e462d2cbb636433dfb0ba2d34d/docs/deploying-to-aws.md#rolling-the-worker-from-ci). For the alarm, pass
823
834
  `alarmTopic`.
824
835
 
825
836
  **Now deletable.** A manual `cdk deploy` after each canopycms bump whose only purpose is moving the
@@ -830,7 +841,7 @@ worker, and a hand-built alarm on the worker log group.
830
841
  **What changed.** (int.112) The boot's `dnf upgrade` could be OOM-killed on every retry. A 1 GiB
831
842
  swap file now goes on first; an upgrade that still fails starts the worker unpatched and notifies
832
843
  `alarmTopic` if set; a retried step names itself when it gives up. See
833
- [The worker instance](https://github.com/safeinsights/canopycms/blob/2924058c932bb84bb07466ecaab6562d46c8825c/docs/deploying-to-aws.md#the-worker-instance).
844
+ [The worker instance](https://github.com/safeinsights/canopycms/blob/cb2de67d9d4750e462d2cbb636433dfb0ba2d34d/docs/deploying-to-aws.md#the-worker-instance).
834
845
 
835
846
  **To adopt.** Deploy, which replaces the worker instance. The bundle needs none of this, so it is
836
847
  not Template first and the worker contract stays at 1.
@@ -896,7 +907,7 @@ and operations may reuse GitHub fetches under 30 seconds old.
896
907
 
897
908
  **To adopt.** Nothing. Seeding `remote.git` stages a copy of the repository beside the gateway's
898
909
  mirror, so the root volume needs room for two
899
- ([details](https://github.com/safeinsights/canopycms/blob/2924058c932bb84bb07466ecaab6562d46c8825c/docs/deploying-to-aws.md#the-worker-instance)).
910
+ ([details](https://github.com/safeinsights/canopycms/blob/cb2de67d9d4750e462d2cbb636433dfb0ba2d34d/docs/deploying-to-aws.md#the-worker-instance)).
900
911
 
901
912
  #### The worker follows a rebased or deleted GitHub branch
902
913
 
@@ -918,7 +929,7 @@ changes the template too (the fallback bundle's key and hash), so only the contr
918
929
  bundle-only roll is safe.
919
930
 
920
931
  **To adopt.** Parameter mode: gate bundle-only rolls on the contract
921
- ([recipe](https://github.com/safeinsights/canopycms/blob/2924058c932bb84bb07466ecaab6562d46c8825c/docs/deploying-to-aws.md#rolling-the-worker-from-ci)). The gate refuses a stack without the
932
+ ([recipe](https://github.com/safeinsights/canopycms/blob/cb2de67d9d4750e462d2cbb636433dfb0ba2d34d/docs/deploying-to-aws.md#rolling-the-worker-from-ci)). The gate refuses a stack without the
922
933
  `WorkerContract` output, so `cdk deploy` the template once, which adds it. A hand-installed unit
923
934
  copies its `Environment=CANOPYCMS_WORKER_CONTRACT=` line from `worker/canopy-worker.service`.
924
935
 
@@ -935,8 +946,8 @@ units from the bundle's contract: 2 gets the split, an older bundle the single u
935
946
  template, then roll the bundle; on an older template it stops with `template too old for this
936
947
  bundle`. Inspect EFS only through `sudo /opt/canopy-worker/canopy-inspect <command>`, never from a root shell. A hand install
937
948
  takes `worker/`'s three units and `gateway.env.example`
938
- ([steps](https://github.com/safeinsights/canopycms/blob/2924058c932bb84bb07466ecaab6562d46c8825c/docs/deploying-to-aws.md#installing-the-units-by-hand)). After the first deploy, run the
939
- [checklist](https://github.com/safeinsights/canopycms/blob/2924058c932bb84bb07466ecaab6562d46c8825c/docs/deploying-to-aws.md#first-deploy-checklist).
949
+ ([steps](https://github.com/safeinsights/canopycms/blob/cb2de67d9d4750e462d2cbb636433dfb0ba2d34d/docs/deploying-to-aws.md#installing-the-units-by-hand)). After the first deploy, run the
950
+ [checklist](https://github.com/safeinsights/canopycms/blob/cb2de67d9d4750e462d2cbb636433dfb0ba2d34d/docs/deploying-to-aws.md#first-deploy-checklist).
940
951
 
941
952
  #### `canopycms-cdk`: `CanopyCmsService.attachTo`, and editor response headers — **behaviour change if you frame the CMS**
942
953
 
@@ -947,7 +958,7 @@ response headers policy. `CanopyCmsDistribution` sends the same headers: `frame-
947
958
  `X-Frame-Options: SAMEORIGIN`, `nosniff`, HSTS and `X-Robots-Tag: noindex`. Unless your app sends
948
959
  its own framing headers, no other origin can frame the editor or any page the CMS domain serves. Every such page is
949
960
  marked `noindex`. The editor's default preview is same-origin and unaffected. See
950
- [Serving the editor from a distribution you already own](https://github.com/safeinsights/canopycms/blob/2924058c932bb84bb07466ecaab6562d46c8825c/docs/deploying-to-aws.md#serving-the-editor-from-a-distribution-you-already-own).
961
+ [Serving the editor from a distribution you already own](https://github.com/safeinsights/canopycms/blob/cb2de67d9d4750e462d2cbb636433dfb0ba2d34d/docs/deploying-to-aws.md#serving-the-editor-from-a-distribution-you-already-own).
951
962
 
952
963
  **To adopt.** If you wired the Function URL into your own distribution by hand, delete those
953
964
  behaviors and call `attachTo`, passing your CMS build's `assetPrefix` as `editorAssetPrefix` and a
@@ -1123,7 +1134,7 @@ one the exclusions leave out. A throw or any other return is logged and treated
1123
1134
  **To adopt.** If your site's routes, sitemap or bylines decide that some entries have no page,
1124
1135
  apply the same rule here, for example `referenceLink: (target, { body }) =>
1125
1136
  !body?.trim() ? false : undefined` in `defineAIContentConfig` from `canopycms/ai`. See
1126
- [AI Content Configuration](https://github.com/safeinsights/canopycms/blob/2924058c932bb84bb07466ecaab6562d46c8825c/README.md#ai-content-configuration).
1137
+ [AI Content Configuration](https://github.com/safeinsights/canopycms/blob/cb2de67d9d4750e462d2cbb636433dfb0ba2d34d/README.md#ai-content-configuration).
1127
1138
 
1128
1139
  **Now deletable.** A `fieldTransforms` entry that re-renders a reference field only to drop or
1129
1140
  change its link.
@@ -1198,7 +1209,7 @@ _First in int.115._
1198
1209
  entry the base branch also changed, the "updated on the base branch" notice and the branch's
1199
1210
  conflict count now stay until the branch merges, so a reviewer still sees which entries replaced a
1200
1211
  base change. They used to clear on the next sync, about five minutes later. README's new [Drafts
1201
- and Unpublishing](https://github.com/safeinsights/canopycms/blob/2924058c932bb84bb07466ecaab6562d46c8825c/README.md#drafts-and-unpublishing) section covers long-lived branches and
1212
+ and Unpublishing](https://github.com/safeinsights/canopycms/blob/cb2de67d9d4750e462d2cbb636433dfb0ba2d34d/README.md#drafts-and-unpublishing) section covers long-lived branches and
1202
1213
  unpublishing.
1203
1214
 
1204
1215
  #### The editor calls the content drawer "All content"
@@ -1510,7 +1521,7 @@ editor carries an unsaved draft of a stamped entry onto its stamped version.
1510
1521
  The flag is refused off a top-level `datetime`, on `list: true`, and with `required: true`.
1511
1522
 
1512
1523
  **To adopt.** Add `stampOnPublish: true` to the date field your site sorts or labels by, such as
1513
- `{ name: 'publishedAt', type: 'datetime', stampOnPublish: true }`. See [Stamping a publication date](https://github.com/safeinsights/canopycms/blob/2924058c932bb84bb07466ecaab6562d46c8825c/README.md#stamping-a-publication-date).
1524
+ `{ name: 'publishedAt', type: 'datetime', stampOnPublish: true }`. See [Stamping a publication date](https://github.com/safeinsights/canopycms/blob/cb2de67d9d4750e462d2cbb636433dfb0ba2d34d/README.md#stamping-a-publication-date).
1514
1525
 
1515
1526
  **Now deletable.** A build step or hook that writes a missing publication date into new entries.
1516
1527
 
@@ -1557,7 +1568,7 @@ preview/form divider is now keyboard-resizable within the same 15–85% the spli
1557
1568
  stored at, and `react-split-pane` is no longer a dependency.
1558
1569
  `EditorPanes`, `EditorPanesProps`, the `PaneLayout` type and the `SPLIT_PERCENT_*` and `DEFAULT_*_SPLIT_PERCENT` constants are
1559
1570
  no longer exported from `canopycms/client`. See
1560
- [Your root layout](https://github.com/safeinsights/canopycms/blob/2924058c932bb84bb07466ecaab6562d46c8825c/README.md#editor-customization).
1571
+ [Your root layout](https://github.com/safeinsights/canopycms/blob/cb2de67d9d4750e462d2cbb636433dfb0ba2d34d/README.md#editor-customization).
1561
1572
 
1562
1573
  **To adopt.** Nothing, unless you import `EditorPanes` or those constants: render `CanopyEditor`
1563
1574
  instead, which lays out its own panes. Hiding your site chrome on the editor route is now
@@ -1668,7 +1679,7 @@ never ended. `canopycms-auth-clerk` skips it while the editor is mounted, and ex
1668
1679
  **To adopt.** Nothing for the editor, if your edit page uses `useClerkAuthConfig()` or
1669
1680
  `ClerkSignIn`. If your CMS build renders `<SignIn>`, `UserButton` or `OrganizationSwitcher` on your
1670
1681
  own pages, mount the hook as in
1671
- [Clerk components on your own pages](https://github.com/safeinsights/canopycms/blob/2924058c932bb84bb07466ecaab6562d46c8825c/packages/canopycms-auth-clerk/README.md#clerk-components-on-your-own-pages).
1682
+ [Clerk components on your own pages](https://github.com/safeinsights/canopycms/blob/cb2de67d9d4750e462d2cbb636433dfb0ba2d34d/packages/canopycms-auth-clerk/README.md#clerk-components-on-your-own-pages).
1672
1683
  Your own Server Actions in the CMS build still 403 behind OAC.
1673
1684
 
1674
1685
  **Now deletable.** Any local patch of `window.__internal_onBeforeSetActive` (or 6.x's
@@ -1709,12 +1720,12 @@ fast naming the ARN, the field and the keys present, never a value.
1709
1720
  **To adopt.** Nothing, unless one of those secrets holds a JSON document: then set the matching
1710
1721
  prop. The scaffolded stack fills them from the repository _variables_
1711
1722
  `CANOPY_GITHUB_TOKEN_SECRET_JSON_FIELD` and `CLERK_SECRET_KEY_SECRET_JSON_FIELD`
1712
- ([why the prefix](https://github.com/safeinsights/canopycms/blob/2924058c932bb84bb07466ecaab6562d46c8825c/docs/deploying-to-aws.md#repository-secrets-and-variables)); a stack scaffolded earlier
1723
+ ([why the prefix](https://github.com/safeinsights/canopycms/blob/cb2de67d9d4750e462d2cbb636433dfb0ba2d34d/docs/deploying-to-aws.md#repository-secrets-and-variables)); a stack scaffolded earlier
1713
1724
  adds the props to `infrastructure/bin/app.ts` and `infrastructure/lib/cms-stack.ts` and the two `env`
1714
1725
  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
1715
1726
  (also in `secretsArns`). Don't use CDK's `secretValueFromJson`: it resolves the plaintext into the deployed
1716
1727
  resource's configuration, readable by anyone who can describe it. Only `CLERK_SECRET_KEY` goes through Secrets Manager; `CLERK_JWT_KEY` and the publishable
1717
- key are public material ([Security Model](https://github.com/safeinsights/canopycms/blob/2924058c932bb84bb07466ecaab6562d46c8825c/docs/deploying-to-aws.md#security-model)).
1728
+ key are public material ([Security Model](https://github.com/safeinsights/canopycms/blob/cb2de67d9d4750e462d2cbb636433dfb0ba2d34d/docs/deploying-to-aws.md#security-model)).
1718
1729
 
1719
1730
  **Now deletable.** A wrapper that fetches the secret, parses it and re-exports one field into the
1720
1731
  worker's environment, such as a `jq` step in user data or a wrapper entrypoint around
@@ -1726,7 +1737,7 @@ worker's environment, such as a `jq` step in user data or a wrapper entrypoint a
1726
1737
  `githubToken` is not deprecated and stays the documented default; `canopycms` neither depends on
1727
1738
  nor imports `@octokit/auth-app`. Register one App per site, not one shared across repositories:
1728
1739
  anyone holding an App's key can mint a token for any of its installations
1729
- ([why](https://github.com/safeinsights/canopycms/blob/2924058c932bb84bb07466ecaab6562d46c8825c/ARCHITECTURE.md#why-one-github-app-per-site-not-one-shared-across-an-organisation)).
1740
+ ([why](https://github.com/safeinsights/canopycms/blob/cb2de67d9d4750e462d2cbb636433dfb0ba2d34d/ARCHITECTURE.md#why-one-github-app-per-site-not-one-shared-across-an-organisation)).
1730
1741
 
1731
1742
  **To adopt with `canopycms-cdk`** (existing stacks need no edit). `CanopyCmsServiceProps` takes
1732
1743
  `githubAppId`, `githubAppInstallationId`, `githubAppPrivateKeySecretArn` and
@@ -1739,7 +1750,7 @@ anyone holding an App's key can mint a token for any of its installations
1739
1750
  `verify` checks an existing installation's permissions: run it, since an App missing a
1740
1751
  permission only shows up later, as `sync-failed`. `create` needs an interactive terminal and
1741
1752
  never edits an existing JSON secret (create one and point the JSON-field prop at it)
1742
- ([details](https://github.com/safeinsights/canopycms/blob/2924058c932bb84bb07466ecaab6562d46c8825c/docs/deploying-to-aws.md#register-it-with-canopycms-init-github-app)).
1753
+ ([details](https://github.com/safeinsights/canopycms/blob/cb2de67d9d4750e462d2cbb636433dfb0ba2d34d/docs/deploying-to-aws.md#register-it-with-canopycms-init-github-app)).
1743
1754
  2. Set the three props and **remove `githubTokenSecretArn`** (with its JSON field). A partial set
1744
1755
  of the three is refused at synth, and so is an App alongside a token.
1745
1756
  3. In the generated workflow, store them as `CANOPY_GITHUB_APP_ID`,
@@ -1750,7 +1761,7 @@ anyone holding an App's key can mint a token for any of its installations
1750
1761
 
1751
1762
  The private key is ARN-only; passing the key itself is refused at synth. Its ARN joins the worker's
1752
1763
  IAM policy automatically, so you need not add it to `secretsArns`. See
1753
- [Authenticating as a GitHub App](https://github.com/safeinsights/canopycms/blob/2924058c932bb84bb07466ecaab6562d46c8825c/docs/deploying-to-aws.md#authenticating-as-a-github-app).
1764
+ [Authenticating as a GitHub App](https://github.com/safeinsights/canopycms/blob/cb2de67d9d4750e462d2cbb636433dfb0ba2d34d/docs/deploying-to-aws.md#authenticating-as-a-github-app).
1754
1765
 
1755
1766
  ```bash
1756
1767
  canopycms init-github-app create -- \
@@ -1798,7 +1809,7 @@ downloads the `.pem` from the App's settings page.
1798
1809
 
1799
1810
  **What changed.** The worker re-reads a Secrets Manager secret (the GitHub token or the Clerk secret
1800
1811
  key) when the operation using it fails. Timings, costs and the store-before-revoke order are in
1801
- [Rotating a secret](https://github.com/safeinsights/canopycms/blob/2924058c932bb84bb07466ecaab6562d46c8825c/docs/deploying-to-aws.md#rotating-a-secret).
1812
+ [Rotating a secret](https://github.com/safeinsights/canopycms/blob/cb2de67d9d4750e462d2cbb636433dfb0ba2d34d/docs/deploying-to-aws.md#rotating-a-secret).
1802
1813
 
1803
1814
  **To adopt.** Nothing for credentials from `*_SECRET_ARN`, which is every scaffolded deployment. A
1804
1815
  GitHub App private key is still read only at boot: store the new key, replace the instance, and
@@ -1852,12 +1863,12 @@ also check the bucket policy for its grant.
1852
1863
  5. `withCanopy()` adds sharp's libvips to Next's file tracing (not for a static export) and, on
1853
1864
  Next 16 and later, sets `turbopack: {}` when your config has neither `turbopack` nor your own
1854
1865
  `webpack` and it can read your Next version. A webpack build still fails its image transforms
1855
- ([Dual Build Support](https://github.com/safeinsights/canopycms/blob/2924058c932bb84bb07466ecaab6562d46c8825c/docs/deploying-to-aws.md#dual-build-support)).
1866
+ ([Dual Build Support](https://github.com/safeinsights/canopycms/blob/cb2de67d9d4750e462d2cbb636433dfb0ba2d34d/docs/deploying-to-aws.md#dual-build-support)).
1856
1867
 
1857
1868
  **Breaking:** a stack setting `platform` on `fromImageAsset` without `architecture` gets an arm64
1858
1869
  function while `platform` still decides the image, so `Platform.LINUX_AMD64` builds an image the
1859
1870
  function cannot run. A stack setting neither moves to arm64 with a matching image, built under QEMU
1860
- on an x86 host ([Where the image is built](https://github.com/safeinsights/canopycms/blob/2924058c932bb84bb07466ecaab6562d46c8825c/docs/deploying-to-aws.md#where-the-image-is-built)).
1871
+ on an x86 host ([Where the image is built](https://github.com/safeinsights/canopycms/blob/cb2de67d9d4750e462d2cbb636433dfb0ba2d34d/docs/deploying-to-aws.md#where-the-image-is-built)).
1861
1872
 
1862
1873
  **To adopt.**
1863
1874
 
@@ -1886,7 +1897,7 @@ reason; `platform` on `fromImageAsset`; and, with `withCanopy()`, a hand-written
1886
1897
 
1887
1898
  **What changed.** `media.uploadUrl` (s3 adapter; an absolute http(s) URL or a site-relative path)
1888
1899
  replaces the `url` that `beginUpload()` returns, leaving the presign's `fields` untouched, so
1889
- uploads can be same-origin. See [Media Configuration](https://github.com/safeinsights/canopycms/blob/2924058c932bb84bb07466ecaab6562d46c8825c/README.md#media-configuration) for the
1900
+ uploads can be same-origin. See [Media Configuration](https://github.com/safeinsights/canopycms/blob/cb2de67d9d4750e462d2cbb636433dfb0ba2d34d/README.md#media-configuration) for the
1890
1901
  CloudFront behavior it expects.
1891
1902
 
1892
1903
  **To adopt.** Optional. Set it from an environment variable: a site-relative value works only where
@@ -1911,7 +1922,7 @@ needs `lazyPublicTransforms: true`) let you pass a deterministically named role,
1911
1922
  bucket's stack computes `arn:aws:iam::<account>:role/<name>` from literals instead of a
1912
1923
  `Fn::GetStackOutput` reference only the CDK CLI resolves. The constructs re-attach
1913
1924
  `AWSLambdaBasicExecutionRole` (and the VPC policy) that `lambda.Function` drops from a role you
1914
- pass. See [Cross-account asset bucket](https://github.com/safeinsights/canopycms/blob/2924058c932bb84bb07466ecaab6562d46c8825c/docs/deploying-to-aws.md#cross-account-asset-bucket).
1925
+ pass. See [Cross-account asset bucket](https://github.com/safeinsights/canopycms/blob/cb2de67d9d4750e462d2cbb636433dfb0ba2d34d/docs/deploying-to-aws.md#cross-account-asset-bucket).
1915
1926
 
1916
1927
  **To adopt.** Optional:
1917
1928
 
@@ -2021,7 +2032,7 @@ public JWKS PEM, used only to verify signatures.
2021
2032
  to variables (Settings → Secrets and variables → Actions → Variables); `bin/app.ts` refuses the
2022
2033
  deploy at synth while it is unset. Check that `bin/app.ts` passes `CLERK_SECRET_KEY` as
2023
2034
  `clerkSecretKeySecretArn` (read by the worker), never in the Lambda's `environment`, unless you keep
2024
- `clerkMiddleware` ([Security Model](https://github.com/safeinsights/canopycms/blob/2924058c932bb84bb07466ecaab6562d46c8825c/docs/deploying-to-aws.md#security-model)).
2035
+ `clerkMiddleware` ([Security Model](https://github.com/safeinsights/canopycms/blob/cb2de67d9d4750e462d2cbb636433dfb0ba2d34d/docs/deploying-to-aws.md#security-model)).
2025
2036
 
2026
2037
  #### `readByUrlPath` answers only where `listEntries` publishes — **breaking (routing)**
2027
2038
 
@@ -2120,7 +2131,7 @@ basePath: process.env.NEXT_PUBLIC_BASE_PATH,
2120
2131
  Then pass `baseUrl` to `assetUrl` only if Next serves `/assets` (local adapter, `next dev`, S3 with
2121
2132
  no distribution): `assetUrl(image, { width: 960, baseUrl: BASE_PATH })`. Assets on CloudFront via
2122
2133
  `AssetSupport` stay at the distribution root; pass no `baseUrl` (mount table under "Where `/assets`
2123
- is mounted" in [Media Configuration](https://github.com/safeinsights/canopycms/blob/2924058c932bb84bb07466ecaab6562d46c8825c/README.md#media-configuration)). Two traps:
2134
+ is mounted" in [Media Configuration](https://github.com/safeinsights/canopycms/blob/cb2de67d9d4750e462d2cbb636433dfb0ba2d34d/README.md#media-configuration)). Two traps:
2124
2135
 
2125
2136
  - Don't pass a deployment `basePath` to `contentStaticParams({ basePath })`; that option filters by
2126
2137
  a nested route prefix and emits zero params, building green.
@@ -2279,7 +2290,7 @@ Under `exactOptionalPropertyTypes: true`, omit keys instead of assigning `undefi
2279
2290
  `withTrailingSlash` and `isAbsoluteUrl` from `canopycms/server`; `defineSeoFieldGroup()` from
2280
2291
  `canopycms`; `generateContentSitemap` and `entryToMetadata` from `canopycms-next`, bound on
2281
2292
  `createNextCanopyContext`'s result. See
2282
- [Sitemap and SEO Metadata](https://github.com/safeinsights/canopycms/blob/2924058c932bb84bb07466ecaab6562d46c8825c/README.md#sitemap-and-seo-metadata). Every routable entry type is in
2293
+ [Sitemap and SEO Metadata](https://github.com/safeinsights/canopycms/blob/cb2de67d9d4750e462d2cbb636433dfb0ba2d34d/README.md#sitemap-and-seo-metadata). Every routable entry type is in
2283
2294
  the sitemap unless `exclude`d or `noindex`; one `noindex` predicate drives both robots metadata and
2284
2295
  sitemap exclusion. `trailingSlash` is never inferred. `lastModified` defaults to `updatedAt`, a
2285
2296
  filesystem mtime. An empty SEO field counts as unset. `siteUrl` must be absolute, colliding URLs are
@@ -2336,7 +2347,7 @@ underscore-prefixed files are skipped.
2336
2347
 
2337
2348
  **What changed.** New scaffolds write `defaultBranchAccess: 'deny'` and
2338
2349
  `defaultPathAccess: { read: 'allow' }`
2339
- ([Public read on server deployments](https://github.com/safeinsights/canopycms/blob/2924058c932bb84bb07466ecaab6562d46c8825c/README.md#public-read-on-server-deployments)).
2350
+ ([Public read on server deployments](https://github.com/safeinsights/canopycms/blob/cb2de67d9d4750e462d2cbb636433dfb0ba2d34d/README.md#public-read-on-server-deployments)).
2340
2351
 
2341
2352
  **To adopt.** An older scaffold's `defaultBranchAccess: 'allow'` is wider than recommended;
2342
2353
  consider `'deny'`. If you deleted `defaultPathAccess: { read: 'allow' }`, anonymous visitors get no content until you
@@ -2389,7 +2400,7 @@ re-checked an entry's type (a `switch` on `meta.entryType` can merge them into o
2389
2400
  **What changed.** `BlockComponentRegistry<Blocks>` (types only, from `canopycms`; `BlockValueOf<Blocks, 'hero'>`
2390
2401
  gives one template's value type) requires exactly
2391
2402
  one component per block template name when written as an object literal. See
2392
- [Block Component Registries](https://github.com/safeinsights/canopycms/blob/2924058c932bb84bb07466ecaab6562d46c8825c/README.md#block-component-registries) and
2403
+ [Block Component Registries](https://github.com/safeinsights/canopycms/blob/cb2de67d9d4750e462d2cbb636433dfb0ba2d34d/README.md#block-component-registries) and
2393
2404
  `apps/example1/app/components/PostView.tsx`.
2394
2405
 
2395
2406
  ```ts
@@ -2411,7 +2422,7 @@ templates against the schema.
2411
2422
 
2412
2423
  **What changed.** Spreading a `const` field array into several schemas, and nesting
2413
2424
  `defineInlineFieldGroup()` inside a block template, are documented
2414
- ([Reusable Field Fragments](https://github.com/safeinsights/canopycms/blob/2924058c932bb84bb07466ecaab6562d46c8825c/README.md#reusable-field-fragments)); `defineFieldFragment()` is an
2425
+ ([Reusable Field Fragments](https://github.com/safeinsights/canopycms/blob/cb2de67d9d4750e462d2cbb636433dfb0ba2d34d/README.md#reusable-field-fragments)); `defineFieldFragment()` is an
2415
2426
  identity helper for them.
2416
2427
 
2417
2428
  ```ts
@@ -2430,7 +2441,7 @@ field by composing from the same `const` field object.
2430
2441
  A block template holding a `reference` field is a shared block; `read()`/`readByUrlPath()` resolve
2431
2442
  it, and listings do with
2432
2443
  [`resolveReferences`](#listings-resolve-references-and-a-resolved-reference-carries-urlpath-and-optionally-its-body-16--breaking-type-level)
2433
- (0.0.64). See [Shared / Referenced Blocks](https://github.com/safeinsights/canopycms/blob/2924058c932bb84bb07466ecaab6562d46c8825c/README.md#shared--referenced-blocks).
2444
+ (0.0.64). See [Shared / Referenced Blocks](https://github.com/safeinsights/canopycms/blob/cb2de67d9d4750e462d2cbb636433dfb0ba2d34d/README.md#shared--referenced-blocks).
2434
2445
 
2435
2446
  **Now deletable.** A second `read()` in page code to unwrap a shared block's reference.
2436
2447
 
@@ -2452,7 +2463,7 @@ Not retro-documented, apart from these:
2452
2463
 
2453
2464
  #### The registry is keyed by entry-type name (0.0.42)
2454
2465
 
2455
- **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/2924058c932bb84bb07466ecaab6562d46c8825c/README.md#convention-why-key-the-registry-by-entry-type-name) says when to keep them.
2466
+ **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/cb2de67d9d4750e462d2cbb636433dfb0ba2d34d/README.md#convention-why-key-the-registry-by-entry-type-name) says when to keep them.
2456
2467
 
2457
2468
  **To adopt.**
2458
2469
 
@@ -1,11 +1,10 @@
1
1
  'use client';
2
2
  import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
3
3
  import { Box, Group } from '@mantine/core';
4
- import { SHELL_REGION_BORDER } from '../shell/EditorShell.js';
4
+ import { SHELL_HEADER_HEIGHT, SHELL_REGION_BORDER } from '../shell/EditorShell.js';
5
5
  import { describeBranchLock } from '../branch-lock.js';
6
6
  import { EntryBreadcrumb } from './EntryBreadcrumb.js';
7
7
  import { EntrySaveButton } from './EntrySaveButton.js';
8
- const ENTRY_HEADER_HEIGHT = 48;
9
8
  /** The open entry's breadcrumb, menu, unsaved dot and "Read-only" chip, then Save, over the panes. */
10
9
  export function EntryHeader({ currentEntry, entryLoading = false, branchName, busy, breadcrumbSegments, onCollectionOpen, onEntryReveal, navigatorToggleRef, onFileReload, onFileDiscardDraft, onEntryRename, onEntryDelete, onSave, saveAllRunning, saving = false, savedSignal, savedHere = false, hasUnsavedChanges, entryHasDraft = hasUnsavedChanges, draftStorageFailed = false, entryReadOnly = false, entryUnavailable = false, branchStatus, branchReadOnly = false, branchWriteBlocked = false, branchLoading = false, branchPending = false, branchMissing = false, }) {
11
10
  const branchLockReason = describeBranchLock({
@@ -25,7 +24,7 @@ export function EntryHeader({ currentEntry, entryLoading = false, branchName, bu
25
24
  : !currentEntry
26
25
  ? 'Open an entry to save it.'
27
26
  : (entryLockReason ?? (!hasUnsavedChanges ? 'No changes to save.' : '')));
28
- return (_jsxs(Group, { component: "section", "aria-label": "Entry", "data-testid": "entry-header", gap: "xs", wrap: "nowrap", justify: "space-between", px: "sm", py: 6, mih: ENTRY_HEADER_HEIGHT, style: {
27
+ return (_jsxs(Group, { component: "section", "aria-label": "Entry", "data-testid": "entry-header", gap: "xs", wrap: "nowrap", justify: "space-between", px: "sm", h: SHELL_HEADER_HEIGHT, style: {
29
28
  flexShrink: 0,
30
29
  borderBottom: SHELL_REGION_BORDER,
31
30
  background: 'var(--mantine-color-body)',
@@ -9,11 +9,13 @@ export interface EditorShellProps {
9
9
  }
10
10
  /** The line between two shell regions, as under the top bar. */
11
11
  export declare const SHELL_REGION_BORDER = "1px solid var(--canopy-input-border)";
12
+ /** The content panel's header and the entry header, set outright so their bottom borders line up. */
13
+ export declare const SHELL_HEADER_HEIGHT = 49;
12
14
  /**
13
15
  * Every resizable divider in the shell, the panel's and the panes', shows this many pixels wide.
14
16
  * Its pointer target is wider, `DIVIDER_TARGET_PX`. A finger's reaches 6px past each side of the
15
17
  * bar: under the panes' separator, the narrow window's overlay panel keeps its header's close
16
- * button clear, as that header's top padding is 10px.
18
+ * button clear, as that header centres it 10px below its top.
17
19
  */
18
20
  export declare const DIVIDER_WIDTH_PX = 4;
19
21
  export declare const DIVIDER_TARGET_PX: {
@@ -6,11 +6,13 @@ import { RemoveScroll } from 'react-remove-scroll';
6
6
  import { useHideHostChrome } from './host-chrome.js';
7
7
  /** The line between two shell regions, as under the top bar. */
8
8
  export const SHELL_REGION_BORDER = '1px solid var(--canopy-input-border)';
9
+ /** The content panel's header and the entry header, set outright so their bottom borders line up. */
10
+ export const SHELL_HEADER_HEIGHT = 49;
9
11
  /**
10
12
  * Every resizable divider in the shell, the panel's and the panes', shows this many pixels wide.
11
13
  * Its pointer target is wider, `DIVIDER_TARGET_PX`. A finger's reaches 6px past each side of the
12
14
  * bar: under the panes' separator, the narrow window's overlay panel keeps its header's close
13
- * button clear, as that header's top padding is 10px.
15
+ * button clear, as that header centres it 10px below its top.
14
16
  */
15
17
  export const DIVIDER_WIDTH_PX = 4;
16
18
  export const DIVIDER_TARGET_PX = { fine: 12, coarse: 16 };
@@ -2,10 +2,10 @@
2
2
  import { jsxs as _jsxs, jsx as _jsx } from "react/jsx-runtime";
3
3
  import { Drawer, Group } from '@mantine/core';
4
4
  /**
5
- * The header of every right-hand drawer, sized and ruled like the content panel's header in
6
- * `SidePanelHost`: a 16px semibold title, a default-size close button, `md` by `xs` padding and a
7
- * 1px bottom rule. It is the drawer's own `Drawer.Header`, so the title labels the dialog and the
8
- * header stays pinned while the body scrolls.
5
+ * The header of every right-hand drawer, ruled like the content panel's header: a 16px semibold
6
+ * title, a default-size close button and a 1px rule, its `xs` padding making `SHELL_HEADER_HEIGHT`.
7
+ * As the drawer's own `Drawer.Header`, its title labels the dialog and it stays pinned while the
8
+ * body scrolls.
9
9
  */
10
10
  const OverlayHeader = ({ title, adornment, titleRef, titleTabIndex, }) => (_jsxs(Drawer.Header, { mih: 0, px: "md", py: "xs", style: { borderBlockEnd: '1px solid var(--canopy-input-border)' }, children: [_jsx(Drawer.Title, { ref: titleRef, tabIndex: titleTabIndex, fw: 600, fz: "md", miw: 0, children: _jsxs(Group, { component: "span", gap: "xs", wrap: "nowrap", children: [title, adornment] }) }), _jsx(Drawer.CloseButton, { "aria-label": "Close" })] }));
11
11
  /**
@@ -4,7 +4,7 @@ import { useEffect, useId, useLayoutEffect, useRef, useState, } from 'react';
4
4
  import { CloseButton, Group, Text, Tooltip, Transition } from '@mantine/core';
5
5
  import { useReducedMotion, useWindowEvent } from '@mantine/hooks';
6
6
  import { FOCUS_RETURN_ATTR, focusIfIdle } from '../utils/focus-return.js';
7
- import { DIVIDER_COLOR, DIVIDER_TARGET_PX, DIVIDER_WIDTH_PX } from './EditorShell.js';
7
+ import { DIVIDER_COLOR, DIVIDER_TARGET_PX, DIVIDER_WIDTH_PX, SHELL_HEADER_HEIGHT, SHELL_REGION_BORDER, } from './EditorShell.js';
8
8
  const KEY_STEP_PX = 16;
9
9
  const RESIZING_ATTR = 'data-canopy-panel-resizing';
10
10
  /** The drawers' slide: Mantine's `Transition` default. */
@@ -302,7 +302,7 @@ export function SidePanelHost({ title, mode, opened, width, minWidth, maxWidth,
302
302
  }, onBlur: (event) => {
303
303
  if (!event.currentTarget.contains(event.relatedTarget))
304
304
  focusInside.current = false;
305
- }, children: [_jsx("style", { children: PANEL_STYLES }), _jsxs(Group, { justify: "space-between", wrap: "nowrap", gap: "xs", px: "md", py: "xs", style: { borderBlockEnd: '1px solid var(--canopy-input-border)' }, children: [_jsx(Text, { id: titleId, component: "h2", fw: 600, size: "md", m: 0, children: title }), _jsxs(Group, { gap: "xs", wrap: "nowrap", children: [actions, _jsx(Tooltip, { label: `Close ${title.toLowerCase()} panel`, children: _jsx(CloseButton, { "aria-label": `Close ${title.toLowerCase()} panel`, onClick: onClose }) })] })] }), _jsx("div", { style: { flex: 1, minHeight: 0, overflow: 'auto' }, children: children }), _jsx("div", { role: "separator", "aria-orientation": "vertical", "aria-label": `Resize ${title.toLowerCase()} panel`, "aria-controls": panelId, "aria-valuenow": Math.round(shownWidth), "aria-valuemin": minWidth, "aria-valuemax": maxWidth,
305
+ }, children: [_jsx("style", { children: PANEL_STYLES }), _jsxs(Group, { justify: "space-between", wrap: "nowrap", gap: "xs", px: "md", h: SHELL_HEADER_HEIGHT, style: { flexShrink: 0, borderBlockEnd: SHELL_REGION_BORDER }, children: [_jsx(Text, { id: titleId, component: "h2", fw: 600, size: "md", m: 0, children: title }), _jsxs(Group, { gap: "xs", wrap: "nowrap", children: [actions, _jsx(Tooltip, { label: `Close ${title.toLowerCase()} panel`, children: _jsx(CloseButton, { "aria-label": `Close ${title.toLowerCase()} panel`, onClick: onClose }) })] })] }), _jsx("div", { style: { flex: 1, minHeight: 0, overflow: 'auto' }, children: children }), _jsx("div", { role: "separator", "aria-orientation": "vertical", "aria-label": `Resize ${title.toLowerCase()} panel`, "aria-controls": panelId, "aria-valuenow": Math.round(shownWidth), "aria-valuemin": minWidth, "aria-valuemax": maxWidth,
306
306
  // A focusable separator is a window splitter, a widget; jsx-a11y counts every one static.
307
307
  // eslint-disable-next-line jsx-a11y/no-noninteractive-tabindex
308
308
  tabIndex: 0, className: "canopy-side-panel-separator", "data-dragging": dragWidth !== null || undefined, ...separatorHandlers })] })) })] }));
package/dist/version.d.ts CHANGED
@@ -1 +1 @@
1
- export declare const CANOPYCMS_VERSION = "0.3.1";
1
+ export declare const CANOPYCMS_VERSION = "0.3.2";
package/dist/version.js CHANGED
@@ -1,3 +1,3 @@
1
1
  // Generated by scripts/bump-version.mjs, its only writer. The package builds with plain
2
2
  // tsc (rootDir: src), so src/ cannot import ../package.json; version.test.ts keeps the two equal.
3
- export const CANOPYCMS_VERSION = '0.3.1';
3
+ export const CANOPYCMS_VERSION = '0.3.2';
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "//": "@codemirror/language, @lezer/highlight: workaround — @mdxeditor/editor uses cm6-theme-basic-light which peer-requires these but mdxeditor doesn't declare them as dependencies",
3
3
  "name": "canopycms",
4
- "version": "0.3.1",
4
+ "version": "0.3.2",
5
5
  "description": "CanopyCMS core package: schema-driven content, branch-aware editing, and editor UI for Next.js.",
6
6
  "license": "MIT",
7
7
  "repository": {