mintlify 1.1.6 → 1.1.8

package/bin/mint/client/src/layouts/UserFeedback.tsx

@@ -0,0 +1,73 @@
+import Link from 'next/link';
+import { useRouter } from 'next/router';
+import { FontAwesomeIcon } from '@fortawesome/react-fontawesome';
+import { solid, regular } from '@fortawesome/fontawesome-svg-core/import.macro';
+
+const FeedbackTooltip = ({ message }: { message: string }) => {
+  return (
+    <div className="absolute hidden group-hover:block bottom-full left-1/2 mb-3.5 pb-1 -translate-x-1/2">
+      <div
+        className="relative w-24 flex justify-center bg-primary-dark text-white text-xs font-medium py-0.5 px-1.5 rounded-lg"
+        data-reach-alert="true"
+      >
+        {message}
+        <svg
+          aria-hidden="true"
+          width="16"
+          height="6"
+          viewBox="0 0 16 6"
+          className="text-primary-dark absolute top-full left-1/2 -mt-px -ml-2"
+        >
+          <path
+            fillRule="evenodd"
+            clipRule="evenodd"
+            d="M15 0H1V1.00366V1.00366V1.00371H1.01672C2.72058 1.0147 4.24225 2.74704 5.42685 4.72928C6.42941 6.40691 9.57154 6.4069 10.5741 4.72926C11.7587 2.74703 13.2803 1.0147 14.9841 1.00371H15V0Z"
+            fill="currentColor"
+          ></path>
+        </svg>
+      </div>
+    </div>
+  );
+};
+
+export function UserFeedback({ title }: { title: string }) {
+  const router = useRouter();
+  return (
+    <div className="flex items-center space-x-2">
+      <Link href={`/api/suggest?path=${router.pathname}`}>
+        <a
+          className="relative w-fit flex items-center p-1.5 group fill-slate-500 dark:fill-slate-400 hover:fill-slate-700 dark:hover:fill-slate-200 dark:hover:text-slate-300"
+          target="_blank"
+          rel="noopener noreferrer"
+        >
+          <FontAwesomeIcon
+            icon={regular('pencil')}
+            className="h-3.5 w-3.5 block group-hover:hidden"
+          />
+          <FontAwesomeIcon
+            icon={solid('pencil')}
+            className="h-3.5 w-3.5 hidden group-hover:block"
+          />
+          <FeedbackTooltip message="Edit this page" />
+        </a>
+      </Link>
+      <Link href={`/api/issue?path=${router.pathname}&title=${title}`}>
+        <a
+          className="relative w-fit flex items-center p-1.5 group fill-slate-500 dark:fill-slate-400 hover:fill-slate-700 dark:hover:fill-slate-200 dark:hover:text-slate-300"
+          target="_blank"
+          rel="noopener noreferrer"
+        >
+          <FontAwesomeIcon
+            icon={regular('triangle-exclamation')}
+            className="h-3.5 w-3.5 block group-hover:hidden"
+          />
+          <FontAwesomeIcon
+            icon={solid('triangle-exclamation')}
+            className="h-3.5 w-3.5 hidden group-hover:block"
+          />
+          <FeedbackTooltip message="Raise an issue" />
+        </a>
+      </Link>
+    </div>
+  );
+}

package/bin/mint/client/src/layouts/getGroupsInDivision.ts

@@ -0,0 +1,25 @@
+import { Group, Groups, GroupPage, isGroup } from '@/metadata';
+
+export function getGroupsInDivision(nav: Groups, divisionUrls: string[]) {
+  return nav.filter((group: Group) => isGroupInDivision(group, divisionUrls));
+}
+
+export function getGroupsNotInDivision(nav: Groups, divisionUrls: string[]) {
+  return nav.filter((group: Group) => !isGroupInDivision(group, divisionUrls));
+}
+
+function isGroupInDivision(group: Group, divisionUrls: string[]) {
+  return group.pages.some((page) => divisionUrls.some((url) => isGroupPageInDivision(page, url)));
+}
+
+function isGroupPageInDivision(page: GroupPage, divisionUrl: string): boolean {
+  if (isGroup(page)) {
+    return isGroupInDivision(page, [divisionUrl]);
+  }
+
+  if (page?.href == null) {
+    return false;
+  }
+
+  return page.href.startsWith(`/${divisionUrl}/`);
+}

package/bin/mint/client/src/layouts/isPathInGroupPages.ts

@@ -0,0 +1,10 @@
+import { GroupPage, isGroup } from '@/metadata';
+
+export default function isPathInGroupPages(pathname: string, groupPages: GroupPage[]): boolean {
+  return groupPages.some((groupPage) => {
+    if (isGroup(groupPage)) {
+      return isPathInGroupPages(pathname, groupPage.pages);
+    }
+    return groupPage.href === pathname;
+  });
+}

package/bin/mint/client/src/metadata.ts

@@ -0,0 +1,58 @@
+import metadataJson from './metadata.json';
+
+export const documentationNav: Groups = metadataJson;
+export const nonMetaTags = ['api', 'openapi', 'sidebarTitle'];
+
+export type PageContext = {
+  title?: string;
+  sidebarTitle?: string;
+  description?: string;
+  api?: string;
+  openapi?: string;
+  href?: string;
+};
+
+export type Groups = Group[];
+
+export type Group = {
+  group: string;
+  pages: GroupPage[];
+};
+
+export type GroupPage = PageContext | Group;
+
+export const isGroup = (group: GroupPage): group is Group => {
+  // Used in if-statements to case GroupPage into either PageContext or Group
+  // The return type "group is Group" is the cast
+  return group && group.hasOwnProperty('group') && group.hasOwnProperty('pages');
+};
+
+export const findPageInGroup = (
+  group: Group,
+  targetHref: string
+): { group: string; page: PageContext } | undefined => {
+  const { pages } = group;
+  let target = undefined;
+  pages.forEach((page) => {
+    const actualPage = page as PageContext;
+    const subGroup = page as Group;
+    if (actualPage?.href === targetHref) {
+      target = { group: group.group, page: actualPage };
+    } else if (isGroup(subGroup)) {
+      const resultInSubGroup = findPageInGroup(subGroup, targetHref);
+      if (resultInSubGroup != null) {
+        target = resultInSubGroup;
+      }
+    }
+  });
+  return target;
+};
+
+export const flattenGroupPages = (groupPages: GroupPage[]): PageContext[] => {
+  return groupPages.flatMap((groupPage) => {
+    if (isGroup(groupPage)) {
+      return flattenGroupPages(groupPage.pages);
+    }
+    return groupPage;
+  });
+};

package/bin/mint/client/src/nav.json

@@ -0,0 +1,219 @@
+[
+  {
+    "group": "Getting started",
+    "pages": [
+      {
+        "title": "Onboarding and Setup",
+        "description": "This page will help you get started with Telematica EV APIs",
+        "href": "/onboarding"
+      },
+      {
+        "title": "Contact us",
+        "href": "/contact-us"
+      },
+      {
+        "title": "Supported EV brands",
+        "href": "/supported-ev-models-india"
+      }
+    ]
+  },
+  {
+    "group": "Products",
+    "pages": [
+      {
+        "title": "Telematica Connect UI",
+        "description": "Authenticate users with 26+ EV brands using white labeled UI",
+        "href": "/products/vehicle-apis"
+      },
+      {
+        "title": "Unified Vehicle APIs",
+        "description": "Single API to read and issue commands to 26+ EV brands",
+        "href": "/products/unified-vehicle-apis"
+      },
+      {
+        "title": "Telematica Poller",
+        "description": "Effortless polling of EV data",
+        "href": "/products/telematica-poller"
+      },
+      {
+        "title": "Telematica Webhooks",
+        "href": "/products/webhooks"
+      },
+      {
+        "title": "Telematica Schedules",
+        "description": "Schedule commands or report generation for your customer vehicles",
+        "href": "/products/telematica-schedules-beta"
+      },
+      {
+        "title": "Telematica Routing APIs (beta)",
+        "description": "Plug and play routing module for EVs with advanced features",
+        "href": "/products/telematica-routing-apis-in-alpha"
+      }
+    ]
+  },
+  {
+    "group": "Guides and How-To's",
+    "pages": [
+      {
+        "title": "Consent UI and custom query parameters",
+        "href": "/guides/consent-ui-parameters"
+      },
+      {
+        "title": "Creating the POST callback endpoint",
+        "href": "/guides/callback-endpoint"
+      },
+      {
+        "title": "Expected Errors",
+        "href": "/guides/expected-errors"
+      },
+      {
+        "title": "FAQs",
+        "href": "/guides/faqs"
+      }
+    ]
+  },
+  {
+    "group": "Telematica Vehicle APIs",
+    "pages": [
+      {
+        "group": "Vehicle Data - v2",
+        "pages": [
+          {
+            "title": "SOC",
+            "description": "Get the current SOC of the vehicle in kms",
+            "href": "/reference/vehicledatacontroller_getsoc"
+          },
+          {
+            "title": "Range",
+            "description": "Get the current range of the vehicle in kms",
+            "href": "/reference/vehicledatacontroller_getrange"
+          },
+          {
+            "title": "Odometer",
+            "description": "Get the current odometer reading of the vehicle in kms",
+            "href": "/reference/vehicledatacontroller_getodo"
+          },
+          {
+            "title": "Location",
+            "description": "Get the current location of the vehicle",
+            "href": "/reference/vehicledatacontroller_getlocation"
+          },
+          {
+            "title": "Charging Status",
+            "description": "Get the current charging status of the vehicle",
+            "href": "/reference/vehicledatacontroller_getchargingstatus"
+          },
+          {
+            "title": "Static Attributes",
+            "description": "Get the static attributes of the vehicle",
+            "href": "/reference/vehicledatacontroller_getstaticattributes"
+          },
+          {
+            "title": "Start Charge",
+            "description": "Command the vehicle to start charging",
+            "href": "/reference/vehicledatacontroller_startcharging"
+          },
+          {
+            "title": "Stop Charge",
+            "description": "Command the vehicle to stop charging",
+            "href": "/reference/vehicledatacontroller_stopcharging"
+          }
+        ]
+      },
+      {
+        "group": "Testing Endpoints",
+        "pages": [
+          {
+            "title": "Testing Endpoints",
+            "href": "/reference/testing"
+          },
+          {
+            "title": "Test SOC",
+            "description": "Test the soc endpoint on a dummy vehicle",
+            "href": "/reference/testing/vehicledatacontroller_getsoctest"
+          },
+          {
+            "title": "Test Range",
+            "description": "Test the range endpoint on a dummy vehicle",
+            "href": "/reference/testing/vehicledatacontroller_getrangetest"
+          },
+          {
+            "title": "Test Range-SOC",
+            "description": "Test the range-soc endpoint on a dummy vehicle",
+            "href": "/reference/testing/vehicledatacontroller_getrangesoctest"
+          },
+          {
+            "title": "Test Location",
+            "description": "Test the location endpoint on a dummy vehicle",
+            "href": "/reference/testing/vehicledatacontroller_getlocationtest"
+          },
+          {
+            "title": "Test Charging Status",
+            "description": "Test the charging-status endpoint on a dummy vehicle",
+            "href": "/reference/testing/vehicledatacontroller_getchargingstatustest"
+          },
+          {
+            "title": "Test Odometer",
+            "description": "Test the odo endpoint on a dummy vehicle",
+            "href": "/reference/testing/vehicledatacontroller_getodotest"
+          },
+          {
+            "title": "Test static-attributes",
+            "description": "Test the static-attributes endpoint on a dummy vehicle",
+            "href": "/reference/testing/vehicledatacontroller_getstaticattributestest"
+          }
+        ]
+      },
+      {
+        "group": "Vehicle Data - v1",
+        "pages": [
+          {
+            "title": "SOC (battery level)",
+            "description": "Get the current SOC (battery level) of the vehicle",
+            "href": "/reference/vehicledatacontroller_getsocv1"
+          },
+          {
+            "title": "Range",
+            "description": "Get the current range of the vehicle in kms",
+            "href": "/reference/vehicledatacontroller_getrangev1"
+          },
+          {
+            "title": "Range-SOC",
+            "description": "Get the current range and SOC of the vehicle in single call",
+            "href": "/reference/vehicledatacontroller_getrangesocv1"
+          },
+          {
+            "title": "Location",
+            "description": "Get the last known location of the vehicle",
+            "href": "/reference/vehicledatacontroller_getlocationv1"
+          },
+          {
+            "title": "Charging Status",
+            "description": "Get the current charging status of the vehicle",
+            "href": "/reference/vehicledatacontroller_getchargingstatusv1"
+          },
+          {
+            "title": "Odometer",
+            "description": "Get the odometer reading of the vehicle",
+            "href": "/reference/vehicledatacontroller_getodov1"
+          },
+          {
+            "title": "Static Attributes",
+            "description": "Get static attributes for a vehicle (like VIN, model, year etc.)",
+            "href": "/reference/vehicledatacontroller_getstaticattributesv1"
+          }
+        ]
+      }
+    ]
+  },
+  {
+    "group": "Sample callback endpoints",
+    "pages": [
+      {
+        "title": "New vehicle connection callback",
+        "description": "This is a dummy callback endpoint.       Please share the POST callback endpoint created in your app's backend with Telematica to get callback requests of below format",
+        "href": "/reference/appcontroller_callback"
+      }
+    ]
+  }
+]

package/bin/mint/client/src/openapi.ts

@@ -0,0 +1,3 @@
+import openapiJSON from './openapi.json';
+
+export const openApi = openapiJSON as any;

package/bin/mint/client/src/pages/404.tsx

@@ -0,0 +1,73 @@
+import { ChevronRightIcon } from '@heroicons/react/solid';
+import Link from 'next/link';
+
+import { documentationNav, isGroup } from '@/metadata';
+
+export default function Error() {
+  return (
+    <div>
+      <main className="max-w-6xl w-full mx-auto px-4 sm:px-6 lg:px-8">
+        <div className="max-w-md mx-auto py-12 sm:py-20">
+          <div className="text-center">
+            <p className="text-xl font-semibold text-primary dark:text-primary-light">404</p>
+            <h1 className="mt-2 text-xl font-bold text-slate-800 dark:text-slate-100 tracking-tight sm:text-4xl sm:tracking-tight">
+              Page not found
+            </h1>
+            <p className="mt-2 text-lg text-slate-500 dark:text-slate-400">
+              But here are some other popular destinations
+            </p>
+          </div>
+          <div className="mt-8">
+            <ul className="mt-4 border-l border-slate-100 dark:border-slate-800">
+              {documentationNav.slice(0, 3).map((nav) => {
+                if (nav?.pages == null || nav.pages[0] == null || isGroup(nav.pages[0])) {
+                  return null;
+                }
+
+                return (
+                  <Link href={nav.pages[0].href || '/'}>
+                    <li
+                      key={nav.group}
+                      className="group -ml-px relative my-3 py-2 px-6 flex items-start border-l border-transparent hover:border-primary dark:hover:border-primary-light space-x-4 cursor-pointer"
+                    >
+                      <div className="min-w-0 flex-1">
+                        <h3 className="text-sm font-semibold text-primary dark:text-primary-light">
+                          {nav.group}
+                        </h3>
+                        <h1 className="text-base font-medium text-slate-600 dark:text-slate-300 group-hover:text-slate-900 dark:group-hover:text-slate-100">
+                          {nav.pages[0].title}
+                        </h1>
+                        <p className="text-base text-slate-500 dark:text-slate-400">
+                          {nav.pages[0].description}
+                        </p>
+                      </div>
+                      <div className="flex-shrink-0 self-center">
+                        <ChevronRightIcon
+                          className="h-5 w-5 text-slate-400 dark:text-slate-400 group-hover:text-slate-700 dark:group-hover:text-slate-200"
+                          aria-hidden="true"
+                        />
+                      </div>
+                    </li>
+                  </Link>
+                );
+              })}
+            </ul>
+            <div className="mt-12">
+              <Link href="/">
+                <a className="text-sm font-medium text-primary hover:text-primary-dark dark:text-primary-light dark:hover:text-primary">
+                  Back to main page<span aria-hidden="true"> &rarr;</span>
+                </a>
+              </Link>
+            </div>
+          </div>
+        </div>
+      </main>
+    </div>
+  );
+}
+
+Error.layoutProps = {
+  meta: {
+    title: '404',
+  },
+};

package/bin/mint/client/src/pages/_app.tsx

@@ -0,0 +1,138 @@
+import ProgressBar from '@badrap/bar-of-progress';
+import { ResizeObserver } from '@juggle/resize-observer';
+import 'focus-visible';
+import 'intersection-observer';
+import Head from 'next/head';
+import Router from 'next/router';
+import { useState, useEffect } from 'react';
+
+import { AnalyticsMediatorInterface } from '@/analytics/AbstractAnalyticsImplementation';
+import AnalyticsContext from '@/analytics/AnalyticsContext';
+import AnalyticsMediator from '@/analytics/AnalyticsMediator';
+import FakeAnalyticsMediator from '@/analytics/FakeAnalyticsMediator';
+import GA4Script from '@/analytics/GA4Script';
+import { config } from '@/config';
+import { Meta } from '@/layouts/ContentsLayout';
+import { DocumentationLayout } from '@/layouts/DocumentationLayout';
+import { documentationNav, findPageInGroup, PageContext, nonMetaTags } from '@/metadata';
+import { Header } from '@/ui/Header';
+import { SearchProvider } from '@/ui/Search';
+import { Title } from '@/ui/Title';
+import '@/utils/fontAwesome';
+import getAnalyticsConfig from '@/utils/getAnalyticsConfig';
+
+import '../css/fonts.css';
+import '../css/main.css';
+
+if (typeof window !== 'undefined' && !('ResizeObserver' in window)) {
+  window.ResizeObserver = ResizeObserver;
+}
+
+const progress = new ProgressBar({
+  size: 2,
+  color: config?.colors?.primary ?? '#0C8C5E',
+  className: 'bar-of-progress',
+  delay: 100,
+});
+
+// this fixes safari jumping to the bottom of the page
+// when closing the search modal using the `esc` key
+if (typeof window !== 'undefined') {
+  progress.start();
+  progress.finish();
+}
+
+Router.events.on('routeChangeStart', () => progress.start());
+Router.events.on('routeChangeComplete', () => progress.finish());
+Router.events.on('routeChangeError', () => progress.finish());
+
+export default function App(props: any) {
+  const { Component, pageProps, router } = props;
+  const [initializedAnalyticsMediator, setInitializedAnalyticsMediator] = useState(false);
+  const [analyticsMediator, setAnalyticsMediator] = useState<AnalyticsMediatorInterface>(
+    new FakeAnalyticsMediator()
+  );
+
+  const analytics = getAnalyticsConfig(config);
+
+  // AnalyticsMediator can only run in the browser
+  // We use useEffect because it only runs on render
+  useEffect(() => {
+    if (!initializedAnalyticsMediator) {
+      const newMediator = new AnalyticsMediator(analytics);
+      setAnalyticsMediator(newMediator);
+      setInitializedAnalyticsMediator(true);
+    }
+  }, [initializedAnalyticsMediator, analytics]);
+
+  let [navIsOpen, setNavIsOpen] = useState(false);
+
+  useEffect(() => {
+    Router.events.on('routeChangeComplete', (url: string, routeProps: any) => {
+      analyticsMediator.onRouteChange(url, routeProps);
+    });
+  }, [analyticsMediator]);
+
+  useEffect(() => {
+    if (!navIsOpen) return;
+    function handleRouteChange() {
+      setNavIsOpen(false);
+    }
+    Router.events.on('routeChangeComplete', handleRouteChange);
+    return () => {
+      Router.events.off('routeChangeComplete', handleRouteChange);
+    };
+  }, [navIsOpen]);
+
+  let section = undefined;
+  let meta: Meta = {};
+  documentationNav.forEach((group) => {
+    const foundPage = findPageInGroup(group, router.pathname);
+    if (foundPage) {
+      section = foundPage.group;
+      meta = foundPage.page;
+      return false;
+    }
+    return true;
+  });
+  const metaTags: PageContext = {};
+  Object.entries(meta).forEach(([key, value]) => {
+    if (nonMetaTags.includes(key)) return;
+    metaTags[key as keyof PageContext] = value;
+  });
+  return (
+    <AnalyticsContext.Provider value={analyticsMediator}>
+      <Title suffix={config.name}>{meta.sidebarTitle || meta.title}</Title>
+      <Head>
+        {config?.metadata &&
+          Object.entries(config?.metadata).map(([key, value]) => {
+            if (!value) {
+              return null;
+            }
+            return <meta key={key} name={key} content={value as any} />;
+          })}
+        {Object.entries(metaTags).map(([key, value]) => (
+          <meta key={key} name={key} content={value} />
+        ))}
+      </Head>
+      <GA4Script ga4={analytics.ga4} />
+      <SearchProvider>
+        <Header
+          hasNav={Boolean(config.navigation?.length)}
+          navIsOpen={navIsOpen}
+          onNavToggle={(isOpen: boolean) => setNavIsOpen(isOpen)}
+          title={meta?.title}
+          section={section}
+        />
+        <DocumentationLayout
+          isMdx={pageProps?.isMdx}
+          navIsOpen={navIsOpen}
+          setNavIsOpen={setNavIsOpen}
+          meta={meta}
+        >
+          <Component section={section} meta={meta} />
+        </DocumentationLayout>
+      </SearchProvider>
+    </AnalyticsContext.Provider>
+  );
+}

package/bin/mint/client/src/pages/_document.tsx

@@ -0,0 +1,57 @@
+import NextDocument, { Html, Head, Main, NextScript, DocumentContext } from 'next/document';
+
+import { config } from '@/config';
+
+const FAVICON_VERSION = 3;
+
+function v(href: string) {
+  return `${href}?v=${FAVICON_VERSION}`;
+}
+
+export default class Document extends NextDocument {
+  static async getInitialProps(ctx: DocumentContext) {
+    const initialProps = await NextDocument.getInitialProps(ctx);
+    return { ...initialProps };
+  }
+
+  render() {
+    return (
+      <Html lang="en" className="dark [--scroll-mt:9.875rem] lg:[--scroll-mt:6.3125rem]">
+        <Head>
+          <link rel="apple-touch-icon" sizes="180x180" href={v('/favicons/apple-touch-icon.png')} />
+          <link rel="icon" type="image/png" sizes="32x32" href={v('/favicons/favicon-32x32.png')} />
+          <link rel="icon" type="image/png" sizes="16x16" href={v('/favicons/favicon-16x16.png')} />
+          <link rel="shortcut icon" href={v('/favicons/favicon.ico')} />
+          <meta name="apple-mobile-web-app-title" content={config.name} />
+          <meta name="application-name" content={config.name} />
+          <meta name="theme-color" content="#ffffff" />
+          <meta name="msapplication-TileColor" content={config.colors?.primary} />
+          <meta name="msapplication-config" content={v('/favicons/browserconfig.xml')} />
+          <script
+            dangerouslySetInnerHTML={{
+              __html: `
+                try {
+                  if (localStorage.theme === 'dark' || (!('theme' in localStorage) && window.matchMedia('(prefers-color-scheme: dark)').matches)) {
+                    document.documentElement.classList.add('dark')
+                  } else {
+                    document.documentElement.classList.remove('dark')
+                  }
+                } catch (_) {}
+              `,
+            }}
+          />
+        </Head>
+        <body
+          className="antialiased bg-background-light dark:bg-background-dark text-slate-500 dark:text-slate-400"
+          // Add background image
+          {...(config.backgroundImage && {
+            style: { background: `url('${config.backgroundImage}') no-repeat fixed top right` },
+          })}
+        >
+          <Main />
+          <NextScript />
+        </body>
+      </Html>
+    );
+  }
+}

package/bin/mint/client/src/pages/api/issue.ts

@@ -0,0 +1,10 @@
+import { NextApiRequest, NextApiResponse } from 'next';
+
+function handler(req: NextApiRequest, res: NextApiResponse) {
+  const { path, title } = req.query;
+  return res.redirect(
+    `https://docs.mintlify.com/api/v1/app/issue/${process.env.NAME}?path=${path}.mdx&title=${title}`
+  );
+}
+
+export default handler;

package/bin/mint/client/src/pages/api/name.ts

@@ -0,0 +1,8 @@
+import { withSentry } from '@sentry/nextjs';
+import { NextApiRequest, NextApiResponse } from 'next';
+
+function handler(_: NextApiRequest, res: NextApiResponse) {
+  return res.status(200).send(process.env.NAME);
+}
+
+export default withSentry(handler);