@realadvisor-sites/kit-core 0.4.1 → 0.4.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/AGENTS.md CHANGED
@@ -371,3 +371,10 @@ minutes for a new site.
371
371
  something is broken; touch the CRM preview's injected scripts.
372
372
  - Deploy, push, or call external services (RealAdvisor publishes), or leave
373
373
  wiring-example markup and placeholder labels.
374
+ - Change the kit or SDK versions in `package.json` as part of another
375
+ request. Upgrade only when the customer asks, when RealAdvisor refuses the
376
+ kit as unsupported, or when a requested feature needs a newer kit, and say
377
+ so. To upgrade, bump all the kit packages and the SDK to one exact version,
378
+ install, then apply every `### Upgrade` step in the new kit's
379
+ `node_modules/@realadvisor/sites-kit-core/CHANGELOG.md` newer than the old
380
+ version, and run the self-check.
package/CHANGELOG.md ADDED
@@ -0,0 +1,57 @@
1
+ # Changelog
2
+
3
+ The SDK, kit-core, kit-astro and kit-react are released together, one version
4
+ for all four. This file ships inside `@realadvisor-sites/kit-core`, so a site
5
+ reads it at `node_modules/@realadvisor/sites-kit-core/CHANGELOG.md`.
6
+
7
+ Each version has an entry. An `### Upgrade` section lists what a site must
8
+ change when it moves to that version. When there is no Upgrade section, bumping
9
+ the versions is enough.
10
+
11
+ To upgrade a site, read every entry newer than the site's current version,
12
+ oldest first, and apply each Upgrade step in order.
13
+
14
+ ## 0.4.2
15
+
16
+ - This changelog, shipped in kit-core.
17
+
18
+ ## 0.4.1
19
+
20
+ - First release through the Publish workflow: staged on npm with provenance,
21
+ approved by a maintainer with 2FA.
22
+ - `bin` paths without `./`.
23
+
24
+ ## 0.4.0
25
+
26
+ - The kit is split into `kit-core` (framework-neutral) and `kit-astro` (the
27
+ Astro integration). `@realadvisor-sites/kit` is deprecated.
28
+
29
+ ### Upgrade
30
+
31
+ 1. In `package.json`, replace `@realadvisor/sites-kit` with two packages, both at
32
+ the same version as the SDK:
33
+ ```json
34
+ "@realadvisor/sites-kit-core": "npm:@realadvisor-sites/kit-core@0.4.0",
35
+ "@realadvisor/sites-kit-astro": "npm:@realadvisor-sites/kit-astro@0.4.0"
36
+ ```
37
+ 2. Rename the imports. `@realadvisor/sites-kit/astro`, `/middleware`, `/ra` and
38
+ `/components/*` move to `@realadvisor/sites-kit-astro/...`. Every other
39
+ `@realadvisor/sites-kit/<x>` becomes `@realadvisor/sites-kit-core/<x>`.
40
+ 3. In `CLAUDE.md`, load the rules from
41
+ `node_modules/@realadvisor/sites-kit-core/AGENTS.md`.
42
+
43
+ ## 0.3.0
44
+
45
+ - First version on npm.
46
+
47
+ ### Upgrade
48
+
49
+ For a site that depends on the kit by path (`file:../kit`, from the monorepo
50
+ before `realadvisor/sites`):
51
+
52
+ 1. Pin the published packages instead of `file:` paths (see 0.4.0 for the
53
+ names).
54
+ 2. SDK fields are snake_case: `first_name`, `property_type`, and so on, not
55
+ `firstName`, `propertyType`.
56
+ 3. A list is `{ data, pagination }`. Read `page.data` instead of `page.items`,
57
+ and `page.pagination.total` instead of `page.total`.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@realadvisor-sites/kit-core",
3
- "version": "0.4.1",
3
+ "version": "0.4.2",
4
4
  "description": "The framework-neutral core of a RealAdvisor site, shared by the Astro kit and the React kit: data helpers over @realadvisor/sites-sdk (a peer), i18n, formatting, legal texts, SEO, search, images, security headers, the browser scripts (listing search and map, enquiry, consent), the sites-kit tools (fixture, screenshot, deploy check) and the rules the coding agent follows (AGENTS.md, DESIGN.md).",
5
5
  "license": "MIT",
6
6
  "repository": {
@@ -19,6 +19,7 @@
19
19
  "*.mjs",
20
20
  "*.mts",
21
21
  "AGENTS.md",
22
+ "CHANGELOG.md",
22
23
  "DESIGN.md",
23
24
  "README.md",
24
25
  "LICENSE",
@@ -54,7 +55,7 @@
54
55
  "test": "node --experimental-strip-types --no-warnings=ExperimentalWarning --test \"test/*.test.mjs\" \"test/*.test.ts\""
55
56
  },
56
57
  "peerDependencies": {
57
- "@realadvisor/sites-sdk": "^0.4.1",
58
+ "@realadvisor/sites-sdk": "^0.4.2",
58
59
  "playwright": "^1.64.1"
59
60
  },
60
61
  "peerDependenciesMeta": {