@bygghammar/cms-platform 0.1.0 → 0.1.1

package/README.md

@@ -28,9 +28,59 @@ import { registerTranslations } from "@bygghammar/cms-platform/i18n";
 registerTranslations({ generated: TRANSLATIONS, overrides: TRANSLATION_OVERRIDES });
 ```
 
-## Consuming
+Host components must participate in a value the application actually uses.
+Do not rely only on `import "./register-host"` because an optimized build may
+remove that module when the application's `package.json` declares
+`"sideEffects": false`.
 
-Today the package is linked through the Bun workspace (`workspace:*`), so edits
-are picked up instantly with no publish step. When the workspace managed npm
-registry is enabled, the same source publishes under the `@ws-` scope and sites
-switch `workspace:*` for a version range — no code changes.
+```tsx
+import {
+  initializeHostComponents,
+  type HostComponents,
+} from "@bygghammar/cms-platform/host";
+
+const HOST_COMPONENTS = {
+  FocalImage,
+  LazyVideo,
+  FocusPicker,
+  RichTextEditor,
+  mediaLibraryQueryOptions,
+  useMediaUpload,
+} satisfies Partial<HostComponents>;
+
+export const BLOCK_REGISTRY = initializeHostComponents(
+  HOST_COMPONENTS,
+  () => createBlockRegistry(),
+);
+```
+
+Keep any existing registration module in the consuming application's
+`sideEffects` allowlist as defence in depth until every entry point uses the
+explicit contract. CSS must also remain in that allowlist.
+
+## Publishing
+
+This directory is the maintained source for the public npm package. Releases
+use npm Trusted Publishing from GitHub Actions; do not publish from a laptop or
+create an npm token.
+
+1. Merge the reviewed version bump and wait for Checks to pass on `main`.
+2. Run **Actions → Publish CMS platform → Run workflow** from `main` and enter
+   the exact version from this package.
+3. Verify the new public version before updating consuming CMS lockfiles.
+
+Never place an npm token or `.npmrc` in the repository. Consumers install an
+explicit released version such as `@bygghammar/cms-platform@^0.1.1`.
+
+### Release checks and troubleshooting
+
+The workflow type-checks the package and runs
+`tests/cms-platform-host-contract.test.tsx` before requesting npm's OIDC
+publishing credential. Keep Vitest's include glob compatible with both
+`*.test.ts` and `*.test.tsx`; otherwise the release stops with “No test files
+found” before npm is contacted.
+
+If a release run fails, read its failed step before rerunning it. A failed run
+does not publish a partial package. After a successful run, verify the public
+registry reports the requested version, then update each consuming application
+and its frozen lockfile in a separate pull request.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bygghammar/cms-platform",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Shared CMS platform: blocks, block types, i18n core, UI primitives and design-token contract used by every Bygghammar/Voyara site.",
   "type": "module",
   "sideEffects": false,
@@ -13,6 +13,14 @@
     "src",
     "README.md"
   ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/byggis79/devsba.git",
+    "directory": "packages/cms-platform"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
   "exports": {
     ".": "./src/index.ts",
     "./i18n": "./src/i18n/index.ts",
@@ -32,8 +40,10 @@
     "./blocks/registry": "./src/blocks/registry.tsx"
   },
   "peerDependencies": {
+    "@tanstack/react-query": ">=5",
     "lucide-react": ">=0.5.0",
     "react": ">=19",
-    "react-dom": ">=19"
+    "react-dom": ">=19",
+    "sonner": ">=2"
   }
-}
+}

package/src/host/index.tsx

@@ -89,6 +89,22 @@ export function registerHostComponents(components: Partial<HostComponents>): voi
   hosts = { ...hosts, ...components };
 }
 
+/**
+ * Register a site's host components as part of constructing a value the site
+ * actually exports or renders.
+ *
+ * Prefer this over a side-effect-only import. Applications whose package
+ * metadata declares `sideEffects: false` may otherwise lose their registration
+ * module during an optimized build even though development still works.
+ */
+export function initializeHostComponents<T>(
+  components: Partial<HostComponents>,
+  initialize: () => T,
+): T {
+  registerHostComponents(components);
+  return initialize();
+}
+
 function missing(name: keyof HostComponents): never {
   throw new Error(
     `@bygghammar/cms-platform: host "${name}" is not registered. Call registerHostComponents() during site startup.`,