@jojomatik/nuxt-bundle 2.0.0-beta.6 → 2.0.0-beta.7

package/README.md

@@ -3,5 +3,30 @@
 
 A bundle of commonly used nuxt dependencies and configuration.
 
+## Usage
+Extend your Nuxt configuration with `@jojomatik/nuxt-bundle` to use its shared dependencies and configuration. Dependency licenses are validated during builds.
+
+Use `licenseModule.licenseOverrides` to provide license metadata for dependencies whose manifests omit it. Overrides are still checked against `licenseModule.allowedLicenses`:
+
+```ts
+export default defineNuxtConfig({
+  extends: "@jojomatik/nuxt-bundle",
+  licenseModule: {
+    licenseOverrides: {
+      "socket.io-client": "MIT",
+    },
+  },
+});
+```
+
+Dependencies without an override still fail validation when their license metadata is missing.
+An override can also be a function that receives the license from the package metadata. For example, to supply MIT only when the license is missing:
+
+```ts
+licenseOverrides: {
+  "socket.io-client": (license) => license || "MIT",
+}
+```
+
 ## Licensing
 This project is licensed under the MIT License (MIT). See also [`LICENSE`](LICENSE).

package/lib/__tests__/license-validation.test.ts

@@ -0,0 +1,116 @@
+import assert from "node:assert/strict";
+import { test } from "node:test";
+import { createLicensePluginOptions } from "../license-plugin-options.ts";
+import {
+  applyLicenseOverrides,
+  validateDependencyLicense,
+} from "../license-validation.ts";
+
+test("applies a package license override before validation", () => {
+  assert.deepEqual(
+    validateDependencyLicense(
+      { name: "socket.io-client" },
+      { "socket.io-client": "MIT" },
+      ["MIT"],
+    ),
+    { license: "MIT", isAllowed: true },
+  );
+});
+
+test("rejects missing license metadata without an override", () => {
+  assert.deepEqual(
+    validateDependencyLicense({ name: "unlicensed-package" }, {}, ["MIT"]),
+    { license: undefined, isAllowed: false },
+  );
+});
+
+test("still rejects an overridden license outside the allow-list", () => {
+  assert.deepEqual(
+    validateDependencyLicense(
+      { name: "socket.io-client" },
+      { "socket.io-client": "MIT" },
+      ["Apache-2.0"],
+    ),
+    { license: "MIT", isAllowed: false },
+  );
+});
+
+test("applies overrides to generated metadata without mutating dependencies", () => {
+  const dependency = { name: "socket.io-client" };
+
+  assert.deepEqual(
+    applyLicenseOverrides([dependency], { "socket.io-client": "MIT" }),
+    [{ name: "socket.io-client", license: "MIT" }],
+  );
+  assert.equal(dependency.license, undefined);
+});
+
+test("allows an override callback to supply a license only when missing", () => {
+  const licenseOverrides = {
+    "socket.io-client": (license: string | undefined) => license || "MIT",
+  };
+
+  assert.deepEqual(
+    validateDependencyLicense({ name: "socket.io-client" }, licenseOverrides, [
+      "MIT",
+    ]),
+    { license: "MIT", isAllowed: true },
+  );
+  assert.deepEqual(
+    validateDependencyLicense(
+      { name: "socket.io-client", license: "GPL-3.0" },
+      licenseOverrides,
+      ["MIT"],
+    ),
+    { license: "GPL-3.0", isAllowed: false },
+  );
+  assert.deepEqual(
+    applyLicenseOverrides(
+      [{ name: "socket.io-client", license: "GPL-3.0" }],
+      licenseOverrides,
+    ),
+    [{ name: "socket.io-client", license: "GPL-3.0" }],
+  );
+});
+
+test("normalizes null license metadata before invoking an override callback", () => {
+  let callbackLicense: string | undefined = "not called";
+  const licenseOverrides = {
+    "socket.io-client": (license: string | undefined) => {
+      callbackLicense = license;
+      return license || "MIT";
+    },
+  };
+
+  assert.deepEqual(
+    validateDependencyLicense(
+      { name: "socket.io-client", license: null },
+      licenseOverrides,
+      ["MIT"],
+    ),
+    { license: "MIT", isAllowed: true },
+  );
+  assert.equal(callbackLicense, undefined);
+});
+
+test("applies license overrides in configured plugin callbacks", () => {
+  const pluginOptions = createLicensePluginOptions(
+    {
+      allowedLicenses: ["MIT"],
+      licenseOverrides: {
+        "socket.io-client": (license) => license ?? "MIT",
+      },
+    },
+    {
+      error: assert.fail,
+      info: assert.fail,
+    },
+  );
+  const dependency = { name: "socket.io-client", license: null };
+
+  assert.equal(pluginOptions.thirdParty.allow.test(dependency), true);
+  assert.deepEqual(
+    JSON.parse(pluginOptions.thirdParty.output.template([dependency])),
+    [{ name: "socket.io-client", license: "MIT" }],
+  );
+});

package/lib/license-plugin-options.ts

@@ -0,0 +1,91 @@
+import {
+  applyLicenseOverrides,
+  validateDependencyLicense,
+  type LicenseOverride,
+} from "./license-validation.ts";
+
+type LicenseModuleOptions = {
+  allowedLicenses: string[];
+  licenseOverrides?: Record<string, LicenseOverride>;
+};
+
+type LicenseLogger = {
+  error(message: string): void;
+  info(message: string): void;
+};
+
+type LicenseDependency = {
+  name: string;
+  license?: string | null;
+};
+
+const envKey = "ALLOWED_LICENCES";
+
+export function createLicensePluginOptions(
+  options: LicenseModuleOptions,
+  logger: LicenseLogger,
+) {
+  return {
+    thirdParty: {
+      includePrivate: false,
+      allow: {
+        test: (dependency: LicenseDependency) => {
+          const allowedLicensesFromEnv = process.env[envKey]
+            ?.split(",")
+            .map((license) => license.trim());
+          const allowedLicenses =
+            allowedLicensesFromEnv ?? options.allowedLicenses;
+          const overrides = options.licenseOverrides ?? {};
+          const validation = validateDependencyLicense(
+            dependency,
+            overrides,
+            allowedLicenses,
+          );
+
+          if (!validation.license) return false;
+
+          if (!validation.isAllowed) {
+            logger.error(
+              `Dependency "${dependency.name}" has a license (${validation.license}) that is not the list of allowed licenses (${allowedLicenses.join(", ")}).`,
+            );
+
+            const requiredLicenses = [...allowedLicenses, validation.license];
+            const configContent = JSON.stringify(
+              {
+                extends: "@jojomatik/nuxt-bundle",
+                licenseModule: {
+                  allowedLicenses: requiredLicenses,
+                },
+              },
+              undefined,
+              2,
+            );
+            const configExample =
+              "export default defineNuxtConfig(" + configContent + ");\n";
+
+            logger.info(
+              `You can specify allowed licenses in "nuxt.config.ts" environment variable:`,
+            );
+            console.log(configExample);
+
+            logger.info(
+              `You can also specify allowed licenses via "${envKey}" environment variable (ALLOWED_LICENCES=${requiredLicenses.join(",")}).`,
+            );
+          }
+
+          return validation.isAllowed;
+        },
+        failOnUnlicensed: true,
+        failOnViolation: true,
+      },
+      output: {
+        file: "public/dependencies.json",
+        template(dependencies: LicenseDependency[]) {
+          return JSON.stringify(
+            applyLicenseOverrides(dependencies, options.licenseOverrides ?? {}),
+          );
+        },
+      },
+    },
+  };
+}

package/lib/license-validation.ts

@@ -0,0 +1,45 @@
+type LicenseDependency = {
+  name: string;
+  license?: string | null;
+};
+
+export type LicenseOverride =
+  | string
+  | ((license: string | undefined) => string | undefined);
+
+function resolveLicense(
+  dependency: LicenseDependency,
+  licenseOverrides: Record<string, LicenseOverride>,
+) {
+  const originalLicense = dependency.license ?? undefined;
+  const override = licenseOverrides[dependency.name];
+
+  if (!Object.hasOwn(licenseOverrides, dependency.name)) {
+    return originalLicense;
+  }
+
+  return typeof override === "function" ? override(originalLicense) : override;
+}
+
+export function validateDependencyLicense(
+  dependency: LicenseDependency,
+  licenseOverrides: Record<string, LicenseOverride>,
+  allowedLicenses: string[],
+) {
+  const license = resolveLicense(dependency, licenseOverrides);
+
+  return {
+    license,
+    isAllowed: Boolean(license && allowedLicenses.includes(license)),
+  };
+}
+
+export function applyLicenseOverrides(
+  dependencies: LicenseDependency[],
+  licenseOverrides: Record<string, LicenseOverride>,
+) {
+  return dependencies.map((dependency) => ({
+    ...dependency,
+    license: resolveLicense(dependency, licenseOverrides),
+  }));
+}

package/modules/license-module.ts

@@ -1,8 +1,8 @@
 import { addVitePlugin, defineNuxtModule, useLogger } from "nuxt/kit";
 import license from "rollup-plugin-license";
+import { createLicensePluginOptions } from "../lib/license-plugin-options";
 
 const moduleKey = "@jojomatik/nuxt-bundle/license-module";
-const envKey = "ALLOWED_LICENCES";
 
 const logger = useLogger(moduleKey);
 
@@ -12,77 +12,6 @@ export default defineNuxtModule({
     configKey: "licenseModule",
   },
   setup(options) {
-    addVitePlugin(
-      license({
-        thirdParty: {
-          includePrivate: false,
-          allow: {
-            test: (dependency) => {
-              // Return false for unlicensed dependencies.
-              if (!dependency.license) return false;
-
-              // Load allowed licenses from environment-variable
-              const allowedLicensesFromEnv = process.env[envKey]
-                ?.split(",")
-                .map((license) => license.trim());
-
-              // Load allowed licenses from module options
-              // Allow MIT and Apache-2.0 licenses by default
-              const allowedLicenses =
-                allowedLicensesFromEnv ?? options.allowedLicenses;
-
-              const isLicenseAllowed = allowedLicenses.includes(
-                dependency.license,
-              );
-
-              if (!isLicenseAllowed) {
-                logger.error(
-                  `Dependency "${dependency.name}" has a license (${dependency.license}) that is not the list of allowed licenses (${allowedLicenses.join(", ")}).`,
-                );
-
-                const requiredLicenses = [
-                  ...allowedLicenses,
-                  dependency.license,
-                ];
-
-                const configContent = JSON.stringify(
-                  {
-                    extends: "@jojomatik/nuxt-bundle",
-                    licenseModule: {
-                      allowedLicenses: requiredLicenses,
-                    },
-                  },
-                  undefined,
-                  2,
-                );
-
-                const configExample =
-                  "export default defineNuxtConfig(" + configContent + ");\n";
-
-                logger.info(
-                  `You can specify allowed licenses in "nuxt.config.ts" environment variable:`,
-                );
-                console.log(configExample);
-
-                logger.info(
-                  `You can also specify allowed licenses via "${envKey}" environment variable (ALLOWED_LICENCES=${requiredLicenses.join(",")}).`,
-                );
-              }
-
-              return isLicenseAllowed;
-            },
-            failOnUnlicensed: true,
-            failOnViolation: true,
-          },
-          output: {
-            // Output file into public directory which is included in the build output.
-            file: "public/dependencies.json",
-            template(dependencies) {
-              return JSON.stringify(dependencies);
-            },
-          },
-        },
-      }),
-    );
+    addVitePlugin(license(createLicensePluginOptions(options, logger)));
   },
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jojomatik/nuxt-bundle",
-  "version": "2.0.0-beta.6",
+  "version": "2.0.0-beta.7",
   "type": "module",
   "description": "A bundle of commonly used nuxt dependencies and configuration.",
   "keywords": [
@@ -15,10 +15,12 @@
     "build": "nuxi build",
     "start": "node .output/server/index.mjs",
     "lint": "eslint . --max-warnings 0",
+    "test": "node --experimental-strip-types --test lib/__tests__/*.test.ts",
     "semantic-release": "semantic-release"
   },
   "files": [
     "app",
+    "lib",
     "locales",
     "modules",
     "nuxt.config.ts",
@@ -28,40 +30,40 @@
   ],
   "main": "nuxt.config.ts",
   "dependencies": {
-    "@crystal-creations/crystal-components": "1.0.0-beta.43",
+    "@crystal-creations/crystal-components": "1.0.0-beta.49",
     "@fontsource/roboto": "5.2.9",
     "@mdi/js": "7.4.47",
     "@nuxt/eslint": "1.12.1",
     "@nuxt/image": "2.0.0",
     "@nuxtjs/i18n": "10.2.1",
-    "@nuxtjs/seo": "3.3.0",
+    "@nuxtjs/seo": "5.3.16",
     "@nuxtjs/storybook": "9.0.1",
     "@semantic-release/exec": "7.1.0",
     "@semantic-release/git": "10.0.1",
     "@storybook/addon-links": "9.1.17",
     "@storybook/addon-docs": "9.1.17",
     "@types/node": "24.10.4",
-    "chromatic": "13.3.4",
+    "chromatic": "13.3.5",
     "conventional-changelog-conventionalcommits": "9.1.0",
     "eslint-config-prettier": "10.1.8",
     "eslint-plugin-prettier": "5.5.4",
     "eslint-plugin-storybook": "9.1.17",
     "eslint-plugin-vue": "10.6.2",
     "prettier": "3.7.4",
-    "rollup": "4.55.1",
+    "rollup": "4.59.0",
     "rollup-plugin-license": "3.6.0",
     "sass": "1.97.1",
     "semantic-release": "25.0.2",
-    "storybook": "9.1.17",
+    "storybook": "9.1.19",
     "typescript": "5.9.3",
     "vue-router": "4.6.4",
     "vuetify": "3.11.6",
-    "vuetify-nuxt-module": "0.19.2"
+    "vuetify-nuxt-module": "0.19.5"
   },
   "devDependencies": {
     "eslint": "9.39.2",
-    "nuxt": "4.2.2",
-    "vite": "7.3.0",
+    "nuxt": "4.5.1",
+    "vite": "7.3.5",
     "vue": "3.5.26"
   },
   "peerDependencies": {
@@ -86,5 +88,8 @@
   },
   "publishConfig": {
     "access": "public"
+  },
+  "resolutions": {
+    "jiti": "2.6.1"
   }
 }