@koine/next 2.0.0-beta.132 → 2.0.0-beta.133

package/12/AnalyticsGoogle.d.ts

@@ -1,4 +1,5 @@
 export type AnalyticsGoogleProps = {
+    /** Falls back to `.env` variable `NEXT_PUBLIC_GTM_ID` */
     id?: string;
 };
 export declare let AnalyticsGoogle: ({ id }: AnalyticsGoogleProps) => import("react/jsx-runtime").JSX.Element | null;

package/12/DisableErrorOverlay.d.ts

@@ -1,2 +1,7 @@
+/**
+ * Disable error overlay during `dev`
+ *
+ * @see https://github.com/vercel/next.js/discussions/13387#discussioncomment-101564
+ */
 export declare let DisableErrorOverlay: () => import("react/jsx-runtime").JSX.Element;
 export default DisableErrorOverlay;

package/12/Seo.d.ts

@@ -10,6 +10,9 @@ export type SeoData = {
 type SeoPropsOpenGraph = NextSeoProps["openGraph"] & {
     image?: string;
 };
+/**
+ * @see https://github.com/garmeeh/next-seo/blob/master/src/types.ts#L395
+ */
 export type SeoProps = Omit<NextSeoProps, "additionalMetaTags" | "additionalLinkTags" | "mobileAlternate" | "robotsProps"> & {
     metaTags?: ReadonlyArray<MetaTag>;
     linkTags?: ReadonlyArray<LinkTag>;
@@ -19,5 +22,28 @@ export type SeoProps = Omit<NextSeoProps, "additionalMetaTags" | "additionalLink
     openGraph?: SeoPropsOpenGraph;
     og?: SeoPropsOpenGraph;
 };
+/**
+ * Adapted from [garmeeh/next-seo](https://github.com/garmeeh/next-seo)
+ *
+ * See also:
+ * - https://github.com/catnose99/next-head-seo
+ * - https://nextjs.org/docs/api-reference/next/head
+ *
+ * NB: on the homepage you usually want to customize the `titleTemplate` to avoid
+ * doubled app name. Assuming your default seo configuration is something like:
+ *
+ * ```js
+ * {
+ *   titleTemplate: "%s | MyApp"
+ * }
+ * ```
+ *
+ * On the homepage you migh want to override it, e.g.:
+ * ```js
+ * <Seo title="MyApp | Some description" titleTemplate="%s" />
+ * ```
+ *
+ * @deprecated
+ */
 export declare let Seo: (props: SeoProps) => import("react/jsx-runtime").JSX.Element;
 export default Seo;

package/12/SeoDefaults.d.ts

@@ -1,10 +1,16 @@
 import type { DefaultSeoProps } from "next-seo/lib/types";
 import type { JsonObject } from "@koine/utils";
 import { type LinkTag, type MetaTag } from "./seoBuildTags";
+/**
+ * @see https://github.com/garmeeh/next-seo/blob/master/src/types.ts#L413
+ */
 export type SeoDefaultsProps = Omit<DefaultSeoProps, "additionalMetaTags" | "additionalLinkTags" | "dangerouslySetAllPagesToNoIndex" | "dangerouslySetAllPagesToNoFollow" | "defaultOpenGraphImageWidth" | "defaultOpenGraphImageHeight" | "defaultOpenGraphVideoWidth" | "defaultOpenGraphVideoHeight" | "mobileAlternate" | "robotsProps"> & {
     metaTags?: ReadonlyArray<MetaTag>;
     linkTags?: ReadonlyArray<LinkTag>;
     schema?: JsonObject;
 };
+/**
+ * @deprecated
+ */
 export declare let SeoDefaults: (props: SeoDefaultsProps) => import("react/jsx-runtime").JSX.Element;
 export default SeoDefaults;

package/12/seoBuildTags.d.ts

@@ -3,5 +3,20 @@ import type { SeoDefaultsProps } from "./SeoDefaults";
 export type MetaTag = React.DetailedHTMLProps<React.MetaHTMLAttributes<HTMLMetaElement>, HTMLMetaElement>;
 export type LinkTag = React.DetailedHTMLProps<React.LinkHTMLAttributes<HTMLLinkElement>, HTMLLinkElement>;
 type BuildTagsParams = SeoProps & SeoDefaultsProps;
+/**
+ * Comparing to `next-seo` we do a couple of things in addition while many
+ * others are removed.
+ *
+ * - Add `seo` meta object coming from a CMS probably
+ * - Add `ogimage` and `openGraph.image` as single image source
+ * - Add `og` alias to define `openGraph`
+ * - Add check for `title` equal to `templateTitle` to avoid meta titles like
+ *   "My site | My site" often happening in homepages
+ * - Remove the open graph videos and images
+ *
+ * - Shorter code
+ *
+ * @returns
+ */
 export declare const seoBuildTags: ({ seo, hidden, keywords, title, titleTemplate, defaultTitle, noindex, nofollow, description, languageAlternates, twitter, facebook, openGraph, og: ogAlias, canonical, metaTags, linkTags, schema, }?: BuildTagsParams) => import("react").ReactNode[];
 export default seoBuildTags;

package/12/types.d.ts

@@ -1,2 +1,5 @@
+/**
+ * @file Export all types separately to ease imports
+ */
 export type { SeoData } from "./Seo";
 export type { SeoDefaultsProps } from "./SeoDefaults";

package/ThemeContext.d.ts

@@ -1,9 +1,15 @@
 export type ThemeContextProps = {
+    /** List of all available theme names */
     themes: string[];
+    /** Forced theme name for the current page */
     forcedTheme?: string;
+    /** Update the theme */
     setTheme: (theme: string) => void;
+    /** Active theme name */
     theme?: string;
+    /** If `enableSystem` is true and the active theme is "system", this returns whether the system preference resolved to "dark" or "light". Otherwise, identical to `theme` */
     resolvedTheme?: string;
+    /** If enableSystem is true, returns the System theme preference ("dark" or "light"), regardless what the active theme is */
     systemTheme?: "dark" | "light";
 };
 export declare const ThemeContext: import("react").Context<ThemeContextProps>;

package/ThemeProvider.d.ts

@@ -2,15 +2,33 @@ type ValueObject = {
     [themeName: string]: string;
 };
 export type ThemeProviderProps = React.PropsWithChildren<{
+    /** List of all available theme names */
     themes?: string[];
+    /** Forced theme name for the current page */
     forcedTheme?: string;
+    /** Whether to switch between dark and light themes based on prefers-color-scheme */
     enableSystem?: boolean;
+    /** Disable all CSS transitions when switching themes */
     disableTransitionOnChange?: boolean;
+    /** Whether to indicate to browsers which color scheme is used (dark or light) for built-in UI like inputs and buttons */
     enableColorScheme?: boolean;
+    /** Default theme name (for v0.0.12 and lower the default was light). If `enableSystem` is false, the default theme is light */
     defaultTheme?: string;
+    /** HTML attribute modified based on the active theme. Accepts `class` and `data-*` (meaning any data attribute, `data-mode`, `data-color`, etc.) */
     attribute?: string | "class";
+    /** Mapping of theme name to HTML attribute value. Object where key is the theme name and value is the attribute value */
     value?: ValueObject;
+    /** Nonce string to pass to the inline script for CSP headers */
     nonce?: string;
 }>;
+/**
+ * @borrows [next-themes](https://github.com/pacocoursey/next-themes)
+ *
+ * Differences:
+ *
+ * - enableColorScheme: `false` by default (instead of `true`), this plays more
+ * nicely with tailwind `dark` class mode as dark theme is supposed to be only
+ * controlled by tailwind modifiers
+ */
 export declare const ThemeProvider: ({ forcedTheme, disableTransitionOnChange, enableSystem, enableColorScheme, themes, defaultTheme, attribute, value, children, nonce, }: ThemeProviderProps) => import("react/jsx-runtime").JSX.Element;
 export default ThemeProvider;

package/config.d.ts

@@ -1,14 +1,38 @@
 import type { NextConfig } from "next";
 import { type WithI18nAsyncOptions, type WithI18nLegacyOptions } from "@koine/i18n/next";
+/**
+ * @legacy
+ */
 export type Routes = NonNullable<WithI18nLegacyOptions["i18nRoutes"]>["routes"];
 type ModularizeShortcut = {
+    /**
+     * A list of the packages to modularize, if a `scope` is given that will be
+     * automatically prepended before a slash e.g. `{scope}/@{lib}`.
+     * @example ["components", "utils"]
+     */
     libs: string[];
+    /**
+     * The scope of the packages to modularize, if given a slash is automatically
+     * appended between the scope and the lib name
+     * @example "@"
+     */
     scope?: string;
 };
 export type WithKoineOptions = NextConfig & {
     nx?: boolean;
     svg?: boolean;
+    /**
+     * Shortcut option to automatically create swc transforms to feed into
+     * _Next.js_' `modularizeImports`
+     */
     modularize?: ModularizeShortcut[] | ModularizeShortcut;
 } & WithI18nLegacyOptions & WithI18nAsyncOptions;
+/**
+ * Get Next.js config with some basic opinionated defaults
+ *
+ * @param {object} options
+ * @property {boolean} [options.nx=false] Nx monorepo setup
+ * @property {boolean} [options.svg=false] SVG to react components
+ */
 export declare let withKoine: (options?: WithKoineOptions) => NextConfig;
 export {};

package/load.d.ts

@@ -1,2 +1,10 @@
+/**
+ * Utility to load a component with an optional pre-determined delay.
+ *
+ * This was designed to improve anti spam with async form loading.
+ *
+ * @see https://github.com/vercel/next.js/blob/main/packages/next/next-server/lib/dynamic.tsx
+ * @see https://github.com/vercel/next.js/blob/canary/examples/with-dynamic-import/pages/index.js
+ */
 export declare function load<T>(component: T, milliseconds: number): Promise<T>;
 export default load;

package/package.json

@@ -2,9 +2,9 @@
   "name": "@koine/next",
   "sideEffects": false,
   "dependencies": {
-    "@koine/browser": "2.0.0-beta.132",
-    "@koine/utils": "2.0.0-beta.132",
-    "@koine/i18n": "2.0.0-beta.132"
+    "@koine/browser": "2.0.0-beta.133",
+    "@koine/utils": "2.0.0-beta.133",
+    "@koine/i18n": "2.0.0-beta.133"
   },
   "peerDependencies": {
     "next": "^14.0.4",
@@ -64,5 +64,5 @@
   "module": "./index.esm.js",
   "main": "./index.cjs.js",
   "types": "./index.esm.d.ts",
-  "version": "2.0.0-beta.132"
+  "version": "2.0.0-beta.133"
 }

package/useTheme.d.ts

@@ -1,4 +1,7 @@
 import { type ThemeContextProps } from "./ThemeContext";
 export type UseThemeProps = ThemeContextProps;
+/**
+ * @borrows [next-themes](https://github.com/pacocoursey/next-themes)
+ */
 export declare const useTheme: () => ThemeContextProps;
 export default useTheme;