@okam/directus-next 1.2.10 → 1.2.11

package/CHANGELOG.md

@@ -1,3 +1,27 @@
+## 1.2.11 (2026-01-14)
+
+### 🚀 Features
+
+- ⚠️  React 19 + Next.js 15 upgrade for all @okam/* packages ([#369](https://github.com/OKAMca/stack/pull/369))
+
+### 🩹 Fixes
+
+- ⚠️  functions starting with "use" should be reserved to react hooks ([68f1f8f](https://github.com/OKAMca/stack/commit/68f1f8f))
+
+### ⚠️  Breaking Changes
+
+- Consumers must now have react and react-dom in their own
+
+### 🧱 Updated Dependencies
+
+- Updated stack-ui to 1.44.0
+- Updated next-component to 1.2.4
+
+### ❤️ Thank You
+
+- Marie-Maxime Tanguay @marie-maxime
+- Pierre-Olivier Clerson @poclerson
+
 ## 1.2.8 (2025-11-01)
 
 ### 🧱 Updated Dependencies

package/index.d.ts

@@ -4,5 +4,4 @@ export { logger as DirectusNextLogger } from './logger';
 export { directusRouteRouter } from './router/router';
 export { getJsonErrorResponse } from './response';
 export * from './types';
-export type { TPageSettings, TPageSettingsTranslation, TPageSettingsItemQuery, TPageSettingsItemDocument, TUsePageSettingsProps, } from './pageSettings/interface';
 export type { TFiles } from './files/interface';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@okam/directus-next",
   "main": "./index.js",
-  "version": "1.2.10",
+  "version": "1.2.11",
   "types": "./index.d.ts",
   "exports": {
     ".": {
@@ -34,8 +34,9 @@
   "dependencies": {
     "@okam/core-lib": "1.17.0",
     "@okam/directus-node": "0.6.2",
+    "@okam/stack-ui": "1.44.0",
     "@okam/logger": "1.1.0",
-    "@okam/next-component": "1.2.3",
+    "@okam/next-component": "1.2.4",
     "next": "^15.0.0",
     "radashi": "^12.3.0",
     "@okam/directus-query": "1.4.2",

package/pageSettings/context.d.ts

@@ -1,5 +1,6 @@
 import { Variables } from 'graphql-request';
-import { TPageSettingsQueryItem, TUsePageSettingsReturn } from './interface';
+import { TPageSettingsQueryItem } from '../types/pageSettings';
+import { TGetPageSettingsReturn } from './interface';
 
-export declare function pageSettingsContext<Item extends TPageSettingsQueryItem>(defaultValue?: TUsePageSettingsReturn<Item>): readonly [() => TUsePageSettingsReturn<Item> | undefined, (value: TUsePageSettingsReturn<Item> | undefined) => void];
+export declare function pageSettingsContext<Item extends TPageSettingsQueryItem>(defaultValue?: TGetPageSettingsReturn<Item>): readonly [() => TGetPageSettingsReturn<Item> | undefined, (value: TGetPageSettingsReturn<Item> | undefined) => void];
 export declare function pageSettingsVariablesContext(variables?: Variables): readonly [() => object | undefined, (value: object | undefined) => void];

package/pageSettings/{usePageSettings.d.ts → getPageSettings.d.ts}

@@ -1,5 +1,6 @@
 import { Variables } from 'graphql-request';
-import { TUsePageSettingsProps, TPageSettingsQueryItem, TUsePageSettingsReturn } from './interface';
+import { TPageSettingsQueryItem } from '../types/pageSettings';
+import { TGetPageSettingsProps, TGetPageSettingsReturn } from './interface';
 
 /**
  * @param props Optional props. Passing new props will trigger a new query if the variables have changed compared to the value of the variables in the cache. Omitting props will return the cached value.
@@ -28,4 +29,8 @@ import { TUsePageSettingsProps, TPageSettingsQueryItem, TUsePageSettingsReturn }
  * ```
  * @returns The new queried page settings item or the cached value if the variables have not changed. If the query contains a fragment, the contents of the fragment will be returned.
  */
-export declare function usePageSettings<Item extends TPageSettingsQueryItem, ItemKey extends string = string, QueryVariables extends Variables = Variables>(props?: TUsePageSettingsProps<Item, ItemKey, QueryVariables>, itemKey?: Exclude<ItemKey, '__typename'>): Promise<TUsePageSettingsReturn<Item>>;
+export declare function getPageSettings<Item extends TPageSettingsQueryItem, ItemKey extends string = string, QueryVariables extends Variables = Variables>(props?: TGetPageSettingsProps<Item, ItemKey, QueryVariables>, itemKey?: Exclude<ItemKey, '__typename'>): Promise<TGetPageSettingsReturn<Item>>;
+/**
+ * @deprecated Use `getPageSettings` instead
+ */
+export declare const usePageSettings: typeof getPageSettings;

package/pageSettings/index.d.ts

@@ -1,3 +1,3 @@
 export * from './context';
-export type { TPageSettings, TPageSettingsTranslation, TPageSettingsItemDocument, TPageSettingsItemQuery, } from './interface';
-export * from './usePageSettings';
+export type { TGetPageSettingsConfig, TGetPageSettingsProps, TGetPageSettingsReturn } from './interface';
+export { getPageSettings, usePageSettings } from './getPageSettings';

package/pageSettings/interface.d.ts

@@ -1,60 +1,17 @@
 import { TypedDocumentNode } from '@graphql-typed-document-node/core';
+import { Nullable } from '../../../../stack/stack-ui/src/index.ts';
 import { Variables } from 'graphql-request';
-import { TFiles } from '../files/interface';
-import { DirectusRouteConfig } from '../types/directusRouteConfig';
+import { TDirectusRouteConfig } from '../types/directusRouteConfig';
+import { Fragmentize } from '../types/Fragments';
+import { TPageSettings, TPageSettingsItemQuery, TPageSettingsQueryItem } from '../types/pageSettings';
 
-export type Fragmentize<FragmentData, FragmentName extends string = string> = {
-    ' $fragmentRefs'?: {
-        [FragmentKey in FragmentName]?: FragmentData | null | undefined;
-    } | null | undefined;
-} | null | undefined;
-export type MaybeArray<T> = T | (T | null | undefined)[] | null | undefined;
-/**
- * Directus page settings translations collection.
- */
-export type TPageSettingsTranslation = {
-    slug?: string | null;
-    title?: string | null;
-    path?: string | null;
-    languages_code?: {
-        code: string;
-    } | null;
-    page_settings_id?: TPageSettings | null;
-    canonical_url?: string | null;
-    meta_description?: string | null;
-    no_follow?: boolean | null;
-    no_index?: boolean | null;
-    og_image?: TFiles | null;
-};
-/**
- * Directus page settings collection.
- */
-export type TPageSettings = {
-    id: string;
-    belongs_to_collection?: string | null;
-    belongs_to_key?: string | null;
-    translations?: Array<TPageSettingsTranslation | null> | null;
-    route?: {
-        translations?: Array<{
-            route?: string | null;
-        } | null> | null;
-    } | null;
-};
-export type TPageSettingsQueryItem = {
-    page_settings?: TPageSettings | Fragmentize<TPageSettings, 'PageSettingsFragment'> | null | undefined;
-} | null | undefined;
-export type TPageSettingsItemQuery<Item extends TPageSettingsQueryItem, ItemKey extends string> = {
-    __typename?: 'Query';
-} & {
-    [Key in ItemKey]?: MaybeArray<Item> | MaybeArray<Fragmentize<Item>>;
-};
 export type TPageSettingsItemDocument<Item extends TPageSettingsQueryItem, ItemKey extends string, QueryVariables extends Variables> = TypedDocumentNode<TPageSettingsItemQuery<Item, ItemKey>, QueryVariables>;
-export type TUsePageSettingsConfig = DirectusRouteConfig | Record<string, string>;
+export type TGetPageSettingsConfig = TDirectusRouteConfig | Record<string, string>;
 /**
  * If not using a fragment in the item key, all type parameters must be passed. Otherwise, only the `page_settings` field will be in the type definition.
  * If using a fragment in the item key, the return type will contain the fragment.
  */
-export interface TUsePageSettingsProps<Item extends TPageSettingsQueryItem, ItemKey extends string, QueryVariables extends Variables> {
+export interface TGetPageSettingsProps<Item extends TPageSettingsQueryItem, ItemKey extends string, QueryVariables extends Variables> {
     document: TPageSettingsItemDocument<Item, ItemKey, QueryVariables>;
     /**
      * `variables.locale` is a special value that will get mapped according to the config.
@@ -63,8 +20,8 @@ export interface TUsePageSettingsProps<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?: TUsePageSettingsConfig;
+    config?: TGetPageSettingsConfig;
 }
-export type TUsePageSettingsReturn<Item extends TPageSettingsQueryItem> = Omit<Item, 'page_settings'> & {
-    page_settings?: Exclude<NonNullable<Item>['page_settings'], Fragmentize<TPageSettings, 'PageSettingsFragment'>> | null | undefined;
+export type TGetPageSettingsReturn<Item extends TPageSettingsQueryItem> = Omit<Item, 'page_settings'> & {
+    page_settings?: Nullable<Exclude<NonNullable<Item>['page_settings'], Fragmentize<TPageSettings, 'PageSettingsFragment'>>>;
 };

package/redirect/utils/getRedirectsRoute.d.ts

@@ -1,9 +1,9 @@
 import { TFetchRedirectsResponse } from '../../../../directus-node/src/edge.ts';
-import { DirectusRouteRedirectsModule } from '../../types/directusRouteConfig';
+import { TDirectusRouteRedirectsModule } from '../../types/directusRouteConfig';
 
 /**
  * Gets a response from `options.apiRoute`
- * @param {DirectusRouteRedirectsModule} options
+ * @param {TDirectusRouteRedirectsModule} options
  * @returns {Promise<TFetchRedirectsResponse>}
  */
-export declare function getRedirectsRoute({ apiRoute, getApiRouteUrl, getRedirectSecret, }?: DirectusRouteRedirectsModule): Promise<TFetchRedirectsResponse>;
+export declare function getRedirectsRoute({ apiRoute, getApiRouteUrl, getRedirectSecret, }?: TDirectusRouteRedirectsModule): Promise<TFetchRedirectsResponse>;

package/redirect/utils/handleRedirect.d.ts

@@ -1,7 +1,7 @@
 import { NextRequest, NextResponse } from 'next/server';
-import { DirectusRouteRedirectsModule } from '../../types/directusRouteConfig';
+import { TDirectusRouteRedirectsModule } from '../../types/directusRouteConfig';
 
 /**
  * Handles next redirection using directus redirects
  */
-export declare function handleRedirect(request: NextRequest, options?: DirectusRouteRedirectsModule): Promise<NextResponse<unknown> | null>;
+export declare function handleRedirect(request: NextRequest, options?: TDirectusRouteRedirectsModule): Promise<NextResponse<unknown> | null>;

package/router/router.d.ts

@@ -1,17 +1,17 @@
 import { NextRequest, NextResponse as NextResponseType } from 'next/server';
-import { DirectusRouteConfig } from '../types/directusRouteConfig';
+import { TDirectusRouteConfig } from '../types/directusRouteConfig';
 
 /**
  * Handles incoming middleware requests and rewrites the path to the new format according to fetched page settings.
  * @param request - The NextRequest object
- * @param config - The DirectusRouteConfig object
+ * @param config - The TDirectusRouteConfig object
  * @deprecated Use `directusRouteRouter(request, config)` instead. NextResponse is now directly imported in this file.
  * @param NextResponse - The NextResponse object
  * @returns NextResponse
  *
  * @example
  * ```typescript
- * export const directusConfig: DirectusRouteConfig = {
+ * export const directusConfig: TDirectusRouteConfig = {
  *  localeMap: {
  *    'fr-CA': 'fr',
  *    'en-CA': 'en',
@@ -28,7 +28,7 @@ import { DirectusRouteConfig } from '../types/directusRouteConfig';
  * }
  * ```
  */
-export declare function directusRouteRouter(request: NextRequest, config: DirectusRouteConfig, 
+export declare function directusRouteRouter(request: NextRequest, config: TDirectusRouteConfig, 
 /**
  * @deprecated Use `directusRouteRouter(request, config)` instead. NextResponse is now directly imported in this file.
  */

package/router/utils/fetchPageSettingsTranslation.d.ts

@@ -1,3 +1,3 @@
-import { PageSettingsTranslation } from '../../types';
+import { TPageSettingsTranslation } from '../../types';
 
-export declare function fetchPageSettingsTranslation(path: string): Promise<PageSettingsTranslation[] | null>;
+export declare function fetchPageSettingsTranslation(path: string): Promise<TPageSettingsTranslation[] | null>;

package/router/utils/locale.d.ts

@@ -1,4 +1,4 @@
-import { DirectusRouteConfig } from '../../types';
+import { TDirectusRouteConfig } from '../../types';
 
 /**
  * Validates if a given string is a valid locale from the directus route configuration.
@@ -6,14 +6,14 @@ import { DirectusRouteConfig } from '../../types';
  * @param config The Directus route configuration containing the locale map
  * @returns The validated locale string, or undefined if invalid
  */
-export declare function getValidLocale(maybeLocale: string | null | undefined, config: DirectusRouteConfig): string | undefined;
+export declare function getValidLocale(maybeLocale: string | null | undefined, config: TDirectusRouteConfig): string | undefined;
 /**
  * Splits the locale from the pathname and returns the locale and the pathname without the locale.
  * @param pathname The pathname to split the locale from
  * @param config The Directus route configuration containing the locale map
  * @returns The locale and the pathname without the locale
  */
-export declare function splitLocaleFromPathname(pathname: string, config: DirectusRouteConfig): {
+export declare function splitLocaleFromPathname(pathname: string, config: TDirectusRouteConfig): {
     locale: string;
     pathname: string;
 } | {

package/server.d.ts

@@ -1,3 +1,3 @@
 export { directusRouteRouter } from './router/router';
-export type { DirectusRouteConfig } from './types/directusRouteConfig';
+export type { TDirectusRouteConfig } from './types/directusRouteConfig';
 export * from './pageSettings';

package/server.js

@@ -15,20 +15,20 @@ function createServerContext(defaultValue) {
   return [getValue, setValue];
 }
 function pageSettingsContext(defaultValue) {
-  const [pageSettings, setPageSettings2] = createServerContext(defaultValue);
-  return [pageSettings, setPageSettings2];
+  const [pageSettings, setPageSettings] = createServerContext(defaultValue);
+  return [pageSettings, setPageSettings];
 }
 function pageSettingsVariablesContext(variables) {
   const [pageSettingsVariables, setPageSettingsVariables] = createServerContext(variables);
   return [pageSettingsVariables, setPageSettingsVariables];
 }
-const [getPageSettings, setPageSettings] = pageSettingsContext();
+const [getPageSettingsContext, setPageSettingsContext] = pageSettingsContext();
 const [getVariables, setVariables] = pageSettingsVariablesContext();
-function isDirectusRouteConfig(config) {
+function isTDirectusRouteConfig(config) {
   return !!config && "localeMap" in config;
 }
 function getDirectusVariables(variables, config) {
-  const localeMap = isDirectusRouteConfig(config) ? config.localeMap : config;
+  const localeMap = isTDirectusRouteConfig(config) ? config.localeMap : config;
   if (!localeMap) {
     return variables;
   }
@@ -36,11 +36,11 @@ function getDirectusVariables(variables, config) {
   const directusLocale = radashi.invert(localeMap)[locale] ?? locale;
   return { ...variables, locale: directusLocale };
 }
-async function usePageSettings(props, itemKey) {
+async function getPageSettings(props, itemKey) {
   var _a, _b, _c, _d, _e;
   const { variables, config } = props ?? {};
   const directusVariables = getDirectusVariables(variables, config);
-  const defaultReturn = getPageSettings() ?? {};
+  const defaultReturn = getPageSettingsContext();
   if (!props || radashi.isEqual(getVariables(), directusVariables)) {
     router.log("Using cached page settings", { path: (_c = (_b = (_a = defaultReturn.page_settings) == null ? void 0 : _a.translations) == null ? void 0 : _b[0]) == null ? void 0 : _c.path });
     return defaultReturn;
@@ -62,11 +62,13 @@ async function usePageSettings(props, itemKey) {
     return defaultReturn;
   }
   router.log("Caching new page settings", { path: currentPath });
-  setPageSettings(currentItem);
+  setPageSettingsContext(currentItem);
   setVariables(variables);
   return currentItem;
 }
+const usePageSettings = getPageSettings;
 exports.directusRouteRouter = router.directusRouteRouter;
+exports.getPageSettings = getPageSettings;
 exports.pageSettingsContext = pageSettingsContext;
 exports.pageSettingsVariablesContext = pageSettingsVariablesContext;
 exports.usePageSettings = usePageSettings;

package/server.mjs

@@ -14,20 +14,20 @@ function createServerContext(defaultValue) {
   return [getValue, setValue];
 }
 function pageSettingsContext(defaultValue) {
-  const [pageSettings, setPageSettings2] = createServerContext(defaultValue);
-  return [pageSettings, setPageSettings2];
+  const [pageSettings, setPageSettings] = createServerContext(defaultValue);
+  return [pageSettings, setPageSettings];
 }
 function pageSettingsVariablesContext(variables) {
   const [pageSettingsVariables, setPageSettingsVariables] = createServerContext(variables);
   return [pageSettingsVariables, setPageSettingsVariables];
 }
-const [getPageSettings, setPageSettings] = pageSettingsContext();
+const [getPageSettingsContext, setPageSettingsContext] = pageSettingsContext();
 const [getVariables, setVariables] = pageSettingsVariablesContext();
-function isDirectusRouteConfig(config) {
+function isTDirectusRouteConfig(config) {
   return !!config && "localeMap" in config;
 }
 function getDirectusVariables(variables, config) {
-  const localeMap = isDirectusRouteConfig(config) ? config.localeMap : config;
+  const localeMap = isTDirectusRouteConfig(config) ? config.localeMap : config;
   if (!localeMap) {
     return variables;
   }
@@ -35,11 +35,11 @@ function getDirectusVariables(variables, config) {
   const directusLocale = invert(localeMap)[locale] ?? locale;
   return { ...variables, locale: directusLocale };
 }
-async function usePageSettings(props, itemKey) {
+async function getPageSettings(props, itemKey) {
   var _a, _b, _c, _d, _e;
   const { variables, config } = props ?? {};
   const directusVariables = getDirectusVariables(variables, config);
-  const defaultReturn = getPageSettings() ?? {};
+  const defaultReturn = getPageSettingsContext();
   if (!props || isEqual(getVariables(), directusVariables)) {
     log("Using cached page settings", { path: (_c = (_b = (_a = defaultReturn.page_settings) == null ? void 0 : _a.translations) == null ? void 0 : _b[0]) == null ? void 0 : _c.path });
     return defaultReturn;
@@ -61,12 +61,14 @@ async function usePageSettings(props, itemKey) {
     return defaultReturn;
   }
   log("Caching new page settings", { path: currentPath });
-  setPageSettings(currentItem);
+  setPageSettingsContext(currentItem);
   setVariables(variables);
   return currentItem;
 }
+const usePageSettings = getPageSettings;
 export {
   d as directusRouteRouter,
+  getPageSettings,
   pageSettingsContext,
   pageSettingsVariablesContext,
   usePageSettings

package/types/Fragments.d.ts

@@ -0,0 +1,5 @@
+export type Fragmentize<FragmentData, FragmentName extends string = string> = {
+    ' $fragmentRefs'?: {
+        [FragmentKey in FragmentName]?: FragmentData | null | undefined;
+    } | null | undefined;
+} | null | undefined;

package/types/directusRouteConfig.d.ts

@@ -1,4 +1,4 @@
-export interface DirectusRouteRedirectsModule {
+export interface TDirectusRouteRedirectsModule {
     /**
      * @default process.env.NEXT_API_REDIRECT_SECRET
      */
@@ -12,7 +12,7 @@ export interface DirectusRouteRedirectsModule {
      */
     apiRoute?: string;
 }
-export interface DirectusRouteConfig {
+export interface TDirectusRouteConfig {
     localeMap?: Record<string, string>;
     collectionSettings: {
         [collection: string]: {
@@ -24,6 +24,6 @@ export interface DirectusRouteConfig {
         };
     };
     modules?: {
-        redirects?: DirectusRouteRedirectsModule;
+        redirects?: TDirectusRouteRedirectsModule;
     };
 }

package/types/index.d.ts

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

package/types/pageSettings.d.ts

@@ -1,13 +1,41 @@
-export interface PageSettingsTranslation {
-    languages_code?: {
-        code?: string | null | undefined;
-    } | null | undefined;
+import { Nullable } from '../../../../stack/stack-ui/src/index.ts';
+import { TFiles } from '../files';
+import { Fragmentize } from './Fragments';
+
+export interface TPageSettingsTranslation {
+    languages_code?: Nullable<{
+        code?: Nullable<string>;
+    }>;
+    page_settings_id?: Nullable<{
+        belongs_to_collection?: Nullable<string>;
+        belongs_to_key?: Nullable<string>;
+    }>;
+    title?: Nullable<string>;
+    slug?: Nullable<string>;
+    path?: Nullable<string>;
+    meta_description?: Nullable<string>;
+    no_follow?: Nullable<boolean>;
+    no_index?: Nullable<boolean>;
+    og_image?: Nullable<TFiles>;
+}
+export interface TPageSettings {
     id: string;
-    page_settings_id?: {
-        belongs_to_collection?: string | null | undefined;
-        belongs_to_key?: string | null | undefined;
-    } | null | undefined;
-    title?: string | null | undefined;
-    slug?: string | null | undefined;
-    path?: string | null | undefined;
+    belongs_to_collection?: Nullable<string>;
+    belongs_to_key?: Nullable<string>;
+    translations?: DeepNullableArray<TPageSettingsTranslation>;
+    route?: Nullable<{
+        translations?: DeepNullableArray<{
+            route?: Nullable<string>;
+        }>;
+    }>;
 }
+export type TPageSettingsQueryItem = Nullable<{
+    page_settings?: TPageSettings | Fragmentize<TPageSettings, 'PageSettingsFragment'>;
+}>;
+export type TPageSettingsItemQuery<Item extends TPageSettingsQueryItem, ItemKey extends string> = {
+    [Key in ItemKey]?: MaybeArray<Item> | MaybeArray<Fragmentize<Item>>;
+} & {
+    __typename?: 'Query';
+};
+export type DeepNullableArray<T> = Nullable<Nullable<T>[]>;
+export type MaybeArray<T> = T | (T | null | undefined)[] | null | undefined;