@koine/next 1.0.0 → 1.0.3

package/_tslib.js

@@ -0,0 +1,41 @@
+'use strict';
+
+/*! *****************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+
+function __rest(s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+}
+
+function __awaiter(thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+}
+
+exports.__awaiter = __awaiter;
+exports.__rest = __rest;

package/app/App--emotion.d.ts

@@ -0,0 +1,10 @@
+import React from "react";
+import { AppProps as NextAppProps } from "next/app";
+import { AppThemeEmotionProps } from "./AppTheme--emotion";
+import { AppMainProps } from "./AppMain";
+export declare type AppEmotionProps = NextAppProps & AppThemeEmotionProps & AppMainProps;
+/**
+ * App
+ */
+export declare const AppEmotion: React.FC<AppEmotionProps>;
+export default AppEmotion;

package/app/App--sc.d.ts

@@ -0,0 +1,10 @@
+import React from "react";
+import { AppProps as NextAppProps } from "next/app";
+import { AppThemeScProps } from "./AppTheme--sc";
+import { AppMainProps } from "./AppMain";
+export declare type AppBaseProps = NextAppProps & AppThemeScProps & AppMainProps;
+/**
+ * App
+ */
+export declare const AppBase: React.FC<AppBaseProps>;
+export default AppBase;

package/app/App--vanilla.d.ts

@@ -0,0 +1,10 @@
+import React from "react";
+import { AppProps as NextAppProps } from "next/app";
+import { AppThemeVanillaProps } from "./AppTheme--vanilla";
+import { AppMainVanillaProps } from "./AppMain--vanilla";
+export declare type AppVanillaProps = NextAppProps & AppThemeVanillaProps & AppMainVanillaProps;
+/**
+ * App
+ */
+export declare const AppVanilla: React.FC<AppVanillaProps>;
+export default AppVanilla;

package/app/AppAuth--emotion.d.ts

@@ -0,0 +1,10 @@
+import React from "react";
+import { AppProps as NextAppProps } from "next/app";
+import { AppThemeEmotionProps } from "./AppTheme--emotion";
+import { AppMainProps } from "./AppMain";
+export declare type AppAuthEmotionProps = NextAppProps & AppThemeEmotionProps & AppMainProps;
+/**
+ * App with authentication provided by `next-auth`
+ */
+export declare const AppAuthEmotion: React.FC<AppAuthEmotionProps>;
+export default AppAuthEmotion;

package/app/AppAuth--sc.d.ts

@@ -0,0 +1,10 @@
+import React from "react";
+import { AppProps as NextAppProps } from "next/app";
+import { AppThemeScProps } from "./AppTheme--sc";
+import { AppMainProps } from "./AppMain";
+export declare type AppAuthScProps = NextAppProps & AppThemeScProps & AppMainProps;
+/**
+ * App with authentication provided by `next-auth`
+ */
+export declare const AppAuthSc: React.FC<AppAuthScProps>;
+export default AppAuthSc;

package/app/AppHead.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+export declare type AppHeadProps = unknown;
+export declare const AppHead: React.FC<AppHeadProps>;

package/app/AppMain--vanilla.d.ts

@@ -0,0 +1,27 @@
+import React from "react";
+import { AppProps as NextAppProps } from "next/app";
+import { SeoDefaultsProps } from "../Seo";
+export declare type AppMainVanillaProps = NextAppProps & {
+    /**
+     * A wrapping layout component
+     */
+    Layout: React.FC<Record<string, unknown>>;
+    /**
+     * Seo site wide default configuration
+     */
+    seo?: SeoDefaultsProps;
+    /**
+     * JSX to render just after SEO
+     */
+    pre?: React.ReactNode;
+    /**
+     * JSX to render just at the end of the markup
+     */
+    post?: React.ReactNode;
+};
+/**
+ * App main
+ *
+ * It does not imply any specific styling or animation solution
+ */
+export declare const AppMainVanilla: React.FC<AppMainVanillaProps>;

package/app/AppMain.d.ts

@@ -0,0 +1,34 @@
+import React from "react";
+import { AppProps as NextAppProps } from "next/app";
+import { HTMLMotionProps } from "framer-motion";
+import { SeoDefaultsProps } from "../Seo";
+export declare type AppMainProps = NextAppProps & {
+    /**
+     * A wrapping layout component
+     */
+    Layout: React.FC<Record<string, unknown>>;
+    /**
+     * Seo site wide default configuration
+     */
+    seo?: SeoDefaultsProps;
+    /**
+     * It defaults to fade in/out
+     */
+    transition?: Omit<HTMLMotionProps<"div">, "key">;
+    /**
+     * JSX to render just after SEO
+     */
+    pre?: React.ReactNode;
+    /**
+     * JSX to render just at the end of the markup
+     */
+    post?: React.ReactNode;
+};
+/**
+ * App main
+ *
+ * It implies a setup for `styled-components` and `framer-motion` libraries.
+ *
+ * About the page transition [wallis' blog post](https://wallis.dev/blog/nextjs-page-transitions-with-framer-motion)
+ */
+export declare const AppMain: React.FC<AppMainProps>;

package/app/AppTheme--emotion.d.ts

@@ -0,0 +1,15 @@
+import React from "react";
+import { AppProps as NextAppProps } from "next/app";
+import { Theme } from "@mui/material/styles";
+import { EmotionCache } from "@emotion/react";
+export declare type AppThemeEmotionProps = NextAppProps & {
+    emotionCache?: EmotionCache;
+    /**
+     * A theme object
+     */
+    theme: Theme;
+};
+/**
+ * App theme with `emotion` (good for `@mui`)s
+ */
+export declare const AppThemeEmotion: React.FC<AppThemeEmotionProps>;

package/app/AppTheme--sc.d.ts

@@ -0,0 +1,13 @@
+import React from "react";
+import { AppProps as NextAppProps } from "next/app";
+import { Theme } from "@koine/react";
+export declare type AppThemeScProps = NextAppProps & {
+    /**
+     * A theme object
+     */
+    theme: Theme;
+};
+/**
+ * App theme with `styled-components`
+ */
+export declare const AppThemeSc: React.FC<AppThemeScProps>;

package/app/AppTheme--vanilla.d.ts

@@ -0,0 +1,10 @@
+import React from "react";
+import { AppProps as NextAppProps } from "next/app";
+import { ThemeProviderProps } from "../Theme";
+export declare type AppThemeVanillaProps = NextAppProps & {
+    theme: ThemeProviderProps["defaultTheme"];
+};
+/**
+ * App theme with vanilla class based theme (good for `tailwindcss`)
+ */
+export declare const AppThemeVanilla: React.FC<AppThemeVanillaProps>;

package/app/index.d.ts

@@ -0,0 +1,11 @@
+export * from "./App--emotion";
+export * from "./App--sc";
+export * from "./App--vanilla";
+export * from "./AppAuth--emotion";
+export * from "./AppAuth--sc";
+export * from "./AppHead";
+export * from "./AppMain";
+export * from "./AppMain--vanilla";
+export * from "./AppTheme--emotion";
+export * from "./AppTheme--sc";
+export * from "./AppTheme--vanilla";

package/app/motion-features.d.ts

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

package/app.js

@@ -0,0 +1,250 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+require('./es.object.assign.js');
+var jsxRuntime = require('react/jsx-runtime');
+var React = require('react');
+var Head = require('next/head');
+var styles = require('@mui/material/styles');
+var react = require('@emotion/react');
+var CssBaseline = require('@mui/material/CssBaseline');
+var react$1 = require('@koine/react');
+var emotion = require('./emotion.js');
+var Theme = require('./Theme.js');
+var router = require('next/router');
+var framerMotion = require('framer-motion');
+require('./es.string.replace.js');
+require('@koine/utils');
+var styledComponents = require('styled-components');
+var react$2 = require('next-auth/react');
+require('next/script');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
+var Head__default = /*#__PURE__*/_interopDefaultLegacy(Head);
+var CssBaseline__default = /*#__PURE__*/_interopDefaultLegacy(CssBaseline);
+
+const AppHead = props => {
+  return jsxRuntime.jsx(Head__default["default"], Object.assign({}, props, {
+    children: jsxRuntime.jsx("meta", {
+      name: "viewport",
+      content: "width=device-width"
+    })
+  }));
+};
+
+let _ = t => t,
+    _t;
+
+const clientSideEmotionCache = emotion.createEmotionCache();
+/**
+ * App theme with `emotion` (good for `@mui`)s
+ */
+
+const AppThemeEmotion = ({
+  emotionCache: _emotionCache = clientSideEmotionCache,
+  theme,
+  children
+}) => {
+  return jsxRuntime.jsx(react.CacheProvider, Object.assign({
+    value: _emotionCache
+  }, {
+    children: jsxRuntime.jsxs(styles.ThemeProvider, Object.assign({
+      theme: theme
+    }, {
+      children: [jsxRuntime.jsx(CssBaseline__default["default"], {}), jsxRuntime.jsx(react.Global, {
+        styles: react.css(_t || (_t = _`
+            ${0}
+          `), react$1.stylesGlobal)
+      }), children]
+    }))
+  }));
+};
+
+/**
+ * @see https://www.framer.com/docs/guide-reduce-bundle-size/
+ */
+
+const loadMotionFeatures = () => Promise.resolve().then(function () { return require('./motion-features.js'); }).then(m => m.default);
+/**
+ * App main
+ *
+ * It implies a setup for `styled-components` and `framer-motion` libraries.
+ *
+ * About the page transition [wallis' blog post](https://wallis.dev/blog/nextjs-page-transitions-with-framer-motion)
+ */
+
+
+const AppMain = ({
+  Component,
+  pageProps,
+  Layout,
+  // theme,
+  seo,
+  transition: _transition = {
+    initial: {
+      opacity: 0
+    },
+    animate: {
+      opacity: 1
+    },
+    exit: {
+      opacity: 0
+    }
+  },
+  pre,
+  post
+}) => {
+  const {
+    pathname
+  } = router.useRouter();
+  return jsxRuntime.jsxs(framerMotion.LazyMotion, Object.assign({
+    features: loadMotionFeatures
+  }, {
+    children: [jsxRuntime.jsx(Theme.SeoDefaults, Object.assign({}, seo)), pre, jsxRuntime.jsx(Theme.NextProgress, {}), jsxRuntime.jsx(Layout, {
+      children: jsxRuntime.jsx(framerMotion.AnimatePresence, Object.assign({
+        exitBeforeEnter: true,
+        initial: false
+      }, {
+        children: jsxRuntime.jsx(framerMotion.m.div, Object.assign({}, _transition, {
+          children: /*#__PURE__*/React.createElement(Component, Object.assign({}, pageProps, {
+            key: pathname
+          }))
+        }), pathname)
+      }))
+    }), post]
+  }));
+};
+
+/**
+ * App
+ */
+
+const AppEmotion = props => {
+  return jsxRuntime.jsxs(React__default["default"].Fragment, {
+    children: [jsxRuntime.jsx(AppHead, {}), jsxRuntime.jsx(AppThemeEmotion, Object.assign({}, props, {
+      children: jsxRuntime.jsx(AppMain, Object.assign({}, props))
+    }))]
+  });
+};
+
+/**
+ * App theme with `styled-components`
+ */
+
+const AppThemeSc = ({
+  theme,
+  children
+}) => {
+  return jsxRuntime.jsxs(styledComponents.ThemeProvider, Object.assign({
+    theme: theme
+  }, {
+    children: [jsxRuntime.jsx(react$1.StylesGlobal, {}), children]
+  }));
+};
+
+/**
+ * App
+ */
+
+const AppBase = props => {
+  return jsxRuntime.jsxs(React__default["default"].Fragment, {
+    children: [jsxRuntime.jsx(AppHead, {}), jsxRuntime.jsx(AppThemeSc, Object.assign({}, props, {
+      children: jsxRuntime.jsx(AppMain, Object.assign({}, props))
+    }))]
+  });
+};
+
+/**
+ * App theme with vanilla class based theme (good for `tailwindcss`)
+ */
+
+const AppThemeVanilla = ({
+  theme,
+  children
+}) => {
+  // return (
+  //   <ThemeVanillaProvider initialTheme={theme}>{children}</ThemeVanillaProvider>
+  // );
+  return jsxRuntime.jsx(Theme.ThemeProvider, Object.assign({
+    defaultTheme: theme,
+    attribute: "class"
+  }, {
+    children: children
+  }));
+};
+
+/**
+ * App main
+ *
+ * It does not imply any specific styling or animation solution
+ */
+
+const AppMainVanilla = ({
+  Component,
+  pageProps,
+  Layout,
+  seo,
+  pre,
+  post
+}) => {
+  return jsxRuntime.jsxs(React__default["default"].Fragment, {
+    children: [jsxRuntime.jsx(Theme.SeoDefaults, Object.assign({}, seo)), pre, jsxRuntime.jsx(Layout, {
+      children: jsxRuntime.jsx(Component, Object.assign({}, pageProps))
+    }), post]
+  });
+};
+
+/**
+ * App
+ */
+
+const AppVanilla = props => {
+  return jsxRuntime.jsxs(React__default["default"].Fragment, {
+    children: [jsxRuntime.jsx(AppHead, {}), jsxRuntime.jsx(AppThemeVanilla, Object.assign({}, props, {
+      children: jsxRuntime.jsx(AppMainVanilla, Object.assign({}, props))
+    }))]
+  });
+};
+
+/**
+ * App with authentication provided by `next-auth`
+ */
+
+const AppAuthEmotion = props => {
+  return jsxRuntime.jsxs(react$2.SessionProvider, Object.assign({
+    session: props.pageProps.session
+  }, {
+    children: [jsxRuntime.jsx(AppHead, {}), jsxRuntime.jsx(AppThemeEmotion, Object.assign({}, props, {
+      children: jsxRuntime.jsx(AppMain, Object.assign({}, props))
+    }))]
+  }));
+};
+
+/**
+ * App with authentication provided by `next-auth`
+ */
+
+const AppAuthSc = props => {
+  return jsxRuntime.jsxs(react$2.SessionProvider, Object.assign({
+    session: props.pageProps.session
+  }, {
+    children: [jsxRuntime.jsx(AppHead, {}), jsxRuntime.jsx(AppThemeSc, Object.assign({}, props, {
+      children: jsxRuntime.jsx(AppMain, Object.assign({}, props))
+    }))]
+  }));
+};
+
+exports.AppAuthEmotion = AppAuthEmotion;
+exports.AppAuthSc = AppAuthSc;
+exports.AppBase = AppBase;
+exports.AppEmotion = AppEmotion;
+exports.AppHead = AppHead;
+exports.AppMain = AppMain;
+exports.AppMainVanilla = AppMainVanilla;
+exports.AppThemeEmotion = AppThemeEmotion;
+exports.AppThemeSc = AppThemeSc;
+exports.AppThemeVanilla = AppThemeVanilla;
+exports.AppVanilla = AppVanilla;

package/config/index.d.ts

@@ -0,0 +1,58 @@
+import type { NextConfig } from "next";
+import type { Redirect, Rewrite } from "next/dist/lib/load-custom-routes";
+/**
+ * Normalise pathname
+ *
+ * From a path like `/some//malformed/path///` it returns `some/malformed/path`
+ *
+ * - Removes subsequent slashes
+ * - Removing initial and ending slashes
+ */
+export declare function normaliseUrlPathname(pathname: string): string;
+/**
+ * Clean a pathname and encode each part
+ *
+ * @see {@link normaliseUrlPathname}
+ */
+export declare function encodePathname(pathname: string): string;
+/**
+ */
+export declare function getPathRedirect(locale: string, localisedPathname: string, templateName: string, dynamic?: boolean, permanent?: boolean): {
+    source: string;
+    destination: string;
+    permanent: boolean;
+    locale: false;
+};
+/**
+ */
+export declare function getPathRewrite(source: string, destination: string, dynamic?: boolean): {
+    source: string;
+    destination: string;
+};
+/**
+ */
+export declare function getRedirects({ defaultLocale, routes, dynamicRoutes, permanent, }: {
+    defaultLocale: string;
+    routes: Record<string, string>;
+    dynamicRoutes: Record<string, boolean>;
+    permanent?: boolean;
+}): Promise<Redirect[]>;
+/**
+ */
+export declare function getRewrites({ routes, dynamicRoutes, }: {
+    routes: Record<string, string>;
+    dynamicRoutes: Record<string, boolean>;
+}): Promise<Rewrite[]>;
+declare type KoineNextConfig = {
+    /** @default true Nx monorepo setup */
+    nx?: boolean;
+    /** @default true  Svg to react components */
+    svg?: boolean;
+    /** @default true  Styled components enabled */
+    sc?: boolean;
+};
+/**
+ * Get Next.js config with some basic opinionated defaults
+ */
+export declare function withKoine({ nx, svg, sc, ...nextConfig }?: NextConfig & KoineNextConfig): NextConfig;
+export default withKoine;