@koine/next 1.0.26 → 1.0.29

package/README.md

@@ -1 +1,13 @@
 # @koine/next
+
+## i18n
+
+To make typescript work nicely with `useT`, `getT` and `T` make sure to enable [`resolveJsonModule`](https://www.typescriptlang.org/tsconfig#resolveJsonModule) in your `tsconfig.json` file:
+
+```json
+{
+  "compilerOptions": {
+    "resolveJsonModule": true,
+  }
+}
+```

package/config/index.js

@@ -142,7 +142,18 @@ export function withKoine(_a) {
             // @see https://github.com/vercel/next.js/discussions/30174#discussion-3643870
             scrollRestoration: true }, (nextConfig.experimental || {})), { 
             // @see https://nextjs.org/docs/advanced-features/compiler#modularize-imports
-            modularizeImports: __assign({}, (((_b = nextConfig === null || nextConfig === void 0 ? void 0 : nextConfig.experimental) === null || _b === void 0 ? void 0 : _b.modularizeImports) || {})) }), 
+            modularizeImports: __assign(__assign({}, (((_b = nextConfig === null || nextConfig === void 0 ? void 0 : nextConfig.experimental) === null || _b === void 0 ? void 0 : _b.modularizeImports) || {})), { 
+                // FIXME: make these work with the right file/folder structure?
+                // "@koine/next/?(((\\w*)?/?)*)": {
+                //   transform: "@koine/next/{{ matches.[1] }}/{{member}}",
+                // },
+                // "@koine/react/?(((\\w*)?/?)*)": {
+                //   transform: "@koine/react/{{ matches.[1] }}/{{member}}",
+                // },
+                // "@koine/utils/?(((\\w*)?/?)*)": {
+                //   transform: "@koine/utils/{{ matches.[1] }}/{{member}}",
+                // },
+                "@koine/utils": { transform: "@koine/utils/{{member}}" } }) }), 
         // @see https://github.com/vercel/next.js/issues/7322#issuecomment-887330111
         reactStrictMode: true }, nextConfig);
     if (svg) {

package/i18n/T/index.d.ts

@@ -1,6 +1,14 @@
 import type { TransProps } from "next-translate";
-import type { /* TranslationsPaths, */ TranslationsAllPaths } from "../useT";
-export declare type TProps = Omit<TransProps, "i18nKey" | "ns"> & {
+import type { TranslateNamespace, TranslationsPaths, TranslationsAllPaths } from "../types";
+export declare type TProps<TNamespace extends TranslateNamespace | undefined = undefined> = (Omit<TransProps, "i18nKey" | "ns"> & {
     i18nKey: TranslationsAllPaths;
-};
+}) | (Omit<TransProps, "i18nKey" | "ns"> & {
+    ns: TNamespace;
+    i18nKey: TranslationsPaths<TNamespace>;
+});
+/**
+ * **NOTE**: To make typescript work nicely here make sure to enable
+ * [`resolveJsonModule`](https://www.typescriptlang.org/tsconfig#resolveJsonModule)
+ * in your `tsconfig.json` file.
+ */
 export declare const T: (props: TProps) => JSX.Element;

package/i18n/T/index.js

@@ -1,4 +1,9 @@
 import { __assign } from "tslib";
 import { jsx as _jsx } from "react/jsx-runtime";
 import Trans from "next-translate/Trans";
+/**
+ * **NOTE**: To make typescript work nicely here make sure to enable
+ * [`resolveJsonModule`](https://www.typescriptlang.org/tsconfig#resolveJsonModule)
+ * in your `tsconfig.json` file.
+ */
 export var T = function (props) { return _jsx(Trans, __assign({}, props)); };

package/i18n/getT/index.d.ts

@@ -1,3 +1,8 @@
-import type { Translate } from "../useT";
-export declare type GetT = <TNamespace extends keyof Koine.NextTranslations | undefined>(locale?: string, namespace?: TNamespace) => Promise<Translate<TNamespace>>;
+import type { Translate, TranslateNamespace } from "../types";
+export declare type GetT = <TNamespace extends TranslateNamespace | undefined = undefined>(locale?: string, namespace?: TNamespace) => Promise<Translate<TNamespace>>;
+/**
+ * **NOTE**: To make typescript work nicely here make sure to enable
+ * [`resolveJsonModule`](https://www.typescriptlang.org/tsconfig#resolveJsonModule)
+ * in your `tsconfig.json` file.
+ */
 export declare const getT: GetT;

package/i18n/getT/index.js

@@ -1,9 +1,8 @@
 /* eslint-disable @typescript-eslint/no-unnecessary-type-constraint */
+import getTranslation from "next-translate/getT";
 /**
- * @file
- *
- * About the typescript support for translation strings @see:
- * - https://github.com/vinissimus/next-translate/issues/721
+ * **NOTE**: To make typescript work nicely here make sure to enable
+ * [`resolveJsonModule`](https://www.typescriptlang.org/tsconfig#resolveJsonModule)
+ * in your `tsconfig.json` file.
  */
-import getTranslation from "next-translate/getT";
 export var getT = getTranslation;

package/i18n/index.d.ts

@@ -4,3 +4,4 @@ export * from "./translationAsOptions";
 export * from "./useDateFormat";
 export * from "./useLocale";
 export * from "./useT";
+export * from "./types";

package/i18n/index.js

@@ -4,3 +4,4 @@ export * from "./translationAsOptions";
 export * from "./useDateFormat";
 export * from "./useLocale";
 export * from "./useT";
+export * from "./types";

package/i18n/translationAsOptions/index.d.ts

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

package/i18n/types.d.ts

@@ -0,0 +1,87 @@
+/**
+ * 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");
+ *     "Header": typeof import("./locales/en/Header.json");
+ *   }
+ * }
+ * ```
+ *
+ * An alternative to the use of the extended namespace (that I could not make it
+ * to work) is to augment the interface commented here below with module
+ * augmentation, something like:
+ *
+ * ```ts
+ * declare module "@koine/next/i18n" {
+ *   interface TranslationsDictionary {
+ *     "~": typeof import("./locales/en/~.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
+ */
+export declare type TranslationsDictionary = Koine.NextTranslations;
+export declare type TranslateNamespace = Extract<keyof TranslationsDictionary, string>;
+declare type Join<S1, S2> = S1 extends string ? S2 extends string ? `${S1}.${S2}` : S1 : never;
+export declare type TranslationsPaths<T, TAddRoot extends true | undefined = undefined> = {
+    [K in Extract<keyof T, string>]: T[K] extends Array<Record<string, unknown>> ? `${K}` : T[K] extends Record<string, unknown> ? TAddRoot extends true ? `${K}` | Join<K, TranslationsPaths<T[K], TAddRoot>> : Join<K, TranslationsPaths<T[K], TAddRoot>> : T[K] extends Array<string | number | boolean> ? `${K}` : T[K] extends string | number | boolean ? K extends string ? `${K}` : never : never;
+}[Extract<keyof T, string>];
+export declare type TranslationsAllPaths = {
+    [N in Extract<keyof TranslationsDictionary, string>]: {
+        [K in Extract<keyof TranslationsDictionary[N], string>]: TranslationsDictionary[N][K] extends Array<Record<string, unknown>> ? `${N}:${K}` : TranslationsDictionary[N][K] extends Record<string, unknown> ? `${N}:${K}` | Join<K extends string ? `${N}:${K}` : `${N}:`, TranslationsPaths<TranslationsDictionary[N][K], true>> : TranslationsDictionary[N][K] extends Array<string | number | boolean> ? `${N}:${K}` : TranslationsDictionary[N][K] extends string | number | boolean ? K extends string ? `${N}:${K}` : `${N}:` : never;
+    }[Extract<keyof TranslationsDictionary[N], string>];
+}[Extract<keyof TranslationsDictionary, string>];
+/**
+ * Query object to populate the returned translated string interpolating data.
+ *  Unlike in `next-translate` we allow passing just `obj` as a shortcut for
+ * `{ returnObjects: true }`. In such case the thrid argument will not exists.
+ *
+ * TODO: type safe this behaviour of the third argument (options).
+ */
+export declare type TranslationQuery = undefined | null | "obj" | {
+    [key: string]: string | number | boolean;
+};
+/**
+ * Opions of the translate function. Unlike in `next-translate` we allow passing
+ * just `obj` as a shortcut for `{ returnObjects: true }`.
+ */
+export declare type TranslationOptions = undefined | "obj" | {
+    returnObjects?: boolean;
+    fallback?: string | string[];
+    default?: string;
+};
+/**
+ * Translate function which optionally accept a namespace as first argument
+ */
+export declare type Translate<TNamespace extends TranslateNamespace | undefined> = TNamespace extends TranslateNamespace ? TranslateNamespaced<TNamespace> : TranslateDefault;
+/**
+ * Translate function **without** namespace, it allows to select any of the all
+ * available strings in all namespaces.
+ */
+export declare type TranslateDefault = <TReturn = string>(s: TranslationsAllPaths, q?: TranslationQuery, o?: TranslationOptions) => TReturn;
+/**
+ * Translate function **with** namespace, it allows to select only the all available
+ * strings in the given namespace.
+ */
+export declare type TranslateNamespaced<TNamespace extends TranslateNamespace> = <TReturn = string>(s: TranslationsPaths<TranslationsDictionary[TNamespace], true>, q?: TranslationQuery, o?: TranslationOptions) => TReturn;
+/**
+ * Translate function loose type, to use only in implementations that uses
+ * the `t` function indirectly without needng knowledge of the string it needs
+ * to output.
+ */
+export declare type TranslateLoose = (s?: any, q?: TranslationQuery, o?: TranslationOptions) => string;
+export {};

package/i18n/types.js

@@ -0,0 +1 @@
+export {};

package/i18n/useT/index.d.ts

@@ -1,50 +1,16 @@
-export declare type TranslateNamespace = Extract<keyof Koine.NextTranslations, string>;
-declare type Join<S1, S2> = S1 extends string ? S2 extends string ? `${S1}.${S2}` : S1 : 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], TAddRoot>> : Join<K, TranslationsPaths<T[K], TAddRoot>> : K : 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>> ? `${N}:${K}` : Koine.NextTranslations[N][K] extends Record<string, unknown> ? `${N}:${K}` | Join<K extends string ? `${N}:${K}` : `${N}:`, TranslationsPaths<Koine.NextTranslations[N][K], true>> : Koine.NextTranslations[N][K] extends Array<string | number | boolean> ? `${N}:${K}` : 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>];
+import type { TranslateNamespace, TranslateDefault, TranslateNamespaced } from "../types";
 /**
- * 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], true>, q?: TranslationQuery, o?: TranslationOptions) => TReturn;
-/**
- * Wrap `next-translate` useTranslations adding the `obj` second argument shortcut
- * and type safety
+ * Wrap `next-translate` useTranslations for type safet and adding the `obj`
+ * second argument shortcut for `{ returnObjects: true }`
  *
  * @see https://github.com/vinissimus/next-translate/issues/513#issuecomment-779826418
+ *
+ * About the typescript support for translation strings see:
+ * - https://github.com/vinissimus/next-translate/issues/721
+ *
+ * **NOTE**: To make typescript work nicely here make sure to enable
+ * [`resolveJsonModule`](https://www.typescriptlang.org/tsconfig#resolveJsonModule)
+ * in your `tsconfig.json` file.
  */
 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

@@ -1,105 +1,19 @@
-/* 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
+            return t((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...
- */
+// 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";

package/node/config/index.js

@@ -152,7 +152,18 @@ function withKoine(_a) {
             // @see https://github.com/vercel/next.js/discussions/30174#discussion-3643870
             scrollRestoration: true }, (nextConfig.experimental || {})), { 
             // @see https://nextjs.org/docs/advanced-features/compiler#modularize-imports
-            modularizeImports: tslib_1.__assign({}, (((_b = nextConfig === null || nextConfig === void 0 ? void 0 : nextConfig.experimental) === null || _b === void 0 ? void 0 : _b.modularizeImports) || {})) }), 
+            modularizeImports: tslib_1.__assign(tslib_1.__assign({}, (((_b = nextConfig === null || nextConfig === void 0 ? void 0 : nextConfig.experimental) === null || _b === void 0 ? void 0 : _b.modularizeImports) || {})), { 
+                // FIXME: make these work with the right file/folder structure?
+                // "@koine/next/?(((\\w*)?/?)*)": {
+                //   transform: "@koine/next/{{ matches.[1] }}/{{member}}",
+                // },
+                // "@koine/react/?(((\\w*)?/?)*)": {
+                //   transform: "@koine/react/{{ matches.[1] }}/{{member}}",
+                // },
+                // "@koine/utils/?(((\\w*)?/?)*)": {
+                //   transform: "@koine/utils/{{ matches.[1] }}/{{member}}",
+                // },
+                "@koine/utils": { transform: "@koine/utils/{{member}}" } }) }), 
         // @see https://github.com/vercel/next.js/issues/7322#issuecomment-887330111
         reactStrictMode: true }, nextConfig);
     if (svg) {

package/node/i18n/T/index.js

@@ -4,5 +4,10 @@ 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"));
+/**
+ * **NOTE**: To make typescript work nicely here make sure to enable
+ * [`resolveJsonModule`](https://www.typescriptlang.org/tsconfig#resolveJsonModule)
+ * in your `tsconfig.json` file.
+ */
 var T = function (props) { return (0, jsx_runtime_1.jsx)(Trans_1.default, tslib_1.__assign({}, props)); };
 exports.T = T;

package/node/i18n/getT/index.js

@@ -3,11 +3,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getT = void 0;
 var tslib_1 = require("tslib");
+var getT_1 = tslib_1.__importDefault(require("next-translate/getT"));
 /**
- * @file
- *
- * About the typescript support for translation strings @see:
- * - https://github.com/vinissimus/next-translate/issues/721
+ * **NOTE**: To make typescript work nicely here make sure to enable
+ * [`resolveJsonModule`](https://www.typescriptlang.org/tsconfig#resolveJsonModule)
+ * in your `tsconfig.json` file.
  */
-var getT_1 = tslib_1.__importDefault(require("next-translate/getT"));
 exports.getT = getT_1.default;

package/node/i18n/index.js

@@ -7,3 +7,4 @@ tslib_1.__exportStar(require("./translationAsOptions"), exports);
 tslib_1.__exportStar(require("./useDateFormat"), exports);
 tslib_1.__exportStar(require("./useLocale"), exports);
 tslib_1.__exportStar(require("./useT"), exports);
+tslib_1.__exportStar(require("./types"), exports);

package/node/i18n/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/node/i18n/useT/index.js

@@ -1,23 +1,14 @@
 "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
+            return t(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;
             );
         };
@@ -25,86 +16,9 @@ function useT(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...
- */
+// 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";

package/package.json

@@ -7,9 +7,9 @@
   "peerDependencies": {
     "react": "^16.8 || ^17 || ^18",
     "next": "^12.1.6",
-    "@koine/utils": "1.0.26",
+    "@koine/utils": "1.0.29",
     "framer-motion": "^6.3.10",
-    "@koine/react": "1.0.26",
+    "@koine/react": "1.0.29",
     "styled-components": "^5.3.5",
     "@mui/base": "^5.0.0-alpha.83",
     "react-icons": "^4.4.0",
@@ -20,6 +20,7 @@
     "yup": "^0.32.11",
     "react-hook-form": "^7.31.3",
     "type-fest": "^2.13.0",
+    "react-popper": "^2.3.0",
     "tslib": "^2.4.0",
     "next-auth": "^4.3.4",
     "@mui/material": "^5.8.2",
@@ -29,7 +30,7 @@
     "next-translate": "^1.4.0",
     "next-seo": "^5.4.0"
   },
-  "version": "1.0.26",
+  "version": "1.0.29",
   "module": "./index.js",
   "types": "./index.d.ts"
 }

package/typings.d.ts

@@ -83,13 +83,8 @@ declare namespace Koine {
    * - `{ComponentName}`: pascal cased for **components** specific data
    */
   interface NextTranslations {
-    "~": Record<string, string>;
-    _: Record<string, string>;
+    [key: string]: any;
   }
-  // interface NextTranslations {
-  //   "~": Record<string, string>;
-  //   _: Record<string, string>;
-  // }
 }
 
 /**
@@ -97,7 +92,6 @@ declare namespace Koine {
  * the `koine` ecosystem. For instance Google Analytics globally available
  * variables.
  */
-
-declare const gtag: (
-  ...args: Record<string, unknown>[]
-) => Record<string, unknown>;
+declare interface Window {
+  gtag: (...args: Record<string, unknown>[]) => Record<string, unknown>;
+}

package/Forms/useSubmit.d.ts

@@ -1,24 +0,0 @@
-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/Forms/useSubmit.js

@@ -1,28 +0,0 @@
-import { __assign, __awaiter, __generator } from "tslib";
-import { useAsyncFn } from "@koine/react";
-import { api } from "../utils/api";
-export function useSubmit(url, transformData) {
-    var _this = this;
-    var _a = useAsyncFn(function (json) { return __awaiter(_this, void 0, void 0, function () {
-        var response;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0:
-                    if (transformData)
-                        json = transformData(json);
-                    return [4 /*yield*/, api.post(url, {
-                            json: json,
-                        })];
-                case 1:
-                    response = _a.sent();
-                    if (process.env["NODE_ENV"] !== "production") {
-                        console.log("[@koine/next] useSubmit response", response);
-                    }
-                    return [2 /*return*/, response];
-            }
-        });
-    }); }, [url, transformData]), state = _a[0], submit = _a[1];
-    var loading = state.loading, error = state.error, value = state.value;
-    var fail = !loading && (!!error || (value === null || value === void 0 ? void 0 : value.fail));
-    return __assign(__assign({ submit: submit, loading: loading }, (value || {})), { fail: fail });
-}

package/utils/api.d.ts

@@ -1,55 +0,0 @@
-declare type _Response = Response;
-export declare namespace KoineApi {
-    type ResponseSuccesfull = unknown;
-    type ResponseFailed = unknown;
-    type ResponseShared<T extends Record<string, unknown> = {}> = T & {
-        status: _Response["status"];
-        msg: _Response["statusText"];
-    };
-    type Response<Succesfull extends ResponseSuccesfull = ResponseSuccesfull, Failed extends ResponseFailed = ResponseFailed> = {
-        status: _Response["status"];
-        msg: _Response["statusText"];
-        ok: true;
-        fail?: false;
-        data: Succesfull;
-    } | {
-        status: _Response["status"];
-        msg: _Response["statusText"];
-        ok?: false;
-        fail: true;
-        data: Failed;
-    };
-    /**
-     * Request options
-     */
-    type RequestOptions<TJson = unknown> = {
-        /**
-         * JSON request body
-         *
-         * @default {}
-         */
-        json?: TJson;
-        /**
-         * Params will be serialized into a string and appended to the URL
-         */
-        params?: Record<string, unknown>;
-        /**
-         * Headers will be merged with
-         * ```
-         * { "content-type": "application/json" }
-         * ```
-         */
-        headers?: RequestInit["headers"];
-        /**
-         * Timeout in `ms`, if `falsy` there is no timeout
-         *
-         * @default 10000
-         */
-        timeout?: number | false | null;
-    };
-    type RequestMethod = "get" | "post" | "put" | "patch" | "delete";
-    type RequestFn = <Succesfull extends ResponseSuccesfull = unknown, Failed extends ResponseFailed = unknown>(endpoint: string, options?: RequestOptions) => Promise<Response<Succesfull, Failed>>;
-    type Client = Record<RequestMethod, RequestFn>;
-}
-export declare const api: KoineApi.Client;
-export {};

package/utils/api.js

@@ -1,44 +0,0 @@
-import { __assign, __awaiter, __generator } from "tslib";
-import { buildUrlQueryString } from "@koine/utils";
-export var api = ["get", "post", "put", "patch", "delete"].reduce(function (api, method) {
-    api[method] = function (endpoint, options) {
-        if (options === void 0) { options = {}; }
-        return __awaiter(void 0, void 0, void 0, function () {
-            var _a, json, params, _b, headers, _c, timeout, requestInit, timeoutNumber, controller, timeoutId, url, response, result;
-            return __generator(this, function (_d) {
-                switch (_d.label) {
-                    case 0:
-                        _a = options.json, json = _a === void 0 ? {} : _a, params = options.params, _b = options.headers, headers = _b === void 0 ? {} : _b, _c = options.timeout, timeout = _c === void 0 ? 10000 : _c;
-                        requestInit = {
-                            method: method.toUpperCase(),
-                            headers: __assign({ "content-type": "application/json" }, headers),
-                        };
-                        timeoutNumber = Number(timeout);
-                        url = "/api/".concat(endpoint.replace(/^\/*/, ""));
-                        if (method !== "get") {
-                            requestInit.body = JSON.stringify(json);
-                        }
-                        if (timeoutNumber > 0) {
-                            controller = new AbortController();
-                            timeoutId = setTimeout(function () { return controller.abort(); }, timeoutNumber);
-                            requestInit.signal = controller.signal;
-                        }
-                        if (params) {
-                            url += buildUrlQueryString(params);
-                        }
-                        return [4 /*yield*/, fetch(url, requestInit)];
-                    case 1:
-                        response = _d.sent();
-                        if (timeoutId) {
-                            clearTimeout(timeoutId);
-                        }
-                        return [4 /*yield*/, response.json()];
-                    case 2:
-                        result = (_d.sent());
-                        return [2 /*return*/, result];
-                }
-            });
-        });
-    };
-    return api;
-}, {});