@prezly/theme-kit-nextjs 5.3.0 → 5.3.1-alpha.0

package/README.md

@@ -54,6 +54,25 @@ If you don't have these credentials, you can use one of our [testing newsrooms c
 In a base setup, you don't have to make any changes to your config.
 Depending on your use-case, you might need to make some additions to your base config.
 
+#### `withPrezlyConfig` helper
+
+You can add all of the necessary properties to your Next config with a single helper function.
+It adds the required `i18n` config, `images` config if you're using `next/image` to display images served from Prezly, and recommended security headers.
+Apart from several properties in `i18n` config, all of your existing config properties will be preserved and merged with our custom properties.
+You can control each of the config overrides with optional parameters object.
+
+```js
+const withPrezlyConfig = require('@prezly/theme-kit-nextjs/config')(/* Optional parameters for PrezlyConfig */);
+
+const config ={
+    /* ...your next config... */
+};
+
+module.exports = withPrezlyConfig(config);
+```
+
+You can also add the properties manually if you want even more control over the config.
+
 #### Using next/image to display images served from Prezly
 
 We provide `@prezly/uploadcare-image` package to conveniently display images inside Prezly content, and this is the recommended way to display images in your theme.

package/build/adapter-nextjs/processRequest.js

@@ -14,7 +14,10 @@ const intl_1 = require("../intl");
  */
 function processRequest(context, props, canonicalUrl) {
     (0, theme_kit_core_1.assertServerEnv)('processRequest');
-    const { locale: nextLocale, query } = context;
+    const { locale: nextLocale, query, res } = context;
+    // Since Next 13, Cache-Control header set in `next.config.js` is overwritten by Next in production, effectively bypassing any caching systems setup on top of the theme.
+    // This is a workaround for that issue. See https://nextjs.org/docs/pages/building-your-application/deploying/production-checklist#caching
+    res.setHeader('Cache-Control', 'public, max-age=0, must-revalidate');
     const { localeResolved, ...pageProps } = props;
     // If no locale was provided by Next, it most likely means that the theme is not supporting multi-language.
     // In that case we won't show 404 page.

package/build/adapter-nextjs/processRequest.js.map

@@ -1 +1 @@
-{"version":3,"file":"processRequest.js","sourceRoot":"","sources":["../../src/adapter-nextjs/processRequest.ts"],"names":[],"mappings":";;;AAAA,2DAA8F;AAG9F,kCAAuD;AAGvD;;;;;;;;GAQG;AACH,SAAgB,cAAc,CAC1B,OAAkC,EAClC,KAA8C,EAC9C,YAAqB;IAErB,IAAA,gCAAe,EAAC,gBAAgB,CAAC,CAAC;IAClC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;IAE9C,MAAM,EAAE,cAAc,EAAE,GAAG,SAAS,EAAE,GAAG,KAAK,CAAC;IAE/C,2GAA2G;IAC3G,uCAAuC;IACvC,IAAI,CAAC,cAAc,IAAI,UAAU,EAAE;QAC/B,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;KAC7B;IAED,IAAI,YAAY,EAAE;QACd,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,SAAS,CAAC,oBAAoB,CAAC;QACjE,MAAM,aAAa,GAAG,6BAAY,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;QAC3D,MAAM,kBAAkB,GAAG,IAAA,sCAAqB,EAAC,SAAS,EAAE,aAAa,CAAC,CAAC;QAE3E,MAAM,QAAQ,GAAG,IAAA,mCAA4B,EACzC,kBAAkB,EAClB,UAAU,EACV,YAAY,EACZ,KAAK,CACR,CAAC;QACF,IAAI,QAAQ,EAAE;YACV,OAAO,EAAE,QAAQ,EAAE,CAAC;SACvB;KACJ;IAED,OAAO;QACH,KAAK,EAAE,SAA8B;KACxC,CAAC;AACN,CAAC;AAnCD,wCAmCC"}
+{"version":3,"file":"processRequest.js","sourceRoot":"","sources":["../../src/adapter-nextjs/processRequest.ts"],"names":[],"mappings":";;;AAAA,2DAA8F;AAG9F,kCAAuD;AAGvD;;;;;;;;GAQG;AACH,SAAgB,cAAc,CAC1B,OAAkC,EAClC,KAA8C,EAC9C,YAAqB;IAErB,IAAA,gCAAe,EAAC,gBAAgB,CAAC,CAAC;IAClC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC;IAEnD,yKAAyK;IACzK,0IAA0I;IAC1I,GAAG,CAAC,SAAS,CAAC,eAAe,EAAE,oCAAoC,CAAC,CAAC;IAErE,MAAM,EAAE,cAAc,EAAE,GAAG,SAAS,EAAE,GAAG,KAAK,CAAC;IAE/C,2GAA2G;IAC3G,uCAAuC;IACvC,IAAI,CAAC,cAAc,IAAI,UAAU,EAAE;QAC/B,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;KAC7B;IAED,IAAI,YAAY,EAAE;QACd,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,SAAS,CAAC,oBAAoB,CAAC;QACjE,MAAM,aAAa,GAAG,6BAAY,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;QAC3D,MAAM,kBAAkB,GAAG,IAAA,sCAAqB,EAAC,SAAS,EAAE,aAAa,CAAC,CAAC;QAE3E,MAAM,QAAQ,GAAG,IAAA,mCAA4B,EACzC,kBAAkB,EAClB,UAAU,EACV,YAAY,EACZ,KAAK,CACR,CAAC;QACF,IAAI,QAAQ,EAAE;YACV,OAAO,EAAE,QAAQ,EAAE,CAAC;SACvB;KACJ;IAED,OAAO;QACH,KAAK,EAAE,SAA8B;KACxC,CAAC;AACN,CAAC;AAvCD,wCAuCC"}

package/build/config/index.d.ts

@@ -0,0 +1,17 @@
+import type { NextConfig } from 'next';
+interface PrezlyConfigParams {
+    /**
+     * Enables Prezly i18n support. Defaults to `true`
+     */
+    i18n: boolean;
+    /**
+     * Enables support for Prezly images in `next/image`. Defaults to `true`
+     */
+    images: boolean;
+    /**
+     * Adds security headers recommended by Prezly. Defaults to `true`
+     */
+    recommendedHeaders: boolean;
+}
+export default function PrezlyConfig(params?: Partial<PrezlyConfigParams>): (config: NextConfig) => NextConfig;
+export {};

package/build/config/index.js

@@ -0,0 +1,75 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const localeConfig_1 = __importDefault(require("@prezly/theme-kit-core/localeConfig"));
+const intl_1 = require("../intl");
+const DEFAULT_PARAMS = {
+    i18n: true,
+    images: true,
+    recommendedHeaders: true,
+};
+// eslint-disable-next-line import/no-default-export
+function PrezlyConfig(params) {
+    const finalParams = { ...DEFAULT_PARAMS, ...params };
+    return function withPrezlyConfig(config) {
+        const { headers } = config;
+        return {
+            ...config,
+            ...(finalParams.recommendedHeaders && {
+                async headers() {
+                    return [
+                        ...(typeof headers === 'function' ? await headers() : []),
+                        {
+                            source: '/(.*)',
+                            locale: false,
+                            headers: [
+                                {
+                                    key: 'Strict-Transport-Security',
+                                    value: 'max-age=63072000; includeSubDomains; preload',
+                                },
+                                {
+                                    key: 'X-XSS-Protection',
+                                    value: '1; mode=block',
+                                },
+                                {
+                                    key: 'X-Frame-Options',
+                                    value: 'SAMEORIGIN',
+                                },
+                                {
+                                    key: 'X-Content-Type-Options',
+                                    value: 'nosniff',
+                                },
+                                {
+                                    key: 'Content-Security-Policy',
+                                    value: 'upgrade-insecure-requests; report-uri https://csp.prezly.net/report;',
+                                },
+                            ],
+                        },
+                    ];
+                },
+            }),
+            images: {
+                ...config.images,
+                domains: [...(config.images?.domains || []), 'cdn.uc.assets.prezly.com'],
+            },
+            ...(finalParams.i18n && {
+                i18n: {
+                    ...config.i18n,
+                    // These are all the locales you want to support in
+                    // your application
+                    locales: [...localeConfig_1.default, intl_1.DUMMY_DEFAULT_LOCALE],
+                    // This is the default locale you want to be used when visiting
+                    // a non-locale prefixed path e.g. `/hello`
+                    // We use Pseudo locale used for localization testing, to reliably determine if we need to fallback to the default newsroom language
+                    defaultLocale: intl_1.DUMMY_DEFAULT_LOCALE,
+                    // Default locale detection is disabled, since the locales would be determined by Prezly API
+                    localeDetection: false,
+                },
+            }),
+        };
+    };
+}
+exports.default = PrezlyConfig;
+//# sourceMappingURL=index.js.map

package/build/config/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/config/index.ts"],"names":[],"mappings":";;;;;AAAA,uFAA0D;AAG1D,kCAA+C;AAiB/C,MAAM,cAAc,GAAuB;IACvC,IAAI,EAAE,IAAI;IACV,MAAM,EAAE,IAAI;IACZ,kBAAkB,EAAE,IAAI;CAC3B,CAAC;AAEF,oDAAoD;AACpD,SAAwB,YAAY,CAAC,MAAoC;IACrE,MAAM,WAAW,GAAG,EAAE,GAAG,cAAc,EAAE,GAAG,MAAM,EAAE,CAAC;IAErD,OAAO,SAAS,gBAAgB,CAAC,MAAkB;QAC/C,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAE3B,OAAO;YACH,GAAG,MAAM;YACT,GAAG,CAAC,WAAW,CAAC,kBAAkB,IAAI;gBAClC,KAAK,CAAC,OAAO;oBACT,OAAO;wBACH,GAAG,CAAC,OAAO,OAAO,KAAK,UAAU,CAAC,CAAC,CAAC,MAAM,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;wBACzD;4BACI,MAAM,EAAE,OAAO;4BACf,MAAM,EAAE,KAAK;4BACb,OAAO,EAAE;gCACL;oCACI,GAAG,EAAE,2BAA2B;oCAChC,KAAK,EAAE,8CAA8C;iCACxD;gCACD;oCACI,GAAG,EAAE,kBAAkB;oCACvB,KAAK,EAAE,eAAe;iCACzB;gCACD;oCACI,GAAG,EAAE,iBAAiB;oCACtB,KAAK,EAAE,YAAY;iCACtB;gCACD;oCACI,GAAG,EAAE,wBAAwB;oCAC7B,KAAK,EAAE,SAAS;iCACnB;gCACD;oCACI,GAAG,EAAE,yBAAyB;oCAC9B,KAAK,EAAE,sEAAsE;iCAChF;6BACJ;yBACJ;qBACJ,CAAC;gBACN,CAAC;aACJ,CAAC;YACF,MAAM,EAAE;gBACJ,GAAG,MAAM,CAAC,MAAM;gBAChB,OAAO,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,IAAI,EAAE,CAAC,EAAE,0BAA0B,CAAC;aAC3E;YACD,GAAG,CAAC,WAAW,CAAC,IAAI,IAAI;gBACpB,IAAI,EAAE;oBACF,GAAG,MAAM,CAAC,IAAI;oBACd,mDAAmD;oBACnD,mBAAmB;oBACnB,OAAO,EAAE,CAAC,GAAG,sBAAO,EAAE,2BAAoB,CAAC;oBAC3C,+DAA+D;oBAC/D,2CAA2C;oBAC3C,oIAAoI;oBACpI,aAAa,EAAE,2BAAoB;oBACnC,4FAA4F;oBAC5F,eAAe,EAAE,KAAK;iBACzB;aACJ,CAAC;SACL,CAAC;IACN,CAAC,CAAC;AACN,CAAC;AA7DD,+BA6DC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prezly/theme-kit-nextjs",
-  "version": "5.3.0",
+  "version": "5.3.1-alpha.0",
   "description": "Data layer and utility library for developing Prezly themes with NextJS",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -10,11 +10,15 @@
   ],
   "exports": {
     ".": "./build/index.js",
+    "./config": "./build/config.js",
     "./server": "./build/server.js",
     "./playwright": "./build/playwright/index.js"
   },
   "typesVersions": {
     "*": {
+      "config": [
+        "build/config.d.ts"
+      ],
       "server": [
         "build/server.d.ts"
       ],
@@ -71,11 +75,11 @@
     "next-seo": "^5.4.0"
   },
   "devDependencies": {
-    "@sentry/nextjs": "7.53.0"
+    "@sentry/nextjs": "7.53.1"
   },
   "publishConfig": {
     "access": "public"
   },
   "sideEffects": false,
-  "gitHead": "be17fb60560d46fc7e15ae76111594251e7a0ec3"
+  "gitHead": "c47bc554ebe87b641bdcc9a2ace51cf8884eb096"
 }