nuxt-site-config 2.0.0-beta.0

package/dist/build.d.ts

@@ -0,0 +1,5 @@
+import { S as SiteConfig } from './type-dfe3e7b7.js';
+
+declare function useSiteConfig(overrides?: Partial<SiteConfig>): Partial<SiteConfig>;
+
+export { SiteConfig, useSiteConfig };

package/dist/build.mjs

@@ -0,0 +1,63 @@
+import { tryUseNuxt } from '@nuxt/kit';
+import { withHttp, withHttps } from 'ufo';
+import defu from 'defu';
+
+const SITE_CONFIG_ENV = {
+  name: process.env.NUXT_PUBLIC_SITE_NAME,
+  url: process.env.NUXT_PUBLIC_SITE_URL,
+  description: process.env.NUXT_PUBLIC_SITE_DESCRIPTION,
+  image: process.env.NUXT_PUBLIC_SITE_IMAGE,
+  index: String(process.env.NUXT_PUBLIC_SITE_INDEX) !== "false",
+  titleSeparator: process.env.NUXT_PUBLIC_SITE_TITLE_SEPARATOR,
+  trailingSlash: String(process.env.NUXT_PUBLIC_SITE_TRAILING_SLASH) !== "false",
+  language: process.env.NUXT_PUBLIC_SITE_LANGUAGE
+};
+
+const _siteConfigOverrides = {};
+const NITRO_ENV_URL = [
+  process.env.NUXT_PUBLIC_VERCEL_URL,
+  // vercel
+  process.env.NUXT_PUBLIC_URL,
+  // netlify
+  process.env.NUXT_PUBLIC_CF_PAGES_URL
+  // cloudflare pages
+];
+function overrideSiteConfig(overrides = {}) {
+  for (const k of Object.keys(overrides))
+    _siteConfigOverrides[k] = overrides[k];
+}
+function createSiteConfig(input) {
+  const nitroEnvConfig = {};
+  const nitroUrl = NITRO_ENV_URL.find((k) => Boolean(k));
+  if (nitroUrl)
+    nitroEnvConfig.url = nitroUrl;
+  for (const k of Object.keys(SITE_CONFIG_ENV)) {
+    if (SITE_CONFIG_ENV[k])
+      nitroEnvConfig[k] = SITE_CONFIG_ENV[k];
+  }
+  const config = defu(_siteConfigOverrides, nitroEnvConfig, input.runtimeConfig || {}, input.contextConfig || {});
+  if (typeof config.index !== "undefined")
+    config.index = String(config.index) !== "false";
+  else
+    config.index = process.env.NODE_ENV === "production";
+  if (config.url && !config.url.startsWith("http"))
+    config.url = config.url.includes("localhost") ? withHttp(config.url) : withHttps(config.url);
+  return config;
+}
+
+function useSiteConfig(overrides = {}) {
+  if (Object.keys(overrides))
+    overrideSiteConfig(overrides);
+  const runtimeConfig = {};
+  const nuxt = tryUseNuxt();
+  if (nuxt) {
+    for (const k of Object.keys(SITE_CONFIG_ENV)) {
+      const env = runtimeConfig[k] = nuxt?.options.runtimeConfig.public.site[k];
+      if (env)
+        runtimeConfig[k] = env;
+    }
+  }
+  return createSiteConfig({ runtimeConfig });
+}
+
+export { useSiteConfig };

package/dist/module.cjs

@@ -0,0 +1,5 @@
+module.exports = function(...args) {
+  return import('./module.mjs').then(m => m.default.call(this, ...args))
+}
+const _meta = module.exports.meta = require('./module.json')
+module.exports.getMeta = () => Promise.resolve(_meta)

package/dist/module.d.ts

@@ -0,0 +1,11 @@
+import * as _nuxt_schema from '@nuxt/schema';
+import { S as SiteConfig } from './type-dfe3e7b7.js';
+
+interface ModuleOptions extends SiteConfig {
+}
+interface ModulePublicRuntimeConfig {
+    site: SiteConfig;
+}
+declare const _default: _nuxt_schema.NuxtModule<ModuleOptions>;
+
+export { ModuleOptions, ModulePublicRuntimeConfig, _default as default };

package/dist/module.json

@@ -0,0 +1,9 @@
+{
+  "name": "nuxt-site-config",
+  "compatibility": {
+    "nuxt": "^3.5.0",
+    "bridge": false
+  },
+  "configKey": "site",
+  "version": "2.0.0-beta.0"
+}

package/dist/module.mjs

@@ -0,0 +1,20 @@
+import { defineNuxtModule, createResolver, addImportsDir } from '@nuxt/kit';
+import defu from 'defu';
+
+const module = defineNuxtModule({
+  meta: {
+    name: "nuxt-site-config",
+    compatibility: {
+      nuxt: "^3.5.0",
+      bridge: false
+    },
+    configKey: "site"
+  },
+  async setup(config, nuxt) {
+    nuxt.options.runtimeConfig.public.site = defu(config, nuxt.options.runtimeConfig.public.site || {});
+    const { resolve } = createResolver(import.meta.url);
+    addImportsDir(resolve("./runtime/composables"));
+  }
+});
+
+export { module as default };

package/dist/runtime/useSiteConfig.d.ts

@@ -0,0 +1,2 @@
+import type { SiteConfig } from '../type';
+export declare function useSiteConfig(overrides?: Partial<SiteConfig>): Partial<SiteConfig>;

package/dist/runtime/useSiteConfig.mjs

@@ -0,0 +1,28 @@
+import { joinURL } from "ufo";
+import { getRequestURL } from "h3";
+import { SITE_CONFIG_ENV } from "../const";
+import { createSiteConfig, overrideSiteConfig } from "../shared";
+import { useAppConfig, useRequestEvent, useRuntimeConfig } from "#imports";
+function useRequestURL() {
+  if (process.server) {
+    const { baseURL } = useRuntimeConfig().app;
+    const url = getRequestURL(useRequestEvent());
+    url.pathname = joinURL(baseURL, url.pathname);
+    return url;
+  }
+  return new URL(window.location.href);
+}
+export function useSiteConfig(overrides = {}) {
+  if (Object.keys(overrides))
+    overrideSiteConfig(overrides);
+  const { baseURL } = useRuntimeConfig().app;
+  const contextConfig = {
+    url: joinURL(useRequestURL().hostname, baseURL)
+  };
+  const { public: publicRuntimeConfig } = useRuntimeConfig();
+  const appConfig = useAppConfig();
+  const runtimeConfig = {};
+  for (const k of SITE_CONFIG_ENV)
+    runtimeConfig[k] = appConfig.site?.[k] || publicRuntimeConfig.site?.[k];
+  return createSiteConfig({ runtimeConfig, contextConfig });
+}

package/dist/type-dfe3e7b7.d.ts

@@ -0,0 +1,12 @@
+interface SiteConfig {
+    url: string;
+    name: string;
+    description: string;
+    image: string;
+    index: boolean;
+    titleSeparator: string;
+    trailingSlash: boolean;
+    language: string;
+}
+
+export { SiteConfig as S };

package/dist/types.d.ts

@@ -0,0 +1,17 @@
+
+import { ModuleOptions, ModulePublicRuntimeConfig } from './module'
+
+declare module '@nuxt/schema' {
+  interface NuxtConfig { ['site']?: Partial<ModuleOptions> }
+  interface NuxtOptions { ['site']?: ModuleOptions }
+  interface PublicRuntimeConfig extends ModulePublicRuntimeConfig {}
+}
+
+declare module 'nuxt/schema' {
+  interface NuxtConfig { ['site']?: Partial<ModuleOptions> }
+  interface NuxtOptions { ['site']?: ModuleOptions }
+  interface PublicRuntimeConfig extends ModulePublicRuntimeConfig {}
+}
+
+
+export { ModuleOptions, ModulePublicRuntimeConfig, default } from './module'

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "nuxt-site-config",
+  "type": "module",
+  "version": "2.0.0-beta.0",
+  "license": "MIT",
+  "funding": "https://github.com/sponsors/harlan-zw",
+  "homepage": "https://github.com/harlan-zw/nuxt-seo-kit#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/harlan-zw/nuxt-seo-kit.git",
+    "directory": "site-config"
+  },
+  "bugs": {
+    "url": "https://github.com/harlan-zw/nuxt-seo-kit/issues"
+  },
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/module.d.ts",
+      "import": "./dist/module.mjs"
+    },
+    "./build": {
+      "types": "./dist/build.d.ts",
+      "import": "./dist/build.mjs"
+    }
+  },
+  "main": "dist/module.mjs",
+  "module": "dist/module.mjs",
+  "types": "dist/module.d.ts",
+  "files": [
+    "dist",
+    "*.d.ts"
+  ],
+  "dependencies": {
+    "@nuxt/kit": "^3.5.1",
+    "@nuxt/module-builder": "^0.3.1",
+    "defu": "^6.1.2",
+    "ufo": "^1.1.2"
+  },
+  "scripts": {
+    "build": "nuxt-module-build",
+    "stub": "unbuild --stub"
+  }
+}