@okam/directus-next 0.4.1 → 1.1.1

package/CHANGELOG.md

@@ -1,3 +1,18 @@
+## 1.1.1 (2025-07-09)
+
+### 🩹 Fixes
+
+- **directus-next:** missing external deps for build ([8146c77](https://github.com/OKAMca/stack/commit/8146c77))
+- update vite-plugin-dts to version 3 ([5d33c77](https://github.com/OKAMca/stack/commit/5d33c77))
+- package deps error ([b665a45](https://github.com/OKAMca/stack/commit/b665a45))
+- search field icon ([0850fde](https://github.com/OKAMca/stack/commit/0850fde))
+
+### ❤️ Thank You
+
+- Marie-Maxime Tanguay
+- Pierre-Olivier Clerson @poclerson
+- poclerson
+
 ## 0.3.0 (2024-12-03)
 
 

package/files/index.d.ts

@@ -0,0 +1 @@
+export type { TFiles } from './interface';

package/files/interface.d.ts

@@ -0,0 +1,24 @@
+export type TFiles = {
+    id?: string | null;
+    title?: string | null;
+    description?: string | null;
+    tags?: any | null;
+    location?: string | null;
+    storage?: string | null;
+    focal_point_divider?: string | null;
+    focal_point_x?: number | null;
+    focal_point_y?: number | null;
+    filename_disk?: string | null;
+    filename_download?: string | null;
+    type?: string | null;
+    width?: number | null;
+    height?: number | null;
+    duration?: number | null;
+    embed?: string | null;
+    caption?: string | null;
+    thumbhash?: string | null;
+    /**
+     * @deprecated Use `filename_download` instead
+     */
+    filenameDownload?: string | null;
+};

package/index.d.ts

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

package/{directus/directus-next/src/lib → lib}/directusRouteRouter.js

@@ -4,8 +4,11 @@ const logger = require("../logger.js");
 async function fetchPageSettingsTranslation(path) {
   const graphqlEndpoint = process.env.NEXT_SERVER_GRAPHQL_URL || process.env.NEXT_PUBLIC_GRAPHQL_URL;
   const graphqlApiKey = process.env.NEXT_PUBLIC_API_TOKEN;
-  if (!graphqlEndpoint || !graphqlApiKey) {
-    throw new Error("Missing GraphQL configuration");
+  if (!graphqlEndpoint) {
+    throw new Error("Missing GraphQL configuration `graphqlEndpoint`");
+  }
+  if (!graphqlApiKey) {
+    throw new Error("Missing GraphQL configuration `graphqlApiKey`");
   }
   const query = `
     query Languages_code($filter: page_settings_translations_filter) {
@@ -49,10 +52,15 @@ async function fetchPageSettingsTranslation(path) {
     return null;
   }
 }
+function removeLocaleFromPathname(pathname, config) {
+  const currentLocale = Object.values(config.localeMap ?? {}).find((locale) => pathname.startsWith(`/${locale}/`));
+  return { locale: currentLocale, pathname: currentLocale ? pathname.replace(`/${currentLocale}/`, "/") : pathname };
+}
 async function directusRouteRouter(request, config, NextResponse) {
   var _a, _b;
-  const { pathname } = request.nextUrl;
-  logger.log("Processing request for pathname:", pathname);
+  const { pathname: localizedPathname } = request.nextUrl;
+  const { locale, pathname } = removeLocaleFromPathname(localizedPathname, config);
+  logger.log("Processing request for pathname:", { locale, pathname });
   const translations = await fetchPageSettingsTranslation(pathname);
   if (!translations || translations.length === 0) {
     logger.log("No translation found for path:", pathname);

package/{directus/directus-next/src/lib → lib}/directusRouteRouter.mjs

@@ -2,8 +2,11 @@ import { log } from "../logger.mjs";
 async function fetchPageSettingsTranslation(path) {
   const graphqlEndpoint = process.env.NEXT_SERVER_GRAPHQL_URL || process.env.NEXT_PUBLIC_GRAPHQL_URL;
   const graphqlApiKey = process.env.NEXT_PUBLIC_API_TOKEN;
-  if (!graphqlEndpoint || !graphqlApiKey) {
-    throw new Error("Missing GraphQL configuration");
+  if (!graphqlEndpoint) {
+    throw new Error("Missing GraphQL configuration `graphqlEndpoint`");
+  }
+  if (!graphqlApiKey) {
+    throw new Error("Missing GraphQL configuration `graphqlApiKey`");
   }
   const query = `
     query Languages_code($filter: page_settings_translations_filter) {
@@ -47,10 +50,15 @@ async function fetchPageSettingsTranslation(path) {
     return null;
   }
 }
+function removeLocaleFromPathname(pathname, config) {
+  const currentLocale = Object.values(config.localeMap ?? {}).find((locale) => pathname.startsWith(`/${locale}/`));
+  return { locale: currentLocale, pathname: currentLocale ? pathname.replace(`/${currentLocale}/`, "/") : pathname };
+}
 async function directusRouteRouter(request, config, NextResponse) {
   var _a, _b;
-  const { pathname } = request.nextUrl;
-  log("Processing request for pathname:", pathname);
+  const { pathname: localizedPathname } = request.nextUrl;
+  const { locale, pathname } = removeLocaleFromPathname(localizedPathname, config);
+  log("Processing request for pathname:", { locale, pathname });
   const translations = await fetchPageSettingsTranslation(pathname);
   if (!translations || translations.length === 0) {
     log("No translation found for path:", pathname);

package/{directus/directus-next/src/logger.js → logger.js}

@@ -1,8 +1,7 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-require("../../../stack/logger/src/lib/logger.js");
-const factoryLogger = require("../../../stack/logger/src/lib/factoryLogger.js");
-const logger = factoryLogger("[DirectusNext]");
+const logger$1 = require("@okam/logger");
+const logger = logger$1.createLogger("[DirectusNext]");
 function log(msg, context, severity = "log") {
   if (process.env.NODE_ENV === "development") {
     logger.log(msg, severity, { context });

package/{directus/directus-next/src/logger.mjs → logger.mjs}

@@ -1,5 +1,4 @@
-import "../../../stack/logger/src/lib/logger.mjs";
-import createLogger from "../../../stack/logger/src/lib/factoryLogger.mjs";
+import { createLogger } from "@okam/logger";
 const logger = createLogger("[DirectusNext]");
 function log(msg, context, severity = "log") {
   if (process.env.NODE_ENV === "development") {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@okam/directus-next",
   "main": "./index.js",
-  "version": "0.4.1",
+  "version": "1.1.1",
   "types": "./index.d.ts",
   "exports": {
     ".": {
@@ -34,6 +34,11 @@
   "dependencies": {
     "@okam/logger": "1.1.0",
     "next": "^14.1.1",
-    "radashi": "^12.3.0"
+    "radashi": "^12.3.0",
+    "@okam/directus-query": "1.4.1",
+    "server-only": "0.0.1",
+    "graphql-request": "7.1.2",
+    "server-only-context": "0.1.0",
+    "@graphql-typed-document-node/core": "3.2.0"
   }
 }

package/pageSettings/context.d.ts

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

package/pageSettings/context.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+require("server-only");
+const createServerContext = require("server-only-context");
+function pageSettingsContext(defaultValue) {
+  const [pageSettings, setPageSettings] = createServerContext(defaultValue);
+  return [pageSettings, setPageSettings];
+}
+function pageSettingsVariablesContext(variables) {
+  const [pageSettingsVariables, setPageSettingsVariables] = createServerContext(variables);
+  return [pageSettingsVariables, setPageSettingsVariables];
+}
+exports.pageSettingsContext = pageSettingsContext;
+exports.pageSettingsVariablesContext = pageSettingsVariablesContext;

package/pageSettings/context.mjs

@@ -0,0 +1,14 @@
+import "server-only";
+import createServerContext from "server-only-context";
+function pageSettingsContext(defaultValue) {
+  const [pageSettings, setPageSettings] = createServerContext(defaultValue);
+  return [pageSettings, setPageSettings];
+}
+function pageSettingsVariablesContext(variables) {
+  const [pageSettingsVariables, setPageSettingsVariables] = createServerContext(variables);
+  return [pageSettingsVariables, setPageSettingsVariables];
+}
+export {
+  pageSettingsContext,
+  pageSettingsVariablesContext
+};

package/pageSettings/index.d.ts

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

package/pageSettings/interface.d.ts

@@ -0,0 +1,69 @@
+import { type TypedDocumentNode } from '@graphql-typed-document-node/core';
+import type { Variables } from 'graphql-request';
+import type { TFiles } from '../files/interface';
+import type { DirectusRouteConfig } from '../types/directusRouteConfig';
+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>;
+/**
+ * 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> {
+    document: TPageSettingsItemDocument<Item, ItemKey, QueryVariables>;
+    /**
+     * `variables.locale` is a special value that will get mapped according to the config.
+     */
+    variables?: QueryVariables;
+    /**
+     * 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;
+}
+export type TUsePageSettingsReturn<Item extends TPageSettingsQueryItem> = Omit<Item, 'page_settings'> & {
+    page_settings?: Exclude<NonNullable<Item>['page_settings'], Fragmentize<TPageSettings, 'PageSettingsFragment'>> | null | undefined;
+};

package/pageSettings/usePageSettings.d.ts

@@ -0,0 +1,30 @@
+import type { Variables } from 'graphql-request';
+import type { TUsePageSettingsProps, TPageSettingsQueryItem, TUsePageSettingsReturn } 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.
+ * @param itemKey Required if the query has more than a single root field
+ * @example
+ * #### `itemKey` not required
+ * ```graphql
+ * query PageById($id: ID!) {
+ *   pages_by_id(id: $id) {
+ *     ...Page
+ *   }
+ * }
+ * ```
+ *
+ * #### `itemKey` required
+ * Otherwise the first root field will be used as the item key automatically (not necessarily the correct one)
+ * ```graphql
+ * query PageAndPostById($id: ID!) {
+ *   pages_by_id(id: $id) {
+ *     ...Page
+ *   }
+ *   posts_by_id(id: $id) {
+ *     ...Post
+ *   }
+ * }
+ * ```
+ * @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>>;

package/pageSettings/usePageSettings.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const directusQuery = require("@okam/directus-query");
+const radashi = require("radashi");
+const logger = require("../logger.js");
+const context = require("./context.js");
+const [getPageSettings, setPageSettings] = context.pageSettingsContext();
+const [getVariables, setVariables] = context.pageSettingsVariablesContext();
+function isDirectusRouteConfig(config) {
+  return !!config && "localeMap" in config;
+}
+function getDirectusVariables(variables, config) {
+  const localeMap = isDirectusRouteConfig(config) ? config.localeMap : config;
+  if (!localeMap) {
+    return variables;
+  }
+  const locale = radashi.get(variables, "locale");
+  const directusLocale = radashi.invert(localeMap)[locale] ?? locale;
+  return { ...variables, locale: directusLocale };
+}
+async function usePageSettings(props, itemKey) {
+  var _a, _b, _c, _d, _e;
+  const { variables, config } = props ?? {};
+  const directusVariables = getDirectusVariables(variables, config);
+  const defaultReturn = getPageSettings() ?? {};
+  if (!props || radashi.isEqual(getVariables(), directusVariables)) {
+    logger.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;
+  }
+  const { document } = props;
+  const key = itemKey ?? radashi.get(document, "definitions[0].selectionSet.selections[0].name.value");
+  logger.log("Querying new page settings", directusVariables);
+  const result = await directusQuery.queryGql(document, directusVariables);
+  const items = result == null ? void 0 : result[key];
+  const currentItem = Array.isArray(items) ? items == null ? void 0 : items[0] : items;
+  const currentPageSettings = currentItem == null ? void 0 : currentItem.page_settings;
+  const currentPath = (_e = (_d = currentPageSettings == null ? void 0 : currentPageSettings.translations) == null ? void 0 : _d[0]) == null ? void 0 : _e.path;
+  if (!currentItem) {
+    logger.log("No item found. Falling back to cached page settings", { path: currentPath }, "warn");
+    return defaultReturn;
+  }
+  if (!currentPageSettings) {
+    logger.log("No page settings found. Falling back to cached page settings", { path: currentPath }, "warn");
+    return defaultReturn;
+  }
+  logger.log("Caching new page settings", { path: currentPath });
+  setPageSettings(currentItem);
+  setVariables(variables);
+  return currentItem;
+}
+exports.usePageSettings = usePageSettings;

package/pageSettings/usePageSettings.mjs

@@ -0,0 +1,51 @@
+import { queryGql } from "@okam/directus-query";
+import { isEqual, get, invert } from "radashi";
+import { log } from "../logger.mjs";
+import { pageSettingsContext, pageSettingsVariablesContext } from "./context.mjs";
+const [getPageSettings, setPageSettings] = pageSettingsContext();
+const [getVariables, setVariables] = pageSettingsVariablesContext();
+function isDirectusRouteConfig(config) {
+  return !!config && "localeMap" in config;
+}
+function getDirectusVariables(variables, config) {
+  const localeMap = isDirectusRouteConfig(config) ? config.localeMap : config;
+  if (!localeMap) {
+    return variables;
+  }
+  const locale = get(variables, "locale");
+  const directusLocale = invert(localeMap)[locale] ?? locale;
+  return { ...variables, locale: directusLocale };
+}
+async function usePageSettings(props, itemKey) {
+  var _a, _b, _c, _d, _e;
+  const { variables, config } = props ?? {};
+  const directusVariables = getDirectusVariables(variables, config);
+  const defaultReturn = getPageSettings() ?? {};
+  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;
+  }
+  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 items = result == null ? void 0 : result[key];
+  const currentItem = Array.isArray(items) ? items == null ? void 0 : items[0] : items;
+  const currentPageSettings = currentItem == null ? void 0 : currentItem.page_settings;
+  const currentPath = (_e = (_d = currentPageSettings == null ? void 0 : currentPageSettings.translations) == null ? void 0 : _d[0]) == null ? void 0 : _e.path;
+  if (!currentItem) {
+    log("No item found. Falling back to cached page settings", { path: currentPath }, "warn");
+    return defaultReturn;
+  }
+  if (!currentPageSettings) {
+    log("No page settings found. Falling back to cached page settings", { path: currentPath }, "warn");
+    return defaultReturn;
+  }
+  log("Caching new page settings", { path: currentPath });
+  setPageSettings(currentItem);
+  setVariables(variables);
+  return currentItem;
+}
+export {
+  usePageSettings
+};

package/server.d.ts

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

package/server.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const directusRouteRouter = require("./lib/directusRouteRouter.js");
+const context = require("./pageSettings/context.js");
+const usePageSettings = require("./pageSettings/usePageSettings.js");
+exports.directusRouteRouter = directusRouteRouter.directusRouteRouter;
+exports.pageSettingsContext = context.pageSettingsContext;
+exports.pageSettingsVariablesContext = context.pageSettingsVariablesContext;
+exports.usePageSettings = usePageSettings.usePageSettings;

package/server.mjs

@@ -0,0 +1,9 @@
+import { directusRouteRouter } from "./lib/directusRouteRouter.mjs";
+import { pageSettingsContext, pageSettingsVariablesContext } from "./pageSettings/context.mjs";
+import { usePageSettings } from "./pageSettings/usePageSettings.mjs";
+export {
+  directusRouteRouter,
+  pageSettingsContext,
+  pageSettingsVariablesContext,
+  usePageSettings
+};

package/directus/directus-next/src/server.js

@@ -1,4 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const directusRouteRouter = require("./lib/directusRouteRouter.js");
-exports.directusRouteRouter = directusRouteRouter.directusRouteRouter;

package/directus/directus-next/src/server.mjs

@@ -1,4 +0,0 @@
-import { directusRouteRouter } from "./lib/directusRouteRouter.mjs";
-export {
-  directusRouteRouter
-};

package/stack/logger/src/lib/factoryLogger.js

@@ -1,8 +0,0 @@
-"use strict";
-const logger = require("./logger.js");
-const createLogger = (name, logger$1, suppressConsole = false) => {
-  const log = new logger.Logger(name, logger$1, suppressConsole);
-  log.log(`Logger initialized`, "info");
-  return log;
-};
-module.exports = createLogger;

package/stack/logger/src/lib/factoryLogger.mjs

@@ -1,9 +0,0 @@
-import { Logger } from "./logger.mjs";
-const createLogger = (name, logger, suppressConsole = false) => {
-  const log = new Logger(name, logger, suppressConsole);
-  log.log(`Logger initialized`, "info");
-  return log;
-};
-export {
-  createLogger as default
-};

package/stack/logger/src/lib/logger.js

@@ -1,37 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-class Logger {
-  constructor(nameSpace, logger2, suppressConsole) {
-    this.nameSpace = "[STACK]";
-    this.suppressConsole = false;
-    this.env = process.env["NODE_ENV"];
-    this.nameSpace = nameSpace ?? this.nameSpace;
-    this.suppressConsole = suppressConsole ?? this.suppressConsole;
-    this.logger = logger2 ?? this.internalLogger;
-  }
-  internalLogger(message, severity, context) {
-    if (this.env === "production") {
-      return;
-    }
-    console[severity || "log"](`${this.nameSpace} ${message}`.trimStart(), context ?? "");
-  }
-  setLogger(logger2) {
-    this.logger = (message, severity, context) => {
-      if (this.suppressConsole) {
-        this.internalLogger(message, severity, context);
-      }
-      logger2(message, severity, context);
-    };
-  }
-  static getInstance() {
-    if (!Logger.instance) {
-      Logger.instance = new Logger();
-    }
-    return Logger.instance;
-  }
-  log(message, severity, context) {
-    this.logger(message, severity, context);
-  }
-}
-Logger.getInstance();
-exports.Logger = Logger;

package/stack/logger/src/lib/logger.mjs

@@ -1,37 +0,0 @@
-class Logger {
-  constructor(nameSpace, logger2, suppressConsole) {
-    this.nameSpace = "[STACK]";
-    this.suppressConsole = false;
-    this.env = process.env["NODE_ENV"];
-    this.nameSpace = nameSpace ?? this.nameSpace;
-    this.suppressConsole = suppressConsole ?? this.suppressConsole;
-    this.logger = logger2 ?? this.internalLogger;
-  }
-  internalLogger(message, severity, context) {
-    if (this.env === "production") {
-      return;
-    }
-    console[severity || "log"](`${this.nameSpace} ${message}`.trimStart(), context ?? "");
-  }
-  setLogger(logger2) {
-    this.logger = (message, severity, context) => {
-      if (this.suppressConsole) {
-        this.internalLogger(message, severity, context);
-      }
-      logger2(message, severity, context);
-    };
-  }
-  static getInstance() {
-    if (!Logger.instance) {
-      Logger.instance = new Logger();
-    }
-    return Logger.instance;
-  }
-  log(message, severity, context) {
-    this.logger(message, severity, context);
-  }
-}
-Logger.getInstance();
-export {
-  Logger
-};