@model-w/preset-nuxt3 0.1.8 → 1.0.1

package/README.md

@@ -5,4 +5,4 @@ with the following the documentation available in the [Model-W](https://github.c
 
 ### Documentation
 
-[✨ **Documentation is there** ✨](http://modelw-nuxt3-preset.rtfd.io/)
+[✨ **Documentation is there** ✨](http://model-w-nuxt3-preset.rtfd.io/)

package/index.ts

@@ -0,0 +1,261 @@
+// @ts-ignore
+import { defineNuxtConfig } from "nuxt/config";
+import { defu } from "defu";
+import type { NuxtConfig } from "nuxt/schema";
+import type { ModuleOptions as SentryOptions } from "@model-w/sentry";
+import type { ModuleOptions as ProxyOptions } from "@model-w/proxy";
+
+/**
+ * Signature of calls to EnvManager to avoid inconsistent calls to the same
+ * var.
+ */
+type Signature = {
+    defaultValue: any;
+    buildDefault: any;
+};
+
+/**
+ * Error thrown when a required env var is missing.
+ */
+class ImproperlyConfigured extends Error {
+    constructor(message: string) {
+        super(message);
+        this.name = "ImproperlyConfigured";
+    }
+}
+
+/**
+ * This helps keeping track of environment variables that are used, mandatory,
+ * etc.
+ */
+class EnvManager {
+    private getSignatures: Record<string, Signature> = {};
+    private signatureMismatch: Set<string> = new Set();
+    private inBuildMode: boolean = JSON.parse(
+        process.env.BUILD_MODE || "false"
+    );
+    private missing: Set<string> = new Set();
+    private read: Record<string, { isRequired: boolean }> = {};
+    private syntaxError: Set<string> = new Set();
+
+    /**
+     * Gets an environment variable
+     *
+     * @param name Name of the variable
+     * @param defaultValue Default value, if any
+     * @param buildDefault Default value when building to avoid an error to be
+     *  raised
+     */
+    get({
+        name,
+        defaultValue,
+        buildDefault,
+    }: {
+        name: string;
+        defaultValue?: any;
+        buildDefault?: any;
+    }): any {
+        const signature = { defaultValue, buildDefault };
+
+        if (this.getSignatures.hasOwnProperty(name)) {
+            if (
+                signature.defaultValue !==
+                    this.getSignatures[name].defaultValue ||
+                signature.buildDefault !== this.getSignatures[name].buildDefault
+            ) {
+                this.signatureMismatch.add(name);
+            }
+        } else {
+            this.getSignatures[name] = signature;
+        }
+
+        const currentDefault =
+            this.inBuildMode && buildDefault !== undefined
+                ? buildDefault
+                : defaultValue;
+
+        this.read[name] = {
+            isRequired: currentDefault === undefined,
+        };
+
+        if (typeof process.env[name] === "undefined") {
+            if (currentDefault === undefined) {
+                this.missing.add(name);
+            }
+
+            return currentDefault;
+        }
+
+        return process.env[name];
+    }
+
+    /**
+     * Checks for any missing var or inconsistency in order to nicely warn
+     * the user.
+     */
+    raiseParseFail(): void {
+        if (
+            this.get({
+                name: "NO_ENV_CHECK",
+                defaultValue: false,
+                buildDefault: false,
+            })
+        ) {
+            return;
+        }
+
+        if (
+            !this.missing.size &&
+            !this.syntaxError.size &&
+            !this.signatureMismatch.size
+        ) {
+            return;
+        }
+
+        const parts: string[] = ["Incorrect environment variables."];
+
+        if (this.missing.size) {
+            parts.push(` Missing: ${Array.from(this.missing).join(", ")}.`);
+        }
+
+        if (this.syntaxError.size) {
+            parts.push(
+                ` Syntax error: ${Array.from(this.syntaxError).join(", ")}.`
+            );
+        }
+
+        if (this.signatureMismatch.size) {
+            parts.push(
+                ` get() calls mismatch: ${Array.from(
+                    this.signatureMismatch
+                ).join(", ")}.`
+            );
+        }
+
+        throw new ImproperlyConfigured(parts.join(""));
+    }
+}
+
+export interface ModelWConfig {
+    siteName?: string;
+    apiUrl?: string;
+    runtimeConfig?: Extract<NuxtConfig, "runtimeConfig">;
+    sentryDsn?: string;
+    environment?: string;
+    app?: Extract<NuxtConfig, "app">;
+    head?: Extract<Extract<NuxtConfig, "app">, "head">;
+    moduleConfig?: Array<any>;
+    backAlias?: string;
+    cmsAlias?: string;
+    proxyFilters?: Array<any>;
+}
+
+/**
+ * Context manager that checks env consistency at the end
+ *
+ * @param func Function to call. The return value will be propagated
+ */
+export function envManager<T>(func: (env: EnvManager) => T): T {
+    const env = new EnvManager();
+    const out = func(env);
+
+    env.raiseParseFail();
+
+    return out;
+}
+
+/**
+ * Define a Nuxt config with Model W defaults
+ *
+ * @param env Env manager (from the envManager context manager)
+ * @param config Your config
+ */
+export function defineModelWConfig(
+    env: EnvManager,
+    config: ModelWConfig
+): NuxtConfig {
+    const siteName = config.siteName || "Model W";
+    const head: Extract<Extract<NuxtConfig, "app">, "head"> = defu(
+        config.head || {},
+        {
+            titleTemplate: `%s - ${siteName}`,
+        }
+    );
+    const app: Extract<NuxtConfig, "app"> = defu(config.app || {}, {
+        head,
+    });
+    const apiUrl =
+        config.apiUrl ||
+        env.get({ name: "API_URL", buildDefault: "http://localhost" });
+
+    const backAlias = config.backAlias || "back";
+    const cmsAlias = config.cmsAlias || "wubba-lubba-dub-dub";
+
+    const previewEditRegex = new RegExp(
+        `^/${cmsAlias}/pages/[^/]+/edit/preview/$`
+    );
+    const previewAddRegex = new RegExp(
+        `^/${cmsAlias}/pages/add/[^/]+/[^/]+/[^/]+/preview/$`
+    );
+
+    const sentryDsn =
+        config.sentryDsn || env.get({ name: "SENTRY_DSN", defaultValue: "" });
+    const environment =
+        config.environment ||
+        env.get({
+            name: "ENVIRONMENT",
+            defaultValue: sentryDsn ? undefined : "",
+        });
+
+    const generatedConfig: NuxtConfig = {
+        app,
+
+        runtimeConfig: defu(config.runtimeConfig || {}, {
+            apiUrl,
+        }),
+
+        proxy: {
+            options: {
+                target: apiUrl,
+                changeOrigin: true,
+            },
+            forwardHost: true,
+            filters: [
+                {
+                    header: /x-reach-api:.+/,
+                },
+                {
+                    path: `/${backAlias}`,
+                },
+                {
+                    path: `/${cmsAlias}`,
+                },
+                {
+                    path: previewEditRegex,
+                    method: /^(?!POST$).*/,
+                    useProxy: false,
+                },
+                {
+                    path: previewAddRegex,
+                    method: /^(?!POST$).*/,
+                    useProxy: false,
+                },
+                ...(config.proxyFilters || []),
+            ],
+        } as ProxyOptions,
+
+        sentry: {
+            dsn: sentryDsn,
+            environment: environment,
+        } as SentryOptions,
+
+        modules: [
+            "@model-w/axios",
+            "@model-w/sentry",
+            "@model-w/proxy",
+            ...(config.moduleConfig || []),
+        ],
+    };
+
+    return defineNuxtConfig(generatedConfig);
+}

package/package.json

@@ -1,50 +1,52 @@
 {
     "name": "@model-w/preset-nuxt3",
-    "version": "0.1.8",
+    "version": "1.0.1",
+    "type": "module",
+    "description": "Preset of Nuxt3 for ModelW",
+    "license": "WTFPL",
     "repository": {
         "type": "git",
         "url": "git+https://github.com/ModelW/preset-nuxt3.git"
     },
+    "homepage": "https://github.com/ModelW/preset-nuxt3#readme",
     "bugs": {
         "url": "https://github.com/ModelW/preset-nuxt3/issues"
     },
-    "description": "Preset of Nuxt3 for ModelW",
-    "homepage": "https://github.com/ModelW/preset-nuxt3#readme",
-    "main": "nuxt.config.ts",
+    "author": "Rémy Sanchez (@xowap)",
+    "contributors": [
+        "Laurent Treguier",
+        "Ivan Lorenzo"
+    ],
+    "keywords": [
+        "nuxt3",
+        "nuxt3-preset",
+        "model-w",
+        "modelw"
+    ],
+    "main": "index.ts",
+    "files": [
+        "index.ts",
+        "README.md",
+        "package.json"
+    ],
     "scripts": {
         "test": "echo \"Error: no test specified\" && exit 1"
     },
     "engines": {
-        "node": ">=16.0.0"
+        "node": "18.x"
     },
     "peerDependencies": {
-        "vue": "~3.2.47",
-        "nuxt": "~3.4.x"
+        "@model-w/axios": "0.x || 1.x",
+        "@model-w/proxy": "0.x || 1.x",
+        "@model-w/sentry": "1.x",
+        "@vuelidate/core": "2.0.x",
+        "@vuelidate/validators": "2.0.x",
+        "nuxt": "3.4.x",
+        "sass": "1.62.x",
+        "vite-svg-loader": "4.0.x",
+        "vue": "3.2.x"
     },
     "dependencies": {
-        "@model-w/axios": "~0.3.0",
-        "@model-w/proxy": "~0.1.4",
-        "@model-w/sentry": "~0.1.1",
-        "@vuelidate/core": "~2.0.2",
-        "@vuelidate/validators": "~2.0.2",
-        "defu": "~6.1.2",
-        "jsdom": "~21.1.1",
-        "nuxt-runtime-compiler": "~1.2.2",
-        "vite-svg-loader": "~4.0.0",
-        "vue3-toastify": "~0.1.6",
-        "sass": "~1.62.0",
-        "sass-loader": "~13.2.2"
-    },
-    "keywords": [
-        "Nuxt3",
-        "modelw",
-        "model-w",
-        "Nuxt3-preset"
-    ],
-    "author": "Rémy Sanchez (@xowap)",
-    "license": "WTFPL",
-    "contributors": [
-        "Laurent Treguier",
-        "Ivan Lorenzo"
-    ]
+        "defu": "^6.1.2"
+    }
 }

package/.env-template

@@ -1,21 +0,0 @@
-set -a
-
-# Base frontend configuration:
-# Frontend desired URL for example "localhost:3000"
-BASE_URL="http://localhost:3000"
-
-# Backend URL location for example "localhost:8000"
-API_URL="http://localhost:8000"
-
-# Proxy configuration stuff
-BACK_ALIAS="back"
-CMS_ALIAS="cms"
-
-# Template config
-NUXT_PUBLIC_SERVER_TEMPLATED_COMPONENTS=true
-
-# Site name
-SITE_NAME="Model W"
-
-# Sentry configuration dsn url
-SENTRY_DSN="https://<number>.ingest.sentry.io/<number>"

package/nuxt.config.ts

@@ -1,54 +0,0 @@
-export interface ModelWConfig {
-    siteName?: string;
-    apiURL?: string;
-    sentryDSN?: string;
-    ENV?: string;
-    charset?: string;
-    meta?: Array<any>;
-    moduleConfig?: Array<any>;
-    backAlias?: string;
-    cmsAlias?: string;
-}
-
-export function defineModelWConfig(config: ModelWConfig) {
-    return defineNuxtConfig({
-        app: {
-            head: {
-                titleTemplate: config.siteName,
-            },
-            // @ts-ignore
-            meta: config.meta,
-        },
-
-        routeRules: {
-            '/': {
-                prerender: true,
-                cors: true
-            },
-            '/*': {
-                cors: true
-            }
-        },
-
-        runtimeConfig: {
-            apiURL: config.apiURL,
-            backAlias: config.backAlias,
-            cmsAlias: config.cmsAlias,
-            public: {
-                sentryDSN: config.sentryDSN,
-                serverTemplatedComponents: false,
-            },
-            ENV: config.ENV,
-        },
-
-        build: {},
-
-        modules: [
-            "nuxt-runtime-compiler",
-            "@model-w/axios",
-            "@model-w/sentry",
-            "@model-w/proxy",
-            ...(config.moduleConfig ? config.moduleConfig : []),
-        ]
-    })
-}