strapi-plugin-navigation 2.5.4 → 3.0.0-beta.1

package/dist/server/src/controllers/client.d.ts

@@ -0,0 +1,192 @@
+import { Core } from '@strapi/strapi';
+import { Context as KoaContext } from 'koa';
+export default function clientController(context: {
+    strapi: Core.Strapi;
+}): {
+    getService(): {
+        readAll({ locale, orderBy, orderDirection }: import("../services/client/types").ReadAllInput): Promise<{
+            name: string;
+            id: number;
+            documentId: string;
+            slug: string;
+            localeCode: string;
+            visible: boolean;
+            items?: import("../schemas").NavigationItemDBSchema[] | undefined;
+        }[]>;
+        renderRFRNavigationItem({ item }: import("../services/client/types").RenderRFRNavInput): import("../dtos").RFRNavigationItemDTO;
+        renderRFRPage({ item, parent, enabledCustomFieldsNames }: import("../services/client/types").RenderRFRPageInput): import("../dtos").RFRPageDTO;
+        renderRFR({ items, parent, parentNavItem, contentTypes, enabledCustomFieldsNames, }: import("../services/client/types").RenderRFRInput): {
+            pages: {};
+            nav: {};
+        };
+        renderTree({ items, documentId, path, itemParser, }: import("../services/client/types").RenderTreeInput): Promise<import("../dtos").NavigationItemDTO[]>;
+        getCustomFields(additionalFields: ("audience" | {
+            type: "string" | "boolean";
+            name: string;
+            label: string;
+            options?: string[] | undefined;
+            required?: boolean | undefined;
+            enabled?: boolean | undefined;
+            multi?: false | undefined;
+        } | {
+            type: "media";
+            name: string;
+            label: string;
+            options?: string[] | undefined;
+            required?: boolean | undefined;
+            enabled?: boolean | undefined;
+            multi?: false | undefined;
+        } | {
+            options: string[];
+            type: "select";
+            name: string;
+            label: string;
+            multi: boolean;
+            required?: boolean | undefined;
+            enabled?: boolean | undefined;
+        })[]): ({
+            type: "string" | "boolean";
+            name: string;
+            label: string;
+            options?: string[] | undefined;
+            required?: boolean | undefined;
+            enabled?: boolean | undefined;
+            multi?: false | undefined;
+        } | {
+            type: "media";
+            name: string;
+            label: string;
+            options?: string[] | undefined;
+            required?: boolean | undefined;
+            enabled?: boolean | undefined;
+            multi?: false | undefined;
+        } | {
+            options: string[];
+            type: "select";
+            name: string;
+            label: string;
+            multi: boolean;
+            required?: boolean | undefined;
+            enabled?: boolean | undefined;
+        })[];
+        renderType({ criteria, filter, itemCriteria, locale, populate, rootPath, type, wrapRelated, }: import("../services/client/types").RenderTypeInput): Promise<import("../dtos").NavigationItemDTO[] | {
+            pages: {};
+            nav: {};
+        } | {
+            audience: string[] | undefined;
+            title: string;
+            related: any;
+            items: null;
+            path?: string | null | undefined;
+            type: "INTERNAL" | "EXTERNAL" | "WRAPPER";
+            id: number;
+            documentId: string;
+            slug?: string | null | undefined;
+            externalPath?: string | null | undefined;
+            uiRouterKey: string;
+            menuAttached: boolean;
+            order: number;
+            collapsed: boolean;
+            autoSync?: boolean | null | undefined;
+            master?: import("../dtos").NavigationDTO | undefined;
+            parent?: import("../dtos").NavigationItemDTO | null | undefined;
+        }[]>;
+        renderChildren({ childUIKey, idOrSlug, locale, menuOnly, type, wrapRelated, }: import("../services/client/types").RenderChildrenInput): Promise<import("../dtos").NavigationItemDTO[] | {
+            pages: {};
+            nav: {};
+        } | {
+            audience: string[] | undefined;
+            title: string;
+            related: any;
+            items: null;
+            path?: string | null | undefined;
+            type: "INTERNAL" | "EXTERNAL" | "WRAPPER";
+            id: number;
+            documentId: string;
+            slug?: string | null | undefined;
+            externalPath?: string | null | undefined;
+            uiRouterKey: string;
+            menuAttached: boolean;
+            order: number;
+            collapsed: boolean;
+            autoSync?: boolean | null | undefined;
+            master?: import("../dtos").NavigationDTO | undefined;
+            parent?: import("../dtos").NavigationItemDTO | null | undefined;
+        }[]>;
+        render({ idOrSlug, locale, menuOnly, populate, rootPath, type, wrapRelated, }: import("../services/client/types").RenderInput): Promise<import("../dtos").NavigationItemDTO[] | {
+            pages: {};
+            nav: {};
+        } | {
+            audience: string[] | undefined;
+            title: string;
+            related: any;
+            items: null;
+            path?: string | null | undefined;
+            type: "INTERNAL" | "EXTERNAL" | "WRAPPER";
+            id: number;
+            documentId: string;
+            slug?: string | null | undefined;
+            externalPath?: string | null | undefined;
+            uiRouterKey: string;
+            menuAttached: boolean;
+            order: number;
+            collapsed: boolean;
+            autoSync?: boolean | null | undefined;
+            master?: import("../dtos").NavigationDTO | undefined;
+            parent?: import("../dtos").NavigationItemDTO | null | undefined;
+        }[]>;
+    };
+    readAll(ctx: KoaContext): Promise<{
+        name: string;
+        id: number;
+        documentId: string;
+        slug: string;
+        localeCode: string;
+        visible: boolean;
+        items?: import("../schemas").NavigationItemDBSchema[] | undefined;
+    }[] | KoaContext>;
+    render(ctx: KoaContext): Promise<import("../dtos").NavigationItemDTO[] | {
+        pages: {};
+        nav: {};
+    } | {
+        audience: string[] | undefined;
+        title: string;
+        related: any;
+        items: null;
+        path?: string | null | undefined;
+        type: "INTERNAL" | "EXTERNAL" | "WRAPPER";
+        id: number;
+        documentId: string;
+        slug?: string | null | undefined;
+        externalPath?: string | null | undefined;
+        uiRouterKey: string;
+        menuAttached: boolean;
+        order: number;
+        collapsed: boolean;
+        autoSync?: boolean | null | undefined;
+        master?: import("../dtos").NavigationDTO | undefined;
+        parent?: import("../dtos").NavigationItemDTO | null | undefined;
+    }[]>;
+    renderChild(ctx: KoaContext): Promise<import("../dtos").NavigationItemDTO[] | {
+        pages: {};
+        nav: {};
+    } | {
+        audience: string[] | undefined;
+        title: string;
+        related: any;
+        items: null;
+        path?: string | null | undefined;
+        type: "INTERNAL" | "EXTERNAL" | "WRAPPER";
+        id: number;
+        documentId: string;
+        slug?: string | null | undefined;
+        externalPath?: string | null | undefined;
+        uiRouterKey: string;
+        menuAttached: boolean;
+        order: number;
+        collapsed: boolean;
+        autoSync?: boolean | null | undefined;
+        master?: import("../dtos").NavigationDTO | undefined;
+        parent?: import("../dtos").NavigationItemDTO | null | undefined;
+    }[]>;
+};

package/dist/server/src/controllers/index.d.ts

@@ -0,0 +1,7 @@
+import adminController from './admin';
+import clientController from './client';
+declare const _default: {
+    admin: typeof adminController;
+    client: typeof clientController;
+};
+export default _default;

package/dist/server/src/controllers/utils.d.ts

@@ -0,0 +1,4 @@
+type Populate = string | boolean | string[] | undefined;
+export declare const sanitizePopulateField: (populate: Populate) => Populate;
+export declare const parseId: (id: string) => string;
+export {};

package/dist/server/src/controllers/validators.d.ts

@@ -0,0 +1,49 @@
+import * as z from 'zod';
+export declare const idSchema: z.ZodString;
+export declare const readAllQuerySchema: z.ZodObject<{
+    locale: z.ZodOptional<z.ZodString>;
+    orderBy: z.ZodOptional<z.ZodString>;
+    orderDirection: z.ZodOptional<z.ZodEnum<["DESC", "ASC"]>>;
+}, "strip", z.ZodTypeAny, {
+    locale?: string | undefined;
+    orderBy?: string | undefined;
+    orderDirection?: "DESC" | "ASC" | undefined;
+}, {
+    locale?: string | undefined;
+    orderBy?: string | undefined;
+    orderDirection?: "DESC" | "ASC" | undefined;
+}>;
+export declare const renderTypeSchema: z.ZodEnum<["FLAT", "TREE", "RFR"]>;
+export declare const populateSchema: z.ZodUnion<[z.ZodBoolean, z.ZodString, z.ZodArray<z.ZodString, "many">, z.ZodUndefined]>;
+export declare const renderQuerySchema: z.ZodObject<{
+    type: z.ZodOptional<z.ZodEnum<["FLAT", "TREE", "RFR"]>>;
+    menu: z.ZodOptional<z.ZodEnum<["true", "false"]>>;
+    path: z.ZodOptional<z.ZodString>;
+    locale: z.ZodOptional<z.ZodString>;
+    populate: z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodString, z.ZodArray<z.ZodString, "many">, z.ZodUndefined]>>;
+}, "strip", z.ZodTypeAny, {
+    path?: string | undefined;
+    type?: "FLAT" | "TREE" | "RFR" | undefined;
+    populate?: string | boolean | string[] | undefined;
+    locale?: string | undefined;
+    menu?: "true" | "false" | undefined;
+}, {
+    path?: string | undefined;
+    type?: "FLAT" | "TREE" | "RFR" | undefined;
+    populate?: string | boolean | string[] | undefined;
+    locale?: string | undefined;
+    menu?: "true" | "false" | undefined;
+}>;
+export declare const renderChildQueryParams: z.ZodObject<{
+    type: z.ZodOptional<z.ZodEnum<["FLAT", "TREE", "RFR"]>>;
+    menu: z.ZodOptional<z.ZodEnum<["true", "false"]>>;
+    locale: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    type?: "FLAT" | "TREE" | "RFR" | undefined;
+    locale?: string | undefined;
+    menu?: "true" | "false" | undefined;
+}, {
+    type?: "FLAT" | "TREE" | "RFR" | undefined;
+    locale?: string | undefined;
+    menu?: "true" | "false" | undefined;
+}>;

package/dist/server/src/destroy.d.ts

@@ -0,0 +1,5 @@
+import type { Core } from '@strapi/strapi';
+declare const destroy: ({ strapi }: {
+    strapi: Core.Strapi;
+}) => void;
+export default destroy;

package/dist/server/src/dtos/config.d.ts

@@ -0,0 +1,28 @@
+import { NavigationPluginConfigDBSchema } from '../schemas';
+import { CONTENT_TYPES_NAME_FIELDS_DEFAULTS } from '../utils';
+export type ConfigContentTypeDTO = {
+    uid: string;
+    name: string;
+    draftAndPublish: boolean | undefined;
+    isSingle: boolean;
+    description: string;
+    collectionName: string;
+    contentTypeName: string;
+    label: string;
+    relatedField: string | undefined;
+    templateName: string | undefined;
+    available: boolean | undefined;
+    labelSingular: string;
+    endpoint: string;
+    plugin: string | undefined;
+    visible: boolean;
+};
+export type NavigationPluginConfigDTO = Pick<NavigationPluginConfigDBSchema, 'additionalFields' | 'allowedLevels' | 'cascadeMenuAttached' | 'preferCustomContentTypes' | 'contentTypesNameFields' | 'contentTypesPopulate' | 'gql' | 'pathDefaultFields'> & {
+    contentTypes: ConfigContentTypeDTO[];
+    contentTypesNameFields: {
+        default: typeof CONTENT_TYPES_NAME_FIELDS_DEFAULTS;
+    } & Record<string, string[]>;
+    isGQLPluginEnabled: boolean | undefined;
+    isCachePluginEnabled: boolean | undefined;
+    isCacheEnabled: boolean | undefined;
+};

package/dist/server/src/dtos/index.d.ts

@@ -0,0 +1,3 @@
+export * from './config';
+export * from './navigation-item';
+export * from './navigation';

package/dist/server/src/dtos/navigation-item.d.ts

@@ -0,0 +1,52 @@
+import { NavigationItemDBSchema, NavigationItemType } from '../schemas';
+import { NavigationDTO } from './navigation';
+export type NavigationItemDTO = Omit<NavigationItemDBSchema, 'related' | 'items' | 'master' | 'parent'> & {
+    related?: {
+        id: number;
+        uid: string;
+        documentId: string;
+        locale?: string;
+    } | null;
+    items?: NavigationItemDTO[];
+    master?: NavigationDTO;
+    parent?: NavigationItemDTO | null;
+    order?: number;
+};
+export type CreateBranchNavigationItemDTO = Omit<NavigationItemDBSchema, 'id' | 'documentId' | 'items'> & {
+    id?: number;
+    documentId?: string;
+    items?: CreateBranchNavigationItemDTO[];
+    removed?: boolean;
+    updated?: boolean;
+};
+export type RFRNavigationItemDTO = {
+    label: string;
+    type: NavigationItemType;
+    audience?: string[];
+} | {
+    label: string;
+    type: NavigationItemType;
+    audience?: string[];
+    url: string;
+} | {
+    label: string;
+    type: NavigationItemType;
+    audience?: string[];
+    page: string;
+};
+export type RFRPageDTO = Pick<NavigationItemDTO, 'title' | 'path' | 'audience' | 'menuAttached'> & {
+    id: NavigationItemDTO['uiRouterKey'];
+    documentId: string;
+    templateName?: string;
+    related?: {
+        contentType: string;
+        documentId?: string;
+    };
+    parent?: string;
+} & Record<string, unknown>;
+export type RFRRenderDTO = {
+    nav: {
+        root: RFRNavigationItemDTO[];
+    } & Record<string, RFRNavigationItemDTO[]>;
+    pages: Record<string, RFRPageDTO>;
+};

package/dist/server/src/dtos/navigation.d.ts

@@ -0,0 +1,5 @@
+import { NavigationDBSchema } from '../schemas';
+import { NavigationItemDTO } from './navigation-item';
+export type NavigationDTO = Omit<NavigationDBSchema, 'items'> & {
+    items?: NavigationItemDTO[];
+};

package/dist/server/src/graphql/config.d.ts

@@ -0,0 +1,5 @@
+import { Core } from '@strapi/strapi';
+declare const _default: ({ strapi }: {
+    strapi: Core.Strapi;
+}) => Promise<void>;
+export default _default;

package/dist/server/src/graphql/index.d.ts

@@ -0,0 +1 @@
+export * from "./setup";

package/dist/server/src/graphql/queries/index.d.ts

@@ -0,0 +1 @@
+export declare const getQueries: (context: any) => any;

package/dist/server/src/graphql/queries/render-navigation-child.d.ts

@@ -0,0 +1,31 @@
+export declare const renderNavigationChild: ({ strapi, nexus }: any) => {
+    type: any;
+    args: {
+        documentId: any;
+        childUiKey: any;
+        type: string;
+        menuOnly: any;
+    };
+    resolve(_: any, args: any): Promise<import("../../dtos").NavigationItemDTO[] | {
+        pages: {};
+        nav: {};
+    } | {
+        audience: string[] | undefined;
+        title: string;
+        related: any;
+        items: null;
+        path?: string | null | undefined;
+        type: "INTERNAL" | "EXTERNAL" | "WRAPPER";
+        id: number;
+        documentId: string;
+        slug?: string | null | undefined;
+        externalPath?: string | null | undefined;
+        uiRouterKey: string;
+        menuAttached: boolean;
+        order: number;
+        collapsed: boolean;
+        autoSync?: boolean | null | undefined;
+        master?: import("../../dtos").NavigationDTO | undefined;
+        parent?: import("../../dtos").NavigationItemDTO | null | undefined;
+    }[]>;
+};

package/dist/server/src/graphql/queries/render-navigation.d.ts

@@ -0,0 +1,32 @@
+export declare const renderNavigation: ({ strapi, nexus }: any) => {
+    args: {
+        navigationIdOrSlug: any;
+        type: string;
+        menuOnly: any;
+        path: any;
+        locale: any;
+    };
+    type: any;
+    resolve(_: unknown, { navigationIdOrSlug, type, menuOnly, path: rootPath, locale }: any): Promise<import("../../dtos").NavigationItemDTO[] | {
+        pages: {};
+        nav: {};
+    } | {
+        audience: string[] | undefined;
+        title: string;
+        related: any;
+        items: null;
+        path?: string | null | undefined;
+        type: "INTERNAL" | "EXTERNAL" | "WRAPPER";
+        id: number;
+        documentId: string;
+        slug?: string | null | undefined;
+        externalPath?: string | null | undefined;
+        uiRouterKey: string;
+        menuAttached: boolean;
+        order: number;
+        collapsed: boolean;
+        autoSync?: boolean | null | undefined;
+        master?: import("../../dtos").NavigationDTO | undefined;
+        parent?: import("../../dtos").NavigationItemDTO | null | undefined;
+    }[]>;
+};

package/{server → dist/server/src}/graphql/resolvers-config.d.ts

@@ -1,4 +1,4 @@
-declare function _exports({}: {}): {
+export declare const getResolversConfig: () => {
     'Query.renderNavigationChild': {
         auth: boolean;
     };
@@ -6,5 +6,3 @@ declare function _exports({}: {}): {
         auth: boolean;
     };
 };
-export = _exports;
-//# sourceMappingURL=resolvers-config.d.ts.map

package/dist/server/src/graphql/setup.d.ts

@@ -0,0 +1,4 @@
+import { Core } from '@strapi/strapi';
+export declare const graphQLSetup: ({ strapi }: {
+    strapi: Core.Strapi;
+}) => Promise<void>;

package/dist/server/src/graphql/types/content-types-name-fields.d.ts

@@ -0,0 +1,2 @@
+declare const _default: ({ nexus, strapi }: any) => any;
+export default _default;

package/dist/server/src/graphql/types/content-types.d.ts

@@ -0,0 +1,2 @@
+declare const _default: ({ nexus }: any) => any;
+export default _default;

package/dist/server/src/graphql/types/create-navigation-item.d.ts

@@ -0,0 +1,2 @@
+declare const _default: ({ nexus }: any) => any;
+export default _default;

package/dist/server/src/graphql/types/create-navigation-related.d.ts

@@ -0,0 +1,2 @@
+declare const _default: ({ nexus }: any) => any;
+export default _default;

package/dist/server/src/graphql/types/create-navigation.d.ts

@@ -0,0 +1,2 @@
+declare const _default: ({ nexus }: any) => any;
+export default _default;

package/dist/server/src/graphql/types/index.d.ts

@@ -0,0 +1 @@
+export declare const getTypes: (context: any) => any[];

package/dist/server/src/graphql/types/navigation-config.d.ts

@@ -0,0 +1,2 @@
+declare const _default: ({ nexus }: any) => any;
+export default _default;

package/dist/server/src/graphql/types/navigation-details.d.ts

@@ -0,0 +1,2 @@
+declare const _default: ({ nexus }: any) => any;
+export default _default;

package/dist/server/src/graphql/types/navigation-item-additional-field-media.d.ts

@@ -0,0 +1,2 @@
+declare const _default: ({ nexus }: any) => any;
+export default _default;

package/dist/server/src/graphql/types/navigation-item-additional-fields.d.ts

@@ -0,0 +1,2 @@
+declare const _default: ({ nexus, config }: any) => any;
+export default _default;

package/dist/server/src/graphql/types/navigation-item-related-data.d.ts

@@ -0,0 +1,2 @@
+declare const _default: ({ nexus }: any) => any;
+export default _default;

package/dist/server/src/graphql/types/navigation-item-related.d.ts

@@ -0,0 +1,2 @@
+declare const _default: ({ strapi, nexus, config }: any) => any;
+export default _default;

package/dist/server/src/graphql/types/navigation-item.d.ts

@@ -0,0 +1,2 @@
+declare const _default: ({ nexus, config }: any) => any;
+export default _default;

package/dist/server/src/graphql/types/navigation-render-type.d.ts

@@ -0,0 +1,2 @@
+declare const _default: ({ nexus }: any) => any;
+export default _default;

package/dist/server/src/graphql/types/navigation.d.ts

@@ -0,0 +1,2 @@
+declare const _default: ({ nexus }: any) => any;
+export default _default;

package/dist/server/src/i18n/index.d.ts

@@ -0,0 +1,4 @@
+import { Core } from '@strapi/strapi';
+export declare const navigationSetup: (context: {
+    strapi: Core.Strapi;
+}) => Promise<void>;