@carlonicora/nextjs-jsonapi 1.4.0 → 1.6.0

package/scripts/generate-web-module/utils/i18n-updater.ts

@@ -1,15 +1,13 @@
 /**
  * i18n Updater
  *
- * Updates the messages/en.json file with new module translations.
+ * Updates the messages/{language}.json files with new module translations.
  */
 
 import * as fs from "fs";
 import { FrontendTemplateData } from "../types/template-data.interface";
 import { buildI18nMessages } from "../transformers/i18n-generator";
 
-const MESSAGES_PATH = "apps/web/messages/en.json";
-
 export interface I18nUpdateResult {
   success: boolean;
   message: string;
@@ -17,20 +15,22 @@ export interface I18nUpdateResult {
 }
 
 /**
- * Update messages/en.json with new module translations
+ * Update messages/{language}.json with new module translations
  *
  * @param data - Frontend template data
  * @param webBasePath - Base path to web app
+ * @param language - Language code (e.g., "en", "es", "fr")
  * @param dryRun - Whether to perform a dry run
  * @returns Update result
  */
 export function updateI18n(
   data: FrontendTemplateData,
   webBasePath: string,
+  language: string = "en",
   dryRun: boolean = false
 ): I18nUpdateResult {
   const { names, i18nKeys } = data;
-  const messagesPath = `${webBasePath}/${MESSAGES_PATH}`;
+  const messagesPath = `${webBasePath}/apps/web/messages/${language}.json`;
 
   // Check if file exists
   if (!fs.existsSync(messagesPath)) {
@@ -48,7 +48,7 @@ export function updateI18n(
   } catch (e) {
     return {
       success: false,
-      message: `Failed to parse messages/en.json: ${e}`,
+      message: `Failed to parse messages/${language}.json: ${e}`,
     };
   }
 
@@ -56,7 +56,7 @@ export function updateI18n(
   if (messages.features && messages.features[names.camelCase]) {
     return {
       success: true,
-      message: `Module ${names.camelCase} already exists in messages/en.json`,
+      message: `Module ${names.camelCase} already exists in messages/${language}.json`,
       alreadyExists: true,
     };
   }
@@ -82,7 +82,7 @@ export function updateI18n(
   if (dryRun) {
     return {
       success: true,
-      message: `[DRY RUN] Would update messages/en.json with ${names.camelCase} translations`,
+      message: `[DRY RUN] Would update messages/${language}.json with ${names.camelCase} translations`,
     };
   }
 
@@ -92,7 +92,7 @@ export function updateI18n(
 
   return {
     success: true,
-    message: `Updated messages/en.json with ${names.camelCase} translations`,
+    message: `Updated messages/${language}.json with ${names.camelCase} translations`,
   };
 }
 

package/scripts/generate-web-module/validators/json-schema-validator.ts

@@ -134,11 +134,11 @@ export function validateJsonSchema(schema: any): ValidationError[] {
         });
       }
 
-      // Directory should be features or foundations
-      if (rel.directory && !["features", "foundations"].includes(rel.directory)) {
+      // Directory should be features, foundations, or @foundation (for package imports)
+      if (rel.directory && !["features", "foundations", "@foundation"].includes(rel.directory) && !rel.directory.startsWith("@foundation/")) {
         errors.push({
           field: `relationships[${index}].directory`,
-          message: 'Relationship directory should be "features" or "foundations"',
+          message: 'Relationship directory should be "features", "foundations", or "@foundation"',
           severity: "warning",
         });
       }

package/src/client/JsonApiClient.ts

@@ -0,0 +1,248 @@
+"use client";
+
+import { JsonApiDataFactory } from "../core/factories/JsonApiDataFactory";
+import { ApiRequestDataTypeInterface } from "../core/interfaces/ApiRequestDataTypeInterface";
+import { ApiResponseInterface } from "../core/interfaces/ApiResponseInterface";
+import { translateResponse } from "../core/utils/translateResponse";
+import { ModuleWithPermissions } from "../permissions/types";
+import { directFetch } from "./request";
+import { getClientToken } from "./token";
+
+// Config storage for client contexts
+let _clientConfig: {
+  apiUrl: string;
+  appUrl?: string;
+  trackablePages?: ModuleWithPermissions[];
+  bootstrapper?: () => void;
+  additionalHeaders?: Record<string, string>;
+} | null = null;
+
+/**
+ * Configure the JSON:API client for browser contexts.
+ * Call this in your client-side initialization or use JsonApiProvider.
+ */
+export function configureClientJsonApi(config: {
+  apiUrl: string;
+  appUrl?: string;
+  trackablePages?: ModuleWithPermissions[];
+  bootstrapper?: () => void;
+  additionalHeaders?: Record<string, string>;
+}): void {
+  _clientConfig = config;
+  if (config.bootstrapper) {
+    config.bootstrapper();
+  }
+}
+
+export function getClientApiUrl(): string {
+  if (_clientConfig?.apiUrl) {
+    return _clientConfig.apiUrl;
+  }
+  const envUrl = process.env.NEXT_PUBLIC_API_URL;
+  if (!envUrl) {
+    throw new Error("API URL not configured. Use configureClientJsonApi() or set NEXT_PUBLIC_API_URL environment variable.");
+  }
+  return envUrl;
+}
+
+export function getClientAppUrl(): string {
+  if (_clientConfig?.appUrl) {
+    return _clientConfig.appUrl;
+  }
+  const envUrl = process.env.NEXT_PUBLIC_ADDRESS;
+  if (!envUrl) {
+    throw new Error("App URL not configured. Use configureClientJsonApi({ appUrl }) or set NEXT_PUBLIC_ADDRESS environment variable.");
+  }
+  return envUrl.trim().replace(/\/+$/, "");
+}
+
+export function getClientTrackablePages(): ModuleWithPermissions[] {
+  return _clientConfig?.trackablePages ?? [];
+}
+
+function runClientBootstrapper(): void {
+  if (_clientConfig?.bootstrapper) {
+    _clientConfig.bootstrapper();
+  }
+}
+
+function buildClientUrl(endpoint: string): string {
+  const apiUrl = getClientApiUrl();
+  return endpoint.startsWith("http") ? endpoint : `${apiUrl}${endpoint}`;
+}
+
+export async function ClientJsonApiGet(params: {
+  classKey: ApiRequestDataTypeInterface;
+  endpoint: string;
+  companyId?: string;
+  language: string;
+}): Promise<ApiResponseInterface> {
+  runClientBootstrapper();
+  const token = await getClientToken();
+
+  const apiResponse = await directFetch({
+    method: "GET",
+    url: buildClientUrl(params.endpoint),
+    token,
+    companyId: params.companyId,
+    language: params.language,
+    additionalHeaders: _clientConfig?.additionalHeaders,
+  });
+
+  return translateResponse({
+    classKey: params.classKey,
+    apiResponse,
+    companyId: params.companyId,
+    language: params.language,
+    paginationHandler: async (endpoint: string) =>
+      ClientJsonApiGet({
+        classKey: params.classKey,
+        endpoint,
+        companyId: params.companyId,
+        language: params.language,
+      }),
+  });
+}
+
+export async function ClientJsonApiPost(params: {
+  classKey: ApiRequestDataTypeInterface;
+  endpoint: string;
+  companyId?: string;
+  body?: any;
+  overridesJsonApiCreation?: boolean;
+  files?: { [key: string]: File | Blob } | File | Blob;
+  language: string;
+  responseType?: ApiRequestDataTypeInterface;
+}): Promise<ApiResponseInterface> {
+  runClientBootstrapper();
+  const token = await getClientToken();
+
+  let body = params.body;
+  if (!body) {
+    body = {};
+  } else if (params.overridesJsonApiCreation !== true) {
+    body = JsonApiDataFactory.create(params.classKey, body);
+  }
+
+  const apiResponse = await directFetch({
+    method: "POST",
+    url: buildClientUrl(params.endpoint),
+    token,
+    body,
+    files: params.files,
+    companyId: params.companyId,
+    language: params.language,
+    additionalHeaders: _clientConfig?.additionalHeaders,
+  });
+
+  return translateResponse({
+    classKey: params.responseType ?? params.classKey,
+    apiResponse,
+    companyId: params.companyId,
+    language: params.language,
+  });
+}
+
+export async function ClientJsonApiPut(params: {
+  classKey: ApiRequestDataTypeInterface;
+  endpoint: string;
+  companyId?: string;
+  body?: any;
+  files?: { [key: string]: File | Blob } | File | Blob;
+  language: string;
+  responseType?: ApiRequestDataTypeInterface;
+}): Promise<ApiResponseInterface> {
+  runClientBootstrapper();
+  const token = await getClientToken();
+
+  let body = params.body;
+  if (!body) {
+    body = {};
+  } else {
+    body = JsonApiDataFactory.create(params.classKey, body);
+  }
+
+  const apiResponse = await directFetch({
+    method: "PUT",
+    url: buildClientUrl(params.endpoint),
+    token,
+    body,
+    files: params.files,
+    companyId: params.companyId,
+    language: params.language,
+    additionalHeaders: _clientConfig?.additionalHeaders,
+  });
+
+  return translateResponse({
+    classKey: params.responseType ?? params.classKey,
+    apiResponse,
+    companyId: params.companyId,
+    language: params.language,
+  });
+}
+
+export async function ClientJsonApiPatch(params: {
+  classKey: ApiRequestDataTypeInterface;
+  endpoint: string;
+  companyId?: string;
+  body?: any;
+  files?: { [key: string]: File | Blob } | File | Blob;
+  overridesJsonApiCreation?: boolean;
+  responseType?: ApiRequestDataTypeInterface;
+  language: string;
+}): Promise<ApiResponseInterface> {
+  runClientBootstrapper();
+  const token = await getClientToken();
+
+  let body = params.body;
+  if (!body) {
+    body = {};
+  } else if (params.overridesJsonApiCreation !== true) {
+    body = JsonApiDataFactory.create(params.classKey, body);
+  }
+
+  const apiResponse = await directFetch({
+    method: "PATCH",
+    url: buildClientUrl(params.endpoint),
+    token,
+    body,
+    files: params.files,
+    companyId: params.companyId,
+    language: params.language,
+    additionalHeaders: _clientConfig?.additionalHeaders,
+  });
+
+  return translateResponse({
+    classKey: params.responseType ?? params.classKey,
+    apiResponse,
+    companyId: params.companyId,
+    language: params.language,
+  });
+}
+
+export async function ClientJsonApiDelete(params: {
+  classKey: ApiRequestDataTypeInterface;
+  endpoint: string;
+  companyId?: string;
+  language: string;
+  responseType?: ApiRequestDataTypeInterface;
+}): Promise<ApiResponseInterface> {
+  runClientBootstrapper();
+  const token = await getClientToken();
+
+  const apiResponse = await directFetch({
+    method: "DELETE",
+    url: buildClientUrl(params.endpoint),
+    token,
+    companyId: params.companyId,
+    language: params.language,
+    additionalHeaders: _clientConfig?.additionalHeaders,
+  });
+
+  return translateResponse({
+    classKey: params.responseType ?? params.classKey,
+    apiResponse,
+    companyId: params.companyId,
+    language: params.language,
+  });
+}

package/src/client/config.ts

@@ -0,0 +1,78 @@
+"use client";
+
+import { ModuleWithPermissions } from "../permissions/types";
+
+// Config storage for client-side contexts
+let _clientConfig: {
+  apiUrl: string;
+  appUrl?: string;
+  trackablePages?: ModuleWithPermissions[];
+  bootstrapper?: () => void;
+  additionalHeaders?: Record<string, string>;
+} | null = null;
+
+/**
+ * Configure the JSON:API client. This is the main configuration function.
+ * This is typically called during app initialization.
+ */
+export function configureJsonApi(config: {
+  apiUrl: string;
+  appUrl?: string;
+  trackablePages?: ModuleWithPermissions[];
+  bootstrapper?: () => void;
+  additionalHeaders?: Record<string, string>;
+}): void {
+  _clientConfig = config;
+  // Call bootstrapper immediately to register all modules
+  if (config.bootstrapper) {
+    config.bootstrapper();
+  }
+}
+
+/**
+ * Configure the client config. This is typically called during app initialization.
+ * @deprecated Use configureJsonApi instead
+ */
+export function configureClientConfig(config: {
+  apiUrl: string;
+  appUrl?: string;
+  trackablePages?: ModuleWithPermissions[];
+}): void {
+  _clientConfig = config;
+}
+
+/**
+ * Get the configured API URL.
+ */
+export function getApiUrl(): string {
+  if (_clientConfig?.apiUrl) {
+    return _clientConfig.apiUrl;
+  }
+  if (typeof process !== "undefined" && process.env?.NEXT_PUBLIC_API_URL) {
+    return process.env.NEXT_PUBLIC_API_URL;
+  }
+  return "";
+}
+
+/**
+ * Get the configured app URL.
+ */
+export function getAppUrl(): string {
+  if (_clientConfig?.appUrl) {
+    return _clientConfig.appUrl;
+  }
+  if (typeof process !== "undefined" && process.env?.NEXT_PUBLIC_APP_URL) {
+    return process.env.NEXT_PUBLIC_APP_URL;
+  }
+  if (typeof window !== "undefined") {
+    return window.location.origin;
+  }
+  return "";
+}
+
+/**
+ * Get the configured trackable pages.
+ */
+export function getTrackablePages(): ModuleWithPermissions[] {
+  return _clientConfig?.trackablePages ?? [];
+}

package/src/client/index.ts

@@ -3,12 +3,17 @@
 // Context and Provider
 export * from "./context";
 
-// Hooks
+// Client-side hooks
 export * from "./hooks";
 
 // Client-side request utilities
 export * from "./request";
 export * from "./token";
+export * from "./JsonApiClient";
+export * from "./config";
+
+// All hooks (merged from /hooks entry point)
+export * from "../hooks";
 
 // Table generator registration (must be in client-only context)
 import { useCompanyTableStructure } from "../features/company/hooks";

package/src/components/containers/TabsContainer.tsx

@@ -1,7 +1,7 @@
 "use client";
 
 import { useCurrentUserContext } from "../../contexts";
-import { UserInterface } from "../../features";
+import { UserInterface } from "../../features/user/data";
 import { Action, ModuleWithPermissions } from "../../permissions";
 import { ScrollArea, Tabs, TabsContent, TabsList, TabsTrigger } from "../../shadcnui";
 import { cn } from "../../utils";

package/src/components/editors/BlockNoteEditor.tsx

@@ -8,7 +8,9 @@ import { CheckIcon, XIcon } from "lucide-react";
 import { useTranslations } from "next-intl";
 import React, { useCallback, useEffect, useMemo, useRef, useState } from "react";
 import { useCurrentUserContext } from "../../contexts";
-import { S3Interface, S3Service, UserInterface } from "../../features";
+import { S3Interface } from "../../features/s3/data";
+import { UserInterface } from "../../features/user/data";
+import { S3Service } from "../../features/s3/data/s3.service";
 import { Button } from "../../shadcnui";
 import { BlockNoteDiffUtil, BlockNoteWordDiffRendererUtil, cn } from "../../utils";
 import { errorToast } from "../errors";

package/src/components/index.ts

@@ -8,6 +8,7 @@ export * from "./navigations";
 export * from "./pages";
 export * from "./tables";
 
+// Feature components
 export * from "../features/auth/components";
 export * from "../features/company/components";
 export * from "../features/content/components";
@@ -15,3 +16,6 @@ export * from "../features/feature/components";
 export * from "../features/notification/components";
 export * from "../features/role/components";
 export * from "../features/user/components";
+
+// shadcn/ui components (merged from /shadcnui entry point)
+export * from "../shadcnui";

package/src/components/navigations/Breadcrumb.tsx

@@ -21,7 +21,7 @@ type BreadcrumbProps = { items: BreadcrumbItemData[] };
 
 const ITEMS_TO_DISPLAY = 3;
 
-export function Breadcrumb({ items }: BreadcrumbProps) {
+export function BreadcrumbNavigation({ items }: BreadcrumbProps) {
   const generateUrl = usePageUrlGenerator();
   const t = useTranslations();
 

package/src/components/navigations/Header.tsx

@@ -2,7 +2,7 @@
 
 import { useSharedContext } from "../../contexts/SharedContext";
 import { SidebarTrigger } from "../../shadcnui";
-import { Breadcrumb } from "./Breadcrumb";
+import { BreadcrumbNavigation } from "./Breadcrumb";
 
 type HeaderProps = {
   children?: React.ReactNode;
@@ -16,7 +16,7 @@ export function Header({ children }: HeaderProps) {
       <div className="bg-sidebar flex h-12 w-full flex-row items-center justify-between pl-2 pr-4">
         <SidebarTrigger aria-label="Toggle sidebar" />
         <div className="flex w-full flex-row items-center justify-start">
-          <Breadcrumb items={breadcrumbs} />
+          <BreadcrumbNavigation items={breadcrumbs} />
         </div>
         <div className="flex w-64 flex-row items-center justify-end gap-x-4 whitespace-nowrap">
           {children ? children : null}

package/src/contexts/CommonContext.tsx

@@ -3,7 +3,7 @@
 import { useTranslations } from "next-intl";
 
 import { createContext, ReactNode, useContext } from "react";
-import { UserInterface } from "../features";
+import { UserInterface } from "../features/user/data";
 import { useCurrentUserContext } from "../features/user/contexts";
 import { BreadcrumbItemData } from "../interfaces";
 import { SharedProvider } from "./SharedContext";

package/src/contexts/SocketContext.tsx

@@ -1,7 +1,7 @@
 "use client";
 
 import React, { createContext, useContext } from "react";
-import { NotificationInterface } from "../features";
+import { NotificationInterface } from "../features/notification/data";
 import { useSocket } from "../hooks";
 
 interface SocketContextProps {

package/src/contexts/index.ts

@@ -5,3 +5,6 @@ export * from "../features/user/contexts";
 export * from "./CommonContext";
 export * from "./SharedContext";
 export * from "./SocketContext";
+
+// Jotai atoms (merged from /atoms entry point)
+export * from "../atoms";