nuxt-site-config-kit 0.7.5 → 0.8.1

package/dist/index.cjs

@@ -14,21 +14,21 @@ async function getPkgJsonContextConfig(rootDir) {
     description: pkgJson.description
   };
 }
-async function initSiteConfig() {
-  const nuxt = kit.tryUseNuxt();
+async function initSiteConfig(nuxt = kit.tryUseNuxt()) {
   if (!nuxt)
     return;
   let siteConfig = nuxt._siteConfig;
   if (siteConfig)
     return siteConfig;
-  const rootDir = nuxt?.options.rootDir || process.cwd();
   siteConfig = siteConfigStack.createSiteConfigStack();
-  const isNodeEnv = !!process.env.NODE_ENV;
   siteConfig.push({
     _context: "defaults",
+    locale: "en",
     trailingSlash: false,
     titleSeparator: "|"
   });
+  const rootDir = nuxt?.options.rootDir || process.cwd();
+  const isNodeEnv = !!process.env.NODE_ENV;
   siteConfig.push({
     _context: "system",
     name: rootDir.split("/").pop(),
@@ -60,19 +60,23 @@ async function initSiteConfig() {
   nuxt._siteConfig = siteConfig;
   return siteConfig;
 }
-async function getSiteConfigStack() {
-  const lastFunctionName = new Error("tmp").stack?.split("\n")[2].split(" ")[5];
-  const container = await initSiteConfig();
-  if (!container)
-    throw new Error(`Site config isn't initialized. Make sure you're calling \`${lastFunctionName}\` within the Nuxt context.`);
-  return container;
+async function installNuxtSiteConfig(nuxt = kit.tryUseNuxt()) {
+  await kit.installModule(await kit.resolvePath("nuxt-site-config"));
+  await initSiteConfig(nuxt);
+}
+function getSiteConfigStack(nuxt = kit.tryUseNuxt()) {
+  if (!nuxt)
+    throw new Error("Nuxt context is missing.");
+  if (!nuxt._siteConfig)
+    throw new Error("Site config is not initialized. Make sure you are running your module after nuxt-site-config.");
+  return nuxt._siteConfig;
 }
-async function updateSiteConfig(input) {
-  const container = await getSiteConfigStack();
+function updateSiteConfig(input, nuxt = kit.tryUseNuxt()) {
+  const container = getSiteConfigStack(nuxt);
   container.push(input);
 }
-async function useSiteConfig() {
-  const container = await getSiteConfigStack();
+function useSiteConfig(nuxt = kit.tryUseNuxt()) {
+  const container = getSiteConfigStack(nuxt);
   return container.get();
 }
 
@@ -119,8 +123,30 @@ async function assertSiteConfig(mode, options) {
   };
 }
 
+function withSiteUrl(path, options = {}) {
+  const siteConfig = useSiteConfig();
+  if (!siteConfig.url && options.throwErrorOnMissingSiteUrl)
+    throw new Error("Missing url in site config. Please add `{ site: { url: <url> } }` to nuxt.config.ts.");
+  const nuxt = kit.useNuxt();
+  const base = nuxt.options.app.baseURL || nuxt.options.nitro.baseURL || "/";
+  return siteConfigStack.resolveSitePath(path, {
+    absolute: true,
+    siteUrl: siteConfig.url || "",
+    trailingSlash: siteConfig.trailingSlash,
+    base,
+    withBase: options.withBase
+  });
+}
+function withSiteTrailingSlash(path) {
+  const siteConfig = useSiteConfig();
+  return siteConfigStack.fixSlashes(siteConfig.trailingSlash, path);
+}
+
 exports.assertSiteConfig = assertSiteConfig;
 exports.initSiteConfig = initSiteConfig;
+exports.installNuxtSiteConfig = installNuxtSiteConfig;
 exports.requireSiteConfig = requireSiteConfig;
 exports.updateSiteConfig = updateSiteConfig;
 exports.useSiteConfig = useSiteConfig;
+exports.withSiteTrailingSlash = withSiteTrailingSlash;
+exports.withSiteUrl = withSiteUrl;

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import { SiteConfigInput, SiteConfigStack, SiteConfig } from 'site-config-stack';
 export { SiteConfig, SiteConfigInput, SiteConfigStack } from 'site-config-stack';
+import { Nuxt } from '@nuxt/schema';
 
 type AssertionModes = 'prerender' | 'generate' | 'build';
 interface ModuleAssertion {
@@ -17,9 +18,10 @@ declare module '@nuxt/schema' {
     }
 }
 
-declare function initSiteConfig(): Promise<SiteConfigStack | undefined>;
-declare function updateSiteConfig(input: SiteConfigInput): Promise<void>;
-declare function useSiteConfig(): Promise<SiteConfig>;
+declare function initSiteConfig(nuxt?: Nuxt | null): Promise<SiteConfigStack | undefined>;
+declare function installNuxtSiteConfig(nuxt?: Nuxt | null): Promise<void>;
+declare function updateSiteConfig(input: SiteConfigInput, nuxt?: Nuxt | null): void;
+declare function useSiteConfig(nuxt?: Nuxt | null): SiteConfig;
 
 declare function requireSiteConfig(context: string, requirements: Partial<Record<keyof SiteConfig, string>>, modes: Partial<Record<AssertionModes, boolean>>): void;
 declare function assertSiteConfig(mode: AssertionModes, options?: {
@@ -30,4 +32,10 @@ declare function assertSiteConfig(mode: AssertionModes, options?: {
     messages: string[];
 }>;
 
-export { AssertionModes, ModuleAssertion, assertSiteConfig, initSiteConfig, requireSiteConfig, updateSiteConfig, useSiteConfig };
+declare function withSiteUrl(path: string, options?: {
+    withBase?: boolean;
+    throwErrorOnMissingSiteUrl?: boolean;
+}): string;
+declare function withSiteTrailingSlash(path: string): string;
+
+export { AssertionModes, ModuleAssertion, assertSiteConfig, initSiteConfig, installNuxtSiteConfig, requireSiteConfig, updateSiteConfig, useSiteConfig, withSiteTrailingSlash, withSiteUrl };

package/dist/index.mjs

@@ -1,6 +1,6 @@
-import { tryUseNuxt, useNuxt, useLogger } from '@nuxt/kit';
+import { tryUseNuxt, installModule, resolvePath, useNuxt, useLogger } from '@nuxt/kit';
 import { readPackageJSON } from 'pkg-types';
-import { createSiteConfigStack, envSiteConfig } from 'site-config-stack';
+import { createSiteConfigStack, envSiteConfig, resolveSitePath, fixSlashes } from 'site-config-stack';
 
 async function getPkgJsonContextConfig(rootDir) {
   const pkgJson = await readPackageJSON(void 0, { startingFrom: rootDir });
@@ -12,21 +12,21 @@ async function getPkgJsonContextConfig(rootDir) {
     description: pkgJson.description
   };
 }
-async function initSiteConfig() {
-  const nuxt = tryUseNuxt();
+async function initSiteConfig(nuxt = tryUseNuxt()) {
   if (!nuxt)
     return;
   let siteConfig = nuxt._siteConfig;
   if (siteConfig)
     return siteConfig;
-  const rootDir = nuxt?.options.rootDir || process.cwd();
   siteConfig = createSiteConfigStack();
-  const isNodeEnv = !!process.env.NODE_ENV;
   siteConfig.push({
     _context: "defaults",
+    locale: "en",
     trailingSlash: false,
     titleSeparator: "|"
   });
+  const rootDir = nuxt?.options.rootDir || process.cwd();
+  const isNodeEnv = !!process.env.NODE_ENV;
   siteConfig.push({
     _context: "system",
     name: rootDir.split("/").pop(),
@@ -58,19 +58,23 @@ async function initSiteConfig() {
   nuxt._siteConfig = siteConfig;
   return siteConfig;
 }
-async function getSiteConfigStack() {
-  const lastFunctionName = new Error("tmp").stack?.split("\n")[2].split(" ")[5];
-  const container = await initSiteConfig();
-  if (!container)
-    throw new Error(`Site config isn't initialized. Make sure you're calling \`${lastFunctionName}\` within the Nuxt context.`);
-  return container;
+async function installNuxtSiteConfig(nuxt = tryUseNuxt()) {
+  await installModule(await resolvePath("nuxt-site-config"));
+  await initSiteConfig(nuxt);
+}
+function getSiteConfigStack(nuxt = tryUseNuxt()) {
+  if (!nuxt)
+    throw new Error("Nuxt context is missing.");
+  if (!nuxt._siteConfig)
+    throw new Error("Site config is not initialized. Make sure you are running your module after nuxt-site-config.");
+  return nuxt._siteConfig;
 }
-async function updateSiteConfig(input) {
-  const container = await getSiteConfigStack();
+function updateSiteConfig(input, nuxt = tryUseNuxt()) {
+  const container = getSiteConfigStack(nuxt);
   container.push(input);
 }
-async function useSiteConfig() {
-  const container = await getSiteConfigStack();
+function useSiteConfig(nuxt = tryUseNuxt()) {
+  const container = getSiteConfigStack(nuxt);
   return container.get();
 }
 
@@ -117,4 +121,23 @@ async function assertSiteConfig(mode, options) {
   };
 }
 
-export { assertSiteConfig, initSiteConfig, requireSiteConfig, updateSiteConfig, useSiteConfig };
+function withSiteUrl(path, options = {}) {
+  const siteConfig = useSiteConfig();
+  if (!siteConfig.url && options.throwErrorOnMissingSiteUrl)
+    throw new Error("Missing url in site config. Please add `{ site: { url: <url> } }` to nuxt.config.ts.");
+  const nuxt = useNuxt();
+  const base = nuxt.options.app.baseURL || nuxt.options.nitro.baseURL || "/";
+  return resolveSitePath(path, {
+    absolute: true,
+    siteUrl: siteConfig.url || "",
+    trailingSlash: siteConfig.trailingSlash,
+    base,
+    withBase: options.withBase
+  });
+}
+function withSiteTrailingSlash(path) {
+  const siteConfig = useSiteConfig();
+  return fixSlashes(siteConfig.trailingSlash, path);
+}
+
+export { assertSiteConfig, initSiteConfig, installNuxtSiteConfig, requireSiteConfig, updateSiteConfig, useSiteConfig, withSiteTrailingSlash, withSiteUrl };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "nuxt-site-config-kit",
   "type": "module",
-  "version": "0.7.5",
+  "version": "0.8.1",
   "description": "Shared site configuration build-time utilities for Nuxt 3 modules.",
   "license": "MIT",
   "funding": "https://github.com/sponsors/harlan-zw",
@@ -31,7 +31,7 @@
     "defu": "^6.1.2",
     "pkg-types": "^1.0.3",
     "ufo": "^1.1.2",
-    "site-config-stack": "0.7.5"
+    "site-config-stack": "0.8.1"
   },
   "scripts": {
     "lint": "eslint . --fix",