@okam/directus-next 2.0.3 → 2.2.0

package/CHANGELOG.md

@@ -1,3 +1,39 @@
+## 2.1.1 (2026-03-26)
+
+### 🚀 Features
+
+- **directus-next:** getPageSettings props accepts gql client ([a6d983fa](https://github.com/OKAMca/stack/commit/a6d983fa))
+
+### 🩹 Fixes
+
+- **directus-next:** getPageSettings also allows custom query fn ([c76c5163](https://github.com/OKAMca/stack/commit/c76c5163))
+- **directus-next:** remove props client memoization to match config arg ([fb169f6a](https://github.com/OKAMca/stack/commit/fb169f6a))
+
+### 🧱 Updated Dependencies
+
+- Updated directus-query to 2.0.1
+
+### ❤️ Thank You
+
+- poclerson
+
+## 2.1.0 (2026-03-26)
+
+### 🚀 Features
+
+- **directus-next:** directus router default locale + display options ([#420](https://github.com/OKAMca/stack/pull/420))
+
+### 🩹 Fixes
+
+- resolve dependabot security alerts and clean up published package dependencies ([#441](https://github.com/OKAMca/stack/pull/441))
+- replace use server by server-only in server chunks ([#437](https://github.com/OKAMca/stack/pull/437))
+
+### ❤️ Thank You
+
+- Claude Opus 4.6 (1M context)
+- Marie-Maxime Tanguay @marie-maxime
+- Pierre-Olivier Clerson @poclerson
+
 ## 2.0.3 (2026-03-20)
 
 ### 🩹 Fixes

package/index.d.ts

@@ -4,4 +4,4 @@ export { logger as DirectusNextLogger } from './logger';
 export * from './redirect';
 export { getJsonErrorResponse } from './response';
 export { directusRouteRouter } from './router/router';
-export type * from './types';
+export * from './types';

package/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const router = require("./router-CwzG5Cu9.js");
+const router = require("./router-gCcQYkLJ.js");
 const headers = require("next/headers");
 const navigation = require("next/navigation");
 const radashi = require("radashi");
@@ -36,6 +36,7 @@ function getJsonErrorResponse(data, status) {
     headers: headers2
   });
 }
+const TEMPLATE_VAR_RE = /\{\{([a-z]+)\}\}/gi;
 function jsonStringsArraySchema(message, code) {
   return zod__namespace.string().transform((val, ctx) => {
     try {
@@ -97,7 +98,7 @@ function parseDraftParams(url, expectedSecret) {
 }
 function getPathFromRoute(routeUrl, url, index = 0) {
   const { searchParams } = new URL(url);
-  const matches = [...routeUrl.matchAll(/\{\{([a-z]+)\}\}/gi)];
+  const matches = [...routeUrl.matchAll(TEMPLATE_VAR_RE)];
   const map = {};
   matches.forEach((match) => {
     const key = match[1] ?? "";
@@ -202,12 +203,18 @@ async function handleRedirectsRoute({
   const { redirects, rewrites } = await edge.fetchRedirectsData({ graphqlEndpoint, graphqlApiKey, limit }, init);
   return new Response(JSON.stringify({ redirects, rewrites }), { status: 200 });
 }
+var DirectusRouteLocalePrefix = /* @__PURE__ */ ((DirectusRouteLocalePrefix2) => {
+  DirectusRouteLocalePrefix2["AsNeeded"] = "as-needed";
+  DirectusRouteLocalePrefix2["Always"] = "always";
+  return DirectusRouteLocalePrefix2;
+})(DirectusRouteLocalePrefix || {});
 exports.DirectusNextLogger = router.logger;
 exports.directusRouteRouter = router.directusRouteRouter;
 exports.getApiRouteUrlDefault = router.getApiRouteUrlDefault;
 exports.getRedirectSecretDefault = router.getRedirectSecretDefault;
 exports.getRedirectsRoute = router.getRedirectsRoute;
 exports.handleRedirect = router.handleRedirect;
+exports.DirectusRouteLocalePrefix = DirectusRouteLocalePrefix;
 exports.getDraftSecretDefault = getDraftSecretDefault;
 exports.getJsonErrorResponse = getJsonErrorResponse;
 exports.getPathFromRoute = getPathFromRoute;

package/index.mjs

@@ -1,5 +1,5 @@
-import { g as getRedirectSecretDefault } from "./router-16XNi-G3.mjs";
-import { l, d, a, b, h } from "./router-16XNi-G3.mjs";
+import { g as getRedirectSecretDefault } from "./router-CnD4Qckn.mjs";
+import { l, d, a, b, h } from "./router-CnD4Qckn.mjs";
 import { draftMode } from "next/headers";
 import { redirect } from "next/navigation";
 import { template } from "radashi";
@@ -18,6 +18,7 @@ function getJsonErrorResponse(data, status) {
     headers
   });
 }
+const TEMPLATE_VAR_RE = /\{\{([a-z]+)\}\}/gi;
 function jsonStringsArraySchema(message, code) {
   return zod.string().transform((val, ctx) => {
     try {
@@ -79,7 +80,7 @@ function parseDraftParams(url, expectedSecret) {
 }
 function getPathFromRoute(routeUrl, url, index = 0) {
   const { searchParams } = new URL(url);
-  const matches = [...routeUrl.matchAll(/\{\{([a-z]+)\}\}/gi)];
+  const matches = [...routeUrl.matchAll(TEMPLATE_VAR_RE)];
   const map = {};
   matches.forEach((match) => {
     const key = match[1] ?? "";
@@ -184,8 +185,14 @@ async function handleRedirectsRoute({
   const { redirects, rewrites } = await fetchRedirectsData({ graphqlEndpoint, graphqlApiKey, limit }, init);
   return new Response(JSON.stringify({ redirects, rewrites }), { status: 200 });
 }
+var DirectusRouteLocalePrefix = /* @__PURE__ */ ((DirectusRouteLocalePrefix2) => {
+  DirectusRouteLocalePrefix2["AsNeeded"] = "as-needed";
+  DirectusRouteLocalePrefix2["Always"] = "always";
+  return DirectusRouteLocalePrefix2;
+})(DirectusRouteLocalePrefix || {});
 export {
   l as DirectusNextLogger,
+  DirectusRouteLocalePrefix,
   d as directusRouteRouter,
   a as getApiRouteUrlDefault,
   getDraftSecretDefault,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@okam/directus-next",
-  "version": "2.0.3",
+  "version": "2.2.0",
   "repository": {
     "url": "https://github.com/OKAMca/stack.git"
   },
@@ -42,11 +42,11 @@
   },
   "dependencies": {
     "@graphql-typed-document-node/core": "3.2.0",
-    "@okam/core-lib": "2.0.0",
-    "@okam/directus-node": "1.0.0",
-    "@okam/directus-query": "2.0.0",
+    "@okam/core-lib": "2.1.0",
+    "@okam/directus-node": "1.1.0",
+    "@okam/directus-query": "2.1.0",
     "@okam/logger": "1.1.0",
-    "@okam/next-component": "2.0.3",
+    "@okam/next-component": "2.1.0",
     "graphql-request": "^7.1.2",
     "radashi": "^12.3.0",
     "server-only": "0.0.1",

package/pageSettings/interface.d.ts

@@ -1,5 +1,5 @@
 import { TypedDocumentNode } from '@graphql-typed-document-node/core';
-import { Variables } from 'graphql-request';
+import { GraphQLClient, Variables } from 'graphql-request';
 import { TDirectusRouteConfig } from '../types/directusRouteConfig';
 import { Fragmentize } from '../types/Fragments';
 import { TPageSettings, TPageSettingsItemQuery, TPageSettingsQueryItem } from '../types/pageSettings';
@@ -19,6 +19,30 @@ export interface TGetPageSettingsProps<Item extends TPageSettingsQueryItem, Item
      * Either a directus route config or directly a locale map. Not passing a config while passing a document will result in direct usage of the `locale` variable.
      */
     config?: TGetPageSettingsConfig;
+    /**
+     * GraphQL client to use for the query done via {@link queryGql}. Defaults to `@okam/directus-query` `defaultGraphqlRequestClient`
+     * @default defaultGraphqlRequestClient
+     */
+    client?: GraphQLClient;
+    /**
+     * Query function to replace the default {@link queryGql}. Note that `document`, `variables` and `client` still get passed to this function, but they can be overriden easily.
+     *
+     * @example
+     * ```ts
+     * const customGqlClient = new GraphQLClient()
+     *
+     * const product = await getPageSettings({
+     *   queryGqlFn: async (document, variables) => {
+     *     // ignore the `client` argument passed in the callback
+     *     const result = await queryGql(document, variables, customGqlClient)
+     *     return result
+     *   }
+     * })
+     * ```
+     *
+     * @default queryGql
+     */
+    queryGqlFn?: (document: TPageSettingsItemDocument<Item, ItemKey, QueryVariables>, queryKey?: QueryVariables | undefined, client?: GraphQLClient) => Promise<TPageSettingsItemQuery<Item, ItemKey>>;
 }
 export type TGetPageSettingsReturn<Item extends TPageSettingsQueryItem> = Omit<Item, 'page_settings'> & {
     page_settings?: Exclude<NonNullable<Item>['page_settings'], Fragmentize<TPageSettings, 'PageSettingsFragment'>> | null | undefined;

package/{router-16XNi-G3.mjs → router-CnD4Qckn.mjs}

@@ -1,3 +1,4 @@
+import { LocalePrefix } from "@okam/next-component/server";
 import { NextResponse } from "next/server";
 import { capitalize, isEmpty } from "radashi";
 import { createLogger } from "@okam/logger";
@@ -190,14 +191,21 @@ async function directusRouteRouter(request, config, NextResponse$1 = NextRespons
     log(`PageSettings with id ${id} was found but is not associated with any locale.`, { id }, "warn");
     return NextResponse$1.next();
   }
-  const mappedLocale = config.localeMap?.[directusLocale] || directusLocale;
-  const idField = config.collectionSettings[collection]?.idField || config.collectionSettings.default.idField;
+  const { localeMap, collectionSettings, localePrefix = LocalePrefix.Always, defaultLocale } = config;
+  const mappedLocale = localeMap?.[directusLocale] || directusLocale;
+  const isDirectusRouteLocalePrefixedMap = {
+    [LocalePrefix.Always]: true,
+    [LocalePrefix.AsNeeded]: directusLocale !== defaultLocale
+  };
+  const isDirectusRouteLocalePrefixed = isDirectusRouteLocalePrefixedMap[localePrefix];
+  const displayedLocale = isDirectusRouteLocalePrefixed ? `/${mappedLocale}` : "";
+  const idField = collectionSettings[collection]?.idField || collectionSettings.default.idField;
   log("Directus locale:", directusLocale);
   log("Mapped locale:", mappedLocale);
   log("Collection:", collection);
   log("ID Field:", idField);
   log("ID:", id);
-  const newPath = `/${mappedLocale}/${collection}/${id}`;
+  const newPath = `${displayedLocale}/${collection}/${id}`;
   log(`Rewriting path: ${pathname} -> ${newPath}`);
   const url = request.nextUrl.clone();
   url.pathname = newPath;

package/{router-CwzG5Cu9.js → router-gCcQYkLJ.js}

@@ -1,4 +1,5 @@
 "use strict";
+const server$1 = require("@okam/next-component/server");
 const server = require("next/server");
 const radashi = require("radashi");
 const logger$1 = require("@okam/logger");
@@ -191,14 +192,21 @@ async function directusRouteRouter(request, config, NextResponse = server.NextRe
     log(`PageSettings with id ${id} was found but is not associated with any locale.`, { id }, "warn");
     return NextResponse.next();
   }
-  const mappedLocale = config.localeMap?.[directusLocale] || directusLocale;
-  const idField = config.collectionSettings[collection]?.idField || config.collectionSettings.default.idField;
+  const { localeMap, collectionSettings, localePrefix = server$1.LocalePrefix.Always, defaultLocale } = config;
+  const mappedLocale = localeMap?.[directusLocale] || directusLocale;
+  const isDirectusRouteLocalePrefixedMap = {
+    [server$1.LocalePrefix.Always]: true,
+    [server$1.LocalePrefix.AsNeeded]: directusLocale !== defaultLocale
+  };
+  const isDirectusRouteLocalePrefixed = isDirectusRouteLocalePrefixedMap[localePrefix];
+  const displayedLocale = isDirectusRouteLocalePrefixed ? `/${mappedLocale}` : "";
+  const idField = collectionSettings[collection]?.idField || collectionSettings.default.idField;
   log("Directus locale:", directusLocale);
   log("Mapped locale:", mappedLocale);
   log("Collection:", collection);
   log("ID Field:", idField);
   log("ID:", id);
-  const newPath = `/${mappedLocale}/${collection}/${id}`;
+  const newPath = `${displayedLocale}/${collection}/${id}`;
   log(`Rewriting path: ${pathname} -> ${newPath}`);
   const url = request.nextUrl.clone();
   url.pathname = newPath;

package/server.js

@@ -1,7 +1,7 @@
 require("server-only");
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const router = require("./router-CwzG5Cu9.js");
+const router = require("./router-gCcQYkLJ.js");
 const directusQuery = require("@okam/directus-query");
 const radashi = require("radashi");
 const server = require("@okam/next-component/server");
@@ -16,11 +16,11 @@ function pageSettingsVariablesContext(variables) {
 }
 const [getPageSettingsContext, setPageSettingsContext] = pageSettingsContext();
 const [getVariables, setVariables] = pageSettingsVariablesContext();
-function isTDirectusRouteConfig(config) {
-  return config != null && "localeMap" in config;
+function isDirectusRouteConfig(config) {
+  return config != null && "collectionSettings" in config;
 }
 function getDirectusVariables(variables, config) {
-  const localeMap = isTDirectusRouteConfig(config) ? config.localeMap : config;
+  const localeMap = isDirectusRouteConfig(config) ? config.localeMap : config;
   if (localeMap == null) {
     return variables;
   }
@@ -29,7 +29,7 @@ function getDirectusVariables(variables, config) {
   return { ...variables, locale: directusLocale };
 }
 async function getPageSettings(props, itemKey) {
-  const { variables, config } = props ?? {};
+  const { variables, config, client = directusQuery.defaultGraphqlRequestClient, queryGqlFn = directusQuery.queryGql } = props ?? {};
   const directusVariables = getDirectusVariables(variables, config);
   const defaultReturn = getPageSettingsContext();
   if (props == null || radashi.isEqual(getVariables(), directusVariables)) {
@@ -39,7 +39,7 @@ async function getPageSettings(props, itemKey) {
   const { document } = props;
   const key = itemKey ?? radashi.get(document, "definitions[0].selectionSet.selections[0].name.value");
   router.log("Querying new page settings", directusVariables);
-  const result = await directusQuery.queryGql(document, directusVariables);
+  const result = await queryGqlFn(document, directusVariables, client);
   const items = result?.[key];
   const currentItem = Array.isArray(items) ? items?.[0] : items;
   const currentPageSettings = currentItem?.page_settings;

package/server.mjs

@@ -1,7 +1,7 @@
 import "server-only";
-import { c as log } from "./router-16XNi-G3.mjs";
-import { d } from "./router-16XNi-G3.mjs";
-import { queryGql } from "@okam/directus-query";
+import { c as log } from "./router-CnD4Qckn.mjs";
+import { d } from "./router-CnD4Qckn.mjs";
+import { queryGql, defaultGraphqlRequestClient } from "@okam/directus-query";
 import { isEqual, get, invert } from "radashi";
 import { createServerContext } from "@okam/next-component/server";
 import "server-only";
@@ -15,11 +15,11 @@ function pageSettingsVariablesContext(variables) {
 }
 const [getPageSettingsContext, setPageSettingsContext] = pageSettingsContext();
 const [getVariables, setVariables] = pageSettingsVariablesContext();
-function isTDirectusRouteConfig(config) {
-  return config != null && "localeMap" in config;
+function isDirectusRouteConfig(config) {
+  return config != null && "collectionSettings" in config;
 }
 function getDirectusVariables(variables, config) {
-  const localeMap = isTDirectusRouteConfig(config) ? config.localeMap : config;
+  const localeMap = isDirectusRouteConfig(config) ? config.localeMap : config;
   if (localeMap == null) {
     return variables;
   }
@@ -28,7 +28,7 @@ function getDirectusVariables(variables, config) {
   return { ...variables, locale: directusLocale };
 }
 async function getPageSettings(props, itemKey) {
-  const { variables, config } = props ?? {};
+  const { variables, config, client = defaultGraphqlRequestClient, queryGqlFn = queryGql } = props ?? {};
   const directusVariables = getDirectusVariables(variables, config);
   const defaultReturn = getPageSettingsContext();
   if (props == null || isEqual(getVariables(), directusVariables)) {
@@ -38,7 +38,7 @@ async function getPageSettings(props, itemKey) {
   const { document } = props;
   const key = itemKey ?? get(document, "definitions[0].selectionSet.selections[0].name.value");
   log("Querying new page settings", directusVariables);
-  const result = await queryGql(document, directusVariables);
+  const result = await queryGqlFn(document, directusVariables, client);
   const items = result?.[key];
   const currentItem = Array.isArray(items) ? items?.[0] : items;
   const currentPageSettings = currentItem?.page_settings;

package/types/directusRouteConfig.d.ts

@@ -1,3 +1,4 @@
+import { LocalePrefix } from '@okam/next-component/server';
 export interface TDirectusRouteRedirectsModule {
     /**
      * @default process.env.NEXT_API_REDIRECT_SECRET
@@ -12,8 +13,71 @@ export interface TDirectusRouteRedirectsModule {
      */
     apiRoute?: string;
 }
-export interface TDirectusRouteConfig {
-    localeMap?: Record<string, string>;
+/**
+ * @deprecated
+ * Use `LocalePrefix` from `@okam/next-component` instead.
+ */
+export declare enum DirectusRouteLocalePrefix {
+    /**
+     * The pathname will be prefixed with the locale only when it is not the default locale
+     *
+     * @example
+     * ```ts
+     * const directusConfig = {
+     *   localePrefix: 'as-needed',
+     *   defaultLocale: 'en-CA',
+     *   localeMap: {
+     *     'fr-CA': 'fr',
+     *     'en-CA': 'en',
+     *   }
+     * }
+     *
+     * // navigate to /en/products/1
+     * // output: /products/1 with english language
+     *
+     * // navigate to /products/1
+     * // output: /products/1 with english language
+     *
+     * // navigate to /fr/produits/1
+     * // output: /fr/produits/1 with french language
+     * ```
+     */
+    AsNeeded = "as-needed",
+    /**
+     * The pathname will always be prefixed by the locale
+     *
+     * @example
+     * ```ts
+     * const directusConfig = {
+     *   localePrefix: 'always',
+     *   defaultLocale: 'en-CA',
+     *   localeMap: {
+     *     'fr-CA': 'fr',
+     *     'en-CA': 'en',
+     *   }
+     * }
+     *
+     * // navigate to /en/products/1
+     * // output: /en/products/1 with english language
+     *
+     * // navigate to /products/1
+     * // output: /en/products/1 with english language
+     *
+     * // navigate to /fr/produits/1
+     * // output: /fr/produits/1 with french language
+     * ```
+     */
+    Always = "always"
+}
+export type TDirectusRouteI18n<Locales extends string> = {
+    defaultLocale: Locales;
+    localePrefix: `${LocalePrefix.AsNeeded}`;
+} | {
+    defaultLocale?: Locales;
+    localePrefix?: `${LocalePrefix.Always}` | undefined;
+};
+export type TDirectusRouteConfig<Locales extends string = string> = {
+    localeMap?: Record<Locales, string>;
     collectionSettings: {
         [collection: string]: {
             idField: string;
@@ -26,4 +90,4 @@ export interface TDirectusRouteConfig {
     modules?: {
         redirects?: TDirectusRouteRedirectsModule;
     };
-}
+} & TDirectusRouteI18n<Locales>;

package/types/index.d.ts

@@ -1,2 +1,3 @@
+export { DirectusRouteLocalePrefix } from './directusRouteConfig';
 export type { TDirectusRouteConfig, TDirectusRouteRedirectsModule } from './directusRouteConfig';
 export type { TPageSettings, TPageSettingsItemQuery, TPageSettingsQueryItem, TPageSettingsTranslation, } from './pageSettings';