@notform/nuxt 0.0.0-stage → 4.0.0-alpha.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Favour Emeka
+
+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

@@ -1,3 +1,53 @@
-# Temporary Holding Version
+<h1 align="center">
+  <img alt="NotForm Logo" loading="lazy" width="50" height="50" decoding="async" data-nimg="1" style="color:transparent" src="https://notformdocs.vercel.app/favicon.svg">
+  </br>
+  NotForm for Nuxt
+</h1>
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+<p align="center">
+  Official Nuxt integration for NotForm.
+</p>
+
+This module registers NotForm's components and composable so you can use them in any page or component without importing them. The APIs are exactly the ones in the core package.
+
+## Install
+
+```bash
+pnpm add @notform/nuxt
+```
+
+The module brings `notform` with it. Add `notform` to your own dependencies only if you want to import its types directly.
+
+Register the module in `nuxt.config.ts`:
+
+```ts
+export default defineNuxtConfig({
+  modules: ['@notform/nuxt'],
+})
+```
+
+## Auto-imports
+
+The module registers `Form`, `Field`, `ArrayField`, `FieldError`, and `useForm`. 
+
+These APIs are otherwise identical to the vue package.
+
+Use `notform.aliases` to change selected names:
+
+```ts
+export default defineNuxtConfig({
+  modules: ['@notform/nuxt'],
+  notform: {
+    aliases: {
+      Form: 'AppForm',
+      useForm: 'useAppForm',
+    },
+  },
+})
+```
+
+See the [Nuxt guide](https://notformdocs.vercel.app/docs/getting-started/nuxt-module) for setup details.
+
+## License
+
+MIT © [Favour Emeka](https://github.com/favorodera)

package/dist/module.d.mts

@@ -0,0 +1,11 @@
+import * as _nuxt_schema from '@nuxt/schema';
+
+declare const componentNames: readonly ["Form", "Field", "ArrayField", "FieldError"];
+declare const composableName: "useForm";
+interface ModuleOptions {
+    aliases?: Partial<Record<typeof componentNames[number] | typeof composableName, string>>;
+}
+declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
+
+export { _default as default };
+export type { ModuleOptions };

package/dist/module.json

@@ -0,0 +1,12 @@
+{
+  "compatibility": {
+    "nuxt": ">=4.0.0"
+  },
+  "configKey": "notform",
+  "name": "@notform/nuxt",
+  "version": "4.0.0-alpha.0",
+  "builder": {
+    "@nuxt/module-builder": "1.0.3",
+    "unbuild": "unknown"
+  }
+}

package/dist/module.mjs

@@ -0,0 +1,40 @@
+import { defineNuxtModule, createResolver, addComponent, addImports } from '@nuxt/kit';
+
+const name = "@notform/nuxt";
+const version = "4.0.0-alpha.0";
+const packageJson = {
+	name: name,
+	version: version};
+
+const componentNames = ["Form", "Field", "ArrayField", "FieldError"];
+const composableName = "useForm";
+const module$1 = defineNuxtModule({
+  meta: {
+    compatibility: { nuxt: ">=4.0.0" },
+    configKey: "notform",
+    name: packageJson.name,
+    version: packageJson.version
+  },
+  async setup(options) {
+    const { resolvePath } = createResolver(import.meta.url);
+    const corePackagePath = await resolvePath("notform");
+    for (const componentExportName of componentNames) {
+      const registeredComponentName = options.aliases?.[componentExportName] ?? componentExportName;
+      addComponent({
+        export: componentExportName,
+        filePath: corePackagePath,
+        name: registeredComponentName,
+        priority: 1
+      });
+    }
+    const registeredComposableName = options.aliases?.[composableName] ?? composableName;
+    addImports({
+      as: registeredComposableName,
+      from: corePackagePath,
+      name: composableName,
+      priority: 1
+    });
+  }
+});
+
+export { module$1 as default };

package/dist/types.d.mts

@@ -0,0 +1,3 @@
+export { default } from './module.mjs'
+
+export { type ModuleOptions } from './module.mjs'

package/package.json

@@ -1,6 +1,66 @@
 {
   "name": "@notform/nuxt",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "type": "module",
+  "version": "4.0.0-alpha.0",
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "description": "Official Nuxt integration for NotForm.",
+  "author": "Favour Emeka <favorodera@gmail.com>",
+  "license": "MIT",
+  "funding": "https://github.com/sponsors/favorodera",
+  "homepage": "https://notformdocs.vercel.app/",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/favorodera/notform.git"
+  },
+  "bugs": {
+    "url": "https://github.com/favorodera/notform/issues"
+  },
+  "keywords": [
+    "notform",
+    "vue",
+    "nuxt",
+    "form",
+    "standard-schema"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/types.d.mts",
+      "import": "./dist/module.mjs"
+    }
+  },
+  "main": "./dist/module.mjs",
+  "typesVersions": {
+    "*": {
+      ".": [
+        "./dist/types.d.mts"
+      ]
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=24.0.0"
+  },
+  "dependencies": {
+    "@nuxt/kit": "^4.6.4",
+    "notform": "4.0.0-alpha.0"
+  },
+  "devDependencies": {
+    "@nuxt/module-builder": "^1.0.3",
+    "@nuxt/schema": "^4.6.4",
+    "@types/node": "^26.6.5",
+    "nuxt": "^4.6.4",
+    "vue-tsc": "^3.3.13"
+  },
+  "scripts": {
+    "build": "nuxt-module-build prepare && nuxt-module-build build",
+    "dev": "nuxt-module-build prepare && nuxt-module-build build --stub",
+    "lint": "nuxt-module-build prepare && eslint .",
+    "lint:fix": "nuxt-module-build prepare && eslint . --fix",
+    "typecheck": "nuxt-module-build prepare && vue-tsc --noEmit"
+  }
 }