@wpnuxt/core 1.0.0-edge.5 → 1.0.0-edge.6

package/README.md

@@ -14,37 +14,20 @@ I am working towards a stable release. And will inform about it here
 Nuxt module for using WordPress as a headless CMS with a Nuxt 3 frontend
 
 - [✨  Release Notes](/CHANGELOG.md)
-<!-- - [🏀 Online playground](https://stackblitz.com/github/your-org/my-module?file=playground%2Fapp.vue) -->
-<!-- - [📖 &nbsp;Documentation](https://example.com) -->
+- [🏀 Online playground](https://stackblitz.com/github/wpnuxt/wpnuxt-core?file=playground%2Fapp%2Fpages%2Findex.vue)
+- [📖 &nbsp;Documentation](https://wpnuxt.com)
 
 ## Features
 
 - Content is fetched from WordPress using server-side GraphQL api calls
-- Support for (Gutenberg Blocks), using WPEngine's wp-graphql-content-blocks https://faustjs.org/tutorial/get-started-with-wp-graphql-content-blocks
+- Support for (Gutenberg Blocks) by adding the separate [@wpnuxt/blocks](https://github.com/wpnuxt/wpnuxt-blocks), which uses WPEngine's [wp-graphql-content-blocks](https://faustjs.org/tutorial/get-started-with-wp-graphql-content-blocks) and a set of custom vue components
 
 ## Quick Setup
 
-1. Add `@vernaillen/wpnuxt` dependency to your project
+Install the module to your Nuxt application with one command:
 
 ```bash
-# Using pnpm
-pnpm add -D @vernaillen/wpnuxt
-
-# Using yarn
-yarn add --dev @vernaillen/wpnuxt
-
-# Using npm
-npm install --save-dev @vernaillen/wpnuxt
-```
-
-2. Add '@vernaillen/wpnuxt' to the `modules` section of `nuxt.config.ts`
-
-```js
-export default defineNuxtConfig({
-  modules: [
-    '@vernaillen/wpnuxt'
-  ]
-})
+npx nuxi module add @wpnuxt/core
 ```
 
 That's it! You can now use the WPNuxt module in your Nuxt app ✨
@@ -53,26 +36,26 @@ That's it! You can now use the WPNuxt module in your Nuxt app ✨
 
 ```bash
 # Install dependencies
-npm install
+pnpm install
 
 # Generate type stubs
-npm run dev:prepare
+pnpm run dev:prepare
 
 # Develop with the playground
-npm run dev
+pnpm run dev
 
 # Build the playground
-npm run dev:build
+pnpm run dev:build
 
 # Run ESLint
-npm run lint
+pnpm run lint
 
 # Run Vitest
-npm run test
-npm run test:watch
+pnpm run test
+pnpm run test:watch
 
 # Release new version
-npm run release
+pnpm run release
 ```
 
 <!-- Badges -->

package/dist/module.d.mts

@@ -21,24 +21,14 @@ interface WPNuxtConfig {
   faustSecretKey?: string
   defaultMenuName?: string
 
-  /**
-   * Enable custom components for Gutenberg blocks
-   * When disabled the module will use the renderedHtml of each block returned by WordPress
-   *
-   * @default true
-   */
-  blocks?: boolean
-
-  replaceSchema?: boolean
   enableCache?: boolean
 
   staging?: boolean
+
   /**
-   * Generate composables based on the GraphQL queries, provided by both the WPNuxt module as the queries added by the user.
-   *
-   * @default { enabled: true, prefix: 'useWP' }
+   * @default 'useWP'
    */
-  generateComposables?: WPNuxtConfigComposables
+  composablesPrefix: string
 
   queries?: WPNuxtConfigQueries
 
@@ -53,18 +43,6 @@ interface WPNuxtConfig {
   downloadSchema?: boolean
 }
 
-interface WPNuxtConfigComposables {
-  enabled?: boolean
-
-  /**
-   * Prefix to use for generated composables
-   *
-   * @example 'useWP' => 'useWPPages', 'useWPPosts', 'useWPMenu'
-   * @default 'useWP'
-   */
-  prefix?: string
-}
-
 interface WPNuxtConfigQueries {
   /**
    * @default true

package/dist/module.d.ts

@@ -21,24 +21,14 @@ interface WPNuxtConfig {
   faustSecretKey?: string
   defaultMenuName?: string
 
-  /**
-   * Enable custom components for Gutenberg blocks
-   * When disabled the module will use the renderedHtml of each block returned by WordPress
-   *
-   * @default true
-   */
-  blocks?: boolean
-
-  replaceSchema?: boolean
   enableCache?: boolean
 
   staging?: boolean
+
   /**
-   * Generate composables based on the GraphQL queries, provided by both the WPNuxt module as the queries added by the user.
-   *
-   * @default { enabled: true, prefix: 'useWP' }
+   * @default 'useWP'
    */
-  generateComposables?: WPNuxtConfigComposables
+  composablesPrefix: string
 
   queries?: WPNuxtConfigQueries
 
@@ -53,18 +43,6 @@ interface WPNuxtConfig {
   downloadSchema?: boolean
 }
 
-interface WPNuxtConfigComposables {
-  enabled?: boolean
-
-  /**
-   * Prefix to use for generated composables
-   *
-   * @example 'useWP' => 'useWPPages', 'useWPPosts', 'useWPMenu'
-   * @default 'useWP'
-   */
-  prefix?: string
-}
-
 interface WPNuxtConfigQueries {
   /**
    * @default true

package/dist/module.json

@@ -1,6 +1,6 @@
 {
   "name": "@wpnuxt/core",
-  "version": "1.0.0-edge.5",
+  "version": "1.0.0-edge.6",
   "configKey": "wpNuxt",
   "nuxt": ">=3.1.0",
   "builder": {

package/dist/module.mjs

@@ -1,5 +1,5 @@
 import { promises, statSync, existsSync, cpSync } from 'node:fs';
-import { resolveFiles, defineNuxtModule, createResolver, addPlugin, addImports, addComponent, addServerHandler, installModule, hasNuxtModule, addTemplate } from '@nuxt/kit';
+import { resolveFiles, defineNuxtModule, createResolver, addPlugin, addImports, addComponent, addServerHandler, installModule, hasNuxtModule, addTemplate, addTypeTemplate } from '@nuxt/kit';
 import defu from 'defu';
 import { join } from 'pathe';
 import consola, { createConsola } from 'consola';
@@ -8,7 +8,7 @@ import { upperFirst } from 'scule';
 import { parse } from 'graphql';
 
 const name = "@wpnuxt/core";
-const version = "1.0.0-edge.5";
+const version = "1.0.0-edge.6";
 
 const loggerRef = ref();
 const initLogger = (logLevel) => {
@@ -78,18 +78,14 @@ async function prepareContext(ctx) {
   if (ctx.docs) {
     await prepareFunctions(ctx);
   }
-  const fnName = (fn) => ctx.composables.prefix + upperFirst(fn);
+  const fnName = (fn) => ctx.composablesPrefix + upperFirst(fn);
   const fnExp = (q, typed = false) => {
     const functionName = fnName(q.name);
     if (!typed) {
-      const nodesArray = q.nodes?.map((n) => `'${n}'`);
-      return `export const ${functionName} = (params) => useWPContent('${q.name}', [${nodesArray?.join(",")}], false, params)`;
+      return `export const ${functionName} = (params) => useWPContent('${q.name}', [${q.nodes?.map((n) => `'${n}'`).join(",")}], false, params)`;
     }
-    let fragmentSuffix = "";
-    if (q.fragments && q.fragments.length > 0 && q.nodes && q.nodes.length > 0 && q.nodes.includes("nodes")) {
-      fragmentSuffix = "[]";
-    }
-    const fragments = q.fragments && q.fragments.length > 0 ? q.fragments.map((f) => `${f}Fragment${fragmentSuffix}`).join(" | ") : "any";
+    const fragmentSuffix = q.fragments?.length && q.nodes?.includes("nodes") ? "[]" : "";
+    const fragments = q.fragments?.length ? q.fragments.map((f) => `${f}Fragment${fragmentSuffix}`).join(" | ") : "any";
     return `  export const ${functionName}: (params?: ${q.name}QueryVariables) => AsyncData<${fragments}, FetchError | null | undefined>`;
   };
   ctx.generateImports = () => [
@@ -145,21 +141,15 @@ async function generateWPNuxtComposables(ctx, queryOutputPath, resolver) {
   await prepareContext(ctx);
 }
 
-const defaultComposablesConfig = {
-  enabled: true,
-  prefix: "useWP"
-};
 const defaultConfigs = {
   wordpressUrl: "",
   frontendUrl: "",
   faustSecretKey: "",
   defaultMenuName: "main",
-  blocks: true,
-  replaceSchema: false,
   enableCache: true,
   staging: false,
   logLevel: 3,
-  generateComposables: defaultComposablesConfig
+  composablesPrefix: "useWP"
 };
 const module = defineNuxtModule({
   meta: {
@@ -177,14 +167,11 @@ const module = defineNuxtModule({
       wordpressUrl: process.env.WPNUXT_WORDPRESS_URL || options.wordpressUrl,
       frontendUrl: process.env.WPNUXT_FRONTEND_URL || options.frontendUrl,
       defaultMenuName: process.env.WPNUXT_DEFAULT_MENU_NAME || options.defaultMenuName,
-      blocks: process.env.WPNUXT_BLOCKS ? process.env.WPNUXT_BLOCKS === "true" : options.blocks,
-      replaceSchema: process.env.WPNUXT_REPLACE_SCHEMA === "true" || options.replaceSchema,
       enableCache: process.env.WPNUXT_ENABLE_CACHE ? process.env.WPNUXT_ENABLE_CACHE === "true" : options.enableCache,
       staging: process.env.WPNUXT_STAGING === "true" || options.staging,
       downloadSchema: process.env.WPNUXT_DOWNLOAD_SCHEMA === "true" || options.downloadSchema,
-      // TODO also allow below options as env vars?
       logLevel: process.env.WPNUXT_LOG_LEVEL ? Number.parseInt(process.env.WPNUXT_LOG_LEVEL) : options.logLevel,
-      generateComposables: options.generateComposables
+      composablesPrefix: process.env.WPNUXT_COMPOSABLES_PREFIX || options.composablesPrefix
     };
     nuxt.options.runtimeConfig.wpNuxt = defu(nuxt.options.runtimeConfig.wpNuxt, {
       faustSecretKey: process.env.WPNUXT_FAUST_SECRET_KEY ? process.env.WPNUXT_FAUST_SECRET_KEY : options.faustSecretKey
@@ -199,8 +186,6 @@ const module = defineNuxtModule({
     logger.debug("Debug mode enabled, log level:", publicWPNuxtConfig.logLevel);
     if (publicWPNuxtConfig.staging)
       logger.info("Staging enabled");
-    if (publicWPNuxtConfig.blocks)
-      logger.info("Blocks enabled");
     const { resolve } = createResolver(import.meta.url);
     const resolveRuntimeModule = (path) => resolve("./runtime", path);
     const srcResolver = createResolver(nuxt.options.srcDir);
@@ -245,6 +230,7 @@ const module = defineNuxtModule({
     const userQueryPathExists = existsSync(userQueryPath);
     cpSync(resolveRuntimeModule("./queries/"), queryOutputPath, { recursive: true });
     if (hasNuxtModule("@wpnuxt/blocks")) {
+      logger.debug("Loading @wpnuxt/blocks");
       for (const m of nuxt.options._installedModules) {
         if (m.meta.name === "@wpnuxt/blocks" && m.entryPath) {
           let blocksQueriesPath;
@@ -257,7 +243,7 @@ const module = defineNuxtModule({
         }
       }
     } else {
-      logger.debug("!!! If you want to render Gutenberg blocks with separate vue components, please install the @wpnuxt/blocks module");
+      logger.debug("Tip: Install the @wpnuxt/blocks module if you want to render Gutenberg blocks with separate vue components");
     }
     if (userQueryPathExists) {
       logger.debug("Extending queries:", userQueryPath);
@@ -276,6 +262,7 @@ const module = defineNuxtModule({
         dedupeFragments: true,
         onlyOperationTypes: true,
         avoidOptionals: false,
+        maybeValue: "T | undefined",
         disableOnBuild: false,
         gqlImport: "graphql-request#wpnuxt",
         namingConvention: {
@@ -319,29 +306,26 @@ const module = defineNuxtModule({
     });
     nuxt.options.nitro.externals.inline.push(template.dst);
     nuxt.options.alias["#graphql-middleware-server-options-build"] = template.dst;
-    if (publicWPNuxtConfig.generateComposables && publicWPNuxtConfig.generateComposables.enabled) {
-      logger.trace("Generating composables");
-      const composablesConfig = typeof publicWPNuxtConfig.generateComposables === "object" ? publicWPNuxtConfig.generateComposables : defaultComposablesConfig;
-      const ctx = await {
-        fns: [],
-        fnImports: [],
-        composables: composablesConfig
-      };
-      await generateWPNuxtComposables(ctx, queryOutputPath, srcResolver);
-      addTemplate({
-        write: true,
-        filename: "wpnuxt.mjs",
-        getContents: () => ctx.generateImports?.() || ""
-      });
-      addTemplate({
-        write: true,
-        filename: "wpnuxt/index.d.ts",
-        getContents: () => ctx.generateDeclarations?.() || ""
-      });
-      nuxt.hook("imports:extend", (autoimports) => {
-        autoimports.push(...ctx.fnImports || []);
-      });
-    }
+    logger.trace("Start generating composables");
+    const ctx = await {
+      fns: [],
+      fnImports: [],
+      composablesPrefix: publicWPNuxtConfig.composablesPrefix
+    };
+    await generateWPNuxtComposables(ctx, queryOutputPath, srcResolver);
+    addTemplate({
+      write: true,
+      filename: "wpnuxt/index.mjs",
+      getContents: () => ctx.generateImports?.() || ""
+    });
+    addTypeTemplate({
+      write: true,
+      filename: "wpnuxt/index.d.ts",
+      getContents: () => ctx.generateDeclarations?.() || ""
+    });
+    nuxt.hook("imports:extend", (autoimports) => {
+      autoimports.push(...ctx.fnImports || []);
+    });
     nuxt.hook("nitro:init", async (nitro) => {
       const keys = await nitro.storage.getKeys("cache:content");
       keys.forEach(async (key) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wpnuxt/core",
-  "version": "1.0.0-edge.5",
+  "version": "1.0.0-edge.6",
   "description": "WPNuxt",
   "repository": {
     "type": "git",
@@ -97,5 +97,8 @@
     "pathe": "^1.1.2",
     "scule": "^1.3.0"
   },
-  "packageManager": "pnpm@9.7.0"
+  "packageManager": "pnpm@9.7.0",
+  "engines": {
+    "node": ">=18"
+  }
 }