Skip to main content

Changelog for @faustjs/next

@faustjs/next

0.15.13​

Patch Changes​

  • 6b71e32: Add deprecation notices
  • Updated dependencies [6b71e32]
    • @faustjs/react@0.15.13
    • @faustjs/core@0.15.13

0.15.12​

Patch Changes​

  • 176bc82: Chore: Fixes import order style lint error.

0.15.11​

Patch Changes​

  • f5dac42: Updated fast-xml-parser dependency

0.15.10​

Patch Changes​

  • d52fcdb: Added notice for preference towards the new faust.js version.
  • Updated dependencies [d52fcdb]
    • @faustjs/core@0.15.10
    • @faustjs/react@0.15.10

0.15.9​

Patch Changes​

  • e71a5ce: Fixes the Type '{}' is missing the following properties from type... bug some users may experience when building a Faust.js app. #1013

0.15.8​

Patch Changes​

  • de94e46: Added the ability to create a sitemap.xml file for base xml sitemaps and custom pages.

0.15.7​

Patch Changes​

  • 6ab4e1d: Added support for older versions of iOS
  • Updated dependencies [6ab4e1d]
    • @faustjs/core@0.15.7
    • @faustjs/react@0.15.7

0.15.6​

Patch Changes​

  • da3a1ae: Fixes draft preview links when i18n is enabled in Next.js config #853
  • 59241bb: build: Updates eslint to v8
  • Updated dependencies [a03fae1]
  • Updated dependencies [59241bb]
    • @faustjs/core@0.15.6
    • @faustjs/react@0.15.6

0.15.5​

Patch Changes​

  • 732623e: Added the robotsTxt config option in handleSitemapRequests that allows you to specify the content of your /robots.txt route. You can use the following snippet to create a /robots.txt route:

    handleSitemapRequests(req, {
      wpUrl: process.env.NEXT_PUBLIC_WORDPRESS_URL,
      sitemapIndexPath: '/wp-sitemap.xml',
      async robotsTxt(sitemapUrl) {
        return `
            User-agent: *
            Allow: /

            Sitemap: ${sitemapUrl}
          `;
      },
    });

    Notice robotsTxt is an async function that takes sitemapUrl as an argument. sitemapUrl can then be used to specify the URL to your sitemap in your robots.txt content.

  • 7e98ca6: Added support for sitemaps! Sitemaps in Faust.js work with Next.js middleware. You can create a piece of middleware at src/pages/_middleware.ts with the following content:

    import { handleSitemapRequests } from '@faustjs/next/middleware';
    import { NextRequest, NextResponse } from 'next/server';

    export default async function middleware(req: NextRequest) {
      const sitemapRequest = await handleSitemapRequests(req, {
        wpUrl: process.env.NEXT_PUBLIC_WORDPRESS_URL,
        sitemapIndexPath: '/wp-sitemap.xml',
      });

      if (sitemapRequest) {
        return sitemapRequest;
      }

      return NextResponse.next();
    }

    The handleSitemapRequests API requires wpUrl and sitemapIndexPath to be defined. There is optional properties you can define to suit your needs. The config is as follows:

    import { handleSitemapRequests } from '@faustjs/next';

    handleSitemapRequests(middlewareReq, {
      // REQUIRED: Your WordPress URL
      wpUrl: process.env.NEXT_PUBLIC_WORDPRESS_URL,
      // REQUIRED: The path to your sitemap index file on WordPress
      sitemapIndexPath: '/wp-sitemap.xml',
      /**
       * OPTIONAL: Sitemap paths to ignore. Useful if you don't want to include sitemaps for users, categories, etc.
       */
      sitemapPathsToIgnore: [
        '/wp-sitemap-posts-page-1.xml',
        '/wp-sitemap-posts-post-*', // Specify a wildcard a tthe end to avoid multiple indices if necessary
      ],
      /**
       * OPTIONAL: List of Next.js pages to include in your sitemap.
       */
      pages: [
        {
          path: '/about', // required
          priority: 0.75, // optional
          changefreq: 'monthly', // optional
          lastmod: new Date().toISOString(), // optional
        },
      ],
      /**
       * OPTIONAL: Replace WP urls with the headless frontend. `true` by default.
       */
      replaceUrls: true,
    });

0.15.4​

Patch Changes​

  • d2b2b39: Fixed previews when trailingSlash is enabled in Next.js config
  • Updated dependencies [d2b2b39]
    • @faustjs/core@0.15.4

0.15.3​

Patch Changes​

  • 1d386de: Check for FaustContext before calling GQty queries and throw an error if it's not provided.

0.15.1​

Patch Changes​

  • c74ce4f: Introduced the usePreviewNode hook to get preview data from any post type. You can use it like so:

    import type { Page, Post } from 'client';
    import { client } from 'client';

    export default function Preview() {
      const isLoading = client.useIsLoading();
      const { typeName, node } = client.auth.usePreviewNode();

      if (isLoading || node === undefined) {
        return <p>Loading...</p>;
      }

      if (node === null) {
        return <p>Post not found</p>;
      }

      switch (typeName) {
        case 'Page': {
          const page = node as Page;
          return (
            <>
              <h1>{page.title()}</h1>
              <div dangerouslySetInnerHTML={{ __html: page.content() }} />
            </>
          );
        }
        case 'Post': {
          const post = node as Post;
          return (
            <>
              <h1>{post.title()}</h1>
              <div dangerouslySetInnerHTML={{ __html: post.content() }} />
            </>
          );
        }
        // Add custom post types here as needed
        default: {
          throw new Error(`Unknown post type: ${typeName}`);
        }
      }
    }

    With usePreviewNode, we have deprecated the usePreview hook. It is still available, but it is recommended to use usePreviewNode instead.

  • Updated dependencies [3c1280b]

  • Updated dependencies [3c1280b]

    • @faustjs/react@0.15.1
    • @faustjs/core@0.15.1

0.15.0​

Minor Changes​

  • a044a07: Add file extensions to import statements to fully support ES Modules. Support for Next.js 12 🎉

Patch Changes​

  • Updated dependencies [a044a07]
    • @faustjs/core@0.15.0
    • @faustjs/react@0.15.0

0.14.0​

Patch Changes​

  • Updated dependencies [dc936a5]
    • @faustjs/core@0.14.0
    • @faustjs/react@0.14.0

0.13.1​

Patch Changes​

  • a3b08d6: Fixed an intermittent error TypeError: Cannot read property 'get' of undefined when running in dev mode.
  • a3b08d6: Updated dependencies
  • Updated dependencies [a3b08d6]
    • @faustjs/core@0.13.1
    • @faustjs/react@0.13.1

0.13.0​

Minor Changes​

  • 8630834: BREAKING: Rename HeadlessProvider to FaustProvider

0.12.4​

Patch Changes​

  • 81d6162: Refactored core exports and naming to make root namespace cleaner
  • Updated dependencies [81d6162]
    • @faustjs/core@0.12.4
    • @faustjs/react@0.12.4

0.12.3​

Patch Changes​

0.12.2​

Patch Changes​

  • 1e32f81: Typeings for getNextStaticProps and getNextServerSideProps now allow and protect custom props.

0.12.1​

Patch Changes​

  • 7d30277: logQueries is can now be called and will log GraphQL queries if desired.

0.12.0​

Minor Changes​

  • 8243e9f: headlessConfig from @faustjs/core is now just config, and @faustjs/next has its own config with a global revalidate option.

    Your faust.config.js needs to change to look like this:

    import { config as coreConfig } 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.local file?',
      );
    }

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

    Or, to configure the global revalidate option in @faustjs/next:

    import { config as coreConfig } from '@faustjs/core';
    import { config as nextConfig } from '@faustjs/next';

    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.local file?',
      );
    }

    nextConfig({
      revalidate: 60, // 1 minute
    });

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

    NOTE: @faustjs/next defaults to revalidate: 900 (15 minutes).

  • 5c7f662: Introduced an argument to the useAuth hook, UseAuthOptions, to provide users the ability to disable automatic redirect from the useAuth hook upon an unauthenticated user.

    import { client } from 'client';

    export default function Page() {
      const { isLoading, isAuthenticated, authResult } = client.auth.useAuth({
        shouldRedirect: false,
      });

      if (isLoading) {
        return <p>Loading...</p>;
      }

      if (!isAuthenticated) {
        return (
          <p>You need to be authenticated to see this content. Please login.</p>
        );
      }

      return <p>Authenticated content</p>;
    }

Patch Changes​

  • c4b205a: Implemented changesets 🦋
  • Updated dependencies [4ded997]
  • Updated dependencies [8243e9f]
  • Updated dependencies [f0f2706]
  • Updated dependencies [c4b205a]
  • Updated dependencies [5c7f662]
    • @faustjs/core@0.12.0
    • @faustjs/react@0.12.0