Version Packages

examples/next/getting-started/package.json

@@ -12,8 +12,8 @@
     "wpe-build": "next build"
   },
   "dependencies": {
-    "@faustjs/core": "^0.11.0",
-    "@faustjs/next": "^0.11.0",
+    "@faustjs/core": "^0.12.0",
+    "@faustjs/next": "^0.12.0",
     "next": "^11.1.2",
     "normalize.css": "^8.0.1",
     "react": "^17.0.2",

packages/core/CHANGELOG.md

@@ -0,0 +1,79 @@
+# @faustjs/core
+
+## 0.12.0
+
+### Minor Changes
+
+- 4ded997: Implement `logoutHandler` middleware
+- 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:
+
+  ```ts
+  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`:
+
+  ```ts
+  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).
+
+- f0f2706: Introduced the `apiRouter` that will handle all of the Faust.js related endpoints for you.
+
+  ## Breaking Changes
+
+  With the introduction of `apiRouter` we have introduced a breaking change. You will need to remove your `pages/api/auth/wpe-headless.ts` file, and create a new file, `pages/api/faust/[[...route]].ts` with the following content:
+
+  ```ts
+  import 'faust.config';
+  import { apiRouter } from '@faustjs/core/api';
+
+  export default apiRouter;
+  ```
+
+  **Note**: The `[[...route]]` naming convention is a [Next.js convention for a catch-all route.](https://nextjs.org/docs/routing/dynamic-routes#optional-catch-all-routes)
+
+  ### Config changes
+
+  The `apiEndpoint` and `apiUrl` config options have been removed in exchange for the `apiBasePath` option. This option specifies the base path for all of the Faust.js endpoints. The `blogUrlPrefix` is no longer necessary and has been removed from the config interface.
+
+### Patch Changes
+
+- c4b205a: Implemented `changesets` 🦋
+- 5c7f662: Added the appropriate `Content-Type` response header to the `authorizeHandler` middleware

packages/core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faustjs/core",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "This module helps you use WordPress as a Headless CMS",
   "main": "dist/cjs/index.js",
   "module": "dist/mjs/index.js",

packages/next/CHANGELOG.md

@@ -0,0 +1,89 @@
+# @faustjs/next
+
+## 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:
+
+  ```ts
+  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`:
+
+  ```ts
+  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.
+
+  ```tsx
+  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

packages/next/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faustjs/next",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "This module helps you use WordPress as a Headless CMS with Next.js",
   "main": "dist/cjs/index.js",
   "module": "dist/mjs/index.js",
@@ -84,8 +84,8 @@
   "dependencies": {
     "@gqty/logger": "^2.0.0",
     "@gqty/react": "^2.0.0",
-    "@faustjs/core": "^0.11.0",
-    "@faustjs/react": "^0.11.0",
+    "@faustjs/core": "^0.12.0",
+    "@faustjs/react": "^0.12.0",
     "graphql": ">=15.6",
     "lodash": "^4.17.21"
   }

packages/react/CHANGELOG.md

@@ -0,0 +1,64 @@
+# @faustjs/react
+
+## 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:
+
+  ```ts
+  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`:
+
+  ```ts
+  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).
+
+### 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