@signal24/vue-foundation 4.30.10 → 4.31.0

package/.oxlintrc.json

@@ -0,0 +1,39 @@
+{
+    "plugins": ["typescript", "unicorn", "oxc", "vitest", "promise", "import"],
+    "env": {
+        "builtin": true,
+        "es2025": true,
+        "commonjs": true,
+        "node": true
+    },
+    "ignorePatterns": ["dist/", ".yarn/", "src/openapi-client-generated/"],
+    "rules": {
+        "no-array-constructor": "error",
+        "no-case-declarations": "error",
+        "no-empty": "error",
+        "no-fallthrough": "error",
+        "no-prototype-builtins": "error",
+        "no-redeclare": "error",
+        "no-regex-spaces": "error",
+        "no-unused-expressions": "error",
+        "no-var": "error",
+        "prefer-rest-params": "error",
+        "prefer-spread": "error",
+        "typescript/ban-ts-comment": "error",
+        "typescript/no-empty-object-type": "error",
+        "typescript/no-explicit-any": "error",
+        "typescript/no-namespace": "error",
+        "typescript/no-require-imports": "error",
+        "typescript/no-unnecessary-type-constraint": "error",
+        "typescript/no-unsafe-function-type": "error",
+        "typescript/prefer-namespace-keyword": "error"
+    },
+    "overrides": [
+        {
+            "files": ["tests/**/*.spec.ts"],
+            "rules": {
+                "typescript/no-explicit-any": "off"
+            }
+        }
+    ]
+}

package/CLAUDE.md

@@ -0,0 +1,64 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code when working with this repository.
+
+## Project Overview
+
+`@signal24/vue-foundation` is a Vue 3 component library (components, directives, helpers, hooks) distributed as an ES module with TypeScript types. See `README.md` for full API documentation.
+
+## Commands
+
+```bash
+yarn build          # Clean dist, Vite build, generate types
+yarn build:watch    # Rebuild on file changes
+yarn demo           # Run demo app for testing components
+yarn dev            # Vite dev server
+yarn test:unit      # Run unit tests (Vitest)
+yarn test:types     # Type checking (vue-tsc)
+yarn lint           # ESLint with auto-fix
+yarn format         # Prettier
+```
+
+## Architecture
+
+```
+src/
+  index.ts              # Main entry, exports everything, installVf()
+  config.ts             # Global options (configureVf)
+  types.ts              # Utility types (Branded, PickRequired, etc.)
+  components/           # Vue components + overlay system
+    overlay-container.ts  # Core overlay management (presentOverlay, etc.)
+    overlay-anchor.vue    # Positioned overlays
+    overlay-types.ts      # Anchor option types
+    vf-modal.vue          # Base modal shell
+    vf-alert-modal.vue    # Alert/confirm dialog
+    alert-helpers.ts      # showAlert, showConfirm, showWait, etc.
+    modal-helpers.ts      # vfModalRef()
+    vf-toast.vue          # Toast notification
+    toast-helpers.ts      # showToast()
+    vf-smart-select.vue   # Searchable select with generics
+    vf-ez-smart-select.vue # Simplified smart select
+    vf-ajax-select.vue    # Async-loading select
+  directives/           # v-autofocus, v-tooltip, v-hotkey, v-datetime, etc.
+    index.ts              # registerDirectives() + type augmentation
+  helpers/              # Pure utility functions
+  hooks/                # Composition API hooks (infinite-scroll, resize-watcher)
+  filters/              # Display formatting (createFilters)
+  vite-plugins/         # OpenAPI client generator Vite plugin
+```
+
+## Key Patterns
+
+- **Overlay system**: Components with a `callback` prop are shown via `presentOverlay()`, which wraps them in a Promise. The callback prop is injected automatically.
+- **Error convention**: `UserError` = user-facing (shown directly), other errors = system errors (wrapped with support text). `handleErrorAndAlert()` dispatches to the global error handler and shows an alert.
+- **Masking**: `maskForm()` / `maskComponent()` disable UI during async ops and return an unmask function.
+- **Directives**: All registered in `registerDirectives()`. State is stored on elements via Symbols.
+- **Generics**: `VfSmartSelect` and `VfAjaxSelect` use Vue 3.3+ `defineProps` with generics.
+
+## Build Details
+
+- Vite library mode, ES format only
+- External deps: `vue`, `@vue/shared`, `date-fns`, `lodash`, `@signal24/openapi-client-codegen`
+- SCSS with `api: 'modern-compiler'`
+- Vite-plugins have separate tsconfig (`tsconfig.vite-plugins.json`)
+- Main branch is `develop`

package/README.md

@@ -0,0 +1,43 @@
+# @signal24/vue-foundation
+
+A Vue 3 component library providing common components, directives, helpers, and hooks for building applications. Distributed as an ES module with full TypeScript type definitions.
+
+## Documentation
+
+Full documentation and live interactive demos: **[signal24.github.io/vue-foundation](https://signal24.github.io/vue-foundation/)**
+
+## Quick Start
+
+```bash
+yarn add @signal24/vue-foundation
+# Peer dependencies
+yarn add vue date-fns lodash
+```
+
+```typescript
+import { createApp } from 'vue';
+import { installVf, configureVf, OverlayContainer } from '@signal24/vue-foundation';
+import '@signal24/vue-foundation/dist/vue-foundation.css';
+
+import App from './App.vue';
+
+const app = createApp(App);
+installVf(app);
+configureVf({});
+app.mount('#app');
+```
+
+See the [Getting Started guide](https://signal24.github.io/vue-foundation/guide/getting-started) for full setup instructions.
+
+## What's Included
+
+- **Components** — Modal system, searchable selects, toast notifications, overlay management
+- **Directives** — v-tooltip, v-hotkey, v-datetime, v-confirm-button, v-infinite-scroll, and more
+- **Helpers** — Error handling, form masking, context menus, string/number/object utilities
+- **Hooks** — useInfiniteScroll, useResizeWatcher
+- **Filters** — Display formatting via createFilters()
+- **Types** — Branded types, PickRequired, PickOptional, and more
+
+## License
+
+MIT

package/demo/vite.config.ts

@@ -1,8 +1,8 @@
 import { fileURLToPath, URL } from 'node:url';
 
-import eslintPlugin from '@nabla/vite-plugin-eslint';
 import { openapiClientGeneratorPlugin } from '@signal24/vue-foundation/vite-plugins';
 import vue from '@vitejs/plugin-vue';
+import oxlintPlugin from 'vite-plugin-oxlint';
 import { defineConfig } from 'vite';
 
 // https://vitejs.dev/config/
@@ -14,7 +14,7 @@ export default defineConfig({
         // without that, we lose context tracking through otel and Sentry errors and traces are no longer correlated
         target: 'es2015'
     },
-    plugins: [vue(), eslintPlugin(), openapiClientGeneratorPlugin()],
+    plugins: [vue(), oxlintPlugin(), openapiClientGeneratorPlugin()],
     resolve: {
         alias: {
             '@': fileURLToPath(new URL('../src', import.meta.url))

package/dist/src/vite-plugins/index.js

@@ -1,2 +1 @@
-// todo: dunno why this needs .JS, but Vite panics with ERR_MODULE_NOT_FOUND if we don't
 export * from './vite-openapi-plugin.js';