hazo_config 2.1.0 → 2.1.1

package/CHANGE_LOG.md

@@ -0,0 +1,47 @@
+# Changelog
+
+## 2.1.1
+- chore: add `engines` field (`node >= 18.0.0`) and `prepublishOnly` script
+- chore: widen React peer deps to support React 18 and 19
+- chore: add CHANGE_LOG.md, SETUP_CHECKLIST.md, AGENTS.md, config/ sample, design/ architecture
+- chore: clean up test-app duplicate transitive dependencies
+- chore: update .npmignore for new dev files
+
+## 2.1.0
+- feat: add JSON import/export to AppConfigListEditor
+- Export utility functions: `validate_import_data`, `merge_items`, `export_items_to_json`, `generate_export_filename`
+
+## 2.0.2
+- feat: add AppConfigListEditor component with shadcn/ui
+- Generic CRUD list editor for arrays of structured objects (tags, document types, etc.)
+- Supports field types: text, textarea, color_swatch, select, number, toggle
+
+## 2.0.1
+- chore: add test-app build artifacts to .gitignore
+
+## 2.0.0
+- **BREAKING**: Renamed `org_id` to `scope_id` in `AppConfigItem` and `AppConfigContext`
+- **BREAKING**: Split `config_value` into `config_value_text` and `config_value_json`
+- **BREAKING**: Added `config_type` field (`'general'` | `'json'`)
+- feat: add database-backed AppConfig component with JSON editing support
+- feat: add `useAppConfig` hook for async database operations
+- See `MIGRATION_V2.md` for upgrade guide
+
+## 1.4.2
+- fix: separate server/client exports to prevent Next.js bundling errors
+- Added `hazo_config/server` entry point with `server-only` guard
+
+## 1.4.1
+- fix: update JS output issues
+
+## 1.4.0
+- fix: add missing files to package.json
+- fix: ES module exports with explicit .js extensions
+- Added package development rules
+
+## 1.0.0
+- Initial release
+- HazoConfig class with INI file support, TTL-based caching
+- ConfigViewer and ConfigEditor React components
+- MockConfigProvider for testing
+- Sensitive field masking (auto-detection of passwords, tokens, keys)

package/SETUP_CHECKLIST.md

@@ -0,0 +1,132 @@
+# Setup Checklist
+
+Step-by-step setup for consuming apps using hazo_config.
+
+## 1. Install
+
+```bash
+npm install hazo_config
+```
+
+## 2. Tailwind CSS Setup
+
+### Tailwind v4
+Add `@source` directive in your globals.css to ensure Tailwind compiles classes from the package:
+
+```css
+@import "tailwindcss";
+@source "../node_modules/hazo_config/dist";
+```
+
+### Tailwind v3
+Add the dist directory to your `tailwind.config.js` content array:
+
+```js
+module.exports = {
+  content: [
+    './src/**/*.{js,ts,jsx,tsx}',
+    './node_modules/hazo_config/dist/**/*.{js,ts,jsx,tsx}',
+  ],
+}
+```
+
+## 3. CSS Custom Properties (Optional)
+
+Add these CSS variables if you want themed styling:
+
+```css
+:root {
+  --hazo-config-bg: #ffffff;
+  --hazo-config-border: #e2e8f0;
+  --hazo-config-text: #1a202c;
+  --hazo-config-muted: #718096;
+}
+```
+
+## 4. Import Components
+
+### Client-side (components, browser)
+```typescript
+import { ConfigViewer, ConfigEditor, AppConfig, MockConfigProvider } from 'hazo_config'
+```
+
+### Server-side (API routes, server components)
+```typescript
+import { HazoConfig } from 'hazo_config/server'
+```
+
+## 5. INI File Config (if using HazoConfig)
+
+Create your config file:
+```ini
+[database]
+host = localhost
+port = 5432
+
+[app]
+name = My Application
+debug = false
+```
+
+Initialize in server code:
+```typescript
+import { HazoConfig } from 'hazo_config/server'
+
+const config = new HazoConfig({
+  filePath: './config/app_config.ini',
+  create_if_missing: true,
+  cache_ttl_ms: 5000,
+})
+```
+
+## 6. Database Config (if using AppConfig)
+
+Create the `hazo_app_config` table in your database:
+
+### PostgreSQL
+```sql
+CREATE TABLE IF NOT EXISTS hazo_app_config (
+  id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
+  scope_id UUID,
+  user_id UUID,
+  config_section TEXT NOT NULL,
+  config_name TEXT NOT NULL,
+  config_value_text TEXT DEFAULT '',
+  config_value_json JSONB DEFAULT '{}',
+  config_type TEXT NOT NULL DEFAULT 'general',
+  created_at TIMESTAMPTZ DEFAULT NOW(),
+  changed_at TIMESTAMPTZ DEFAULT NOW()
+);
+```
+
+### SQLite
+```sql
+CREATE TABLE IF NOT EXISTS hazo_app_config (
+  id TEXT PRIMARY KEY,
+  scope_id TEXT,
+  user_id TEXT,
+  config_section TEXT NOT NULL,
+  config_name TEXT NOT NULL,
+  config_value_text TEXT DEFAULT '',
+  config_value_json TEXT DEFAULT '{}',
+  config_type TEXT NOT NULL DEFAULT 'general',
+  created_at TEXT DEFAULT (datetime('now')),
+  changed_at TEXT DEFAULT (datetime('now'))
+);
+```
+
+## 7. Next.js Configuration
+
+Add to `next.config.js`:
+```javascript
+const nextConfig = {
+  transpilePackages: ['hazo_config'],
+}
+```
+
+## 8. Verify
+
+- [ ] `import { ConfigViewer } from 'hazo_config'` resolves without errors
+- [ ] `import { HazoConfig } from 'hazo_config/server'` works in server code
+- [ ] Tailwind classes from hazo_config render correctly (check backgrounds, borders)
+- [ ] Sensitive fields are masked in ConfigViewer/ConfigEditor

package/package.json

@@ -1,12 +1,14 @@
 {
   "name": "hazo_config",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "description": "Config wrapper with error handling",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
-    "dist"
+    "dist",
+    "CHANGE_LOG.md",
+    "SETUP_CHECKLIST.md"
   ],
   "exports": {
     ".": {
@@ -28,6 +30,7 @@
   },
   "scripts": {
     "build": "tsc -p tsconfig.build.json",
+    "prepublishOnly": "npm run build",
     "storybook": "npx storybook dev -p 6006",
     "build-storybook": "npx storybook build",
     "test": "vitest run",
@@ -54,6 +57,9 @@
     "url": "https://github.com/pub12/hazo_config/issues"
   },
   "homepage": "https://github.com/pub12/hazo_config#readme",
+  "engines": {
+    "node": ">=18.0.0"
+  },
   "dependencies": {
     "@radix-ui/react-alert-dialog": "^1.1.15",
     "@radix-ui/react-dialog": "^1.1.15",
@@ -92,8 +98,8 @@
     "vitest": "^1.6.1"
   },
   "peerDependencies": {
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0",
+    "react": "^18.0.0 || ^19.0.0",
+    "react-dom": "^18.0.0 || ^19.0.0",
     "tailwindcss": "^3.0.0"
   },
   "peerDependenciesMeta": {