@koine/next 1.0.16 → 1.0.17

package/Auth/helpers.d.ts

@@ -1,4 +1,4 @@
-import type { Translate } from "../I18n";
+import type { TranslateLoose } from "../i18n";
 /**
  * @see next/auth `pages` mapping: https://next-auth.js.org/configuration/pages`
  */
@@ -10,7 +10,7 @@ export declare type AuthRoutesMap = {
     secured?: RegExp[];
 };
 export declare const AUTH_ROUTES: AuthRoutesMap;
-export declare function getAuthRoutes(t: Translate): AuthRoutesMap;
+export declare function getAuthRoutes(t: TranslateLoose): AuthRoutesMap;
 /**
  * @param url e.g. "http://localhost:3000/signin?callbackUrl=http://localhost:3000/profile"
  */

package/Auth/useLogin.js

@@ -3,7 +3,7 @@ import { useState, useCallback } from "react";
 import { useRouter } from "next/router";
 import { signIn } from "next-auth/react";
 import { parseURL } from "@koine/utils";
-import { useT } from "../I18n";
+import { useT } from "../i18n";
 import { getAuthRoutes, getCallbackUrl } from "./helpers";
 export function useLogin() {
     var t = useT();

package/Auth/useLoginUrl.js

@@ -1,5 +1,5 @@
 import { useEffect, useState } from "react";
-import { useT } from "../I18n";
+import { useT } from "../i18n";
 import { getAuthRoutes } from "./helpers";
 export function useLoginUrl() {
     var _a = useState(""), currentUrl = _a[0], setCurrentUrl = _a[1];

package/Auth/useLogout.js

@@ -2,7 +2,7 @@ import { useState, useCallback } from "react";
 import { useRouter } from "next/router";
 import { signOut } from "next-auth/react";
 import { parseURL } from "@koine/utils";
-import { useT } from "../I18n";
+import { useT } from "../i18n";
 import { getAuthRoutes, getCallbackUrl } from "./helpers";
 export function useLogout() {
     var t = useT();

package/Forms/useForm.d.ts

@@ -1,7 +1,7 @@
 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): {
+import { type TranslateLoose } from "../i18n";
+export declare function useForm<T extends FieldValues>(schema: ObjectSchema<any>, t: TranslateLoose, 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>;
@@ -21,12 +21,6 @@ export declare function useForm<T extends FieldValues>(schema: ObjectSchema<any>
         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;
+        t: TranslateLoose;
     };
 };

package/Forms/useForm.js

@@ -2,12 +2,10 @@ import { __assign } from "tslib";
 import { useMemo } from "react";
 import { useForm as _useForm } from "react-hook-form";
 import { yupResolver as resolver } from "@hookform/resolvers/yup";
-import { useT } from "../I18n";
 export function useForm(
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-schema, i18nNamespace, formProps, debug) {
+schema, t, formProps, debug) {
     if (formProps === void 0) { formProps = {}; }
-    var t = useT(i18nNamespace);
     // const form = _useForm<InferType<ObjectSchema<T, object>>>({
     var form = _useForm(__assign({ 
         // @ts-expect-error FIXME:

package/i18n/T/index.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+import type { TransProps } from "next-translate";
+import type { TranslationsPaths, TranslationsAllPaths } from "../useT";
+export declare type TProps<TNamespace extends keyof Koine.NextTranslations | undefined = undefined> = Omit<TransProps, "i18nKey" | "ns"> & {
+    i18nKey: TNamespace extends keyof Koine.NextTranslations ? TranslationsPaths<Koine.NextTranslations[TNamespace]> : TranslationsAllPaths;
+    ns?: TNamespace;
+};
+export declare function T(props: TProps): JSX.Element;

package/i18n/T/index.js

@@ -0,0 +1,6 @@
+import { __assign } from "tslib";
+import { jsx as _jsx } from "react/jsx-runtime";
+import Trans from "next-translate/Trans";
+export function T(props) {
+    return _jsx(Trans, __assign({}, props));
+}

package/i18n/T/package.json

@@ -0,0 +1,6 @@
+{
+  "sideEffects": false,
+  "module": "./index.js",
+  "main": "../../node/i18n/T/index.js",
+  "types": "./index.d.ts"
+}

package/i18n/getT/index.d.ts

@@ -0,0 +1,3 @@
+import type { Translate } from "../useT";
+export declare type GetT = <TNamespace extends keyof Koine.NextTranslations | undefined>(locale?: string, namespace?: TNamespace) => Promise<Translate<TNamespace>>;
+export declare const getT: GetT;

package/i18n/getT/index.js

@@ -0,0 +1,9 @@
+/* eslint-disable @typescript-eslint/no-unnecessary-type-constraint */
+/**
+ * @file
+ *
+ * About the typescript support for translation strings @see:
+ * - https://github.com/vinissimus/next-translate/issues/721
+ */
+import getTranslation from "next-translate/getT";
+export var getT = getTranslation;

package/i18n/getT/package.json

@@ -0,0 +1,6 @@
+{
+  "sideEffects": false,
+  "module": "./index.js",
+  "main": "../../node/i18n/getT/index.js",
+  "types": "./index.d.ts"
+}

package/i18n/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./getT";
+export * from "./T";
+export * from "./translationAsOptions";
+export * from "./useDateFormat";
+export * from "./useLocale";
+export * from "./useT";

package/i18n/index.js

@@ -0,0 +1,6 @@
+export * from "./getT";
+export * from "./T";
+export * from "./translationAsOptions";
+export * from "./useDateFormat";
+export * from "./useLocale";
+export * from "./useT";

package/{I18n → i18n}/package.json

@@ -1,6 +1,6 @@
 {
   "sideEffects": false,
   "module": "./index.js",
-  "main": "../node/I18n/index.js",
+  "main": "../node/i18n/index.js",
   "types": "./index.d.ts"
 }

package/i18n/translationAsOptions/index.d.ts

@@ -0,0 +1,3 @@
+import type { TranslateLoose } from "../useT";
+import type { Option } from "@koine/react";
+export declare function translationAsOptions(t: TranslateLoose, i18nKey: string): Option[];

package/i18n/translationAsOptions/index.js

@@ -0,0 +1,9 @@
+export function translationAsOptions(t, i18nKey) {
+    var dictionary = t(i18nKey, undefined, {
+        returnObjects: true,
+    });
+    return Object.keys(dictionary).map(function (key) { return ({
+        value: key,
+        label: dictionary[key],
+    }); });
+}

package/i18n/translationAsOptions/package.json

@@ -0,0 +1,6 @@
+{
+  "sideEffects": false,
+  "module": "./index.js",
+  "main": "../../node/i18n/translationAsOptions/index.js",
+  "types": "./index.d.ts"
+}

package/i18n/useDateFormat/index.d.ts

@@ -0,0 +1,6 @@
+import format from "date-fns/format";
+/**
+ * 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/useDateFormat/index.js

@@ -0,0 +1,37 @@
+import { __assign } from "tslib";
+import { useEffect, useState } from "react";
+import { useRouter } from "next/router";
+import format from "date-fns/format";
+import { useDateLocale } from "@koine/react";
+/**
+ * Automatically returns the `date-fns/format` function with the right locale
+ * passed as option (grabbed from next router value).
+ */
+export var useDateFormat = function () {
+    var _a = useState(function () {
+        return function () {
+            var args = [];
+            for (var _i = 0; _i < arguments.length; _i++) {
+                args[_i] = arguments[_i];
+            }
+            return format.apply(void 0, args);
+        };
+    }), formatter = _a[0], setFormatter = _a[1];
+    var router = useRouter();
+    var locale = useDateLocale(router.locale);
+    useEffect(function () {
+        if (locale) {
+            var newFormatter_1 = function (date, _format, options) { return format(date, _format, __assign(__assign({}, (options || {})), { locale: locale })); };
+            setFormatter(function () {
+                return function () {
+                    var args = [];
+                    for (var _i = 0; _i < arguments.length; _i++) {
+                        args[_i] = arguments[_i];
+                    }
+                    return newFormatter_1.apply(void 0, args);
+                };
+            });
+        }
+    }, [locale]);
+    return formatter;
+};

package/i18n/useDateFormat/package.json

@@ -0,0 +1,6 @@
+{
+  "sideEffects": false,
+  "module": "./index.js",
+  "main": "../../node/i18n/useDateFormat/index.js",
+  "types": "./index.d.ts"
+}

package/i18n/useLocale/index.d.ts

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

package/i18n/useLocale/index.js

@@ -0,0 +1,4 @@
+import useTranslation from "next-translate/useTranslation";
+export function useLocale() {
+    return useTranslation().lang;
+}

package/i18n/useLocale/package.json

@@ -0,0 +1,6 @@
+{
+  "sideEffects": false,
+  "module": "./index.js",
+  "main": "../../node/i18n/useLocale/index.js",
+  "types": "./index.d.ts"
+}

package/i18n/useT/index.d.ts

@@ -0,0 +1,50 @@
+export declare type TranslateNamespace = Extract<keyof Koine.NextTranslations, string>;
+declare type Join<S1, S2> = S1 extends string ? S2 extends string ? `${S1}.${S2}` : never : never;
+export declare type TranslationsPaths<T, TAddRoot extends true | undefined = undefined> = {
+    [K in keyof T]: T[K] extends Record<string, unknown> ? K extends string ? TAddRoot extends true ? `${K}` | Join<K, TranslationsPaths<T[K]>> : Join<K, TranslationsPaths<T[K]>> : Join<K, TranslationsPaths<T[K], TAddRoot>> : K;
+}[keyof T];
+export declare type TranslationsAllPaths = {
+    [N in Extract<keyof Koine.NextTranslations, string>]: {
+        [K in Extract<keyof Koine.NextTranslations[N], string>]: Koine.NextTranslations[N][K] extends Array<Record<string, unknown>> ? Join<K extends string ? `${N}:${K}` : `${N}:`, TranslationsPaths<Koine.NextTranslations[N][K], true>> : Koine.NextTranslations[N][K] extends Record<string, unknown> ? Join<K extends string ? `${N}:${K}` : `${N}:`, TranslationsPaths<Koine.NextTranslations[N][K], true>> : Koine.NextTranslations[N][K] extends Array<string | number | boolean> ? Join<K extends string ? `${N}:${K}` : `${N}:`, TranslationsPaths<Koine.NextTranslations[N][K], true>> : Koine.NextTranslations[N][K] extends string | number | boolean ? K extends string ? `${N}:${K}` : `${N}:` : ``;
+    }[Extract<keyof Koine.NextTranslations[N], string>];
+}[Extract<keyof Koine.NextTranslations, string>];
+/**
+ * Passing just `obj` is a shortcut for `{ returnObjects: true }`
+ */
+export declare type TranslationQuery = undefined | null | "obj" | {
+    [key: string]: string | number | boolean;
+};
+/**
+ * Passing just `obj` is a shortcut for `{ returnObjects: true }`
+ */
+export declare type TranslationOptions = undefined | "obj" | {
+    returnObjects?: boolean;
+    fallback?: string | string[];
+    default?: string;
+};
+export declare type TranslateLoose = (s: any, // s: string,
+q?: any, // q?: TranslationQuery,
+o?: any) => string;
+export declare type Translate<TNamespace extends keyof Koine.NextTranslations | undefined> = TNamespace extends keyof Koine.NextTranslations ? TranslateNamespaced<TNamespace> : TranslateDefault;
+export declare type TranslateDefault = <TReturn extends unknown = string>(s: TranslationsAllPaths, q?: TranslationQuery, o?: TranslationOptions) => TReturn;
+export declare type TranslateNamespaced<TNamespace extends keyof Koine.NextTranslations> = <TReturn extends unknown = string>(s: TranslationsPaths<Koine.NextTranslations[TNamespace]>, q?: TranslationQuery, o?: TranslationOptions) => TReturn;
+/**
+ * Wrap `next-translate` useTranslations adding the `obj` second argument shortcut
+ * and type safety
+ *
+ * @see https://github.com/vinissimus/next-translate/issues/513#issuecomment-779826418
+ */
+export declare function useT(): TranslateDefault;
+export declare function useT<TNamespace extends TranslateNamespace>(namespace: TNamespace): TranslateNamespaced<TNamespace>;
+export {};
+/**
+ * Using this as generic instead of the interface on the namespace `Koine.NextTranslations`
+ * generates the typescript warning `Type instantiation is excessively deep and possibly infinite.`
+ * Its usage is left here and commented out. Maybe we can restore it once we find
+ * the time to look for a way to avoid the warning
+ */
+/**
+ * Instead of wrapping the `useTranslation` hook from [`next-translate`](https://github.com/vinissimus/next-translate/blob/master/src/useTranslation.tsx)
+ * we might just rewrite it with our custom implementation but the `_context`
+ * to use is not exposed by the library...
+ */

package/i18n/useT/index.js

@@ -0,0 +1,115 @@
+/* eslint-disable @typescript-eslint/no-unnecessary-type-constraint */
+/**
+ * @file
+ *
+ * About the typescript support for translation strings @see:
+ * - https://github.com/vinissimus/next-translate/issues/721
+ */
+import { useMemo } from "react";
+import useTranslation from "next-translate/useTranslation";
+export function useT(namespace) {
+    var t = useTranslation().t;
+    var tMemoized = useMemo(function () {
+        return function (s, q, o) {
+            return t(
+            // @ts-expect-error again...
+            (namespace ? "".concat(namespace, ":").concat(s) : s), q === "obj" ? null : q, q === "obj" || o === "obj" ? { returnObjects: true } : o
+            // ) as TReturn extends (undefined | never | unknown) ? TranslateReturn<TranslationQuery, TranslationOptions> : TReturn;
+            );
+        };
+    }, [t, namespace]);
+    return tMemoized;
+}
+/**
+ * Using this as generic instead of the interface on the namespace `Koine.NextTranslations`
+ * generates the typescript warning `Type instantiation is excessively deep and possibly infinite.`
+ * Its usage is left here and commented out. Maybe we can restore it once we find
+ * the time to look for a way to avoid the warning
+ */
+// type Translations = { [key: string]: Record<string, unknown> };
+// export type TranslationsAllPaths<TTranslations extends Translations> = {
+//   [N in Extract<keyof TTranslations, string>]: {
+//     [K in Extract<
+//       keyof TTranslations[N],
+//       string
+//     >]: TTranslations[N][K] extends Array<
+//       // if we have an array of objects
+//       Record<string, unknown>
+//     >
+//       ? Join<
+//           K extends string ? `${N}:${K}` : `${N}:`,
+//           Paths<TTranslations[N][K], true>
+//         >
+//       : // if we have an object
+//       TTranslations[N][K] extends Record<string, unknown>
+//       ? Join<
+//           K extends string ? `${N}:${K}` : `${N}:`,
+//           Paths<TTranslations[N][K], true>
+//         > /* &
+//           Record<TTranslations[N][K], object> */
+//       : // if we have an array of primitives
+//       TTranslations[N][K] extends Array<string | number | boolean>
+//       ? Join<
+//           K extends string ? `${N}:${K}` : `${N}`,
+//           Paths<TTranslations[N][K], true>
+//         >
+//       : // if we have a primitve string/number/boolean
+//       TTranslations[N][K] extends string | number | boolean
+//       ? K extends string
+//         ? `${N}:${K}`
+//         : `${N}:`
+//       : ``;
+//   }[Extract<keyof TTranslations[N], string>];
+// }[Extract<keyof TTranslations, string>];
+// export type Translate<
+//   TTranslations extends Translations = Koine.NextTranslations,
+//   TNamespace extends undefined | keyof TTranslations = undefined
+// > = <TReturn extends unknown = string>(
+//   s: TNamespace extends keyof TTranslations
+//     ? Paths<TTranslations[TNamespace]>
+//     : TranslationsAllPaths<TTranslations>,
+//   q?: TranslationQuery,
+//   o?: TranslationOptions
+// ) => TReturn;
+// export function useT<
+//   TTranslations extends Translations = Koine.NextTranslations,
+//   TNamespace extends keyof TTranslations | undefined = undefined
+// >(namespace?: TNamespace) {
+//   const t = useTranslation().t;
+//   const tMemoized = useMemo(
+//     () =>
+//       <TReturn extends unknown = string>(
+//         s: TNamespace extends keyof TTranslations
+//           ? Paths<TTranslations[TNamespace], true>
+//           : TranslationsAllPaths<TTranslations>,
+//         q?: TranslationQuery,
+//         o?: TranslationOptions
+//       ) =>
+//         t(
+//           namespace ? `${namespace}:${s}` : s,
+//           q === "obj" ? null : q,
+//           q === "obj" || o === "obj" ? { returnObjects: true } : o
+//           // ) as TReturn extends (undefined | never | unknown) ? TranslateReturn<TranslationQuery, TranslationOptions> : TReturn;
+//         ) as TReturn,
+//     [t, namespace]
+//   );
+//   return tMemoized;
+// }
+/**
+ * Instead of wrapping the `useTranslation` hook from [`next-translate`](https://github.com/vinissimus/next-translate/blob/master/src/useTranslation.tsx)
+ * we might just rewrite it with our custom implementation but the `_context`
+ * to use is not exposed by the library...
+ */
+// import { useContext, useMemo } from "react"
+// import wrapTWithDefaultNs from "next-translate/lib/cjs/wrapTWithDefaultNs";
+// import I18nContext from "next-translate/lib/cjs/_context";
+// export default function useTranslation(defaultNS?: string): I18n {
+//   const ctx = useContext(I18nContext)
+//   return useMemo(
+//     () => ({
+//       ...ctx,
+//       t: wrapTWithDefaultNs(ctx.t, defaultNS),
+//     }),
+//     [ctx.lang, defaultNS]
+//   )
+// }

package/i18n/useT/package.json

@@ -0,0 +1,6 @@
+{
+  "sideEffects": false,
+  "module": "./index.js",
+  "main": "../../node/i18n/useT/index.js",
+  "types": "./index.d.ts"
+}

package/index.d.ts

@@ -3,7 +3,7 @@ export * from "./Auth";
 export * from "./Favicon";
 export * from "./Forms";
 export * from "./Head";
-export * from "./I18n";
+export * from "./i18n";
 export * from "./Img";
 export * from "./Link";
 export * from "./NextProgress";

package/index.js

@@ -3,7 +3,7 @@ export * from "./Auth";
 export * from "./Favicon";
 export * from "./Forms";
 export * from "./Head";
-export * from "./I18n";
+export * from "./i18n";
 export * from "./Img";
 export * from "./Link";
 export * from "./NextProgress";

package/node/Auth/useLogin.js

@@ -6,10 +6,10 @@ var react_1 = require("react");
 var router_1 = require("next/router");
 var react_2 = require("next-auth/react");
 var utils_1 = require("@koine/utils");
-var I18n_1 = require("../I18n");
+var i18n_1 = require("../i18n");
 var helpers_1 = require("./helpers");
 function useLogin() {
-    var t = (0, I18n_1.useT)();
+    var t = (0, i18n_1.useT)();
     var push = (0, router_1.useRouter)().push;
     var _a = (0, react_1.useState)(false), loading = _a[0], setLoading = _a[1];
     var _b = (0, react_1.useState)(false), ok = _b[0], setOk = _b[1];

package/node/Auth/useLoginUrl.js

@@ -2,11 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.useLoginUrl = void 0;
 var react_1 = require("react");
-var I18n_1 = require("../I18n");
+var i18n_1 = require("../i18n");
 var helpers_1 = require("./helpers");
 function useLoginUrl() {
     var _a = (0, react_1.useState)(""), currentUrl = _a[0], setCurrentUrl = _a[1];
-    var t = (0, I18n_1.useT)();
+    var t = (0, i18n_1.useT)();
     (0, react_1.useEffect)(function () {
         setCurrentUrl("?callbackUrl=".concat(window.location.href));
     }, []);

package/node/Auth/useLogout.js

@@ -5,10 +5,10 @@ var react_1 = require("react");
 var router_1 = require("next/router");
 var react_2 = require("next-auth/react");
 var utils_1 = require("@koine/utils");
-var I18n_1 = require("../I18n");
+var i18n_1 = require("../i18n");
 var helpers_1 = require("./helpers");
 function useLogout() {
-    var t = (0, I18n_1.useT)();
+    var t = (0, i18n_1.useT)();
     var push = (0, router_1.useRouter)().push;
     var _a = (0, react_1.useState)(false), loading = _a[0], setLoading = _a[1];
     var _b = (0, react_1.useState)(false), ok = _b[0], setOk = _b[1];

package/node/Forms/useForm.js

@@ -5,12 +5,10 @@ var tslib_1 = require("tslib");
 var react_1 = require("react");
 var react_hook_form_1 = require("react-hook-form");
 var yup_1 = require("@hookform/resolvers/yup");
-var I18n_1 = require("../I18n");
 function useForm(
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-schema, i18nNamespace, formProps, debug) {
+schema, t, formProps, debug) {
     if (formProps === void 0) { formProps = {}; }
-    var t = (0, I18n_1.useT)(i18nNamespace);
     // const form = _useForm<InferType<ObjectSchema<T, object>>>({
     var form = (0, react_hook_form_1.useForm)(tslib_1.__assign({ 
         // @ts-expect-error FIXME:

package/node/i18n/T/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.T = void 0;
+var tslib_1 = require("tslib");
+var jsx_runtime_1 = require("react/jsx-runtime");
+var Trans_1 = tslib_1.__importDefault(require("next-translate/Trans"));
+function T(props) {
+    return (0, jsx_runtime_1.jsx)(Trans_1.default, tslib_1.__assign({}, props));
+}
+exports.T = T;

package/node/i18n/getT/index.js

@@ -0,0 +1,13 @@
+"use strict";
+/* eslint-disable @typescript-eslint/no-unnecessary-type-constraint */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getT = void 0;
+var tslib_1 = require("tslib");
+/**
+ * @file
+ *
+ * About the typescript support for translation strings @see:
+ * - https://github.com/vinissimus/next-translate/issues/721
+ */
+var getT_1 = tslib_1.__importDefault(require("next-translate/getT"));
+exports.getT = getT_1.default;

package/node/i18n/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./getT"), exports);
+tslib_1.__exportStar(require("./T"), exports);
+tslib_1.__exportStar(require("./translationAsOptions"), exports);
+tslib_1.__exportStar(require("./useDateFormat"), exports);
+tslib_1.__exportStar(require("./useLocale"), exports);
+tslib_1.__exportStar(require("./useT"), exports);

package/node/i18n/translationAsOptions/index.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.translationAsOptions = void 0;
+function translationAsOptions(t, i18nKey) {
+    var dictionary = t(i18nKey, undefined, {
+        returnObjects: true,
+    });
+    return Object.keys(dictionary).map(function (key) { return ({
+        value: key,
+        label: dictionary[key],
+    }); });
+}
+exports.translationAsOptions = translationAsOptions;

package/node/i18n/useDateFormat/index.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useDateFormat = void 0;
+var tslib_1 = require("tslib");
+var react_1 = require("react");
+var router_1 = require("next/router");
+var format_1 = tslib_1.__importDefault(require("date-fns/format"));
+var react_2 = require("@koine/react");
+/**
+ * Automatically returns the `date-fns/format` function with the right locale
+ * passed as option (grabbed from next router value).
+ */
+var useDateFormat = function () {
+    var _a = (0, react_1.useState)(function () {
+        return function () {
+            var args = [];
+            for (var _i = 0; _i < arguments.length; _i++) {
+                args[_i] = arguments[_i];
+            }
+            return format_1.default.apply(void 0, args);
+        };
+    }), formatter = _a[0], setFormatter = _a[1];
+    var router = (0, router_1.useRouter)();
+    var locale = (0, react_2.useDateLocale)(router.locale);
+    (0, react_1.useEffect)(function () {
+        if (locale) {
+            var newFormatter_1 = function (date, _format, options) { return (0, format_1.default)(date, _format, tslib_1.__assign(tslib_1.__assign({}, (options || {})), { locale: locale })); };
+            setFormatter(function () {
+                return function () {
+                    var args = [];
+                    for (var _i = 0; _i < arguments.length; _i++) {
+                        args[_i] = arguments[_i];
+                    }
+                    return newFormatter_1.apply(void 0, args);
+                };
+            });
+        }
+    }, [locale]);
+    return formatter;
+};
+exports.useDateFormat = useDateFormat;

package/node/i18n/useLocale/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useLocale = void 0;
+var tslib_1 = require("tslib");
+var useTranslation_1 = tslib_1.__importDefault(require("next-translate/useTranslation"));
+function useLocale() {
+    return (0, useTranslation_1.default)().lang;
+}
+exports.useLocale = useLocale;

package/node/i18n/useT/index.js

@@ -0,0 +1,120 @@
+"use strict";
+/* eslint-disable @typescript-eslint/no-unnecessary-type-constraint */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useT = void 0;
+var tslib_1 = require("tslib");
+/**
+ * @file
+ *
+ * About the typescript support for translation strings @see:
+ * - https://github.com/vinissimus/next-translate/issues/721
+ */
+var react_1 = require("react");
+var useTranslation_1 = tslib_1.__importDefault(require("next-translate/useTranslation"));
+function useT(namespace) {
+    var t = (0, useTranslation_1.default)().t;
+    var tMemoized = (0, react_1.useMemo)(function () {
+        return function (s, q, o) {
+            return t(
+            // @ts-expect-error again...
+            (namespace ? "".concat(namespace, ":").concat(s) : s), q === "obj" ? null : q, q === "obj" || o === "obj" ? { returnObjects: true } : o
+            // ) as TReturn extends (undefined | never | unknown) ? TranslateReturn<TranslationQuery, TranslationOptions> : TReturn;
+            );
+        };
+    }, [t, namespace]);
+    return tMemoized;
+}
+exports.useT = useT;
+/**
+ * Using this as generic instead of the interface on the namespace `Koine.NextTranslations`
+ * generates the typescript warning `Type instantiation is excessively deep and possibly infinite.`
+ * Its usage is left here and commented out. Maybe we can restore it once we find
+ * the time to look for a way to avoid the warning
+ */
+// type Translations = { [key: string]: Record<string, unknown> };
+// export type TranslationsAllPaths<TTranslations extends Translations> = {
+//   [N in Extract<keyof TTranslations, string>]: {
+//     [K in Extract<
+//       keyof TTranslations[N],
+//       string
+//     >]: TTranslations[N][K] extends Array<
+//       // if we have an array of objects
+//       Record<string, unknown>
+//     >
+//       ? Join<
+//           K extends string ? `${N}:${K}` : `${N}:`,
+//           Paths<TTranslations[N][K], true>
+//         >
+//       : // if we have an object
+//       TTranslations[N][K] extends Record<string, unknown>
+//       ? Join<
+//           K extends string ? `${N}:${K}` : `${N}:`,
+//           Paths<TTranslations[N][K], true>
+//         > /* &
+//           Record<TTranslations[N][K], object> */
+//       : // if we have an array of primitives
+//       TTranslations[N][K] extends Array<string | number | boolean>
+//       ? Join<
+//           K extends string ? `${N}:${K}` : `${N}`,
+//           Paths<TTranslations[N][K], true>
+//         >
+//       : // if we have a primitve string/number/boolean
+//       TTranslations[N][K] extends string | number | boolean
+//       ? K extends string
+//         ? `${N}:${K}`
+//         : `${N}:`
+//       : ``;
+//   }[Extract<keyof TTranslations[N], string>];
+// }[Extract<keyof TTranslations, string>];
+// export type Translate<
+//   TTranslations extends Translations = Koine.NextTranslations,
+//   TNamespace extends undefined | keyof TTranslations = undefined
+// > = <TReturn extends unknown = string>(
+//   s: TNamespace extends keyof TTranslations
+//     ? Paths<TTranslations[TNamespace]>
+//     : TranslationsAllPaths<TTranslations>,
+//   q?: TranslationQuery,
+//   o?: TranslationOptions
+// ) => TReturn;
+// export function useT<
+//   TTranslations extends Translations = Koine.NextTranslations,
+//   TNamespace extends keyof TTranslations | undefined = undefined
+// >(namespace?: TNamespace) {
+//   const t = useTranslation().t;
+//   const tMemoized = useMemo(
+//     () =>
+//       <TReturn extends unknown = string>(
+//         s: TNamespace extends keyof TTranslations
+//           ? Paths<TTranslations[TNamespace], true>
+//           : TranslationsAllPaths<TTranslations>,
+//         q?: TranslationQuery,
+//         o?: TranslationOptions
+//       ) =>
+//         t(
+//           namespace ? `${namespace}:${s}` : s,
+//           q === "obj" ? null : q,
+//           q === "obj" || o === "obj" ? { returnObjects: true } : o
+//           // ) as TReturn extends (undefined | never | unknown) ? TranslateReturn<TranslationQuery, TranslationOptions> : TReturn;
+//         ) as TReturn,
+//     [t, namespace]
+//   );
+//   return tMemoized;
+// }
+/**
+ * Instead of wrapping the `useTranslation` hook from [`next-translate`](https://github.com/vinissimus/next-translate/blob/master/src/useTranslation.tsx)
+ * we might just rewrite it with our custom implementation but the `_context`
+ * to use is not exposed by the library...
+ */
+// import { useContext, useMemo } from "react"
+// import wrapTWithDefaultNs from "next-translate/lib/cjs/wrapTWithDefaultNs";
+// import I18nContext from "next-translate/lib/cjs/_context";
+// export default function useTranslation(defaultNS?: string): I18n {
+//   const ctx = useContext(I18nContext)
+//   return useMemo(
+//     () => ({
+//       ...ctx,
+//       t: wrapTWithDefaultNs(ctx.t, defaultNS),
+//     }),
+//     [ctx.lang, defaultNS]
+//   )
+// }

package/node/index.js

@@ -6,7 +6,7 @@ tslib_1.__exportStar(require("./Auth"), exports);
 tslib_1.__exportStar(require("./Favicon"), exports);
 tslib_1.__exportStar(require("./Forms"), exports);
 tslib_1.__exportStar(require("./Head"), exports);
-tslib_1.__exportStar(require("./I18n"), exports);
+tslib_1.__exportStar(require("./i18n"), exports);
 tslib_1.__exportStar(require("./Img"), exports);
 tslib_1.__exportStar(require("./Link"), exports);
 tslib_1.__exportStar(require("./NextProgress"), exports);

package/package.json

@@ -6,9 +6,9 @@
   "dependencies": {
     "react": "^16.8 || ^17 || ^18",
     "next": "^12.1.6",
-    "@koine/utils": "1.0.16",
+    "@koine/utils": "1.0.17",
     "framer-motion": "^6.3.4",
-    "@koine/react": "1.0.16",
+    "@koine/react": "1.0.17",
     "styled-components": "^5.3.5",
     "@mui/base": "^5.0.0-alpha.82",
     "react-icons": "^4.3.1",
@@ -29,7 +29,7 @@
     "next-seo": "^5.4.0"
   },
   "peerDependencies": {},
-  "version": "1.0.16",
+  "version": "1.0.17",
   "module": "./index.js",
   "types": "./index.d.ts"
 }

package/typings.d.ts

@@ -59,28 +59,37 @@ declare namespace Koine {
   };
 
   /**
-   * Translations dictionary extracted from JSON files. You need to extend this
-   * type with something like:
+   * Translations dictionary extracted from JSON files.
+   * You need to augment this type with something like:
    *
    * ```ts
    * declare namespace Koine {
    *   interface NextTranslations {
    *     "~": typeof import("./locales/en/~.json");
-   *     _: typeof import("./locales/en/_.json");
-   *     $team: typeof import("./locales/en/$team.json");
-   *     home: typeof import("./locales/en/home.json");
-   *     Footer: typeof import("./locales/en/Footer.json");
-   *     Header: typeof import("./locales/en/Header.json");
+   *     "_": typeof import("./locales/en/_.json");
+   *     "$team": typeof import("./locales/en/$team.json");
+   *     "home": typeof import("./locales/en/home.json");
+   *     "Header": typeof import("./locales/en/Header.json");
    *   }
    * }
    * ```
+   *
+   * Best to follow a convention to name the files which become the namespaces:
+   *
+   * - `~`: for app wide **urls** translated definitions
+   * - `_`: for app wide **common** translations
+   * - `${data}`: dollar prefix for static **data** like arrays, objects, .etc
+   * - `{route-name}`: lower cased for **route** specific data
+   * - `{ComponentName}`: pascal cased for **components** specific data
    */
   interface NextTranslations {
-    /** Convention for app wide `common` translations */
-    _: Record<string, string>;
-    /** Convention for app wide `routes` translated definitions */
     "~": Record<string, string>;
+    _: Record<string, string>;
   }
+  // interface NextTranslations {
+  //   "~": Record<string, string>;
+  //   _: Record<string, string>;
+  // }
 }
 
 /**

package/I18n/I18n.d.ts

@@ -1,44 +0,0 @@
-/// <reference types="@koine/next/typings" />
-import format from "date-fns/format";
-import type { 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]>> & Record<Koine.NextTranslations[N][K], object> : 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];
-/**
- * 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<N extends undefined | keyof Koine.NextTranslations = undefined> = <R extends unknown = string>(s: N extends TranslateNamespace ? Paths<Koine.NextTranslations[N]> | AllPaths : AllPaths, q?: TranslationQuery, o?: TranslationOptions) => 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;
-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/I18n.js

@@ -1,95 +0,0 @@
-/// <reference types="@koine/next/typings" />
-import { __assign } from "tslib";
-/* eslint-disable @typescript-eslint/no-unnecessary-type-constraint */
-/**
- * @file
- *
- * About the typescript support for translation strings @see:
- * - https://github.com/vinissimus/next-translate/issues/721
- */
-import { useEffect, useState, useMemo } from "react";
-import { useRouter } from "next/router";
-import format from "date-fns/format";
-import useTranslation from "next-translate/useTranslation";
-import { useDateLocale } from "@koine/react";
-export { default as T } from "next-translate/Trans";
-/**
- * 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 function useT(namespace) {
-    var t = useTranslation().t;
-    // const typedT = <
-    //   // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-constraint
-    //   R extends unknown = string,
-    //   // Q extends TranslationQuery = TranslationQuery
-    //   // O extends TranslationOptions = TranslationOptions
-    // >(
-    //   s: N extends TranslateNamespace
-    //     ? Paths<Koine.NextTranslations[N]> | AllPaths
-    //     : AllPaths,
-    //   q?: TranslationQuery,
-    //   o?: TranslationOptions
-    // ) =>
-    //   // eslint-disable-next-line
-    //   t.call(
-    //     null,
-    //     namespace ? `${namespace}:${s}` : s,
-    //     q === "obj" ? null : q,
-    //     q === "obj" || o === "obj" ? { returnObjects: true } : o
-    //   // ) as R extends (undefined | never | unknown) ? TranslateReturn<TranslationQuery, TranslationOptions> : R;
-    //   ) as R;
-    // return typedT;
-    var tMemoized = useMemo(function () {
-        return function (s, q, o) {
-            return t(namespace ? "".concat(namespace, ":").concat(s) : s, q === "obj" ? null : q, q === "obj" || o === "obj" ? { returnObjects: true } : o
-            // ) as R extends (undefined | never | unknown) ? TranslateReturn<TranslationQuery, TranslationOptions> : R;
-            );
-        };
-    }, [t, namespace]);
-    // return tMemoized as Translate<N>;
-    return tMemoized;
-}
-export function translationAsOptions(t, i18nKey) {
-    var dictionary = t(i18nKey, undefined, {
-        returnObjects: true,
-    });
-    return Object.keys(dictionary).map(function (key) { return ({
-        value: key,
-        label: dictionary[key],
-    }); });
-}
-/**
- * Automatically returns the `date-fns/format` function with the right locale
- * passed as option (grabbed from next router value).
- */
-export var useDateFormat = function () {
-    var _a = useState(function () {
-        return function () {
-            var args = [];
-            for (var _i = 0; _i < arguments.length; _i++) {
-                args[_i] = arguments[_i];
-            }
-            return format.apply(void 0, args);
-        };
-    }), formatter = _a[0], setFormatter = _a[1];
-    var router = useRouter();
-    var locale = useDateLocale(router.locale);
-    useEffect(function () {
-        if (locale) {
-            var newFormatter_1 = function (date, _format, options) { return format(date, _format, __assign(__assign({}, (options || {})), { locale: locale })); };
-            setFormatter(function () {
-                return function () {
-                    var args = [];
-                    for (var _i = 0; _i < arguments.length; _i++) {
-                        args[_i] = arguments[_i];
-                    }
-                    return newFormatter_1.apply(void 0, args);
-                };
-            });
-        }
-    }, [locale]);
-    return formatter;
-};

package/I18n/index.d.ts

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

package/I18n/index.js

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

package/node/I18n/I18n.js

@@ -1,102 +0,0 @@
-"use strict";
-/// <reference types="@koine/next/typings" />
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useDateFormat = exports.translationAsOptions = exports.useT = exports.T = void 0;
-var tslib_1 = require("tslib");
-/* eslint-disable @typescript-eslint/no-unnecessary-type-constraint */
-/**
- * @file
- *
- * About the typescript support for translation strings @see:
- * - https://github.com/vinissimus/next-translate/issues/721
- */
-var react_1 = require("react");
-var router_1 = require("next/router");
-var format_1 = tslib_1.__importDefault(require("date-fns/format"));
-var useTranslation_1 = tslib_1.__importDefault(require("next-translate/useTranslation"));
-var react_2 = require("@koine/react");
-var Trans_1 = require("next-translate/Trans");
-Object.defineProperty(exports, "T", { enumerable: true, get: function () { return tslib_1.__importDefault(Trans_1).default; } });
-/**
- * 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
- */
-function useT(namespace) {
-    var t = (0, useTranslation_1.default)().t;
-    // const typedT = <
-    //   // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-constraint
-    //   R extends unknown = string,
-    //   // Q extends TranslationQuery = TranslationQuery
-    //   // O extends TranslationOptions = TranslationOptions
-    // >(
-    //   s: N extends TranslateNamespace
-    //     ? Paths<Koine.NextTranslations[N]> | AllPaths
-    //     : AllPaths,
-    //   q?: TranslationQuery,
-    //   o?: TranslationOptions
-    // ) =>
-    //   // eslint-disable-next-line
-    //   t.call(
-    //     null,
-    //     namespace ? `${namespace}:${s}` : s,
-    //     q === "obj" ? null : q,
-    //     q === "obj" || o === "obj" ? { returnObjects: true } : o
-    //   // ) as R extends (undefined | never | unknown) ? TranslateReturn<TranslationQuery, TranslationOptions> : R;
-    //   ) as R;
-    // return typedT;
-    var tMemoized = (0, react_1.useMemo)(function () {
-        return function (s, q, o) {
-            return t(namespace ? "".concat(namespace, ":").concat(s) : s, q === "obj" ? null : q, q === "obj" || o === "obj" ? { returnObjects: true } : o
-            // ) as R extends (undefined | never | unknown) ? TranslateReturn<TranslationQuery, TranslationOptions> : R;
-            );
-        };
-    }, [t, namespace]);
-    // return tMemoized as Translate<N>;
-    return tMemoized;
-}
-exports.useT = useT;
-function translationAsOptions(t, i18nKey) {
-    var dictionary = t(i18nKey, undefined, {
-        returnObjects: true,
-    });
-    return Object.keys(dictionary).map(function (key) { return ({
-        value: key,
-        label: dictionary[key],
-    }); });
-}
-exports.translationAsOptions = translationAsOptions;
-/**
- * Automatically returns the `date-fns/format` function with the right locale
- * passed as option (grabbed from next router value).
- */
-var useDateFormat = function () {
-    var _a = (0, react_1.useState)(function () {
-        return function () {
-            var args = [];
-            for (var _i = 0; _i < arguments.length; _i++) {
-                args[_i] = arguments[_i];
-            }
-            return format_1.default.apply(void 0, args);
-        };
-    }), formatter = _a[0], setFormatter = _a[1];
-    var router = (0, router_1.useRouter)();
-    var locale = (0, react_2.useDateLocale)(router.locale);
-    (0, react_1.useEffect)(function () {
-        if (locale) {
-            var newFormatter_1 = function (date, _format, options) { return (0, format_1.default)(date, _format, tslib_1.__assign(tslib_1.__assign({}, (options || {})), { locale: locale })); };
-            setFormatter(function () {
-                return function () {
-                    var args = [];
-                    for (var _i = 0; _i < arguments.length; _i++) {
-                        args[_i] = arguments[_i];
-                    }
-                    return newFormatter_1.apply(void 0, args);
-                };
-            });
-        }
-    }, [locale]);
-    return formatter;
-};
-exports.useDateFormat = useDateFormat;

package/node/I18n/index.js

@@ -1,4 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./I18n"), exports);