@koine/next 1.0.1 → 1.0.2

package/package.json

@@ -1,18 +1,25 @@
 {
   "name": "@koine/next",
   "sideEffects": false,
-  "version": "1.0.1",
+  "exports": {
+    ".": "./index.js",
+    "./app": "./app.js",
+    "./config": "./config.js",
+    "./document": "./document.js"
+  },
+  "version": "1.0.2",
   "main": "./index.umd.js",
   "module": "./index.esm.js",
   "typings": "./index.d.ts",
-  "dependencies": {},
-  "peerDependencies": {
+  "dependencies": {
     "react": "^17.0.2",
     "next": "^12.1.4",
+    "@koine/utils": "1.0.2",
     "next-auth": "^4.3.1",
     "framer-motion": "^6.2.9",
     "@mui/material": "^5.6.0",
     "@emotion/react": "^11.9.0",
+    "@koine/react": "1.0.2",
     "styled-components": "^5.3.5",
     "react-hook-form": "^7.29.0",
     "@emotion/server": "^11.4.0",
@@ -22,5 +29,6 @@
     "date-fns": "^2.28.0",
     "next-translate": "^1.3.5",
     "next-seo": "^5.4.0"
-  }
+  },
+  "peerDependencies": {}
 }

package/types.d.ts

@@ -0,0 +1,91 @@
+/**
+ * Next utility types
+ */
+declare type PageServer<P> = import("next").InferGetServerSidePropsType<P>;
+declare type PageStatic<P> = import("next").InferGetStaticPropsType<P>;
+declare type DataServer<P, T> = import("next").GetServerSideProps<P, T>;
+declare type DataStatic<P, T> = import("next").GetStaticProps<P, T>;
+declare type DataStaticPaths<P> = import("next").GetStaticPaths<P>;
+declare type DataStaticPathsResult<P> = import("next").GetStaticPathsResult<P>;
+
+/**
+ * Nx types
+ *
+ * Allow to embed SVGs as both URLs string and as React components
+ */
+declare module "*.svg" {
+  const content: unknown;
+  export const ReactComponent: import("react").FC<
+    import("react").ComponentProps<"svg">
+  >;
+  export default content;
+}
+
+/**
+ * Extend NodeJS `process.env` with variables used by @koine
+ */
+declare namespace NodeJS {
+  interface ProcessEnv {
+    NEXT_PUBLIC_APP_URL: string;
+    AUTH_ROUTE_LOGIN: string;
+    AUTH_ROUTE_PROFILE: string;
+    AUTH_ROUTE_REGISTER: string;
+    AUTH_ROUTES_SECURED: string;
+  }
+}
+
+/**
+ * Types specifically related to `@koine/next` exposed on the global unique
+ * namespace `Koine`. Most of the types here should be prefixed by `Next`, e.g.
+ * `NextSomeFeature` accessible anywhere from `Koine.NextSomeFeature`
+ */
+declare namespace Koine {
+  /**
+   * Default SEO data structure expected by the `<Seo>` component's prop `seo`
+   */
+  type NextSeo = import("./Seo").SeoData;
+
+  /**
+   * Next auth routes configurable map
+   *
+   * @see next/auth `pages` mapping: https://next-auth.js.org/configuration/pages`
+   */
+  type NextAuthRoutesMap = {
+    login: string;
+    profile: string;
+    register: string;
+    /** Array of regexes to match pathnames of protected routes */
+    secured: RegExp[];
+  };
+
+  /**
+   * Translations dictionary extracted from JSON files. You need to extend this
+   * type with something like:
+   *
+   * ```ts
+   * "~": typeof import("./public/locales/en/~.json");
+   * _: typeof import("./public/locales/en/_.json");
+   * $team: typeof import("./public/locales/en/$team.json");
+   * home: typeof import("./public/locales/en/home.json");
+   * Footer: typeof import("./public/locales/en/Footer.json");
+   * Header: typeof import("./public/locales/en/Header.json");
+   * ```
+   */
+  // eslint-disable-next-line @typescript-eslint/no-empty-interface
+  interface NextTranslations {
+    /** Convention for app wide `common` translations */
+    _: Record<string, string>;
+    /** Convention for app wide `routes` translated definitions */
+    "~": Record<string, string>;
+  }
+}
+
+/**
+ * List here the global variables used by third party scripts supported within
+ * the `koine` ecosystem. For instance Google Analytics globally available
+ * variables.
+ */
+
+declare const gtag: (
+  ...args: Record<string, unknown>[]
+) => Record<string, unknown>;

package/utils/api.d.ts

@@ -0,0 +1,55 @@
+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/index.d.ts

@@ -0,0 +1,19 @@
+export * from "./api";
+export declare const ONE_HOUR = 3600;
+export declare const ONE_DAY = 84000;
+/**
+ * Get site absolute url with the given path
+ *
+ * - It uses the `NEXT_PUBLIC_APP_URL` env variable
+ * - It removes the trailing slashes
+ */
+export declare function getSiteUrl(path?: string): string;
+/**
+ * Utility to load a component with an optional pre-determined delay.
+ *
+ * This was designed to improve anti spam wit async form loading.
+ *
+ * @see https://github.com/vercel/next.js/blob/main/packages/next/next-server/lib/dynamic.tsx
+ * @see https://github.com/vercel/next.js/blob/canary/examples/with-dynamic-import/pages/index.js
+ */
+export declare function load<T>(component: T, milliseconds: number): Promise<T>;

package/motion-features.esm.js

@@ -1,2 +0,0 @@
-import { domMax } from 'framer-motion';
-export { domMax as default } from 'framer-motion';