@murabei-data-science/pumpwood-ui 1.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Murabei
+
+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,145 @@
+# Pumpwood UI Components
+
+A scalable, accessible, and customizable UI library built with
+React, Tailwind CSS 4, and Storybook.
+
+The library is split into two entry points:
+
+- **`pumpwood-ui-components/components`** — primitives and reusable UI
+  blocks (Button, Table, Select, Dialog, etc.)
+- **`pumpwood-ui-components/design-system`** — product patterns
+  (Auth, AutoFormContent, DetailPage, M2MTable, Filters, etc.)
+
+## Installation
+
+Install the package using pnpm (or npm/yarn):
+
+```bash
+pnpm install pumpwood-ui-components
+```
+
+## Setup
+
+The library expects `React` to be available as a global variable. In
+Next.js 14+ with the App Router this is not the case by default. Add
+the following to your `next.config.mjs` to patch it at build time:
+
+```js
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  // ...your existing config
+  webpack: (config, { webpack }) => {
+    config.plugins.push(
+      new webpack.ProvidePlugin({
+        React: "react",
+      })
+    );
+    return config;
+  },
+};
+
+export default nextConfig;
+```
+
+Import the library styles once in your app entry:
+
+```tsx
+import "pumpwood-ui-components/dist/index.css";
+```
+
+## Usage
+
+Import from the subpath that matches the layer you need:
+
+```tsx
+import { Button, Table, Select } from "pumpwood-ui-components/components";
+import {
+  AutoFormContent,
+  LoginCard,
+  DetailPage,
+} from "pumpwood-ui-components/design-system";
+
+function MyComponent() {
+  return <Button className="bg-blue-500">Click Me</Button>;
+}
+```
+
+### Design-system peer dependencies
+
+Patterns under `design-system` may require additional peers depending on
+what you import:
+
+- `swr` — M2MTable, Filters with FKSelect
+- `react-hook-form` — forms integrated with AutoFormContent consumers
+
+### Customized Prefix
+
+This library uses the `pw:` prefix for all Tailwind utility classes to
+avoid conflicts with your application's styles. When overriding styles
+via `className`, use valid Tailwind utilities prefixed with `pw:` if
+your app is configured to match, or standard utilities if your app has
+its own separate Tailwind config.
+
+## Migration from v1.x
+
+Version 2.0 removes the root entry point. Update imports as follows:
+
+```tsx
+// Before (v1.x)
+import { Button, AutoFormContent } from "pumpwood-ui-components";
+
+// After (v2.x)
+import { Button } from "pumpwood-ui-components/components";
+import { AutoFormContent } from "pumpwood-ui-components/design-system";
+```
+
+When using design-system patterns, also import components they compose
+(for example FKSelect-backed filters require the components subpath).
+
+## Building and Publishing to npm
+
+To quickly build and publish the package to npm, we have a helper
+script that automates the environment variable loading, building, and
+publishing.
+
+### 1. Setup Auth Token (One-time setup)
+
+We use an authentication token rather than logging in interactively.
+
+Create a `.env` file at the root of the project with your npm token
+(this file is already in `.gitignore` so it won't be committed safely):
+
+```ini
+NODE_AUTH_TOKEN=your_npm_access_token_here
+```
+
+Your `.npmrc` file is already configured to automatically read this
+token.
+
+### 2. Update Version
+
+npm requires a new version number for every successful publish. Before
+publishing, bump your package version:
+
+```bash
+npm version patch  # For bug fixes (e.g., 1.0.1 -> 1.0.2)
+# or
+npm version minor  # For new features (e.g., 1.0.1 -> 1.1.0)
+```
+
+### 3. Run the Publish Script
+
+Finally, make sure your dependencies are installed (e.g.,
+`pnpm install`) and simply run the automated script:
+
+```bash
+./publish.sh
+```
+
+This script will automatically:
+
+1. Load your `.env` token.
+2. Build the project using Rollup.
+3. Publish to the public npm registry.
+
+Once the command succeeds, your new version is live on the npm registry!