Patch Changes

https://github.com/wpengine/faustjs/commit/6a7559376a15bab06e3fc1b0f537199810ea19e3: Fixes a PHP 8 warning that occured on post types not registered with WP GraphQL https://github.com/wpengine/faustjs/pull/812

Patch Changes

• https://github.com/wpengine/faustjs/commit/420d0b491947ef05b49aa0e40caaca798f15c7e2: Remove trailing slash from frontend uri.
• https://github.com/wpengine/faustjs/commit/037b57b733c4e60f5df47e9e75ca4ccfaa4a1c73: Ensure sitemap URLs use the WordPress domain and not the headless frontend domain. Fixes a conflict with Yoast SEO that prevented post links from being added to the posts sitemap.

Patch Changes

• b7af359: Simplify generation of preview links. Fixes an issue where preview links were missing slashes with certain permalink structures. Thanks @torounit!
• 662c377: Plugin settings are now validated and sanitized before saving.
• c730348: Disables access to the site editor when themes are disabled

Patch Changes

• 1dcd987: Removes unused event callbacks for rewrite rule and post status changes. The is_events_enabled() function has also been removed.
• 5c69b68: ConditionalTags has been deprecated as it was introduced in an older version of the framework when routing was done from the NextTemplateLoader. Now that we are using Next.js pages for routing, conditionalTags are no longer needed.
• 7d156ba: Add a documentation link that explains "Features" checkbox settings in more detail

Patch Changes

• ab4a661: Fixed issue where file editor was unable to save

Patch Changes

• f948c04: Fixed plugin icon SVG display issue in Chrome #683

Minor Changes

• Changed the plugin name to FaustWP.
• Changed all internal PHP function names to use namespaces.
• Changed the WP_HEADLESS_SECRET_KEY constant to FAUSTWP_SECRET_KEY.
• Changed the authentication endpoint namespace from wpac/v1 to faustwp/v1
• Changed settings option name from wpe_headless to faustwp_settings
• Changed the following filter names:
  • wpe_headless_setting to faustwp_setting
  • wpe_headless_settings to faustwp_settings
  • wpe_headless_domain_replacement_enabled to faustwp_domain_replacement_enabled
• Changed the text domain to faustwp.
• Changed minimum required PHP version to 7.2.
• Changed minimum required WordPress version to 5.7.
• Changed the hook used for public route redirection.
• Fixed the "headless post preview" link on the FaustWP settings page.
• Fixed "unexpected output" error during plugin activation.
• Fixed skipped domain replacement in GraphQL responses that include generalSettings.
• Added LICENSE file.

Release 0.10.0 of the NPM packages include BREAKING CHANGES. Existing users of Faust.js will need to make the following changes:

Step 1 - Update the WPE Headless Plugin

Ensure that you are on version 0.6.0 or later of the WPE Headless Plugin.

Step 2 - Update preview.tsx file

If you started from the next/getting-started example, replace the contents of src/pages/preview.tsx with the following:

import { PageComponent } from './[...pageUri]';
import { PostComponent } from './posts/[postSlug]';
import { client } from 'client';

export default function Preview() {
  const { usePreview } = client.auth;
  const result = usePreview();

  if (client.useIsLoading() || !result) {
    return <p>loading...</p>;
  }

  if (result.type === 'page') {
    if (!result.page) {
      return <>Not Found</>;
    }

    return <PageComponent page={result.page} />;
  }

  if (!result.post) {
    return <>Not Found</>;
  }

  return <PostComponent post={result.post} />;
}

Step 3 - Create next.config.js file

In the root of your project, alongside package.json, create a next.config.js file with the following contents:

const { withFaust } = require('@faustjs/next');

/**
 * @type {import('next').NextConfig}
 **/
module.exports = withFaust();

If you already have an existing next.config.js file, you can place it within the first argument of the withFaust function, like so:

const { withFaust } = require('@faustjs/next');

/**
 * @type {import('next').NextConfig}
 **/
module.exports = withFaust({
    // Your Next.js config here
});

Step 4 - Update gqty.config.js file

In the root of your project, alongside package.json, replace the gqty.config.js file with the following:

require('dotenv').config();

/**
 * @type {import("@gqty/cli").GQtyConfig}
 */
const config = {
  react: false,
  scalarTypes: { DateTime: 'string' },
  introspection: {
    endpoint: `${process.env.NEXT_PUBLIC_WORDPRESS_URL}/graphql`,
    headers: {},
  },
  destination: './src/client/index.ts',
  subscriptions: false,
  javascriptOutput: false,
};

console.log(`Using "${config.introspection.endpoint}" to generate schema...`);

module.exports = config;

Release package/core/0.9.0

Release 0.9.0 of the NPM packages include BREAKING CHANGES. Existing users of Faust.js will need to update their faust.config.js file to use ESM syntax, opposed to CJS syntax.

For example, users will need to replace their current faust.config.js file:

const { headlessConfig } = require('@faustjs/core');

if (!process.env.NEXT_PUBLIC_WORDPRESS_URL) {
  console.error(
    'You must provide a NEXT_PUBLIC_WORDPRESS_URL environment variable, did you forget to load your .env file?',
  );
}

/**
 * @type {import("@faustjs/core").HeadlessConfig}
 */
module.exports = headlessConfig({
  wpUrl: process.env.NEXT_PUBLIC_WORDPRESS_URL,
  apiClientSecret: process.env.WP_HEADLESS_SECRET,
});

With the following code:

import { headlessConfig } from '@faustjs/core';

if (!process.env.NEXT_PUBLIC_WORDPRESS_URL) {
  console.error(
    'You must provide a NEXT_PUBLIC_WORDPRESS_URL environment variable, did you forget to load your .env file?',
  );
}

/**
 * @type {import("@faustjs/core").HeadlessConfig}
 */
export default headlessConfig({
  wpUrl: process.env.NEXT_PUBLIC_WORDPRESS_URL,
  apiClientSecret: process.env.WP_HEADLESS_SECRET,
});

In the first release of our headless framework for WordPress, we make previews simple.

What's in the release:

• Headless Plugin for WordPress
  • Supports an OAuth flow for authentication
• @wpengine/headless
  • Authorization handler to support the plugin OAuth flow
  • React hooks for retrieving posts via GQL
  • Next.js SSR support for retrieving data from GQL

Tryout Previews and give us feedback via discussions!