@devcoffee/nuxt-core 1.0.0

package/README.md

@@ -0,0 +1,84 @@
+<!--
+Get your module up and running quickly.
+
+Find and replace all on all files (CMD+SHIFT+F):
+- Name: My Module
+- Package name: my-module
+- Description: My new Nuxt module
+-->
+
+# My Module
+
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![License][license-src]][license-href]
+[![Nuxt][nuxt-src]][nuxt-href]
+
+My new Nuxt module for doing amazing things.
+
+- [✨ &nbsp;Release Notes](/CHANGELOG.md)
+<!-- - [🏀 Online playground](https://stackblitz.com/github/your-org/my-module?file=playground%2Fapp.vue) -->
+<!-- - [📖 &nbsp;Documentation](https://example.com) -->
+
+## Features
+
+<!-- Highlight some of the features your module provide here -->
+- ⛰ &nbsp;Foo
+- 🚠 &nbsp;Bar
+- 🌲 &nbsp;Baz
+
+## Quick Setup
+
+Install the module to your Nuxt application with one command:
+
+```bash
+npx nuxi module add my-module
+```
+
+That's it! You can now use My Module in your Nuxt app ✨
+
+
+## Contribution
+
+<details>
+  <summary>Local development</summary>
+  
+  ```bash
+  # Install dependencies
+  npm install
+  
+  # Generate type stubs
+  npm run dev:prepare
+  
+  # Develop with the playground
+  npm run dev
+  
+  # Build the playground
+  npm run dev:build
+  
+  # Run ESLint
+  npm run lint
+  
+  # Run Vitest
+  npm run test
+  npm run test:watch
+  
+  # Release new version
+  npm run release
+  ```
+
+</details>
+
+
+<!-- Badges -->
+[npm-version-src]: https://img.shields.io/npm/v/my-module/latest.svg?style=flat&colorA=020420&colorB=00DC82
+[npm-version-href]: https://npmjs.com/package/my-module
+
+[npm-downloads-src]: https://img.shields.io/npm/dm/my-module.svg?style=flat&colorA=020420&colorB=00DC82
+[npm-downloads-href]: https://npm.chart.dev/my-module
+
+[license-src]: https://img.shields.io/npm/l/my-module.svg?style=flat&colorA=020420&colorB=00DC82
+[license-href]: https://npmjs.com/package/my-module
+
+[nuxt-src]: https://img.shields.io/badge/Nuxt-020420?logo=nuxt.js
+[nuxt-href]: https://nuxt.com

package/dist/module.d.mts

@@ -0,0 +1,161 @@
+import * as _nuxt_schema from '@nuxt/schema';
+import { LogLevel, ConsolaOptions } from 'consola';
+
+type LoggingOptions = {
+    tag: string;
+    level: LogLevel;
+} & DeepPartial<Pick<ConsolaOptions, 'throttle' | 'throttleMin' | 'formatOptions'>>;
+type ModuleOptions = {
+    logging: {
+        server: LoggingOptions;
+        ssr: LoggingOptions;
+        client: LoggingOptions;
+    };
+};
+
+declare const configKey: "nuxtCore";
+declare module 'nuxt/schema' {
+    interface RuntimeConfig {
+        [configKey]: ModuleOptions;
+    }
+    interface PublicRuntimeConfig {
+        [configKey]: {
+            logging: ModuleOptions['logging']['client'];
+        };
+    }
+}
+declare const _default: _nuxt_schema.NuxtModule<{
+    logging?: {
+        server?: {
+            tag?: string | undefined;
+            level?: 0 | 1 | 2 | 3 | 4 | 5 | {
+                toString?: {} | undefined;
+                toFixed?: {} | undefined;
+                toExponential?: {} | undefined;
+                toPrecision?: {} | undefined;
+                valueOf?: {} | undefined;
+                toLocaleString?: {} | undefined;
+            } | undefined;
+            throttle?: number | undefined;
+            throttleMin?: number | undefined;
+            formatOptions?: {
+                [x: string]: unknown;
+                columns?: number | undefined;
+                date?: boolean | undefined;
+                colors?: boolean | undefined;
+                compact?: boolean | number | undefined;
+                errorLevel?: number | undefined;
+            } | undefined;
+        } | undefined;
+        ssr?: {
+            tag?: string | undefined;
+            level?: 0 | 1 | 2 | 3 | 4 | 5 | {
+                toString?: {} | undefined;
+                toFixed?: {} | undefined;
+                toExponential?: {} | undefined;
+                toPrecision?: {} | undefined;
+                valueOf?: {} | undefined;
+                toLocaleString?: {} | undefined;
+            } | undefined;
+            throttle?: number | undefined;
+            throttleMin?: number | undefined;
+            formatOptions?: {
+                [x: string]: unknown;
+                columns?: number | undefined;
+                date?: boolean | undefined;
+                colors?: boolean | undefined;
+                compact?: boolean | number | undefined;
+                errorLevel?: number | undefined;
+            } | undefined;
+        } | undefined;
+        client?: {
+            tag?: string | undefined;
+            level?: 0 | 1 | 2 | 3 | 4 | 5 | {
+                toString?: {} | undefined;
+                toFixed?: {} | undefined;
+                toExponential?: {} | undefined;
+                toPrecision?: {} | undefined;
+                valueOf?: {} | undefined;
+                toLocaleString?: {} | undefined;
+            } | undefined;
+            throttle?: number | undefined;
+            throttleMin?: number | undefined;
+            formatOptions?: {
+                [x: string]: unknown;
+                columns?: number | undefined;
+                date?: boolean | undefined;
+                colors?: boolean | undefined;
+                compact?: boolean | number | undefined;
+                errorLevel?: number | undefined;
+            } | undefined;
+        } | undefined;
+    } | undefined;
+}, {
+    logging?: {
+        server?: {
+            tag?: string | undefined;
+            level?: 0 | 1 | 2 | 3 | 4 | 5 | {
+                toString?: {} | undefined;
+                toFixed?: {} | undefined;
+                toExponential?: {} | undefined;
+                toPrecision?: {} | undefined;
+                valueOf?: {} | undefined;
+                toLocaleString?: {} | undefined;
+            } | undefined;
+            throttle?: number | undefined;
+            throttleMin?: number | undefined;
+            formatOptions?: {
+                [x: string]: unknown;
+                columns?: number | undefined;
+                date?: boolean | undefined;
+                colors?: boolean | undefined;
+                compact?: boolean | number | undefined;
+                errorLevel?: number | undefined;
+            } | undefined;
+        } | undefined;
+        ssr?: {
+            tag?: string | undefined;
+            level?: 0 | 1 | 2 | 3 | 4 | 5 | {
+                toString?: {} | undefined;
+                toFixed?: {} | undefined;
+                toExponential?: {} | undefined;
+                toPrecision?: {} | undefined;
+                valueOf?: {} | undefined;
+                toLocaleString?: {} | undefined;
+            } | undefined;
+            throttle?: number | undefined;
+            throttleMin?: number | undefined;
+            formatOptions?: {
+                [x: string]: unknown;
+                columns?: number | undefined;
+                date?: boolean | undefined;
+                colors?: boolean | undefined;
+                compact?: boolean | number | undefined;
+                errorLevel?: number | undefined;
+            } | undefined;
+        } | undefined;
+        client?: {
+            tag?: string | undefined;
+            level?: 0 | 1 | 2 | 3 | 4 | 5 | {
+                toString?: {} | undefined;
+                toFixed?: {} | undefined;
+                toExponential?: {} | undefined;
+                toPrecision?: {} | undefined;
+                valueOf?: {} | undefined;
+                toLocaleString?: {} | undefined;
+            } | undefined;
+            throttle?: number | undefined;
+            throttleMin?: number | undefined;
+            formatOptions?: {
+                [x: string]: unknown;
+                columns?: number | undefined;
+                date?: boolean | undefined;
+                colors?: boolean | undefined;
+                compact?: boolean | number | undefined;
+                errorLevel?: number | undefined;
+            } | undefined;
+        } | undefined;
+    } | undefined;
+}, false>;
+
+export { _default as default };

package/dist/module.json

@@ -0,0 +1,12 @@
+{
+  "name": "nuxt-core",
+  "version": "1.0.0",
+  "configKey": "nuxtCore",
+  "compatibility": {
+    "nuxt": "^4.0.0"
+  },
+  "builder": {
+    "@nuxt/module-builder": "1.0.2",
+    "unbuild": "3.6.1"
+  }
+}

package/dist/module.mjs

@@ -0,0 +1,76 @@
+import { useLogger, defineNuxtModule, createResolver, addServerImportsDir, addServerPlugin, addImportsDir, addPlugin } from '@nuxt/kit';
+import { merge } from 'lodash-es';
+
+const version = "1.0.0";
+
+const defaultModuleOptions = {
+  logging: {
+    server: {
+      tag: "server",
+      level: 2
+    },
+    ssr: {
+      tag: "app-ssr",
+      level: 2
+    },
+    client: {
+      tag: "app-client",
+      level: 2
+    }
+  }
+};
+function normalizedModuleOptions(...inputOpts) {
+  return merge({}, defaultModuleOptions, ...inputOpts);
+}
+
+const moduleName = "nuxt-core";
+const configKey = "nuxtCore";
+const logger = useLogger(moduleName);
+const module = defineNuxtModule({
+  meta: {
+    name: moduleName,
+    version,
+    configKey,
+    compatibility: {
+      nuxt: "^4.0.0"
+    }
+  },
+  // Default configuration options of the Nuxt module
+  defaults: {},
+  setup(_options, _nuxt) {
+    const resolver = createResolver(import.meta.url);
+    let normalizedRuntimeConfig = _nuxt.options.runtimeConfig || {};
+    const normalizedOptions = normalizedModuleOptions(_options, normalizedRuntimeConfig[configKey] || {});
+    normalizedRuntimeConfig = merge(normalizedRuntimeConfig, {
+      [configKey]: normalizedOptions,
+      public: {
+        [configKey]: merge({}, { logging: normalizedOptions.logging.client })
+      }
+    });
+    _nuxt.options.runtimeConfig = normalizedRuntimeConfig;
+    const sharedAlias = {};
+    _nuxt.options.alias = merge(_nuxt.options.alias, sharedAlias);
+    _nuxt.options.typescript = merge(_nuxt.options.typescript, {
+      tsConfig: { compilerOptions: { types: [] } }
+    });
+    addServerImportsDir(resolver.resolve("./runtime/server/composables"));
+    addServerPlugin(resolver.resolve("./runtime/server/plugins/logging"));
+    addImportsDir(resolver.resolve("./runtime/app/composables"));
+    addPlugin({
+      mode: "all",
+      name: "devcoffee-nuxt-core-logging",
+      src: resolver.resolve("./runtime/app/plugins/logging.ts")
+    });
+    _nuxt.hook("nitro:prepare:types", (opts) => {
+      opts.references.push({ path: resolver.resolve("./runtime/types/global.env.d.ts") });
+      opts.references.push({ path: resolver.resolve("./runtime/types/nitro.d.ts") });
+    });
+    _nuxt.hook("prepare:types", (opts) => {
+      opts.references.push({ path: resolver.resolve("./runtime/types/global.env.d.ts") });
+      opts.references.push({ path: resolver.resolve("./runtime/types/nuxt.d.ts") });
+    });
+    logger.success("`%s` setup finished", moduleName);
+  }
+});
+
+export { module as default };

package/dist/runtime/app/composables/useLogger.d.ts

@@ -0,0 +1,5 @@
+import type { LogLevel } from 'consola';
+export default function useLogger(opts?: {
+    tag?: string;
+    level?: LogLevel;
+}): any;

package/dist/runtime/app/composables/useLogger.js

@@ -0,0 +1,4 @@
+import { useNuxtApp } from "#app";
+export default function useLogger(opts) {
+  return useNuxtApp().$logging.getLogger(opts);
+}

package/dist/runtime/app/plugins/logging.d.ts

@@ -0,0 +1,17 @@
+import { type ConsolaInstance, type LogLevel } from 'consola';
+declare const _default: import("#app").Plugin<{
+    logging: {
+        getLogger: (opts?: {
+            tag?: string;
+            level?: LogLevel;
+        }) => ConsolaInstance;
+    };
+}> & import("#app").ObjectPlugin<{
+    logging: {
+        getLogger: (opts?: {
+            tag?: string;
+            level?: LogLevel;
+        }) => ConsolaInstance;
+    };
+}>;
+export default _default;

package/dist/runtime/app/plugins/logging.js

@@ -0,0 +1,26 @@
+import { reactive } from "vue";
+import { defineNuxtPlugin, useRequestEvent, useRuntimeConfig } from "#app";
+import { consola } from "consola";
+function initLogger() {
+  let config;
+  if (import.meta.server) {
+    config = useRuntimeConfig(useRequestEvent()).nuxtCore.logging.ssr;
+  } else {
+    config = useRuntimeConfig().public.nuxtCore.logging;
+    console.log("Initializing logger with tag:", config);
+  }
+  const { tag = "app", ...opts } = config;
+  return consola.create(opts).withTag(tag);
+}
+export default defineNuxtPlugin(async (_nuxtApp) => {
+  const logger = reactive(initLogger());
+  function getLogger(opts) {
+    const { tag, level } = opts || {};
+    let _logger = logger;
+    if (level != void 0) {
+      _logger = _logger.create({ level });
+    }
+    return tag != void 0 ? _logger.withTag(tag) : _logger;
+  }
+  return { provide: { logging: { getLogger } } };
+});

package/dist/runtime/plugin.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("#app").Plugin<Record<string, unknown>> & import("#app").ObjectPlugin<Record<string, unknown>>;
+export default _default;

package/dist/runtime/plugin.js

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

package/dist/runtime/server/composables/useServerLogger.d.ts

@@ -0,0 +1,6 @@
+import { type ConsolaInstance, type LogLevel } from 'consola';
+import type { H3Event } from 'h3';
+export default function useServerLogger(event?: H3Event, opts?: {
+    tag?: string;
+    level: LogLevel;
+}): ConsolaInstance;

package/dist/runtime/server/composables/useServerLogger.js

@@ -0,0 +1,15 @@
+import { consola } from "consola";
+import { useRuntimeConfig } from "nitropack/runtime";
+let globalServerLogger;
+export default function useServerLogger(event, opts) {
+  if (!globalServerLogger) {
+    const { tag: tag2, ...opts2 } = useRuntimeConfig(event).nuxtCore.logging.server;
+    globalServerLogger = consola.create(opts2).withTag(tag2);
+  }
+  const { tag, level } = opts || {};
+  let _logger = globalServerLogger;
+  if (level != void 0) {
+    _logger = _logger.create({ level });
+  }
+  return tag != void 0 ? _logger.withTag(tag) : _logger;
+}

package/dist/runtime/server/plugins/logging.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("nitropack").NitroAppPlugin;
+export default _default;

package/dist/runtime/server/plugins/logging.js

@@ -0,0 +1,7 @@
+import { defineNitroPlugin } from "nitropack/runtime";
+import useServerLogger from "../composables/useServerLogger.js";
+export default defineNitroPlugin((nitroApp) => {
+  nitroApp.hooks.hook("request", async (event) => {
+    event.context.logger = useServerLogger(event);
+  });
+});

package/dist/runtime/server/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": "../../../.nuxt/tsconfig.server.json",
+}

package/dist/runtime/types/global.env.d.ts

@@ -0,0 +1,39 @@
+declare global {
+  type GenericType<T = any, K extends string = string> = Record<K, T>
+
+  type Nullable<T> = T | null
+
+  type Concrete<Type> = {
+    [Property in keyof Type]-?: Type[Property]
+  }
+
+  type DeepPartial<T> = T extends object
+    ? {
+        [P in keyof T]?: DeepPartial<T[P]>
+      }
+    : T
+
+  type DeepReadonly<T> = T extends (infer R)[]
+    ? ReadonlyArray<DeepReadonly<R>>
+    : T extends (...args: any[]) => any
+      ? T // Functions are not frozen, but their properties are
+      : T extends object
+        ? { readonly [P in keyof T]: DeepReadonly<T[P]> }
+        : T
+
+  type UnionKeyOf<T1, T2> = Array<Partial<keyof T1> & Partial<keyof T2>>
+
+  type WithRequired<T, K extends keyof T> = T & { [P in K]-?: T[P] }
+
+  type ElementType<T extends ReadonlyArray<unknown>> = T extends ReadonlyArray<infer ElementType> ? ElementType : never
+
+  type IteratorKeys<T extends Readonly<Array<string>>> = T[number]
+
+  type Distinct<T, DistinctName> = T & { __TYPE__: DistinctName }
+
+  type MayBeDate = Date | string | number
+
+  type Awaitable<T> = T | Promise<T>
+}
+
+export {}

package/dist/runtime/types/nitro.d.ts

@@ -0,0 +1,9 @@
+import type { ConsolaInstance } from 'consola'
+
+declare module 'h3' {
+  interface H3EventContext {
+    logger: ConsolaInstance
+  }
+}
+
+export {}

package/dist/runtime/types/nuxt.d.ts

@@ -0,0 +1,17 @@
+import type { ConsolaInstance } from 'consola'
+
+type NuxtCoreLogging = {
+  getLogger: (opts?: { tag?: string; level?: LogLevel }) => ConsolaInstance
+}
+
+declare module 'vue' {
+  interface ComponentCustomProperties {
+    $logging: NuxtCoreLogging
+  }
+}
+
+declare module '#app' {
+  interface NuxtApp {
+    $logging: NuxtCoreLogging
+  }
+}

package/dist/types.d.mts

@@ -0,0 +1,7 @@
+import type { NuxtModule } from '@nuxt/schema'
+
+import type { default as Module } from './module.mjs'
+
+export type ModuleOptions = typeof Module extends NuxtModule<infer O> ? Partial<O> : Record<string, any>
+
+export { default } from './module.mjs'

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@devcoffee/nuxt-core",
+  "version": "1.0.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "author": "Hieu Nguyen <hieunguyen@devcoffee.tech>",
+  "description": "devcoffee core module for Nuxt",
+  "license": "MIT",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/types.d.mts",
+      "import": "./dist/module.mjs"
+    }
+  },
+  "main": "./dist/module.mjs",
+  "typesVersions": {
+    "*": {
+      ".": [
+        "./dist/types.d.mts"
+      ]
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "nuxt": {
+    "module": "src/module.ts"
+  },
+  "scripts": {
+    "dev": "npm run dev:prepare && nuxi dev playground",
+    "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
+    "dev:build": "nuxi build playground",
+    "prepack": "nuxt-module-build build",
+    "release": "npm run lint && npm run test && npm run prepack && changelogen --release && npm publish && git push --follow-tags",
+    "lint": "eslint .",
+    "test": "vitest run",
+    "test:watch": "vitest watch",
+    "test:types": "vue-tsc --noEmit && cd playground && vue-tsc --noEmit"
+  },
+  "dependencies": {
+    "@nuxt/kit": "^4.1.3",
+    "consola": "^3.4.2",
+    "lodash-es": "^4.17.21"
+  },
+  "devDependencies": {
+    "@ianvs/prettier-plugin-sort-imports": "^4.7.0",
+    "@nuxt/devtools": "^2.6.5",
+    "@nuxt/eslint": "^1.9.0",
+    "@nuxt/eslint-config": "^1.9.0",
+    "@nuxt/module-builder": "^1.0.2",
+    "@nuxt/schema": "^4.1.3",
+    "@nuxt/test-utils": "^3.19.2",
+    "@types/lodash-es": "^4.17.12",
+    "@types/node": "latest",
+    "changelogen": "^0.6.2",
+    "cross-env": "^10.1.0",
+    "devcoffee-global-types": "^1.0.0",
+    "eslint": "^9.37.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.4",
+    "nuxt": "^4.1.3",
+    "prettier": "^3.6.2",
+    "typescript": "~5.9.3",
+    "vitest": "^3.2.4",
+    "vue-tsc": "^3.1.0"
+  }
+}