feat!: nuxt and vue plugins

Novout · Novout · commit d867a22d1816 · 2025-10-29T21:21:12.000-03:00
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,5 @@
 .vscode
+.nuxt
 node_modules
 dist
 coverage
diff --git a/README.md b/README.md
@@ -11,6 +11,7 @@
 
 ## Features
 
+- ✅ Vue and Nuxt Plugin
 - ✅ Local or File Object
 - ✅ Support JSON
 - ✅ Exclude Wrong Data
diff --git a/package.json b/package.json
@@ -1,5 +1,5 @@
 {
-	"name": "nvton-monorepo",
+	"name": "nvton",
 	"version": "0.0.0",
 	"repository": {
 		"type": "git",
@@ -16,8 +16,10 @@
 	},
 	"private": true,
 	"scripts": {
-		"build": "pnpm run build:core",
+		"build": "pnpm -r --filter=\"./packages/**/*\" run build",
 		"build:core": "pnpm -C packages/nvton run build",
+		"build:vue": "pnpm -C packages/vue run build",
+		"build:nuxt": "pnpm -C packages/nuxt run build",
 		"format": "prettier . --write",
 		"test": "vitest run --coverage",
 		"test:dev": "vitest",
@@ -27,13 +29,6 @@
 		"publish-ci": "tsx scripts/publish-ci.ts",
 		"release": "tsx scripts/release.ts"
 	},
-	"dependencies": {
-		"c12": "^3.3.1",
-		"defu": "^6.1.4",
-		"destr": "^2.0.5",
-		"fs-extra": "^11.3.2",
-		"pathe": "^2.0.3"
-	},
 	"devDependencies": {
 		"@types/fs-extra": "^11.0.4",
 		"@types/node": "^24.9.2",
@@ -42,10 +37,10 @@
 		"generi": "^1.4.1",
 		"prettier": "^3.6.2",
 		"tinyglobby": "^0.2.15",
-		"tsdown": "^0.15.11",
+		"tsdown": "^0.15.12",
 		"tsx": "^4.20.6",
 		"typescript": "^5.9.3",
-		"vitest": "^4.0.4",
+		"vitest": "^4.0.5",
 		"zx": "^8.8.5"
 	}
 }
diff --git a/packages/nuxt/.nuxtrc b/packages/nuxt/.nuxtrc
@@ -0,0 +1,2 @@
+imports.autoImport=false
+typescript.includeWorkspace=true
diff --git a/packages/nuxt/README.md b/packages/nuxt/README.md
@@ -0,0 +1,61 @@
+# Nuxt4 NVTON Module
+
+## Setup
+
+```bash
+npm i nuxt-nvton
+```
+
+```js
+// nuxt.config.ts
+modules: [
+  'nuxt-nvton'
+]
+```
+
+## Example
+
+```ts
+<script setup>
+import { useNuxtApp } from '#app';
+
+const { $nvton } = useNuxtApp()
+
+$pdf.new({
+  plugins: [
+    {
+      page: [
+        // simple counter footer
+        ({ Text }, context, current, total) => {
+          // render in every page
+          Text(`${current}/${total}`, { fontSize: 20 }, {
+            x: context.width / 2,
+            y: context.height - context.margins.bottom
+          })
+        },
+        // simple header
+        ({ Text }, context, current, total) => {
+          // render in every page
+          Text('A Simple Header', {}, {
+            x: context.width / 2,
+            y: context.margins.top - 20
+          })
+        }
+      ]
+    }
+  ]
+})
+
+$pdf.add([
+  { raw: 'Hello NUXT!', text: { fontSize: 22 }},
+])
+
+$pdf.run().then(blob => {
+  const iframe = document.querySelector('#pdf')
+
+  iframe.src = blob
+}).catch((err) => {
+  console.error(err)
+})
+</script>
+```
diff --git a/packages/nuxt/package.json b/packages/nuxt/package.json
@@ -0,0 +1,52 @@
+{
+	"name": "nuxt-nvton",
+	"sideEffects": false,
+	"author": {
+		"email": "novout@hotmail.com",
+		"name": "Giovane Cardoso",
+		"url": "https://github.com/Novout"
+	},
+	"version": "0.0.0",
+	"repository": "https://github.com/Novout/nvton",
+	"description": "A PDF document generator to your Nuxt application.",
+	"engines": {
+		"node": ">=14.16"
+	},
+	"bugs": {
+		"url": "https://github.com/betterwrite/Novout/nvton"
+	},
+	"keywords": [
+		"nvton",
+		"nuxt4"
+	],
+	"license": "MIT",
+	"type": "module",
+	"exports": {
+		".": {
+			"import": "./dist/module.mjs",
+			"require": "./dist/module.cjs"
+		}
+	},
+	"main": "./dist/module.cjs",
+	"types": "./dist/types.d.ts",
+	"files": [
+		"dist",
+		"package.json"
+	],
+	"scripts": {
+		"todo:build": "nuxi prepare && nuxt-module-build && nuxi prepare playground",
+		"prepack": "nuxi prepare && nuxt-module-build && nuxi prepare playground"
+	},
+	"dependencies": {
+		"@nuxt/kit": "^4.2.0",
+		"defu": "catalog:",
+		"nvton": "workspace:*"
+	},
+	"devDependencies": {
+		"@nuxt/module-builder": "^1.0.2",
+		"@nuxt/schema": "^4.2.0",
+		"@nuxtjs/eslint-config-typescript": "^12.1.0",
+		"eslint": "^8.42.0",
+		"nuxt": "^4.2.0"
+	}
+}
diff --git a/packages/nuxt/src/module.ts b/packages/nuxt/src/module.ts
@@ -0,0 +1,39 @@
+import { fileURLToPath } from 'url';
+import { defineNuxtModule, addPlugin, createResolver } from '@nuxt/kit';
+import { type Nvton, type NvtonOptions, DEFAULT_CONFIG } from 'nvton';
+import { defu } from 'defu';
+
+export default defineNuxtModule<NvtonOptions>({
+	meta: {
+		name: 'nuxt-nvton',
+		configKey: 'nvton',
+		compatibility: {
+			nuxt: '>=4.0.0',
+		},
+	},
+	defaults: DEFAULT_CONFIG,
+	setup(options, nuxt) {
+		const { resolve } = createResolver(import.meta.url);
+		const runtimeDir = fileURLToPath(new URL('./runtime', import.meta.url));
+
+		nuxt.options.build.transpile.push(runtimeDir);
+		nuxt.options.runtimeConfig.public.nvton = defu(
+			nuxt.options.runtimeConfig.public.nvton ?? DEFAULT_CONFIG,
+			options
+		);
+
+		addPlugin(resolve(runtimeDir, 'plugin'));
+	},
+});
+
+declare module '#app' {
+	interface NuxtApp {
+		$nvton: Nvton;
+	}
+}
+
+declare module 'vue' {
+	interface ComponentCustomProperties {
+		$nvton: Nvton;
+	}
+}
diff --git a/packages/nuxt/src/runtime/plugin.ts b/packages/nuxt/src/runtime/plugin.ts
@@ -0,0 +1,6 @@
+import { defineNuxtPlugin } from '#app';
+import { nvton } from 'nvton';
+
+export default defineNuxtPlugin(({ provide }) => {
+	provide('nvton', nvton(false));
+});
diff --git a/packages/nuxt/tsconfig.json b/packages/nuxt/tsconfig.json
@@ -0,0 +1,3 @@
+{
+	"extends": "./.nuxt/tsconfig.json"
+}
diff --git a/packages/nvton/package.json b/packages/nvton/package.json
@@ -44,5 +44,12 @@
 		"dev": "tsdown",
 		"dev:watch": "tsdown --watch",
 		"build": "tsdown --minify"
+	},
+	"dependencies": {
+		"c12": "catalog:",
+		"defu": "catalog:",
+		"destr": "catalog:",
+		"fs-extra": "catalog:",
+		"pathe": "catalog:"
 	}
 }
diff --git a/packages/nvton/src/data.ts b/packages/nvton/src/data.ts
@@ -9,9 +9,12 @@ export class NVTON {
 	private data: Map<LexerKey, unknown>;
 	private options: NvtonOptions = DEFAULT_CONFIG;
 
-	private loadDefaultConfig(options?: NvtonOptions): Awaitable<void> {
+	private loadDefaultConfig(
+		options?: NvtonOptions,
+		force: boolean = false
+	): Awaitable<void> {
 		try {
-			if (!isBrowser) {
+			if (!isBrowser && !force) {
 				return new Promise(async (res, rej) => {
 					const { config } = await loadConfig({
 						name: 'nvton',
@@ -31,23 +34,26 @@ export class NVTON {
 		}
 	}
 
-	constructor(lexeme: LexerResult, options?: NvtonOptions) {
+	constructor(lexeme?: LexerResult, options?: NvtonOptions) {
 		this.data = new Map();
 		this.loadDefaultConfig(options);
-		this.set(lexeme);
+		if (lexeme) this.load(lexeme);
 	}
 
-	private set(lexeme: LexerResult) {
+	public load(lexeme: LexerResult, options?: NvtonOptions) {
+		if (options) this.loadDefaultConfig(options, true);
+
 		lexeme.forEach((item) => {
-			if (Array.isArray(item)) this.set(item);
+			if (Array.isArray(item)) this.load(item);
 			else {
 				// TODO: support custom keys
 				this.data.set(item.key, item.data);
 			}
 		});
 	}
 
-	public get(target: string) {
+	// TODO: dynamic type in runtime value doens't exists
+	public get<T = unknown>(target: string) {
 		// TODO: simple language for deep search
 		return this.data.get(target);
 	}
diff --git a/packages/nvton/src/index.ts b/packages/nvton/src/index.ts
@@ -1,2 +1,3 @@
 export * from './pipeline';
 export * from './types';
+export { DEFAULT_CONFIG, MIMETYPE, EXTENSION } from './constants';
diff --git a/packages/nvton/src/pipeline.ts b/packages/nvton/src/pipeline.ts
@@ -1,8 +1,12 @@
 import { getFile, isBrowser } from './utils';
 import { lex } from './lexer';
 import { NVTON } from './data';
+import { NvtonOptions } from './types';
+import { DEFAULT_CONFIG } from './constants';
+
+const get = (raw: string | false, options?: NvtonOptions): NVTON => {
+	if (!raw) return new NVTON(undefined, options ?? DEFAULT_CONFIG);
 
-const get = (raw: string): NVTON => {
 	const isFilepath = raw.endsWith('.nvton');
 
 	if (isFilepath && isBrowser) {
@@ -19,7 +23,7 @@ const get = (raw: string): NVTON => {
 
 	const data = lex(resolved);
 
-	return new NVTON(data);
+	return new NVTON(data, options ?? DEFAULT_CONFIG);
 };
 
-export const nvton = (raw: string) => get(raw);
+export const nvton = (raw: string | false, options?: NvtonOptions) => get(raw, options);
diff --git a/packages/nvton/src/types.ts b/packages/nvton/src/types.ts
@@ -3,7 +3,7 @@ import { NVTON } from './data';
 export type Maybe<T = void> = T | undefined | null;
 export type Awaitable<T = void> = T | Promise<T>;
 
-export type Nvton = typeof NVTON;
+export type Nvton = NVTON;
 
 export type LexerType = 'object' | 'tuple' | 'function' | 'default';
 export type LexerKey = string | number;
diff --git a/packages/nvton/tsdown.config.ts b/packages/nvton/tsdown.config.ts
@@ -1,10 +1,14 @@
+import { readFileSync } from 'node:fs';
+import { fileURLToPath } from 'node:url';
 import { defineConfig } from 'tsdown';
 
+const pkgPath = fileURLToPath(new URL('./package.json', import.meta.url));
+const pkg = JSON.parse(readFileSync(pkgPath, 'utf-8'));
+
 export default defineConfig({
-	entry: 'src/index.ts',
-	format: ['esm', 'cjs'],
+	entry: ['src/index.ts'],
 	target: ['es2015', 'node18'],
 	clean: true,
 	dts: true,
-	external: [],
+	external: [...Object.keys(pkg.dependencies)],
 });
diff --git a/packages/vue/README.md b/packages/vue/README.md
@@ -0,0 +1,28 @@
+# Vue NVTON
+
+A NVTON plugin for Vue 3.x
+
+## Install
+
+`npm i vue-nvton`
+
+## Example
+
+```ts
+//...
+import { NVTONPlugin } from 'vue-nvton';
+//...
+const app = createApp(App);
+app.use(NVTONPlugin);
+app.mount('#app');
+
+// ...
+<script setup lang="ts">
+import { useNvton } from 'vue-nvton'
+
+const nvton = useNvton()
+nvton.load("[0, 1, ['key', 'value']]")
+
+const value = nvton.get<string>('key')
+</script>
+``` 
diff --git a/packages/vue/package.json b/packages/vue/package.json
diff --git a/packages/vue/src/index.ts b/packages/vue/src/index.ts
diff --git a/packages/vue/tsconfig.json b/packages/vue/tsconfig.json
diff --git a/packages/vue/tsdown.config.ts b/packages/vue/tsdown.config.ts
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml

-Original file line number
+Diff line change
@@ @@ -1,4 +1,5 @@ @@
 .vscode
 +.nuxt
 node_modules
 dist
 coverage
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+imports.autoImport=false`
	`2`	`+typescript.includeWorkspace=true`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "extends": "./.nuxt/tsconfig.json"`
	`3`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -44,5 +44,12 @@`
`44`	`44`	`"dev": "tsdown",`
`45`	`45`	`"dev:watch": "tsdown --watch",`
`46`	`46`	`"build": "tsdown --minify"`
	`47`	`+ },`
	`48`	`+ "dependencies": {`
	`49`	`+ "c12": "catalog:",`
	`50`	`+ "defu": "catalog:",`
	`51`	`+ "destr": "catalog:",`
	`52`	`+ "fs-extra": "catalog:",`
	`53`	`+ "pathe": "catalog:"`
`47`	`54`	`}`
`48`	`55`	`}`