feat: change package name to @charlietango/react-umbraco

Author: thebuilder

.github/workflows/ci.yml

@@ -25,6 +25,11 @@ jobs:
         run: pnpm install
       - name: Lint
         run: pnpm biome ci .
+      - name: Type check
+        run: pnpm typecheck
+      - name: Example type check
+        run: pnpm typecheck
+        working-directory: examples/UmbracoRichText
       - name: Install playwright
         run: pnpm exec playwright install
       - name: Test

.prettierignore

@@ -1,2 +1,4 @@
+# We use Biome to format our code, so we ignore all files for Prettier
 **/*.*
+# Biome doesn't format these files, so include them in Prettier
 !**/*.md

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Charlie Tango <https://github.com/charlietango>
+Copyright (c) 2025 Charlie Tango <https://github.com/charlietango>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,4 +1,4 @@
-# react-umbraco
+# Umbraco Rich Text
 
 [![npm version][npm-version-src]][npm-version-href]
 [![License][license-src]][license-href]
@@ -8,11 +8,11 @@ A collection of React components for working with the Umbraco
 
 ## Install
 
-Install the `@charlietango/react-umbraco` package with your package manager of
-choice.
+Install the `@charlietango/umbraco-rich-text` package with your package manager
+of choice.
 
 ```sh
-npm install @charlietango/react-umbraco
+npm install @charlietango/umbraco-rich-text
 ```
 
 ## `<UmbracoRichText>`
@@ -50,7 +50,7 @@ import {
   UmbracoRichText,
   RenderBlockContext,
   RenderNodeContext,
-} from "@charlietango/react-umbraco";
+} from "@charlietango/umbraco-rich-text";
 import Image from "next/image";
 import Link from "next/link";
 
@@ -117,7 +117,7 @@ import { components } from "@/openapi/umbraco";
 // Define the intermediate interface
 type ApiBlockItemModel = components["schemas"]["ApiBlockItemModel"];
 
-declare module "@charlietango/react-umbraco" {
+declare module "@charlietango/umbraco-rich-text" {
   interface UmbracoBlockItemModel extends ApiBlockItemModel {}
 }
 ```
@@ -146,7 +146,7 @@ can be useful for generating meta descriptions or other text-based properties.
 ### Example
 
 ```ts
-import { richTextToPlainText } from "@charlietango/react-umbraco";
+import { richTextToPlainText } from "@charlietango/umbraco-rich-text";
 
 const plainText = richTextToPlainText(richTextData);
 
@@ -169,8 +169,8 @@ const ignoreTags = richTextToPlainText(richTextData, {
 <!-- Badges -->
 
 [npm-version-src]:
-  https://img.shields.io/npm/v/@charlietango/react-umbraco?style=flat&colorA=080f12&colorB=1fa669
-[npm-version-href]: https://npmjs.com/package/@charlietango/react-umbraco
+  https://img.shields.io/npm/v/@charlietango/umbraco-rich-text?style=flat&colorA=080f12&colorB=1fa669
+[npm-version-href]: https://npmjs.com/package/@charlietango/umbraco-rich-text
 [license-src]:
   https://img.shields.io/github/license/charlie-tango/react-umbraco.svg?style=flat&colorA=080f12&colorB=1fa669
 [license-href]: https://github.com/charlie-tango/react-umbraco/blob/main/LICENSE

examples/UmbracoRichText/package.json

@@ -1,26 +1,27 @@
 {
-  "name": "react-umbraco-example",
+  "name": "@charlietango/umbraco-rich-text--example",
   "private": true,
   "type": "module",
   "scripts": {
     "dev": "vite",
     "build": "tsc && vite build",
-    "preview": "vite preview"
+    "preview": "vite preview",
+    "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@charlietango/react-umbraco": "workspace:*",
-    "react": "^19.1.0",
-    "react-dom": "^19.1.0",
+    "@charlietango/umbraco-rich-text": "workspace:*",
+    "react": "^19.1.1",
+    "react-dom": "^19.1.1",
     "react-lazy-load-image-component": "^1.6.3"
   },
   "devDependencies": {
     "@tailwindcss/typography": "^0.5.16",
     "@tailwindcss/vite": "^4.1.11",
-    "@types/react": "^19.1.8",
-    "@types/react-dom": "^19.1.6",
-    "@vitejs/plugin-react": "^4.6.0",
+    "@types/react": "^19.1.10",
+    "@types/react-dom": "^19.1.7",
+    "@vitejs/plugin-react": "^5.0.0",
     "tailwindcss": "^4.1.11",
-    "typescript": "^5.8.3",
-    "vite": "^7.0.5"
+    "typescript": "^5.9.2",
+    "vite": "^7.1.2"
   }
 }

examples/UmbracoRichText/src/RichText.tsx

@@ -1,8 +1,8 @@
 import {
-  type UmbracoBlockContext,
+  type RenderBlockContext,
   type RenderNodeContext,
   UmbracoRichText,
-} from '@charlietango/react-umbraco';
+} from '@charlietango/umbraco-rich-text';
 
 // replace with ApiBlockItemModel from your own Umbraco API openapi docs for type safety
 interface ApiBlockItemModel {
@@ -14,7 +14,7 @@ interface ApiBlockItemModel {
   };
 }
 
-declare module '@charlietango/react-umbraco' {
+declare module '@charlietango/umbraco-rich-text' {
   interface UmbracoBlockItemModel extends ApiBlockItemModel {}
 }
 
@@ -42,7 +42,7 @@ function exhaustiveGuard(value: never): never {
 // provide handling of rendering blocks from Umbraco
 function renderBlock({
   content,
-}: UmbracoBlockContext): React.ReactNode | undefined {
+}: RenderBlockContext): React.ReactNode | undefined {
   if (!content) return undefined;
 
   // discriminating on content.id ensures correct typing for the content properties based on the defined ApiBlockItemModel

package.json

@@ -1,21 +1,22 @@
 {
-  "name": "@charlietango/react-umbraco",
+  "name": "@charlietango/umbraco-rich-text",
   "private": false,
   "type": "module",
   "version": "0.6.0",
-  "packageManager": "pnpm@10.10.0+sha512.d615db246fe70f25dcfea6d8d73dee782ce23e2245e3c4f6f888249fb568149318637dca73c2c5c8ef2a4ca0d5657fb9567188bfab47f566d1ee6ce987815c39",
-  "description": "React components for working with Umbraco Headless",
+  "packageManager": "pnpm@10.14.0+sha512.ad27a79641b49c3e481a16a805baa71817a04bbe06a38d17e60e2eaee83f6a146c6a688125f5792e48dd5ba30e7da52a5cda4c3992b9ccf333f9ce223af84748",
+  "description": "React component for working with rich text from the Umbraco Content Delivery API.",
   "author": "Charlie Tango",
   "license": "MIT",
-  "homepage": "https://github.com/charlie-tango/react-umbraco#readme",
+  "homepage": "https://github.com/charlie-tango/umbraco-rich-text#readme",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/charlie-tango/react-umbraco.git"
+    "url": "git+https://github.com/charlie-tango/umbraco-rich-text.git"
   },
-  "bugs": "https://github.com/charlie-tango/react-umbraco/issues",
+  "bugs": "https://github.com/charlie-tango/umbraco-rich-text/issues",
   "keywords": [
     "umbraco",
     "react",
+    "rich text",
     "content delivery api",
     "headless cms"
   ],
@@ -52,7 +53,7 @@
     "prepare": "simple-git-hooks"
   },
   "stackblitz": {
-    "startCommand": "pnpm build && pnpm --filter=react-umbraco-example dev"
+    "startCommand": "pnpm build && pnpm --filter=umbraco-rich-text-example dev"
   },
   "dependencies": {
     "html-entities": "^2.6.0"
@@ -61,25 +62,25 @@
     "react": "^18.0.0 || ^19.0.0"
   },
   "devDependencies": {
-    "@biomejs/biome": "^2.1.1",
-    "@types/node": "^24.0.14",
-    "@types/react": "^19.1.8",
-    "@types/react-dom": "^19.1.6",
-    "@vitejs/plugin-react": "^4.6.0",
+    "@biomejs/biome": "^2.1.4",
+    "@types/node": "^24.2.1",
+    "@types/react": "^19.1.10",
+    "@types/react-dom": "^19.1.7",
+    "@vitejs/plugin-react": "^5.0.0",
     "@vitest/browser": "^3.2.4",
-    "bumpp": "^10.2.0",
-    "lint-staged": "^16.1.2",
-    "playwright": "^1.54.1",
+    "bumpp": "^10.2.3",
+    "lint-staged": "^16.1.5",
+    "playwright": "^1.54.2",
     "prettier": "^3.6.2",
-    "react": "^19.1.0",
-    "react-dom": "^19.1.0",
+    "react": "^19.1.1",
+    "react-dom": "^19.1.1",
     "rimraf": "^6.0.1",
-    "simple-git-hooks": "^2.13.0",
-    "typescript": "^5.8.3",
-    "unbuild": "^3.5.0",
-    "vite": "^7.0.5",
+    "simple-git-hooks": "^2.13.1",
+    "typescript": "^5.9.2",
+    "unbuild": "^3.6.0",
+    "vite": "^7.1.2",
     "vitest": "^3.2.4",
-    "vitest-browser-react": "^1.0.0"
+    "vitest-browser-react": "^1.0.1"
   },
   "simple-git-hooks": {
     "pre-commit": "pnpm lint-staged"