@okam/directus-next 1.2.10 → 1.2.12

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';