@koine/next 1.0.0 → 1.0.3

package/Analytics/AnalyticsGoogle.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="react" />
+export declare type AnalyticsGoogleProps = {
+    /** Falls back to `.env` variable `NEXT_PUBLIC_GTM_ID` */
+    id?: string;
+};
+export declare const AnalyticsGoogle: ({ id }: AnalyticsGoogleProps) => JSX.Element | null;

package/Analytics/index.d.ts

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

package/Auth/helpers.d.ts

@@ -0,0 +1,17 @@
+import type { Translate } from "../I18n";
+/**
+ * @see next/auth `pages` mapping: https://next-auth.js.org/configuration/pages`
+ */
+export declare type AuthRoutesMap = {
+    login?: string;
+    profile?: string;
+    register?: string;
+    /** Array of regexes to match pathnames of protected routes */
+    secured?: RegExp[];
+};
+export declare const AUTH_ROUTES: AuthRoutesMap;
+export declare function getAuthRoutes(t: Translate): AuthRoutesMap;
+/**
+ * @param url e.g. "http://localhost:3000/signin?callbackUrl=http://localhost:3000/profile"
+ */
+export declare function getCallbackUrl(url?: string): string;

package/Auth/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./helpers";
+export * from "./useLogin";
+export * from "./useLoginUrl";
+export * from "./useLogout";

package/Auth/useLogin.d.ts

@@ -0,0 +1,7 @@
+import { SubmitHandler } from "react-hook-form";
+export declare function useLogin<LoginForm = {}>(): {
+    submit: SubmitHandler<LoginForm>;
+    loading: boolean;
+    ok: boolean;
+    fail: boolean;
+};

package/Auth/useLoginUrl.d.ts

@@ -0,0 +1 @@
+export declare function useLoginUrl(): string;

package/Auth/useLogout.d.ts

@@ -0,0 +1,6 @@
+export declare function useLogout(): {
+    submit: (event: React.SyntheticEvent<HTMLFormElement>) => void;
+    loading: boolean;
+    ok: boolean;
+    fail: boolean;
+};

package/Favicon/Favicon.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+import { FaviconTagsProps } from "@koine/react";
+export declare type FaviconProps = FaviconTagsProps;
+export declare const Favicon: (props: FaviconTagsProps) => JSX.Element;

package/Favicon/index.d.ts

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

package/Forms/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./useForm";
+export * from "./useSubmit";

package/Forms/useForm.d.ts

@@ -0,0 +1,32 @@
+import type { UseFormProps, FieldValues } from "react-hook-form";
+import type { ObjectSchema } from "yup";
+import { TranslateNamespace } from "../I18n";
+export declare function useForm<T extends FieldValues>(schema: ObjectSchema<any>, i18nNamespace: TranslateNamespace, formProps?: UseFormProps, debug?: boolean): {
+    watch: import("react-hook-form").UseFormWatch<T>;
+    getValues: import("react-hook-form").UseFormGetValues<T>;
+    getFieldState: import("react-hook-form").UseFormGetFieldState<T>;
+    setError: import("react-hook-form").UseFormSetError<T>;
+    clearErrors: import("react-hook-form").UseFormClearErrors<T>;
+    setValue: import("react-hook-form").UseFormSetValue<T>;
+    trigger: import("react-hook-form").UseFormTrigger<T>;
+    formState: import("react-hook-form").FormState<T>;
+    resetField: import("react-hook-form").UseFormResetField<T>;
+    reset: import("react-hook-form").UseFormReset<T>;
+    handleSubmit: import("react-hook-form").UseFormHandleSubmit<T>;
+    unregister: import("react-hook-form").UseFormUnregister<T>;
+    control: import("react-hook-form").Control<T, any>;
+    register: import("react-hook-form").UseFormRegister<T>;
+    setFocus: import("react-hook-form").UseFormSetFocus<T>;
+    field: {
+        control: import("react-hook-form").Control<T, any>;
+        register: import("react-hook-form").UseFormRegister<T>;
+        setValue: import("react-hook-form").UseFormSetValue<T>;
+        t: <R extends unknown = string>(s: string, q?: "obj" | {
+            [key: string]: string | number | boolean;
+        } | null | undefined, o?: "obj" | {
+            returnObjects?: boolean | undefined;
+            fallback?: string | string[] | undefined;
+            default?: string | undefined;
+        } | undefined) => R;
+    };
+};

package/Forms/useSubmit.d.ts

@@ -0,0 +1,24 @@
+import type { UnpackNestedValue } from "react-hook-form";
+import { KoineApi } from "../utils/api";
+export declare function useSubmit<RequestBody extends {}, ResponseSuccesfull extends KoineApi.ResponseSuccesfull = {}, ResponseFailed extends KoineApi.ResponseFailed = Record<keyof RequestBody, string | string[]>>(url: string, transformData?: (json: UnpackNestedValue<RequestBody>) => any): {
+    submit: (json: any) => Promise<KoineApi.Response<ResponseSuccesfull, ResponseFailed>>;
+    loading: boolean;
+} & {
+    status: number;
+    msg: string;
+} & ({
+    ok?: boolean | undefined;
+    fail?: boolean | undefined;
+    loading: true;
+    data?: undefined;
+} | {
+    ok: true;
+    fail?: false | undefined;
+    loading?: false | undefined;
+    data: ResponseSuccesfull;
+} | {
+    ok?: false | undefined;
+    fail: true;
+    loading?: false | undefined;
+    data: ResponseFailed;
+});

package/Head/Head.d.ts

@@ -0,0 +1 @@
+export { default as Head } from "next/head";

package/Head/index.d.ts

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

package/I18n/I18n.d.ts

@@ -0,0 +1,48 @@
+import format from "date-fns/format";
+import { Option } from "@koine/react";
+export { default as T } from "next-translate/Trans";
+declare type Join<S1, S2> = S1 extends string ? S2 extends string ? `${S1}.${S2}` : never : never;
+declare type Paths<T> = {
+    [K in keyof T]: T[K] extends Record<string, unknown> ? Join<K, Paths<T[K]>> : K;
+}[keyof T];
+export declare type AllPaths = {
+    [N in keyof Koine.NextTranslations]: {
+        [K in keyof Koine.NextTranslations[N]]: Koine.NextTranslations[N][K] extends Array<Record<string, unknown>> ? Join<K extends string ? `${N}:${K}` : `${N}:`, Paths<Koine.NextTranslations[N][K]>> : Koine.NextTranslations[N][K] extends Record<string, unknown> ? Join<K extends string ? `${N}:${K}` : `${N}:`, Paths<Koine.NextTranslations[N][K]>> : Koine.NextTranslations[N][K] extends Array<string | number | boolean> ? Join<K extends string ? `${N}:${K}` : `${N}`, Paths<Koine.NextTranslations[N][K]>> : Koine.NextTranslations[N][K] extends string | number | boolean ? K extends string ? `${N}:${K}` : `${N}:` : ``;
+    }[keyof Koine.NextTranslations[N]];
+}[keyof Koine.NextTranslations];
+declare type TranslateReturn<Q extends TranslationQuery, O extends TranslationOptions> = string;
+/**
+ * Passing just `obj` is a shortcut for `{ returnObjects: true }`
+ */
+declare type TranslationQuery = undefined | null | "obj" | {
+    [key: string]: string | number | boolean;
+};
+/**
+ * Passing just `obj` is a shortcut for `{ returnObjects: true }`
+ */
+declare type TranslationOptions = undefined | "obj" | {
+    returnObjects?: boolean;
+    fallback?: string | string[];
+    default?: string;
+};
+export declare type TranslateNamespace = keyof Koine.NextTranslations;
+export declare type TranslateKey = AllPaths;
+export declare type Translate<R extends unknown = string, N extends undefined | keyof Koine.NextTranslations = undefined, Q extends TranslationQuery = undefined, O extends TranslationOptions = undefined> = (s: N extends keyof Koine.NextTranslations ? Paths<Koine.NextTranslations[N]> | AllPaths : AllPaths, q?: Q, o?: O) => R extends undefined | unknown ? TranslateReturn<Q, O> : R;
+export declare type TranslateLoose = (s: any, q?: any, o?: any) => string;
+/**
+ * FIXME: the use of `useMemo` is a hopefully-temporary solution to fix the FOUC
+ * problem of untranslated text during page transitions
+ *
+ * @see https://github.com/vinissimus/next-translate/issues/513#issuecomment-779826418
+ */
+export declare function useT<N extends TranslateNamespace | undefined>(namespace?: N): <R extends unknown = string>(s: N extends TranslateNamespace ? Paths<Koine.NextTranslations[N]> | AllPaths : AllPaths, q?: TranslationQuery, o?: TranslationOptions) => R;
+/**
+ * @deprecated Not sure whether this will ever be useful
+ */
+export declare function useLooseT(namespace?: string): import("next-translate").Translate;
+export declare function translationAsOptions(t: TranslateLoose, i18nKey: string): Option[];
+/**
+ * Automatically returns the `date-fns/format` function with the right locale
+ * passed as option (grabbed from next router value).
+ */
+export declare const useDateFormat: () => typeof format;

package/I18n/index.d.ts

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

package/Img/Img.d.ts

@@ -0,0 +1,21 @@
+import React from "react";
+import NextImage, { ImageProps as NextImageProps, StaticImageData } from "next/image";
+import { KoineImgSmartProps, KoineImgSmartWrapProps } from "@koine/react";
+interface StaticRequire {
+    default: StaticImageData;
+}
+declare type StaticImport = StaticRequire | StaticImageData;
+export declare type NextImgProps = Omit<React.ComponentPropsWithoutRef<"img">, "src"> & Omit<NextImageProps, "src"> & {
+    src: string | StaticImport;
+};
+export declare const NextImg: typeof NextImage;
+export declare type NextImgSmartWrapProps = KoineImgSmartWrapProps;
+export declare type NextImgSmartProps = KoineImgSmartProps & NextImgProps;
+export declare const NextImgSmart: (props: NextImgSmartProps) => JSX.Element;
+export declare function getNextImgProps<T>({ src, alt, layout, blurDataURL, width, height, priority, objectFit, objectPosition, ...restProps }: T & NextImgProps): {
+    nextImgProps: NextImgProps;
+    restProps: Omit<T & Omit<Pick<React.DetailedHTMLProps<React.ImgHTMLAttributes<HTMLImageElement>, HTMLImageElement>, "key" | keyof React.ImgHTMLAttributes<HTMLImageElement>>, "src"> & Omit<NextImageProps, "src"> & {
+        src: string | StaticImport;
+    }, "alt" | "height" | "src" | "width" | "layout" | "priority" | "blurDataURL" | "objectFit" | "objectPosition">;
+};
+export {};

package/Img/index.d.ts

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

package/Link/Link.d.ts

@@ -0,0 +1,8 @@
+import React from "react";
+import { LinkProps as NextLinkProps } from "next/link";
+import { KoineLinkProps } from "@koine/react";
+export declare type LinkProps = Omit<KoineLinkProps, "href"> & Omit<NextLinkProps, "as" | "passHref" | "children">;
+/**
+ * @see https://next.js.org/docs/api-reference/next/link
+ */
+export declare const Link: React.ForwardRefExoticComponent<Pick<LinkProps, "slot" | "style" | "title" | "key" | "download" | "href" | "hrefLang" | "media" | "ping" | "rel" | "target" | "type" | "referrerPolicy" | "defaultChecked" | "defaultValue" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "accessKey" | "className" | "contentEditable" | "contextMenu" | "dir" | "draggable" | "hidden" | "id" | "lang" | "placeholder" | "spellCheck" | "tabIndex" | "translate" | "radioGroup" | "role" | "about" | "datatype" | "inlist" | "prefix" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "color" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "inputMode" | "is" | "aria-activedescendant" | "aria-atomic" | "aria-autocomplete" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-hidden" | "aria-invalid" | "aria-keyshortcuts" | "aria-label" | "aria-labelledby" | "aria-level" | "aria-live" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext" | "children" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocus" | "onFocusCapture" | "onBlur" | "onBlurCapture" | "onChange" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onReset" | "onResetCapture" | "onSubmit" | "onSubmitCapture" | "onInvalid" | "onInvalidCapture" | "onLoad" | "onLoadCapture" | "onError" | "onErrorCapture" | "onKeyDown" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUp" | "onKeyUpCapture" | "onAbort" | "onAbortCapture" | "onCanPlay" | "onCanPlayCapture" | "onCanPlayThrough" | "onCanPlayThroughCapture" | "onDurationChange" | "onDurationChangeCapture" | "onEmptied" | "onEmptiedCapture" | "onEncrypted" | "onEncryptedCapture" | "onEnded" | "onEndedCapture" | "onLoadedData" | "onLoadedDataCapture" | "onLoadedMetadata" | "onLoadedMetadataCapture" | "onLoadStart" | "onLoadStartCapture" | "onPause" | "onPauseCapture" | "onPlay" | "onPlayCapture" | "onPlaying" | "onPlayingCapture" | "onProgress" | "onProgressCapture" | "onRateChange" | "onRateChangeCapture" | "onSeeked" | "onSeekedCapture" | "onSeeking" | "onSeekingCapture" | "onStalled" | "onStalledCapture" | "onSuspend" | "onSuspendCapture" | "onTimeUpdate" | "onTimeUpdateCapture" | "onVolumeChange" | "onVolumeChangeCapture" | "onWaiting" | "onWaitingCapture" | "onAuxClick" | "onAuxClickCapture" | "onClick" | "onClickCapture" | "onContextMenu" | "onContextMenuCapture" | "onDoubleClick" | "onDoubleClickCapture" | "onDrag" | "onDragCapture" | "onDragEnd" | "onDragEndCapture" | "onDragEnter" | "onDragEnterCapture" | "onDragExit" | "onDragExitCapture" | "onDragLeave" | "onDragLeaveCapture" | "onDragOver" | "onDragOverCapture" | "onDragStart" | "onDragStartCapture" | "onDrop" | "onDropCapture" | "onMouseDown" | "onMouseDownCapture" | "onMouseEnter" | "onMouseLeave" | "onMouseMove" | "onMouseMoveCapture" | "onMouseOut" | "onMouseOutCapture" | "onMouseOver" | "onMouseOverCapture" | "onMouseUp" | "onMouseUpCapture" | "onSelect" | "onSelectCapture" | "onTouchCancel" | "onTouchCancelCapture" | "onTouchEnd" | "onTouchEndCapture" | "onTouchMove" | "onTouchMoveCapture" | "onTouchStart" | "onTouchStartCapture" | "onPointerDown" | "onPointerDownCapture" | "onPointerMove" | "onPointerMoveCapture" | "onPointerUp" | "onPointerUpCapture" | "onPointerCancel" | "onPointerCancelCapture" | "onPointerEnter" | "onPointerEnterCapture" | "onPointerLeave" | "onPointerLeaveCapture" | "onPointerOver" | "onPointerOverCapture" | "onPointerOut" | "onPointerOutCapture" | "onGotPointerCapture" | "onGotPointerCaptureCapture" | "onLostPointerCapture" | "onLostPointerCaptureCapture" | "onScroll" | "onScrollCapture" | "onWheel" | "onWheelCapture" | "onAnimationStart" | "onAnimationStartCapture" | "onAnimationEnd" | "onAnimationEndCapture" | "onAnimationIteration" | "onAnimationIterationCapture" | "onTransitionEnd" | "onTransitionEndCapture" | "replace" | "scroll" | "shallow" | "prefetch" | "locale"> & React.RefAttributes<HTMLAnchorElement>>;

package/Link/index.d.ts

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

package/NextProgress/NextProgress.d.ts

@@ -0,0 +1,14 @@
+/// <reference types="react" />
+export declare type NextProgressProps = {
+    /** @default 0.3 */
+    startAt: number;
+    /** @default true */
+    showOnShallow: boolean;
+    /** @default 200 */
+    stopDelayMs: number;
+};
+export declare const NextProgress: ({ startAt, showOnShallow, stopDelayMs, }: {
+    startAt?: number | undefined;
+    showOnShallow?: boolean | undefined;
+    stopDelayMs?: number | undefined;
+}) => JSX.Element;

package/NextProgress/index.d.ts

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

package/Seo/Seo.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+import { SeoProps } from "./helpers";
+export declare const Seo: React.MemoExoticComponent<(props: SeoProps) => JSX.Element>;

package/Seo/SeoDefaults.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+import { SeoDefaultsProps } from "./helpers";
+export declare const SeoDefaults: React.MemoExoticComponent<(props: SeoDefaultsProps) => JSX.Element>;

package/Seo/helpers.d.ts

@@ -0,0 +1,48 @@
+import React from "react";
+import type { NextSeoProps, DefaultSeoProps } from "next-seo/lib/types";
+export declare type SeoData = {
+    hidden?: boolean;
+    title?: string;
+    description?: string;
+    keywords?: string | string[];
+    ogimage?: string;
+};
+declare type SeoPropsOpenGraph = NextSeoProps["openGraph"] & {
+    image?: string;
+};
+/**
+ * @see https://github.com/garmeeh/next-seo/blob/master/src/types.ts#L395
+ */
+export declare type SeoProps = Omit<NextSeoProps, "additionalMetaTags" | "additionalLinkTags" | "mobileAlternate" | "robotsProps"> & {
+    metaTags?: NextSeoProps["additionalMetaTags"];
+    linkTags?: NextSeoProps["additionalLinkTags"];
+    seo?: SeoData;
+    hidden?: SeoData["hidden"];
+    keywords?: SeoData["keywords"];
+    openGraph?: SeoPropsOpenGraph;
+    og?: SeoPropsOpenGraph;
+};
+/**
+ * @see https://github.com/garmeeh/next-seo/blob/master/src/types.ts#L413
+ */
+export declare type SeoDefaultsProps = Omit<DefaultSeoProps, "additionalMetaTags" | "additionalLinkTags" | "dangerouslySetAllPagesToNoIndex" | "dangerouslySetAllPagesToNoFollow" | "defaultOpenGraphImageWidth" | "defaultOpenGraphImageHeight" | "defaultOpenGraphVideoWidth" | "defaultOpenGraphVideoHeight" | "mobileAlternate" | "robotsProps"> & {
+    metaTags?: DefaultSeoProps["additionalMetaTags"];
+    linkTags?: DefaultSeoProps["additionalLinkTags"];
+};
+declare type BuildTagsParams = SeoProps & SeoDefaultsProps;
+/**
+ * We do a couple of things in addition while many other 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` equale 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 buildTags: ({ seo, hidden, keywords, title, titleTemplate, defaultTitle, noindex, nofollow, description, languageAlternates, twitter, facebook, openGraph, og: ogAlias, canonical, metaTags, linkTags, }?: BuildTagsParams) => React.ReactNode[];
+export {};

package/Seo/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @file
+ *
+ * Adapted from https://github.com/garmeeh/next-seo
+ *
+ * See also:
+ * - https://github.com/catnose99/next-head-seo
+ * - https://nextjs.org/docs/api-reference/next/head
+ */
+export * from "./helpers";
+export * from "./Seo";
+export * from "./SeoDefaults";

package/Theme/Theme.d.ts

@@ -0,0 +1,46 @@
+/**
+ * @file
+ *
+ * Adapted from [next-themes](https://github.com/pacocoursey/next-themes)
+ */
+import React from "react";
+declare type ValueObject = {
+    [themeName: string]: string;
+};
+export declare type UseThemeProps = {
+    /** 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 type ThemeProviderProps = {
+    /** 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;
+};
+export declare const useTheme: () => UseThemeProps;
+export declare const ThemeProvider: React.FC<ThemeProviderProps>;
+export {};

package/Theme/index.d.ts

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