@ciwergrp/nuxid 1.0.5 → 1.1.0

package/README.md

@@ -1,37 +1,40 @@
 # Nuxid – Nuxt Essentials
 
-Nuxid bundles a handful of productivity helpers for Nuxt projects: icon defaults, lodash auto-imports, Element Plus validation helpers, and a flexible form composable. Enable the pieces you need and keep the rest off.
+Nuxid bundles a set of productivity helpers for Nuxt projects: lodash auto-imports, Element Plus-friendly validation rules, a form composable, helper utilities, optional icon defaults, Element Plus setup, and Pinia integration. Enable the pieces you need and keep the rest off.
 
 ## Quick start
 
 Install and register the module:
 
 ```bash
-pnpm add nuxid
+pnpm add @ciwergrp/nuxid
 ```
 
 ```ts
 // nuxt.config.ts
 export default defineNuxtConfig({
-  modules: ['nuxid'],
+  modules: ['@ciwergrp/nuxid'],
   nuxid: {
-    // lodash, validator, icon, and form are enabled by default
+    // lodash, validator, form, helper, and pinia are enabled by default
   },
 })
 ```
 
 ## Features
 
-- **Icon defaults** (`@nuxt/icon` dependency): component name `KIcon`, size `1.25em`, base class `align-middle inline-block text-current`, mode `svg`. Override via `nuxid.icon`, or disable with `nuxid.icon = false`.
-- **Lodash auto-imports**: imports from `lodash-es` with prefix `ki` (e.g. `kiDebounce`), skips prefix for names starting with `is`. Configure with:
+- **Lodash auto-imports** (enabled by default): imports from `lodash-es` with prefix `ki` (e.g. `kiDebounce`), skips prefix for names starting with `is`. Configure with:
   - `enabled` (default `true`)
   - `prefix` (`false | string`, default `'ki'`)
   - `prefixSkip` (`string | string[] | false`, default `'is'`)
   - `upperAfterPrefix` (`boolean`, default `true`)
   - `exclude` (`string[]`)
   - `alias` (`Array<[from, to]>`)
-- **Validator helpers**: Element Plus friendly `createValidationRules` plus `ValidationRule` and `ValidationOptions` types. Auto-imported when enabled.
-- **Form composable**: `useForm` wraps `$fetch`, handles `processing`, `errors`, `response`, and builds `FormData` automatically (or always when `alwaysFormData: true`). Auto-imported when enabled.
+- **Validator helpers** (enabled by default): Element Plus friendly `createValidationRules` plus `ValidationRule` and `ValidationOptions` types. Auto-imported when enabled.
+- **Form composable** (enabled by default): `useHttp` wraps `$fetch`, handles `processing`, `errors`, `response`, and builds `FormData` automatically (or always when `alwaysFormData: true`). Auto-imported when enabled.
+- **Helper utilities** (enabled by default): array/object/number/string helpers with configurable factory (`number().abbreviate()`) or prefixed (`NumberAbbreviate()`) styles, locale lookups, and currency defaults.
+- **Pinia integration** (enabled by default): injects Pinia, auto-imports core helpers (`defineStore`, `storeToRefs`, etc.), and auto-imports stores from `stores` by default.
+- **Icon defaults** (disabled by default): installs `@nuxt/icon` with default component name `KIcon`, size `1.25em`, base class `align-middle inline-block text-current`, mode `svg`. Configure via `nuxid.icon.config`.
+- **Element Plus module** (disabled by default): installs `@element-plus/nuxt` with your provided config.
 
 ## Usage snippets
 
@@ -56,7 +59,7 @@ const rules = createValidationRules(
 **Form example**
 
 ```ts
-const form = useForm({ name: '', avatar: null }, { alwaysFormData: false })
+const form = useHttp({ name: '', avatar: null }, { alwaysFormData: false })
 
 await form.post('/api/profile')
 
@@ -65,23 +68,44 @@ if (form.errors) {
 }
 ```
 
+**Helper example**
+
+```ts
+const price = number().currency(4200)
+const slug = string().slug('Hello World')
+```
+
+**Pinia example**
+
+```ts
+export const useCartStore = defineStore('cart', {
+  state: () => ({ items: [] }),
+})
+```
+
 ## Configuration reference
 
 ```ts
 export default defineNuxtConfig({
-  modules: ['nuxid'],
+  modules: ['@ciwergrp/nuxid'],
   nuxid: {
     icon: {
-      enabled: true,
-      componentName: 'KIcon',
-      size: '1.25em',
-      class: 'align-middle inline-block text-current',
-      mode: 'svg',
-      provider: undefined,
-      collections: undefined,
-      aliases: undefined,
-      fallbacks: undefined,
-      extend: undefined,
+      enabled: false,
+      config: {
+        componentName: 'KIcon',
+        size: '1.25em',
+        class: 'align-middle inline-block text-current',
+        mode: 'svg',
+        provider: undefined,
+        collections: undefined,
+        aliases: undefined,
+        fallbacks: undefined,
+        extend: undefined,
+      },
+    },
+    elementPlus: {
+      enabled: false,
+      config: {},
     },
     lodash: {
       enabled: true,
@@ -97,6 +121,20 @@ export default defineNuxtConfig({
     form: {
       enabled: true,
     },
+    helper: {
+      enabled: true,
+      config: {
+        style: 'factory',
+        localeSource: 'cookie',
+        localeKey: 'lang',
+        localeFallback: 'en',
+        defaultCurrency: 'USD',
+      },
+    },
+    pinia: {
+      enabled: true,
+      storesDirs: ['stores'],
+    },
   },
 })
 ```

package/dist/module.d.mts

@@ -1,6 +1,6 @@
 import * as _nuxt_schema from '@nuxt/schema';
 export * from '../dist/runtime/form.js';
-export { default as useForm } from '../dist/runtime/form.js';
+export { default as useHttp } from '../dist/runtime/form.js';
 export * from '../dist/runtime/validator.js';
 export * from '../dist/runtime/helper/index.js';
 
@@ -173,6 +173,29 @@ interface PiniaOptions {
 }
 type PiniaFeatureInput = boolean | Partial<PiniaOptions> | undefined;
 
+interface VueUseOptions {
+    /**
+     * Enable VueUse integration
+     * @default true
+     */
+    enabled: boolean;
+    /**
+     * Enable auto-imports from @vueuse/nuxt
+     * @default true
+     */
+    autoImports: boolean;
+    /**
+     * Register VueUse SSR handlers
+     * @default false
+     */
+    ssrHandlers: boolean;
+    /**
+     * Extra VueUse functions to exclude from auto-imports
+     */
+    exclude: string[];
+}
+type VueUseFeatureInput = boolean | Partial<VueUseOptions> | undefined;
+
 interface ModuleOptions {
     lodash?: LodashFeatureInput;
     validator?: ValidatorFeatureInput;
@@ -181,6 +204,7 @@ interface ModuleOptions {
     elementPlus?: ElementPlusFeatureInput;
     helper?: HelperFeatureInput;
     pinia?: PiniaFeatureInput;
+    vueuse?: VueUseFeatureInput;
 }
 declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
 

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "@ciwergrp/nuxid",
   "configKey": "nuxid",
-  "version": "1.0.5",
+  "version": "1.1.0",
   "builder": {
     "@nuxt/module-builder": "1.0.2",
     "unbuild": "3.6.1"

package/dist/module.mjs

@@ -2,7 +2,7 @@ import { addImports, addPlugin, addImportsDir, defineNuxtModule, createResolver,
 import * as lodash from 'lodash-es';
 import { fileURLToPath } from 'node:url';
 export * from '../dist/runtime/form.js';
-export { default as useForm } from '../dist/runtime/form.js';
+export { default as useHttp } from '../dist/runtime/form.js';
 export * from '../dist/runtime/validator.js';
 export * from '../dist/runtime/helper/index.js';
 
@@ -142,8 +142,8 @@ function registerFormFeature(options, { from }) {
   if (!options.enabled) {
     return;
   }
-  addImports({ name: "default", as: "useForm", from });
-  addImports({ name: "UseForm", as: "UseForm", from, type: true });
+  addImports({ name: "default", as: "useHttp", from });
+  addImports({ name: "UseHttp", as: "UseHttp", from, type: true });
   addImports({ name: "NuxidFormOptions", as: "NuxidFormOptions", from, type: true });
 }
 
@@ -373,6 +373,80 @@ function registerPiniaFeature(options, nuxt, { runtimeDir, payload, plugin, comp
   }
 }
 
+const disabledFunctions = [
+  "toRefs",
+  "toRef",
+  "toValue",
+  "useFetch",
+  "useCookie",
+  "useHead",
+  "useStorage",
+  "useImage",
+  "useTitle"
+];
+
+const vueuseDefaults = {
+  enabled: false,
+  autoImports: true,
+  ssrHandlers: false,
+  exclude: []
+};
+function resolveVueUseOptions(input) {
+  if (input === false) {
+    return { ...vueuseDefaults, enabled: false };
+  }
+  const overrides = typeof input === "boolean" || input === void 0 ? {} : input;
+  return {
+    ...vueuseDefaults,
+    ...overrides,
+    enabled: overrides?.enabled ?? true,
+    autoImports: overrides?.autoImports ?? vueuseDefaults.autoImports,
+    ssrHandlers: overrides?.ssrHandlers ?? vueuseDefaults.ssrHandlers,
+    exclude: [
+      ...disabledFunctions,
+      ...vueuseDefaults.exclude,
+      ...overrides?.exclude ?? []
+    ]
+  };
+}
+function registerVueUseFeature(options, nuxt) {
+  if (!options.enabled || !options.autoImports || !options.exclude.length) {
+    return;
+  }
+  const excluded = new Set(options.exclude);
+  const hasFrom = (value) => {
+    if (typeof value !== "object" || value === null || !("from" in value)) {
+      return false;
+    }
+    return typeof value.from === "string";
+  };
+  nuxt.hook("imports:sources", (sources) => {
+    for (let index = sources.length - 1; index >= 0; index -= 1) {
+      const source = sources[index];
+      const sourceFrom = source.from;
+      const hasVueUseSource = typeof sourceFrom === "string" && sourceFrom.startsWith("@vueuse/");
+      const hasVueUseImport = Array.isArray(source.imports) && source.imports.some((item) => typeof item === "object" && item !== null && hasFrom(item) && item.from.startsWith("@vueuse/"));
+      if (!hasVueUseSource && !hasVueUseImport) {
+        continue;
+      }
+      const filteredImports = (source.imports ?? []).filter((item) => {
+        if (typeof item === "string") {
+          return !excluded.has(item);
+        }
+        if (typeof item === "object" && item !== null && "name" in item) {
+          return !excluded.has(item.name);
+        }
+        return true;
+      });
+      if (!filteredImports.length) {
+        sources.splice(index, 1);
+        continue;
+      }
+      source.imports = filteredImports;
+    }
+  });
+}
+
 const module$1 = defineNuxtModule({
   meta: {
     name: "@ciwergrp/nuxid",
@@ -382,9 +456,6 @@ const module$1 = defineNuxtModule({
     const dependencies = {
       "@sentry/nuxt": {
         version: "10.32.1"
-      },
-      "@vueuse/nuxt": {
-        version: "14.1.0"
       }
     };
     return dependencies;
@@ -398,6 +469,7 @@ const module$1 = defineNuxtModule({
     const elementPlusOptions = resolveElementPlusOptions(options.elementPlus);
     const helperOptions = resolveHelperOptions(options.helper);
     const piniaOptions = resolvePiniaOptions(options.pinia);
+    const vueuseOptions = resolveVueUseOptions(options.vueuse);
     if (iconOptions.enabled) {
       await installModule("@nuxt/icon", iconOptions.config);
     }
@@ -432,6 +504,13 @@ const module$1 = defineNuxtModule({
         resolver
       });
     }
+    if (vueuseOptions.enabled) {
+      await installModule("@vueuse/nuxt", {
+        autoImports: vueuseOptions.autoImports,
+        ssrHandlers: vueuseOptions.ssrHandlers
+      });
+      registerVueUseFeature(vueuseOptions, nuxt);
+    }
     addPlugin(resolver.resolve("./runtime/plugin"));
   }
 });

package/dist/runtime/form.d.ts

@@ -1,7 +1,7 @@
 import type { HTTPMethod } from 'h3';
 import type { NitroFetchOptions, NitroFetchRequest } from 'nitropack';
 export type FormFetcher = <T = any>(request: NitroFetchRequest, opts?: NitroFetchOptions<NitroFetchRequest>) => Promise<T>;
-export interface UseForm<DefaultResponseType = any> {
+export interface UseHttp<DefaultResponseType = any> {
     _method?: HTTPMethod;
     submit: <APIResponseType = DefaultResponseType>(method: HTTPMethod, url: NitroFetchRequest, options?: NitroFetchOptions<NitroFetchRequest>) => Promise<APIResponseType>;
     post: <APIResponseType = DefaultResponseType>(url: NitroFetchRequest, options?: NitroFetchOptions<NitroFetchRequest>) => Promise<APIResponseType>;
@@ -18,4 +18,4 @@ export interface FormComposableOptions {
     fetcher?: FormFetcher;
     fetchOptions?: NitroFetchOptions<NitroFetchRequest>;
 }
-export default function useForm<TData extends object, DefaultResponseType = any>(initialData: TData, formOptions?: FormComposableOptions): TData & UseForm<DefaultResponseType>;
+export default function useHttp<TData extends object, DefaultResponseType = any>(initialData: TData, formOptions?: FormComposableOptions): TData & UseHttp<DefaultResponseType>;

package/dist/runtime/form.js

@@ -17,7 +17,7 @@ function normalizeValue(value) {
   }
   return value;
 }
-export default function useForm(initialData, formOptions) {
+export default function useHttp(initialData, formOptions) {
   const form = reactive({
     ...initialData,
     response: null,

package/dist/runtime/plugin.js

@@ -1,4 +1,3 @@
 import { defineNuxtPlugin } from "#app";
 export default defineNuxtPlugin((_nuxtApp) => {
-  console.log("Plugin injected!");
 });

package/dist/types.d.mts

@@ -1,4 +1,4 @@
-export { type useForm } from '../dist/runtime/form.js'
+export { type useHttp } from '../dist/runtime/form.js'
 
 export { default } from './module.mjs'
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ciwergrp/nuxid",
-  "version": "1.0.5",
+  "version": "1.1.0",
   "description": "All-in-one essential modules for Nuxt",
   "repository": {
     "type": "git",
@@ -75,7 +75,8 @@
     "nuxt": "^4.2.1",
     "typescript": "~5.9.3",
     "vitest": "^4.0.13",
-    "vue-tsc": "^3.1.5"
+    "vue-tsc": "^3.1.5",
+    "@vueuse/nuxt": "14.1.0"
   },
   "scripts": {
     "dev": "npm run dev:prepare && nuxi dev playground",