@react-foundry/client-component-helpers 0.1.0

package/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (C) 2019-2025 Crown Copyright
+Copyright (C) 2019-2026 Daniel A.C. Martin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,48 @@
+React Foundry - Client Component Helpers
+========================================
+
+Helper functions for writing client components.
+
+
+Using this package
+------------------
+
+First install the package into your project:
+
+```shell
+npm install -S @react-foundry/client-component-helpers
+```
+
+Then use it in your code as follows:
+
+```js
+import clientComponentHelpers from '@react-foundry/client-component-helpers';
+
+// WRITEME
+
+```
+
+
+Working on this package
+-----------------------
+
+Before working on this package you must install its dependencies using
+the following command:
+
+```shell
+pnpm install
+```
+
+
+### Building
+
+```shell
+npm run build
+```
+
+
+### Clean-up
+
+```shell
+npm run clean
+```

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from './is-mounted';

package/dist/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./is-mounted"), exports);

package/dist/index.mjs

@@ -0,0 +1 @@
+export * from './is-mounted';

package/dist/is-mounted.d.ts

@@ -0,0 +1 @@
+export declare const useIsMounted: () => boolean;

package/dist/is-mounted.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useIsMounted = void 0;
+const react_1 = require("react");
+// Inspired by:
+// - https://tech.willhaben.at/how-to-shoot-yourself-in-the-foot-in-react-401e7dbba720
+// - https://www.joshwcomeau.com/react/the-perils-of-rehydration/
+const useIsMounted = () => {
+    const [isMounted, setIsMounted] = (0, react_1.useState)(false);
+    const markAsMounted = () => setIsMounted(true);
+    (0, react_1.useEffect)(markAsMounted, []);
+    return isMounted;
+};
+exports.useIsMounted = useIsMounted;

package/dist/is-mounted.mjs

@@ -0,0 +1,10 @@
+import { useEffect, useState } from 'react';
+// Inspired by:
+// - https://tech.willhaben.at/how-to-shoot-yourself-in-the-foot-in-react-401e7dbba720
+// - https://www.joshwcomeau.com/react/the-perils-of-rehydration/
+export const useIsMounted = () => {
+    const [isMounted, setIsMounted] = useState(false);
+    const markAsMounted = () => setIsMounted(true);
+    useEffect(markAsMounted, []);
+    return isMounted;
+};

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@react-foundry/client-component-helpers",
+  "version": "0.1.0",
+  "description": "Helper functions for writing client components.",
+  "main": "dist/index.js",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js",
+      "default": "./dist/index.mjs"
+    }
+  },
+  "files": [
+    "/dist"
+  ],
+  "author": "Daniel A.C. Martin <npm@daniel-martin.co.uk> (http://daniel-martin.co.uk/)",
+  "license": "MIT",
+  "peerDependencies": {
+    "react": "^19.2.3"
+  },
+  "devDependencies": {
+    "@types/react": "19.2.9",
+    "typescript": "5.9.3"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "npm run build:esm && npm run build:cjs",
+    "build:esm": "tsc -m es2022 && find dist -name '*.js' -exec sh -c 'mv \"$0\" \"${0%.js}.mjs\"' {} \\;",
+    "build:cjs": "tsc",
+    "clean": "rm -rf dist tsconfig.tsbuildinfo"
+  },
+  "module": "dist/index.mjs",
+  "typings": "dist/index.d.ts"
+}