@carlonicora/nextjs-jsonapi 1.108.0 → 1.109.0

package/dist/features/help/index.d.mts

@@ -0,0 +1,115 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as React from 'react';
+import { ReactNode } from 'react';
+import { H as HelpContentConfig, a as HelpArticle, e as HelpHeading, b as HelpMode } from '../../help-content-config.interface-B9L02u9i.mjs';
+export { d as HELP_MODES, c as HelpBrandConfig, f as HelpRedirect } from '../../help-content-config.interface-B9L02u9i.mjs';
+import { u as usePageUrlGenerator } from '../../usePageUrlGenerator-uOnyJ6j2.mjs';
+import '../../types-CQSjy7et.mjs';
+import 'lucide-react';
+import '../../ApiRequestDataTypeInterface-CYEcRUrh.mjs';
+
+declare function HelpProvider({ children }: {
+    children: ReactNode;
+}): react_jsx_runtime.JSX.Element;
+declare function useHelp(): HelpContentConfig;
+
+declare function HelpHeader(): react_jsx_runtime.JSX.Element;
+
+declare function HelpSideNav(): react_jsx_runtime.JSX.Element;
+
+declare function HelpArticleBody({ article, children }: {
+    article: HelpArticle;
+    children: ReactNode;
+}): react_jsx_runtime.JSX.Element;
+
+declare function HelpTOC({ headings }: {
+    headings: readonly HelpHeading[];
+}): react_jsx_runtime.JSX.Element | null;
+
+declare function HelpHint({ contextKey }: {
+    contextKey: string;
+}): react_jsx_runtime.JSX.Element | null;
+
+declare function HelpAskAi(): react_jsx_runtime.JSX.Element;
+
+interface HelpSearchResultRowProps {
+    result: {
+        id: string;
+        name: string;
+        entityType: string;
+    };
+    onSelect?: () => void;
+}
+declare function HelpSearchResultRow({ result, onSelect }: HelpSearchResultRowProps): react_jsx_runtime.JSX.Element;
+
+type CalloutType = "info" | "warning" | "tip" | "danger";
+declare function Callout({ type, children }: {
+    type?: CalloutType;
+    children: ReactNode;
+}): react_jsx_runtime.JSX.Element;
+
+declare function Steps({ children }: {
+    children: ReactNode;
+}): react_jsx_runtime.JSX.Element;
+declare function Step({ children }: {
+    children: ReactNode;
+}): react_jsx_runtime.JSX.Element;
+
+declare function Screenshot({ src, alt, caption }: {
+    src: string;
+    alt?: string;
+    caption?: string;
+}): react_jsx_runtime.JSX.Element;
+
+declare function EntityRef({ type, children }: {
+    type: string;
+    children: ReactNode;
+}): react_jsx_runtime.JSX.Element;
+
+declare function KeyBinding({ children }: {
+    children: ReactNode;
+}): react_jsx_runtime.JSX.Element;
+
+declare function Video({ src, poster }: {
+    src: string;
+    poster?: string;
+}): react_jsx_runtime.JSX.Element;
+
+declare function Related({ slugs }: {
+    slugs: string[];
+}): react_jsx_runtime.JSX.Element | null;
+
+declare const MDX_COMPONENTS: {
+    Callout: typeof Callout;
+    Steps: typeof Steps;
+    Step: typeof Step;
+    Screenshot: typeof Screenshot;
+    EntityRef: typeof EntityRef;
+    KeyBinding: typeof KeyBinding;
+    Video: typeof Video;
+    Related: typeof Related;
+};
+
+declare function useHelpManifest(): readonly HelpArticle[];
+
+declare function useHelpArticle(mode: string, slug: string): HelpArticle | undefined;
+
+declare function useHelpFilter(articles: readonly HelpArticle[]): {
+    query: string;
+    setQuery: React.Dispatch<React.SetStateAction<string>>;
+    filtered: HelpArticle[];
+};
+
+declare function articleUrl(generateUrl: ReturnType<typeof usePageUrlGenerator>, article: {
+    mode: HelpMode;
+    slug: string;
+}): string;
+declare function modeUrl(generateUrl: ReturnType<typeof usePageUrlGenerator>, mode: HelpMode): string;
+
+/**
+ * The fixed namespace of i18n keys this feature reads via useTranslations/getTranslations.
+ * Consuming apps must define each entry in their messages/<locale>.json.
+ */
+declare const HELP_I18N_KEYS: readonly ["help.modes.tutorial", "help.modes.how-to", "help.modes.reference", "help.modes.explanation", "help.sideNav.filterPlaceholder", "help.sideNav.noMatches", "help.toc.title", "help.article.lastUpdated", "help.article.previous", "help.article.next", "help.article.related", "help.askAi.button", "help.askAi.loginTooltip", "help.askAi.sheet.title", "help.askAi.sheet.subtitle", "help.header.search", "help.header.login", "help.header.openApp", "help.hint.trigger", "help.hint.viewArticle", "help.hint.pickArticle", "help.landing.heading", "help.landing.subheading", "help.landing.featuredTutorials", "help.landing.browseByMode", "help.modeIndex.empty", "help.search.removed", "help.footerLink"];
+
+export { HELP_I18N_KEYS, HelpArticle, HelpArticleBody, HelpAskAi, HelpContentConfig, HelpHeader, HelpHeading, HelpHint, HelpMode, HelpProvider, HelpSearchResultRow, HelpSideNav, HelpTOC, MDX_COMPONENTS, articleUrl, modeUrl, useHelp, useHelpArticle, useHelpFilter, useHelpManifest };

package/dist/features/help/index.d.ts

@@ -0,0 +1,115 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as React from 'react';
+import { ReactNode } from 'react';
+import { H as HelpContentConfig, a as HelpArticle, e as HelpHeading, b as HelpMode } from '../../help-content-config.interface-B9L02u9i.js';
+export { d as HELP_MODES, c as HelpBrandConfig, f as HelpRedirect } from '../../help-content-config.interface-B9L02u9i.js';
+import { u as usePageUrlGenerator } from '../../usePageUrlGenerator-tjq2mlDV.js';
+import '../../types-DHOxe8rc.js';
+import 'lucide-react';
+import '../../ApiRequestDataTypeInterface-CYEcRUrh.js';
+
+declare function HelpProvider({ children }: {
+    children: ReactNode;
+}): react_jsx_runtime.JSX.Element;
+declare function useHelp(): HelpContentConfig;
+
+declare function HelpHeader(): react_jsx_runtime.JSX.Element;
+
+declare function HelpSideNav(): react_jsx_runtime.JSX.Element;
+
+declare function HelpArticleBody({ article, children }: {
+    article: HelpArticle;
+    children: ReactNode;
+}): react_jsx_runtime.JSX.Element;
+
+declare function HelpTOC({ headings }: {
+    headings: readonly HelpHeading[];
+}): react_jsx_runtime.JSX.Element | null;
+
+declare function HelpHint({ contextKey }: {
+    contextKey: string;
+}): react_jsx_runtime.JSX.Element | null;
+
+declare function HelpAskAi(): react_jsx_runtime.JSX.Element;
+
+interface HelpSearchResultRowProps {
+    result: {
+        id: string;
+        name: string;
+        entityType: string;
+    };
+    onSelect?: () => void;
+}
+declare function HelpSearchResultRow({ result, onSelect }: HelpSearchResultRowProps): react_jsx_runtime.JSX.Element;
+
+type CalloutType = "info" | "warning" | "tip" | "danger";
+declare function Callout({ type, children }: {
+    type?: CalloutType;
+    children: ReactNode;
+}): react_jsx_runtime.JSX.Element;
+
+declare function Steps({ children }: {
+    children: ReactNode;
+}): react_jsx_runtime.JSX.Element;
+declare function Step({ children }: {
+    children: ReactNode;
+}): react_jsx_runtime.JSX.Element;
+
+declare function Screenshot({ src, alt, caption }: {
+    src: string;
+    alt?: string;
+    caption?: string;
+}): react_jsx_runtime.JSX.Element;
+
+declare function EntityRef({ type, children }: {
+    type: string;
+    children: ReactNode;
+}): react_jsx_runtime.JSX.Element;
+
+declare function KeyBinding({ children }: {
+    children: ReactNode;
+}): react_jsx_runtime.JSX.Element;
+
+declare function Video({ src, poster }: {
+    src: string;
+    poster?: string;
+}): react_jsx_runtime.JSX.Element;
+
+declare function Related({ slugs }: {
+    slugs: string[];
+}): react_jsx_runtime.JSX.Element | null;
+
+declare const MDX_COMPONENTS: {
+    Callout: typeof Callout;
+    Steps: typeof Steps;
+    Step: typeof Step;
+    Screenshot: typeof Screenshot;
+    EntityRef: typeof EntityRef;
+    KeyBinding: typeof KeyBinding;
+    Video: typeof Video;
+    Related: typeof Related;
+};
+
+declare function useHelpManifest(): readonly HelpArticle[];
+
+declare function useHelpArticle(mode: string, slug: string): HelpArticle | undefined;
+
+declare function useHelpFilter(articles: readonly HelpArticle[]): {
+    query: string;
+    setQuery: React.Dispatch<React.SetStateAction<string>>;
+    filtered: HelpArticle[];
+};
+
+declare function articleUrl(generateUrl: ReturnType<typeof usePageUrlGenerator>, article: {
+    mode: HelpMode;
+    slug: string;
+}): string;
+declare function modeUrl(generateUrl: ReturnType<typeof usePageUrlGenerator>, mode: HelpMode): string;
+
+/**
+ * The fixed namespace of i18n keys this feature reads via useTranslations/getTranslations.
+ * Consuming apps must define each entry in their messages/<locale>.json.
+ */
+declare const HELP_I18N_KEYS: readonly ["help.modes.tutorial", "help.modes.how-to", "help.modes.reference", "help.modes.explanation", "help.sideNav.filterPlaceholder", "help.sideNav.noMatches", "help.toc.title", "help.article.lastUpdated", "help.article.previous", "help.article.next", "help.article.related", "help.askAi.button", "help.askAi.loginTooltip", "help.askAi.sheet.title", "help.askAi.sheet.subtitle", "help.header.search", "help.header.login", "help.header.openApp", "help.hint.trigger", "help.hint.viewArticle", "help.hint.pickArticle", "help.landing.heading", "help.landing.subheading", "help.landing.featuredTutorials", "help.landing.browseByMode", "help.modeIndex.empty", "help.search.removed", "help.footerLink"];
+
+export { HELP_I18N_KEYS, HelpArticle, HelpArticleBody, HelpAskAi, HelpContentConfig, HelpHeader, HelpHeading, HelpHint, HelpMode, HelpProvider, HelpSearchResultRow, HelpSideNav, HelpTOC, MDX_COMPONENTS, articleUrl, modeUrl, useHelp, useHelpArticle, useHelpFilter, useHelpManifest };