@carlonicora/nextjs-jsonapi 3.3.0 → 3.3.2

package/src/core/env.ts

@@ -0,0 +1,73 @@
+/**
+ * The single place in this package that reads `process.env`.
+ *
+ * Everything else imports {@link ENV}. Centralising the reads keeps every
+ * default in one place — the same contract `base.config.ts` provides on the
+ * NestJS side — instead of scattering `process.env.X || "…"` across hooks,
+ * clients and components where the fallbacks silently drift apart.
+ *
+ * WHY THE READS MUST STAY LITERAL: Next.js inlines `NEXT_PUBLIC_*` by textual
+ * substitution at build time, replacing the exact expression
+ * `process.env.NEXT_PUBLIC_FOO` with a string literal. A computed lookup
+ * (`process.env[key]`) is NOT substituted and reads as `undefined` in the
+ * browser bundle. Every entry below therefore spells its variable out in full,
+ * and new entries must do the same.
+ *
+ * WHY GETTERS AND NOT PLAIN PROPERTIES: every call site this replaced read
+ * `process.env` at CALL time, not at import time. A plain property would freeze
+ * the value when the module is first imported, which breaks any consumer that
+ * assigns the variable after boot — the package's own tests do exactly that.
+ * Getters keep the read lazy while leaving the expression literal, so the build
+ * time substitution still applies.
+ *
+ * Because that substitution happens before the code runs, no reference to
+ * `process` survives into the client bundle — so this module is safe to import
+ * from client components, server components, route handlers and middleware
+ * alike. It deliberately carries no `"use client"` directive for that reason.
+ *
+ * Values are normalised (empty string rather than `undefined`, booleans rather
+ * than string comparisons) so callers never repeat the parsing. Callers that
+ * must distinguish "unset" from "set to empty" — the URL getters, which throw a
+ * configuration error — check for an empty string.
+ */
+export const ENV = {
+  /** Public API base URL (NEXT_PUBLIC_API_URL). Empty when unset. */
+  get API_URL(): string {
+    return process.env.NEXT_PUBLIC_API_URL ?? "";
+  },
+  /** Public app base URL (NEXT_PUBLIC_ADDRESS). Empty when unset. */
+  get APP_URL(): string {
+    return process.env.NEXT_PUBLIC_ADDRESS ?? "";
+  },
+  /**
+   * Alternative app base URL (NEXT_PUBLIC_APP_URL), used only by
+   * `client/config.ts`'s `getAppUrl()` before it falls back to
+   * `window.location.origin`. Empty when unset.
+   */
+  get APP_URL_ALTERNATE(): string {
+    return process.env.NEXT_PUBLIC_APP_URL ?? "";
+  },
+  /** Web-push VAPID public key (NEXT_PUBLIC_VAPID_PUBLIC_KEY). Empty when unset. */
+  get VAPID_PUBLIC_KEY(): string {
+    return process.env.NEXT_PUBLIC_VAPID_PUBLIC_KEY ?? "";
+  },
+  /** Google Maps JS key (NEXT_PUBLIC_GOOGLE_MAPS_API_KEY). Empty disables autocomplete. */
+  get GOOGLE_MAPS_API_KEY(): string {
+    return process.env.NEXT_PUBLIC_GOOGLE_MAPS_API_KEY ?? "";
+  },
+  /**
+   * NEXT_PUBLIC_PRIVATE_INSTALLATION === "true", case-insensitively
+   * (default false). A private installation is a single-tenant deployment.
+   */
+  get PRIVATE_INSTALLATION(): boolean {
+    return process.env.NEXT_PUBLIC_PRIVATE_INSTALLATION?.toLowerCase() === "true";
+  },
+  /** NODE_ENV === "production" — set by the Next build, not by `.env`. */
+  get IS_PRODUCTION(): boolean {
+    return process.env.NODE_ENV === "production";
+  },
+  /** NODE_ENV === "development" — gates verbose client-side diagnostics. */
+  get IS_DEVELOPMENT(): boolean {
+    return process.env.NODE_ENV === "development";
+  },
+};

package/src/core/index.ts

@@ -1,4 +1,5 @@
 // Core interfaces
+export * from "./env";
 export * from "./interfaces";
 
 // Abstracts

package/src/features/auth/utils/AuthCookies.ts

@@ -1,5 +1,6 @@
 // Server-only cookie utilities (consumers should provide their own server actions via configureAuth)
 
+import { ENV } from "../../../core/env";
 import { cookies } from "next/headers";
 import { gzip } from "pako";
 
@@ -20,7 +21,7 @@ export async function updateToken(params: {
     };
   }[];
 }): Promise<void> {
-  const isProduction = process.env.NODE_ENV === "production";
+  const isProduction = ENV.IS_PRODUCTION;
 
   if (params.token)
     (await cookies()).set({

package/src/features/company/components/forms/CompanyEditor.tsx

@@ -21,6 +21,7 @@ import {
 } from "../../../../components";
 import type { FiscalDataHandle } from "../../../../components";
 import { SectionHeader } from "../../../../components/typography";
+import { ENV } from "../../../../core/env";
 import { Modules } from "../../../../core";
 import { useI18nRouter } from "../../../../i18n";
 import { getRoleId } from "../../../../roles";
@@ -69,7 +70,7 @@ function CompanyEditorInternal({
   const canAccessFeatures =
     hasRole(getRoleId().Administrator) ||
     (hasRole(getRoleId().CompanyAdministrator) &&
-      process.env.NEXT_PUBLIC_PRIVATE_INSTALLATION?.toLowerCase() === "true");
+      ENV.PRIVATE_INSTALLATION);
 
   // Fetch features when sheet opens
   const handleDialogOpenChange = useCallback(

package/src/hooks/usePushNotifications.ts

@@ -1,6 +1,7 @@
 "use client";
 
 import { useEffect } from "react";
+import { ENV } from "../core/env";
 import { useCurrentUserContext } from "../contexts";
 import { UserInterface } from "../features/user/data";
 import { PushService } from "../features/push/data/push.service";
@@ -43,7 +44,7 @@ export default function usePushNotifications(): void {
             return; // User denied permission, this is not an error
           }
 
-          const vapidPublicKey = (process.env.NEXT_PUBLIC_VAPID_PUBLIC_KEY || "").trim();
+          const vapidPublicKey = ENV.VAPID_PUBLIC_KEY.trim();
           if (!vapidPublicKey) {
             return;
           }

package/src/hooks/useSocket.ts

@@ -2,6 +2,7 @@
 
 import { useEffect, useRef, useState } from "react";
 import io from "socket.io-client";
+import { ENV } from "../core/env";
 import { Modules, rehydrate } from "../core";
 import { NotificationInterface } from "../features/notification/data";
 
@@ -45,7 +46,7 @@ export function useSocket({ token }: UseSocketOptions): UseSocketReturn {
   useEffect(() => {
     if (!token) return;
 
-    const globalSocketKey = `__socket_${process.env.NEXT_PUBLIC_API_URL?.replace(/[^a-zA-Z0-9]/g, "_")}`;
+    const globalSocketKey = `__socket_${ENV.API_URL.replace(/[^a-zA-Z0-9]/g, "_")}`;
 
     if (typeof window !== "undefined") {
       const _allSocketKeys = Object.keys(window).filter((key) => key.startsWith("__socket_"));
@@ -79,7 +80,7 @@ export function useSocket({ token }: UseSocketOptions): UseSocketReturn {
       shouldConnect.current = false;
 
       try {
-        currentSocket = io(process.env.NEXT_PUBLIC_API_URL as string, {
+        currentSocket = io(ENV.API_URL, {
           auth: { token },
           transports: ["websocket"],
           timeout: 20000,
@@ -147,7 +148,7 @@ export function useSocket({ token }: UseSocketOptions): UseSocketReturn {
 
       // In development, preserve socket in window for HMR but remove listeners
       if (currentSocket) {
-        if (process.env.NODE_ENV === "development") {
+        if (ENV.IS_DEVELOPMENT) {
           currentSocket.off("connect", handleConnect);
           currentSocket.off("disconnect", handleDisconnect);
           currentSocket.off("message", handleMessage);

package/src/server/JsonApiServer.ts

@@ -1,5 +1,6 @@
 // Server-only utilities (NOT server actions - these cannot be called from client components)
 
+import { ENV } from "../core/env";
 import { JsonApiDataFactory } from "../core/factories/JsonApiDataFactory";
 import { ApiRequestDataTypeInterface } from "../core/interfaces/ApiRequestDataTypeInterface";
 import { ApiResponseInterface } from "../core/interfaces/ApiResponseInterface";
@@ -38,7 +39,7 @@ export function getServerApiUrl(): string {
   if (_serverConfig?.apiUrl) {
     return _serverConfig.apiUrl;
   }
-  const envUrl = process.env.NEXT_PUBLIC_API_URL;
+  const envUrl = ENV.API_URL;
   if (!envUrl) {
     throw new Error(
       "API URL not configured. Use configureServerJsonApi() or set NEXT_PUBLIC_API_URL environment variable.",
@@ -51,7 +52,7 @@ export function getServerAppUrl(): string {
   if (_serverConfig?.appUrl) {
     return _serverConfig.appUrl;
   }
-  const envUrl = process.env.NEXT_PUBLIC_ADDRESS;
+  const envUrl = ENV.APP_URL;
   if (!envUrl) {
     throw new Error(
       "App URL not configured. Use configureServerJsonApi({ appUrl }) or set NEXT_PUBLIC_ADDRESS environment variable.",

package/src/unified/JsonApiRequest.ts

@@ -1,3 +1,4 @@
+import { ENV } from "../core/env";
 import { JsonApiDataFactory } from "../core/factories/JsonApiDataFactory";
 import { ApiData } from "../core/interfaces/ApiData";
 import { ApiRequestDataTypeInterface } from "../core/interfaces/ApiRequestDataTypeInterface";
@@ -136,7 +137,7 @@ export function getApiUrl(): string {
     return _staticConfig.apiUrl;
   }
   // Fallback to environment variable
-  const envUrl = process.env.NEXT_PUBLIC_API_URL;
+  const envUrl = ENV.API_URL;
   if (!envUrl) {
     throw new Error("API URL not configured. Use configureJsonApi() or set NEXT_PUBLIC_API_URL environment variable.");
   }
@@ -148,7 +149,7 @@ export function getAppUrl(): string {
     return _staticConfig.appUrl;
   }
   // Fallback to environment variable
-  const envUrl = process.env.NEXT_PUBLIC_ADDRESS;
+  const envUrl = ENV.APP_URL;
   if (!envUrl) {
     throw new Error(
       "App URL not configured. Use configureJsonApi({ appUrl }) or set NEXT_PUBLIC_ADDRESS environment variable.",

package/dist/JsonApiRequest-6TYNBVUL.js

@@ -1,26 +0,0 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});
-
-
-
-
-
-
-
-
-
-
-var _chunkPFAZPP54js = require('./chunk-PFAZPP54.js');
-require('./chunk-7QVYU63E.js');
-
-
-
-
-
-
-
-
-
-
-
-exports.JsonApiDelete = _chunkPFAZPP54js.JsonApiDelete; exports.JsonApiGet = _chunkPFAZPP54js.JsonApiGet; exports.JsonApiPatch = _chunkPFAZPP54js.JsonApiPatch; exports.JsonApiPost = _chunkPFAZPP54js.JsonApiPost; exports.JsonApiPut = _chunkPFAZPP54js.JsonApiPut; exports.buildUrl = _chunkPFAZPP54js.buildUrl; exports.configureJsonApi = _chunkPFAZPP54js.configureJsonApi; exports.getApiUrl = _chunkPFAZPP54js.getApiUrl; exports.getAppUrl = _chunkPFAZPP54js.getAppUrl; exports.getTrackablePages = _chunkPFAZPP54js.getTrackablePages;
-//# sourceMappingURL=JsonApiRequest-6TYNBVUL.js.map